mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-17 18:25:50 +00:00
Links for checks tuts, rippled install, etc.
This commit is contained in:
@@ -12,6 +12,7 @@
|
||||
[seconds since the Ripple Epoch]: basic-data-types.html#specifying-time
|
||||
[Sequence Number]: basic-data-types.html#account-sequence
|
||||
[SHA-512Half]: ledger-data-formats.html#sha512half
|
||||
[Specifying Currency Amounts]: basic-data-types.html#specifying-currency-amounts
|
||||
[Specifying Ledgers]: basic-data-types.html#specifying-ledgers
|
||||
[Specifying Time]: basic-data-types.html#specifying-time
|
||||
[standard format]: response-formatting.html
|
||||
|
||||
@@ -136,7 +136,7 @@ The one argument to the constructor is an options object, which has [a variety o
|
||||
* The example `server` setting uses a secure WebSocket connection to connect to one of the public servers that Ripple (the company) operates.
|
||||
* If you don't include the `server` option, RippleAPI runs in [offline mode](reference-rippleapi.html#offline-functionality) instead, which only provides methods that don't need network connectivity.
|
||||
* You can specify a [Ripple Test Net](https://ripple.com/build/ripple-test-net/) server instead to connect to the parallel-world Test Network instead of the production XRP Ledger.
|
||||
* If you [run your own `rippled`](tutorial-rippled-setup.html), you can instruct it to connect to your local server. For example, you might say `server: 'ws://localhost:5005'` instead.
|
||||
* If you [run your own `rippled`](install-rippled.html), you can instruct it to connect to your local server. For example, you might say `server: 'ws://localhost:5005'` instead.
|
||||
|
||||
### Connecting and Promises
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Before you can run any commands against a `rippled` server, you must know which server you are connecting to. Most servers are configured not to accept API requests directly from the outside network.
|
||||
|
||||
Alternatively, you can [run your own local copy of `rippled`](tutorial-rippled-setup.html). This is required if you want to access any of the [Admin Commands](#list-of-admin-commands). In this case, you should use whatever IP and port you configured the server to bind. (For example, `127.0.0.1:54321`) Additionally, to access admin functionality, you must connect from a port/IP address marked as admin in the config file.
|
||||
Alternatively, you can [run your own local copy of `rippled`](install-rippled.html). This is required if you want to access any of the [Admin Commands](#list-of-admin-commands). In this case, you should use whatever IP and port you configured the server to bind. (For example, `127.0.0.1:54321`) Additionally, to access admin functionality, you must connect from a port/IP address marked as admin in the config file.
|
||||
|
||||
The [example config file](https://github.com/ripple/rippled/blob/release/doc/rippled-example.cfg#L907-L930) listens for connections on the local loopback network (127.0.0.1), with JSON-RPC (HTTP) on port 5005 and WebSocket (WS) on port 6006, and treats all connected clients as admin.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ You need an XRP Ledger address that can send transactions, and has enough XRP av
|
||||
If you started `rippled` in [stand-alone mode](stand-alone-mode.html) with a new genesis ledger, you must:
|
||||
|
||||
1. Generate keys for a new address, or reuse keys you already have.
|
||||
2. Submit a Payment transaction to fund the new address from the genesis account. (Send at least 100,000,000 [drops of XRP](reference-rippled.html#specifying-currency-amounts).)
|
||||
2. Submit a Payment transaction to fund the new address from the genesis account. (Send at least 100,000,000 [drops of XRP][].)
|
||||
3. Manually close the ledger.
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ Take note of the `account_id` (XRP Ledger Address) and `master_seed` (secret key
|
||||
|
||||
## 3. Send SignerListSet transaction
|
||||
|
||||
[Sign and submit](reference-transaction-format.html#signing-and-submitting-transactions) a [SignerListSet transaction](reference-transaction-format.html#signerlistset) in the normal (single-signature) way. This associates a SignerList with your XRP Ledger address, so that a combination of signatures from the members of that SignerList can multi-sign later transactions on your behalf.
|
||||
[Sign and submit](transaction-basics.html#signing-and-submitting-transactions) a [SignerListSet transaction][] in the normal (single-signature) way. This associates a SignerList with your XRP Ledger address, so that a combination of signatures from the members of that SignerList can multi-sign later transactions on your behalf.
|
||||
|
||||
In this example, the SignerList has 3 members, with the weights and quorum set up such that multi-signed transactions need a signature from rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW plus at least one signature from the other two members of the list.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
`rippled` is the core peer-to-peer server that manages the XRP Ledger. A `rippled` server can connect to a network of peers, relay cryptographically signed transactions, and maintain a local copy of the complete shared global ledger.
|
||||
|
||||
For an overview of `rippled`, see [Operating rippled Servers](tutorial-rippled-setup.html).
|
||||
For an overview of `rippled`, see [Operating rippled Servers](install-rippled.html).
|
||||
|
||||
Use these instructions to build a `rippled` executable from source version 0.90.0 or higher on Ubuntu Linux 16.04 or higher. These instructions were tested on Ubuntu 16.04 LTS.
|
||||
|
||||
@@ -17,7 +17,7 @@ You need a **minimum** of 8GB of RAM.
|
||||
|
||||
**_To run `rippled`:_**
|
||||
|
||||
Meet these [system requirements](tutorial-rippled-setup.html#minimum-system-requirements).
|
||||
Meet these [system requirements](install-rippled.html#minimum-system-requirements).
|
||||
|
||||
|
||||
## 1. Build `rippled`
|
||||
@@ -182,7 +182,7 @@ Watchdog: Launching child 1
|
||||
|
||||
## Explore Next Steps
|
||||
|
||||
* Now that you have a stock `rippled` server running, you may want to consider running it as a validating server. For information about validating servers and why you might want to run one, see the [rippled Setup Tutorial](tutorial-rippled-setup.html).
|
||||
* Now that you have a stock `rippled` server running, you may want to consider running it as a validating server. For information about validating servers and why you might want to run one, see the [rippled Setup Tutorial](install-rippled.html).
|
||||
|
||||
* For information about communicating with your `rippled` server using the `rippled` API, see the [`rippled` API reference](reference-rippled.html).
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Load a Saved Ledger in Stand-Alone Mode
|
||||
|
||||
You can start with a ledger version that was saved to disk if your `rippled` server was previously synced with the XRP Ledger peer-to-peer network (either the production network or the [Test Net](tutorial-rippled-setup.html#parallel-networks)).
|
||||
You can start with a ledger version that was saved to disk if your `rippled` server was previously synced with the XRP Ledger peer-to-peer network (either the production network or the [Test Net](parallel-networks.html)).
|
||||
|
||||
## 1. Start `rippled` normally.
|
||||
|
||||
|
||||
@@ -15,14 +15,14 @@ To cancel a Check with this tutorial, you need the following:
|
||||
- You need the ID of a Check object currently in the ledger.
|
||||
- For example, this tutorial includes examples that cancel a Check with the ID `49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0`, although you must use a different ID to go through these steps yourself.
|
||||
- The **address** and **secret key** of a funded account to send the CheckCancel transaction. This address must be either the sender or the recipient of the Check, unless the Check is expired.
|
||||
- A secure way to sign transactions, such as [RippleAPI][] or your own [`rippled` server](tutorial-rippled-setup.html).
|
||||
- A secure way to sign transactions, such as [RippleAPI][] or your own [`rippled` server](install-rippled.html).
|
||||
- A client library that can connect to a `rippled` server, such as [RippleAPI][] or any HTTP or WebSocket library.
|
||||
- For more information, see [Connecting to `rippled`](reference-rippled.html#connecting-to-rippled).
|
||||
- For more information, see [Get Started with the `rippled` API](get-started-with-the-rippled-api.html).
|
||||
|
||||
|
||||
## {{cancel_n.next()}}. 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](reference-transaction-format.html#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](transaction-common-fields.html#auto-fillable-fields) when signing:
|
||||
|
||||
| Field | Value | Description |
|
||||
|:------------------|:-----------------|:--------------------------------------|
|
||||
@@ -151,7 +151,7 @@ The following examples demonstrate how to cancel a Check.
|
||||
|
||||
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.
|
||||
|
||||
Look for a `DeletedNode` object in the transaction metadata with `"LedgerEntryType": "Check"` to indicate that the transaction removed a [Check ledger object](reference-ledger-format.html#check). The `LedgerIndex` of this object should match the ID of the Check.
|
||||
Look for a `DeletedNode` object in the transaction metadata with `"LedgerEntryType": "Check"` to indicate that the transaction removed a [Check ledger object](check.html). The `LedgerIndex` of this object should match the ID of the Check.
|
||||
|
||||
### Example Request
|
||||
|
||||
@@ -190,8 +190,8 @@ Look for a `DeletedNode` object in the transaction metadata with `"LedgerEntryTy
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
<!--{# common links #}-->
|
||||
[Specifying Currency Amounts]: reference-rippled.html#specifying-currency-amounts
|
||||
[RippleAPI]: reference-rippleapi.html
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
<!--{# common link defs #}-->
|
||||
[RippleAPI]: rippleapi.html
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -17,7 +17,7 @@ The specified recipient can also [cash the check for an exact amount](tutorial-c
|
||||
|
||||
## {{cash_flex_n.next()}}. 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](reference-transaction-format.html#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](transaction-common-fields.html#auto-fillable-fields) when signing:
|
||||
|
||||
| Field | Value | Description |
|
||||
|:------------------|:--------------------------|:-----------------------------|
|
||||
@@ -204,7 +204,6 @@ If the Check was cashed for a flexible `DeliverMin` amount and succeeded, you ca
|
||||
- If the issued currency has a [transfer fee](transfer-fees.html), 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 #}-->
|
||||
[Specifying Currency Amounts]: reference-rippled.html#specifying-currency-amounts
|
||||
[RippleAPI]: reference-rippleapi.html
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
|
||||
@@ -14,7 +14,7 @@ The specified recipient can also [cash the check for a flexible amount](tutorial
|
||||
|
||||
## {{cash_exact_n.next()}}. 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](reference-transaction-format.html#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](transaction-common-fields.html#auto-fillable-fields) when signing:
|
||||
|
||||
| Field | Value | Description |
|
||||
|:------------------|:--------------------------|:-----------------------------|
|
||||
@@ -148,7 +148,6 @@ If cashing the Check failed, the Check remains in the ledger so you can try cash
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
<!--{# common links #}-->
|
||||
[Specifying Currency Amounts]: reference-rippled.html#specifying-currency-amounts
|
||||
[RippleAPI]: reference-rippleapi.html
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
|
||||
@@ -74,7 +74,6 @@ for (i=0; i < account_objects_response.account_objects.length; i++) {
|
||||
```
|
||||
|
||||
<!--{# common links #}-->
|
||||
[Specifying Currency Amounts]: reference-rippled.html#specifying-currency-amounts
|
||||
[RippleAPI]: reference-rippleapi.html
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
|
||||
@@ -75,7 +75,6 @@ for (i=0; i < account_objects_response.account_objects.length; i++) {
|
||||
```
|
||||
|
||||
<!--{# common links #}-->
|
||||
[Specifying Currency Amounts]: reference-rippled.html#specifying-currency-amounts
|
||||
[RippleAPI]: reference-rippleapi.html
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
_Requires the [Checks Amendment](known-amendments.html#checks)._
|
||||
|
||||
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](reference-ledger-format.html#check) which the recipient can cash later.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@@ -19,13 +19,13 @@ To send a Check with this tutorial, you need the following:
|
||||
- The **address** and **secret key** of a funded account to send the Check from.
|
||||
- You can use the [XRP Ledger Test Net Faucet](https://ripple.com/build/xrp-test-net/) to get a funded address and secret with 10,000 Test Net XRP.
|
||||
- The **address** of a funded account to receive the Check.
|
||||
- A secure way to sign transactions, such as [RippleAPI][] or your own [`rippled` server](tutorial-rippled-setup.html).
|
||||
- A secure way to sign transactions, such as [RippleAPI][] or your own [`rippled` server](install-rippled.html).
|
||||
- A client library that can connect to a `rippled` server, such as [RippleAPI][] or any HTTP or WebSocket library.
|
||||
- For more information, see [Connecting to `rippled`](reference-rippled.html#connecting-to-rippled).
|
||||
- For more information, see [Get Started with the `rippled` API](get-started-with-the-rippled-api.html).
|
||||
|
||||
## {{send_n.next()}}. 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](reference-transaction-format.html#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](transaction-common-fields.html#auto-fillable-fields) when signing:
|
||||
|
||||
| Field | Value | Description |
|
||||
|:------------------|:--------------------------|:-----------------------------|
|
||||
@@ -67,6 +67,7 @@ The following example shows a prepared Check from BoxSend SG (rBXsgNkPcDN2runsvW
|
||||
## {{send_n.next()}}. Sign the CheckCreate transaction
|
||||
|
||||
{% include '_snippets/tutorial-sign-step.md' %}
|
||||
<!--{#_ #}-->
|
||||
|
||||
### Example Request
|
||||
|
||||
@@ -120,6 +121,7 @@ The following example shows a prepared Check from BoxSend SG (rBXsgNkPcDN2runsvW
|
||||
|
||||
{% set step_1_link = "#1-prepare-the-checkcreate-transaction" %}
|
||||
{% include '_snippets/tutorial-submit-step.md' %}
|
||||
<!--{#_ #}-->
|
||||
|
||||
### Example Request
|
||||
|
||||
@@ -173,12 +175,13 @@ The following example shows a prepared Check from BoxSend SG (rBXsgNkPcDN2runsvW
|
||||
## {{send_n.next()}}. Wait for validation
|
||||
|
||||
{% include '_snippets/wait-for-validation.md' %}
|
||||
<!--{#_ #}-->
|
||||
|
||||
## {{send_n.next()}}. 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.
|
||||
|
||||
Look for a `CreatedNode` object in the transaction metadata to indicate that the transaction created a [Check ledger object](reference-ledger-format.html#check). The `LedgerIndex` of this object is the ID of the Check. In the following example, the Check's ID is `49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0`.
|
||||
Look for a `CreatedNode` object in the transaction metadata to indicate that the transaction created a [Check ledger object](check.html). The `LedgerIndex` of this object is the ID of the Check. In the following example, the Check's ID is `49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0`.
|
||||
|
||||
**Note:** RippleAPI does not report the Check's ID when you look up a CheckCreate transaction. You can work around this by calculating the Check's ID from the [Check ID format](reference-ledger-format.html#check-id-format), as in the example RippleAPI code below. <!--{# TODO: Remove this and update the code samples if ripple-lib #876 gets fixed. #}-->
|
||||
|
||||
@@ -230,7 +233,8 @@ Look for a `CreatedNode` object in the transaction metadata to indicate that the
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
<!--{# common links #}-->
|
||||
[Specifying Currency Amounts]: reference-rippled.html#specifying-currency-amounts
|
||||
<!--{# common link defs #}-->
|
||||
[RippleAPI]: reference-rippleapi.html
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Look up escrows
|
||||
|
||||
All pending escrows are stored in the ledger as [Escrow objects](reference-ledger-format.html#escrow).
|
||||
All pending escrows are stored in the ledger as [Escrow objects](escrow.html).
|
||||
|
||||
You can look up escrow objects by the [sender's address](#look-up-escrows-by-sender-address) or the [destination address](#look-up-escrows-by-destination-address) using the [`account_objects`](reference-rippled.html#account-objects) method.
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ print(cancel_after)
|
||||
|
||||
## 3. Submit EscrowCreate transaction
|
||||
|
||||
[Sign and submit](reference-transaction-format.html#signing-and-submitting-transactions) an [EscrowCreate transaction][]. Set the `Condition` field of the transaction to the time when the held payment should be released. Set the `Destination` to the recipient, which can be the same address as the sender. Include the `CancelAfter` or `FinishAfter` time you calculated in the previous step. Set the `Amount` to the total amount of [XRP, in drops](reference-rippled.html#specifying-currency-amounts), to escrow.
|
||||
[Sign and submit](reference-transaction-format.html#signing-and-submitting-transactions) an [EscrowCreate transaction][]. Set the `Condition` field of the transaction to the time when the held payment should be released. Set the `Destination` to the recipient, which can be the same address as the sender. Include the `CancelAfter` or `FinishAfter` time you calculated in the previous step. Set the `Amount` to the total amount of [XRP, in drops][], to escrow.
|
||||
|
||||
{% include '_snippets/secret-key-warning.md' %} <!--#{ fix md highlighting_ #}-->
|
||||
|
||||
@@ -94,7 +94,7 @@ Response:
|
||||
|
||||
## 5. Confirm that the escrow was created
|
||||
|
||||
Use the [tx method][] with the transaction's identifying hash to check its final status. In particular, look for a `CreatedNode` in the transaction metadata to indicate that it created an [Escrow ledger object](reference-ledger-format.html#escrow).
|
||||
Use the [tx method][] with the transaction's identifying hash to check its final status. In particular, look for a `CreatedNode` in the transaction metadata to indicate that it created an [Escrow ledger object](escrow.html).
|
||||
|
||||
Request:
|
||||
|
||||
@@ -175,6 +175,7 @@ Response:
|
||||
```
|
||||
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
|
||||
@@ -37,7 +37,7 @@ print(release_date_ripple)
|
||||
|
||||
## 2. Submit EscrowCreate transaction
|
||||
|
||||
[Sign and submit](reference-transaction-format.html#signing-and-submitting-transactions) an [EscrowCreate transaction][]. Set the `FinishAfter` field of the transaction to the time when the held payment should be released. Omit the `Condition` field to make time the only condition for releasing the held payment. Set the `Destination` to the recipient, which may be the same address as the sender. Set the `Amount` to the total amount of [XRP, in drops](reference-rippled.html#specifying-currency-amounts), to escrow.
|
||||
[Sign and submit](reference-transaction-format.html#signing-and-submitting-transactions) an [EscrowCreate transaction][]. Set the `FinishAfter` field of the transaction to the time when the held payment should be released. Omit the `Condition` field to make time the only condition for releasing the held payment. Set the `Destination` to the recipient, which may be the same address as the sender. Set the `Amount` to the total amount of [XRP, in drops][], to escrow.
|
||||
|
||||
{% include '_snippets/secret-key-warning.md' %} <!--#{ fix md highlighting_ #}-->
|
||||
|
||||
@@ -74,7 +74,7 @@ Take note of the transaction's identifying `hash` value so you can check its fin
|
||||
|
||||
## 4. Confirm that the escrow was created
|
||||
|
||||
Use the [tx method][] with the transaction's identifying hash to check its final status. Look for a `CreatedNode` in the transaction metadata to indicate that it created an [Escrow ledger object](reference-ledger-format.html#escrow).
|
||||
Use the [tx method][] with the transaction's identifying hash to check its final status. Look for a `CreatedNode` in the transaction metadata to indicate that it created an [Escrow ledger object](escrow.html).
|
||||
|
||||
Request:
|
||||
|
||||
@@ -200,6 +200,8 @@ Response:
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
|
||||
@@ -155,7 +155,7 @@ In the response from the JSON-RPC, the payer should look for the following:
|
||||
- In the transaction's `meta` field, confirm that the `TransactionResult` is `tesSUCCESS`.
|
||||
- Confirm that the response has `"validated":true` to indicate the data comes from a validated ledger. (The result `tesSUCCESS` is only [final](reference-transaction-format.html#finality-of-results) if it appears in a validated ledger version.)
|
||||
- In the `AffectedNodes` array of the transaction's `meta` field, look for a `CreatedNode` object with the `LedgerEntryType` of `PayChannel`. The `LedgerIndex` field of the `CreatedNode` object indicates the Channel ID. (In the above example, this is a hex string starting with "5DB0...") The Channel ID is necessary later to sign claims.
|
||||
For more information on the PayChannel ledger object type, see [PayChannel ledger object](reference-ledger-format.html#paychannel).
|
||||
For more information on the PayChannel ledger object type, see [PayChannel ledger object](paychannel.html).
|
||||
|
||||
|
||||
## 2. The payee checks specifics of the payment channel.
|
||||
@@ -481,7 +481,7 @@ The channel can remain on the ledger in an expired state indefinitely. This is b
|
||||
|
||||
Ripple recommends that the payer sends a second [PaymentChannelClaim transaction][] with the `tfClose` flag for this purpose. However, other accounts, even those not involved in the payment channel, can cause an expired channel to close.
|
||||
|
||||
The command to submit the transaction is the same as the previous example requesting channel expiration. (However, its resulting [auto-filled](reference-transaction-format.html#auto-fillable-fields) `Sequence` number, signature, and identifying hash are unique.)
|
||||
The command to submit the transaction is the same as the previous example requesting channel expiration. (However, its resulting [auto-filled](transaction-common-fields.html#auto-fillable-fields) `Sequence` number, signature, and identifying hash are unique.)
|
||||
|
||||
Example of [submitting](reference-rippled.html#sign-and-submit-mode) a transaction to close an expired channel:
|
||||
|
||||
|
||||
@@ -187,7 +187,7 @@ Amounts of XRP are represented on the XRP Ledger as an unsigned integer count of
|
||||
|
||||
One drop (.000001 XRP) cannot be further subdivided. Keep this in mind when calculating and displaying FX rates between XRP and other assets.
|
||||
|
||||
For more information, see [Specifying Currency Amounts](reference-rippled.html#specifying-currency-amounts).
|
||||
For more information, see [Specifying Currency Amounts][].
|
||||
|
||||
#### On-Ledger and Off-Ledger
|
||||
|
||||
@@ -599,4 +599,7 @@ Off-Ledger Balances</td>
|
||||
</table>
|
||||
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
Reference in New Issue
Block a user