History

Andrea Franz 809db97e54 mailserver pagination (#1039 ) * mailserver sends envelopes in descending order * add limit value in mailserver request payload * mailserver sends messages up to the limit specified in the request * update Archive method to return key and error * processRequest returns the next page cursor * add cursor to mailserver request * add limit and cursor to request payload * fix request limit encoding * wait for request completed event in TrackerSuite/TestRequestCompleted * add cursor to mailserver response * fix cursor position in payload * add e2e test for mail server pagination * validate mail server response size * remove old limitReached var * fix lint warnings * add whisper patch * fix tests after rebase * check all return values to avoid lint warnings * check that all messages have been retrieved after 2 paginated requests * fix lint warnings * rename geth patch * merge mailserver patches into one * add last envelope hash to mailserver response and EventEnvelopeAvailable event * update whisper patch * add docs to MailServerResponse * update whisper patch * fix tests and lint warnings * send mailserver response data on EventMailServerRequestCompleted signal * update tracker tests * optimise pagination test waiting for mailserver to archive only before requesting * rollback mailserver interface changes * refactoring and docs changes * fix payload size check to determine if a limit is specified * add more docs to the processRequest method * add constants for request payload field lengths * add const noLimits to specify that limit=0 means no limits		2018-07-02 09:38:10 +02:00
..
dedup	Fix issues reported by lint. Part of #1017	2018-06-14 13:52:51 +02:00
README.md	Deduplicator: add API to confirm received messages.	2018-05-10 15:28:48 +02:00
api.go	mailserver pagination (#1039 )	2018-07-02 09:38:10 +02:00
api_test.go	RequestHistoricMessages response (#1009 )	2018-06-15 17:12:31 +02:00
debug.go	New debug_postSync endpoint (#1046 )	2018-06-25 15:27:17 +02:00
service.go	mailserver pagination (#1039 )	2018-07-02 09:38:10 +02:00
service_test.go	mailserver pagination (#1039 )	2018-07-02 09:38:10 +02:00
signal.go	mailserver pagination (#1039 )	2018-07-02 09:38:10 +02:00

README.md

Whisper API Extension

API

shhext_getNewFilterMessages

Accepts the same input as shh_getFilterMessages.

Returns

Returns a list of whisper messages matching the specified filter. Filters out the messages already confirmed received by shhext_confirmMessagesProcessed

Deduplication is made using the whisper envelope content and topic only, so the same content received in different whisper envelopes will be deduplicated.

shhext_confirmMessagesProcessed

Confirms whisper messages received and processed on the client side. These messages won't appear anymore when shhext_getNewFilterMessages is called.

Parameters

Gets a list of whisper envelopes.

shhext_post

Accepts same input as shh_post.

Returns

DATA, 32 Bytes - the envelope hash

shhext_requestMessages

Sends a request for historic messages to a mail server.

Parameters

Object - The message request object:

mailServerPeer:URL - Mail servers' enode addess
from:QUANTITY - (optional) Lower bound of time range as unix timestamp, default is 24 hours back from now
to:QUANTITY- (optional) Upper bound of time range as unix timestamp, default is now
topic:DATA, 4 Bytes - Regular whisper topic
symKeyID:DATA- ID of a symmetric key to authenticate to mail server, derived form mail server password

Returns

Boolean - returns true if the request was send, otherwise false.

Signals

Sends sent signal once per envelope.

{
  "type": "envelope.sent",
  "event": {
    "hash": "0xea0b93079ed32588628f1cabbbb5ed9e4d50b7571064c2962c3853972db67790"
  }
}

Sends expired signal if envelope dropped from whisper local queue before it was sent to any peer on the network.

{
  "type": "envelope.expired",
  "event": {
    "hash": "0x754f4c12dccb14886f791abfeb77ffb86330d03d5a4ba6f37a8c21281988b69e"
  }
}