Improve consistency of descriptions in frontmatter

This commit is contained in:
mDuo13
2025-08-15 13:19:49 -07:00
parent 94686086ee
commit 468c8d3a47
87 changed files with 124 additions and 171 deletions

View File

@@ -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
---

View File

@@ -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

View File

@@ -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

View File

@@ -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")

View File

@@ -1,6 +1,6 @@
---
seo:
description: The definition and details of a Decentralized Identifier (DID).
description: A Decentralized Identifier (DID).
labels:
- DID
---

View File

@@ -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

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -1,6 +1,6 @@
---
html: ledger-entry-types.html
parent: ledger-data-formats.html
seo:
description: A list of all types of entry that can exist in the ledger's state data.
metadata:
indexPage: true
---

View File

@@ -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

View File

@@ -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

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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")

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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

View File

@@ -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

View File

@@ -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:

View File

@@ -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:

View File

@@ -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")

View File

@@ -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:

View File

@@ -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
---

View File

@@ -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:

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -1,6 +1,4 @@
---
html: checkcancel.html
parent: transaction-types.html
seo:
description: Cancel a check.
labels:

View File

@@ -1,6 +1,4 @@
---
html: checkcash.html
parent: transaction-types.html
seo:
description: Redeem a check.
labels:

View File

@@ -1,6 +1,4 @@
---
html: checkcreate.html
parent: transaction-types.html
seo:
description: Create a check.
labels:

View File

@@ -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

View File

@@ -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
---

View File

@@ -1,8 +1,6 @@
---
html: diddelete.html
parent: transaction-types.html
seo:
description: Delete a DID.
description: Delete a Decentralized Identifier.
labels:
- DID
---

View File

@@ -1,6 +1,6 @@
---
seo:
description: Create or update a DID.
description: Create or update a Decentralized Identifier.
labels:
- DID
---

View File

@@ -1,6 +1,6 @@
---
seo:
description: Reclaim escrowed XRP.
description: Cancel an expired escrow, returning the funds to the sender.
labels:
- Escrow
---

View File

@@ -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
---

View File

@@ -1,6 +1,6 @@
---
seo:
description: Deliver escrowed XRP to recipient.
description: Deliver escrowed funds to the intended recipient.
labels:
- Escrow
---

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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")

View File

@@ -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
}
```
<!-- ## MPTokenIssuanceSet Fields -->
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
| Field | JSON Type | [Internal Type][] | Required? | Description |

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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
}
```

View File

@@ -1,6 +1,6 @@
---
seo:
description: Use TokenMint to issue new NFTs.
description: Mint a Non-Fungible Token (NFT).
labels:
- Non-fungible Tokens, NFTs
---

View File

@@ -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")

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -1,6 +1,6 @@
---
seo:
description: Send funds from one account to another.
description: Send funds from one account to another; or convert funds between currencies, sending to the same account; or create a new account by sending it XRP.
labels:
- Payments
- XRP

View File

@@ -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
---

View File

@@ -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
---

View File

@@ -1,6 +1,6 @@
---
seo:
description: Delete a Permissioned Domain entry from the ledger.
description: Delete a permissioned domain.
labels:
- Compliance
- Permissioned Domains

View File

@@ -1,6 +1,6 @@
---
seo:
description: Create or update a Permissioned Domain.
description: Create or update a permissioned domain.
labels:
- Compliance
- Permissioned Domains

View File

@@ -1,6 +1,4 @@
---
html: setregularkey.html
parent: transaction-types.html
seo:
description: Add, remove, or modify an account's regular key pair.
labels:

View File

@@ -1,6 +1,4 @@
---
html: signerlistset.html
parent: transaction-types.html
seo:
description: Add, remove, or modify an account's multi-signing list.
labels:

View File

@@ -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
---

View File

@@ -1,6 +1,4 @@
---
html: trustset.html
parent: transaction-types.html
seo:
description: Add or modify a trust line.
labels:

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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:

View File

@@ -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

View File

@@ -1,6 +1,4 @@
---
html: xchaincreatebridge.html
parent: transaction-types.html
seo:
description: Create a bridge between two chains.
labels:

View File

@@ -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:

View File

@@ -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