Type alias MintCandyMachineV2BuilderParams

Type declaration

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

  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?: undefined | 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?: undefined | PublicKey

  The owner of the minted NFT.

  Default Value

  metaplex.identity().publicKey

• Optional newToken?: undefined | 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?: undefined | 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?: undefined | 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.

• Optional createMintAccountInstructionKey?: undefined | string

  A key to distinguish the instruction that creates the mint account of the NFT.

• Optional initializeMintInstructionKey?: undefined | string

  A key to distinguish the instruction that initializes the mint account of the NFT.

• Optional createAssociatedTokenAccountInstructionKey?: undefined | string

  A key to distinguish the instruction that creates the associated token account of the NFT.

• Optional createTokenAccountInstructionKey?: undefined | string

  A key to distinguish the instruction that creates the token account of the NFT.

• Optional initializeTokenInstructionKey?: undefined | string

  A key to distinguish the instruction that initializes the token account of the NFT.

• Optional mintTokensInstructionKey?: undefined | string

  A key to distinguish the instruction that mints the one token.

• Optional mintNftInstructionKey?: undefined | string

  A key to distinguish the instruction that mints the NFT.

• Optional setCollectionInstructionKey?: undefined | string

  A key to distinguish the instruction that sets the collection on the minted NFT.