Class TreeConfig

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

Hierarchy

TreeConfig

Implements

TreeConfigArgs

Index

Properties

`Readonly` numMinted

numMinted: bignum

`Readonly` totalMintCapacity

totalMintCapacity: bignum

`Readonly` treeCreator

treeCreator: PublicKey

`Readonly` treeDelegate

treeDelegate: PublicKey

Accessors

`Static` byteSize

get byteSize(): number
Returns the byteSize of a Buffer holding the serialized data of TreeConfig

Returns number
- Defined in src/generated/accounts/TreeConfig.ts:117

Methods

pretty

pretty(): {
    numMinted: number | {
        toNumber: (() => number);
    };
    totalMintCapacity: number | {
        toNumber: (() => number);
    };
    treeCreator: string;
    treeDelegate: string;
}
Returns a readable version of TreeConfig properties and can be used to convert to JSON and/or logging

Returns {
    numMinted: number | {
        toNumber: (() => number);
    };
    totalMintCapacity: number | {
        toNumber: (() => number);
    };
    treeCreator: string;
    treeDelegate: string;
}
- numMinted: number | {
  toNumber: (() => number);
  }
- totalMintCapacity: number | {
  toNumber: (() => number);
  }
- treeCreator: string
- treeDelegate: string
- Defined in src/generated/accounts/TreeConfig.ts:149

serialize

serialize(): [Buffer, number]
Serializes the TreeConfig 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/TreeConfig.ts:106

`Static` deserialize

deserialize(buf: Buffer, offset?: number): [TreeConfig, number]
Deserializes the TreeConfig 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 [TreeConfig, number]
- Defined in src/generated/accounts/TreeConfig.ts:98

`Static` fromAccountAddress

fromAccountAddress(connection: Connection, address: PublicKey): Promise<TreeConfig>
Retrieves the account info from the provided address and deserializes the TreeConfig from its data.

Throws
Error if no account info is found at the address or if deserialization fails
Parameters
- connection: Connection
- address: PublicKey
Returns Promise<TreeConfig>
- Defined in src/generated/accounts/TreeConfig.ts:69

`Static` fromAccountInfo

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

`Static` fromArgs

fromArgs(args: TreeConfigArgs): TreeConfig
Creates a TreeConfig instance from the provided args.
Parameters
- args: TreeConfigArgs
Returns TreeConfig
- Defined in src/generated/accounts/TreeConfig.ts:43

`Static` getMinimumBalanceForRentExemption

getMinimumBalanceForRentExemption(connection: Connection, commitment?: Commitment): Promise<number>
Fetches the minimum balance needed to exempt an account holding TreeConfig data from rent
Parameters
- connection: Connection
  
  used to retrieve the rent exemption information
- Optional commitment: Commitment
Returns Promise<number>
- Defined in src/generated/accounts/TreeConfig.ts:127

`Static` gpaBuilder

gpaBuilder(programId?: PublicKey): GpaBuilder<Object>
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<Object>
- Defined in src/generated/accounts/TreeConfig.ts:86

`Static` hasCorrectByteSize

hasCorrectByteSize(buf: Buffer, offset?: number): boolean
Determines if the provided Buffer has the correct byte size to hold TreeConfig data.
Parameters
- buf: Buffer
- offset: number = 0
Returns boolean
- Defined in src/generated/accounts/TreeConfig.ts:141

Class TreeConfig

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

Readonly numMinted

Readonly totalMintCapacity

Readonly treeCreator

Readonly treeDelegate

Accessors

Static byteSize

Returns number

Methods

pretty

Returns { numMinted: number | { toNumber: (() => number); }; totalMintCapacity: number | { toNumber: (() => number); }; treeCreator: string; treeDelegate: string; }

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

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

treeCreator: string

treeDelegate: string

serialize

Returns

Returns [Buffer, number]

Static deserialize

Returns

Parameters

buf: Buffer

offset: number = 0

Returns [TreeConfig, number]

Static fromAccountAddress

Throws

Parameters

connection: Connection

address: PublicKey

Returns Promise<TreeConfig>

Static fromAccountInfo

Returns

Parameters

accountInfo: AccountInfo<Buffer>

offset: number = 0

Returns [TreeConfig, number]

Static fromArgs

Parameters

args: TreeConfigArgs

Returns TreeConfig

Static getMinimumBalanceForRentExemption

Parameters

connection: Connection

Optional commitment: Commitment

Returns Promise<number>

Static gpaBuilder

Parameters

programId: PublicKey = ...

Returns GpaBuilder<Object>

Static hasCorrectByteSize

Parameters

buf: Buffer

offset: number = 0

Returns boolean

Settings

Member Visibility

Theme

`Readonly` numMinted

`Readonly` totalMintCapacity

`Readonly` treeCreator

`Readonly` treeDelegate

`Static` byteSize

Returns {
numMinted: number | {
toNumber: (() => number);
};
totalMintCapacity: number | {
toNumber: (() => number);
};
treeCreator: string;
treeDelegate: string;
}

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

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

`Static` deserialize

`Static` fromAccountAddress

`Static` fromAccountInfo

`Static` fromArgs

`Static` getMinimumBalanceForRentExemption

`Optional` commitment: Commitment

`Static` gpaBuilder

`Static` hasCorrectByteSize