Compare commits

...

9 Commits

Author SHA1 Message Date
mDuo13
d37f82ab34 [JA] fix frontmatter of AccountDelete 2026-04-28 18:06:38 -07:00
mDuo13
3f9a2afe04 Re-generate CSS for tx type landings 2026-04-28 18:03:29 -07:00
mDuo13
fb83c3cea5 [JA] Revise tx type index to use automatic categories 2026-04-28 18:03:09 -07:00
mDuo13
9561262a25 Revise tx type index to use automatic categories 2026-04-28 18:02:50 -07:00
mDuo13
b67fb1f6a0 [JA] Update tx type metadata for use on index page 2026-04-28 18:01:56 -07:00
mDuo13
61e7216488 Update transaction type metadata for use on index page 2026-04-28 18:00:59 -07:00
mDuo13
9a42a41688 Add styles for TxRefs components 2026-04-28 18:00:00 -07:00
mDuo13
eb8b9b543c Reorg components & impl. TxRef component 2026-04-28 17:59:03 -07:00
rachelflynn
d28b5dbffb Revised transaction types landing page 2026-04-23 11:09:13 -04:00
158 changed files with 1019 additions and 389 deletions

View File

@@ -2,7 +2,9 @@
seo:
description: アカウントの削除
labels:
- アカウント
- Accounts
requiredAmendment: DeletableAccounts
txIcon: cancel
---
# AccountDelete
@@ -10,7 +12,7 @@ labels:
AccountDeleteトランザクションは、XRP Ledgerで[アカウント](../../ledger-data/ledger-entry-types/accountroot.md)と、アカウントが所有するオブジェクトを削除し、可能であれば、アカウントの残りのXRPを指定された送金先アカウントに送信します。アカウントを削除する要件については、[アカウントの削除](../../../../concepts/accounts/deleting-accounts.md)をご覧ください。
_[DeletableAccounts Amendment][]が必要です。_
{% amendment-disclaimer name="DeletableAccounts" /%}
## {% $frontmatter.seo.title %} JSONの例

View File

@@ -2,7 +2,8 @@
seo:
description: XRP Ledgerのアカウントのプロパティーを修正します。
labels:
- アカウント
- Accounts
txIcon: modify
---
# AccountSet

View File

@@ -1,10 +1,11 @@
---
html: ammbid.html
parent: transaction-types.html
seo:
description: 自動マーケットメーカーのオークションスロットに入札することで、手数料の割引を受けることができます。
labels:
- AMM
- AMM
- DEX
requiredAmendment: AMM
txIcon: modify
---
# AMMBid
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMBid.cpp "Source")

View File

@@ -2,8 +2,10 @@
seo:
description: 自動マーケットメーカープールに発行済みトークンを預け入れた保有者から、トークンを回収する。
labels:
- AMM
- Tokens
- AMM
- DEX
requiredAmendment: AMMClawback
txIcon: cancel
---
# AMMClawback

View File

@@ -4,7 +4,10 @@ parent: transaction-types.html
seo:
description: 指定された資産ペアを取引するための新しい自動マーケットメーカーを作成します。
labels:
- AMM
- AMM
- DEX
requiredAmendment: AMM
txIcon: create
---
# AMMCreate
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMCreate.cpp "Source")

View File

@@ -1,10 +1,11 @@
---
html: ammdelete.html
parent: transaction-types.html
seo:
description: 空のプールを持つ自動マーケットメーカーのインスタンスを削除します。
labels:
- AMM
- AMM
- DEX
requiredAmendment: AMM
txIcon: cancel
---
# AMMDelete
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDelete.cpp "Source")

View File

@@ -4,7 +4,10 @@ parent: transaction-types.html
seo:
description: 自動マーケットメーカーに資金を預け、LPTokenを受け取ります。
labels:
- AMM
- AMM
- DEX
requiredAmendment: AMM
txIcon: send
---
# AMMDeposit
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDeposit.cpp "Source")

View File

@@ -4,7 +4,10 @@ parent: transaction-types.html
seo:
description: 自動マーケットメーカーインスタンスの取引手数料へ投票する。
labels:
- AMM
- AMM
- DEX
requiredAmendment: AMM
txIcon: modify
---
# AMMVote
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMVote.cpp "Source")

View File

@@ -4,7 +4,10 @@ parent: transaction-types.html
seo:
description: LPトークを自動マーケットメーカーに返却し、プールが保有する資産の一部と引き換えマス。
labels:
- AMM
- AMM
- DEX
requiredAmendment: AMM
txIcon: send
---
# AMMWithdraw
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMWithdraw.cpp "Source")

View File

@@ -2,15 +2,19 @@
seo:
description: 最大8件のトランザクションをまとめて作成・送信し、それらがすべて成功するか、すべて失敗するようにアトミックに処理されるようにします。
labels:
- Batch
- Transaction Sending
- Transaction Sending
- Other Transactions
requiredAmendment: Batch
status: not_enabled
txIcon: other
---
# Batch
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Batch.cpp "Source")
`Batch`トランザクションは、最大8つのトランザクションを単一のバッチで送信します。各トランザクションは、4つのモード(全て成功または全て失敗All or Nothing、一つのみ成功Only One、失敗まで継続Until Failure、および独立実行Independent)のいずれかでアトミックに実行されます。
{% amendment-disclaimer name="Batch" /%}
## {% $frontmatter.seo.title %} JSONの例
### 単一アカウントの場合

View File

@@ -1,17 +1,18 @@
---
html: checkcancel.html
parent: transaction-types.html
seo:
description: 未清算のCheckを取り消し、送金を行わずにレジャーから削除します。
labels:
- Checks
- Checks
- Payments
requiredAmendment: Checks
txIcon: cancel
---
# CheckCancel
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CancelCheck.cpp "Source")
未清算のCheckを取り消し、送金を行わずにレジャーから削除します。Checkの送金元または送金先は、いつでもこのトランザクションタイプを使用してCheckを取り消すことができます。有効期限切れのCheckはすべてのアドレスが取り消すことができます。
_[Checks Amendment][]が必要です_
{% amendment-disclaimer name="Checks" /%}
## {% $frontmatter.seo.title %} JSONの例

View File

@@ -1,10 +1,11 @@
---
html: checkcash.html
parent: transaction-types.html
seo:
description: レジャーでCheckオブジェクトの清算を試みます。
labels:
- Checks
- Checks
- Payments
requiredAmendment: Checks
txIcon: finish
---
# CheckCash
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CashCheck.cpp "Source")
@@ -13,7 +14,7 @@ labels:
Checkに相当する資金があるとは保証されないため、送金元に十分な残高がないか、または資金を送金できるだけの十分な流動性がないことが原因で、Checkの清算が失敗することがあります。このような状況が発生した場合、Checkはレジャーに残り、送金先は後でこのCheckの換金を再試行するか、または異なる額で換金を試みることができます。
_[Checks Amendment][]が必要です_
{% amendment-disclaimer name="Checks" /%}
## {% $frontmatter.seo.title %} JSONの例

View File

