@devtion/actions 0.0.0-5d170d3 → 0.0.0-5fad82d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/README.md +1 -1
  2. package/dist/index.mjs +368 -329
  3. package/dist/index.node.js +369 -328
  4. package/dist/types/src/helpers/constants.d.ts +11 -2
  5. package/dist/types/src/helpers/constants.d.ts.map +1 -1
  6. package/dist/types/src/helpers/contracts.d.ts.map +1 -1
  7. package/dist/types/src/helpers/crypto.d.ts +1 -0
  8. package/dist/types/src/helpers/crypto.d.ts.map +1 -1
  9. package/dist/types/src/helpers/database.d.ts +8 -0
  10. package/dist/types/src/helpers/database.d.ts.map +1 -1
  11. package/dist/types/src/helpers/security.d.ts +2 -2
  12. package/dist/types/src/helpers/security.d.ts.map +1 -1
  13. package/dist/types/src/helpers/storage.d.ts +5 -2
  14. package/dist/types/src/helpers/storage.d.ts.map +1 -1
  15. package/dist/types/src/helpers/utils.d.ts +34 -20
  16. package/dist/types/src/helpers/utils.d.ts.map +1 -1
  17. package/dist/types/src/helpers/verification.d.ts +3 -2
  18. package/dist/types/src/helpers/verification.d.ts.map +1 -1
  19. package/dist/types/src/helpers/vm.d.ts.map +1 -1
  20. package/dist/types/src/index.d.ts +2 -2
  21. package/dist/types/src/index.d.ts.map +1 -1
  22. package/dist/types/src/types/index.d.ts +9 -3
  23. package/dist/types/src/types/index.d.ts.map +1 -1
  24. package/package.json +3 -8
  25. package/src/helpers/constants.ts +45 -31
  26. package/src/helpers/contracts.ts +3 -3
  27. package/src/helpers/database.ts +13 -0
  28. package/src/helpers/functions.ts +1 -1
  29. package/src/helpers/security.ts +33 -52
  30. package/src/helpers/services.ts +3 -3
  31. package/src/helpers/storage.ts +15 -3
  32. package/src/helpers/utils.ts +316 -277
  33. package/src/helpers/verification.ts +6 -6
  34. package/src/helpers/vm.ts +14 -7
  35. package/src/index.ts +5 -3
  36. package/src/types/index.ts +32 -8
@@ -1,6 +1,6 @@
1
1
  /**
2
- * @module @p0tion/actions
3
- * @version 1.0.5
2
+ * @module @devtion/actions
3
+ * @version 1.2.5
4
4
  * @file A set of actions and helpers for CLI commands
5
5
  * @copyright Ethereum Foundation 2022
6
6
  * @license MIT
@@ -17,9 +17,7 @@ var firestore = require('firebase/firestore');
17
17
  var snarkjs = require('snarkjs');
18
18
  var crypto = require('crypto');
19
19
  var blake = require('blakejs');
20
- var ffjavascript = require('ffjavascript');
21
20
  var winston = require('winston');
22
- var clientS3 = require('@aws-sdk/client-s3');
23
21
  var stream = require('stream');
24
22
  var util = require('util');
25
23
  var app = require('firebase/app');
@@ -30,10 +28,10 @@ var clientEc2 = require('@aws-sdk/client-ec2');
30
28
  var clientSsm = require('@aws-sdk/client-ssm');
31
29
  var dotenv = require('dotenv');
32
30
 
33
- // Main part for the Hermez Phase 1 Trusted Setup URLs to download PoT files.
34
- const potFileDownloadMainUrl = `https://hermez.s3-eu-west-1.amazonaws.com/`;
35
- // Main part for the Hermez Phase 1 Trusted Setup PoT files to be downloaded.
36
- const potFilenameTemplate = `powersOfTau28_hez_final_`;
31
+ // Main part for the PPoT Phase 1 Trusted Setup URLs to download PoT files.
32
+ const potFileDownloadMainUrl = `https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/`;
33
+ // Main part for the PPoT Phase 1 Trusted Setup PoT files to be downloaded.
34
+ const potFilenameTemplate = `ppot_0080_`;
37
35
  // The genesis zKey index.
38
36
  const genesisZkeyIndex = `00000`;
39
37
  // The number of exponential iterations to be executed by SnarkJS when finalizing the ceremony.
@@ -50,6 +48,8 @@ const verifierSmartContractAcronym = "verifier";
50
48
  const ec2InstanceTag = "p0tionec2instance";
51
49
  // The name of the VM startup script file.
52
50
  const vmBootstrapScriptFilename = "bootstrap.sh";
51
+ // Match hash output by snarkjs in transcript log
52
+ const contribHashRegex = new RegExp("Contribution.+Hash.+\n\t\t.+\n\t\t.+\n.+\n\t\t.+\r?\n");
53
53
  /**
54
54
  * Define the supported VM configuration types.
55
55
  * @dev the VM configurations can be retrieved at https://aws.amazon.com/ec2/instance-types/
@@ -107,112 +107,116 @@ const vmConfigurationTypes = {
107
107
  */
108
108
  const powersOfTauFiles = [
109
109
  {
110
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_01.ptau",
110
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_01.ptau",
111
111
  size: 0.000084
112
112
  },
113
113
  {
114
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_02.ptau",
114
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_02.ptau",
115
115
  size: 0.000086
116
116
  },
117
117
  {
118
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_03.ptau",
118
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_03.ptau",
119
119
  size: 0.000091
120
120
  },
121
121
  {
122
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_04.ptau",
122
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_04.ptau",
123
123
  size: 0.0001
124
124
  },
125
125
  {
126
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_05.ptau",
126
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_05.ptau",
127
127
  size: 0.000117
128
128
  },
129
129
  {
130
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_06.ptau",
130
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_06.ptau",
131
131
  size: 0.000153
132
132
  },
133
133
  {
134
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_07.ptau",
134
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_07.ptau",
135
135
  size: 0.000225
136
136
  },
137
137
  {
138
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_08.ptau",
138
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_08.ptau",
139
139
  size: 0.0004
140
140
  },
141
141
  {
142
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_09.ptau",
142
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_09.ptau",
143
143
  size: 0.000658
144
144
  },
145
145
  {
146
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_10.ptau",
146
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_10.ptau",
147
147
  size: 0.0013
148
148
  },
149
149
  {
150
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_11.ptau",
150
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_11.ptau",
151
151
  size: 0.0023
152
152
  },
153
153
  {
154
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_12.ptau",
154
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_12.ptau",
155
155
  size: 0.0046
156
156
  },
157
157
  {
158
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_13.ptau",
158
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_13.ptau",
159
159
  size: 0.0091
160
160
  },
161
161
  {
162
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_14.ptau",
162
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_14.ptau",
163
163
  size: 0.0181
164
164
  },
165
165
  {
166
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_15.ptau",
166
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_15.ptau",
167
167
  size: 0.0361
168
168
  },
169
169
  {
170
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_16.ptau",
170
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_16.ptau",
171
171
  size: 0.0721
172
172
  },
173
173
  {
174
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_17.ptau",
174
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_17.ptau",
175
175
  size: 0.144
176
176
  },
177
177
  {
178
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_18.ptau",
178
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_18.ptau",
179
179
  size: 0.288
180
180
  },
181
181
  {
182
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_19.ptau",
182
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_19.ptau",
183
183
  size: 0.576
184
184
  },
185
185
  {
186
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_20.ptau",
186
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_20.ptau",
187
187
  size: 1.1
188
188
  },
189
189
  {
190
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_21.ptau",
190
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_21.ptau",
191
191
  size: 2.3
192
192
  },
193
193
  {
194
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_22.ptau",
194
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_22.ptau",
195
195
  size: 4.5
196
196
  },
197
197
  {
198
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_23.ptau",
198
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_23.ptau",
199
199
  size: 9.0
200
200
  },
201
201
  {
202
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_24.ptau",
202
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_24.ptau",
203
203
  size: 18.0
204
204
  },
205
205
  {
206
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_25.ptau",
206
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_25.ptau",
207
207
  size: 36.0
208
208
  },
209
209
  {
210
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_26.ptau",
210
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_26.ptau",
211
211
  size: 72.0
212
212
  },
213
213
  {
214
- ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_27.ptau",
214
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_27.ptau",
215
215
  size: 144.0
216
+ },
217
+ {
218
+ ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_final.ptau",
219
+ size: 288.0
216
220
  }
217
221
  ];
