Add request parameters to server definitions

Updated server_definitions.md to include request parameters.
2025-12-06 17:27:57 +00:00 · 2025-12-03 10:50:37 -05:00
6 changed files with 44 additions and 58 deletions
--- a/_code-samples/partial-payment/go/go.mod
+++ b/_code-samples/partial-payment/go/go.mod
@@ -1,6 +1,8 @@
 module github.com/XRPLF

-go 1.24.0
+go 1.23.0
+
+toolchain go1.23.10

 require github.com/Peersyst/xrpl-go v0.1.11

@@ -18,5 +20,5 @@ require (
 	github.com/tyler-smith/go-bip32 v1.0.0 // indirect
 	github.com/tyler-smith/go-bip39 v1.1.0 // indirect
 	github.com/ugorji/go/codec v1.2.11 // indirect
-	golang.org/x/crypto v0.45.0 // indirect
+	golang.org/x/crypto v0.35.0 // indirect
 )
--- a/_code-samples/partial-payment/go/go.sum
+++ b/_code-samples/partial-payment/go/go.sum
@@ -46,8 +46,8 @@ github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZ
 golang.org/x/crypto v0.0.0-20170613210332-850760c427c5/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q=
-golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4=
+golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs=
+golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
--- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md
+++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md
@@ -24,7 +24,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h
 ```json
 {
  "command": "mpt_holders",
-  "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
+  "mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
  "ledger_index": "validated"
 }
 ```
@@ -36,7 +36,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h
  "method": "mpt_holders",
  "params": [
    {
-      "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
+      "mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
      "ledger_index": "validated"
    }
  ]
@@ -46,7 +46,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h

 {% /tabs %}

-{% try-it method="mpt_holders" /%}
+{% try-it method="mpt_holders" server="devnet-clio" /%}

 The request contains the following parameters:

@@ -65,20 +65,19 @@ The request contains the following parameters:
 ```json
 {
  "result": {
-    "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
+    "mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
    "limit": 50,
-    "ledger_index": 99563041,
+    "ledger_index": 2414929,
    "mptokens": [
      {
-        "account": "rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP",
+        "account": "rfyWeQpYM3vCXRHA9cMLs2ZEdZv1F1jzm9",
        "flags": 0,
-        "mpt_amount": "100",
-        "mptoken_index": "081078D38E9C36647B4AD95ECB476F434B817753AD4F6B4B5EE0ED4C3185C80F"
+        "mpt_amount": "200",
+        "mptoken_index": "22F99DCD55BCCF3D68DC3E4D6CF12602006A7563A6BE93FC57FD63298BCCEB13"
      }
    ],
    "validated": true
  },
-  "id": "example_mpt_holders",
  "status": "success",
  "type": "response",
  "warnings": [
@@ -97,15 +96,15 @@ The request contains the following parameters:

 {
  "result": {
-    "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
+    "mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
    "limit": 50,
-    "ledger_index": 99563067,
+    "ledger_index": 2415033,
    "mptokens": [
      {
-        "account": "rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP",
+        "account": "rfyWeQpYM3vCXRHA9cMLs2ZEdZv1F1jzm9",
        "flags": 0,
-        "mpt_amount": "100",
-        "mptoken_index": "081078D38E9C36647B4AD95ECB476F434B817753AD4F6B4B5EE0ED4C3185C80F"
+        "mpt_amount": "200",
+        "mptoken_index": "22F99DCD55BCCF3D68DC3E4D6CF12602006A7563A6BE93FC57FD63298BCCEB13"
      }
    ],
    "validated": true,
--- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md
+++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md
@@ -47,8 +47,8 @@ In addition to the general fields above, you must specify *exactly 1* of the fol
    - [Get DepositPreauth Entry](#get-depositpreauth-entry)
    - [Get Ticket Entry](#get-ticket-entry)
    - [Get NFT Page](#get-nft-page)
-    - [Get MPT Issuance Entry](#get-mpt-issuance-entry)
-    - [Get MPToken Entry](#get-mptoken-entry)
+    - [Get MPT Issuance Object](#get-mpt-issuance-object)
+    - [Get MPToken Object](#get-mptoken-object)
  - [Response Format](#response-format)
  - [Possible Errors](#possible-errors)

@@ -883,7 +883,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0

 {% try-it method="ledger_entry-nft-page" /%}

-### Get MPT Issuance Entry
+### Get MPT Issuance Object

 Return an `MPTokenIssuance` object.

@@ -900,7 +900,7 @@ Return an `MPTokenIssuance` object.
 {
    "id": "example_get_mpt_issuance",
    "command": "ledger_entry",
-    "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
+    "mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
    "ledger_index": "validated"
 }
 ```
