3.1.1 • Published 1 year ago
@qfi/ethdamcli v3.1.1
Commands
ethdamcli
: CLI entry point.ethdamcli auth \"<mnemonic>\"
: Allow to interact with the blockchain-related commands (e.g., deploy) with a wallet by passing in wallet's mnemonic.<mnemonic>
: the secret mnemonic phrase (e.g., 12 words) separated by spaces (e.g., "test test test test test test test test test test test junk"). nb. the double quotes are mandatory!
ethdamcli genkeys <amount>
: Generate a new specified amount of MACI and ETH keypairs (QR Codes inclueded).<amount>
: amount of MACI and ETH keypairs to be generated (e.g., 3000)
ethdamcli contracts:deploy <network>
: Deploy the smart contracts infrastructure necessary for running a new QFI/MACI instance for a specified network.<network>
: the network where the contracts will be deployed (e.g., MATIC)
ethdamcli contracts:add-recipients <network> <path>
: Add recipients on RecipientRegistry Smart Contract deployed on the network by taking data from CSV input file specified in the path.<network>
: the network where the contracts has been deployed (e.g., MATIC)<path>
: the path of the CSV input file where the recipients data is stored (e.g., ~/Desktop/myrecipients_data.csv`). _nb. The CSV file must contain rows organized as follows: * name * tagline * description * problemSpace * ethereumAddress * contactEmail * teamName (optional) * teamDescription (optional) * githubUrl (optional) * radicleUrl (optional) * websiteUrl (optional) * twitterUr (optional) * discordUrl (optional) * bannerImageHash * thumbnailImageHash
Examples
ethdamcli auth "test test test test test test test test test test test junk"
ethdamcli genkeys 3000
ethdamcli contracts:deploy MATIC
ethdamcli contracts:add-recipients MATIC ~/Desktop/my_recipients_data.csv
Getting Started
Prerequisities
You need to have the following installed:
git >= 2.25.1 node >= 16.14.0 npm >= 8.9.0 yarn >= 1.22.18
Local Development
https://github.com/quadratic-funding/qfi.git
cd qfi
git checkout cohort/ethdam
yarn
yarn build
cd packages/cli
npm i -g
# You are ready to run the commands as above :)