Signature-based Minting

Functionality available for contracts that implement the IERC721 and ISignatureMintERC721 interfaces.

Allows you to utilize signature-based minting of NFTs.

Generate

Generate a signature that a wallet address can use to mint the specified number of NFTs.

This is typically an admin operation, where the owner of the contract generates a signature that allows another wallet to mint tokens.

NFTMetadata meta = new NFTMetadata()
{
    name = "Unity NFT",
    description = "Minted From Unity",
    image = "ipfs://QmbpciV7R5SSPb6aT9kEBAxoYoXBUsStJkMpxzymV4ZcVc",
};
var receiverAddress = "{{wallet_address}}";
var payload = new ERC721MintPayload(receiverAddress, meta);
var signedPayload = await contract.ERC721.signature.Generate(payload);

Configuration

The information you provide to the generate method outlines what the signature can be used for.

The to, and metadata fields are required, while the rest are optional.

receiverAddress (required)

The wallet address that can use this signature to mint tokens.

This is to prevent another wallet from intercepting the signature and using it to mint tokens for themselves.

Must be a string.

metadata (required)

The metadata of the NFT to mint.

Must be an NFTMetadata struct containing metadata that conforms to the metadata standards.

The metadata is uploaded and pinned to IPFS before the NFT(s) are minted.

Mint

Mint tokens from a previously generated signature (see generate).

NFTMetadata meta = new NFTMetadata()
{
    name = "Unity NFT",
    description = "Minted From Unity",
    image = "ipfs://QmbpciV7R5SSPb6aT9kEBAxoYoXBUsStJkMpxzymV4ZcVc",
};
var receiverAddress = "{{wallet_address}}";
var payload = new ERC721MintPayload(receiverAddress, meta);
var signedPayload = await contract.ERC721.signature.Generate(payload);

var data = await contract.ERC721.signature.Mint(signedPayload);

Configuration

signature (required)

The signature created by the generate function.

Verify

Verify that a payload is correctly signed.

This allows you to provide a payload, and prove that it was valid and was generated by a wallet with permission to generate signatures.

If a payload is not valid, the mint function will fail, but you can use this function to verify that the payload is valid before attempting to mint the tokens if you want to show a more user-friendly error message.

Configuration

payload (required)

The payload to verify.

Return Value

Returns true if the payload is valid, false otherwise.

NFTMetadata meta = new NFTMetadata()
{
    name = "Unity NFT",
    description = "Minted From Unity",
    image = "ipfs://QmbpciV7R5SSPb6aT9kEBAxoYoXBUsStJkMpxzymV4ZcVc",
};
var receiverAddress = "{{wallet_address}}";
var payload = new ERC721MintPayload(receiverAddress, meta);
var signedPayload = await contract.ERC721.signature.Generate(payload);

var data = await contract.ERC721.signature.Verify(signedPayload);