status-go/services/subscriptions
Pedro Pombeiro db01f0b3e4 Avoid passing node to subscriptions service 2020-01-20 13:15:17 +01:00
..
README.md Implement subscription for eth and shh filters using signals. (#1455) 2019-05-07 09:05:38 +02:00
api.go Avoid passing node to subscriptions service 2020-01-20 13:15:17 +01:00
filters.go Implement subscription for eth and shh filters using signals. (#1455) 2019-05-07 09:05:38 +02:00
filters_eth.go fix parameters parsing for eth_* filters subscriptions (#1461) 2019-05-10 12:56:58 +02:00
filters_shh.go Implement subscription for eth and shh filters using signals. (#1455) 2019-05-07 09:05:38 +02:00
service.go Avoid passing node to subscriptions service 2020-01-20 13:15:17 +01:00
service_nimbus.go Nimbus node support 2020-01-20 13:15:17 +01:00
signals.go Implement subscription for eth and shh filters using signals. (#1455) 2019-05-07 09:05:38 +02:00
subscription.go Fix race condition in subscriptions (#1646) 2019-12-11 09:44:57 +01:00
subscriptions.go Fix race condition in subscriptions (#1646) 2019-12-11 09:44:57 +01:00
subscriptions_test.go Use goimports instead of gofmt 2020-01-06 10:17:23 +01:00

README.md

Signal Subscriptions

This package implements subscriptions mechanics using signal package.

It defines 3 new RPC methods in the eth namespace and 2 signals.

Methods

###eth_subscribeSignal Creates a new filter and subscribes to its changes via signals.

Parameters: receives the method name and parameters for the filter that is created.

Example 1:

{
  "jsonrpc": "2.0", 
  "id": 1,
  "method": "eth_subscribeSignal", 
  "params": ["eth_newPendingTransactionFilter", []]
}

Example 2:

{
  "jsonrpc": "2.0", 
  "id": 2,
  "method": "eth_subscribeSignal", 
  "params": [
    "shh_newMessageFilter",
    [{ "symKeyID":"abcabcabcabc", "topics": ["0x12341234"] }]
  ]
}

Supported filters: shh_newMessageFilter, eth_newFilter, eth_newBlockFilter, eth_newPendingTransactionFilter (see Ethereum documentation for respective parameters).

Returns: error or subscriptionID.

###eth_unsubscribeSignal Unsubscribes and removes one filter by its ID. NOTE: Unsubscribing from a filter removes it.

Parameters: subscriptionID obtained from eth_subscribeSignal Returns: error if something went wrong while unsubscribing.

Signals

  1. Subscription data received
{
  "type": "subscriptions.data",
  "event": {
    "subscription_id": "shh_0x01",
    "data": {
        <whisper envelope 01>,
        <whisper envelope 02>,
        ...
    }
}
  1. Subscription error received
{
  "type": "subscriptions.error",
  "event": {
    "subscription_id": "shh_0x01",
    "error_message": "can not find filter with id: 0x01"
  }
}