History

Andrea Franz 6c469299b6 fix default range value for shhext_requestMessages (#934 ) * fix default range value for shhext_requestMessages * use t.Run to run scenarions * fix case when To - 24 hours is negative		2018-05-10 16:47:54 +02:00
..
dedup	Deduplicator: add API to confirm received messages.	2018-05-10 15:28:48 +02:00
README.md	Deduplicator: add API to confirm received messages.	2018-05-10 15:28:48 +02:00
api.go	fix default range value for shhext_requestMessages (#934 )	2018-05-10 16:47:54 +02:00
api_test.go	fix default range value for shhext_requestMessages (#934 )	2018-05-10 16:47:54 +02:00
service.go	Deduplicator: add API to confirm received messages.	2018-05-10 15:28:48 +02:00
service_test.go	fix default range value for shhext_requestMessages (#934 )	2018-05-10 16:47:54 +02:00
signal.go	Move signal logic into signal package	2018-05-03 09:35:58 +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"
  }
}