Class TokenMetadataGpaBuilder

Hierarchy

GpaBuilder
- TokenMetadataGpaBuilder
  - MetadataV1GpaBuilder

Index

Constructors

Methods

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

Properties

metaplex programId config sortCallback?

Constructors

constructor

new TokenMetadataGpaBuilder(metaplex: Metaplex, programId?: PublicKey): TokenMetadataGpaBuilder
Parameters
- metaplex: Metaplex
- Optional programId: PublicKey
Returns TokenMetadataGpaBuilder
Overrides GpaBuilder.constructor
- Defined in packages/js/src/plugins/nftModule/gpaBuilders.ts:19

Methods

whereKey

whereKey(key: Key): TokenMetadataGpaBuilder
Parameters
- key: Key
Returns TokenMetadataGpaBuilder
- Defined in packages/js/src/plugins/nftModule/gpaBuilders.ts:23

mergeConfig

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

slice

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

withoutData

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

addFilter

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

where

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

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[]>
Inherited from GpaBuilder.getAndMap
- Defined in packages/js/src/utils/GpaBuilder.ts:98

getPublicKeys

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

getDataAsPublicKeys

getDataAsPublicKeys(): Promise<PublicKey[]>
Returns Promise<PublicKey[]>
Inherited from GpaBuilder.getDataAsPublicKeys
- 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>
Inherited from GpaBuilder.getMultipleAccounts
- Defined in packages/js/src/utils/GpaBuilder.ts:111

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.

Class TokenMetadataGpaBuilder

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

metaplex: Metaplex

Optional programId: PublicKey

Returns TokenMetadataGpaBuilder

Methods

whereKey

Parameters

key: Key

Returns TokenMetadataGpaBuilder

mergeConfig

Parameters

config: GetProgramAccountsConfig

Returns TokenMetadataGpaBuilder

slice

Parameters

offset: number

length: number

Returns TokenMetadataGpaBuilder

withoutData

Returns TokenMetadataGpaBuilder

addFilter

Parameters

Rest ...filters: GetProgramAccountsFilter[]

Returns TokenMetadataGpaBuilder

where

Parameters

offset: number

bytes: string | number | PublicKey | Buffer | BN

Returns TokenMetadataGpaBuilder

whereSize

Parameters

dataSize: number

Returns TokenMetadataGpaBuilder

sortUsing

Parameters

callback: GpaSortCallback

Returns TokenMetadataGpaBuilder

get

Returns Promise<UnparsedAccount[]>

getAndMap

Type Parameters

T

Parameters

callback: ((account: UnparsedAccount) => T)

Parameters

account: UnparsedAccount

Returns T

Returns Promise<T[]>

getPublicKeys

Returns Promise<PublicKey[]>

getDataAsPublicKeys

Returns Promise<PublicKey[]>

getMultipleAccounts

Parameters

Optional callback: ((account: UnparsedAccount) => PublicKey)

Parameters

account: UnparsedAccount

Returns PublicKey

Optional options: GmaBuilderOptions

Returns Promise<GmaBuilder>

Properties

Protected Readonly metaplex

Protected Readonly programId

Protected config

Protected Optional sortCallback

Settings

Member Visibility

Theme

`Optional` programId: PublicKey

`Rest` ...filters: GetProgramAccountsFilter[]

`Optional` callback: ((account: UnparsedAccount) => PublicKey)

`Optional` options: GmaBuilderOptions

`Protected` `Readonly` metaplex

`Protected` `Readonly` programId

`Protected` config

`Protected` `Optional` sortCallback