@devtion/devcli 0.0.0-4f2b2be → 0.0.0-521e678
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/README.md +1 -1
- package/dist/.env +3 -3
- package/dist/index.js +116 -65
- package/dist/types/commands/finalize.d.ts +3 -2
- package/dist/types/commands/setup.d.ts +1 -1
- package/dist/types/lib/prompts.d.ts +5 -5
- package/dist/types/lib/utils.d.ts +2 -1
- package/package.json +2 -2
- package/src/commands/auth.ts +18 -8
- package/src/commands/contribute.ts +11 -7
- package/src/commands/finalize.ts +18 -9
- package/src/commands/index.ts +1 -1
- package/src/commands/listCeremonies.ts +1 -2
- package/src/commands/observe.ts +2 -2
- package/src/commands/setup.ts +59 -27
- package/src/commands/validate.ts +1 -2
- package/src/index.ts +17 -8
- package/src/lib/prompts.ts +19 -19
- package/src/lib/services.ts +0 -2
- package/src/lib/utils.ts +41 -8
package/src/commands/auth.ts
CHANGED
|
@@ -63,8 +63,13 @@ export const expirationCountdownForGithubOAuth = (expirationInSeconds: number) =
|
|
|
63
63
|
*/
|
|
64
64
|
export const onVerification = async (verification: Verification): Promise<void> => {
|
|
65
65
|
// Copy code to clipboard.
|
|
66
|
-
|
|
67
|
-
|
|
66
|
+
let noClipboard = false
|
|
67
|
+
try {
|
|
68
|
+
clipboard.writeSync(verification.user_code)
|
|
69
|
+
clipboard.readSync()
|
|
70
|
+
} catch (error) {
|
|
71
|
+
noClipboard = true
|
|
72
|
+
}
|
|
68
73
|
|
|
69
74
|
// Display data.
|
|
70
75
|
console.log(
|
|
@@ -73,12 +78,13 @@ export const onVerification = async (verification: Verification): Promise<void>
|
|
|
73
78
|
)} on this device to generate a new token and authenticate\n`
|
|
74
79
|
)
|
|
75
80
|
|
|
76
|
-
console.log(theme.colors.magenta(figlet.textSync("Code is Below", { font: "ANSI Shadow" })),
|
|
77
|
-
|
|
81
|
+
console.log(theme.colors.magenta(figlet.textSync("Code is Below", { font: "ANSI Shadow" })), "\n")
|
|
82
|
+
|
|
83
|
+
const message = !noClipboard ? `has been copied to your clipboard (${theme.emojis.clipboard})` : ``
|
|
78
84
|
console.log(
|
|
79
|
-
`${theme.symbols.info} Your auth code: ${theme.text.bold(verification.user_code)}
|
|
85
|
+
`${theme.symbols.info} Your auth code: ${theme.text.bold(verification.user_code)} ${message} ${
|
|
80
86
|
theme.symbols.success
|
|
81
|
-
}
|
|
87
|
+
}\n`
|
|
82
88
|
)
|
|
83
89
|
|
|
84
90
|
const spinner = customSpinner(`Redirecting to Github...`, `clock`)
|
|
@@ -86,8 +92,12 @@ export const onVerification = async (verification: Verification): Promise<void>
|
|
|
86
92
|
|
|
87
93
|
await sleep(10000) // ~10s to make users able to read the CLI.
|
|
88
94
|
|
|
89
|
-
|
|
90
|
-
|
|
95
|
+
try {
|
|
96
|
+
// Automatically open the page (# Step 2).
|
|
97
|
+
await open(verification.verification_uri)
|
|
98
|
+
} catch (error: any) {
|
|
99
|
+
console.log(`${theme.symbols.info} Please authenticate via GitHub at ${verification.verification_uri}`)
|
|
100
|
+
}
|
|
91
101
|
|
|
92
102
|
spinner.stop()
|
|
93
103
|
|
|
@@ -40,7 +40,7 @@ import {
|
|
|
40
40
|
estimateParticipantFreeGlobalDiskSpace
|
|
41
41
|
} from "../lib/utils.js"
|
|
42
42
|
import { COMMAND_ERRORS, showError } from "../lib/errors.js"
|
|
43
|
-
import { bootstrapCommandExecutionAndServices, checkAuth } from "../lib/services.js"
|
|
43
|
+
import { authWithToken, bootstrapCommandExecutionAndServices, checkAuth } from "../lib/services.js"
|
|
44
44
|
import { getAttestationLocalFilePath, localPaths } from "../lib/localConfigs.js"
|
|
45
45
|
import theme from "../lib/theme.js"
|
|
46
46
|
import { checkAndMakeNewDirectoryIfNonexistent, writeFile } from "../lib/files.js"
|
|
@@ -724,7 +724,8 @@ export const listenToParticipantDocumentChanges = async (
|
|
|
724
724
|
participant,
|
|
725
725
|
entropy,
|
|
726
726
|
providerUserId,
|
|
727
|
-
false // not finalizing.
|
|
727
|
+
false, // not finalizing.
|
|
728
|
+
circuits.length
|
|
728
729
|
)
|
|
729
730
|
}
|
|
730
731
|
// Scenario (3.A).
|
|
@@ -810,7 +811,9 @@ export const listenToParticipantDocumentChanges = async (
|
|
|
810
811
|
await getLatestVerificationResult(firestoreDatabase, ceremony.id, circuit.id, participant.id)
|
|
811
812
|
|
|
812
813
|
// Get next circuit for contribution.
|
|
813
|
-
const nextCircuit = timeoutExpired
|
|
814
|
+
const nextCircuit = timeoutExpired
|
|
815
|
+
? getCircuitBySequencePosition(circuits, changedContributionProgress)
|
|
816
|
+
: getCircuitBySequencePosition(circuits, changedContributionProgress + 1)
|
|
814
817
|
|
|
815
818
|
// Check disk space requirements for participant.
|
|
816
819
|
const wannaGenerateAttestation = await handleDiskSpaceRequirementForNextContribution(
|
|
@@ -891,12 +894,13 @@ export const listenToParticipantDocumentChanges = async (
|
|
|
891
894
|
const contribute = async (opt: any) => {
|
|
892
895
|
const { firebaseApp, firebaseFunctions, firestoreDatabase } = await bootstrapCommandExecutionAndServices()
|
|
893
896
|
|
|
894
|
-
// Check for authentication.
|
|
895
|
-
const { user, providerUserId, token } = await checkAuth(firebaseApp)
|
|
896
|
-
|
|
897
897
|
// Get options.
|
|
898
898
|
const ceremonyOpt = opt.ceremony
|
|
899
899
|
const entropyOpt = opt.entropy
|
|
900
|
+
const { auth } = opt
|
|
901
|
+
|
|
902
|
+
// Check for authentication.
|
|
903
|
+
const { user, providerUserId, token } = auth ? await authWithToken(firebaseApp, auth) : await checkAuth(firebaseApp)
|
|
900
904
|
|
|
901
905
|
// Prepare data.
|
|
902
906
|
let selectedCeremony: FirebaseDocumentInfo
|
|
@@ -948,7 +952,7 @@ const contribute = async (opt: any) => {
|
|
|
948
952
|
const userData = userDoc.data()
|
|
949
953
|
if (!userData) {
|
|
950
954
|
spinner.fail(
|
|
951
|
-
`Unfortunately we could not find a user document with your information. This likely means that you did not pass the GitHub reputation checks and therefore are not elegible to contribute to any ceremony. Please contact the coordinator if you believe this to be an error.`
|
|
955
|
+
`Unfortunately we could not find a user document with your information. This likely means that you did not pass the GitHub reputation checks and therefore are not elegible to contribute to any ceremony. If you believe you pass the requirements, it might be possible that your profile is private and we were not able to fetch your real statistics, in this case please consider making your profile public for the duration of the contribution. Please contact the coordinator if you believe this to be an error.`
|
|
952
956
|
)
|
|
953
957
|
process.exit(0)
|
|
954
958
|
}
|
package/src/commands/finalize.ts
CHANGED
|
@@ -36,9 +36,9 @@ import {
|
|
|
36
36
|
sleep,
|
|
37
37
|
terminate
|
|
38
38
|
} from "../lib/utils.js"
|
|
39
|
-
import { bootstrapCommandExecutionAndServices, checkAuth } from "../lib/services.js"
|
|
39
|
+
import { authWithToken, bootstrapCommandExecutionAndServices, checkAuth } from "../lib/services.js"
|
|
40
40
|
import {
|
|
41
|
-
|
|
41
|
+
getFinalAttestationLocalFilePath,
|
|
42
42
|
getFinalZkeyLocalFilePath,
|
|
43
43
|
getVerificationKeyLocalFilePath,
|
|
44
44
|
getVerifierContractLocalFilePath,
|
|
@@ -112,7 +112,7 @@ export const handleVerifierSmartContract = async (
|
|
|
112
112
|
? `${dirname(
|
|
113
113
|
fileURLToPath(import.meta.url)
|
|
114
114
|
)}/../../../../node_modules/snarkjs/templates/verifier_groth16.sol.ejs`
|
|
115
|
-
: `${dirname(fileURLToPath(import.meta.url))}
|
|
115
|
+
: `${dirname(fileURLToPath(import.meta.url))}/../node_modules/snarkjs/templates/verifier_groth16.sol.ejs`
|
|
116
116
|
|
|
117
117
|
// Export the Solidity verifier smart contract.
|
|
118
118
|
const verifierCode = await exportVerifierContract(finalZkeyLocalFilePath, verifierPath)
|
|
@@ -152,6 +152,7 @@ export const handleVerifierSmartContract = async (
|
|
|
152
152
|
* @param participant <FirebaseDocumentInfo> - the Firestore document of the participant (coordinator).
|
|
153
153
|
* @param beacon <string> - the value used to compute the final contribution while finalizing the ceremony.
|
|
154
154
|
* @param coordinatorIdentifier <string> - the identifier of the coordinator.
|
|
155
|
+
* @param circuitsLength <number> - the number of circuits in the ceremony.
|
|
155
156
|
*/
|
|
156
157
|
export const handleCircuitFinalization = async (
|
|
157
158
|
cloudFunctions: Functions,
|
|
@@ -160,7 +161,8 @@ export const handleCircuitFinalization = async (
|
|
|
160
161
|
circuit: FirebaseDocumentInfo,
|
|
161
162
|
participant: FirebaseDocumentInfo,
|
|
162
163
|
beacon: string,
|
|
163
|
-
coordinatorIdentifier: string
|
|
164
|
+
coordinatorIdentifier: string,
|
|
165
|
+
circuitsLength: number
|
|
164
166
|
) => {
|
|
165
167
|
// Step (1).
|
|
166
168
|
await handleStartOrResumeContribution(
|
|
@@ -171,7 +173,8 @@ export const handleCircuitFinalization = async (
|
|
|
171
173
|
participant,
|
|
172
174
|
computeSHA256ToHex(beacon),
|
|
173
175
|
coordinatorIdentifier,
|
|
174
|
-
true
|
|
176
|
+
true,
|
|
177
|
+
circuitsLength
|
|
175
178
|
)
|
|
176
179
|
|
|
177
180
|
await sleep(2000) // workaound for descriptors.
|
|
@@ -241,11 +244,16 @@ export const handleCircuitFinalization = async (
|
|
|
241
244
|
* @dev For proper execution, the command requires the coordinator to be authenticated with a GitHub account (run auth command first) in order to
|
|
242
245
|
* handle sybil-resistance and connect to GitHub APIs to publish the gist containing the final public attestation.
|
|
243
246
|
*/
|
|
244
|
-
const finalize = async () => {
|
|
247
|
+
const finalize = async (opt: any) => {
|
|
245
248
|
const { firebaseApp, firebaseFunctions, firestoreDatabase } = await bootstrapCommandExecutionAndServices()
|
|
246
249
|
|
|
247
250
|
// Check for authentication.
|
|
248
|
-
const {
|
|
251
|
+
const { auth } = opt
|
|
252
|
+
const {
|
|
253
|
+
user,
|
|
254
|
+
providerUserId,
|
|
255
|
+
token: coordinatorAccessToken
|
|
256
|
+
} = auth ? await authWithToken(firebaseApp, auth) : await checkAuth(firebaseApp)
|
|
249
257
|
|
|
250
258
|
// Preserve command execution only for coordinators.
|
|
251
259
|
if (!(await isCoordinator(user))) showError(COMMAND_ERRORS.COMMAND_NOT_COORDINATOR, true)
|
|
@@ -306,7 +314,8 @@ const finalize = async () => {
|
|
|
306
314
|
circuit,
|
|
307
315
|
participant,
|
|
308
316
|
beacon,
|
|
309
|
-
providerUserId
|
|
317
|
+
providerUserId,
|
|
318
|
+
circuits.length
|
|
310
319
|
)
|
|
311
320
|
|
|
312
321
|
process.stdout.write(`\n`)
|
|
@@ -344,7 +353,7 @@ const finalize = async () => {
|
|
|
344
353
|
|
|
345
354
|
// Write public attestation locally.
|
|
346
355
|
writeFile(
|
|
347
|
-
|
|
356
|
+
getFinalAttestationLocalFilePath(
|
|
348
357
|
`${prefix}_${finalContributionIndex}_${commonTerms.foldersAndPathsTerms.attestation}.log`
|
|
349
358
|
),
|
|
350
359
|
Buffer.from(publicAttestation)
|
package/src/commands/index.ts
CHANGED
|
@@ -6,4 +6,4 @@ export { default as finalize } from "./finalize.js"
|
|
|
6
6
|
export { default as clean } from "./clean.js"
|
|
7
7
|
export { default as logout } from "./logout.js"
|
|
8
8
|
export { default as validate } from "./validate.js"
|
|
9
|
-
export { default as listCeremonies} from "./listCeremonies.js"
|
|
9
|
+
export { default as listCeremonies } from "./listCeremonies.js"
|
|
@@ -17,11 +17,10 @@ const listCeremonies = async () => {
|
|
|
17
17
|
|
|
18
18
|
// loop through all ceremonies
|
|
19
19
|
for (const ceremony of ceremonies) names.push(ceremony.data().prefix)
|
|
20
|
-
|
|
20
|
+
|
|
21
21
|
// print them to the console
|
|
22
22
|
console.log(names.join(", "))
|
|
23
23
|
process.exit(0)
|
|
24
|
-
|
|
25
24
|
} catch (err: any) {
|
|
26
25
|
showError(`${err.toString()}`, false)
|
|
27
26
|
// we want to exit with a non-zero exit code
|
package/src/commands/observe.ts
CHANGED
|
@@ -15,7 +15,7 @@ import { COMMAND_ERRORS, GENERIC_ERRORS, showError } from "../lib/errors.js"
|
|
|
15
15
|
import { promptForCeremonySelection } from "../lib/prompts.js"
|
|
16
16
|
import { bootstrapCommandExecutionAndServices, checkAuth } from "../lib/services.js"
|
|
17
17
|
import theme from "../lib/theme.js"
|
|
18
|
-
import {customSpinner, getSecondsMinutesHoursFromMillis, sleep } from "../lib/utils.js"
|
|
18
|
+
import { customSpinner, getSecondsMinutesHoursFromMillis, sleep } from "../lib/utils.js"
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* Clean cursor lines from current position back to root (default: zero).
|
|
@@ -143,7 +143,7 @@ const observe = async () => {
|
|
|
143
143
|
// Preserve command execution only for coordinators].
|
|
144
144
|
if (!(await isCoordinator(user))) showError(COMMAND_ERRORS.COMMAND_NOT_COORDINATOR, true)
|
|
145
145
|
|
|
146
|
-
// Get running
|
|
146
|
+
// Get running ceremonies info (if any).
|
|
147
147
|
const runningCeremoniesDocs = await getOpenedCeremonies(firestoreDatabase)
|
|
148
148
|
|
|
149
149
|
// Ask to select a ceremony.
|
package/src/commands/setup.ts
CHANGED
|
@@ -2,12 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
import { zKey } from "snarkjs"
|
|
4
4
|
import boxen from "boxen"
|
|
5
|
-
import { createWriteStream, Dirent, renameSync } from "fs"
|
|
5
|
+
import { createWriteStream, Dirent, renameSync, existsSync } from "fs"
|
|
6
6
|
import { pipeline } from "node:stream"
|
|
7
7
|
import { promisify } from "node:util"
|
|
8
8
|
import fetch from "node-fetch"
|
|
9
9
|
import { Functions } from "firebase/functions"
|
|
10
|
-
import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3"
|
|
11
10
|
import {
|
|
12
11
|
CeremonyTimeoutType,
|
|
13
12
|
CircomCompilerData,
|
|
@@ -63,7 +62,6 @@ import {
|
|
|
63
62
|
getFileStats,
|
|
64
63
|
checkAndMakeNewDirectoryIfNonexistent
|
|
65
64
|
} from "../lib/files.js"
|
|
66
|
-
import { Readable } from "stream"
|
|
67
65
|
|
|
68
66
|
/**
|
|
69
67
|
* Handle whatever is needed to obtain the input data for a circuit that the coordinator would like to add to the ceremony.
|
|
@@ -183,7 +181,7 @@ export const handleAdditionOfCircuitsToCeremony = async (
|
|
|
183
181
|
|
|
184
182
|
if (matchingWasms.length !== 1) showError(COMMAND_ERRORS.COMMAND_SETUP_MISMATCH_R1CS_WASM, true)
|
|
185
183
|
|
|
186
|
-
// Get input data for
|
|
184
|
+
// Get input data for chosen circuit.
|
|
187
185
|
const circuitInputData = await getInputDataToAddCircuitToCeremony(
|
|
188
186
|
choosenCircuitFilename,
|
|
189
187
|
matchingWasms[0],
|
|
@@ -324,7 +322,7 @@ export const checkAndDownloadSmallestPowersOfTau = async (
|
|
|
324
322
|
* number of powers greater than or equal to the powers needed by the zKey), the coordinator will be asked
|
|
325
323
|
* to provide a number of powers manually, ranging from the smallest possible to the largest.
|
|
326
324
|
* @param neededPowers <number> - the smallest amount of powers needed by the zKey.
|
|
327
|
-
* @returns Promise<string, string> - the information about the
|
|
325
|
+
* @returns Promise<string, string> - the information about the chosen Powers of Tau file for the pre-computed zKey
|
|
328
326
|
* along with related powers.
|
|
329
327
|
*/
|
|
330
328
|
export const handlePreComputedZkeyPowersOfTauSelection = async (
|
|
@@ -468,7 +466,7 @@ export const handleCircuitArtifactUploadToStorage = async (
|
|
|
468
466
|
* from Hermez's ceremony Phase 1 Reliable Setup Ceremony.
|
|
469
467
|
* @param cmd? <any> - the path to the ceremony setup file.
|
|
470
468
|
*/
|
|
471
|
-
const setup = async (cmd: { template?: string
|
|
469
|
+
const setup = async (cmd: { template?: string; auth?: string }) => {
|
|
472
470
|
// Setup command state.
|
|
473
471
|
const circuits: Array<CircuitDocument> = [] // Circuits.
|
|
474
472
|
let ceremonyId: string = "" // The unique identifier of the ceremony.
|
|
@@ -476,8 +474,10 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
|
|
|
476
474
|
const { firebaseApp, firebaseFunctions, firestoreDatabase } = await bootstrapCommandExecutionAndServices()
|
|
477
475
|
|
|
478
476
|
// Check for authentication.
|
|
479
|
-
const { user, providerUserId } = cmd.auth
|
|
480
|
-
|
|
477
|
+
const { user, providerUserId } = cmd.auth
|
|
478
|
+
? await authWithToken(firebaseApp, cmd.auth)
|
|
479
|
+
: await checkAuth(firebaseApp)
|
|
480
|
+
|
|
481
481
|
// Preserve command execution only for coordinators.
|
|
482
482
|
if (!(await isCoordinator(user))) showError(COMMAND_ERRORS.COMMAND_NOT_COORDINATOR, true)
|
|
483
483
|
|
|
@@ -503,7 +503,7 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
|
|
|
503
503
|
// if there is the file option, then set up the non interactively
|
|
504
504
|
if (cmd.template) {
|
|
505
505
|
// 1. parse the file
|
|
506
|
-
// tmp data - do not cleanup files as we need them
|
|
506
|
+
// tmp data - do not cleanup files as we need them
|
|
507
507
|
const spinner = customSpinner(`Parsing ${theme.text.bold(cmd.template!)} setup configuration file...`, `clock`)
|
|
508
508
|
spinner.start()
|
|
509
509
|
const setupCeremonyData = await parseCeremonyFile(cmd.template!)
|
|
@@ -526,18 +526,44 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
|
|
|
526
526
|
const zkeyLocalPathAndFileName = getZkeyLocalFilePath(circuit.files.initialZkeyFilename)
|
|
527
527
|
|
|
528
528
|
// 2. download the pot and wasm files
|
|
529
|
-
await checkAndDownloadSmallestPowersOfTau(
|
|
530
|
-
|
|
529
|
+
await checkAndDownloadSmallestPowersOfTau(
|
|
530
|
+
convertToDoubleDigits(circuit.metadata?.pot!),
|
|
531
|
+
circuit.files.potFilename
|
|
532
|
+
)
|
|
533
|
+
|
|
531
534
|
// 3. generate the zKey
|
|
532
|
-
const spinner = customSpinner(
|
|
535
|
+
const spinner = customSpinner(
|
|
536
|
+
`Generating genesis zKey for circuit ${theme.text.bold(circuit.name)}...`,
|
|
537
|
+
`clock`
|
|
538
|
+
)
|
|
533
539
|
spinner.start()
|
|
534
|
-
await zKey.newZKey(r1csLocalPathAndFileName, getPotLocalFilePath(circuit.files.potFilename), zkeyLocalPathAndFileName, undefined)
|
|
535
|
-
spinner.succeed(`Generation of the genesis zKey for citcui ${theme.text.bold(circuit.name)} completed successfully`)
|
|
536
540
|
|
|
541
|
+
if (existsSync(zkeyLocalPathAndFileName)) {
|
|
542
|
+
spinner.succeed(
|
|
543
|
+
`The genesis zKey for circuit ${theme.text.bold(circuit.name)} is already present on disk`
|
|
544
|
+
)
|
|
545
|
+
} else {
|
|
546
|
+
await zKey.newZKey(
|
|
547
|
+
r1csLocalPathAndFileName,
|
|
548
|
+
getPotLocalFilePath(circuit.files.potFilename),
|
|
549
|
+
zkeyLocalPathAndFileName,
|
|
550
|
+
undefined
|
|
551
|
+
)
|
|
552
|
+
spinner.succeed(
|
|
553
|
+
`Generation of the genesis zKey for circuit ${theme.text.bold(circuit.name)} completed successfully`
|
|
554
|
+
)
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
const hashSpinner = customSpinner(
|
|
558
|
+
`Calculating hashes for circuit ${theme.text.bold(circuit.name)}...`,
|
|
559
|
+
`clock`
|
|
560
|
+
)
|
|
561
|
+
hashSpinner.start()
|
|
537
562
|
// 4. calculate the hashes
|
|
538
563
|
const wasmBlake2bHash = await blake512FromPath(wasmLocalPathAndFileName)
|
|
539
564
|
const potBlake2bHash = await blake512FromPath(getPotLocalFilePath(circuit.files.potFilename))
|
|
540
565
|
const initialZkeyBlake2bHash = await blake512FromPath(zkeyLocalPathAndFileName)
|
|
566
|
+
hashSpinner.succeed(`Hashes for circuit ${theme.text.bold(circuit.name)} calculated successfully`)
|
|
541
567
|
|
|
542
568
|
// 5. upload the artifacts
|
|
543
569
|
|
|
@@ -549,7 +575,7 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
|
|
|
549
575
|
zkeyLocalPathAndFileName,
|
|
550
576
|
circuit.files.initialZkeyFilename
|
|
551
577
|
)
|
|
552
|
-
|
|
578
|
+
|
|
553
579
|
// Check if PoT file has been already uploaded to storage.
|
|
554
580
|
const alreadyUploadedPot = await checkIfObjectExist(
|
|
555
581
|
firebaseFunctions,
|
|
@@ -590,25 +616,31 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
|
|
|
590
616
|
// 6 update the setup data object
|
|
591
617
|
ceremonySetupData.circuits[index].files = {
|
|
592
618
|
...circuit.files,
|
|
593
|
-
potBlake2bHash
|
|
594
|
-
wasmBlake2bHash
|
|
595
|
-
initialZkeyBlake2bHash
|
|
619
|
+
potBlake2bHash,
|
|
620
|
+
wasmBlake2bHash,
|
|
621
|
+
initialZkeyBlake2bHash
|
|
596
622
|
}
|
|
597
623
|
|
|
598
624
|
ceremonySetupData.circuits[index].zKeySizeInBytes = getFileStats(zkeyLocalPathAndFileName).size
|
|
599
625
|
}
|
|
600
|
-
|
|
601
626
|
|
|
602
627
|
// 7. setup the ceremony
|
|
603
|
-
const ceremonyId = await setupCeremony(
|
|
604
|
-
|
|
605
|
-
ceremonySetupData.ceremonyInputData
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
628
|
+
const ceremonyId = await setupCeremony(
|
|
629
|
+
firebaseFunctions,
|
|
630
|
+
ceremonySetupData.ceremonyInputData,
|
|
631
|
+
ceremonySetupData.ceremonyPrefix,
|
|
632
|
+
ceremonySetupData.circuits
|
|
633
|
+
)
|
|
634
|
+
console.log(
|
|
635
|
+
`Congratulations, the setup of ceremony ${theme.text.bold(
|
|
636
|
+
ceremonySetupData.ceremonyInputData.title
|
|
637
|
+
)} (${`UID: ${theme.text.bold(ceremonyId)}`}) has been successfully completed ${
|
|
638
|
+
theme.emojis.tada
|
|
639
|
+
}. You will be able to find all the files and info respectively in the ceremony bucket and database document.`
|
|
640
|
+
)
|
|
641
|
+
|
|
610
642
|
terminate(providerUserId)
|
|
611
|
-
}
|
|
643
|
+
}
|
|
612
644
|
|
|
613
645
|
// Look for R1CS files.
|
|
614
646
|
const r1csFilePaths = await filterDirectoryFilesByExtension(cwd, `.r1cs`)
|
package/src/commands/validate.ts
CHANGED
|
@@ -4,7 +4,7 @@ import { showError } from "../lib/errors.js"
|
|
|
4
4
|
/**
|
|
5
5
|
* Validate ceremony setup command.
|
|
6
6
|
*/
|
|
7
|
-
const validate = async (cmd: { template: string
|
|
7
|
+
const validate = async (cmd: { template: string; constraints?: number }) => {
|
|
8
8
|
try {
|
|
9
9
|
// parse the file and cleanup after
|
|
10
10
|
const parsedFile = await parseCeremonyFile(cmd.template, true)
|
|
@@ -18,7 +18,6 @@ const validate = async (cmd: { template: string, constraints?: number }) => {
|
|
|
18
18
|
}
|
|
19
19
|
|
|
20
20
|
console.log(true)
|
|
21
|
-
|
|
22
21
|
} catch (err: any) {
|
|
23
22
|
showError(`${err.toString()}`, false)
|
|
24
23
|
// we want to exit with a non-zero exit code
|
package/src/index.ts
CHANGED
|
@@ -4,7 +4,17 @@ import { createCommand } from "commander"
|
|
|
4
4
|
import { readFileSync } from "fs"
|
|
5
5
|
import { dirname } from "path"
|
|
6
6
|
import { fileURLToPath } from "url"
|
|
7
|
-
import {
|
|
7
|
+
import {
|
|
8
|
+
setup,
|
|
9
|
+
auth,
|
|
10
|
+
contribute,
|
|
11
|
+
observe,
|
|
12
|
+
finalize,
|
|
13
|
+
clean,
|
|
14
|
+
logout,
|
|
15
|
+
validate,
|
|
16
|
+
listCeremonies
|
|
17
|
+
} from "./commands/index.js"
|
|
8
18
|
|
|
9
19
|
// Get pkg info (e.g., name, version).
|
|
10
20
|
const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`
|
|
@@ -21,15 +31,13 @@ program
|
|
|
21
31
|
.description("compute contributions for a Phase2 Trusted Setup ceremony circuits")
|
|
22
32
|
.option("-c, --ceremony <string>", "the prefix of the ceremony you want to contribute for", "")
|
|
23
33
|
.option("-e, --entropy <string>", "the entropy (aka toxic waste) of your contribution", "")
|
|
34
|
+
.option("-a, --auth <string>", "the Github OAuth 2.0 token", "")
|
|
24
35
|
.action(contribute)
|
|
25
36
|
program
|
|
26
37
|
.command("clean")
|
|
27
38
|
.description("clean up output generated by commands from the current working directory")
|
|
28
39
|
.action(clean)
|
|
29
|
-
program
|
|
30
|
-
.command("list")
|
|
31
|
-
.description("List all ceremonies prefixes")
|
|
32
|
-
.action(listCeremonies)
|
|
40
|
+
program.command("list").description("List all ceremonies prefixes").action(listCeremonies)
|
|
33
41
|
program
|
|
34
42
|
.command("logout")
|
|
35
43
|
.description("sign out from Firebae Auth service and delete Github OAuth 2.0 token from local storage")
|
|
@@ -47,10 +55,10 @@ const ceremony = program.command("coordinate").description("commands for coordin
|
|
|
47
55
|
ceremony
|
|
48
56
|
.command("setup")
|
|
49
57
|
.description("setup a Groth16 Phase 2 Trusted Setup ceremony for zk-SNARK circuits")
|
|
50
|
-
.option(
|
|
51
|
-
.option(
|
|
58
|
+
.option("-t, --template <path>", "The path to the ceremony setup template", "")
|
|
59
|
+
.option("-a, --auth <string>", "The Github OAuth 2.0 token", "")
|
|
52
60
|
.action(setup)
|
|
53
|
-
|
|
61
|
+
|
|
54
62
|
ceremony
|
|
55
63
|
.command("observe")
|
|
56
64
|
.description("observe in real-time the waiting queue of each ceremony circuit")
|
|
@@ -61,6 +69,7 @@ ceremony
|
|
|
61
69
|
.description(
|
|
62
70
|
"finalize a Phase2 Trusted Setup ceremony by applying a beacon, exporting verification key and verifier contract"
|
|
63
71
|
)
|
|
72
|
+
.option("-a, --auth <string>", "the Github OAuth 2.0 token", "")
|
|
64
73
|
.action(finalize)
|
|
65
74
|
|
|
66
75
|
program.parseAsync(process.argv)
|
package/src/lib/prompts.ts
CHANGED
|
@@ -203,7 +203,7 @@ export const promptCircomCompiler = async (): Promise<CircomCompilerData> => {
|
|
|
203
203
|
* Shows a list of circuits for a single option selection.
|
|
204
204
|
* @dev the circuit names are derived from local R1CS files.
|
|
205
205
|
* @param options <Array<string>> - an array of circuits names.
|
|
206
|
-
* @returns Promise<string> - the name of the
|
|
206
|
+
* @returns Promise<string> - the name of the chosen circuit.
|
|
207
207
|
*/
|
|
208
208
|
export const promptCircuitSelector = async (options: Array<string>): Promise<string> => {
|
|
209
209
|
const { circuitFilename } = await prompts({
|
|
@@ -223,7 +223,7 @@ export const promptCircuitSelector = async (options: Array<string>): Promise<str
|
|
|
223
223
|
* Shows a list of standard EC2 VM instance types for a single option selection.
|
|
224
224
|
* @notice the suggested VM configuration type is calculated based on circuit constraint size.
|
|
225
225
|
* @param constraintSize <number> - the amount of circuit constraints
|
|
226
|
-
* @returns Promise<string> - the name of the
|
|
226
|
+
* @returns Promise<string> - the name of the chosen VM type.
|
|
227
227
|
*/
|
|
228
228
|
export const promptVMTypeSelector = async (constraintSize): Promise<string> => {
|
|
229
229
|
let suggestedConfiguration: number = 0
|
|
@@ -325,7 +325,7 @@ export const promptVMDiskTypeSelector = async (): Promise<DiskTypeForVM> => {
|
|
|
325
325
|
/**
|
|
326
326
|
* Show a series of questions about the circuits.
|
|
327
327
|
* @param constraintSize <number> - the amount of circuit constraints.
|
|
328
|
-
* @param timeoutMechanismType <CeremonyTimeoutType> - the
|
|
328
|
+
* @param timeoutMechanismType <CeremonyTimeoutType> - the chosen timeout mechanism type for the ceremony.
|
|
329
329
|
* @param needPromptCircomCompiler <boolean> - a boolean value indicating if the questions related to the Circom compiler version and commit hash must be asked.
|
|
330
330
|
* @param enforceVM <boolean> - a boolean value indicating if the contribution verification could be supported by VM-only approach or not.
|
|
331
331
|
* @returns Promise<Array<Circuit>> - circuit info prompted by the coordinator.
|
|
@@ -343,7 +343,7 @@ export const promptCircuitInputData = async (
|
|
|
343
343
|
let circomVersion: string = ""
|
|
344
344
|
let circomCommitHash: string = ""
|
|
345
345
|
let circuitInputData: CircuitInputData
|
|
346
|
-
let
|
|
346
|
+
let cfOrVm: CircuitContributionVerificationMechanism
|
|
347
347
|
let vmDiskType: DiskTypeForVM
|
|
348
348
|
let vmConfigurationType: string = ""
|
|
349
349
|
|
|
@@ -422,19 +422,23 @@ export const promptCircuitInputData = async (
|
|
|
422
422
|
circomCommitHash = commitHash
|
|
423
423
|
}
|
|
424
424
|
|
|
425
|
-
// Ask for
|
|
425
|
+
// Ask for preferred contribution verification method (CF vs VM).
|
|
426
426
|
if (!enforceVM) {
|
|
427
427
|
const { confirmation } = await askForConfirmation(
|
|
428
428
|
`The contribution verification can be performed using Cloud Functions (CF, cheaper for small contributions but limited to 1M constraints) or custom virtual machines (expensive but could scale up to 30M constraints). Be aware about VM costs and if you wanna learn more, please visit the documentation to have a complete overview about cost estimation of the two mechanisms.\nChoose the contribution verification mechanism`,
|
|
429
429
|
`CF`, // eq. true.
|
|
430
430
|
`VM` // eq. false.
|
|
431
431
|
)
|
|
432
|
-
|
|
433
|
-
|
|
432
|
+
cfOrVm = confirmation
|
|
433
|
+
? CircuitContributionVerificationMechanism.CF
|
|
434
|
+
: CircuitContributionVerificationMechanism.VM
|
|
435
|
+
} else {
|
|
436
|
+
cfOrVm = CircuitContributionVerificationMechanism.VM
|
|
437
|
+
}
|
|
434
438
|
|
|
435
|
-
if (
|
|
439
|
+
if (cfOrVm === undefined) showError(COMMAND_ERRORS.COMMAND_ABORT_PROMPT, true)
|
|
436
440
|
|
|
437
|
-
if (
|
|
441
|
+
if (cfOrVm === CircuitContributionVerificationMechanism.VM) {
|
|
438
442
|
// Ask for selecting the specific VM configuration type.
|
|
439
443
|
vmConfigurationType = await promptVMTypeSelector(constraintSize)
|
|
440
444
|
|
|
@@ -478,9 +482,7 @@ export const promptCircuitInputData = async (
|
|
|
478
482
|
paramsConfiguration: circuitConfigurationValues
|
|
479
483
|
},
|
|
480
484
|
verification: {
|
|
481
|
-
cfOrVm
|
|
482
|
-
? CircuitContributionVerificationMechanism.CF
|
|
483
|
-
: CircuitContributionVerificationMechanism.VM,
|
|
485
|
+
cfOrVm,
|
|
484
486
|
vm: {
|
|
485
487
|
vmConfigurationType,
|
|
486
488
|
vmDiskType
|
|
@@ -520,9 +522,7 @@ export const promptCircuitInputData = async (
|
|
|
520
522
|
paramsConfiguration: circuitConfigurationValues
|
|
521
523
|
},
|
|
522
524
|
verification: {
|
|
523
|
-
cfOrVm
|
|
524
|
-
? CircuitContributionVerificationMechanism.CF
|
|
525
|
-
: CircuitContributionVerificationMechanism.VM,
|
|
525
|
+
cfOrVm,
|
|
526
526
|
vm: {
|
|
527
527
|
vmConfigurationType,
|
|
528
528
|
vmDiskType
|
|
@@ -586,7 +586,7 @@ export const promptCircuitAddition = async (): Promise<boolean> => {
|
|
|
586
586
|
* Shows a list of pre-computed zKeys for a single option selection.
|
|
587
587
|
* @dev the names are derived from local zKeys files.
|
|
588
588
|
* @param options <Array<string>> - an array of pre-computed zKeys names.
|
|
589
|
-
* @returns Promise<string> - the name of the
|
|
589
|
+
* @returns Promise<string> - the name of the chosen pre-computed zKey.
|
|
590
590
|
*/
|
|
591
591
|
export const promptPreComputedZkeySelector = async (options: Array<string>): Promise<string> => {
|
|
592
592
|
const { preComputedZkeyFilename } = await prompts({
|
|
@@ -633,13 +633,13 @@ export const promptNeededPowersForCircuit = async (suggestedSmallestNeededPowers
|
|
|
633
633
|
* Shows a list of PoT files for a single option selection.
|
|
634
634
|
* @dev the names are derived from local PoT files.
|
|
635
635
|
* @param options <Array<string>> - an array of PoT file names.
|
|
636
|
-
* @returns Promise<string> - the name of the
|
|
636
|
+
* @returns Promise<string> - the name of the chosen PoT.
|
|
637
637
|
*/
|
|
638
638
|
export const promptPotSelector = async (options: Array<string>): Promise<string> => {
|
|
639
639
|
const { potFilename } = await prompts({
|
|
640
640
|
type: "select",
|
|
641
641
|
name: "potFilename",
|
|
642
|
-
message: theme.text.bold("Select the Powers of Tau file
|
|
642
|
+
message: theme.text.bold("Select the Powers of Tau file chosen for the circuit"),
|
|
643
643
|
choices: options.map((option: string) => {
|
|
644
644
|
console.log(option)
|
|
645
645
|
return { title: option, value: option }
|
|
@@ -731,7 +731,7 @@ export const promptToTypeEntropyOrBeacon = async (isEntropy = true): Promise<str
|
|
|
731
731
|
* @return <Promise<string>> - the entropy.
|
|
732
732
|
*/
|
|
733
733
|
export const promptForEntropy = async (): Promise<string> => {
|
|
734
|
-
// Prompt for entropy generation
|
|
734
|
+
// Prompt for entropy generation preferred method.
|
|
735
735
|
const { confirmation } = await askForConfirmation(
|
|
736
736
|
`Do you prefer to type your entropy or generate it randomly?`,
|
|
737
737
|
"Manually",
|
package/src/lib/services.ts
CHANGED