@@ -1,17 +1,18 @@
---
html: checkcreate.html
parent: transaction-types.html
seo:
description: レジャーにCheckオブジェクトを作成します
labels:
- Checks
- Checks
- Payments
requiredAmendment: Checks
txIcon: create
---
# CheckCreate
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateCheck.cpp "Source")
レジャーにCheckオブジェクトを作成します。これにより指定の送金先は後日換金することができます。このトランザクションの送信者はCheckの送金元です。
_[Checks Amendment][]が必要です_
{% amendment-disclaimer name="Checks" /%}
## {% $frontmatter.seo.title %} JSONの例

View File

@@ -2,7 +2,9 @@
seo:
description: 発行したトークンを取り戻します。
labels:
- トークン
- Tokens
requiredAmendment: Clawback
txIcon: cancel
---
# Clawback

View File

@@ -1,12 +1,18 @@
---
seo:
description: アカウントに仮発行された資格情報を承認します。
status: not_enabled
labels:
- Decentralized Storage
- Credentials
requiredAmendment: Credentials
txIcon: finish
---
# CredentialAccept
CredentialAcceptトランザクションは資格情報を承認し、その資格情報を有効にします。資格情報の対象者のみがこの操作を実行できます。
{% amendment-disclaimer name="Credentials" /%}
## CredentialAccept JSONの例
```json

View File

@@ -1,13 +1,19 @@
---
seo:
description: アカウントに対して暫定的に資格情報を発行します。
status: not_enabled
labels:
- Decentralized Storage
- Credentials
requiredAmendment: Credentials
txIcon: create
---
# CredentialCreate
CredentialCreateトランザクションは、レジャーにCredentialを作成します。Credential(資格情報)の発行者はこのトランザクションを使用して、暫定的に資格情報を発行します。Credentialは、その対象アカウントが[CredentialAcceptトランザクション][]で承認するまで有効になりません。
{% amendment-disclaimer name="Credentials" /%}
## CredentialCreate JSONの例
```json

View File

@@ -1,7 +1,11 @@
---
seo:
description: レジャーから認証情報を削除し、事実上失効させます。
status: not_enabled
labels:
- Decentralized Storage
- Credentials
requiredAmendment: Credentials
txIcon: cancel
---
# CredentialDelete

View File

@@ -2,7 +2,10 @@
seo:
description: DepositPreauthトランザクションは別のアカウントに対し、このトランザクションの送信者に支払いを送金することを事前承認します。
labels:
- セキュリティ
- Accounts
- Security
requiredAmendment: DepositPreauth
txIcon: modify
---
# DepositPreauth
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DepositPreauth.cpp "Source")

View File

@@ -1,21 +1,20 @@
---
html: diddelete.html
parent: transaction-types.html
seo:
description: DIDを削除する。
labels:
- DID
- DID
- Decentralized Storage
requiredAmendment: DID
txIcon: cancel
---
# DIDDelete
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "ソース")
_([DID Amendment][])_
指定した`Account`フィールドに関連付けられている[DIDレジャーエントリ](../../ledger-data/ledger-entry-types/did.md)を削除します。
{% admonition type="info" name="注記" %}このトランザクションは[共通フィールド][]のみ利用します。{% /admonition %}
{% amendment-disclaimer name="DID" /%}
## {% $frontmatter.seo.title %} JSONの例

View File

@@ -1,19 +1,18 @@
---
html: didset.html
parent: transaction-types.html
seo:
description: DIDを作成または更新します。
labels:
- DID
- DID
- Decentralized Storage
requiredAmendment: DID
txIcon: create
---
# DIDSet
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "ソース")
_([DID Amendment][])_
新しい[DIDレジャーエントリ](../../ledger-data/ledger-entry-types/did.md)を作成したり、既存の項目を更新したりします。
{% amendment-disclaimer name="DID" /%}
## {% $frontmatter.seo.title %} JSONの例

View File

@@ -3,6 +3,9 @@ seo:
description: Escrowに留保されているXRPを送金元に返金します。
labels:
- Escrow
- Payments
requiredAmendment: Escrow
txIcon: cancel
---
# EscrowCancel
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")

View File

@@ -3,6 +3,9 @@ seo:
description: Escrowプロセスが終了または取り消されるまでXRPを隔離します。
labels:
- Escrow
- Payments
requiredAmendment: Escrow
txIcon: create
---
# EscrowCreate
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")

View File

@@ -3,6 +3,9 @@ seo:
description: エスクローされたXRPを受取人へ送金します。
labels:
- Escrow
- Payments
requiredAmendment: Escrow
txIcon: finish
---
# EscrowFinish
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")

View File

@@ -1,22 +1,40 @@
---
html: transaction-types.html
parent: transaction-formats.html
seo:
description: トランザクションのタイプは、どういったタイプの操作を実行することが想定されているのかを示します。
metadata:
indexPage: true
indexPage: true
labels:
- ブロックチェーン
- ブロックチェーン
---
# トランザクションのタイプ
トランザクションのタイプ(`TransactionType`フィールド)は、トランザクションに関する最も基本的な情報です。トランザクションで、どういったタイプの操作を実行することが想定されているのかを示します。
トランザクションのタイプ(`TransactionType`フィールド)は、どういったタイプの操作を実行することが想定されているのかを示します。すべてのトランザクションに、[共通フィールド](../common-fields.md)が含まれています。
すべてのトランザクションに、特定の共通フィールドが含まれています。
## アカウント
* [共通フィールド](../common-fields.md)
{% tx-category name="Accounts" /%}
トランザクションのタイプごとに、実行される操作のタイプに関連した追加のフィールドが含まれています。
## 支払い
{% tx-category name="Payments" /%}
## トークン
{% tx-category name="Tokens" /%}
## 分散型取引所DEX
{% tx-category name="DEX" /%}
## 分散型ストレージ
{% tx-category name="Decentralized Storage" /%}
## XRPLサイドチェーン
{% tx-category name="Interoperability" /%}
## その他
{% tx-category name="Other Transactions" /%}
{% child-pages /%}

View File

@@ -2,9 +2,11 @@
seo:
description: アカウントが特定のMPTの残高を保持することを許可します。
labels:
- Multi-Purpose Token, MPT
- Multi-purpose Tokens, MPTs
- Tokens
requiredAmendment: MPTokensV1
txIcon: modify
---
# MPTokenAuthorize
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenAuthorize.cpp "ソース")

View File

@@ -2,7 +2,10 @@
seo:
description: 新しいMulti-Purpose Tokenを発行します。
labels:
- Multi-Purpose Token, MPT
- Multi-purpose Tokens, MPTs
- Tokens
requiredAmendment: MPTokensV1
txIcon: create
---
# MPTokenIssuanceCreate

View File

@@ -2,7 +2,10 @@
seo:
description: Multi-Purpose Tokenを削除します。
labels:
- Multi-Purpose Token, MPT
- Multi-purpose Tokens, MPTs
- Tokens
requiredAmendment: MPTokensV1
txIcon: cancel
---
# MPTokenIssuanceDestroy
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceDestroy.cpp "ソース")

View File

@@ -2,7 +2,10 @@
seo:
description: MPTの変更可能なプロパティを設定します。
labels:
- Multi-Purpose Token, MPT
- Multi-purpose Tokens, MPTs
- Tokens
requiredAmendment: MPTokensV1
txIcon: modify
---
# MPTokenIssuanceSet
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceSet.cpp "ソース")

