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

package/src/helpers/constants.ts

@@ -1,7 +1,7 @@
-// Main part for the Hermez Phase 1 Trusted Setup URLs to download PoT files.
-export const potFileDownloadMainUrl = `https://hermez.s3-eu-west-1.amazonaws.com/`
-// Main part for the Hermez Phase 1 Trusted Setup PoT files to be downloaded.
-export const potFilenameTemplate = `powersOfTau28_hez_final_`
+// Main part for the PPoT Phase 1 Trusted Setup URLs to download PoT files.
+export const potFileDownloadMainUrl = `https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/`
+// Main part for the PPoT Phase 1 Trusted Setup PoT files to be downloaded.
+export const potFilenameTemplate = `ppot_0080_`
 // The genesis zKey index.
 export const genesisZkeyIndex = `00000`
 // The number of exponential iterations to be executed by SnarkJS when finalizing the ceremony.
@@ -18,6 +18,8 @@ export const verifierSmartContractAcronym = "verifier"
 export const ec2InstanceTag = "p0tionec2instance"
 // The name of the VM startup script file.
 export const vmBootstrapScriptFilename = "bootstrap.sh"
+// Match hash output by snarkjs in transcript log
+export const contribHashRegex = new RegExp("Contribution.+Hash.+\n\t\t.+\n\t\t.+\n.+\n\t\t.+\r?\n")
 
 /**
  * Define the supported VM configuration types.
@@ -77,112 +79,116 @@ export const vmConfigurationTypes = {
  */
 export const powersOfTauFiles = [
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_01.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_01.ptau",
         size: 0.000084
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_02.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_02.ptau",
         size: 0.000086
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_03.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_03.ptau",
         size: 0.000091
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_04.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_04.ptau",
         size: 0.0001
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_05.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_05.ptau",
         size: 0.000117
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_06.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_06.ptau",
         size: 0.000153
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_07.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_07.ptau",
         size: 0.000225
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_08.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_08.ptau",
         size: 0.0004
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_09.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_09.ptau",
         size: 0.000658
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_10.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_10.ptau",
         size: 0.0013
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_11.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_11.ptau",
         size: 0.0023
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_12.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_12.ptau",
         size: 0.0046
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_13.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_13.ptau",
         size: 0.0091
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_14.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_14.ptau",
         size: 0.0181
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_15.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_15.ptau",
         size: 0.0361
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_16.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_16.ptau",
         size: 0.0721
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_17.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_17.ptau",
         size: 0.144
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_18.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_18.ptau",
         size: 0.288
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_19.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_19.ptau",
         size: 0.576
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_20.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_20.ptau",
         size: 1.1
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_21.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_21.ptau",
         size: 2.3
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_22.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_22.ptau",
         size: 4.5
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_23.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_23.ptau",
         size: 9.0
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_24.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_24.ptau",
         size: 18.0
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_25.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_25.ptau",
         size: 36.0
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_26.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_26.ptau",
         size: 72.0
     },
     {
-        ref: "https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_27.ptau",
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_27.ptau",
         size: 144.0
+    },
+    {
+        ref: "https://pse-trusted-setup-ppot.s3.eu-central-1.amazonaws.com/pot28_0080/ppot_0080_final.ptau",
+        size: 288.0
     }
 ]
 
@@ -217,6 +223,12 @@ export const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {
@@ -308,5 +320,7 @@ export const commonTerms = {
         finalizeCeremony: "finalizeCeremony",
         downloadCircuitArtifacts: "downloadCircuitArtifacts",
         transferObject: "transferObject",
+        bandadaValidateProof: "bandadaValidateProof",
+        checkNonceOfSIWEAddress: "checkNonceOfSIWEAddress"
     }
 }

package/src/helpers/contracts.ts

@@ -1,5 +1,4 @@
 import { Contract, ContractFactory, Signer } from "ethers"
