@devtion/devcli 0.0.0-a9e4cd4 → 0.0.0-bbc217a
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/.env +14 -0
- package/dist/index.js +437 -46
- package/dist/public/mini-semaphore.wasm +0 -0
- package/dist/public/mini-semaphore.zkey +0 -0
- package/dist/types/commands/authBandada.d.ts +2 -0
- package/dist/types/commands/authSIWE.d.ts +7 -0
- package/dist/types/commands/ceremony/index.d.ts +3 -0
- package/dist/types/commands/ceremony/listParticipants.d.ts +2 -0
- package/dist/types/commands/index.d.ts +2 -0
- package/dist/types/commands/setup.d.ts +2 -2
- package/dist/types/lib/bandada.d.ts +6 -0
- package/dist/types/lib/files.d.ts +1 -0
- package/dist/types/lib/localConfigs.d.ts +38 -0
- package/dist/types/lib/prompts.d.ts +1 -1
- package/dist/types/types/index.d.ts +69 -0
- package/package.json +10 -3
- package/src/commands/auth.ts +7 -1
- package/src/commands/authBandada.ts +120 -0
- package/src/commands/authSIWE.ts +185 -0
- package/src/commands/ceremony/index.ts +20 -0
- package/src/commands/ceremony/listParticipants.ts +56 -0
- package/src/commands/contribute.ts +47 -24
- package/src/commands/finalize.ts +8 -4
- package/src/commands/index.ts +2 -0
- package/src/commands/logout.ts +3 -1
- package/src/commands/observe.ts +5 -1
- package/src/commands/setup.ts +3 -3
- package/src/index.ts +18 -5
- package/src/lib/bandada.ts +51 -0
- package/src/lib/errors.ts +2 -2
- package/src/lib/localConfigs.ts +54 -0
- package/src/lib/prompts.ts +3 -6
- package/src/lib/services.ts +38 -13
- package/src/lib/utils.ts +7 -4
- package/src/types/index.ts +75 -0
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Auth command using Sign In With Ethereum
|
|
3
|
+
* @notice The auth command allows a user to make the association of their Ethereum account with the CLI by leveraging SIWE as an authentication mechanism.
|
|
4
|
+
* @dev Under the hood, the command handles a manual Device Flow following the guidelines in the SIWE documentation.
|
|
5
|
+
*/
|
|
6
|
+
declare const authSIWE: () => Promise<void>;
|
|
7
|
+
export default authSIWE;
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
export { default as setup } from "./setup.js";
|
|
2
2
|
export { default as auth } from "./auth.js";
|
|
3
|
+
export { default as authBandada } from "./authBandada.js";
|
|
4
|
+
export { default as authSIWE } from "./authSIWE.js";
|
|
3
5
|
export { default as contribute } from "./contribute.js";
|
|
4
6
|
export { default as observe } from "./observe.js";
|
|
5
7
|
export { default as finalize } from "./finalize.js";
|
|
@@ -27,7 +27,7 @@ export declare const handleAdditionOfCircuitsToCeremony: (r1csOptions: Array<str
|
|
|
27
27
|
export declare const displayCeremonySummary: (ceremonyInputData: CeremonyInputData, circuits: Array<CircuitDocument>) => void;
|
|
28
28
|
/**
|
|
29
29
|
* Check if the smallest Powers of Tau has already been downloaded/stored in the correspondent local path
|
|
30
|
-
* @dev we are downloading the Powers of Tau file from
|
|
30
|
+
* @dev we are downloading the Powers of Tau file from Perpetual Powers of Tau Phase 1 Trusted Setup.
|
|
31
31
|
* @param powers <string> - the smallest amount of powers needed for the given circuit (should be in a 'XY' stringified form).
|
|
32
32
|
* @param ptauCompleteFilename <string> - the complete file name of the powers of tau file to be downloaded.
|
|
33
33
|
* @returns <Promise<void>>
|
|
@@ -76,7 +76,7 @@ export declare const handleCircuitArtifactUploadToStorage: (firebaseFunctions: F
|
|
|
76
76
|
* @notice The setup command allows the coordinator of the ceremony to prepare the next ceremony by interacting with the CLI.
|
|
77
77
|
* @dev For proper execution, the command must be run in a folder containing the R1CS files related to the circuits
|
|
78
78
|
* for which the coordinator wants to create the ceremony. The command will download the necessary Tau powers
|
|
79
|
-
* from
|
|
79
|
+
* from PPoT ceremony Phase 1 Setup Ceremony.
|
|
80
80
|
* @param cmd? <any> - the path to the ceremony setup file.
|
|
81
81
|
*/
|
|
82
82
|
declare const setup: (cmd: {
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { GroupResponse } from "@bandada/api-sdk";
|
|
2
|
+
import { Identity } from "@semaphore-protocol/identity";
|
|
3
|
+
export declare const getGroup: (groupId: string) => Promise<GroupResponse | null>;
|
|
4
|
+
export declare const getMembersOfGroup: (groupId: string) => Promise<string[] | null>;
|
|
5
|
+
export declare const addMemberToGroup: (groupId: string, dashboardUrl: string, identity: Identity) => Promise<void>;
|
|
6
|
+
export declare const isGroupMember: (groupId: string, identity: Identity) => Promise<boolean>;
|
|
@@ -35,6 +35,44 @@ export declare const setLocalAccessToken: (token: string) => void;
|
|
|
35
35
|
* Delete the stored access token.
|
|
36
36
|
*/
|
|
37
37
|
export declare const deleteLocalAccessToken: () => void;
|
|
38
|
+
/**
|
|
39
|
+
* Return the Bandada identity, if present.
|
|
40
|
+
* @returns <string | undefined> - the Bandada identity if present, otherwise undefined.
|
|
41
|
+
*/
|
|
42
|
+
export declare const getLocalBandadaIdentity: () => string | unknown;
|
|
43
|
+
/**
|
|
44
|
+
* Check if the Bandada identity exists in the local storage.
|
|
45
|
+
* @returns <boolean>
|
|
46
|
+
*/
|
|
47
|
+
export declare const checkLocalBandadaIdentity: () => boolean;
|
|
48
|
+
/**
|
|
49
|
+
* Set the Bandada identity.
|
|
50
|
+
* @param identity <string> - the Bandada identity to be stored.
|
|
51
|
+
*/
|
|
52
|
+
export declare const setLocalBandadaIdentity: (identity: string) => void;
|
|
53
|
+
/**
|
|
54
|
+
* Delete the stored Bandada identity.
|
|
55
|
+
*/
|
|
56
|
+
export declare const deleteLocalBandadaIdentity: () => void;
|
|
57
|
+
/**
|
|
58
|
+
* Return the authentication method, if present.
|
|
59
|
+
* @returns <string | undefined> - the authentication method if present, otherwise undefined.
|
|
60
|
+
*/
|
|
61
|
+
export declare const getLocalAuthMethod: () => string | unknown;
|
|
62
|
+
/**
|
|
63
|
+
* Check if the authentication method exists in the local storage.
|
|
64
|
+
* @returns <boolean>
|
|
65
|
+
*/
|
|
66
|
+
export declare const checkLocalAuthMethod: () => boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Set the authentication method.
|
|
69
|
+
* @param method <string> - the authentication method to be stored.
|
|
70
|
+
*/
|
|
71
|
+
export declare const setLocalAuthMethod: (method: string) => void;
|
|
72
|
+
/**
|
|
73
|
+
* Delete the stored authentication method.
|
|
74
|
+
*/
|
|
75
|
+
export declare const deleteLocalAuthMethod: () => void;
|
|
38
76
|
/**
|
|
39
77
|
* Get the complete local file path.
|
|
40
78
|
* @param cwd <string> - the current working directory path.
|
|
@@ -90,7 +90,7 @@ export declare const promptPotSelector: (options: Array<string>) => Promise<stri
|
|
|
90
90
|
* @param isFinalizing <boolean> - true when the coordinator must select a ceremony for finalization; otherwise false (participant selects a ceremony for contribution).
|
|
91
91
|
* @returns Promise<FirebaseDocumentInfo> - the Firestore document of the selected ceremony.
|
|
92
92
|
*/
|
|
93
|
-
export declare const promptForCeremonySelection: (ceremoniesDocuments: Array<FirebaseDocumentInfo>, isFinalizing: boolean) => Promise<FirebaseDocumentInfo>;
|
|
93
|
+
export declare const promptForCeremonySelection: (ceremoniesDocuments: Array<FirebaseDocumentInfo>, isFinalizing: boolean, messageToDisplay?: string) => Promise<FirebaseDocumentInfo>;
|
|
94
94
|
/**
|
|
95
95
|
* Prompt the participant to type the entropy or the coordinator to type the beacon.
|
|
96
96
|
* @param isEntropy <boolean> - true when prompting for typing entropy; otherwise false.
|
|
@@ -63,3 +63,72 @@ export type GithubGistFile = {
|
|
|
63
63
|
raw_url: string;
|
|
64
64
|
size: number;
|
|
65
65
|
};
|
|
66
|
+
/**
|
|
67
|
+
* Define the return object of the function that verifies the Bandada membership and proof.
|
|
68
|
+
* @typedef {Object} VerifiedBandadaResponse
|
|
69
|
+
* @property {boolean} valid - true if the proof is valid and the user is a member of the group; otherwise false.
|
|
70
|
+
* @property {string} message - a message describing the result of the verification.
|
|
71
|
+
* @property {string} token - the custom access token.
|
|
72
|
+
*/
|
|
73
|
+
export type VerifiedBandadaResponse = {
|
|
74
|
+
valid: boolean;
|
|
75
|
+
message: string;
|
|
76
|
+
token: string;
|
|
77
|
+
};
|
|
78
|
+
/**
|
|
79
|
+
* Define the return object of the device code uri request.
|
|
80
|
+
* @typedef {Object} OAuthDeviceCodeResponse
|
|
81
|
+
* @property {string} device_code - the device code.
|
|
82
|
+
* @property {string} user_code - the user code.
|
|
83
|
+
* @property {string} verification_uri - the verification uri.
|
|
84
|
+
* @property {number} expires_in - the expiration time in seconds.
|
|
85
|
+
* @property {number} interval - the interval time in seconds.
|
|
86
|
+
* @property {string} verification_uri_complete - the complete verification uri.
|
|
87
|
+
* @property {string} error - in case there was an error, show the code
|
|
88
|
+
* @property {string} error_description - error details.
|
|
89
|
+
* @property {string} error_uri - error uri.
|
|
90
|
+
*/
|
|
91
|
+
export type OAuthDeviceCodeResponse = {
|
|
92
|
+
device_code: string;
|
|
93
|
+
user_code: string;
|
|
94
|
+
verification_uri: string;
|
|
95
|
+
expires_in: number;
|
|
96
|
+
interval: number;
|
|
97
|
+
verification_uri_complete: string;
|
|
98
|
+
error?: string;
|
|
99
|
+
error_description?: string;
|
|
100
|
+
error_uri?: string;
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* Define the return object of the polling endpoint
|
|
104
|
+
* @typedef {Object} OAuthTokenResponse
|
|
105
|
+
* @property {string} access_token - the resulting device flow token
|
|
106
|
+
* @property {string} token_type - token type
|
|
107
|
+
* @property {number} expires_in - when does the token expires
|
|
108
|
+
* @property {string} scope - the scope requested by the initial device flow endpoint
|
|
109
|
+
* @property {string} refresh_token - refresh token
|
|
110
|
+
* @property {string} id_token - id token
|
|
111
|
+
* @property {string} error - in case there was an error, show the code
|
|
112
|
+
* @property {string} error_description - error details
|
|
113
|
+
*/
|
|
114
|
+
export type OAuthTokenResponse = {
|
|
115
|
+
access_token: string;
|
|
116
|
+
token_type: string;
|
|
117
|
+
expires_in: number;
|
|
118
|
+
scope: string;
|
|
119
|
+
refresh_token: string;
|
|
120
|
+
id_token: string;
|
|
121
|
+
error?: string;
|
|
122
|
+
error_description?: string;
|
|
123
|
+
};
|
|
124
|
+
/**
|
|
125
|
+
* @typedef {Object} CheckNonceOfSIWEAddressResponse
|
|
126
|
+
* @property {boolean} valid - if the checking was valid or not
|
|
127
|
+
* @property {string} message - more information about the validity
|
|
128
|
+
* @property {string} token - token to sign into Firebase
|
|
129
|
+
*/
|
|
130
|
+
export type CheckNonceOfSIWEAddressResponse = {
|
|
131
|
+
valid: boolean;
|
|
132
|
+
message: string;
|
|
133
|
+
token: string;
|
|
134
|
+
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@devtion/devcli",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-bbc217a",
|
|
5
5
|
"description": "All-in-one interactive command-line for interfacing with zkSNARK Phase 2 Trusted Setup ceremonies",
|
|
6
6
|
"repository": "git@github.com:privacy-scaling-explorations/p0tion.git",
|
|
7
7
|
"homepage": "https://github.com/privacy-scaling-explorations/p0tion",
|
|
@@ -34,11 +34,14 @@
|
|
|
34
34
|
"build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
|
|
35
35
|
"start": "ts-node --esm ./src/index.ts",
|
|
36
36
|
"auth": "yarn start auth",
|
|
37
|
+
"auth:siwe": "yarn start auth-siwe",
|
|
38
|
+
"auth:bandada": "yarn start auth-bandada",
|
|
37
39
|
"contribute": "yarn start contribute",
|
|
38
40
|
"clean": "yarn start clean",
|
|
39
41
|
"list": "yarn start list",
|
|
40
42
|
"logout": "yarn start logout",
|
|
41
43
|
"validate": "yarn start validate",
|
|
44
|
+
"ceremony:participants": "yarn start ceremony participants",
|
|
42
45
|
"coordinate:setup": "yarn start coordinate setup",
|
|
43
46
|
"coordinate:observe": "yarn start coordinate observe",
|
|
44
47
|
"coordinate:finalize": "yarn start coordinate finalize",
|
|
@@ -57,6 +60,7 @@
|
|
|
57
60
|
"@types/winston": "^2.4.4",
|
|
58
61
|
"rollup-plugin-auto-external": "^2.0.0",
|
|
59
62
|
"rollup-plugin-cleanup": "^3.2.1",
|
|
63
|
+
"rollup-plugin-copy": "^3.5.0",
|
|
60
64
|
"rollup-plugin-typescript2": "^0.34.1",
|
|
61
65
|
"solc": "^0.8.19",
|
|
62
66
|
"ts-node": "^10.9.1",
|
|
@@ -65,10 +69,12 @@
|
|
|
65
69
|
"dependencies": {
|
|
66
70
|
"@adobe/node-fetch-retry": "^2.2.0",
|
|
67
71
|
"@aws-sdk/client-s3": "^3.329.0",
|
|
72
|
+
"@bandada/api-sdk": "^1.0.0-beta.1",
|
|
68
73
|
"@devtion/actions": "latest",
|
|
69
74
|
"@octokit/auth-oauth-app": "^5.0.5",
|
|
70
75
|
"@octokit/auth-oauth-device": "^4.0.4",
|
|
71
76
|
"@octokit/request": "^6.2.3",
|
|
77
|
+
"@semaphore-protocol/identity": "^3.15.1",
|
|
72
78
|
"blakejs": "^1.2.1",
|
|
73
79
|
"boxen": "^7.1.0",
|
|
74
80
|
"chalk": "^5.2.0",
|
|
@@ -78,6 +84,7 @@
|
|
|
78
84
|
"commander": "^10.0.1",
|
|
79
85
|
"conf": "^11.0.1",
|
|
80
86
|
"dotenv": "^16.0.3",
|
|
87
|
+
"ethers": "^6.9.0",
|
|
81
88
|
"figlet": "^1.6.0",
|
|
82
89
|
"firebase": "^9.21.0",
|
|
83
90
|
"log-symbols": "^5.1.0",
|
|
@@ -90,12 +97,12 @@
|
|
|
90
97
|
"prompts": "^2.4.2",
|
|
91
98
|
"rimraf": "^5.0.0",
|
|
92
99
|
"rollup": "^3.21.6",
|
|
93
|
-
"snarkjs": "
|
|
100
|
+
"snarkjs": "0.7.3",
|
|
94
101
|
"timer-node": "^5.0.7",
|
|
95
102
|
"winston": "^3.8.2"
|
|
96
103
|
},
|
|
97
104
|
"publishConfig": {
|
|
98
105
|
"access": "public"
|
|
99
106
|
},
|
|
100
|
-
"gitHead": "
|
|
107
|
+
"gitHead": "41d13d724d628f5901ece1ef659d1a554c0db8d9"
|
|
101
108
|
}
|
package/src/commands/auth.ts
CHANGED
|
@@ -8,7 +8,12 @@ import figlet from "figlet"
|
|
|
8
8
|
import { fileURLToPath } from "url"
|
|
9
9
|
import { dirname } from "path"
|
|
10
10
|
import { GENERIC_ERRORS, showError } from "../lib/errors.js"
|
|
11
|
-
import {
|
|
11
|
+
import {
|
|
12
|
+
checkLocalAccessToken,
|
|
13
|
+
getLocalAccessToken,
|
|
14
|
+
setLocalAccessToken,
|
|
15
|
+
setLocalAuthMethod
|
|
16
|
+
} from "../lib/localConfigs.js"
|
|
12
17
|
import { bootstrapCommandExecutionAndServices, signInToFirebase } from "../lib/services.js"
|
|
13
18
|
import theme from "../lib/theme.js"
|
|
14
19
|
import {
|
|
@@ -171,6 +176,7 @@ const auth = async () => {
|
|
|
171
176
|
const newToken = await executeGithubDeviceFlow(String(process.env.AUTH_GITHUB_CLIENT_ID))
|
|
172
177
|
|
|
173
178
|
// Store the new access token.
|
|
179
|
+
setLocalAuthMethod("github")
|
|
174
180
|
setLocalAccessToken(newToken)
|
|
175
181
|
} else spinner.succeed(`Local authentication token found\n`)
|
|
176
182
|
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
import { Identity } from "@semaphore-protocol/identity"
|
|
2
|
+
|
|
3
|
+
import { commonTerms } from "@devtion/actions"
|
|
4
|
+
import { httpsCallable } from "firebase/functions"
|
|
5
|
+
import { groth16 } from "snarkjs"
|
|
6
|
+
import { getAuth, signInWithCustomToken } from "firebase/auth"
|
|
7
|
+
import prompts from "prompts"
|
|
8
|
+
import { getLocalDirname } from "../lib/files.js"
|
|
9
|
+
import theme from "../lib/theme.js"
|
|
10
|
+
import { customSpinner } from "../lib/utils.js"
|
|
11
|
+
import { VerifiedBandadaResponse } from "../types/index.js"
|
|
12
|
+
import { showError } from "../lib/errors.js"
|
|
13
|
+
import { bootstrapCommandExecutionAndServices } from "../lib/services.js"
|
|
14
|
+
import { addMemberToGroup, isGroupMember } from "../lib/bandada.js"
|
|
15
|
+
import {
|
|
16
|
+
checkLocalBandadaIdentity,
|
|
17
|
+
deleteLocalAccessToken,
|
|
18
|
+
deleteLocalAuthMethod,
|
|
19
|
+
deleteLocalBandadaIdentity,
|
|
20
|
+
getLocalBandadaIdentity,
|
|
21
|
+
setLocalAccessToken,
|
|
22
|
+
setLocalAuthMethod,
|
|
23
|
+
setLocalBandadaIdentity
|
|
24
|
+
} from "../lib/localConfigs.js"
|
|
25
|
+
|
|
26
|
+
const { BANDADA_DASHBOARD_URL, BANDADA_GROUP_ID } = process.env
|
|
27
|
+
|
|
28
|
+
const authBandada = async () => {
|
|
29
|
+
try {
|
|
30
|
+
const { firebaseFunctions } = await bootstrapCommandExecutionAndServices()
|
|
31
|
+
const spinner = customSpinner(`Checking identity string for Semaphore...`, `clock`)
|
|
32
|
+
spinner.start()
|
|
33
|
+
// 1. check if _identity string exists in local storage
|
|
34
|
+
let identityString: string | unknown
|
|
35
|
+
const isIdentityStringStored = checkLocalBandadaIdentity()
|
|
36
|
+
if (isIdentityStringStored) {
|
|
37
|
+
identityString = getLocalBandadaIdentity()
|
|
38
|
+
spinner.succeed(`Identity seed found\n`)
|
|
39
|
+
} else {
|
|
40
|
+
spinner.warn(`Identity seed not found\n`)
|
|
41
|
+
// 2. generate a random _identity string and save it in local storage
|
|
42
|
+
const { seed } = await prompts({
|
|
43
|
+
type: "text",
|
|
44
|
+
name: "seed",
|
|
45
|
+
message: theme.text.bold(`Enter a secret string to use as your identity seed in Semaphore:`),
|
|
46
|
+
initial: false
|
|
47
|
+
})
|
|
48
|
+
identityString = seed as string
|
|
49
|
+
setLocalBandadaIdentity(identityString as string)
|
|
50
|
+
}
|
|
51
|
+
// 3. create a semaphore identity with _identity string as a seed
|
|
52
|
+
const identity = new Identity(identityString as string)
|
|
53
|
+
|
|
54
|
+
// 4. check if the user is a member of the group
|
|
55
|
+
console.log(`Checking Bandada membership...`)
|
|
56
|
+
const isMember = await isGroupMember(BANDADA_GROUP_ID, identity)
|
|
57
|
+
if (!isMember) {
|
|
58
|
+
await addMemberToGroup(BANDADA_GROUP_ID, BANDADA_DASHBOARD_URL, identity)
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
// 5. generate a proof that the user owns the commitment.
|
|
62
|
+
spinner.text = `Generating proof of identity...`
|
|
63
|
+
spinner.start()
|
|
64
|
+
// publicSignals = [hash(externalNullifier, identityNullifier), commitment]
|
|
65
|
+
|
|
66
|
+
const initDirectoryName = getLocalDirname()
|
|
67
|
+
const directoryName = initDirectoryName.includes("/src") ? "." : initDirectoryName
|
|
68
|
+
|
|
69
|
+
const { proof, publicSignals } = await groth16.fullProve(
|
|
70
|
+
{
|
|
71
|
+
identityTrapdoor: identity.trapdoor,
|
|
72
|
+
identityNullifier: identity.nullifier,
|
|
73
|
+
externalNullifier: BANDADA_GROUP_ID
|
|
74
|
+
},
|
|
75
|
+
`${directoryName}/public/mini-semaphore.wasm`,
|
|
76
|
+
`${directoryName}/public/mini-semaphore.zkey`
|
|
77
|
+
)
|
|
78
|
+
spinner.succeed(`Proof generated.\n`)
|
|
79
|
+
spinner.text = `Sending proof to verification...`
|
|
80
|
+
spinner.start()
|
|
81
|
+
// 6. send proof to a cloud function that verifies it and checks membership
|
|
82
|
+
const cf = httpsCallable(firebaseFunctions, commonTerms.cloudFunctionsNames.bandadaValidateProof)
|
|
83
|
+
const result = await cf({
|
|
84
|
+
proof,
|
|
85
|
+
publicSignals
|
|
86
|
+
})
|
|
87
|
+
const { valid, token, message } = result.data as VerifiedBandadaResponse
|
|
88
|
+
if (!valid) {
|
|
89
|
+
showError(message, true)
|
|
90
|
+
deleteLocalAuthMethod()
|
|
91
|
+
deleteLocalAccessToken()
|
|
92
|
+
deleteLocalBandadaIdentity()
|
|
93
|
+
}
|
|
94
|
+
spinner.succeed(`Proof verified.\n`)
|
|
95
|
+
spinner.text = `Authenticating...`
|
|
96
|
+
spinner.start()
|
|
97
|
+
// 7. Auth to p0tion firebase
|
|
98
|
+
const credentials = await signInWithCustomToken(getAuth(), token)
|
|
99
|
+
setLocalAuthMethod("bandada")
|
|
100
|
+
setLocalAccessToken(token)
|
|
101
|
+
spinner.succeed(`Authenticated as ${theme.text.bold(credentials.user.uid)}.`)
|
|
102
|
+
|
|
103
|
+
console.log(
|
|
104
|
+
`\n${theme.symbols.warning} You can always log out by running the ${theme.text.bold(
|
|
105
|
+
`phase2cli logout`
|
|
106
|
+
)} command`
|
|
107
|
+
)
|
|
108
|
+
} catch (error) {
|
|
109
|
+
// Delete local token.
|
|
110
|
+
console.log("An error crashed the process. Deleting local token and identity.")
|
|
111
|
+
console.error(error)
|
|
112
|
+
deleteLocalAuthMethod()
|
|
113
|
+
deleteLocalAccessToken()
|
|
114
|
+
deleteLocalBandadaIdentity()
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
process.exit(0)
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
export default authBandada
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import open from "open"
|
|
2
|
+
import figlet from "figlet"
|
|
3
|
+
import clipboard from "clipboardy"
|
|
4
|
+
import fetch from "node-fetch"
|
|
5
|
+
import { getAuth, signInWithCustomToken } from "firebase/auth"
|
|
6
|
+
import { httpsCallable } from "firebase/functions"
|
|
7
|
+
import { commonTerms } from "@devtion/actions"
|
|
8
|
+
import { showError } from "../lib/errors.js"
|
|
9
|
+
import { bootstrapCommandExecutionAndServices } from "../lib/services.js"
|
|
10
|
+
import theme from "../lib/theme.js"
|
|
11
|
+
import { customSpinner, sleep } from "../lib/utils.js"
|
|
12
|
+
import { CheckNonceOfSIWEAddressResponse, OAuthDeviceCodeResponse, OAuthTokenResponse } from "../types/index.js"
|
|
13
|
+
import {
|
|
14
|
+
checkLocalAccessToken,
|
|
15
|
+
deleteLocalAccessToken,
|
|
16
|
+
deleteLocalAuthMethod,
|
|
17
|
+
getLocalAccessToken,
|
|
18
|
+
setLocalAccessToken,
|
|
19
|
+
setLocalAuthMethod
|
|
20
|
+
} from "../lib/localConfigs.js"
|
|
21
|
+
|
|
22
|
+
const showVerificationCodeAndUri = async (OAuthDeviceCode: OAuthDeviceCodeResponse) => {
|
|
23
|
+
// Copy code to clipboard.
|
|
24
|
+
let noClipboard = false
|
|
25
|
+
try {
|
|
26
|
+
clipboard.writeSync(OAuthDeviceCode.user_code)
|
|
27
|
+
clipboard.readSync()
|
|
28
|
+
} catch (error) {
|
|
29
|
+
noClipboard = true
|
|
30
|
+
}
|
|
31
|
+
// Display data.
|
|
32
|
+
console.log(
|
|
33
|
+
`${theme.symbols.warning} Visit ${theme.text.bold(
|
|
34
|
+
theme.text.underlined(OAuthDeviceCode.verification_uri_complete)
|
|
35
|
+
)} on this device to generate a new token and authenticate\n`
|
|
36
|
+
)
|
|
37
|
+
console.log(theme.colors.magenta(figlet.textSync("Code is Below", { font: "ANSI Shadow" })), "\n")
|
|
38
|
+
|
|
39
|
+
const message = !noClipboard ? `has been copied to your clipboard (${theme.emojis.clipboard})` : ``
|
|
40
|
+
console.log(
|
|
41
|
+
`${theme.symbols.info} Your auth code: ${theme.text.bold(OAuthDeviceCode.user_code)} ${message} ${
|
|
42
|
+
theme.symbols.success
|
|
43
|
+
}\n`
|
|
44
|
+
)
|
|
45
|
+
const spinner = customSpinner(`Redirecting to Sign In With Ethereum...`, `clock`)
|
|
46
|
+
spinner.start()
|
|
47
|
+
await sleep(10000) // ~10s to make users able to read the CLI.
|
|
48
|
+
try {
|
|
49
|
+
// Automatically open the page (# Step 2).
|
|
50
|
+
await open(OAuthDeviceCode.verification_uri_complete)
|
|
51
|
+
} catch (error: any) {
|
|
52
|
+
console.log(
|
|
53
|
+
`${theme.symbols.info} Please authenticate via SIWE at ${OAuthDeviceCode.verification_uri_complete}`
|
|
54
|
+
)
|
|
55
|
+
}
|
|
56
|
+
spinner.stop()
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Return the token to sign in to Firebase after passing the SIWE Device Flow
|
|
61
|
+
* @param clientId <string> - The client id of the Auth0 application.
|
|
62
|
+
* @param firebaseFunctions <any> - The Firebase functions instance to call the cloud function
|
|
63
|
+
* @returns <string> - The token to sign in to Firebase
|
|
64
|
+
*/
|
|
65
|
+
const executeSIWEDeviceFlow = async (clientId: string, firebaseFunctions: any): Promise<string> => {
|
|
66
|
+
// Call Auth0 endpoint to request device code uri
|
|
67
|
+
const OAuthDeviceCode = (await fetch(`${process.env.AUTH0_APPLICATION_URL}/oauth/device/code`, {
|
|
68
|
+
method: "POST",
|
|
69
|
+
headers: { "content-type": "application/json" },
|
|
70
|
+
body: JSON.stringify({
|
|
71
|
+
client_id: clientId,
|
|
72
|
+
scope: "openid",
|
|
73
|
+
audience: `${process.env.AUTH0_APPLICATION_URL}/api/v2/`
|
|
74
|
+
})
|
|
75
|
+
}).then((_res) => _res.json())) as OAuthDeviceCodeResponse
|
|
76
|
+
if (OAuthDeviceCode.error) {
|
|
77
|
+
showError(OAuthDeviceCode.error_description, true)
|
|
78
|
+
deleteLocalAuthMethod()
|
|
79
|
+
deleteLocalAccessToken()
|
|
80
|
+
}
|
|
81
|
+
await showVerificationCodeAndUri(OAuthDeviceCode)
|
|
82
|
+
// Poll Auth0 endpoint until you get token or request expires
|
|
83
|
+
let isSignedIn = false
|
|
84
|
+
let isExpired = false
|
|
85
|
+
let auth0Token = ""
|
|
86
|
+
while (!isSignedIn && !isExpired) {
|
|
87
|
+
// Call Auth0 endpoint to request token
|
|
88
|
+
const OAuthToken = (await fetch(`${process.env.AUTH0_APPLICATION_URL}/oauth/token`, {
|
|
89
|
+
method: "POST",
|
|
90
|
+
headers: { "content-type": "application/json" },
|
|
91
|
+
body: JSON.stringify({
|
|
92
|
+
client_id: clientId,
|
|
93
|
+
device_code: OAuthDeviceCode.device_code,
|
|
94
|
+
grant_type: "urn:ietf:params:oauth:grant-type:device_code"
|
|
95
|
+
})
|
|
96
|
+
}).then((_res) => _res.json())) as OAuthTokenResponse
|
|
97
|
+
if (OAuthToken.error) {
|
|
98
|
+
if (OAuthToken.error === "authorization_pending") {
|
|
99
|
+
// Wait for the user to sign in
|
|
100
|
+
await sleep(OAuthDeviceCode.interval * 1000)
|
|
101
|
+
} else if (OAuthToken.error === "slow_down") {
|
|
102
|
+
// Wait for the user to sign in
|
|
103
|
+
await sleep(OAuthDeviceCode.interval * 1000 * 2)
|
|
104
|
+
} else if (OAuthToken.error === "expired_token") {
|
|
105
|
+
// The user didn't sign in on time
|
|
106
|
+
isExpired = true
|
|
107
|
+
}
|
|
108
|
+
} else {
|
|
109
|
+
// The user signed in
|
|
110
|
+
isSignedIn = true
|
|
111
|
+
auth0Token = OAuthToken.access_token
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
// Send token to cloud function to check nonce, create user and retrieve token
|
|
115
|
+
const cf = httpsCallable(firebaseFunctions, commonTerms.cloudFunctionsNames.checkNonceOfSIWEAddress)
|
|
116
|
+
const result = await cf({
|
|
117
|
+
auth0Token
|
|
118
|
+
})
|
|
119
|
+
const { token, valid, message } = result.data as CheckNonceOfSIWEAddressResponse
|
|
120
|
+
if (!valid) {
|
|
121
|
+
showError(message, true)
|
|
122
|
+
deleteLocalAuthMethod()
|
|
123
|
+
deleteLocalAccessToken()
|
|
124
|
+
}
|
|
125
|
+
return token
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Auth command using Sign In With Ethereum
|
|
130
|
+
* @notice The auth command allows a user to make the association of their Ethereum account with the CLI by leveraging SIWE as an authentication mechanism.
|
|
131
|
+
* @dev Under the hood, the command handles a manual Device Flow following the guidelines in the SIWE documentation.
|
|
132
|
+
*/
|
|
133
|
+
const authSIWE = async () => {
|
|
134
|
+
try {
|
|
135
|
+
const { firebaseFunctions } = await bootstrapCommandExecutionAndServices()
|
|
136
|
+
// Console more context for the user.
|
|
137
|
+
console.log(
|
|
138
|
+
`${theme.symbols.info} ${theme.text.bold(
|
|
139
|
+
`You are about to authenticate on this CLI using your Ethereum address (device flow - OAuth 2.0 mechanism).\n${theme.symbols.warning} Please, note that only a Sign-in With Ethereum signature will be required`
|
|
140
|
+
)}\n`
|
|
141
|
+
)
|
|
142
|
+
const spinner = customSpinner(`Checking authentication token...`, `clock`)
|
|
143
|
+
spinner.start()
|
|
144
|
+
await sleep(5000)
|
|
145
|
+
|
|
146
|
+
// Manage OAuth Github or SIWE token.
|
|
147
|
+
const isLocalTokenStored = checkLocalAccessToken()
|
|
148
|
+
|
|
149
|
+
if (!isLocalTokenStored) {
|
|
150
|
+
spinner.fail(`No local authentication token found\n`)
|
|
151
|
+
|
|
152
|
+
// Generate a new access token using Github Device Flow (OAuth 2.0).
|
|
153
|
+
const newToken = await executeSIWEDeviceFlow(String(process.env.AUTH_SIWE_CLIENT_ID), firebaseFunctions)
|
|
154
|
+
|
|
155
|
+
// Store the new access token.
|
|
156
|
+
setLocalAuthMethod("siwe")
|
|
157
|
+
setLocalAccessToken(newToken)
|
|
158
|
+
} else spinner.succeed(`Local authentication token found\n`)
|
|
159
|
+
|
|
160
|
+
// Get access token from local store.
|
|
161
|
+
const token = String(getLocalAccessToken())
|
|
162
|
+
|
|
163
|
+
spinner.text = `Authenticating...`
|
|
164
|
+
spinner.start()
|
|
165
|
+
|
|
166
|
+
// Exchange token for credential.
|
|
167
|
+
const credentials = await signInWithCustomToken(getAuth(), token)
|
|
168
|
+
spinner.succeed(`Authenticated as ${theme.text.bold(credentials.user.uid)}.`)
|
|
169
|
+
|
|
170
|
+
console.log(
|
|
171
|
+
`\n${theme.symbols.warning} You can always log out by running the ${theme.text.bold(
|
|
172
|
+
`phase2cli logout`
|
|
173
|
+
)} command`
|
|
174
|
+
)
|
|
175
|
+
process.exit(0)
|
|
176
|
+
} catch (error) {
|
|
177
|
+
// Delete local token.
|
|
178
|
+
console.log("An error crashed the process. Deleting local token and identity.")
|
|
179
|
+
console.error(error)
|
|
180
|
+
deleteLocalAuthMethod()
|
|
181
|
+
deleteLocalAccessToken()
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
export default authSIWE
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Command } from "commander"
|
|
2
|
+
import listParticipants from "./listParticipants.js"
|
|
3
|
+
|
|
4
|
+
const setCeremonyCommands = (program: Command) => {
|
|
5
|
+
const ceremony = program.command("ceremony").description("manage ceremonies")
|
|
6
|
+
|
|
7
|
+
ceremony
|
|
8
|
+
.command("participants")
|
|
9
|
+
.description("retrieve participants list of a ceremony")
|
|
10
|
+
.requiredOption(
|
|
11
|
+
"-c, --ceremony <string>",
|
|
12
|
+
"the prefix of the ceremony you want to retrieve information about",
|
|
13
|
+
""
|
|
14
|
+
)
|
|
15
|
+
.action(listParticipants)
|
|
16
|
+
|
|
17
|
+
return ceremony
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export default setCeremonyCommands
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { collection, doc, getDocs } from "firebase/firestore"
|
|
2
|
+
import { ParticipantDocument, UserDocument, commonTerms, getAllCeremonies } from "@devtion/actions"
|
|
3
|
+
import theme from "../../lib/theme.js"
|
|
4
|
+
import { bootstrapCommandExecutionAndServices } from "../../lib/services.js"
|
|
5
|
+
import { showError } from "../../lib/errors.js"
|
|
6
|
+
import { promptForCeremonySelection } from "../../lib/prompts.js"
|
|
7
|
+
|
|
8
|
+
const listParticipants = async () => {
|
|
9
|
+
try {
|
|
10
|
+
const { firestoreDatabase } = await bootstrapCommandExecutionAndServices()
|
|
11
|
+
|
|
12
|
+
const allCeremonies = await getAllCeremonies(firestoreDatabase)
|
|
13
|
+
const selectedCeremony = await promptForCeremonySelection(
|
|
14
|
+
allCeremonies,
|
|
15
|
+
true,
|
|
16
|
+
"Which ceremony would you like to see participants?"
|
|
17
|
+
)
|
|
18
|
+
|
|
19
|
+
const docRef = doc(firestoreDatabase, commonTerms.collections.ceremonies.name, selectedCeremony.id)
|
|
20
|
+
const participantsRef = collection(docRef, "participants")
|
|
21
|
+
const participantsSnapshot = await getDocs(participantsRef)
|
|
22
|
+
const participants = participantsSnapshot.docs.map(
|
|
23
|
+
(participantDoc) => participantDoc.data() as ParticipantDocument
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
const usersRef = collection(firestoreDatabase, "users")
|
|
27
|
+
const usersSnapshot = await getDocs(usersRef)
|
|
28
|
+
const users = usersSnapshot.docs.map((userDoc) => {
|
|
29
|
+
const data = userDoc.data() as UserDocument
|
|
30
|
+
return { id: userDoc.id, ...data }
|
|
31
|
+
})
|
|
32
|
+
|
|
33
|
+
const participantDetails = participants
|
|
34
|
+
.map((participant) => {
|
|
35
|
+
const user = users.find((_user) => _user.id === participant.userId)
|
|
36
|
+
if (!user) return null
|
|
37
|
+
return {
|
|
38
|
+
id: user.name,
|
|
39
|
+
status: participant.status,
|
|
40
|
+
contributionStep: participant.contributionStep,
|
|
41
|
+
lastUpdated: new Date(participant.lastUpdated)
|
|
42
|
+
}
|
|
43
|
+
})
|
|
44
|
+
.filter((user) => user !== null)
|
|
45
|
+
|
|
46
|
+
const participantsDone = participantDetails.filter((participant) => participant.status === "DONE")
|
|
47
|
+
console.log(participantDetails)
|
|
48
|
+
console.log(`${theme.text.underlined("Total participants:")} ${participantDetails.length}`)
|
|
49
|
+
console.log(`${theme.text.underlined("Total participants finished:")} ${participantsDone.length}`)
|
|
50
|
+
} catch (err: any) {
|
|
51
|
+
showError(`Something went wrong: ${err.toString()}`, true)
|
|
52
|
+
}
|
|
53
|
+
process.exit(0)
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export default listParticipants
|