Type alias MintCandyMachineV2Input

MintCandyMachineV2Input: {
    candyMachine: Pick<CandyMachineV2, "address" | "walletAddress" | "authorityAddress" | "tokenMintAddress" | "itemsRemaining" | "itemsAvailable" | "itemsMinted" | "whitelistMintSettings" | "goLiveDate" | "endSettings">;
    newMint?: Signer;
    newOwner?: PublicKey;
    newToken?: Signer;
    payerToken?: PublicKey;
    whitelistToken?: PublicKey;
}

Type declaration

  • candyMachine: Pick<CandyMachineV2, "address" | "walletAddress" | "authorityAddress" | "tokenMintAddress" | "itemsRemaining" | "itemsAvailable" | "itemsMinted" | "whitelistMintSettings" | "goLiveDate" | "endSettings">

    The Candy Machine to mint from. We only need a subset of the CandyMachine model but we need enough information regarding its settings to know how to mint from it.

    This includes, its wallet address, its item statistics, it live date, its whitelist settings, etc.

  • Optional newMint?: Signer

    The mint account to create as a Signer. This expects a brand new Keypair with no associated account.

    Default Value

    Keypair.generate()

  • Optional newOwner?: PublicKey

    The owner of the minted NFT.

    Default Value

    metaplex.identity().publicKey

  • Optional newToken?: Signer

    The new token account to create as a Signer.

    This property would typically be ignored as, by default, it will create a associated token account from the newOwner and newMint properties.

    When provided, the newOwner property will be ignored.

    Default Value

    associated token address of newOwner and newMint.

  • Optional payerToken?: PublicKey

    The token account that should pay for the minted NFT.

    This is only relevant when the Candy Machine uses a mint treasury (i.e. payments are made using SPL tokens and not SOL).

    Default Value

    associated token address of payer and candyMachine.tokenMintAddress.

  • Optional whitelistToken?: PublicKey

    The token account that contains whitelist tokens.

    This is only relevant when the Candy Machine uses whitelist settings.

    Default Value

    associated token address of payer and candyMachine.whitelistMintSettings.mint.

Generated using TypeDoc