@devtion/actions 0.0.0-7e983e3 → 0.0.0-8bb9489

package/README.md

@@ -67,7 +67,7 @@ yarn add @p0tion/actions
 
 ### Local Development
 
-**Prerequisities**
+**Prerequisites**
 
 -   Node.js version 16.0 or higher.
 -   Yarn version 3.5.0 or higher.

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /**
  * @module @p0tion/actions
- * @version 1.0.5
+ * @version 1.0.9
  * @file A set of actions and helpers for CLI commands
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -17,8 +17,7 @@ import crypto from 'crypto';
 import blake from 'blakejs';
 import { utils } from 'ffjavascript';
 import winston from 'winston';
-import { S3Client, HeadObjectCommand, GetObjectCommand } from '@aws-sdk/client-s3';
-import { pipeline, Readable } from 'stream';
+import { pipeline } from 'stream';
 import { promisify } from 'util';
 import { initializeApp } from 'firebase/app';
 import { signInWithCredential, initializeAuth, getAuth } from 'firebase/auth';
@@ -244,6 +243,12 @@ const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {
@@ -334,7 +339,7 @@ const commonTerms = {
         finalizeCircuit: "finalizeCircuit",
         finalizeCeremony: "finalizeCeremony",
         downloadCircuitArtifacts: "downloadCircuitArtifacts",
-        transferObject: "transferObject",
+        transferObject: "transferObject"
     }
 };
 
@@ -685,11 +690,15 @@ const getChunksAndPreSignedUrls = async (cloudFunctions, bucketName, objectKey,
  * @param cloudFunctions <Functions> - the Firebase Cloud Functions service instance.
  * @param ceremonyId <string> - the unique identifier of the ceremony.
  * @param alreadyUploadedChunks Array<ETagWithPartNumber> - the temporary information about the already uploaded chunks.
+ * @param logger <GenericBar> - an optional logger to show progress.
  * @returns <Promise<Array<ETagWithPartNumber>>> - the completed (uploaded) chunks information.
  */
-const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremonyId, alreadyUploadedChunks) => {
+const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremonyId, alreadyUploadedChunks, logger) => {
     // Keep track of uploaded chunks.
     const uploadedChunks = alreadyUploadedChunks || [];
+    // if we were passed a logger, start it
+    if (logger)
+        logger.start(chunksWithUrls.length, 0);
     // Loop through remaining chunks.
     for (let i = alreadyUploadedChunks ? alreadyUploadedChunks.length : 0; i < chunksWithUrls.length; i += 1) {
         // Consume the pre-signed url to upload the chunk.
@@ -721,6 +730,9 @@ const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremony
         // nb. this must be done only when contributing (not finalizing).
         if (!!ceremonyId && !!cloudFunctions)
             await temporaryStoreCurrentContributionUploadedChunkData(cloudFunctions, ceremonyId, chunk);
+        // increment the count on the logger
+        if (logger)
+            logger.increment();
     }
     return uploadedChunks;
 };
@@ -741,8 +753,9 @@ const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremony
  * @param configStreamChunkSize <number> - size of each chunk into which the artifact is going to be splitted (nb. will be converted in MB).
  * @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).
  * @param [temporaryDataToResumeMultiPartUpload] <TemporaryParticipantContributionData> - the temporary information necessary to resume an already started multi-part upload.
+ * @param logger <GenericBar> - an optional logger to show progress.
  */
-const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFilePath, configStreamChunkSize, ceremonyId, temporaryDataToResumeMultiPartUpload) => {
+const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFilePath, configStreamChunkSize, ceremonyId, temporaryDataToResumeMultiPartUpload, logger) => {
     // The unique identifier of the multi-part upload.
     let multiPartUploadId = "";
     // The list of already uploaded chunks.
@@ -766,7 +779,7 @@ const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFileP
     const chunksWithUrlsZkey = await getChunksAndPreSignedUrls(cloudFunctions, bucketName, objectKey, localFilePath, multiPartUploadId, configStreamChunkSize, ceremonyId);
     // Step (2).
     const partNumbersAndETagsZkey = await uploadParts(chunksWithUrlsZkey, mime.lookup(localFilePath), // content-type.
-    cloudFunctions, ceremonyId, alreadyUploadedChunks);
+    cloudFunctions, ceremonyId, alreadyUploadedChunks, logger);
     // Step (3).
     await completeMultiPartUpload(cloudFunctions, bucketName, objectKey, multiPartUploadId, partNumbersAndETagsZkey, ceremonyId);
 };
