mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-28 15:45:50 +00:00
Clarifications grab bag (DOC-1086):
- Add payment_channel to account_objects type list - Clarify payment channel reserves in a couple places - Add owner_funds field to book_offers response
This commit is contained in:
@@ -23,6 +23,7 @@ Many objects in the ledger are owned by a particular address, and count toward t
|
||||
- [Trust lines](reference-ledger-format.html#ripplestate) are shared between two addresses. The owner reserve can apply to one or both of the addresses, depending on whether the fields that address controls are in their default state. See [Contributing to the Owner Reserve](reference-ledger-format.html#contributing-to-the-owner-reserve) for details.
|
||||
- A single [SignerList](reference-ledger-format.html#signerlist) counts as 3 to 10 objects for purposes of the owner reserve, depending on how many members it has. See also: [SignerLists and Reserves](reference-ledger-format.html#signerlists-and-reserves).
|
||||
- [Held Payments (Escrow)](reference-ledger-format.html#escrow) are owned by the address that placed them.
|
||||
- [Payment Channels](tutorial-paychan.html) are owned by the address that created them.
|
||||
- [Owner directories](reference-ledger-format.html#directorynode) list all the ledger nodes that contribute to an address's owner reserve. However, the owner directory itself does not count towards the reserve.
|
||||
|
||||
#### Owner Reserve Edge Cases ####
|
||||
|
||||
@@ -1571,7 +1571,7 @@ The request includes the following parameters:
|
||||
| `Field` | Type | Description |
|
||||
|:---------------|:-------------------------------------------|:---------------|
|
||||
| `account` | String | A unique identifier for the account, most commonly the account's address. |
|
||||
| `type` | String | _(Optional)_ If included, filter results to include only this type of ledger node. Valid types include `state` (trust lines), `offer` (offers), and `ticket` (part of the forthcoming signing process). |
|
||||
| `type` | String | _(Optional)_ If included, filter results to include only this type of ledger node. The valid types are: `offer`, `signer_list`, `state` (trust line), `escrow`, and `payment_channel`. <!-- Author's note: Omitted types from this list that can't be owned by an account: https://github.com/ripple/rippled/blob/1dbc5a57e6b0e90a9da0d6e56f2f5a99e6ac1d8c/src/ripple/rpc/impl/RPCHelpers.cpp#L676-L686 --> |
|
||||
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) |
|
||||
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) |
|
||||
| `limit` | Unsigned Integer | _(Optional)_ The maximum number of objects to include in the results. Must be within the inclusive range 10 to 400 on non-admin connections. Defaults to 200. |
|
||||
@@ -7753,6 +7753,7 @@ In addition to the standard Offer fields, the following fields may be included i
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:--------------------|:---------------------------------|:--------------------|
|
||||
| `owner_funds` | String (XRP) or Object (non-XRP) | Amount of the currency the side placing the offer has available to be traded. If a trader has multiple offers in the same book, only the highest-ranked offer includes this field. |
|
||||
| `taker_gets_funded` | String (XRP) or Object (non-XRP) | (Only included in partially-funded offers) The maximum amount of currency that the taker can get, given the funding status of the offer. |
|
||||
| `taker_pays_funded` | String (XRP) or Object (non-XRP) | (Only included in partially-funded offers) The maximum amount of currency that the taker would pay, given the funding status of the offer. |
|
||||
| `quality` | Number | The exchange rate, as the ratio `taker_pays` divided by `taker_gets`. For fairness, offers that have the same quality are automatically taken first-in, first-out. (In other words, if multiple people offer to exchange currency at the same rate, the oldest offer is taken first.) |
|
||||
|
||||
@@ -61,6 +61,8 @@ This is a [PaymentChannelCreate transaction][]. As part of this process, the pay
|
||||
|
||||
The following example shows creation of a payment channel by [submitting](reference-rippled.html#sign-and-submit-mode) to a local `rippled` server with the JSON-RPC API. The payment channel allocates 100 XRP from the [example payer](#example-values) (rN7n7...) to the [example payee](#example-values) (rf1Bi...) with a settlement delay of 1 day. The public key is the example payer's master public key, in hexadecimal.
|
||||
|
||||
**Note:** A payment channel counts as one object toward the payer's [owner reserve](concept-reserves.html#owner-reserves). The owner must keep at least enough XRP to satisfy the reserve after subtracting the XRP allocated to the payment channel.
|
||||
|
||||
Request:
|
||||
|
||||
POST http://localhost:5005/
|
||||
|
||||
Reference in New Issue
Block a user