Remove redocly-incompatible syntax from checks tutorials

This commit is contained in:
mDuo13
2024-01-11 16:46:37 -08:00
parent 7367f119e4
commit 9fd5c2a135
13 changed files with 43 additions and 100 deletions

View File

@@ -13,8 +13,6 @@ _[Checks Amendment][]により追加されました。_
着信したCheckが不要な場合、取り消すことができます。送信時に内容を誤って入力した場合や状況が変化した場合に、送信したCheckを取り消すこともできます。有効期限切れのCheckはレジャーから削除する必要があります。これにより、送金元に[所有者準備金](../../../concepts/accounts/reserves.md#所有者準備金)が戻ります。 着信したCheckが不要な場合、取り消すことができます。送信時に内容を誤って入力した場合や状況が変化した場合に、送信したCheckを取り消すこともできます。有効期限切れのCheckはレジャーから削除する必要があります。これにより、送金元に[所有者準備金](../../../concepts/accounts/reserves.md#所有者準備金)が戻ります。
{% set cancel_n = cycler(* range(1,99)) %}
## 前提条件 ## 前提条件
このチュートリアルでCheckを取り消すには、以下が必要です。 このチュートリアルでCheckを取り消すには、以下が必要です。
@@ -26,7 +24,7 @@ _[Checks Amendment][]により追加されました。_
- [クライアントライブラリ](../../../references/client-libraries.md)またはHTTPライブラリ、WebSocketライブラリなど。 - [クライアントライブラリ](../../../references/client-libraries.md)またはHTTPライブラリ、WebSocketライブラリなど。
## {{cancel_n.next()}}.CheckCancelトランザクションの準備 ## 1. CheckCancelトランザクションの準備
[CheckCancelトランザクション][]のフィールドの値を決定します。以下のフィールドは必要最小限のフィールドです。その他のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)可能なフィールドです。 [CheckCancelトランザクション][]のフィールドの値を決定します。以下のフィールドは必要最小限のフィールドです。その他のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)可能なフィールドです。
@@ -59,7 +57,7 @@ Checkを取り消す例を以下に示します。
{% /tabs %} {% /tabs %}
## {{cancel_n.next()}}.CheckCancelトランザクションの署名 ## 2. CheckCancelトランザクションの署名
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -93,9 +91,8 @@ Checkを取り消す例を以下に示します。
{% /tabs %} {% /tabs %}
## {{cancel_n.next()}}.署名済みCheckCancelトランザクションの送信 ## 3. 署名済みCheckCancelトランザクションの送信
{% set step_1_link = "#1checkcancelトランザクションの準備" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
### リクエストの例 ### リクエストの例
@@ -127,11 +124,11 @@ Checkを取り消す例を以下に示します。
{% /tabs %} {% /tabs %}
## {{cancel_n.next()}}.検証の待機 ## 4. 検証の待機
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{cancel_n.next()}}.最終結果の確認 ## 5. 最終結果の確認
トランザクションのステータスを確認するには、CheckCancelトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドをトランザクションメタデータから検索し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果から検索します。 トランザクションのステータスを確認するには、CheckCancelトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドをトランザクションメタデータから検索し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果から検索します。

View File

