github.com/status-im/status-go@v1.1.0/services/ext/README.md (about)

     1  Whisper API Extension
     2  =====================
     3  
     4  API
     5  ---
     6  
     7  
     8  #### shhext_getNewFilterMessages
     9  
    10  Accepts the same input as [`shh_getFilterMessages`](https://github.com/ethereum/wiki/wiki/JSON-RPC#shh_getFilterChanges).
    11  
    12  ##### Returns
    13  
    14  Returns a list of whisper messages matching the specified filter. Filters out
    15  the messages already confirmed received by [`shhext_confirmMessagesProcessed`](#shhextconfirmmessagesprocessed)
    16  
    17  Deduplication is made using the whisper envelope content and topic only, so the
    18  same content received in different whisper envelopes will be deduplicated.
    19  
    20  
    21  #### shhext_confirmMessagesProcessed
    22  
    23  Confirms whisper messages received and processed on the client side. These
    24  messages won't appear anymore when [`shhext_getNewFilterMessages`](#shhextgetnewfiltermessages) 
    25  is called.
    26  
    27  ##### Parameters
    28  
    29  Gets a list of whisper envelopes.
    30  
    31  
    32  #### shhext_post
    33  
    34  Accepts same input as [`shh_post`](https://github.com/ethereum/wiki/wiki/JSON-RPC#shh_post).
    35  
    36  ##### Returns
    37  
    38  `DATA`, 32 Bytes - the envelope hash
    39  
    40  #### shhext_requestMessages
    41  
    42  Sends a request for historic messages to a mail server.
    43  
    44  ##### Parameters
    45  
    46  1. `Object` - The message request object:
    47  
    48  - `mailServerPeer`:`URL` - Mail servers' enode addess
    49  - `from`:`QUANTITY` - (optional) Lower bound of time range as unix timestamp, default is 24 hours back from now
    50  - `to`:`QUANTITY`- (optional) Upper bound of time range as unix timestamp, default is now
    51  - `topic`:`DATA`, 4 Bytes - Regular whisper topic
    52  - `symKeyID`:`DATA`- ID of a symmetric key to authenticate to mail server, derived from mail server password
    53  
    54  ##### Returns
    55  
    56  `Boolean` - returns `true` if the request was send, otherwise `false`.
    57  
    58  Signals
    59  -------
    60  
    61  Sends sent signal once per envelope.
    62  
    63  ```json
    64  {
    65    "type": "envelope.sent",
    66    "event": {
    67      "hash": "0xea0b93079ed32588628f1cabbbb5ed9e4d50b7571064c2962c3853972db67790"
    68    }
    69  }
    70  ```
    71  
    72  Sends expired signal if envelope dropped from whisper local queue before it was
    73  sent to any peer on the network.
    74  
    75  ```json
    76  {
    77    "type": "envelope.expired",
    78    "event": {
    79      "hash": "0x754f4c12dccb14886f791abfeb77ffb86330d03d5a4ba6f37a8c21281988b69e"
    80    }
    81  }
    82  ```