Libraries

Clr.fund Instances

DEV Instance

PROD Instance

Libraries

Clr.fund Instances

DEV Instance

Libraries

Clr.fund Instances

DEV Instance

Clr.fund for everyone is a suite of products that is designed to Fund your community’s public goods with provably fair, collusion-resistant quadratic funding.

You can use the Clr.Fund Deployer to deploy your own quadratic funding application. Empower your community to choose and fund its future, in a fully decentralized manner.

Getting Started

Clrfund For Everyone is currently in development, our alpha versions of the application are available in the following networks.

Clrfund For Everyone

Coordinator manual

Coordinate using MACI CLI

Clone the MACI repo and switch to version v0.9.4:

git clone https://github.com/appliedzkp/maci.git
cd maci/
git checkout v0.9.4

Follow instructions in README.md to install necessary dependencies.

Medium Circuits

Download zkSNARK parameters for 'medium' circuits into circuits/params/ directory and rebuild the keys:

cd circuits
./scripts/buildSnarksMedium.sh

x32 Circuits

Download zkSNARK parameters for 'x32' circuits into circuits/params/ directory and rebuild the keys:

cd circuits
./scripts/buildSnarks32.sh

Recompile the contracts:

cd ../contracts
npm run compileSol

Generate coordinator key

cd ../cli
node build/index.js genMaciKeypair

A single key can be used to coordinate multiple rounds.

Tally votes

Decrypt messages and tally the votes:

cd ../cli
node build/index.js genProofs \
    --eth-provider <json-rpc-api-url> \
    --contract <maci-address> \
    --privkey <coordinator-private-key> \
    --output proofs.json \
    --tally-file tally.json

Coordinator private key must be in MACI key format (starts with macisk). Ethereum private key can be any private key that controls the necessary amount of ETH to pay for gas.

The genProofs command will create two files: proofs.json and tally.json. The proofs.json file will be needed to run the next command which submits proofs to MACI contract:

node build/index.js proveOnChain \
    --eth-provider <json-rpc-api-url> \
    --contract <maci-address> \
    --privkey <coordinator-private-key> \
    --eth-privkey <eth-private-key> \
    --proof-file proofs.json

The process may take several hours. Results can be found in tally.json file, which must then be published via IPFS.

Finally, the CID of tally file must be submitted to FundingRound contract:

await fundingRound.publishTallyHash('<CID>')

Coordinate using clrfund scripts

Generate coordinator key

cd contracts/
yarn ts-node scripts/generate-key.ts

A single key can be used to coordinate multiple rounds.

Tally votes

Install zkutil (see instructions in MACI readme).

Switch to contracts directory:

cd contracts/

Download zkSNARK parameters for 'medium' circuits to snark-params directory. Example:

ipfs get --output snark-params QmRzp3vkFPNHPpXiu7iKpPqVnZB97wq7gyih2mp6pa5bmD

Set the path to downloaded parameter files and also the path to zkutil binary (if needed):

export NODE_CONFIG='{"snarkParamsPath": "../../../contracts/snark-params/", "zkutil_bin": "/usr/bin/zkutil"}'

Decrypt messages and tally the votes:

COORDINATOR_PK=<coordinator-private-key> COORDINATOR_ETH_PK=<eth-private-key> ROUND_ADDRESS=<funding-round-address> yarn hardhat run --network xdai scripts/tally.ts

Result will be saved to tally.json file, which must then be published via IPFS.

User interface

User interface deployer is in development. Please contact designerdao.eth@gmail.com for help on launching a user interface for your contracts.

Running the funding round

Administrator of clr.fund instance should set parameters before starting the funding round. Once the round has started, it is mostly autonomous and its parameters can not be changed. It can only be finalized (allowing recipients to claim allocated funding) or cancelled (allowing contributors can withdraw their funds).

The arguments for transferMatchingFunds method should be taken from tally.json file published by the :

• total-spent value can be found by key totalVoiceCredits.spent.

• total-spent-salt value can be found by key totalVoiceCredits.salt.

Providing matching funds

The funding source is an ethereum address from which clr.fund can receive matching funding using the . It could be an externally owned account or a contract (such as DAO).

To become a funding source the address should be added the list of funding sources by clr.fund administrator. At the end of each funding round clr.fund checks token allowance for the FundingRoundFactory contract address and transfers allowed amount of tokens to the matching pool.