ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-21 04:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates per Shawn Xie

Browse Source
This commit is contained in:
Dennis Dawson
2024-12-12 16:38:31 -08:00
parent e3643aed6d
commit 0875576802
5 changed files with 22 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md
View File

@@ -978,8 +978,8 @@ Return an `MPToken` object.
{
"id": "example_get_mpt_issuance",
"command": "ledger_entry",
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
"ledger_index": "validated"
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
}
```
@@ -988,16 +988,20 @@ Return an `MPToken` object.
```json
{
"method": "ledger_entry",
"params": [{
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
"ledger_index": "validated"
}]
"params": [
{
"mptoken":{
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
}
}
]
}
```
*Commandline*
```sh
rippled json ledger_entry '{ "mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E", "ledger_index": "validated" }'
rippled json ledger_entry '{ "mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D", "account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"}'
```
<!-- MULTICODE_BLOCK_END -->

11
docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/mpt_holders.md
View File

@@ -9,7 +9,7 @@ labels:
{% partial file="/docs/_snippets/mpts-disclaimer.md" /%}
For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all holders of that MPT and their balance. This method likely returns very large data sets, so you should expect to implement paging via the `marker` field.
For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all holders of that MPT and their balance. This method likely returns very large data sets, so you should expect to implement paging via the `marker` field. This API is only available using Clio, not rippled.
## Request Format
@@ -91,15 +91,8 @@ An `mptoken` object has the following parameters:
| `account` | string | The account address of the holder who owns the `MPToken`. |
| `flags` | number | The flags assigned to the`MPToken` object. |
| `mpt_amount` | string | Base 10-encoded amount of the holder's balance. |
| `locked_amount` | string | Base 10-encoded amount of the locked balance. (Can be omitted if the value is 0.) |
| `mptoken_index` | string | Key of the `MPToken` object. |
#### Synthetic mpt_issuance_id field
`MPTokenIssuanceID` is an identifier that allows you to specify an `MPTokenIssuance` in RPCs. The server adds a synthetically parsed `mpt_issuance_id` field to API responses to avoid the need for client-side parsing of the `MPTokenIssuanceID`.
##### Transaction Metadata
An `mpt_issuance_id` field is provided in JSON transaction metadata (not available for binary) for all successful `MPTokenIssuanceCreate` transactions. The following APIs are impacted: `tx`, `account_tx`, `subscribe` and `ledger`.
##### Example
Example of a `tx` response:
@@ -147,7 +140,7 @@ Example of an `account_objects` response:
"Flags": 64,
"Issuer": "rBT9cUqK6UvpvZhPFNQ2qpUTin8rDokBeL",
"LedgerEntryType": "MPTokenIssuance",
"OutstandingAmount": "5a",
"OutstandingAmount": "100",
"OwnerNode": "0",
"PreviousTxnID": "BDC5ECA6B115C74BF4DA83E36325A2F55DF9E2C968A5CC15EB4D009D87D5C7CA",
"PreviousTxnLgrSeq": 308,

2
docs/references/protocol/data-types/mptoken.md
View File

@@ -41,7 +41,7 @@ The `MPTokenID` is the result of SHA512-Half of the following values, concatenat
| `LedgerEntryType` | number | UInt16 | The value 0x007F, mapped to the string `MPToken`, indicates that this object describes an individual account's holding of an MPT. |
| `Account` | string | AccountID | The owner of the MPT. |
| `MPTokenIssuanceID` | string | UInt192 | The `MPTokenIssuance` identifier. |
| `MPTAmount` | string | UInt64 | This value specifies a positive amount of tokens currently held by the owner. Valid values for this field are between 0x0 and 0xFFFFFFFFFFFFFFFF. |
| `MPTAmount` | string | UInt64 | This value specifies a positive amount of tokens currently held by the owner. Valid values for this field are between 0x0 and 0x7FFFFFFFFFFFFFFF. |
| `Flags` | number | UInt32 | (Default) See [MPToken Flags](#mptoken-flags) |
| `PreviousTxnID` | string | Hash256 | Transaction ID of the transaction that most recently modified this object. |
| `PreviousTxnLgrSeq` | number | UInt32 | The sequence of the ledger that contains the transaction that most recently modified this object. |

2
docs/references/protocol/data-types/mptokenissuance.md
View File

@@ -20,7 +20,7 @@ The `MPTokenIssuance` object represents a single MPT issuance and holds data ass
"Issuer": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
"AssetScale": "2",
"MaximumAmount": "100000000",
"OutstandingAmount": "3e8",
"OutstandingAmount": "100",
"TransferFee": 50000,
"MPTokenMetadata": "",
"OwnerNode": "74"

6
docs/references/protocol/transactions/metadata.md
View File

@@ -254,7 +254,13 @@ Transactions (`tx` and `account_tx`) involving NFTs can contain the following fi
| `nftoken_id` | String | Shows the `NFTokenID` for the `NFToken` that changed on the ledger as a result of the transaction. Only present if the transaction is `NFTokenMint` or `NFTokenAcceptOffer`. See [NFTokenID](../data-types/nftoken.md#nftokenid). |
| `nftoken_ids` | Array | Shows all the `NFTokenIDs` for the `NFTokens` that changed on the ledger as a result of the transaction. Only present if the transaction is `NFTokenCancelOffer`. |
| `offer_id` | String | Shows the `OfferID`of a new `NFTokenOffer` in a response from a `NFTokenCreateOffer` transaction. |
## MPT Fields
### Synthetic mpt_issuance_id field
`MPTokenIssuanceID` is an identifier that allows you to specify an `MPTokenIssuance` in RPCs. The server adds a synthetically parsed `mpt_issuance_id` field to API responses to avoid the need for client-side parsing of the `MPTokenIssuanceID`.
### Transaction Metadata
An `mpt_issuance_id` field is provided in JSON transaction metadata (not available for binary) for all successful `MPTokenIssuanceCreate` transactions. The following APIs are impacted: `tx`, `account_tx`, `subscribe` and `ledger`.
## delivered_amount