218
222
  /**
@@ -246,6 +250,12 @@ const commonTerms = {
246
250
  verificationStartedAt: "verificationStartedAt"
247
251
  }
248
252
  },
253
+ avatars: {
254
+ name: "avatars",
255
+ fields: {
256
+ avatarUrl: "avatarUrl"
257
+ }
258
+ },
249
259
  ceremonies: {
250
260
  name: "ceremonies",
251
261
  fields: {
@@ -337,6 +347,8 @@ const commonTerms = {
337
347
  finalizeCeremony: "finalizeCeremony",
338
348
  downloadCircuitArtifacts: "downloadCircuitArtifacts",
339
349
  transferObject: "transferObject",
350
+ bandadaValidateProof: "bandadaValidateProof",
351
+ checkNonceOfSIWEAddress: "checkNonceOfSIWEAddress"
340
352
  }
341
353
  };
342
354
 
@@ -687,19 +699,23 @@ const getChunksAndPreSignedUrls = async (cloudFunctions, bucketName, objectKey,
687
699
  * @param cloudFunctions <Functions> - the Firebase Cloud Functions service instance.
688
700
  * @param ceremonyId <string> - the unique identifier of the ceremony.
689
701
  * @param alreadyUploadedChunks Array<ETagWithPartNumber> - the temporary information about the already uploaded chunks.
702
+ * @param logger <GenericBar> - an optional logger to show progress.
690
703
  * @returns <Promise<Array<ETagWithPartNumber>>> - the completed (uploaded) chunks information.
691
704
  */
692
- const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremonyId, alreadyUploadedChunks) => {
705
+ const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremonyId, alreadyUploadedChunks, logger) => {
693
706
  // Keep track of uploaded chunks.
694
707
  const uploadedChunks = alreadyUploadedChunks || [];
708
+ // if we were passed a logger, start it
709
+ if (logger)
710
+ logger.start(chunksWithUrls.length, 0);
695
711
  // Loop through remaining chunks.
696
712
  for (let i = alreadyUploadedChunks ? alreadyUploadedChunks.length : 0; i < chunksWithUrls.length; i += 1) {
697
713
  // Consume the pre-signed url to upload the chunk.
698
714
  // @ts-ignore
699
715
  const response = await fetch(chunksWithUrls[i].preSignedUrl, {
700
716
  retryOptions: {
701
- retryInitialDelay: 500,
702
- socketTimeout: 60000,
717
+ retryInitialDelay: 500, // 500 ms.
718
+ socketTimeout: 60000, // 60 seconds.
703
719
  retryMaxDuration: 300000 // 5 minutes.
704
720
  },
705
721
  method: "PUT",
@@ -723,6 +739,9 @@ const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremony
723
739
  // nb. this must be done only when contributing (not finalizing).
724
740
  if (!!ceremonyId && !!cloudFunctions)
725
741
  await temporaryStoreCurrentContributionUploadedChunkData(cloudFunctions, ceremonyId, chunk);
742
+ // increment the count on the logger
743
+ if (logger)
744
+ logger.increment();
726
745
  }
727
746
  return uploadedChunks;
728
747
  };
@@ -743,8 +762,9 @@ const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremony
743
762
  * @param configStreamChunkSize <number> - size of each chunk into which the artifact is going to be splitted (nb. will be converted in MB).
744
763
  * @param [ceremonyId] <string> - the unique identifier of the ceremony (used as a double-edge sword - as identifier and as a check if current contributor is the coordinator finalizing the ceremony).
745
764
  * @param [temporaryDataToResumeMultiPartUpload] <TemporaryParticipantContributionData> - the temporary information necessary to resume an already started multi-part upload.
765
+ * @param logger <GenericBar> - an optional logger to show progress.
746
766
  */
747
- const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFilePath, configStreamChunkSize, ceremonyId, temporaryDataToResumeMultiPartUpload) => {
767
+ const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFilePath, configStreamChunkSize, ceremonyId, temporaryDataToResumeMultiPartUpload, logger) => {
748
768
  // The unique identifier of the multi-part upload.
749
769
  let multiPartUploadId = "";
750
770
  // The list of already uploaded chunks.
@@ -768,7 +788,7 @@ const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFileP
768
788
  const chunksWithUrlsZkey = await getChunksAndPreSignedUrls(cloudFunctions, bucketName, objectKey, localFilePath, multiPartUploadId, configStreamChunkSize, ceremonyId);
769
789
  // Step (2).
770
790
  const partNumbersAndETagsZkey = await uploadParts(chunksWithUrlsZkey, mime.lookup(localFilePath), // content-type.
771
- cloudFunctions, ceremonyId, alreadyUploadedChunks);
791
+ cloudFunctions, ceremonyId, alreadyUploadedChunks, logger);
772
792
  // Step (3).
773
793
  await completeMultiPartUpload(cloudFunctions, bucketName, objectKey, multiPartUploadId, partNumbersAndETagsZkey, ceremonyId);
774
794
  };
@@ -992,6 +1012,17 @@ const getClosedCeremonies = async (firestoreDatabase) => {
992
1012
  ]);
993
1013
  return fromQueryToFirebaseDocumentInfo(closedCeremoniesQuerySnap.docs);
994
1014
  };
1015
+ /**
1016
+ * Query all ceremonies
1017
+ * @notice get all ceremonies from the database.
1018
+ * @dev this is a helper for the CLI ceremony methods.
1019
+ * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
1020
+ * @returns <Promise<Array<FirebaseDocumentInfo>>> - the list of all ceremonies.
1021
+ */
1022
+ const getAllCeremonies = async (firestoreDatabase) => {
1023
+ const ceremoniesQuerySnap = await queryCollection(firestoreDatabase, commonTerms.collections.ceremonies.name, []);
1024
+ return fromQueryToFirebaseDocumentInfo(ceremoniesQuerySnap.docs);
1025
+ };
995
1026
 
