Holds the data for the CandyMachine Account and provides de/serialization functionality for that data

Hierarchy

  • CandyMachine

Implements

Properties

authority: PublicKey
collectionMint: PublicKey
features: number[]
itemsRedeemed: bignum
mintAuthority: PublicKey
tokenStandard: number

Methods

  • Returns a readable version of CandyMachine properties and can be used to convert to JSON and/or logging

    Returns {
        authority: string;
        collectionMint: string;
        data: CandyMachineData;
        features: number[];
        itemsRedeemed: number | {
            toNumber: (() => number);
        };
        mintAuthority: string;
        tokenStandard: number;
        version: string;
    }

    • authority: string
    • collectionMint: string
    • data: CandyMachineData
    • features: number[]
    • itemsRedeemed: number | {
          toNumber: (() => number);
      }
    • mintAuthority: string
    • tokenStandard: number
    • version: string
  • Retrieves the account info from the provided address and deserializes the CandyMachine from its data.

    Throws

    Error if no account info is found at the address or if deserialization fails

    Parameters

    • connection: Connection
    • address: PublicKey
    • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

    Returns Promise<CandyMachine>

  • Deserializes the CandyMachine from the data of the provided web3.AccountInfo.

    Returns

    a tuple of the account data and the offset up to which the buffer was read to obtain it.

    Parameters

    • accountInfo: AccountInfo<Buffer>
    • offset: number = 0

    Returns [CandyMachine, number]

  • Fetches the minimum balance needed to exempt an account holding CandyMachine data from rent

    Parameters

    • args: CandyMachineArgs

      need to be provided since the byte size for this account depends on them

    • connection: Connection

      used to retrieve the rent exemption information

    • Optional commitment: Commitment

    Returns Promise<number>

  • Provides a web3.Connection.getProgramAccounts config builder, to fetch accounts matching filters that can be specified via that builder.

    Parameters

    • programId: PublicKey = ...

      the program that owns the accounts we are filtering

    Returns GpaBuilder<CandyMachineArgs & {
        accountDiscriminator: number[];
    }>

Generated using TypeDoc