JBController

Stitches together funding cycles and project tokens, making sure all activity is accounted for and correct.

Code

https://github.com/jbx-protocol/juice-contracts-v2/blob/main/contracts/JBController.sol

Addresses

Ethereum mainnet: 0x4e3ef8AFCC2B52E4e704f4c8d9B7E7948F651351

Ethereum rinkeby: 0xd96ecf0E07eB197587Ad4A897933f78A00B21c9a

Interfaces

Name	Description
IJBController	General interface for the generic controller methods in this contract that interacts with funding cycles and tokens according to the protocol's rules.
IJBMigratable	Allows migrating to this contract, with a hook called to prepare for the migration.

Inheritance

Contract	Description
JBOperatable	Includes convenience functionality for checking a message sender's permissions before executing certain transactions.
ERC165	Introspection on interface adherance.

Constructor

/**
  @param _operatorStore A contract storing operator assignments.
  @param _projects A contract which mints ERC-721's that represent project ownership and transfers.
  @param _directory A contract storing directories of terminals and controllers for each project.
  @param _fundingCycleStore A contract storing all funding cycle configurations.
  @param _tokenStore A contract that manages token minting and burning.
  @param _splitsStore A contract that stores splits for each project.
*/
constructor(
  IJBOperatorStore _operatorStore,
  IJBProjects _projects,
  IJBDirectory _directory,
  IJBFundingCycleStore _fundingCycleStore,
  IJBTokenStore _tokenStore,
  IJBSplitsStore _splitsStore
) JBOperatable(_operatorStore) {
  projects = _projects;
  directory = _directory;
  fundingCycleStore = _fundingCycleStore;
  tokenStore = _tokenStore;
  splitsStore = _splitsStore;
}

• _operatorStore is an IJBOperatorStore contract storing operator assignments.
• _projects is an IJBProjects contract which mints ERC-721's that represent project ownership and transfers.
• _directory is an IJBDirectory contract storing directories of terminals and controllers for each project.
• _fundingCycleStore is an IJBFundingCycleStore contract storing all funding cycle configurations.
• _tokenStore is an IJBTokenStore contract that manages token minting and burning.
• _splitsStore is an IJBSplitsStore contract that stores splits for each project.

Events

Name	Data
LaunchProject	uint256 configuration uint256 projectId string memo address caller
LaunchFundingCycles	uint256 configuration uint256 projectId string memo address caller
ReconfigureFundingCycles	uint256 configuration uint256 projectId string memo address caller
SetFundAccessConstraints	uint256 indexed fundingCycleConfiguration uint256 indexed fundingCycleNumber uint256 indexed projectId JBFundAccessConstraints constraints address caller
DistributeReservedTokens	uint256 indexed fundingCycleConfiguration uint256 indexed fundingCycleNumber uint256 indexed projectId address beneficiary uint256 tokenCount uint256 beneficiaryTokenCount string memo address caller
DistributeToReservedTokenSplit	uint256 indexed projectId uint256 indexed domain uint256 indexed group JBSplit split uint256 count address caller
MintTokens	address indexed beneficiary uint256 indexed projectId uint256 tokenCount string memo uint256 reservedRate address caller
BurnTokens	address indexed holder uint256 indexed projectId uint256 tokenCount string memo address caller
PrepMigration	uint256 projectId IJBController from address caller
Migrate	uint256 projectId IJBController to address caller

Properties

Function	Definition
projects	Traits immutable Returns IJBProjects
fundingCycleStore	Traits immutable Returns IJBFundingCycleStore
tokenStore	Traits immutable Returns IJBTokenStore
splitsStore	Traits immutable Returns IJBSplitsStore
directory	Traits immutable Returns IJBDirectory

Read

Function	Definition
distributionLimitOf	Params uint256 _projectId uint256 _configuration IJBPaymentTerminal _terminal address _token Returns uint256 distributionLimit
overflowAllowanceOf	Params uint256 _projectId uint256 _configuration IJBPaymentTerminal _terminal address _token Returns uint256 overflowAllowance
reservedTokenBalanceOf	Params uint256 _projectId uint256 _reservedRate Returns uint256 reservedTokenBalance
totalOutstandingTokensOf	Params uint256 _projectId uint256 _reservedRate Returns uint256 totalOutstandingTokens
getFundingCycleOf	Params uint256 _projectId uint256 _configuration Returns JBFundingCycle fundingCycle JBFundingCycleMetadata metadata
latestConfiguredFundingCycleOf	Params uint256 _projectId Returns JBFundingCycle fundingCycle JBFundingCycleMetadata metadata JBBallotState ballotState
currentFundingCycleOf	Params uint256 _projectId Returns JBFundingCycle fundingCycle JBFundingCycleMetadata metadata
queuedFundingCycleOf	Params uint256 _projectId Returns JBFundingCycle fundingCycle JBFundingCycleMetadata metadata
supportsInterface	Params uint256 _interfaceId Returns bool

Write

Function	Definition
launchProjectFor	Traits virtual Params address _owner JBMetadataContent _projectMetadata JBFundingCycleData _data JBFundingCycleMetadata _metadata uint256 _mustStartAtOrAfter JBGroupedSplits[] _groupedSplits JBFundAccessConstraints[] _fundAccessConstraints IJBPaymentTerminal[] _terminals string calldata _memo Returns uint256 projectId
launchFundingCyclesFor	Traits requirePermission virtual Params uint256 _projectId JBFundingCycleData _data JBFundingCycleMetadata _metadata uint256 _mustStartAtOrAfter JBGroupedSplits[] _groupedSplits JBFundAccessConstraints[] _fundAccessConstraints IJBPaymentTerminal[] _terminals string calldata _memo Returns uint256 configuration
reconfigureFundingCyclesOf	Traits requirePermission virtual Params uint256 _projectId JBFundingCycleData _data JBFundingCycleMetadata _metadata JBGroupedSplits[] _groupedSplits JBFundAccessConstraints[] _fundAccessConstraints string calldata _memo Returns uint256 configuration
issueTokenFor	Traits requirePermission virtual Params uint256 _projectId string _name string _symbol Returns IJBToken token
changeTokenOf	Traits requirePermission virtual Params uint256 _projectId IJBToken _token address _newOwner
mintTokensOf	Traits requirePermissionAllowingOverride virtual Params uint256 _projectId uint256 _tokenCount address _beneficiary string _memo bool _preferClaimedTokens, bool _useReservedRate Returns uint256 beneficiaryTokenCount
burnTokensOf	Traits requirePermissionAllowingOverride virtual Params address _holder uint256 _projectId uint256 _tokenCount string _memo bool _preferClaimedTokens
distributeReservedTokensOf	Traits virtual Params uint256 _projectId string _memo Returns uint256 tokenCount
prepForMigrationOf	Traits virtual Params uint256 _projectId address _from
migrate	Traits requirePermission virtual Params uint256 _projectId IJBMigratable _to