996
1027
  /**
997
1028
  * @hidden
@@ -1040,207 +1071,22 @@ const compareHashes = async (path1, path2) => {
1040
1071
  };
1041
1072
 
1042
1073
  /**
1043
- * Parse and validate that the ceremony configuration is correct
1044
- * @notice this does not upload any files to storage
1045
- * @param path <string> - the path to the configuration file
1046
- * @param cleanup <boolean> - whether to delete the r1cs file after parsing
1047
- * @returns any - the data to pass to the cloud function for setup and the circuit artifacts
1074
+ * Return a string with double digits if the provided input is one digit only.
1075
+ * @param in <number> - the input number to be converted.
1076
+ * @returns <string> - the two digits stringified number derived from the conversion.
1048
1077
  */
1049
- const parseCeremonyFile = async (path, cleanup = false) => {
1050
- // check that the path exists
1051
- if (!fs.existsSync(path))
1052
- throw new Error("The provided path to the configuration file does not exist. Please provide an absolute path and try again.");
1053
- try {
1054
- // read the data
1055
- const data = JSON.parse(fs.readFileSync(path).toString());
1056
- // verify that the data is correct
1057
- if (data['timeoutMechanismType'] !== "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */ && data['timeoutMechanismType'] !== "FIXED" /* CeremonyTimeoutType.FIXED */)
1058
- throw new Error("Invalid timeout type. Please choose between DYNAMIC and FIXED.");
1059
- // validate that we have at least 1 circuit input data
1060
- if (!data.circuits || data.circuits.length === 0)
1061
- throw new Error("You need to provide the data for at least 1 circuit.");
1062
- // validate that the end date is in the future
1063
- let endDate;
1064
- let startDate;
1065
- try {
1066
- endDate = new Date(data.endDate);
1067
- startDate = new Date(data.startDate);
1068
- }
1069
- catch (error) {
1070
- throw new Error("The dates should follow this format: 2023-07-04T00:00:00.");
1071
- }
1072
- if (endDate <= startDate)
1073
- throw new Error("The end date should be greater than the start date.");
1074
- const currentDate = new Date();
1075
- if (endDate <= currentDate || startDate <= currentDate)
1076
- throw new Error("The start and end dates should be in the future.");
1077
- // validate penalty
1078
- if (data.penalty <= 0)
1079
- throw new Error("The penalty should be greater than zero.");
1080
- const circuits = [];
1081
- const urlPattern = /(https?:\/\/[^\s]+)/g;
1082
- const commitHashPattern = /^[a-f0-9]{40}$/i;
1083
- const circuitArtifacts = [];
1084
- for (let i = 0; i < data.circuits.length; i++) {
1085
- const circuitData = data.circuits[i];
1086
- const artifacts = circuitData.artifacts;
1087
- circuitArtifacts.push({
1088
- artifacts: artifacts
1089
- });
1090
- const r1csPath = artifacts.r1csStoragePath;
1091
- const wasmPath = artifacts.wasmStoragePath;
1092
- // where we storing the r1cs downloaded
1093
- const localR1csPath = `./${circuitData.name}.r1cs`;
1094
- // check that the artifacts exist in S3
1095
- // we don't need any privileges to download this
1096
- // just the correct region
1097
- const s3 = new clientS3.S3Client({ region: artifacts.region });
1098
- try {
1099
- await s3.send(new clientS3.HeadObjectCommand({
1100
- Bucket: artifacts.bucket,
1101
- Key: r1csPath
1102
- }));
1103
- }
1104
- catch (error) {
1105
- throw new Error(`The r1cs file (${r1csPath}) seems to not exist. Please ensure this is correct and that the object is publicly available.`);
1106
- }
1107
- try {
1108
- await s3.send(new clientS3.HeadObjectCommand({
1109
- Bucket: artifacts.bucket,
1110
- Key: wasmPath
1111
- }));
1112
- }
1113
- catch (error) {
1114
- throw new Error(`The wasm file (${wasmPath}) seems to not exist. Please ensure this is correct and that the object is publicly available.`);
1115
- }
1116
- // download the r1cs to extract the metadata
1117
- const command = new clientS3.GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.r1csStoragePath });
1118
- const response = await s3.send(command);
1119
- const streamPipeline = util.promisify(stream.pipeline);
1120
- if (response.$metadata.httpStatusCode !== 200)
1121
- throw new Error("There was an error while trying to download the r1cs file. Please check that the file has the correct permissions (public) set.");
1122
- if (response.Body instanceof stream.Readable)
1123
- await streamPipeline(response.Body, fs.createWriteStream(localR1csPath));
1124
- // extract the metadata from the r1cs
1125
- const metadata = getR1CSInfo(localR1csPath);
1126
- // validate that the circuit hash and template links are valid
1127
- const template = circuitData.template;
1128
- const URLMatch = template.source.match(urlPattern);
1129
- if (!URLMatch || URLMatch.length === 0 || URLMatch.length > 1)
1130
- throw new Error("You should provide the URL to the circuits templates on GitHub.");
1131
- const hashMatch = template.commitHash.match(commitHashPattern);
1132
- if (!hashMatch || hashMatch.length === 0 || hashMatch.length > 1)
1133
- throw new Error("You should provide a valid commit hash of the circuit templates.");
1134
- // calculate the hash of the r1cs file
1135
- const r1csBlake2bHash = await blake512FromPath(localR1csPath);
1136
- const circuitPrefix = extractPrefix(circuitData.name);
1137
- // filenames
1138
- const doubleDigitsPowers = convertToDoubleDigits(metadata.pot);
1139
- const r1csCompleteFilename = `${circuitData.name}.r1cs`;
1140
- const wasmCompleteFilename = `${circuitData.name}.wasm`;
1141
- const smallestPowersOfTauCompleteFilenameForCircuit = `${potFilenameTemplate}${doubleDigitsPowers}.ptau`;
1142
- const firstZkeyCompleteFilename = `${circuitPrefix}_${genesisZkeyIndex}.zkey`;
1143
- // storage paths
1144
- const r1csStorageFilePath = getR1csStorageFilePath(circuitPrefix, r1csCompleteFilename);
1145
- const wasmStorageFilePath = getWasmStorageFilePath(circuitPrefix, wasmCompleteFilename);
1146
- const potStorageFilePath = getPotStorageFilePath(smallestPowersOfTauCompleteFilenameForCircuit);
1147
- const zkeyStorageFilePath = getZkeyStorageFilePath(circuitPrefix, firstZkeyCompleteFilename);
1148
- const files = {
1149
- potFilename: smallestPowersOfTauCompleteFilenameForCircuit,
1150
- r1csFilename: r1csCompleteFilename,
1151
- wasmFilename: wasmCompleteFilename,
1152
- initialZkeyFilename: firstZkeyCompleteFilename,
1153
- potStoragePath: potStorageFilePath,
1154
- r1csStoragePath: r1csStorageFilePath,
1155
- wasmStoragePath: wasmStorageFilePath,
1156
- initialZkeyStoragePath: zkeyStorageFilePath,
1157
- r1csBlake2bHash: r1csBlake2bHash
1158
- };
1159
- // validate that the compiler hash is a valid hash
1160
- const compiler = circuitData.compiler;
1161
- const compilerHashMatch = compiler.commitHash.match(commitHashPattern);
1162
- if (!compilerHashMatch || compilerHashMatch.length === 0 || compilerHashMatch.length > 1)
1163
- throw new Error("You should provide a valid commit hash of the circuit compiler.");
1164
- // validate that the verification options are valid
1165
- const verification = circuitData.verification;
1166
- if (verification.cfOrVm !== "CF" && verification.cfOrVm !== "VM")
1167
- throw new Error("Please enter a valid verification mechanism: either CF or VM");
1168
- // @todo VM parameters verification
1169
- // if (verification['cfOrVM'] === "VM") {}
1170
- // check that the timeout is provided for the correct configuration
1171
- let dynamicThreshold;
1172
- let fixedTimeWindow;
1173
- let circuit = {};
1174
- if (data.timeoutMechanismType === "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */) {
1175
- if (circuitData.dynamicThreshold <= 0)
1176
- throw new Error("The dynamic threshold should be > 0.");
1177
- dynamicThreshold = circuitData.dynamicThreshold;
1178
- // the Circuit data for the ceremony setup
1179
- circuit = {
1180
- name: circuitData.name,
1181
- description: circuitData.description,
1182
- prefix: circuitPrefix,
1183
- sequencePosition: i + 1,
1184
- metadata: metadata,
1185
- files: files,
1186
- template: template,
1187
- compiler: compiler,
1188
- verification: verification,
1189
- dynamicThreshold: dynamicThreshold,
1190
- avgTimings: {
1191
- contributionComputation: 0,
1192
- fullContribution: 0,
1193
- verifyCloudFunction: 0
1194
- },
1195
- };
1196
- }
1197
- if (data.timeoutMechanismType === "FIXED" /* CeremonyTimeoutType.FIXED */) {
1198
- if (circuitData.fixedTimeWindow <= 0)
1199
- throw new Error("The fixed time window threshold should be > 0.");
1200
- fixedTimeWindow = circuitData.fixedTimeWindow;
1201
- // the Circuit data for the ceremony setup
1202
- circuit = {
1203
- name: circuitData.name,
1204
- description: circuitData.description,
1205
- prefix: circuitPrefix,
1206
- sequencePosition: i + 1,
1207
- metadata: metadata,
1208
- files: files,
1209
- template: template,
1210
- compiler: compiler,
1211
- verification: verification,
1212
- fixedTimeWindow: fixedTimeWindow,
1213
- avgTimings: {
1214
- contributionComputation: 0,
1215
- fullContribution: 0,
1216
- verifyCloudFunction: 0
1217
- },
1218
- };
1219
- }
1220
- circuits.push(circuit);
1221
- // remove the local r1cs download (if used for verifying the config only vs setup)
1222
- if (cleanup)
1223
- fs.unlinkSync(localR1csPath);
1224
- }
1225
- const setupData = {
1226
- ceremonyInputData: {
1227
- title: data.title,
1228
- description: data.description,
1229
- startDate: startDate.valueOf(),
1230
- endDate: endDate.valueOf(),
1231
- timeoutMechanismType: data.timeoutMechanismType,
1232
- penalty: data.penalty
1233
- },
1234
- ceremonyPrefix: extractPrefix(data.title),
1235
- circuits: circuits,
1236
- circuitArtifacts: circuitArtifacts
1237
- };
1238
- return setupData;
1239
- }
1240
- catch (error) {
1241
- throw new Error(`Error while parsing up the ceremony setup file. ${error.message}`);
1242
- }
1243
- };
1078
+ const convertToDoubleDigits = (amount) => (amount < 10 ? `0${amount}` : amount.toString());
1079
+ /**
1080
+ * Extract a prefix consisting of alphanumeric and underscore characters from a string with arbitrary characters.
1081
+ * @dev replaces all special symbols and whitespaces with an underscore char ('_'). Convert all uppercase chars to lowercase.
1082
+ * @notice example: str = 'Multiplier-2!2.4.zkey'; output prefix = 'multiplier_2_2_4.zkey'.
1083
+ * NB. Prefix extraction is a key process that conditions the name of the ceremony artifacts, download/upload from/to storage, collections paths.
1084
+ * @param str <string> - the arbitrary string from which to extract the prefix.
1085
+ * @returns <string> - the resulting prefix.
1086
+ */
1087
+ const extractPrefix = (str) =>
1088
+ // eslint-disable-next-line no-useless-escape
1089
+ str.replace(/[`\s~!@#$%^&*()|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, "-").toLowerCase();
1244
1090
  /**
1245
1091
  * Extract data from a R1CS metadata file generated with a custom file-based logger.
1246
1092
  * @notice useful for extracting metadata circuits contained in the generated file using a logger
@@ -1297,17 +1143,6 @@ const formatZkeyIndex = (progress) => {
1297
1143
  * @returns <number> - the amount of powers.
1298
1144
  */
1299
1145
  const extractPoTFromFilename = (potCompleteFilename) => Number(potCompleteFilename.split("_").pop()?.split(".").at(0));
1300
- /**
1301
- * Extract a prefix consisting of alphanumeric and underscore characters from a string with arbitrary characters.
1302
- * @dev replaces all special symbols and whitespaces with an underscore char ('_'). Convert all uppercase chars to lowercase.
1303
- * @notice example: str = 'Multiplier-2!2.4.zkey'; output prefix = 'multiplier_2_2_4.zkey'.
1304
- * NB. Prefix extraction is a key process that conditions the name of the ceremony artifacts, download/upload from/to storage, collections paths.
1305
- * @param str <string> - the arbitrary string from which to extract the prefix.
1306
- * @returns <string> - the resulting prefix.
1307
- */
1308
- const extractPrefix = (str) =>
1309
- // eslint-disable-next-line no-useless-escape
1310
- str.replace(/[`\s~!@#$%^&*()|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, "-").toLowerCase();
1311
1146
  /**
1312
1147
  * Automate the generation of an entropy for a contribution.
1313
1148
  * @dev Took inspiration from here https://github.com/glamperd/setup-mpc-ui/blob/master/client/src/state/Compute.tsx#L112.
@@ -1374,7 +1209,9 @@ const getContributionsValidityForContributor = async (firestoreDatabase, circuit
1374
1209
  * @param isFinalizing <boolean> - true when the coordinator is finalizing the ceremony, otherwise false.
1375
1210
  * @returns <string> - the public attestation preamble.
1376
1211
  */
1377
- const getPublicAttestationPreambleForContributor = (contributorIdentifier, ceremonyName, isFinalizing) => `Hey, I'm ${contributorIdentifier} and I have ${isFinalizing ? "finalized" : "contributed to"} the ${ceremonyName} MPC Phase2 Trusted Setup ceremony.\nThe following are my contribution signatures:`;
1212
+ const getPublicAttestationPreambleForContributor = (contributorIdentifier, ceremonyName, isFinalizing) => `Hey, I'm ${contributorIdentifier} and I have ${isFinalizing ? "finalized" : "contributed to"} the ${ceremonyName}${ceremonyName.toLowerCase().includes("trusted setup") || ceremonyName.toLowerCase().includes("ceremony")
1213
+ ? "."
1214
+ : " MPC Phase2 Trusted Setup ceremony."}\nThe following are my contribution signatures:`;
1378
1215
  /**
1379
1216
  * Check and prepare public attestation for the contributor made only of its valid contributions.
1380
1217
  * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
@@ -1445,6 +1282,41 @@ const readBytesFromFile = (localFilePath, offset, length, position) => {
1445
1282
  // Return the read bytes.
1446
1283
  return buffer;
1447
1284
  };
1285
+ /**
1286
+ * Given a buffer in little endian format, convert it to bigint
1287
+ * @param buffer
1288
+ * @returns
1289
+ */
1290
+ function leBufferToBigint(buffer) {
1291
+ return BigInt(`0x${buffer.reverse().toString("hex")}`);
1292
+ }
1293
+ /**
1294
+ * Given an input containing string values, convert them
1295
+ * to bigint
1296
+ * @param input - The input to convert
1297
+ * @returns the input with string values converted to bigint
1298
+ */
1299
+ const unstringifyBigInts = (input) => {
1300
+ if (typeof input === "string" && /^[0-9]+$/.test(input)) {
1301
+ return BigInt(input);
1302
+ }
1303
+ if (typeof input === "string" && /^0x[0-9a-fA-F]+$/.test(input)) {
1304
+ return BigInt(input);
1305
+ }
1306
+ if (Array.isArray(input)) {
1307
+ return input.map(unstringifyBigInts);
1308
+ }
1309
+ if (input === null) {
1310
+ return null;
1311
+ }
1312
+ if (typeof input === "object") {
1313
+ return Object.entries(input).reduce((acc, [key, value]) => {
1314
+ acc[key] = unstringifyBigInts(value);
1315
+ return acc;
1316
+ }, {});
1317
+ }
1318
+ return input;
1319
+ };
1448
1320
  /**
1449
1321
  * Return the info about the R1CS file.ù
1450
1322
  * @dev this method was built taking inspiration from
@@ -1505,17 +1377,17 @@ const getR1CSInfo = (localR1CSFilePath) => {
1505
1377
  let constraints = 0;
1506
1378
  try {
1507
1379
  // Get 'number of section' (jump magic r1cs and version1 data).
1508
- const numberOfSections = ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, 8));
1380
+ const numberOfSections = leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, 8));
1509
1381
  // Jump to first section.
1510
1382
  pointer = 12;
1511
1383
  // For each section
1512
1384
  for (let i = 0; i < numberOfSections; i++) {
1513
1385
  // Read section type.
1514
- const sectionType = ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer));
1386
+ const sectionType = leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer));
1515
1387
  // Jump to section size.
1516
1388
  pointer += 4;
1517
1389
  // Read section size
1518
- const sectionSize = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
1390
+ const sectionSize = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
1519
1391
  // If at header section (0x00000001 : Header Section).
1520
1392
  if (sectionType === BigInt(1)) {
1521
1393
  // Read info from header section.
@@ -1547,22 +1419,22 @@ const getR1CSInfo = (localR1CSFilePath) => {
1547
1419
  */
1548
1420
  pointer += sectionSize - 20;
1549
1421
  // Read R1CS info.
1550
- wires = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1422
+ wires = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1551
1423
  pointer += 4;
1552
- publicOutputs = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1424
+ publicOutputs = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1553
1425
  pointer += 4;
1554
- publicInputs = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1426
+ publicInputs = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1555
1427
  pointer += 4;
1556
- privateInputs = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1428
+ privateInputs = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1557
1429
  pointer += 4;
1558
- labels = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
1430
+ labels = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
1559
1431
  pointer += 8;
1560
- constraints = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1432
+ constraints = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
1561
1433
  }
1562
1434
  pointer += 8 + Number(sectionSize);
1563
1435
  }
