ICreatorBase
Author: transientlabs.xyz
Base interface for creator contracts
Interface id = 0x1c8e024d
Functions
totalSupply
Function to get total supply minted so far
function totalSupply() external view returns (uint256);
setApprovedMintContracts
Function to set approved mint contracts
Access to owner or admin
function setApprovedMintContracts(address[] calldata minters, bool status) external;
Parameters
| Name | Type | Description |
|---|---|---|
minters | address[] | Array of minters to grant approval to |
status | bool | Status for the minters |
setBlockListRegistry
Function to change the blocklist registry
Access to owner or admin
function setBlockListRegistry(address newBlockListRegistry) external;
Parameters
| Name | Type | Description |
|---|---|---|
newBlockListRegistry | address | The new blocklist registry |
blocklistRegistry
Function to get the blocklist registry
function blocklistRegistry() external view returns (IBlockListRegistry);
setNftDelegationRegistry
Function to change the TL NFT delegation registry
Access to owner or admin
function setNftDelegationRegistry(address newNftDelegationRegistry) external;
Parameters
| Name | Type | Description |
|---|---|---|
newNftDelegationRegistry | address | The new blocklist registry |
tlNftDelegationRegistry
Function to get the delegation registry
function tlNftDelegationRegistry() external view returns (ITLNftDelegationRegistry);
setDefaultRoyalty
Function to set the default royalty specification
Requires owner or admin
function setDefaultRoyalty(address newRecipient, uint256 newPercentage) external;
Parameters
| Name | Type | Description |
|---|---|---|
newRecipient | address | The new royalty payout address |
newPercentage | uint256 | The new royalty percentage in basis (out of 10,000) |
setTokenRoyalty
Function to override a token's royalty info
Requires owner or admin
function setTokenRoyalty(uint256 tokenId, address newRecipient, uint256 newPercentage) external;
Parameters
| Name | Type | Description |
|---|---|---|
tokenId | uint256 | The token to override royalty for |
newRecipient | address | The new royalty payout address for the token id |
newPercentage | uint256 | The new royalty percentage in basis (out of 10,000) for the token id |
setStoryStatus
Function to enable or disable collector story inscriptions
Requires owner or admin
function setStoryStatus(bool status) external;
Parameters
| Name | Type | Description |
|---|---|---|
status | bool | The status to set for collector story inscriptions |
storyEnabled
Function to get the status of collector stories
function storyEnabled() external view returns (bool);
Returns
| Name | Type | Description |
|---|---|---|
<none> | bool | bool Status of collector stories being enabled |
Events
StoryStatusUpdate
Event for changing the story status
event StoryStatusUpdate(address indexed sender, bool indexed status);
BlockListRegistryUpdate
Event for changing the BlockList registry
event BlockListRegistryUpdate(
address indexed sender, address indexed prevBlockListRegistry, address indexed newBlockListRegistry
);
NftDelegationRegistryUpdate
Event for changing the NFT Delegation registry
event NftDelegationRegistryUpdate(
address indexed sender, address indexed prevNftDelegationRegistry, address indexed newNftDelegationRegistry
);