Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 3.02 KB

tally-verify.md

File metadata and controls

90 lines (57 loc) · 3.02 KB
Raw

How to tally votes

Only a funding round coordinator can tally votes.

Tally votes

Install MACI dependencies (see the github action, .github/workflows/test-scripts.yml for all the dependencies to install)

Run the script monorepo/.github/scripts/download-6-9-2-3.sh to download the parameter files.

Set the following env vars in /contracts/.env:

# private key for decrypting messages
COORDINATOR_MACISK=<coordinator-maci-private-key>

# private key for interacting with contracts
WALLET_MNEMONIC=
WALLET_PRIVATE_KEY

# credential to upload tally result to IPFS
PINATA_API_KEY=
PINATA_SECRET_API_KEY=

Decrypt messages, tally the votes:

yarn hardhat tally --clrfund {CLRFUND_CONTRACT_ADDRESS} --maci-tx-hash {MACI_CREATION_TRANSACTION_HASH} --proof-dir {OUTPUT_DIR} --rapidsnark {RAPID_SNARK} --network {network}

You only need to provide --rapidsnark if you are running the tally command on an intel chip. If the tally script failed, you can rerun the command with the same parameters.


Result will be saved to `{OUTPUT_DIR}/{network}-{fundingRoundAddress}/tally.json` file, which is also available on IPFS at `https://{ipfs-gateway-host}/ipfs/{tally-hash}`.

### Finalize round

Make sure you have the following env vars in `.env`. Ignore this if you are running a local test round in `localhost`, the script will know these values itself.

private key of the owner of the clrfund contract for interacting with the contract

WALLET_MNEMONIC= WALLET_PRIVATE_KEY=


Once you have the `tally.json` from the tally script, run:

yarn hardhat finalize --clrfund {CLRFUND_CONTRACT_ADDRESS} --proof-dir {OUTPUT_DIR} --network {network}


# How to verify the tally results

Anyone can verify the tally results in the tally.json.

From the clrfund contracts folder, run the following command to verify the result:

yarn hardhat verify-tally-file --tally-file {tally.json} --network {network}


# How to enable the leaderboard view

After finalizing the round, enable the leaderboard view in the vue-app by exporting the round information as follow:

1) Set the etherscan API key in the hardhat.config.ts file in the contracts folder
2) Export the round and tally result

```sh
cd contracts

yarn hardhat export-round --output-dir ../vue-app/src/rounds --network {network} --round-address {round_address} --operator {operator} --start-block {recipient-registry-start-block} --ipfs {ipfs-gateway-url}
  1. Build and deploy the app

Troubleshooting

If you encountered core dumped while running the genProofs script as seen in this issue, make sure the files are not corrupted due to disk space issue, e.g. check file sizes, checksum, and missing files.

Also, lack of memory can also cause core dump, try to work around it by setting max-old-space-size before rrunning the tally script.

export NODE_OPTIONS=--max-old-space-size=4096

Error at message index n - invalid nonce is also a warning, not an error. This error occurs when users reallocated their contribution.