Merge pull request #93 from privacy-scaling-explorations/dev

chore(merge) - dev to staging
privacy-scaling-explorations · Oct 10, 2023 · 627e769 · 627e769
2 parents d132808 + 71f2d95
commit 627e769
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 108 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -62,7 +62,7 @@ Failing to follow the above instructions, will result in the CI checks failing.
           "template": {
               "source": "<HTTPS_URL_OF_THE_CIRCOM_FILE>",
               "commitHash": "<TEMPLATE_COMMIT_HASH>",
-              "paramConfiguration": ["<CIRCUIT_INSTANCE_PARAMETERS_ARRAY>"]
+              "paramsConfiguration": ["<CIRCUIT_INSTANCE_PARAMETERS_ARRAY>"]
           },
           "verification": {
               "cfOrVm": "<DESIRED_VERIFICATION_MECHANISM (VM/CF)>"
@@ -98,7 +98,7 @@ Failing to follow the above instructions, will result in the CI checks failing.
     - template - an object made of:
         - source - a string with the URL of the circom file
         - commitHash -  a string with the commit id (needs to be a GitHub commit hash)
-        - paramConfiguration - an array of numbers with the parameters of the circuit template
+        - paramsConfiguration - an array of numbers with the parameters of the circuit template
     - verification - an object detailing how the circuit's zKeys will be verified
         - cfOrVm - a string with either "CF" or "VM". If "VM" the following must be added:
             - vmConfigurationType - a string with the VM type - options:

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -57,7 +57,7 @@ Failing to follow the above instructions, will result in the CI checks failing.
           "template": {
               "source": "<HTTPS_URL_OF_THE_CIRCOM_FILE>",
               "commitHash": "<TEMPLATE_COMMIT_HASH>",
-              "paramConfiguration": [6,8,3,2]
+              "paramsConfiguration": [6,8,3,2]
           },
           "verification": {
               "cfOrVm": "CF"
@@ -91,7 +91,7 @@ Failing to follow the above instructions, will result in the CI checks failing.
     - template - an object made of:
         - source - a string with the URL of the circom file
         - commitHash -  a string with the commit id (needs to be a GitHub commit hash)
-        - paramConfiguration - an array of numbers with the parameters of the circuit template
+        - paramsConfiguration - an array of numbers with the parameters of the circuit template
     - verification - an object detailing how the circuit's zKeys will be verified
         - cfOrVm - a string with either "CF" or "VM". If "VM" the following must be added:
             - vmConfigurationType - a string with the VM type - options:

diff --git a/ceremonies/README.md b/ceremonies/README.md
@@ -18,7 +18,7 @@ To request a new ceremony to be setup, you will need to submit a PR with a folde
 - fill the *p0tionConfig.json* file accordingly:
     + The title of the ceremony will end up being its prefix. Prefixes are simply the title all lowercase, with dashes (*-*) instead of whitespace. For example, given a title of *Example Ceremony*, the prefix will be *example-ceremony*.
     + Fill the rest of the fields with the desired data, ensuring that each circuit details are correct, and that you chose the required Verification method.
-    + In the artifacts fields, please add the correct storage path and bucket name - note that we require both the *r1cs* and the *wasm* files.
+    + In the artifacts fields, please add the correct storage path on AWS (the URL to the artifacts) - note that we require both the *r1cs* and the *wasm* files.
     + *Note* that you can use [p0tion phase2cli](https://github.com/privacy-scaling-explorations/p0tion) as follows to verify that the config file is correct:
         * `phase2cli validate --template $PATH_TO_THE_TEMPLATE`
 - create a directory inside *./ceremonies* and name it with the *prefix* (detailed in the bullet point above). 
@@ -65,16 +65,14 @@ The script will upload your artifacts to a S3 bucket of your choice (must be own
           "template": {
               "source": "<HTTPS_URL_OF_THE_CIRCOM_FILE>",
               "commitHash": "<TEMPLATE_COMMIT_HASH>",
-              "paramConfiguration": ["<CIRCUIT_INSTANCE_PARAMETERS_ARRAY>"]
+              "paramsConfiguration": ["<CIRCUIT_INSTANCE_PARAMETERS_ARRAY>"]
           },
           "verification": {
               "cfOrVm": "<DESIRED_VERIFICATION_MECHANISM (VM/CF)>"
           },
           "artifacts": {
-              "bucket": "<THE_BUCKET_NAME>",
-              "region": "<THE_AWS_REGION_WHERE_THE_BUCKET_LIVES>",
-              "r1csLocalFilePath": "<PATH_TO_THE_CIRCUIT_R1CS>",
-              "wasmLocalFilePath": "<PATH_TO_THE_CIRCUIT_WASM>"
+              "r1csStoragePath": "<URL_TO_THE_CIRCUIT_R1CS>",
+              "r1csStoragePath": "<URL_TO_THE_CIRCUIT_WASM>"
           },
           "name": "<CIRCUIT_NAME>",
           "dynamicThreshold": "<THE_DYNAMIC_THRESHOLD (NUMBER)>",
@@ -101,7 +99,7 @@ The script will upload your artifacts to a S3 bucket of your choice (must be own
     - template - an object made of:
         - source - a string with the URL of the circom file
         - commitHash -  a string with the commit id (needs to be a GitHub commit hash)
-        - paramConfiguration - an array of numbers with the parameters of the circuit template
+        - paramsConfiguration - an array of numbers with the parameters of the circuit template
     - verification - an object detailing how the circuit's zKeys will be verified
         - cfOrVm - a string with either "CF" or "VM". If "VM" the following must be added:
             - vmConfigurationType - a string with the VM type - options:
@@ -116,10 +114,8 @@ The script will upload your artifacts to a S3 bucket of your choice (must be own
                 * "st1"
                 * "sc1"
     - artifacts - an object with the storage path to the r1cs and wasm on s3
-        - bucket - a string with the bucket name
-        - region - the AWS region where the bucket live
-        - r1csStoragePath - a string with the r1cs storage path e.g. "test-ceremony/circuit.r1cs"
-        - wasmStoragePath - a string with the wasm storage path e.g. "test-ceremony/circuit.wasm"
+        - r1csStoragePath - a string with the r1cs storage path on S3 e.g. "https://test-ceremony.region.amazonaws.com/circuit.r1cs"
+        - wasmStoragePath - a string with the wasm storage path on s3 e.g. "https://test-ceremony.region.amazonaws.com/circuit.wasm"
     - name - a string with the circuit name
     - dynamicThreshold - if selected dynamic timeout please enter the threshold here as a number
     - fixedTimeWindow - if selected fixed timeout please enter the time window here as a number