Registry

Registry entity - manages Factory and Entity state info.
Methods
authority
function authority() external view returns (contract Authority)
Returns
Name
Type
Description
_0
contract Authority
undefined
baseToken
function baseToken() external view returns (contract ERC20)
Base Token address is the stable coin contract used throughout the system.
Returns
Name
Type
Description
_0
contract ERC20
undefined
canCall
function canCall(address user, address target, bytes4 functionSig) external view returns (bool)
Parameters
Name
Type
Description
user
address
undefined
target
address
undefined
functionSig
bytes4
undefined
Returns
Name
Type
Description
_0
bool
undefined
doesRoleHaveCapability
function doesRoleHaveCapability(uint8 role, address target, bytes4 functionSig) external view returns (bool)
Parameters
Name
Type
Description
role
uint8
undefined
target
address
undefined
functionSig
bytes4
undefined
Returns
Name
Type
Description
_0
bool
undefined
doesUserHaveRole
function doesUserHaveRole(address user, uint8 role) external view returns (bool)
Parameters
Name
Type
Description
user
address
undefined
role
uint8
undefined
Returns
Name
Type
Description
_0
bool
undefined
getDonationFee
function getDonationFee(contract Entity _entity) external view returns (uint32)
Gets default donation fee pct (as a zoc) for an Entity.
Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned.
Parameters
Name
Type
Description
_entity
contract Entity
The receiving entity of the donation for which the fee is being fetched.
Returns
Name
Type
Description
_0
uint32
uint32 The default donation fee for the entity's type.
getDonationFeeWithOverrides
function getDonationFeeWithOverrides(contract Entity _entity) external view returns (uint32)
Gets lowest possible donation fee pct (as a zoc) for an Entity, among default and override.
Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned.
Parameters
Name
Type
Description
_entity
contract Entity
The receiving entity of the donation for which the fee is being fetched.
Returns
Name
Type
Description
_0
uint32
uint32 The minimum of the default donation fee and the receiver's fee override.
getPayoutFee
function getPayoutFee(contract Entity _entity) external view returns (uint32)
Gets default payout fee pct (as a zoc) for an Entity.
Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned.
Parameters
Name
Type
Description
_entity
contract Entity
The sender entity of the payout for which the fee is being fetched.
Returns
Name
Type
Description
_0
uint32
uint32 The default payout fee for the entity's type.
getPayoutFeeWithOverrides
function getPayoutFeeWithOverrides(contract Entity _entity) external view returns (uint32)
Gets lowest possible payout fee pct (as a zoc) for an Entity, among default and override.
Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned.
Parameters
Name
Type
Description
_entity
contract Entity
The sender entity of the payout for which the fee is being fetched.
Returns
Name
Type
Description
_0
uint32
uint32 The minimum of the default payout fee and the sender's fee override.
getRolesWithCapability
function getRolesWithCapability(address, bytes4) external view returns (bytes32)
Parameters
Name
Type
Description
_0
address
undefined
_1
bytes4
undefined
Returns
Name
Type
Description
_0
bytes32
undefined
getTransferFee
function getTransferFee(contract Entity _sender, contract Entity _receiver) external view returns (uint32)
Gets default transfer fee pct (as a zoc) between sender & receiver Entities.
Makes use of _parseFeeWithFlip, so if no default exists, "type(uint32).max" will be returned.
Parameters
Name
Type
Description
_sender
contract Entity
The sending entity of the transfer for which the fee is being fetched.
_receiver
contract Entity
The receiving entity of the transfer for which the fee is being fetched.
Returns
Name
Type
Description
_0
uint32
uint32 The default transfer fee.
getTransferFeeWithOverrides
function getTransferFeeWithOverrides(contract Entity _sender, contract Entity _receiver) external view returns (uint32)
Gets lowest possible transfer fee pct (as a zoc) between sender & receiver Entities, among default and overrides.
Makes use of _parseFeeWithFlip, so if no default or overrides exist, "type(uint32).max" will be returned.
Parameters
Name
Type
Description
_sender
contract Entity
The sending entity of the transfer for which the fee is being fetched.
_receiver
contract Entity
The receiving entity of the transfer for which the fee is being fetched.
Returns
Name
Type
Description
_0
uint32
uint32 The minimum of the default transfer fee, and sender and receiver overrides.
getUserRoles
function getUserRoles(address) external view returns (bytes32)
Parameters
Name
Type
Description
_0
address
undefined
Returns
Name
Type
Description
_0
bytes32
undefined
isActiveEntity
function isActiveEntity(contract Entity) external view returns (bool)
Mapping of active status of entities.
Parameters
Name
Type
Description
_0
contract Entity
undefined
Returns
Name
Type
Description
_0
bool
undefined
isActivePortfolio
function isActivePortfolio(contract Portfolio) external view returns (bool)
Maps portfolios to their enabled/disabled status.
Parameters
Name
Type
Description
_0
contract Portfolio
undefined
Returns
Name
Type
Description
_0
bool
undefined
isApprovedFactory
function isApprovedFactory(address) external view returns (bool)
Mapping of approved factory contracts that are allowed to register new Entities.
Parameters
Name
Type
Description
_0
address
undefined
Returns
Name
Type
Description
_0
bool
undefined
isCapabilityPublic
function isCapabilityPublic(address, bytes4) external view returns (bool)
Parameters
Name
Type
Description
_0
address
undefined
_1
bytes4
undefined
Returns
Name
Type
Description
_0
bool
undefined
isSwapperSupported
function isSwapperSupported(contract ISwapWrapper) external view returns (bool)
Maps swap wrappers to their enabled/disabled status.
Parameters
Name
Type
Description
_0
contract ISwapWrapper
undefined
Returns
Name
Type
Description
_0
bool
undefined
owner
function owner() external view returns (address)
Returns
Name
Type
Description
_0
address
undefined
setAuthority
function setAuthority(contract Authority newAuthority) external nonpayable
Parameters
Name
Type
Description
newAuthority
contract Authority
undefined
setDefaultDonationFee
function setDefaultDonationFee(uint8 _entityType, uint32 _fee) external nonpayable
Sets the default donation fee for an entity type.
Parameters
Name
Type
Description
_entityType
uint8
Entity type.
_fee
uint32
The fee percentage to be set (a zoc).
setDefaultPayoutFee
function setDefaultPayoutFee(uint8 _entityType, uint32 _fee) external nonpayable
Sets the default payout fee for an entity type.
Parameters
Name
Type
Description
_entityType
uint8
Entity type.
_fee
uint32
The fee percentage to be set (a zoc).
setDefaultTransferFee
function setDefaultTransferFee(uint8 _fromEntityType, uint8 _toEntityType, uint32 _fee) external nonpayable
Sets the default transfer fee for transfers from one specific entity type to another.
Parameters
Name
Type
Description
_fromEntityType
uint8
The entityType making the transfer.
_toEntityType
uint8
The receiving entityType.
_fee
uint32
The transfer fee percentage (a zoc).
setDonationFeeReceiverOverride
function setDonationFeeReceiverOverride(contract Entity _entity, uint32 _fee) external nonpayable
Sets the donation fee receiver override for a specific entity.
Parameters
Name
Type
Description
_entity
contract Entity
Entity.
_fee
uint32
The overriding fee (a zoc).
setEntityActive
function setEntityActive(contract Entity _entity) external nonpayable
Sets Entity as active. This is a special method to be called only by approved factories. Other callers should use setEntityStatus instead.
Parameters
Name
Type
Description
_entity
contract Entity
The entity.
setEntityStatus
function setEntityStatus(contract Entity _entity, bool _isActive) external nonpayable
Sets the enable/disable state of an Entity.
Parameters
Name
Type
Description
_entity
contract Entity
The entity whose active state is to be updated.
_isActive
bool
True if the entity should be active, false otherwise.
setFactoryApproval
function setFactoryApproval(address _factory, bool _isApproved) external nonpayable
Sets the approval state of a factory. Grants the factory permissions to set entity status.
Parameters
Name
Type
Description
_factory
address
The factory whose approval state is to be updated.
_isApproved
bool
True if the factory should be approved, false otherwise.
setOwner
function setOwner(address newOwner) external nonpayable
Parameters
Name
Type
Description
newOwner
address
undefined
setPayoutFeeOverride
function setPayoutFeeOverride(contract Entity _entity, uint32 _fee) external nonpayable
Sets the payout fee override for a specific entity.
Parameters
Name
Type
Description
_entity
contract Entity
Entity.
_fee
uint32
The overriding fee (a zoc).
setPortfolioStatus
function setPortfolioStatus(contract Portfolio _portfolio, bool _isActive) external nonpayable
Sets the enable/disable state of a Portfolio.
Parameters
Name
Type
Description
_portfolio
contract Portfolio
Portfolio.
_isActive
bool
True if setting portfolio to active, false otherwise.
setPublicCapability
function setPublicCapability(address target, bytes4 functionSig, bool enabled) external nonpayable
Parameters
Name
Type
Description
target
address
undefined
functionSig
bytes4
undefined
enabled
bool
undefined
setRoleCapability
function setRoleCapability(uint8 role, address target, bytes4 functionSig, bool enabled) external nonpayable
Parameters
Name
Type
Description
role
uint8
undefined
target
address
undefined
functionSig
bytes4
undefined
enabled
bool
undefined
setSwapWrapperStatus
function setSwapWrapperStatus(contract ISwapWrapper _swapWrapper, bool _supported) external nonpayable
Sets the enable/disable state of a SwapWrapper. System owners must ensure meticulous review of SwapWrappers before approving them.
Parameters
Name

Name	Type	Description
user	address	undefined
target	address	undefined
functionSig	bytes4	undefined

Name	Type	Description
role	uint8	undefined
target	address	undefined
functionSig	bytes4	undefined

Name	Type	Description
_sender	contract Entity	The sending entity of the transfer for which the fee is being fetched.
_receiver	contract Entity	The receiving entity of the transfer for which the fee is being fetched.

Name	Type	Description
_entityType	uint8	Entity type.
_fee	uint32	The fee percentage to be set (a zoc).

Name	Type	Description
_fromEntityType	uint8	The entityType making the transfer.
_toEntityType	uint8	The receiving entityType.
_fee	uint32	The transfer fee percentage (a zoc).

Name	Type	Description
_entity	contract Entity	Entity.
_fee	uint32	The overriding fee (a zoc).

Name	Type	Description
_entity	contract Entity	The entity whose active state is to be updated.
_isActive	bool	True if the entity should be active, false otherwise.

Name	Type	Description
_factory	address	The factory whose approval state is to be updated.
_isApproved	bool	True if the factory should be approved, false otherwise.

Name	Type	Description
_portfolio	contract Portfolio	Portfolio.
_isActive	bool	True if setting portfolio to active, false otherwise.