View File

@@ -2,7 +2,11 @@
seo:
description: NFTokenの購入または売却のオファーを受け入れる。
labels:
- NFT, 非代替性トークン
- Non-fungible Tokens, NFTs
- Tokens
- DEX
requiredAmendment: NonFungibleTokensV1_1
txIcon: finish
---
# NFTokenAcceptOffer
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenAcceptOffer.cpp "ソース")

View File

@@ -1,10 +1,11 @@
---
html: nftokenburn.html
parent: transaction-types.html
seo:
description: TokenBurnを使用して、NFTを永久に破棄します。
labels:
- 非代替性トークン, NFT
- Non-fungible Tokens, NFTs
- Tokens
requiredAmendment: NonFungibleTokensV1_1
txIcon: cancel
---
# NFTokenBurn

View File

@@ -1,10 +1,12 @@
---
html: nftokencanceloffer.html
parent: transaction-types.html
seo:
description: NFTokenの売買のための既存のトークンへのオファーをキャンセルする。
labels:
- NFT, 非代替性トークン
- Non-fungible Tokens, NFTs
- Tokens
- DEX
requiredAmendment: NonFungibleTokensV1_1
txIcon: cancel
---
# NFTokenCancelOffer
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCancelOffer.cpp "ソース")

View File

@@ -1,10 +1,12 @@
---
html: nftokencreateoffer.html
parent: transaction-types.html
seo:
description: NFTの売買のオファーを作成する。
labels:
- 非代替性トークン, NFT
- Non-fungible Tokens, NFTs
- Tokens
- DEX
requiredAmendment: NonFungibleTokensV1_1
txIcon: create
---
# NFTokenCreateOffer
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCreateOffer.cpp "ソース")

View File

@@ -2,7 +2,10 @@
seo:
description: NFTokenMintを使用して新規NFTを発行する。
labels:
- 非代替性トークン, NFT
- Non-fungible Tokens, NFTs
- Tokens
requiredAmendment: NonFungibleTokensV1_1
txIcon: create
---
# NFTokenMint
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenMint.cpp "Source")

View File

@@ -2,15 +2,18 @@
seo:
description: ダイナミックNFTを変更します。
labels:
- 非代替性トークン, トークン, NFT
title:
- NFTokenModify
- Non-fungible Tokens, NFTs
- Tokens
requiredAmendment: DynamicNFT
txIcon: modify
---
# NFTokenModify
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenModify.cpp "ソース")
`NFTokenModify`は、NFTの`URI`フィールドを別のURIに変更し、NFTのサポートデータを更新するために使用されます。NFTは、`tfMutable`フラグが設定された状態でミントされている必要があります。[ダイナミックNFT](../../../../concepts/tokens/nfts/dynamic-nfts.md)をご覧ください。
{% amendment-disclaimer name="DynamicNFT" /%}
## {% $frontmatter.seo.title %} JSONの例

View File

@@ -1,16 +1,15 @@
---
html: offercancel.html
parent: transaction-types.html
seo:
description: XRP LedgerからOfferオブジェクトを削除します。
description: 分散型取引所からオファーを削除します。
labels:
- 分散型取引所
- DEX
txIcon: cancel
---
# OfferCancel
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CancelOffer.cpp "Source")
OfferCancelトランザクションは、XRP LedgerからOfferオブジェクトを削除します。
[分散型取引所](../../../../concepts/tokens/decentralized-exchange/index.md)からオファーを削除します。
## {% $frontmatter.seo.title %}のJSONの例

View File

@@ -2,10 +2,10 @@
seo:
description: 通貨交換の注文を作成します。
labels:
- 分散型取引所
- DEX
txIcon: create
---
# OfferCreate
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateOffer.cpp "ソース")
OfferCreateトランザクションは[分散型取引所](../../../../concepts/tokens/decentralized-exchange/index.md)で[注文](../../../../concepts/tokens/decentralized-exchange/offers.md)を作成します。

View File

@@ -2,15 +2,17 @@
seo:
description: 既存の価格オラクルを削除します。
labels:
- オラクル
- Oracle
- Decentralized Storage
requiredAmendment: PriceOracle
txIcon: cancel
---
# OracleDelete
_([PriceOracle Amendment][])_
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteOracle.cpp "ソース")
既存の`Oracle`レジャーエントリを削除します。
{% amendment-disclaimer name="PriceOracle" /%}
## OracleDeleteのJSONの例

View File

@@ -2,15 +2,17 @@
seo:
description: 価格オラクルを作成または更新します。
labels:
- オラクル
- Oracle
- Decentralized Storage
requiredAmendment: PriceOracle
txIcon: create
---
# OracleSet
_([PriceOracle Amendment][])_
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetOracle.cpp "ソース")
Oracle Document ID を使用して、新しい`Oracle`レジャーエントリを作成するか、既存のフィールドを更新します。
{% amendment-disclaimer name="PriceOracle" /%}
## OracleSetのJSONの例

View File

@@ -1,11 +1,12 @@
---
seo:
description: アカウント間での価値の移動します。
description: アカウント間での価値の移動します、またはアカウントを作成する
labels:
- 支払い
- XRP
- クロスカレンシー
- トークン
- Accounts
- Payments
- XRP
- Cross-Currency
txIcon: send
---
# Payment
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Payment.cpp "ソース")

View File

@@ -2,7 +2,10 @@
seo:
description: Payment Channelに対しXRPを請求します。
labels:
- Payment Channel
- Payment Channels
- Payments
requiredAmendment: PayChan
txIcon: finish
---
# PaymentChannelClaim
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PayChan.cpp "Source")

View File

@@ -2,7 +2,10 @@
seo:
description: 新しいペイメントチャネルを作成します。
labels:
- Payment Channel
- Payment Channels
- Payments
requiredAmendment: PayChan
txIcon: create
---
# PaymentChannelCreate
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PayChan.cpp "ソース")

View File

@@ -2,7 +2,10 @@
seo:
description: Payment ChannelにXRPを追加します。
labels:
- Payment Channel
- Payment Channels
- Payments
requiredAmendment: PayChan
txIcon: modify
---
# PaymentChannelFund
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PayChan.cpp "Source")

View File

@@ -2,15 +2,18 @@
seo:
description: 許可型ドメインのレジャーエントリを削除する
labels:
- コンプライアンス
- 許可型ドメイン
- Compliance
- Permissioned Domains
- Decentralized Storage
requiredAmendment: PermissionedDomains
txIcon: cancel
---
# PermissionedDomainDelete
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PermissionedDomainDelete.cpp "ソース")
所有する[許可型ドメイン][]を削除します。
_([PermissionedDomains amendment][]が必要です {% not-enabled /%})_
{% amendment-disclaimer name="PermissionedDomains" /%}
## {% $frontmatter.seo.title %}のJSONの例

View File

@@ -2,15 +2,18 @@
seo:
description: 許可型ドメインを作成または更新する
labels:
- コンプライアンス
- 許可型ドメイン
- Compliance
- Permissioned Domains
- Decentralized Storage
requiredAmendment: PermissionedDomains
txIcon: create
---
# PermissionedDomainSet
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/PermissionedDomainSet.cpp "ソース")
[許可型ドメイン][]を作成するか、所有するドメインを変更します。
_([PermissionedDomains amendment][]が必要です {% not-enabled /%})_
{% amendment-disclaimer name="PermissionedDomains" /%}
## {% $frontmatter.seo.title %}のJSONの例

