Skip to content

Latest commit

 

History

History
99 lines (70 loc) · 3.76 KB

README.md

File metadata and controls

99 lines (70 loc) · 3.76 KB
Raw

Ajna Ecosystem Coordination

Contracts

Grant Fund

Ajna Token


Tests

For information on running tests and checking code coverage see the Tests README.

Development

Install Foundry instructions then, install the foundry toolchain installer (foundryup) with:

curl -L https://foundry.paradigm.xyz | bash

To get the latest forge or cast binaries, tun

foundryup

Project Setup

  • Make a copy of .env.example and name it .env. Add the values for
    • ETH_RPC_URL - required by forge to fork chain
  • Run
make all

Contract Deployment

Ensure the following env variables are in your .env file or exported into your environment.

Environment Variable Purpose
DEPLOY_ADDRESS address from which you wish to deploy
DEPLOY_KEY path to the JSON keystore file for the deployment address
ETHERSCAN_API_KEY required to verify contracts
ETH_RPC_URL node on your target deployment network

Here's an example:

DEPLOY_ADDRESS=0x9965507d1a55bcc2695c58ba16fb37d819b0a4dc
DEPLOY_KEY=~/hush/deployment.json
ETHERSCAN_API_KEY=55ORCKI875XKNO89475DNOCHDPINI54OFY
ETH_RPC_URL=http://127.0.0.1:8545

You will be prompted for your key's password interactively.

⚠ The ETH_RPC_URL you provide determines the deployment network for your contract.

If you wish to deploy against an anvil or ganache endpoint, edit the Makefile, replacing --keystore ${DEPLOY_KEY} with --private-key ${DEPLOY_PRIVATE_KEY}. In your environment, set DEPLOY_ADDRESS to one of the pre-funded accounts and DEPLOY_PRIVATE_KEY to the unencrypted private key.

AJNA token

Deployment of the AJNA token requires an argument stating where minted tokens should be sent. AJNA has already been deployed to Goerli and Mainnet; see AJNA_TOKEN.md for addresses. There is no reason to deploy the AJNA token to L2s or sidechains; see MULTICHAIN_STRATEGY.md for details. Upon deployment, minted tokens are transferred to a user-specified address which must be specified in make arguments. To run a new deployment on a test network or local testchain, run:

make deploy-ajnatoken mintto=<MINT_TO_ADDRESS>

Record the address of the token upon deployment. See AJNA_TOKEN.md for validation.

Burn Wrapper

To deploy, ensure the correct AJNA token address is specified in code. Then, run:

make deploy-burnwrapper ajna=<AJNA_TOKEN_ADDRESS>

Grant Fund

Deployment of the Grant Coordination Fund requires an argument to specify the address of the AJNA token. The deployment script also uses the token address to determine funding level.

To deploy, run:

make deploy-grantfund ajna=<AJNA_TOKEN_ADDRESS>

See GRANT_FUND.md for next steps.

Grant Fund deployer

Deployer contract can be used to deploy grant fund, fund treasury and start distribution in a single call to avoid someone starting a distribution without treasury.

Steps to use Deployer contract to deploy grant Fund:

  1. Deploy Deployer contract.
  2. Approve <treasury_amount> AJNA to Deployer contract from treasury address.
  3. Call deployGrantFund(address ajnaToken_, uint256 treasury_) from treasury address to deploy grant fund and start distribution with treasury amount.
  4. GrantFund can be verified using remix contract verification plugin, foundry or hardhat.

To deploy Deployer contract, run:

make deploy-grantfund-deployer