IColleCollectionUpgradeable

This interface includes the necessary methods for managing ColleCollection NFTs.

MetadataUpdate

event MetadataUpdate(uint256 _tokenId)

SecondaryMetadataIPFS

event SecondaryMetadataIPFS(string _ipfsHash, uint256 _id)

Emitted when the off-chain metadata for a token has been updated.

RecallReason

event RecallReason(uint256 _id, address _from, address _to, string _ipfsHash)

Emitted when a token is recalled back to Colle. A reason must be provided.

mint

function mint(string _uri, address _receiver) external

Mints a new NFT.

Parameters

Name	Type	Description
_uri	string	The URI of the NFT's metadata.
_receiver	address	The address to receive the minted NFT.

updateSaleMetadata

function updateSaleMetadata(uint256 _tokenId, string _uri) external

Updates the sale metadata of a specific NFT.

Parameters

Name	Type	Description
_tokenId	uint256	The ID of the NFT to update.
_uri	string	The new URI of the sale metadata.

updateTokenURI

function updateTokenURI(uint256 _tokenId, string _uri) external

Updates the token metadata URI

This function can only be called by a Colle.

Parameters

Name	Type	Description
_tokenId	uint256	The ID of the token to update.
_uri	string	The new URI for the token metadata.

getSaleMetadata

function getSaleMetadata(uint256 _tokenId) external view returns (string)

Gets the sale metadata of a specific NFT.

Parameters

Name	Type	Description
_tokenId	uint256	The ID of the NFT to query.

Return Values

Name	Type	Description
[0]	string	The URI of the sale metadata.

isSaleMetadataSet

function isSaleMetadataSet(uint256 _tokenId) external view returns (bool)

Checks if the sale metadata of a specific NFT is set.

Parameters

Name	Type	Description
_tokenId	uint256	The ID of the NFT to query.

Return Values

Name	Type	Description
[0]	bool	True if the sale metadata is set, false otherwise.

permitApprove

function permitApprove(address _to, uint256 _tokenId, struct Signature _signature) external

Allows a signer to approve a transfer on their behalf using a signature.

Parameters

Name	Type	Description
_to	address	The address to approve.
_tokenId	uint256	The ID of the token to approve.
_signature	struct Signature	The signature from the approving address, the 'from', including deadline

permitSetApprovalForAll

function permitSetApprovalForAll(address _operator, bool _approve, struct Signature _signature) external

Approves an address to transfer any tokens owned by the sender.

Parameters

Name	Type	Description
_operator	address	The address to approve.
_approve	bool	Whether to approve or revoke approval
_signature	struct Signature	The signature, deadline and signer from the owner of the token.

permitSafeTransfer

function permitSafeTransfer(address _to, uint256 _tokenId, struct Signature _signature) external

Allows a signer to transfer a NFT on their behalf using a signature.

Parameters

Name	Type	Description
_to	address	The address to receive the token.
_tokenId	uint256	The ID of the token to transfer.
_signature	struct Signature	The signature, deadline and signer from the owner of the token.

recall

function recall(uint256 _tokenId, address _to, string _ipfsReason) external

Allows relayer to forceably transfer a token from one address to another.

This function can only be called by a relayer, and a reason must be provided. This function is used to recall tokens if the NFT's association with it's physical counterpart is lost, and a user proves they are in possessio of the physical good.

Parameters

Name	Type	Description
_tokenId	uint256	The ID of the token to transfer.
_to	address	The address to receive the token.
_ipfsReason	string	The IPFS hash which leads to the reason for the recall.