IMintNFT

Git Source

Functions

initialize

Initialize the mint nft.

function initialize(
    uint256 characterId_,
    uint256 noteId_,
    address web3Entry_,
    string calldata name_,
    string calldata symbol_
) external;

Parameters

NameTypeDescription
characterId_uint256The character ID of the note to initialize.
noteId_uint256The note ID to initialize.
web3Entry_addressThe address of web3Entry contract.
name_stringThe name to set for this NFT.
symbol_stringThe symbol to set for this NFT.

mint

Mints a note NFT to the specified address. This can only be called by web3Entry, and is called upon note.

function mint(address to) external returns (uint256);

Parameters

NameTypeDescription
toaddressThe address to mint the NFT to.

Returns

NameTypeDescription
<none>uint256uint256 The minted token ID.

setTokenRoyalty

Changes the royalty percentage of specific token ID for secondary sales. Can only be called by character owner of note.

function setTokenRoyalty(uint256 tokenId, address recipient, uint96 fraction) external;

Parameters

NameTypeDescription
tokenIduint256The token ID to set.
recipientaddressThe receive address.
fractionuint96The royalty percentage measured in basis points. Each basis point represents 0.01%.

setDefaultRoyalty

Changes the default royalty percentage for secondary sales. Can only be called by character owner of note.

function setDefaultRoyalty(address recipient, uint96 fraction) external;

Parameters

NameTypeDescription
recipientaddressThe receive address.
fractionuint96The royalty percentage measured in basis points. Each basis point represents 0.01%.

deleteDefaultRoyalty

Deletes the default royalty percentage. Can only be called by character owner of note.

function deleteDefaultRoyalty() external;

originalReceiver

Returns the original receiver of specified NFT.

function originalReceiver(uint256 tokenId) external view returns (address);

Returns

NameTypeDescription
<none>addressThe address of original receiver.

getSourceNotePointer

Returns the source note pointer mapped to this note NFT.

function getSourceNotePointer() external view returns (uint256 characterId, uint256 noteId);

Returns

NameTypeDescription
characterIduint256The character ID.
noteIduint256The note ID.