Type alias UpdateCandyMachineV2BuilderParams

UpdateCandyMachineV2BuilderParams: { candyMachine: Pick<CandyMachineV2, "address" | "walletAddress" | "collectionMintAddress">; authority?: Signer; newData?: CandyMachineData & { wallet: PublicKey; tokenMint: Option<PublicKey> }; newAuthority?: PublicKey; newCollection?: Option<PublicKey>; updateInstructionKey?: string; updateAuthorityInstructionKey?: string; setCollectionInstructionKey?: string; removeCollectionInstructionKey?: string }

Type declaration

  • candyMachine: Pick<CandyMachineV2, "address" | "walletAddress" | "collectionMintAddress">

    The Candy Machine to update. We only need a subset of the CandyMachine model to figure out the current values for the wallet and collection addresses.

  • Optional authority?: Signer

    The Signer authorized to update the candy machine.

    Default Value

    metaplex.identity()

  • Optional newData?: CandyMachineData & { wallet: PublicKey; tokenMint: Option<PublicKey> }

    The new Candy Machine data. This includes the wallet and token mint addresses which can both be updated.

    Default Value

    Defaults to not being updated.

  • Optional newAuthority?: PublicKey

    The new Candy Machine authority.

    Default Value

    Defaults to not being updated.

  • Optional newCollection?: Option<PublicKey>

    The mint address of the new Candy Machine collection. When null is provided, the collection is removed.

    Default Value

    Defaults to not being updated.

  • Optional updateInstructionKey?: string

    A key to distinguish the instruction that updates the data.

  • Optional updateAuthorityInstructionKey?: string

    A key to distinguish the instruction that updates the authority.

  • Optional setCollectionInstructionKey?: string

    A key to distinguish the instruction that sets the collection.

  • Optional removeCollectionInstructionKey?: string

    A key to distinguish the instruction that removes the collection.

Generated using TypeDoc