Type alias CandyMachineConfigLineSettings

CandyMachineConfigLineSettings: {
    type: "configLines";
    prefixName: string;
    nameLength: number;
    prefixUri: string;
    uriLength: number;
    isSequential: boolean;
}

A set of settings that aim to reduce the size of the Candy Machine whilst allowing items to be manually inserted for more flexibility.

This introduces name and uri prefixes that will be used for each item inserted.

Example

For instance, say all inserted items will have the following structure, where zeros represent the dynamic part of the name and URI:

Then we can use the following prefixes:

And the following lengths:

  • nameLength: 4 (assuming we'll never have more than 9999 items)
  • uriLength: 20

We could even go one step further and set the nameLength to zero by relying on template variables in the name prefix:

  • prefixName: "My NFT Project #$ID+1$"
  • nameLength: 0

Now, the program will automatically append the item number to the name of each minted NFT.

Type declaration

  • Readonly type: "configLines"

    Identifier used to distinguish the various types of item settings.

  • Readonly prefixName: string

    The prefix of the name of each item.

    The following template variables can be used:

    • $ID$: The index of the item (starting at 0).
    • $ID+1$: The number of the item (starting at 1).
  • Readonly nameLength: number

    The maximum length to use for the name of inserted items excluding the length of the prefix.

    For instance, if the name prefix is "My NFT Project #" and we want to add item numbers up to 9999, we would set this value to 4.

  • Readonly prefixUri: string

    The prefix of the URI of each item.

    The following template variables can be used:

    • $ID$: The index of the item (starting at 0).
    • $ID+1$: The number of the item (starting at 1).
  • Readonly uriLength: number

    The maximum length to use for the URI of inserted items excluding the length of the prefix.

    For instance, if the URI prefix is "https://arweave.net/" and we assume Arweave identifiers are 20 characters long max, we would set this value to 20.

  • Readonly isSequential: boolean

    Indicates whether to use a sequential index generator or not. When set to true, NFTs will be minted sequentially. When set to false, NFTs will be minted in a random order.

Settings

Member Visibility

Theme

Generated using TypeDoc