@devtion/actions 0.0.0-270e9e0 → 0.0.0-56491a8

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /**
- * @module @p0tion/actions
- * @version 1.0.4
+ * @module @devtion/actions
+ * @version 1.0.6
  * @file A set of actions and helpers for CLI commands
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -17,7 +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 { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';
 import { pipeline, Readable } from 'stream';
 import { promisify } from 'util';
 import { initializeApp } from 'firebase/app';
@@ -244,6 +244,12 @@ const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {
@@ -1085,42 +1091,34 @@ 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`;
+            // where we storing the wasm downloaded
+            const localWasmPath = `./${circuitData.name}.wasm`;
             // 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.`);
-            }
+            const s3 = new S3Client({
+                region: artifacts.region,
+                credentials: undefined
+            });
             // 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.");
+                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.`);
             if (response.Body instanceof Readable)
                 await streamPipeline(response.Body, fs.createWriteStream(localR1csPath));
             // extract the metadata from the r1cs
             const metadata = getR1CSInfo(localR1csPath);
+            // download wasm too to ensure it's available
+            const wasmCommand = new GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.wasmStoragePath });
+            const wasmResponse = await s3.send(wasmCommand);
+            if (wasmResponse.$metadata.httpStatusCode !== 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.`);
+            if (wasmResponse.Body instanceof Readable)
+                await streamPipeline(wasmResponse.Body, fs.createWriteStream(localWasmPath));
             // validate that the circuit hash and template links are valid
             const template = circuitData.template;
             const URLMatch = template.source.match(urlPattern);
@@ -1168,35 +1166,53 @@ const parseCeremonyFile = async (path, cleanup = false) => {
             // check that the timeout is provided for the correct configuration
             let dynamicThreshold;
             let fixedTimeWindow;
+            let circuit = {};
             if (data.timeoutMechanismType === "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */) {
                 if (circuitData.dynamicThreshold <= 0)
                     throw new Error("The dynamic threshold should be > 0.");
                 dynamicThreshold = circuitData.dynamicThreshold;
+                // the Circuit data for the ceremony setup
+                circuit = {
+                    name: circuitData.name,
+                    description: circuitData.description,
+                    prefix: circuitPrefix,
+                    sequencePosition: i + 1,
+                    metadata: metadata,
+                    files: files,
+                    template: template,
+                    compiler: compiler,
+                    verification: verification,
+                    dynamicThreshold: dynamicThreshold,
+                    avgTimings: {
+                        contributionComputation: 0,
+                        fullContribution: 0,
+                        verifyCloudFunction: 0
+                    },
+                };
             }
             if (data.timeoutMechanismType === "FIXED" /* CeremonyTimeoutType.FIXED */) {
                 if (circuitData.fixedTimeWindow <= 0)
                     throw new Error("The fixed time window threshold should be > 0.");
                 fixedTimeWindow = circuitData.fixedTimeWindow;
+                // the Circuit data for the ceremony setup
+                circuit = {
+                    name: circuitData.name,
+                    description: circuitData.description,
+                    prefix: circuitPrefix,
+                    sequencePosition: i + 1,
+                    metadata: metadata,
+                    files: files,
+                    template: template,
+                    compiler: compiler,
+                    verification: verification,
+                    fixedTimeWindow: fixedTimeWindow,
+                    avgTimings: {
+                        contributionComputation: 0,
+                        fullContribution: 0,
+                        verifyCloudFunction: 0
+                    },
+                };
             }
-            // the Circuit data for the ceremony setup
-            const circuit = {
-                name: circuitData.name,
-                description: circuitData.description,
-                prefix: circuitPrefix,
-                sequencePosition: i + 1,
-                metadata: metadata,
-                files: files,
-                template: template,
-                compiler: compiler,
-                verification: verification,
-                fixedTimeWindow: fixedTimeWindow,
-                // dynamicThreshold: dynamicThreshold,
-                avgTimings: {
-                    contributionComputation: 0,
-                    fullContribution: 0,
-                    verifyCloudFunction: 0
-                },
-            };
             circuits.push(circuit);
             // remove the local r1cs download (if used for verifying the config only vs setup)
             if (cleanup)
