Class GpaBuilder<Account, Fields>

Builder for getProgramAccounts RPC requests.

Type Parameters

Account extends object = RpcAccount
Fields extends object = {}

Hierarchy

GpaBuilder

Index

Constructors

constructor

new GpaBuilder<Account, Fields>(context: Pick<Context, "rpc">, programId: PublicKey<string>, options?: {
    dataSlice?: RpcDataSlice;
    deserializeCallback?: GpaBuilderMapCallback<Account>;
    fields?: GpaBuilderFieldSerializers<Fields, Fields>;
    filters?: RpcDataFilter[];
    sortCallback?: GpaBuilderSortCallback;
}): GpaBuilder<Account, Fields>
Type Parameters
- Account extends object = RpcAccount
- Fields extends object = {}
Parameters
- context: Pick<Context, "rpc">
- programId: PublicKey<string>
- Optional options: {
      dataSlice?: RpcDataSlice;
      deserializeCallback?: GpaBuilderMapCallback<Account>;
      fields?: GpaBuilderFieldSerializers<Fields, Fields>;
      filters?: RpcDataFilter[];
      sortCallback?: GpaBuilderSortCallback;
  }
  - Optional Readonly dataSlice?: RpcDataSlice
  - Optional Readonly deserializeCallback?: GpaBuilderMapCallback<Account>
  - Optional Readonly fields?: GpaBuilderFieldSerializers<Fields, Fields>
  - Optional Readonly filters?: RpcDataFilter[]
  - Optional Readonly sortCallback?: GpaBuilderSortCallback
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:37

Properties

`Protected` `Readonly` context

context: Pick<Context, "rpc">

`Readonly` options

options: {
    dataSlice?: RpcDataSlice;
    deserializeCallback?: GpaBuilderMapCallback<Account>;
    fields?: GpaBuilderFieldSerializers<Fields, Fields>;
    filters?: RpcDataFilter[];
    sortCallback?: GpaBuilderSortCallback;
}

Type declaration

Optional Readonly dataSlice?: RpcDataSlice
Optional Readonly deserializeCallback?: GpaBuilderMapCallback<Account>
Optional Readonly fields?: GpaBuilderFieldSerializers<Fields, Fields>
Optional Readonly filters?: RpcDataFilter[]
Optional Readonly sortCallback?: GpaBuilderSortCallback

`Readonly` programId

programId: PublicKey<string>

Methods

addFilter

addFilter(...filters: RpcDataFilter[]): GpaBuilder<Account, Fields>
Parameters
- Rest ...filters: RpcDataFilter[]
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:76

deserializeUsing

deserializeUsing<T>(callback: GpaBuilderMapCallback<T>): GpaBuilder<T, Fields>
Type Parameters
- T extends object
Parameters
- callback: GpaBuilderMapCallback<T>
Returns GpaBuilder<T, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:72

get

get(options?: RpcGetProgramAccountsOptions): Promise<RpcAccount[]>
Parameters
- Optional options: RpcGetProgramAccountsOptions
Returns Promise<RpcAccount[]>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:81

getAndMap

getAndMap<T>(callback: GpaBuilderMapCallback<T>, options?: RpcGetProgramAccountsOptions): Promise<T[]>
Type Parameters
- T
Parameters
- callback: GpaBuilderMapCallback<T>
- Optional options: RpcGetProgramAccountsOptions
Returns Promise<T[]>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:82

getDataAsPublicKeys

getDataAsPublicKeys(options?: RpcGetProgramAccountsOptions): Promise<PublicKey<string>[]>
Parameters
- Optional options: RpcGetProgramAccountsOptions
Returns Promise<PublicKey<string>[]>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:85

getDeserialized

getDeserialized(options?: RpcGetProgramAccountsOptions): Promise<Account[]>
Parameters
- Optional options: RpcGetProgramAccountsOptions
Returns Promise<Account[]>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:83

`Protected` getField

