xrpl/src/models/methods/nftBuyOffers.ts

A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser

import { NFTOffer } from '../common'

import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'

/**
 * The `nft_buy_offers` method retrieves all of buy offers for the specified
 * NFToken.
 *
 * @category Requests
 */
export interface NFTBuyOffersRequest
  extends BaseRequest,
    LookupByLedgerRequest {
  command: 'nft_buy_offers'
  /**
   * The unique identifier of an NFToken. The request returns buy offers for this NFToken.
   */
  nft_id: string
}

/**
 * Response expected from an {@link NFTBuyOffersRequest}.
 *
 * @category Responses
 */
export interface NFTBuyOffersResponse extends BaseResponse {
  result: {
    /**
     * A list of buy offers for the specified NFToken.
     */
    offers: NFTOffer[]
    /**
     * The token ID of the NFToken to which these offers pertain.
     */
    nft_id: string
  }
}