Compare commits

..

38 Commits

Author SHA1 Message Date
Rome Reginelli
8d2d3850ec Merge pull request #3368 from XRPLF/rwa-updates
Refactor RWA tokenization buttons
2025-10-29 12:20:26 -07:00
akcodez
c7961f692e use Link component for link 2025-10-29 12:17:21 -07:00
akcodez
dbcdb508aa add arrow to get started now 2025-10-29 12:15:59 -07:00
akcodez
982386d0f6 Update CompanyLogo component to use anchor tag for external links, enhancing accessibility and security with target and rel attributes. 2025-10-29 07:36:34 -07:00
akcodez
9dde1114ca remove arrow from internal link 2025-10-29 07:32:47 -07:00
akcodez
4ee47a63dc fix css build issues 2025-10-29 07:29:41 -07:00
Rome Reginelli
41b07a458e Merge pull request #3364 from XRPLF/fix_links_from_concepts
Fix source links in concepts and infrastructure sections
2025-10-28 14:12:58 -07:00
Rome Reginelli
e6765094a9 Merge pull request #3365 from XRPLF/fix_links_from_protocol_refs
Update links in protocol references
2025-10-28 13:56:23 -07:00
Maria Shodunke
fdcbc6c747 Merge pull request #3367 from XRPLF/kennyzlei/lending-protocol-faucet
Add new faucet configuration for Lending-Devnet
2025-10-28 16:07:44 +00:00
akcodez
5f3dc85e5b Refactor tokenization page layout and styles; update button structure and link behavior for improved responsiveness and user experience. 2025-10-27 12:11:40 -07:00
Kenny Lei
ea0c186fa0 Add new faucet configuration for Lending-Devnet 2025-10-27 09:30:51 -07:00
Maria Shodunke
31ff09c093 Merge pull request #3359 from XRPLF/mpt-metadata-schema
Add MPT Metadata Schema section to concept docs
2025-10-23 17:09:42 +01:00
mDuo13
3fa6394b09 Update links in protocol references 2025-10-22 16:03:12 -07:00
Rome Reginelli
4319594cf1 Merge pull request #3346 from XRPLF/contrib_titles_and_markdoc_tags
Update contributor documentation w/ more info
2025-10-22 15:03:45 -07:00
Rome Reginelli
7d9b9f7c17 Merge pull request #3360 from XRPLF/consistent_tx_examples
Add mainnet AMMCreate and OracleSet transaction examples
2025-10-22 15:03:18 -07:00
mDuo13
483c7c55e2 Adjust rate limiting log message example 2025-10-22 15:01:57 -07:00
Rome Reginelli
0d73d6d851 Merge pull request #3341 from XRPLF/fix_lsfammnode
Fix lsfAMMNode docs
2025-10-22 09:25:49 -07:00
mDuo13
408c0f27e8 Fix source links in concepts and infrastructure sections 2025-10-21 18:08:31 -07:00
oeggert
e7cb03a88d Merge pull request #3355 from XRPLF/remove-sidechain-devnet
remove mentions of Sidechain-Devnet
2025-10-21 14:29:05 -07:00
Rome Reginelli
18985ad7e5 Merge pull request #3356 from XRPLF/events-updates-2025-10-16
add xrpl hackathon, update image for italy hackathon
2025-10-21 14:12:27 -07:00
akcodez
09708e58de update event images 2025-10-21 08:57:03 -07:00
mDuo13
6e6247952f Revise contrib documentation per review 2025-10-20 17:56:06 -07:00
mDuo13
d7ca624269 Update translation contribution docs (fix #3239) 2025-10-20 17:53:19 -07:00
Rome Reginelli
d07d6dae6d Reword flags reminder per suggestion
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
2025-10-17 11:47:55 -07:00
Maria Shodunke
bc0c698692 Add MPT Metadata Schema section to concept docs
- Updates MPT Concept docs with metadata schema
- Updates issue-mpt-with-metdata example code with new schema changes.
2025-10-17 18:34:36 +01:00
Mayukha Vadari
878f1ba77c change URLs 2025-10-17 10:50:58 -04:00
Maria Shodunke
c83fc47941 Merge pull request #3328 from XRPLF/mptoken-authorize-transaction-sample
Add example JSON for MPTokenAuthorize transaction
2025-10-17 08:23:27 +01:00
akcodez
588da44a2e add xrpl hackathon, update image for italy hackathon 2025-10-16 09:12:14 -07:00
Maria Shodunke
f511a23ea2 Additional changes for other MPToken transactions 2025-10-16 12:08:25 +01:00
Maria Shodunke
20225b5f62 Update JSON + add Mainnet transaction 2025-10-16 11:36:10 +01:00
Mayukha Vadari
10c974249f remove mentions of Sidechain-Devnet 2025-10-15 18:03:36 -04:00
mDuo13
5d45562fc6 Add mainnet AMMCreate and OracleSet transaction examples 2025-10-15 11:40:05 -07:00
oeggert
befd012ffa Merge pull request #3350 from XRPLF/update-nft_history
Update nft_history command
2025-10-15 09:58:13 -07:00
Maria Shodunke
4481320636 Add example JSON for MPTokenAuthorize transaction 2025-10-14 17:03:15 +01:00
Oliver Eggert
f248b92d0d update nft_history command with actual responses and notes about api_version 2 2025-10-10 15:51:51 -07:00
mDuo13
b1c8a33de9 Fix display of child pages in contributor documentation 2025-10-08 17:58:10 -07:00
mDuo13
755b15383b Update contributor documentation w/ more info
- Clarify frontmatter, especially titles
- Document more markdoc tags
2025-10-08 17:53:13 -07:00
mDuo13
b2aa96e283 Fix lsfAMMNode docs 2025-10-07 12:21:26 -07:00
139 changed files with 1383 additions and 1017 deletions

View File

@@ -17,8 +17,6 @@ Para ayudar a miembros de la comunidad del XRP Ledger a interactuar con la tecno
| Mainnet | Lanzamientos estables | _El_ [XRP Ledger](/about/), un libro contable criptográfico descentralizado impulsado por una red de servidores peer-to-peer y el hogar de [XRP](../../introduction/what-is-xrp.md). |
| Testnet | Lanzamientos estables | Una red de "universo alternativo" que actua como un campo de pruebas para el software construido en el XRP Ledger, sin impactar a los usuarios del XRP Ledger de producción y sin arriesgar dinero real. El [estado de enmienda](/resources/known-amendments.md) de Testnet está destinado a reflejar de cerca el de la Mainnet, aunque pueden ocurrir ligeras variaciones en el tiempo debido a la naturaleza impredecible de los sistemas descentralizados. |
| Devnet | Lanzamientos Beta | Una vista previa de las próximas atracciones, donde cambios inestables en el software principal de XRP Ledger se pueden probar. Los desarrolladores pueden utilizar esta altnet para interactuar y aprender sobre funcionalidades nuevas planficiadas para el XRP Ledger y enmiendas que no están habilitadas en la Mainnet. |
| [Hooks V3 Testnet](https://hooks-testnet-v3.xrpl-labs.com/) | [Servidor Hooks](https://github.com/XRPL-Labs/xrpld-hooks) | Una vista previa de la funcionalidad de smart contract en la cadena utilizando [hooks](https://xrpl-hooks.readme.io/). |
| Sidechain-Devnet | Lanzamientos Beta | Una sidechain para probar funcionalidades en puentes cross-chain. Devnet se trata como la cadena de bloqueo y esta sidechain es la cadena de emisión.<br>Soporte a la librería:<br>- [xrpl.js 2.12.0](https://www.npmjs.com/package/xrpl/v/2.12.0)<br>- [xrpl-py 2.4.0](https://pypi.org/project/xrpl-py/2.4.0/)<br>**Nota**: También puedes usar la herramienta de línea de comandos [`xbridge-cli`](https://github.com/XRPLF/xbridge-cli) para configurar un puente entre cadenas en tu máquina local. |
Cada altnet tiene su propia distribución separada de XRP de prueba, que se [regala gratis](/resources/dev-tools/xrp-faucets) a partes interesadas en experimentar con el XRP Ledger y desarrollar aplicaciones e integraciones. El XRP test no tiene valor en el mundo real y se pierde cuando la red se reinicia.

View File

@@ -17,8 +17,6 @@ XRP Ledgerコミュニティのメンバーが、メインネットに影響を
| Mainnet | 安定版リリース | ピアツーピアサーバのネットワーク機能を備えた分散型の暗号台帳であり、[XRP](../../introduction/what-is-xrp.md)の土台となる[XRP Ledger](/about/)です。 |
| Testnet | 安定版リリース | XRP Ledger上に構築したソフトウェアのテスト環境として動作する「代替環境」のネットワークです。本番環境のXRP Ledgerユーザに影響を及ぼすことも、本物の通貨をリスクにさらすこともありません。Testnetの[Amendmentのステータス](/resources/known-amendments.md)は、Mainnetを厳密に反映するようになっていますが、分散型システムが持つ予測不可能な性質により、タイミングにわずかな違いが生じることがあります。 |
| Devnet | ベータ版リリース | 次期リリースのプレビューネットワークです。XRP Ledgerのコアソフトウェアへの不安定な変更がテストされます。このAltNetを使用すると、開発者はまだMainnetで有効になっていないXRPLの計画段階の新機能やAmendmentを操作したり学習したりすることができます。 |
| [Hooks V3 Testnet](https://hooks-testnet-v3.xrpl-labs.com/) | [Hooksサーバ](https://github.com/XRPL-Labs/xrpld-hooks) | [Hooks](https://xrpl-hooks.readme.io/)を使用したオンチェーン・スマートコントラクト機能のプレビューネットワークです。 |
| Sidechain-Devnet | ベータ版リリース | クロスチェーンブリッジ機能をテストするためのサイドチェーンです。<br>ライブラリのサポート:<br>- [xrpl.js 2.12.0](https://www.npmjs.com/package/xrpl/v/2.12.0)<br>- [xrpl-py 2.4.0](https://pypi.org/project/xrpl-py/2.4.0/)<br>**注記**: また、[`xbridge-cli`](https://github.com/XRPLF/xbridge-cli)コマンドラインツールを使用して、ローカルマシンにクロスチェーンブリッジをセットアップすることもできます。 |
テスト用XRPは、XRP Ledgerの実験やアプリケーションの開発、統合に興味のある人々に[無償で提供](/resources/dev-tools/xrp-faucets)されています。テスト用のXRPは実際には価値を持たず、ネットワークがリセットされると失われます。

View File

@@ -43,11 +43,6 @@ labels:
# No [ips] stanza. Use the default hubs to connect to Mainnet.
```
```{% label="Sidechain-Devnet" %}
[ips]
sidechain-net2.devnet.rippletest.net 51235
```
{% /tabs %}
2. 以前の `[ips]`があれば、コメントアウトしてください。
@@ -78,11 +73,6 @@ labels:
main
```
```{% label="Sidechain-Devnet" %}
[network_id]
262
```
{% /tabs %}
カスタムネットワークの場合、そのネットワークに接続する全員が、そのネットワークに固有の値を使用する必要があります。新しいネットワークを作成するときは、ネットワークIDを11から4,294,967,295までの整数からランダムに選択します。
@@ -121,14 +111,6 @@ labels:
ED2677ABFFD1B33AC6FBC3062B71F1E8397C1505E1C42C64D11AD1B28FF73F4734
```
```{% label="Sidechain-Devnet" %}
[validator_list_sites]
https://vlsidechain-net2.devnet.rippletest.net
[validator_list_keys]
EDA5504C7133743FADA46342229B4E9CBBE1CF9BCA19D16633574F7CBB72F79569
```
{% /tabs %}
{% admonition type="success" name="ヒント" %}プレビュー版パッケージには必要な項目があらかじめ設定されている場合がありますが、念のため確認してください。{% /admonition %}
@@ -182,13 +164,6 @@ labels:
```
{% /tab %}
{% tab label="Sidechain-Devnet" %}
```
[features]
XChainBridge
```
{% /tab %}
{% /tabs %}
{% admonition type="danger" name="警告" %}メインネットまたはテストネットに接続するときは、`[features]`を使用しないでください。他のネットワークと異なる機能を強制的に有効にすると、サーバがネットワークから分断される可能性があります。{% /admonition %}

View File

@@ -4,7 +4,7 @@ parent: ledger-entry-types.html
seo:
description: NFTを売買するオファーを作成する。
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenOffer

View File

@@ -4,7 +4,7 @@ parent: ledger-entry-types.html
seo:
description: NFTokenを記録するためのレジャー構造。
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenPage

View File

@@ -26,7 +26,6 @@ labels:
| Ripple[¹][] | Testnet (Clio) | `https://clio.altnet.rippletest.net:51234/` | `wss://clio.altnet.rippletest.net:51233/` | Clioを使用したTestnet公開サーバ |
| Ripple[¹][] | Devnet | `https://s.devnet.rippletest.net:51234/` | `wss://s.devnet.rippletest.net:51233/` | Devnet 公開サーバ |
| Ripple[¹][] | Devnet (Clio) | `https://clio.devnet.rippletest.net:51234/` | `wss://clio.devnet.rippletest.net:51233/` | Clioを使用したDevnet公開サーバ |
| Ripple[¹][] | Sidechain-Devnet | `https://sidechain-net2.devnet.rippletest.net:51234/` | `wss://sidechain-net2.devnet.rippletest.net:51233/` | クロスチェーンブリッジ機能をテストするためのサイドチェーンDevnet。Devnetはロックチェーンとして機能し、このサイドチェーンは発行チェーンとして機能します。 |
| XRPL Labs | Xahau Testnet | `https://xahau-test.net/` | `wss://xahau-test.net/` | [Hooksが有効](https://hooks.xrpl.org/)なXahau Testnet |
[ネットワーク]: ../concepts/networks-and-servers/parallel-networks.md

View File

@@ -1,8 +1,6 @@
import * as React from 'react';
import dynamicReact from '@markdoc/markdoc/dist/react'
import { useThemeHooks } from '@redocly/theme/core/hooks'
import { Link } from '@redocly/theme/components/Link/Link'
import { NotEnabled } from '@theme/markdoc/components';
import dynamicReact from '@markdoc/markdoc/dist/react';
import { Link } from '@redocly/theme/components/Link/Link';
export interface XRPLCardProps {
title: string,
@@ -32,74 +30,6 @@ export function XRPLCard(props: XRPLCardProps) {
)
}
export function LabelGrid(props: {
category: string
}) {
const { usePageSharedData } = useThemeHooks()
const data = usePageSharedData('index-page-items') as any[]
const matchingPages = data.filter((page) => {return page.category === props.category})
const labelsInCategory = []
const unlabeled = []
for (const page of matchingPages) {
if (page.labels) {
for (const label of page.labels) {
if (!labelsInCategory.includes(label)) {
labelsInCategory.push(label)
}
}
} else {
unlabeled.push(page)
}
}
labelsInCategory.sort()
return (
<div className="card-grid card-grid-2xN">
{labelsInCategory.map( (label) => (
RawNavCard(label, matchingPages.filter((page) => {return page.labels?.includes(label)})
) )
)}
{ unlabeled.length ? (
RawNavCard("Unlabeled", unlabeled)
) : ""}
</div>
)
}
function RawNavCard(label: string, pages: any[]) {
return (
<div className="card nav-card" key={label}>
<h3 className="card-title">{label}</h3>
<ul className="nav">
{pages?.map((page: any) => (
<li className="nav-item" key={page.slug}>
<Link className="nav-link" to={page.slug}>{
page.status === "not_enabled" ? (<>
<NotEnabled />
{" "}
</>) : ""
}{page.title}</Link>
{
// To add page descriptions to the cards, uncomment:
//<p className="blurb child-blurb">{page.seo?.description}</p>
}
</li>
))}
</ul>
</div>
)
}
export function NavCard(props: {
label: string
}) {
const { usePageSharedData } = useThemeHooks()
const data = usePageSharedData('index-page-items') as any[]
const matchingPages = data.filter((page) => {return page.labels?.includes(props.label)})
return RawNavCard(props.label, matchingPages)
}
export function CardGrid(props) {
const gridClass = `card-grid card-grid-${props.layout}`
return (

View File

@@ -8,7 +8,7 @@ import { idify } from '../helpers'
import { Button } from '@redocly/theme/components/Button/Button'
export { default as XRPLoader } from '../components/XRPLoader'
export { XRPLCard, CardGrid, NavCard, LabelGrid } from '../components/XRPLCard'
export { XRPLCard, CardGrid } from '../components/XRPLCard'
export { AmendmentsTable, AmendmentDisclaimer, Badge } from '../components/Amendments'
export function IndexPageItems() {
@@ -140,7 +140,7 @@ export function TxExample(props: {
} else if (props.server == 'testnet') {
use_server = "&server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F"
}
const ws_req = `req=%7B%22id%22%3A%22example_tx_lookup%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22${props.txid}%22%2C%22binary%22%3Afalse%2C%22api_version%22%3A2%7D`
const to_path = `/resources/dev-tools/websocket-api-tool?${ws_req}${use_server}`
return (

View File

@@ -182,30 +182,6 @@ export const cardGrid: Schema & { tagName: string } = {
render: 'CardGrid'
}
export const navCard: Schema & { tagName: string } = {
tagName: 'nav-card',
attributes: {
label: {
type: 'String',
required: true
}
},
render: 'NavCard',
selfClosing: true
}
export const labelGrid: Schema & { tagName: string } = {
tagName: 'label-grid',
attributes: {
category: {
type: 'String',
required: true
}
},
render: 'LabelGrid',
selfClosing: true
}
export const tryIt: Schema & { tagName: string } = {
tagName: 'try-it',
attributes: {

View File

@@ -10,26 +10,26 @@ const { wallet } = await client.fundWallet()
// Define metadata as JSON
const mpt_metadata = {
ticker: 'TBILL',
name: 'T-Bill Yield Token',
desc: 'A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.',
icon: 'https://example.org/tbill-icon.png',
asset_class: 'rwa',
asset_subclass: 'treasury',
issuer_name: 'Example Yield Co.',
urls: [
t: 'TBILL',
n: 'T-Bill Yield Token',
d: 'A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.',
i: 'https://example.org/tbill-icon.png',
ac: 'rwa',
as: 'treasury',
in: 'Example Yield Co.',
us: [
{
url: 'https://exampleyield.co/tbill',
type: 'website',
title: 'Product Page'
u: 'https://exampleyield.co/tbill',
c: 'website',
t: 'Product Page'
},
{
url: 'https://exampleyield.co/docs',
type: 'docs',
title: 'Yield Token Docs'
u: 'https://exampleyield.co/docs',
c: 'docs',
t: 'Yield Token Docs'
}
],
additional_info: {
ai: {
interest_rate: '5.00%',
interest_type: 'variable',
yield_source: 'U.S. Treasury Bills',

View File

@@ -12,26 +12,26 @@ wallet = generate_faucet_wallet(client, debug=True)
# Define metadata as JSON
mpt_metadata = {
"ticker": "TBILL",
"name": "T-Bill Yield Token",
"desc": "A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.",
"icon": "https://example.org/tbill-icon.png",
"asset_class": "rwa",
"asset_subclass": "treasury",
"issuer_name": "Example Yield Co.",
"urls": [
"t": "TBILL",
"n": "T-Bill Yield Token",
"d": "A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.",
"i": "example.org/tbill-icon.png",
"ac": "rwa",
"as": "treasury",
"in": "Example Yield Co.",
"us": [
{
"url": "https://exampleyield.co/tbill",
"type": "website",
"title": "Product Page"
"u": "exampleyield.co/tbill",
"c": "website",
"t": "Product Page"
},
{
"url": "https://exampleyield.co/docs",
"type": "docs",
"title": "Yield Token Docs"
"u": "exampleyield.co/docs",
"c": "docs",
"t": "Yield Token Docs"
}
],
"additional_info": {
"ai": {
"interest_rate": "5.00%",
"interest_type": "variable",
"yield_source": "U.S. Treasury Bills",

View File

@@ -1270,7 +1270,7 @@ const events = [
link: "https://luma.com/llwjrmcx",
location: "Rome, Italy",
date: "November 07, 2025",
image: hackathon,
image: italyHackathon,
end_date: "November 08, 2025",
},
{
@@ -1306,6 +1306,17 @@ const events = [
date: "December 10, 2025",
end_date: "December 10, 2025",
},
{
name: "XRPL Hackathon @ Blockchain Kaigi 2025",
description:
"This is a 3-week online hackathon culminating in demos and an awards ceremony to be held in conjunction with Blockchain Kaigi 2025 in Mumbai, India.",
type: "hackathon",
link: "https://luma.com/ypj8ecj0",
location: "Online (with demos at IIT Bombay)",
date: "Nov 14 - Dec 06, 2025",
image: require("../static/img/events/hackathon-kaigi.png"),
end_date: "December 06, 2025",
},
];

View File

@@ -390,10 +390,22 @@ const events = [
link: "https://xrpl.vegahacks.xyz/",
location: "Virtual",
date: "October 01 - November 14, 2025",
image: hackathon,
image: italyHackathon,
end_date: "November 14, 2025",
start_date: "October 01, 2025",
},
{
name: "XRPL Hackathon @ Blockchain Kaigi 2025",
description:
"This is a 3-week online hackathon culminating in demos and an awards ceremony to be held in conjunction with Blockchain Kaigi 2025 in Mumbai, India.",
type: "hackathon",
link: "https://luma.com/ypj8ecj0",
location: "Online (with demos at IIT Bombay)",
date: "November 14 - December 06, 2025",
image: require("../static/img/events/hackathon-kaigi.png"),
start_date: "November 14, 2025",
end_date: "December 06, 2025",
},
];

View File

@@ -1,10 +1,8 @@
---
html: addresses.html
parent: accounts.html
seo:
description: Addresses uniquely identify XRP Ledger accounts, using base58 format.
labels:
- Accounts
- Accounts
---
# Addresses
@@ -24,16 +22,16 @@ Some addresses have special meaning, or historical uses, in the XRP Ledger. In m
|-------------------------------|------|---------|-------------|
| `rrrrrrrrrrrrrrrrrrrrrhoLvTp` | ACCOUNT\_ZERO | An address that is the XRP Ledger's [base58][] encoding of the value `0`. In peer-to-peer communications, `rippled` uses this address as the issuer for XRP. | Yes |
| `rrrrrrrrrrrrrrrrrrrrBZbvji` | ACCOUNT\_ONE | An address that is the XRP Ledger's [base58][] encoding of the value `1`. In the ledger, [RippleState entries](../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md) use this address as a placeholder for the issuer of a trust line balance. | Yes |
| `rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh` | The genesis account | When `rippled` starts a new genesis ledger from scratch (for example, in stand-alone mode), this account holds all the XRP. This address is generated from the seed value `masterpassphrase` which is [hard-coded](https://github.com/XRPLF/rippled/blob/94ed5b3a53077d815ad0dd65d490c8d37a147361/src/ripple/app/ledger/Ledger.cpp#L184). | No |
| `rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh` | The genesis account | When `rippled` starts a new genesis ledger from scratch (for example, in stand-alone mode), this account holds all the XRP. This address is generated from the seed value `masterpassphrase` which is [hard-coded](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/xrpld/app/ledger/Ledger.cpp#L184). | No |
| `rrrrrrrrrrrrrrrrrNAMEtxvNvQ` | Ripple Name reservation black-hole | In the past, Ripple asked users to send XRP to this account to reserve Ripple Names.| Yes |
| `rrrrrrrrrrrrrrrrrrrn5RM1rHd` | NaN Address | Previous versions of [ripple-lib](https://github.com/XRPLF/xrpl.js) generated this address when encoding the value [NaN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN) using the XRP Ledger's [base58][] string encoding format. | Yes |
| `rrrrrrrrrrrrrrrrrrrn5RM1rHd` | NaN Address | Old JavaScript client libraries generated this address when encoding the value [NaN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN) using the XRP Ledger's [base58][] string encoding format. | Yes |
## Address Encoding
{% admonition type="success" name="Tip" %}These technical details are only relevant for people building low-level library software for XRP Ledger compatibility!{% /admonition %}
[[Source]](https://github.com/XRPLF/rippled/blob/35fa20a110e3d43ffc1e9e664fc9017b6f2747ae/src/ripple/protocol/impl/AccountID.cpp#L109-L140 "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/libxrpl/protocol/AccountID.cpp#L133-L175 "Source")
XRP Ledger addresses are encoded using [base58][] with the _dictionary_ `rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz`. Since the XRP Ledger encodes several types of keys with base58, it prefixes the encoded data with a one-byte "type prefix" (also called a "version prefix") to distinguish them. The type prefix causes addresses to usually start with different letters in base58 format.

View File

@@ -154,14 +154,14 @@ The process of deriving a key pair depends on the signing algorithm. In all case
The key derivation processes described here are implemented in multiple places and programming languages:
- In C++ in the `rippled` code base:
- [Seed definition](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/Seed.h)
- [General & Ed25519 key derivation](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/impl/SecretKey.cpp)
- [secp256k1 key derivation](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/impl/SecretKey.cpp)
- [Seed definition](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/Seed.cpp)
- [General & Ed25519 key derivation](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/SecretKey.cpp)
- [secp256k1 key derivation](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/SecretKey.cpp)
- In Python 3 in {% repo-link path="_code-samples/key-derivation/py/key_derivation.py" %}this repository's code samples section{% /repo-link %}.
- In JavaScript in the [`ripple-keypairs`](https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-keypairs) package.
### Ed25519 Key Derivation
[[Source]](https://github.com/XRPLF/rippled/blob/fc7ecd672a3b9748bfea52ce65996e324553c05f/src/ripple/protocol/impl/SecretKey.cpp#L203 "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/libxrpl/protocol/SecretKey.cpp#L311-L317 "Source")
[{% inline-svg file="/docs/img/key-derivation-ed25519.svg" /%}](/docs/img/key-derivation-ed25519.svg "Passphrase → Seed → Secret Key → Prefix + Public Key")
@@ -182,7 +182,7 @@ The key derivation processes described here are implemented in multiple places a
Validator ephemeral keys cannot be Ed25519.
### secp256k1 Key Derivation
[[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/impl/SecretKey.cpp "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/SecretKey.cpp "Source")
[{% inline-svg file="/docs/img/key-derivation-secp256k1.svg" /%}](/docs/img/key-derivation-secp256k1.svg "Passphrase → Seed → Root Key Pair → Intermediate Key Pair → Master Key Pair")
@@ -201,7 +201,7 @@ The steps to derive the XRP Ledger's secp256k1 account key pair from a seed valu
2. Calculate the [SHA-512Half][] of the concatenated (seed+root sequence) value.
3. If the result is not a valid secp256k1 secret key, increment the root sequence by 1 and start over. [[Source]](https://github.com/XRPLF/rippled/blob/fc7ecd672a3b9748bfea52ce65996e324553c05f/src/ripple/crypto/impl/GenerateDeterministicKey.cpp#L103 "Source")
3. If the result is not a valid secp256k1 secret key, increment the root sequence by 1 and start over. [[Source]](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/libxrpl/protocol/SecretKey.cpp#L103-L114 "Source")
A valid secp256k1 key must not be zero, and it must be numerically less than the _secp256k1 group order_. The secp256k1 group order is the constant value `0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141`.

View File

@@ -107,7 +107,7 @@ When the consensus process completes, each server independently computes a new l
2. Place the agreed-upon transaction set in _canonical order_ so that every server processes them the same way.
[Canonical order](https://github.com/XRPLF/rippled/blob/8429dd67e60ba360da591bfa905b58a35638fda1/src/ripple/app/misc/CanonicalTXSet.cpp#L25-L36) is not the order the transactions were received, because servers may receive the same transactions in different order. To prevent participants from competing over transaction ordering, canonical order is hard to manipulate.
[Canonical order](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/misc/CanonicalTXSet.cpp) is not the order the transactions were received, because servers may receive the same transactions in different order. To prevent participants from competing over transaction ordering, canonical order is hard to manipulate.
3. Process each transaction according to its instructions, in order. Update the ledger's state data accordingly.

View File

@@ -1,11 +1,9 @@
---
html: invariant-checking.html
parent: consensus.html
seo:
description: Understand what invariant checking is, why it exists, how it works, and what invariant checks are active.
labels:
- Blockchain
- Security
- Blockchain
- Security
---
# Invariant Checking
@@ -29,49 +27,25 @@ The processing of incorrect transaction would undermine the value of trust in th
## How it Works
The invariant checker is a second layer of code that runs automatically in real-time after each transaction. Before the transaction's results are committed to the ledger, the invariant checker examines those changes for correctness. If the transaction's results would break one of the XRP Ledger's strict rules, the invariant checker rejects the transaction. Transactions that are rejected this way have the result code `tecINVARIANT_FAILED` and are included in the ledger with no effects.
The invariant checker is a second layer of code that runs automatically in real-time after each transaction. Before the transaction's results are committed to the ledger, the invariant checker examines those changes for correctness. If the transaction's results would break one of the XRP Ledger's strict rules, the invariant checker rejects the transaction. Transactions that are rejected this way have the [result code](../../references/protocol/transactions/transaction-results/index.md) `tecINVARIANT_FAILED` and are included in the ledger with no effects.
To include the transaction in the ledger with a `tec`-class code, some minimal processing is necessary. If this minimal processing still breaks an invariant, the transaction fails with the code `tefINVARIANT_FAILED` instead, and is not included in the ledger at all.
## Active Invariants
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/InvariantCheck.h "Source")
The XRP Ledger checks all the following invariants on each transaction:
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L92 "Source")
- [Transaction Fee Check](#transaction-fee-check)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L118 "Source")
- [XRP Not Created](#xrp-not-created)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L146 "Source")
- [Account Roots Not Deleted](#account-roots-not-deleted)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L173 "Source")
- [XRP Balance Checks](#xrp-balance-checks)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L197 "Source")
- [Ledger Entry Types Match](#ledger-entry-types-match)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L224 "Source")
- [No XRP Trust Lines](#no-xrp-trust-lines)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L251 "Source")
- [No Bad Offers](#no-bad-offers)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L275 "Source")
- [No Zero Escrow](#no-zero-escrow)
[[Source]](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h#L300 "Source")
- [Valid New Account Root](#valid-new-account-root)
@@ -97,7 +71,7 @@ The XRP Ledger checks all the following invariants on each transaction:
### XRP Balance Checks
- **Invariant Condition(s):**
- An account's XRP balance must be of type XRP, and it cannot be less than 0 or more than 100 billion XRP exactly.
- An account's XRP balance must be of type XRP, and it cannot be less than 0 or more than [100 billion XRP exactly](https://github.com/XRPLF/rippled/blob/a7792ebcae63db64e9ae3d7704576252837c2512/include/xrpl/protocol/SystemParameters.h#L44-L51).
### Ledger Entry Types Match
@@ -155,18 +129,12 @@ The XRP Ledger checks all the following invariants on each transaction:
## See Also
- **Blog:**
- [Protecting the Ledger: Invariant Checking](https://xrpl.org/blog/2017/invariant-checking.html)
- [Protecting the Ledger: Invariant Checking](/blog/2017/invariant-checking.md)
- **Repository:**
- [Invariant Check.h](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.h)
- [Invariant Check.cpp](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/app/tx/impl/InvariantCheck.cpp)
- [System Parameters](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/SystemParameters.h#L43)
- [XRP Amount](https://github.com/XRPLF/rippled/blob/develop/src/ripple/basics/XRPAmount.h#L244)
- [Ledger Formats](https://github.com/XRPLF/rippled/blob/023f5704d07d09e70091f38a0d4e5df213a3144b/src/ripple/protocol/LedgerFormats.h#L36-L94)
- [`InvariantCheck.h`](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/InvariantCheck.h)
- [`InvariantCheck.cpp`](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/InvariantCheck.cpp)
- [`XRPAmount.h`](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/XRPAmount.h)
- **Other:**
- [Authorized Trust Lines](../tokens/fungible-tokens/authorized-trust-lines.md)
- [Calculating Balance Changes for a Transaction](https://xrpl.org/blog/2015/calculating-balance-changes-for-a-transaction.html#calculating-balance-changes-for-a-transaction)
{% raw-partial file="/docs/_snippets/common-links.md" /%}

View File

@@ -1,11 +1,9 @@
---
html: peer-protocol.html
parent: networks-and-servers.html
seo:
description: The peer protocol specifies the language rippled servers speak to each other.
labels:
- Core Server
- Blockchain
- Core Server
- Blockchain
---
# Peer Protocol
@@ -18,11 +16,11 @@ The peer protocol is the main mode of communication between servers in the XRP L
- Requesting ledger data from historical ledgers, or providing that data.
- Proposing a set of transactions for consensus, or sharing the calculated outcome of applying a consensus transaction set.
To set up a peer-to-peer connection, one server connects to another using HTTPS and requests an [HTTP upgrade](https://tools.ietf.org/html/rfc7230#section-6.7) to switch to the `XRPL/2.0` protocol (formerly `RTXP/1.2`). (For more information, see the [Overlay Network](https://github.com/XRPLF/rippled/blob/96bbabbd2ece106779bb544aa0e4ce174e99fdf6/src/ripple/overlay/README.md#handshake) article in the [`rippled` repository](https://github.com/ripple/rippled).)
To set up a peer-to-peer connection, one server connects to another using HTTPS and requests an [HTTP upgrade](https://tools.ietf.org/html/rfc7230#section-6.7) to switch to the `XRPL/2.0` protocol (formerly `RTXP/1.2`). For more information, see the source code's [Overlay Network](https://github.com/XRPLF/rippled/blob/master/src/xrpld/overlay/README.md#handshake) article.
## Peer Discovery
The XRP Ledger uses a "gossip" protocol to help find servers find others to connect to in the XRP Ledger network. Whenever a server starts up, it reconnects to any other peers it previously connected to. As a fallback, it uses the [hardcoded public hubs](https://github.com/XRPLF/rippled/blob/fa57859477441b60914e6239382c6fba286a0c26/src/ripple/overlay/impl/OverlayImpl.cpp#L518-L525). After a server successfully connects to a peer, it asks that peer for the contact information (generally, IP address and port) of other XRP Ledger servers that may also be seeking peers. The server can then connect to those servers, and ask them for the contact information of yet more XRP Ledger servers to peer with. Through this process, the server makes enough peer connections that it can remain reliably connected to the rest of the network even if it loses a connection to any single peer.
The XRP Ledger uses a "gossip" protocol to help find servers find others to connect to in the XRP Ledger network. Whenever a server starts up, it reconnects to any other peers it previously connected to. As a fallback, it uses the [hardcoded public hubs](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/xrpld/overlay/detail/OverlayImpl.cpp#L495-L508). After a server successfully connects to a peer, it asks that peer for the contact information (generally, IP address and port) of other XRP Ledger servers that may also be seeking peers. The server can then connect to those servers, and ask them for the contact information of yet more XRP Ledger servers to peer with. Through this process, the server makes enough peer connections that it can remain reliably connected to the rest of the network even if it loses a connection to any single peer.
Typically, a server needs to connect to a public hub only once, for a short amount of time, to find other peers. After doing so, the server may or may not remain connected to the hub, depending on how stable its network connection is, how busy the hub is, and how many other high-quality peers the server finds. The server saves the addresses of these other peers so it can try reconnecting directly to those peers later, after a network outage or a restart.

View File

@@ -31,16 +31,10 @@ LP tokens enable liquidity providers to:
An AMM holds two different assets: at most one of these can be XRP, and one or both of them can be [tokens](../index.md).
For any given pair of assets, there can be up to one AMM in the ledger. Anyone can create the AMM for an asset pair if it doesn't exist, or deposit to an AMM if it already exists.
When you want to trade in the decentralized exchange, your [Offers](offers.md) and [Cross-Currency Payments](../../payment-types/cross-currency-payments.md) can automatically use AMMs to complete the trade. A single transaction might execute by matching Offers, AMMs, or a mix of both, depending on what's cheaper.
When you want to trade in the decentralized exchange, your [offers](offers.md) and [cross-currency payments](../../payment-types/cross-currency-payments.md) can automatically use AMMs to complete the trade. A single transaction might execute by matching offers, AMMs, or a mix of both, depending on what's cheaper. You can [read a transaction's metadata](../../transactions/finality-of-results/look-up-transaction-results.md) to see what liquidity it consumed.
![1 Transaction using offers, AMMs, or both.](/docs/img/cpt-amm-or-offer.png)
{% admonition type="info" name="Note" %}
You can determine if a `Payment` or `OfferCreate` transaction interacted with an AMM by checking for a [`RippleState`](../../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md) ledger entry in the transaction metadata. A `Flags` value of `16777216` indicates AMM liquidity was consumed.
{% /admonition %}
An AMM sets its exchange rate based on the balance of assets in the pool. When you trade against an AMM, the exchange rate adjusts based on how much your trade shifts the balance of assets the AMM holds. As its supply of one asset goes down, the price of that asset goes up; as its supply of an asset goes up, the price of that asset goes down.
![As supply increases, prices drop, and vice-versa.](/docs/img/cpt-amm-balance.png)

View File

@@ -85,7 +85,7 @@ Trust line limits protect you from receiving more of a token as payment than you
Existing Offers are grouped by exchange rate, which is measured as the ratio between `TakerGets` and `TakerPays`. Offers with a higher exchange rate are taken preferentially. (That is, the person accepting the offer receives as much as possible for the amount of currency they pay out.) Offers with the same exchange rate are taken on the basis of which offer was placed first.
When Offers execute in the same ledger block, the order in which they execute is determined by the [canonical order](https://github.com/XRPLF/rippled/blob/release/src/ripple/app/misc/CanonicalTXSet.cpp "Source code: Transaction ordering") in which the transactions were [applied to the ledger](https://github.com/XRPLF/rippled/blob/5425a90f160711e46b2c1f1c93d68e5941e4bfb6/src/ripple/app/consensus/LedgerConsensus.cpp#L1435-L1538 "Source code: Applying transactions"). This behavior is designed to be deterministic, efficient, and hard to game.
When Offers execute in the same ledger block, the order in which they execute is determined by the [canonical order](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/misc/CanonicalTXSet.cpp "Source code: Transaction ordering") in which transactions were applied to the ledger. Transactions that fail initially can be pushed back and retried at the end of the ledger. This behavior is designed to be deterministic, efficient, and hard to game.
## Offer Expiration

View File

@@ -45,6 +45,94 @@ Every MPT issuance has a set of key properties defined in the ledger as an [MPTo
After the MPT is issued, the on-chain data cannot be changed. However, the proposed [XLS-94: Dynamic MPT standard](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0094-dynamic-MPT) {% not-enabled /%} would allow fields to be marked as mutable during creation, so that those fields can be changed later.
#### Metadata Schema
To fit within the 1024-byte limit, MPT metadata must use compressed JSON keys. The following table describes these keys and their corresponding fields:
| Field Name | Key | Type | Required? | Description |
|:--------------- |:---- |:---------------- |---------- |-------------|
| ticker | `t` | String | Yes | The ticker symbol used to represent the token. Must be uppercase letters (A-Z) and digits (0-9) only. A maximum of 6 characters is recommended. |
| name | `n` | String | Yes | The display name of the token. Any UTF-8 string is permitted. |
| desc | `d` | String | No | A short description of the token. Any UTF-8 string is permitted. |
| icon | `i` | String | Yes | The URI to the token icon. Can be `hostname/path` (HTTPS is assumed), or full URI for other protocols. |
| asset_class | `ac` | String | Yes | Categorizes tokens by their primary purpose and backing. See [Asset Class](#asset-class) for more details. |
| asset_subclass | `as` | String | No | An optional subcategory that is only required if the `asset_class` is `rwa`. See [Asset Subclass](#asset-subclass) for more details. |
| issuer_name | `in` | String | Yes | Name of the entity issuing the token. Any UTF-8 string is permitted. |
| uris | `us` | Array | No | The list of related URIs such as website, documentation, and social media. See [URIs](#uris) for more details.|
| additional_info | `ai` | Object or String | No | Freeform field for key token details like interest rate, maturity date, term, or other relevant info. Any valid JSON object or UTF-8 string is permitted. |
##### Asset Class
The `asset_class` field categorizes tokens by their primary purpose and backing. These categories help applications understand the nature of the token and its intended use case.
| Category | Definition |
|----------|------------|
| `rwa` | Tokens representing real-world assets (RWAs), which derive value from legally enforceable claims on physical or off-chain financial assets. |
| `memes` | Community-driven tokens without intrinsic backing or utility claims, primarily driven by internet culture or speculation. |
| `wrapped` | Tokens representing assets from other blockchains, typically backed 1:1 by bridges or custodians. |
| `gaming` | Tokens used in games or virtual worlds, often representing in-game currency, assets, or rewards. |
| `defi` | Tokens native to or used within DeFi protocols, including governance tokens, DEX tokens, and lending assets. |
| `other` | Tokens that do not clearly fit into the defined categories. This may include experimental, test, or tokens with unique use cases not covered elsewhere. |
##### Asset Subclass
When `asset_class` is set to `rwa`, an `asset_subclass` can be specified to provide more granular categorization. This describes what type of real-world asset backs the token and what legal or regulatory framework might apply.
| Subclass | Definition |
|----------|------------|
| `stablecoin` | Tokens pegged to a stable value, typically fiat currencies like USD, which are backed by reserves like cash, treasuries, or crypto collateral. |
| `commodity` | Tokens that represent physical commodities like gold, silver, or oil, often redeemable or legally linked to off-chain reserves. |
| `real_estate` | Tokens representing ownership or claims on real estate, including fractionalized property shares or REIT-like instruments. |
| `private_credit` | Tokens representing debt obligations from private entities, such as loans, invoices, or receivables. |
| `equity` | Tokens representing ownership shares in companies, similar to traditional stock or equity instruments. |
| `treasury` | Tokens backed by government debt instruments, such as U.S. Treasury bills or bonds. |
| `other` | Tokens that do not fit into the predefined categories, including experimental, hybrid, or emerging real-world asset types. |
##### URIs
The `us` array contains a list of URI objects, each with a URI link, category, and human-readable title.
| Field Name | Key | Type | Required? | Description |
|:---------- |:--- |:------ |:--------- |:-------------|
| uri | `u` | String | Yes |`hostname/path` or full URI link to the related resource. |
| category | `c` | String | Yes | The category of the link provided. Allowed values are: `website`, `social`, `docs`, `other`. |
| title | `t` | String | Yes | Human-readable label for the link. |
#### Example JSON Metadata
The following example shows metadata for a treasury-backed token.
```json
{
"t": "TBILL",
"n": "T-Bill Yield Token",
"d": "A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.",
"i": "example.org/tbill-icon.png",
"ac": "rwa",
"as": "treasury",
"in": "Example Yield Co.",
"us": [
{
"u": "exampleyield.co/tbill",
"c": "website",
"t": "Product Page"
},
{
"u": "exampleyield.co/docs",
"c": "docs",
"t": "Yield Token Docs"
}
],
"ai": {
"interest_rate": "5.00%",
"interest_type": "variable",
"yield_source": "U.S. Treasury Bills",
"maturity_date": "2045-06-30",
"cusip": "912796RX0"
}
}
```
### Transferability Controls
MPTs can be configured with different levels of transferability controls by adjusting the following flags:

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: You can assign another account to mint NFTs in your stead.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Authorizing Another Minter

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Minting NFTs in batches.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Batch Minting

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: You can mint NFTs as collections using the NFT Taxon field.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Minting NFTs into Collections

View File

@@ -2,7 +2,7 @@
seo:
description: Create NFTs with the option of changing the URI to update its referenced data object.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Dynamic Non-Fungible Tokens (dNFTs)

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Use a new account to mint a fixed number of NFTs, then black hole the account.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Guaranteeing a Fixed Supply of NFTs

View File

@@ -4,7 +4,7 @@ parent: tokens.html
seo:
description: Introduction to XRPL NFTs.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Non-Fungible Tokens

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Specialized APIs let you access useful NFT metadata.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFT APIs

View File

@@ -2,7 +2,7 @@
seo:
description: Create NFTs that can't be traded among users.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Non-Transferable Tokens

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Storage options for the payload of your NFT.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFT Payload Storage

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Understand reserve requirements for minting and holding NFTs.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFT Reserve Requirements

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: You can assign another account to mint NFTs in your stead.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Running an NFT Auction

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Trading NFTs in direct or brokered mode.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Trading NFTs

View File

@@ -227,15 +227,15 @@ If the payment contains a `CreatedNode` with `"LedgerEntryType": "AccountRoot"`,
#### Token Payments
Payments involving tokens are a bit more complicated.
Payments involving [trust line tokens](../../tokens/fungible-tokens/trust-line-tokens.md) are a bit more complicated.
All changes in token balances are reflected in [RippleState objects](../../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md), which represent [trust lines](../../tokens/fungible-tokens/index.md). An increase to one party's balance on a trust line is considered to decrease the counterparty's balance by equal amount; in the metadata, this is only recorded as a single change to the shared `Balance` for the RippleState object. Whether this change is recorded as an "increase" or "decrease" depends on which account has the numerically higher address.
All changes to trust line token balances are reflected in [RippleState entries](../../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md), which represent [trust lines](../../tokens/fungible-tokens/index.md). An increase to one party's balance on a trust line is considered to decrease the counterparty's balance by equal amount; transaction metadata records only a single net change to the shared `Balance` of a `RippleState` entry. Whether this change is recorded as an "increase" or "decrease" depends on which account has the numerically higher address.
A single payment may go across a long [path](../../tokens/fungible-tokens/paths.md) consisting of several trust lines and order books. The process of changing the balances on several trust lines to connect parties indirectly is called [rippling](../../tokens/fungible-tokens/rippling.md). Depending on the `issuer` specified in the transaction's `Amount` field, it is also possible that the amount delivered may be split between several trust lines (`RippleState` accounts) connected to the destination account.
A single payment may go across a long [path](../../tokens/fungible-tokens/paths.md) consisting of several trust lines and order books. The process of changing the balances on several trust lines to connect parties indirectly is called [rippling](../../tokens/fungible-tokens/rippling.md). Depending on the `issuer` specified in the transaction's `Amount` field, it is also possible that the amount delivered may be split between several trust lines (separate RippleState entries) connected to the destination account.
{% admonition type="success" name="Tip" %}The order that modified objects are presented in the metadata does not necessarily match the order those objects were visited while processing a payment. To better understand payment execution, it may help to reorder `AffectedNodes` members to reconstruct the paths the funds took through the ledger.{% /admonition %}
Cross-currency payments consume [Offers](../../../references/protocol/ledger-data/ledger-entry-types/offer.md) in part or entirely to change between different currency codes and issuers. If a transaction shows `DeletedNode` objects for `Offer` types, that can indicate an Offer that was fully consumed, or an Offer that was found to be [expired or unfunded](../../tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer) at the time of processing. If a transaction shows a `ModifiedNode` of type `Offer`, that indicates an Offer that was partially consumed.
Cross-currency payments use [offers](../../tokens/decentralized-exchange/offers.md) and [AMMs](../../tokens/decentralized-exchange/automated-market-makers.md) to convert between different currency codes and issuers. Offers can be partially or fully consumed. If a transaction shows `DeletedNode` objects for `Offer` types, that can indicate an offer that was fully consumed, or an offer that was found to be [expired or unfunded](../../tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer) at the time of processing. If a transaction shows a `ModifiedNode` of type `Offer`, that indicates an offer that was partially consumed.
The [`QualityIn` and `QualityOut` settings of trust lines](../../../references/protocol/transactions/types/trustset.md) can affect how one side of a trust line values the token, so that the numeric change in balances is different from how the sender values that token. The `delivered_amount` shows how much was delivered as valued by the recipient.
@@ -243,9 +243,17 @@ If the amount to be sent or received is outside of the [token precision](../../.
Depending on the length of the [paths](../../tokens/fungible-tokens/paths.md), the metadata for cross-currency payments can be _long_. For example, [transaction 8C55AFC2A2AA42B5CE624AEECDB3ACFDD1E5379D4E5BF74A8460C5E97EF8706B](https://xrpcharts.ripple.com/#/transactions/8C55AFC2A2AA42B5CE624AEECDB3ACFDD1E5379D4E5BF74A8460C5E97EF8706B) delivered 2.788 GCB issued by `rHaaans...`, spending XRP but passing through USD from 2 issuers, paying XRP to 2 accounts, removing an unfunded offer from `r9ZoLsJ...` to trade EUR for ETH, plus bookkeeping for a total of 17 different ledger objects modified. <!-- SPELLING_IGNORE: gcb -->
#### Using AMM Liquidity
You can tell if an AMM was involved in a transaction by looking for [RippleState entries](../../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md) that belong to an AMM. Check the `Flags` value of each `RippleState` entry in the `AffectedNodes` array; if the [`lsfAMMNode` flag](../../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md#ripplestate-flags) is enabled, then that trust line is connected to an AMM. Flags are combined using bitwise operations. To check if `lsfAMMNode` is enabled, use a bitwise-AND operator, like the following pseudo-code:
```
isEnabled = RippleState.Flags & lsfAMMNode
```
### Offers
An [OfferCreate transaction][] may or may not create an object in the ledger, depending on how much was matched and whether the transaction used flags such as `tfImmediateOrCancel`. Look for a `CreatedNode` entry with `"LedgerEntryType": "Offer"` to see if the transaction added a new Offer to the ledger's order books. For example:
An [OfferCreate transaction][] may or may not create an object in the ledger, depending on how much was matched and whether the transaction used flags such as `tfImmediateOrCancel`. Look for a `CreatedNode` entry with `"LedgerEntryType": "Offer"` to see if the transaction added a new Offer entry to the ledger's order books. For example:
```json
{
@@ -268,11 +276,11 @@ An [OfferCreate transaction][] may or may not create an object in the ledger, de
}
```
A `ModifiedNode` of type `Offer` indicates an Offer that was matched and partially consumed. A single transaction can consume a large number of Offers. An Offer to trade two tokens might also consume Offers to trade XRP because of [auto-bridging](../../tokens/decentralized-exchange/autobridging.md). All or part of an exchange can be auto-bridged.
A `ModifiedNode` of type `Offer` indicates an offer that was matched and partially consumed. A single transaction can consume a large number of offers. An offer to trade two tokens might also consume offers to trade XRP because of [auto-bridging](../../tokens/decentralized-exchange/autobridging.md). All or part of an exchange can be auto-bridged. Offers can also use AMMs to convert currency; you can recognize when this happens by [checking for a `RippleState` entry with the `lsfAMMNode` flag](#using-amm-liquidity) in the `AffectedNodes` array.
A `DeletedNode` of type `Offer` can indicate a matching Offer that was fully consumed, an Offer that was found to be [expired or unfunded](../../tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer) at the time of processing, or an Offer that was canceled as part of placing a new Offer. You can recognize a canceled Offer because the `Account` that placed it is the sender of the transaction that deleted it.
A `DeletedNode` of type `Offer` can indicate a matching offer that was fully consumed, an offer that was found to be [expired or unfunded](../../tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer) at the time of processing, or an offer that was canceled as part of placing a new offer. You can recognize a canceled offer because the `Account` that placed it is the sender of the transaction that deleted it.
Example of a deleted Offer:
Example of a deleted offer:
```json
{
@@ -300,11 +308,11 @@ Example of a deleted Offer:
}
```
Offers can create, delete, and modify both types of [DirectoryNode objects](../../../references/protocol/ledger-data/ledger-entry-types/directorynode.md), to keep track of who placed which Offers and which Offers are available at which exchange rates. Generally, users don't need to pay close attention to this bookkeeping.
Offers can create, delete, and modify [DirectoryNode entries](../../../references/protocol/ledger-data/ledger-entry-types/directorynode.md), both to keep track of who placed which offers and which offers are available at which exchange rates. Generally, users don't need to pay close attention to this bookkeeping.
An [OfferCancel transaction][] may have the code `tesSUCCESS` even if there was no Offer to delete. Look for a `DeletedNode` of type `Offer` to confirm that the transaction actually deleted an Offer. If not, the Offer may already have been removed by a previous transaction, or the OfferCancel transaction may have used the wrong sequence number in the `OfferSequence` field.
An [OfferCancel transaction][] may have the code `tesSUCCESS` even if there was no offer to delete. Look for a `DeletedNode` of type `Offer` to confirm that the transaction actually deleted an offer. If not, the offer may already have been removed by a previous transaction, or the OfferCancel transaction may have used the wrong sequence number in the `OfferSequence` field.
If an OfferCreate transaction shows a `CreatedNode` of type `RippleState`, that indicates that [the Offer created a trust line](../../tokens/decentralized-exchange/offers.md#offers-and-trust) to hold a token received in the trade.
If an OfferCreate transaction shows a `CreatedNode` of type `RippleState`, that indicates that [the offer created a trust line](../../tokens/decentralized-exchange/offers.md#offers-and-trust) to hold a token received in the trade.
### Escrows

View File

@@ -64,7 +64,7 @@ For each new ledger version, the server picks a soft limit on the number of tran
The open ledger cost requirement is [proportional to the normal cost of the transaction](#fee-levels), not the absolute transaction cost. Transaction types that have a higher-than-normal requirement, such as [multi-signed transactions](../accounts/multi-signing.md) must pay more to meet the open ledger cost than transactions which have minimum transaction cost requirements.
See also: [Fee Escalation explanation in `rippled` repository](https://github.com/XRPLF/rippled/blob/release/src/ripple/app/misc/FeeEscalation.md).
See also: [Fee Escalation explanation in `rippled` repository](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/misc/FeeEscalation.md).
### Queued Transactions

View File

@@ -4,7 +4,7 @@ seo:
status: not_enabled
labels:
- Blockchain
- Sidechains
- Interoperability
---
# Cross-Chain Bridges

View File

@@ -3,7 +3,7 @@ seo:
description: An XRPL sidechain is an independent ledger with its own consensus algorithm, transaction types, and rules.
labels:
- Blockchain
- Sidechains
- Interoperability
---
# XRPL Sidechains

View File

@@ -4,16 +4,16 @@ seo:
status: not_enabled
labels:
- Blockchain
- Sidechains
- Interoperability
---
# Witness Servers
[[Source]](https://github.com/seelabs/xbridge_witness "Source")
A _witness server_ acts as a neutral witness for transactions between a locking chain and an issuing chain. It listens to the door accounts on both sides of a bridge and signs attestations that confirm a transaction occurred. They are essentially acting as an oracle to “prove” that value was locked or burned on a source account, which allows the recipient to then claim (via minting or unlocking) the equivalent funds on the destination account.
The bridge between the locking chain and the issuing chain includes the following information in its configuration:
The bridge between the locking chain and the issuing chain includes the following information in its configuration:
* Witness servers that monitor transactions on the bridge. You can choose one or more witness servers.
* Witness servers that monitor transactions on the bridge. You can choose one or more witness servers.
* Fee for witness servers for their service.
Anyone can run a witness server. However, the burden is on the participants of the issuing chain to evaluate the reliability of witness servers. If you run a witness server, you must also run a `rippled` node and sync it to the chain the witness server needs access to.
@@ -92,7 +92,7 @@ The witness server takes a JSON configuration file, specified using the `--conf`
| [`IssuingChain`](#issuingchain-and-lockingchain-fields) | Object | Yes | The parameters for interacting with the issuing chain. |
| [`LockingChain`](#issuingchain-and-lockingchain-fields) | Object | Yes | The parameters for interacting with the locking chain. |
| `RPCEndpoint` | Object | Yes | The endpoint for RPC requests to the witness server. |
| `LogFile` | String | Yes | The location of the log file. |
| `LogFile` | String | Yes | The location of the log file. |
| `LogLevel` | String | Yes | The level of logs to store in the log file. The options are `All`, `Trace`, `Debug`, `Info`, `Warning`, `Error`, `Fatal`, `Disabled`, and `None`. |
| `DBDir` | String | Yes | The location of the directory where the databases are stored. |
| `SigningKeySeed` | String | Yes | The seed that the witness server should use to sign its attestations. |

View File

@@ -43,11 +43,6 @@ Edit your `rippled.cfg` file.
# No [ips] stanza. Use the default hubs to connect to Mainnet.
```
```{% label="Sidechain-Devnet" %}
[ips]
sidechain-net2.devnet.rippletest.net 51235
```
{% /tabs %}
2. Comment out the previous `[ips]` stanza, if there is one:
@@ -77,11 +72,6 @@ Edit your `rippled.cfg` file.
main
```
```{% label="Sidechain-Devnet" %}
[network_id]
262
```
{% /tabs %}
For custom networks, everyone who connects to the network should use a value unique to that network. When creating a new network, choose a network ID at random from the integers 11 to 4,294,967,295.
@@ -120,14 +110,6 @@ Edit your `validators.txt` file. This file is located in the same folder as your
ED2677ABFFD1B33AC6FBC3062B71F1E8397C1505E1C42C64D11AD1B28FF73F4734
```
```{% label="Sidechain-Devnet" %}
[validator_list_sites]
https://vlsidechain-net2.devnet.rippletest.net
[validator_list_keys]
EDA5504C7133743FADA46342229B4E9CBBE1CF9BCA19D16633574F7CBB72F79569
```
{% /tabs %}
{% admonition type="success" name="Tip" %}Preview packages might come with the necessary stanzas pre-configured, but check them just in case.{% /admonition %}
@@ -181,13 +163,6 @@ For some test networks using experimental features, you must also forcefully ena
```
{% /tab %}
{% tab label="Sidechain-Devnet" %}
```
[features]
XChainBridge
```
{% /tab %}
{% /tabs %}
{% admonition type="danger" name="Warning" %}Do not use the `[features]` stanza when connecting to Mainnet or Testnet. Forcefully enabling different features than the rest of the network could cause your server to diverge from the network.{% /admonition %}

View File

@@ -8,7 +8,7 @@ labels:
- Core Server
---
# Online Deletion
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/misc/SHAMapStoreImp.cpp "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/misc/SHAMapStoreImp.cpp "Source")
The online deletion feature lets the `rippled` server delete the server's local copy of old ledger versions to keep disk usage from rapidly growing over time. The default config file sets online deletion to run automatically, but online deletion can also be configured to run only when prompted.

View File

@@ -18,7 +18,7 @@ rippled -a --start --conf=/path/to/rippled.cfg
For more information on the options you can use when starting `rippled` in stand-alone mode, see [Commandline Usage: Stand-Alone Mode Options](../commandline-usage.md#stand-alone-mode-options).
In a genesis ledger, the [genesis address](../../concepts/accounts/addresses.md#special-addresses) holds all 100 billion XRP. The keys of the genesis address are [hardcoded](https://github.com/XRPLF/rippled/blob/94ed5b3a53077d815ad0dd65d490c8d37a147361/src/ripple/app/ledger/Ledger.cpp#L184) as follows:
In a genesis ledger, the [genesis address](../../concepts/accounts/addresses.md#special-addresses) holds all 100 billion XRP. The keys of the genesis address are [hardcoded](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/xrpld/app/ledger/Ledger.cpp#L184) as follows:
**Address:** `rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh`

View File

@@ -1,10 +1,8 @@
---
html: understanding-log-messages.html
parent: troubleshoot-the-rippled-server.html
seo:
description: Interpret and respond to warning and error messages in the debug log.
labels:
- Core Server
- Core Server
---
# Understanding Log Messages
@@ -122,10 +120,10 @@ A large number of these messages around the same time may indicate a problem, su
The following log message indicates that a client to the server's public API has been dropped as a result of [rate limiting](../../references/http-websocket-apis/api-conventions/rate-limiting.md):
```text
Resource:WRN Consumer entry 169.55.164.21 dropped with balance 15970 at or above drop threshold 15000
Resource:WRN Consumer entry 169.55.164.21 dropped with balance 25970 at or above drop threshold 25000
```
The entry contains the IP address of the client that exceeded its rate limit, and the client's "balance", which is a score estimating the rate at which the client has been using the API. The threshold for dropping a client is [hardcoded to a score of 15000](https://github.com/XRPLF/rippled/blob/06c371544acc3b488b9d9c057cee4e51f6bef7a2/src/ripple/resource/impl/Tuning.h#L34-L35).
The entry contains the IP address of the client that exceeded its rate limit, and the client's "balance", which is a score estimating the rate at which the client has been using the API. The threshold for dropping a client is [hardcoded to a score of 25000](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/include/xrpl/resource/detail/Tuning.h#L35). {% badge href="https://xrpl.org/blog/2025/rippled-2.3.1" %}Updated in: rippled 2.3.1{% /badge %}
If you see frequent messages from the same IP address, you may want to block those IP addresses from your network to reduce the load on your server's public API. (For example, you may be able to configure your firewall to block those IP addresses.)

View File

@@ -4,7 +4,7 @@ parent: account-methods.html
seo:
description: Get a list of all NFTs for an account.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# account_nfts
[[Source]](https://github.com/xrplf/rippled/blob/master/src/ripple/rpc/handlers/AccountObjects.cpp "Source")

View File

@@ -4,7 +4,7 @@ parent: clio-methods.html
seo:
description: Retrieve the history of ownership and transfers for the specified NFT using Clio server's `nft_history` API.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# nft_history
@@ -24,7 +24,7 @@ An example of the request format:
{
"id": 1,
"command": "nft_history",
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
"nft_id": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9"
}
```
{% /tab %}
@@ -35,7 +35,7 @@ An example of the request format:
"method": "nft_history",
"params": [
{
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
"nft_id": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9"
}
]
}
@@ -48,17 +48,17 @@ An example of the request format:
The request contains the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------------|:-------------------------------|
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_index_min` | Integer | _(Optional)_ Use to specify the earliest ledger from which to include NFTs. A value of `-1` instructs the server to use the earliest validated ledger version available. |
| `ledger_index_max` | Integer | _(Optional)_ Use to specify the most recent ledger to include NFTs from. A value of `-1` instructs the server to use the most recent validated ledger version available. |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. Do not specify the `ledger_index` as `closed` or `current`; doing so forwards the request to the P2P `rippled` server and the `nft_history` API is not available on `rippled`. (See [Specifying Ledgers][]) |
| `binary` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns transactions as hex strings instead of JSON. |
| `forward` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results might not be internally ordered, but the pages are ordered overall.) |
| `limit` | UInt32 | _(Optional)_ Limit the number of NFTs to retrieve. The server is not required to honor this value. |
| `marker` | Marker | Value from a previous paginated response. Resume retrieving data where that response left off. This value is NOT stable if there is a change in the server's range of available ledgers. If you are querying the “validated” ledger, it is possible that new NFTs are created during your paging. |
| `Field` | Type | Description |
|:-------------------|:---------------------------|:------------|
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_index_min` | Integer | _(Optional)_ Use to specify the earliest ledger from which to include NFTs. A value of `-1` instructs the server to use the earliest validated ledger version available. |
| `ledger_index_max` | Integer | _(Optional)_ Use to specify the most recent ledger to include NFTs from. A value of `-1` instructs the server to use the most recent validated ledger version available. |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. Do not specify the `ledger_index` as `closed` or `current`; doing so forwards the request to the P2P `rippled` server and the `nft_history` API is not available on `rippled`. (See [Specifying Ledgers][]) |
| `binary` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns transactions as hex strings instead of JSON. |
| `forward` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results might not be internally ordered, but the pages are ordered overall.) |
| `limit` | UInt32 | _(Optional)_ Limit the number of NFTs to retrieve. The server is not required to honor this value. |
| `marker` | Marker | Value from a previous paginated response. Resume retrieving data where that response left off. This value is NOT stable if there is a change in the server's range of available ledgers. If you are querying the “validated” ledger, it is possible that new NFTs are created during your paging. |
{% admonition type="info" name="Note" %}If you do not specify a ledger version, Clio uses the latest validated ledger.{% /admonition %}
@@ -71,78 +71,221 @@ An example of a successful response:
{% tab label="WebSocket" %}
```json
{
"id": 0,
"type": "response",
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876163,
"nft_id": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"ledger_index_min": 32570,
"ledger_index_max": 99409949,
"transactions": [
{
"meta": {
"AffectedNodes": [
{
"CreatedNode": {
"LedgerEntryType": "NFTokenPage",
"LedgerIndex": "97707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFF",
"NewFields": {
"NFTokens": [
{
"NFToken": {
"NFTokenID": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469"
}
}
]
}
"DeletedNode": {
"FinalFields": {
"Flags": 2,
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"PreviousTxnID": "FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A5619",
"PreviousTxnLgrSeq": 92840801,
"RootIndex": "1C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "1C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D"
}
},
{
"ModifiedNode": {
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "587E28972F3B63D2260C0671E59593EE6C4D27AB857D1AF230F5CAA959BB3EAC",
"PreviousTxnID": "15DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A",
"PreviousTxnLgrSeq": 93800929
}
},
{
"DeletedNode": {
"FinalFields": {
"Amount": "3000000",
"Destination": "rpx9JThQ2y37FaGeeJP7PXDUVEXY3PHZSC",
"Flags": 1,
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"NFTokenOfferNode": "0",
"Owner": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"OwnerNode": "a3",
"PreviousTxnID": "FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A5619",
"PreviousTxnLgrSeq": 92840801
},
"LedgerEntryType": "NFTokenOffer",
"LedgerIndex": "6267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8"
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Balance": "999999988",
"Account": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"Balance": "270183296",
"BurnedNFTokens": 72,
"FirstNFTokenSequence": 66004341,
"Flags": 0,
"MintedNFTokens": 1,
"OwnerCount": 1,
"Sequence": 27876155
"MintedNFTokens": 111,
"OwnerCount": 1204,
"Sequence": 66025366
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24",
"LedgerIndex": "993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019",
"PreviousFields": {
"Balance": "1000000000",
"OwnerCount": 0,
"Sequence": 27876154
"Balance": "270183308",
"OwnerCount": 1205,
"Sequence": 66025365
},
"PreviousTxnID": "B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB6939",
"PreviousTxnLgrSeq": 27876154
"PreviousTxnID": "15DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A",
"PreviousTxnLgrSeq": 93800929
}
},
{
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"IndexNext": "a6",
"IndexPrevious": "a2",
"Owner": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"RootIndex": "FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD7140"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "D397E071F0DE6F26875FA9ABD92FAFC13B1CE6E6A612DD9FDB1EF4FA2D79B0B6",
"PreviousTxnID": "15DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A",
"PreviousTxnLgrSeq": 93800929
}
}
],
"TransactionIndex": 0,
"TransactionIndex": 98,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Account": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"Fee": "12",
"LastLedgerSequence": 93800952,
"NFTokenOffers": [
"6267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8"
],
"Sequence": 66025365,
"SigningPubKey": "03F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D4",
"SourceTag": 101102979,
"TransactionType": "NFTokenCancelOffer",
"TxnSignature": "30450221009897AFA16980838EAB0DD819E199E77E80879AA303DAEFF36FB970406715050402205892143D89D07CBD95CA101B2DE561465615A05E670A0A7A15209A0EFC52FE44",
"hash": "324EA92E3B2FD79B53655682045667BA7B683D5FB1051BF33BDDA982F21CB531",
"ledger_index": 93800934,
"date": 791530220
},
"validated": true
}
// ... Additional Metadata omitted for brevity
},
{
"meta": {
"AffectedNodes": [
{
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"NFTokens": [
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816B4066980521CFFD",
"URI": "697066733A2F2F516D577335764370506278664A48466351514335385534585778614536446E68376E36414457516F517154714364"
}
},
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816BABD2130521D078",
"URI": "697066733A2F2F516D50363735763661326A5379316263656D70444D355A70365638683842685677594E77737A667053417439394A"
}
}
// ... Additional NFToken entries omitted for brevity
],
"NextPageMin": "6807BF848FACD972F2F617E27003D75B2CAAC9812CAAC9818A6641830521CFE8",
"PreviousPageMin": "6807BF848FACD972F2F617E27003D75B2CAAC9812CAAC9816B4066980521CFFD"
},
"LedgerEntryType": "NFTokenPage",
"LedgerIndex": "6807BF848FACD972F2F617E27003D75B2CAAC9812CAAC98179E62DAF0521D014",
"PreviousFields": {
"NFTokens": [
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816B4066980521CFFD",
"URI": "697066733A2F2F516D577335764370506278664A48466351514335385534585778614536446E68376E36414457516F517154714364"
}
},
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816BABD2130521D078",
"URI": "697066733A2F2F516D50363735763661326A5379316263656D70444D355A70365638683842685677594E77737A667053417439394A"
}
}
// ... Additional NFToken entries omitted for brevity
]
},
"PreviousTxnID": "75036C0D3740CEBF1A45E1EAA080F434E8CE865375A962D9F809A92B79ABBBBE",
"PreviousTxnLgrSeq": 86769021
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rwVhZJLcdtioxdETLq31Ne2K97xm4zA8Jv",
"Balance": "62592375",
"BurnedNFTokens": 129,
"FirstNFTokenSequence": 86101877,
"Flags": 0,
"MintedNFTokens": 629,
"OwnerCount": 20,
"Sequence": 86102636
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "DD1EBD4FBD7B5FD90A271F416083636046FBEA37342114A0026C444F95FFE1F3",
"PreviousFields": {
"Balance": "62592387",
"MintedNFTokens": 628,
"Sequence": 86102635
},
"PreviousTxnID": "C43C70DD5921EAFEFDC2EDC43DF83FF0FE74FB796D9E3F32EA4BFAF890968876",
"PreviousTxnLgrSeq": 86774497
}
}
],
"TransactionIndex": 3,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "rwVhZJLcdtioxdETLq31Ne2K97xm4zA8Jv",
"Fee": "12",
"Flags": 8,
"LastLedgerSequence": 27876176,
"LastLedgerSequence": 86774537,
"Memos": [
{
"Memo": {
"MemoData": "43726561746564206F6E206E66742E6F6E7872702E636F6D"
}
}
],
"NFTokenTaxon": 0,
"Sequence": 27876154,
"SigningPubKey": "EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F6",
"Sequence": 86102635,
"SigningPubKey": "027A4E42790158269E1FAD03364B5A365C26D1C686DEA1A22BFE889AC0C759B2CD",
"SourceTag": 69420589,
"TransactionType": "NFTokenMint",
"TransferFee": 10000,
"TxnSignature": "EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C79802",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469",
"hash": "E0774E1B8628E397C6E88F67D4424E55E4C81324607B19318255310A6FBAA4A2",
"ledger_index": 27876158,
"date": 735167200
"TxnSignature": "3045022100B6AD2D48CFBBA1700A45853D779CEA05A4E438F0B98A6BEDB2200ABEA1D9F87902207E5879CDE873807B945344D2C872632103989097AE3660DEEAD52D84640C414D",
"URI": "697066733A2F2F516D57515A4167695A337041327065654A4D7441703663326A394151666E78706A754E62674D5A505748617A3267",
"hash": "FB9F697C4C9C7E8248BA63E7EDB4435B3CC12AF0BF426E618B184B76B7F94D28",
"ledger_index": 86774529,
"date": 764373881
},
"validated": true
}
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
},
"id": "example_nft_history",
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
@@ -157,74 +300,216 @@ An example of a successful response:
```json
{
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876163,
"nft_id": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"ledger_index_min": 32570,
"ledger_index_max": 99413196,
"transactions": [
{
"meta": {
"AffectedNodes": [
{
"CreatedNode": {
"LedgerEntryType": "NFTokenPage",
"LedgerIndex": "97707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFF",
"NewFields": {
"NFTokens": [
{
"NFToken": {
"NFTokenID": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469"
}
}
]
}
"DeletedNode": {
"FinalFields": {
"Flags": 2,
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"PreviousTxnID": "FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A5619",
"PreviousTxnLgrSeq": 92840801,
"RootIndex": "1C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "1C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D"
}
},
{
"ModifiedNode": {
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "587E28972F3B63D2260C0671E59593EE6C4D27AB857D1AF230F5CAA959BB3EAC",
"PreviousTxnID": "15DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A",
"PreviousTxnLgrSeq": 93800929
}
},
{
"DeletedNode": {
"FinalFields": {
"Amount": "3000000",
"Destination": "rpx9JThQ2y37FaGeeJP7PXDUVEXY3PHZSC",
"Flags": 1,
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"NFTokenOfferNode": "0",
"Owner": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"OwnerNode": "a3",
"PreviousTxnID": "FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A5619",
"PreviousTxnLgrSeq": 92840801
},
"LedgerEntryType": "NFTokenOffer",
"LedgerIndex": "6267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8"
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Balance": "999999988",
"Account": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"Balance": "270183296",
"BurnedNFTokens": 72,
"FirstNFTokenSequence": 66004341,
"Flags": 0,
"MintedNFTokens": 1,
"OwnerCount": 1,
"Sequence": 27876155
"MintedNFTokens": 111,
"OwnerCount": 1204,
"Sequence": 66025366
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24",
"LedgerIndex": "993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019",
"PreviousFields": {
"Balance": "1000000000",
"OwnerCount": 0,
"Sequence": 27876154
"Balance": "270183308",
"OwnerCount": 1205,
"Sequence": 66025365
},
"PreviousTxnID": "B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB6939",
"PreviousTxnLgrSeq": 27876154
"PreviousTxnID": "15DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A",
"PreviousTxnLgrSeq": 93800929
}
},
{
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"IndexNext": "a6",
"IndexPrevious": "a2",
"Owner": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"RootIndex": "FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD7140"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "D397E071F0DE6F26875FA9ABD92FAFC13B1CE6E6A612DD9FDB1EF4FA2D79B0B6",
"PreviousTxnID": "15DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A",
"PreviousTxnLgrSeq": 93800929
}
}
],
"TransactionIndex": 0,
"TransactionIndex": 98,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Account": "rBodLLeMx7mqEBv4B2BsaWeTJYnALQddd6",
"Fee": "12",
"LastLedgerSequence": 93800952,
"NFTokenOffers": [
"6267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8"
],
"Sequence": 66025365,
"SigningPubKey": "03F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D4",
"SourceTag": 101102979,
"TransactionType": "NFTokenCancelOffer",
"TxnSignature": "30450221009897AFA16980838EAB0DD819E199E77E80879AA303DAEFF36FB970406715050402205892143D89D07CBD95CA101B2DE561465615A05E670A0A7A15209A0EFC52FE44",
"hash": "324EA92E3B2FD79B53655682045667BA7B683D5FB1051BF33BDDA982F21CB531",
"ledger_index": 93800934,
"date": 791530220
},
"validated": true
}
// ... Additional metadata entries omitted for brevity
{
"meta": {
"AffectedNodes": [
{
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"NFTokens": [
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816B4066980521CFFD",
"URI": "697066733A2F2F516D577335764370506278664A48466351514335385534585778614536446E68376E36414457516F517154714364"
}
},
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816BABD2130521D078",
"URI": "697066733A2F2F516D50363735763661326A5379316263656D70444D355A70365638683842685677594E77737A667053417439394A"
}
}
// ... Additional NFToken entries omitted for brevity
],
"NextPageMin": "6807BF848FACD972F2F617E27003D75B2CAAC9812CAAC9818A6641830521CFE8",
"PreviousPageMin": "6807BF848FACD972F2F617E27003D75B2CAAC9812CAAC9816B4066980521CFFD"
},
"LedgerEntryType": "NFTokenPage",
"LedgerIndex": "6807BF848FACD972F2F617E27003D75B2CAAC9812CAAC98179E62DAF0521D014",
"PreviousFields": {
"NFTokens": [
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816B4066980521CFFD",
"URI": "697066733A2F2F516D577335764370506278664A48466351514335385534585778614536446E68376E36414457516F517154714364"
}
},
{
"NFToken": {
"NFTokenID": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816BABD2130521D078",
"URI": "697066733A2F2F516D50363735763661326A5379316263656D70444D355A70365638683842685677594E77737A667053417439394A"
}
}
// ... Additional NFToken entries omitted for brevity
]
},
"PreviousTxnID": "75036C0D3740CEBF1A45E1EAA080F434E8CE865375A962D9F809A92B79ABBBBE",
"PreviousTxnLgrSeq": 86769021
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rwVhZJLcdtioxdETLq31Ne2K97xm4zA8Jv",
"Balance": "62592375",
"BurnedNFTokens": 129,
"FirstNFTokenSequence": 86101877,
"Flags": 0,
"MintedNFTokens": 629,
"OwnerCount": 20,
"Sequence": 86102636
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "DD1EBD4FBD7B5FD90A271F416083636046FBEA37342114A0026C444F95FFE1F3",
"PreviousFields": {
"Balance": "62592387",
"MintedNFTokens": 628,
"Sequence": 86102635
},
"PreviousTxnID": "C43C70DD5921EAFEFDC2EDC43DF83FF0FE74FB796D9E3F32EA4BFAF890968876",
"PreviousTxnLgrSeq": 86774497
}
}
],
"TransactionIndex": 3,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "rwVhZJLcdtioxdETLq31Ne2K97xm4zA8Jv",
"Fee": "12",
"Flags": 8,
"LastLedgerSequence": 27876176,
"LastLedgerSequence": 86774537,
"Memos": [
{
"Memo": {
"MemoData": "43726561746564206F6E206E66742E6F6E7872702E636F6D"
}
}
],
"NFTokenTaxon": 0,
"Sequence": 27876154,
"SigningPubKey": "EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F6",
"Sequence": 86102635,
"SigningPubKey": "027A4E42790158269E1FAD03364B5A365C26D1C686DEA1A22BFE889AC0C759B2CD",
"SourceTag": 69420589,
"TransactionType": "NFTokenMint",
"TransferFee": 10000,
"TxnSignature": "EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C79802",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469",
"hash": "E0774E1B8628E397C6E88F67D4424E55E4C81324607B19318255310A6FBAA4A2",
"ledger_index": 27876158,
"date": 735167200
"TxnSignature": "3045022100B6AD2D48CFBBA1700A45853D779CEA05A4E438F0B98A6BEDB2200ABEA1D9F87902207E5879CDE873807B945344D2C872632103989097AE3660DEEAD52D84640C414D",
"URI": "697066733A2F2F516D57515A4167695A337041327065654A4D7441703663326A394151666E78706A754E62674D5A505748617A3267",
"hash": "FB9F697C4C9C7E8248BA63E7EDB4435B3CC12AF0BF426E618B184B76B7F94D28",
"ledger_index": 86774529,
"date": 764373881
},
"validated": true
}
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
"validated": true,
"status": "success"
},
"warnings": [
{
@@ -240,28 +525,56 @@ An example of a successful response:
With the `binary` parameter set to _true_, you receive a compact response that uses hex strings. It's not human readable, but much more concise.
{% admonition type="info" name="Note" %}
The example response below uses `api_version: 2`.
{% /admonition %}
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 0,
"type": "response",
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876275,
"nft_id": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"ledger_index_min": 32570,
"ledger_index_max": 99435937,
"transactions": [
{
"meta": "201C00000000F8E31100505697707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFFE8FAEC5A0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B000000007542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469E1F1E1E1E51100612501A95B3A55B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB693956AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24E62401A95B3A2D0000000062400000003B9ACA00E1E722000000002401A95B3B2D00000001202B0000000162400000003B9AC9F4811497707A94B298B50334C39FB46E245D4744C0F5B5E1E1F1031000",
"tx_blob": "12001914271022000000082401A95B3A201B01A95B50202A0000000068400000000000000C7321EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F67440EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C798027542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469811497707A94B298B50334C39FB46E245D4744C0F5B5",
"ledger_index": 27876158,
"date": 735167200,
"meta_blob": "201C00000062F8E4110064561C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231DE72200000002250588A36155FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A5619581C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E511006125059749E15515DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A56587E28972F3B63D2260C0671E59593EE6C4D27AB857D1AF230F5CAA959BB3EACE1E4110037566267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8E72200000001250588A3613400000000000000A33C000000000000000055FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A56195A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000002DC6C082147682B8C119F94724861D13A4B5307CBFABB669DD83141565EED165BA79999425204A8491C73B1301E34FE1E1E511006125059749E15515DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A56993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019E62403EF77952D000004B56240000000101AAB8CE1E722000000002403EF77962D000004B4202B0000006F202C00000048203203EF25756240000000101AAB8081147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E511006425059749E15515DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A56D397E071F0DE6F26875FA9ABD92FAFC13B1CE6E6A612DD9FDB1EF4FA2D79B0B6E722000000003100000000000000A63200000000000000A258FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD714082147682B8C119F94724861D13A4B5307CBFABB669DDE1E1F1031000",
"tx_blob": "12001C230606B5832403EF7795201B059749F868400000000000000C732103F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D4744730450221009897AFA16980838EAB0DD819E199E77E80879AA303DAEFF36FB970406715050402205892143D89D07CBD95CA101B2DE561465615A05E670A0A7A15209A0EFC52FE4481147682B8C119F94724861D13A4B5307CBFABB669DD0413206267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8",
"ledger_index": 93800934,
"date": 791530220,
"validated": true
},
{
"meta_blob": "201C0000004BF8E3110064561C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231DE82200000002581C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E5110061250588A35E55A1525FDCD490BD83BB936612B5C76D52507E40CB8384223AAC95E9ECDDD816BD56587E28972F3B63D2260C0671E59593EE6C4D27AB857D1AF230F5CAA959BB3EACE1E3110037566267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8E822000000013400000000000000A35A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000002DC6C082147682B8C119F94724861D13A4B5307CBFABB669DD83141565EED165BA79999425204A8491C73B1301E34FE1E1E5110061250588A35D554489CBBC591F7828A27B281FE513CDFC1E032ECF9483F01530404D3C29DDE5DC56993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019E62403EF5AB42D00000A1A62400000003AD61EBEE1E722000000002403EF5AB52D00000A1B202B0000006F202C00000048203203EF257562400000003AD61EB281147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E5110064250588A35D554489CBBC591F7828A27B281FE513CDFC1E032ECF9483F01530404D3C29DDE5DC56D397E071F0DE6F26875FA9ABD92FAFC13B1CE6E6A612DD9FDB1EF4FA2D79B0B6E722000000003200000000000000A258FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD714082147682B8C119F94724861D13A4B5307CBFABB669DDE1E1F1031000",
"tx_blob": "12001B2200000001230606B5832403EF5AB4201B0588A3735A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000002DC6C068400000000000000C732103F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D474473045022100F9AD1F24218A86E0C4ED87D7A80D30E64BED3158F369383EE2DAF8F215779C7C0220059A7B626D7F38E352BCCA7F45D3B4C10726BA2CAE64F8147089CF057297062281147682B8C119F94724861D13A4B5307CBFABB669DD83141565EED165BA79999425204A8491C73B1301E34F",
"ledger_index": 92840801,
"date": 787788902,
"validated": true
},
{
"meta_blob": "201C00000001F8E311003756417A1F7087351FF2F091149125B8537A08561DAA07B35399943DC4A3B1E591DAE83400000000000000185A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001EBF1882147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E5110064566400E79FD76837F48323E54A66DA168891E601EBDBF0BA3F9AD6A334784407ABE7220000000032000000000000001758FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD714082147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E311006456889A03272E16CBCA081FF39EE838C3A217485670113019DAA4A84932AEFC7F02E8220000000158889A03272E16CBCA081FF39EE838C3A217485670113019DAA4A84932AEFC7F025A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E511006125052C7E41558176DA2BA3363B0901379B292270CA089EDE39A255D4A8F0224C86483467BCEA56993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019E62403EF20182D0000017A6240000000E53A6064E1E722000000002403EF20192D0000017B6240000000E53A605881147682B8C119F94724861D13A4B5307CBFABB669DDE1E1F1031000",
"tx_blob": "12001B230423462D2403EF2018201B052C7E635A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001EBF1868400000000000000C732103F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D474473045022100991746A6AD5FC763B658D592AE6301AB19504C8032C97538AFE938FA375EBE8A0220200F7848848653D59151F432D6C6374C4838EE1373F7EFAA5C1EF4570B5FFBFA81147682B8C119F94724861D13A4B5307CBFABB669DD82146807BF848FACD972F2F617E27003D75B2CAAC981F9EA7D1843726561746564206F6E206E66742E6F6E7872702E636F6DE1F1",
"ledger_index": 86802011,
"date": 764479561,
"validated": true
},
{
"meta_blob": "201C0000000EF8E3110064561C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231DE82200000002581C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E5110064566096E1D8134722843D499E983F3A092D9B74AD2039F7F4FC3C17587B34DAFA24E7220000000032000000000000000D58830BE57DF6ED1C3103070BF1968CEFB15ADE866418A1B176E9B188ECE82BC63382146807BF848FACD972F2F617E27003D75B2CAAC981E1E1E511006125052C1F3F558DA0521A7779A7F845981EA94D551062C611F492F60F9ECEF53978340A63E32B56CD3CA85955F9B786BAD89F9125200EB9BCBEE5DCC996CC71A565FAA876CD1ACCE1E311003756D8C83BE4736E856BD18F92FC9A4ABD45641313508E5412D6ACACB90A82F948F5E8220000000134000000000000000E5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001E848082146807BF848FACD972F2F617E27003D75B2CAAC9818314112DE2804BD473EB8A77E01E1C43A9CDC79A6EBFE1E1E511006125052C1F3F558DA0521A7779A7F845981EA94D551062C611F492F60F9ECEF53978340A63E32B56DD1EBD4FBD7B5FD90A271F416083636046FBEA37342114A0026C444F95FFE1F3E6240521D44B2D000001EB62400000003C5AD883E1E72200000000240521D44C2D000001EC202B00000275202C0000008120320521CF7562400000003C5AD87781146807BF848FACD972F2F617E27003D75B2CAAC981E1E1F1031000",
"tx_blob": "12001B2200000001230423462D240521D44B201B052C1F4A5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001E848068400000000000000C7321027A4E42790158269E1FAD03364B5A365C26D1C686DEA1A22BFE889AC0C759B2CD7447304502210084109EB534DC4C45F5CA0AA10C08E396FDC1A84925B20B4188426EA0E56090CD02203555F331713600C91C09E72EFAC8BCC594A95561C16880866735F62D1DB0794381146807BF848FACD972F2F617E27003D75B2CAAC9818314112DE2804BD473EB8A77E01E1C43A9CDC79A6EBFF9EA7D1843726561746564206F6E206E66742E6F6E7872702E636F6DE1F1",
"ledger_index": 86777666,
"date": 764385850,
"validated": true
}
// ... Additional metadata omitted for brevity
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
},
"id": "example_nft_history",
"api_version": 2,
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
@@ -276,19 +589,42 @@ With the `binary` parameter set to _true_, you receive a compact response that u
```json
{
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876275,
"nft_id": "000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9",
"ledger_index_min": 32570,
"ledger_index_max": 99435993,
"transactions": [
{
"meta": "201C00000000F8E31100505697707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFFE8FAEC5A0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B000000007542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469E1F1E1E1E51100612501A95B3A55B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB693956AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24E62401A95B3A2D0000000062400000003B9ACA00E1E722000000002401A95B3B2D00000001202B0000000162400000003B9AC9F4811497707A94B298B50334C39FB46E245D4744C0F5B5E1E1F1031000",
"tx_blob": "12001914271022000000082401A95B3A201B01A95B50202A0000000068400000000000000C7321EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F67440EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C798027542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469811497707A94B298B50334C39FB46E245D4744C0F5B5",
"ledger_index": 27876158,
"date": 735167200,
"meta_blob": "201C00000062F8E4110064561C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231DE72200000002250588A36155FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A5619581C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E511006125059749E15515DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A56587E28972F3B63D2260C0671E59593EE6C4D27AB857D1AF230F5CAA959BB3EACE1E4110037566267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8E72200000001250588A3613400000000000000A33C000000000000000055FD779D4C51C30730EB3EC7B20D07CDB0BC5A259D165F29C8CFDE86752D5A56195A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000002DC6C082147682B8C119F94724861D13A4B5307CBFABB669DD83141565EED165BA79999425204A8491C73B1301E34FE1E1E511006125059749E15515DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A56993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019E62403EF77952D000004B56240000000101AAB8CE1E722000000002403EF77962D000004B4202B0000006F202C00000048203203EF25756240000000101AAB8081147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E511006425059749E15515DF0F4622A6BBA7051D029A1ED16930DB3D476D2B29CDF63FFDA5B320BF385A56D397E071F0DE6F26875FA9ABD92FAFC13B1CE6E6A612DD9FDB1EF4FA2D79B0B6E722000000003100000000000000A63200000000000000A258FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD714082147682B8C119F94724861D13A4B5307CBFABB669DDE1E1F1031000",
"tx_blob": "12001C230606B5832403EF7795201B059749F868400000000000000C732103F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D4744730450221009897AFA16980838EAB0DD819E199E77E80879AA303DAEFF36FB970406715050402205892143D89D07CBD95CA101B2DE561465615A05E670A0A7A15209A0EFC52FE4481147682B8C119F94724861D13A4B5307CBFABB669DD0413206267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8",
"ledger_index": 93800934,
"date": 791530220,
"validated": true
},
{
"meta_blob": "201C0000004BF8E3110064561C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231DE82200000002581C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E5110061250588A35E55A1525FDCD490BD83BB936612B5C76D52507E40CB8384223AAC95E9ECDDD816BD56587E28972F3B63D2260C0671E59593EE6C4D27AB857D1AF230F5CAA959BB3EACE1E3110037566267FBBCE11EEFB9931BFD2BB7E2D4455A60CBA6DE60830266DA4C1C7966D2A8E822000000013400000000000000A35A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000002DC6C082147682B8C119F94724861D13A4B5307CBFABB669DD83141565EED165BA79999425204A8491C73B1301E34FE1E1E5110061250588A35D554489CBBC591F7828A27B281FE513CDFC1E032ECF9483F01530404D3C29DDE5DC56993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019E62403EF5AB42D00000A1A62400000003AD61EBEE1E722000000002403EF5AB52D00000A1B202B0000006F202C00000048203203EF257562400000003AD61EB281147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E5110064250588A35D554489CBBC591F7828A27B281FE513CDFC1E032ECF9483F01530404D3C29DDE5DC56D397E071F0DE6F26875FA9ABD92FAFC13B1CE6E6A612DD9FDB1EF4FA2D79B0B6E722000000003200000000000000A258FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD714082147682B8C119F94724861D13A4B5307CBFABB669DDE1E1F1031000",
"tx_blob": "12001B2200000001230606B5832403EF5AB4201B0588A3735A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000002DC6C068400000000000000C732103F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D474473045022100F9AD1F24218A86E0C4ED87D7A80D30E64BED3158F369383EE2DAF8F215779C7C0220059A7B626D7F38E352BCCA7F45D3B4C10726BA2CAE64F8147089CF057297062281147682B8C119F94724861D13A4B5307CBFABB669DD83141565EED165BA79999425204A8491C73B1301E34F",
"ledger_index": 92840801,
"date": 787788902,
"validated": true
},
{
"meta_blob": "201C00000001F8E311003756417A1F7087351FF2F091149125B8537A08561DAA07B35399943DC4A3B1E591DAE83400000000000000185A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001EBF1882147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E5110064566400E79FD76837F48323E54A66DA168891E601EBDBF0BA3F9AD6A334784407ABE7220000000032000000000000001758FF1CF158ED5CE0E41E954B6CD1C3B5ECF1D4A3901113F1E2B9DCBF9532FD714082147682B8C119F94724861D13A4B5307CBFABB669DDE1E1E311006456889A03272E16CBCA081FF39EE838C3A217485670113019DAA4A84932AEFC7F02E8220000000158889A03272E16CBCA081FF39EE838C3A217485670113019DAA4A84932AEFC7F025A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E511006125052C7E41558176DA2BA3363B0901379B292270CA089EDE39A255D4A8F0224C86483467BCEA56993F123FC11F0FDD065FB33C99007369E4768994C03936C67B92C44F47DE5019E62403EF20182D0000017A6240000000E53A6064E1E722000000002403EF20192D0000017B6240000000E53A605881147682B8C119F94724861D13A4B5307CBFABB669DDE1E1F1031000",
"tx_blob": "12001B230423462D2403EF2018201B052C7E635A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001EBF1868400000000000000C732103F314C754C26C0B9A859693C57CFCE464A14E86ADA0CAA174817A637E828E64D474473045022100991746A6AD5FC763B658D592AE6301AB19504C8032C97538AFE938FA375EBE8A0220200F7848848653D59151F432D6C6374C4838EE1373F7EFAA5C1EF4570B5FFBFA81147682B8C119F94724861D13A4B5307CBFABB669DD82146807BF848FACD972F2F617E27003D75B2CAAC981F9EA7D1843726561746564206F6E206E66742E6F6E7872702E636F6DE1F1",
"ledger_index": 86802011,
"date": 764479561,
"validated": true
},
{
"meta_blob": "201C0000000EF8E3110064561C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231DE82200000002581C7421BF3CBA58699FF855EFF8BB68E63B843B17442FEED9CF3FDB5F497C231D5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E9E1E1E5110064566096E1D8134722843D499E983F3A092D9B74AD2039F7F4FC3C17587B34DAFA24E7220000000032000000000000000D58830BE57DF6ED1C3103070BF1968CEFB15ADE866418A1B176E9B188ECE82BC63382146807BF848FACD972F2F617E27003D75B2CAAC981E1E1E511006125052C1F3F558DA0521A7779A7F845981EA94D551062C611F492F60F9ECEF53978340A63E32B56CD3CA85955F9B786BAD89F9125200EB9BCBEE5DCC996CC71A565FAA876CD1ACCE1E311003756D8C83BE4736E856BD18F92FC9A4ABD45641313508E5412D6ACACB90A82F948F5E8220000000134000000000000000E5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001E848082146807BF848FACD972F2F617E27003D75B2CAAC9818314112DE2804BD473EB8A77E01E1C43A9CDC79A6EBFE1E1E511006125052C1F3F558DA0521A7779A7F845981EA94D551062C611F492F60F9ECEF53978340A63E32B56DD1EBD4FBD7B5FD90A271F416083636046FBEA37342114A0026C444F95FFE1F3E6240521D44B2D000001EB62400000003C5AD883E1E72200000000240521D44C2D000001EC202B00000275202C0000008120320521CF7562400000003C5AD87781146807BF848FACD972F2F617E27003D75B2CAAC981E1E1F1031000",
"tx_blob": "12001B2200000001230423462D240521D44B201B052C1F4A5A000827106807BF848FACD972F2F617E27003D75B2CAAC9816CEE14840521D1E96140000000001E848068400000000000000C7321027A4E42790158269E1FAD03364B5A365C26D1C686DEA1A22BFE889AC0C759B2CD7447304502210084109EB534DC4C45F5CA0AA10C08E396FDC1A84925B20B4188426EA0E56090CD02203555F331713600C91C09E72EFAC8BCC594A95561C16880866735F62D1DB0794381146807BF848FACD972F2F617E27003D75B2CAAC9818314112DE2804BD473EB8A77E01E1C43A9CDC79A6EBFF9EA7D1843726561746564206F6E206E66742E6F6E7872702E636F6DE1F1",
"ledger_index": 86777666,
"date": 764385850,
"validated": true
}
// ... Additional metadata omitted for brevity
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
"validated": true,
"status": "success"
},
"warnings": [
{
@@ -297,7 +633,6 @@ With the `binary` parameter set to _true_, you receive a compact response that u
}
]
}
```
{% /tab %}
@@ -319,13 +654,14 @@ The response follows the [standard format][], with a successful result containin
Each transaction object includes the following fields, depending on whether it was requested in JSON or hex string (`"binary":true`) format.
| `Field` | Type | Description |
|:---------------|:---------------------------------|:-------------------------|
| `ledger_index` | Integer | The [ledger index][] of the ledger version that included this transaction. |
| `meta` | Object (JSON) or String (Binary) | If `binary` is True, then this is a hex string of the transaction metadata. Otherwise, the transaction metadata is included in JSON format. |
| `tx` | Object | (JSON mode only) JSON object defining the transaction |
| `tx_blob` | String | (Binary mode only) Unique hashed String representing the transaction. |
| `validated` | Boolean | Whether or not the transaction is included in a validated ledger. Any transaction not yet in a validated ledger is subject to change. |
| `Field` | Type | Description |
|:----------------|:---------------------------------|:-------------------------|
| `ledger_index` | Integer | The [ledger index][] of the ledger version that included this transaction. |
| `meta` (API v1) | Object (JSON) or String (Binary) | If `binary` is true, then this is a hex string of the transaction metadata. Otherwise, the transaction metadata is included in JSON format. |
| `meta_blob` (API v2) | String (Binary) | If `binary` is true, then this is a hex string of the transaction metadata. Otherwise, the transaction metadata is included as `meta` in JSON format. |
| `tx` | Object | (JSON mode only) JSON object defining the transaction |
| `tx_blob` | String | (Binary mode only) Unique hashed String representing the transaction. |
| `validated` | Boolean | Whether or not the transaction is included in a validated ledger. Any transaction not yet in a validated ledger is subject to change. |
For definitions of the fields returned in the `tx` object, see [Transaction Metadata](../../../protocol/transactions/metadata.md).

View File

@@ -4,7 +4,7 @@ parent: clio-methods.html
seo:
description: Retrieve information about the specified NFT using Clio server's `nft_info` API.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# nft_info
[[Source]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTInfo.cpp "Source")

View File

@@ -4,7 +4,7 @@ parent: clio-methods.html
seo:
description: Retrieve the history of ownership and transfers for the specified NFT using Clio server's `nft_history` API.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# nfts_by_issuer

View File

@@ -4,7 +4,7 @@ parent: path-and-order-book-methods.html
seo:
description: Get a list of all buy offers for a NFToken.
labels:
- NFTs, NFTokens
- Non-fungible Tokens, NFTs, NFTokens
---
# nft_buy_offers
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/NFTOffers.cpp "Source")

View File

@@ -4,7 +4,7 @@ parent: path-and-order-book-methods.html
seo:
description: Get a list of all sell offers for a NFToken.
labels:
- NFTs, NFTokens
- Non-fungible Tokens, NFTs, NFTokens
---
# nft_sell_offers
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/NFTOffers.cpp "Source")

View File

@@ -1,21 +1,12 @@
---
html: serialization.html
parent: protocol-reference.html
seo:
description: Conversion between JSON and canonical binary format for XRP Ledger transactions and other objects.
labels:
- Blockchain
- Transaction Sending
curated_anchors:
- name: Sample Code
anchor: "#sample-code"
- name: Canonical Field Order
anchor: "#canonical-field-order"
- name: Type List
anchor: "#type-list"
- Blockchain
- Transaction Sending
---
# Binary Format
[[Source]](https://github.com/XRPLF/rippled/blob/develop/include/xrpl/protocol/SField.h "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/SField.h "Source")
This page describes the XRP Ledger's canonical binary format for transactions and other data. This binary format is necessary to create and verify digital signatures of those transactions' contents, and is also used in other places including in the [peer-to-peer communications between servers](../../concepts/networks-and-servers/peer-protocol.md). The [`rippled` APIs](../http-websocket-apis/index.md) typically use JSON to communicate with client applications. However, JSON is unsuitable as a format for serializing transactions for being digitally signed, because JSON can represent the same data in many different but equivalent ways.
@@ -55,7 +46,7 @@ Both signed and unsigned transactions can be represented in both JSON and binary
The serialization processes described here are implemented in multiple places and programming languages:
- In C++ [in the `rippled` code base](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/impl/STObject.cpp).
- In C++ [in the `rippled` code base](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/STObject.cpp).
- In JavaScript in {% repo-link path="_code-samples/tx-serialization/" %}this repository's code samples section{% /repo-link %}.
- In Python 3 in {% repo-link path="_code-samples/tx-serialization/" %}this repository's code samples section{% /repo-link %}.
@@ -65,7 +56,7 @@ Additionally, many [client libraries](../client-libraries.md) provide serializat
## Internal Format
Each field has an canonical binary format, or _internal format_ used in the XRP Ledger protocol to represent that field in transactions and ledger data. The binary format is needed for signing, but it is also used in peer-to-peer communications, in ledger storage, and in other places. The binary formats for all fields are defined in the source code of [`SField.h`](https://github.com/XRPLF/rippled/blob/develop/include/xrpl/protocol/SField.h). The JSON format for transactions and ledger data is standardized for convenience, but JSON is only used in APIs and client libraries: strictly speaking, only the binary format exists at the level of the XRP Ledger protocol.
Each field has an canonical binary format, or _internal format_ used in the XRP Ledger protocol to represent that field in transactions and ledger data. The binary format is needed for signing, but it is also used in peer-to-peer communications, in ledger storage, and in other places. The binary formats for all fields are defined in the source code of [`SField.h`](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/SField.h). The JSON format for transactions and ledger data is standardized for convenience, but JSON is only used in APIs and client libraries: strictly speaking, only the binary format exists at the level of the XRP Ledger protocol.
The [Transaction Format Reference](transactions/index.md) and [Ledger Data Reference](ledger-data/index.md) list both the JSON and the internal (binary) formats for all fields. For example, the `Flags` [common transaction field](transactions/common-fields.md) is a Number in JSON and a UInt32 in binary. Even though the JSON representation uses a data type that can contain decimal places or very large values, the field is limited to values that can be represented as a 32-bit unsigned integer.
@@ -265,7 +256,7 @@ The following diagram shows the serialization formats for all three amount forma
[{% inline-svg file="/docs/img/serialization-amount.svg" /%}](/docs/img/serialization-amount.svg 'The first bit is an amount type bit (0 = XRP or MPT, 1 = fungible token). XRP has a sign bit (always 1 for positive), an MPT indicator bit (0=XRP) and 61 bits of precision. MPTs have a sign bit (always 1 for positive), an MPT indicator bit (1=MPT), 5 reserved bits, 64 bit integer quantity, and a 192 bit MPT Issuance ID which consists of the 32-bit Sequence number followed by 160-bit issuer AccountID. Fungible Token amounts consist start with an amount type bit of 1, a sign bit which can be 1 or 0, an exponent (8 bits), significant digits (54 bits), currency code (160 bits), and issuer (160 bits).')
#### Token Amount Format
[[Source]](https://github.com/XRPLF/rippled/blob/35fa20a110e3d43ffc1e9e664fc9017b6f2747ae/src/ripple/protocol/impl/STAmount.cpp "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/STAmount.cpp "Source")
[{% inline-svg file="/docs/img/currency-number-format.svg" /%}](/docs/img/currency-number-format.svg "Token Amount Format diagram")
@@ -354,12 +345,12 @@ The following example shows the serialization format for an object (a single `Me
The `Paths` field of a cross-currency [Payment transaction][] is a "PathSet", represented in JSON as an array of arrays. For more information on what paths are used for, see [Paths](../../concepts/tokens/fungible-tokens/paths.md).
A PathSet is serialized as **1 to 6** individual paths in sequence[[Source]](https://github.com/XRPLF/rippled/blob/4cff94f7a4a05302bdf1a248515379da99c5bcd4/src/ripple/app/tx/impl/Payment.h#L35-L36 "Source"). Each complete path is followed by a byte that indicates what comes next:
A PathSet is serialized as **1 to 6** individual paths in sequence[[Source]](https://github.com/XRPLF/rippled/blob/5e33ca56fd51b02a5490e8e156e2de65937cf88e/src/xrpld/app/tx/detail/Payment.h#L30 "Source"). Each complete path is followed by a byte that indicates what comes next:
- `0xff` indicates another path follows
- `0x00` indicates the end of the PathSet
Each path consists of **1 to 8** path steps in order[[Source]](https://github.com/XRPLF/rippled/blob/4cff94f7a4a05302bdf1a248515379da99c5bcd4/src/ripple/app/tx/impl/Payment.h#L38-L39 "Source"). Each step starts with a **type** byte, followed by one or more fields describing the path step. The type indicates which fields are present in that path step through bitwise flags. (For example, the value `0x30` indicates changing both currency and issuer.) If more than one field is present, the fields are always placed in a specific order.
Each path consists of **1 to 8** path steps in order[[Source]](https://github.com/XRPLF/rippled/blob/5e33ca56fd51b02a5490e8e156e2de65937cf88e/src/xrpld/app/tx/detail/Payment.h#L33 "Source"). Each step starts with a **type** byte, followed by one or more fields describing the path step. The type indicates which fields are present in that path step through bitwise flags. (For example, the value `0x30` indicates changing both currency and issuer.) If more than one field is present, the fields are always placed in a specific order.
The following table describes the possible fields and the bitwise flags to set in the type byte to indicate them:

View File

@@ -28,7 +28,7 @@ Each closed [Ledger](../ledger-data/index.md) has a [Ledger Index][] and a [Hash
### Hash Prefixes
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/HashPrefix.h "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/HashPrefix.h "Source")
In many cases, the XRP Ledger prefixes an object's binary data with a 4-byte code before calculating its hash, so that objects of different types have different hashes even if their binary formats are the same. The existing 4-byte codes are structured as three alphabetic characters, encoded as ASCII, followed by a zero byte.

View File

@@ -4,7 +4,7 @@ parent: basic-data-types.html
seo:
description: Introduction to XRPL NFTs.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFToken

View File

@@ -1,10 +1,9 @@
---
html: ledger-entry-common-fields.html
seo:
description: These common fields are part of every ledger entry.
---
# Ledger Entry Common Fields
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp)
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/LedgerFormats.cpp)
Every entry in a [ledger](../../../concepts/ledgers/index.md)'s state data has the same set of common fields, plus additional fields based on the [ledger entry type](ledger-entry-types/index.md). Field names are case-sensitive. The common fields for all ledger entries are:
@@ -19,9 +18,9 @@ Every entry in a [ledger](../../../concepts/ledgers/index.md)'s state data has t
## Ledger Entry ID
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/Indexes.cpp)
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/Indexes.cpp)
Each ledger entry has a unique ID. The ID is derived by hashing important contents of the entry, along with a [namespace identifier](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/LedgerFormats.h). The [ledger entry type](ledger-entry-types/index.md) determines the namespace identifier to use and which contents to include in the hash. This ensures every ID is unique. The hash function is [SHA-512Half][].
Each ledger entry has a unique ID. The ID is derived by hashing important contents of the entry, along with a _namespace identifier_ which is a 16 bit value. The [ledger entry type](ledger-entry-types/index.md) determines the namespace identifier to use and which contents to include in the hash. This ensures every ID is unique. The hash function is [SHA-512Half][].
Generally, a ledger entry's ID is returned as the `index` field in JSON, at the same level as the object's contents. In [transaction metadata](../transactions/metadata.md), the ledger object's ID in JSON is `LedgerIndex`.

View File

@@ -42,7 +42,7 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| `AMMID` | String | UInt256 | No | {% amendment-disclaimer name="AMM" /%} The ledger entry ID of the corresponding AMM ledger entry. Set during account creation; cannot be modified. If present, indicates that this is a special AMM AccountRoot; always omitted on non-AMM accounts. |
| `Balance` | String | Amount | No | The account's current [XRP balance in drops][XRP, in drops], represented as a string. |
| `BurnedNFTokens` | Number | UInt32 | No | How many total of this account's issued [non-fungible tokens](../../../../concepts/tokens/nfts/index.md) have been burned. This number is always equal or less than `MintedNFTokens`. |
| `Domain` | String | Blob | No | A domain associated with this account. In JSON, this is the hexadecimal for the ASCII representation of the domain. [Cannot be more than 256 bytes in length.](https://github.com/xrplf/rippled/blob/55dc7a252e08a0b02cd5aa39e9b4777af3eafe77/src/ripple/app/tx/impl/SetAccount.h#L34) |
| `Domain` | String | Blob | No | A domain associated with this account. In JSON, this is the hexadecimal for the ASCII representation of the domain. [Cannot be more than 256 bytes in length.](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/include/xrpl/protocol/Protocol.h#L98) |
| `EmailHash` | String | UInt128 | No | The md5 hash of an email address. Clients can use this to look up an avatar through services such as [Gravatar](https://en.gravatar.com/). |
| `FirstNFTokenSequence` | Number | UInt32 | No | The account's [Sequence Number][] at the time it minted its first [non-fungible-token](../../../../concepts/tokens/nfts/index.md). {% amendment-disclaimer name="fixNFTokenRemint" /%} |
| `LedgerEntryType` | String | UInt16 | Yes | The value `0x0061`, mapped to the string `AccountRoot`, indicates that this is an AccountRoot object. |

View File

@@ -1,8 +1,8 @@
---
seo:
description: A single cross-chain bridge that connects and enables value to move efficiently between two blockchains.
description: A single cross-chain bridge that connects and enables value to move efficiently between two blockchains.
labels:
- Sidechains
- Interoperability
status: not_enabled
---
# Bridge

View File

@@ -64,7 +64,7 @@ There are no flags defined for {% code-page-name /%} entries.
## Check ID Format
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/Indexes.cpp#L193-L200 "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/libxrpl/protocol/Indexes.cpp#L335-L339 "Source")
The ID of a `Check` entry is the [SHA-512Half][] of the following values, concatenated in order:

View File

@@ -72,7 +72,7 @@ There are no flags defined for {% code-page-name /%} entries.
## LedgerHashes ID Formats
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/Indexes.cpp#L26-L42)
[[Source]](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/libxrpl/protocol/Indexes.cpp#L195-L211)
There are two formats for `LedgerHashes` ledger entry IDs, depending on whether the entry is a "recent history" sub-type or a "previous history" sub-type.

View File

@@ -2,7 +2,7 @@
seo:
description: Multi-Purpose Tokens (MPT) of one issuance held by a specific account.
labels:
- MPTs, Tokens
- Multi-purpose Tokens, MPTs, Tokens
status: not_enabled
---
# MPToken

View File

@@ -2,7 +2,7 @@
seo:
description: Definition of a Multi-Purpose Token (MPT) issuance.
labels:
- MPTs, Tokens
- Multi-purpose Tokens, MPTs, Tokens
status: not_enabled
---
# MPTokenIssuance

View File

@@ -2,7 +2,7 @@
seo:
description: An offer to buy or sell an NFT.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenOffer
[[Source]](https://github.com/XRPLF/rippled/blob/f64cf9187affd69650907d0d92e097eb29693945/include/xrpl/protocol/detail/ledger_entries.macro#L34-L44 "Source")

View File

@@ -2,7 +2,7 @@
seo:
description: A group of up to 32 NFTs, stored together for efficiency.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenPage
[[Source]](https://github.com/XRPLF/rippled/blob/f64cf9187affd69650907d0d92e097eb29693945/include/xrpl/protocol/detail/ledger_entries.macro#L97-L103 "Source")

View File

@@ -2,7 +2,7 @@
seo:
description: A trust line, which tracks the net balance of fungible tokens between two accounts.
labels:
- Tokens
- Tokens
---
# RippleState
[[Source]](https://github.com/XRPLF/rippled/blob/f64cf9187affd69650907d0d92e097eb29693945/include/xrpl/protocol/detail/ledger_entries.macro#L277-L289 "Source")
@@ -69,19 +69,19 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
`RippleState` entries can have the following flags combined into the `Flags` field:
| Flag Name | Hex Value | Decimal Value | Corresponding [TrustSet Flag](../../transactions/types/trustset.md#trustset-flags) | Description |
|-------------------|--------------|---------------|-----------------|---------|
| `lsfAMMNode` | `0x01000000` | 16777216 | (None) | This entry consumed AMM liquidity to complete a [`Payment`](../../transactions/types/payment.md) transaction. |
| `lsfLowReserve` | `0x00010000` | 65536 | (None) | This entry [contributes to the low account's owner reserve](#ripplestate-reserve). |
| `lsfHighReserve` | `0x00020000` | 131072 | (None) | This entry [contributes to the high account's owner reserve](#ripplestate-reserve). |
| `lsfLowAuth` | `0x00040000` | 262144 | `tfSetAuth` | The low account has authorized the high account to hold tokens issued by the low account. |
| `lsfHighAuth` | `0x00080000` | 524288 | `tfSetAuth` | The high account has authorized the low account to hold tokens issued by the high account. |
| `lsfLowNoRipple` | `0x00100000` | 1048576 | `tfSetNoRipple` | The low account [has disabled rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) from this trust line. |
| `lsfHighNoRipple` | `0x00200000` | 2097152 | `tfSetNoRipple` | The high account [has disabled rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) from this trust line. |
| `lsfLowFreeze` | `0x00400000` | 4194304 | `tfSetFreeze` | The low account has frozen the trust line, preventing the high account from transferring the asset. |
| `lsfHighFreeze` | `0x00800000` | 8388608 | `tfSetFreeze` | The high account has frozen the trust line, preventing the low account from transferring the asset. |
| `lsfLowDeepFreeze` | `0x02000000` | 33554432 |`tfSetLowDeepFreeze` | The low account has deep-frozen the trust line, preventing the high account from sending and receiving the asset. |
| `lsfHighDeepFreeze` | `0x04000000` | 67108864 | `tfSetHighDeepFreeze` | The high account has deep-frozen the trust line, preventing the low account from sending and receiving the asset. |
| Flag Name | Hex Value | Decimal Value | Corresponding [TrustSet Flag](../../transactions/types/trustset.md#trustset-flags) | Description |
|---------------------|--------------|---------------|-----------------------|---------|
| `lsfLowReserve` | `0x00010000` | 65536 | (None) | This entry [contributes to the low account's owner reserve](#ripplestate-reserve). |
| `lsfHighReserve` | `0x00020000` | 131072 | (None) | This entry [contributes to the high account's owner reserve](#ripplestate-reserve). |
| `lsfLowAuth` | `0x00040000` | 262144 | `tfSetAuth` | The low account has authorized the high account to hold tokens issued by the low account. |
| `lsfHighAuth` | `0x00080000` | 524288 | `tfSetAuth` | The high account has authorized the low account to hold tokens issued by the high account. |
| `lsfLowNoRipple` | `0x00100000` | 1048576 | `tfSetNoRipple` | The low account [has disabled rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) from this trust line. |
| `lsfHighNoRipple` | `0x00200000` | 2097152 | `tfSetNoRipple` | The high account [has disabled rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) from this trust line. |
| `lsfLowFreeze` | `0x00400000` | 4194304 | `tfSetFreeze` | The low account has frozen the trust line, preventing the high account from transferring the asset. |
| `lsfHighFreeze` | `0x00800000` | 8388608 | `tfSetFreeze` | The high account has frozen the trust line, preventing the low account from transferring the asset. |
| `lsfAMMNode` | `0x01000000` | 16777216 | (None) | This trust line holds one of the assets in an [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)'s pool; one of this trust line's accounts is the AMM, and the other is the issuer of the token. {% amendment-disclaimer name="AMM" /%} |
| `lsfLowDeepFreeze` | `0x02000000` | 33554432 |`tfSetLowDeepFreeze` | The low account has deep-frozen the trust line, preventing the high account from sending and receiving the asset. {% amendment-disclaimer name="DeepFreeze" /%} |
| `lsfHighDeepFreeze` | `0x04000000` | 67108864 | `tfSetHighDeepFreeze` | The high account has deep-frozen the trust line, preventing the low account from sending and receiving the asset. {% amendment-disclaimer name="DeepFreeze" /%} |
The two accounts connected by the trust line can each change their own settings with a [TrustSet transaction][].

View File

@@ -1,8 +1,8 @@
---
seo:
description: A cross-chain transfer of value.
description: A cross-chain transfer of value.
labels:
- Sidechains
- Interoperability
status: not_enabled
---
# XChainOwnedClaimID

View File

@@ -1,8 +1,8 @@
---
seo:
description: A record of attestations for creating an account via a cross-chain transfer.
description: A record of attestations for creating an account via a cross-chain transfer.
labels:
- Sidechains
- Interoperability
status: not_enabled
---
# XChainOwnedCreateAccountClaimID

View File

@@ -8,7 +8,7 @@ labels:
- Blockchain
---
# Ledger Header
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/ledger/ReadView.h#L71 "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/consensus/RCLCxLedger.h "Source")
Every [ledger version](../../../concepts/ledgers/index.md) has a unique header that describes the contents. You can look up a ledger's header information with the [ledger method][]. The contents of the ledger header are as follows:

View File

@@ -8,7 +8,7 @@ labels:
---
# Transaction Results
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/TER.h "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/TER.cpp "Source")
The `rippled` server summarizes transaction results with result codes, which appear in fields such as `engine_result` and `meta.TransactionResult`. These codes are grouped into several categories of with different prefixes:

View File

@@ -7,7 +7,7 @@ labels:
- Transaction Sending
---
# tec Codes
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TER.cpp "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/libxrpl/protocol/TER.cpp "Source")
These codes indicate that the transaction did not succeed, but it was applied to a ledger to apply the [transaction cost](../../../../concepts/transactions/transaction-cost.md) and may have had other side effects to the ledger. The `tec` codes have numerical values in the range 100 to 199. It is recommended to use the text code, not the numeric value.

View File

@@ -3,7 +3,6 @@ seo:
description: Delete an account.
labels:
- Accounts
category: Settings
---
# AccountDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteAccount.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Set options on an account.
labels:
- Accounts
category: Settings
---
# AccountSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetAccount.cpp "Source")
@@ -31,7 +30,7 @@ Modify the settings or properties of an [account in the XRP Ledger](../../../../
| Field | JSON Type | [Internal Type][] | Description |
|:-----------------|:-----------------|:------------------|:-------------------|
| [`ClearFlag`](#accountset-flags) | Number | UInt32 | Unique identifier of a flag to disable for this account. |
| [`Domain`](#domain) | String | Blob | The domain that owns this account, as a string of hex representing the ASCII for the domain in lowercase. [Cannot be more than 256 bytes in length.](https://github.com/XRPLF/rippled/blob/55dc7a252e08a0b02cd5aa39e9b4777af3eafe77/src/ripple/app/tx/impl/SetAccount.h#L34) |
| [`Domain`](#domain) | String | Blob | The domain that owns this account, as a string of hex representing the ASCII for the domain in lowercase. [Cannot be more than 256 bytes in length.](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/include/xrpl/protocol/Protocol.h#L98) |
| `EmailHash` | String | UInt128 | An arbitrary 128-bit value. Conventionally, clients treat this as the md5 hash of an email address to use for displaying a [Gravatar](http://en.gravatar.com/site/implement/hash/) image. |
| `MessageKey` | String | Blob | Public key for sending encrypted messages to this account. To set the key, it must be exactly 33 bytes, with the first byte indicating the key type: `0x02` or `0x03` for secp256k1 keys, `0xED` for Ed25519 keys. To remove the key, use an empty value. |
| `NFTokenMinter` | String - [Address][] | AccountID | Another account that can [mint NFTokens for you](../../../../tutorials/javascript/nfts/assign-an-authorized-minter.md). {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} |

View File

@@ -3,7 +3,6 @@ seo:
description: Bid on an Automated Market Maker's auction slot, which grants a discounted fee.
labels:
- AMM
category: Trading
---
# AMMBid
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMBid.cpp "Source")

View File

@@ -3,7 +3,7 @@ seo:
description: Claw back tokens from a holder who has deposited your issued tokens into an Automated Market Maker pool.
labels:
- AMM
category: Trading
- Tokens
---
# AMMClawback

View File

@@ -3,7 +3,6 @@ seo:
description: Create a new Automated Market Maker for trading a given pair of assets.
labels:
- AMM
category: Trading
---
# AMMCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMCreate.cpp "Source")
@@ -20,21 +19,32 @@ Creates both an [AMM entry][] and a [special AccountRoot entry](../../ledger-dat
```json
{
"Account" : "rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm",
"Amount" : {
"currency" : "TST",
"issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
"value" : "25"
},
"Amount2" : "250000000",
"Fee" : "2000000",
"Flags" : 2147483648,
"Sequence" : 6,
"TradingFee" : 500,
"TransactionType" : "AMMCreate"
"Account": "r3qNwezAqKp2FRFteiFjhC4V1at4KePFx7",
"Amount": {
"currency": "SKY",
"issuer": "rSKYachd4cqUgztsTr83mEKTAcNZG4Ez2",
"value": "80"
},
"Amount2": "20000000",
"Fee": "200000",
"Flags": 2147483648,
"LastLedgerSequence": 99502897,
"Memos": [
{
"Memo": {
"MemoData": "414D4D2063726561746520696E69746961746564207669612058506D61726B65742E636F6D"
}
}
],
"Sequence": 94041760,
"SourceTag": 20221212,
"TradingFee": 1000,
"TransactionType": "AMMCreate",
}
```
{% tx-example txid="E4CC45E28421618FFEB1920B8FE152EAAB70489BD9AD52FEF24D58389C011C5E" /%}
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
| Field | JSON Type | [Internal Type][] | Required? | Description |

View File

@@ -3,7 +3,6 @@ seo:
description: Delete an Automated Market Maker with an empty asset pool.
labels:
- AMM
category: Trading
---
# AMMDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDelete.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Deposit funds into an Automated Market Maker in exchange for LPTokens.
labels:
- AMM
category: Trading
---
# AMMDeposit
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDeposit.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Vote on the trading fee for an Automated Market Maker.
labels:
- AMM
category: Trading
---
# AMMVote
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMVote.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Return LPTokens to an Automated Market Maker in exchange for a share of the assets the pool holds.
labels:
- AMM
category: Trading
---
# AMMWithdraw
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMWithdraw.cpp "Source")

View File

@@ -4,7 +4,6 @@ seo:
labels:
- Transaction Sending
status: not_enabled
category: Other
---
# Batch
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Batch.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Cancel a check.
labels:
- Checks
category: Payments
---
# CheckCancel
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CancelCheck.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Redeem a check.
labels:
- Checks
category: Payments
---
# CheckCash
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CashCheck.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Create a check.
labels:
- Checks
category: Payments
---
# CheckCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateCheck.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Claw back tokens you've issued.
labels:
- Tokens
category: Payments
---
# Clawback
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Clawback.cpp "Source")

View File

@@ -1,9 +1,6 @@
---
seo:
description: Accept a credential provisionally issued to your account.
labels:
- Credentials
category: Settings
---
# CredentialAccept
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source")

View File

@@ -1,9 +1,6 @@
---
seo:
description: Provisionally issue a credential to a subject account.
labels:
- Credentials
category: Settings
---
# CredentialCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source")

View File

@@ -1,9 +1,6 @@
---
seo:
description: Remove a credential from the ledger, effectively revoking it.
labels:
- Credentials
category: Settings
---
# CredentialDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source")

View File

@@ -4,7 +4,7 @@ seo:
labels:
- Accounts
- Permissions
category: Settings
- Delegate
status: not_enabled
---
# DelegateSet

View File

@@ -2,8 +2,7 @@
seo:
description: Preauthorize an account to send payments to you.
labels:
- Permissions
category: Settings
- Security
---
# DepositPreauth
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DepositPreauth.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Delete a Decentralized Identifier.
labels:
- DID
category: Other
---
# DIDDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Create or update a Decentralized Identifier.
labels:
- DID
category: Other
---
# DIDSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Cancel an expired escrow, returning the funds to the sender.
labels:
- Escrow
category: Payments
---
# EscrowCancel
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Escrow funds, which can be released to the destination after a specific time or condition.
labels:
- Escrow
category: Payments
---
# EscrowCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Deliver escrowed funds to the intended recipient.
labels:
- Escrow
category: Payments
---
# EscrowFinish
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")

View File

@@ -16,38 +16,5 @@ All transactions have certain fields in common:
Each transaction type has additional fields relevant to the type of action it causes.
## Payments
{% label-grid category="Payments" /%}
## Trading
{% label-grid category="Trading" /%}
## Tokens
{% label-grid category="Tokens" /%}
## Settings
{% label-grid category="Settings" /%}
## Other
{% label-grid category="Other" /%}
<!--
## Manual card grid below (ignore)
{% card-grid layout="2xN" %}
{% nav-card label="AMM" /%}
{% nav-card label="Credentials" /%}
{% nav-card label="Tokens" /%}
{% nav-card label="Transaction Sending" /%}
{% nav-card label="DID" /%}
{% nav-card label="MPTs" /%}
{% nav-card label="NFTs" /%}
{% nav-card label="Decentralized Exchange" /%}
{% nav-card label="Oracles" /%}
{% nav-card label="Sidechains" /%}
{% nav-card label="Permissioned Domains" /%}
{% /card-grid %}
## All Transaction Types Alphabetically
{% child-pages /%}
-->

View File

@@ -3,7 +3,7 @@ seo:
description: Repair corruptions to the XRP ledger's state data.
labels:
- Utilities
category: Other
- Troubleshooting
---
# LedgerStateFix
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/LedgerStateFix.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Set up your account to receive a specific MPT as a holder; or authorize a holder as an MPT issuer.
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenAuthorize
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenAuthorize.cpp "Source")
@@ -16,6 +15,23 @@ Control whether an account can hold a given [Multi-purpose Token (MPT)](../../..
{% amendment-disclaimer name="MPTokensV1" /%}
## Example MPTokenAuthorize JSON
This example assumes that the transaction is submitted by the holder of the token.
```json
{
"TransactionType": "MPTokenAuthorize",
"Account": "rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP",
"MPTokenIssuanceID": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"Fee": "10",
"Flags": 0,
"Sequence": 99537811
}
```
{% tx-example txid="9C19FBB8C0C92C17B11DF626A94303776D44AC36D7A760863FF3585532C38230" /%}
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
| Field | JSON Type | [Internal Type][] | Required? | Description |

View File

@@ -2,8 +2,7 @@
seo:
description: Define the properties of a new Multi-Purpose Token (MPT).
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenIssuanceCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceCreate.cpp "Source")
@@ -21,16 +20,20 @@ This example assumes that the issuer of the token is the signer of the transacti
```json
{
"TransactionType": "MPTokenIssuanceCreate",
"Account": "rajgkBmMxmz161r8bWYH7CQAFZP5bA9oSG",
"AssetScale": 2,
"TransferFee": 314,
"Account": "rNFta7UKwcoiCpxEYbhH2v92numE3cceB6",
"AssetScale": 4,
"TransferFee": 0,
"MaximumAmount": "50000000",
"Flags": 83659,
"MPTokenMetadata": "7B227469636B6572223A20225442494C4C222C20226E616D65223A2022542D42696C6C205969656C6420546F6B656E222C202264657363223A202241207969656C642D62656172696E6720737461626C65636F696E206261636B65642062792073686F72742D7465726D20552E532E205472656173757269657320616E64206D6F6E6579206D61726B657420696E737472756D656E74732E222C202269636F6E223A202268747470733A2F2F6578616D706C652E6F72672F7462696C6C2D69636F6E2E706E67222C202261737365745F636C617373223A2022727761222C202261737365745F737562636C617373223A20227472656173757279222C20226973737565725F6E616D65223A20224578616D706C65205969656C6420436F2E222C202275726C73223A205B7B2275726C223A202268747470733A2F2F6578616D706C657969656C642E636F2F7462696C6C222C202274797065223A202277656273697465222C20227469746C65223A202250726F647563742050616765227D2C207B2275726C223A202268747470733A2F2F6578616D706C657969656C642E636F2F646F6373222C202274797065223A2022646F6373222C20227469746C65223A20225969656C6420546F6B656E20446F6373227D5D2C20226164646974696F6E616C5F696E666F223A207B22696E7465726573745F72617465223A2022352E303025222C2022696E7465726573745F74797065223A20227661726961626C65222C20227969656C645F736F75726365223A2022552E532E2054726561737572792042696C6C73222C20226D617475726974795F64617465223A2022323034352D30362D3330222C20226375736970223A2022393132373936525830227D7D",
"Fee": "10"
"MPTokenMetadata": "7B2274223A225442494C4C222C226E223A22542D42696C6C205969656C6420546F6B656E222C2264223A2241207969656C642D62656172696E6720737461626C65636F696E206261636B65642062792073686F72742D7465726D20552E532E205472656173757269657320616E64206D6F6E6579206D61726B657420696E737472756D656E74732E222C2269223A226578616D706C652E6F72672F7462696C6C2D69636F6E2E706E67222C226163223A22727761222C226173223A227472656173757279222C22696E223A224578616D706C65205969656C6420436F2E222C227573223A5B7B2275223A226578616D706C657969656C642E636F2F7462696C6C222C2263223A2277656273697465222C2274223A2250726F647563742050616765227D2C7B2275223A226578616D706C657969656C642E636F2F646F6373222C2263223A22646F6373222C2274223A225969656C6420546F6B656E20446F6373227D5D2C226169223A7B22696E7465726573745F72617465223A22352E303025222C22696E7465726573745F74797065223A227661726961626C65222C227969656C645F736F75726365223A22552E532E2054726561737572792042696C6C73222C226D617475726974795F64617465223A22323034352D30362D3330222C226375736970223A22393132373936525830227D7D",
"Fee": "12",
"Flags": 122,
"Sequence": 99536574
}
```
{% tx-example txid="F4491A84EE3BC27A2F5B63FEBF0CB310368E27E9EF07E00A46F1DC2764852133" /%}
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
| Field | JSON Type | [Internal Type][] | Required? | Description |

View File

@@ -2,8 +2,7 @@
seo:
description: Delete a Multi-Purpose Token definition.
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenIssuanceDestroy
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceDestroy.cpp "Source")
@@ -17,11 +16,15 @@ Delete a [Multi-purpose Token (MPT)](../../../../concepts/tokens/fungible-tokens
```json
{
"TransactionType": "MPTokenIssuanceDestroy",
"Account": "rNFta7UKwcoiCpxEYbhH2v92numE3cceB6",
"MPTokenIssuanceID": "05EECEBC97A7D635DE2393068691A015FED5A89AD203F5AA",
"Fee": "10",
"MPTokenIssuanceID": "00070C4495F14B0E44F78A264E41713C64B5F89242540EE255534400000000000000"
"Flags": 0,
"Sequence": 99536573
}
```
{% tx-example txid="B270DEE7D229D626699935B7B3CC37A1BAD3E832044CE5129722C2965D3EB228" /%}
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}

View File

@@ -2,8 +2,7 @@
seo:
description: Set mutable properties of a Multi-Purpose Token definition.
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenIssuanceSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceSet.cpp "Source")
@@ -12,17 +11,23 @@ Update a mutable property of a [Multi-purpose Token (MPT)](../../../../concepts/
{% amendment-disclaimer name="MPTokensV1" /%}
## Example
## Example MPTokenIssuanceSet JSON
This example locks the balances of all holders of the specified MPT issuance.
```json
{
"TransactionType": "MPTokenIssuanceSet",
"Account": "rNFta7UKwcoiCpxEYbhH2v92numE3cceB6",
"MPTokenIssuanceID": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"Fee": "10",
"MPTokenIssuanceID": "00070C4495F14B0E44F78A264E41713C64B5F89242540EE255534400000000000000",
"Flags": 1
"Flags": 1,
"Sequence": 99536577
}
```
{% tx-example txid="5DB41F975E3AC04DD4AE9E93764AFBBABB0E4C7322B2D6F2E84B253FAA170BF3" /%}
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
| Field | JSON Type | [Internal Type][] | Required? | Description |

View File

@@ -2,8 +2,7 @@
seo:
description: Accept an offer to buy or sell an NFT.
labels:
- NFTs
category: Trading
- NFTs, Non-fungible Tokens
---
# NFTokenAcceptOffer
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenAcceptOffer.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Permanently destroy an NFT.
labels:
- NFTs
category: Tokens
- Non-fungible Tokens, NFTs
---
# NFTokenBurn
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenBurn.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Cancel offers to buy or sell an NFT.
labels:
- NFTs
category: Trading
- NFTs, Non-fungible Tokens
---
# NFTokenCancelOffer
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCancelOffer.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Create an offer to buy or sell an NFT.
labels:
- NFTs
category: Trading
- Non-fungible Tokens, NFTs
---
# NFTokenCreateOffer
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCreateOffer.cpp "Source")

Some files were not shown because too many files have changed in this diff Show More