-import { utils as ffUtils } from "ffjavascript"
 import { Firestore, where } from "firebase/firestore"
 import { Functions } from "firebase/functions"
 import fs from "fs"
@@ -16,6 +15,7 @@ import {
 import { compareHashes } from "./crypto"
 import { commonTerms, finalContributionIndex, verificationKeyAcronym, verifierSmartContractAcronym } from "./constants"
 import { fromQueryToFirebaseDocumentInfo, queryCollection } from "./database"
+import { unstringifyBigInts } from "./utils"
 
 /**
  * Formats part of a GROTH16 SNARK proof
@@ -41,11 +41,11 @@ export const p256 = (proofPart: any) => {
  */
 export const formatSolidityCalldata = (circuitInput: string[], _proof: any): any => {
     try {
-        const proof = ffUtils.unstringifyBigInts(_proof)
+        const proof = unstringifyBigInts(_proof) as any
         // format the public inputs to the circuit
         const formattedCircuitInput = []
         for (const cInput of circuitInput) {
-            formattedCircuitInput.push(p256(ffUtils.unstringifyBigInts(cInput)))
+            formattedCircuitInput.push(p256(unstringifyBigInts(cInput)))
         }
         // construct calldata
         const calldata = {

package/src/helpers/database.ts

@@ -219,3 +219,16 @@ export const getClosedCeremonies = async (firestoreDatabase: Firestore): Promise
 
     return fromQueryToFirebaseDocumentInfo(closedCeremoniesQuerySnap.docs)
 }
+
+/**
+ * Query all ceremonies
+ * @notice get all ceremonies from the database.
+ * @dev this is a helper for the CLI ceremony methods.
+ * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
+ * @returns <Promise<Array<FirebaseDocumentInfo>>> - the list of all ceremonies.
+ */
+export const getAllCeremonies = async (firestoreDatabase: Firestore): Promise<Array<FirebaseDocumentInfo>> => {
+    const ceremoniesQuerySnap = await queryCollection(firestoreDatabase, commonTerms.collections.ceremonies.name, [])
+
+    return fromQueryToFirebaseDocumentInfo(ceremoniesQuerySnap.docs)
+}

package/src/helpers/functions.ts

@@ -435,4 +435,4 @@ export const finalizeCeremony = async (functions: Functions, ceremonyId: string)
     await cf({
         ceremonyId
     })
-}
+}

package/src/helpers/security.ts

@@ -1,57 +1,30 @@
 import fetch from "@adobe/node-fetch-retry"
 /**
- * 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: string): Promise<number> => {
-    const response = await fetch(`https://api.github.com/user/${user}/repos`, {
+const getGitHubStats = async (user: string): Promise<any> => {
+    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.")
-    const jsonData: any = 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: string): Promise<number> => {
-    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: any = 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: string): Promise<number> => {
-    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.")
+        throw new Error("It was not possible to retrieve the user's statistic. Please try again.")
 
     const jsonData: any = await response.json()
 
-    return jsonData.length
+    const data = {
+        following: jsonData.following,
+        followers: jsonData.followers,
+        publicRepos: jsonData.public_repos,
+        avatarUrl: jsonData.avatar_url,
+        age: jsonData.created_at
+    }
+
+    return data
 }
 
 /**
@@ -60,27 +33,35 @@ const getNumberOfFollowingGitHub = async (user: string): Promise<number> => {
  * @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
  */
 export const githubReputation = async (
     userLogin: string,
     minimumAmountOfFollowing: number,
     minimumAmountOfFollowers: number,
-    minimumAmountOfPublicRepos: number
-): Promise<boolean> => {
+    minimumAmountOfPublicRepos: number,
+    minimumAge: number
+): Promise<any> => {
     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, age } = await getGitHubStats(userLogin)
 
     if (
         following < minimumAmountOfFollowing ||
-        repos < minimumAmountOfPublicRepos ||
-        followers < minimumAmountOfFollowers
+        publicRepos < minimumAmountOfPublicRepos ||
+        followers < minimumAmountOfFollowers ||
+        new Date(age) > new Date(Date.now() - minimumAge)
     )
-        return false
-    return true
+        return {
+            reputable: false,
+            avatarUrl: ""
+        }
+
+    return {
+        reputable: true,
+        avatarUrl
+    }
 }

