status-go/services/shhext
Andrea Maria Piana 81d8ca82a2
Add confirm messages processed by ID (#1375)
Currently PFS messages are decrypted and therefore modified before being
passed to the client. This make IDs computation difficult, as we pass
the whole object to the client and expect the object be passed back once
confirmed.
This changes the behavior allowing confirmation by ID, which is passed
to the client instead of the raw object.
This is a breaking change, but status-react is already forward
compatible.
2019-02-19 13:58:42 +01:00
..
chat Add confirm messages processed by ID (#1375) 2019-02-19 13:58:42 +01:00
dedup Add confirm messages processed by ID (#1375) 2019-02-19 13:58:42 +01:00
mailservers Add request with retries api call 2019-01-24 14:31:56 +02:00
README.md Implement mailserver canary service. Closes #1086 2018-08-07 17:17:59 +02:00
api.go Add confirm messages processed by ID (#1375) 2019-02-19 13:58:42 +01:00
api_test.go add SyncMessages method to shhext api (#1309) 2018-12-14 12:21:34 +01:00
debug.go Use status-im whisper/whisperv6 module everywhere 2018-10-03 09:27:51 +03:00
requests.go Prevent frequent requests with same topics 2019-01-18 14:52:33 +02:00
requests_test.go Prevent frequent requests with same topics 2019-01-18 14:52:33 +02:00
service.go Add GetContactCode call, add DH flag (#1367) 2019-02-12 12:07:13 +01:00
service_test.go Gomobile support (#1164) 2019-02-01 18:02:52 +01:00
signal.go Mailserver: return error response. (#1244) 2018-10-18 12:25:00 +02:00
tracker.go Prevent frequent requests with same topics 2019-01-18 14:52:33 +02:00
tracker_test.go Prevent frequent requests with same topics 2019-01-18 14:52:33 +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
  1. 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 from 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"
  }
}