View File

@@ -1,10 +1,10 @@
---
html: setregularkey.html
parent: transaction-types.html
seo:
description: アカウントに関連付けられているレギュラーキーペアの割り当て、変更、削除を行います。
labels:
- セキュリティ
- Security
- Accounts
txIcon: modify
---
# SetRegularKey
@@ -29,7 +29,6 @@ labels:
{% tx-example txid="6AA6F6EAAAB56E65F7F738A9A2A8A7525439D65BA990E9BA08F6F4B1C2D349B4" /%}
{% raw-partial file="/@l10n/ja/docs/_snippets/tx-fields-intro.md" /%}
<!--{# fix md highlighting_ #}-->
| フィールド | JSONの型 | [内部の型][] | 説明 |
|:-------------|:----------|:------------------|:------------------------------|

View File

@@ -1,17 +1,19 @@
---
html: signerlistset.html
parent: transaction-types.html
seo:
description: トランザクションのマルチシグに使用できる署名者のリストを作成、置換、削除します。
labels:
- セキュリティ
- Security
- Accounts
requiredAmendment: MultiSign
txIcon: modify
---
# SignerListSet
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetSignerList.cpp "ソース")
SignerListSetトランザクションは、トランザクションの[マルチシグ](../../../../concepts/accounts/multi-signing.md)に使用できる署名者のリストを作成、置換、削除します。このトランザクションタイプは[MultiSign Amendment][]により導入されました。
{% amendment-disclaimer name="MultiSign" /%}
## {% $frontmatter.seo.title %}のJSONの例
```json

View File

@@ -1,19 +1,19 @@
---
html: ticketcreate.html
parent: transaction-types.html
seo:
description: チケットとして1つ以上のシーケンス番号を確保する。
labels:
- Transaction Sending
- Transaction Sending
- Accounts
requiredAmendment: TicketBatch
txIcon: create
---
# TicketCreate
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateTicket.cpp "Source")
_([TicketBatch amendment][]が必要です)_
TicketCreateトランザクションは、1つまたは複数の[シーケンス番号](../../data-types/basic-data-types.md#アカウントシーケンス)を[Tickets](../../ledger-data/ledger-entry-types/ticket.md)として確保します。
{% amendment-disclaimer name="TicketBatch" /%}
## {% $frontmatter.seo.title %}JSONの例
```json
@@ -28,9 +28,6 @@ TicketCreateトランザクションは、1つまたは複数の[シーケンス
{% tx-example txid="738AEF36B48CA4A2D85C2B74910DC34DDBBCA4C83643F2DB84A58785ED5AD3E3" /%}
{% raw-partial file="/@l10n/ja/docs/_snippets/tx-fields-intro.md" /%}
<!--{# fix md highlighting_ #}-->
| フィールド | JSONの型 | [内部の型][] | 説明 |
|:-----------------|:-----------------|:------------------|:-------------------|
| `TicketCount` | 数値 | UInt32 | 作成するチケットの枚数。これは正の数でなければならず、このトランザクションの実行の結果、アカウントが250枚以上のチケットを所有することはできません。 |

View File

@@ -1,13 +1,11 @@
---
html: trustset.html
parent: transaction-types.html
seo:
description: トラストラインを作成または変更します。
labels:
- トークン
- Tokens
txIcon: modify
---
# TrustSet
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetTrust.cpp "Source")
2つのアカウントをリンクする[トラストライン](../../../../concepts/tokens/fungible-tokens/index.md)を作成または変更します。

View File

@@ -1,23 +1,20 @@
---
html: xchainaccountcreatecommit.html
parent: transaction-types.html
seo:
description: ブリッジが接続するチェーンの一つでアカウントを作成します。このアカウントがそのチェーンのブリッジの入り口となります。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: create
---
# XChainAccountCreateCommit
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L466-L474 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
このトランザクションはXRP-XRPブリッジにのみ使用できます。
`XChainAccountCreateCommit`トランザクションは、発行チェーンにトランザクションを送信するために、Witnessサーバ用の新しいアカウントを作成します。
発行チェーンにトランザクションを送信するために、Witnessサーバ用の新しいアカウントを作成します。このトランザクションはXRP-XRPブリッジにのみ使用できます。
{% admonition type="warning" name="注意" %}このトランザクションは、Witnessの証明書が送信先チェーンに確実に送信される場合にのみ実行されるべきです。署名が送信されない場合、証明書が受信されるまでアカウント作成はブロックされます。XRP-XRPブリッジでこのトランザクションを無効にするには、ブリッジの`MinAccountCreateAmount`フィールドを省略します。{% /admonition %}
{% amendment-disclaimer name="XChainBridge" /%}
## XChainAccountCreateCommit JSONの例

View File

@@ -1,18 +1,16 @@
---
html: xchainaddaccountcreateattestation.html
parent: transaction-types.html
seo:
description: XChainAddAccountCreateAttestationトランザクションは他のチェーンでXChainAccountCreateCommitトランザクションが発生した証明をWitnessサーバから提示します。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: create
---
# XChainAddAccountCreateAttestation
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L447-L464 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
`XChainAddAccountCreateAttestation`トランザクションは、`XChainAccountCreateCommit`トランザクションがもう一方のチェーンで発生したというWitnessサーバからの証明を提示します。
`XChainAccountCreateCommit`トランザクションがもう一方のチェーンで発生したというWitnessサーバからの証明を提示します。
この署名は署名が提供された時点のドアの署名者リストにある鍵の一つでなければなりません。署名が提出されてから定足数に達するまでの間に署名者リストが変更された場合、新しい署名セットが使用され、現在収集されている署名の一部が削除される可能性があります。
@@ -20,6 +18,7 @@ _[XChainBridge Amendment][] {% not-enabled /%} が必要です_
{% admonition type="info" name="注記" %}報酬は現在のリストにある鍵を持っているアカウントにのみ送られます。署名者の定足数は`SignatureReward`に一致する必要があります。より大きな報酬を得ようとして、一つのWitnessサーバがこの値に不正な値を指定することはできません。{% /admonition %}
{% amendment-disclaimer name="XChainBridge" /%}
## XChainAddAccountCreateAttestation JSONの例

View File

@@ -1,18 +1,16 @@
---
html: xchainaddclaimattestation.html
parent: transaction-types.html
seo:
description: 送信元チェーンで発生したイベントを、送信先チェーンに証明(アテスト)します。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: modify
---
# XChainAddClaimAttestation
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L429-L445 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
`XChainAddClaimAttestation`トランザクションは`XChainCommit`トランザクションを証明するWitnessサーバの署名を提供します。
`XChainCommit`トランザクションを証明するWitnessサーバの署名を提供します。
この署名は、署名が提出された時点のドアの署名者リストにある鍵の一つでなければなりません。ただし、署名が提出されてから定足数に達するまでの間に署名者リストが変更された場合は、新しい署名セットが使用され、現在収集されている署名の一部が削除されることがあります。
@@ -20,6 +18,7 @@ _[XChainBridge Amendment][] {% not-enabled /%} が必要です_
{% admonition type="info" name="注記" %}報酬は現在のリストにある鍵を持っているアカウントにのみ送られます。署名者の定足数は`SignatureReward`に一致する必要があります。より大きな報酬を得ようとして、一つのWitnessサーバがこの値に不正な値を指定することはできません。{% /admonition %}
{% amendment-disclaimer name="XChainBridge" /%}
## XChainAddClaimAttestation JSONの例

View File

@@ -1,21 +1,20 @@
---
html: xchainclaim.html
parent: transaction-types.html
seo:
description: 送信先チェーンで金額を請求することで、クロスチェーンでの価値移転を完了させます。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: finish
---
# XChainClaim
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L418-L427 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
`XChainClaim`トランザクションはクロスチェーンでの価値の移転を完了させます。`XChainClaim`トランザクションにより、ユーザは送信元チェーンでロックされた価値と同等の価値を送信先チェーンで請求することができます。ユーザは、送金元チェーンでロックされた価値に関連付けられたクロスチェーン請求ID`Account`フィールド)を所有している場合にのみ、その価値を請求することができます。ユーザは誰にでも資金を送ることができます(`Destination`フィールド)。このトランザクションが必要になるのは`XChainCommit`トランザクションで`OtherChainDestination`が指定されていない場合、または自動送金で何か問題が発生した場合のみです。
トランザクションによって送金に成功すると、対象の`XChainOwnedClaimID`レジャーオブジェクトは削除されます。これはトランザクションのリプレイを防ぎます。トランザクションが失敗した場合、`XChainOwnedClaimID`は削除されず、異なるパラメータでトランザクションを再実行できます。
{% amendment-disclaimer name="XChainBridge" /%}
## XChainClaim JSONの例