@@ -15,14 +15,12 @@ Checkから可能な限りの額を受領したい場合には、変動金額で
指定受取人は、[Checkを正確な金額で換金する](cash-a-check-for-a-flexible-amount.md)こともできます。 指定受取人は、[Checkを正確な金額で換金する](cash-a-check-for-a-flexible-amount.md)こともできます。
{% set cash_flex_n = cycler(* range(1,99)) %}
## 前提条件 ## 前提条件
{% partial file="/_snippets/checkcash-prereqs.md" /%} {% partial file="/_snippets/checkcash-prereqs.md" /%}
## {{cash_flex_n.next()}}.CheckCashトランザクションの準備 ## 1. CheckCashトランザクションの準備
[CheckCashトランザクション][]のフィールドの値を決定します。Checkを変動金額で換金する場合、以下のフィールドは必要最小限です。それ以外のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)可能なフィールドです。 [CheckCashトランザクション][]のフィールドの値を決定します。Checkを変動金額で換金する場合、以下のフィールドは必要最小限です。それ以外のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)可能なフィールドです。
@@ -56,7 +54,7 @@ Checkを変動金額で換金するためのトランザクションを準備す
{% /tabs %} {% /tabs %}
## {{cash_flex_n.next()}}.CheckCashトランザクションの署名 ## 2. CheckCashトランザクションの署名
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -82,9 +80,8 @@ Checkを変動金額で換金するためのトランザクションを準備す
{% /tabs %} {% /tabs %}
## {{cash_flex_n.next()}}.署名済みCheckCashトランザクションの送信 ## 3. 署名済みCheckCashトランザクションの送信
{% set step_1_link = "#1checkcashトランザクションの準備" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
### リクエストの例 ### リクエストの例
@@ -108,11 +105,11 @@ Checkを変動金額で換金するためのトランザクションを準備す
{% /tabs %} {% /tabs %}
## {{cash_flex_n.next()}}.検証の待機 ## 4. 検証の待機
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{cash_flex_n.next()}}.最終結果の確認 ## 5. 最終結果の確認
トランザクションのステータスを確認するには、CheckCashトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドをトランザクションメタデータから検索し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果から検索します。 トランザクションのステータスを確認するには、CheckCashトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドをトランザクションメタデータから検索し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果から検索します。
@@ -151,7 +148,7 @@ Checkを変動金額で換金するためのトランザクションを準備す
| `tecPATH_PARTIAL` | トラストラインの限度額、または送金元に送金通貨の残高(イシュアーの[送金手数料](../../../concepts/tokens/transfer-fees.md)がある場合はこの手数料を含むが十分になかったことが原因で、Checkでは十分なトークンを送金できませんでした。 | 原因がトラストラインの限度額である場合は、(希望する場合には)限度額を引き上げる[TrustSetトランザクション][]を送信するか、または通貨の一部を消費して残高を減らしてから、Checkの換金を再試行します。原因が送金元の残高である場合は、送金元にCheckの通貨が積み増しされるまで待つか、または以前よりも低い額でCheckの換金を再試行します。 | | `tecPATH_PARTIAL` | トラストラインの限度額、または送金元に送金通貨の残高(イシュアーの[送金手数料](../../../concepts/tokens/transfer-fees.md)がある場合はこの手数料を含むが十分になかったことが原因で、Checkでは十分なトークンを送金できませんでした。 | 原因がトラストラインの限度額である場合は、(希望する場合には)限度額を引き上げる[TrustSetトランザクション][]を送信するか、または通貨の一部を消費して残高を減らしてから、Checkの換金を再試行します。原因が送金元の残高である場合は、送金元にCheckの通貨が積み増しされるまで待つか、または以前よりも低い額でCheckの換金を再試行します。 |
| `tecUNFUNDED_PAYMENT` | Checkで十分なXRPを送金できませんでした。 | 送金元にXRPが積み増しされるまで待つか、または以前よりも低い額でCheckの換金を再試行します。 | | `tecUNFUNDED_PAYMENT` | Checkで十分なXRPを送金できませんでした。 | 送金元にXRPが積み増しされるまで待つか、または以前よりも低い額でCheckの換金を再試行します。 |
## {{cash_flex_n.next()}}.送金された額の確認 ## 6. 送金された額の確認
Checkが変動する`DeliverMin`の額で換金された場合は、Checkは少なくとも`DeliverMin`の額で換金されたと想定できます。送金された額を正確に得るには、トランザクションメタデータを調べます。<!--{# TODO: Update if RIPD-1623 adds a delivered_amount field. #}-->メタデータの`AffectedNodes`配列には、通貨のタイプに応じて、Checkの換金による残高の変更を反映した12つのオブジェクトが含まれています。 Checkが変動する`DeliverMin`の額で換金された場合は、Checkは少なくとも`DeliverMin`の額で換金されたと想定できます。送金された額を正確に得るには、トランザクションメタデータを調べます。<!--{# TODO: Update if RIPD-1623 adds a delivered_amount field. #}-->メタデータの`AffectedNodes`配列には、通貨のタイプに応じて、Checkの換金による残高の変更を反映した12つのオブジェクトが含まれています。
@@ -192,14 +189,8 @@ Checkが変動する`DeliverMin`の額で換金された場合は、Checkは少
- Checkの送金元または受取人がイシュアーであるトークンの場合、これらのアカウント間のトラストラインを表す`RippleState`オブジェクトでは、`Balance`がCheckの受取人に有利な方法で調整されています。 - Checkの送金元または受取人がイシュアーであるトークンの場合、これらのアカウント間のトラストラインを表す`RippleState`オブジェクトでは、`Balance`がCheckの受取人に有利な方法で調整されています。
<!-- {# TODO: example of single-RippleState balance changes #}-->
- イシュアーが第三者であるトークンの場合、2つの`RippleState`送金元からイシュアーへのトラストラインとイシュアーから受取人へのトラストラインに対する変更があります。Checkの送金元とイシュアーの関係を表す`RippleState`オブジェクトではその`Balance`がイシュアーに有利に変更され、イシュアーと受取人の間の関係を表す`RippleState`オブジェクトではその`Balance`が受取人に有利に変更されます。 - イシュアーが第三者であるトークンの場合、2つの`RippleState`送金元からイシュアーへのトラストラインとイシュアーから受取人へのトラストラインに対する変更があります。Checkの送金元とイシュアーの関係を表す`RippleState`オブジェクトではその`Balance`がイシュアーに有利に変更され、イシュアーと受取人の間の関係を表す`RippleState`オブジェクトではその`Balance`が受取人に有利に変更されます。
<!--{# TODO: example of double-RippleState balance changes #}-->
- トークンに[送金手数料](../../../concepts/tokens/transfer-fees.md)がある場合、受取人への入金額を上回る額がCheckの送金元から引き落とされます。この差額が送金手数料であり、これがイシュアーに戻されることによりイシュアーの正味の債務は減少します。 - トークンに[送金手数料](../../../concepts/tokens/transfer-fees.md)がある場合、受取人への入金額を上回る額がCheckの送金元から引き落とされます。この差額が送金手数料であり、これがイシュアーに戻されることによりイシュアーの正味の債務は減少します。
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -13,13 +13,11 @@ Checkがレジャーに含まれており有効期限切れではない場合は
指定の受取人は、[Checkを変動金額で換金する](cash-a-check-for-a-flexible-amount.md)こともできます。 指定の受取人は、[Checkを変動金額で換金する](cash-a-check-for-a-flexible-amount.md)こともできます。
{% set cash_exact_n = cycler(* range(1,99)) %}
## 前提条件 ## 前提条件
{% partial file="/_snippets/checkcash-prereqs.md" /%} {% partial file="/_snippets/checkcash-prereqs.md" /%}
## {{cash_exact_n.next()}}.CheckCashトランザクションの準備 ## 1. CheckCashトランザクションの準備
[CheckCashトランザクション][]のフィールドの値を決定します。Checkを正確な金額で換金する場合、以下のフィールドが最低限必要です。それ以外のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)可能なフィールドです。 [CheckCashトランザクション][]のフィールドの値を決定します。Checkを正確な金額で換金する場合、以下のフィールドが最低限必要です。それ以外のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)可能なフィールドです。
@@ -55,7 +53,7 @@ Checkを正確な金額で換金するためのトランザクションを準備
{% /tabs %} {% /tabs %}
## {{cash_exact_n.next()}}.CheckCashトランザクションの署名 ## 2. CheckCashトランザクションの署名
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -81,9 +79,8 @@ Checkを正確な金額で換金するためのトランザクションを準備
{% /tabs %} {% /tabs %}
## {{cash_exact_n.next()}}.署名済みCheckCashトランザクションの送信 ## 3. 署名済みCheckCashトランザクションの送信
{% set step_1_link = "#1checkcashトランザクションの準備" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
### リクエストの例 ### リクエストの例
@@ -107,11 +104,11 @@ Checkを正確な金額で換金するためのトランザクションを準備
{% /tabs %} {% /tabs %}
## {{cash_exact_n.next()}}.検証の待機 ## 4. 検証の待機
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{cash_exact_n.next()}}.最終結果の確認 ## 5.最終結果の確認
トランザクションのステータスを確認するには、CheckCashトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドをトランザクションメタデータから検索し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果から検索します。 トランザクションのステータスを確認するには、CheckCashトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドをトランザクションメタデータから検索し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果から検索します。
@@ -140,6 +137,4 @@ Checkを換金できない場合、Checkはレジャーに残るため、後日
{% /tabs %} {% /tabs %}
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -69,6 +69,4 @@ for (i=0; i < account_objects_response.account_objects.length; i++) {
} }
``` ```
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -13,8 +13,6 @@ _[Checks Amendment][]により追加されました。_
## 1. 特定のアドレスのすべてのCheckの検索 ## 1. 特定のアドレスのすべてのCheckの検索
<!--{# TODO: Update if https://github.com/XRPLF/rippled/issues/2443 gets done #}-->
特定のアドレスで受信および送信されるすべてのCheckのリストを取得するには、送金元アカウントのアドレスを指定した`account_objects`コマンドを実行し、リクエストの`type` フィールドを`checks`に設定します。 特定のアドレスで受信および送信されるすべてのCheckのリストを取得するには、送金元アカウントのアドレスを指定した`account_objects`コマンドを実行し、リクエストの`type` フィールドを`checks`に設定します。
**注記:**`account_objects`コマンドのコマンドラインインターフェイスでは`type`フィールドは受け入れられません。代わりに[jsonメソッド][]を使用してコマンドラインからJSON-RPCフォーマットのリクエストを送信できます。 **注記:**`account_objects`コマンドのコマンドラインインターフェイスでは`type`フィールドは受け入れられません。代わりに[jsonメソッド][]を使用してコマンドラインからJSON-RPCフォーマットのリクエストを送信できます。
@@ -69,6 +67,4 @@ for (i=0; i < account_objects_response.account_objects.length; i++) {
} }
``` ```
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -15,7 +15,6 @@ Checkの送信は、指定受取人にあなたからの支払いを引き出す
XRP Ledgerの外部でGrand PaymentsはBoxSend SGに請求書IDは`46060241FABCF692D4D934BA2A6C4427CD4279083E38C77CBE642243E43BE291`を送り、Grand PaymentsのXRP LedgerアドレスrGPnRH1EBpHeTF2QG8DCAgM7z5pb75LAis宛てに100 XRPのCheckを送信するよう要求します。 XRP Ledgerの外部でGrand PaymentsはBoxSend SGに請求書IDは`46060241FABCF692D4D934BA2A6C4427CD4279083E38C77CBE642243E43BE291`を送り、Grand PaymentsのXRP LedgerアドレスrGPnRH1EBpHeTF2QG8DCAgM7z5pb75LAis宛てに100 XRPのCheckを送信するよう要求します。
{% set send_n = cycler(* range(1,99)) %}
## 前提条件 ## 前提条件
@@ -27,7 +26,7 @@ XRP Ledgerの外部でGrand PaymentsはBoxSend SGに請求書IDは`46060241FA
- トランザクションに[安全に署名できる手段](../../../concepts/transactions/secure-signing.md)。 - トランザクションに[安全に署名できる手段](../../../concepts/transactions/secure-signing.md)。
- [クライアントライブラリ](../../../references/client-libraries.md)またはHTTPライブラリ、WebSocketライブラリなど。 - [クライアントライブラリ](../../../references/client-libraries.md)またはHTTPライブラリ、WebSocketライブラリなど。
## {{send_n.next()}}.CheckCreateトランザクションの準備 ## 1. CheckCreateトランザクションの準備
Checkの額と、Checkを現金化できる当事者を決定します。[CheckCreateトランザクション][]のフィールドの値を決定します。以下のフィールドは必要最小限のフィールドです。その他のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)できるフィールドです。 Checkの額と、Checkを現金化できる当事者を決定します。[CheckCreateトランザクション][]のフィールドの値を決定します。以下のフィールドは必要最小限のフィールドです。その他のフィールドはオプションまたは署名時に[自動入力](../../../references/protocol/transactions/common-fields.md#自動入力可能なフィールド)できるフィールドです。
@@ -62,7 +61,7 @@ Checkの額と、Checkを現金化できる当事者を決定します。[CheckC
{% /tabs %} {% /tabs %}
## {{send_n.next()}}.CheckCreateトランザクションへの署名 ## 2. CheckCreateトランザクションへの署名
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -103,9 +102,8 @@ Checkの額と、Checkを現金化できる当事者を決定します。[CheckC
{% /tabs %} {% /tabs %}
## {{send_n.next()}}.署名済みトランザクションの送信 ## 3.署名済みトランザクションの送信
{% set step_1_link = "#1checkcreateトランザクションの準備" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
@@ -146,12 +144,12 @@ Checkの額と、Checkを現金化できる当事者を決定します。[CheckC
{% /tabs %} {% /tabs %}
## {{send_n.next()}}.検証の待機 ## 4.検証の待機
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{send_n.next()}}.最終結果の確認 ## 5.最終結果の確認
トランザクションのステータスを確認するには、CheckCreateトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションメタデータで、トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドを探し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果で探します。 トランザクションのステータスを確認するには、CheckCreateトランザクションの識別用ハッシュを指定した[txメソッド][]を使用します。トランザクションメタデータで、トランザクションが成功したことを示す`"TransactionResult": "tesSUCCESS"`フィールドを探し、またこの結果が最終結果であることを示す`"validated": true`フィールドを結果で探します。

View File

@@ -1,3 +1,3 @@
Take the signed transaction blob from the previous step and submit it to a `rippled` server. You can do this safely even if you do not run the `rippled` server. The response contains a provisional result, which should be `tesSUCCESS`, but this result is [usually not final](../concepts/transactions/finality-of-results/index.md). A provisional response of `terQUEUED` is also OK, since [queued transactions](../concepts/transactions/transaction-cost.md#queued-transactions) are generally included in the next open ledger version (usually about 10 seconds after submission). Take the signed transaction blob from the previous step and submit it to a `rippled` server. You can do this safely even if you do not run the `rippled` server. The response contains a provisional result, which should be `tesSUCCESS`, but this result is [usually not final](../concepts/transactions/finality-of-results/index.md). A provisional response of `terQUEUED` is also OK, since [queued transactions](../concepts/transactions/transaction-cost.md#queued-transactions) are generally included in the next open ledger version (usually about 10 seconds after submission).
**Tip:** If the preliminary result is `tefMAX_LEDGER`, the transaction has failed permanently because its `LastLedgerSequence` parameter is lower than the current ledger. This happens when you take longer than the expected number of ledger versions between preparing and submitting the transaction. If this occurs, [start over from step 1]({{step_1_link}}) with a higher `LastLedgerSequence` value. **Tip:** If the preliminary result is `tefMAX_LEDGER`, the transaction has failed permanently because its `LastLedgerSequence` parameter is lower than the current ledger. This happens when you take longer than the expected number of ledger versions between preparing and submitting the transaction. If this occurs, start over from step 1 with a higher `LastLedgerSequence` value.

View File

@@ -11,8 +11,6 @@ This tutorial shows how to cancel a [Check](../../../concepts/payment-types/chec
You may want to cancel an incoming Check if you do not want it. You might cancel an outgoing Check if you made a mistake when sending it or if circumstances have changed. If a Check expires, it's also necessary to cancel it to remove it from the ledger so the sender gets their [owner reserve](../../../concepts/accounts/reserves.md#owner-reserves) back. You may want to cancel an incoming Check if you do not want it. You might cancel an outgoing Check if you made a mistake when sending it or if circumstances have changed. If a Check expires, it's also necessary to cancel it to remove it from the ledger so the sender gets their [owner reserve](../../../concepts/accounts/reserves.md#owner-reserves) back.
{% set cancel_n = cycler(* range(1,99)) %}
## Prerequisites ## Prerequisites
To cancel a Check with this tutorial, you need the following: To cancel a Check with this tutorial, you need the following:
@@ -24,7 +22,7 @@ To cancel a Check with this tutorial, you need the following:
- A [client library](../../../references/client-libraries.md) or any HTTP or WebSocket library. - A [client library](../../../references/client-libraries.md) or any HTTP or WebSocket library.
## {{cancel_n.next()}}. Prepare the CheckCancel transaction ## 1. Prepare the CheckCancel transaction
Figure out the values of the [CheckCancel transaction][] fields. The following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing: Figure out the values of the [CheckCancel transaction][] fields. The following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing:
@@ -57,7 +55,7 @@ The following examples show how to cancel a Check.
{% /tabs %} {% /tabs %}
## {{cancel_n.next()}}. Sign the CheckCancel transaction ## 2. Sign the CheckCancel transaction
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -91,9 +89,8 @@ The following examples show how to cancel a Check.
{% /tabs %} {% /tabs %}
## {{cancel_n.next()}}. Submit the signed CheckCancel transaction ## 3. Submit the signed CheckCancel transaction
{% set step_1_link = "#1-prepare-the-checkcancel-transaction" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
### Example Request ### Example Request
@@ -125,11 +122,11 @@ The following examples show how to cancel a Check.
{% /tabs %} {% /tabs %}
## {{cancel_n.next()}}. Wait for validation ## 4. Wait for validation
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{cancel_n.next()}}. Confirm final result ## 5. Confirm final result
Use the [tx method][] with the CheckCancel transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final. Use the [tx method][] with the CheckCancel transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final.

View File

@@ -13,14 +13,12 @@ You might cash a Check for a flexible amount if you want to get as much as possi
The specified recipient can also [cash the check for an exact amount](cash-a-check-for-a-flexible-amount.md). The specified recipient can also [cash the check for an exact amount](cash-a-check-for-a-flexible-amount.md).
{% set cash_flex_n = cycler(* range(1,99)) %}
## Prerequisites ## Prerequisites
{% partial file="/_snippets/checkcash-prereqs.md" /%} {% partial file="/_snippets/checkcash-prereqs.md" /%}
## {{cash_flex_n.next()}}. Prepare the CheckCash transaction ## 1. Prepare the CheckCash transaction
Figure out the values of the [CheckCash transaction][] fields. To cash a check for a flexible amount, the following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing: Figure out the values of the [CheckCash transaction][] fields. To cash a check for a flexible amount, the following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing:
@@ -54,7 +52,7 @@ The following examples show how to prepare a transaction to cash a Check for a f
{% /tabs %} {% /tabs %}
## {{cash_flex_n.next()}}. Sign the CheckCash transaction ## 2. Sign the CheckCash transaction
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -80,9 +78,8 @@ The following examples show how to prepare a transaction to cash a Check for a f
{% /tabs %} {% /tabs %}
## {{cash_flex_n.next()}}. Submit the signed CheckCash transaction ## 3. Submit the signed CheckCash transaction
{% set step_1_link = "#1-prepare-the-checkcash-transaction" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
### Example Request ### Example Request
@@ -106,11 +103,11 @@ The following examples show how to prepare a transaction to cash a Check for a f
{% /tabs %} {% /tabs %}
## {{cash_flex_n.next()}}. Wait for validation ## 4. Wait for validation
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{cash_flex_n.next()}}. Confirm final result ## 5. Confirm final result
Use the [tx method][] with the CheckCash transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final. Use the [tx method][] with the CheckCash transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final.
@@ -149,7 +146,7 @@ If cashing the Check failed with a `tec`-class code, look up the code in the [Fu
| `tecPATH_PARTIAL` | The Check could not deliver enough tokens, either due to trust line limits or because the sender does not have enough balance of the token to send (including the issuer's [transfer fee](../../../concepts/tokens/transfer-fees.md), if there is one). | If the problem is the trust line limit, send a [TrustSet transaction][] to increase your limit (if desired) or lower your balance by spending some of the currency, then try to cash the Check again. If the problem is the sender's balance, wait for the sender to have more of the Check's currency, or try again to cash the Check for a lesser amount. | | `tecPATH_PARTIAL` | The Check could not deliver enough tokens, either due to trust line limits or because the sender does not have enough balance of the token to send (including the issuer's [transfer fee](../../../concepts/tokens/transfer-fees.md), if there is one). | If the problem is the trust line limit, send a [TrustSet transaction][] to increase your limit (if desired) or lower your balance by spending some of the currency, then try to cash the Check again. If the problem is the sender's balance, wait for the sender to have more of the Check's currency, or try again to cash the Check for a lesser amount. |
| `tecUNFUNDED_PAYMENT` | The Check could not deliver enough XRP. | Wait for the sender to have more XRP, or try again to cash the Check for a lesser amount. | | `tecUNFUNDED_PAYMENT` | The Check could not deliver enough XRP. | Wait for the sender to have more XRP, or try again to cash the Check for a lesser amount. |
## {{cash_flex_n.next()}}. Confirm delivered amount ## 6. Confirm delivered amount
If the Check was cashed for a flexible `DeliverMin` amount and succeeded, you can assume that the Check was cashed for at least the `DeliverMin` amount. To get the exact amount delivered, check the transaction metadata. The `delivered_amount` field in the metadata shows the exact amount delivered. (This field is only provided if the Check was cashed for a flexible amount. If the check was successfully cashed for a fixed amount, then the delivered amount is equal to the `Amount` of the CheckCash transaction.) If the Check was cashed for a flexible `DeliverMin` amount and succeeded, you can assume that the Check was cashed for at least the `DeliverMin` amount. To get the exact amount delivered, check the transaction metadata. The `delivered_amount` field in the metadata shows the exact amount delivered. (This field is only provided if the Check was cashed for a flexible amount. If the check was successfully cashed for a fixed amount, then the delivered amount is equal to the `Amount` of the CheckCash transaction.)
@@ -190,14 +187,8 @@ If the Check was cashed for a flexible `DeliverMin` amount and succeeded, you ca
- For tokens where the sender or recipient of the check is the issuer, the `RippleState` object representing the trust line between those accounts has its `Balance` adjusted in the favor of the Check's recipient. - For tokens where the sender or recipient of the check is the issuer, the `RippleState` object representing the trust line between those accounts has its `Balance` adjusted in the favor of the Check's recipient.
<!-- {# TODO: example of single-RippleState balance changes #}-->
- For tokens with a third-party issuer, there are changes to two `RippleState` objects, representing the trust lines connecting the sender to the issuer, and the issuer to the recipient. The `RippleState` object representing the relationship between the Check's sender and the issuer has its `Balance` changed in favor of the issuer, and the `RippleState` object representing the relationship between the issuer and the recipient has its `Balance` changed in favor of the recipient. - For tokens with a third-party issuer, there are changes to two `RippleState` objects, representing the trust lines connecting the sender to the issuer, and the issuer to the recipient. The `RippleState` object representing the relationship between the Check's sender and the issuer has its `Balance` changed in favor of the issuer, and the `RippleState` object representing the relationship between the issuer and the recipient has its `Balance` changed in favor of the recipient.
<!--{# TODO: example of double-RippleState balance changes #}-->
- If the token has a [transfer fee](../../../concepts/tokens/transfer-fees.md), the Check's sender may be debited more than the recipient is credited. (The difference is the transfer fee, which is returned to the issuer as a decreased net obligation.) - If the token has a [transfer fee](../../../concepts/tokens/transfer-fees.md), the Check's sender may be debited more than the recipient is credited. (The difference is the transfer fee, which is returned to the issuer as a decreased net obligation.)
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -11,13 +11,11 @@ As long as the Check is in the ledger and not expired, the specified recipient c
The specified recipient can also [cash the check for a flexible amount](cash-a-check-for-a-flexible-amount.md). The specified recipient can also [cash the check for a flexible amount](cash-a-check-for-a-flexible-amount.md).
{% set cash_exact_n = cycler(* range(1,99)) %}
## Prerequisites ## Prerequisites
{% partial file="/_snippets/checkcash-prereqs.md" /%} {% partial file="/_snippets/checkcash-prereqs.md" /%}
## {{cash_exact_n.next()}}. Prepare the CheckCash transaction ## 1. Prepare the CheckCash transaction
Figure out the values of the [CheckCash transaction][] fields. To cash a check for an exact amount, the following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing: Figure out the values of the [CheckCash transaction][] fields. To cash a check for an exact amount, the following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing:
@@ -53,7 +51,7 @@ The following examples show how to prepare a transaction to cash a Check for a f
{% /tabs %} {% /tabs %}
## {{cash_exact_n.next()}}. Sign the CheckCash transaction ## 2. Sign the CheckCash transaction
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -79,9 +77,8 @@ The following examples show how to prepare a transaction to cash a Check for a f
{% /tabs %} {% /tabs %}
## {{cash_exact_n.next()}}. Submit the signed CheckCash transaction ## 3. Submit the signed CheckCash transaction
{% set step_1_link = "#1-prepare-the-checkcash-transaction" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
### Example Request ### Example Request
@@ -105,11 +102,11 @@ The following examples show how to prepare a transaction to cash a Check for a f
{% /tabs %} {% /tabs %}
## {{cash_exact_n.next()}}. Wait for validation ## 4. Wait for validation
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{cash_exact_n.next()}}. Confirm final result ## 5. Confirm final result
Use the [tx method][] with the CheckCash transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final. Use the [tx method][] with the CheckCash transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final.
@@ -138,6 +135,4 @@ If cashing the Check failed, the Check remains in the ledger so you can try cash
{% /tabs %} {% /tabs %}
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -13,9 +13,6 @@ This tutorial shows how to look up [Checks](../../../concepts/payment-types/chec
To get a list of all incoming and outgoing Checks for an account, use the `account_objects` command with the recipient account's address and set the `type` field of the request to `checks`. To get a list of all incoming and outgoing Checks for an account, use the `account_objects` command with the recipient account's address and set the `type` field of the request to `checks`.
<!-- Moved this note to the account_objects method page. -->
**Note:** The commandline interface to the `account_objects` command does not accept the `type` field. You can use the [json method][] to send the JSON-RPC format request on the commandline instead.
### Example Request ### Example Request
{% tabs %} {% tabs %}
@@ -67,6 +64,4 @@ for (i=0; i < account_objects_response.account_objects.length; i++) {
} }
``` ```
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -11,12 +11,8 @@ This tutorial shows how to look up [Checks](../../../concepts/payment-types/chec
## 1. Look up all Checks for the address ## 1. Look up all Checks for the address
<!--{# TODO: Update if https://github.com/XRPLF/rippled/issues/2443 gets done #}-->
To get a list of all incoming and outgoing Checks for an account, use the `account_objects` command with the sending account's address and set the `type` field of the request to `checks`. To get a list of all incoming and outgoing Checks for an account, use the `account_objects` command with the sending account's address and set the `type` field of the request to `checks`.
<!-- This note moved to account_objects method page. -->
**Note:** The commandline interface to the `account_objects` command does not accept the `type` field. You can use the [json method][] to send the JSON-RPC format request on the commandline instead.
### Example Request ### Example Request
@@ -68,6 +64,4 @@ for (i=0; i < account_objects_response.account_objects.length; i++) {
} }
``` ```
<!--{# common links #}-->
{% raw-partial file="/_snippets/common-links.md" /%} {% raw-partial file="/_snippets/common-links.md" /%}

View File

@@ -15,8 +15,6 @@ This tutorial uses the example of a fictitious company, BoxSend SG (whose XRP Le
Outside of the XRP Ledger, Grand Payments sends an invoice to BoxSend SG with the ID `46060241FABCF692D4D934BA2A6C4427CD4279083E38C77CBE642243E43BE291`, and requests a Check for 100 XRP be sent to Grand Payments' XRP Ledger address of `rGPnRH1EBpHeTF2QG8DCAgM7z5pb75LAis`. <!-- SPELLING_IGNORE: boxsend --> Outside of the XRP Ledger, Grand Payments sends an invoice to BoxSend SG with the ID `46060241FABCF692D4D934BA2A6C4427CD4279083E38C77CBE642243E43BE291`, and requests a Check for 100 XRP be sent to Grand Payments' XRP Ledger address of `rGPnRH1EBpHeTF2QG8DCAgM7z5pb75LAis`. <!-- SPELLING_IGNORE: boxsend -->
{% set send_n = cycler(* range(1,99)) %}
## Prerequisites ## Prerequisites
To send a Check with this tutorial, you need the following: To send a Check with this tutorial, you need the following:
@@ -27,7 +25,7 @@ To send a Check with this tutorial, you need the following:
- A [secure way to sign transactions](../../../concepts/transactions/secure-signing.md). - A [secure way to sign transactions](../../../concepts/transactions/secure-signing.md).
- A [client library](../../../references/client-libraries.md) or any HTTP or WebSocket library. - A [client library](../../../references/client-libraries.md) or any HTTP or WebSocket library.
## {{send_n.next()}}. Prepare the CheckCreate transaction ## 1. Prepare the CheckCreate transaction
Decide how much money the Check is for and who can cash it. Figure out the values of the [CheckCreate transaction][] fields. The following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing: Decide how much money the Check is for and who can cash it. Figure out the values of the [CheckCreate transaction][] fields. The following fields are the bare minimum; everything else is either optional or can be [auto-filled](../../../references/protocol/transactions/common-fields.md#auto-fillable-fields) when signing:
@@ -62,7 +60,7 @@ The following example shows a prepared Check from BoxSend SG (`rBXsgNkPcDN2runsv
{% /tabs %} {% /tabs %}
## {{send_n.next()}}. Sign the CheckCreate transaction ## 2. Sign the CheckCreate transaction
{% partial file="/_snippets/tutorial-sign-step.md" /%} {% partial file="/_snippets/tutorial-sign-step.md" /%}
@@ -103,12 +101,10 @@ The following example shows a prepared Check from BoxSend SG (`rBXsgNkPcDN2runsv
{% /tabs %} {% /tabs %}
## {{send_n.next()}}. Submit the signed transaction ## 3. Submit the signed transaction
{% set step_1_link = "#1-prepare-the-checkcreate-transaction" %}
{% partial file="/_snippets/tutorial-submit-step.md" /%} {% partial file="/_snippets/tutorial-submit-step.md" /%}
### Example Request ### Example Request
{% tabs %} {% tabs %}
@@ -146,12 +142,12 @@ The following example shows a prepared Check from BoxSend SG (`rBXsgNkPcDN2runsv
{% /tabs %} {% /tabs %}
## {{send_n.next()}}. Wait for validation ## 4. Wait for validation
{% partial file="/_snippets/wait-for-validation.md" /%} {% partial file="/_snippets/wait-for-validation.md" /%}
## {{send_n.next()}}. Confirm final result ## 5. Confirm final result
Use the [tx method][] with the CheckCreate transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final. Use the [tx method][] with the CheckCreate transaction's identifying hash to check its status. Look for a `"TransactionResult": "tesSUCCESS"` field in the transaction's metadata, indicating that the transaction succeeded, and the field `"validated": true` in the result, indicating that this result is final.