@@ -2061,55 +2077,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
@@ -2117,19 +2105,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
+    };
 };
 
 /**

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
- * @module @p0tion/actions
- * @version 1.0.4
+ * @module @devtion/actions
+ * @version 1.0.6
  * @file A set of actions and helpers for CLI commands
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -246,6 +246,12 @@ const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {
@@ -1087,42 +1093,34 @@ 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`;
+            // where we storing the wasm downloaded
+            const localWasmPath = `./${circuitData.name}.wasm`;
             // check that the artifacts exist in S3
             // we don't need any privileges to download this
             // just the correct region
-            const s3 = new clientS3.S3Client({ region: artifacts.region });
-            try {
-                await s3.send(new clientS3.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 clientS3.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.`);
-            }
+            const s3 = new clientS3.S3Client({
+                region: artifacts.region,
+                credentials: undefined
+            });
             // download the r1cs to extract the metadata
             const command = new clientS3.GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.r1csStoragePath });
             const response = await s3.send(command);
             const streamPipeline = util.promisify(stream.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.");
+                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.`);
             if (response.Body instanceof stream.Readable)
                 await streamPipeline(response.Body, fs.createWriteStream(localR1csPath));
             // extract the metadata from the r1cs
             const metadata = getR1CSInfo(localR1csPath);
+            // download wasm too to ensure it's available
+            const wasmCommand = new clientS3.GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.wasmStoragePath });
+            const wasmResponse = await s3.send(wasmCommand);
+            if (wasmResponse.$metadata.httpStatusCode !== 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.`);
+            if (wasmResponse.Body instanceof stream.Readable)
+                await streamPipeline(wasmResponse.Body, fs.createWriteStream(localWasmPath));
             // validate that the circuit hash and template links are valid
             const template = circuitData.template;
             const URLMatch = template.source.match(urlPattern);
@@ -1170,35 +1168,53 @@ const parseCeremonyFile = async (path, cleanup = false) => {
             // check that the timeout is provided for the correct configuration
             let dynamicThreshold;
             let fixedTimeWindow;
+            let circuit = {};
             if (data.timeoutMechanismType === "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */) {
                 if (circuitData.dynamicThreshold <= 0)
                     throw new Error("The dynamic threshold should be > 0.");
                 dynamicThreshold = circuitData.dynamicThreshold;
+                // the Circuit data for the ceremony setup
+                circuit = {
+                    name: circuitData.name,
+                    description: circuitData.description,
+                    prefix: circuitPrefix,
+                    sequencePosition: i + 1,
+                    metadata: metadata,
+                    files: files,
+                    template: template,
+                    compiler: compiler,
+                    verification: verification,
+                    dynamicThreshold: dynamicThreshold,
+                    avgTimings: {
+                        contributionComputation: 0,
+                        fullContribution: 0,
+                        verifyCloudFunction: 0
+                    },
+                };
             }
             if (data.timeoutMechanismType === "FIXED" /* CeremonyTimeoutType.FIXED */) {
                 if (circuitData.fixedTimeWindow <= 0)
                     throw new Error("The fixed time window threshold should be > 0.");
                 fixedTimeWindow = circuitData.fixedTimeWindow;
+                // the Circuit data for the ceremony setup
+                circuit = {
+                    name: circuitData.name,
+                    description: circuitData.description,
+                    prefix: circuitPrefix,
+                    sequencePosition: i + 1,
+                    metadata: metadata,
+                    files: files,
+                    template: template,
+                    compiler: compiler,
+                    verification: verification,
+                    fixedTimeWindow: fixedTimeWindow,
+                    avgTimings: {
+                        contributionComputation: 0,
+                        fullContribution: 0,
+                        verifyCloudFunction: 0
+                    },
+                };
             }
