Allo Procotol Contracts

This project is built using hardhat. All the contracts required to run / manage a round can be found here. If you come across any vulnerabilities, do create an issue / raise a PR to help improve the contracts. ^_^

Directory Structure

.
├── contracts                           # Smart contracts
├   ├── utils                           # useful utils
├   ├── program                         # program contracts
├   ├   ├── ProgramFactory.sol          # factory contract which deploys program
├   ├   ├── ProgramImplementation.sol   # program contract
├   ├── round                           # round contracts
├   ├   ├── RoundFactory.sol            # factory contract which deploys round
├   ├   ├── RoundImplementation.sol     # round contract 
├   ├── votingStrategy                  # voting strategy
├   ├   ├── IVotingStrategy.sol         # voting strategy interface
├   ├   ├── QuadraticFundingVotingStrategy.sol      # QF voting strategy
├── scripts                             # Deploy scripts for smart contracts
├── docs                                # documentation 
├── test                                # Test for smart contracts
├── .env.example                        # .env template
├── .eslintrc.js                        # Eslint config
├── .prettierrc                         # Prettier config
├── .solhint.json                       # Solhint config
├── hardhat.config.json                 # Hardhat configuration
├── package.json                        # Package configuration
├── tsconfig.json                       # Typescript configuration
└── README.md

Terminology

• Program Operators: wallets that have the permission to create & manage the program
• Program: maintained by Program Operators which together form a team
• Round Operators: wallets that have the permission to create & manage the round
• Round: created by a Program and deal with everything relating to running a round
• Voter: wallet who cast a vote to a grant during the round

Deploy Steps

To know how the contracts should be setup, refer DEPLOY_STEPS.md

Chain Deployment List

To know the addresses are deployed on which network. refer CHAINS.md

Development

s To contribute to this project, fork the project and follow the instructions at DEV.md

This is built and maintained using hardhat

General Setup

These steps would have to be done per chain but there are intended to be deployed only once

Program

1. Deploy ProgramFactory
2. Deploy ProgramImplementation
3. Link ProgramImplementation to ProgramFactory contract

Round

1. Deploying all voting strategy (contracts under votingStrategy/)
2. Deploy RoundFactory
3. Deploy RoundImplementation
4. Link RoundImplementation to RoundFactory contract

Program Setup

1. To create a program, you would not deploy a contract but instead, rely on the create function on the ProgramFactory to create a clone of the already deployed ProgramImplementation contract
2. Any interaction in terms of updating parameters etc can be performed against the ProgramImplementation contract itself

The ProgramFactory enables us to have upgradable contracts on ProgramImplementation

Round Setup

1. To create a round, you would not deploy a contract but instead, rely on the create function on the RoundFactory to create a new RoundImplementation contract.
2. The user would have to choose a voting strategy like QuadraticFundingVotingStrategy (already deployed via instruction mention in DEPLOY_STEPS.md)
3. Any interaction in terms of updating parameters etc can be performed against the RoundImplementation contract itself

The RoundFactory enables us to have upgradable contracts on RoundImplementation.

Deploy Steps

To know how the contracts should be setup, refer DEPLOY_STEPS.md

Chain Deployment List

To know the addresses are deployed on which network. refer CHAINS.md

Development

To contribute to this project, fork the project and follow the instructions at DEV.md

You can run a local chain and deploy contracts using our docker configuration and tasks:

# Build the docker image with the project deps + anvil
make docker-build

# run a containerized chain with anvil
make docker-run

# deploy the contracts to the containerized chain
make docker-deploy-contracts

Contract Documentation

The contract documentation has been generated using primitive-dodoc and can be found over at docs/contracts