Add request(), hasNextPage(), and requestNextPage() #887
Conversation
src/api.ts
Outdated
| @@ -225,7 +241,7 @@ class RippleAPI extends EventEmitter { | |||
| // NOTE: We have to generalize the `this._request()` function signature | |||
| return this.api.request('ledger_data').then(response => { | ||
| return this.api.requestNextPage('ledger_data', {}, response); | ||
| }).then(response => { | ||
| assert.equal(response.state[0].index, '000B714B790C3C79FEE00D17C4DEB436B375466F29679447BA64F265FD63D731') |
There was a problem hiding this comment.
Should this instead use the fixture to compare?
There was a problem hiding this comment.
Since the value comes from the fixture, I think we want to compare with this hardcoded value in order to test that the next page of data was actually retrieved.
| assert(false, 'Should reject'); | ||
| }).catch(error => { | ||
| assert(error instanceof Error); | ||
| assert.equal(error.message, 'response does not have a next page') |
There was a problem hiding this comment.
It'd be nice to see (either here or in the hasNextPage test above) that hasNextPage returns false for the same response that requestNextPage rejects.
docs/src/rippledAPIs.md.ejs
Outdated
| Type | Description | ||
| ---- | ----------- | ||
| `ledgerClosed` | Sent by the `ledger` stream when the consensus process declares a new fully validated ledger. The message identifies the ledger and provides some information about its contents. | ||
| `validationReceived` | Sent by the validations stream when the server receives validation messages, also called validation votes, from validators it trusts. |
There was a problem hiding this comment.
This stream will include all validations received, not just those the rippled trusts.
XRPLF/xrpl-dev-portal#341
docs/src/requestNextPage.md.ejs
Outdated
|
|
||
| Requests the next page of data. | ||
|
|
||
| You can use this convenience method, or include `currentResponse.marker` in your `params` yourself. |
There was a problem hiding this comment.
maybe add "when using/calling request" at the end
|
|
||
| Refer to [rippled APIs](https://ripple.com/build/rippled-apis/) for commands and options. All XRP amounts must be specified in drops. One drop is equal to 0.000001 XRP. See [Specifying Currency Amounts](https://ripple.com/build/rippled-apis/#specifying-currency-amounts). | ||
|
|
||
| Most commands return data for the `current` (in-progress, open) ledger by default. Do not rely on this. Always specify a ledger version in your request. In the example below, the 'validated' ledger is requested, which is the most recent ledger that has been validated by the whole network. See [Specifying Ledgers](https://ripple.com/build/rippled-apis/#specifying-ledgers). |
There was a problem hiding this comment.
The top of this file still says
RippleAPI only provides access to validated, immutable transaction data.
https://github.com/ripple/ripple-lib/blob/develop/docs/index.md#introduction
|
Thanks @wilsonianb ! Please have a second look. |
docs/src/rippledAPIs.md.ejs
Outdated
| `ledgerClosed` | Sent by the `ledger` stream when the consensus process declares a new fully validated ledger. The message identifies the ledger and provides some information about its contents. | ||
| `validationReceived` | Sent by the `validations` stream when the server receives a validation message, also called a validation vote, regardless of whether the server trusts the validator. | ||
| `transaction` | Sent by many subscriptions including `transactions`, `transactions_proposed`, `accounts`, `accounts_proposed`, and `book` (Order Book). See [Transaction Streams](https://ripple.com/build/rippled-apis/#transaction-streams) for details. | ||
| `peerStatusChange` | Admin-only. Reports a large amount of information on the activities of other `rippled` servers to which the server is connected. |
There was a problem hiding this comment.
It looks like we don't actually handle all of these
https://github.com/ripple/ripple-lib/blob/develop/src/common/connection.ts#L10-L14
- Add docs for `streams`
docs/index.md
Outdated
| @@ -750,6 +753,183 @@ signature | string | *Optional* Signed claim authorizing withdrawal of XRP from | |||
| ``` | |||
|
|
|||
|
|
|||
| # rippled APIs | |||
|
|
|||
| ripple-lib relies on [rippled APIs](https://ripple.com/build/rippled-apis/) for all online functionality. With ripple-lib version 0.22.0 and higher, you can easily access rippled APIs through ripple-lib. Use the `request()`, `hasNextPage()`, and `requestNextPage()` methods: | |||
There was a problem hiding this comment.
Don't worry about the indicated version number, I will update this to be accurate before the release goes out.
|
@intelliot this looks great! Sorry I wasn't able to review, awesome work getting this pushed out! |
request()enables access to all rippled APIs.While
markercan be used directly for pagination, these methods are provided for convenience:hasNextPage(currentResponse)returnstruewhen there are more pages available.requestNextPage(command, params, currentResponse)returns a promise that resolves to the next page of data.