mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-17 18:25:50 +00:00
Merge branch 'gh-pages' of https://github.com/ripple/ripple-dev-portal into gh-pages
This commit is contained in:
@@ -353,7 +353,7 @@ Response:
|
||||
}
|
||||
```
|
||||
|
||||
To confirm that an account has DefaultRipple enabled, look up the account using the [account_info command](rippled-apis.html#account-info), specifying a validated ledger version. Use [a bitwise-AND operator](https://en.wikipedia.org/wiki/Bitwise_operation#AND) to compare the `Flags` field with 0x00800000 (the [ledger flag lsfDefaultRipple](https://wiki.ripple.com/Ledger_Format#AccountRoot)). If the result of the bitwise-AND operation is nonzero, then the account has DefaultRipple enabled.
|
||||
To confirm that an account has DefaultRipple enabled, look up the account using the [account_info command](rippled-apis.html#account-info), specifying a validated ledger version. Use [a bitwise-AND operator](https://en.wikipedia.org/wiki/Bitwise_operation#AND) to compare the `Flags` field with 0x00800000 (the [ledger flag lsfDefaultRipple](ripple-ledger.html#accountroot-flags)). If the result of the bitwise-AND operation is nonzero, then the account has DefaultRipple enabled.
|
||||
|
||||
|
||||
## Generating Source and Destination Tags ##
|
||||
|
||||
@@ -71,8 +71,8 @@ A path set is an array. Each member of the path set is another array that repres
|
||||
| account | String - Address | (Optional) If present, this path step represents rippling through the specified account. |
|
||||
| currency | String - currency code | (Optional) If present, this path step represents changing currencies through an order book. The currency specified indicates the new currency. |
|
||||
| issuer | String - Address | (Optional) If the path step represents changing currencies through an order book, this field indicates the issuer of the new currency. This field is not present when changing to XRP. |
|
||||
| type | Integer | **DEPRECATED**: An indicator of which other fields are present. |
|
||||
| type_hex | String | **DEPRECATED**: A hexadecimal representation of the `type` field. |
|
||||
| type | Integer | **DEPRECATED** (Optional) An indicator of which other fields are present. |
|
||||
| type_hex | String | **DEPRECATED**: (Optional) A hexadecimal representation of the `type` field. |
|
||||
|
||||
The `type` field, used for the binary serialization of a path set, is actually constructed through bitwise operations on a single integer. The bits are defined as follows:
|
||||
|
||||
|
||||
@@ -338,7 +338,7 @@ When an amount of currency is specified as part of a JSON body, it is encoded as
|
||||
|-------|------|-------------|
|
||||
| value | String (Quoted decimal) | The quantity of the currency |
|
||||
| currency | String | Three-digit [ISO 4217 Currency Code](http://www.xe.com/iso4217.php) specifying which currency. Alternatively, a 160-bit hex value. (Some advanced features, like [demurrage](https://ripple.com/wiki/Gateway_demurrage), require the hex version.) |
|
||||
| counterparty | String | (New in [v1.4.0](https://github.com/ripple/ripple-rest/releases/tag/1.4.0)) The Ripple address of the account that is a counterparty to this currency. This is usually an [issuing gateway](https://wiki.ripple.com/Gateway_List). Always omitted, or an empty string, for XRP. |
|
||||
| counterparty | String | (New in [v1.4.0](https://github.com/ripple/ripple-rest/releases/tag/1.4.0)) The Ripple address of the account that is a counterparty to this currency. This is usually an [issuing gateway](https://ripple.com/knowledge_center/gateways/). Always omitted, or an empty string, for XRP. |
|
||||
| issuer | String | (Prior to 1.4.0) **DEPRECATED** alias for `counterparty`. Some methods may still return this instead. |
|
||||
|
||||
|
||||
@@ -444,7 +444,7 @@ Submitted transactions can have additional fields reflecting the current status
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| direction | String | The direction of the payment relative to the account from the URL, either `"outgoing"` (sent by the account in the URL) or `"incoming"` (received by the account in the URL) |
|
||||
| result | String | The [Ripple transaction status code](https://wiki.ripple.com/Transaction_errors) for the transaction. A value of `"tesSUCCESS"` indicates a successful transaction. |
|
||||
| result | String | The [Ripple transaction status code](transactions.html#transaction-results) for the transaction. A value of `"tesSUCCESS"` indicates a successful transaction. |
|
||||
| timestamp | String | The time the ledger containing this transaction was validated, as a [ISO8601 extended format](http://en.wikipedia.org/wiki/ISO_8601) string in the form `YYYY-MM-DDTHH:mm:ss.sssZ`. |
|
||||
| fee | String (Quoted decimal) | The amount of XRP charged as a transaction fee. |
|
||||
| source_balance_changes | Array | Array of [Amount objects](#amount_object) indicating changes in balances held by the account sending the transaction as a result of the transaction. |
|
||||
@@ -522,9 +522,9 @@ An bid object describes an offer to exchange two currencies, including the curre
|
||||
| type | String (`buy` or `sell`) | Whether the order is to buy or sell. |
|
||||
| price | String ([Amount Object](#amount_object)) | The quoted price, denominated in total units of the counter currency per unit of the base currency |
|
||||
| taker\_pays\_total | String ([Amount Object](#amount_object)) | The total amount the taker must pay to consume this order. |
|
||||
| taker\_pays\_funded | String ([Amount Object](#amount_object)) | The actual amount the taker must pay to consume this order, if the order is [partially funded](https://wiki.ripple.com/Unfunded_offers). |
|
||||
| taker\_pays\_funded | String ([Amount Object](#amount_object)) | The actual amount the taker must pay to consume this order, if the order is [partially funded](transactions.html#lifecycle-of-an-offer). |
|
||||
| taker\_gets\_total | String ([Amount Object](#amount_object)) | The total amount the taker will get once the order is consumed. |
|
||||
| taker\_gets\_funded | String ([Amount Object](#amount_object)) | The actual amount the taker will get once the order is consumed, if the order is [partially funded](https://wiki.ripple.com/Unfunded_offers). |
|
||||
| taker\_gets\_funded | String ([Amount Object](#amount_object)) | The actual amount the taker will get once the order is consumed, if the order is [partially funded](transactions.html#lifecycle-of-an-offer). |
|
||||
| order\_maker | String | The Ripple address of the account that placed the bid or ask on the order book. |
|
||||
| sequence | Number | The sequence number of the transaction that created the order. Used in combination with account to uniquely identify the order. |
|
||||
| sell | Boolean | Whether the order should be [sell](https://ripple.com/build/transactions/#offercreate-flags). |
|
||||
@@ -740,7 +740,7 @@ The response contains a `settings` object, with the following fields:
|
||||
| wallet\_locator | String | (Not used) |
|
||||
| wallet\_size | String | (Not used) |
|
||||
| message\_key | String | A [secp256k1](https://en.bitcoin.it/wiki/Secp256k1) public key that should be used to encrypt secret messages to this account. |
|
||||
| domain | String | The domain that holds this account. Clients can use this to verify the account in the [ripple.txt](https://wiki.ripple.com/Ripple.txt) or [host-meta](https://wiki.ripple.com/Gateway_Services) of the domain. |
|
||||
| domain | String | The domain that holds this account. Clients can use this to verify the account in the [ripple.txt](https://wiki.ripple.com/Ripple.txt) of the domain. |
|
||||
| signers | (Undefined) | (To be used for [Multi-sign](https://wiki.ripple.com/M_of_N)) |
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user