Merge pull request #1629 from XRPLF/IA-checks-tutorials

Pull concept info out of checks tutorials.
This commit is contained in:
oeggert
2022-12-13 16:32:50 -08:00
committed by GitHub
8 changed files with 33 additions and 91 deletions

View File

@@ -7,8 +7,6 @@ labels:
---
# Cancel a Check
_Added by the [Checks amendment][]._
This tutorial shows how to cancel a [Check](checks.html), which removes the [Check object from the ledger](check.html) without sending money.
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](reserves.html#owner-reserves) back.

View File

@@ -7,8 +7,6 @@ labels:
---
# Cash a Check for a Flexible Amount
_Added by the [Checks amendment][]._
As long as the Check is in the ledger and not expired, the specified recipient can cash it to receive a flexible amount by sending a [CheckCash transaction][] with a `DeliverMin` field. When cashing a Check in this way, the receiver gets as much as is possible to deliver, debiting the Check's sender for the Check's full `SendMax` amount or as much as is available. Cashing fails if it doesn't deliver at least the `DeliverMin` amount to the Check's recipient.
You might cash a Check for a flexible amount if you want to get as much as possible from the Check.

View File

@@ -7,8 +7,6 @@ labels:
---
# Cash a Check for an Exact Amount
_Added by the [Checks amendment][]._
As long as the Check is in the ledger and not expired, the specified recipient can cash it to receive any exact amount up to the amount specified in the Check by sending a [CheckCash transaction][] with an `Amount` field. You would cash a Check this way if you want to receive a specific amount, for example to pay off an invoice or bill exactly.
The specified recipient can also [cash the check for a flexible amount](cash-a-check-for-a-flexible-amount.html).

View File

@@ -7,7 +7,7 @@ labels:
---
# Look Up Checks by Recipient
_Added by the [Checks amendment][]._
***TODO: Merge this with the look up checks by sender page.***
This tutorial shows how to look up [Checks](checks.html) by their recipient. You may also want to [look up Checks by sender](look-up-checks-by-sender.html).
@@ -15,6 +15,7 @@ This tutorial shows how to look up [Checks](checks.html) by their recipient. You
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

View File

@@ -7,7 +7,7 @@ labels:
---
# Look Up Checks by Sender
_Added by the [Checks amendment][]._
***TODO: Merge this with the look up checks by recipient page.***
This tutorial shows how to look up [Checks](checks.html) by their sender. You may also want to [look up Checks by recipient](look-up-checks-by-recipient.html).
@@ -17,6 +17,7 @@ This tutorial shows how to look up [Checks](checks.html) by their sender. You ma
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

View File

@@ -7,11 +7,11 @@ labels:
---
# Send a Check
_Added by the [Checks amendment][]._
Sending a Check is like writing permission for an intended recipient to pull a payment from you. The outcome of this process is a [Check object in the ledger](check.html) which the recipient can cash later.
<!--> Moved to checks.md
In many cases, you want to send a [Payment][] instead of a Check, since that delivers the money directly to the recipient in one step. However, if your intended recipient uses [DepositAuth](depositauth.html), you cannot send them Payments directly, so a Check is a good alternative.
<-->
This tutorial uses the example of a fictitious company, BoxSend SG (whose XRP Ledger address is `rBXsgNkPcDN2runsvWmwxk3Lh97zdgo9za`) paying a fictitious cryptocurrency consulting company named Grand Payments (with XRP Ledger address `rGPnRH1EBpHeTF2QG8DCAgM7z5pb75LAis`) for some consulting work. Grand Payments prefers be paid in XRP, but to simplify their taxes and regulation, only accepts payments they've explicitly approved.