Merge pull request #2792 from mDuo13/escrow_update_code

Clean up some Escrow code sample issues
XRPLF · Oct 15, 2024 · 687445e · 687445e
2 parents 82ff22a + 5835468
commit 687445e
Show file tree

Hide file tree

Showing 42 changed files with 142 additions and 195 deletions.
diff --git a/...s/how-tos/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.md b/...s/how-tos/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.md
@@ -18,7 +18,7 @@ XRP LedgerのEscrowが有効期限切れとなるのは、その`CancelAfter`の
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/ledger-request-expiration.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/ledger-request-expiration.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -28,7 +28,7 @@ XRP LedgerのEscrowが有効期限切れとなるのは、その`CancelAfter`の
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/ledger-response-expiration.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/ledger-response-expiration.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -41,7 +41,7 @@ XRP LedgerのEscrowが有効期限切れとなるのは、その`CancelAfter`の
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/account_objects-request-expiration.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/account_objects-request-expiration.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -51,7 +51,7 @@ XRP LedgerのEscrowが有効期限切れとなるのは、その`CancelAfter`の
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/account_objects-response-expiration.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/account_objects-response-expiration.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -67,7 +67,7 @@ XRP Ledgerでは、[EscrowCancelトランザクション][]に[署名して送
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-request-escrowcancel.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-request-escrowcancel.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -77,7 +77,7 @@ XRP Ledgerでは、[EscrowCancelトランザクション][]に[署名して送
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-response-escrowcancel.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-response-escrowcancel.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -97,7 +97,7 @@ EscrowCancelトランザクションの識別用ハッシュを指定した[tx
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-request-escrowcancel.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-request-escrowcancel.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -107,7 +107,7 @@ EscrowCancelトランザクションの識別用ハッシュを指定した[tx
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-response-escrowcancel.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-response-escrowcancel.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}

diff --git a/.../tutorials/how-tos/use-specialized-payment-types/use-escrows/look-up-escrows.md b/.../tutorials/how-tos/use-specialized-payment-types/use-escrows/look-up-escrows.md
@@ -24,7 +24,7 @@ Escrowオブジェクトを検索するには、[account_objectsメソッド][]
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/account_objects-request.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/account_objects-request.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -39,7 +39,7 @@ Escrowオブジェクトを検索するには、[account_objectsメソッド][]
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/account_objects-response.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/account_objects-response.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -57,7 +57,7 @@ Escrowオブジェクトを検索するには、[account_objectsメソッド][]
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/account_objects-request.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/account_objects-request.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -72,7 +72,7 @@ Escrowオブジェクトを検索するには、[account_objectsメソッド][]
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/account_objects-response.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/account_objects-response.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}

diff --git a/...s/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.md b/...s/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.md
@@ -81,7 +81,7 @@ print(cancel_after)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-request-escrowcreate-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-request-escrowcreate-condition.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -91,7 +91,7 @@ print(cancel_after)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-response-escrowcreate-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-response-escrowcreate-condition.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -109,7 +109,7 @@ print(cancel_after)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-request-escrowcreate-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-request-escrowcreate-condition.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -119,7 +119,7 @@ print(cancel_after)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-response-escrowcreate-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-response-escrowcreate-condition.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -137,7 +137,7 @@ Escrowが有効期限切れの場合は、[Escrowの取消し](cancel-an-expired
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-request-escrowfinish-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-request-escrowfinish-condition.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -147,7 +147,7 @@ Escrowが有効期限切れの場合は、[Escrowの取消し](cancel-an-expired
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-response-escrowfinish-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-response-escrowfinish-condition.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -164,10 +164,10 @@ EscrowFinishトランザクションの識別用ハッシュを指定した[tx
 
 リクエスト:
 
-{% code-snippet file="/_code-samples/escrow/websocket/tx-request-escrowfinish-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-request-escrowfinish-condition.json" language="json" /%}
 
 レスポンス:
 
-{% code-snippet file="/_code-samples/escrow/websocket/tx-response-escrowfinish-condition.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-response-escrowfinish-condition.json" language="json" /%}
 
 {% raw-partial file="/docs/_snippets/common-links.md" /%}
diff --git a/...ls/how-tos/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.md b/...ls/how-tos/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.md
@@ -52,7 +52,7 @@ print(release_date_ripple)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-request-escrowcreate-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-request-escrowcreate-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -62,7 +62,7 @@ print(release_date_ripple)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-response-escrowcreate-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-response-escrowcreate-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -83,7 +83,7 @@ print(release_date_ripple)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-request-escrowcreate-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-request-escrowcreate-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -93,7 +93,7 @@ print(release_date_ripple)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-response-escrowcreate-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-response-escrowcreate-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -109,7 +109,7 @@ print(release_date_ripple)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/ledger-request.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/ledger-request.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -119,7 +119,7 @@ print(release_date_ripple)
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/ledger-response.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/ledger-response.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -140,7 +140,7 @@ Escrowが有効期限切れの場合は、[Escrowの取消し](cancel-an-expired
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-request-escrowfinish-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-request-escrowfinish-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -150,7 +150,7 @@ Escrowが有効期限切れの場合は、[Escrowの取消し](cancel-an-expired
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/submit-response-escrowfinish-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/submit-response-escrowfinish-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -170,7 +170,7 @@ EscrowFinishトランザクションの識別用ハッシュを指定した[tx
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-request-escrowfinish-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-request-escrowfinish-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}
@@ -180,7 +180,7 @@ EscrowFinishトランザクションの識別用ハッシュを指定した[tx
 {% tabs %}
 
 {% tab label="Websocket" %}
-{% code-snippet file="/_code-samples/escrow/websocket/tx-response-escrowfinish-time.json" language="json" /%}
+{% code-snippet file="/_api-examples/escrow/websocket/tx-response-escrowfinish-time.json" language="json" /%}
 {% /tab %}
 
 {% /tabs %}

diff --git a/...t/account_objects-request-expiration.json → ...t/account_objects-request-expiration.json b/...t/account_objects-request-expiration.json → ...t/account_objects-request-expiration.json
diff --git a/...ow/websocket/account_objects-request.json → ...ow/websocket/account_objects-request.json b/...ow/websocket/account_objects-request.json → ...ow/websocket/account_objects-request.json
diff --git a/.../account_objects-response-expiration.json → .../account_objects-response-expiration.json b/.../account_objects-response-expiration.json → .../account_objects-response-expiration.json
diff --git a/...w/websocket/account_objects-response.json → ...w/websocket/account_objects-response.json b/...w/websocket/account_objects-response.json → ...w/websocket/account_objects-response.json
diff --git a/.../websocket/ledger-request-expiration.json → .../websocket/ledger-request-expiration.json b/.../websocket/ledger-request-expiration.json → .../websocket/ledger-request-expiration.json
diff --git a/...ples/escrow/websocket/ledger-request.json → ...ples/escrow/websocket/ledger-request.json b/...ples/escrow/websocket/ledger-request.json → ...ples/escrow/websocket/ledger-request.json
diff --git a/...websocket/ledger-response-expiration.json → ...websocket/ledger-response-expiration.json b/...websocket/ledger-response-expiration.json → ...websocket/ledger-response-expiration.json
diff --git a/...les/escrow/websocket/ledger-response.json → ...les/escrow/websocket/ledger-response.json b/...les/escrow/websocket/ledger-response.json → ...les/escrow/websocket/ledger-response.json
diff --git a/...ebsocket/submit-request-escrowcancel.json → ...ebsocket/submit-request-escrowcancel.json b/...ebsocket/submit-request-escrowcancel.json → ...ebsocket/submit-request-escrowcancel.json
diff --git a/...ubmit-request-escrowcreate-condition.json → ...ubmit-request-escrowcreate-condition.json b/...ubmit-request-escrowcreate-condition.json → ...ubmit-request-escrowcreate-condition.json
diff --git a/...ket/submit-request-escrowcreate-time.json → ...ket/submit-request-escrowcreate-time.json b/...ket/submit-request-escrowcreate-time.json → ...ket/submit-request-escrowcreate-time.json
diff --git a/...ubmit-request-escrowfinish-condition.json → ...ubmit-request-escrowfinish-condition.json b/...ubmit-request-escrowfinish-condition.json → ...ubmit-request-escrowfinish-condition.json
diff --git a/...ket/submit-request-escrowfinish-time.json → ...ket/submit-request-escrowfinish-time.json b/...ket/submit-request-escrowfinish-time.json → ...ket/submit-request-escrowfinish-time.json
diff --git a/...bsocket/submit-response-escrowcancel.json → ...bsocket/submit-response-escrowcancel.json b/...bsocket/submit-response-escrowcancel.json → ...bsocket/submit-response-escrowcancel.json
diff --git a/...bmit-response-escrowcreate-condition.json → ...bmit-response-escrowcreate-condition.json b/...bmit-response-escrowcreate-condition.json → ...bmit-response-escrowcreate-condition.json
diff --git a/...et/submit-response-escrowcreate-time.json → ...et/submit-response-escrowcreate-time.json b/...et/submit-response-escrowcreate-time.json → ...et/submit-response-escrowcreate-time.json
diff --git a/...bmit-response-escrowfinish-condition.json → ...bmit-response-escrowfinish-condition.json b/...bmit-response-escrowfinish-condition.json → ...bmit-response-escrowfinish-condition.json
diff --git a/...et/submit-response-escrowfinish-time.json → ...et/submit-response-escrowfinish-time.json b/...et/submit-response-escrowfinish-time.json → ...et/submit-response-escrowfinish-time.json
diff --git a/...ow/websocket/tx-request-escrowcancel.json → ...ow/websocket/tx-request-escrowcancel.json b/...ow/websocket/tx-request-escrowcancel.json → ...ow/websocket/tx-request-escrowcancel.json
diff --git a/...et/tx-request-escrowcreate-condition.json → ...et/tx-request-escrowcreate-condition.json b/...et/tx-request-escrowcreate-condition.json → ...et/tx-request-escrowcreate-condition.json
diff --git a/...bsocket/tx-request-escrowcreate-time.json → ...bsocket/tx-request-escrowcreate-time.json b/...bsocket/tx-request-escrowcreate-time.json → ...bsocket/tx-request-escrowcreate-time.json
diff --git a/...et/tx-request-escrowfinish-condition.json → ...et/tx-request-escrowfinish-condition.json b/...et/tx-request-escrowfinish-condition.json → ...et/tx-request-escrowfinish-condition.json
diff --git a/...bsocket/tx-request-escrowfinish-time.json → ...bsocket/tx-request-escrowfinish-time.json b/...bsocket/tx-request-escrowfinish-time.json → ...bsocket/tx-request-escrowfinish-time.json
diff --git a/...w/websocket/tx-response-escrowcancel.json → ...w/websocket/tx-response-escrowcancel.json b/...w/websocket/tx-response-escrowcancel.json → ...w/websocket/tx-response-escrowcancel.json
diff --git a/...t/tx-response-escrowcreate-condition.json → ...t/tx-response-escrowcreate-condition.json b/...t/tx-response-escrowcreate-condition.json → ...t/tx-response-escrowcreate-condition.json
diff --git a/...socket/tx-response-escrowcreate-time.json → ...socket/tx-response-escrowcreate-time.json b/...socket/tx-response-escrowcreate-time.json → ...socket/tx-response-escrowcreate-time.json
diff --git a/...t/tx-response-escrowfinish-condition.json → ...t/tx-response-escrowfinish-condition.json b/...t/tx-response-escrowfinish-condition.json → ...t/tx-response-escrowfinish-condition.json
diff --git a/...socket/tx-response-escrowfinish-time.json → ...socket/tx-response-escrowfinish-time.json b/...socket/tx-response-escrowfinish-time.json → ...socket/tx-response-escrowfinish-time.json
diff --git a/_code-samples/escrow/js/cancel-escrow-v2.js b/_code-samples/escrow/js/cancel-escrow-v2.js
diff --git a/_code-samples/escrow/js/cancel-escrow.js b/_code-samples/escrow/js/cancel-escrow.js
@@ -1,24 +1,21 @@
 'use strict'
-if (typeof module !== "undefined") {
-  // Use var here because const/let are block-scoped to the if statement.
-  var xrpl = require('xrpl')
-}
+const xrpl = require('xrpl');
 
 // Preqrequisites:
 // 1. Create an escrow using the create-escrow.js snippet
 // 2. Replace the OfferSequence with the sequence number of the escrow you created
 // 3. Paste the seed of the account that created the escrow
-// 4. Run the snippet
+// 4. Run this snippet
 
-const seed = "sEd7jfWyNG6J71dEojB3W9YdHp2KCjy";
-const sequenceNumber = null;
+const seed = "sEd7jfWyNG6J71dEojB3W9YdHp2KCjy"; // replace with your seed
+const sequenceNumber = 0; // replace with the sequence number of your escrow
 
-const main = async () => {
+async function main() {
   try {
     // Connect -------------------------------------------------------------------
     const client = new xrpl.Client('wss://s.altnet.rippletest.net:51233');
     await client.connect();
-    
+
     // Prepare wallet to sign the transaction -------------------------------------
     const wallet = await xrpl.Wallet.fromSeed(seed);
     console.log("Wallet Address: ", wallet.address);
@@ -45,7 +42,7 @@ const main = async () => {
     console.log(`Finished submitting! \n${JSON.stringify(response.result, null, "\t")}`);
 
     await client.disconnect();
-    
+
   } catch (error) {
     console.log(error);
   }