-            // the Circuit data for the ceremony setup
-            const circuit = {
-                name: circuitData.name,
-                description: circuitData.description,
-                prefix: circuitPrefix,
-                sequencePosition: i + 1,
-                metadata: metadata,
-                files: files,
-                template: template,
-                compiler: compiler,
-                verification: verification,
-                fixedTimeWindow: fixedTimeWindow,
-                // dynamicThreshold: dynamicThreshold,
-                avgTimings: {
-                    contributionComputation: 0,
-                    fullContribution: 0,
-                    verifyCloudFunction: 0
-                },
-            };
             circuits.push(circuit);
             // remove the local r1cs download (if used for verifying the config only vs setup)
             if (cleanup)
@@ -2063,55 +2079,27 @@ const verifyCeremony = async (functions, firestore$1, ceremonyPrefix, outputDire
 };
 
 /**
- * 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
@@ -2119,19 +2107,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
+    };
 };
 
 /**

package/dist/types/src/helpers/constants.d.ts

@@ -98,6 +98,12 @@ export declare const commonTerms: {
                 verificationStartedAt: string;
             };
         };
+        avatars: {
+            name: string;
+            fields: {
+                avatarUrl: string;
+            };
+        };
         ceremonies: {
             name: string;
             fields: {

package/dist/types/src/helpers/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/helpers/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,sBAAsB,+CAA+C,CAAA;AAElF,eAAO,MAAM,mBAAmB,6BAA6B,CAAA;AAE7D,eAAO,MAAM,gBAAgB,UAAU,CAAA;AAEvC,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC,eAAO,MAAM,eAAe,UAAU,CAAA;AAEtC,eAAO,MAAM,sBAAsB,UAAU,CAAA;AAE7C,eAAO,MAAM,sBAAsB,SAAS,CAAA;AAE5C,eAAO,MAAM,4BAA4B,aAAa,CAAA;AAEtD,eAAO,MAAM,cAAc,sBAAsB,CAAA;AAEjD,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2ChC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;GA6G5B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuHvB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/helpers/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,sBAAsB,+CAA+C,CAAA;AAElF,eAAO,MAAM,mBAAmB,6BAA6B,CAAA;AAE7D,eAAO,MAAM,gBAAgB,UAAU,CAAA;AAEvC,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC,eAAO,MAAM,eAAe,UAAU,CAAA;AAEtC,eAAO,MAAM,sBAAsB,UAAU,CAAA;AAE7C,eAAO,MAAM,sBAAsB,SAAS,CAAA;AAE5C,eAAO,MAAM,4BAA4B,aAAa,CAAA;AAEtD,eAAO,MAAM,cAAc,sBAAsB,CAAA;AAEjD,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2ChC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;GA6G5B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6HvB,CAAA"}

package/dist/types/src/helpers/security.d.ts

@@ -4,7 +4,7 @@
  * @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 declare const githubReputation: (userLogin: string, minimumAmountOfFollowing: number, minimumAmountOfFollowers: number, minimumAmountOfPublicRepos: number) => Promise<boolean>;
+export declare const githubReputation: (userLogin: string, minimumAmountOfFollowing: number, minimumAmountOfFollowers: number, minimumAmountOfPublicRepos: number) => Promise<any>;
 //# sourceMappingURL=security.d.ts.map

package/dist/types/src/helpers/security.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../../src/helpers/security.ts"],"names":[],"mappings":"AAwDA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,cACd,MAAM,4BACS,MAAM,4BACN,MAAM,8BACJ,MAAM,KACnC,QAAQ,OAAO,CAgBjB,CAAA"}
+{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../../src/helpers/security.ts"],"names":[],"mappings":"AA8BA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,cACd,MAAM,4BACS,MAAM,4BACN,MAAM,8BACJ,MAAM,KACnC,QAAQ,GAAG,CAsBb,CAAA"}

package/dist/types/src/helpers/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/helpers/utils.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAW,EAAE,YAAY,EAAE,MAAM,IAAI,CAAA;AAErC,OAAO,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEzC,OAAO,EACH,eAAe,EACf,YAAY,EAGZ,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EAGpB,MAAM,gBAAgB,CAAA;AAmBvB;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAgB,MAAM,YAAW,OAAO,KAAW,QAAQ,iBAAiB,CA4MzG,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,iBAAkB,MAAM,UAAU,MAAM,KAAG,MAgBtF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oCAAoC,gBAAiB,MAAM,WAAW,MAAM,WAUxF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,aAAc,MAAM,KAAG,MASlD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,wBAAyB,MAAM,KAAG,MACH,CAAA;AAElE;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,QAAS,MAAM,KAAG,MAEsC,CAAA;AAElF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,cAAsE,CAAA;AAEtG;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B,aAC3B,MAAM,oBAAoB,CAAC,oBACnB,MAAM,KACzB,oBAYF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,cAAe,MAAM,WAAW,OAAO,KAAG,MAC1B,CAAA;AAEjD;;;;;;;;GAQG;AACH,eAAO,MAAM,sCAAsC,sBAC5B,SAAS,YAClB,MAAM,oBAAoB,CAAC,cACzB,MAAM,iBACH,MAAM,gBACP,OAAO,KACtB,QAAQ,MAAM,oBAAoB,CAAC,CAmCrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0CAA0C,0BAC5B,MAAM,gBACf,MAAM,gBACN,OAAO,WAImF,CAAA;AAE5G;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qCAAqC,sBAC3B,SAAS,YAClB,MAAM,oBAAoB,CAAC,cACzB,MAAM,iBACH,MAAM,4BACK,MAAM,YAAY,CAAC,yBACtB,MAAM,gBACf,MAAM,gBACN,OAAO,KACtB,QAAQ,MAAM,CA2DhB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,aAAc,MAAM,UAAS,QAAQ,aAAa,CAAC,OAAO,CAAC,KAAY,MAQvG,CAAA;AAEN;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,kBACX,MAAM,UACb,MAAM,UACN,MAAM,YACJ,YAAY,KACvB,MAYF,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,sBAAuB,MAAM,KAAG,eA0IvD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,WAAY,MAAM,KAAG,MAA0D,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/helpers/utils.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAW,EAAE,YAAY,EAAE,MAAM,IAAI,CAAA;AAErC,OAAO,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEzC,OAAO,EACH,eAAe,EACf,YAAY,EAGZ,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EAGpB,MAAM,gBAAgB,CAAA;AAmBvB;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAgB,MAAM,YAAW,OAAO,KAAW,QAAQ,iBAAiB,CA+NzG,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,iBAAkB,MAAM,UAAU,MAAM,KAAG,MAgBtF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oCAAoC,gBAAiB,MAAM,WAAW,MAAM,WAUxF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,aAAc,MAAM,KAAG,MASlD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,wBAAyB,MAAM,KAAG,MACH,CAAA;AAElE;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,QAAS,MAAM,KAAG,MAEsC,CAAA;AAElF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,cAAsE,CAAA;AAEtG;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B,aAC3B,MAAM,oBAAoB,CAAC,oBACnB,MAAM,KACzB,oBAYF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,cAAe,MAAM,WAAW,OAAO,KAAG,MAC1B,CAAA;AAEjD;;;;;;;;GAQG;AACH,eAAO,MAAM,sCAAsC,sBAC5B,SAAS,YAClB,MAAM,oBAAoB,CAAC,cACzB,MAAM,iBACH,MAAM,gBACP,OAAO,KACtB,QAAQ,MAAM,oBAAoB,CAAC,CAmCrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0CAA0C,0BAC5B,MAAM,gBACf,MAAM,gBACN,OAAO,WAImF,CAAA;AAE5G;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qCAAqC,sBAC3B,SAAS,YAClB,MAAM,oBAAoB,CAAC,cACzB,MAAM,iBACH,MAAM,4BACK,MAAM,YAAY,CAAC,yBACtB,MAAM,gBACf,MAAM,gBACN,OAAO,KACtB,QAAQ,MAAM,CA2DhB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,aAAc,MAAM,UAAS,QAAQ,aAAa,CAAC,OAAO,CAAC,KAAY,MAQvG,CAAA;AAEN;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,kBACX,MAAM,UACb,MAAM,UACN,MAAM,YACJ,YAAY,KACvB,MAYF,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,sBAAuB,MAAM,KAAG,eA0IvD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,WAAY,MAAM,KAAG,MAA0D,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devtion/actions",
-  "version": "0.0.0-270e9e0",
+  "version": "0.0.0-56491a8",
   "description": "A set of actions and helpers for CLI commands",
   "repository": "git@github.com:privacy-scaling-explorations/p0tion.git",
   "homepage": "https://github.com/privacy-scaling-explorations/p0tion",
@@ -83,5 +83,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "558cd8e1ece3f6f3cde816d3bb0b88fea90a86a9"
+  "gitHead": "29b556076a3424c9aaf3a5a35b40df8520fa2217"
 }

package/src/helpers/constants.ts

@@ -217,6 +217,12 @@ export const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {

package/src/helpers/security.ts

@@ -1,45 +1,12 @@
 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
- */
-const getNumberOfPublicReposGitHub = async (user: string): Promise<number> => {
-    const response = await fetch(`https://api.github.com/user/${user}/repos`, {
-        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
+ * 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 getNumberOfFollowingGitHub = async (user: string): Promise<number> => {
-    const response = await fetch(`https://api.github.com/user/${user}/following`, {
+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!}`
@@ -47,11 +14,18 @@ const getNumberOfFollowingGitHub = async (user: string): Promise<number> => {
     })
 
     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
+    }
+
+    return data 
 }
 
 /**
@@ -60,27 +34,33 @@ 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> => {
+): 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 } = 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
+    }
 }

package/src/helpers/utils.ts

@@ -87,34 +87,19 @@ export const parseCeremonyFile = async (path: string, cleanup: boolean = false):
             circuitArtifacts.push({
                 artifacts: artifacts
             })
-            const r1csPath = artifacts.r1csStoragePath
-            const wasmPath = artifacts.wasmStoragePath
 
             // where we storing the r1cs downloaded
             const localR1csPath = `./${circuitData.name}.r1cs`
+            // where we storing the wasm downloaded
+            const localWasmPath = `./${circuitData.name}.wasm`
 
             // 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: any) {
-                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: any) {
-                throw new Error(`The wasm file (${wasmPath}) seems to not exist. Please ensure this is correct and that the object is publicly available.`)
-            }
+            const s3 = new S3Client({
+                region: artifacts.region,
+                credentials: undefined
+            })
 
             // download the r1cs to extract the metadata
             const command = new GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.r1csStoragePath })
@@ -122,7 +107,7 @@ export const parseCeremonyFile = async (path: string, cleanup: boolean = false):
             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.")
+                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.`)
 
             if (response.Body instanceof Readable) 
                 await streamPipeline(response.Body, fs.createWriteStream(localR1csPath))
@@ -130,6 +115,16 @@ export const parseCeremonyFile = async (path: string, cleanup: boolean = false):
             // extract the metadata from the r1cs
             const metadata = getR1CSInfo(localR1csPath)
 
+            // download wasm too to ensure it's available
+            const wasmCommand = new GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.wasmStoragePath })
+            const wasmResponse = await s3.send(wasmCommand)
+
+            if (wasmResponse.$metadata.httpStatusCode !== 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.`)
+            
+            if (wasmResponse.Body instanceof Readable)
+                await streamPipeline(wasmResponse.Body, fs.createWriteStream(localWasmPath))
+
             // validate that the circuit hash and template links are valid
             const template = circuitData.template