Juicebox Protocol: How to Prepare for an Audit of a Deployed Project

Overview

• You can launch a DAO with governance
• All-in-one crowdfunding with powerful treasury management and redemptions
• And as mentioned above, you can build and launch your NFT project

Architecture

Core contracts

JBTokenStore

1function mintFor(
2  address _holder,
3  uint256 _projectId,
4  uint256 _amount,
5  bool _preferClaimedTokens
6) external override onlyController(_projectId) { ... }

1function burnFrom(
2  address _holder,
3  uint256 _projectId,
4  uint256 _amount,
5  bool _preferClaimedTokens
6) external override onlyController(_projectId) { ... }

1function issueFor(
2  uint256 _projectId,
3  string calldata _name,
4  string calldata _symbol
5)
6  external
7  override
8  requirePermission(projects.ownerOf(_projectId), _projectId, JBOperations.ISSUE)
9  returns (IJBToken token)
10{ ... }

JBSplitsStore

• A project can store splits for an arbitrary number of groups, such as for payout distributions or for reserved token distributions.
• A split can specify an address, a Juicebox project, a contract that adheres to the IJBSplitAllocator interface, or the address that calls the transaction to distribute payouts or reserved tokens as its recipient.
• By default, splits can be changed at any time for any funding cycle configuration. A project's owner can also independently lock a split to a funding cycle configuration for a customizable duration.

1function set(
2  uint256 _projectId,
3  uint256 _domain,
4  JBGroupedSplits[] calldata _groupedSplits
5)
6  external
7  override
8  requirePermissionAllowingOverride(
9      projects.ownerOf(_projectId),
10      _projectId,
11      JBOperations.SET_SPLITS,
12      address(directory.controllerOf(_projectId)) == msg.sender
13  ) { ... }

1/**
2  @member preferClaimed A flag that only has effect if a projectId is also
3    specified, and the project has a token contract attached. If so, this flag
4    indicates if the tokens that result from making a payment to the project
5    should be delivered claimed into the beneficiary's wallet, or unclaimed
6    to save gas.
7  @member preferAddToBalance A flag indicating if a distribution to a project
8    should prefer triggering its addToBalance function instead of its pay function.
9  @member percent The percent of the whole group that this split occupies.
10    This number is out of `JBConstants.SPLITS_TOTAL_PERCENT`.
11  @member projectId The ID of a project. If an allocator is not set but a
12    projectId is set, funds will be sent to the protocol treasury belonging
13    to the project whose ID is specified.
14  @member beneficiary An address. The role of the beneficiary depends on
15    whether or not projectId is specified, and whether or not an allocator
16    is specified.
17  @member lockedUntil Specifies if the split should be unchangeable until
18    the specified time, with the exception of extending the locked period.
19  @member allocator If an allocator is specified, funds will be sent to the
20    allocator contract along with all properties of this split.
21*/
22struct JBSplit {
23  bool preferClaimed;
24  bool preferAddToBalance;
25  uint256 percent;
26  uint256 projectId;
27  address payable beneficiary;
28  uint256 lockedUntil;
29  IJBSplitAllocator allocator;
30}

JBPrices

1// The available price feeds.
2// The feed returns the number of `_currency` units that can be
3// converted to 1 `_base` unit.
4
5mapping(uint256 => mapping(uint256 => IJBPriceFeed)) public override feedFor;

1function addFeedFor(
2  uint256 _currency,
3  uint256 _base,
4  IJBPriceFeed _feed
5) external override onlyOwner { ... }

Surface contracts

• JBController3_1 — stitches together funding cycles and project tokens, allowing for restricted control, accounting, and token management.
• JBPayoutRedemptionPaymentTerminal3_1 — manages all inflows and outflows of funds.
• JBSingleTokenPaymentTerminalStore3_1 — manages accounting data on behalf of payment terminals that manage balances of only one token type.

Juice Buyback Delegate

What is a Buyback contract?

• It allows a retailer to return unsold inventory up to a specified amount at an agreed-upon price.
• It increases the optimal order quantity for the retailer, resulting in higher product availability and higher profits for both the retailer and the supplier.

What is a Data source contract?

• A data source contract is a way of providing extensions to a treasury that either overrides or augments the default payout redemption payment functionality.
• A data source contract can be used to provide custom data to the pay(...) transaction and/or the redeemTokensOf(...) transaction.
• A data source is responsible for specifying any delegate hooks that should be triggered after the core functionality of a pay(...) or redeemTokensOf(...) transaction executes successfully.

What is a Delegate contract?

• A delegate contract is a way of providing extensions to a treasury that augments the default payout redemption payment behavior.
• Pay delegates include a custom didPay(...) hook that will execute after all of the default protocol pay logic has been successfully executed in the terminal contract.
• Redemption delegates include a custom didRedeem(...) hook that will execute after all of the default protocol redeem logic has been successfully executed in the terminal contract.

JBXBuybackDelegate.sol

payParams()

1function payParams(JBPayParamsData calldata _data) external override
2  returns (
3    uint256 weight,
4    string memory memo,
5    JBPayDelegateAllocation[] memory delegateAllocations
6  )

didPay()

1function didPay(JBDidPayData calldata _data) external payable override

uniswapV3SwapCallback()

1function uniswapV3SwapCallback(
2  int256 amount0Delta,
3  int256 amount1Delta,
4  bytes calldata data
5) external override

Get in Touch