1564
1436
  return {
1565
- curve: "bn-128",
1437
+ curve: "bn-128", /// @note currently default to bn-128 as we support only Groth16 proving system.
1566
1438
  wires,
1567
1439
  constraints,
1568
1440
  privateInputs,
@@ -1577,11 +1449,194 @@ const getR1CSInfo = (localR1CSFilePath) => {
1577
1449
  }
1578
1450
  };
1579
1451
  /**
1580
- * Return a string with double digits if the provided input is one digit only.
1581
- * @param in <number> - the input number to be converted.
1582
- * @returns <string> - the two digits stringified number derived from the conversion.
1452
+ * Parse and validate that the ceremony configuration is correct
1453
+ * @notice this does not upload any files to storage
1454
+ * @param path <string> - the path to the configuration file
1455
+ * @param cleanup <boolean> - whether to delete the r1cs file after parsing
1456
+ * @returns any - the data to pass to the cloud function for setup and the circuit artifacts
1583
1457
  */
1584
- const convertToDoubleDigits = (amount) => (amount < 10 ? `0${amount}` : amount.toString());
1458
+ const parseCeremonyFile = async (path, cleanup = false) => {
1459
+ // check that the path exists
1460
+ if (!fs.existsSync(path))
1461
+ throw new Error("The provided path to the configuration file does not exist. Please provide an absolute path and try again.");
1462
+ try {
1463
+ // read the data
1464
+ const data = JSON.parse(fs.readFileSync(path).toString());
1465
+ // verify that the data is correct
1466
+ if (data.timeoutMechanismType !== "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */ &&
1467
+ data.timeoutMechanismType !== "FIXED" /* CeremonyTimeoutType.FIXED */)
1468
+ throw new Error("Invalid timeout type. Please choose between DYNAMIC and FIXED.");
1469
+ // validate that we have at least 1 circuit input data
1470
+ if (!data.circuits || data.circuits.length === 0)
1471
+ throw new Error("You need to provide the data for at least 1 circuit.");
1472
+ // validate that the end date is in the future
1473
+ let endDate;
1474
+ let startDate;
1475
+ try {
1476
+ endDate = new Date(data.endDate);
1477
+ startDate = new Date(data.startDate);
1478
+ }
1479
+ catch (error) {
1480
+ throw new Error("The dates should follow this format: 2023-07-04T00:00:00.");
1481
+ }
1482
+ if (endDate <= startDate)
1483
+ throw new Error("The end date should be greater than the start date.");
1484
+ const currentDate = new Date();
1485
+ if (endDate <= currentDate || startDate <= currentDate)
1486
+ throw new Error("The start and end dates should be in the future.");
1487
+ // validate penalty
1488
+ if (data.penalty <= 0)
1489
+ throw new Error("The penalty should be greater than zero.");
1490
+ const circuits = [];
1491
+ const urlPattern = /(https?:\/\/[^\s]+)/g;
1492
+ const commitHashPattern = /^[a-f0-9]{40}$/i;
1493
+ const circuitArtifacts = [];
1494
+ for (let i = 0; i < data.circuits.length; i++) {
1495
+ const circuitData = data.circuits[i];
1496
+ const { artifacts } = circuitData;
1497
+ circuitArtifacts.push({
1498
+ artifacts
1499
+ });
1500
+ // where we storing the r1cs downloaded
1501
+ const localR1csPath = `./${circuitData.name}.r1cs`;
1502
+ // where we storing the wasm downloaded
1503
+ const localWasmPath = `./${circuitData.name}.wasm`;
1504
+ // download the r1cs to extract the metadata
1505
+ const streamPipeline = util.promisify(stream.pipeline);
1506
+ // Make the call.
1507
+ const responseR1CS = await fetch(artifacts.r1csStoragePath);
1508
+ // Handle errors.
1509
+ if (!responseR1CS.ok && responseR1CS.status !== 200)
1510
+ throw new Error(`There was an error while trying to download the r1cs file for circuit ${circuitData.name}. Please check that the file has the correct permissions (public) set.`);
1511
+ await streamPipeline(responseR1CS.body, fs.createWriteStream(localR1csPath));
1512
+ // Write the file locally
1513
+ // extract the metadata from the r1cs
1514
+ const metadata = getR1CSInfo(localR1csPath);
1515
+ // download wasm too to ensure it's available
1516
+ const responseWASM = await fetch(artifacts.wasmStoragePath);
1517
+ if (!responseWASM.ok && responseWASM.status !== 200)
1518
+ throw new Error(`There was an error while trying to download the WASM file for circuit ${circuitData.name}. Please check that the file has the correct permissions (public) set.`);
1519
+ await streamPipeline(responseWASM.body, fs.createWriteStream(localWasmPath));
1520
+ // validate that the circuit hash and template links are valid
1521
+ const { template } = circuitData;
1522
+ const URLMatch = template.source.match(urlPattern);
1523
+ if (!URLMatch || URLMatch.length === 0 || URLMatch.length > 1)
1524
+ throw new Error("You should provide the URL to the circuits templates on GitHub.");
1525
+ const hashMatch = template.commitHash.match(commitHashPattern);
1526
+ if (!hashMatch || hashMatch.length === 0 || hashMatch.length > 1)
1527
+ throw new Error("You should provide a valid commit hash of the circuit templates.");
1528
+ // calculate the hash of the r1cs file
1529
+ const r1csBlake2bHash = await blake512FromPath(localR1csPath);
1530
+ const circuitPrefix = extractPrefix(circuitData.name);
1531
+ // filenames
1532
+ const doubleDigitsPowers = convertToDoubleDigits(metadata.pot);
1533
+ const r1csCompleteFilename = `${circuitData.name}.r1cs`;
1534
+ const wasmCompleteFilename = `${circuitData.name}.wasm`;
1535
+ const smallestPowersOfTauCompleteFilenameForCircuit = `${potFilenameTemplate}${doubleDigitsPowers}.ptau`;
1536
+ const firstZkeyCompleteFilename = `${circuitPrefix}_${genesisZkeyIndex}.zkey`;
1537
+ // storage paths
1538
+ const r1csStorageFilePath = getR1csStorageFilePath(circuitPrefix, r1csCompleteFilename);
1539
+ const wasmStorageFilePath = getWasmStorageFilePath(circuitPrefix, wasmCompleteFilename);
1540
+ const potStorageFilePath = getPotStorageFilePath(smallestPowersOfTauCompleteFilenameForCircuit);
1541
+ const zkeyStorageFilePath = getZkeyStorageFilePath(circuitPrefix, firstZkeyCompleteFilename);
1542
+ const files = {
1543
+ potFilename: smallestPowersOfTauCompleteFilenameForCircuit,
1544
+ r1csFilename: r1csCompleteFilename,
1545
+ wasmFilename: wasmCompleteFilename,
1546
+ initialZkeyFilename: firstZkeyCompleteFilename,
1547
+ potStoragePath: potStorageFilePath,
1548
+ r1csStoragePath: r1csStorageFilePath,
1549
+ wasmStoragePath: wasmStorageFilePath,
1550
+ initialZkeyStoragePath: zkeyStorageFilePath,
1551
+ r1csBlake2bHash
1552
+ };
1553
+ // validate that the compiler hash is a valid hash
1554
+ const { compiler } = circuitData;
1555
+ const compilerHashMatch = compiler.commitHash.match(commitHashPattern);
1556
+ if (!compilerHashMatch || compilerHashMatch.length === 0 || compilerHashMatch.length > 1)
1557
+ throw new Error("You should provide a valid commit hash of the circuit compiler.");
1558
+ // validate that the verification options are valid
1559
+ const { verification } = circuitData;
1560
+ if (verification.cfOrVm !== "CF" && verification.cfOrVm !== "VM")
1561
+ throw new Error("Please enter a valid verification mechanism: either CF or VM");
1562
+ // @todo VM parameters verification
1563
+ // if (verification['cfOrVM'] === "VM") {}
1564
+ // check that the timeout is provided for the correct configuration
1565
+ let dynamicThreshold;
1566
+ let fixedTimeWindow;
1567
+ let circuit = {};
1568
+ if (data.timeoutMechanismType === "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */) {
1569
+ if (circuitData.dynamicThreshold <= 0)
1570
+ throw new Error("The dynamic threshold should be > 0.");
1571
+ dynamicThreshold = circuitData.dynamicThreshold;
1572
+ // the Circuit data for the ceremony setup
1573
+ circuit = {
1574
+ name: circuitData.name,
1575
+ description: circuitData.description,
1576
+ prefix: circuitPrefix,
1577
+ sequencePosition: i + 1,
1578
+ metadata,
1579
+ files,
1580
+ template,
1581
+ compiler,
1582
+ verification,
1583
+ dynamicThreshold,
1584
+ avgTimings: {
1585
+ contributionComputation: 0,
1586
+ fullContribution: 0,
1587
+ verifyCloudFunction: 0
1588
+ }
1589
+ };
1590
+ }
1591
+ if (data.timeoutMechanismType === "FIXED" /* CeremonyTimeoutType.FIXED */) {
1592
+ if (circuitData.fixedTimeWindow <= 0)
1593
+ throw new Error("The fixed time window threshold should be > 0.");
1594
+ fixedTimeWindow = circuitData.fixedTimeWindow;
1595
+ // the Circuit data for the ceremony setup
1596
+ circuit = {
1597
+ name: circuitData.name,
1598
+ description: circuitData.description,
1599
+ prefix: circuitPrefix,
1600
+ sequencePosition: i + 1,
1601
+ metadata,
1602
+ files,
1603
+ template,
1604
+ compiler,
1605
+ verification,
1606
+ fixedTimeWindow,
1607
+ avgTimings: {
1608
+ contributionComputation: 0,
1609
+ fullContribution: 0,
1610
+ verifyCloudFunction: 0
1611
+ }
1612
+ };
1613
+ }
1614
+ circuits.push(circuit);
1615
+ // remove the local r1cs and wasm downloads (if used for verifying the config only vs setup)
1616
+ if (cleanup) {
1617
+ fs.unlinkSync(localR1csPath);
1618
+ fs.unlinkSync(localWasmPath);
1619
+ }
1620
+ }
1621
+ const setupData = {
1622
+ ceremonyInputData: {
1623
+ title: data.title,
1624
+ description: data.description,
1625
+ startDate: startDate.valueOf(),
1626
+ endDate: endDate.valueOf(),
1627
+ timeoutMechanismType: data.timeoutMechanismType,
1628
+ penalty: data.penalty
1629
+ },
1630
+ ceremonyPrefix: extractPrefix(data.title),
1631
+ circuits,
1632
+ circuitArtifacts
1633
+ };
1634
+ return setupData;
1635
+ }
1636
+ catch (error) {
1637
+ throw new Error(`Error while parsing up the ceremony setup file. ${error.message}`);
1638
+ }
1639
+ };
1585
1640
 
