yarn install

yarn test

Note: When running any hardhat command for Vana and Morph, you need to specify the config file, use --config hardhat.v1.config.ts.

Run the localtest in one terminal:

yarn hardhat node

Deploy Registry:

yarn hardhat --network localhost registry:deploy

And create some dummy data:

yarn hardhat --network localhost registry:populate

Deploy DivviRegistry:

yarn hardhat --network localhost divvi-registry:deploy

Deploy mock token:

yarn hardhat mock-token:deploy --network localhost

Deploy RewardPool using the deployed mock token address:

yarn hardhat reward-pool:deploy \
    --network localhost \
    --pool-token 0x5FbDB2315678afecb367f032d93F642f64180aa3 \
    --reward-function 0xa1b2c3d4e5f67890abcdef1234567890abcdef12 \
    --timelock 1767222000

The token address above will match if you deploy the mock token first thing on the fresh Harhat node.

Run Harhdat console:

yarn hardhat console --network localhost

Use ethers in Hardhat console to interact with the contract:

const RewardPool = await ethers.getContractFactory("RewardPool")
const rewardPool = await RewardPool.attach('0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0')
await rewardPool.rewardFunctionId()

You may want to set the ALCHEMY_KEY in .env to avoid getting rate limited by RPC nodes.

Fetch referrals for a specific protocol, removes duplicate events across chains, and filters out events where the user was previously exposed to the protocol. By default the output file is <protocol>-referrals.csv

$ yarn ts-node ./scripts/fetchReferrals.ts --protocol beefy
Fetching referral events for protocol: beefy
Wrote results to beefy-referrals.csv

Calculates KPI for a list of referrals. By default it directly reads from the output script of fetchReferrals.ts. By default the output file is rewards/<protocol>/<startTimestampISO>_<endTimestampISO>/kpi.csv

$ yarn ts-node ./scripts/calculateKpi.ts --protocol beefy --startTimestamp 2025-05-08T00:00:00Z --endTimestamp 2025-05-16T00:00:00Z
Calculating KPI for 0x15B5f5FE55704140ce5057d85c28f8b237c1Bc53 (1/1)
Wrote results to rewards/beefy/2025-05-08T00:00:00.000Z_2025-05-16T00:00:00.000Z/kpi.csv

Calculating KPIs requires fetching the user's referral timestamp, which is slow due to rate limits. If running KPI calculations frequently, it may help to use Redis. Locally, run in a separate terminal:

docker-compose up

Then add the redis url to the above command:

$ yarn ts-node ./scripts/calculateKpi.ts --protocol beefy --startTimestamp 2025-05-08T00:00:00Z --endTimestamp 2025-05-16T00:00:00Z --redis-connection=redis://127.0.0.1:6379

Fetch the count of users referred for a specific protocol. If no network IDs or referrer IDs are passed, get the user count for all referrers across all supported networks for that protocol.

# networkIds is optional
yarn ts-node ./scripts/referrerUserCount.ts --protocol Beefy --referrerIds app1 app2 app3 --networkIds celo-mainnet base-mainnet

Our example Data Availability contract (located on Op Mainnet at 0x2Bcbfc02AAa1dB9798179902DeE48F268C8DD3CC) tracks the number of Celo transfers users have made over a period of time. The script found in scripts/dataAvailability/getTokenTransfers.ts calculates this data for a specified time range and uploads it to a specified contract. It can be invoked with:

yarn ts-node scripts/dataAvailability/getTokenTransfers.ts --token-address 0x471EcE3750Da237f93B8E339c536989b8978a438 \
  --network celo-mainnet
  --start-block 34304880
  --end-block 34304900
  --output-file out.csv
  --data-availability-address=<DATA_AVAILABILITY_CONTRACT_ADDRESS>
  --upload

Raw objective function data will always be output to --output-file. If --upload is set, the script will additionally upload the data to the specified contract, using the account stored in the MNEMONIC environment variable.

More context on this script and how it can be used/modified can be found in the risc0-example repo.

This repository contains the contract(s) necessary to support the Divvi protocol v0.

See docs/contracts.md for network deployments.

We use OpenZeppelin Defender to manage deployments on Mainnet. Before beginning a deployment, make sure that your .env file is set up correctly. Namely, make sure to get the DEFENDER_API_KEY, DEFENDER_API_SECRET, CELOSCAN_API_KEY values from GSM and copy them in. (Ideally we could inject these config values into Hardhat automatically, but I haven't found a way to do that.)

To deploy Registry, run:

yarn hardhat registry:deploy --network celo

To deploy DivviRegistry, run:

yarn hardhat divvi-registry:deploy \
    --network op \
    --use-defender \
    --defender-deploy-salt <SALT> \
    --owner-address <OWNER_ADDRESS>

To deploy RewardPoolFactory, run:

yarn hardhat reward-pool-factory:deploy \
    --network celo \
    --use-defender \
    --defender-deploy-salt <SALT> \
    --owner-address <OWNER_ADDRESS>

To deploy RewardPool, run:

yarn hardhat reward-pool:deploy \
    --network celo \
    --use-defender \
    --defender-deploy-salt <SALT> \
    --owner-address <OWNER_ADDRESS> \
    --pool-token <TOKEN_ADDRESS> \
    --manager-address <MANAGER_ADDRESS> \
    --reward-function 0x<GIT_HASH> \
    --timelock <TIMESTAMP> \

After this is done, you should see output in your terminal with a command to run to verify the contract on the block explorers.

To upgrade DivviRegistry, run:

yarn hardhat divvi-registry:upgrade \
    --network op \
    --use-defender \
    --defender-deploy-salt <SALT> \
    --defender-upgrade-approval-process-id 8bc61a25-72ed-41df-8370-7aa94526f1cb \
    --proxy-address 0xEdb51A8C390fC84B1c2a40e0AE9C9882Fa7b7277

To upgrade the staging DivviRegistry, run:

yarn hardhat divvi-registry:upgrade \
    --network op \
    --use-defender \
    --defender-deploy-salt <SALT> \
    --defender-upgrade-approval-process-id f1d0a27d-c2f1-4f87-b36c-d3c308283702 \
    --proxy-address 0x2f5E320698dB89CbefB810Fa19264103d99aAFB1

To deploy DataAvailability, run:

yarn hardhat data-availability:deploy --network op \
  --owner-address <OWNER_ADDRESS> \
  --image-id <IMAGE_ID> \
  --verifier-address 0x0b144e07a0826182b6b59788c34b32bfa86fb711

More context is provided in the risc0-example repo.

Metadata about proxy and implementation deployments is automatically generated and stored in the .openzeppelin/ directory, which should be checked into version control.

In case you lost this file, this can be generated by using the hardhatForceImport.ts script. You can run the below command

ADDRESS=<proxy-address> CONTRACT_NAME=<contract-name> yarn hardhat run scripts/hardhatForceImport.ts --network <network>