Skip to content

Commit

Permalink
add usage comment in the task
Browse files Browse the repository at this point in the history
  • Loading branch information
yuetloo committed Aug 2, 2023
1 parent 25b8de6 commit 31c46ab
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions contracts/tasks/tally.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@ import { genProofs, proveOnChain, fetchLogs } from 'maci-cli'
import { getIpfsHash } from '../utils/ipfs'
import { addTallyResultsBatch } from '../utils/maci'

/**
* Tally votes for the specified funding round. This task can be rerun by
* passing in additional parameters: --maci-logs, --maci-state-file
*
* Make sure to set the following environment variables in the .env file
* if not running test using the localhost network
* 1) COORDINATOR_ETH_PK - coordinator's wallet private key to interact with contracts
* 2) COORDINATOR_PK - coordinator's MACI private key to decrypt messages
*
* Sample usage:
*
* yarn hardhat tally --round-address <address> --start-block <maci-start-block> --network <network>
*
* To rerun:
*
* yarn hardhat tally --round-address <address> --network <network> \
* --maci-logs <maci-log-files> --maci-state-file <maci-state-file>
*/

type TallyArgs = {
fundingRound: Contract
coordinatorMaciPrivKey: string
Expand Down

0 comments on commit 31c46ab

Please sign in to comment.