View File

@@ -1,19 +1,18 @@
---
html: xchaincommit.html
parent: transaction-types.html
seo:
description: クロスチェーンでの価値移転を開始します。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: send
---
# XChainCommit
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L408-L416 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
`XChainCommit`はクロスチェーン送金の2番目のステップです。`XChainCommit`は発行チェーンでラップできるようにロックチェーンで資産を保管したり、ロックチェーンで返却できるように発行チェーンでラップされた資産をバーンしたりします。
クロスチェーン送金の2番目のステップです。`XChainCommit`は発行チェーンでラップできるようにロックチェーンで資産を保管したり、ロックチェーンで返却できるように発行チェーンでラップされた資産をバーンしたりします。
{% amendment-disclaimer name="XChainBridge" /%}
## XChainCommit JSONの例

View File

@@ -1,18 +1,16 @@
---
html: xchaincreatebridge.html
parent: transaction-types.html
seo:
description: 2つのチェーン間にブリッジを作成します。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: create
---
# XChainCreateBridge
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L381-L388 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
`XChainCreateBridge`トランザクションは新しい`Bridge`レジャーオブジェクトを作成し、トランザクショ ンが送信されたチェーン上に新しいクロスチェーンブリッジの入り口を定義します。これにはブリッジのドアアカウントと資産に関する情報が含まれます。
新しい`Bridge`レジャーオブジェクトを作成し、トランザクショ ンが送信されたチェーン上に新しいクロスチェーンブリッジの入り口を定義します。これにはブリッジのドアアカウントと資産に関する情報が含まれます。
このトランザクションは、ロックチェーンのドアアカウントが最初に送信する必要があります。有効なブリッジをセットアップするには、Witnessサーバのセットアップに加えて、両チェーンのドアアカウントがこのトランザクションを送信しなければなりません。
@@ -20,6 +18,7 @@ _[XChainBridge Amendment][] {% not-enabled /%} が必要です_
{% admonition type="info" name="注記" %}各ドアアカウントは1つのブリッジしか持つことができません。これにより、同じ資産に対して複数のブリッジが作成され、いずれかのチェーンで資産が不一致となるのを防ぐことができます。{% /admonition %}
{% amendment-disclaimer name="XChainBridge" /%}
## XChainCreateBridge JSONの例

View File

@@ -1,23 +1,22 @@
---
html: xchaincreateclaimid.html
parent: transaction-types.html
seo:
description: クロスチェーン送金に使用するクロスチェーン請求IDを作成します。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: create
---
# XChainCreateClaimID
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp#L399-L406 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
`XChainCreateClaimID`トランザクションはクロスチェーン送金に使われる新しいクロスチェーン請求IDを作成します。クロスチェーン請求IDは*1つの*クロスチェーン送金を表します。
このトランザクションはクロスチェーン送金の最初のステップであり、送金元チェーンではなく、送金先チェーンで送信されます。
また、送金元チェーン上の資金をロックまたはバーンする送金元チェーン上のアカウントも含まれます。
{% amendment-disclaimer name="XChainBridge" /%}
## XChainCreateClaimID JSONの例

View File