@@ -911,7 +911,7 @@ Return an `MPTokenIssuance` object.
 {
  "method": "ledger_entry",
  "params": [{
-    "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
+    "mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
    "ledger_index": "validated"
  }]
 }
@@ -920,14 +920,16 @@ Return an `MPTokenIssuance` object.

 {% tab label="Commandline" %}
 ```sh
-rippled json ledger_entry '{ "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA", "ledger_index": "validated" }'
+rippled json ledger_entry '{ "mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E", "ledger_index": "validated" }'
 ```
 {% /tab %}
 {% /tabs %}

-{% try-it method="ledger_entry-mptokenissuance" /%}
+<!-- TODO: add try-it for MPT issuance
+{% try-it method="ledger_entry-mpt_issuance" /%}
+-->

-### Get MPToken Entry
+### Get MPToken Object

 Return an `MPToken` object.

@@ -944,11 +946,11 @@ Return an `MPToken` object.
 {% tab label="WebSocket" %}
 ```json
 {
-    "id": "example_get_mpt",
+    "id": "example_get_mpt_issuance",
    "command": "ledger_entry",
    "mptoken": {
-      "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
-      "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
+      "mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
+      "account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
    }
 }
 ```
@@ -961,8 +963,8 @@ Return an `MPToken` object.
    "params": [
        {
            "mptoken":{
-                "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
-                "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
+                "mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
+                "account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
            } 
        }
    ]
@@ -972,12 +974,15 @@ Return an `MPToken` object.

 {% tab label="Commandline" %}
 ```sh
-rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA", "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"} }'
+rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D", "account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"} }'
 ```
 {% /tab %}
 {% /tabs %}

+<!-- TODO: make a try-it link for MPT object
 {% try-it method="ledger_entry-mptoken" /%}
+ -->
+

 ## Response Format

--- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md
+++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md
@@ -39,7 +39,11 @@ An example of the request format:

 {% try-it method="server_definitions" /%}

-The request does not take any parameters.
+The request includes the following parameters:
+
+| Field             | Type   | Required? | Description |
+|:------------------|:-------|:----------|-------------|
+| `hash`            | String | No        | If included and the hash matches the server's hash, the full set of definitions will not be returned. |


 ## Response Format
--- a/resources/dev-tools/components/websocket-api/data/command-list.json
+++ b/resources/dev-tools/components/websocket-api/data/command-list.json
@@ -420,7 +420,7 @@
        "body": {
          "id": "example_mpt_holders",
          "command": "mpt_holders",
-          "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
+          "mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
          "ledger_index": "validated"
        }
      }
@@ -802,30 +802,6 @@
          },
          "ledger_index": "validated"
        }
-      },
-      {
-        "name": "ledger_entry - MPTokenIssuance",
-        "description": "Returns an MPTokenIssuance object in its raw ledger format.",
-        "link": "/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry#get-mpt-issuance-entry",
-        "body": {
-          "id": "example_get_mpt_issuance",
-          "command": "ledger_entry",
-          "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
-          "ledger_index": "validated"
-        }
-      },
-      {
-        "name": "ledger_entry - MPToken",
-        "description": "Returns an MPToken object in its raw ledger format.",
-        "link": "/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry#get-mptoken-entry",
-        "body": {
-          "id": "example_get_mpt",
-          "command": "ledger_entry",
-          "mptoken": {
-            "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
-            "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
-          }
-        }
      }
    ]
  }