diff --git a/@l10n/es-ES/docs/concepts/accounts/deleting-accounts.md b/@l10n/es-ES/docs/concepts/accounts/deleting-accounts.md index 5f6e0bfce9..50066fc8e4 100644 --- a/@l10n/es-ES/docs/concepts/accounts/deleting-accounts.md +++ b/@l10n/es-ES/docs/concepts/accounts/deleting-accounts.md @@ -1,7 +1,6 @@ --- -html: deleting-accounts.html -parent: accounts.html -blurb: Acerca de eliminar una cuenta XRP Ledger. +seo: + description: Acerca de eliminar una cuenta XRP Ledger. labels: - Cuentas --- diff --git a/@l10n/es-ES/docs/concepts/consensus-protocol/consensus-protections.md b/@l10n/es-ES/docs/concepts/consensus-protocol/consensus-protections.md index 0dd08a2afc..d3d6025a19 100644 --- a/@l10n/es-ES/docs/concepts/consensus-protocol/consensus-protections.md +++ b/@l10n/es-ES/docs/concepts/consensus-protocol/consensus-protections.md @@ -1,7 +1,6 @@ --- -html: consensus-protections.html -parent: consensus.html -blurb: Aprende cómo el Protocolo de Consenso del XRP Ledger se protege contra varios problemas y ataques que pueden ocurrir en un sistema financiero descentralizado. +seo: + description: Aprende cómo el Protocolo de Consenso del XRP Ledger se protege contra varios problemas y ataques que pueden ocurrir en un sistema financiero descentralizado. labels: - Blockchain --- 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 893e6d8209..f2e5ff2f48 100644 --- a/@l10n/ja/docs/concepts/tokens/fungible-tokens/deep-freeze.md +++ b/@l10n/ja/docs/concepts/tokens/fungible-tokens/deep-freeze.md @@ -1,5 +1,6 @@ --- -blurb: ディープフリーズは、トラストラインのフリーズが解除されるまで、フリーズされたトークン保有者がその資金を送受信できないようにします。 +seo: + description: ディープフリーズは、トラストラインのフリーズが解除されるまで、フリーズされたトークン保有者がその資金を送受信できないようにします。 labels: - トークン - フリーズ diff --git a/@l10n/ja/docs/concepts/tokens/fungible-tokens/multi-purpose-tokens.md b/@l10n/ja/docs/concepts/tokens/fungible-tokens/multi-purpose-tokens.md index c01ea8b5db..f661585292 100644 --- a/@l10n/ja/docs/concepts/tokens/fungible-tokens/multi-purpose-tokens.md +++ b/@l10n/ja/docs/concepts/tokens/fungible-tokens/multi-purpose-tokens.md @@ -1,5 +1,6 @@ --- -blurb: Multi-Purpose Tokenは、トラストラインよりもコンパクトで柔軟なトークンタイプです。 +seo: + description: Multi-Purpose Tokenは、トラストラインよりもコンパクトで柔軟なトークンタイプです。 labels: - トークン - MPT diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md index 18627c80da..362aab43fe 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md @@ -1,7 +1,6 @@ --- -html: get_aggregate_price.html -parent: ledger-methods.html -blurb: 指定されたOracleインスタンスの集計価格を計算します。 +seo: + description: 指定されたOracleインスタンスの集計価格を計算します。 labels: - オラクル --- diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/mpt_holders.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/mpt_holders.md index 3f662ff481..b898a8cf72 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/mpt_holders.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/mpt_holders.md @@ -1,5 +1,6 @@ --- -blurb: 指定された`MPTokenIssuanceID`とledgerシーケンスに対する所有者の情報を取得します。 +seo: + description: 指定された`MPTokenIssuanceID`とledgerシーケンスに対する所有者の情報を取得します。 labels: - アカウント - XRP 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 5c9be3ecab..7883d76fd3 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 @@ -1,5 +1,6 @@ --- -blurb: XRPLのMulti-Purpose Tokenのオブジェクトについて説明します。 +seo: + description: XRPLのMulti-Purpose Tokenのオブジェクトについて説明します。 labels: - Multi-Purpose Token, MPT, トークン --- 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 f0d9e18ac8..1d00d6601a 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 @@ -1,5 +1,6 @@ --- -blurb: Introduction to XRPL MPTs. +seo: + description: 単一のMPT Issuanceを表し、Issuance自体に関連するデータを保持します。 labels: - Multi-Purpose Token, MPT, トークン --- diff --git a/@l10n/ja/docs/references/protocol/transactions/types/mptokenauthorize.md b/@l10n/ja/docs/references/protocol/transactions/types/mptokenauthorize.md index 8085042765..33afef27b1 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/mptokenauthorize.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/mptokenauthorize.md @@ -1,7 +1,6 @@ --- -html: mptokenauthorize.html -parent: transaction-types.html -blurb: アカウントが特定のMPTの残高を保持することを許可します。 +seo: + description: アカウントが特定のMPTの残高を保持することを許可します。 labels: - Multi-Purpose Token, MPT --- diff --git a/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancecreate.md b/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancecreate.md index 7049ac3fe1..e0199d8c64 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancecreate.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancecreate.md @@ -1,7 +1,6 @@ --- -html: mptokenissuancecreate.html -parent: transaction-types.html -blurb: 新しいMulti-Purpose Tokenを発行します。 +seo: + description: 新しいMulti-Purpose Tokenを発行します。 labels: - Multi-Purpose Token, MPT --- diff --git a/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancedestroy.md b/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancedestroy.md index eb84a6fc52..3854289624 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancedestroy.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuancedestroy.md @@ -1,7 +1,6 @@ --- -html: mptokenissuancedestroy.html -parent: transaction-types.html -blurb: レジャーからMulti-Purpose Tokenを削除します。 +seo: + description: Multi-Purpose Tokenを削除します。 labels: - Multi-Purpose Token, MPT --- diff --git a/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuanceset.md b/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuanceset.md index 1e2f43877d..3486ced9fe 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuanceset.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/mptokenissuanceset.md @@ -1,7 +1,6 @@ --- -html: mptokenissuanceset.html -parent: transaction-types.html -blurb: MPTの変更可能なプロパティを設定します。 +seo: + description: MPTの変更可能なプロパティを設定します。 labels: - Multi-Purpose Token, MPT --- diff --git a/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md b/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md index 803125e5f2..aa0d54d18c 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md @@ -1,7 +1,6 @@ --- -html: oracledelete.html -parent: transaction-types.html -blurb: 既存の価格オラクルを削除します。 +seo: + description: 既存の価格オラクルを削除します。 labels: - オラクル --- diff --git a/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md b/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md index 80443e7a09..802e2b015e 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md @@ -1,7 +1,6 @@ --- -html: OracleSet.html -parent: transaction-types.html -blurb: 価格オラクルを作成または更新します。 +seo: + description: 価格オラクルを作成または更新します。 labels: - オラクル --- diff --git a/@theme/markdoc/components.tsx b/@theme/markdoc/components.tsx index bb9b470b3d..0535c5f484 100644 --- a/@theme/markdoc/components.tsx +++ b/@theme/markdoc/components.tsx @@ -20,7 +20,10 @@ export function IndexPageItems() { {data?.map((item: any) => (
  • {item.title} -

    {item.blurb}

    + { + item.status === "not_enabled" ? () : "" + } +

    {item.seo?.description}

    • ))} diff --git a/_code-samples/build-a-browser-wallet/js/yarn.lock b/_code-samples/build-a-browser-wallet/js/yarn.lock index dbc583c2dd..e45ffa38aa 100644 --- a/_code-samples/build-a-browser-wallet/js/yarn.lock +++ b/_code-samples/build-a-browser-wallet/js/yarn.lock @@ -830,12 +830,13 @@ set-function-length@^1.2.2: has-property-descriptors "^1.0.2" sha.js@^2.4.0, sha.js@^2.4.11, sha.js@^2.4.8: - version "2.4.11" - resolved "https://registry.yarnpkg.com/sha.js/-/sha.js-2.4.11.tgz#37a5cf0b81ecbc6943de109ba2960d1b26584ae7" - integrity sha512-QMEp5B7cftE7APOjk5Y6xgrbWu+WkLVQwk8JNjZ8nKRciZaByEW6MubieAiToS7+dwvrjGhH8jRXz3MVd0AYqQ== + version "2.4.12" + resolved "https://registry.yarnpkg.com/sha.js/-/sha.js-2.4.12.tgz#eb8b568bf383dfd1867a32c3f2b74eb52bdbf23f" + integrity sha512-8LzC5+bvI45BjpfXU8V5fdU2mfeKiQe1D1gIMn7XUlF3OTUrpdJpPPH4EMAnF0DsHHdSZqCdSss5qCmJKuiO3w== dependencies: - inherits "^2.0.1" - safe-buffer "^5.0.1" + inherits "^2.0.4" + safe-buffer "^5.2.1" + to-buffer "^1.2.0" source-map-js@^1.2.1: version "1.2.1" diff --git a/docs/_snippets/common-links.md b/docs/_snippets/common-links.md index dd12e812a7..de77e4d843 100644 --- a/docs/_snippets/common-links.md +++ b/docs/_snippets/common-links.md @@ -82,14 +82,15 @@ [DelegateSet transactions]: /docs/references/protocol/transactions/types/delegateset.md [DepositAuth amendment]: /resources/known-amendments.md#depositauth [DepositPreauth amendment]: /resources/known-amendments.md#depositpreauth -[DepositPreauth entry]: /docs/references/protocol/transactions/types/depositpreauth.md -[DepositPreauth object]: /docs/references/protocol/transactions/types/depositpreauth.md +[DepositPreauth entry]: /docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md +[DepositPreauth object]: /docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md [DepositPreauth transaction]: /docs/references/protocol/transactions/types/depositpreauth.md [DepositPreauth transactions]: /docs/references/protocol/transactions/types/depositpreauth.md [DepositPreauth]: /docs/references/protocol/transactions/types/depositpreauth.md [DIDSet transaction]: /docs/references/protocol/transactions/types/didset.md [DIDSet transactions]: /docs/references/protocol/transactions/types/didset.md [DIDSet]: /docs/references/protocol/transactions/types/didset.md +[DIDDelete transaction]: /docs/references/protocol/transactions/types/diddelete.md [DirectoryNode entry]: /docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md [DirectoryNode object]: /docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md [DisallowIncoming amendment]: /resources/known-amendments.md#disallowincoming @@ -99,8 +100,8 @@ [EnableAmendment]: /docs/references/protocol/transactions/pseudo-transaction-types/enableamendment.md [EnforceInvariants amendment]: /resources/known-amendments.md#enforceinvariants [Escrow amendment]: /resources/known-amendments.md#escrow -[Escrow entry]: /docs/concepts/payment-types/escrow.md -[Escrow object]: /docs/concepts/payment-types/escrow.md +[Escrow entry]: /docs/references/protocol/ledger-data/ledger-entry-types/escrow.md +[Escrow object]: /docs/references/protocol/ledger-data/ledger-entry-types/escrow.md [EscrowCancel transaction]: /docs/references/protocol/transactions/types/escrowcancel.md [EscrowCancel transactions]: /docs/references/protocol/transactions/types/escrowcancel.md [EscrowCancel]: /docs/references/protocol/transactions/types/escrowcancel.md @@ -194,6 +195,8 @@ [PermissionDelegation amendment]: /resources/known-amendments.md#permissiondelegation [PermissionedDEX amendment]: /resources/known-amendments.md#permissioneddex [Permissioned DEXes]: /docs/concepts/tokens/decentralized-exchange/permissioned-dexes.md +[PermissionedDomain entry]: /docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md +[PermissionedDomainDelete transaction]: /docs/references/protocol/transactions/types/permissioneddomaindelete.md [PermissionedDomainSet transaction]: /docs/references/protocol/transactions/types/permissioneddomainset.md [PermissionedDomainSetトランザクション]: /@l10n/ja/docs/references/protocol/transactions/types/permissioneddomainset.md [PermissionedDomains amendment]: /resources/known-amendments.md#permissioneddomains @@ -263,6 +266,7 @@ [XChainCreateClaimID transaction]: /docs/references/protocol/transactions/types/xchaincreateclaimid.md [XChainCreateClaimID transactions]: /docs/references/protocol/transactions/types/xchaincreateclaimid.md [XChainCreateClaimID]: /docs/references/protocol/transactions/types/xchaincreateclaimid.md +[XChainOwnedCreateAccountClaimID entry]: /docs/references/protocol/ledger-data/ledger-entry-types/xchainownedcreateaccountclaimid.md [XChainOwnedClaimID entry]: /docs/references/protocol/ledger-data/ledger-entry-types/xchainownedclaimid [XRP, in drops]: /docs/references/protocol/data-types/basic-data-types.md#specifying-currency-amounts [XRPFees amendment]: /resources/known-amendments.md#xrpfees diff --git a/docs/concepts/tokens/fungible-tokens/deep-freeze.md b/docs/concepts/tokens/fungible-tokens/deep-freeze.md index 346f7fb369..554393cbfa 100644 --- a/docs/concepts/tokens/fungible-tokens/deep-freeze.md +++ b/docs/concepts/tokens/fungible-tokens/deep-freeze.md @@ -1,5 +1,6 @@ --- -blurb: Deep Freeze ensures that frozen token holders can neither send nor receive frozen funds until their trust line is unfrozen. +seo: + description: Deep Freeze ensures that frozen token holders can neither send nor receive frozen funds until their trust line is unfrozen. labels: - Tokens - Freeze 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 ef66251d7e..9364e0dafa 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 @@ -1,9 +1,11 @@ --- -blurb: Get the holders for a given `MPTokenIssuanceID` and ledger sequence. +seo: + description: Get the holders of a given MPT issuance as of a given ledger. labels: - Accounts - XRP - Multi Purpose Tokens, MPTs +stautus: not_enabled --- # mpt_holders 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 4cedda9e6a..f984b88ca0 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 @@ -1,7 +1,6 @@ --- -html: get_aggregate_price.html -parent: ledger-methods.html -blurb: Calculates the aggregate price of specified Oracle instances. +seo: + description: Calculate the aggregate price of specified Oracle instances. labels: - Oracle --- 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 e5f119600f..2071868623 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/amendments.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/amendments.md @@ -1,6 +1,6 @@ --- seo: - description: Singleton ledger entry with status of enabled and pending amendments. + description: The status of enabled and pending amendments. labels: - Blockchain --- 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 1abe30791a..f7b8beda14 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/bridge.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/bridge.md @@ -1,6 +1,6 @@ --- seo: - description: A `bridge` object represents a single cross-chain bridge that connects and enables value to move efficiently between two blockchains. + description: A single cross-chain bridge that connects and enables value to move efficiently between two blockchains. labels: - Interoperability status: not_enabled 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 5e1a18f3ab..c4415c40bc 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/credential.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/credential.md @@ -1,6 +1,6 @@ --- seo: - description: An attestation about a subject account from a credential issuer account, which can be used to preauthorize payments. + description: A credential, which can be used to preauthorize payments or gain access to specific permissioned domains. status: not_enabled --- # Credential 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 3ef3f17828..ea0972566d 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md @@ -4,6 +4,7 @@ seo: labels: - Accounts - Permissions +status: not_enabled --- # Delegate [[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/include/xrpl/protocol/detail/ledger_entries.macro#L475-L482 "Source") @@ -65,4 +66,9 @@ There are no flags defined for {% code-page-name /%} entries. {% code-page-name /%} entries are not deletion blockers. If the owner (delegating) account is deleted, all such ledger entries are deleted along with them. However, the `Authorize` +## See Also + +- **Transactions:** + - [DelegateSet transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 169f020423..70d28486e2 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/depositpreauth.md @@ -109,4 +109,9 @@ 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. +## See Also + +- **Transactions** + - [DepositPreauth transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 e79a529dab..a1e332e423 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/did.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/did.md @@ -1,6 +1,6 @@ --- seo: - description: The definition and details of a Decentralized Identifier (DID). + description: A Decentralized Identifier (DID). labels: - DID --- @@ -61,4 +61,10 @@ The ID of a `DID` entry is the [SHA-512Half][] of the following values, concaten 1. The `DID` space key (`0x0049`). 2. The AccountID that controls the DID. +## See Also + +- **Transactions:** + - [DIDDelete transaction][] + - [DIDSet transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 671c5b64c7..445165156e 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/directorynode.md @@ -1,6 +1,6 @@ --- seo: - description: Contains links to other objects. + description: A set of links to other ledger entries, either objects owned by an account or trades in the decentralized exchange. labels: - Data Retention - Decentralized Exchange 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 99f9a42125..a6aca8706b 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/escrow.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/escrow.md @@ -1,6 +1,6 @@ --- seo: - description: Contains XRP held for a conditional payment. + description: An escrow, which holds funds to be released when certain conditions are met. labels: - Escrow --- @@ -74,4 +74,11 @@ The ID of an `Escrow` entry is the [SHA-512Half][] of the following values, conc * The Sequence number of the [EscrowCreate transaction][] that created the `Escrow` entry If the EscrowCreate transaction used a [Ticket](../../../../concepts/accounts/tickets.md), use the `TicketSequence` value instead. +## See Also + +- **Transactions:** + - [EscrowCancel transaction][] + - [EscrowCreate transaction][] + - [EscrowFinish transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 72faf11f90..acd00fb685 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/feesettings.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/feesettings.md @@ -1,6 +1,6 @@ --- seo: - description: Singleton object with consensus-approved base transaction cost and reserve requirements. + description: The current base transaction cost and reserve requirements. labels: - Fees --- diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/index.md b/docs/references/protocol/ledger-data/ledger-entry-types/index.md index eb58112d27..86d22d0293 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/index.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/index.md @@ -1,6 +1,6 @@ --- -html: ledger-entry-types.html -parent: ledger-data-formats.html +seo: + description: A list of all entry types that can exist in the ledger's state data. metadata: indexPage: true --- 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 5dec551fa1..2450f29d32 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md @@ -1,7 +1,9 @@ --- -blurb: Describes the XRPL multi-purpose token object. +seo: + description: Multi-Purpose Tokens (MPT) of one issuance held by a specific account. labels: - Multi-purpose Tokens, MPTs, Tokens +status: not_enabled --- # MPToken @@ -54,4 +56,8 @@ The ID of an `MPToken` entry is the [SHA-512Half][] of the following values, con - The `MPTokenIssuanceID` for the issuance being held. - The `AccountID` of the token holder. +## See Also + +- [MPTokenAuthorize transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md b/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md index 9e210a7c5a..26fd95fd3a 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md @@ -1,7 +1,9 @@ --- -blurb: The `MPTokenIssuance` object represents a single MPT issuance and holds data associated with the issuance itself. +seo: + description: Definition of a Multi-Purpose Token (MPT) issuance. labels: - Multi-purpose Tokens, MPTs, Tokens +status: not_enabled --- # MPTokenIssuance 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 eaf9cabc2c..8bace205d5 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/nftokenoffer.md @@ -1,6 +1,6 @@ --- seo: - description: Create offers to buy or sell NFTs. + description: An offer to buy or sell an NFT. labels: - Non-fungible Tokens, NFTs --- 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 22bd0f8773..4be17ab6a7 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md @@ -1,6 +1,6 @@ --- seo: - description: Ledger structure for recording NFTokens. + description: A group of up to 32 NFTs, stored together for efficiency. labels: - Non-fungible Tokens, NFTs --- 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 51cdabfd32..f22d9102e2 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/offer.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/offer.md @@ -1,6 +1,6 @@ --- seo: - description: An order to make a currency trade. + description: An offer (order) to trade currencies in the decentralized exchange. labels: - Decentralized Exchange --- 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 44325f5d17..59099547b2 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md @@ -1,6 +1,6 @@ --- seo: - description: A ledger entry to publish price information about currency pairs. + description: A record of price information about currency pairs from an outside source. labels: - Decentralized Exchange --- 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 b129e3ffe0..8b1bb72f18 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md @@ -1,6 +1,6 @@ --- seo: - description: A channel for asynchronous XRP payments. + description: A payment channel, which allows for rapid, asynchronous payments. labels: - Payment Channels --- 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 e217311f10..86e017078c 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md @@ -1,9 +1,10 @@ --- seo: - description: A PermissionedDomain ledger entry represents a Permissioned Domain, which is used to limit access to other features. + description: A permissioned domain, which is used to limit access to other features. labels: - Compliance - Permissioned Domains +status: not_enabled --- # PermissionedDomain [[Source]](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/detail/ledger_entries.macro#L451-L461 "Source") @@ -77,5 +78,10 @@ The ID of a {% code-page-name /%} entry is the [SHA-512Half][] of the following 0. The AccountID of the {% code-page-name /%}'s owner. 0. The Sequence number of the transaction that created the {% code-page-name /%}. +## See Also + +- **Transactions:** + - [PermissionedDomainDelete transaction][] + - [PermissionedDomainSet transaction][] {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/ripplestate.md b/docs/references/protocol/ledger-data/ledger-entry-types/ripplestate.md index 85afdb7fcb..d458930428 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/ripplestate.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/ripplestate.md @@ -1,6 +1,6 @@ --- seo: - description: This entry represents a trust line, tracking the net balance of tokens between them. + description: A trust line, which tracks the net balance of fungible tokens between two accounts. labels: - Tokens --- @@ -124,4 +124,9 @@ The ID of a RippleState entry is the [SHA-512Half][] of the following values, co * The AccountID of the high account * The 160-bit currency code of the trust line(s) +## See Also + +- **Transactions:** + - [TrustSet transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 acce6a35af..9c27354fe9 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md @@ -102,4 +102,9 @@ The ID of a `SignerList` entry is the SHA-512Half of the following values, conca * The AccountID of the owner of the signer list * The `SignerListID` (currently always `0`) +## See Also + +- **Transactions:** + - [SignerListSet transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 fdb6cbd34b..5f8b3ea304 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/ticket.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/ticket.md @@ -1,8 +1,6 @@ --- -html: ticket.html -parent: ledger-entry-types.html seo: - description: A Ticket tracks an account sequence number that has been set aside for future use. + description: A ticket, which sets aside a sequence number for use in a future transaction. labels: - Transaction Sending --- @@ -60,4 +58,9 @@ The ID of a Ticket object is the SHA-512Half of the following values, concatenat * The AccountID of the owner of the Ticket * The `TicketSequence` number of the Ticket +## See Also + +- **Transactions:** + - [TicketCreate transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 88d7c82b11..c825a829f8 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedclaimid.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedclaimid.md @@ -1,6 +1,6 @@ --- seo: - description: An `XChainOwnedClaimID` object represents *one* cross-chain transfer of value. + description: A cross-chain transfer of value. labels: - Interoperability status: not_enabled @@ -102,4 +102,9 @@ _(Requires the [XChainBridge amendment][] {% not-enabled /%})_ | `LockingChainDoor` | String | AccountID | Yes | The door account on the locking chain. | | `LockingChainIssue` | Issue | Issue | Yes | The asset that is locked and unlocked on the locking chain. | +## See Also + +- **Transactions:** + - [XChainCreateClaimID transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} 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 0559a0425d..27631b9328 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedcreateaccountclaimid.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/xchainownedcreateaccountclaimid.md @@ -1,6 +1,6 @@ --- seo: - description: The `XChainOwnedCreateAccountClaimID` ledger object is used to collect attestations for creating an account via a cross-chain transfer. + description: A record of attestations for creating an account via a cross-chain transfer. labels: - Interoperability status: not_enabled @@ -85,4 +85,9 @@ _(Requires the [XChainBridge amendment][] {% not-enabled /%})_ | `LockingChainDoor` | String | AccountID | Yes | The door account on the locking chain. | | `LockingChainIssue` | Issue | Issue | Yes | The asset that is locked and unlocked on the locking chain. | +## See Also + +- **Transactions:** + - [XChainAddAccountCreateAttestation transaction][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/common-fields.md b/docs/references/protocol/transactions/common-fields.md index 7ec6bdc52c..aa8dece2a6 100644 --- a/docs/references/protocol/transactions/common-fields.md +++ b/docs/references/protocol/transactions/common-fields.md @@ -1,6 +1,4 @@ --- -html: transaction-common-fields.html -parent: transaction-formats.html seo: description: These common fields can be provided on any XRP Ledger transaction. labels: diff --git a/docs/references/protocol/transactions/types/ammbid.md b/docs/references/protocol/transactions/types/ammbid.md index ca18e44278..723a0aa625 100644 --- a/docs/references/protocol/transactions/types/ammbid.md +++ b/docs/references/protocol/transactions/types/ammbid.md @@ -1,6 +1,4 @@ --- -html: ammbid.html -parent: transaction-types.html seo: description: Bid on an Automated Market Maker's auction slot, which grants a discounted fee. labels: diff --git a/docs/references/protocol/transactions/types/ammclawback.md b/docs/references/protocol/transactions/types/ammclawback.md index 0cd2785676..f4fca83bf1 100644 --- a/docs/references/protocol/transactions/types/ammclawback.md +++ b/docs/references/protocol/transactions/types/ammclawback.md @@ -1,3 +1,10 @@ +--- +seo: + description: Claw back tokens from a holder who has deposited your issued tokens into an Automated Market Maker pool. +labels: + - AMM + - Tokens +--- # AMMClawback [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMClawback.cpp "Source") diff --git a/docs/references/protocol/transactions/types/ammcreate.md b/docs/references/protocol/transactions/types/ammcreate.md index 04ebbdacd2..42aa0e48a0 100644 --- a/docs/references/protocol/transactions/types/ammcreate.md +++ b/docs/references/protocol/transactions/types/ammcreate.md @@ -1,6 +1,4 @@ --- -html: ammcreate.html -parent: transaction-types.html seo: description: Create a new Automated Market Maker for trading a given pair of assets. labels: diff --git a/docs/references/protocol/transactions/types/ammdelete.md b/docs/references/protocol/transactions/types/ammdelete.md index 58ab923612..dd95d3cb7a 100644 --- a/docs/references/protocol/transactions/types/ammdelete.md +++ b/docs/references/protocol/transactions/types/ammdelete.md @@ -1,8 +1,6 @@ --- -html: ammdelete.html -parent: transaction-types.html seo: - description: Delete an Automated Market Maker instance with an empty asset pool. + description: Delete an Automated Market Maker with an empty asset pool. labels: - AMM --- diff --git a/docs/references/protocol/transactions/types/ammdeposit.md b/docs/references/protocol/transactions/types/ammdeposit.md index e807b4a1eb..c9580979a0 100644 --- a/docs/references/protocol/transactions/types/ammdeposit.md +++ b/docs/references/protocol/transactions/types/ammdeposit.md @@ -1,6 +1,4 @@ --- -html: ammdeposit.html -parent: transaction-types.html seo: description: Deposit funds into an Automated Market Maker in exchange for LPTokens. labels: diff --git a/docs/references/protocol/transactions/types/ammvote.md b/docs/references/protocol/transactions/types/ammvote.md index e8915e5a5c..ad8a2a74a1 100644 --- a/docs/references/protocol/transactions/types/ammvote.md +++ b/docs/references/protocol/transactions/types/ammvote.md @@ -1,8 +1,6 @@ --- -html: ammvote.html -parent: transaction-types.html seo: - description: Vote on the trading fee for an Automated Market Maker instance. + description: Vote on the trading fee for an Automated Market Maker. labels: - AMM --- diff --git a/docs/references/protocol/transactions/types/ammwithdraw.md b/docs/references/protocol/transactions/types/ammwithdraw.md index b403fbd9bf..54740adb6e 100644 --- a/docs/references/protocol/transactions/types/ammwithdraw.md +++ b/docs/references/protocol/transactions/types/ammwithdraw.md @@ -1,8 +1,6 @@ --- -html: ammwithdraw.html -parent: transaction-types.html seo: - description: Return LPTokens into an Automated Market Maker in exchange for a share of the assets the pool holds. + description: Return LPTokens to an Automated Market Maker in exchange for a share of the assets the pool holds. labels: - AMM --- diff --git a/docs/references/protocol/transactions/types/checkcancel.md b/docs/references/protocol/transactions/types/checkcancel.md index d25ae436bf..b9f6017c93 100644 --- a/docs/references/protocol/transactions/types/checkcancel.md +++ b/docs/references/protocol/transactions/types/checkcancel.md @@ -1,6 +1,4 @@ --- -html: checkcancel.html -parent: transaction-types.html seo: description: Cancel a check. labels: diff --git a/docs/references/protocol/transactions/types/checkcash.md b/docs/references/protocol/transactions/types/checkcash.md index 4ce0565335..22369c466e 100644 --- a/docs/references/protocol/transactions/types/checkcash.md +++ b/docs/references/protocol/transactions/types/checkcash.md @@ -1,6 +1,4 @@ --- -html: checkcash.html -parent: transaction-types.html seo: description: Redeem a check. labels: diff --git a/docs/references/protocol/transactions/types/checkcreate.md b/docs/references/protocol/transactions/types/checkcreate.md index 8e0d6ea0f8..9bcd36d827 100644 --- a/docs/references/protocol/transactions/types/checkcreate.md +++ b/docs/references/protocol/transactions/types/checkcreate.md @@ -1,6 +1,4 @@ --- -html: checkcreate.html -parent: transaction-types.html seo: description: Create a check. labels: diff --git a/docs/references/protocol/transactions/types/delegateset.md b/docs/references/protocol/transactions/types/delegateset.md index a28af70af2..0e0caae4d6 100644 --- a/docs/references/protocol/transactions/types/delegateset.md +++ b/docs/references/protocol/transactions/types/delegateset.md @@ -1,6 +1,6 @@ --- seo: - description: An transaction that delegates a set of permissions to another account. + description: Grant another account permission to send some transactions for you, or revoke that permission. labels: - Accounts - Permissions @@ -73,5 +73,8 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} | `temDISABLED` | The [Permission Delegation amendment][] is not enabled. | | `temMALFORMED` | The transaction was invalid. For example, the `Authorize` account is the same as the sender of the transaction, the `Permissions` list contains duplicate entries, or one of the permissions in the list is not a valid permission. | +## See Also + +- [Delegate ledger entry][] {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/depositpreauth.md b/docs/references/protocol/transactions/types/depositpreauth.md index 790ae3acac..90743d9278 100644 --- a/docs/references/protocol/transactions/types/depositpreauth.md +++ b/docs/references/protocol/transactions/types/depositpreauth.md @@ -1,6 +1,6 @@ --- seo: - description: Preauthorizes an account to send payments to this one. + description: Preauthorize an account to send payments to you. labels: - Security --- @@ -89,5 +89,8 @@ In addition to error types that can occur for all transactions, DepositPreauth t | `temCANNOT_PREAUTH_SELF` | The address in the `Authorize` field is the sender of the transaction. You cannot preauthorize yourself. | | `temDISABLED` | A required amendment is not enabled. | +## See Also + +- [DepositPreauth object][] {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/diddelete.md b/docs/references/protocol/transactions/types/diddelete.md index cd39f960ba..3642120b70 100644 --- a/docs/references/protocol/transactions/types/diddelete.md +++ b/docs/references/protocol/transactions/types/diddelete.md @@ -1,8 +1,6 @@ --- -html: diddelete.html -parent: transaction-types.html seo: - description: Delete a DID. + description: Delete a Decentralized Identifier. labels: - DID --- @@ -39,4 +37,8 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} |:--------------------|:---------------------------------------------| | `tecNO_ENTRY` | The account doesn't have a DID. | +## See Also + +- [DID entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/didset.md b/docs/references/protocol/transactions/types/didset.md index ff3dc750db..beefaec6c2 100644 --- a/docs/references/protocol/transactions/types/didset.md +++ b/docs/references/protocol/transactions/types/didset.md @@ -1,6 +1,6 @@ --- seo: - description: Create or update a DID. + description: Create or update a Decentralized Identifier. labels: - DID --- @@ -48,4 +48,8 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} | `tecEMPTY_DID` | The transaction will create an empty DID ledger entry. Check that your updates don't remove the `Data`, `DIDDocument`, and `URI` fields. | | `temEMPTY_DID` | The transaction is malformed and missing any DID information. Include either the `Data`, `DIDDocument`, or `URI` fields. | +## See Also + +- [DID entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/escrowcancel.md b/docs/references/protocol/transactions/types/escrowcancel.md index b9a37e5c85..410ec8dada 100644 --- a/docs/references/protocol/transactions/types/escrowcancel.md +++ b/docs/references/protocol/transactions/types/escrowcancel.md @@ -1,6 +1,6 @@ --- seo: - description: Reclaim escrowed XRP. + description: Cancel an expired escrow, returning the funds to the sender. labels: - Escrow --- @@ -38,4 +38,8 @@ Any account may submit an EscrowCancel transaction. * If the corresponding [EscrowCreate transaction][] did not specify a `CancelAfter` time, the EscrowCancel transaction fails. * Otherwise the EscrowCancel transaction fails if the `CancelAfter` time is after the close time of the most recently-closed ledger. +## See Also + +- [Escrow entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/escrowcreate.md b/docs/references/protocol/transactions/types/escrowcreate.md index 646fa80af7..ba5b5d2c79 100644 --- a/docs/references/protocol/transactions/types/escrowcreate.md +++ b/docs/references/protocol/transactions/types/escrowcreate.md @@ -1,6 +1,6 @@ --- seo: - description: Create an escrowed XRP payment. + description: Escrow funds, which can be released to the destination after a specific time or condition. labels: - Escrow --- @@ -58,4 +58,8 @@ It is not possible to create a conditional escrow with no expiration, but you ca Before the [fix1571 amendment][] became enabled on 2018-06-19, it was possible to create an escrow with `CancelAfter` only. These escrows could be finished by anyone at any time before the specified expiration. {% /admonition %} +## See Also + +- [Escrow entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/escrowfinish.md b/docs/references/protocol/transactions/types/escrowfinish.md index 3b7e25fffd..6e18b18a5c 100644 --- a/docs/references/protocol/transactions/types/escrowfinish.md +++ b/docs/references/protocol/transactions/types/escrowfinish.md @@ -1,6 +1,6 @@ --- seo: - description: Deliver escrowed XRP to recipient. + description: Deliver escrowed funds to the intended recipient. labels: - Escrow --- @@ -49,4 +49,8 @@ Any account may submit an EscrowFinish transaction. In [non-production networks](../../../../concepts/networks-and-servers/parallel-networks.md), it may be possible [to delete](../../../../concepts/accounts/deleting-accounts.md) the destination account of a pending escrow. In this case, an attempt to finish the escrow fails with the result `tecNO_TARGET`, but the escrow object remains unless it has expired normally. If another payment re-creates the destination account, the escrow can be finished successfully. The destination account of an escrow can only be deleted if the escrow was created before the [fix1523 amendment](/resources/known-amendments.md#fix1523) became enabled. No such escrows exist in the production XRP Ledger, so this edge case is not possible on the production XRP Ledger. This edge case is also not possible in test networks that enable both fix1523 and Escrow amendments at the same time, which is the default when you [start a new genesis ledger](../../../../infrastructure/testing-and-auditing/start-a-new-genesis-ledger-in-stand-alone-mode.md). +## See Also + +- [Escrow entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/ledgerstatefix.md b/docs/references/protocol/transactions/types/ledgerstatefix.md index 375c2a0317..07bf92c2bf 100644 --- a/docs/references/protocol/transactions/types/ledgerstatefix.md +++ b/docs/references/protocol/transactions/types/ledgerstatefix.md @@ -1,6 +1,6 @@ --- seo: - description: Repair corruptions to the XRP ledger. + description: Repair corruptions to the XRP ledger's state data. labels: - Utilities - Troubleshooting diff --git a/docs/references/protocol/transactions/types/mptokenauthorize.md b/docs/references/protocol/transactions/types/mptokenauthorize.md index 26b188c1cd..60841dd0fa 100644 --- a/docs/references/protocol/transactions/types/mptokenauthorize.md +++ b/docs/references/protocol/transactions/types/mptokenauthorize.md @@ -1,7 +1,9 @@ --- -blurb: Allow an account to hold an amount of a particular MPT. +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 --- # MPTokenAuthorize @@ -30,4 +32,8 @@ Transactions of the MPTokenAuthorize type support additional values in the `Flag |:-------------------|:-------------|:--------------|:------------------------------| | `tfMPTUnauthorize` | `0x00000001` | 1 | When the holder enables this flag, if their balance of the given MPT is zero, it revokes their willingness to hold this MPT and deletes their `MPToken` entry. If their balance is non-zero, the transaction fails. When an issuer enables this flag, it revokes permission for the specified holder to hold this MPT; the transaction fails if the MPT does not use allow-listing. | +## See Also + +- [MPToken entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/mptokenissuancecreate.md b/docs/references/protocol/transactions/types/mptokenissuancecreate.md index 47f8805719..8211cb3497 100644 --- a/docs/references/protocol/transactions/types/mptokenissuancecreate.md +++ b/docs/references/protocol/transactions/types/mptokenissuancecreate.md @@ -1,7 +1,9 @@ --- -blurb: Issue a new Multi-purpose Token. +seo: + description: Define the properties of a new Multi-Purpose Token (MPT). labels: - Multi-purpose Tokens, MPTs +status: not_enabled --- # MPTokenIssuanceCreate diff --git a/docs/references/protocol/transactions/types/mptokenissuancedestroy.md b/docs/references/protocol/transactions/types/mptokenissuancedestroy.md index 2444c38958..0242c45713 100644 --- a/docs/references/protocol/transactions/types/mptokenissuancedestroy.md +++ b/docs/references/protocol/transactions/types/mptokenissuancedestroy.md @@ -1,7 +1,9 @@ --- -blurb: Remove a Multi-purpose Token from the ledger. +seo: + description: Delete a Multi-Purpose Token definition. labels: - Multi-purpose Tokens, MPTs +status: not_enabled --- # MPTokenIssuanceDestroy [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceDestroy.cpp "Source") diff --git a/docs/references/protocol/transactions/types/mptokenissuanceset.md b/docs/references/protocol/transactions/types/mptokenissuanceset.md index dda812c325..f8117b9dd9 100644 --- a/docs/references/protocol/transactions/types/mptokenissuanceset.md +++ b/docs/references/protocol/transactions/types/mptokenissuanceset.md @@ -1,7 +1,9 @@ --- -blurb: Set mutable properties for an MPT. +seo: + description: Set mutable properties of a Multi-Purpose Token definition. labels: - - Multi-purpose Tokens, MPTs + - Multi-purpose Tokens, MPTs +status: not_enabled --- # MPTokenIssuanceSet [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceSet.cpp "Source") @@ -14,15 +16,13 @@ _(Requires the [MPTokensV1 amendment][] {% not-enabled /%}.)_ ```json { - "TransactionType": "MPTokenIssuanceSet", - "Fee": "10", - "MPTokenIssuanceID": "00070C4495F14B0E44F78A264E41713C64B5F89242540EE255534400000000000000", - "Flags": 1 + "TransactionType": "MPTokenIssuanceSet", + "Fee": "10", + "MPTokenIssuanceID": "00070C4495F14B0E44F78A264E41713C64B5F89242540EE255534400000000000000", + "Flags": 1 } ``` - - {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} | Field | JSON Type | [Internal Type][] | Required? | Description | diff --git a/docs/references/protocol/transactions/types/nftokenburn.md b/docs/references/protocol/transactions/types/nftokenburn.md index 2113d0a009..17c4263283 100644 --- a/docs/references/protocol/transactions/types/nftokenburn.md +++ b/docs/references/protocol/transactions/types/nftokenburn.md @@ -1,8 +1,6 @@ --- -html: nftokenburn.html -parent: transaction-types.html seo: - description: Use TokenBurn to permanently destroy NFTs. + description: Permanently destroy an NFT. labels: - Non-fungible Tokens, NFTs --- diff --git a/docs/references/protocol/transactions/types/nftokencanceloffer.md b/docs/references/protocol/transactions/types/nftokencanceloffer.md index c68ce911cd..088cd19961 100644 --- a/docs/references/protocol/transactions/types/nftokencanceloffer.md +++ b/docs/references/protocol/transactions/types/nftokencanceloffer.md @@ -1,8 +1,6 @@ --- -html: nftokencanceloffer.html -parent: transaction-types.html seo: - description: Cancel existing token offers to buy or sell an NFToken. + description: Cancel offers to buy or sell an NFT. labels: - NFTs, Non-fungible Tokens --- diff --git a/docs/references/protocol/transactions/types/nftokencreateoffer.md b/docs/references/protocol/transactions/types/nftokencreateoffer.md index 5bcfeed8e8..dce51f18d5 100644 --- a/docs/references/protocol/transactions/types/nftokencreateoffer.md +++ b/docs/references/protocol/transactions/types/nftokencreateoffer.md @@ -1,10 +1,8 @@ --- -html: nftokencreateoffer.html -parent: transaction-types.html seo: - description: Create an offer to buy or sell NFTs. + description: Create an offer to buy or sell an NFT. labels: - - Non-fungible Tokens, NFTs + - Non-fungible Tokens, NFTs --- # NFTokenCreateOffer [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCreateOffer.cpp "Source") @@ -19,11 +17,11 @@ _(Added by the [NonFungibleTokensV1_1 amendment][].)_ ```json { - "TransactionType": "NFTokenCreateOffer", - "Account": "rs8jBmmfpwgmrSPgwMsh7CvKRmRt1JTVSX", - "NFTokenID": "000100001E962F495F07A990F4ED55ACCFEEF365DBAA76B6A048C0A200000007", - "Amount": "1000000", - "Flags": 1 + "TransactionType": "NFTokenCreateOffer", + "Account": "rs8jBmmfpwgmrSPgwMsh7CvKRmRt1JTVSX", + "NFTokenID": "000100001E962F495F07A990F4ED55ACCFEEF365DBAA76B6A048C0A200000007", + "Amount": "1000000", + "Flags": 1 } ``` diff --git a/docs/references/protocol/transactions/types/nftokenmint.md b/docs/references/protocol/transactions/types/nftokenmint.md index 72f75eae2b..ab975403ea 100644 --- a/docs/references/protocol/transactions/types/nftokenmint.md +++ b/docs/references/protocol/transactions/types/nftokenmint.md @@ -1,6 +1,6 @@ --- seo: - description: Use TokenMint to issue new NFTs. + description: Mint a Non-Fungible Token (NFT). labels: - Non-fungible Tokens, NFTs --- diff --git a/docs/references/protocol/transactions/types/nftokenmodify.md b/docs/references/protocol/transactions/types/nftokenmodify.md index e751ff2f97..d742e8c8d5 100644 --- a/docs/references/protocol/transactions/types/nftokenmodify.md +++ b/docs/references/protocol/transactions/types/nftokenmodify.md @@ -3,8 +3,6 @@ seo: description: Modify a dynamic NFT. labels: - Non-fungible Tokens, NFTs -title: - - NFTokenModify --- # NFTokenModify [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenModify.cpp "Source") diff --git a/docs/references/protocol/transactions/types/offercancel.md b/docs/references/protocol/transactions/types/offercancel.md index 2843bfb72b..9277e2b0b6 100644 --- a/docs/references/protocol/transactions/types/offercancel.md +++ b/docs/references/protocol/transactions/types/offercancel.md @@ -1,8 +1,6 @@ --- -html: offercancel.html -parent: transaction-types.html seo: - description: Withdraw a currency-exchange order. + description: Withdraw an offer to trade in the decentralized exchange. labels: - Decentralized Exchange --- diff --git a/docs/references/protocol/transactions/types/offercreate.md b/docs/references/protocol/transactions/types/offercreate.md index 59c6b89378..7a6c9783db 100644 --- a/docs/references/protocol/transactions/types/offercreate.md +++ b/docs/references/protocol/transactions/types/offercreate.md @@ -1,6 +1,6 @@ --- seo: - description: Submit an order to exchange currency. + description: Offer to trade currencies in the decentralized exchange; create a limit order. labels: - Decentralized Exchange --- diff --git a/docs/references/protocol/transactions/types/oracledelete.md b/docs/references/protocol/transactions/types/oracledelete.md index cb63191cf3..cdfb6a5a13 100644 --- a/docs/references/protocol/transactions/types/oracledelete.md +++ b/docs/references/protocol/transactions/types/oracledelete.md @@ -1,7 +1,6 @@ --- -html: oracledelete.html -parent: transaction-types.html -blurb: Delete an existing price oracle. +seo: + description: Delete a price oracle. labels: - Oracle --- diff --git a/docs/references/protocol/transactions/types/oracleset.md b/docs/references/protocol/transactions/types/oracleset.md index 16169606ee..1453b6447f 100644 --- a/docs/references/protocol/transactions/types/oracleset.md +++ b/docs/references/protocol/transactions/types/oracleset.md @@ -1,7 +1,6 @@ --- -html: OracleSet.html -parent: transaction-types.html -blurb: Create or update an existing price oracle. +seo: + description: Create or update a price oracle. labels: - Oracle --- diff --git a/docs/references/protocol/transactions/types/payment.md b/docs/references/protocol/transactions/types/payment.md index 2c9703bd59..0745eb2ab9 100644 --- a/docs/references/protocol/transactions/types/payment.md +++ b/docs/references/protocol/transactions/types/payment.md @@ -1,6 +1,6 @@ --- seo: - description: Send funds from one account to another. + description: Send funds to another account, convert between currencies, or create a new account by sending it XRP. labels: - Payments - XRP diff --git a/docs/references/protocol/transactions/types/paymentchannelclaim.md b/docs/references/protocol/transactions/types/paymentchannelclaim.md index 7967dd6626..e148708d0b 100644 --- a/docs/references/protocol/transactions/types/paymentchannelclaim.md +++ b/docs/references/protocol/transactions/types/paymentchannelclaim.md @@ -1,8 +1,6 @@ --- -html: paymentchannelclaim.html -parent: transaction-types.html seo: - description: Claim money from a payment channel. + description: Claim funds from a payment channel. labels: - Payment Channels --- diff --git a/docs/references/protocol/transactions/types/paymentchannelfund.md b/docs/references/protocol/transactions/types/paymentchannelfund.md index 2acdb18456..6ad7e0c127 100644 --- a/docs/references/protocol/transactions/types/paymentchannelfund.md +++ b/docs/references/protocol/transactions/types/paymentchannelfund.md @@ -1,8 +1,6 @@ --- -html: paymentchannelfund.html -parent: transaction-types.html seo: - description: Add more XRP to a payment channel. + description: Add more funds to a payment channel. labels: - Payment Channels --- diff --git a/docs/references/protocol/transactions/types/permissioneddomaindelete.md b/docs/references/protocol/transactions/types/permissioneddomaindelete.md index abd8f90964..a7947a9518 100644 --- a/docs/references/protocol/transactions/types/permissioneddomaindelete.md +++ b/docs/references/protocol/transactions/types/permissioneddomaindelete.md @@ -1,6 +1,6 @@ --- seo: - description: Delete a Permissioned Domain entry from the ledger. + description: Delete a permissioned domain. labels: - Compliance - Permissioned Domains @@ -45,4 +45,8 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} | `tecNO_ENTRY` | The permissioned domain specified in the `DomainID` field doesn't exist in the ledger. | | `temDISABLED` | The `PermissionedDomains` amendment is not enabled. | +## See Also + +- [PermissionedDomain entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/permissioneddomainset.md b/docs/references/protocol/transactions/types/permissioneddomainset.md index a0ebc3bdf2..7734a92cac 100644 --- a/docs/references/protocol/transactions/types/permissioneddomainset.md +++ b/docs/references/protocol/transactions/types/permissioneddomainset.md @@ -1,6 +1,6 @@ --- seo: - description: Create or update a Permissioned Domain. + description: Create or update a permissioned domain. labels: - Compliance - Permissioned Domains @@ -61,5 +61,8 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} | `tecNO_PERMISSION` | The transaction attempted to modify an existing Domain, but the sender of the transaction is not the owner of the specified Domain. | | `temDISABLED` | Either the `PermissionedDomains` amendment is not enabled, or the `Credentials` amendment is not enabled. | +## See Also + +- [PermissionedDomain entry][] {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/setregularkey.md b/docs/references/protocol/transactions/types/setregularkey.md index 16829f8346..ff3b7c0bf3 100644 --- a/docs/references/protocol/transactions/types/setregularkey.md +++ b/docs/references/protocol/transactions/types/setregularkey.md @@ -1,6 +1,4 @@ --- -html: setregularkey.html -parent: transaction-types.html seo: description: Add, remove, or modify an account's regular key pair. labels: diff --git a/docs/references/protocol/transactions/types/signerlistset.md b/docs/references/protocol/transactions/types/signerlistset.md index 121a9c6286..2f1124e88c 100644 --- a/docs/references/protocol/transactions/types/signerlistset.md +++ b/docs/references/protocol/transactions/types/signerlistset.md @@ -1,6 +1,4 @@ --- -html: signerlistset.html -parent: transaction-types.html seo: description: Add, remove, or modify an account's multi-signing list. labels: @@ -64,4 +62,8 @@ You cannot remove the last method of signing transactions from an account. If an Creating or replacing a signer list enables the `lsfOneOwnerCount` flag on the [SignerList object](../../ledger-data/ledger-entry-types/signerlist.md). Lists that were created before the [MultiSignReserve amendment][] became enabled do not have this flag and have a higher [owner reserve](../../../../concepts/accounts/reserves.md#owner-reserves). You can decrease the owner reserve for these lists by replacing the list with the same list. For more information, see [SignerList Flags](../../ledger-data/ledger-entry-types/signerlist.md#signerlist-flags). +## See Also + +- [SignerList entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/ticketcreate.md b/docs/references/protocol/transactions/types/ticketcreate.md index 42757d43ed..a6c7e93dfa 100644 --- a/docs/references/protocol/transactions/types/ticketcreate.md +++ b/docs/references/protocol/transactions/types/ticketcreate.md @@ -1,8 +1,6 @@ --- -html: ticketcreate.html -parent: transaction-types.html seo: - description: Set aside one or more sequence numbers as Tickets. + description: Set aside one or more sequence numbers as tickets. labels: - Transaction Sending --- @@ -49,4 +47,8 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} | `tecDIR_FULL` | This transaction would cause the account to own more than the limit of 250 Tickets at a time, or more than the maximum number of ledger objects in general. | | `tecINSUFFICIENT_RESERVE` | The sending account does not have enough XRP to meet the [owner reserve](../../../../concepts/accounts/reserves.md) of all the requested Tickets. | +## See Also + +- [Ticket entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/trustset.md b/docs/references/protocol/transactions/types/trustset.md index 90b7a2541c..9d3eaf627e 100644 --- a/docs/references/protocol/transactions/types/trustset.md +++ b/docs/references/protocol/transactions/types/trustset.md @@ -1,6 +1,4 @@ --- -html: trustset.html -parent: transaction-types.html seo: description: Add or modify a trust line. labels: @@ -65,4 +63,8 @@ If a transaction tries to enable No Ripple but cannot, it fails with the result The Auth flag of a trust line does not determine whether the trust line counts towards its owner's XRP reserve requirement. An issuer can pre-authorize a trust line with the `tfSetfAuth` flag only, even if the limit and balance of the trust line are 0. +## See Also + +- [RippleState entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md b/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md index 9186da7c37..994233e481 100644 --- a/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md +++ b/docs/references/protocol/transactions/types/xchainaccountcreatecommit.md @@ -1,8 +1,6 @@ --- -html: xchainaccountcreatecommit.html -parent: transaction-types.html seo: - description: Create an account on one of the chains that the bridge connects. This account serves as the bridge entrance for that chain. + description: Create an account on another chain to serve as a door account for a cross-chain bridge. labels: - Interoperability status: not_enabled diff --git a/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md b/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md index ddfab812f0..d4b7b3033d 100644 --- a/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md +++ b/docs/references/protocol/transactions/types/xchainaddaccountcreateattestation.md @@ -1,8 +1,6 @@ --- -html: xchainaddaccountcreateattestation.html -parent: transaction-types.html seo: - description: The `XChainAddAccountCreateAttestation` transaction provides an attestation from a witness server that a `XChainAccountCreateCommit` transaction occurred on the other chain. + description: Provide an attestation that an XChainAccountCreateCommit transaction occurred on another chain, for a cross-chain bridge. labels: - Interoperability status: not_enabled @@ -78,4 +76,8 @@ Any account can submit signatures. | `LockingChainDoor` | String | AccountID | Yes | The door account on the locking chain. | | `LockingChainIssue` | Issue | Issue | Yes | The asset that is locked and unlocked on the locking chain. | +## See Also + +- [XChainOwnedCreateAccountClaimID entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/xchainaddclaimattestation.md b/docs/references/protocol/transactions/types/xchainaddclaimattestation.md index d17829567b..7c2b6725f0 100644 --- a/docs/references/protocol/transactions/types/xchainaddclaimattestation.md +++ b/docs/references/protocol/transactions/types/xchainaddclaimattestation.md @@ -1,8 +1,6 @@ --- -html: xchainaddclaimattestation.html -parent: transaction-types.html seo: - description: Submit proof (attestation) to the destination chain that an event that happened on the source chain. + description: Provide an attestation that an XChainCommit transaction occurred on another chain, for a cross-chain bridge. labels: - Interoperability status: not_enabled diff --git a/docs/references/protocol/transactions/types/xchainclaim.md b/docs/references/protocol/transactions/types/xchainclaim.md index e6e529aa03..fadd466b48 100644 --- a/docs/references/protocol/transactions/types/xchainclaim.md +++ b/docs/references/protocol/transactions/types/xchainclaim.md @@ -1,6 +1,4 @@ --- -html: xchainclaim.html -parent: transaction-types.html seo: description: Complete a cross-chain transfer of value by claiming the value on the destination chain. labels: diff --git a/docs/references/protocol/transactions/types/xchaincommit.md b/docs/references/protocol/transactions/types/xchaincommit.md index 2cda732751..bf4e995078 100644 --- a/docs/references/protocol/transactions/types/xchaincommit.md +++ b/docs/references/protocol/transactions/types/xchaincommit.md @@ -1,8 +1,6 @@ --- -html: xchaincommit.html -parent: transaction-types.html seo: - description: Initiate a cross-chain transfer of value. + description: Start a cross-chain transfer of value. labels: - Interoperability status: not_enabled diff --git a/docs/references/protocol/transactions/types/xchaincreatebridge.md b/docs/references/protocol/transactions/types/xchaincreatebridge.md index fb5d0e55cb..477a469ac0 100644 --- a/docs/references/protocol/transactions/types/xchaincreatebridge.md +++ b/docs/references/protocol/transactions/types/xchaincreatebridge.md @@ -1,6 +1,4 @@ --- -html: xchaincreatebridge.html -parent: transaction-types.html seo: description: Create a bridge between two chains. labels: diff --git a/docs/references/protocol/transactions/types/xchaincreateclaimid.md b/docs/references/protocol/transactions/types/xchaincreateclaimid.md index e6d1256094..597b5aa757 100644 --- a/docs/references/protocol/transactions/types/xchaincreateclaimid.md +++ b/docs/references/protocol/transactions/types/xchaincreateclaimid.md @@ -1,6 +1,4 @@ --- -html: xchaincreateclaimid.html -parent: transaction-types.html seo: description: Create a cross-chain claim ID that is used for a cross-chain transfer. labels: @@ -59,4 +57,8 @@ It also includes the account on the source chain that locks or burns the funds o | `LockingChainDoor` | String | Account | Yes | The door account on the locking chain. | | `LockingChainIssue` | Issue | Issue | Yes | The asset that is locked and unlocked on the locking chain. | +## See Also + +- [XChainOwnedClaimID entry][] + {% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/protocol/transactions/types/xchainmodifybridge.md b/docs/references/protocol/transactions/types/xchainmodifybridge.md index 9904e862ca..05dcd604f4 100644 --- a/docs/references/protocol/transactions/types/xchainmodifybridge.md +++ b/docs/references/protocol/transactions/types/xchainmodifybridge.md @@ -1,8 +1,6 @@ --- -html: xchainmodifybridge.html -parent: transaction-types.html seo: - description: Modify the parameters of a bridge. + description: Modify the parameters of a cross-chain bridge. labels: - Interoperability status: not_enabled