getField<K>(fieldName: K, forcedOffset?: number): [number, Serializer<Fields[K], Fields[K]>]
Type Parameters
- K extends string | number | symbol
Parameters
- fieldName: K
- Optional forcedOffset: number
Returns [number, Serializer<Fields[K], Fields[K]>]
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:86

getPublicKeys

getPublicKeys(options?: RpcGetProgramAccountsOptions): Promise<PublicKey<string>[]>
Parameters
- Optional options: RpcGetProgramAccountsOptions
Returns Promise<PublicKey<string>[]>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:84

registerFields

registerFields<T>(fields: GpaBuilderFieldSerializers<T, T>): GpaBuilder<Account, T>
Type Parameters
- T extends object
Parameters
- fields: GpaBuilderFieldSerializers<T, T>
Returns GpaBuilder<Account, T>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:45

registerFieldsFromStruct

registerFieldsFromStruct<T>(structFields: StructToSerializerTuple<T, T>): GpaBuilder<Account, T>
Type Parameters
- T extends object
Parameters
- structFields: StructToSerializerTuple<T, T>
Returns GpaBuilder<Account, T>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:46

registerNestedFieldsFromStruct

registerNestedFieldsFromStruct<T>(parentPath: string, parentOffset: number, structFields: StructToSerializerTuple<T, T>): GpaBuilder<Account, Fields & { [ K in string | number | symbol as `${string}.${K & string}`]: T[K] }>
Registers nested struct fields with a parent path prefix. This allows filtering on nested fields using dot-notation paths.

Example
```
gpaBuilder
  .registerFieldsFromStruct([
    ['authority', publicKeySerializer],
    ['metadata', metadataSerializer],
  ])
  .registerNestedFieldsFromStruct('metadata', 32, [
    ['name', stringSerializer],
    ['creator', publicKeySerializer],
  ])
  .whereField('metadata.creator', somePublicKey)
```
Type Parameters
- T extends object
Parameters
- parentPath: string
  
  The dot-notation path prefix for the nested fields
- parentOffset: number
  
  The byte offset where the parent struct starts
- structFields: StructToSerializerTuple<T, T>
  
  The nested struct's field definitions
Returns GpaBuilder<Account, Fields & { [ K in string | number | symbol as `${string}.${K & string}`]: T[K] }>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:69

reset

reset(): GpaBuilder<Account, Fields>
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:44

slice

slice(offset: number, length: number): GpaBuilder<Account, Fields>
Parameters
- offset: number
- length: number
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:73

sliceField

sliceField(field: keyof Fields, offset?: number): GpaBuilder<Account, Fields>
Parameters
- field: keyof Fields
- Optional offset: number
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:74

sortUsing

sortUsing(callback: GpaBuilderSortCallback): GpaBuilder<Account, Fields>
Parameters
- callback: GpaBuilderSortCallback
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:80

where

where(offset: number, data: string | number | bigint | boolean | Uint8Array | PublicKey<string>): GpaBuilder<Account, Fields>
Parameters
- offset: number
- data: string | number | bigint | boolean | Uint8Array | PublicKey<string>
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:77

whereField

whereField<K>(field: K, data: Fields[K], offset?: number): GpaBuilder<Account, Fields>
Type Parameters
- K extends string | number | symbol
Parameters
- field: K
- data: Fields[K]
- Optional offset: number
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:78

whereSize

whereSize(dataSize: number): GpaBuilder<Account, Fields>
Parameters
- dataSize: number
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:79

withoutData

withoutData(): GpaBuilder<Account, Fields>
Returns GpaBuilder<Account, Fields>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@1.5.1/node_modules/@metaplex-foundation/umi/dist/types/GpaBuilder.d.ts:75

Class GpaBuilder<Account, Fields>

Type Parameters

Account extends object = RpcAccount

