mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-19 11:45:49 +00:00
Add nfts_by_issuer data type (#2694)
* add nfts_by_issuer data type * update HISTORY.md * update HISTORY.md * added to index and change field name * change to added in history * reformat change in history * reformat history on bfts_by_issuer --------- Authored-by: Kassaking <kassaking7@gmail.com>
This commit is contained in:
@@ -4,6 +4,8 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
|
||||
|
||||
## Unreleased
|
||||
|
||||
### Added
|
||||
* Add `nfts_by_issuer` clio-only API definition
|
||||
## 3.1.0 (2024-06-03)
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
@@ -100,6 +100,7 @@ import {
|
||||
NFTHistoryTransaction,
|
||||
} from './nftHistory'
|
||||
import { NFTInfoRequest, NFTInfoResponse } from './nftInfo'
|
||||
import { NFTsByIssuerRequest, NFTsByIssuerResponse } from './nftsByIssuer'
|
||||
import { NFTSellOffersRequest, NFTSellOffersResponse } from './nftSellOffers'
|
||||
import { NoRippleCheckRequest, NoRippleCheckResponse } from './norippleCheck'
|
||||
import {
|
||||
@@ -212,6 +213,7 @@ type Request =
|
||||
// clio only methods
|
||||
| NFTInfoRequest
|
||||
| NFTHistoryRequest
|
||||
| NFTsByIssuerRequest
|
||||
// AMM methods
|
||||
| AMMInfoRequest
|
||||
// Price Oracle methods
|
||||
@@ -268,6 +270,7 @@ type Response =
|
||||
// clio only methods
|
||||
| NFTInfoResponse
|
||||
| NFTHistoryResponse
|
||||
| NFTsByIssuerResponse
|
||||
// AMM methods
|
||||
| AMMInfoResponse
|
||||
// Price Oracle methods
|
||||
@@ -413,6 +416,8 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
||||
? NFTSellOffersResponse
|
||||
: T extends NFTInfoRequest
|
||||
? NFTInfoResponse
|
||||
: T extends NFTsByIssuerRequest
|
||||
? NFTsByIssuerResponse
|
||||
: T extends NFTHistoryRequest
|
||||
? NFTHistoryResponse
|
||||
: Response
|
||||
@@ -582,6 +587,8 @@ export {
|
||||
NFTHistoryRequest,
|
||||
NFTHistoryResponse,
|
||||
NFTHistoryTransaction,
|
||||
NFTsByIssuerRequest,
|
||||
NFTsByIssuerResponse,
|
||||
// AMM methods
|
||||
AMMInfoRequest,
|
||||
AMMInfoResponse,
|
||||
|
||||
68
packages/xrpl/src/models/methods/nftsByIssuer.ts
Normal file
68
packages/xrpl/src/models/methods/nftsByIssuer.ts
Normal file
@@ -0,0 +1,68 @@
|
||||
import { NFToken } from '../common'
|
||||
|
||||
import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
|
||||
|
||||
/**
|
||||
* The nfts_by_issuer method returns a list of NFTokens issued by the account.
|
||||
* The order of the NFTs is not associated with the date the NFTs were minted.
|
||||
* Expects a response in the form of a {@link
|
||||
* NFTsByIssuerResponse}.
|
||||
*
|
||||
* @category Requests
|
||||
*/
|
||||
export interface NFTsByIssuerRequest
|
||||
extends BaseRequest,
|
||||
LookupByLedgerRequest {
|
||||
command: 'nfts_by_issuer'
|
||||
/**
|
||||
* A unique identifier for the account, most commonly the account's address
|
||||
*/
|
||||
issuer: string
|
||||
/**
|
||||
* Value from a previous paginated response. Resume retrieving data where
|
||||
* that response left off. This value is stable even if there is a change in
|
||||
* the server's range of available ledgers.
|
||||
*/
|
||||
marker?: unknown
|
||||
/**
|
||||
* Filter NFTs issued by this issuer that have this taxon.
|
||||
*/
|
||||
nft_taxon?: number
|
||||
/**
|
||||
* Default varies. Limit the number of transactions to retrieve. The server
|
||||
* is not required to honor this value.
|
||||
*/
|
||||
limit?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Expected response from an {@link NFTsByIssuerRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export interface NFTsByIssuerResponse extends BaseResponse {
|
||||
result: {
|
||||
/**
|
||||
* The unique identifier for the account, most commonly the account's address
|
||||
*/
|
||||
issuer: string
|
||||
/**
|
||||
* A list of NFTs issued by the account.
|
||||
* The order of the NFTs is not associated with the date the NFTs were minted.
|
||||
*/
|
||||
nfts: NFToken[]
|
||||
/**
|
||||
* Server-defined value indicating the response is paginated. Pass this
|
||||
* to the next call to resume where this call left off.
|
||||
*/
|
||||
marker?: unknown
|
||||
/**
|
||||
* The limit value used in the request.
|
||||
*/
|
||||
limit?: number
|
||||
/**
|
||||
* Use to filter NFTs issued by this issuer that have this taxon.
|
||||
*/
|
||||
nft_taxon?: number
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user