From 28de18d7d60244e93b48e1cfbb97468ae4c85f05 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Fri, 3 Oct 2025 16:17:49 -0700 Subject: [PATCH] Use amendment disclaimer & update tx ref intros --- .../accounts/decentralized-identifiers.md | 1 - .../ja/docs/_snippets/clawback-disclaimer.md | 1 - .../docs/concepts/accounts/multi-signing.md | 2 +- @l10n/ja/docs/concepts/accounts/tickets.md | 2 +- .../decentralized-identifiers.md | 6 +-- .../automated-market-makers.md | 2 +- .../fungible-tokens/clawing-back-tokens.md | 6 +-- .../tokens/fungible-tokens/deep-freeze.md | 2 +- .../fungible-tokens/stablecoins/settings.md | 3 +- @l10n/ja/docs/concepts/tokens/nfts/index.md | 2 +- @l10n/ja/docs/concepts/tokens/nfts/trading.md | 2 +- .../account-methods/account_nfts.md | 2 +- .../ledger-methods/ledger_entry.md | 4 +- .../path-and-order-book-methods/amm_info.md | 2 +- .../nft_buy_offers.md | 2 +- .../nft_sell_offers.md | 2 +- .../references/protocol/data-types/nftoken.md | 2 +- .../ledger-entry-types/accountroot.md | 18 ++++----- .../ledger-data/ledger-entry-types/amm.md | 2 +- .../ledger-data/ledger-entry-types/mptoken.md | 2 +- .../ledger-entry-types/mptokenissuance.md | 2 +- .../ledger-entry-types/negativeunl.md | 2 +- .../ledger-entry-types/nftokenoffer.md | 2 +- .../ledger-entry-types/nftokenpage.md | 2 +- .../pseudo-transaction-types/unlmodify.md | 2 +- .../transaction-results/tec-codes.md | 28 +++++++------- .../protocol/transactions/types/accountset.md | 10 ++--- .../protocol/transactions/types/ammbid.md | 2 +- .../transactions/types/ammclawback.md | 2 +- .../protocol/transactions/types/ammcreate.md | 2 +- .../protocol/transactions/types/ammdelete.md | 2 +- .../protocol/transactions/types/ammdeposit.md | 2 +- .../protocol/transactions/types/ammvote.md | 2 +- .../transactions/types/ammwithdraw.md | 2 +- .../transactions/types/checkcreate.md | 2 +- .../protocol/transactions/types/clawback.md | 6 +-- .../transactions/types/nftokenacceptoffer.md | 2 +- .../transactions/types/nftokenburn.md | 2 +- .../transactions/types/nftokencanceloffer.md | 2 +- .../transactions/types/nftokencreateoffer.md | 4 +- .../transactions/types/nftokenmint.md | 2 +- .../types/paymentchannelcreate.md | 2 +- .../protocol/transactions/types/trustset.md | 2 +- .../tokenization/stablecoin-issuer.md | 2 +- docs/_snippets/clawback-disclaimer.md | 1 - docs/concepts/accounts/deleting-accounts.md | 4 +- docs/concepts/accounts/depositauth.md | 24 +++++------- docs/concepts/accounts/multi-signing.md | 2 +- .../accounts/permission-delegation.md | 2 +- docs/concepts/accounts/tickets.md | 4 +- .../consensus-protocol/negative-unl.md | 8 ++-- .../decentralized-storage/credentials.md | 1 - .../decentralized-identifiers.md | 2 +- .../decentralized-storage/price-oracles.md | 18 +++++---- .../automated-market-makers.md | 2 +- .../permissioned-domains.md | 5 ++- .../tokens/fungible-tokens/deep-freeze.md | 2 +- .../fungible-tokens/stablecoins/settings.md | 3 +- docs/concepts/tokens/nfts/dynamic-nfts.md | 21 ++-------- docs/concepts/tokens/nfts/index.md | 2 +- docs/concepts/tokens/nfts/trading.md | 2 +- .../xrpl-sidechains/cross-chain-bridges.md | 2 +- docs/concepts/xrpl-sidechains/index.md | 2 +- .../xrpl-sidechains/witness-servers.md | 2 +- .../account-methods/account_channels.md | 2 +- .../account-methods/account_info.md | 8 ++-- .../account-methods/account_nfts.md | 2 +- .../clio-methods/mpt_holders.md | 2 +- .../ledger-methods/ledger_entry.md | 8 ++-- .../path-and-order-book-methods/amm_info.md | 2 +- .../book_offers.md | 2 +- .../get_aggregate_price.md | 2 +- .../nft_buy_offers.md | 2 +- .../nft_sell_offers.md | 2 +- .../path-and-order-book-methods/path_find.md | 2 +- .../ripple_path_find.md | 2 +- .../channel_authorize.md | 6 +-- .../payment-channel-methods/channel_verify.md | 4 +- .../subscription-methods/subscribe.md | 2 +- .../references/protocol/data-types/nftoken.md | 2 +- .../protocol/data-types/permission-values.md | 3 +- .../ledger-entry-types/accountroot.md | 26 ++++++------- .../ledger-entry-types/amendments.md | 4 +- .../ledger-data/ledger-entry-types/amm.md | 6 +-- .../ledger-data/ledger-entry-types/bridge.md | 2 +- .../ledger-data/ledger-entry-types/check.md | 2 +- .../ledger-entry-types/credential.md | 2 +- .../ledger-entry-types/delegate.md | 2 +- .../ledger-entry-types/depositpreauth.md | 3 +- .../ledger-data/ledger-entry-types/did.md | 2 +- .../ledger-entry-types/directorynode.md | 8 ++-- .../ledger-data/ledger-entry-types/escrow.md | 2 +- .../ledger-entry-types/feesettings.md | 8 ++-- .../ledger-data/ledger-entry-types/mptoken.md | 2 +- .../ledger-entry-types/negativeunl.md | 6 +-- .../ledger-entry-types/nftokenoffer.md | 2 +- .../ledger-entry-types/nftokenpage.md | 2 +- .../ledger-data/ledger-entry-types/offer.md | 6 +-- .../ledger-data/ledger-entry-types/oracle.md | 2 +- .../ledger-entry-types/paychannel.md | 2 +- .../ledger-entry-types/permissioneddomain.md | 2 +- .../ledger-entry-types/signerlist.md | 6 +-- .../ledger-data/ledger-entry-types/ticket.md | 2 +- .../ledger-entry-types/xchainownedclaimid.md | 2 +- .../xchainownedcreateaccountclaimid.md | 2 +- .../protocol/transactions/common-fields.md | 6 +-- .../protocol/transactions/metadata.md | 2 +- .../pseudo-transaction-types/unlmodify.md | 2 +- .../transaction-results/tec-codes.md | 38 +++++++++---------- .../transaction-results/tef-codes.md | 6 +-- .../transaction-results/tem-codes.md | 10 ++--- .../transaction-results/ter-codes.md | 2 +- .../transactions/types/accountdelete.md | 3 +- .../protocol/transactions/types/accountset.md | 19 +++++----- .../protocol/transactions/types/ammbid.md | 2 +- .../transactions/types/ammclawback.md | 6 +-- .../protocol/transactions/types/ammcreate.md | 4 +- .../protocol/transactions/types/ammdelete.md | 4 +- .../protocol/transactions/types/ammdeposit.md | 4 +- .../protocol/transactions/types/ammvote.md | 4 +- .../transactions/types/ammwithdraw.md | 4 +- .../protocol/transactions/types/batch.md | 4 +- .../transactions/types/checkcancel.md | 4 +- .../protocol/transactions/types/checkcash.md | 6 +-- .../transactions/types/checkcreate.md | 6 +-- .../protocol/transactions/types/clawback.md | 30 ++++++--------- .../transactions/types/credentialaccept.md | 8 ++-- .../transactions/types/credentialcreate.md | 8 ++-- .../transactions/types/credentialdelete.md | 8 ++-- .../transactions/types/delegateset.md | 2 +- .../transactions/types/depositpreauth.md | 8 ++-- .../protocol/transactions/types/diddelete.md | 7 ++-- .../protocol/transactions/types/didset.md | 7 ++-- .../transactions/types/escrowcancel.md | 7 ++-- .../transactions/types/escrowcreate.md | 7 ++-- .../transactions/types/escrowfinish.md | 7 ++-- .../transactions/types/ledgerstatefix.md | 8 ++-- .../transactions/types/mptokenauthorize.md | 6 +-- .../types/mptokenissuancecreate.md | 12 ++---- .../types/mptokenissuancedestroy.md | 8 +--- .../transactions/types/mptokenissuanceset.md | 5 +-- .../transactions/types/nftokenacceptoffer.md | 4 +- .../transactions/types/nftokenburn.md | 8 ++-- .../transactions/types/nftokencanceloffer.md | 4 +- .../transactions/types/nftokencreateoffer.md | 8 ++-- .../transactions/types/nftokenmint.md | 6 ++- .../transactions/types/nftokenmodify.md | 6 +-- .../transactions/types/offercancel.md | 4 +- .../transactions/types/offercreate.md | 9 ++--- .../transactions/types/oracledelete.md | 9 ++--- .../protocol/transactions/types/oracleset.md | 9 ++--- .../protocol/transactions/types/payment.md | 12 +++--- .../transactions/types/paymentchannelclaim.md | 4 +- .../types/paymentchannelcreate.md | 4 +- .../transactions/types/paymentchannelfund.md | 2 +- .../types/permissioneddomaindelete.md | 7 ++-- .../types/permissioneddomainset.md | 7 ++-- .../transactions/types/setregularkey.md | 5 +-- .../transactions/types/signerlistset.md | 7 ++-- .../transactions/types/ticketcreate.md | 5 +-- .../protocol/transactions/types/trustset.md | 4 +- .../types/xchainaccountcreatecommit.md | 8 ++-- .../xchainaddaccountcreateattestation.md | 5 +-- .../types/xchainaddclaimattestation.md | 5 +-- .../transactions/types/xchainclaim.md | 7 ++-- .../transactions/types/xchaincommit.md | 8 ++-- .../transactions/types/xchaincreatebridge.md | 7 ++-- .../transactions/types/xchaincreateclaimid.md | 7 ++-- .../transactions/types/xchainmodifybridge.md | 7 ++-- .../create-an-automated-market-maker.md | 2 +- .../set-up-iou-iou-bridge.md | 2 +- .../set-up-xrp-xrp-bridge.md | 2 +- .../submit-cross-chain-transaction.md | 2 +- .../tokenization/stablecoin-issuer.md | 4 +- 174 files changed, 404 insertions(+), 478 deletions(-) delete mode 100644 @l10n/ja/docs/_snippets/clawback-disclaimer.md delete mode 100644 docs/_snippets/clawback-disclaimer.md diff --git a/@l10n/es-ES/docs/concepts/accounts/decentralized-identifiers.md b/@l10n/es-ES/docs/concepts/accounts/decentralized-identifiers.md index 9bbed0905b..1b78f341d4 100644 --- a/@l10n/es-ES/docs/concepts/accounts/decentralized-identifiers.md +++ b/@l10n/es-ES/docs/concepts/accounts/decentralized-identifiers.md @@ -3,7 +3,6 @@ html: decentralized-identifiers.html parent: accounts.html seo: description: Los identificadores decentralizados permiten identidades digitales decentralizadas verificables. -status: not_enabled labels: - DID --- diff --git a/@l10n/ja/docs/_snippets/clawback-disclaimer.md b/@l10n/ja/docs/_snippets/clawback-disclaimer.md deleted file mode 100644 index bc3139d57b..0000000000 --- a/@l10n/ja/docs/_snippets/clawback-disclaimer.md +++ /dev/null @@ -1 +0,0 @@ -_[Clawback amendment](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0039d-clawback)が必要です。_ diff --git a/@l10n/ja/docs/concepts/accounts/multi-signing.md b/@l10n/ja/docs/concepts/accounts/multi-signing.md index a6a0672c49..a5273fc182 100644 --- a/@l10n/ja/docs/concepts/accounts/multi-signing.md +++ b/@l10n/ja/docs/concepts/accounts/multi-signing.md @@ -38,7 +38,7 @@ _([ExpandedSignerList amendment][]により更新されました。)_ また、リスト内の各署名者のエントリに最大256ビットの任意のデータを追加することができます。このデータはネットワークで必要とされたり使用されたりすることはありませんが、スマートコントラクトや他のアプリケーションが署名者に関する他のデータを特定したり確認したりするために使用することができます。 -_([ExpandedSignerList amendment][]により追加されました。)_ +{% amendment-disclaimer name="ExpandedSignerList" /%} ### Signer WeightとQuorumの使用例 diff --git a/@l10n/ja/docs/concepts/accounts/tickets.md b/@l10n/ja/docs/concepts/accounts/tickets.md index 5598738263..5fb39a1cde 100644 --- a/@l10n/ja/docs/concepts/accounts/tickets.md +++ b/@l10n/ja/docs/concepts/accounts/tickets.md @@ -9,7 +9,7 @@ labels: --- # Ticket -_([TicketBatch amendment][]により追加されました。)_ +{% amendment-disclaimer name="TicketBatch" /%} XRP Ledgerのチケットは、取引をすぐに送信せずに、その取引のために[シーケンス番号][]を確保する方法です。チケットを使うことで、通常の順序以外で取引を送信することができます。この使用例としては、必要な署名を集めるのに時間がかかるような[マルチサイン取引](multi-signing.md)などが挙げられます。 diff --git a/@l10n/ja/docs/concepts/decentralized-storage/decentralized-identifiers.md b/@l10n/ja/docs/concepts/decentralized-storage/decentralized-identifiers.md index 3a871e21a4..937a136b34 100644 --- a/@l10n/ja/docs/concepts/decentralized-storage/decentralized-identifiers.md +++ b/@l10n/ja/docs/concepts/decentralized-storage/decentralized-identifiers.md @@ -1,16 +1,11 @@ --- -html: decentralized-identifiers.html -parent: accounts.html seo: description: 分散型IDは、検証可能な分散型デジタルIDを可能にします。 -status: not_enabled labels: - DID --- # 分散型ID -_([DID Amendment][] {% not-enabled /%} が必要です。)_ - 分散型ID(DID)は、検証可能なデジタルIDを可能にするWorld Wide Web Consortium(W3C)によって定義された新しいタイプの識別子です。DIDはDID所有者の完全な管理下にあり、中央管理レジストリ、IDプロバイダ、認証局から独立しています。 DIDの主な基本原則は以下の通りです。 @@ -25,6 +20,7 @@ DIDの主な基本原則は以下の通りです。 {% admonition type="info" name="注記" %}XRP LedgerにおけるDIDの実装は、[DID v1.0仕様](https://www.w3.org/TR/did-core/)の仕様に準拠しています。{% /admonition %} +{% amendment-disclaimer name="DID" /%} ## 仕組み diff --git a/@l10n/ja/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md b/@l10n/ja/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md index 862581e11e..87eb9e84ca 100644 --- a/@l10n/ja/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md +++ b/@l10n/ja/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md @@ -8,7 +8,7 @@ labels: --- # 自動マーケットメーカー(AMM)とは? -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} 自動マーケットメーカー(AMM)は、XRP Ledgerの分散型取引所において流動性を提供します。個々のAMMは2つの資産のプールを保有します。ユーザは数式で定められた取引レートによりその2つの資産間でスワップが可能です。 diff --git a/@l10n/ja/docs/concepts/tokens/fungible-tokens/clawing-back-tokens.md b/@l10n/ja/docs/concepts/tokens/fungible-tokens/clawing-back-tokens.md index fdbf9edec2..36535a0f53 100644 --- a/@l10n/ja/docs/concepts/tokens/fungible-tokens/clawing-back-tokens.md +++ b/@l10n/ja/docs/concepts/tokens/fungible-tokens/clawing-back-tokens.md @@ -1,6 +1,4 @@ --- -html: clawing-back-tokens.html -parent: trust-lines-and-issuing.html seo: description: 発行者は、トークンを発行する前にClawback機能を有効にすると、規制遵守の目的でトークンを取り戻すことができます。 labels: @@ -8,8 +6,6 @@ labels: --- # トークンの回収 -{% partial file="/@l10n/ja/docs/_snippets/clawback-disclaimer.md" /%} - 規制上の目的から、トークンがアカウントに送信された後にトークンを回収する機能を必要とする発行者が存在します。例えば、トークンが違法行為で制裁を受けたアカウントに送られたことが発覚した場合、発行者はその資金を「回収」することができます。 発行者は、発行アカウントで**Allow Clawback**フラグを有効にすることで、トークンを回収する権限を得ることができます。発行者がすでにトークンを発行している場合、このフラグを有効にすることはできません。 @@ -21,6 +17,8 @@ Clawback機能はデフォルトで無効になっています。使用するに `lsfNoFreeze`が設定されているときに`lsfAllowTrustLineClawback`を設定しようとすると、トランザクションは`tecNO_PERMISSION`を返します。 逆に、`lsfAllowTrustLineClawback`が設定されている時に`lsfNoFreeze`を設定しようとすると、トランザクションは`tecNO_PERMISSION`を返します。 +{% amendment-disclaimer name="Clawback" /%} + ## Clawbackトランザクションの例 ```json diff --git a/@l10n/ja/docs/concepts/tokens/fungible-tokens/deep-freeze.md b/@l10n/ja/docs/concepts/tokens/fungible-tokens/deep-freeze.md index f2e5ff2f48..128c5675ab 100644 --- a/@l10n/ja/docs/concepts/tokens/fungible-tokens/deep-freeze.md +++ b/@l10n/ja/docs/concepts/tokens/fungible-tokens/deep-freeze.md @@ -14,7 +14,7 @@ labels: ディープフリーズは、支払い、オファー、分散型取引所（DEX）、自動マーケットメイカー（AMM）に関わるトラストラインに影響を与えます。発行者は、ディープフリーズ状態の保有者に対して、送金および受取をブロックできます。 -_([DeepFreeze amendment][]により追加されました。)_ +{% amendment-disclaimer name="DeepFreeze" /%} ## ディープフリーズの仕組み diff --git a/@l10n/ja/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md b/@l10n/ja/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md index 0697f28f88..3405dd50f7 100644 --- a/@l10n/ja/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md +++ b/@l10n/ja/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md @@ -82,12 +82,11 @@ KYC(Know Your Customer)やAML(Anti-Money Laundering)などのコンプライア ### Clawbackフラグ -_([Clawback amendment](/resources/known-amendments.md#clawback) が必要です。)_ - Clawbackにより、特定の状況下でトラストラインからステーブルコインを回収(クローバック)することができます。これにより、アカウントへのアクセス不能や悪意のある活動などの課題に対応する能力が追加されます。 [Clawback](../../../../references/protocol/transactions/types/clawback.md)をご覧ください。 +{% amendment-disclaimer name="Clawback" /%} ### 固定供給量 diff --git a/@l10n/ja/docs/concepts/tokens/nfts/index.md b/@l10n/ja/docs/concepts/tokens/nfts/index.md index 8d8f6d644f..25876f970e 100644 --- a/@l10n/ja/docs/concepts/tokens/nfts/index.md +++ b/@l10n/ja/docs/concepts/tokens/nfts/index.md @@ -11,7 +11,7 @@ labels: XRP Ledgerは、非代替性トークン(NFT)をネイティブにサポートしています。 非代替性トークンは、芸術作品やゲーム内アイテムなど、ユニークな物理的、非物理的、あるいは純粋なデジタル商品の所有権を証明する役割を果たします。 -_([NonFungibleTokensV1_1 amendment][]により追加されました。)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} このようなデジタル資産を表現するには、XRP LedgerのNon-Fungible Tokens機能（スタンダードドラフト番号で[XLS-20](https://github.com/XRPLF/XRPL-Standards/discussions/46)と呼ばれることもあります）を使用します。 diff --git a/@l10n/ja/docs/concepts/tokens/nfts/trading.md b/@l10n/ja/docs/concepts/tokens/nfts/trading.md index 1e798717c6..612f84f42a 100644 --- a/@l10n/ja/docs/concepts/tokens/nfts/trading.md +++ b/@l10n/ja/docs/concepts/tokens/nfts/trading.md @@ -12,7 +12,7 @@ labels: XRP Ledger上のアカウント間で`NFToken`オブジェクトを転送することができます。`NFToken`の売買をオファーしたり、他のアカウントから自分が保有するNFTokenへの売買オファーを受け入れることができます。`NFToken`を無料(価格が0)で売却することで、`NFToken`を配布することもできます。すべてのオファーは[NFTokenCreateOfferトランザクション][]を使って作成されます。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## 売却オファー diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md index 28e3bf5d28..36a0318b4d 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md @@ -11,7 +11,7 @@ labels: `account_nfts`メソッドは、指定したアカウントの`NFToken`オブジェクトの一覧を返します。 -_([NonFungibleTokensV1_1 amendment][]により追加されました。)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## リクエストのフォーマット リクエストのフォーマットの例 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index c3515fb583..b91fd1f711 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -164,7 +164,7 @@ rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 ### AMMエントリを取得する -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} レジャーからAutomated Market-Maker(AMM)エントリを取得します。これは[amm_infoメソッド][]と似ていますが、`ledger_entry`は保存されているレジャーエントリのみを返します。 @@ -787,7 +787,7 @@ rippled json ledger_entry '{ "deposit_preauth": { "owner": "rf1BiGeXwwQoi8Z2ueFY ### Ticketエントリを取得する -将来の使用のために確保された[シーケンス番号][]を表す[Ticketエントリ](../../../protocol/ledger-data/ledger-entry-types/ticket.md)を取得します。文字列(TicketのエントリID)またはオブジェクトを指定します。 _([TicketBatch amendment][]により追加されました。)_ +将来の使用のために確保された[シーケンス番号][]を表す[Ticketエントリ](../../../protocol/ledger-data/ledger-entry-types/ticket.md)を取得します。文字列(TicketのエントリID)またはオブジェクトを指定します。 {% amendment-disclaimer name="TicketBatch" /%} | フィールド | 型 | 説明 | |:--------------------|:-----------------------|:----------------------| diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md index 95f891f509..dde560028f 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md @@ -14,7 +14,7 @@ labels: {% code-page-name /%}メソッドは、自動マーケットメーカー（AMM）インスタンスに関する情報を取得します。 -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} ### リクエストのフォーマット diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md index 583589fb2a..1e6c08539a 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md @@ -11,7 +11,7 @@ labels: `nft_buy_offers`メソッドは、与えられた[NFToken][]オブジェクトに対する購入オファーのリストを返します。 -_([NonFungibleTokensV1_1 amendment][]により追加されました。)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## リクエストのフォーマット リクエストのフォーマットの例： diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md index 9382f4abf0..f7747f8581 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md @@ -11,7 +11,7 @@ labels: `nft_sell_offers`メソッドは、与えられた[NFToken][]オブジェクトに対する売却オファーのリストを返します。 -_([NonFungibleTokensV1_1 amendment][]により追加されました。)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## リクエストのフォーマット リクエストのフォーマットの例： diff --git a/@l10n/ja/docs/references/protocol/data-types/nftoken.md b/@l10n/ja/docs/references/protocol/data-types/nftoken.md index c966c0e0ed..86b2617e7e 100644 --- a/@l10n/ja/docs/references/protocol/data-types/nftoken.md +++ b/@l10n/ja/docs/references/protocol/data-types/nftoken.md @@ -10,7 +10,7 @@ labels: `NFToken`オブジェクトは、1つの非代替性トークン(NFT)を表します。単体では保存されず、他の`NFToken`オブジェクトと共に[NFTokenPageオブジェクト][]に格納されます。 -_([NonFungibleTokensV1_1 amendment][]により追加されました。)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md index 92f5ac3a7f..f0d37784f0 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md @@ -1,6 +1,4 @@ --- -html: accountroot.html -parent: ledger-entry-types.html seo: description: あるアカウントの設定、XRP残高、その他のメタデータを表します。 labels: @@ -41,7 +39,7 @@ labels: |:------------------------------|:---------|:------------------|:------|:------| | `Account` | 文字列 | AccountID | はい | この[アカウント](../../../../concepts/accounts/index.md)を識別するための（クラシック）アドレスです。 | | `AccountTxnID` | 文字列 | UInt256 | いいえ | このアカウントから直近に送信されたトランザクションの識別ハッシュ。このフィールドは、[`AccountTxnID`トランザクションフィールド](../../transactions/common-fields.md#accounttxnid)を使うために有効になっていなければなりません。これを有効にするには、[`asfAccountTxnID`フラグを有効にしたAccountSetトランザクション](../../transactions/types/accountset.md#accountsetのフラグ)を送信してください。 | -| `AMMID` | 文字列 | UInt256 | いいえ | _([AMM amendment][]により追加されました。)_ 対応するAMMレジャーエントリのレジャーエントリID。アカウント作成時に設定します。AMM以外のアカウントでは常に省略されます。 | +| `AMMID` | 文字列 | UInt256 | いいえ | {% amendment-disclaimer name="AMM" /%} 対応するAMMレジャーエントリのレジャーエントリID。アカウント作成時に設定します。AMM以外のアカウントでは常に省略されます。 | | `Balance` | 文字列 | Amount | いいえ | アカウントの現在の[XRPのdrop数][]で、文字列で表現されます。 | | `BurnedNFTokens` | 数値 | UInt32 | いいえ | このアカウントで発行された [非代替性トークン](../../../../concepts/tokens/nfts/index.md) のうち、バーンしたトークンの総数を表します。この数値は常に `MintedNFTokens` と同じかそれ以下となります。 | | `Domain` | 文字列 | VariableLength | いいえ | このアカウントに関連付けられたドメイン。JSONでは、ドメインのASCII表現を16進数で表現します。[256バイトを超える長さは使用できません](https://github.com/xrplf/rippled/blob/55dc7a252e08a0b02cd5aa39e9b4777af3eafe77/src/ripple/app/tx/impl/SetAccount.h#L34) | @@ -56,7 +54,7 @@ labels: | `PreviousTxnLgrSeq` | 数値 | UInt32 | はい | 最後にこのオブジェクトを変更したトランザクションが記録された[レジャーインデックス][]。 | | `RegularKey` | 文字列 | AccountID | いいえ | このアカウントのトランザクションに署名するときにマスターキーの代わりに使用できる[キーペア](../../../../concepts/accounts/cryptographic-keys.md)のアドレス。この値を変更するには[SetRegularKeyトランザクション][]を使用してください。 | | `Sequence` | 数値 | UInt32 | はい | このアカウントの有効な次のトランザクションの[シーケンス番号](../../data-types/basic-data-types.md#アカウントシーケンス) を表します。 | -| `TicketCount` | 数値 | UInt32 | いいえ | このアカウントが台帳に保有する[チケット](../../../../concepts/accounts/tickets.md)の数です。これは、アカウントが一度に250 チケットという上限以内に留まることを保証するために自動的に更新されます。このフィールドは、チケットの数がゼロの場合は省略されます。 _([TicketBatch amendment][]により追加されました)_ | +| `TicketCount` | 数値 | UInt32 | いいえ | このアカウントが台帳に保有する[チケット](../../../../concepts/accounts/tickets.md)の数です。これは、アカウントが一度に250 チケットという上限以内に留まることを保証するために自動的に更新されます。このフィールドは、チケットの数がゼロの場合は省略されます。 {% amendment-disclaimer name="TicketBatch" /%} | | `TickSize` | 数値 | UInt8 | いいえ | このアドレスが発行した通貨が関わるオファーの為替レートに使用する有効桁数。有効な値は`3`以上`15`以下です。_（[TickSize Amendment][]により追加されました。）_ | | `TransferRate` | 数値 | UInt32 | いいえ | このアカウントが発行した通貨を他のユーザが相互に送金する際に、これらのユーザに請求する[送金手数料](../../../../concepts/tokens/fungible-tokens/transfer-fees.md)。 | | `WalletLocator` | 文字列 | UInt256 | いいえ | ユーザが設定できる任意の256bit値。 | @@ -64,7 +62,7 @@ labels: ## AMMの特殊なAccountRootエントリ -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} [自動マーケットメーカー](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)(AMM)は、AMMの詳細の一部を追跡するための[AMMレジャーエントリ](amm.md)に加えて、LPトークンを発行しAMMプール内の資産を保持するためにAccountRootレジャーエントリを使用します。AMMに関連するAccountRootのアドレスは、AMMが作成される前にユーザがそのアドレスを特定し資金を提供できないように、ランダム化されています。AMMのAccountRootは、通常のアカウントとは異なり、以下のような設定で作成されます。 @@ -89,14 +87,14 @@ AccountRootオブジェクトは`Flags`フィールドに以下のフラグを | フラグ名 | 16進数値 | 10進数値 | 対応する[AccountSetのフラグ](../../transactions/types/accountset.md#accountsetのフラグ) | 説明 | |-----------------------------------|--------------|----------|-------------------------------------|-------------------------------| -| `lsfAllowTrustLineClawback` | `0x80000000` | 2147483648 | `asfAllowTrustLineClawback` | このアカウントの[Clawback](../../../../concepts/tokens/fungible-tokens/clawing-back-tokens.md)を有効にします。 _([Clawback Amendment][]が必要です。)_ | +| `lsfAllowTrustLineClawback` | `0x80000000` | 2147483648 | `asfAllowTrustLineClawback` | このアカウントの[Clawback](../../../../concepts/tokens/fungible-tokens/clawing-back-tokens.md)を有効にします。 {% amendment-disclaimer name="Clawback" /%} | | `lsfDefaultRipple` | `0x00800000` | 8388608 | `asfDefaultRipple` | このアドレスのトラストラインでデフォルトで[rippling](../../../../concepts/tokens/fungible-tokens/rippling.md)を有効にします。発行アドレスに必要です。他のアドレスでの使用は推奨されません。 | | `lsfDepositAuth` | `0x01000000` | 16777216 | `asfDepositAuth` | このアカウントは、アカウントが送信するトランザクションと、[事前承認された](../../../../concepts/accounts/depositauth.md#事前承認)アカウントからの資金だけを受領します。（[DepositAuth](../../../../concepts/accounts/depositauth.md)が有効になっています。） | | `lsfDisableMaster` | `0x00100000` | 1048576 | `asfDisableMaster` | このアカウントのトランザクションの署名にマスターキーを使用することを禁止します。 | -| `lsfDisallowIncomingCheck` | `0x08000000` | 134217728 | `asfDisallowIncomingCheck` | このアカウントを宛先とするチェックの作成をブロックします。 _([DisallowIncoming Amendment][]により追加されました。)_ | -| `lsfDisallowIncomingNFTokenOffer` | `0x04000000` | 67108864 | `asfDisallowIncomingNFTokenOffer` | このアカウントを宛先とするNFTokenオファーの作成をブロックします。 _([DisallowIncoming Amendment][]により追加されました。)_ | -| `lsfDisallowIncomingPayChan` | `0x10000000` | 268435456 | `asfDisallowIncomingPayChan` | このアカウントを宛先とするペイメントチャネルの作成をブロックします。 _([DisallowIncoming Amendment][]により追加されました。)_ | -| `lsfDisallowIncomingTrustline` | `0x20000000` | 536870912 | `asfDisallowIncomingTrustline` | このアカウントに対するトラストラインの作成をブロックします。 _([DisallowIncoming Amendment][]により追加されました。)_ | +| `lsfDisallowIncomingCheck` | `0x08000000` | 134217728 | `asfDisallowIncomingCheck` | このアカウントを宛先とするチェックの作成をブロックします。 {% amendment-disclaimer name="DisallowIncoming" /%} | +| `lsfDisallowIncomingNFTokenOffer` | `0x04000000` | 67108864 | `asfDisallowIncomingNFTokenOffer` | このアカウントを宛先とするNFTokenオファーの作成をブロックします。 {% amendment-disclaimer name="DisallowIncoming" /%} | +| `lsfDisallowIncomingPayChan` | `0x10000000` | 268435456 | `asfDisallowIncomingPayChan` | このアカウントを宛先とするペイメントチャネルの作成をブロックします。 {% amendment-disclaimer name="DisallowIncoming" /%} | +| `lsfDisallowIncomingTrustline` | `0x20000000` | 536870912 | `asfDisallowIncomingTrustline` | このアカウントに対するトラストラインの作成をブロックします。 {% amendment-disclaimer name="DisallowIncoming" /%} | | `lsfDisallowXRP` | `0x00080000` | 524288 | `asfDisallowXRP` | クライアントアプリケーションはこのアカウントにXRPを送金しないでください。`rippled`により強制されるものではありません。 | | `lsfGlobalFreeze` | `0x00400000` | 4194304 | `asfGlobalFreeze` | このアドレスが発行するすべての資産がフリーズされます。 | | `lsfNoFreeze` | `0x00200000` | 2097152 | `asfNoFreeze` | このアドレスは、このアドレスに接続しているトラストラインをフリーズできません。一度有効にすると、無効にできません。 | diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/amm.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/amm.md index 5bfea97665..a5f5a4d276 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/amm.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/amm.md @@ -9,7 +9,7 @@ labels: # AMM [[ソース]](https://github.com/xrplf/rippled/blob/c1e4bfb08bcc9f187d794a71d653003a6148dc68/src/ripple/protocol/impl/LedgerFormats.cpp#L265-L275 "Source") -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} `AMM`レジャーエントリは、単一の[自動マーケットメーカー](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)(AMM)インスタンスを表します。これは常に[特殊なAccountRootエントリ](accountroot.md#ammの特殊なaccountrootエントリ)と対になっています。 diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md index 7883d76fd3..faca502fe5 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md @@ -10,7 +10,7 @@ labels: `MPTokenIssuanceID`.`MPToken`オブジェクトは、トークン発行者ではないアカウントが保有する複数のトークンを表します。MPTは通常の支払いやDEXトランザクションを通じて取得され、これらと同じタイプのトランザクションを使用してオプションで償還または交換することができます。MPTokenのオブジェクトキーは、スペースキー、保有者のアドレス、および`MPTokenIssuanceID`をハッシュ化することで生成されます。 -_([MPTokensV1_1 amendment][]により追加されました。)_ +{% amendment-disclaimer name="MPTokensV1_1" /%} ## MPToken JSONの例 diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md index 1d00d6601a..fb94e4b901 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md @@ -10,7 +10,7 @@ labels: `MPTokenIssuance`オブジェクトは、単一のMPT Issuanceを表し、Issuance自体に関連するデータを保持します。このIssuanceは`MPTokenIssuanceCreate`トランザクションを使用して作成され、`MPTokenIssuanceDestroy`トランザクションによって破棄することができます。 -_([MPTokensV1_1 amendment][]により追加されました。)_ +{% amendment-disclaimer name="MPTokensV1_1" /%} ## MPTokenIssuance JSONの例 diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md index 225672dd82..80131a8e3a 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md @@ -8,7 +8,7 @@ labels: --- # NegativeUNL -_([NegativeUNL amendment][]により追加されました。)_ +{% amendment-disclaimer name="NegativeUNL" /%} `NegativeUNL`オブジェクトタイプは、[ネガティブUNL](../../../../concepts/consensus-protocol/negative-unl.md)の現在の状態、つまり現在オフラインであると考えられる信頼できるバリデーションのリストを含んでいます。 diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md index 6dad37f62f..725b12e38c 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md @@ -10,7 +10,7 @@ labels: `lsfTransferable`フラグが設定されているトークンは、オファーを使って参加者間で転送することができます。`NFTokenOffer`オブジェクトは`NFToken`オブジェクトの購入、売却、または譲渡のオファーを表します。`NFToken`の所有者は`NFTokenCreateOffer`を使用して売買を行うことができます。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md index 38e8f382f3..c3b1844344 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md @@ -10,7 +10,7 @@ labels: `NFTokenPage`オブジェクトは、同じアカウントが所有する[NFT](../../../../concepts/tokens/nfts/index.md)のコレクションを表します。一つのアカウントは複数の`NFTokenPage`エントリを持つことができ、それらは双方向リストを形成します。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## {% $frontmatter.seo.title %}のJSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md b/@l10n/ja/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md index 56213536da..2167875bc0 100644 --- a/@l10n/ja/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md +++ b/@l10n/ja/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md @@ -8,7 +8,7 @@ labels: --- # UNLModify -_([NegativeUNL amendment][]により追加されました)_ +{% amendment-disclaimer name="NegativeUNL" /%} `UNLModify`[疑似トランザクション](pseudo-transaction-types.md)は[Negative UNL](../../../../concepts/consensus-protocol/negative-unl.md)の変更を示し、信頼できるバリデータがオフラインになったかオンラインに戻ってきたことを示します。 diff --git a/@l10n/ja/docs/references/protocol/transactions/transaction-results/tec-codes.md b/@l10n/ja/docs/references/protocol/transactions/transaction-results/tec-codes.md index bd9db8c5d6..809622c031 100644 --- a/@l10n/ja/docs/references/protocol/transactions/transaction-results/tec-codes.md +++ b/@l10n/ja/docs/references/protocol/transactions/transaction-results/tec-codes.md @@ -17,14 +17,14 @@ labels: | コード | 値 | 説明 | |:---------------------------------- |:----|:----------------------------------------| -| `tecAMM_ACCOUNT` | 168 | 自動マーケットメーカー（AMM）アカウントではこの操作が許可されていないため、トランザクションが失敗しました。 _([AMM amendment][]により追加されました。)_ | -| `tecAMM_UNFUNDED` | 162 | 送信者が指定された資産を十分に保有していないため[AMMCreateトランザクション][]が失敗しました。 _([AMM amendment][]により追加されました。)_ | -| `tecAMM_BALANCE` | 163 | AMMまたはユーザーが指定された資産の十分な量を保有していないため[AMMDeposit][]または[AMMWithdraw][]トランザクションが失敗しました。(例えば、AMMが保有するよりも多くを引き出そうとしている場合） _([AMM amendment][]により追加されました。)_ | -| `tecAMM_EMPTY` | 166 | AMMのプールに資産がないためAMM関連のトランザクションが失敗しました。この状態では、AMMを削除するか、新しい入金でAMMに資金を供給することしかできません。 _([AMM amendment][]により追加されました。)_ | -| `tecAMM_FAILED` | 164 | AMM関連のトランザクションは失敗しました。[AMMDeposit][]または[AMMWithdraw][]の場合、これは送信者が指定された資産を十分に持っていないか、利用可能な金額では不可能な実効価格がトランザクションで要求されたことが原因である可能性があります。[AMMBid][]の場合、これは当該アカウントが落札に必要な金額を十分に持っていないか、指定された最高入札価格よりも高い金額が必要であることが原因である可能性があります。[AMMVote] の場合、このAMMのLPトークンをより多く保有している他のアカウントからの投票がすでに多すぎるのが原因である可能性があります。 _([AMM amendment][]により追加されました。)_ | -| `tecAMM_INVALID_TOKENS` | 165 | LPトークンの不足や丸め処理の問題により、AMM関連のトランザクションが失敗しました。例えば、返却されるLPトークンの額がゼロに切り捨てられる場合、「非常に少量の資産を預け入れる」という行為が失敗する可能性があります。 _([AMM amendment][]により追加されました。)_ | -| `tecAMM_NOT_EMPTY` | 167 | トランザクションは、資産プールが空のAMMで動作するように設計されていましたが、指定されたAMMは資産を保有しています。 _([AMM amendment][]により追加されました。)_ | -| `tecCANT_ACCEPT_OWN_NFTOKEN_OFFER` | 157 | トランザクションは、同じアカウントが購入または売却するために作成された[非代替可能トークン(NFT)](../../../../concepts/tokens/nfts/index.md)のオファーを受け入れようとしました。 _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | +| `tecAMM_ACCOUNT` | 168 | 自動マーケットメーカー（AMM）アカウントではこの操作が許可されていないため、トランザクションが失敗しました。 {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_UNFUNDED` | 162 | 送信者が指定された資産を十分に保有していないため[AMMCreateトランザクション][]が失敗しました。 {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_BALANCE` | 163 | AMMまたはユーザーが指定された資産の十分な量を保有していないため[AMMDeposit][]または[AMMWithdraw][]トランザクションが失敗しました。(例えば、AMMが保有するよりも多くを引き出そうとしている場合） {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_EMPTY` | 166 | AMMのプールに資産がないためAMM関連のトランザクションが失敗しました。この状態では、AMMを削除するか、新しい入金でAMMに資金を供給することしかできません。 {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_FAILED` | 164 | AMM関連のトランザクションは失敗しました。[AMMDeposit][]または[AMMWithdraw][]の場合、これは送信者が指定された資産を十分に持っていないか、利用可能な金額では不可能な実効価格がトランザクションで要求されたことが原因である可能性があります。[AMMBid][]の場合、これは当該アカウントが落札に必要な金額を十分に持っていないか、指定された最高入札価格よりも高い金額が必要であることが原因である可能性があります。[AMMVote] の場合、このAMMのLPトークンをより多く保有している他のアカウントからの投票がすでに多すぎるのが原因である可能性があります。 {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_INVALID_TOKENS` | 165 | LPトークンの不足や丸め処理の問題により、AMM関連のトランザクションが失敗しました。例えば、返却されるLPトークンの額がゼロに切り捨てられる場合、「非常に少量の資産を預け入れる」という行為が失敗する可能性があります。 {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_NOT_EMPTY` | 167 | トランザクションは、資産プールが空のAMMで動作するように設計されていましたが、指定されたAMMは資産を保有しています。 {% amendment-disclaimer name="AMM" /%} | +| `tecCANT_ACCEPT_OWN_NFTOKEN_OFFER` | 157 | トランザクションは、同じアカウントが購入または売却するために作成された[非代替可能トークン(NFT)](../../../../concepts/tokens/nfts/index.md)のオファーを受け入れようとしました。 {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecCLAIM` | 100 | 不明なエラー。トランザクションコストは消却されました。 | | `tecCRYPTOCONDITION_ERROR` | 146 | この[EscrowCreate][]トランザクションまたは[EscrowFinish][]トランザクションに指定されるCrypto-conditionの形式が誤っているか、または一致しませんでした。 | | `tecDIR_FULL` | 121 | トランザクションがアカウントの所有者ディレクトリにオブジェクト（トラストライン、Check、Escrow、Payment Channelなど）を追加しようと試みましたが、このアカウントはレジャーにこれ以上のオブジェクトを所有できません。 | @@ -38,16 +38,16 @@ labels: | `tecINSUF_RESERVE_LINE` | 122 | 送信側アカウントに、新しいトラストラインを作成するのに十分なXRPがないため、トランザクションが失敗しました。（[準備金](../../../../concepts/accounts/reserves.md)をご覧ください）このエラーは、取引相手から同一通貨の送信側アカウントへのトラストラインがデフォルト以外の状態である場合に発生します。（その他のケースについては`tecNO_LINE_INSUF_RESERVE`をご覧ください。） | | `tecINSUF_RESERVE_OFFER` | 123 | 送信側アカウントに、新しいオファーを作成するのに十分なXRPがないため、トランザクションが失敗しました。（[準備金](../../../../concepts/accounts/reserves.md)をご覧ください。) | | `tecINSUFF_FEE` | 136 | 指定された[トランザクションコスト](../../../../concepts/transactions/transaction-cost.md)を支払うのに十分なXRPが送金元アカウントにないため、トランザクションが失敗しました。（この場合、送金元のXRPが指定されたトランザクションコストよりも低い場合でも、トランザクション処理によってすべて消却されます。）この結果は、このトランザクションがコンセンサスセットに含まれるのに十分なネットワークに配布された*後に*アカウントの残高が減少した場合にのみ発生します。そうでない場合、トランザクションは配布される前に[`terINSUF_FEE_B`](ter-codes.md)で失敗します。 | -| `tecINSUFFICIENT_FUNDS` | 158 | 関連するアカウントのうちの1つが必要な資産を十分に保有していません。 _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | -| `tecINSUFFICIENT_PAYMENT` | 161 | 指定された金額は、トランザクションに関わるすべての料金を支払うには十分ではありません。例えば、非代替性トークンを取引する場合、購入金額はブローカー手数料と販売金額の両方を支払うには不十分である可能性があります。 _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | +| `tecINSUFFICIENT_FUNDS` | 158 | 関連するアカウントのうちの1つが必要な資産を十分に保有していません。 {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | +| `tecINSUFFICIENT_PAYMENT` | 161 | 指定された金額は、トランザクションに関わるすべての料金を支払うには十分ではありません。例えば、非代替性トークンを取引する場合、購入金額はブローカー手数料と販売金額の両方を支払うには不十分である可能性があります。 {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecINSUFFICIENT_RESERVE` | 141 | トランザクションによって[必要準備金](../../../../concepts/accounts/reserves.md)が増加し、送信側アカウントの残高を超える可能性があります。[SignerListSet][]、[PaymentChannelCreate][]、[PaymentChannelFund][]、および[EscrowCreate][]からこのエラーコードが返されることがあります。詳細は、[SignerListと準備金](../../ledger-data/ledger-entry-types/signerlist.md#signerlistと準備金)をご覧ください。 | | `tecINTERNAL` | 144 | 不明な内部エラーが発生し、トランザクションコストは適用されました。通常はこのエラーは返されません。このエラーを再現できる場合は、[問題を報告](https://github.com/XRPLF/rippled/issues)してください。 | | `tecINVARIANT_FAILED` | 147 | このトランザクションを実行しようとしたところ、不変性チェックが失敗しました。[EnforceInvariants Amendment][]により追加されました。このエラーを再現できる場合は、[問題を報告](https://github.com/XRPLF/rippled/issues)してください。 | | `tecKILLED` | 150 | [OfferCreateトランザクション][]がtfFillOrKillフラグを指定しましたが、トランザクションを確定できなかったため、このトランザクションは取り消されました。_（[fix1578 Amendment][]により追加されました。）_ | -| `tecMAX_SEQUENCE_REACHED` | 153 | シーケンス番号フィールドはすでに最大値に達しています。これには`MintedNFTokens`フィールドも含まれます。 _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | +| `tecMAX_SEQUENCE_REACHED` | 153 | シーケンス番号フィールドはすでに最大値に達しています。これには`MintedNFTokens`フィールドも含まれます。 {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecNEED_MASTER_KEY` | 142 | このトランザクションはマスターキーを必要とする変更（[マスターキーの無効化または残高フリーズ能力の放棄](../types/accountset.md#accountsetのフラグ)など）を試みました。| -| `tecNFTOKEN_BUY_SELL_MISMATCH` | 155 | [NFTokenAcceptOfferトランザクション][]は、非代替性トークンの購入と売却に関する対応しないオファーをマッチングさせようとしました。 _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | -| `tecNFTOKEN_OFFER_TYPE_MISMATCH` | 156 | トランザクションで指定されたオファーのうち、1つまたは複数について、オファーの種類が適切ではありませんでした。（例えば、`NFTokenSellOffer`フィールドに購入オファーが指定されていました。） _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | +| `tecNFTOKEN_BUY_SELL_MISMATCH` | 155 | [NFTokenAcceptOfferトランザクション][]は、非代替性トークンの購入と売却に関する対応しないオファーをマッチングさせようとしました。 {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | +| `tecNFTOKEN_OFFER_TYPE_MISMATCH` | 156 | トランザクションで指定されたオファーのうち、1つまたは複数について、オファーの種類が適切ではありませんでした。（例えば、`NFTokenSellOffer`フィールドに購入オファーが指定されていました。） {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecNO_ALTERNATIVE_KEY` | 130 | トランザクションが唯一の[トランザクション承認](../../../../concepts/transactions/index.md#トランザクションの承認)メソッドを削除しようとしました。これは、レギュラーキーを削除する[SetRegularKeyトランザクション][]、SignerListを削除する[SignerListSetトランザクション][]、またはマスターキーを無効にする[AccountSetトランザクション][]である可能性があります。（`rippled` 0.30.0より前のバージョンでは、このトランザクションは`tecMASTER_DISABLED`と呼ばれていました。） | | `tecNO_AUTH` | 134 | トランザクションはトラストラインの残高を、`lsfRequireAuth`フラグが有効になっているアカウントに追加する必要がありましたが、そのトラストラインが承認されていなかったため、失敗しました。トラストラインが存在しない場合は、代わりに`tecNO_LINE`が発生します。 | | `tecNO_DST` | 124 | トランザクションの受信側のアカウントが存在しません。これには、PaymentトランザクションタイプやTrustSetトランザクションタイプがあります。（XRPを十分に受信した場合に作成される可能性があります。） | @@ -59,7 +59,7 @@ labels: | `tecNO_LINE_REDUNDANT` | 127 | トランザクションはトラストラインをデフォルト状態に設定しようと試みましたが、トラストラインが存在していなかったため、失敗しました。 | | `tecNO_PERMISSION` | 139 | 送信者にはこの操作を実行する権限がありません。たとえば[EscrowFinishトランザクション][]が`FinishAfter`時刻に達する前に保留中の支払をリリースしようとしたか、送信者が所有していないChannelで誰かが[PaymentChannelFund][]を使用しようとしたか、または[Payment][]が「DepositAuth」フラグが有効になっているアカウントに資金の送金を試みました。 | | `tecNO_REGULAR_KEY` | 131 | [AccountSetトランザクション][]がマスターキーを無効にしようとしましたが、アカウントにはマスターキー以外で[トランザクションを承認する](../../../../concepts/transactions/index.md#トランザクションの承認)方法がありません。[マルチシグ](../../../../concepts/accounts/multi-signing.md)が有効な場合、このコードは廃止予定であり、代わりに`tecNO_ALTERNATIVE_KEY`が使用されます。 | -| `tecNO_SUITABLE_NFTOKEN_PAGE` | 154 | トランザクションは、非代替性トークンの発行または取得を試みましたが、`NFToken`を受け取るアカウントには、それを保持できるディレクトリページがありません。この状況はレアケースです。 _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | +| `tecNO_SUITABLE_NFTOKEN_PAGE` | 154 | トランザクションは、非代替性トークンの発行または取得を試みましたが、`NFToken`を受け取るアカウントには、それを保持できるディレクトリページがありません。この状況はレアケースです。 {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecNO_TARGET` | 138 | トランザクションが参照するEscrowレジャーオブジェクトまたはPayChannelレジャーオブジェクトが存在していません。これらのオブジェクトは、これまでに存在したことがないか、すでに削除されています。（たとえば、別の[EscrowFinishトランザクション][]で保留中の支払がすでに実行されている場合などです。）あるいは、支払先アカウントで`asfDisallowXRP`が設定されているため、このアカウントは[PaymentChannelCreate][]トランザクションまたは[EscrowCreate][]トランザクションの宛先に指定できません。 | | `tecOVERSIZE` | 145 | サーバがこのトランザクションの適用時に大量のメタデータを作成したため、このトランザクションを処理できませんでした。 | | `tecOWNERS` | 132 | トランザクションでは、トランザクションを送信するアカウントの「所有者カウント」はゼロ以外である必要があります。このためトランザクションを正常に完了できません。たとえば、トラストラインや使用可能なオファーがあるアカウントでは、[`lsfRequireAuth`](../types/accountset.md#accountsetのフラグ)フラグを有効にできません。 | diff --git a/@l10n/ja/docs/references/protocol/transactions/types/accountset.md b/@l10n/ja/docs/references/protocol/transactions/types/accountset.md index 88bc75e9bb..e8899554f1 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/accountset.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/accountset.md @@ -74,14 +74,14 @@ AccountSetトランザクションは、[XRP Ledgerのアカウント](../../led |:----------------------------------|:------|:--------------| | `asfAccountTxnID` | 5 | このアカウントの直近のトランザクションのIDを追跡します。[AccountTxnID](../common-fields.md#accounttxnid)については必須です。 | | `asfAllowTrustLineClawback` | 16 | アカウントの発行したトークンを回収する機能を有効にします。 _（[Clawback Amendment][]により追加されました）。_　所有者ディレクトリが存在する場合はClawback機能を有効にできません。つまり、トラストラインやオファー、エスクロー、ペイメントチャネル、チェック、または署名者リストを設定する前に行う必要があります。このフラグは、有効にした後は無効にできません。| -| `asfAuthorizedNFTokenMinter` | 10 | このアカウントの代わりに、別のアカウントが非代替性トークン（NFToken）をミントすることを許可するために使用します。認可されたアカウントを[AccountRoot](../../ledger-data/ledger-entry-types/accountroot.md)オブジェクトの`NFTokenMinter`フィールドで指定します。認可されたアカウントを削除するには、このフラグを有効にして`NFTokenMinter`フィールドを省略します。 _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ | +| `asfAuthorizedNFTokenMinter` | 10 | このアカウントの代わりに、別のアカウントが非代替性トークン（NFToken）をミントすることを許可するために使用します。認可されたアカウントを[AccountRoot](../../ledger-data/ledger-entry-types/accountroot.md)オブジェクトの`NFTokenMinter`フィールドで指定します。認可されたアカウントを削除するには、このフラグを有効にして`NFTokenMinter`フィールドを省略します。 {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `asfDefaultRipple` | 8 | このアカウントのトラストラインでの[リップリング](../../../../concepts/tokens/fungible-tokens/rippling.md)をデフォルトで有効にします。 | | `asfDepositAuth` | 9 | このアカウントに対して[Deposit Authorization](../../../../concepts/accounts/depositauth.md)を有効にします _（[DepositAuth Amendment][]により追加されました）。_ | | `asfDisableMaster` | 4 | マスターキーペアの使用を禁止します。[レギュラーキー](../../../../concepts/accounts/cryptographic-keys.md)や[署名者リスト](../../../../concepts/accounts/multi-signing.md)など、トランザクションに署名するための別の手段がアカウントで設定されている場合のみ有効にできます。 | -| `asfDisallowIncomingCheck` | 13 | チェックの着信をブロックします。_([DisallowIncoming amendment][] が必要です。)_ | -| `asfDisallowIncomingNFTokenOffer` | 12 | NFTokenOffersの着信をブロックします。_([DisallowIncoming amendment][] が必要です)_。 | -| `asfDisallowIncomingPayChan` | 14 | ペイメントチャネルの着信をブロックします。_([DisallowIncoming amendment][] が必要です)_。 | -| `asfDisallowIncomingTrustline` | 15 | トラストラインの着信をブロックします。_([DisallowIncoming amendment][] が必要です)_。 | +| `asfDisallowIncomingCheck` | 13 | チェックの着信をブロックします。{% amendment-disclaimer name="DisallowIncoming" /%} | +| `asfDisallowIncomingNFTokenOffer` | 12 | NFTokenOffersの着信をブロックします。{% amendment-disclaimer name="DisallowIncoming" /%} | +| `asfDisallowIncomingPayChan` | 14 | ペイメントチャネルの着信をブロックします。{% amendment-disclaimer name="DisallowIncoming" /%} | +| `asfDisallowIncomingTrustline` | 15 | トラストラインの着信をブロックします。{% amendment-disclaimer name="DisallowIncoming" /%} | | `asfDisallowXRP` | 3 | XRPがこのアカウントに送信されないようにします（勧告的なもので、XRP Ledgerのプロトコルでは強制されません）。 | | `asfGlobalFreeze` | 7 | このアカウントによって発行されたすべての資産を[フリーズ](../../../../concepts/tokens/fungible-tokens/freezes.md)します。 | | `asfNoFreeze` | 6 | [個々のトラストラインのフリーズまたはGlobal Freezeの無効化](../../../../concepts/tokens/fungible-tokens/freezes.md)の機能を永続的に放棄します。このフラグは、有効にした後は無効にできません。 | diff --git a/@l10n/ja/docs/references/protocol/transactions/types/ammbid.md b/@l10n/ja/docs/references/protocol/transactions/types/ammbid.md index a289deddec..d2ec7c87a6 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/ammbid.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/ammbid.md @@ -9,7 +9,7 @@ labels: # AMMBid [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMBid.cpp "Source") -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} [自動マーケットメーカー](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)のオークションスロットに入札することができます。落札されると、競り落とされるか24時間が経過するまで、割引料金でAMMと取引することができます。24時間が経過する前に競り落とされた場合、残り時間に応じて落札価格の一部が払い戻されます。AMMの取引手数料が0の場合、入札は可能ですが、入札スロットは取引手数料が変更されるまでメリットをもたらしません。 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/ammclawback.md b/@l10n/ja/docs/references/protocol/transactions/types/ammclawback.md index c7ab1d26b6..0c0a1d7d66 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/ammclawback.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/ammclawback.md @@ -14,7 +14,7 @@ labels: Clawbackはデフォルトで無効です。Clawbackを使用するには、[AccountSetトランザクション][]を送信して、**Allow Trust Line Clawback**設定を有効にする必要があります。すでにトークンが発行済みである発行者はClawbackを有効にできません。**Allow Trust Line Clawback**を有効にするには、トラストライン、オファー、エスクロー、ペイメントチャネル、チェック、署名者リストを設定する前に、所有者ディレクトリを完全に空にする必要があります。Clawbackを有効にした後は、元に戻すことはできません。つまり発行者アカウントは、トラストラインの発行済みトークンを回収できる権利を永続的に得ます。 -_([AMMClawback amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMMClawback" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/ammcreate.md b/@l10n/ja/docs/references/protocol/transactions/types/ammcreate.md index 588bc35e6a..30f66737b1 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/ammcreate.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/ammcreate.md @@ -9,7 +9,7 @@ labels: # AMMCreate [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMCreate.cpp "Source") -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} 資産（[代替可能トークン](../../../../concepts/tokens/index.md)または[XRP](../../../../introduction/what-is-xrp.md)）のペアを取引するための新しい[自動マーケットメーカー](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)(AMM)インスタンスを作成します。 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/ammdelete.md b/@l10n/ja/docs/references/protocol/transactions/types/ammdelete.md index b8e63529e2..0d440014e4 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/ammdelete.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/ammdelete.md @@ -9,7 +9,7 @@ labels: # AMMDelete [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDelete.cpp "Source") -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} 自動で削除しきれなかった空の[自動マーケットメーカー](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)(AMM)インスタンスを削除します。 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/ammdeposit.md b/@l10n/ja/docs/references/protocol/transactions/types/ammdeposit.md index db70878999..1222a02719 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/ammdeposit.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/ammdeposit.md @@ -19,7 +19,7 @@ labels: - AMMのプールにある資産の一方または両方を保有する権限がない {% /admonition %} -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/ammvote.md b/@l10n/ja/docs/references/protocol/transactions/types/ammvote.md index 9dc8c01e66..b5ef112769 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/ammvote.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/ammvote.md @@ -11,7 +11,7 @@ labels: [自動マーケットメーカー](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)インスタンスの取引手数料を投票します。最大8つのアカウントが、保有するAMMのLPトークンの量に比例して投票することができます。投票を行うごとには、投票の加重平均に基づいてAMMの取引手数料が再計算されます。 -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/ammwithdraw.md b/@l10n/ja/docs/references/protocol/transactions/types/ammwithdraw.md index 85295e0809..9ceeeae7c8 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/ammwithdraw.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/ammwithdraw.md @@ -11,7 +11,7 @@ labels: AMMの流動性プロバイダトークン（LPトークン）を返却することで、[自動マーケットメーカー](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)(AMM)インスタンスから資産を引き出します。 -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/checkcreate.md b/@l10n/ja/docs/references/protocol/transactions/types/checkcreate.md index 1aaf32ec5f..e14c1850ee 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/checkcreate.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/checkcreate.md @@ -42,7 +42,7 @@ _（[Checks Amendment][]が必要です）_ ## エラーケース -- `Destination`アカウントがCheckの着信をブロックしている場合、トランザクションは結果コード`tecNO_PERMISSION`で失敗します。 _([DisallowIncoming amendment][] が必要です。)_ +- `Destination`アカウントがCheckの着信をブロックしている場合、トランザクションは結果コード`tecNO_PERMISSION`で失敗します。 {% amendment-disclaimer name="DisallowIncoming" /%} - `Destination`がトランザクションの送信者である場合、トランザクションは結果コード`temREDUNDANT`で失敗します。 - `Destination`[アカウント](../../../../concepts/accounts/index.md)がレジャーに存在していない場合、トランザクションは結果コード`tecNO_DST`で失敗します。 - `Destination`アカウントでRequireDestフラグが有効であるが、トランザクションに`DestinationTag`フィールドが含まれていない場合、トランザクションは結果コード`tecDST_TAG_NEEDED`で失敗します。 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/clawback.md b/@l10n/ja/docs/references/protocol/transactions/types/clawback.md index eb0155734d..98c29947b7 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/clawback.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/clawback.md @@ -1,6 +1,4 @@ --- -html: clawback.html -parent: transaction-types.html seo: description: 発行したトークンを取り戻します。 labels: @@ -10,12 +8,12 @@ labels: [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Clawback.cpp "ソース") -{% partial file="/@l10n/ja/docs/_snippets/clawback-disclaimer.md" /%} - あなたのアカウントが発行したトークンを回収します。 Clawback機能はデフォルトで無効になっています。使用するには、[AccountSetトランザクション][]を送信して**Allow Trust Line Clawback**設定を有効にする必要があります。既存のトークンを持つ発行者はClawback機能を有効にできません。つまり、トラストライン、オファー、エスクロー、ペイメントチャネル、チェック、または署名者リストを設定する前に行う必要があります。Clawback機能を有効にした後、元に戻すことはできません：アカウントは永久にトラストラインで発行された資産を回収する権限を得ます。 +{% amendment-disclaimer name="Clawback" /%} + ## {% $frontmatter.seo.title %} JSONの例 ```json diff --git a/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md b/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md index 319e01eec9..0813a7624a 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md @@ -12,7 +12,7 @@ labels: * 1つのオファーを受け入れます。これは _ダイレクト_ モードと呼ばれます。 * 2つの異なるオファー(`NFToken`の購入オファーと同じ`NFToken`に対するの売却オファー)をアトミックに受け入れます。これは _ブローカー_ モードと呼ばれます。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## NFTokenAcceptOffer JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/nftokenburn.md b/@l10n/ja/docs/references/protocol/transactions/types/nftokenburn.md index 43481d0367..00c2ffa16d 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/nftokenburn.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/nftokenburn.md @@ -14,7 +14,7 @@ NFTokenBurnトランザクションは、`NFToken`オブジェクトを保持し この操作に成功すると、対応する`NFToken`が削除されます。この操作によって`NFToken`を保持している`NFTokenPage`が空になるか、統合されて`NFTokenPage`が削除されると、所有者準備金が1つ減ります。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/nftokencanceloffer.md b/@l10n/ja/docs/references/protocol/transactions/types/nftokencanceloffer.md index dde11565ec..a5a3e42392 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/nftokencanceloffer.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/nftokencanceloffer.md @@ -11,7 +11,7 @@ labels: `NFTokenCancelOffer`トランザクションは、`NFTokenCreateOffer`を使用して作成した既存のトークンへのオファーをキャンセルするために使用できます。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/nftokencreateoffer.md b/@l10n/ja/docs/references/protocol/transactions/types/nftokencreateoffer.md index f131a071eb..c5ec6561af 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/nftokencreateoffer.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/nftokencreateoffer.md @@ -13,7 +13,7 @@ labels: 成功した場合、トランザクションは[NFTokenOfferオブジェクト][]を作成します。各オファーは、オファーを提示したアカウントの[所有者準備金](../../../../concepts/accounts/reserves.md)に関連づけて1つのオブジェクトとしてカウントされます。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## {% $frontmatter.seo.title %} JSONの例 @@ -66,7 +66,7 @@ NFTokenCreateOfferタイプのトランザクションは、以下のように[` | `tecNO_ENTRY` | `NFToken`フィールドで指定したアカウントは所有していません。 | | `tecNO_ISSUER` | `Amount`フィールドで指定した発行者が存在しません。 | | `tecNO_LINE` | `Amount`フィールドはトークンですが、`NFToken`の発行者はそのトークンのトラストラインを持っておらず、`NFToken`は[`lsfTrustLine`フラグ](../../data-types/nftoken.md#nftoken-フラグ)が有効ではありません。 | -| `tecNO_PERMISSION` | `Destination`アカウントが着信する NFTokenOffer をブロックします。 _([DisallowIncoming amendment][] が必要です。)_ +| `tecNO_PERMISSION` | `Destination`アカウントが着信する NFTokenOffer をブロックします。 {% amendment-disclaimer name="DisallowIncoming" /%} | `tecUNFUNDED_OFFER` | 購入オファーの場合、送信者は`Amount`フィールドで指定された通貨を利用可能です。もし`Amount`がXRPである場合、これは準備不足によるものかもしれません。もし`Amount`がトークンである場合、これは[フリーズ](../../../../concepts/tokens/fungible-tokens/freezes.md)されている可能性があります。 | | `tefNFTOKEN_IS_NOT_TRANSFERABLE` | `NFToken`は[`lsfTransferable`フラグ](../../data-types/nftoken.md#nftoken-flags)が無効になっており、このトランザクションでは`NFToken`を発行者に転送したり発行者から転送したりすることはできません。 | diff --git a/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md b/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md index ae42980ba6..59769b201e 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md @@ -9,7 +9,7 @@ labels: `NFTokenMint`トランザクションは非代替性トークンを作成し、`NFTokenMinter`に紐付く[NFTokenPageオブジェクト][]に[NFToken][]オブジェクトとして追加します。このトランザクションは`NFTokenMinter`にとって、不変と定義されているトークンフィールド(例えば`Flags`)を設定することができる唯一の方法です。 -_([NonFungibleTokensV1_1 amendment][]により追加されました)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## {% $frontmatter.seo.title %} JSONの例 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/paymentchannelcreate.md b/@l10n/ja/docs/references/protocol/transactions/types/paymentchannelcreate.md index baf0ab2cd0..e48c39ae5e 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/paymentchannelcreate.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/paymentchannelcreate.md @@ -41,6 +41,6 @@ _[PayChan Amendment][]により追加されました。_ | `CancelAfter` | 数値 | UInt32 | _（省略可）_ このChannelの有効期限（[Rippleエポック以降の経過秒数][]）。この時刻の経過後にトランザクションがこのChannelを変更しようとすると、このChannelは閉鎖し、Channelは変更されません。この値は変更できません。Channelはこの時刻よりも早い時点で閉鎖できますが、この時刻の経過後にもオープンしたままにすることはできません。 | | `DestinationTag` | 数値 | UInt32 | _（省略可）_ このPayment Channelの宛先（宛先アドレスのホスティングされている受取人など） を詳しく指定するための任意のタグ。 | -`Destination` アカウントがペイメントチャネルの着信をブロックしている場合、トランザクションは結果コード`tecNO_PERMISSION` 失敗します。_([DisallowIncoming amendment][] が必要です)_。 +`Destination` アカウントがペイメントチャネルの着信をブロックしている場合、トランザクションは結果コード`tecNO_PERMISSION` 失敗します。{% amendment-disclaimer name="DisallowIncoming" /%} {% raw-partial file="/@l10n/ja/docs/_snippets/common-links.md" /%} diff --git a/@l10n/ja/docs/references/protocol/transactions/types/trustset.md b/@l10n/ja/docs/references/protocol/transactions/types/trustset.md index 64fb4833ed..930c52b0a1 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/trustset.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/trustset.md @@ -44,7 +44,7 @@ labels: | `QualityIn` | 数値 | UInt32 | _（省略可）_ このトラストラインの受入額を、1,000,000,000単位当たりのこの数値の割合で評価。値`0`は、残高を額面価格で扱うことを示す省略表現です。 | | `QualityOut` | 数値 | UInt32 | _（省略可）_ このトラストラインの払出額を、1,000,000,000単位当たりのこの数値の割合で評価。値`0`は、残高を額面価格で扱うことを示す省略表現です。 | -`LimitAmount.issuer`で指定されたアカウントがトラストラインの着信をブロックしている場合、結果コード`tecNO_PERMISSION`でトランザクションが失敗します。 _([DisallowIncoming amendment][] が必要です)_ +`LimitAmount.issuer`で指定されたアカウントがトラストラインの着信をブロックしている場合、結果コード`tecNO_PERMISSION`でトランザクションが失敗します。 {% amendment-disclaimer name="DisallowIncoming" /%} ## TrustSetのフラグ diff --git a/@l10n/ja/docs/use-cases/tokenization/stablecoin-issuer.md b/@l10n/ja/docs/use-cases/tokenization/stablecoin-issuer.md index 08d33811fc..52d2067df0 100644 --- a/@l10n/ja/docs/use-cases/tokenization/stablecoin-issuer.md +++ b/@l10n/ja/docs/use-cases/tokenization/stablecoin-issuer.md @@ -206,7 +206,7 @@ Clawbackは、ステーブルコインの配布を開始する前に選択でき ### AMMへのリスト -_([AMM amendment][]により追加されました。)_ +{% amendment-disclaimer name="AMM" /%} 自動マーケットメイカー(AMM)は、XRP Ledgerの分散型取引所で流動性を提供するスマートコントラクトです。各AMMは2つの資産のプールを保有し、計算式で設定された取引レートでユーザがそれらの間でスワップを行うことを可能にします。 diff --git a/docs/_snippets/clawback-disclaimer.md b/docs/_snippets/clawback-disclaimer.md deleted file mode 100644 index 0037aac429..0000000000 --- a/docs/_snippets/clawback-disclaimer.md +++ /dev/null @@ -1 +0,0 @@ -_Requires the [Clawback amendment](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0039d-clawback)._ diff --git a/docs/concepts/accounts/deleting-accounts.md b/docs/concepts/accounts/deleting-accounts.md index 3415119f5e..1df77e562c 100644 --- a/docs/concepts/accounts/deleting-accounts.md +++ b/docs/concepts/accounts/deleting-accounts.md @@ -1,6 +1,4 @@ --- -html: deleting-accounts.html -parent: accounts.html seo: description: About deleting an XRP Ledger account. labels: @@ -31,7 +29,7 @@ The following [ledger entry types](../../references/protocol/ledger-data/ledger- - `PayChannel` - `RippleState` (trust line) - `Check` -- `PermissionedDomain` _(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_ +- `PermissionedDomain` {% amendment-disclaimer name="PermissionedDomains" /%} Any other types of ledger entries that an account owns are automatically deleted along with the account. diff --git a/docs/concepts/accounts/depositauth.md b/docs/concepts/accounts/depositauth.md index f6ce9e3f85..f73b37174c 100644 --- a/docs/concepts/accounts/depositauth.md +++ b/docs/concepts/accounts/depositauth.md @@ -1,6 +1,4 @@ --- -html: depositauth.html -parent: accounts.html seo: description: The DepositAuth setting lets an account block incoming payments by default. labels: @@ -9,8 +7,6 @@ labels: --- # Deposit Authorization -_(Added by the [DepositAuth amendment][].)_ - Deposit Authorization is an optional [account](index.md) setting in the XRP Ledger. If enabled, Deposit Authorization blocks all transfers from strangers, including transfers of XRP and [tokens](../tokens/index.md). An account with Deposit Authorization can only receive value in two ways: - From accounts it has [preauthorized](#preauthorization). @@ -18,6 +14,8 @@ Deposit Authorization is an optional [account](index.md) setting in the XRP Ledg By default, new accounts have DepositAuth disabled and can receive XRP from anyone. +{% amendment-disclaimer name="DepositAuth" /%} + ## Background Financial services regulations and licenses may require that a business or entity must know the sender of all transactions it receives. This presents a challenge on a decentralized system like the XRP Ledger where participants are identified by pseudonyms which can be freely generated and the default behavior is for any address to be able to pay any other. @@ -26,7 +24,7 @@ The Deposit Authorization flag introduces an option for those using the XRP Ledg When you have Deposit Authorization enabled, you can receive money from [Checks](/resources/known-amendments.md#checks), [Escrow](../payment-types/escrow.md), and [Payment Channels](/resources/known-amendments.md#paychan). In these transactions' "two-step" model, first the source sends a transaction to authorize sending funds, then the destination sends a transaction to authorize receiving those funds. -To receive money from [Payment transactions][] when you have Deposit Authorization enabled, you must [preauthorize](#preauthorization) the senders of those Payments. _(Added by the [DepositPreauth amendment][].)_ +To receive money from [Payment transactions][] when you have Deposit Authorization enabled, you must [preauthorize](#preauthorization) the senders of those Payments. ## Recommended Usage @@ -41,15 +39,15 @@ To get the full effect of Deposit Authorization, Ripple recommends also doing th An account with Deposit Authorization enabled: - **Cannot** be the destination of [Payment transactions][], with **the following exceptions**: - - If the destination has [preauthorized](#preauthorization) the sender of the Payment. _(Added by the [DepositPreauth amendment][])_ + - If the destination has [preauthorized](#preauthorization) the sender of the Payment. - If the account's XRP balance is equal to or below the minimum account [reserve requirement](reserves.md), it can be the destination of an XRP Payment whose `Amount` is equal or less than the minimum account reserve (currently {% $env.PUBLIC_BASE_RESERVE %}). This is to prevent an account from becoming "stuck" by being unable to send transactions but also unable to receive XRP. The account's owner reserve does not matter for this case. - Can receive XRP from [PaymentChannelClaim transactions][] **only in the following cases**: - The sender of the PaymentChannelClaim transaction is the destination of the payment channel. - - The destination of the PaymentChannelClaim transaction has [preauthorized](#preauthorization) the sender of the PaymentChannelClaim. _(Added by the [DepositPreauth amendment][])_ + - The destination of the PaymentChannelClaim transaction has [preauthorized](#preauthorization) the sender of the PaymentChannelClaim. - Can receive XRP from [EscrowFinish transactions][] **only in the following cases**: - The sender of the EscrowFinish transaction is the destination of the escrow. - - The destination of the EscrowFinish transaction has [preauthorized](#preauthorization) the sender of the EscrowFinish. _(Added by the [DepositPreauth amendment][])_ -- **Can** receive XRP or tokens by sending a [CheckCash][] transaction. _(Added by the [Checks amendment][].)_ + - The destination of the EscrowFinish transaction has [preauthorized](#preauthorization) the sender of the EscrowFinish. +- **Can** receive XRP or tokens by sending a [CheckCash][] transaction. - **Can** receive XRP or tokens by sending [OfferCreate transactions][]. - If the account sends an OfferCreate transaction that is not fully executed immediately, it **can** receive the rest of the ordered XRP or token later when the offer is consumed by other accounts' [Payment][] and [OfferCreate][] transactions. - If the account has created any trust lines without the [No Ripple flag](../tokens/fungible-tokens/rippling.md) enabled, or has enabled the Default Ripple flag and issued any currency, the account **can** receive the tokens of those trust lines in [Payment transactions][] as a result of rippling. It cannot be the destination of those transactions. @@ -76,8 +74,6 @@ If the result of the `Flags` value bitwise-AND the `lsfDepositAuth` flag value ( ## Preauthorization -_(Added by the [DepositPreauth amendment][].)_ - Accounts with DepositAuth enabled can _preauthorize_ certain senders, to allow payments from those senders to succeed even with DepositAuth enabled. This allows specific senders to send funds directly without the receiver taking action on each transaction individually. Preauthorization is not required to use DepositAuth, but can make certain operations more convenient. Preauthorization is currency-agnostic. You cannot preauthorize accounts for specific currencies only. @@ -94,6 +90,9 @@ After the DepositPreauth transaction has been processed, the authorized account Preauthorization has no effect on the other ways to send money to an account with DepositAuth enabled. See [Precise Semantics](#precise-semantics) for the exact rules. +{% amendment-disclaimer name="DepositPreauth" /%} + + ### Checking for Authorization You can use the [deposit_authorized method][] to see if an account is authorized to deposit to another account. This method checks two things: @@ -111,9 +110,6 @@ You can use the [deposit_authorized method][] to see if an account is authorized - The `DisallowXRP` flag indicates that an account should not receive XRP. This is a softer protection than Deposit Authorization, and is not enforced by the XRP Ledger. (Client applications should honor this flag or at least warn about it.) - The `RequireDest` flag indicates that an account can only receive currency amounts if the sending transaction specifies a [Destination Tag](../transactions/source-and-destination-tags.md). This protects users from forgetting to indicate the purpose of a payment, but does not protect recipients from unknown senders, who can make up arbitrary destination tags. - [Partial Payments](../payment-types/partial-payments.md) provide a way for accounts to return unwanted payments while subtracting [transfer fees](../tokens/fungible-tokens/transfer-fees.md) and exchange rates from the amount delivered instead of adding them to the amount sent. - -[DepositPreauth amendment]: /resources/known-amendments.md#depositpreauth - {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/concepts/accounts/multi-signing.md b/docs/concepts/accounts/multi-signing.md index a4f9f4504b..f4e00fa7b3 100644 --- a/docs/concepts/accounts/multi-signing.md +++ b/docs/concepts/accounts/multi-signing.md @@ -38,7 +38,7 @@ The quorum value of a list is the minimum weight total required to authorize a t You can also add up to 256 bits of arbitrary data to each signer's entry in the list. This data is not required or used by the network, but can be used by smart contracts or other applications to identify or confirm other data about the signers. -_(Added by the [ExpandedSignerList amendment][].)_ +{% amendment-disclaimer name="ExpandedSignerList" /%} ### Examples Using Signer Weight and Quorum diff --git a/docs/concepts/accounts/permission-delegation.md b/docs/concepts/accounts/permission-delegation.md index 61c4cf7db2..df63fc5a51 100644 --- a/docs/concepts/accounts/permission-delegation.md +++ b/docs/concepts/accounts/permission-delegation.md @@ -10,7 +10,7 @@ status: not_enabled Permission delegation is the function of granting various permissions to another account to send permissions on behalf of your account. You can use permission delegation to enable flexible security paradigms such as role-based access control, instead of or alongside techniques such as [multi-signing](./multi-signing.md). -_(Requires the [PermissionDelegation amendment][] {% not-enabled /%}.)_ + {% amendment-disclaimer name="PermissionDelegation" /%} ## Background: The Need for Permission Delegation diff --git a/docs/concepts/accounts/tickets.md b/docs/concepts/accounts/tickets.md index fc86ebe84a..4f01c28d7b 100644 --- a/docs/concepts/accounts/tickets.md +++ b/docs/concepts/accounts/tickets.md @@ -9,10 +9,10 @@ labels: --- # Tickets -_(Added by the [TicketBatch amendment][].)_ - A Ticket in the XRP Ledger is a way of setting aside a [sequence number][Sequence Number] for a transaction without sending it right away. Tickets allow transactions to be sent outside of the normal sequence order. One use case for this is to allow for [multi-signed transactions](multi-signing.md) where it may take a while to collect the necessary signatures: while collecting signatures for a transaction that uses a Ticket, you can still send other transactions. +{% amendment-disclaimer name="TicketBatch" /%} + ## Background [Transactions](../transactions/index.md) have sequence numbers so that any given transaction can execute no more than once. Sequence numbers also make sure any given transaction is unique: if you send the exact same amount of money to the same person multiple times, the Sequence Number is one detail that is guaranteed to be different each time. Finally, Sequence Numbers provide an elegant way to put transactions in a consistent order, even if some of them arrive out of order when sent throughout the network. diff --git a/docs/concepts/consensus-protocol/negative-unl.md b/docs/concepts/consensus-protocol/negative-unl.md index 2ce382fc3f..30decaabc1 100644 --- a/docs/concepts/consensus-protocol/negative-unl.md +++ b/docs/concepts/consensus-protocol/negative-unl.md @@ -1,19 +1,17 @@ --- -html: negative-unl.html -parent: consensus.html seo: description: Understand how Negative UNL improves the ledger's resilience during partial outages. labels: - - Blockchain + - Blockchain --- # Negative UNL -_Added by the [NegativeUNL Amendment](/resources/known-amendments.md#negativeunl)._ - The _Negative UNL_ is a feature of the XRP Ledger [consensus protocol](index.md) that improves _liveness_, the network's ability to make forward progress during a partial outage. Using the Negative UNL, servers adjust their effective UNLs based on which validators are currently online and operational, so that a new [ledger version](../ledgers/index.md) can be declared _validated_ even if several trusted validators are offline. The Negative UNL has no impact on how the network processes transactions or what transactions' outcomes are, except that it improves the network's ability to declare outcomes final during some types of partial outages. +{% amendment-disclaimer name="NegativeUNL" /%} + ## Background Each server in the XRP Ledger protocol independently decides a ledger version is validated when a quorum of its trusted validators agree. A server's trusted validators are defined by that server's UNL (Unique Node List), a list of validators it trusts not to collude. By default, servers are configured to trust any validator on at least one of two lists, one UNL published by the XRP Ledger Foundation and one UNL published by Ripple. diff --git a/docs/concepts/decentralized-storage/credentials.md b/docs/concepts/decentralized-storage/credentials.md index dfb6791a44..0bc862424c 100644 --- a/docs/concepts/decentralized-storage/credentials.md +++ b/docs/concepts/decentralized-storage/credentials.md @@ -1,7 +1,6 @@ --- seo: description: Create and manage credentials on the blockchain, which can provide authorization for payments or other features, while respecting privacy and decentralization. -status: not_enabled --- # Credentials diff --git a/docs/concepts/decentralized-storage/decentralized-identifiers.md b/docs/concepts/decentralized-storage/decentralized-identifiers.md index 2a194698f3..8e3939d94b 100644 --- a/docs/concepts/decentralized-storage/decentralized-identifiers.md +++ b/docs/concepts/decentralized-storage/decentralized-identifiers.md @@ -8,7 +8,7 @@ labels: --- # Decentralized Identifiers -_(Requires the [DID amendment][])_ +{% amendment-disclaimer name="DID" /%} A Decentralized Identifier (DID) is a new type of identifier defined by the World Wide Web Consortium (W3C) that enables verifiable, digital identities. DIDs are fully under the control of the DID owner, independent from any centralized registry, identity provider, or certificate authority. diff --git a/docs/concepts/decentralized-storage/price-oracles.md b/docs/concepts/decentralized-storage/price-oracles.md index 93261d1476..32a90c6c2c 100644 --- a/docs/concepts/decentralized-storage/price-oracles.md +++ b/docs/concepts/decentralized-storage/price-oracles.md @@ -1,19 +1,21 @@ +--- +seo: + description: Price oracles gather real-world market prices and record them in the blockchain so that other tools and technology can access this data directly. +--- # Price Oracles -_(Requires the [PriceOracle amendment][])_ +Price oracles gather real-world market prices and record them in the blockchain so that other tools and technology can access this data directly. -Blockchains can't inherently interact with and "know" what's happening off the network, but many of its use cases in decentralized finance require this information. - -Price oracles solve this problem. An oracle is a service or technology that gathers real-world information, such as market prices, exchange rates, or interest rates, and relays it to the blockchain. Like blockchains, most oracles are also decentralized and validate data through multiple nodes. +Blockchains can't inherently interact with and "know" what's happening off the network, but many of its use cases in decentralized finance require this information. Price oracles solve this problem by putting the data on-chain where decentralized apps can find it. Like blockchains, most oracles are also decentralized and validate data through multiple nodes. {% admonition type="info" name="Note" %} - -Generally speaking, oracles aren't limited to only providing financial information. They can provide any type of info, such as what sports team won a game, or even the weather. The XRP Ledger's Price Oracle feature, however, is designed specifically for reporting the prices of assets. - +Generally speaking, oracles aren't limited to only providing financial information like asset prices, exchange rates, or interest rates. They can provide any type of info, such as what sports team won a game, or even the weather. The XRP Ledger's Price Oracle feature, however, is designed specifically for reporting the prices of assets. {% /admonition %} +{% amendment-disclaimer name="PriceOracle" /%} -## How Oracles Works + +## How Oracles Work Most oracle blockchain interactions work like this: diff --git a/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md b/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md index 5f5c9c9fe4..daca668354 100644 --- a/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md +++ b/docs/concepts/tokens/decentralized-exchange/automated-market-makers.md @@ -9,7 +9,7 @@ labels: --- # Automated Market Makers -_(Added by the [AMM amendment][])_ +{% amendment-disclaimer name="AMM" /%} Automated Market Makers (AMMs) provide liquidity in the XRP Ledger's decentralized exchange (DEX). Each AMM holds a pool of two assets. You can swap between the two assets at an exchange rate set by a mathematical formula. diff --git a/docs/concepts/tokens/decentralized-exchange/permissioned-domains.md b/docs/concepts/tokens/decentralized-exchange/permissioned-domains.md index 621c303c75..1f694429b5 100644 --- a/docs/concepts/tokens/decentralized-exchange/permissioned-domains.md +++ b/docs/concepts/tokens/decentralized-exchange/permissioned-domains.md @@ -2,8 +2,9 @@ seo: description: Learn how Permissioned Domains on the XRP Ledger enable controlled, secure blockchain environments. Explore their role in decentralized exchanges (DEXes) and lending protocols. labels: - - Compliance - - Permissioned Domains + - Compliance + - Permissioned Domains +status: not_enabled --- # Permissioned Domains diff --git a/docs/concepts/tokens/fungible-tokens/deep-freeze.md b/docs/concepts/tokens/fungible-tokens/deep-freeze.md index 554393cbfa..a486fc3b01 100644 --- a/docs/concepts/tokens/fungible-tokens/deep-freeze.md +++ b/docs/concepts/tokens/fungible-tokens/deep-freeze.md @@ -12,7 +12,7 @@ Deep Freeze lets token issuers on the XRP Ledger prevent token misuse by frozen Deep Freeze impacts trust lines that interact with payments, offers, DEX, and AMM. Issuers can block sending and receiving of funds for holders in deep freeze. -_(Requires the [DeepFreeze amendment][] )_ +{% amendment-disclaimer name="DeepFreeze" /%} ## Deep Freeze Mechanism diff --git a/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md b/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md index 540b64f6c1..fcbd1354fd 100644 --- a/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md +++ b/docs/concepts/tokens/fungible-tokens/stablecoins/settings.md @@ -80,12 +80,11 @@ See [Freezing Tokens](../freezes.md). ### Clawback Flags -_(Requires the [Clawback amendment](/resources/known-amendments.md#clawback))_ - Clawback allows you to retrieve, or _clawback_, stablecoins from a trust line under specific circumstances. This gives you added ability to respond to challenges such as lost account access or malicious activity. See [Clawback](../../../../references/protocol/transactions/types/clawback.md). +{% amendment-disclaimer name="Clawback" /%} ### Fixed Supply diff --git a/docs/concepts/tokens/nfts/dynamic-nfts.md b/docs/concepts/tokens/nfts/dynamic-nfts.md index 8db541619b..fa09f551bc 100644 --- a/docs/concepts/tokens/nfts/dynamic-nfts.md +++ b/docs/concepts/tokens/nfts/dynamic-nfts.md @@ -4,29 +4,16 @@ seo: labels: - Non-fungible Tokens, NFTs --- - # Dynamic Non-Fungible Tokens (dNFTs) -Standard NFTs are immutable. Some use cases would benefit from the capability to update the referenced data object after the initial minting of an NFT. For example, a concert ticket for a postponed event could be updated with an alternate date, or a virtual trading card for an athlete could be periodically updated with current statistics. Dynamic Non-Fungible Tokens (dNFTs) provide the flexibility required for these use cases. +Standard NFTs are immutable. In some use cases, you need to update the referenced data object after the initial minting of an NFT. For example, a concert ticket for a postponed event could be updated with an alternate date, or a virtual trading card for an athlete could be periodically updated with current statistics. Dynamic Non-Fungible Tokens (dNFTs) provide the flexibility required for these use cases. ## Creating a dNFT -When minting a new NFT, set the `tfMutable` flag (`0x00000010`) to enable the ability to update the NFT's `URI` field. +When minting a new NFT, enable the `tfMutable` flag (`0x00000010`) to make the NFT mutable. ## Modifying a dNFT -Use the `NFTokenModify` transaction to update the URI field of a dNFT. Provide the `Account` of the issuer or an authorized minter, the `Owner` of the dNFT (if different than the `Account` address), the `NFTokenID`, and the `URI` to the new object data. +The issuer, or their authorized minter, can modify a dNFT at any time, by sending a [NFTokenModify transaction][]. Only the `URI` field of the NFT can be changed this way. -### Sample NFTokenModify Transaction - -```json -{ - "TransactionType": "NFTokenModify", - "Account": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh", - "Owner": "rogue5HnPRSszD9CWGSUz8UGHMVwSSKF6", - "Fee": "10", - "Sequence": 33, - "NFTokenID": "0008C350C182B4F213B82CCFA4C6F59AD76F0AFCFBDF04D5A048C0A300000007", - "URI": "697066733A2F2F62616679626569636D6E73347A736F6C686C6976346C746D6E356B697062776373637134616C70736D6C6179696970666B73746B736D3472746B652F5665742E706E67", - } -``` +{% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/concepts/tokens/nfts/index.md b/docs/concepts/tokens/nfts/index.md index 47f895658b..525254f8a2 100644 --- a/docs/concepts/tokens/nfts/index.md +++ b/docs/concepts/tokens/nfts/index.md @@ -11,7 +11,7 @@ labels: The XRP Ledger natively supports non-fungible tokens (NFTs, or “nifties” in the vernacular). Non-fungible tokens serve to encode ownership of unique physical, non-physical, or purely digital goods, such as works of art or in-game items. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} To represent digital assets similar to these, use the XRP Ledger's Non-Fungible Tokens feature (sometimes referred to by its standards draft number, [XLS-20](https://github.com/XRPLF/XRPL-Standards/discussions/46)). diff --git a/docs/concepts/tokens/nfts/trading.md b/docs/concepts/tokens/nfts/trading.md index e6806eedbc..193f0f7d6d 100644 --- a/docs/concepts/tokens/nfts/trading.md +++ b/docs/concepts/tokens/nfts/trading.md @@ -11,7 +11,7 @@ labels: You can transfer NFTs between accounts on the XRP Ledger. You can offer to buy or sell an NFT, or accept offers from other accounts to buy an NFT you own. You can even give away an NFT by offering to sell it at a price of 0. All offers are created using [NFTokenCreateOffer transaction][]. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Reserve Requirements diff --git a/docs/concepts/xrpl-sidechains/cross-chain-bridges.md b/docs/concepts/xrpl-sidechains/cross-chain-bridges.md index b39c73b204..c3eb001602 100644 --- a/docs/concepts/xrpl-sidechains/cross-chain-bridges.md +++ b/docs/concepts/xrpl-sidechains/cross-chain-bridges.md @@ -10,7 +10,7 @@ labels: --- # Cross-Chain Bridges -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} Cross-chain bridges enable you to move XRP and tokens between the XRP Ledger and other blockchains. When referring to the blockchains connected by a bridge, one is the locking chain and the other the issuing chain. diff --git a/docs/concepts/xrpl-sidechains/index.md b/docs/concepts/xrpl-sidechains/index.md index e2072a64ef..7ad0560843 100644 --- a/docs/concepts/xrpl-sidechains/index.md +++ b/docs/concepts/xrpl-sidechains/index.md @@ -9,7 +9,7 @@ labels: --- # XRPL Sidechains -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} A sidechain is an independent ledger with its own consensus algorithm, transaction types, rules, and nodes. It acts as its own blockchain, running parallel to the mainchain (XRP Ledger), enabling value to move between the two without compromising the speed, efficiency, and throughput of the mainchain. diff --git a/docs/concepts/xrpl-sidechains/witness-servers.md b/docs/concepts/xrpl-sidechains/witness-servers.md index a712af9f1e..70be8d01bb 100644 --- a/docs/concepts/xrpl-sidechains/witness-servers.md +++ b/docs/concepts/xrpl-sidechains/witness-servers.md @@ -11,7 +11,7 @@ labels: # Witness Servers [[Source]](https://github.com/seelabs/xbridge_witness "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} 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. diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md index e09a6cf166..52ef0f89d0 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md @@ -9,7 +9,7 @@ labels: # account_channels [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountChannels.cpp "Source") -_(Added by the [PayChan amendment][].)_ +{% amendment-disclaimer name="PayChan" /%} The `account_channels` method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger. diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md index db656adea2..e1bf1bd9d5 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md @@ -216,10 +216,10 @@ The `account_flags` field contains the following nested fields: | `defaultRipple` | Boolean | If `true`, the account allows [rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) on its trust lines by default. | | `depositAuth` | Boolean | If `true`, the account is using [Deposit Authorization](../../../../concepts/accounts/depositauth.md) and does not accept any payments from unknown parties. | | `disableMasterKey` | Boolean | If `true`, the account's [master key pair](../../../../concepts/accounts/cryptographic-keys.md) is disabled. | -| `disallowIncomingCheck` | Boolean | If `true`, the account does not allow others to send [Checks](../../../../concepts/payment-types/checks.md) to it. _(Requires the [DisallowIncoming amendment][])_ | -| `disallowIncomingNFTokenOffer` | Boolean | If `true`, the account does not allow others to make [NFT buy or sell offers](../../../../concepts/tokens/nfts/trading.md) to it. _(Requires the [DisallowIncoming amendment][])_ | -| `disallowIncomingPayChan` | Boolean | If `true`, the account does not allow others to make [Payment Channels](../../../../concepts/payment-types/payment-channels.md) to it. _(Requires the [DisallowIncoming amendment][])_ | -| `disallowIncomingTrustline` | Boolean | If `true`, the account does not allow others to make [trust lines](../../../../concepts/tokens/fungible-tokens/index.md) to it. _(Requires the [DisallowIncoming amendment][])_ | +| `disallowIncomingCheck` | Boolean | If `true`, the account does not allow others to send [Checks](../../../../concepts/payment-types/checks.md) to it. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `disallowIncomingNFTokenOffer` | Boolean | If `true`, the account does not allow others to make [NFT buy or sell offers](../../../../concepts/tokens/nfts/trading.md) to it. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `disallowIncomingPayChan` | Boolean | If `true`, the account does not allow others to make [Payment Channels](../../../../concepts/payment-types/payment-channels.md) to it. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `disallowIncomingTrustline` | Boolean | If `true`, the account does not allow others to make [trust lines](../../../../concepts/tokens/fungible-tokens/index.md) to it. {% amendment-disclaimer name="DisallowIncoming" /%} | | `disallowIncomingXRP` | Boolean | If `true`, the account does not want to receive XRP from others. (This is advisory, and not enforced at a protocol level.) | | `globalFreeze` | Boolean | If `true`, all tokens issued by the account are currently frozen. | | `noFreeze` | Boolean | If `true`, the account has permanently given up the abilities to freeze individual trust lines or end a global freeze. See [No Freeze](../../../../concepts/tokens/fungible-tokens/freezes.md#no-freeze) for details. | diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md index 33870f0257..c1464a7b59 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md @@ -11,7 +11,7 @@ labels: The `account_nfts` method returns a list of `NFToken` objects for the specified account. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Request Format An example of the request format: diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md index 9364e0dafa..cc775f2a87 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md @@ -12,7 +12,7 @@ stautus: not_enabled [[Source]](https://github.com/XRPLF/clio/blob/develop/src/rpc/handlers/MPTHolders.cpp "Source") -_(Requires the [MPTokensV1 amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="MPTokensV1" /%} For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all holders of that [MPT](../../../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md) and their balance. This method likely returns very large data sets, so you should expect to implement paging via the `marker` field. This API is only available using Clio, not `rippled`. {% badge href="https://github.com/XRPLF/clio/releases/tag/2.3.0" %}New in: Clio v2.3.0{% /badge %} diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index 4896d77123..209d2847ab 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -164,7 +164,7 @@ rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 ### Get AMM Entry -_(Added by the [AMM amendment][])_ +{% amendment-disclaimer name="AMM" /%} Retrieve an Automated Market-Maker (AMM) object from the ledger. This is similar to [amm_info method][], but the `ledger_entry` version returns only the ledger entry as stored. @@ -231,7 +231,7 @@ rippled json ledger_entry '{ "amm": { "asset": { "currency": "XRP" }, "asset2": ### Get Bridge Entry -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} Retrieve a [Bridge entry](../../../protocol/ledger-data/ledger-entry-types/bridge.md), which represents a single cross-chain bridge that connects the XRP Ledger with another blockchain. @@ -467,7 +467,7 @@ rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJY ### Get Oracle Entry -_(Requires the [PriceOracle amendment][])_ +{% amendment-disclaimer name="PriceOracle" /%} Retrieve an [Oracle entry](../../../protocol/ledger-data/ledger-entry-types/oracle.md), which represents a single price oracle that can store token prices. @@ -792,7 +792,7 @@ rippled json ledger_entry '{ "deposit_preauth": { "owner": "rf1BiGeXwwQoi8Z2ueFY ### Get Ticket Entry -Retrieve a [Ticket entry](../../../protocol/ledger-data/ledger-entry-types/ticket.md), which represents a [sequence number][] set aside for future use. _(Added by the [TicketBatch amendment][])_ +Retrieve a [Ticket entry](../../../protocol/ledger-data/ledger-entry-types/ticket.md), which represents a [sequence number][] set aside for future use. {% amendment-disclaimer name="TicketBatch" /%} | Field | Type | Description | |:--------------------|:---------------------|:----------------------| diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md index 0916b98bd3..70aa9b392c 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md @@ -13,7 +13,7 @@ labels: The {% code-page-name /%} method gets information about an [Automated Market Maker (AMM)](/docs/concepts/tokens/decentralized-exchange/automated-market-makers) instance. -_(Added by the [AMM amendment][])_ +{% amendment-disclaimer name="AMM" /%} ### Request Format diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md index 1c60cdae1e..bb2118faf0 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md @@ -71,7 +71,7 @@ The request includes the following parameters: |:---------------|:-----------------|:----------|-------------| | `taker_gets` | Object | Yes | The asset the account taking the offer would receive, as a [currency without an amount](../../../protocol/data-types/currency-formats.md#specifying-without-amounts). | | `taker_pays` | Object | Yes | The asset the account taking the offer would pay, as a [currency without an amount](../../../protocol/data-types/currency-formats.md#specifying-without-amounts). | -| `domain` | [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, return offers from the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) instead of using the open DEX. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `domain` | [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, return offers from the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) instead of using the open DEX. {% amendment-disclaimer name="PermissionedDEX" /%} | | `ledger_hash` | [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) | | `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `limit` | Number | No | The maximum number of offers to return. The response may include fewer results. | diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md index f984b88ca0..2e0d971ce3 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md @@ -6,7 +6,7 @@ labels: --- # get_aggregate_price -_(Requires the [PriceOracle amendment][])_ +{% amendment-disclaimer name="PriceOracle" /%} [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/GetAggregatePrice.cpp "Source") diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md index a7dcf8f37c..9c76231efb 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md @@ -11,7 +11,7 @@ labels: The `nft_buy_offers` method returns a list of buy offers for a given [NFToken][] object. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Request Format An example of the request format: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md index a73786b804..f84a15e788 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md @@ -11,7 +11,7 @@ labels: The `nft_sell_offers` method returns a list of sell offers for a given [NFToken][] object. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Request Format An example of the request format: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md index bd8ecce764..c572fbc25f 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md @@ -61,7 +61,7 @@ The request includes the following parameters: | `source_account` | String - [Address][] | Yes | The account to find a path from. (In other words, the account that would be sending a payment.) | | `destination_account` | String - [Address][] | Yes | The account to find a path to. (In other words, the account that would receive a payment.) | | `destination_amount` | [Currency Amount][] | Yes | How much the destination account would receive. **Special case:** You can specify `"-1"` (for XRP) or provide -1 as the contents of the `value` field (for tokens). This requests a path to deliver as much as possible, while spending no more than the amount specified in `send_max` (if provided). | -| `domain` | String - [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, only return paths that use the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `domain` | String - [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, only return paths that use the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). {% amendment-disclaimer name="PermissionedDEX" /%} | | `paths` | Array | No | Array of arrays of objects, representing [payment paths](../../../../concepts/tokens/fungible-tokens/paths.md) to check. | `send_max` | [Currency Amount][] | No | Maximum amount that would be spent. Not compatible with `source_currencies`. | You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path. | diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md index 1dc0bf439c..059fcfa81b 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md @@ -90,7 +90,7 @@ The request includes the following parameters: | `source_account` | String - [Address][] | Yes | The account that would send funds | | `destination_account` | String - [Address][] | Yes | The account that would receive funds | | `destination_amount` | [Currency Amount][] | Yes | How much the destination account would receive. **Special case:** You can specify `"-1"` (for XRP) or provide -1 as the contents of the `value` field (for tokens). This requests a path to deliver as much as possible, while spending no more than the amount specified in `send_max` (if provided). | -| `domain` | String - [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, only return paths that use the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `domain` | String - [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, only return paths that use the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). {% amendment-disclaimer name="PermissionedDEX" /%} | | `ledger_hash` | String - [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) | | `ledger_index` | [Ledger Index][] | No | The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `send_max` | [Currency Amount][] | No | Maximum amount that would be spent. Cannot be used with `source_currencies`. | diff --git a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md index f057876f24..a57281a94b 100644 --- a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md +++ b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize.md @@ -1,6 +1,4 @@ --- -html: channel_authorize.html -parent: payment-channel-methods.html seo: description: Sign a claim for money from a payment channel. labels: @@ -9,10 +7,10 @@ labels: # channel_authorize [[Source]](https://github.com/XRPLF/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L41 "Source") -_(Added by the [PayChan amendment][] to be enabled.)_ - The `channel_authorize` method creates a signature that can be used to redeem a specific amount of XRP or fungible tokens from a payment channel. +{% amendment-disclaimer name="PayChan" /%} + ## Request Format An example of the request format: diff --git a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md index 9ec605ec34..7538c14bbb 100644 --- a/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md +++ b/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify.md @@ -9,10 +9,10 @@ labels: # channel_verify [[Source]](https://github.com/XRPLF/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L89 "Source") -_(Added by the [PayChan amendment][] to be enabled.)_ - The `channel_verify` method checks the validity of a signature that can be used to redeem a specific amount of XRP or fungible tokens from a payment channel. +{% amendment-disclaimer name="PayChan" /%} + ## Request Format An example of the request format: diff --git a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md index 46eb7ba360..e5ebdb8ee7 100644 --- a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md +++ b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md @@ -103,7 +103,7 @@ Each member of the `books` array, if provided, is an object with the following f | `taker_gets` | Object - Currency | Yes | Specification of which currency the account taking the offer would receive, as a [currency object with no amount](../../../protocol/data-types/currency-formats.md#specifying-without-amounts). | | `taker_pays` | Object - Currency | Yes | Specification of which currency the account taking the offer would pay, as a [currency object with no amount](../../../protocol/data-types/currency-formats.md#specifying-without-amounts). | | `both` | Boolean | No | If `true`, return both sides of the order book. The default is `false`. | -| `domain` | String - [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, subscribe to the order books for the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) instead of the open DEX. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `domain` | String - [Hash][] | No | The ledger entry ID of a permissioned domain. If provided, subscribe to the order books for the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) instead of the open DEX. {% amendment-disclaimer name="PermissionedDEX" /%} | | `snapshot` | Boolean | No | If `true`, return the current state of the order book once when you subscribe before sending updates. The default is `false`. | | `taker` | String - [Address][] | No | The acount to use as a perspective for viewing offers. This affects the funding status and fees of [offers](../../../../concepts/tokens/decentralized-exchange/offers.md). | diff --git a/docs/references/protocol/data-types/nftoken.md b/docs/references/protocol/data-types/nftoken.md index 8c5d78deff..1441a8b82a 100644 --- a/docs/references/protocol/data-types/nftoken.md +++ b/docs/references/protocol/data-types/nftoken.md @@ -10,7 +10,7 @@ labels: The `NFToken` object represents a single non-fungible token (NFT). It is not stored on its own, but is contained in a [NFTokenPage object][] alongside other `NFToken` objects. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/data-types/permission-values.md b/docs/references/protocol/data-types/permission-values.md index 8f78370a74..2838d0e7c6 100644 --- a/docs/references/protocol/data-types/permission-values.md +++ b/docs/references/protocol/data-types/permission-values.md @@ -3,6 +3,7 @@ seo: description: Format for permissions that can be granted to other accounts. label: - Permissions +status: not_enabled --- # Permission Values @@ -11,7 +12,7 @@ label: - **Transaction Type Permissions** - Permission to send transactions with the specified [transaction type](../transactions/types/index.md). - **Granular Permissions** - Permission to send transactions with a specific subset of functionality. -_(Requires the [PermissionDelegation amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="PermissionDelegation" /%} ## Numeric and String Values diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md b/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md index c86fd4c0ee..dda47f7849 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md @@ -39,30 +39,30 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e |:------------------------------|:----------|:------------------|:----------|:-------------| | `Account` | String | AccountID | Yes | The identifying (classic) address of this [account](../../../../concepts/accounts/index.md). | | `AccountTxnID` | String | UInt256 | No | The identifying hash of the transaction most recently sent by this account. This field must be enabled to use the [`AccountTxnID` transaction field](../../transactions/common-fields.md#accounttxnid). To enable it, send an [AccountSet transaction with the `asfAccountTxnID` flag enabled](../../transactions/types/accountset.md#accountset-flags). | -| `AMMID` | String | UInt256 | No | _(Added by the [AMM amendment][])_ 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. | +| `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) | | `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). _(Added by the [fixNFTokenRemint amendment][])_ | +| `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. | | `MessageKey` | String | Blob | No | A public key that may be used to send encrypted messages to this account. In JSON, uses hexadecimal. Must be exactly 33 bytes, with the first byte indicating the key type: `0x02` or `0x03` for secp256k1 keys, `0xED` for Ed25519 keys. | -| `MintedNFTokens` | Number | UInt32 | No | How many total [non-fungible tokens](../../../../concepts/tokens/nfts/index.md) have been minted by and on behalf of this account. _(Added by the [NonFungibleTokensV1_1 amendment][])_ | -| `NFTokenMinter` | String | AccountID | No | Another account that can mint [non-fungible tokens](../../../../concepts/tokens/nfts/index.md) on behalf of this account. _(Added by the [NonFungibleTokensV1_1 amendment][])_ | +| `MintedNFTokens` | Number | UInt32 | No | How many total [non-fungible tokens](../../../../concepts/tokens/nfts/index.md) have been minted by and on behalf of this account. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | +| `NFTokenMinter` | String | AccountID | No | Another account that can mint [non-fungible tokens](../../../../concepts/tokens/nfts/index.md) on behalf of this account. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `OwnerCount` | Number | UInt32 | Yes | The number of objects this account owns in the ledger, which contributes to its owner reserve. | | `PreviousTxnID` | String | UInt256 | Yes | The identifying hash of the transaction that most recently modified this object. | | `PreviousTxnLgrSeq` | Number | UInt32 | Yes |The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this object. | | `RegularKey` | String | AccountID | No | The address of a [key pair](../../../../concepts/accounts/cryptographic-keys.md) that can be used to sign transactions for this account instead of the master key. Use a [SetRegularKey transaction][] to change this value. | | `Sequence` | Number | UInt32 | Yes | The [sequence number](../../data-types/basic-data-types.md#account-sequence) of the next valid transaction for this account. | -| `TicketCount` | Number | UInt32 | No | How many [Tickets](../../../../concepts/accounts/tickets.md) this account owns in the ledger. This is updated automatically to ensure that the account stays within the hard limit of 250 Tickets at a time. This field is omitted if the account has zero Tickets. _(Added by the [TicketBatch amendment][].)_ | -| `TickSize` | Number | UInt8 | No | How many significant digits to use for exchange rates of Offers involving currencies issued by this address. Valid values are `3` to `15`, inclusive. _(Added by the [TickSize amendment][].)_ | +| `TicketCount` | Number | UInt32 | No | How many [Tickets](../../../../concepts/accounts/tickets.md) this account owns in the ledger. This is updated automatically to ensure that the account stays within the hard limit of 250 Tickets at a time. This field is omitted if the account has zero Tickets. {% amendment-disclaimer name="TicketBatch" /%} | +| `TickSize` | Number | UInt8 | No | How many significant digits to use for exchange rates of Offers involving currencies issued by this address. Valid values are `3` to `15`, inclusive. {% amendment-disclaimer name="TickSize" /%} | | `TransferRate` | Number | UInt32 | No | A [transfer fee](../../../../concepts/tokens/fungible-tokens/transfer-fees.md) to charge other users for sending currency issued by this account to each other. | | `WalletLocator` | String | UInt256 | No | An arbitrary 256-bit value that users can set. | | `WalletSize` | Number | UInt32 | No | Unused. (The code supports this field but there is no way to set it.) | ## Special AMM AccountRoot Entries -_(Added by the [AMM amendment][])_ +{% amendment-disclaimer name="AMM" /%} Automated Market Makers use an AccountRoot ledger entry to issue their LP Tokens and hold the assets in the AMM pool, and an [AMM ledger entry](amm.md) for tracking some of the details of the AMM. The address of an AMM's AccountRoot is randomized so that users cannot identify and fund the address in advance of the AMM being created. Unlike normal accounts, AMM AccountRoot objects are created with the following settings: @@ -87,14 +87,14 @@ AccountRoot objects can have the following flags combined in the `Flags` field: | Flag Name | Hex Value | Decimal Value | Corresponding [AccountSet Flag](../../transactions/types/accountset.md#accountset-flags) | Description | |-----------------------------------|--------------|-------------------|-----------------------------------|----| -| `lsfAllowTrustLineClawback` | `0x80000000` | 2147483648 | `asfAllowTrustLineClawback` | Enable [Clawback](../../../../concepts/tokens/fungible-tokens/clawing-back-tokens.md) for this account. _(Requires the [Clawback amendment][].)_ | +| `lsfAllowTrustLineClawback` | `0x80000000` | 2147483648 | `asfAllowTrustLineClawback` | Enable [Clawback](../../../../concepts/tokens/fungible-tokens/clawing-back-tokens.md) for this account. {% amendment-disclaimer name="Clawback" /%} | | `lsfDefaultRipple` | `0x00800000` | 8388608 | `asfDefaultRipple` | Enable [rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) on this addresses's trust lines by default. Required for issuing addresses; discouraged for others. | -| `lsfDepositAuth` | `0x01000000` | 16777216 | `asfDepositAuth` | This account has [DepositAuth](../../../../concepts/accounts/depositauth.md) enabled, meaning it can only receive funds from transactions it sends, and from [preauthorized](../../../../concepts/accounts/depositauth.md#preauthorization) accounts. _(Added by the [DepositAuth amendment][])_ | +| `lsfDepositAuth` | `0x01000000` | 16777216 | `asfDepositAuth` | This account has [DepositAuth](../../../../concepts/accounts/depositauth.md) enabled, meaning it can only receive funds from transactions it sends, and from [preauthorized](../../../../concepts/accounts/depositauth.md#preauthorization) accounts. {% amendment-disclaimer name="DepositAuth" /%} | | `lsfDisableMaster` | `0x00100000` | 1048576 | `asfDisableMaster` | Disallows use of the master key to sign transactions for this account. | -| `lsfDisallowIncomingCheck` | `0x08000000` | 134217728 | `asfDisallowIncomingCheck` | This account blocks incoming Checks. _(Added by the [DisallowIncoming amendment][].)_ | -| `lsfDisallowIncomingNFTokenOffer` | `0x04000000` | 67108864 | `asfDisallowIncomingNFTokenOffer` | This account blocks incoming NFTokenOffers. _(Added by the [DisallowIncoming amendment][].)_ | -| `lsfDisallowIncomingPayChan` | `0x10000000` | 268435456 | `asfDisallowIncomingPayChan` | This account blocks incoming Payment Channels. _(Added by the [DisallowIncoming amendment][].)_ | -| `lsfDisallowIncomingTrustline` | `0x20000000` | 536870912 | `asfDisallowIncomingTrustline` | This account blocks incoming trust lines. _(Added by the [DisallowIncoming amendment][].)_ | +| `lsfDisallowIncomingCheck` | `0x08000000` | 134217728 | `asfDisallowIncomingCheck` | This account blocks incoming Checks. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `lsfDisallowIncomingNFTokenOffer` | `0x04000000` | 67108864 | `asfDisallowIncomingNFTokenOffer` | This account blocks incoming NFTokenOffers. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `lsfDisallowIncomingPayChan` | `0x10000000` | 268435456 | `asfDisallowIncomingPayChan` | This account blocks incoming Payment Channels. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `lsfDisallowIncomingTrustline` | `0x20000000` | 536870912 | `asfDisallowIncomingTrustline` | This account blocks incoming trust lines. {% amendment-disclaimer name="DisallowIncoming" /%} | | `lsfDisallowXRP` | `0x00080000` | 524288 | `asfDisallowXRP` | Client applications should not send XRP to this account. (Advisory; not enforced by the protocol.) | | `lsfGlobalFreeze` | `0x00400000` | 4194304 | `asfGlobalFreeze` | All assets issued by this account are frozen. | | `lsfNoFreeze` | `0x00200000` | 2097152 | `asfNoFreeze` | This account cannot freeze trust lines connected to it. Once enabled, cannot be disabled. | diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/amendments.md b/docs/references/protocol/ledger-data/ledger-entry-types/amendments.md index 2071868623..1f3255764b 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/amendments.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/amendments.md @@ -52,8 +52,8 @@ In addition to the [common fields](../common-fields.md), the {% code-page-name / | `Flags` | Number | UInt32 | Yes | A bit-map of boolean flags enabled for this object. Currently, the protocol defines no flags for `Amendments` objects. The value is always `0`. | | `LedgerEntryType` | String | UInt16 | Yes | The value `0x0066`, mapped to the string `Amendments`, indicates that this object describes the status of amendments to the XRP Ledger. | | `Majorities` | Array | Array | No | Array of objects describing the status of amendments that have majority support but are not yet enabled. If omitted, there are no pending amendments with majority support. | -| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | -| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | +| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | +| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | Each member of the `Majorities` field, if it is present, is an object with one field, `Majority`, whose contents are a nested object with the following fields: diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/amm.md b/docs/references/protocol/ledger-data/ledger-entry-types/amm.md index 138be015c0..5cc864dde0 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/amm.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/amm.md @@ -9,7 +9,7 @@ labels: An `AMM` ledger entry describes a single [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) (AMM) instance. This is always paired with a [special AccountRoot entry](accountroot.md#special-amm-accountroot-entries). You can create an AMM by sending an [AMMCreate transaction][]. -_(Added by the [AMM amendment][])_ +{% amendment-disclaimer name="AMM" /%} ## Example AMM JSON @@ -68,8 +68,8 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e | `Account` | String - [Address][] | AccountID | Yes | The address of the [special account](accountroot.md#special-amm-accountroot-entries) that holds this AMM's assets. | | `AuctionSlot` | Object | Object | No | Details of the current owner of the auction slot, as an [Auction Slot object](#auction-slot-object). | | `LPTokenBalance` | [Currency Amount][] | Amount | Yes | The total outstanding balance of liquidity provider tokens from this AMM instance. The holders of these tokens can vote on the AMM's trading fee in proportion to their holdings, or redeem the tokens for a share of the AMM's assets which grows with the trading fees collected. | -| `PreviousTxnID` | String - [Hash][] | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | -| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | +| `PreviousTxnID` | String - [Hash][] | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | +| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | | `TradingFee` | Number | UInt16 | Yes | The percentage fee to be charged for trades against this AMM instance, in units of 1/100,000. The maximum value is 1000, for a 1% fee. | | `VoteSlots` | Array | Array | No | A list of vote objects, representing votes on the pool's trading fee. | diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/bridge.md b/docs/references/protocol/ledger-data/ledger-entry-types/bridge.md index f7b8beda14..0d2457df1a 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/bridge.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/bridge.md @@ -10,7 +10,7 @@ status: not_enabled The `Bridge` ledger entry represents a single cross-chain bridge that connects the XRP Ledger with another blockchain, such as its sidechain, and enables value in the form of XRP and other tokens (IOUs) to move efficiently between the two blockchains. You can create a bridge by sending an [XChainCreateBridge transaction][]. -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} ## Example Bridge JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/check.md b/docs/references/protocol/ledger-data/ledger-entry-types/check.md index afe79352db..1dcee15977 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/check.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/check.md @@ -9,7 +9,7 @@ labels: A `Check` entry describes a [check](../../../../concepts/payment-types/checks.md), similar to a paper personal check, which can be cashed by its destination to get money from its sender. You can create a check by sending a [CheckCreate transaction][]. -_(Added by the [Checks amendment][].)_ +{% amendment-disclaimer name="Checks" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/credential.md b/docs/references/protocol/ledger-data/ledger-entry-types/credential.md index c4415c40bc..098a246f12 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/credential.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/credential.md @@ -7,7 +7,7 @@ status: not_enabled A `Credential` entry represents a [credential](../../../../concepts/decentralized-storage/credentials.md), which contains an attestation about a _subject_ account from a _credential issuer_ account. The meaning of the attestation is defined by the issuer. -_(Requires the [Credentials amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="Credentials" /%} ## Example Credential JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md b/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md index ea0972566d..88db81e174 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md @@ -11,7 +11,7 @@ status: not_enabled A `Delegate` ledger entry stores a set of permissions that an account has delegated to another account. You create a `Delegate` entry by sending a [DelegateSet transaction][]. -_(Requires the [PermissionDelegation amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="PermissionDelegation" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md b/docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md index 70d28486e2..bb1eb56c8b 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md @@ -101,7 +101,6 @@ In this case, the ID is the [SHA-512Half][] of the following values, concatenate * The AccountID in the `Authorize` field ### Credential Preauthorization -_(Requires the [Credentials amendment][]. {% not-enabled /%})_ In this case, the ID is the [SHA-512Half][] of the following values, concatenated in order: @@ -109,6 +108,8 @@ In this case, the ID is the [SHA-512Half][] of the following values, concatenate * The AccountID of the owner of this object (the sender of the [DepositPreauth transaction][] that created this object; in other words, the one that granted the preauthorization) * The contents of the `AuthorizeCredentials` field. +{% amendment-disclaimer name="Credentials" /%} + ## See Also - **Transactions** diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/did.md b/docs/references/protocol/ledger-data/ledger-entry-types/did.md index a1e332e423..5949293784 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/did.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/did.md @@ -9,7 +9,7 @@ labels: A `DID` ledger entry holds references to, or data associated with, a single [Decentralized Identifier (DID)](../../../../concepts/decentralized-storage/decentralized-identifiers.md). You can create or modify a DID by sending a [DIDSet transaction][]. -_(Added by the [DID amendment][])_ +{% amendment-disclaimer name="DID" /%} ## Example DID JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md b/docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md index 445165156e..cc0098e22e 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md @@ -97,7 +97,7 @@ All types of directories are automatically updated by the protocol as necessary. | Name | JSON Type | [Internal Type][] | Required? | Description | |:--------------------|:----------|:------------------|:----------|:------------| -| `DomainID` | String | UInt256 | No | (Offer directories only) The ledger entry ID of a permissioned domain. If present, this order book belongs to the corresponding [Permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). Otherwise, this order book is part of the open DEX. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `DomainID` | String | UInt256 | No | (Offer directories only) The ledger entry ID of a permissioned domain. If present, this order book belongs to the corresponding [Permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). Otherwise, this order book is part of the open DEX. {% amendment-disclaimer name="PermissionedDEX" /%} | | `ExchangeRate` | String | UInt64 | No | (Offer directories only) **DEPRECATED**. Do not use. | | `Flags` | Number | UInt32 | Yes | A bit-map of boolean flags enabled for this object. Currently, the protocol defines no flags for `DirectoryNode` objects. The value is always `0`. | | `Indexes` | Array | Vector256 | Yes | The contents of this directory: an array of IDs of other objects. | @@ -106,8 +106,8 @@ All types of directories are automatically updated by the protocol as necessary. | `LedgerEntryType` | String | UInt16 | Yes | The value `0x0064`, mapped to the string `DirectoryNode`, indicates that this object is part of a directory. | | `NFTokenID` | String | UInt256 | No | (NFT offer directories only) ID of the NFT in a buy or sell offer. | | `Owner` | String | AccountID | No | (Owner directories only) The address of the account that owns the objects in this directory. | -| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | -| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | +| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | +| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | | `RootIndex` | String | UInt256 | Yes | The ID of root object for this directory. | | `TakerGetsCurrency` | String | UInt160 | No | (Offer directories only) The currency code of the `TakerGets` amount from the offers in this directory. | | `TakerGetsIssuer` | String | UInt160 | No | (Offer directories only) The issuer of the `TakerGets` amount from the offers in this directory. | @@ -137,7 +137,7 @@ Owner directories and offer directories for fungible tokens do not use flags; th There are three different formulas for creating the ID of a DirectoryNode, depending on which of the following the DirectoryNode represents: * The first page (also called the root) of an Owner or NFT Offer directory -* The first page of an Offer directory, with variants for the open DEX and permissioned DEX _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ +* The first page of an Offer directory, with variants for the open DEX and permissioned DEX {% amendment-disclaimer name="PermissionedDEX" /%} * Later pages of any type The first page of an Owner directory or NFT Offer directory has an ID that is the [SHA-512Half][] of the following values, concatenated in order: diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/escrow.md b/docs/references/protocol/ledger-data/ledger-entry-types/escrow.md index a6aca8706b..f0663d19e5 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/escrow.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/escrow.md @@ -9,7 +9,7 @@ labels: An `Escrow` ledger entry represents an [escrow](../../../../concepts/payment-types/escrow.md), which holds XRP until specific conditions are met. You can create an escrow by sending an [EscrowCreate transaction][]. -_(Added by the [Escrow amendment][].)_ +{% amendment-disclaimer name="Escrow" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/feesettings.md b/docs/references/protocol/ledger-data/ledger-entry-types/feesettings.md index acd00fb685..ec08f202d6 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/feesettings.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/feesettings.md @@ -55,8 +55,8 @@ The fields of the `FeeSettings` ledger entry depend on whether the [XRPFees amen | `BaseFeeDrops` | String | Amount | Yes | The [transaction cost](../../../../concepts/transactions/transaction-cost.md) of the "reference transaction" in drops of XRP. | | `ReserveBaseDrops` | String | Amount | Yes | The [base reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for an account in the XRP Ledger, as drops of XRP. | | `ReserveIncrementDrops` | String | Amount | Yes | The incremental [owner reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for owning objects, as drops of XRP. | -| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | -| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | +| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | +| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | {% /tab %} {% tab label="Legacy Format" %} @@ -66,8 +66,8 @@ The fields of the `FeeSettings` ledger entry depend on whether the [XRPFees amen | `ReferenceFeeUnits` | Number | UInt32 | Yes | The `BaseFee` translated into "fee units". | | `ReserveBase` | Number | UInt32 | Yes | The [base reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for an account in the XRP Ledger, as drops of XRP. | | `ReserveIncrement` | Number | UInt32 | Yes | The incremental [owner reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for owning objects, as drops of XRP. | -| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | -| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | +| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | +| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | {% admonition type="danger" name="Warning" %}The JSON format for this ledger entry type is unusual. The `BaseFee`, `ReserveBase`, and `ReserveIncrement` indicate drops of XRP but ***not*** in the usual format for [specifying XRP][Currency Amount].{% /admonition %} diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md b/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md index 6bf2e647a8..df84be00b5 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md @@ -33,7 +33,7 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e | `Account` | String - [Address][] | AccountID | Yes | The owner (holder) of these MPTs. | | `MPTokenIssuanceID` | String - Hexadecimal | UInt192 | Yes | The `MPTokenIssuance` identifier. | | `MPTAmount` | String - Number | UInt64 | Yes | The amount of tokens currently held by the owner. The minimum is 0 and the maximum is 263-1. | -| `LockedAmount` | String - Number | UInt64 | No | The amount of tokens currently locked up (for example, in escrow or payment channels). _(Requires the [TokenEscrow amendment][] {% not-enabled /%}.)_ | +| `LockedAmount` | String - Number | UInt64 | No | The amount of tokens currently locked up (for example, in escrow). {% amendment-disclaimer name="TokenEscrow" /%} | | `PreviousTxnID` | String - [Hash][] | UInt256 | Yes | The identifying hash of the transaction that most recently modified this entry. | | `PreviousTxnLgrSeq` | Number | UInt32 | Yes | The sequence of the ledger that contains the transaction that most recently modified this object. | | `OwnerNode` | String | UInt64 | Yes | A hint indicating which page of the owner directory links to this entry, in case the directory consists of multiple pages. | diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md b/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md index 6ad068e259..2110d24ab5 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/negativeunl.md @@ -7,7 +7,7 @@ labels: # NegativeUNL [[Source]](https://github.com/XRPLF/rippled/blob/f64cf9187affd69650907d0d92e097eb29693945/include/xrpl/protocol/detail/ledger_entries.macro#L85-L91 "Source") -_(Added by the [NegativeUNL amendment][].)_ +{% amendment-disclaimer name="NegativeUNL" /%} The `NegativeUNL` ledger entry type contains the current status of the [Negative UNL](../../../../concepts/consensus-protocol/negative-unl.md), a list of trusted validators currently believed to be offline. @@ -41,8 +41,8 @@ In addition to the [common fields](../common-fields.md), the {% code-page-name / |:----------------------|:----------|:------------------|:----------|:---------------------| | `DisabledValidators` | Array | Array | No | A list of `DisabledValidator` objects (see below), each representing a trusted validator that is currently disabled. | | `LedgerEntryType` | String | UInt16 | Yes | The value `0x004E`, mapped to the string `NegativeUNL`, indicates that this entry is the Negative UNL. | -| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | -| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ | +| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | +| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. {% amendment-disclaimer name="fixPreviousTxnID" /%} | | `ValidatorToDisable` | String | Blob | No | The public key of a trusted validator that is scheduled to be disabled in the next flag ledger. | | `ValidatorToReEnable` | String | Blob | No | The public key of a trusted validator in the Negative UNL that is scheduled to be re-enabled in the next flag ledger. | diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md b/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md index fb4b57045e..802fd5cc27 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md @@ -9,7 +9,7 @@ labels: An `NFTokenOffer` entry represents an offer to buy, sell or transfer an [NFT](../../../../concepts/tokens/nfts/index.md). You can create an NFT buy or sell offer by sending an [NFTokenCreateOffer transaction][]. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md b/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md index 4be17ab6a7..dfd50d830c 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md @@ -9,7 +9,7 @@ labels: An `NFTokenPage` entry represents a collection of [NFTs](../../../../concepts/tokens/nfts/index.md) owned by the same account. An account can have multiple `NFTokenPage` entries, which form a doubly linked list. NFT directories are automatically updated when an account mints, burns, buys, or sells NFTs. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/offer.md b/docs/references/protocol/ledger-data/ledger-entry-types/offer.md index 88e09e6f23..3b1dad803e 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/offer.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/offer.md @@ -42,10 +42,10 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e | Name | JSON Type | [Internal Type][] | Required? | Description | |:--------------------|:---------------------|:------------------|:----------|:------------| | `Account` | String - [Address][] | AccountID | Yes | The account that owns this offer. | -| `AdditionalBooks` | Array | Array | No | A list of additional offer directories that link to this offer. This field is only present if this is a hybrid offer in a [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). The array always contains exactly 1 entry. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `AdditionalBooks` | Array | Array | No | A list of additional offer directories that link to this offer. This field is only present if this is a hybrid offer in a [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). The array always contains exactly 1 entry. {% amendment-disclaimer name="PermissionedDEX" /%} | | `BookDirectory` | String - [Hash][] | UInt256 | Yes | The ID of the [offer directory](directorynode.md) that links to this offer. | | `BookNode` | String | UInt64 | Yes | A hint indicating which page of the offer directory links to this entry, in case the directory consists of multiple pages. | -| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain. If present, this offer belongs to the corresponding [Permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain. If present, this offer belongs to the corresponding [Permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md). {% amendment-disclaimer name="PermissionedDEX" /%} | | `Expiration` | Number | UInt32 | No | Indicates the time after which this offer is considered unfunded. See [Specifying Time][] for details. | | `LedgerEntryType` | String | UInt16 | Yes | The value `0x006F`, mapped to the string `Offer`, indicates that this is an offer entry. | | `OwnerNode` | String | UInt64 | Yes | A hint indicating which page of the owner directory links to this entry, in case the directory consists of multiple pages. | @@ -63,7 +63,7 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e |--------------|--------------|---------------|-------------|------------------------| | `lsfPassive` | `0x00010000` | 65536 | `tfPassive` | The offer was placed as passive. This has no effect after the offer is placed into the ledger. | | `lsfSell` | `0x00020000` | 131072 | `tfSell` | The offer was placed as a sell offer. This has no effect after the offer is placed in the ledger, because `tfSell` only matters if you get a better rate than you asked for, which can only happen when the offer is initially placed. | -| `lsfHybrid` | `0x00040000` | 262144 | `tfHybrid` | The offer was placed as a hybrid offer, which means it is listed in a [permissioned DEX](/docs/concepts/tokens/decentralized-exchange/permissioned-dexes.md) and the open DEX. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `lsfHybrid` | `0x00040000` | 262144 | `tfHybrid` | The offer was placed as a hybrid offer, which means it is listed in a [permissioned DEX](/docs/concepts/tokens/decentralized-exchange/permissioned-dexes.md) and the open DEX. {% amendment-disclaimer name="PermissionedDEX" /%} | ## {% $frontmatter.seo.title %} Reserve diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md b/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md index f1ad4788be..ce456700aa 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md @@ -9,7 +9,7 @@ labels: An `Oracle` ledger entry holds data associated with a single [price oracle](../../../../concepts/decentralized-storage/price-oracles.md), which can store information on up to 10 asset pairs. You can create or modify a price oracle with an [OracleSet transaction][]. -_(Added by the [PriceOracle amendment][])_ +{% amendment-disclaimer name="PriceOracle" /%} ## Example Oracle JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md b/docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md index 123ea3e6b0..5b0d126041 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md @@ -9,7 +9,7 @@ labels: A `PayChannel` entry represents a [payment channel](../../../../concepts/payment-types/payment-channels.md). You can create a payment channel with a [PaymentChannelCreate transaction][]. -_(Added by the [PayChan amendment][].)_ +{% amendment-disclaimer name="PayChan" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md b/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md index 86e017078c..9a9d482ead 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md @@ -11,7 +11,7 @@ status: not_enabled A `PermissionedDomain` ledger entry describes a single [permissioned domain][] instance. You can create a permissioned domain by sending a [PermissionedDomainSet transaction][]. -_(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="PermissionedDomains" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md b/docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md index 9c27354fe9..de2c832b00 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md @@ -9,7 +9,7 @@ labels: A `SignerList` entry represents a list of parties that, as a group, are authorized to sign a transaction in place of an individual account by [multi-signing](../../../../concepts/accounts/multi-signing.md). You can create, replace, or remove a signer list using a [SignerListSet transaction][]. -_(Added by the [MultiSign amendment][].)_ +{% amendment-disclaimer name="MultiSign" /%} ## Example {% $frontmatter.seo.title %} JSON @@ -70,13 +70,13 @@ Each member of the `SignerEntries` field is an object that describes that signer |:----------------|:----------|:--------------|:-------------------------------| | `Account` | String | AccountID | An XRP Ledger address whose signature contributes to the multi-signature. It does not need to be a funded address in the ledger. | | `SignerWeight` | Number | UInt16 | The weight of a signature from this signer. A multi-signature is only valid if the sum weight of the signatures provided meets or exceeds the signer list's `SignerQuorum` value. | -| `WalletLocator` | String | UInt256 | _(Optional)_ Arbitrary hexadecimal data. This can be used to identify the signer or for other, related purposes. _(Added by the [ExpandedSignerList amendment][].)_ | +| `WalletLocator` | String | UInt256 | _(Optional)_ Arbitrary hexadecimal data. This can be used to identify the signer or for other, related purposes. {% amendment-disclaimer name="ExpandedSignerList" /%} | When processing a multi-signed transaction, the server looks up the `Account` values with respect to the ledger at the time of transaction execution. If the address _does not_ correspond to a funded [AccountRoot ledger entry](accountroot.md), then only the [master private key](../../../../concepts/accounts/cryptographic-keys.md) associated with that address can be used to produce a valid signature. If the account _does_ exist in the ledger, then it depends on the state of that account. If the account has a Regular Key configured, the Regular Key can be used. The account's master key can only be used if it is not disabled. A multi-signature cannot be used as part of another multi-signature. ## {% $frontmatter.seo.title %} Flags -_(Added by the [MultiSignReserve amendment][].)_ +{% amendment-disclaimer name="MultiSignReserve" /%} SignerList entries can have the following value in the `Flags` field: diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/ticket.md b/docs/references/protocol/ledger-data/ledger-entry-types/ticket.md index 5f8b3ea304..e5ae20f65e 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/ticket.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/ticket.md @@ -9,7 +9,7 @@ labels: A `Ticket` entry type represents a [Ticket](../../../../concepts/accounts/tickets.md), which tracks an account [sequence number][Sequence Number] that has been set aside for future use. You can create new tickets with a [TicketCreate transaction][]. -_(Added by the [TicketBatch amendment][].)_ +{% amendment-disclaimer name="TicketBatch" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedclaimid.md b/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedclaimid.md index c825a829f8..01d3bc812b 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedclaimid.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedclaimid.md @@ -14,7 +14,7 @@ The `XChainOwnedClaimID` entry must be acquired on the destination chain before You can create a new `XChainOwnedClaimID` by sending an [XChainCreateClaimID transaction][]. An `XChainOwnedClaimID` is destroyed when the funds are successfully claimed on the destination chain. -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainOwnedClaimID JSON diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedcreateaccountclaimid.md b/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedcreateaccountclaimid.md index 27631b9328..afa8ed17c5 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedcreateaccountclaimid.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedcreateaccountclaimid.md @@ -14,7 +14,7 @@ You can create a new `XChainOwnedCreateAccountClaimID` entry by sending an [XCha An `XChainOwnedCreateAccountClaimID` ledger entry is destroyed when all the attestations have been received and the funds have transferred to the new account. -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainOwnedCreateAccountClaimID JSON diff --git a/docs/references/protocol/transactions/common-fields.md b/docs/references/protocol/transactions/common-fields.md index aa8dece2a6..1afa546ae1 100644 --- a/docs/references/protocol/transactions/common-fields.md +++ b/docs/references/protocol/transactions/common-fields.md @@ -13,9 +13,9 @@ Every transaction has the same set of common fields, plus additional fields base | `Account` | String - [Address][] | AccountID | Yes | The [account](../../../concepts/accounts/index.md) that initiated the transaction. | | `TransactionType` | String | UInt16 | Yes | The type of transaction. Valid [transaction types](types/index.md) include: `Payment`, `OfferCreate`, `TrustSet`, and many others. | | `Fee` | String - Number | Amount | Yes; [auto-fillable][] | Integer amount of XRP, in drops, to be destroyed as a cost for sending this transaction. Some transaction types have different minimum requirements. See [Transaction Cost][] for details. | -| `Sequence` | Number | UInt32 | Yes; [auto-fillable][] | The [sequence number](../data-types/basic-data-types.md#account-sequence) of the account sending the transaction. A transaction is only valid if the `Sequence` number is exactly 1 greater than the previous transaction from the same account. The special case `0` means the transaction is using a [Ticket](../../../concepts/accounts/tickets.md) instead _(Added by the [TicketBatch amendment][].)_. | +| `Sequence` | Number | UInt32 | Yes; [auto-fillable][] | The [sequence number](../data-types/basic-data-types.md#account-sequence) of the account sending the transaction. A transaction is only valid if the `Sequence` number is exactly 1 greater than the previous transaction from the same account. The special case `0` means the transaction is using a [Ticket](../../../concepts/accounts/tickets.md) instead {% amendment-disclaimer name="TicketBatch" /%}. | | [`AccountTxnID`](#accounttxnid) | String - [Hash][] | UInt256 | No | Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash. | -| [`Delegate`](#delegate) | String - [Address][] | AccountID | No | A delegate account that is sending the transaction on behalf of the `Account`. _(Requires the [PermissionDelegation amendment][] {% not-enabled /%})_ | +| [`Delegate`](#delegate) | String - [Address][] | AccountID | No | A delegate account that is sending the transaction on behalf of the `Account`. {% amendment-disclaimer name="PermissionDelegation" /%} | | [`Flags`](#flags-field) | Number | UInt32 | No | Set of bit-flags for this transaction. | | `LastLedgerSequence` | Number | UInt32 | No; [auto-fillable][] | Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected. See [Reliable Transaction Submission](../../../concepts/transactions/reliable-transaction-submission.md) for more details. | | [`Memos`](#memos-field) | Array of Objects | Array | No | Additional arbitrary information attached to this transaction. | @@ -67,7 +67,7 @@ If the `Delegate` field is provided, this transaction is being sent by a differe Sending a transaction this way is only possible if the delegating account has granted the appropriate transaction permissions to the delegate account. For more information, see [Permission Delegation](/docs/concepts/accounts/permission-delegation.md). -_(Requires the [PermissionDelegation amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="PermissionDelegation" /%} ## Flags Field diff --git a/docs/references/protocol/transactions/metadata.md b/docs/references/protocol/transactions/metadata.md index 6ba3dda528..34e882d522 100644 --- a/docs/references/protocol/transactions/metadata.md +++ b/docs/references/protocol/transactions/metadata.md @@ -256,7 +256,7 @@ Transactions (`tx` and `account_tx`) involving NFTs can contain the following fi | `offer_id` | String | Shows the `OfferID`of a new `NFTokenOffer` in a response from a `NFTokenCreateOffer` transaction. | ## MPT Fields -_(Requires the [MPTokensV1 amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="MPTokensV1" /%} ### Synthetic mpt_issuance_id field `MPTokenIssuanceID` is an identifier that allows you to specify an `MPTokenIssuance` in RPCs. The server adds a synthetically parsed `mpt_issuance_id` field to API responses to avoid the need for client-side parsing of the `MPTokenIssuanceID`. diff --git a/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md b/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md index 4f92cec549..8f11ec8459 100644 --- a/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md +++ b/docs/references/protocol/transactions/pseudo-transaction-types/unlmodify.md @@ -9,7 +9,7 @@ labels: # UNLModify [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Change.cpp "Source") -_(Added by the [NegativeUNL amendment][].)_ +{% amendment-disclaimer name="NegativeUNL" /%} A `UNLModify` [pseudo-transaction](pseudo-transaction-types.md) marks a change to the [Negative UNL](../../../../concepts/consensus-protocol/negative-unl.md), indicating that a trusted validator has gone offline or come back online. diff --git a/docs/references/protocol/transactions/transaction-results/tec-codes.md b/docs/references/protocol/transactions/transaction-results/tec-codes.md index 38073cabde..eb030b1cf9 100644 --- a/docs/references/protocol/transactions/transaction-results/tec-codes.md +++ b/docs/references/protocol/transactions/transaction-results/tec-codes.md @@ -17,20 +17,20 @@ A transaction that fails with a `tec` code destroys the XRP paid as a [transacti | Code | Value | Explanation | |:---------------------------|:------|:----------------------------------------| -| `tecAMM_ACCOUNT` | 168 | The transaction failed because the operation is not allowed on Automated Market Maker (AMM) accounts. _(Added by the [AMM amendment][])_ | -| `tecAMM_UNFUNDED` | 162 | The [AMMCreate transaction][] failed because the sender does not have enough of the specified assets to fund it. _(Added by the [AMM amendment][])_ | -| `tecAMM_BALANCE` | 163 | The [AMMDeposit][] or [AMMWithdraw][] transaction failed because either the AMM or the user does not hold enough of one of the specified assets. (For example, you tried to withdraw more than the AMM holds.) _(Added by the [AMM amendment][])_ | -| `tecAMM_EMPTY` | 166 | The AMM-related transaction failed because the AMM has no assets in its pool. In this state, you can only delete the AMM or fund it with a new deposit. _(Added by the [AMM amendment][])_ | -| `tecAMM_FAILED` | 164 | The AMM-related transaction failed. For [AMMDeposit][] or [AMMWithdraw][] this could be because the sender does not have enough of the specified assets, or the transaction requested an effective price that isn't possible with the available amounts. For [AMMBid][] this could be because the account does not have enough to win the bid or needs more than their specified maximum bid. For [AMMVote][], this could be because there are already too many votes from other accounts that hold more of this AMM's LP Tokens. _(Added by the [AMM amendment][])_ | -| `tecAMM_INVALID_TOKENS` | 165 | The AMM-related transaction failed due to insufficient LP Tokens or problems with rounding; for example, depositing a very small amount of assets could fail if the amount of LP Tokens to be returned rounds down to zero. _(Added by the [AMM amendment][])_ | -| `tecAMM_NOT_EMPTY` | 167 | The transaction was meant to operate on an AMM with empty asset pools, but the specified AMM currently holds assets. _(Added by the [AMM amendment][])_ | -| `tecCANT_ACCEPT_OWN_NFTOKEN_OFFER` | 157 | The transaction tried to accept an offer that was placed by the same account to buy or sell a [non-fungible token](../../../../concepts/tokens/nfts/index.md). _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `tecAMM_ACCOUNT` | 168 | The transaction failed because the operation is not allowed on Automated Market Maker (AMM) accounts. {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_UNFUNDED` | 162 | The [AMMCreate transaction][] failed because the sender does not have enough of the specified assets to fund it. {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_BALANCE` | 163 | The [AMMDeposit][] or [AMMWithdraw][] transaction failed because either the AMM or the user does not hold enough of one of the specified assets. (For example, you tried to withdraw more than the AMM holds.) {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_EMPTY` | 166 | The AMM-related transaction failed because the AMM has no assets in its pool. In this state, you can only delete the AMM or fund it with a new deposit. {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_FAILED` | 164 | The AMM-related transaction failed. For [AMMDeposit][] or [AMMWithdraw][] this could be because the sender does not have enough of the specified assets, or the transaction requested an effective price that isn't possible with the available amounts. For [AMMBid][] this could be because the account does not have enough to win the bid or needs more than their specified maximum bid. For [AMMVote][], this could be because there are already too many votes from other accounts that hold more of this AMM's LP Tokens. {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_INVALID_TOKENS` | 165 | The AMM-related transaction failed due to insufficient LP Tokens or problems with rounding; for example, depositing a very small amount of assets could fail if the amount of LP Tokens to be returned rounds down to zero. {% amendment-disclaimer name="AMM" /%} | +| `tecAMM_NOT_EMPTY` | 167 | The transaction was meant to operate on an AMM with empty asset pools, but the specified AMM currently holds assets. {% amendment-disclaimer name="AMM" /%} | +| `tecCANT_ACCEPT_OWN_NFTOKEN_OFFER` | 157 | The transaction tried to accept an offer that was placed by the same account to buy or sell a [non-fungible token](../../../../concepts/tokens/nfts/index.md). {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecCLAIM` | 100 | Unspecified failure, with transaction cost destroyed. | | `tecCRYPTOCONDITION_ERROR` | 146 | This [EscrowCreate][] or [EscrowFinish][] transaction contained a malformed or mismatched crypto-condition. | | `tecDIR_FULL` | 121 | The transaction tried to add an object (such as a trust line, Check, Escrow, or Payment Channel) to an account's owner directory, but that account cannot own any more objects in the ledger. | | `tecDUPLICATE` | 149 | The transaction tried to create an object (such as a [DepositPreauth][] authorization) that already exists. | | `tecDST_TAG_NEEDED` | 143 | The [Payment transaction][] omitted a [destination tag](../../../../concepts/transactions/source-and-destination-tags.md), but the destination account has the `lsfRequireDestTag` flag enabled. | -| `tecEMPTY_DID` | 187 | The transaction tried to create a [DID entry][] with no contents. A DID must not be empty. _(Added by the [DID amendment][] {% not-enabled /%})_ | +| `tecEMPTY_DID` | 187 | The transaction tried to create a [DID entry][] with no contents. A DID must not be empty. {% amendment-disclaimer name="DID" /%} | | `tecEXPIRED` | 148 | The transaction tried to create an object (such as an Offer or a Check) whose provided Expiration time has already passed. | | `tecFAILED_PROCESSING` | 105 | An unspecified error occurred when processing the transaction. | | `tecFROZEN` | 137 | The [OfferCreate transaction][] failed because one or both of the assets involved are subject to a [global freeze](../../../../concepts/tokens/fungible-tokens/freezes.md). | @@ -38,17 +38,17 @@ A transaction that fails with a `tec` code destroys the XRP paid as a [transacti | `tecINSUF_RESERVE_LINE` | 122 | The transaction failed because the sending account does not have enough XRP to create a new trust line. (See: [Reserves](../../../../concepts/accounts/reserves.md)) This error occurs when the counterparty already has a trust line in a non-default state to the sending account for the same currency. (See `tecNO_LINE_INSUF_RESERVE` for the other case.) | | `tecINSUF_RESERVE_OFFER` | 123 | The transaction failed because the sending account does not have enough XRP to create a new Offer. (See: [Reserves](../../../../concepts/accounts/reserves.md)) | | `tecINSUFF_FEE` | 136 | The transaction failed because the sending account does not have enough XRP to pay the [transaction cost](../../../../concepts/transactions/transaction-cost.md) that it specified. (In this case, the transaction processing destroys all of the sender's XRP even though that amount is lower than the specified transaction cost.) This result only occurs if the account's balance decreases _after_ this transaction has been distributed to enough of the network to be included in a consensus set. Otherwise, the transaction fails with [`terINSUF_FEE_B`](ter-codes.md) before being distributed. | -| `tecINSUFFICIENT_FUNDS` | 158 | One of the accounts involved does not hold enough of a necessary asset. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | -| `tecINSUFFICIENT_PAYMENT` | 161 | The amount specified is not enough to pay all fees involved in the transaction. For example, when trading a non-fungible token, the buy amount may not be enough to pay both the broker fee and the sell amount. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `tecINSUFFICIENT_FUNDS` | 158 | One of the accounts involved does not hold enough of a necessary asset. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | +| `tecINSUFFICIENT_PAYMENT` | 161 | The amount specified is not enough to pay all fees involved in the transaction. For example, when trading a non-fungible token, the buy amount may not be enough to pay both the broker fee and the sell amount. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecINSUFFICIENT_RESERVE` | 141 | The transaction would increase the [reserve requirement](../../../../concepts/accounts/reserves.md) higher than the sending account's balance. [SignerListSet][], [PaymentChannelCreate][], [PaymentChannelFund][], and [EscrowCreate][] can return this error code. See [Signer Lists and Reserves](../../ledger-data/ledger-entry-types/signerlist.md#signer-lists-and-reserves) for more information. | | `tecINTERNAL` | 144 | Unspecified internal error, with transaction cost applied. This error code should not normally be returned. If you can reproduce this error, please [report an issue](https://github.com/XRPLF/rippled/issues). | -| `tecINVALID_UPDATE_TIME` | 188 | The [OracleSet transaction][] failed because the `LastUpdateTime` is invalid. This can occur when the time is more than 300 seconds before or after the ledger close time, or when updating an existing oracle, the new `LastUpdateTime` is not greater than the previous value. _(Added by the [PriceOracle amendment][])_ | -| `tecINVARIANT_FAILED` | 147 | An invariant check failed when trying to execute this transaction. Added by the [EnforceInvariants amendment][]. If you can reproduce this error, please [report an issue](https://github.com/XRPLF/rippled/issues). | -| `tecKILLED` | 150 | The [OfferCreate transaction][] specified the `tfFillOrKill` flag and could not be filled, so it was killed. _(Added by the [fix1578 amendment][].)_ | -| `tecMAX_SEQUENCE_REACHED` | 153 | A sequence number field is already at its maximum. This includes the `MintedNFTokens` field. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `tecINVALID_UPDATE_TIME` | 188 | The [OracleSet transaction][] failed because the `LastUpdateTime` is invalid. This can occur when the time is more than 300 seconds before or after the ledger close time, or when updating an existing oracle, the new `LastUpdateTime` is not greater than the previous value. {% amendment-disclaimer name="PriceOracle" /%} | +| `tecINVARIANT_FAILED` | 147 | An invariant check failed when trying to execute this transaction. If you can reproduce this error, please [report an issue](https://github.com/XRPLF/rippled/issues). {% amendment-disclaimer name="EnforceInvariants" /%} | +| `tecKILLED` | 150 | The [OfferCreate transaction][] specified the `tfFillOrKill` flag and could not be filled, so it was killed. {% amendment-disclaimer name="fix1578" /%} | +| `tecMAX_SEQUENCE_REACHED` | 153 | A sequence number field is already at its maximum. This includes the `MintedNFTokens` field. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecNEED_MASTER_KEY` | 142 | This transaction tried to cause changes that require the master key, such as [disabling the master key or giving up the ability to freeze balances](../types/accountset.md#accountset-flags). | -| `tecNFTOKEN_BUY_SELL_MISMATCH` | 155 | The [NFTokenAcceptOffer transaction][] attempted to match incompatible offers to buy and sell a non-fungible token. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | -| `tecNFTOKEN_OFFER_TYPE_MISMATCH` | 156 | One or more of the offers specified in the transaction was not the right type of offer. (For example, a buy offer was specified in the `NFTokenSellOffer` field.) _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `tecNFTOKEN_BUY_SELL_MISMATCH` | 155 | The [NFTokenAcceptOffer transaction][] attempted to match incompatible offers to buy and sell a non-fungible token. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | +| `tecNFTOKEN_OFFER_TYPE_MISMATCH` | 156 | One or more of the offers specified in the transaction was not the right type of offer. (For example, a buy offer was specified in the `NFTokenSellOffer` field.) {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecNO_ALTERNATIVE_KEY` | 130 | The transaction tried to remove the only available method of [authorizing transactions](../../../../concepts/transactions/index.md#authorizing-transactions). This could be a [SetRegularKey transaction][] to remove the regular key, a [SignerListSet transaction][] to delete a SignerList, or an [AccountSet transaction][] to disable the master key. (Prior to `rippled` 0.30.0, this was called `tecMASTER_DISABLED`.) | | `tecNO_AUTH` | 134 | The transaction failed because it needs to add a balance on a trust line to an account with the `lsfRequireAuth` flag enabled, and that trust line has not been authorized. If the trust line does not exist at all, `tecNO_LINE` occurs instead. | | `tecNO_DST` | 124 | The account on the receiving end of the transaction does not exist. This includes Payment and TrustSet transaction types. (It could be created if it received enough XRP.) | @@ -60,9 +60,9 @@ A transaction that fails with a `tec` code destroys the XRP paid as a [transacti | `tecNO_LINE_REDUNDANT` | 127 | The transaction failed because it tried to set a trust line to its default state, but the trust line did not exist. | | `tecNO_PERMISSION` | 139 | The sender does not have permission to do this operation. For example, the [EscrowFinish transaction][] tried to release a held payment before its `FinishAfter` time, someone tried to use [PaymentChannelFund][] on a channel the sender does not own, or a [Payment][] tried to deliver funds to an account with the "DepositAuth" flag enabled. | | `tecNO_REGULAR_KEY` | 131 | The [AccountSet transaction][] tried to disable the master key, but the account does not have another way to [authorize transactions](../../../../concepts/transactions/index.md#authorizing-transactions). If [multi-signing](../../../../concepts/accounts/multi-signing.md) is enabled, this code is deprecated and `tecNO_ALTERNATIVE_KEY` is used instead. | -| `tecNO_SUITABLE_NFTOKEN_PAGE` | 154 | The transaction tried to mint or acquire a non-fungible token but the account receiving the `NFToken` does not have a directory page that can hold it. This situation is rare. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `tecNO_SUITABLE_NFTOKEN_PAGE` | 154 | The transaction tried to mint or acquire a non-fungible token but the account receiving the `NFToken` does not have a directory page that can hold it. This situation is rare. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecNO_TARGET` | 138 | The transaction referenced an Escrow or PayChannel ledger object that doesn't exist, either because it never existed or it has already been deleted. (For example, another [EscrowFinish transaction][] has already executed the held payment.) Alternatively, the destination account has `asfDisallowXRP` set so it cannot be the destination of this [PaymentChannelCreate][] or [EscrowCreate][] transaction. | -| `tecOBJECT_NOT_FOUND` | 160 | One of the objects specified by this transaction did not exist in the ledger. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `tecOBJECT_NOT_FOUND` | 160 | One of the objects specified by this transaction did not exist in the ledger. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tecOVERSIZE` | 145 | This transaction could not be processed, because the server created an excessively large amount of [metadata](../metadata.md) when it tried to apply the transaction. | | `tecOWNERS` | 132 | The transaction cannot succeed because the sender already owns objects in the ledger. For example, an account cannot enable the [`lsfRequireAuth`](../types/accountset.md#accountset-flags) flag if it has any trust lines or available offers. | | `tecPATH_DRY` | 128 | The transaction failed because the provided [paths](../../../../concepts/tokens/fungible-tokens/paths.md) did not have enough liquidity to send anything at all. This could mean that the source and destination accounts are not linked by [trust lines](../../../../concepts/tokens/fungible-tokens/index.md). | diff --git a/docs/references/protocol/transactions/transaction-results/tef-codes.md b/docs/references/protocol/transactions/transaction-results/tef-codes.md index 1ac27f43f4..38b228334c 100644 --- a/docs/references/protocol/transactions/transaction-results/tef-codes.md +++ b/docs/references/protocol/transactions/transaction-results/tef-codes.md @@ -1,6 +1,4 @@ --- -html: tef-codes.html -parent: transaction-results.html seo: description: tef codes indicate that the transaction failed and was not included in a ledger, but the transaction could have succeeded in some theoretical ledger. labels: @@ -26,10 +24,10 @@ These codes indicate that the transaction failed and was not included in a ledge | `tefEXCEPTION` | While processing the transaction, the server entered an unexpected state. This may be caused by unexpected inputs, for example if the binary data for the transaction is grossly malformed. If you can reproduce this error, please [report an issue](https://github.com/XRPLF/rippled/issues) to get it fixed. | | `tefFAILURE` | Unspecified failure in applying the transaction. | | `tefINTERNAL` | When trying to apply the transaction, the server entered an unexpected state. If you can reproduce this error, please [report an issue](https://github.com/XRPLF/rippled/issues) to get it fixed. | -| `tefINVARIANT_FAILED` | An invariant check failed when trying to claim the [transaction cost](../../../../concepts/transactions/transaction-cost.md). Added by the [EnforceInvariants amendment][]. If you can reproduce this error, please [report an issue](https://github.com/XRPLF/rippled/issues). | +| `tefINVARIANT_FAILED` | An invariant check failed when trying to claim the [transaction cost](../../../../concepts/transactions/transaction-cost.md). If you can reproduce this error, please [report an issue](https://github.com/XRPLF/rippled/issues). {% amendment-disclaimer name="EnfroceInvariants" /%} | | `tefMASTER_DISABLED` | The transaction was signed with the account's master key, but the account has the `lsfDisableMaster` field set. | | `tefMAX_LEDGER` | The transaction included a [`LastLedgerSequence`](../../../../concepts/transactions/reliable-transaction-submission.md#lastledgersequence) parameter, but the current ledger's sequence number is already higher than the specified value. | -| `tefNFTOKEN_IS_NOT_TRANSFERABLE` | The transaction attempted to send a [non-fungible token](../../../../concepts/tokens/nfts/index.md) to another account, but the `NFToken` has the `lsfTransferable` flag disabled and the transfer would not be to or from the issuer. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `tefNFTOKEN_IS_NOT_TRANSFERABLE` | The transaction attempted to send a [non-fungible token](../../../../concepts/tokens/nfts/index.md) to another account, but the `NFToken` has the `lsfTransferable` flag disabled and the transfer would not be to or from the issuer. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `tefNO_AUTH_REQUIRED` | The [TrustSet transaction][] tried to mark a trust line as authorized, but the `lsfRequireAuth` flag is not enabled for the corresponding account, so authorization is not necessary. | | `tefNO_TICKET` | The transaction attempted to use a [Ticket](../../../../concepts/accounts/tickets.md), but the specified `TicketSequence` number does not exist in the ledger, and cannot be created in the future because it is earlier than the sender's current sequence number. | | `tefNOT_MULTI_SIGNING` | The transaction was [multi-signed](../../../../concepts/accounts/multi-signing.md), but the sending account has no SignerList defined. | diff --git a/docs/references/protocol/transactions/transaction-results/tem-codes.md b/docs/references/protocol/transactions/transaction-results/tem-codes.md index 9e61b7815f..93d9bbedf8 100644 --- a/docs/references/protocol/transactions/transaction-results/tem-codes.md +++ b/docs/references/protocol/transactions/transaction-results/tem-codes.md @@ -1,10 +1,8 @@ --- -html: tem-codes.html -parent: transaction-results.html seo: description: tem codes indicate that the transaction was malformed, and cannot succeed according to the XRP Ledger protocol. labels: - - Transaction Sending + - Transaction Sending --- # tem Codes @@ -14,7 +12,7 @@ These codes indicate that the transaction was malformed, and cannot succeed acco | Code | Explanation | |:------------------------------|:----------------------------------------------| -| `temBAD_AMM_TOKENS` | The transaction incorrectly specified one or more assets. For example, the asset's issuer does not match the corresponding asset in the AMM's pool, or the transaction specified the same asset twice. _(Added by the [AMM amendment][])_ | +| `temBAD_AMM_TOKENS` | The transaction incorrectly specified one or more assets. For example, the asset's issuer does not match the corresponding asset in the AMM's pool, or the transaction specified the same asset twice. {% amendment-disclaimer name="AMM" /%} | | `temBAD_AMOUNT` | An amount specified by the transaction (for example the destination `Amount` or `SendMax` values of a [Payment][]) was invalid, possibly because it was a negative number. | | `temBAD_AUTH_MASTER` | The key used to sign this transaction does not match the master key for the account sending it, and the account does not have a [Regular Key](../../../../concepts/accounts/cryptographic-keys.md) set. | | `temBAD_CURRENCY` | The transaction improperly specified a currency field. See [Specifying Currency Amounts][Currency Amount] for the correct format. | @@ -22,7 +20,7 @@ These codes indicate that the transaction was malformed, and cannot succeed acco | `temBAD_FEE` | The transaction improperly specified its `Fee` value, for example by listing a non-XRP currency or some negative amount of XRP. | | `temBAD_ISSUER` | The transaction improperly specified the `issuer` field of some currency included in the request. | | `temBAD_LIMIT` | The [TrustSet transaction][] improperly specified the `LimitAmount` value of a trust line. | -| `temBAD_NFTOKEN_TRANSFER_FEE` | The [NFTokenMint transaction][] improperly specified the `TransferFee` field of the transaction. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `temBAD_NFTOKEN_TRANSFER_FEE` | The [NFTokenMint transaction][] improperly specified the `TransferFee` field of the transaction. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `temBAD_OFFER` | The [OfferCreate transaction][] specifies an invalid offer, such as offering to trade XRP for itself, or offering a negative amount. | | `temBAD_PATH` | The [Payment transaction][] specifies one or more [Paths](../../../../concepts/tokens/fungible-tokens/paths.md) improperly, for example including an issuer for XRP, or specifying an account differently. | | `temBAD_PATH_LOOP` | One of the [Paths](../../../../concepts/tokens/fungible-tokens/paths.md) in the [Payment transaction][] was flagged as a loop, so it cannot be processed in a bounded amount of time. | @@ -45,7 +43,7 @@ These codes indicate that the transaction was malformed, and cannot succeed acco | `temREDUNDANT` | The transaction would do nothing; for example, it is sending a payment directly to the sending account, or creating an offer to buy and sell the same currency from the same issuer. | | `temREDUNDANT_SEND_MAX` | {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.28.0" %}Removed in: rippled 0.28.0{% /badge %} | | `temRIPPLE_EMPTY` | The [Payment transaction][] includes an empty `Paths` field, but paths are necessary to complete this payment. | -| `temSEQ_AND_TICKET` | The transaction contains both a `TicketSequence` field and a non-zero `Sequence` value. A transaction cannot include both. _(Added by the [TicketBatch amendment][].)_ | +| `temSEQ_AND_TICKET` | The transaction contains both a `TicketSequence` field and a non-zero `Sequence` value. A transaction cannot include both. {% amendment-disclaimer name="TicketBatch" /%} | | `temBAD_WEIGHT` | The [SignerListSet transaction][] includes a `SignerWeight` that is invalid, for example a zero or negative value. | | `temBAD_SIGNER` | The [SignerListSet transaction][] includes a signer who is invalid. For example, there may be duplicate entries, or the owner of the SignerList may also be a member. | | `temBAD_QUORUM` | The [SignerListSet transaction][] has an invalid `SignerQuorum` value. Either the value is not greater than zero, or it is more than the sum of all signers in the list. | diff --git a/docs/references/protocol/transactions/transaction-results/ter-codes.md b/docs/references/protocol/transactions/transaction-results/ter-codes.md index 02851e70c3..450433e54d 100644 --- a/docs/references/protocol/transactions/transaction-results/ter-codes.md +++ b/docs/references/protocol/transactions/transaction-results/ter-codes.md @@ -20,7 +20,7 @@ Transactions with `ter` codes have not been applied to the current ledger and ha | `terINSUF_FEE_B` | The account sending the transaction does not have enough XRP to pay the `Fee` specified in the transaction. | | `terLAST` | Used internally only. This code should never be returned. | | `terNO_ACCOUNT` | The address sending the transaction is not funded in the ledger (yet). | -| `terNO_AMM` | The AMM-related transaction specifies an asset pair that does not currently have an AMM instance. _(Added by the [AMM amendment][])_ | +| `terNO_AMM` | The AMM-related transaction specifies an asset pair that does not currently have an AMM instance. {% amendment-disclaimer name="AMM" /%} | | `terNO_AUTH` | The transaction would involve adding currency issued by an account with `lsfRequireAuth` enabled to a trust line that is not authorized. For example, you placed an offer to buy a currency you aren't authorized to hold. | | `terNO_LINE` | Used internally only. This code should never be returned. | | `terNO_RIPPLE` | The transaction can't succeed because of [rippling settings](/docs/concepts/tokens/fungible-tokens/rippling/). For example, the transaction tried to create an AMM even though the issuer of at least one of the tokens has not enabled the Default Ripple flag. | diff --git a/docs/references/protocol/transactions/types/accountdelete.md b/docs/references/protocol/transactions/types/accountdelete.md index 4bba21456f..11ed6d6fa4 100644 --- a/docs/references/protocol/transactions/types/accountdelete.md +++ b/docs/references/protocol/transactions/types/accountdelete.md @@ -5,12 +5,11 @@ labels: - Accounts --- # AccountDelete - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteAccount.cpp "Source") An AccountDelete transaction deletes an [account](../../ledger-data/ledger-entry-types/accountroot.md) and any objects it owns in the XRP Ledger, if possible, sending the account's remaining XRP to a specified destination account. See [Deleting Accounts](../../../../concepts/accounts/deleting-accounts.md) for the requirements to delete an account. -_(Added by the [DeletableAccounts amendment][].)_ +{% amendment-disclaimer name="DeletableAccounts" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/accountset.md b/docs/references/protocol/transactions/types/accountset.md index 5eff632559..f4fce041db 100644 --- a/docs/references/protocol/transactions/types/accountset.md +++ b/docs/references/protocol/transactions/types/accountset.md @@ -5,10 +5,9 @@ labels: - Accounts --- # AccountSet - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetAccount.cpp "Source") -An AccountSet transaction modifies the properties of an [account in the XRP Ledger](../../ledger-data/ledger-entry-types/accountroot.md). +Modify the settings or properties of an [account in the XRP Ledger](../../../../concepts/accounts/index.md). ## Example {% $frontmatter.seo.title %} JSON @@ -34,10 +33,10 @@ An AccountSet transaction modifies the properties of an [account in the XRP Ledg | [`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) | | `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). _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `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" /%} | | [`SetFlag`](#accountset-flags) | Number | UInt32 | Integer flag to enable for this account. | | [`TransferRate`](#transferrate) | Number | UInt32 | The fee to charge when users transfer this account's tokens, represented as billionths of a unit. Cannot be more than `2000000000` or less than `1000000000`, except for the special case `0` meaning no fee. | -| [`TickSize`](../../../../concepts/tokens/decentralized-exchange/ticksize.md) | Number | UInt8 | _(Optional)_ Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are `3` to `15` inclusive, or `0` to disable. _(Added by the [TickSize amendment][])_ | +| [`TickSize`](../../../../concepts/tokens/decentralized-exchange/ticksize.md) | Number | UInt8 | _(Optional)_ Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are `3` to `15` inclusive, or `0` to disable. {% amendment-disclaimer name="TickSize" /%} | | `WalletLocator` | String | UInt256 | An arbitrary 256-bit value. If specified, the value is stored as part of the account but has no inherent meaning or requirements. | | `WalletSize` | Number | UInt32 | Not used. This field is valid in AccountSet transactions but does nothing. | @@ -74,14 +73,14 @@ The available AccountSet flags are: |:----------------------------------|:--------------|:--------------| | `asfAccountTxnID` | 5 | Track the ID of this account's most recent transaction. Required for [`AccountTxnID`](../common-fields.md#accounttxnid) | | `asfAllowTrustLineClawback` | 16 | Allow account to claw back tokens it has issued. _(Requires the Clawback amendment.)_ Can only be set if the account has an empty owner directory (no trust lines, offers, escrows, payment channels, checks, or signer lists). After you set this flag, it cannot be reverted. The account permanently gains the ability to claw back issued assets on trust lines. | -| `asfAuthorizedNFTokenMinter` | 10 | Enable to allow another account to mint non-fungible tokens (NFTokens) on this account's behalf. Specify the authorized account in the `NFTokenMinter` field of the [AccountRoot](../../ledger-data/ledger-entry-types/accountroot.md) object. To remove an authorized minter, enable this flag and omit the `NFTokenMinter` field. _(Added by the [NonFungibleTokensV1_1 amendment][].)_ | +| `asfAuthorizedNFTokenMinter` | 10 | Enable to allow another account to mint non-fungible tokens (NFTokens) on this account's behalf. Specify the authorized account in the `NFTokenMinter` field of the [AccountRoot](../../ledger-data/ledger-entry-types/accountroot.md) object. To remove an authorized minter, enable this flag and omit the `NFTokenMinter` field. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} | | `asfDefaultRipple` | 8 | Enable [rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) on this account's trust lines by default. | -| `asfDepositAuth` | 9 | Enable [Deposit Authorization](../../../../concepts/accounts/depositauth.md) on this account. _(Added by the [DepositAuth amendment][].)_ | +| `asfDepositAuth` | 9 | Enable [Deposit Authorization](../../../../concepts/accounts/depositauth.md) on this account. {% amendment-disclaimer name="DepositAuth" /%} | | `asfDisableMaster` | 4 | Disallow use of the master key pair. Can only be enabled if the account has configured another way to sign transactions, such as a [Regular Key](../../../../concepts/accounts/cryptographic-keys.md) or a [Signer List](../../../../concepts/accounts/multi-signing.md). | -| `asfDisallowIncomingCheck` | 13 | Block incoming Checks. _(Requires the [DisallowIncoming amendment][].)_ | -| `asfDisallowIncomingNFTokenOffer` | 12 | Block incoming NFTokenOffers. _(Requires the [DisallowIncoming amendment][].)_ | -| `asfDisallowIncomingPayChan` | 14 | Block incoming Payment Channels. _(Requires the [DisallowIncoming amendment][].)_ | -| `asfDisallowIncomingTrustline` | 15 | Block incoming trust lines. _(Requires the [DisallowIncoming amendment][].)_ | +| `asfDisallowIncomingCheck` | 13 | Block incoming Checks. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `asfDisallowIncomingNFTokenOffer` | 12 | Block incoming NFTokenOffers. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `asfDisallowIncomingPayChan` | 14 | Block incoming Payment Channels. {% amendment-disclaimer name="DisallowIncoming" /%} | +| `asfDisallowIncomingTrustline` | 15 | Block incoming trust lines. {% amendment-disclaimer name="DisallowIncoming" /%} | | `asfDisallowXRP` | 3 | XRP should not be sent to this account. (Advisory; not enforced by the XRP Ledger protocol.) | | `asfGlobalFreeze` | 7 | [Freeze](../../../../concepts/tokens/fungible-tokens/freezes.md) all assets issued by this account. | | `asfNoFreeze` | 6 | Permanently give up the ability to [freeze individual trust lines or disable Global Freeze](../../../../concepts/tokens/fungible-tokens/freezes.md). This flag can never be disabled after being enabled. | diff --git a/docs/references/protocol/transactions/types/ammbid.md b/docs/references/protocol/transactions/types/ammbid.md index 723a0aa625..01bde0e97d 100644 --- a/docs/references/protocol/transactions/types/ammbid.md +++ b/docs/references/protocol/transactions/types/ammbid.md @@ -11,7 +11,7 @@ Bid on an [Automated Market Maker](../../../../concepts/tokens/decentralized-exc You bid using the AMM's LP Tokens; the amount of a winning bid is returned to the AMM, decreasing the outstanding balance of LP Tokens. -_(Added by the [AMM amendment][].)_ +{% amendment-disclaimer name="AMM" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/ammclawback.md b/docs/references/protocol/transactions/types/ammclawback.md index 43c63f4d82..fecfb8c0b5 100644 --- a/docs/references/protocol/transactions/types/ammclawback.md +++ b/docs/references/protocol/transactions/types/ammclawback.md @@ -2,8 +2,8 @@ seo: description: Claw back tokens from a holder who has deposited your issued tokens into an Automated Market Maker pool. labels: - - AMM - - Tokens + - AMM + - Tokens --- # AMMClawback @@ -13,7 +13,7 @@ Claw back tokens from a holder who has deposited your issued tokens into an AMM Clawback is disabled by default. To use clawback, you must send an [AccountSet transaction][] to enable the **Allow Trust Line Clawback** setting. An issuer with any existing tokens cannot enable clawback. You can only enable **Allow Trust Line Clawback** if you have a completely empty owner directory, meaning you must do so before you set up any trust lines, offers, escrows, payment channels, checks, or signer lists. After you enable clawback, it cannot reverted: the account permanently gains the ability to claw back issued assets on trust lines. -_(Added by the [AMMClawback amendment][].)_ +{% amendment-disclaimer name="AMMClawback" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/ammcreate.md b/docs/references/protocol/transactions/types/ammcreate.md index 42aa0e48a0..947e875734 100644 --- a/docs/references/protocol/transactions/types/ammcreate.md +++ b/docs/references/protocol/transactions/types/ammcreate.md @@ -2,7 +2,7 @@ seo: description: Create a new Automated Market Maker for trading a given pair of assets. labels: - - AMM + - AMM --- # AMMCreate [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMCreate.cpp "Source") @@ -13,7 +13,7 @@ Creates both an [AMM entry][] and a [special AccountRoot entry](../../ledger-dat {% admonition type="warning" name="Caution" %}When you create the AMM, you should fund it with (approximately) equal-value amounts of each asset. Otherwise, other users can profit at your expense by trading with this AMM ([performing arbitrage](https://www.machow.ski/posts/an_introduction_to_automated_market_makers/#price-arbitrage)). The currency risk that liquidity providers take on increases with the volatility (potential for imbalance) of the asset pair. The higher the trading fee, the more it offsets this risk, so it's best to set the trading fee based on the volatility of the asset pair.{% /admonition %} -_(Added by the [AMM amendment][].)_ +{% amendment-disclaimer name="AMM" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/ammdelete.md b/docs/references/protocol/transactions/types/ammdelete.md index dd95d3cb7a..facfdce922 100644 --- a/docs/references/protocol/transactions/types/ammdelete.md +++ b/docs/references/protocol/transactions/types/ammdelete.md @@ -2,7 +2,7 @@ seo: description: Delete an Automated Market Maker with an empty asset pool. labels: - - AMM + - AMM --- # AMMDelete [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDelete.cpp "Source") @@ -11,7 +11,7 @@ Delete an empty [Automated Market Maker](../../../../concepts/tokens/decentraliz Normally, an [AMMWithdraw transaction][] automatically deletes an AMM and all associated ledger entries when it withdraws all the assets from the AMM's pool. However, if there are too many trust lines to the AMM account to remove in one transaction, it may stop before fully removing the AMM. Similarly, an AMMDelete transaction removes up to a maximum of 512 trust lines; it may take several AMMDelete transactions to delete all the trust lines and the associated AMM. In all cases, only the last such transaction deletes the AMM and AccountRoot ledger entries. -_(Added by the [AMM amendment][].)_ +{% amendment-disclaimer name="AMM" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/ammdeposit.md b/docs/references/protocol/transactions/types/ammdeposit.md index c9580979a0..dfed229c1f 100644 --- a/docs/references/protocol/transactions/types/ammdeposit.md +++ b/docs/references/protocol/transactions/types/ammdeposit.md @@ -2,7 +2,7 @@ seo: description: Deposit funds into an Automated Market Maker in exchange for LPTokens. labels: - - AMM + - AMM --- # AMMDeposit [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDeposit.cpp "Source") @@ -17,7 +17,7 @@ You can't deposit either asset into an AMM if: - You aren't authorized to hold at least one of the pooled assets. {% /admonition %} -_(Added by the [AMM amendment][].)_ +{% amendment-disclaimer name="AMM" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/ammvote.md b/docs/references/protocol/transactions/types/ammvote.md index ad8a2a74a1..ac0d0fe5c5 100644 --- a/docs/references/protocol/transactions/types/ammvote.md +++ b/docs/references/protocol/transactions/types/ammvote.md @@ -2,14 +2,14 @@ seo: description: Vote on the trading fee for an Automated Market Maker. labels: - - AMM + - AMM --- # AMMVote [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMVote.cpp "Source") Vote on the trading fee for an [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) instance. Up to 8 accounts can vote in proportion to the amount of the AMM's LP Tokens they hold. Each new vote re-calculates the AMM's trading fee based on a weighted average of the votes. -_(Added by the [AMM amendment][].)_ +{% amendment-disclaimer name="AMM" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/ammwithdraw.md b/docs/references/protocol/transactions/types/ammwithdraw.md index 54740adb6e..ed0a73585c 100644 --- a/docs/references/protocol/transactions/types/ammwithdraw.md +++ b/docs/references/protocol/transactions/types/ammwithdraw.md @@ -2,14 +2,14 @@ seo: description: Return LPTokens to an Automated Market Maker in exchange for a share of the assets the pool holds. labels: - - AMM + - AMM --- # AMMWithdraw [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMWithdraw.cpp "Source") Withdraw assets from an [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) (AMM) instance by returning the AMM's liquidity provider tokens (LP Tokens). -_(Added by the [AMM amendment][].)_ +{% amendment-disclaimer name="AMM" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/batch.md b/docs/references/protocol/transactions/types/batch.md index 25f1d3d65e..02b5eab9f8 100644 --- a/docs/references/protocol/transactions/types/batch.md +++ b/docs/references/protocol/transactions/types/batch.md @@ -8,9 +8,9 @@ status: not_enabled # Batch [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Batch.cpp "Source") -The `Batch` transaction submits up to eight transactions as a single unit. `Batch` transactions are executed atomically in one of four modes: All or Nothing, Only One, Until Failure, and Independent. +Submit up to eight transactions as a single [batch](../../../../concepts/transactions/batch-transactions.md). The transactions in the batch are executed atomically in one of four modes: All or Nothing, Only One, Until Failure, or Independent. -_(Requires the [Batch amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="Batch" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/checkcancel.md b/docs/references/protocol/transactions/types/checkcancel.md index b9f6017c93..b55fd84ff0 100644 --- a/docs/references/protocol/transactions/types/checkcancel.md +++ b/docs/references/protocol/transactions/types/checkcancel.md @@ -7,9 +7,9 @@ labels: # CheckCancel [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CancelCheck.cpp "Source") -Cancels an unredeemed Check, removing it from the ledger without sending any money. The source or the destination of the check can cancel a Check at any time using this transaction type. If the Check has expired, any address can cancel it. +Cancels an unredeemed [check](../../../../concepts/payment-types/checks.md), removing it from the ledger without sending any money. The source or the destination of the check can cancel a check at any time. If the check has expired, any address can cancel it. -_(Added by the [Checks amendment][].)_ +{% amendment-disclaimer name="Checks" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/checkcash.md b/docs/references/protocol/transactions/types/checkcash.md index 22369c466e..4d045e77e4 100644 --- a/docs/references/protocol/transactions/types/checkcash.md +++ b/docs/references/protocol/transactions/types/checkcash.md @@ -7,11 +7,11 @@ labels: # CheckCash [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CashCheck.cpp "Source") -Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding [CheckCreate transaction][]. Only the `Destination` address of a Check can cash it with a CheckCash transaction. Cashing a check this way is similar to executing a [Payment][] initiated by the destination. +Attempts to redeem a [check](../../../../concepts/payment-types/checks.md) to receive up to the amount authorized by the corresponding [CheckCreate transaction][]. Only the `Destination` address of a check can cash it with a CheckCash transaction. Cashing a check this way is similar to executing a [Payment][] initiated by the destination. -Since the funds for a check are not guaranteed, redeeming a Check can fail because the sender does not have a high enough balance or because there is not enough liquidity to deliver the funds. If this happens, the Check remains in the ledger and the destination can try to cash it again later, or for a different amount. +Since the funds for a check are not guaranteed, redeeming a check can fail because the sender does not have a high enough balance or because there is not enough liquidity to deliver the funds. If this happens, the check remains in the ledger and the destination can try to cash it again later, or for a different amount. -_(Added by the [Checks amendment][].)_ +{% amendment-disclaimer name="Checks" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/checkcreate.md b/docs/references/protocol/transactions/types/checkcreate.md index 901211418b..9c2faa2c23 100644 --- a/docs/references/protocol/transactions/types/checkcreate.md +++ b/docs/references/protocol/transactions/types/checkcreate.md @@ -7,9 +7,9 @@ labels: # CheckCreate [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateCheck.cpp "Source") -Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination. The sender of this transaction is the sender of the Check. +Create an on-ledger [check](../../../../concepts/payment-types/checks.md), which is a deferred payment that can be cashed by its intended destination. The sender of this transaction is the sender of the check. -_(Added by the [Checks amendment][].)_ +{% amendment-disclaimer name="Checks" /%} ## Example {% $frontmatter.seo.title %} JSON @@ -40,7 +40,7 @@ _(Added by the [Checks amendment][].)_ ## Error Cases -- If the `Destination` account is blocking incoming Checks, the transaction fails with the result code `tecNO_PERMISSION`. _(Requires the [DisallowIncoming amendment][])_ +- If the `Destination` account is blocking incoming Checks, the transaction fails with the result code `tecNO_PERMISSION`. {% amendment-disclaimer name="DisallowIncoming" /%} - If the `Destination` is the sender of the transaction, the transaction fails with the result code `temREDUNDANT`. - If the `Destination` [account](../../../../concepts/accounts/index.md) does not exist in the ledger, the transaction fails with the result code `tecNO_DST`. - If the `Destination` account has the `RequireDest` flag enabled but the transaction does not include a `DestinationTag` field, the transaction fails with the result code `tecDST_TAG_NEEDED`. diff --git a/docs/references/protocol/transactions/types/clawback.md b/docs/references/protocol/transactions/types/clawback.md index c28ae0aa6f..d730fda234 100644 --- a/docs/references/protocol/transactions/types/clawback.md +++ b/docs/references/protocol/transactions/types/clawback.md @@ -7,11 +7,9 @@ labels: # Clawback [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Clawback.cpp "Source") -Claw back tokens issued by your account. +[Claw back tokens](../../../../concepts/tokens/fungible-tokens/clawing-back-tokens.md) issued by your account. Issuers can only claw back [trust line tokens](../../../../concepts/tokens/fungible-tokens/trust-line-tokens.md) if they enabled the **Allow Trust Line Clawback** setting before issuing any tokens. Issuers can claw back [MPTs](../../../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md) if the corresponding MPT Issuance has clawback enabled. -Clawback is disabled by default. To use clawback, you must send an [AccountSet transaction][] to enable the **Allow Trust Line Clawback** setting. An issuer with any existing tokens cannot enable Clawback. You can only enable **Allow Trust Line Clawback** if you have a completely empty owner directory, meaning you must do so before you set up any trust lines, offers, escrows, payment channels, checks, or signer lists. After you enable Clawback, it cannot reverted: the account permanently gains the ability to claw back issued assets on trust lines. - -_(Added by the [Clawback amendment][].)_ +{% amendment-disclaimer name="Clawback" /%} ## Example {% $frontmatter.seo.title %} JSON @@ -29,16 +27,12 @@ _(Added by the [Clawback amendment][].)_ {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} -| Field | JSON Type | [Internal Type][] | Description | -|:-------------------|:----------|:------------------|:------------------| -| `Amount` | [Currency Amount][] | Amount | The amount being clawed back, as well as the counterparty from which the amount is being clawed back. The quantity to claw back, in the `value` sub-field, must not be zero. If this is more than the current balance, the transaction claws back the entire balance. The sub-field `issuer` within `Amount` represents the token holder's account ID, rather than the issuer's.| -| `Holder` | String | AccountID | (Optional) Specifies the holder's address from which to claw back. The holder must already own an `MPToken` object with a non-zero balance. _(Requires the [MPTokensV1 amendment][] {% not-enabled /%})_ | - -{% admonition type="info" name="Note" %}For an IOU (trust line) in the XRP Ledger, the party that created a token is called the _issuer_, but trust lines are bidirectional and, under some configurations, both sides can be seen as the issuer. In this transaction, the token issuer's address is in the `Account` field, and the token holder's address is in the `Amount` field's `issuer` sub-field.{% /admonition %} - -{% admonition type="info" name="Note" %}To claw back funds from an MPT holder, the issuer must have specified that the MPT allows clawback by setting the `tfMPTCanClawback` flag when creating the MPT using the `MPTokenIssuanceCreate` transaction. Assuming an MPT was created with this flag set, clawbacks are allowed using the `Clawback` transaction.{% /admonition %} - +| Field | JSON Type | [Internal Type][] | Required? | Description | +|:-------------------|:----------|:------------------|:----------|-------------| +| `Amount` | [Currency Amount][] | Amount | Yes | The amount to claw back. The quantity in the `value` sub-field must not be zero. If this is more than the current balance, the transaction claws back the entire balance. When clawing back trust line tokens, the `issuer` sub-field indicates the token holder to claw back tokens from.| +| `Holder` | String | AccountID | No | The holder to claw back tokens from, if clawing back MPTs. The holder must have a non-zero balance of the MPT issuance indicated in the `Amount` field. {% amendment-disclaimer name="MPTokensV1" /%} | +When clawing back trust line tokens, you must omit the `Holder` field. When clawing back MPTs, you must provide the `Holder` field. ## Error Cases @@ -46,10 +40,10 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} | Error Code | Description | |:-----------|:------------| -| `temDISABLED` | Occurs if the [Clawback amendment](/resources/known-amendments.md#clawback) is not enabled. | -| `temBAD_AMOUNT` | Occurs if the holder's balance is 0. It is not an error if the amount exceeds the holder's balance; in that case, the maximum available balance is clawed back. Also occurs if the counterparty listed in `Amount` is the same as the `Account` issuing this transaction. | -| `tecAMM_ACCOUNT` | This operation is not allowed with an AMM account. Use [`AMMClawback`](./ammclawback.md) instead. | -| `tecNO_LINE` | Occurs there is no trust line with the counterparty or that trust line's balance is 0. | -| `tecNO_PERMISSION` | Occurs if you attempt to set `lsfAllowTrustlineClawback` while `lsfNoFreeze` is set. Also occurs, conversely, if you try to set `lsfNoFreeze` while `lsfAllowTrustLineClawback` is set. | +| `temDISABLED` | The [Clawback amendment][] is not enabled. | +| `temBAD_AMOUNT` | The amount of tokens specified to claw back is invalid or zero, or the specified holder is the issuer. | +| `tecAMM_ACCOUNT` | The specified holder is an Automated Market Maker (AMM). To claw back tokens from an AMM, use [`AMMClawback`](./ammclawback.md) instead. | +| `tecNO_LINE` | There is no trust line with the counterparty or that trust line's balance is 0. | +| `tecNO_PERMISSION` | The sender of this transaction does not have the ability to claw back the specified tokens. | {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/credentialaccept.md b/docs/references/protocol/transactions/types/credentialaccept.md index eb01f498da..e6f4ec07ba 100644 --- a/docs/references/protocol/transactions/types/credentialaccept.md +++ b/docs/references/protocol/transactions/types/credentialaccept.md @@ -1,13 +1,13 @@ --- seo: description: Accept a credential provisionally issued to your account. -status: not_enabled --- # CredentialAccept +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source") -A CredentialAccept transaction accepts a credential, which makes the credential valid. Only the subject of the credential can do this. +Accept a [credential](../../../../concepts/decentralized-storage/credentials.md), which makes the credential valid. Only the subject of the credential can do this. -_(Requires the [Credentials amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="Credentials" /%} ## Example CredentialAccept JSON @@ -46,7 +46,7 @@ The combination of `Account`, `Issuer`, and `CredentialType` must match a `Crede | `tecNO_ENTRY` | The credential uniquely identified by the `Account`, `Issuer`, and `CredentialType` fields of the transaction does not exist in the ledger. | | `temDISABLED` | The related amendment is not enabled. | | `temINVALID_ACCOUNT_ID` | The provided `Issuer` field is invalid. For example, it contains [ACCOUNT_ZERO](../../../../concepts/accounts/addresses.md#special-addresses). | -| `temINVALID_FLAG` | The transaction includes a [Flag](../common-fields.md#flags-field) that does not exist, or includes a contradictory combination of flags. _(Requires the [fixInvalidTxFlags amendment][] {% not-enabled /%})_ | +| `temINVALID_FLAG` | The transaction includes a [Flag](../common-fields.md#flags-field) that does not exist, or includes a contradictory combination of flags. {% amendment-disclaimer name="fixInvalidTxFlags" /%} | ## See Also diff --git a/docs/references/protocol/transactions/types/credentialcreate.md b/docs/references/protocol/transactions/types/credentialcreate.md index e570dcbb11..1025fe3c17 100644 --- a/docs/references/protocol/transactions/types/credentialcreate.md +++ b/docs/references/protocol/transactions/types/credentialcreate.md @@ -1,13 +1,13 @@ --- seo: description: Provisionally issue a credential to a subject account. -status: not_enabled --- # CredentialCreate +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source") -A CredentialCreate transaction creates a credential in the ledger. The issuer of the credential uses this transaction to provisionally issue a credential. The credential is not valid until the subject of the credential accepts it with a [CredentialAccept transaction][]. +Provisionally issue a [credential](../../../../concepts/decentralized-storage/credentials.md) in the ledger. The credential is not valid until the subject of the credential accepts it with a [CredentialAccept transaction][]. -_(Requires the [Credentials amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="Credentials" /%} ## Example CredentialCreate JSON @@ -48,7 +48,7 @@ Besides errors that can occur for all transactions, CredentialCreate transaction | `tecNO_TARGET` | The account specified in the `Subject` field is not a funded account in the ledger. | | `temDISABLED` | The related amendment is not enabled. | | `temINVALID_ACCOUNT_ID` | The provided `Subject` field is invalid. For example, it contains [ACCOUNT_ZERO](../../../../concepts/accounts/addresses.md#special-addresses). | -| `temINVALID_FLAG` | The transaction includes a [Flag](../common-fields.md#flags-field) that does not exist, or includes a contradictory combination of flags. _(Requires the [fixInvalidTxFlags amendment][] {% not-enabled /%})_ | +| `temINVALID_FLAG` | The transaction includes a [Flag](../common-fields.md#flags-field) that does not exist, or includes a contradictory combination of flags. {% amendment-disclaimer name="fixInvalidTxFlags" /%} | ## See Also diff --git a/docs/references/protocol/transactions/types/credentialdelete.md b/docs/references/protocol/transactions/types/credentialdelete.md index bc04e4ca4e..7c244816da 100644 --- a/docs/references/protocol/transactions/types/credentialdelete.md +++ b/docs/references/protocol/transactions/types/credentialdelete.md @@ -1,13 +1,13 @@ --- seo: description: Remove a credential from the ledger, effectively revoking it. -status: not_enabled --- # CredentialDelete +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source") -A CredentialDelete transaction removes a credential from the ledger, effectively revoking it. Users may also want to delete an unwanted credential to reduce their [reserve requirement](../../../../concepts/accounts/reserves.md). +Remove a [credential](../../../../concepts/decentralized-storage/credentials.md) from the ledger, effectively revoking it. Users may also want to delete an unwanted credential to reduce their [reserve requirement](../../../../concepts/accounts/reserves.md). -_(Requires the [Credentials amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="Credentials" /%} ## Example CredentialDelete JSON @@ -47,7 +47,7 @@ This transaction looks for a [Credential ledger entry](../../ledger-data/ledger- | `temINVALID_ACCOUNT_ID` | A provided `Subject` or `Issuer` field is invalid. For example, it contains [ACCOUNT_ZERO](../../../../concepts/accounts/addresses.md#special-addresses). | | `tecNO_PERMISSION` | The sender is neither the issuer nor subject of the credential, and the credential is not expired. | | `tecNO_ENTRY` | The specified credential does not exist in the ledger. | -| `temINVALID_FLAG` | The transaction includes a [Flag](../common-fields.md#flags-field) that does not exist, or includes a contradictory combination of flags. _(Requires the [fixInvalidTxFlags amendment][] {% not-enabled /%})_ | +| `temINVALID_FLAG` | The transaction includes a [Flag](../common-fields.md#flags-field) that does not exist, or includes a contradictory combination of flags. {% amendment-disclaimer name="fixInvalidTxFlags" /%} | ## See Also diff --git a/docs/references/protocol/transactions/types/delegateset.md b/docs/references/protocol/transactions/types/delegateset.md index 0e0caae4d6..7c06f55f0a 100644 --- a/docs/references/protocol/transactions/types/delegateset.md +++ b/docs/references/protocol/transactions/types/delegateset.md @@ -12,7 +12,7 @@ status: not_enabled [Delegate permissions](/docs/concepts/accounts/permission-delegation) to another account to send transactions on your behalf. This transaction type can grant, change, or revoke permissions; it creates, modifies, or deletes a [Delegate ledger entry][] accordingly. -_(Requires the [PermissionDelegation amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="PermissionDelegation" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/depositpreauth.md b/docs/references/protocol/transactions/types/depositpreauth.md index 90743d9278..86e9dfd208 100644 --- a/docs/references/protocol/transactions/types/depositpreauth.md +++ b/docs/references/protocol/transactions/types/depositpreauth.md @@ -7,11 +7,11 @@ labels: # DepositPreauth [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DepositPreauth.cpp "Source") -A DepositPreauth transaction grants preauthorization to deliver payments to your account. This is only useful if you are using (or plan to use) [Deposit Authorization](../../../../concepts/accounts/depositauth.md). +Grant preauthorization to send payments to your account. This is only useful if you are using (or plan to use) [Deposit Authorization](../../../../concepts/accounts/depositauth.md). {% admonition type="success" name="Tip" %}You can use this transaction before you enable Deposit Authorization. This may be useful to ensure a smooth transition from not requiring deposit authorization to requiring it.{% /admonition %} -_(Added by the [DepositPreauth amendment][].)_ +{% amendment-disclaimer name="DepositPreauth" /%} ## Example {% $frontmatter.seo.title %} JSON @@ -57,9 +57,9 @@ _(Added by the [DepositPreauth amendment][].)_ | Field | JSON Type | [Internal Type][] | Required? | Description | |:-------------------------|:---------------------|:------------------|:----------|:------------| | `Authorize` | String - [Address][] | AccountID | No | An account to preauthorize. | -| `AuthorizeCredentials` | Array | Array | No | A set of credentials to authorize. _(Requires the [Credentials amendment][]. {% not-enabled /%})_ | +| `AuthorizeCredentials` | Array | Array | No | A set of credentials to authorize. {% amendment-disclaimer name="Credentials" /%} | | `Unauthorize` | String | AccountID | No | An account whose preauthorization should be revoked. | -| `UnauthorizeCredentials` | Array | Array | No | A set of credentials whose preauthorization should be revoked. _(Requires the [Credentials amendment][]. {% not-enabled /%})_ | +| `UnauthorizeCredentials` | Array | Array | No | A set of credentials whose preauthorization should be revoked. {% amendment-disclaimer name="Credentials" /%} | You must provide **exactly one** of `Authorize`, `AuthorizeCredentials`, `Unauthorize`, or `UnauthorizeCredentials`. diff --git a/docs/references/protocol/transactions/types/diddelete.md b/docs/references/protocol/transactions/types/diddelete.md index 3642120b70..0daf4057c8 100644 --- a/docs/references/protocol/transactions/types/diddelete.md +++ b/docs/references/protocol/transactions/types/diddelete.md @@ -2,17 +2,16 @@ seo: description: Delete a Decentralized Identifier. labels: - - DID + - DID --- # DIDDelete - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "Source") -Delete the [DID ledger entry](../../ledger-data/ledger-entry-types/did.md) associated with the specified `Account` field. +Delete the sender's [decentralized identifier (DID)](../../../../concepts/decentralized-storage/decentralized-identifiers.md). {% admonition type="info" name="Note" %}This transaction only uses the [common fields][].{% /admonition %} -_(Added by the [DID amendment][].)_ +{% amendment-disclaimer name="DID" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/didset.md b/docs/references/protocol/transactions/types/didset.md index beefaec6c2..3b181b8ad4 100644 --- a/docs/references/protocol/transactions/types/didset.md +++ b/docs/references/protocol/transactions/types/didset.md @@ -2,15 +2,14 @@ seo: description: Create or update a Decentralized Identifier. labels: - - DID + - DID --- # DIDSet - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "Source") -Creates a new [DID ledger entry](../../ledger-data/ledger-entry-types/did.md) or updates the fields of an existing one. +Create or update a [decentralized identifier (DID)](../../../../concepts/decentralized-storage/decentralized-identifiers.md). -_(Added by the [DID amendment][].)_ +{% amendment-disclaimer name="DID" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/escrowcancel.md b/docs/references/protocol/transactions/types/escrowcancel.md index 410ec8dada..996e766ad5 100644 --- a/docs/references/protocol/transactions/types/escrowcancel.md +++ b/docs/references/protocol/transactions/types/escrowcancel.md @@ -2,15 +2,14 @@ seo: description: Cancel an expired escrow, returning the funds to the sender. labels: - - Escrow + - Escrow --- # EscrowCancel - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source") -Return escrowed XRP to the sender. +Return funds from an expired [escrow](../../../../concepts/payment-types/escrow.md) to it sender. -_(Added by the [Escrow amendment][].)_ +{% amendment-disclaimer name="Escrow" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/escrowcreate.md b/docs/references/protocol/transactions/types/escrowcreate.md index ba5b5d2c79..f8f1b888dc 100644 --- a/docs/references/protocol/transactions/types/escrowcreate.md +++ b/docs/references/protocol/transactions/types/escrowcreate.md @@ -2,15 +2,14 @@ seo: description: Escrow funds, which can be released to the destination after a specific time or condition. labels: - - Escrow + - Escrow --- # EscrowCreate - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source") -Sequester XRP until the escrow process either finishes or is canceled. +Set aside funds in an [escrow](../../../../concepts/payment-types/escrow.md) that delivers them to a predetermined recipient when certain conditions are met. If the escrow has an expiration, the funds can also be returned to the sender after it expires. -_(Added by the [Escrow amendment][].)_ +{% amendment-disclaimer name="Escrow" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/escrowfinish.md b/docs/references/protocol/transactions/types/escrowfinish.md index 6e18b18a5c..04dea5d211 100644 --- a/docs/references/protocol/transactions/types/escrowfinish.md +++ b/docs/references/protocol/transactions/types/escrowfinish.md @@ -2,15 +2,14 @@ seo: description: Deliver escrowed funds to the intended recipient. labels: - - Escrow + - Escrow --- # EscrowFinish - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source") -Deliver XRP from an escrow (held payment) to the recipient. +Deliver XRP from an [escrow](../../../../concepts/payment-types/escrow.md) to the recipient. -_(Added by the [Escrow amendment][].)_ +{% amendment-disclaimer name="Escrow" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/ledgerstatefix.md b/docs/references/protocol/transactions/types/ledgerstatefix.md index 07bf92c2bf..90a17ae0ba 100644 --- a/docs/references/protocol/transactions/types/ledgerstatefix.md +++ b/docs/references/protocol/transactions/types/ledgerstatefix.md @@ -2,15 +2,15 @@ seo: description: Repair corruptions to the XRP ledger's state data. labels: - - Utilities - - Troubleshooting + - Utilities + - Troubleshooting --- # LedgerStateFix [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/LedgerStateFix.cpp "Source") -`LedgerStateFix` is a general purpose transaction used to fix specific issues affecting the XRP ledger. You submit the transaction with the `LedgerFixType` value set to indicate the particular error state to correct. +Repair a specific corruption affecting on-ledger data. This transaction type has a different mode for each type of error state or corruption it can fix. -_(Added by the [fixNFTokenPageLinks amendment][].)_ +{% amendment-disclaimer name="fixNFTokenPageLinks" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/mptokenauthorize.md b/docs/references/protocol/transactions/types/mptokenauthorize.md index 8809137dca..da3d583238 100644 --- a/docs/references/protocol/transactions/types/mptokenauthorize.md +++ b/docs/references/protocol/transactions/types/mptokenauthorize.md @@ -2,14 +2,12 @@ seo: description: Set up your account to receive a specific MPT as a holder; or authorize a holder as an MPT issuer. labels: - - Multi-purpose Tokens, MPTs -status: not_enabled + - Multi-purpose Tokens, MPTs --- - # MPTokenAuthorize [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenAuthorize.cpp "Source") -An MPTokenAuthorize transaction controls whether an account can hold a given [Multi-purpose Token (MPT)](../../../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md). It has several uses: +Control whether an account can hold a given [Multi-purpose Token (MPT)](../../../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md). This transaction has several uses: - An account indicates their willingness to hold an MPT. This creates a new [MPToken entry][] with an initial zero balance owned by that account. This is a prerequisite to receive that type of MPT in a payment. - An account revokes their willingness to hold an MPT, deleting the [MPToken entry][]. This can only be done if their balance of the given MPT is zero. diff --git a/docs/references/protocol/transactions/types/mptokenissuancecreate.md b/docs/references/protocol/transactions/types/mptokenissuancecreate.md index 73d6ff02e4..ba2ac29867 100644 --- a/docs/references/protocol/transactions/types/mptokenissuancecreate.md +++ b/docs/references/protocol/transactions/types/mptokenissuancecreate.md @@ -1,19 +1,15 @@ --- seo: - description: Define the properties of a new Multi-Purpose Token (MPT). + description: Define the properties of a new Multi-Purpose Token (MPT). labels: - - Multi-purpose Tokens, MPTs -status: not_enabled + - Multi-purpose Tokens, MPTs --- - # MPTokenIssuanceCreate [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceCreate.cpp "Source") -The `MPTokenIssuanceCreate` transaction creates an [MPTokenIssuance](../../ledger-data/ledger-entry-types/mptokenissuance.md) object and adds it to the relevant directory node of the creator account. This transaction is the only opportunity an issuer has to specify any token fields that are defined as immutable (for example, MPT Flags). +Creates a new [Multi-purpose Token (MPT)](../../../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md) issuance, which defines the properties of those MPTs. This is a prerequisite to actually issuing the tokens. -If the transaction is successful, the newly created token is owned by the account (the creator account) that executed the transaction. - -Whenever your query returns an `MPTokenIssuance` transaction response, there will always be an `mpt_issuance_id` field on the Transaction Metadata page. +If the transaction is successful, it creates an [MPTokenIssuance entry][] where the sender of the transaction is the MPT's issuer. {% amendment-disclaimer name="MPTokensV1" /%} diff --git a/docs/references/protocol/transactions/types/mptokenissuancedestroy.md b/docs/references/protocol/transactions/types/mptokenissuancedestroy.md index 17854094ad..db6a328c67 100644 --- a/docs/references/protocol/transactions/types/mptokenissuancedestroy.md +++ b/docs/references/protocol/transactions/types/mptokenissuancedestroy.md @@ -2,15 +2,12 @@ seo: description: Delete a Multi-Purpose Token definition. labels: - - Multi-purpose Tokens, MPTs -status: not_enabled + - Multi-purpose Tokens, MPTs --- # MPTokenIssuanceDestroy [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceDestroy.cpp "Source") -The `MPTokenIssuanceDestroy` transaction is used to remove an `MPTokenIssuance` object from the directory node in which it is being held, effectively removing the token from the ledger ("destroying" it). - -If this operation succeeds, the corresponding `MPTokenIssuance` is removed and the owner’s reserve requirement is reduced by one. This operation must fail if there are any holders of the MPT in question. +Delete a [Multi-purpose Token (MPT)](../../../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md) issuance. Only the issuer can delete an MPT issuance, and only if there are no holders of the MPT. {% amendment-disclaimer name="MPTokensV1" /%} @@ -24,7 +21,6 @@ If this operation succeeds, the corresponding `MPTokenIssuance` is removed and t } ``` - {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/mptokenissuanceset.md b/docs/references/protocol/transactions/types/mptokenissuanceset.md index 7439ec1275..a4cc822c1d 100644 --- a/docs/references/protocol/transactions/types/mptokenissuanceset.md +++ b/docs/references/protocol/transactions/types/mptokenissuanceset.md @@ -2,13 +2,12 @@ seo: description: Set mutable properties of a Multi-Purpose Token definition. labels: - - Multi-purpose Tokens, MPTs -status: not_enabled + - Multi-purpose Tokens, MPTs --- # MPTokenIssuanceSet [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceSet.cpp "Source") -Use this transaction to update a mutable property for a Multi-purpose Token. The transaction flags determine which change(s) to apply. +Update a mutable property of a [Multi-purpose Token (MPT)](../../../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md) issuance, including locking (freezing) or unlocking the tokens globally or for an individual holder. {% amendment-disclaimer name="MPTokensV1" /%} diff --git a/docs/references/protocol/transactions/types/nftokenacceptoffer.md b/docs/references/protocol/transactions/types/nftokenacceptoffer.md index 76844651ca..abb16beb73 100644 --- a/docs/references/protocol/transactions/types/nftokenacceptoffer.md +++ b/docs/references/protocol/transactions/types/nftokenacceptoffer.md @@ -7,12 +7,12 @@ labels: # NFTokenAcceptOffer [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenAcceptOffer.cpp "Source") -The `NFTokenAcceptOffer` transaction is used to accept offers to buy or sell an NFT. It has two possible modes: +Accept an offer to buy or sell a [non-fungible token (NFT)](../../../../concepts/tokens/nfts/index.md). This transaction has two modes: * In _direct_ mode, a buyer can accept a sell offer directly, or a seller can accept a buy offer directly. * In _brokered_ mode, a third party (the _broker_) can match two distinct offers, one buying and one selling. If the buy price is higher than the sell price, the broker can claim the difference as a fee for themself. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example NFTokenAcceptOffer JSON diff --git a/docs/references/protocol/transactions/types/nftokenburn.md b/docs/references/protocol/transactions/types/nftokenburn.md index 17c4263283..a1afb208cc 100644 --- a/docs/references/protocol/transactions/types/nftokenburn.md +++ b/docs/references/protocol/transactions/types/nftokenburn.md @@ -7,13 +7,11 @@ labels: # NFTokenBurn [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenBurn.cpp "Source") -The `NFTokenBurn` transaction is used to remove a `NFToken` object from the `NFTokenPage` in which it is being held, effectively removing the token from the ledger (_burning_ it). +Burn (destroy) a [non-fungible token (NFT)](../../../../concepts/tokens/nfts/index.md). The NFT's current holder can always burn it, and if the token's "Burnable" flag is enabled, the issuer and their authorized minter (if they have one) can also burn the NFT. -The sender of this transaction must be the owner of the `NFToken` to burn; or, if the `NFToken` has the `lsfBurnable` flag enabled, can be the issuer or the issuer's authorized `NFTokenMinter` account instead. +If the transaction succeeds, it removes the corresponding [NFToken][] object from the [NFTokenPage entry][] that was storing it. This can cause the pages of an NFT directory to be consolidated. -If this operation succeeds, the corresponding `NFToken` is removed. If this operation empties the `NFTokenPage` holding the `NFToken` or results in consolidation, thus removing a `NFTokenPage`, the owner’s reserve requirement is reduced by one. - -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/nftokencanceloffer.md b/docs/references/protocol/transactions/types/nftokencanceloffer.md index 34e88fe5a2..345331a1a0 100644 --- a/docs/references/protocol/transactions/types/nftokencanceloffer.md +++ b/docs/references/protocol/transactions/types/nftokencanceloffer.md @@ -7,9 +7,9 @@ labels: # NFTokenCancelOffer [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCancelOffer.cpp "Source") -The `NFTokenCancelOffer` transaction can be used to cancel existing token offers created using `NFTokenCreateOffer`. +Cancel an offer to buy or sell a [non-fungible token (NFT)](../../../../concepts/tokens/nfts/index.md). -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/nftokencreateoffer.md b/docs/references/protocol/transactions/types/nftokencreateoffer.md index 42504d0492..c374ee803a 100644 --- a/docs/references/protocol/transactions/types/nftokencreateoffer.md +++ b/docs/references/protocol/transactions/types/nftokencreateoffer.md @@ -7,11 +7,11 @@ labels: # NFTokenCreateOffer [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCreateOffer.cpp "Source") -Creates either a new _Sell_ offer for an `NFToken` owned by the account executing the transaction, or a new _Buy_ offer for an `NFToken` owned by another account. +Create a new offer to either buy or sell a [non-fungible token (NFT)](../../../../concepts/tokens/nfts/index.md). You can only offer to sell NFTs you own or buy NFTs you don't own. -If successful, the transaction creates a [NFTokenOffer object][]. Each offer counts as one object towards the [owner reserve](../../../../concepts/accounts/reserves.md) of the account that placed the offer. +If successful, the transaction creates a [NFTokenOffer object][]. To complete the sale and change ownership of the NFT, the offer must be accepted using an [NFTokenAcceptOffer transaction][]. -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example {% $frontmatter.seo.title %} JSON @@ -64,7 +64,7 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} | `tecNO_ENTRY` | The `NFToken` is not owned by the expected account. | | `tecNO_ISSUER` | The issuer specified in the `Amount` field does not exist. | | `tecNO_LINE` | The `Amount` field is denominated in fungible tokens, but the `NFToken`'s issuer does not have a trust line for those tokens and the `NFToken` does not have the [`lsfTrustLine` flag](../../data-types/nftoken.md#nftoken-flags) enabled. | -| `tecNO_PERMISSION` | The `Destination` account blocks incoming NFTokenOffers. _(Requires the [DisallowIncoming amendment][] )_ +| `tecNO_PERMISSION` | The `Destination` account blocks incoming NFTokenOffers. {% amendment-disclaimer name="DisallowIncoming" /%} | `tecUNFUNDED_OFFER` | For a buy offer, the sender does have the funds specified in the `Amount` field available. If the `Amount` is XRP, this could be due to the reserve requirement; if the `Amount` is denominated in fungible tokens, this could be because they are [frozen](../../../../concepts/tokens/fungible-tokens/freezes.md). | | `tefNFTOKEN_IS_NOT_TRANSFERABLE` | The `NFToken` has the [`lsfTransferable` flag](../../data-types/nftoken.md#nftoken-flags) disabled and this transaction would not transfer the `NFToken` to or from the issuer. | diff --git a/docs/references/protocol/transactions/types/nftokenmint.md b/docs/references/protocol/transactions/types/nftokenmint.md index ab975403ea..7b710b1d07 100644 --- a/docs/references/protocol/transactions/types/nftokenmint.md +++ b/docs/references/protocol/transactions/types/nftokenmint.md @@ -7,9 +7,11 @@ labels: # NFTokenMint [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenMint.cpp "Source") -The `NFTokenMint` transaction creates a non-fungible token and adds it to the relevant [NFTokenPage object][] of the `NFTokenMinter` as an [NFToken][] object. This transaction is the only opportunity the `NFTokenMinter` has to specify any token fields that are defined as immutable (for example, the `TokenFlags`). +Create a [non-fungible token (NFT)](../../../../concepts/tokens/nfts/index.md). This is the only opportunity the minter has to specify any token fields and flags that are immutable. This transaction can be sent by the NFT's issuer or by an [authorized minter](../../../../concepts/tokens/nfts/authorizing-another-minter.md). -_(Added by the [NonFungibleTokensV1_1 amendment][].)_ +If successful, the transaction adds an [NFToken][] object to one of the minter's [NFTokenPage ledger entries][NFTokenPage entry]. + +{% amendment-disclaimer name="NonFungibleTokensV1_1" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/nftokenmodify.md b/docs/references/protocol/transactions/types/nftokenmodify.md index d742e8c8d5..afa56b5618 100644 --- a/docs/references/protocol/transactions/types/nftokenmodify.md +++ b/docs/references/protocol/transactions/types/nftokenmodify.md @@ -2,14 +2,14 @@ seo: description: Modify a dynamic NFT. labels: - - Non-fungible Tokens, NFTs + - Non-fungible Tokens, NFTs --- # NFTokenModify [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenModify.cpp "Source") -`NFTokenModify` is used to change the `URI` field of an NFT to point to a different URI in order to update the supporting data for the NFT. The NFT must have been minted with the `tfMutable` flag set. See [Dynamic Non-Fungible Tokens](../../../../concepts/tokens/nfts/dynamic-nfts.md). +Change the `URI` field of a [dynamic NFT](../../../../concepts/tokens/nfts/dynamic-nfts.md) to update the supporting data for the NFT. Only the issuer, or their authorized minter, can modify an NFT, and only if it was minted with the **Mutable** flag enabled. -_(Requires the [DynamicNFT amendment][] {% not-enabled /%}.)_ +{% amendment-disclaimer name="DynamicNFT" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/offercancel.md b/docs/references/protocol/transactions/types/offercancel.md index 69cfd36de1..795d14e105 100644 --- a/docs/references/protocol/transactions/types/offercancel.md +++ b/docs/references/protocol/transactions/types/offercancel.md @@ -1,6 +1,6 @@ --- seo: - description: Withdraw an offer to trade in the decentralized exchange. + description: Cancel an offer to trade in the decentralized exchange. labels: - Decentralized Exchange --- @@ -8,7 +8,7 @@ labels: [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CancelOffer.cpp "Source") -An OfferCancel transaction removes an Offer object from the XRP Ledger. +Cancel an [offer](../../../../concepts/tokens/decentralized-exchange/offers.md) in the decentralized exchange. ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/offercreate.md b/docs/references/protocol/transactions/types/offercreate.md index 70f5f0e087..1f4dba6cfd 100644 --- a/docs/references/protocol/transactions/types/offercreate.md +++ b/docs/references/protocol/transactions/types/offercreate.md @@ -5,10 +5,9 @@ labels: - Decentralized Exchange --- # OfferCreate - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateOffer.cpp "Source") -An OfferCreate transaction places an [Offer](../../../../concepts/tokens/decentralized-exchange/offers.md) in the [decentralized exchange](../../../../concepts/tokens/decentralized-exchange/index.md). +Place an [offer](../../../../concepts/tokens/decentralized-exchange/offers.md) to trade in the [decentralized exchange](../../../../concepts/tokens/decentralized-exchange/index.md). ## Example {% $frontmatter.seo.title %} JSON @@ -36,7 +35,7 @@ An OfferCreate transaction places an [Offer](../../../../concepts/tokens/decentr | Field | JSON Type | [Internal Type][] | Required? | Description | |:-----------------|:--------------------|:------------------|:----------|-------------| -| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain. If provided, restrict this offer to the [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) of that domain. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain. If provided, restrict this offer to the [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) of that domain. {% amendment-disclaimer name="PermissionedDEX" /%} | | [`Expiration`](../../../../concepts/tokens/decentralized-exchange/offers.md#offer-expiration) | Number | UInt32 | No | Time after which the Offer is no longer active, in [seconds since the Ripple Epoch][]. | | `OfferSequence` | Number | UInt32 | No | An Offer to delete first, specified in the same way as [OfferCancel][]. | | `TakerGets` | [Currency Amount][] | Amount | Yes | The amount and type of currency being sold. | @@ -52,7 +51,7 @@ Transactions of the OfferCreate type support additional values in the [`Flags` f | `tfImmediateOrCancel` | `0x00020000` | 131072 | Treat the offer as an [Immediate or Cancel order](http://en.wikipedia.org/wiki/Immediate_or_cancel) and do not place an [Offer entry][] into the order books. The transaction trades as much as it can by consuming existing offers when it's processed. | | `tfFillOrKill` | `0x00040000` | 262144 | Treat the offer as a [Fill or Kill order](http://en.wikipedia.org/wiki/Fill_or_kill), do not place an [Offer entry][] into the order books, and cancel the offer if it cannot be fully filled at the time of execution. By default, this means that the owner must receive the full `TakerPays` amount; if the `tfSell` flag is enabled, the owner must be able to spend the entire `TakerGets` amount instead. | | `tfSell` | `0x00080000` | 524288 | Exchange the entire `TakerGets` amount, even if it means obtaining more than the `TakerPays` amount in exchange. | -| `tfHybrid` | `0x00100000` | 1048576 | Make this a hybrid offer that can use both a permissioned DEX and the open DEX. The `DomainID` field must be provided when using this flag. | +| `tfHybrid` | `0x00100000` | 1048576 | Make this a hybrid offer that can use both a permissioned DEX and the open DEX. The `DomainID` field must be provided when using this flag. {% amendment-disclaimer name="PermissionedDEX" /%} | ## Error Cases @@ -67,7 +66,7 @@ Transactions of the OfferCreate type support additional values in the [`Flags` f | `tecNO_AUTH` | The transaction involves a token whose issuer uses [Authorized Trust Lines](../../../../concepts/tokens/fungible-tokens/authorized-trust-lines.md) and the the trust line that would receive the tokens exists but has not been authorized. | | `tecNO_ISSUER` | The transaction specifies a token whose `issuer` value is not a funded account in the ledger. | | `tecNO_LINE` | The transaction involves a token whose issuer uses [Authorized Trust Lines](../../../../concepts/tokens/fungible-tokens/authorized-trust-lines.md) and the necessary trust line does not exist. | -| `tecNO_PERMISSION` | The transaction uses a `DomainID` but the sender is not a member of that domain. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `tecNO_PERMISSION` | The transaction uses a `DomainID` but the sender is not a member of that domain. {% amendment-disclaimer name="PermissionedDEX" /%} | | `tecUNFUNDED_OFFER` | The owner does not hold a positive amount of the `TakerGets` currency. (Exception: if `TakerGets` specifies a token that the owner issues, the transaction can succeed.) | | `temBAD_CURRENCY` | The transaction specifies a fungible token incorrectly, such as a fungible token with the currency code "XRP". | | `temBAD_EXPIRATION` | The transaction contains an `Expiration` field that is not validly formatted. | diff --git a/docs/references/protocol/transactions/types/oracledelete.md b/docs/references/protocol/transactions/types/oracledelete.md index 8f6e6dedbf..2f81726906 100644 --- a/docs/references/protocol/transactions/types/oracledelete.md +++ b/docs/references/protocol/transactions/types/oracledelete.md @@ -5,13 +5,11 @@ labels: - Oracle --- # OracleDelete -_(Requires the [PriceOracle amendment][])_ - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteOracle.cpp "Source") -Delete an `Oracle` ledger entry. +Delete a [price oracle](../../../../concepts/decentralized-storage/price-oracles.md). Only the owner of the price oracle can send this transaction. -_(Added by the [PriceOracle amendment][].)_ +{% amendment-disclaimer name="PriceOracle" /%} ## Example OracleDelete JSON @@ -29,8 +27,7 @@ _(Added by the [PriceOracle amendment][].)_ | Field | JSON Type | Internal Type | Required? | Description | |--------------------|-----------|---------------|-----------|-------------| -| `Account` | String | AccountID | Yes | This account must match the account in the `Owner` field of the `Oracle` object. | -| `OracleDocumentID` | String | UInt32 | Yes | A unique identifier of the price oracle for the `Account`. | +| `OracleDocumentID` | Number | UInt32 | Yes | The identifying number of the price oracle, which must be unique per owner. | ## Error Cases diff --git a/docs/references/protocol/transactions/types/oracleset.md b/docs/references/protocol/transactions/types/oracleset.md index 9518b1bc8d..bd8247e7f8 100644 --- a/docs/references/protocol/transactions/types/oracleset.md +++ b/docs/references/protocol/transactions/types/oracleset.md @@ -7,9 +7,9 @@ labels: # OracleSet [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetOracle.cpp "Source") -Creates a new `Oracle` ledger entry or updates the fields of an existing one, using the Oracle Document ID. +Create or update a [price oracle](../../../../concepts/decentralized-storage/price-oracles.md). Only the owner of an existing price oracle can update it. -_(Added by the [PriceOracle amendment][].)_ +{% amendment-disclaimer name="PriceOracle" /%} ## Example OracleSet JSON @@ -40,9 +40,8 @@ _(Added by the [PriceOracle amendment][].)_ | Field | JSON Type | Internal Type | Required? | Description | |--------------------|-----------|---------------|-----------|-------------| -| `Account` | String | AccountID | Yes | This account must match the account in the `Owner` field of the `Oracle` object. | -| `OracleDocumentID` | Number | UInt32 | Yes | A unique identifier of the price oracle for the `Account`. | -| `Provider` | String | Blob | Variable | An arbitrary value that identifies an oracle provider, such as Chainlink, Band, or DIA. This field is a string, up to 256 ASCII hex encoded characters (0x20-0x7E). This field is required when creating a new `Oracle` ledger entry, but is optional for updates. | +| `OracleDocumentID` | Number | UInt32 | Yes | The identifying number of the price oracle, which must be unique per owner. | +| `Provider` | String | Blob | Variable | An arbitrary value that identifies an oracle provider, such as Chainlink, Band, or DIA. This field is a string, up to 256 ASCII hex encoded characters (0x20-0x7E). This field is required when creating a new price oracle, but is optional for updates. | | `URI` | String | Blob | No | An optional Universal Resource Identifier to reference price data off-chain. This field is limited to 256 bytes. | | `LastUpdateTime` | Number | UInt32 | Yes | The time the data was last updated, in seconds since the [UNIX Epoch](https://en.wikipedia.org/wiki/Unix_time). The value must be within 300 seconds (5 minutes) of the ledger's close time. | | `AssetClass` | String | Blob | Variable | Describes the type of asset, such as "currency", "commodity", or "index". This field is a string, up to 16 ASCII hex encoded characters (0x20-0x7E). This field is required when creating a new `Oracle` ledger entry, but is optional for updates. | diff --git a/docs/references/protocol/transactions/types/payment.md b/docs/references/protocol/transactions/types/payment.md index b64a298a11..716dd404c7 100644 --- a/docs/references/protocol/transactions/types/payment.md +++ b/docs/references/protocol/transactions/types/payment.md @@ -10,7 +10,7 @@ labels: # Payment [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Payment.cpp "Source") -A Payment transaction represents a transfer of value from one account to another. (Depending on the path taken, this can involve additional exchanges of value, which occur atomically.) This transaction type can be used for several [types of payments](#types-of-payments). +Send value to an account. (Depending on the path taken, this can involve exchanges of several types of funds, all of which occur atomically.) This transaction type can be used for several [types of payments](#types-of-payments). Payments are also the only way to [create accounts](#creating-accounts). @@ -40,12 +40,12 @@ Payments are also the only way to [create accounts](#creating-accounts). | Field | JSON Type | [Internal Type][] | Required? | Description | |:-----------------|:---------------------|:------------------|:----------|:------------| | `Amount` | [Currency Amount][] | Amount | API v1: Yes | Alias to `DeliverMax`. | -| `CredentialIDs` | Array of Strings | Vector256 | No | Set of Credentials to authorize a deposit made by this transaction. Each member of the array must be the ledger entry ID of a Credential entry in the ledger. _(Requires the [Credentials amendment][]._ {% not-enabled /%})_ | +| `CredentialIDs` | Array of Strings | Vector256 | No | Set of Credentials to authorize a deposit made by this transaction. Each member of the array must be the ledger entry ID of a Credential entry in the ledger. {% amendment-disclaimer name="Credentials" /%} | | `DeliverMax` | [Currency Amount][] | Amount | Yes | [API v2][]: The maximum amount of currency to deliver. [Partial payments](#partial-payments) can deliver less than this amount and still succeed; other payments fail unless they deliver the exact amount. {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %} | | `DeliverMin` | [Currency Amount][] | Amount | No | Minimum amount of destination currency this transaction should deliver. Only valid if this is a [partial payment](#partial-payments). | | `Destination` | String - [Address][] | AccountID | Yes | The account receiving the payment. | | `DestinationTag` | Number | UInt32 | No | Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay. | -| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain. If this is a cross-currency payment, only use the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) to convert currency. Both the sender and the recipient must have valid credentials that grant access to the specified domain. This field has no effect if the payment is not cross-currency. _(Requires the [PermissionedDEX amendment][] {% not-enabled /%})_ | +| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain. If this is a cross-currency payment, only use the corresponding [permissioned DEX](../../../../concepts/tokens/decentralized-exchange/permissioned-dexes.md) to convert currency. Both the sender and the recipient must have valid credentials that grant access to the specified domain. This field has no effect if the payment is not cross-currency. {% amendment-disclaimer name="PermissionedDEX" %/} | | `InvoiceID` | String - Hexadecimal | UInt256 | No | Arbitrary 256-bit value representing a specific reason or identifier for this payment. | | `Paths` | Array of path arrays | PathSet | No | _(Auto-fillable)_ Array of [payment paths](../../../../concepts/tokens/fungible-tokens/paths.md) to be used for this transaction. Must be omitted for XRP-to-XRP transactions. | | `SendMax` | [Currency Amount][] | Amount | No | Highest amount of source currency this transaction is allowed to cost, including [transfer fees](../../../../concepts/tokens/fungible-tokens/transfer-fees.md), exchange rates, and [slippage](http://en.wikipedia.org/wiki/Slippage_%28finance%29). Does not include the [XRP destroyed as a cost for submitting the transaction](../../../../concepts/transactions/transaction-cost.md). Must be supplied for cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP payments. | @@ -145,12 +145,12 @@ In the above example with a ¥95/$15 offer and a ¥5/$2 offer, the situation is ## MPT Payments -_(Requires the [MPTokensV1 amendment][] {% not-enabled /%})_ - When you send a payment using [MPTs](/docs/concepts/tokens/fungible-tokens/multi-purpose-tokens), the _Amount_ field requires only the `mpt_issuance_id` and the `value`. The `MPTokenIssuanceID` is used to uniquely identify the MPT for the transaction. Version 1 MPTokens only support direct MPT payment between accounts. They cannot be traded in the decentralized exchange. +{% amendment-disclaimer name="MPTokensV1" /%} + ### Sample MPT Payment transaction ```json @@ -175,7 +175,7 @@ Version 1 MPTokens only support direct MPT payment between accounts. They cannot ``` ## Credential IDs -_(Requires the [Credentials amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="Credentials" /%} You can send money to an account that uses [Deposit Authorization](../../../../concepts/accounts/depositauth.md) by providing the `CredentialIDs` field with an exact set of credentials that are preauthorized by the recipient. The set of credentials must match a [DepositPreauth entry](../../ledger-data/ledger-entry-types/depositpreauth.md) in the ledger. diff --git a/docs/references/protocol/transactions/types/paymentchannelclaim.md b/docs/references/protocol/transactions/types/paymentchannelclaim.md index 415ef1bd8f..56bb50710c 100644 --- a/docs/references/protocol/transactions/types/paymentchannelclaim.md +++ b/docs/references/protocol/transactions/types/paymentchannelclaim.md @@ -7,7 +7,7 @@ labels: # PaymentChannelClaim [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PayChan.cpp "Source") -Claim funds from a payment channel, adjust the payment channel's expiration, or both. This transaction can be used differently depending on the transaction sender's role in the specified channel: +Claim funds from a [payment channel](../../../../concepts/payment-types/payment-channels.md), adjust the payment channel's expiration, or both. This transaction can be used differently depending on the transaction sender's role in the specified channel: The **source address** of a channel can: @@ -25,7 +25,7 @@ The **destination address** of a channel can: - Cause a channel to be closed if its `Expiration` or `CancelAfter` time is older than the previous ledger's close time. Any validly formed `PaymentChannelClaim` transaction has this effect, regardless of the contents of the transaction. -_(Added by the [PayChan amendment][].)_ +{% amendment-disclaimer name="PayChan" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/paymentchannelcreate.md b/docs/references/protocol/transactions/types/paymentchannelcreate.md index 4fcdbc9c59..90f1f5c62f 100644 --- a/docs/references/protocol/transactions/types/paymentchannelcreate.md +++ b/docs/references/protocol/transactions/types/paymentchannelcreate.md @@ -9,7 +9,7 @@ labels: Create a [payment channel](../../../../concepts/payment-types/payment-channels.md) and fund it. The address sending this transaction becomes the "source address" of the payment channel. -_(Added by the [PayChan amendment][].)_ +{% amendment-disclaimer name="PayChan" /%} ## Example {% $frontmatter.seo.title %} JSON @@ -41,7 +41,7 @@ _(Added by the [PayChan amendment][].)_ | `CancelAfter` | Number | UInt32 | No | The time, in [seconds since the Ripple Epoch][], when this channel expires. Any transaction that would modify the channel after this time closes the channel without otherwise affecting it. This value is immutable; the channel can be closed earlier than this time but cannot remain open after this time. | | `DestinationTag` | Number | UInt32 | No | Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address. | -If the `Destination` account is blocking incoming payment channels, the transaction fails with result code `tecNO_PERMISSION`. _(Requires the [DisallowIncoming amendment][] )_ +If the `Destination` account is blocking incoming payment channels, the transaction fails with result code `tecNO_PERMISSION`. {% amendment-disclaimer name="DisallowIncoming" /%} ## See Also diff --git a/docs/references/protocol/transactions/types/paymentchannelfund.md b/docs/references/protocol/transactions/types/paymentchannelfund.md index 48a0c9a187..8e259aaad2 100644 --- a/docs/references/protocol/transactions/types/paymentchannelfund.md +++ b/docs/references/protocol/transactions/types/paymentchannelfund.md @@ -9,7 +9,7 @@ labels: Add an additional amount to an open [payment channel](../../../../concepts/payment-types/payment-channels.md), and optionally update the expiration time of the channel. Only the source account of the channel can use this transaction. -_(Added by the [PayChan amendment][].)_ +{% amendment-disclaimer name="PayChan" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/permissioneddomaindelete.md b/docs/references/protocol/transactions/types/permissioneddomaindelete.md index a7947a9518..fcf7230b73 100644 --- a/docs/references/protocol/transactions/types/permissioneddomaindelete.md +++ b/docs/references/protocol/transactions/types/permissioneddomaindelete.md @@ -2,15 +2,16 @@ seo: description: Delete a permissioned domain. labels: - - Compliance - - Permissioned Domains + - Compliance + - Permissioned Domains +status: not_enabled --- # PermissionedDomainDelete [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PermissionedDomainDelete.cpp "Source") Delete a [permissioned domain][] that you own. -_(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="PermissionedDomains" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/permissioneddomainset.md b/docs/references/protocol/transactions/types/permissioneddomainset.md index 7734a92cac..97abb5097c 100644 --- a/docs/references/protocol/transactions/types/permissioneddomainset.md +++ b/docs/references/protocol/transactions/types/permissioneddomainset.md @@ -2,15 +2,16 @@ seo: description: Create or update a permissioned domain. labels: - - Compliance - - Permissioned Domains + - Compliance + - Permissioned Domains +status: not_enabled --- # PermissionedDomainSet [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PermissionedDomainSet.cpp "Source") Create a [permissioned domain][], or modify one that you own. -_(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="PermissionedDomains" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/setregularkey.md b/docs/references/protocol/transactions/types/setregularkey.md index ff3b7c0bf3..98d36bd9f4 100644 --- a/docs/references/protocol/transactions/types/setregularkey.md +++ b/docs/references/protocol/transactions/types/setregularkey.md @@ -2,13 +2,13 @@ seo: description: Add, remove, or modify an account's regular key pair. labels: - - Security + - Security --- # SetRegularKey [[Source]](https://github.com/XRPLF/rippled/blob/4239880acb5e559446d2067f00dabb31cf102a23/src/ripple/app/transactors/SetRegularKey.cpp "Source") -A `SetRegularKey` transaction assigns, changes, or removes the regular key pair associated with an account. +Assign, change, or remove the [regular key pair](../../../../concepts/accounts/cryptographic-keys.md) associated with your account. You can protect your account by assigning a regular key pair to it and using it instead of the master key pair to sign transactions whenever possible. If your regular key pair is compromised, but your master key pair is not, you can use a `SetRegularKey` transaction to regain control of your account. @@ -27,7 +27,6 @@ You can protect your account by assigning a regular key pair to it and using it {% tx-example txid="6AA6F6EAAAB56E65F7F738A9A2A8A7525439D65BA990E9BA08F6F4B1C2D349B4" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - | Field | JSON Type | [Internal Type][] | Description | |:-------------|:----------|:------------------|:------------------------------| diff --git a/docs/references/protocol/transactions/types/signerlistset.md b/docs/references/protocol/transactions/types/signerlistset.md index 2f1124e88c..1c3b606cf1 100644 --- a/docs/references/protocol/transactions/types/signerlistset.md +++ b/docs/references/protocol/transactions/types/signerlistset.md @@ -5,10 +5,12 @@ labels: - Security --- # SignerListSet - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetSignerList.cpp "Source") -The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to [multi-sign](../../../../concepts/accounts/multi-signing.md) a transaction. This transaction type was introduced by the [MultiSign amendment][]. +Create, replace, or remove a list of signers that can be used to [multi-sign](../../../../concepts/accounts/multi-signing.md) a transaction. + +{% amendment-disclaimer name="MultiSign" /%} + ## Example {% $frontmatter.seo.title %} JSON @@ -45,7 +47,6 @@ The SignerListSet transaction creates, replaces, or removes a list of signers th {% tx-example txid="09A9C86BF20695735AB03620EB1C32606635AC3DA0B70282F37C674FC889EFE7" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - | Field | JSON Type | [Internal Type][] | Description | |:----------------|:----------|:------------------|:-----------------------------| diff --git a/docs/references/protocol/transactions/types/ticketcreate.md b/docs/references/protocol/transactions/types/ticketcreate.md index a6c7e93dfa..eb3aba1383 100644 --- a/docs/references/protocol/transactions/types/ticketcreate.md +++ b/docs/references/protocol/transactions/types/ticketcreate.md @@ -5,12 +5,11 @@ labels: - Transaction Sending --- # TicketCreate - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateTicket.cpp "Source") -_(Added by the [TicketBatch amendment][].)_ +Set aside one or more [sequence numbers][Sequence Number] as [tickets](../../../../concepts/accounts/tickets.md). -A TicketCreate transaction sets aside one or more [sequence numbers][Sequence Number] as [Tickets](../../../../concepts/accounts/tickets.md). +{% amendment-disclaimer name="TicketBatch" /%} ## Example {% $frontmatter.seo.title %} JSON diff --git a/docs/references/protocol/transactions/types/trustset.md b/docs/references/protocol/transactions/types/trustset.md index 9d3eaf627e..1726a73b0f 100644 --- a/docs/references/protocol/transactions/types/trustset.md +++ b/docs/references/protocol/transactions/types/trustset.md @@ -5,7 +5,6 @@ labels: - Tokens --- # TrustSet - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetTrust.cpp "Source") Create or modify a [trust line](../../../../concepts/tokens/fungible-tokens/index.md) linking two accounts. @@ -31,7 +30,6 @@ Create or modify a [trust line](../../../../concepts/tokens/fungible-tokens/inde {% tx-example txid="8566673ECD0A9731C516906E5D2F47129C5C13713602140733831A56CEAE1A05" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - | Field | JSON Type | [Internal Type][] | Description | |:-------------------------|:----------|:------------------|:------------------| @@ -42,7 +40,7 @@ Create or modify a [trust line](../../../../concepts/tokens/fungible-tokens/inde | `QualityIn` | Number | UInt32 | _(Optional)_ Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. For example, if you set the value to 10,000,000, 1% of incoming funds remain with the sender. If an account sends 100 currency, the sender retains 1 currency unit and the destination receives 99 units. This option is included for parity: in practice, you are much more likely to set a `QualityOut` value. Note that this fee is separate and independent from token transfer fees. | | `QualityOut` | Number | UInt32 | _(Optional)_ Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. For example, if you set the value to 10,000,000, 1% of outgoing funds would remain with the issuer. If the sender sends 100 currency units, the issuer retains 1 currency unit and the destination receives 99 units. Note that this fee is separate and independent from token transfer fees. | -If the account specified in `LimitAmount.issuer` is blocking incoming trust lines, the transaction fails with the result code `tecNO_PERMISSION`. _(Requires the [DisallowIncoming amendment][] )_ +If the account specified in `LimitAmount.issuer` is blocking incoming trust lines, the transaction fails with the result code `tecNO_PERMISSION`. {% amendment-disclaimer name="DisallowIncoming" /%} ## TrustSet Flags diff --git a/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md b/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md index 994233e481..e9c2688e67 100644 --- a/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md +++ b/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md @@ -8,15 +8,13 @@ status: not_enabled # XChainAccountCreateCommit [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L466-L474 "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ - -This transaction can only be used for XRP-XRP bridges. - -The `XChainAccountCreateCommit` transaction creates a new account for a witness server to submit transactions on an issuing chain. +Create a new account for a [witness server](../../../../concepts/xrpl-sidechains/witness-servers.md) to submit transactions on an issuing chain. This transaction can only be used for XRP-XRP bridges. {% admonition type="danger" name="Warning" %}This transaction should only be executed if the witness attestations will be reliably delivered to the destination chain. If the signatures aren't delivered, then account creation will be blocked until attestations are received. This can be used maliciously; to disable this transaction on XRP-XRP bridges, omit the bridge's `MinAccountCreateAmount` field.{% /admonition %} +{% amendment-disclaimer name="XChainBridge" /%} + ## Example XChainAccountCreateCommit JSON ```json diff --git a/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md b/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md index d4b7b3033d..0fb48fc2ed 100644 --- a/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md +++ b/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md @@ -8,9 +8,7 @@ status: not_enabled # XChainAddAccountCreateAttestation [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L447-L464 "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ - -The `XChainAddAccountCreateAttestation` transaction provides an attestation from a witness server that an `XChainAccountCreateCommit` transaction occurred on the other chain. +Provide an attestation from a [witness server](../../../../concepts/xrpl-sidechains/witness-servers.md) that an `XChainAccountCreateCommit` transaction occurred on the other chain. The signature must be from one of the keys on the door's signer list at the time the signature was provided. If the signature list changes between the time the signature was submitted and the quorum is reached, the new signature set is used and some of the currently collected signatures may be removed. @@ -18,6 +16,7 @@ Any account can submit signatures. {% admonition type="info" name="Note" %}The reward is only sent to accounts that have keys on the current list. A quorum of signers need to agree on the `SignatureReward`, the same way they need to agree on the other data. A single witness server can't provide an incorrect value for this in an attempt to collect a larger reward.{% /admonition %} +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainAddAccountCreateAttestation JSON diff --git a/docs/references/protocol/transactions/types/xchainaddclaimattestation.md b/docs/references/protocol/transactions/types/xchainaddclaimattestation.md index 7c2b6725f0..835e4e8838 100644 --- a/docs/references/protocol/transactions/types/xchainaddclaimattestation.md +++ b/docs/references/protocol/transactions/types/xchainaddclaimattestation.md @@ -8,9 +8,7 @@ status: not_enabled # XChainAddClaimAttestation [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L429-L445 "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ - -The `XChainAddClaimAttestation` transaction provides proof from a witness server, attesting to an `XChainCommit` transaction. +Provide proof from a [witness server](../../../../concepts/xrpl-sidechains/witness-servers.md) attesting to an `XChainCommit` transaction. The signature must be from one of the keys on the door's signer list at the time the signature was provided. However, if the signature list changes between the time the signature was submitted and the quorum is reached, the new signature set is used and some of the currently collected signatures may be removed. @@ -18,6 +16,7 @@ Any account can submit signatures. {% admonition type="info" name="Note" %}The reward is only sent to accounts that have keys on the current list. A quorum of signers need to agree on the `SignatureReward`, the same way they need to agree on the other data. A single witness server can't provide an incorrect value for this in an attempt to collect a larger reward.{% /admonition %} +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainAddClaimAttestation JSON diff --git a/docs/references/protocol/transactions/types/xchainclaim.md b/docs/references/protocol/transactions/types/xchainclaim.md index fadd466b48..66b0c9b9a3 100644 --- a/docs/references/protocol/transactions/types/xchainclaim.md +++ b/docs/references/protocol/transactions/types/xchainclaim.md @@ -6,14 +6,13 @@ labels: status: not_enabled --- # XChainClaim -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L418-L427 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/XChainBridge.cpp "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ - -The `XChainClaim` transaction completes a cross-chain transfer of value. It allows a user to claim the value on the destination chain - the equivalent of the value locked on the source chain. A user can only claim the value if they own the cross-chain claim ID associated with the value locked on the source chain (the `Account` field). The user can send the funds to anyone (the `Destination` field). This transaction is only needed if an `OtherChainDestination` isn't specified in the `XChainCommit` transaction, or if something goes wrong with the automatic transfer of funds. +Complete a [cross-chain transfer of value](../../../../concepts/xrpl-sidechains/cross-chain-bridges.md). It allows a user to claim the value on the destination chain - the equivalent of the value locked on the source chain. A user can only claim the value if they own the cross-chain claim ID associated with the value locked on the source chain (the `Account` field). The user can send the funds to anyone (the `Destination` field). This transaction is only needed if an `OtherChainDestination` isn't specified in the `XChainCommit` transaction, or if something goes wrong with the automatic transfer of funds. If the transaction succeeds in moving funds, the referenced `XChainOwnedClaimID` ledger object will be destroyed. This prevents transaction replay. If the transaction fails, the `XChainOwnedClaimID` won't be destroyed and the transaction can be re-run with different parameters. +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainClaim JSON diff --git a/docs/references/protocol/transactions/types/xchaincommit.md b/docs/references/protocol/transactions/types/xchaincommit.md index bf4e995078..8eb9821836 100644 --- a/docs/references/protocol/transactions/types/xchaincommit.md +++ b/docs/references/protocol/transactions/types/xchaincommit.md @@ -6,12 +6,14 @@ labels: status: not_enabled --- # XChainCommit -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L408-L416 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/XChainBridge.cpp "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +Do the second step in a [cross-chain transfer](../../../../concepts/xrpl-sidechains/cross-chain-bridges.md). This transaciton has two modes: -The `XChainCommit` is the second step in a cross-chain transfer. It puts assets into trust on the locking chain so that they can be wrapped on the issuing chain, or burns wrapped assets on the issuing chain so that they can be returned on the locking chain. +- Put assets into trust on the locking chain so that they can be wrapped on the issuing chain. +- Burns wrapped assets on the issuing chain so that they can be returned on the locking chain. +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainCommit JSON diff --git a/docs/references/protocol/transactions/types/xchaincreatebridge.md b/docs/references/protocol/transactions/types/xchaincreatebridge.md index 477a469ac0..63c069123a 100644 --- a/docs/references/protocol/transactions/types/xchaincreatebridge.md +++ b/docs/references/protocol/transactions/types/xchaincreatebridge.md @@ -6,11 +6,9 @@ labels: status: not_enabled --- # XChainCreateBridge -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L381-L388 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/XChainBridge.cpp "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ - -The `XChainCreateBridge` transaction creates a new `Bridge` ledger object and defines a new cross-chain bridge entrance on the chain that the transaction is submitted on. It includes information about door accounts and assets for the bridge. +Creates a new [cross-chain bridge](../../../../concepts/xrpl-sidechains/cross-chain-bridges.md) on the chain that the transaction is submitted on, providing information about door accounts and assets for the bridge. The transaction must be submitted first by the locking chain door account. To set up a valid bridge, door accounts on both chains must submit this transaction, in addition to setting up witness servers. @@ -18,6 +16,7 @@ The complete production-grade setup would also include a `SignerListSet` transac {% admonition type="info" name="Note" %}Each door account can only have one bridge. This prevents the creation of duplicate bridges for the same asset, which can cause asset imbalances on either chain.{% /admonition %} +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainCreateBridge JSON diff --git a/docs/references/protocol/transactions/types/xchaincreateclaimid.md b/docs/references/protocol/transactions/types/xchaincreateclaimid.md index 597b5aa757..60cd337076 100644 --- a/docs/references/protocol/transactions/types/xchaincreateclaimid.md +++ b/docs/references/protocol/transactions/types/xchaincreateclaimid.md @@ -6,16 +6,15 @@ labels: status: not_enabled --- # XChainCreateClaimID -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L399-L406 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/XChainBridge.cpp "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ - -The `XChainCreateClaimID` transaction creates a new cross-chain claim ID that is used for a cross-chain transfer. A cross-chain claim ID represents *one* cross-chain transfer of value. +Create a new cross-chain claim ID that is used for a [cross-chain transfer](../../../../concepts/xrpl-sidechains/cross-chain-bridges.md). A cross-chain claim ID represents *one* cross-chain transfer of value. This transaction is the first step of a cross-chain transfer of value and is submitted on the destination chain, not the source chain. It also includes the account on the source chain that locks or burns the funds on the source chain. +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainCreateClaimID JSON diff --git a/docs/references/protocol/transactions/types/xchainmodifybridge.md b/docs/references/protocol/transactions/types/xchainmodifybridge.md index 05dcd604f4..87a6a63d4a 100644 --- a/docs/references/protocol/transactions/types/xchainmodifybridge.md +++ b/docs/references/protocol/transactions/types/xchainmodifybridge.md @@ -6,16 +6,15 @@ labels: status: not_enabled --- # XChainModifyBridge -[[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/impl/TxFormats.cpp#L390-L397 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/XChainBridge.cpp "Source") -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ - -The `XChainModifyBridge` transaction allows bridge managers to modify the parameters of the bridge. They can only change the `SignatureReward` and the `MinAccountCreateAmount`. +Modify the parameters of a [cross-chain bridge](../../../../concepts/xrpl-sidechains/cross-chain-bridges.md). Only managers can send this transaction, and they can only change the `SignatureReward` and the `MinAccountCreateAmount`. This transaction must be sent by the door account and requires the entities that control the witness servers to coordinate and provide the signatures for this transaction. This coordination happens outside the ledger. {% admonition type="info" name="Note" %}You can't modify the signer list for the bridge with this transaction. The signer list is on the door account itself and is changed in the same way signer lists are changed on accounts (via a `SignerListSet` transaction).{% /admonition %} +{% amendment-disclaimer name="XChainBridge" /%} ## Example XChainModifyBridge JSON diff --git a/docs/tutorials/how-tos/use-tokens/create-an-automated-market-maker.md b/docs/tutorials/how-tos/use-tokens/create-an-automated-market-maker.md index 1409f357cf..77b4f2f965 100644 --- a/docs/tutorials/how-tos/use-tokens/create-an-automated-market-maker.md +++ b/docs/tutorials/how-tos/use-tokens/create-an-automated-market-maker.md @@ -14,7 +14,7 @@ steps: ['Connect', 'Generate', 'Acquire tokens', 'Check for AMM', 'Look up AMMCr --- # Create an Automated Market Maker -_(Added by the [AMM amendment][])_ +{% amendment-disclaimer name="AMM" /%} An [Automated Market Maker (AMM)](../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) can be an efficient way to facilitate exchanges between two assets while earning its liquidity providers passive income. This tutorial shows how to create an AMM for a given asset pair. diff --git a/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-iou-iou-bridge.md b/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-iou-iou-bridge.md index ac81aa8c94..51a2ccc100 100644 --- a/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-iou-iou-bridge.md +++ b/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-iou-iou-bridge.md @@ -8,7 +8,7 @@ labels: --- # Set Up an IOU-IOU Bridge -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} Setting up an IOU-IOU bridge enables you to move tokens between chains. diff --git a/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-xrp-xrp-bridge.md b/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-xrp-xrp-bridge.md index 2f5a212044..c94ddd0ae9 100644 --- a/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-xrp-xrp-bridge.md +++ b/docs/tutorials/how-tos/use-xrpl-sidechains/set-up-xrp-xrp-bridge.md @@ -8,7 +8,7 @@ labels: --- # Set Up an XRP-XRP Bridge -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} Setting up an XRP-XRP bridge enables you to move XRP between chains. The set up requires using the genesis account on the issuing chain as a door account to submit attestations and create transaction submission accounts for witnesses. diff --git a/docs/tutorials/how-tos/use-xrpl-sidechains/submit-cross-chain-transaction.md b/docs/tutorials/how-tos/use-xrpl-sidechains/submit-cross-chain-transaction.md index b588ec505a..668ad9f923 100644 --- a/docs/tutorials/how-tos/use-xrpl-sidechains/submit-cross-chain-transaction.md +++ b/docs/tutorials/how-tos/use-xrpl-sidechains/submit-cross-chain-transaction.md @@ -8,7 +8,7 @@ labels: --- # Submit Cross-chain Transactions -_(Requires the [XChainBridge amendment][] {% not-enabled /%})_ +{% amendment-disclaimer name="XChainBridge" /%} This tutorial explains how to create a test account on a locking chain (_Devent_), and transfer XRP to an issuing chain (_Sidechain-Devnet_), using a supported [client library](../../../references/client-libraries.md) to query and submit transactions. Witness servers are already set up to monitor the XRP-XRP bridge and submit attestations. diff --git a/docs/use-cases/tokenization/stablecoin-issuer.md b/docs/use-cases/tokenization/stablecoin-issuer.md index 3908140dbd..bc4fe26b9d 100644 --- a/docs/use-cases/tokenization/stablecoin-issuer.md +++ b/docs/use-cases/tokenization/stablecoin-issuer.md @@ -159,7 +159,7 @@ See [Enact Global Freeze](../../tutorials/how-tos/use-tokens/enact-global-freeze ### Clawback -_(Requires the [Clawback amendment][] )_ +{% amendment-disclaimer name="Clawback" /%} Clawback is an optional setting that you can choose before you begin to distribute your stablecoin. For regulatory purposes, some issuers _must_ have the ability to recover issued tokens after they are distributed to accounts. For example, if an issuer were to discover that tokens were sent to an account sanctioned for illegal activity, the issuer could recover, or _claw back_, the funds. @@ -206,7 +206,7 @@ Decentralized exchanges (DEXes) are integral to the decentralized finance ecosys ### List on an AMM -_(Added by the [AMM amendment][])_ +{% amendment-disclaimer name="AMM" /%} Automated Market Makers (AMMs) are smart contracts that provide liquidity in the XRP Ledger's decentralized exchange. Each AMM holds a pool of two assets and enables users to swap between them at an exchange rate set by a formula.