From e4d557c19ce053e843b674d06e78ad85bcef33ac Mon Sep 17 00:00:00 2001 From: ddawson Date: Fri, 13 Jan 2023 14:46:10 -0800 Subject: [PATCH 1/5] Add nft_page option --- assets/js/apitool-methods-ws.js | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/assets/js/apitool-methods-ws.js b/assets/js/apitool-methods-ws.js index b3b05276c4..ac38f38b17 100644 --- a/assets/js/apitool-methods-ws.js +++ b/assets/js/apitool-methods-ws.js @@ -211,6 +211,17 @@ Request('ledger_entry - DirectoryNode', { } }) +Request('ledger_entry - NFT Page', { + description: "Returns an NFT Page object in its raw ledger format.", + link: "ledger_entry.html#get-offer-object", + body: { + "id": "example_get_accountroot", + "command": "ledger_entry", + "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", + "ledger_index": "validated" + } +}) + Request('ledger_entry - Offer', { description: "Returns an Offer object in its raw ledger format.", link: "ledger_entry.html#get-offer-object", From cca8a86c2a167db69bdd02646907c6e4157e5c85 Mon Sep 17 00:00:00 2001 From: Dennis Dawson Date: Thu, 2 Feb 2023 09:09:52 -0800 Subject: [PATCH 2/5] Update assets/js/apitool-methods-ws.js Co-authored-by: Rome Reginelli --- assets/js/apitool-methods-ws.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/js/apitool-methods-ws.js b/assets/js/apitool-methods-ws.js index ac38f38b17..8742cc3c82 100644 --- a/assets/js/apitool-methods-ws.js +++ b/assets/js/apitool-methods-ws.js @@ -215,7 +215,7 @@ Request('ledger_entry - NFT Page', { description: "Returns an NFT Page object in its raw ledger format.", link: "ledger_entry.html#get-offer-object", body: { - "id": "example_get_accountroot", + "id": "example_get_nft_page", "command": "ledger_entry", "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", "ledger_index": "validated" From c1776d1259026f3f310f1b83f65350eab9d8e1f7 Mon Sep 17 00:00:00 2001 From: ddawson Date: Wed, 8 Feb 2023 12:04:49 -0800 Subject: [PATCH 3/5] Link to ledger entry --- assets/js/apitool-methods-ws.js | 2 +- .../ledger-methods/ledger_entry.md | 43 +++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/assets/js/apitool-methods-ws.js b/assets/js/apitool-methods-ws.js index 8742cc3c82..df398186de 100644 --- a/assets/js/apitool-methods-ws.js +++ b/assets/js/apitool-methods-ws.js @@ -213,7 +213,7 @@ Request('ledger_entry - DirectoryNode', { Request('ledger_entry - NFT Page', { description: "Returns an NFT Page object in its raw ledger format.", - link: "ledger_entry.html#get-offer-object", + link: "ledger_entry.html#get_nft_page", body: { "id": "example_get_nft_page", "command": "ledger_entry", diff --git a/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index 0a9d9b3f08..e4675eda17 100644 --- a/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -39,6 +39,7 @@ In addition to the general fields above, you must specify *exactly 1* of the fol - [`payment_channel`](#get-paychannel-object) - [`deposit_preauth`](#get-depositpreauth-object) - [`ticket`](#get-ticket-object) +- [`nft_page`](#get-nft-page) **Caution:** If you specify more than 1 of these type-specific fields in a request, the server retrieves results for only 1 of them. It is not defined which one the server chooses, so you should avoid doing this. @@ -560,6 +561,48 @@ rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJ [Try it! >](websocket-api-tool.html#ledger_entry-ticket) +### Get NFT Page + +Return an NFT Page in its raw ledger format. + +| `Field` | Type | Description | +|:------------------------|:---------------------------|:----------------------| +| `nft_page` | String | The [object ID](ledger-object-ids.html) of an [NFT Page](nftokenpage.html) to retrieve. | + + + +*WebSocket* + +```json +{ + "id": "example_get_nft_page", + "command": "ledger_entry", + "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", + "ledger_index": "validated" + }] +} +``` + +*Commandline* + +```sh +rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", "ledger_index": "validated" }' +``` + + + +[Try it! >](websocket-api-tool.html#ledger_entry-nft-page) ## Response Format From 626afa58efc5b9eda4cd6386729f6a9d6b30513b Mon Sep 17 00:00:00 2001 From: Dennis Dawson Date: Tue, 21 Feb 2023 12:55:04 -0800 Subject: [PATCH 4/5] Update assets/js/apitool-methods-ws.js Co-authored-by: Rome Reginelli --- assets/js/apitool-methods-ws.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/js/apitool-methods-ws.js b/assets/js/apitool-methods-ws.js index df398186de..ea11cd0ee5 100644 --- a/assets/js/apitool-methods-ws.js +++ b/assets/js/apitool-methods-ws.js @@ -213,7 +213,7 @@ Request('ledger_entry - DirectoryNode', { Request('ledger_entry - NFT Page', { description: "Returns an NFT Page object in its raw ledger format.", - link: "ledger_entry.html#get_nft_page", + link: "ledger_entry.html#get-nft-page", body: { "id": "example_get_nft_page", "command": "ledger_entry", From d605d9a92a523e77179260952c2ee7959c2411d4 Mon Sep 17 00:00:00 2001 From: ddawson Date: Tue, 21 Feb 2023 15:41:08 -0800 Subject: [PATCH 5/5] Minor change to start build --- content/references/protocol-reference/data-types/nftoken.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/references/protocol-reference/data-types/nftoken.md b/content/references/protocol-reference/data-types/nftoken.md index 238a9f07e6..084a660c04 100644 --- a/content/references/protocol-reference/data-types/nftoken.md +++ b/content/references/protocol-reference/data-types/nftoken.md @@ -106,7 +106,6 @@ Notice that the scrambled version of the `NFTokenTaxon` is `0xBC8B858E`: the scr The fifth section is a sequence number that increases with each `NFToken` the issuer creates. The [NFTokenMint transaction][] sets this part of the `NFTokenID` automatically based on the `MintedTokens` field of the `Issuer` account. If the issuer's [AccountRoot object][] does not have a `MintedTokens` field, the field is assumed to have the value 0; the value of the field is then incremented by exactly 1. - ## URI The URI field points to the data or metadata associated with the `NFToken`. This field does not need to be an HTTP or HTTPS URL; it could be an IPFS URI, a magnet link, an [RFC 2379 "data" URL](https://datatracker.ietf.org/doc/html/rfc2397), or even a totally custom encoding. The URI is not checked for validity, but the field is limited to a maximum length of 256 bytes.