Compare commits

...

3 Commits

Author SHA1 Message Date
Maria Shodunke
a2e5c3a613 Remove unnecessary env 2025-10-16 17:47:11 +01:00
Maria Shodunke
bc5e48a0ba Update Get MPT Issuance + Get MPToken 2025-10-16 17:40:13 +01:00
Maria Shodunke
26fb8775a0 Update mpt_holders method with Mainnet example 2025-10-16 17:01:35 +01:00
3 changed files with 53 additions and 33 deletions

View File

@@ -24,7 +24,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h
```json ```json
{ {
"command": "mpt_holders", "command": "mpt_holders",
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8", "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated" "ledger_index": "validated"
} }
``` ```
@@ -36,7 +36,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h
"method": "mpt_holders", "method": "mpt_holders",
"params": [ "params": [
{ {
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8", "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated" "ledger_index": "validated"
} }
] ]
@@ -46,7 +46,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h
{% /tabs %} {% /tabs %}
{% try-it method="mpt_holders" server="devnet-clio" /%} {% try-it method="mpt_holders" /%}
The request contains the following parameters: The request contains the following parameters:
@@ -65,19 +65,20 @@ The request contains the following parameters:
```json ```json
{ {
"result": { "result": {
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8", "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"limit": 50, "limit": 50,
"ledger_index": 2414929, "ledger_index": 99563041,
"mptokens": [ "mptokens": [
{ {
"account": "rfyWeQpYM3vCXRHA9cMLs2ZEdZv1F1jzm9", "account": "rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP",
"flags": 0, "flags": 0,
"mpt_amount": "200", "mpt_amount": "100",
"mptoken_index": "22F99DCD55BCCF3D68DC3E4D6CF12602006A7563A6BE93FC57FD63298BCCEB13" "mptoken_index": "081078D38E9C36647B4AD95ECB476F434B817753AD4F6B4B5EE0ED4C3185C80F"
} }
], ],
"validated": true "validated": true
}, },
"id": "example_mpt_holders",
"status": "success", "status": "success",
"type": "response", "type": "response",
"warnings": [ "warnings": [
@@ -96,15 +97,15 @@ The request contains the following parameters:
{ {
"result": { "result": {
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8", "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"limit": 50, "limit": 50,
"ledger_index": 2415033, "ledger_index": 99563067,
"mptokens": [ "mptokens": [
{ {
"account": "rfyWeQpYM3vCXRHA9cMLs2ZEdZv1F1jzm9", "account": "rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP",
"flags": 0, "flags": 0,
"mpt_amount": "200", "mpt_amount": "100",
"mptoken_index": "22F99DCD55BCCF3D68DC3E4D6CF12602006A7563A6BE93FC57FD63298BCCEB13" "mptoken_index": "081078D38E9C36647B4AD95ECB476F434B817753AD4F6B4B5EE0ED4C3185C80F"
} }
], ],
"validated": true, "validated": true,

View File

@@ -49,8 +49,8 @@ In addition to the general fields above, you must specify *exactly 1* of the fol
- [Get DepositPreauth Entry](#get-depositpreauth-entry) - [Get DepositPreauth Entry](#get-depositpreauth-entry)
- [Get Ticket Entry](#get-ticket-entry) - [Get Ticket Entry](#get-ticket-entry)
- [Get NFT Page](#get-nft-page) - [Get NFT Page](#get-nft-page)
- [Get MPT Issuance Object](#get-mpt-issuance-object) - [Get MPT Issuance Entry](#get-mpt-issuance-entry)
- [Get MPToken Object](#get-mptoken-object) - [Get MPToken Entry](#get-mptoken-entry)
- [Response Format](#response-format) - [Response Format](#response-format)
- [Possible Errors](#possible-errors) - [Possible Errors](#possible-errors)
@@ -885,7 +885,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
{% try-it method="ledger_entry-nft-page" /%} {% try-it method="ledger_entry-nft-page" /%}
### Get MPT Issuance Object ### Get MPT Issuance Entry
Return an `MPTokenIssuance` object. Return an `MPTokenIssuance` object.
@@ -902,7 +902,7 @@ Return an `MPTokenIssuance` object.
{ {
"id": "example_get_mpt_issuance", "id": "example_get_mpt_issuance",
"command": "ledger_entry", "command": "ledger_entry",
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E", "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated" "ledger_index": "validated"
} }
``` ```
@@ -913,7 +913,7 @@ Return an `MPTokenIssuance` object.
{ {
"method": "ledger_entry", "method": "ledger_entry",
"params": [{ "params": [{
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E", "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated" "ledger_index": "validated"
}] }]
} }
@@ -922,16 +922,14 @@ Return an `MPTokenIssuance` object.
{% tab label="Commandline" %} {% tab label="Commandline" %}
```sh ```sh
rippled json ledger_entry '{ "mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E", "ledger_index": "validated" }' rippled json ledger_entry '{ "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA", "ledger_index": "validated" }'
``` ```
{% /tab %} {% /tab %}
{% /tabs %} {% /tabs %}
<!-- TODO: add try-it for MPT issuance {% try-it method="ledger_entry-mptokenissuance" /%}
{% try-it method="ledger_entry-mpt_issuance" /%}
-->
### Get MPToken Object ### Get MPToken Entry
Return an `MPToken` object. Return an `MPToken` object.
@@ -948,11 +946,11 @@ Return an `MPToken` object.
{% tab label="WebSocket" %} {% tab label="WebSocket" %}
```json ```json
{ {
"id": "example_get_mpt_issuance", "id": "example_get_mpt",
"command": "ledger_entry", "command": "ledger_entry",
"mptoken": { "mptoken": {
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D", "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1" "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
} }
} }
``` ```
@@ -965,8 +963,8 @@ Return an `MPToken` object.
"params": [ "params": [
{ {
"mptoken":{ "mptoken":{
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D", "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1" "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
} }
} }
] ]
@@ -976,15 +974,12 @@ Return an `MPToken` object.
{% tab label="Commandline" %} {% tab label="Commandline" %}
```sh ```sh
rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D", "account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"} }' rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA", "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"} }'
``` ```
{% /tab %} {% /tab %}
{% /tabs %} {% /tabs %}
<!-- TODO: make a try-it link for MPT object
{% try-it method="ledger_entry-mptoken" /%} {% try-it method="ledger_entry-mptoken" /%}
-->
## Response Format ## Response Format

View File

@@ -420,7 +420,7 @@
"body": { "body": {
"id": "example_mpt_holders", "id": "example_mpt_holders",
"command": "mpt_holders", "command": "mpt_holders",
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8", "mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated" "ledger_index": "validated"
} }
} }
@@ -802,6 +802,30 @@
}, },
"ledger_index": "validated" "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"
}
}
} }
] ]
} }