Skip to main content

Module ITIP403Registry

Module ITIP403Registry 

Source
Expand description

Module containing a contract’s types and functions.

interface ITIP403Registry {
    enum PolicyType { WHITELIST, BLACKLIST, COMPOUND }
    function policyIdCounter() external view returns (uint64);
    function policyExists(uint64 policyId) external view returns (bool);
    function policyData(uint64 policyId) external view returns (PolicyType policyType, address admin);
    function isAuthorized(uint64 policyId, address user) external view returns (bool);
    function isAuthorizedSender(uint64 policyId, address user) external view returns (bool);
    function isAuthorizedRecipient(uint64 policyId, address user) external view returns (bool);
    function isAuthorizedMintRecipient(uint64 policyId, address user) external view returns (bool);
    function compoundPolicyData(uint64 policyId) external view returns (uint64 senderPolicyId, uint64 recipientPolicyId, uint64 mintRecipientPolicyId);
    function createPolicy(address admin, PolicyType policyType) external returns (uint64);
    function createPolicyWithAccounts(address admin, PolicyType policyType, address[] calldata accounts) external returns (uint64);
    function setPolicyAdmin(uint64 policyId, address admin) external;
    function modifyPolicyWhitelist(uint64 policyId, address account, bool allowed) external;
    function modifyPolicyBlacklist(uint64 policyId, address account, bool restricted) external;
    function createCompoundPolicy(uint64 senderPolicyId, uint64 recipientPolicyId, uint64 mintRecipientPolicyId) external returns (uint64);
    event PolicyAdminUpdated(uint64 indexed policyId, address indexed updater, address indexed admin);
    event PolicyCreated(uint64 indexed policyId, address indexed updater, PolicyType policyType);
    event WhitelistUpdated(uint64 indexed policyId, address indexed updater, address indexed account, bool allowed);
    event BlacklistUpdated(uint64 indexed policyId, address indexed updater, address indexed account, bool restricted);
    event CompoundPolicyCreated(uint64 indexed policyId, address indexed creator, uint64 senderPolicyId, uint64 recipientPolicyId, uint64 mintRecipientPolicyId);
    error Unauthorized();
    error PolicyNotFound();
    error PolicyNotSimple();
    error InvalidPolicyType();
    error IncompatiblePolicyType();
}

Modules§

abi
Contains dynamic ABI definitions for this contract.

Structs§

BlacklistUpdated
Event with signature BlacklistUpdated(uint64,address,address,bool) and selector 0x94c23f8f319426f2da63b46b024acbc55fe44a5c59dc4c00d11b792515083c54.
CompoundPolicyCreated
Event with signature CompoundPolicyCreated(uint64,address,uint64,uint64,uint64) and selector 0x6e054cdd4e9405e97868ec27e55ca41ee66a481d8cbab2f0283a87a6727a9ab6.
ITIP403RegistryInstance
A ITIP403Registry instance.
IncompatiblePolicyType
Custom error with signature IncompatiblePolicyType() and selector 0xf1011ef5.
InvalidPolicyType
Custom error with signature InvalidPolicyType() and selector 0xcb9f942f.
PolicyAdminUpdated
Event with signature PolicyAdminUpdated(uint64,address,address) and selector 0x98925cfb1bc09c5b43dd0dd56d3d95aa04fb3300927580cc588c3f5dd58c15e1.
PolicyCreated
Event with signature PolicyCreated(uint64,address,uint8) and selector 0x718d87917f0c4cfd1263707ef0e77c656ed8d8bfaca06152bdb0b8094142ec27.
PolicyNotFound
Custom error with signature PolicyNotFound() and selector 0x720caa4f.
PolicyNotSimple
Custom error with signature PolicyNotSimple() and selector 0x7d1fd1a1.
Unauthorized
Custom error with signature Unauthorized() and selector 0x82b42900.
WhitelistUpdated
Event with signature WhitelistUpdated(uint64,address,address,bool) and selector 0xb15f514df899cf1b4ef0dc78f930c10d98883756fa3a1a8853a98132e7f4c5a6.
compoundPolicyDataCall
Function with signature compoundPolicyData(uint64) and selector 0xb6266019.
compoundPolicyDataReturn
Container type for the return parameters of the compoundPolicyData(uint64) function.
createCompoundPolicyCall
Function with signature createCompoundPolicy(uint64,uint64,uint64) and selector 0x5da414ee.
createCompoundPolicyReturn
Container type for the return parameters of the createCompoundPolicy(uint64,uint64,uint64) function.
createPolicyCall
Function with signature createPolicy(address,uint8) and selector 0xca5d55f6.
createPolicyReturn
Container type for the return parameters of the createPolicy(address,uint8) function.
createPolicyWithAccountsCall
Function with signature createPolicyWithAccounts(address,uint8,address[]) and selector 0xa2d3044f.
createPolicyWithAccountsReturn
Container type for the return parameters of the createPolicyWithAccounts(address,uint8,address[]) function.
isAuthorizedCall
Function with signature isAuthorized(uint64,address) and selector 0x55a1179e.
isAuthorizedMintRecipientCall
Function with signature isAuthorizedMintRecipient(uint64,address) and selector 0xb389e305.
isAuthorizedMintRecipientReturn
Container type for the return parameters of the isAuthorizedMintRecipient(uint64,address) function.
isAuthorizedRecipientCall
Function with signature isAuthorizedRecipient(uint64,address) and selector 0x6fbc13d6.
isAuthorizedRecipientReturn
Container type for the return parameters of the isAuthorizedRecipient(uint64,address) function.
isAuthorizedReturn
Container type for the return parameters of the isAuthorized(uint64,address) function.
isAuthorizedSenderCall
Function with signature isAuthorizedSender(uint64,address) and selector 0x14abd81d.
isAuthorizedSenderReturn
Container type for the return parameters of the isAuthorizedSender(uint64,address) function.
modifyPolicyBlacklistCall
Function with signature modifyPolicyBlacklist(uint64,address,bool) and selector 0xc62b27d4.
modifyPolicyBlacklistReturn
Container type for the return parameters of the modifyPolicyBlacklist(uint64,address,bool) function.
modifyPolicyWhitelistCall
Function with signature modifyPolicyWhitelist(uint64,address,bool) and selector 0x71ec67a3.
modifyPolicyWhitelistReturn
Container type for the return parameters of the modifyPolicyWhitelist(uint64,address,bool) function.
policyDataCall
Function with signature policyData(uint64) and selector 0x50214329.
policyDataReturn
Container type for the return parameters of the policyData(uint64) function.
policyExistsCall
Function with signature policyExists(uint64) and selector 0x330f5637.
policyExistsReturn
Container type for the return parameters of the policyExists(uint64) function.
policyIdCounterCall
Function with signature policyIdCounter() and selector 0x3cc32f9c.
policyIdCounterReturn
Container type for the return parameters of the policyIdCounter() function.
setPolicyAdminCall
Function with signature setPolicyAdmin(uint64,address) and selector 0x25f7d376.
setPolicyAdminReturn
Container type for the return parameters of the setPolicyAdmin(uint64,address) function.

Enums§

ITIP403RegistryCalls
Container for all the ITIP403Registry function calls.
ITIP403RegistryErrors
Container for all the ITIP403Registry custom errors.
ITIP403RegistryEvents
Container for all the ITIP403Registry events.
PolicyType

Functions§

new
Creates a new wrapper around an on-chain ITIP403Registry contract instance.