Class CandyMachinesV2Client

You may use the builders() client to access the underlying Transaction Builders of this module.

const buildersClient = metaplex.candyMachinesV2().builders();

Creates a brand new Candy Machine.

const { candyMachine } = await metaplex
  .candyMachinesV2()
  .create({
    sellerFeeBasisPoints: 500, // 5% royalties
    price: sol(1.3), // 1.3 SOL
    itemsAvailable: toBigNumber(1000), // 1000 items available
  };

Deletes an existing Candy Machine.

await metaplex.candyMachinesV2().delete({ candyMachine });

Find all Candy Machines matching by a given publicKey or a given type.

The following two types are supported.

authority: Find Candy Machines whose authority is the given publicKey.

const someAuthority = new PublicKey('...');
const candyMachines = await metaplex
  .candyMachinesV2()
  .findAllBy({ type: 'authority', someAuthority });

wallet: Find Candy Machines whose wallet address is the given publicKey.

const someWallet = new PublicKey('...');
const candyMachines = await metaplex
  .candyMachinesV2()
  .findAllBy({ type: 'wallet', someWallet });

Find an existing Candy Machine by its address.

const candyMachine = await metaplex.candyMachinesV2().findbyAddress({ address });

Find all minted NFTs from a given Candy Machine address.

const nfts = await metaplex
  .candyMachinesV2()
  .findMintedNfts({ candyMachine };

Insert items into an existing Candy Machine.

await metaplex
  .candyMachines()
  .insertItems({
    candyMachine,
    items: [
      { name: 'My NFT #1', uri: 'https://example.com/nft1' },
      { name: 'My NFT #2', uri: 'https://example.com/nft2' },
      { name: 'My NFT #3', uri: 'https://example.com/nft3' },
    ],
  };

Mint an NFT from an existing Candy Machine.

const { nft } = await metaplex
  .candyMachinesV2()
  .mint({ candyMachine };

Helper method that refetches a given Candy Machine.

const candyMachine = await metaplex.candyMachinesV2().refresh(candyMachine);

Updates an existing Candy Machine.

await metaplex
  .candyMachinesV2()
  .update({
    candyMachine,
    price: sol(2), // Updates the price only.
  };