1586
1641
  /**
1587
1642
  * Verify that a zKey is valid
@@ -1830,7 +1885,7 @@ const getFirestoreDatabase = (app) => firestore.getFirestore(app);
1830
1885
  * @param app <FirebaseApp> - the Firebase application.
1831
1886
  * @returns <Functions> - the Cloud Functions associated to the application.
1832
1887
  */
1833
- const getFirebaseFunctions = (app) => functions.getFunctions(app, 'europe-west1');
1888
+ const getFirebaseFunctions = (app) => functions.getFunctions(app, "europe-west1");
1834
1889
  /**
1835
1890
  * Retrieve the configuration variables for the AWS services (S3, EC2).
1836
1891
  * @returns <AWSVariables> - the values of the AWS services configuration variables.
@@ -1839,14 +1894,14 @@ const getAWSVariables = () => {
1839
1894
  if (!process.env.AWS_ACCESS_KEY_ID ||
1840
1895
  !process.env.AWS_SECRET_ACCESS_KEY ||
1841
1896
  !process.env.AWS_REGION ||
1842
- !process.env.AWS_ROLE_ARN ||
1897
+ !process.env.AWS_INSTANCE_PROFILE_ARN ||
1843
1898
  !process.env.AWS_AMI_ID)
1844
1899
  throw new Error("Could not retrieve the AWS environment variables. Please, verify your environment configuration and retry");
1845
1900
  return {
1846
1901
  accessKeyId: process.env.AWS_ACCESS_KEY_ID,
1847
1902
  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
1848
1903
  region: process.env.AWS_REGION || "us-east-1",
1849
- roleArn: process.env.AWS_ROLE_ARN,
1904
+ instanceProfileArn: process.env.AWS_INSTANCE_PROFILE_ARN,
1850
1905
  amiId: process.env.AWS_AMI_ID
1851
1906
  };
1852
1907
  };
@@ -1927,11 +1982,11 @@ const p256 = (proofPart) => {
1927
1982
  */
