feat(genLocalState) - debugging utility for log fetching and local maci state generation

circuits/package.json

@@ -28,7 +28,7 @@
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.9",
+    "@types/chai": "^4.3.11",
     "@types/mocha": "^10.0.4",
     "@types/node": "^18.11.9",
     "chai": "^4.3.10",

cli/tests/prepare_test.sh

@@ -51,6 +51,55 @@ clean() {
 
 }
 
+gen_proofs_pre_fetch() {
+     echo "merge messages ..."
+    $MACI_CLI mergeMessages \
+        --poll-id $1
+
+    echo "merge signups ..."
+    $MACI_CLI mergeSignups \
+        --poll-id $1
+
+    echo "gen proofs ..."
+
+    # generate the local state
+    $MACI_CLI genLocalState \
+        --poll-id $1 \
+        --output localState.json \
+        --privkey macisk.49953af3585856f539d194b46c82f4ed54ec508fb9b882940cbe68bbc57e59e \
+        --num-blocks-per-request 50
+
+    ARCH=$(uname -m)
+    if [[ $ARCH == *"arm"* ]]; then
+        # ARM parameters
+        $MACI_CLI genProofs \
+            --privkey macisk.49953af3585856f539d194b46c82f4ed54ec508fb9b882940cbe68bbc57e59e \
+            --poll-id $1 \
+            --process-wasm ./zkeys/ProcessMessages_"$PROCESS_MESSAGES_PARAMS"_js/ProcessMessages_"$PROCESS_MESSAGES_PARAMS".wasm \
+            --tally-wasm ./zkeys/TallyVotes_"$TALLY_VOTES_PARAMS"_js/TallyVotes_"$TALLY_VOTES_PARAMS".wasm \
+            --process-zkey "$ZKEYS_DIR"/ProcessMessages_"$PROCESS_MESSAGES_PARAMS".0.zkey \
+            --tally-zkey "$ZKEYS_DIR"/TallyVotes_"$TALLY_VOTES_PARAMS".0.zkey \
+            --tally-file tally.json \
+            --output proofs/ \
+            --state-file localState.json \
+            $SUBSIDDY_OPTION_GEN_PROOFS
+    else
+        # Intel parameters
+        $MACI_CLI genProofs \
+            --privkey macisk.49953af3585856f539d194b46c82f4ed54ec508fb9b882940cbe68bbc57e59e \
+            --poll-id $1 \
+            --rapidsnark ~/rapidsnark/build/prover \
+            --process-witnessgen ./zkeys/ProcessMessages_"$PROCESS_MESSAGES_PARAMS" \
+            --tally-witnessgen ./zkeys/TallyVotes_"$TALLY_VOTES_PARAMS" \
+            --process-zkey "$ZKEYS_DIR"/ProcessMessages_"$PROCESS_MESSAGES_PARAMS".0.zkey \
+            --tally-zkey "$ZKEYS_DIR"/TallyVotes_"$TALLY_VOTES_PARAMS".0.zkey \
+            --tally-file tally.json \
+            --output proofs/ \
+            --state-file localState.json \
+            $SUBSIDDY_OPTION_GEN_PROOFS
+    fi
+}
+
 gen_proofs() {
     echo "merge messages ..."
     $MACI_CLI mergeMessages \

cli/tests/vanilla/testPreFetch.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+set -e
+
+BASE_DIR="$(dirname "$BASH_SOURCE")"
+
+. "$BASE_DIR"/../prepare_test.sh
+
+# 1 signup and 1 message
+clean
+
+POLL_ID=0
+
+init_maci
+deploy_poll
+
+
+$MACI_CLI signup \
+    --pubkey macipk.3e7bb2d7f0a1b7e980f1b6f363d1e3b7a12b9ae354c2cd60a9cfa9fd12917391
+
+$MACI_CLI publish \
+    --pubkey macipk.3e7bb2d7f0a1b7e980f1b6f363d1e3b7a12b9ae354c2cd60a9cfa9fd12917391 \
+    --privkey macisk.fd7aa614ec4a82716ffc219c24fd7e7b52a2b63b5afb17e81c22fe21515539c \
+    --state-index 1 \
+    --vote-option-index 0 \
+    --new-vote-weight 9 \
+    --nonce 1 \
+    --poll-id "$POLL_ID"
+
+$MACI_CLI timeTravel \
+    --seconds 90
+
+gen_proofs_pre_fetch "$POLL_ID"
+
+prove_and_verify_on_chain "$POLL_ID"

cli/ts/genLocalState.ts

@@ -0,0 +1,217 @@
+import * as ethers from 'ethers'
+import * as fs from 'fs'
+
+import {
+    genMaciStateFromContract,
+} from 'maci-contracts'
+
+import {
+    validateEthAddress,
+    contractExists,
+    promptPwd,
+} from './utils'
+
+import {
+    DEFAULT_ETH_PROVIDER,
+} from './defaults'
+
+import {readJSONFile} from 'maci-common'
+import {contractFilepath} from './config'
+import { Keypair, PrivKey } from 'maci-domainobjs'
+
+const configureSubparser = (subparsers: any) => {
+    const parser = subparsers.addParser(
+        'genLocalState',
+        { addHelp: true },
+    )
+
+    const maciPrivkeyGroup = parser.addMutuallyExclusiveGroup({ required: true })
+
+    maciPrivkeyGroup.addArgument(
+        ['-dsk', '--prompt-for-maci-privkey'],
+        {
+            action: 'storeTrue',
+            help: 'Whether to prompt for your serialized MACI private key',
+        }
+    )
+
+    maciPrivkeyGroup.addArgument(
+        ['-sk', '--privkey'],
+        {
+            action: 'store',
+            type: 'string',
+            help: 'Your serialized MACI private key',
+        }
+    )
+
+    parser.addArgument(
+        ['-e', '--eth-provider'],
+        {
+            action: 'store',
+            type: 'string',
+            help: `A connection string to an Ethereum provider. Default: ${DEFAULT_ETH_PROVIDER}`,
+        }
+    )
+
+    parser.addArgument(
+        ['-x', '--maci-contract'],
+        {
+            required: false,
+            type: 'string',
+            help: 'The MACI contract address',
+        }
+    )
+
+    parser.addArgument(
+        ['-i', '--poll-id'],
+        {
+            required: false,
+            type: 'int',
+            help: 'The Poll ID',
+        }
+    )
+
+    parser.addArgument(
+        ['-p', '--poll-contract'],
+        {
+            required: false,
+            type: 'string',
+            help: 'The Poll contract address',
+        }
+    )
+
+    parser.addArgument(
+        ['-b', '--start-block'],
+        {
+            type: 'int',
+            help: 'The block number at which the contract was deployed',
+        }
+    )
+
+    parser.addArgument(
+        ['-f', '--end-block'],
+        {
+            required: false,
+            type: 'int',
+            help: 'The last block number to fetch logs from. If not specified, the current block number is used',
+        }
+    )
+
+    parser.addArgument(
+        ['-n', '--num-blocks-per-request'],
+        {
+            required: true,
+            type: 'int',
+            help: 'The number of logs to fetch per RPC request',
+        }
+    )
+
+    parser.addArgument(
+        ['-o', '--output'],
+        {
+            required: true,
+            type: 'string',
+            help: 'The output file for signups and messages',
+        }
+    )
+
+    parser.addArgument(
+        ['-s', '--sleep'],
+        {
+            type: 'int',
+            help: 'The number of milliseconds to sleep between each RPC request to avoid getting rate limited',
+        }
+    )
+}
+
+const genLocalState = async (args: any) => {
+    // read the contract addresses from the config file
+    const contractAddrs = readJSONFile(contractFilepath)
+
+    const pollId = args.poll_id ? args.poll_id : 0
+    const pollArtifactName = `Poll-${pollId}`
+
+    // ensure we have at least one address
+    if ((!contractAddrs||!contractAddrs["MACI"]||!contractAddrs[pollArtifactName]) && !args.maci_contract && !args.poll_contract) {
+        console.error('Error: If no contract address is stored locally, please specify the poll id, the maci contract address and the poll address') 
+        return 
+    }
+    // prioritize cli flag arg
+    const maciAddress = args.maci_contract ? args.maci_contract: contractAddrs["MACI"]
+    const pollAddress = args.poll_contract ? args.poll_contract: contractAddrs[pollArtifactName]
+
+    // validate it's a valid eth address
+    if (!validateEthAddress(maciAddress)) {
+        console.error("Error: invalid MACI contract address. Ensure the address starts with '0x' followed by the 40 hexadecimal characters")
+        return
+    }
+
+    if (!validateEthAddress(pollAddress)) {
+        console.error("Error: invalid Poll contract address. Ensure the address starts with '0x' followed by the 40 hexadecimal characters")
+        return 
+    }
+
+    // Ethereum provider
+    const ethProvider = args.eth_provider ? args.eth_provider : DEFAULT_ETH_PROVIDER
+
+    const provider = new ethers.providers.JsonRpcProvider(ethProvider)
+
+    if (!(await contractExists(provider, maciAddress))) {
+        console.error('Error: there is no MACI contract deployed at the specified address')
+        return
+    }
+
+    if (!(await contractExists(provider, pollAddress))) {
+        console.error('Error: there is no Poll contract deployed at the specified address')
+        return
+    }
+
+    // The coordinator's MACI private key
+    let serializedPrivkey: string 
+    if (args.prompt_for_maci_privkey) {
+        serializedPrivkey = await promptPwd('Your MACI private key')
+    } else {
+        serializedPrivkey = args.privkey
+    }
+
+    if (!PrivKey.isValidSerializedPrivKey(serializedPrivkey)) {
+        console.error('Error: invalid MACI private key')
+        return 
+    }
+
+    const maciPrivkey = PrivKey.unserialize(serializedPrivkey)
+    const coordinatorKeypair = new Keypair(maciPrivkey)
+
+    // calculate the end block number 
+    const endBlockNumber = args.end_block ? args.end_block : await provider.getBlockNumber()
+
+    console.log('Fetching signup and publish message logs')
+    // some rpc endpoint like bsc chain has limitation to retreive history logs
+    let fromBlock = args.start_block ? args.start_block : 0
+    const txHash = args.transaction_hash
+    if (txHash) {
+        const txn = await provider.getTransaction(txHash);
+        fromBlock = txn.blockNumber
+    }
+    console.log(`Fetching logs from ${fromBlock} till ${endBlockNumber} and generating the offline maci state`)
+
+    const maciState = await genMaciStateFromContract(
+        provider,
+        maciAddress,
+        coordinatorKeypair,
+        pollId,
+        fromBlock,
+        args.blocks_per_batch,
+        args.end_block,
+        args.sleep
+    )
+
+    // write the state to a file
+    const serializedState = maciState.toJSON()
+    fs.writeFileSync(args.output, JSON.stringify(serializedState, null, 4))
+}
+
+export {
+    genLocalState,
+    configureSubparser,
+}