vacp2p
/
rfc
mirror of https://github.com/vacp2p/rfc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adds error field to history response (#433) 

* updates the History response

* minor edit

* Update content/docs/rfcs/13/README.md

Co-authored-by: oskarth <ot@oskarthoren.com>

* Update content/docs/rfcs/13/README.md

Co-authored-by: oskarth <ot@oskarthoren.com>

Co-authored-by: oskarth <ot@oskarthoren.com>
This commit is contained in:
Sanaz Taheri Boshrooyeh 2021-07-19 08:04:59 -07:00 committed by GitHub
parent c112dc7c57
commit 2be3e64cd8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/docs/rfcs/13/README.md
View File

@ -82,6 +82,11 @@ message HistoryResponse {
// the first field is reserved for future use // the first field is reserved for future use
repeated WakuMessage messages = 2; repeated WakuMessage messages = 2;
PagingInfo pagingInfo = 3; PagingInfo pagingInfo = 3;
enum Error {
NONE = 0;
INVALID_CURSOR = 1;
}
Error error = 4;
} }
message HistoryRPC { message HistoryRPC {
@ -142,6 +147,9 @@ RPC call to respond to a HistoryQuery call.
In the forward pagination, the `cursor` holds the `Index` of the last message in the `HistoryResponse` `messages` (and the first message in the backward paging). In the forward pagination, the `cursor` holds the `Index` of the last message in the `HistoryResponse` `messages` (and the first message in the backward paging).
The requester shall embed the returned `cursor` inside its next `HistoryQuery` to retrieve the next page of the waku messages. The requester shall embed the returned `cursor` inside its next `HistoryQuery` to retrieve the next page of the waku messages.
The `cursor` obtained from one node SHOULD NOT be used in a request to another node because the result MAY be different. The `cursor` obtained from one node SHOULD NOT be used in a request to another node because the result MAY be different.
- The `error` field contains information about any error that has occurred while processing the corresponding `HistoryQuery`.
`NONE` stands for no error. This is also the default value.
`INVALID_CURSOR` means that the `cursor` field of `HistoryQuery` does not match with the `Index` of any of the `WakuMessage`s persisted by the queried node.
# Future Work # Future Work
@ -179,5 +187,3 @@ This proves accuracy within a range of minutes (e.g., in Bitcoin blockchain) or
Copyright and related rights waived via Copyright and related rights waived via
[CC0](https://creativecommons.org/publicdomain/zero/1.0/). [CC0](https://creativecommons.org/publicdomain/zero/1.0/).