1928
1983
  const formatSolidityCalldata = (circuitInput, _proof) => {
1929
1984
  try {
1930
- const proof = ffjavascript.utils.unstringifyBigInts(_proof);
1985
+ const proof = unstringifyBigInts(_proof);
1931
1986
  // format the public inputs to the circuit
1932
1987
  const formattedCircuitInput = [];
1933
1988
  for (const cInput of circuitInput) {
1934
- formattedCircuitInput.push(p256(ffjavascript.utils.unstringifyBigInts(cInput)));
1989
+ formattedCircuitInput.push(p256(unstringifyBigInts(cInput)));
1935
1990
  }
1936
1991
  // construct calldata
1937
1992
  const calldata = {
@@ -2081,55 +2136,28 @@ const verifyCeremony = async (functions, firestore$1, ceremonyPrefix, outputDire
2081
2136
  };
2082
2137
 
2083
2138
  /**
2084
- * This function will return the number of public repos of a user
2085
- * @param user <string> The username of the user
2086
- * @returns <number> The number of public repos
2087
- */
2088
- const getNumberOfPublicReposGitHub = async (user) => {
2089
- const response = await fetch(`https://api.github.com/user/${user}/repos`, {
2090
- method: "GET",
2091
- headers: {
2092
- Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
2093
- }
2094
- });
2095
- if (response.status !== 200)
2096
- throw new Error("It was not possible to retrieve the number of public repositories. Please try again.");
2097
- const jsonData = await response.json();
2098
- return jsonData.length;
2099
- };
2100
- /**
2101
- * This function will return the number of followers of a user
2102
- * @param user <string> The username of the user
2103
- * @returns <number> The number of followers
2139
+ * This function queries the GitHub API to fetch users statistics
2140
+ * @param user {string} the user uid
2141
+ * @returns {any} the stats from the GitHub API
2104
2142
  */
2105
- const getNumberOfFollowersGitHub = async (user) => {
2106
- const response = await fetch(`https://api.github.com/user/${user}/followers`, {
2143
+ const getGitHubStats = async (user) => {
2144
+ const response = await fetch(`https://api.github.com/user/${user}`, {
2107
2145
  method: "GET",
2108
2146
  headers: {
2109
2147
  Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
2110
2148
  }
2111
2149
  });
2112
2150
  if (response.status !== 200)
2113
- throw new Error("It was not possible to retrieve the number of followers. Please try again.");
2151
+ throw new Error("It was not possible to retrieve the user's statistic. Please try again.");
2114
2152
  const jsonData = await response.json();
2115
- return jsonData.length;
2116
- };
2117
- /**
2118
- * This function will return the number of following of a user
2119
- * @param user <string> The username of the user
2120
- * @returns <number> The number of following users
2121
- */
2122
- const getNumberOfFollowingGitHub = async (user) => {
2123
- const response = await fetch(`https://api.github.com/user/${user}/following`, {
2124
- method: "GET",
2125
- headers: {
2126
- Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
2127
- }
2128
- });
2129
- if (response.status !== 200)
2130
- throw new Error("It was not possible to retrieve the number of following. Please try again.");
2131
- const jsonData = await response.json();
2132
- return jsonData.length;
2153
+ const data = {
2154
+ following: jsonData.following,
2155
+ followers: jsonData.followers,
2156
+ publicRepos: jsonData.public_repos,
2157
+ avatarUrl: jsonData.avatar_url,
2158
+ age: jsonData.created_at
2159
+ };
2160
+ return data;
2133
2161
  };
2134
2162
  /**
2135
2163
  * This function will check if the user is reputable enough to be able to use the app
@@ -2137,19 +2165,24 @@ const getNumberOfFollowingGitHub = async (user) => {
2137
2165
  * @param minimumAmountOfFollowing <number> The minimum amount of following the user should have
2138
2166
  * @param minimumAmountOfFollowers <number> The minimum amount of followers the user should have
2139
2167
  * @param minimumAmountOfPublicRepos <number> The minimum amount of public repos the user should have
2140
- * @returns <boolean> True if the user is reputable enough, false otherwise
2168
+ * @returns <any> Return the avatar URL of the user if the user is reputable, false otherwise
2141
2169
  */
2142
- const githubReputation = async (userLogin, minimumAmountOfFollowing, minimumAmountOfFollowers, minimumAmountOfPublicRepos) => {
2170
+ const githubReputation = async (userLogin, minimumAmountOfFollowing, minimumAmountOfFollowers, minimumAmountOfPublicRepos, minimumAge) => {
2143
2171
  if (!process.env.GITHUB_ACCESS_TOKEN)
2144
2172
  throw new Error("The GitHub access token is missing. Please insert a valid token to be used for anti-sybil checks on user registation, and then try again.");
2145
- const following = await getNumberOfFollowingGitHub(userLogin);
2146
- const repos = await getNumberOfPublicReposGitHub(userLogin);
2147
- const followers = await getNumberOfFollowersGitHub(userLogin);
2173
+ const { following, followers, publicRepos, avatarUrl, age } = await getGitHubStats(userLogin);
2148
2174
  if (following < minimumAmountOfFollowing ||
2149
- repos < minimumAmountOfPublicRepos ||
2150
- followers < minimumAmountOfFollowers)
2151
- return false;
2152
- return true;
2175
+ publicRepos < minimumAmountOfPublicRepos ||
2176
+ followers < minimumAmountOfFollowers ||
2177
+ new Date(age) > new Date(Date.now() - minimumAge))
2178
+ return {
2179
+ reputable: false,
2180
+ avatarUrl: ""
2181
+ };
2182
+ return {
2183
+ reputable: true,
2184
+ avatarUrl
2185
+ };
2153
2186
  };
2154
2187
 
2155
2188
  /**
@@ -2335,8 +2368,8 @@ const createSSMClient = async () => {
2335
2368
  * @returns <Array<string>> - the list of startup commands to be executed.
2336
2369
  */
2337
2370
  const vmBootstrapCommand = (bucketName) => [
2338
- "#!/bin/bash",
2339
- `aws s3 cp s3://${bucketName}/${vmBootstrapScriptFilename} ${vmBootstrapScriptFilename}`,
2371
+ "#!/bin/bash", // shabang.
2372
+ `aws s3 cp s3://${bucketName}/${vmBootstrapScriptFilename} ${vmBootstrapScriptFilename}`, // copy file from S3 bucket to VM.
2340
2373
  `chmod +x ${vmBootstrapScriptFilename} && bash ${vmBootstrapScriptFilename}` // grant permission and execute.
2341
2374
  ];
2342
2375
  /**
@@ -2357,8 +2390,13 @@ const vmDependenciesAndCacheArtifactsCommand = (zKeyPath, potPath, snsTopic, reg
2357
2390
  // eslint-disable-next-line no-template-curly-in-string
2358
2391
  "touch ${MARKER_FILE}",
2359
2392
  "sudo yum update -y",
2360
- "curl -sL https://rpm.nodesource.com/setup_16.x | sudo bash - ",
2361
- "sudo yum install -y nodejs",
2393
+ "curl -O https://nodejs.org/dist/v16.13.0/node-v16.13.0-linux-x64.tar.xz",
2394
+ "tar -xf node-v16.13.0-linux-x64.tar.xz",
2395
+ "mv node-v16.13.0-linux-x64 nodejs",
2396
+ "sudo mv nodejs /opt/",
2397
+ "echo 'export NODEJS_HOME=/opt/nodejs' >> /etc/profile",
2398
+ "echo 'export PATH=$NODEJS_HOME/bin:$PATH' >> /etc/profile",
2399
+ "source /etc/profile",
2362
2400
  "npm install -g snarkjs",
2363
2401
  `aws s3 cp s3://${zKeyPath} /var/tmp/genesisZkey.zkey`,
2364
2402
  `aws s3 cp s3://${potPath} /var/tmp/pot.ptau`,
@@ -2377,6 +2415,7 @@ const vmDependenciesAndCacheArtifactsCommand = (zKeyPath, potPath, snsTopic, reg
2377
2415
  * @returns Array<string> - the list of commands for contribution verification.
2378
2416
  */
2379
2417
  const vmContributionVerificationCommand = (bucketName, lastZkeyStoragePath, verificationTranscriptStoragePathAndFilename) => [
2418
+ `source /etc/profile`,
2380
2419
  `aws s3 cp s3://${bucketName}/${lastZkeyStoragePath} /var/tmp/lastZKey.zkey > /var/tmp/log.txt`,
2381
2420
  `snarkjs zkvi /var/tmp/genesisZkey.zkey /var/tmp/pot.ptau /var/tmp/lastZKey.zkey > /var/tmp/verification_transcript.log`,
2382
2421
  `aws s3 cp /var/tmp/verification_transcript.log s3://${bucketName}/${verificationTranscriptStoragePathAndFilename} &>/dev/null`,
@@ -2403,7 +2442,7 @@ const computeDiskSizeForVM = (zKeySizeInBytes, pot) => Math.ceil(2 * convertByte
2403
2442
  */
2404
2443
  const createEC2Instance = async (ec2, commands, instanceType, volumeSize, diskType) => {
2405
2444
  // Get the AWS variables.
2406
- const { amiId, roleArn } = getAWSVariables();
2445
+ const { amiId, instanceProfileArn } = getAWSVariables();
2407
2446
  // Parametrize the VM EC2 instance.
2408
2447
  const params = {
2409
2448
  ImageId: amiId,
@@ -2412,7 +2451,7 @@ const createEC2Instance = async (ec2, commands, instanceType, volumeSize, diskTy
2412
2451
  MinCount: 1,
2413
2452
  // nb. to find this: iam -> roles -> role_name.
2414
2453
  IamInstanceProfile: {
2415
- Arn: roleArn
2454
+ Arn: instanceProfileArn
2416
2455
  },
2417
2456
  // nb. for running commands at the startup.
2418
2457
  UserData: Buffer.from(commands.join("\n")).toString("base64"),
@@ -2421,7 +2460,7 @@ const createEC2Instance = async (ec2, commands, instanceType, volumeSize, diskTy
2421
2460
  DeviceName: "/dev/xvda",
2422
2461
  Ebs: {
2423
2462
  DeleteOnTermination: true,
2424
- VolumeSize: volumeSize,
2463
+ VolumeSize: volumeSize, // disk size in GB.
2425
2464
  VolumeType: diskType
2426
2465
  }
2427
2466
  }
@@ -2621,6 +2660,7 @@ exports.completeMultiPartUpload = completeMultiPartUpload;
2621
2660
  exports.computeDiskSizeForVM = computeDiskSizeForVM;
2622
2661
  exports.computeSHA256ToHex = computeSHA256ToHex;
2623
2662
  exports.computeSmallestPowersOfTauForCircuit = computeSmallestPowersOfTauForCircuit;
2663
+ exports.contribHashRegex = contribHashRegex;
2624
2664
  exports.convertBytesOrKbToGb = convertBytesOrKbToGb;
2625
2665
  exports.convertToDoubleDigits = convertToDoubleDigits;
2626
2666
  exports.createCustomLoggerForFile = createCustomLoggerForFile;
@@ -2649,6 +2689,7 @@ exports.generatePreSignedUrlsParts = generatePreSignedUrlsParts;
2649
2689
  exports.generateValidContributionsAttestation = generateValidContributionsAttestation;
2650
2690
  exports.generateZkeyFromScratch = generateZkeyFromScratch;
2651
2691
  exports.genesisZkeyIndex = genesisZkeyIndex;
2692
+ exports.getAllCeremonies = getAllCeremonies;
2652
2693
  exports.getAllCollectionDocs = getAllCollectionDocs;
2653
2694
  exports.getBucketName = getBucketName;
2654
2695
  exports.getCeremonyCircuits = getCeremonyCircuits;