Class FreezeEscrow

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

Hierarchy

FreezeEscrow

Implements

FreezeEscrowArgs

Index

Properties

authority candyGuard candyMachine destination firstMintTime freezePeriod frozenCount

Methods

pretty serialize byteSize deserialize fromAccountAddress fromAccountInfo fromArgs getMinimumBalanceForRentExemption gpaBuilder

Properties

`Readonly` authority

authority: PublicKey

`Readonly` candyGuard

candyGuard: PublicKey

`Readonly` candyMachine

candyMachine: PublicKey

`Readonly` destination

destination: PublicKey

`Readonly` firstMintTime

firstMintTime: COption<bignum>

`Readonly` freezePeriod

freezePeriod: bignum

`Readonly` frozenCount

frozenCount: bignum

Methods

pretty

pretty(): {
    authority: string;
    candyGuard: string;
    candyMachine: string;
    destination: string;
    firstMintTime: COption<bignum>;
    freezePeriod: number | {
        toNumber: (() => number);
    };
    frozenCount: number | {
        toNumber: (() => number);
    };
}
Returns a readable version of FreezeEscrow properties and can be used to convert to JSON and/or logging

Returns {
    authority: string;
    candyGuard: string;
    candyMachine: string;
    destination: string;
    firstMintTime: COption<bignum>;
    freezePeriod: number | {
        toNumber: (() => number);
    };
    frozenCount: number | {
        toNumber: (() => number);
    };
}
- authority: string
- candyGuard: string
- candyMachine: string
- destination: string
- firstMintTime: COption<bignum>
- freezePeriod: number | {
  toNumber: (() => number);
  }
- frozenCount: number | {
  toNumber: (() => number);
  }
- Defined in src/generated/accounts/FreezeEscrow.ts:156

serialize

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

`Static` byteSize

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

`Static` deserialize

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

`Static` fromAccountAddress

fromAccountAddress(connection: Connection, address: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<FreezeEscrow>
Retrieves the account info from the provided address and deserializes the FreezeEscrow 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<FreezeEscrow>
- Defined in src/generated/accounts/FreezeEscrow.ts:78

`Static` fromAccountInfo

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

`Static` fromArgs

fromArgs(args: FreezeEscrowArgs): FreezeEscrow
Creates a FreezeEscrow instance from the provided args.
Parameters
- args: FreezeEscrowArgs
Returns FreezeEscrow
- Defined in src/generated/accounts/FreezeEscrow.ts:49

`Static` getMinimumBalanceForRentExemption

getMinimumBalanceForRentExemption(args: FreezeEscrowArgs, connection: Connection, commitment?: Commitment): Promise<number>
Fetches the minimum balance needed to exempt an account holding FreezeEscrow data from rent
Parameters
- args: FreezeEscrowArgs
  
  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/FreezeEscrow.ts:144

`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/FreezeEscrow.ts:96

Class FreezeEscrow

Hierarchy

Implements

Index

Properties

Methods

Properties

Readonly authority

Readonly candyGuard

Readonly candyMachine

Readonly destination

Readonly firstMintTime

Readonly freezePeriod

Readonly frozenCount

Methods

pretty

Returns { authority: string; candyGuard: string; candyMachine: string; destination: string; firstMintTime: COption<bignum>; freezePeriod: number | { toNumber: (() => number); }; frozenCount: number | { toNumber: (() => number); }; }

authority: string

candyGuard: string

candyMachine: string

destination: string

firstMintTime: COption<bignum>

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

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

serialize

Returns

Returns [Buffer, number]

Static byteSize

Parameters

args: FreezeEscrowArgs

Returns number

Static deserialize

Returns

Parameters

buf: Buffer

offset: number = 0

Returns [FreezeEscrow, number]

Static fromAccountAddress

Throws

Parameters

connection: Connection

address: PublicKey

Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

Returns Promise<FreezeEscrow>

Static fromAccountInfo

Returns

Parameters

accountInfo: AccountInfo<Buffer>

offset: number = 0

Returns [FreezeEscrow, number]

Static fromArgs

Parameters

args: FreezeEscrowArgs

Returns FreezeEscrow

Static getMinimumBalanceForRentExemption

Parameters

args: FreezeEscrowArgs

connection: Connection

Optional commitment: Commitment

Returns Promise<number>

Static gpaBuilder

Parameters

programId: PublicKey = ...

Returns GpaBuilder<Object>

Settings

Member Visibility

Theme

`Readonly` authority

`Readonly` candyGuard

`Readonly` candyMachine

`Readonly` destination

`Readonly` firstMintTime

`Readonly` freezePeriod

`Readonly` frozenCount

Returns {
authority: string;
candyGuard: string;
candyMachine: string;
destination: string;
firstMintTime: COption<bignum>;
freezePeriod: number | {
toNumber: (() => number);
};
frozenCount: number | {
toNumber: (() => number);
};
}

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

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

`Static` byteSize

`Static` deserialize

`Static` fromAccountAddress

`Optional` commitmentOrConfig: Commitment | GetAccountInfoConfig

`Static` fromAccountInfo

`Static` fromArgs

`Static` getMinimumBalanceForRentExemption

`Optional` commitment: Commitment

`Static` gpaBuilder