Type alias InsertCandyMachineItemsBuilderParams

InsertCandyMachineItemsBuilderParams: {
    candyMachine: Pick<CandyMachine<DefaultCandyGuardSettings>, "address" | "itemsAvailable" | "itemSettings" | "itemsLoaded">;
    items: Pick<CandyMachineItem, "name" | "uri">[];
    authority?: undefined | Signer;
    index?: undefined | number;
    instructionKey?: undefined | string;
}

Type declaration

  • candyMachine: Pick<CandyMachine<DefaultCandyGuardSettings>, "address" | "itemsAvailable" | "itemSettings" | "itemsLoaded">

    The Candy Machine to insert items into.

    We only need a subset of the CandyMachine model. We need its address, its items settings and the number of items loaded and to be loaded so we can check if the operation is valid.

  • items: Pick<CandyMachineItem, "name" | "uri">[]

    The items to insert into the candy machine.

    This only requires the name and the uri to insert for each item.

    Important: If your config line settings use prefixes, you must only provide the part of the name or URI that comes after theses prefixes.

    For example, if your config line settings use the following prefixes:

    • prefixName: My NFT #
    • prefixUri: https://example.com/nfts/

    Then, an item to insert could be: { name: '1', uri: '1.json' }.

    See

    CandyMachineItem

  • Optional authority?: undefined | Signer

    The Signer authorized to update the candy machine.

    Default Value

    metaplex.identity()

  • Optional index?: undefined | number

    The index we should use to insert the new items. This refers to the index of the first item to insert and the others will follow after it.

    By defaults, this uses the itemsLoaded property so items are simply appended to the current items.

    Default Value

    candyMachine.itemsLoaded

  • Optional instructionKey?: undefined | string

Generated using TypeDoc