@@ -1052,7 +1065,8 @@ const parseCeremonyFile = async (path, cleanup = false) => {
         // read the data
         const data = JSON.parse(fs.readFileSync(path).toString());
         // verify that the data is correct
-        if (data['timeoutMechanismType'] !== "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */ && data['timeoutMechanismType'] !== "FIXED" /* CeremonyTimeoutType.FIXED */)
+        if (data["timeoutMechanismType"] !== "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */ &&
+            data["timeoutMechanismType"] !== "FIXED" /* CeremonyTimeoutType.FIXED */)
             throw new Error("Invalid timeout type. Please choose between DYNAMIC and FIXED.");
         // validate that we have at least 1 circuit input data
         if (!data.circuits || data.circuits.length === 0)
@@ -1085,42 +1099,26 @@ const parseCeremonyFile = async (path, cleanup = false) => {
             circuitArtifacts.push({
                 artifacts: artifacts
             });
-            const r1csPath = artifacts.r1csStoragePath;
-            const wasmPath = artifacts.wasmStoragePath;
             // where we storing the r1cs downloaded
             const localR1csPath = `./${circuitData.name}.r1cs`;
-            // check that the artifacts exist in S3
-            // we don't need any privileges to download this
-            // just the correct region
-            const s3 = new S3Client({ region: artifacts.region });
-            try {
-                await s3.send(new HeadObjectCommand({
-                    Bucket: artifacts.bucket,
-                    Key: r1csPath
-                }));
-            }
-            catch (error) {
-                throw new Error(`The r1cs file (${r1csPath}) seems to not exist. Please ensure this is correct and that the object is publicly available.`);
-            }
-            try {
-                await s3.send(new HeadObjectCommand({
-                    Bucket: artifacts.bucket,
-                    Key: wasmPath
-                }));
-            }
-            catch (error) {
-                throw new Error(`The wasm file (${wasmPath}) seems to not exist. Please ensure this is correct and that the object is publicly available.`);
-            }
+            // where we storing the wasm downloaded
+            const localWasmPath = `./${circuitData.name}.wasm`;
             // download the r1cs to extract the metadata
-            const command = new GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.r1csStoragePath });
-            const response = await s3.send(command);
             const streamPipeline = promisify(pipeline);
-            if (response.$metadata.httpStatusCode !== 200)
-                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.");
-            if (response.Body instanceof Readable)
-                await streamPipeline(response.Body, fs.createWriteStream(localR1csPath));
+            // Make the call.
+            const responseR1CS = await fetch(artifacts.r1csStoragePath);
+            // Handle errors.
+            if (!responseR1CS.ok && responseR1CS.status !== 200)
+                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.`);
+            await streamPipeline(responseR1CS.body, createWriteStream(localR1csPath));
+            // Write the file locally
             // extract the metadata from the r1cs
             const metadata = getR1CSInfo(localR1csPath);
+            // download wasm too to ensure it's available
+            const responseWASM = await fetch(artifacts.wasmStoragePath);
+            if (!responseWASM.ok && responseWASM.status !== 200)
+                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.`);
+            await streamPipeline(responseWASM.body, createWriteStream(localWasmPath));
             // validate that the circuit hash and template links are valid
             const template = circuitData.template;
             const URLMatch = template.source.match(urlPattern);