package/src/helpers/services.ts

@@ -22,7 +22,7 @@ export const getFirestoreDatabase = (app: FirebaseApp): Firestore => getFirestor
  * @param app <FirebaseApp> - the Firebase application.
  * @returns <Functions> - the Cloud Functions associated to the application.
  */
-export const getFirebaseFunctions = (app: FirebaseApp): Functions => getFunctions(app, 'europe-west1')
+export const getFirebaseFunctions = (app: FirebaseApp): Functions => getFunctions(app, "europe-west1")
 
 /**
  * Retrieve the configuration variables for the AWS services (S3, EC2).
@@ -33,7 +33,7 @@ export const getAWSVariables = (): AWSVariables => {
         !process.env.AWS_ACCESS_KEY_ID ||
         !process.env.AWS_SECRET_ACCESS_KEY ||
         !process.env.AWS_REGION ||
-        !process.env.AWS_ROLE_ARN ||
+        !process.env.AWS_INSTANCE_PROFILE_ARN ||
         !process.env.AWS_AMI_ID
     )
         throw new Error(
@@ -44,7 +44,7 @@ export const getAWSVariables = (): AWSVariables => {
         accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
         secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
         region: process.env.AWS_REGION || "us-east-1",
-        roleArn: process.env.AWS_ROLE_ARN!,
+        instanceProfileArn: process.env.AWS_INSTANCE_PROFILE_ARN!,
         amiId: process.env.AWS_AMI_ID!
     }
 }

package/src/helpers/storage.ts

@@ -3,6 +3,7 @@ import mime from "mime-types"
 import fs, { createWriteStream } from "fs"
 import fetch from "@adobe/node-fetch-retry"
 import https from "https"
+import { GenericBar } from "cli-progress"
 import { ETagWithPartNumber, ChunkWithUrl, TemporaryParticipantContributionData } from "../types/index"
 import { commonTerms } from "./constants"
 import {
@@ -80,6 +81,7 @@ export const getChunksAndPreSignedUrls = async (
  * @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.
  */
 export const uploadParts = async (
@@ -87,11 +89,15 @@ export const uploadParts = async (
     contentType: string | false,
     cloudFunctions?: Functions,
     ceremonyId?: string,
-    alreadyUploadedChunks?: Array<ETagWithPartNumber>
+    alreadyUploadedChunks?: Array<ETagWithPartNumber>,
+    logger?: GenericBar
 ): Promise<Array<ETagWithPartNumber>> => {
     // Keep track of uploaded chunks.
     const uploadedChunks: Array<ETagWithPartNumber> = 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.
@@ -128,6 +134,9 @@ export const uploadParts = async (
         // 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
@@ -150,6 +159,7 @@ export const uploadParts = async (
  * @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.
  */
 export const multiPartUpload = async (
     cloudFunctions: Functions,
@@ -158,7 +168,8 @@ export const multiPartUpload = async (
     localFilePath: string,
     configStreamChunkSize: number,
     ceremonyId?: string,
-    temporaryDataToResumeMultiPartUpload?: TemporaryParticipantContributionData
+    temporaryDataToResumeMultiPartUpload?: TemporaryParticipantContributionData,
+    logger?: GenericBar
 ) => {
     // The unique identifier of the multi-part upload.
     let multiPartUploadId: string = ""
@@ -198,7 +209,8 @@ export const multiPartUpload = async (
         mime.lookup(localFilePath), // content-type.
         cloudFunctions,
         ceremonyId,
-        alreadyUploadedChunks
+        alreadyUploadedChunks,
+        logger
     )
 
     // Step (3).