Exchange

The Exchange module provides a set of methods to interact with the marketplace. It allows you to place bids, list tokens for sale, cancel bids or listings, accept bids, buy tokens, create auctions, and accept the highest bid on an auction.

Methods

placeBid

This method allows you to place a bid on a token.

async placeBid(
  bid: Bid,
  signer: Signer,
  onProgress?: (state: PlaceBidState) => void,
): Promise<UUID>

listToken

This method allows you to list a token for sale.

async listToken(
  listing: Listing,
  signer: Signer,
  onProgress?: (state: ListTokenState) => void,
): Promise<UUID>

cancelBid

This method allows you to cancel a bid.

async cancelBid(
  bidId: UUID,
  signer: Signer,
  onProgress?: (state: CancelOfferState) => void,
): Promise<UUID>

cancelListing

This method allows you to cancel a listing.

async cancelListing(
  listingId: UUID,
  signer: Signer,
  onProgress?: (state: CancelOfferState) => void,
): Promise<UUID>

acceptBid

This method allows you to accept a bid.

async acceptBid(
  bidId: UUID,
  quantity: Uint256,
  signer: Signer,
  onProgress?: (state: AcceptOfferState) => void,
): Promise<UUID>

buyToken

This method allows you to accept a listing.

async buyToken(
  listingId: UUID,
  quantity: Uint256,
  signer: Signer,
  onProgress?: (state: AcceptOfferState) => void,
): Promise<UUID>

createAuction

This method allows you to create an auction.

async createAuction(
  auction: Auction,
  signer: Signer,
  onProgress?: (state: ListTokenState) => void,
): Promise<UUID>

acceptAuctionHighestBid

This method allows you to accept the highest bid on an auction.

async acceptAuctionHighestBid(
  auctionId: UUID,
  signer: Signer,
  onProgress?: (state: AcceptAuctionHighestBidState) => void,
): Promise<UUID>

getOffer

This low-level API retrieves an offer. The offer can be either a bid or a listing.

async getOffer(
  offerId: UUID,
): Promise<NonNullable<FetchOfferQuery['offer']>>

Each method in the Exchange module returns a Promise that resolves to a UUID representing the ID of the action performed (bid placed, token listed, bid cancelled, etc.). The getOffer method returns a Promise that resolves to the offer details.

The signer parameter is an instance of Signer used to sign transactions. The onProgress parameter is an optional callback function that can be used to track the progress of the operation.

Installation Asset