Operator
What everyone needs to know
- An operator is an address that has been given permission to take one or more actions on another address's behalf.
- Several functions are only available to a project's owner, or to an operator address that the project's owner has set.
- Operator permissions are stored and managed in the
JBOperatorStore, where they can be added or revoked at any time by the address being operated on behalf of. - Operator permissions are expressed in terms of indexes defined in
JBOperations. - Operator permissions apply to a specific domain namespace, which is used in the Juicebox ecosystem to allow addresses to give permissions that only apply to a specific project (where the domain is the project's ID). A domain of 0 is a wildcard domain, giving an operator access to an action across all domains.
What you'll want to know if you're building
- Permission indexes can be found in
JBOperations,JBOperations2, andJBUriOperations. See Namespaces for a list. - Any address can give an operator permissions to take one or more actions on its behalf by sending a transaction to
JBOperatorStore.setOperator(...). To set multiple operators in the same transaction, useJBOperatorStore.setOperators(...). - Access can be revoked from an operator through the same operations as above by sending an array of permissions that does not include those you wish to revoke.
- Permission for each operation is stored in a bit within an
uint256. If the bit is 1, the permission is enabled for the particular operator within the particular domain. Otherwise it is disabled. JBOperatorStore.hasPermission(...)andJBOperatorStore.hasPermissions(...)can be used to check if an operator has a particular permission.
Operatable functionality
For each project, the following functions can only be accessed by either the address that owns the project's NFT or by operator addresses explicitly allowed by the address that owns the project's NFT. Operators are only valid in the context of a particular owner – if the NFT changes hands, the operators for the project must be set again by the new owner.
An address can set operators for its project with JBOperatorStore.setOperator(...), using the indexes from the JBOperations library. An Operator's permissions depend on the specific parameters the admin allows them. Each of the following functions can be called by the admin, and also by any operator that has been granted permission to call the function by the admin.
JBController3_1.launchFundingCyclesFor(...)JBController3_1.reconfigureFundingCyclesOf(...)JBController3_1.mintTokensOf(...)JBTokenStore.issueFor(...)JBController3_1.setFor(...)JBController3_1.migrate(...)JBPayoutRedemptionPaymentTerminal3_1_1.useAllowanceOf(...)JBPayoutRedemptionPaymentTerminal3_1_1.migrate(...)JBPayoutRedemptionPaymentTerminal3_1_1.processFees(...)JBProjects.setMetadataOf(...)JBSplitsStore.set(...)JBDirectory.setControllerOf(...)JBDirectory.setTerminalsOf(...)JBDirectory.setPrimaryTerminalOf(...)
The following transactions can be used by token holders or operator addresses explicitly allowed by the address that owns the tokens. If the tokens change hands, the operators must be set again by the new holder.