Class CandyMachine

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

Hierarchy

CandyMachine

Implements

CandyMachineArgs

Index

Properties

authority collectionMint data features itemsRedeemed mintAuthority tokenStandard version

Methods

pretty serialize byteSize deserialize fromAccountAddress fromAccountInfo fromArgs getMinimumBalanceForRentExemption gpaBuilder

Properties

`Readonly` authority

authority: PublicKey

`Readonly` collectionMint

collectionMint: PublicKey

`Readonly` data

data: CandyMachineData

`Readonly` features

features: number[]

`Readonly` itemsRedeemed

itemsRedeemed: bignum

`Readonly` mintAuthority

mintAuthority: PublicKey

`Readonly` tokenStandard

tokenStandard: number

`Readonly` version

version: AccountVersion

Methods

pretty

pretty(): {
    authority: string;
    collectionMint: string;
    data: CandyMachineData;
    features: number[];
    itemsRedeemed: number | {
        toNumber: (() => number);
    };
    mintAuthority: string;
    tokenStandard: number;
    version: string;
}
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
- Defined in src/generated/accounts/CandyMachine.ts:161

serialize

serialize(): [Buffer, number]
Serializes the CandyMachine into a Buffer.

Returns
a tuple of the created Buffer and the offset up to which the buffer was written to store it.

Returns [Buffer, number]
- Defined in src/generated/accounts/CandyMachine.ts:119

`Static` byteSize

byteSize(args: CandyMachineArgs): number
Returns the byteSize of a Buffer holding the serialized data of CandyMachine for the provided args.
Parameters
- args: CandyMachineArgs
  
  need to be provided since the byte size for this account depends on them
Returns number
- Defined in src/generated/accounts/CandyMachine.ts:133

`Static` deserialize

deserialize(buf: Buffer, offset?: number): [CandyMachine, number]
Deserializes the CandyMachine from the provided data Buffer.

Returns
a tuple of the account data and the offset up to which the buffer was read to obtain it.
Parameters
- buf: Buffer
- offset: number = 0
Returns [CandyMachine, number]
- Defined in src/generated/accounts/CandyMachine.ts:111

`Static` fromAccountAddress

fromAccountAddress(connection: Connection, address: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<CandyMachine>
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>
- Defined in src/generated/accounts/CandyMachine.ts:83

`Static` fromAccountInfo

fromAccountInfo(accountInfo: AccountInfo<Buffer>, offset?: number): [CandyMachine, number]
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]
- Defined in src/generated/accounts/CandyMachine.ts:70

`Static` fromArgs

fromArgs(args: CandyMachineArgs): CandyMachine
Creates a CandyMachine instance from the provided args.
Parameters
- args: CandyMachineArgs
Returns CandyMachine
- Defined in src/generated/accounts/CandyMachine.ts:53

`Static` getMinimumBalanceForRentExemption

getMinimumBalanceForRentExemption(args: CandyMachineArgs, connection: Connection, commitment?: Commitment): Promise<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>
- Defined in src/generated/accounts/CandyMachine.ts:149

`Static` gpaBuilder

gpaBuilder(programId?: PublicKey): GpaBuilder<CandyMachineArgs & {
accountDiscriminator: 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[];
}>
- Defined in src/generated/accounts/CandyMachine.ts:101

Class CandyMachine

Hierarchy

Implements

Index

Properties

Methods

Properties

Readonly authority

Readonly collectionMint

Readonly data

Readonly features

Readonly itemsRedeemed

Readonly mintAuthority

Readonly tokenStandard

Readonly version

Methods

pretty

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

serialize

Returns

Returns [Buffer, number]

Static byteSize

Parameters

args: CandyMachineArgs

Returns number

Static deserialize

Returns

Parameters

buf: Buffer

offset: number = 0

Returns [CandyMachine, number]

Static fromAccountAddress

Throws

Parameters

connection: Connection

address: PublicKey

Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

Returns Promise<CandyMachine>

Static fromAccountInfo

Returns

Parameters

accountInfo: AccountInfo<Buffer>

offset: number = 0

Returns [CandyMachine, number]

Static fromArgs

Parameters

args: CandyMachineArgs

Returns CandyMachine

Static getMinimumBalanceForRentExemption

Parameters

args: CandyMachineArgs

connection: Connection

Optional commitment: Commitment

Returns Promise<number>

Static gpaBuilder

Parameters

programId: PublicKey = ...

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

Settings

Member Visibility

Theme

`Readonly` authority

`Readonly` collectionMint

`Readonly` data

`Readonly` features

`Readonly` itemsRedeemed

`Readonly` mintAuthority

`Readonly` tokenStandard

`Readonly` version

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

itemsRedeemed: number | {
toNumber: (() => number);
}

`Static` byteSize

`Static` deserialize

`Static` fromAccountAddress

`Optional` commitmentOrConfig: Commitment | GetAccountInfoConfig

`Static` fromAccountInfo

`Static` fromArgs

`Static` getMinimumBalanceForRentExemption

`Optional` commitment: Commitment

`Static` gpaBuilder

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