Juice Extension Templates

This repo provides some implementation templates of peripheral contracts of the Juicebox V2 ecosystem, as well as some common implementation as examples.

Install Foundry

To get set up:

1. Install Foundry.

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

2. Install external lib(s)

git submodule update --init && yarn install

then run

forge update

If git modules are failing to clone, not installing, etc (ie overall submodule misbehaving), use git submodule update --init --recursive --force

3. Run tests:

forge test

4. Update Foundry periodically:

foundryup

Content

This repo is organised as follow:

• contracts/Allocator: contains an IJBSplitsAllocator implementation template (Allocator.sol) as well as existing implementions, in contracts/Allocator/examples: -- SunsetAllocator.sol: an allocator providing custom sunsets (a timestamp after which a reccuring payment is not made anymore) to each beneficiaries of a group of splits

• contracts/DatasourceDelegate: contains an IJBFundingCycleDataSource, IJBPayDelegate and IJBRedemptionDelegate implementation templates (DataSourceDelegate.sol) as well as existing implementions, in contracts/Allocator/examples: -- NFT directory: a datasource minting a NFT for every contribution and a redemption delegate preventing redemption for non-NFT holder ("closed-loop treasury") -- payment routing/: A datasource-delegate following the best possible route between minting and token buy on secondary market, in order to maximise the amount of token received by the contributor.

• contracts/Terminal: contains an IJBPaymentTerminal and IJBRedemptionTerminal implementation template.

Tests

Test for every extension are provided in contracts/test. Those test are using a complete Juicebox contracts deployment (provided in helpers/TestBaseWorkflow) without requiring a forked network.

Deploy & verify

Setup

Configure the .env variables, and add a mnemonic.txt file with the mnemonic of the deployer wallet. The sender address in the .env must correspond to the mnemonic account.

Rinkeby

yarn deploy-rinkeby

Mainnet

yarn deploy-mainnet

The deployments are stored in ./broadcast

See the Foundry Book for available options.