ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 19:55:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] Update book_offers documentation

Browse Source 
- Use an orderbook that returns some output
- Use a limit to prevent the browser tab from crashing
- Removed language around pagination in websocket tool (not currently supported).
This commit is contained in:
Alan Cohen
2014-12-23 11:34:23 -08:00
parent 96da39d641
commit 5092095399
2 changed files with 15 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
content/rippled.md
View File

@@ -5891,15 +5891,13 @@ An example of the request format:
"command": "book_offers", "command": "book_offers",
"taker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "taker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"taker_gets": { "taker_gets": {
"value": "1", "currency": "XRP"
"currency": "EUR",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}, },
"taker_pays": { "taker_pays": {
"value": "1",
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
} },
"limit": 10
} }
``` ```
@@ -5912,15 +5910,13 @@ An example of the request format:
{ {
"taker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "taker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"taker_gets": { "taker_gets": {
"currency": "EUR", "currency": "XRP"
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "1"
}, },
"taker_pays": { "taker_pays": {
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "1" },
} "limit": 10
} }
] ]
} }

12
js/apitool-websocket.js
View File

@@ -219,9 +219,15 @@
ledger_hash: void(0), ledger_hash: void(0),
ledger_index: void(0), ledger_index: void(0),
taker: sample_address, taker: sample_address,
taker_gets: ripple.Amount.from_json('1/EUR/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B').to_json(), taker_gets: {
taker_pays: ripple.Amount.from_json('1/USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B').to_json(), currency: 'XRP'
_description: 'Returns the offers for an order book as one or more pages.', },
taker_pays: {
currency: 'USD',
issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
},
limit: 10,
_description: 'Returns a snapshot of the offers for an order book.',
_link: 'rippled-apis.html#book-offers' _link: 'rippled-apis.html#book-offers'
}); });