From 9d0b2ab0ea74f55e801e7de2a0e2f287503c7743 Mon Sep 17 00:00:00 2001 From: Phu Pham Date: Mon, 30 Jan 2023 16:07:41 -0500 Subject: [PATCH] add readme to each folder --- .../_code-samples/claim-payment-channel/README.md | 5 +++++ .../{ => js}/claimPayChannel.ts | 0 content/_code-samples/get-tx/README.md | 5 +++++ content/_code-samples/multisigning/README.md | 5 +++++ content/_code-samples/partial-payment/README.md | 12 ++++++++++++ content/_code-samples/paths/README.md | 5 +++++ .../_code-samples/reliable-tx-submission/README.md | 9 +++++++++ content/_code-samples/set-regular-key/README.md | 5 +++++ 8 files changed, 46 insertions(+) create mode 100644 content/_code-samples/claim-payment-channel/README.md rename content/_code-samples/claim-payment-channel/{ => js}/claimPayChannel.ts (100%) create mode 100644 content/_code-samples/get-tx/README.md create mode 100644 content/_code-samples/multisigning/README.md create mode 100644 content/_code-samples/partial-payment/README.md create mode 100644 content/_code-samples/paths/README.md create mode 100644 content/_code-samples/reliable-tx-submission/README.md create mode 100644 content/_code-samples/set-regular-key/README.md diff --git a/content/_code-samples/claim-payment-channel/README.md b/content/_code-samples/claim-payment-channel/README.md new file mode 100644 index 0000000000..2a20a5eb5c --- /dev/null +++ b/content/_code-samples/claim-payment-channel/README.md @@ -0,0 +1,5 @@ +# Create and Claim a Payment Channel + +Create, claim and verify a Payment Channel. + +For more context, see [PayChannel](https://xrpl.org/paychannel.html#paychannel). diff --git a/content/_code-samples/claim-payment-channel/claimPayChannel.ts b/content/_code-samples/claim-payment-channel/js/claimPayChannel.ts similarity index 100% rename from content/_code-samples/claim-payment-channel/claimPayChannel.ts rename to content/_code-samples/claim-payment-channel/js/claimPayChannel.ts diff --git a/content/_code-samples/get-tx/README.md b/content/_code-samples/get-tx/README.md new file mode 100644 index 0000000000..20b6db5c51 --- /dev/null +++ b/content/_code-samples/get-tx/README.md @@ -0,0 +1,5 @@ +# Get a Transaction on the Ledger + +Retrieve and display a transaction on the ledger. + +For more context, see [tx Method](https://xrpl.org/tx.html). diff --git a/content/_code-samples/multisigning/README.md b/content/_code-samples/multisigning/README.md new file mode 100644 index 0000000000..3e84562189 --- /dev/null +++ b/content/_code-samples/multisigning/README.md @@ -0,0 +1,5 @@ +# Multisign a transaction. + +Create and submit a SignerListSet and multisign a transaction. + +For more context, see [Multi-signing](https://xrpl.org/multi-signing.html). diff --git a/content/_code-samples/partial-payment/README.md b/content/_code-samples/partial-payment/README.md new file mode 100644 index 0000000000..f42f0a32f9 --- /dev/null +++ b/content/_code-samples/partial-payment/README.md @@ -0,0 +1,12 @@ +# Send Partial Payments + +Send partial payments with money amount less than the amount specified on 2 conditions: + +- Sender has less money than the aamount specified in the payment Tx. +- Sender has the tfPartialPayment flag activated. + +Other ways to specify flags are by using Hex code and decimal code. +eg. For partial payment(tfPartialPayment) +decimal ->131072, hex -> 0x00020000 + +For more context, see [Partial Payments](https://xrpl.org/partial-payments.html) diff --git a/content/_code-samples/paths/README.md b/content/_code-samples/paths/README.md new file mode 100644 index 0000000000..da08ebc9ef --- /dev/null +++ b/content/_code-samples/paths/README.md @@ -0,0 +1,5 @@ +# Use Paths + +Extract paths from RipplePathFind and send a payment using paths. + +For more context, see [Paths](https://xrpl.org/paths.html). diff --git a/content/_code-samples/reliable-tx-submission/README.md b/content/_code-samples/reliable-tx-submission/README.md new file mode 100644 index 0000000000..3ec32315f5 --- /dev/null +++ b/content/_code-samples/reliable-tx-submission/README.md @@ -0,0 +1,9 @@ +# Implement Reliable Transaction Submission + +Send a transaction and see its validation response. For the implementation in this example, we have made the following decisions: + +- We allow the autofill function as a part of submitAndWait to fill up the account sequence, LastLedgerSequence and Fee. Payments are defined upfront, and idempotency is not needed. If the script is run a second time, duplicate payments will result. +- We will rely on the submitAndWait function to get us the transaction submission result after the wait time. +- Transactions will not be automatically retried. Transactions are limited to XRP-to-XRP payments and cannot "succeed" in an unexpected way. + +For more context, see [Reliable Transaction Submission](https://xrpl.org/reliable-transaction-submission.html) diff --git a/content/_code-samples/set-regular-key/README.md b/content/_code-samples/set-regular-key/README.md new file mode 100644 index 0000000000..469e3e7ca6 --- /dev/null +++ b/content/_code-samples/set-regular-key/README.md @@ -0,0 +1,5 @@ +# Use `SetRegularKey` + +Use `SetRegularKey` to assign a key pair to a wallet and make a payment signed using the regular key wallet. + +For more context, see [SetRegularKey](https://xrpl.org/setregularkey.html).