mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-19 19:55:51 +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
|
## Unreleased
|
||||||
|
|
||||||
|
### Added
|
||||||
|
* Add `nfts_by_issuer` clio-only API definition
|
||||||
## 3.1.0 (2024-06-03)
|
## 3.1.0 (2024-06-03)
|
||||||
|
|
||||||
### BREAKING CHANGES
|
### BREAKING CHANGES
|
||||||
|
|||||||
@@ -100,6 +100,7 @@ import {
|
|||||||
NFTHistoryTransaction,
|
NFTHistoryTransaction,
|
||||||
} from './nftHistory'
|
} from './nftHistory'
|
||||||
import { NFTInfoRequest, NFTInfoResponse } from './nftInfo'
|
import { NFTInfoRequest, NFTInfoResponse } from './nftInfo'
|
||||||
|
import { NFTsByIssuerRequest, NFTsByIssuerResponse } from './nftsByIssuer'
|
||||||
import { NFTSellOffersRequest, NFTSellOffersResponse } from './nftSellOffers'
|
import { NFTSellOffersRequest, NFTSellOffersResponse } from './nftSellOffers'
|
||||||
import { NoRippleCheckRequest, NoRippleCheckResponse } from './norippleCheck'
|
import { NoRippleCheckRequest, NoRippleCheckResponse } from './norippleCheck'
|
||||||
import {
|
import {
|
||||||
@@ -212,6 +213,7 @@ type Request =
|
|||||||
// clio only methods
|
// clio only methods
|
||||||
| NFTInfoRequest
|
| NFTInfoRequest
|
||||||
| NFTHistoryRequest
|
| NFTHistoryRequest
|
||||||
|
| NFTsByIssuerRequest
|
||||||
// AMM methods
|
// AMM methods
|
||||||
| AMMInfoRequest
|
| AMMInfoRequest
|
||||||
// Price Oracle methods
|
// Price Oracle methods
|
||||||
@@ -268,6 +270,7 @@ type Response =
|
|||||||
// clio only methods
|
// clio only methods
|
||||||
| NFTInfoResponse
|
| NFTInfoResponse
|
||||||
| NFTHistoryResponse
|
| NFTHistoryResponse
|
||||||
|
| NFTsByIssuerResponse
|
||||||
// AMM methods
|
// AMM methods
|
||||||
| AMMInfoResponse
|
| AMMInfoResponse
|
||||||
// Price Oracle methods
|
// Price Oracle methods
|
||||||
@@ -413,6 +416,8 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
|||||||
? NFTSellOffersResponse
|
? NFTSellOffersResponse
|
||||||
: T extends NFTInfoRequest
|
: T extends NFTInfoRequest
|
||||||
? NFTInfoResponse
|
? NFTInfoResponse
|
||||||
|
: T extends NFTsByIssuerRequest
|
||||||
|
? NFTsByIssuerResponse
|
||||||
: T extends NFTHistoryRequest
|
: T extends NFTHistoryRequest
|
||||||
? NFTHistoryResponse
|
? NFTHistoryResponse
|
||||||
: Response
|
: Response
|
||||||
@@ -582,6 +587,8 @@ export {
|
|||||||
NFTHistoryRequest,
|
NFTHistoryRequest,
|
||||||
NFTHistoryResponse,
|
NFTHistoryResponse,
|
||||||
NFTHistoryTransaction,
|
NFTHistoryTransaction,
|
||||||
|
NFTsByIssuerRequest,
|
||||||
|
NFTsByIssuerResponse,
|
||||||
// AMM methods
|
// AMM methods
|
||||||
AMMInfoRequest,
|
AMMInfoRequest,
|
||||||
AMMInfoResponse,
|
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