Fields extends object = {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Account extends object = RpcAccount

Fields extends object = {}

Parameters

context: Pick<Context, "rpc">

programId: PublicKey<string>

Optional options: { dataSlice?: RpcDataSlice; deserializeCallback?: GpaBuilderMapCallback<Account>; fields?: GpaBuilderFieldSerializers<Fields, Fields>; filters?: RpcDataFilter[]; sortCallback?: GpaBuilderSortCallback; }

Optional Readonly dataSlice?: RpcDataSlice

Optional Readonly deserializeCallback?: GpaBuilderMapCallback<Account>

Optional Readonly fields?: GpaBuilderFieldSerializers<Fields, Fields>

Optional Readonly filters?: RpcDataFilter[]

Optional Readonly sortCallback?: GpaBuilderSortCallback

Returns GpaBuilder<Account, Fields>

Properties

Protected Readonly context

Readonly options

Type declaration

Optional Readonly dataSlice?: RpcDataSlice

Optional Readonly deserializeCallback?: GpaBuilderMapCallback<Account>

Optional Readonly fields?: GpaBuilderFieldSerializers<Fields, Fields>

Optional Readonly filters?: RpcDataFilter[]

Optional Readonly sortCallback?: GpaBuilderSortCallback

Readonly programId

Methods

addFilter

Parameters

Rest ...filters: RpcDataFilter[]

Returns GpaBuilder<Account, Fields>

deserializeUsing

Type Parameters

T extends object

Parameters

callback: GpaBuilderMapCallback<T>

Returns GpaBuilder<T, Fields>

get

Parameters

Optional options: RpcGetProgramAccountsOptions

Returns Promise<RpcAccount[]>

getAndMap

Type Parameters

T

Parameters

callback: GpaBuilderMapCallback<T>

Optional options: RpcGetProgramAccountsOptions

Returns Promise<T[]>

getDataAsPublicKeys

Parameters

Optional options: RpcGetProgramAccountsOptions

Returns Promise<PublicKey<string>[]>

getDeserialized

Parameters

Optional options: RpcGetProgramAccountsOptions

Returns Promise<Account[]>

Protected getField

Type Parameters

K extends string | number | symbol

Parameters

fieldName: K

Optional forcedOffset: number

Returns [number, Serializer<Fields[K], Fields[K]>]

getPublicKeys

Parameters

Optional options: RpcGetProgramAccountsOptions

Returns Promise<PublicKey<string>[]>

registerFields

Type Parameters

T extends object

Parameters

fields: GpaBuilderFieldSerializers<T, T>

`Optional` options: {
dataSlice?: RpcDataSlice;
deserializeCallback?: GpaBuilderMapCallback<Account>;
fields?: GpaBuilderFieldSerializers<Fields, Fields>;
filters?: RpcDataFilter[];
sortCallback?: GpaBuilderSortCallback;
}

`Optional` `Readonly` dataSlice?: RpcDataSlice

`Optional` `Readonly` deserializeCallback?: GpaBuilderMapCallback<Account>

`Optional` `Readonly` fields?: GpaBuilderFieldSerializers<Fields, Fields>

`Optional` `Readonly` filters?: RpcDataFilter[]

`Optional` `Readonly` sortCallback?: GpaBuilderSortCallback

`Protected` `Readonly` context

`Readonly` options

`Optional` `Readonly` dataSlice?: RpcDataSlice

`Optional` `Readonly` deserializeCallback?: GpaBuilderMapCallback<Account>

`Optional` `Readonly` fields?: GpaBuilderFieldSerializers<Fields, Fields>

`Optional` `Readonly` filters?: RpcDataFilter[]

`Optional` `Readonly` sortCallback?: GpaBuilderSortCallback

`Readonly` programId

`Rest` ...filters: RpcDataFilter[]

`Optional` options: RpcGetProgramAccountsOptions

`Optional` options: RpcGetProgramAccountsOptions

`Optional` options: RpcGetProgramAccountsOptions

`Optional` options: RpcGetProgramAccountsOptions

`Protected` getField

`Optional` forcedOffset: number

`Optional` options: RpcGetProgramAccountsOptions

`Optional` offset: number

`Optional` offset: number