status-go/services/shhext
Pedro Pombeiro ed5a5c154d
Move to monorepo structure (#1684)
Move to a monorepo structure with submodules

- Rename status-protocol-go to status-go/protocol
2019-11-21 17:19:22 +01:00
..
dedup Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
mailservers Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
README.md Implement mailserver canary service. Closes #1086 2018-08-07 17:17:59 +02:00
api.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
api_test.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
context.go Execute writes atomically only after request was processed without errors (#1454) 2019-05-06 09:33:19 +03:00
history.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
history_test.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
mailrequests.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
mailrequests_test.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
requests.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
requests_test.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
rpc.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
service.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
service_test.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
signal.go Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01: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"
  }
}