@devtion/backend 0.0.0-004e6ad

package/dist/types/types/index.d.ts

@@ -0,0 +1,186 @@
+import { CeremonyInputData, CircuitDocument, ETagWithPartNumber } from "@devtion/actions";
+import type { Groth16Proof, PublicSignals } from "snarkjs";
+/**
+ * Group all the necessary data needed for running the `setupCeremony` cloud function.
+ * @typedef {Object} SetupCeremonyData
+ * @property {CeremonyInputData} ceremonyInputData - the necessary input data for setup a new ceremony.
+ * @property {string} ceremonyPrefix - the ceremony prefix.
+ * @property {Array<CircuitDocument>} circuits - the necessary input data for setup the related ceremony circuits.
+ */
+export type SetupCeremonyData = {
+    ceremonyInputData: CeremonyInputData;
+    ceremonyPrefix: string;
+    circuits: Array<CircuitDocument>;
+};
+/**
+ * Group all the necessary data needed for running the `createBucket` cloud function.
+ * @typedef {Object} CreateBucketData
+ * @property {string} bucketName - the name of the bucket.
+ */
+export type CreateBucketData = {
+    bucketName: string;
+};
+/**
+ * Group all the necessary data needed for running the `checkIfObjectExist` or `generateGetObjectPreSignedUrl` cloud functions.
+ * @typedef {Object} BucketAndObjectKeyData
+ * @property {string} bucketName - the name of the bucket.
+ * @property {string} objectKey - the unique key to identify the object inside the given AWS S3 bucket.
+ */
+export type BucketAndObjectKeyData = {
+    bucketName: string;
+    objectKey: string;
+};
+/**
+ * Group all the necessary data needed for running the `startMultiPartUpload` cloud function.
+ * @typedef {Object} StartMultiPartUploadData
+ * @property {string} bucketName - the name of the bucket.
+ * @property {string} objectKey - the unique key to identify the object inside the given AWS S3 bucket.
+ * @property {string} ceremonyId - the prefix of the ceremony.
+ */
+export type StartMultiPartUploadData = BucketAndObjectKeyData & {
+    ceremonyId?: string;
+};
+/**
+ * Group all the necessary data needed for running the `generatePreSignedUrlsParts` cloud function.
+ * @typedef {Object} GeneratePreSignedUrlsPartsData
+ * @property {string} bucketName - the name of the bucket.
+ * @property {string} objectKey - the unique key to identify the object inside the given AWS S3 bucket.
+ * @property {string} uploadId - the identifier of the initiated multi-part upload.
+ * @property {number} numberOfParts - the amount of chunks for which pre-signed urls are to be generated.
+ * @property {string} ceremonyId - the prefix of the ceremony.
+ */
+export type GeneratePreSignedUrlsPartsData = BucketAndObjectKeyData & {
+    uploadId: string;
+    numberOfParts: number;
+    ceremonyId?: string;
+};
+/**
+ * Group all the necessary data needed for running the `completeMultiPartUpload` cloud function.
+ * @typedef {Object} GeneratePreSignedUrlsPartsData
+ * @property {string} bucketName - the name of the bucket.
+ * @property {string} objectKey - the unique key to identify the object inside the given AWS S3 bucket.
+ * @property {string} uploadId - the identifier of the initiated multi-part upload.
+ * @property {Array<ETagWithPartNumber>} parts - the chunks of the file related to the multi-part upload.
+ * @property {string} [ceremonyId] - the unique identifier of the ceremony.
+ */
+export type CompleteMultiPartUploadData = BucketAndObjectKeyData & {
+    uploadId: string;
+    parts: Array<ETagWithPartNumber>;
+    ceremonyId?: string;
+};
+/**
+ * Group all the necessary data needed for running the `permanentlyStoreCurrentContributionTimeAndHash` cloud function.
+ * @typedef {Object} PermanentlyStoreCurrentContributionTimeAndHash
+ * @property {string} ceremonyId - the unique identifier of the ceremony.
+ * @property {number} contributionComputationTime - the time spent by the contributor to compute the contribution.
+ * @property {string} contributionHash - the hash of the contribution.
+ */
+export type PermanentlyStoreCurrentContributionTimeAndHash = {
+    ceremonyId: string;
+    contributionComputationTime: number;
+    contributionHash: string;
+};
+/**
+ * Group all the necessary data needed for running the `temporaryStoreCurrentContributionMultiPartUploadId` cloud function.
+ * @typedef {Object} TemporaryStoreCurrentContributionMultiPartUploadId
+ * @property {string} ceremonyId - the unique identifier of the ceremony.
+ * @property {number} uploadId - the unique identifier of the already started multi-part upload.
+ */
+export type TemporaryStoreCurrentContributionMultiPartUploadId = {
+    ceremonyId: string;
+    uploadId: string;
+};
+/**
+ * Group all the necessary data needed for running the `temporaryStoreCurrentContributionUploadedChunkData` cloud function.
+ * @typedef {Object} TemporaryStoreCurrentContributionUploadedChunkData
+ * @property {string} ceremonyId - the unique identifier of the ceremony.
+ * @property {number} uploadId - the unique identifier of the already started multi-part upload.
+ */
+export type TemporaryStoreCurrentContributionUploadedChunkData = {
+    ceremonyId: string;
+    chunk: ETagWithPartNumber;
+};
+/**
+ * Group all the necessary data needed for running the `verifycontribution` cloud function.
+ * @typedef {Object} VerifyContributionData
+ * @property {string} ceremonyId - the unique identifier of the ceremony.
+ * @property {string} circuitId - the unique identifier of the circuit.
+ * @property {string} bucketName - the name of the bucket.
+ * @property {string} contributorOrCoordinatorIdentifier - the identifier of the contributor or coordinator (only when finalizing).
+ */
+export type VerifyContributionData = {
+    ceremonyId: string;
+    circuitId: string;
+    bucketName: string;
+    contributorOrCoordinatorIdentifier: string;
+};
+/**
+ * Group all the necessary data needed for running the `finalizeCircuit` cloud function.
+ * @typedef {Object} FinalizeCircuitData
+ * @property {string} ceremonyId - the unique identifier of the ceremony.
+ * @property {string} circuitId - the unique identifier of the circuit.
+ * @property {string} bucketName - the name of the bucket.
+ * @property {string} beacon - the value used to compute the final contribution while finalizing the ceremony.
+ */
+export type FinalizeCircuitData = {
+    ceremonyId: string;
+    circuitId: string;
+    bucketName: string;
+    beacon: string;
+};
+/**
+ * Group all the necessary data needed for running the `bandadaValidateProof` cloud function.
+ * @typedef {Object} BandadaValidateProof
+ * @property {string} merkleTreeRoot - the merkle tree root of the group.
+ * @property {string} nullifierHash - the nullifier hash of the member.
+ * @property {string} externalNullifier - the external nullifier of the member.
+ * @property {PackedProof} proof - the packed proof generated on the client.
+ */
+export type BandadaValidateProof = {
+    proof: Groth16Proof;
+    publicSignals: PublicSignals;
+};
+/**
+ * Define the return object of the function that verifies the Bandada membership and proof.
+ * @typedef {Object} VerifiedBandadaResponse
+ * @property {boolean} valid - true if the proof is valid and the user is a member of the group; otherwise false.
+ * @property {string} message - a message describing the result of the verification.
+ * @property {string} token - the custom access token.
+ */
+export type VerifiedBandadaResponse = {
+    valid: boolean;
+    message: string;
+    token: string;
+};
+/**
+ * Define the check nonce object for the cloud function
+ * @typedef {Object} CheckNonceOfSIWEAddressRequest
+ * @property {string} auth0Token - token from the device flow authentication
+ */
+export type CheckNonceOfSIWEAddressRequest = {
+    auth0Token: string;
+};
+/**
+ * Define the check nonce response object of the cloud function
+ * @typedef {Object} CheckNonceOfSIWEAddressResponse
+ * @property {boolean} valid - if the checking result was valid or not
+ * @property {string} message - informative message
+ * @property {string} token - token to sign in
+ */
+export type CheckNonceOfSIWEAddressResponse = {
+    valid: boolean;
+    message?: string;
+    token?: string;
+};
+/**
+ * Define the response from auth0 /userinfo endpoint
+ *
+ */
+export type Auth0UserInfo = {
+    sub: string;
+    nickname: string;
+    name: string;
+    picture: string;
+    updated_at: string;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE1D;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;CACnC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG,sBAAsB,GAAG;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,8BAA8B,GAAG,sBAAsB,GAAG;IAClE,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,2BAA2B,GAAG,sBAAsB,GAAG;IAC/D,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,8CAA8C,GAAG;IACzD,UAAU,EAAE,MAAM,CAAA;IAClB,2BAA2B,EAAE,MAAM,CAAA;IACnC,gBAAgB,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,kBAAkB,CAAA;CAC5B,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,kCAAkC,EAAE,MAAM,CAAA;CAC7C,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B,KAAK,EAAE,YAAY,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;CAC/B,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAClC,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG;IACzC,UAAU,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC1C,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AACD;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;CACrB,CAAA"}

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@devtion/backend",
+  "version": "0.0.0-004e6ad",
+  "description": "MPC Phase 2 backend for Firebase services management",
+  "repository": "git@github.com:privacy-scaling-explorations/p0tion.git",
+  "homepage": "https://github.com/privacy-scaling-explorations/p0tion",
+  "bugs": "https://github.com/privacy-scaling-explorations/p0tion/issues",
+  "license": "MIT",
+  "main": "./dist/src/functions/index.js",
+  "exports": {
+    "import": "./dist/src/functions/index.mjs",
+    "require": "./dist/src/functions/index.js"
+  },
+  "types": "dist/types/types/index.d.ts",
+  "engines": {
+    "node": "16"
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "test/",
+    "README.md"
+  ],
+  "keywords": [
+    "typescript",
+    "zero-knowledge",
+    "zk-snarks",
+    "phase-2",
+    "trusted-setup",
+    "ceremony",
+    "snarkjs",
+    "circom"
+  ],
+  "scripts": {
+    "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
+    "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
+    "firebase:login": "firebase login",
+    "firebase:logout": "firebase logout",
+    "firebase:init": "firebase init",
+    "firebase:deploy": "yarn firestore:get-indexes && firebase deploy --project prod",
+    "firebase:deploy-functions": "firebase deploy --only functions --project prod",
+    "firebase:deploy-firestore": "yarn firestore:get-indexes && firebase deploy --only firestore --project prod",
+    "firebase:log-functions": "firebase functions:log --project prod",
+    "firestore:get-indexes": "firebase firestore:indexes --project prod > firestore.indexes.json",
+    "emulator:serve": "yarn build && firebase emulators:start",
+    "emulator:serve-functions": "yarn build && firebase emulators:start --only functions",
+    "emulator:shell": "yarn build && firebase functions:shell",
+    "emulator:exec-test": "firebase --project dev emulators:exec \"yarn test:emulator\"",
+    "test:emulator": "jest --config=../../jest.json --detectOpenHandles --forceExit --coverage=false --watchAll=false --no-cache",
+    "docs": "typedoc src/**/*.ts --out ../../docs/backend"
+  },
+  "devDependencies": {
+    "@firebase/rules-unit-testing": "^2.0.7",
+    "@types/rollup-plugin-auto-external": "^2.0.2",
+    "@types/uuid": "^9.0.1",
+    "firebase-functions-test": "^3.1.0",
+    "firebase-tools": "^12.0.0",
+    "rollup-plugin-auto-external": "^2.0.0",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "@adobe/node-fetch-retry": "^2.2.0",
+    "@aws-sdk/client-ec2": "^3.357.0",
+    "@aws-sdk/client-s3": "^3.329.0",
+    "@aws-sdk/client-ssm": "^3.357.0",
+    "@aws-sdk/middleware-endpoint": "^3.329.0",
+    "@aws-sdk/s3-request-presigner": "^3.329.0",
+    "@bandada/api-sdk": "^1.0.0-beta.1",
+    "@devtion/actions": "latest",
+    "blakejs": "^1.2.1",
+    "dotenv": "^16.0.3",
+    "ethers": "5.7.2",
+    "firebase-admin": "^11.8.0",
+    "firebase-functions": "^4.4.0",
+    "html-entities": "^2.3.3",
+    "rimraf": "^5.0.0",
+    "rollup": "^3.21.6",
+    "snarkjs": "0.7.3",
+    "solc": "^0.8.19",
+    "timer-node": "^5.0.7",
+    "uuid": "^9.0.0",
+    "winston": "^3.8.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "8f3da5596cd864cdd387a32c05622efeaf0c10f7"
+}

package/src/functions/bandada.ts

@@ -0,0 +1,155 @@
+import dotenv from "dotenv"
+import * as functions from "firebase-functions"
+import { ApiSdk } from "@bandada/api-sdk"
+import { groth16 } from "snarkjs"
+import { getAuth } from "firebase-admin/auth"
+import admin from "firebase-admin"
+import { BandadaValidateProof, VerifiedBandadaResponse } from "../types/index"
+
+const VKEY_DATA = {
+    protocol: "groth16",
+    curve: "bn128",
+    nPublic: 3,
+    vk_alpha_1: [
+        "20491192805390485299153009773594534940189261866228447918068658471970481763042",
+        "9383485363053290200918347156157836566562967994039712273449902621266178545958",
+        "1"
+    ],
+    vk_beta_2: [
+        [
+            "6375614351688725206403948262868962793625744043794305715222011528459656738731",
+            "4252822878758300859123897981450591353533073413197771768651442665752259397132"
+        ],
+        [
+            "10505242626370262277552901082094356697409835680220590971873171140371331206856",
+            "21847035105528745403288232691147584728191162732299865338377159692350059136679"
+        ],
+        ["1", "0"]
+    ],
+    vk_gamma_2: [
+        [
+            "10857046999023057135944570762232829481370756359578518086990519993285655852781",
+            "11559732032986387107991004021392285783925812861821192530917403151452391805634"
+        ],
+        [
+            "8495653923123431417604973247489272438418190587263600148770280649306958101930",
+            "4082367875863433681332203403145435568316851327593401208105741076214120093531"
+        ],
+        ["1", "0"]
+    ],
+    vk_delta_2: [
+        [
+            "3697618915467790705869942236922063775466274665053173890632463796679068973252",
+            "14948341351907992175709156460547989243732741534604949238422596319735704165658"
+        ],
+        [
+            "3028459181652799888716942141752307629938889957960373621898607910203491239368",
+            "11380736494786911280692284374675752681598754560757720296073023058533044108340"
+        ],
+        ["1", "0"]
+    ],
+    vk_alphabeta_12: [
+        [
+            [
+                "2029413683389138792403550203267699914886160938906632433982220835551125967885",
+                "21072700047562757817161031222997517981543347628379360635925549008442030252106"
+            ],
+            [
+                "5940354580057074848093997050200682056184807770593307860589430076672439820312",
+                "12156638873931618554171829126792193045421052652279363021382169897324752428276"
+            ],
+            [
+                "7898200236362823042373859371574133993780991612861777490112507062703164551277",
+                "7074218545237549455313236346927434013100842096812539264420499035217050630853"
+            ]
+        ],
+        [
+            [
+                "7077479683546002997211712695946002074877511277312570035766170199895071832130",
+                "10093483419865920389913245021038182291233451549023025229112148274109565435465"
+            ],
+            [
+                "4595479056700221319381530156280926371456704509942304414423590385166031118820",
+                "19831328484489333784475432780421641293929726139240675179672856274388269393268"
+            ],
+            [
+                "11934129596455521040620786944827826205713621633706285934057045369193958244500",
+                "8037395052364110730298837004334506829870972346962140206007064471173334027475"
+            ]
+        ]
+    ],
+    IC: [
+        [
+            "12951059800758687233303204819298121944551181861362200875212570257618182506154",
+            "5751958719396509176593242305268064754837298673622815112953832050159760501392",
+            "1"
+        ],
+        [
+            "9561588427935871983444704959674198910445823619407211599507208879011862515257",
+            "14576201570478094842467636169770180675293504492823217349086195663150934064643",
+            "1"
+        ],
+        [
+            "4811967233483727873912563574622036989372099129165459921963463310078093941559",
+            "1874883809855039536107616044787862082553628089593740724610117059083415551067",
+            "1"
+        ],
+        [
+            "12252730267779308452229639835051322390696643456253768618882001876621526827161",
+            "7899194018737016222260328309937800777948677569409898603827268776967707173231",
+            "1"
+        ]
+    ]
+}
+
+dotenv.config()
+
+const { BANDADA_API_URL, BANDADA_GROUP_ID } = process.env
+
+const bandadaApi = new ApiSdk(BANDADA_API_URL)
+
+export const bandadaValidateProof = functions
+    .region("europe-west1")
+    .runWith({
+        memory: "512MB"
+    })
+    .https.onCall(async (data: BandadaValidateProof): Promise<VerifiedBandadaResponse> => {
+        if (!BANDADA_GROUP_ID) throw new Error("BANDADA_GROUP_ID is not defined in .env")
+
+        const { proof, publicSignals } = data
+        const isCorrect = groth16.verify(VKEY_DATA, publicSignals, proof)
+        if (!isCorrect)
+            return {
+                valid: false,
+                message: "Invalid proof",
+                token: ""
+            }
+
+        const commitment = data.publicSignals[1]
+        const isMember = await bandadaApi.isGroupMember(BANDADA_GROUP_ID, commitment)
+        if (!isMember)
+            return {
+                valid: false,
+                message: "Not a member of the group",
+                token: ""
+            }
+        const auth = getAuth()
+        try {
+            await admin.auth().createUser({
+                uid: commitment
+            })
+        } catch (error: any) {
+            // if user already exist then just pass
+            if (error.code !== "auth/uid-already-exists") {
+                throw new Error(error)
+            }
+        }
+        const token = await auth.createCustomToken(commitment)
+        return {
+            valid: true,
+            message: "Valid proof and group member",
+            token
+        }
+    })
+
+export default bandadaValidateProof