@@ -1138,7 +1136,7 @@ const parseCeremonyFile = async (path, cleanup = false) => {
             const wasmCompleteFilename = `${circuitData.name}.wasm`;
             const smallestPowersOfTauCompleteFilenameForCircuit = `${potFilenameTemplate}${doubleDigitsPowers}.ptau`;
             const firstZkeyCompleteFilename = `${circuitPrefix}_${genesisZkeyIndex}.zkey`;
-            // storage paths 
+            // storage paths
             const r1csStorageFilePath = getR1csStorageFilePath(circuitPrefix, r1csCompleteFilename);
             const wasmStorageFilePath = getWasmStorageFilePath(circuitPrefix, wasmCompleteFilename);
             const potStorageFilePath = getPotStorageFilePath(smallestPowersOfTauCompleteFilenameForCircuit);
@@ -1154,7 +1152,7 @@ const parseCeremonyFile = async (path, cleanup = false) => {
                 initialZkeyStoragePath: zkeyStorageFilePath,
                 r1csBlake2bHash: r1csBlake2bHash
             };
-            // validate that the compiler hash is a valid hash 
+            // validate that the compiler hash is a valid hash
             const compiler = circuitData.compiler;
             const compilerHashMatch = compiler.commitHash.match(commitHashPattern);
             if (!compilerHashMatch || compilerHashMatch.length === 0 || compilerHashMatch.length > 1)
@@ -1189,7 +1187,7 @@ const parseCeremonyFile = async (path, cleanup = false) => {
                         contributionComputation: 0,
                         fullContribution: 0,
                         verifyCloudFunction: 0
-                    },
+                    }
                 };
             }
             if (data.timeoutMechanismType === "FIXED" /* CeremonyTimeoutType.FIXED */) {
@@ -1212,13 +1210,14 @@ const parseCeremonyFile = async (path, cleanup = false) => {
                         contributionComputation: 0,
                         fullContribution: 0,
                         verifyCloudFunction: 0
-                    },
+                    }
                 };
             }
             circuits.push(circuit);
-            // remove the local r1cs download (if used for verifying the config only vs setup)
+            // remove the local r1cs and wasm downloads (if used for verifying the config only vs setup)
             if (cleanup)
                 fs.unlinkSync(localR1csPath);
