Class GpaBuilder<Account, Fields>

constructor

• new GpaBuilder<Account extends object = RpcAccount, Fields extends object = {}>(
      context: Pick<Context, "rpc">,
      programId: PublicKey,
      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
  • options: {
        dataSlice?: RpcDataSlice;
        deserializeCallback?: GpaBuilderMapCallback<Account>;
        fields?: GpaBuilderFieldSerializers<Fields, Fields>;
        filters?: RpcDataFilter[];
        sortCallback?: GpaBuilderSortCallback;
    } = {}

  Returns GpaBuilder<Account, Fields>

Readonlyoptions

ReadonlyprogramId

addFilter

• addFilter(...filters: RpcDataFilter[]): GpaBuilder<Account, Fields>

  Parameters

  • ...filters: RpcDataFilter[]

  Returns GpaBuilder<Account, Fields>

deserializeUsing

• deserializeUsing<T extends object>(
      callback: GpaBuilderMapCallback<T>,
  ): GpaBuilder<T, Fields>

  Type Parameters

  • T extends object

  Parameters

  • callback: GpaBuilderMapCallback<T>

  Returns GpaBuilder<T, Fields>

get

• get(options?: RpcGetProgramAccountsOptions): Promise<RpcAccount[]>

  Parameters

  • options: RpcGetProgramAccountsOptions = {}

  Returns Promise<RpcAccount[]>

getAndMap

• getAndMap<T>(
      callback: GpaBuilderMapCallback<T>,
      options?: RpcGetProgramAccountsOptions,
  ): Promise<T[]>

  Type Parameters

  • T

  Parameters

  • callback: GpaBuilderMapCallback<T>
  • options: RpcGetProgramAccountsOptions = {}

  Returns Promise<T[]>

getDataAsPublicKeys

• getDataAsPublicKeys(
      options?: RpcGetProgramAccountsOptions,
  ): Promise<PublicKey[]>

  Parameters

  • options: RpcGetProgramAccountsOptions = {}

  Returns Promise<PublicKey[]>

getDeserialized

• getDeserialized(options?: RpcGetProgramAccountsOptions): Promise<Account[]>

  Parameters

  • options: RpcGetProgramAccountsOptions = {}

  Returns Promise<Account[]>

getPublicKeys

• getPublicKeys(options?: RpcGetProgramAccountsOptions): Promise<PublicKey[]>

  Parameters

  • options: RpcGetProgramAccountsOptions = {}

  Returns Promise<PublicKey[]>

registerFields

• registerFields<T extends object>(
      fields: GpaBuilderFieldSerializers<T, T>,
  ): GpaBuilder<Account, T>

  Type Parameters

  • T extends object

  Parameters

  • fields: GpaBuilderFieldSerializers<T, T>

  Returns GpaBuilder<Account, T>

registerFieldsFromStruct

• registerFieldsFromStruct<T extends object>(
      structFields: StructToSerializerTuple<T, T>,
  ): GpaBuilder<Account, T>

  Type Parameters

  • T extends object

  Parameters

  • structFields: StructToSerializerTuple<T, T>

  Returns GpaBuilder<Account, T>

registerNestedFieldsFromStruct

• registerNestedFieldsFromStruct<T extends object>(
      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.

  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]
      },
  >

  Example

  gpaBuilder
    .registerFieldsFromStruct([
      ['authority', publicKeySerializer],
      ['metadata', metadataSerializer],
    ])
    .registerNestedFieldsFromStruct('metadata', 32, [
      ['name', stringSerializer],
      ['creator', publicKeySerializer],
    ])
    .whereField('metadata.creator', somePublicKey)
  Copy

reset

• reset(): GpaBuilder<Account, Fields>

  Returns GpaBuilder<Account, Fields>

slice

• slice(offset: number, length: number): GpaBuilder<Account, Fields>

  Parameters

  • offset: number
  • length: number

  Returns GpaBuilder<Account, Fields>

sliceField

• sliceField(field: keyof Fields, offset?: number): GpaBuilder<Account, Fields>

  Parameters

  • field: keyof Fields
  • Optionaloffset: number

  Returns GpaBuilder<Account, Fields>

sortUsing

• sortUsing(callback: GpaBuilderSortCallback): GpaBuilder<Account, Fields>

  Parameters

  • callback: GpaBuilderSortCallback

  Returns GpaBuilder<Account, Fields>

where

• where(
      offset: number,
      data:
          | string
          | number
          | bigint
          | boolean
          | Uint8Array<ArrayBufferLike>
          | PublicKey,
  ): GpaBuilder<Account, Fields>

  Parameters

  • offset: number
  • data: string | number | bigint | boolean | Uint8Array<ArrayBufferLike> | PublicKey

  Returns GpaBuilder<Account, Fields>

whereField

• whereField<K extends string | number | symbol>(
      field: K,
      data: Fields[K],
      offset?: number,
  ): GpaBuilder<Account, Fields>

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • field: K
  • data: Fields[K]
  • Optionaloffset: number

  Returns GpaBuilder<Account, Fields>

whereSize

• whereSize(dataSize: number): GpaBuilder<Account, Fields>

  Parameters

  • dataSize: number

  Returns GpaBuilder<Account, Fields>

withoutData

• withoutData(): GpaBuilder<Account, Fields>

  Returns GpaBuilder<Account, Fields>