mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-04 11:55:50 +00:00
Improve consistency of transaction reference docs
This commit is contained in:
mDuo13
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Delete an account.
|
||||
labels:
|
||||
- Accounts
|
||||
- Accounts
|
||||
---
|
||||
# AccountDelete
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteAccount.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Set options on an account.
|
||||
labels:
|
||||
- Accounts
|
||||
- Accounts
|
||||
---
|
||||
# AccountSet
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetAccount.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Bid on an Automated Market Maker's auction slot, which grants a discounted fee.
|
||||
labels:
|
||||
- AMM
|
||||
- AMM
|
||||
---
|
||||
# AMMBid
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMBid.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Create and submit a batch of up to 8 transactions that succeed or fail atomically.
|
||||
labels:
|
||||
- Transaction Sending
|
||||
- Transaction Sending
|
||||
status: not_enabled
|
||||
---
|
||||
# Batch
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Cancel a check.
|
||||
labels:
|
||||
- Checks
|
||||
- Checks
|
||||
---
|
||||
# CheckCancel
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CancelCheck.cpp "Source")
|
||||
@@ -24,7 +24,6 @@ Cancels an unredeemed [check](../../../../concepts/payment-types/checks.md), rem
|
||||
|
||||
{% tx-example txid="D3328000315C6DCEC1426E4E549288E3672752385D86A40D56856DBD10382953" /%}
|
||||
|
||||
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Description |
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Redeem a check.
|
||||
labels:
|
||||
- Checks
|
||||
- Checks
|
||||
---
|
||||
# CheckCash
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CashCheck.cpp "Source")
|
||||
@@ -27,7 +27,6 @@ Since the funds for a check are not guaranteed, redeeming a check can fail becau
|
||||
|
||||
{% tx-example txid="67B71B13601CDA5402920691841AC27A156463678E106FABD45357175F9FF406" /%}
|
||||
|
||||
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Description |
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Create a check.
|
||||
labels:
|
||||
- Checks
|
||||
- Checks
|
||||
---
|
||||
# CheckCreate
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateCheck.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Claw back tokens you've issued.
|
||||
labels:
|
||||
- Tokens
|
||||
- Tokens
|
||||
---
|
||||
# Clawback
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Clawback.cpp "Source")
|
||||
|
||||
@@ -23,8 +23,7 @@ Accept a [credential](../../../../concepts/decentralized-storage/credentials.md)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## CredentialAccept Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
In addition to the [common fields][], CredentialAccept transactions use the following fields:
|
||||
|
||||
|
||||
@@ -23,8 +23,7 @@ Provisionally issue a [credential](../../../../concepts/decentralized-storage/cr
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## CredentialCreate Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
In addition to the [common fields][], CredentialCreate transactions use the following fields:
|
||||
|
||||
|
||||
@@ -23,8 +23,7 @@ Remove a [credential](../../../../concepts/decentralized-storage/credentials.md)
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## CredentialDelete Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
In addition to the [common fields][], CredentialDelete transactions use the following fields:
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Preauthorize an account to send payments to you.
|
||||
labels:
|
||||
- Security
|
||||
- Security
|
||||
---
|
||||
# DepositPreauth
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DepositPreauth.cpp "Source")
|
||||
@@ -51,7 +51,6 @@ Grant preauthorization to send payments to your account. This is only useful if
|
||||
|
||||
{% tx-example txid="CB1BF910C93D050254C049E9003DA1A265C107E0C8DE4A7CFF55FADFD39D5656" /%}
|
||||
|
||||
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
---
|
||||
html: transaction-types.html
|
||||
parent: transaction-formats.html
|
||||
seo:
|
||||
description: All the different types of transactions that the XRP Ledger can process.
|
||||
metadata:
|
||||
indexPage: true
|
||||
indexPage: true
|
||||
labels:
|
||||
- Blockchain
|
||||
- Blockchain
|
||||
---
|
||||
# Transaction Types
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Accept an offer to buy or sell an NFT.
|
||||
labels:
|
||||
- NFTs, Non-fungible Tokens
|
||||
- NFTs, Non-fungible Tokens
|
||||
---
|
||||
# NFTokenAcceptOffer
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenAcceptOffer.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Permanently destroy an NFT.
|
||||
labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
- Non-fungible Tokens, NFTs
|
||||
---
|
||||
# NFTokenBurn
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenBurn.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Cancel offers to buy or sell an NFT.
|
||||
labels:
|
||||
- NFTs, Non-fungible Tokens
|
||||
- NFTs, Non-fungible Tokens
|
||||
---
|
||||
# NFTokenCancelOffer
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCancelOffer.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
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")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Mint a Non-Fungible Token (NFT).
|
||||
labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
- Non-fungible Tokens, NFTs
|
||||
---
|
||||
# NFTokenMint
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenMint.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Cancel an offer to trade in the decentralized exchange.
|
||||
labels:
|
||||
- Decentralized Exchange
|
||||
- Decentralized Exchange
|
||||
---
|
||||
# OfferCancel
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Offer to trade currencies in the decentralized exchange; create a limit order.
|
||||
labels:
|
||||
- Decentralized Exchange
|
||||
- Decentralized Exchange
|
||||
---
|
||||
# OfferCreate
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateOffer.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Delete a price oracle.
|
||||
labels:
|
||||
- Oracle
|
||||
- Oracle
|
||||
---
|
||||
# OracleDelete
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteOracle.cpp "Source")
|
||||
@@ -22,8 +22,7 @@ Delete a [price oracle](../../../../concepts/decentralized-storage/price-oracles
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## OracleDelete Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | Internal Type | Required? | Description |
|
||||
|--------------------|-----------|---------------|-----------|-------------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Create or update a price oracle.
|
||||
labels:
|
||||
- Oracle
|
||||
- Oracle
|
||||
---
|
||||
# OracleSet
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetOracle.cpp "Source")
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
seo:
|
||||
description: Send funds to another account, convert between currencies, or create a new account by sending it XRP.
|
||||
labels:
|
||||
- Payments
|
||||
- XRP
|
||||
- Cross-Currency
|
||||
- Tokens
|
||||
- Payments
|
||||
- XRP
|
||||
- Cross-Currency
|
||||
- Tokens
|
||||
---
|
||||
# Payment
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Payment.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Claim funds from a payment channel.
|
||||
labels:
|
||||
- Payment Channels
|
||||
- Payment Channels
|
||||
---
|
||||
# PaymentChannelClaim
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PayChan.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Open a new payment channel.
|
||||
labels:
|
||||
- Payment Channels
|
||||
- Payment Channels
|
||||
---
|
||||
# PaymentChannelCreate
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PayChan.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Add more funds to a payment channel.
|
||||
labels:
|
||||
- Payment Channels
|
||||
- Payment Channels
|
||||
---
|
||||
# PaymentChannelFund
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PayChan.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Add, remove, or modify an account's multi-signing list.
|
||||
labels:
|
||||
- Security
|
||||
- Security
|
||||
---
|
||||
# SignerListSet
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetSignerList.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Set aside one or more sequence numbers as tickets.
|
||||
labels:
|
||||
- Transaction Sending
|
||||
- Transaction Sending
|
||||
---
|
||||
# TicketCreate
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateTicket.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Add or modify a trust line.
|
||||
labels:
|
||||
- Tokens
|
||||
- Tokens
|
||||
---
|
||||
# TrustSet
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetTrust.cpp "Source")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Create an account on another chain to serve as a door account for a cross-chain bridge.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainAccountCreateCommit
|
||||
@@ -38,7 +38,7 @@ Create a new account for a [witness server](../../../../concepts/xrpl-sidechains
|
||||
```
|
||||
|
||||
|
||||
## XChainAccountCreateCommit Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:------------------|:--------------------|:------------------|:----------| :-----------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Provide an attestation that an XChainAccountCreateCommit transaction occurred on another chain, for a cross-chain bridge.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainAddAccountCreateAttestation
|
||||
@@ -49,7 +49,7 @@ Any account can submit signatures.
|
||||
```
|
||||
|
||||
|
||||
## XChainAddAccountCreateAttestation Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:---------------------------|:--------------------|:------------------|:----------|:------------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Provide an attestation that an XChainCommit transaction occurred on another chain, for a cross-chain bridge.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainAddClaimAttestation
|
||||
@@ -69,7 +69,7 @@ Any account can submit signatures.
|
||||
```
|
||||
|
||||
|
||||
## XChainAddClaimAttestation Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:---------------------------|:--------------------|:------------------|:----------|-------------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Complete a cross-chain transfer of value by claiming the value on the destination chain.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainClaim
|
||||
@@ -37,7 +37,7 @@ If the transaction succeeds in moving funds, the referenced `XChainOwnedClaimID`
|
||||
```
|
||||
|
||||
|
||||
## XChainClaim Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:------------------------|:--------------------|:------------------|:----------|-------------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Start a cross-chain transfer of value.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainCommit
|
||||
@@ -37,7 +37,7 @@ Do the second step in a [cross-chain transfer](../../../../concepts/xrpl-sidecha
|
||||
```
|
||||
|
||||
|
||||
## XChainCommit Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:------------------------|:--------------------|:------------------|:----------|-------------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Create a bridge between two chains.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainCreateBridge
|
||||
@@ -40,7 +40,7 @@ The complete production-grade setup would also include a `SignerListSet` transac
|
||||
```
|
||||
|
||||
|
||||
## XChainCreateBridge Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:-------------------------|:--------------------|:------------------|:----------|:------------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Create a cross-chain claim ID that is used for a cross-chain transfer.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainCreateClaimID
|
||||
@@ -38,7 +38,7 @@ It also includes the account on the source chain that locks or burns the funds o
|
||||
```
|
||||
|
||||
|
||||
## XChainCreateClaimID Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:-------------------|:---------------------|:------------------|:----------|-------------|
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
seo:
|
||||
description: Modify the parameters of a cross-chain bridge.
|
||||
labels:
|
||||
- Interoperability
|
||||
- Interoperability
|
||||
status: not_enabled
|
||||
---
|
||||
# XChainModifyBridge
|
||||
@@ -38,7 +38,7 @@ This transaction must be sent by the door account and requires the entities that
|
||||
```
|
||||
|
||||
|
||||
## XChainModifyBridge Fields
|
||||
{% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%}
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Required? | Description |
|
||||
|:-------------------------|:--------------------|:------------------|:----------|-------------|
|
||||
|
||||
Reference in New Issue
Block a user