+            fs.unlinkSync(localWasmPath);
         }
         const setupData = {
             ceremonyInputData: {
@@ -1372,7 +1371,9 @@ const getContributionsValidityForContributor = async (firestoreDatabase, circuit
  * @param isFinalizing <boolean> - true when the coordinator is finalizing the ceremony, otherwise false.
  * @returns <string> - the public attestation preamble.
  */
-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:`;
+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")
+    ? "."
+    : " MPC Phase2 Trusted Setup ceremony."}\nThe following are my contribution signatures:`;
 /**
  * Check and prepare public attestation for the contributor made only of its valid contributions.
  * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
@@ -1828,7 +1829,7 @@ const getFirestoreDatabase = (app) => getFirestore(app);
  * @param app <FirebaseApp> - the Firebase application.
  * @returns <Functions> - the Cloud Functions associated to the application.
  */
-const getFirebaseFunctions = (app) => getFunctions(app, 'europe-west1');
+const getFirebaseFunctions = (app) => getFunctions(app, "europe-west1");
 /**
  * Retrieve the configuration variables for the AWS services (S3, EC2).
  * @returns <AWSVariables> - the values of the AWS services configuration variables.
@@ -2079,55 +2080,27 @@ const verifyCeremony = async (functions, firestore, ceremonyPrefix, outputDirect
 };
 
 /**
- * This function will return the number of public repos of a user
- * @param user <string> The username of the user
- * @returns <number> The number of public repos
+ * This function queries the GitHub API to fetch users statistics
+ * @param user {string} the user uid
+ * @returns {any} the stats from the GitHub API
  */
-const getNumberOfPublicReposGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/repos`, {
+const getGitHubStats = async (user) => {
+    const response = await fetch(`https://api.github.com/user/${user}`, {
         method: "GET",
         headers: {
             Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
         }
     });
     if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of public repositories. Please try again.");
+        throw new Error("It was not possible to retrieve the user's statistic. Please try again.");
     const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of followers of a user
- * @param user <string> The username of the user
- * @returns <number> The number of followers
- */
-const getNumberOfFollowersGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/followers`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of followers. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of following of a user
- * @param user <string> The username of the user
- * @returns <number> The number of following users
- */
-const getNumberOfFollowingGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/following`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of following. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
+    const data = {
+        following: jsonData.following,
+        followers: jsonData.followers,
+        publicRepos: jsonData.public_repos,
+        avatarUrl: jsonData.avatar_url
+    };
+    return data;
 };
 /**
  * This function will check if the user is reputable enough to be able to use the app
@@ -2135,19 +2108,23 @@ const getNumberOfFollowingGitHub = async (user) => {
  * @param minimumAmountOfFollowing <number> The minimum amount of following the user should have
  * @param minimumAmountOfFollowers <number> The minimum amount of followers the user should have
  * @param minimumAmountOfPublicRepos <number> The minimum amount of public repos the user should have
- * @returns <boolean> True if the user is reputable enough, false otherwise
+ * @returns <any> Return the avatar URL of the user if the user is reputable, false otherwise
  */
 const githubReputation = async (userLogin, minimumAmountOfFollowing, minimumAmountOfFollowers, minimumAmountOfPublicRepos) => {
     if (!process.env.GITHUB_ACCESS_TOKEN)
         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.");
-    const following = await getNumberOfFollowingGitHub(userLogin);
-    const repos = await getNumberOfPublicReposGitHub(userLogin);
-    const followers = await getNumberOfFollowersGitHub(userLogin);
+    const { following, followers, publicRepos, avatarUrl } = await getGitHubStats(userLogin);
     if (following < minimumAmountOfFollowing ||
-        repos < minimumAmountOfPublicRepos ||
+        publicRepos < minimumAmountOfPublicRepos ||
         followers < minimumAmountOfFollowers)
-        return false;
-    return true;
+        return {
+            reputable: false,
+            avatarUrl: ""
+        };
+    return {
+        reputable: true,
+        avatarUrl: avatarUrl
+    };
 };
 
 /**
@@ -2355,8 +2332,13 @@ const vmDependenciesAndCacheArtifactsCommand = (zKeyPath, potPath, snsTopic, reg
     // eslint-disable-next-line no-template-curly-in-string
     "touch ${MARKER_FILE}",
     "sudo yum update -y",
-    "curl -sL https://rpm.nodesource.com/setup_16.x | sudo bash - ",
-    "sudo yum install -y nodejs",
+    "curl -O https://nodejs.org/dist/v16.13.0/node-v16.13.0-linux-x64.tar.xz",
+    "tar -xf node-v16.13.0-linux-x64.tar.xz",
+    "mv node-v16.13.0-linux-x64 nodejs",
+    "sudo mv nodejs /opt/",
+    "echo 'export NODEJS_HOME=/opt/nodejs' >> /etc/profile",
+    "echo 'export PATH=$NODEJS_HOME/bin:$PATH' >> /etc/profile",
+    "source /etc/profile",
     "npm install -g snarkjs",
     `aws s3 cp s3://${zKeyPath} /var/tmp/genesisZkey.zkey`,
     `aws s3 cp s3://${potPath} /var/tmp/pot.ptau`,
@@ -2375,6 +2357,7 @@ const vmDependenciesAndCacheArtifactsCommand = (zKeyPath, potPath, snsTopic, reg
  * @returns Array<string> - the list of commands for contribution verification.
  */
 const vmContributionVerificationCommand = (bucketName, lastZkeyStoragePath, verificationTranscriptStoragePathAndFilename) => [
+    `source /etc/profile`,
     `aws s3 cp s3://${bucketName}/${lastZkeyStoragePath} /var/tmp/lastZKey.zkey > /var/tmp/log.txt`,
     `snarkjs zkvi /var/tmp/genesisZkey.zkey /var/tmp/pot.ptau /var/tmp/lastZKey.zkey > /var/tmp/verification_transcript.log`,
     `aws s3 cp /var/tmp/verification_transcript.log s3://${bucketName}/${verificationTranscriptStoragePathAndFilename} &>/dev/null`,