refactor: user sdk #2064
Open
refactor: user sdk #2064
+1,428
−232
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
0xmad
requested changes
Jan 23, 2025
| "dependencies": { | ||
| "@commander-js/extra-typings": "^12.1.0", | ||
| "@nomicfoundation/hardhat-toolbox": "^5.0.0", | ||
| "commander": "^12.1.0", |
There was a problem hiding this comment.
Why do you need these (commander, @commander-js/extra-typings) dependencies for sdk?
|
|
||
| const userMaciPubKey = PubKey.deserialize(maciPubKey); | ||
|
|
||
| if (!(await contractExists(signer.provider!, maciAddress))) { |
There was a problem hiding this comment.
Let's move await call to a constant
Comment on lines
+4
to
+7
| export /** | ||
| * Parse the poll joining events from the Poll contract | ||
| */ | ||
| const parsePollJoinEvents = async ({ |
There was a problem hiding this comment.
Suggested change
| export /** | |
| * Parse the poll joining events from the Poll contract | |
| */ | |
| const parsePollJoinEvents = async ({ | |
| /** | |
| * Parse the poll joining events from the Poll contract | |
| */ | |
| export const parsePollJoinEvents = async ({ |
Comment on lines
+43
to
+46
| export /** | ||
| * Parse the signup events from the MACI contract | ||
| */ | ||
| const parseSignupEvents = async ({ |
There was a problem hiding this comment.
Suggested change
| export /** | |
| * Parse the signup events from the MACI contract | |
| */ | |
| const parseSignupEvents = async ({ | |
| /** | |
| * Parse the signup events from the MACI contract | |
| */ | |
| export const parseSignupEvents = async ({ |
| publicKey, | ||
| }: IParseSignupEventsArgs): Promise<{ stateIndex?: string }> => { | ||
| // 1000 blocks at a time | ||
| for (let block = startBlock; block <= currentBlock; block += 1000) { |
There was a problem hiding this comment.
Let's use constant for blocks increment.
Comment on lines
+41
to
+44
| ); | ||
| if (!isValid) { | ||
| failedIndices.push(i); | ||
| } |
There was a problem hiding this comment.
Suggested change
| ); | |
| if (!isValid) { | |
| failedIndices.push(i); | |
| } | |
| ); | |
| if (!isValid) { | |
| failedIndices.push(i); | |
| } |
| const useQv = tallyData.isQuadratic; | ||
| const maciContractAddress = tallyData.maci; | ||
|
|
||
| if (!(await contractExists(signer.provider!, maciContractAddress))) { |
There was a problem hiding this comment.
Let's move await call to a constant
Comment on lines
+61
to
+66
| !(await tallyContract.verifySpentVoiceCredits( | ||
| tallyData.totalSpentVoiceCredits.spent, | ||
| tallyData.totalSpentVoiceCredits.salt, | ||
| newResultsCommitment, | ||
| newPerVOSpentVoiceCreditsCommitment ?? 0n, | ||
| )) |
There was a problem hiding this comment.
The same here with moving to constant
Comment on lines
+88
to
+108
| if (useQv) { | ||
| if (tallyData.perVOSpentVoiceCredits?.tally.length !== numVoteOptions) { | ||
| throw new Error("Wrong number of vote options."); | ||
| } | ||
| // verify per vote option voice credits on-chain | ||
| const failedSpentCredits = await verifyPerVOSpentVoiceCredits( | ||
| tallyContract, | ||
| tallyData, | ||
| voteOptionTreeDepth, | ||
| newSpentVoiceCreditsCommitment, | ||
| newResultsCommitment, | ||
| ); | ||
|
|
||
| if (failedSpentCredits.length > 0) { | ||
| throw new Error( | ||
| `At least one tally result failed the on-chain verification. Please check your Tally data at these indexes: ${failedSpentCredits.join( | ||
| ", ", | ||
| )}`, | ||
| ); | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| if (useQv) { | |
| if (tallyData.perVOSpentVoiceCredits?.tally.length !== numVoteOptions) { | |
| throw new Error("Wrong number of vote options."); | |
| } | |
| // verify per vote option voice credits on-chain | |
| const failedSpentCredits = await verifyPerVOSpentVoiceCredits( | |
| tallyContract, | |
| tallyData, | |
| voteOptionTreeDepth, | |
| newSpentVoiceCreditsCommitment, | |
| newResultsCommitment, | |
| ); | |
| if (failedSpentCredits.length > 0) { | |
| throw new Error( | |
| `At least one tally result failed the on-chain verification. Please check your Tally data at these indexes: ${failedSpentCredits.join( | |
| ", ", | |
| )}`, | |
| ); | |
| } | |
| } | |
| if (!useQv) { | |
| return true; | |
| } | |
| if (tallyData.perVOSpentVoiceCredits?.tally.length !== numVoteOptions) { | |
| throw new Error("Wrong number of vote options."); | |
| } | |
| // verify per vote option voice credits on-chain | |
| const failedSpentCredits = await verifyPerVOSpentVoiceCredits( | |
| tallyContract, | |
| tallyData, | |
| voteOptionTreeDepth, | |
| newSpentVoiceCreditsCommitment, | |
| newResultsCommitment, | |
| ); | |
| if (failedSpentCredits.length > 0) { | |
| throw new Error( | |
| `At least one tally result failed the on-chain verification. Please check your Tally data at these indexes: ${failedSpentCredits.join( | |
| ", ", | |
| )}`, | |
| ); | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Refactor user functions from the SDK
Confirmation
Important
We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team.