ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs (raw order data)

Browse Source
This commit is contained in:
Elliot Lee
2018-05-24 20:02:45 -07:00
parent 95e39153da
commit d55aa2339f
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/index.md
View File

@@ -2470,9 +2470,9 @@ asks[] | object | An order in the order book.
*asks[].state.* fundedAmount | [amount](#amount) | How much of the amount the maker would have to pay that the maker currently holds. *asks[].state.* fundedAmount | [amount](#amount) | How much of the amount the maker would have to pay that the maker currently holds.
*asks[].state.* priceOfFundedAmount | [amount](#amount) | How much the `fundedAmount` would convert to through the exchange rate of this order. *asks[].state.* priceOfFundedAmount | [amount](#amount) | How much the `fundedAmount` would convert to through the exchange rate of this order.
### New in ripple-lib 0.22.0 and higher ### Raw order data
The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. (Requires ripple-lib 0.22.0 or higher.) The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields.
For details, see the rippled method [book_offers](https://ripple.com/build/rippled-apis/#book-offers). For details, see the rippled method [book_offers](https://ripple.com/build/rippled-apis/#book-offers).

4
docs/src/getOrderbook.md.ejs
View File

@@ -14,9 +14,9 @@ This method returns a promise that resolves with an object with the following st
<%- renderSchema('output/get-orderbook.json') %> <%- renderSchema('output/get-orderbook.json') %>
### New in ripple-lib 0.22.0 and higher ### Raw order data
The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. (Requires ripple-lib 0.22.0 or higher.) The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields.
For details, see the rippled method [book_offers](https://ripple.com/build/rippled-apis/#book-offers). For details, see the rippled method [book_offers](https://ripple.com/build/rippled-apis/#book-offers).