Class AuctionClient

Client mainly to interact with Auction and all associated entities.

Hierarchy

BaseClient
- AuctionClient

Index

Methods

Methods

createAuction

createAuction(): void

- Defined in clients/AuctionClient.ts:112
beta

Returns void

createBidForAuction

createBidForAuction(): void

- Defined in clients/AuctionClient.ts:119
beta

Returns void

getAuction

getAuction(auctionPublicKey: PublicKeyOrPublicKeyInit): Promise<null | Auction>

- Defined in clients/AuctionClient.ts:39
Fetches an auction by its public key.

Parameters
- auctionPublicKey: PublicKeyOrPublicKeyInit
  
  Public key to lookup the auction account.
Returns Promise<null | Auction>

Found Auction or null.

getAuctionBidderPots

getAuctionBidderPots(auctionPublicKey: PublicKeyOrPublicKeyInit): Promise<BidderPot[]>

- Defined in clients/AuctionClient.ts:86
Get all BidderPot associated to a specific auction.

Parameters
- auctionPublicKey: PublicKeyOrPublicKeyInit
  
  Public key to lookup the auction account.
Returns Promise<BidderPot[]>

A list of BidderPot

getAuctionBidders

getAuctionBidders(auctionPublicKey: PublicKeyOrPublicKeyInit): Promise<BidderMetadata[]>

- Defined in clients/AuctionClient.ts:58
Fetches all BidderMetadata associated to a specific auction given the auction's public key.

Parameters
- auctionPublicKey: PublicKeyOrPublicKeyInit
  
  Public key to lookup the auction account.
Returns Promise<BidderMetadata[]>

A list of BidderMetadata

getAuctions

getAuctions(): Promise<Auction[]>

- Defined in clients/AuctionClient.ts:14
Get all auctions.

Returns Promise<Auction[]>

A list of all auctions.

Generated using TypeDoc