@@ -1,23 +1,22 @@
---
html: xchainmodifybridge.html
parent: transaction-types.html
seo:
description: ブリッジの設定を変更します。
labels:
- 相互運用性
- Interoperability
requiredAmendment: XChainBridge
status: not_enabled
txIcon: modify
---
# XChainModifyBridge
[[ソース]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/protocol/impl/TxFormats.cpp#L390-L397 "ソース")
_[XChainBridge Amendment][] {% not-enabled /%} が必要です_
`XChainModifyBridge`トランザクションでは、ブリッジ管理者がブリッジの設定を変更することができます。変更できるのは`SignatureReward``MinAccountCreateAmount`だけです。
このトランザクションはドアアカウントから送信される必要があり、Witnessサーバを管理するエンティティがこのトランザクションのために協調し、署名を提供する必要があります。この調整はレジャーの外部で行われます。
{% admonition type="info" name="注記" %}このトランザクションでブリッジの署名者リストを変更することはできません。署名者リストはドアアカウント自体にあり、署名者リストがアカウント上で変更されるのと同じ方法で変更されます(`SignerListSet`トランザクションを利用)。{% /admonition %}
{% amendment-disclaimer name="XChainBridge" /%}
## XChainModifyBridge JSONの例

View File

@@ -1,3 +1,5 @@
// Components related to XRPL Amendment previews and statuses
import * as React from 'react'
import { Link } from '@redocly/theme/components/Link/Link'
import { useThemeHooks } from '@redocly/theme/core/hooks'

View File

@@ -0,0 +1,26 @@
// Component for {% child-pages /%} markdoc tag.
// Return a list of children of the current page.
import { useThemeHooks } from '@redocly/theme/core/hooks'
import { Link } from '@redocly/theme/components/Link/Link'
import NotEnabled from './NotEnabled'
export default function ChildPages() {
const { usePageSharedData } = useThemeHooks()
const data = usePageSharedData('index-page-items') as any[]
return (
<div className="children-display">
<ul>
{data?.map((item: any) => (
<li className="level-1" key={item.slug}>
<Link to={item.slug}>{item.title}</Link>
{
item.status === "not_enabled" ? (<NotEnabled />) : ""
}
<p className="blurb child-blurb">{item.seo?.description}</p>
</li>
))}
</ul>
</div>
)
}

View File

@@ -0,0 +1,11 @@
// Component for {% code-page-name /%} Markdoc tag.
// Returns the current page title in monospace (code) font.
// Useful in includes / templates that may be reused across pages.
export default function CodePageName(props: {
name: string
}) {
return (
<code>{props.name}</code>
)
}

View File

@@ -0,0 +1,45 @@
// Component for {% interactive-block %} markdoc tag. Used in legacy interactive
// tutorials; not recommended for new tutorials.
import * as React from 'react'
import { useLocation } from 'react-router-dom'
import dynamicReact from '@markdoc/markdoc/dist/react'
import { idify } from '../helpers'
export default function InteractiveBlock(props: {
children: React.ReactNode
label: string
steps: string[]
}) {
const stepId = idify(props.label)
const { pathname } = useLocation()
return (
// add key={pathname} to ensure old step state gets rerendered on page navigation
<div className="interactive-block" id={'interactive-' + stepId} key={pathname}>
<div className="interactive-block-inner">
<div className="breadcrumbs-wrap">
<ul
className="breadcrumb tutorial-step-crumbs"
id={'bc-ul-' + stepId}
data-steplabel={props.label}
data-stepid={stepId}
>
{props.steps?.map((step, idx) => {
const iterStepId = idify(step).toLowerCase()
let className = `breadcrumb-item bc-${iterStepId}`
if (idx > 0) className += ' disabled'
if (iterStepId === stepId) className += ' current'
return (
<li className={className} key={iterStepId}>
<a href={`#interactive-${iterStepId}`}>{step}</a>
</li>
)
})}
</ul>
</div>
<div className="interactive-block-ui">{dynamicReact(props.children, React, {})}</div>
</div>
</div>
)
}

View File

@@ -1,4 +1,5 @@
import React from 'react';
// Replaces Redocly's built-in language picker with our custom language picker component.
import styled from 'styled-components';
import { DropdownMenu } from '@redocly/theme/components/Dropdown/DropdownMenu';

View File

@@ -1,4 +1,6 @@
import * as React from "react";
// Replaces the top navbar with our custom XRPL.org top navbar
import React from 'react'
import { useThemeConfig, useThemeHooks } from "@redocly/theme/core/hooks";
import { LanguagePicker } from "@redocly/theme/components/LanguagePicker/LanguagePicker";
import { slugify } from "../../helpers";

View File

@@ -0,0 +1,14 @@
// Component for {% not-enabled /%} markdoc tag. Shows a flask icon with a
// tooltip so you can indicate that a feature is not enabled on the
// XRP Ledger Mainnet. Legacy usage, mostly; prefer {% amendment-disclaimer %}
// for most cases.
import { useThemeHooks } from '@redocly/theme/core/hooks'
export default function NotEnabled() {
const { useTranslate } = useThemeHooks()
const { translate } = useTranslate()
return (
<span className="status not_enabled" title={translate("This feature is not currently enabled on the production XRP Ledger.")}><i className="fa fa-flask"></i></span>
)
}

View File

@@ -0,0 +1,22 @@
// Create a link into the source code repository for this project.
// This is supposed to adjust so that PR builds use the branch+fork of the PR,
// but that part wasn't implemented for Redocly builds.
import * as React from 'react'
import dynamicReact from '@markdoc/markdoc/dist/react'
import { Link } from '@redocly/theme/components/Link/Link'
export default function RepoLink(props: {
children: React.ReactNode
path: string
github_fork: string
github_branch: string
}) {
const treeblob = props.path.indexOf(".") >= 0 ? "blob/" : "tree/"
const sep = props.github_fork[-1] == "/" ? "" : "/"
const href = props.github_fork+sep+treeblob+props.github_branch+"/"+props.path
return (
<Link to={href}>{dynamicReact(props.children, React, {})}</Link>
)
}

View File

@@ -1,5 +1,5 @@
// This component replaces the default Redocly Tabs functionality.
// Original Tabs styling is preserved, but this adds full-page tab
// Replaces Redocly's built-in {% tabs %} component.
// Uses the existing Tabs styling, but adds full-page tab
// switching and preserves tab preferences between pages.
import React, { useRef, useState, useEffect, useCallback, useMemo } from 'react'

View File

@@ -0,0 +1,64 @@
// Component for {% tx-category %} Markdoc tag. Shows a list (table?) of child pages
// with the matching labels in the frontmatter.
// Requires the index-pages Redocly plugin to get child page data.
import { useThemeHooks } from '@redocly/theme/core/hooks'
import { Link } from '@redocly/theme/components/Link/Link'
import { AmendmentDisclaimer } from './Amendments'
interface TxCategoryProps {
name: string,
}
export function TxCategory(props: TxCategoryProps) {
const { usePageSharedData } = useThemeHooks()
const data = usePageSharedData('index-page-items') as any[]
const matchingItems = data?.filter( (page) => {
if (page.labels && page.labels.includes(props.name)) {
return true
}
return false
})
return (
<div className="tx-type-list">
{
matchingItems?.map((item: any) => (
<TxTypeLink key={item.slug} page={item} />
))
}
</div>
)
}
const txIcons = {
"create": require('../../static/img/tx-icons/TransactionCreateIcon.svg'),
"modify": require('../../static/img/tx-icons/TransactionModifyIcon.svg'),
"finish": require('../../static/img/tx-icons/TransactionFinishIcon.svg'),
"cancel": require('../../static/img/tx-icons/TransactionCancelIcon.svg'),
"send": require('../../static/img/tx-icons/TransactionSendIcon.svg'),
"other": require('../../static/img/tx-icons/TransactionUnknownIcon.svg'),
}
function TxTypeLink(props: {page: any}) {
const page = props.page
let txIcon = txIcons["other"]
if (page.txIcon && txIcons[page.txIcon.toLowerCase()]) {
txIcon = txIcons[page.txIcon]
}
return (
<div className="tx-type">
<Link to={page.slug} className="tx-title"><img className="tx-type-icon" src={txIcon} alt="" /> {page.title}</Link>
{
page.requiredAmendment &&
<div className="required-amendment">
Requires: <AmendmentDisclaimer name={page.requiredAmendment} compact={true} mode="" />
</div>
}
{
page.seo?.description &&
<div className="tx-desc">{page.seo.description}</div>
}
</div>
)
}

View File

@@ -0,0 +1,58 @@
import { Link } from '@redocly/theme/components/Link/Link'
import { useThemeHooks } from '@redocly/theme/core/hooks'
type TryItServer = 's1' | 's2' | 'xrplcluster' | 'testnet' | 'devnet' | 'testnet-clio' | 'devnet-clio'
export function TryIt(props: {
method: string,
server?: TryItServer
}) {
const { useTranslate } = useThemeHooks()
const { translate } = useTranslate()
let use_server = ""
if (props.server == "s1") {
use_server = "?server=wss%3A%2F%2Fs1.ripple.com%2F"
} else if (props.server == "s2") {
use_server = "?server=wss%3A%2F%2Fs2.ripple.com%2F"
} else if (props.server == "xrplcluster") {
use_server = "?server=wss%3A%2F%2Fxrplcluster.com%2F"
} else if (props.server == 'devnet') {
use_server = "?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F"
} else if (props.server == 'testnet') {
use_server = "?server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F"
} else if (props.server == 'testnet-clio') {
use_server = "?server=wss%3A%2F%2Fclio.altnet.rippletest.net%3A51233%2F"
} else if (props.server == 'devnet-clio') {
use_server = "?server=wss%3A%2F%2Fclio.devnet.rippletest.net%3A51233%2F"
}
const to_path = `/resources/dev-tools/websocket-api-tool${use_server}#${props.method}`
return (
<Link style={{marginBottom: "1rem", textDecoration: "none"}} className="btn btn-primary btn-arrow" to={to_path} target="_blank" role="button">{translate("component.tryit", "Try it!")}</Link>
)
}
export function TxExample(props: {
txid: string,
server?: TryItServer
}) {
const { useTranslate } = useThemeHooks()
const { translate } = useTranslate()
let use_server = ""
if (props.server == "s1") {
use_server = "&server=wss%3A%2F%2Fs1.ripple.com%2F"
} else if (props.server == "s2") {
use_server = "&server=wss%3A%2F%2Fs2.ripple.com%2F"
} else if (props.server == "xrplcluster") {
use_server = "&server=wss%3A%2F%2Fxrplcluster.com%2F"
} else if (props.server == 'devnet') {
use_server = "&server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F"
} else if (props.server == 'testnet') {
use_server = "&server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F"
}
const ws_req = `req=%7B%22id%22%3A%22example_tx_lookup%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22${props.txid}%22%2C%22binary%22%3Afalse%2C%22api_version%22%3A2%7D`
const to_path = `/resources/dev-tools/websocket-api-tool?${ws_req}${use_server}`
return (
<Link style={{marginBottom: "1rem", textDecoration: "none"}} className="btn btn-primary btn-arrow" to={to_path} target="_blank" role="button">{translate("component.queryexampletx", "Query example transaction")}</Link>
)
}

View File

@@ -1,3 +1,7 @@
// Components for creating grids of cards in the current site style.
// Used in both custom .page.tsx files as well as markdoc tags {% card-grid %}
// and {% xrpl-card %}.
import * as React from 'react';
import dynamicReact from '@markdoc/markdoc/dist/react';
import { Link } from '@redocly/theme/components/Link/Link';

View File

@@ -1,4 +1,4 @@
import * as React from 'react';
// Loading animation component used in various custom pages.
export interface XRPLoaderProps {
message?: string

View File

@@ -3,7 +3,7 @@
*/
import { useEffect, useState } from 'react';
export const useThemeFromClassList = (classNames) => {
export const useThemeFromClassList = (classNames: Array<string>) => {
const [currentTheme, setCurrentTheme] = useState(null);
useEffect(() => {
@@ -40,7 +40,7 @@ export const useThemeFromClassList = (classNames) => {
return currentTheme;
};
export function slugify(s) {
export function slugify(s: string) {
const unacceptable_chars = /[^A-Za-z0-9._ ]+/g;
const whitespace_regex = /\s+/g;
s = s.replace(unacceptable_chars, "");

View File

@@ -1,158 +1,11 @@
import * as React from 'react'
import { useLocation } from 'react-router-dom'
// @ts-ignore
import dynamicReact from '@markdoc/markdoc/dist/react'
import { Link } from '@redocly/theme/components/Link/Link'
import { useThemeHooks } from '@redocly/theme/core/hooks'
import { idify } from '../helpers'
import { Button } from '@redocly/theme/components/Button/Button'
export { default as XRPLoader } from '../components/XRPLoader'
export { XRPLCard, CardGrid } from '../components/XRPLCard'
export { AmendmentsTable, AmendmentDisclaimer, Badge } from '../components/Amendments'
export { Tabs } from '../components/SyncedTabs'
export function IndexPageItems() {
const { usePageSharedData } = useThemeHooks()
const data = usePageSharedData('index-page-items') as any[]
return (
<div className="children-display">
<ul>
{data?.map((item: any) => (
<li className="level-1" key={item.slug}>
<Link to={item.slug}>{item.title}</Link>
{
item.status === "not_enabled" ? (<NotEnabled />) : ""
}
<p className="blurb child-blurb">{item.seo?.description}</p>
</li>
))}
</ul>
</div>
)
}
export function InteractiveBlock(props: {
children: React.ReactNode
label: string
steps: string[]
}) {
const stepId = idify(props.label)
const { pathname } = useLocation()
return (
// add key={pathname} to ensure old step state gets rerendered on page navigation
<div className="interactive-block" id={'interactive-' + stepId} key={pathname}>
<div className="interactive-block-inner">
<div className="breadcrumbs-wrap">
<ul
className="breadcrumb tutorial-step-crumbs"
id={'bc-ul-' + stepId}
data-steplabel={props.label}
data-stepid={stepId}
>
{props.steps?.map((step, idx) => {
const iterStepId = idify(step).toLowerCase()
let className = `breadcrumb-item bc-${iterStepId}`
if (idx > 0) className += ' disabled'
if (iterStepId === stepId) className += ' current'
return (
<li className={className} key={iterStepId}>
<a href={`#interactive-${iterStepId}`}>{step}</a>
</li>
)
})}
</ul>
</div>
<div className="interactive-block-ui">{dynamicReact(props.children, React, {})}</div>
</div>
</div>
)
}
export function RepoLink(props: {
children: React.ReactNode
path: string
github_fork: string
github_branch: string
}) {
const treeblob = props.path.indexOf(".") >= 0 ? "blob/" : "tree/"
const sep = props.github_fork[-1] == "/" ? "" : "/"
const href = props.github_fork+sep+treeblob+props.github_branch+"/"+props.path
return (
<Link to={href}>{dynamicReact(props.children, React, {})}</Link>
)
}
export function CodePageName(props: {
name: string
}) {
return (
<code>{props.name}</code>
)
}
type TryItServer = 's1' | 's2' | 'xrplcluster' | 'testnet' | 'devnet' | 'testnet-clio' | 'devnet-clio'
export function TryIt(props: {
method: string,
server?: TryItServer
}) {
const { useTranslate } = useThemeHooks()
const { translate } = useTranslate()
let use_server = ""
if (props.server == "s1") {
use_server = "?server=wss%3A%2F%2Fs1.ripple.com%2F"
} else if (props.server == "s2") {
use_server = "?server=wss%3A%2F%2Fs2.ripple.com%2F"
} else if (props.server == "xrplcluster") {
use_server = "?server=wss%3A%2F%2Fxrplcluster.com%2F"
} else if (props.server == 'devnet') {
use_server = "?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F"
} else if (props.server == 'testnet') {
use_server = "?server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F"
} else if (props.server == 'testnet-clio') {
use_server = "?server=wss%3A%2F%2Fclio.altnet.rippletest.net%3A51233%2F"
} else if (props.server == 'devnet-clio') {
use_server = "?server=wss%3A%2F%2Fclio.devnet.rippletest.net%3A51233%2F"
}
const to_path = `/resources/dev-tools/websocket-api-tool${use_server}#${props.method}`
return (
<Link style={{marginBottom: "1rem", textDecoration: "none"}} className="btn btn-primary btn-arrow" to={to_path} target="_blank" role="button">{translate("component.tryit", "Try it!")}</Link>
)
}
export function TxExample(props: {
txid: string,
server?: TryItServer
}) {
const { useTranslate } = useThemeHooks()
const { translate } = useTranslate()
let use_server = ""
if (props.server == "s1") {
use_server = "&server=wss%3A%2F%2Fs1.ripple.com%2F"
} else if (props.server == "s2") {
use_server = "&server=wss%3A%2F%2Fs2.ripple.com%2F"
} else if (props.server == "xrplcluster") {
use_server = "&server=wss%3A%2F%2Fxrplcluster.com%2F"
} else if (props.server == 'devnet') {
use_server = "&server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F"
} else if (props.server == 'testnet') {
use_server = "&server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F"
}
const ws_req = `req=%7B%22id%22%3A%22example_tx_lookup%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22${props.txid}%22%2C%22binary%22%3Afalse%2C%22api_version%22%3A2%7D`
const to_path = `/resources/dev-tools/websocket-api-tool?${ws_req}${use_server}`
return (
<Link style={{marginBottom: "1rem", textDecoration: "none"}} className="btn btn-primary btn-arrow" to={to_path} target="_blank" role="button">{translate("component.queryexampletx", "Query example transaction")}</Link>
)
}
export function NotEnabled() {
const { useTranslate } = useThemeHooks()
const { translate } = useTranslate()
return (
<span className="status not_enabled" title={translate("This feature is not currently enabled on the production XRP Ledger.")}><i className="fa fa-flask"></i></span>
)
}
export { default as ChildPages } from '../components/ChildPages'
export { default as NotEnabled } from '../components/NotEnabled'
export { default as InteractiveBlock } from '../components/InteractiveBlock'
export { default as RepoLink } from '../components/RepoLink'
export { default as CodePageName } from '../components/CodePageName'
export { TryIt, TxExample } from '../components/WSToolButtons'
export { TxCategory } from '../components/TxRefs'

View File

@@ -1,8 +1,8 @@
import { Schema, Tag } from '@markdoc/markdoc';
export const indexPageList: Schema & { tagName: string } = {
export const childPages: Schema & { tagName: string } = {
tagName: 'child-pages',
render: 'IndexPageItems',
render: 'ChildPages',
selfClosing: true,
};
@@ -243,3 +243,15 @@ export const amendmentDisclaimer: Schema & { tagName: string } = {
render: 'AmendmentDisclaimer',
selfClosing: true
}
export const txCategory: Schema & { tagName: string } = {
tagName: 'tx-category',
attributes: {
name: {
type: 'String',
required: true
}
},
render: 'TxCategory',
selfClosing: true,
};

View File

@@ -1,3 +1,10 @@
// The purpose of this plugin is to get a list of pages that are "children" of
// the current page and pass along their frontmatter as well as the path that
// can be used to link to those pages from other components.
// It uses experimental Redocly plugin interface stuff that is expected
// to be exposed in a "nicer" way in some theoretical future release.
// The ts-ignore and TODOs are more for Redocly's notes than for XRPLF.
// @ts-check
import { readSharedData } from '@redocly/realm/dist/server/utils/shared-data.js'; // TODO: export function from root package
const INDEX_PAGE_INFO_DATA_KEY = 'index-page-items';
@@ -26,14 +33,21 @@ export function indexPages() {
const item = findItemDeep(sidebar.items, route.fsPath);
const childrenPaths = (item.items || [])
.map((item) => item.fsPath)
.map(
// @ts-ignore
(item) => item.fsPath
)
.filter(Boolean);
const childRoutes = childrenPaths.map((fsPath) =>
const childRoutes = childrenPaths.map(
// @ts-ignore
(fsPath) =>
actions.getRouteByFsPath(fsPath),
);
const childRoutesData = await Promise.all(
childRoutes.map(async (route) => {
childRoutes.map(
// @ts-ignore
async (route) => {
const { data } = await cache.load(
route.fsPath,
'markdown-frontmatter',
@@ -63,6 +77,7 @@ export function indexPages() {
return instance;
}
// @ts-ignore
function findItemDeep(items, fsPath) {
for (const item of items) {
if (item.fsPath === fsPath) {
@@ -70,6 +85,7 @@ function findItemDeep(items, fsPath) {
}
if (item.items) {
// @ts-ignore
const found = findItemDeep(item.items, fsPath);
if (found) {
return found;

View File

@@ -5,8 +5,9 @@
* This creates shared data that maps tutorial paths to their supported languages.
*/
export function tutorialLanguages() {
/** @type {import("@redocly/realm/dist/server/plugins/types").PluginInstance } */
/** @type {import("@redocly/realm/dist/server/types").ExternalPlugin } */
const instance = {
id: 'tutorial-languages',
processContent: async (actions, { fs, cache }) => {
try {
/** @type {Record<string, string[]>} */

View File

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

View File

@@ -3,6 +3,7 @@ seo:
description: Set options on an account.
labels:
- Accounts
txIcon: modify
---
# AccountSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetAccount.cpp "Source")

View File

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

View File

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

View File

@@ -3,6 +3,9 @@ seo:
description: Create a new Automated Market Maker for trading a given pair of assets.
labels:
- AMM
- DEX
requiredAmendment: AMM
txIcon: create
---
# AMMCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMCreate.cpp "Source")

View File

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

View File

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

View File

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

View File

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

View File

@@ -3,7 +3,10 @@ seo:
description: Create and submit a batch of up to 8 transactions that succeed or fail atomically.
labels:
- Transaction Sending
- Other Transactions
requiredAmendment: Batch
status: not_enabled
txIcon: other
---
# Batch
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Batch.cpp "Source")

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -6,6 +6,7 @@ labels:
- Permissions
- Delegate
status: not_enabled
requiredAmendment: PermissionDelegation
---
# DelegateSet
[[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/src/xrpld/app/tx/detail/DelegateSet.cpp "Source")

View File

@@ -3,6 +3,9 @@ seo:
description: Preauthorize an account to send payments to you.
labels:
- Security
- Accounts
requiredAmendment: DepositPreauth
txIcon: modify
---
# DepositPreauth
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DepositPreauth.cpp "Source")

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -8,13 +8,34 @@ labels:
---
# Transaction Types
The type of a transaction (`TransactionType` field) is the most fundamental information about a transaction. This indicates what type of operation the transaction is supposed to do.
The `TransactionType` field determines what operation a transaction performs. All transactions share [common fields](../common-fields.md), plus fields specific to the transaction type.
All transactions have certain fields in common:
The following tables list all transaction types, grouped by feature area.
* [Common Fields](../common-fields.md)
## Accounts
Each transaction type has additional fields relevant to the type of action it causes.
{% tx-category name="Accounts" /%}
## Payments
{% child-pages /%}
{% tx-category name="Payments" /%}
## Tokens
{% tx-category name="Tokens" /%}
## DEX
{% tx-category name="DEX" /%}
## Decentralized Storage
{% tx-category name="Decentralized Storage" /%}
## XRPL Side Chains
{% tx-category name="Interoperability" /%}
## Other
{% tx-category name="Other Transactions" /%}

View File

@@ -4,6 +4,9 @@ seo:
labels:
- Utilities
- Troubleshooting
- Other Transactions
requiredAmendment: fixNFTokenPageLinks
txIcon: other
---
# LedgerStateFix
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/LedgerStateFix.cpp "Source")

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