Class StoreClient

Client to mainly interact with Store and all associated entities.

Hierarchy

BaseClient
- StoreClient

Index

Methods

Methods

getStore

getStore(storePublicKey: PublicKeyOrPublicKeyInit): Promise<null | Store>

- Defined in clients/StoreClient.ts:40
Fetches a store by it's public key

Parameters
- storePublicKey: PublicKeyOrPublicKeyInit
  
  The store's public key.
Returns Promise<null | Store>

The store or null if not found.

getStores

getStores(): Promise<Store[]>

- Defined in clients/StoreClient.ts:17
Fetches all stores.

Returns Promise<Store[]>

A list of stores.

upsertStore

upsertStore(args: { isPublic: boolean; storeAdminPublicKey: PublicKeyOrPublicKeyInit; storePublicKey: PublicKeyOrPublicKeyInit; whitelistedCreators: { activated: boolean; address: PublicKeyOrPublicKeyInit }[] }): Promise<string[]>

- Defined in clients/StoreClient.ts:62
Creates or updates a store on Metaplex.

beta

Parameters
- args: { isPublic: boolean; storeAdminPublicKey: PublicKeyOrPublicKeyInit; storePublicKey: PublicKeyOrPublicKeyInit; whitelistedCreators: { activated: boolean; address: PublicKeyOrPublicKeyInit }[] }
  
  Parameters to provide for the store.
  - isPublic: boolean
  - storeAdminPublicKey: PublicKeyOrPublicKeyInit
  - storePublicKey: PublicKeyOrPublicKeyInit
  - whitelistedCreators: { activated: boolean; address: PublicKeyOrPublicKeyInit }[]
Returns Promise<string[]>

A list of transaction signatures associated to creating or updating the store.

Generated using TypeDoc