Class GpaBuilder

Hierarchy

GpaBuilder

Index

Properties

metaplex programId config sortCallback?

Constructors

Methods

mergeConfig slice withoutData addFilter where whereSize sortUsing get getAndMap getPublicKeys getDataAsPublicKeys getMultipleAccounts

Properties

`Protected` `Readonly` metaplex

metaplex: Metaplex

The connection instance to use when fetching accounts.

`Protected` `Readonly` programId

programId: PublicKey

The public key of the program we want to retrieve accounts from.

`Protected` config

config: GetProgramAccountsConfig = {}

The configs to use when fetching program accounts.

`Protected` `Optional` sortCallback

sortCallback?: GpaSortCallback

When provided, reorder accounts using this callback.

Constructors

constructor

new GpaBuilder(metaplex: Metaplex, programId: PublicKey): GpaBuilder
Parameters
- metaplex: Metaplex
- programId: PublicKey
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:31

Methods

mergeConfig

mergeConfig(config: GetProgramAccountsConfig): GpaBuilder
Parameters
- config: GetProgramAccountsConfig
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:36

slice

slice(offset: number, length: number): GpaBuilder
Parameters
- offset: number
- length: number
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:42

withoutData

withoutData(): GpaBuilder
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:48

addFilter

addFilter(...filters: GetProgramAccountsFilter[]): GpaBuilder
Parameters
- Rest ...filters: GetProgramAccountsFilter[]
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:52

where

where(offset: number, bytes: string | number | PublicKey | Buffer | BN): GpaBuilder
Parameters
- offset: number
- bytes: string | number | PublicKey | Buffer | BN
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:62

whereSize

whereSize(dataSize: number): GpaBuilder
Parameters
- dataSize: number
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:76

sortUsing

sortUsing(callback: GpaSortCallback): GpaBuilder
Parameters
- callback: GpaSortCallback
Returns GpaBuilder
- Defined in packages/js/src/utils/GpaBuilder.ts:80

get

get(): Promise<UnparsedAccount[]>
Returns Promise<UnparsedAccount[]>
- Defined in packages/js/src/utils/GpaBuilder.ts:86

getAndMap

getAndMap<T>(callback: ((account: UnparsedAccount) => T)): Promise<T[]>
Type Parameters
- T
Parameters
- callback: ((account: UnparsedAccount) => T)
  - - (account: UnparsedAccount): T
    - Parameters
      
      account: UnparsedAccount
      
      Returns T
Returns Promise<T[]>
- Defined in packages/js/src/utils/GpaBuilder.ts:98

getPublicKeys

getPublicKeys(): Promise<PublicKey[]>
Returns Promise<PublicKey[]>
- Defined in packages/js/src/utils/GpaBuilder.ts:102

getDataAsPublicKeys

getDataAsPublicKeys(): Promise<PublicKey[]>
Returns Promise<PublicKey[]>
- Defined in packages/js/src/utils/GpaBuilder.ts:106

getMultipleAccounts

getMultipleAccounts(callback?: ((account: UnparsedAccount) => PublicKey), options?: GmaBuilderOptions): Promise<GmaBuilder>
Parameters
- Optional callback: ((account: UnparsedAccount) => PublicKey)
  - - (account: UnparsedAccount): PublicKey
    - Parameters
      
      account: UnparsedAccount
      
      Returns PublicKey
- Optional options: GmaBuilderOptions
Returns Promise<GmaBuilder>
- Defined in packages/js/src/utils/GpaBuilder.ts:111

Generated using TypeDoc