A Python aiohttp wrapper client to subscribe to the Ethereum JSON-RPC PubSub endpoints.
Sub3 can be installed using pip as follows:
$ pip install sub3Refer to the full documentation for the in-depth usage.
- The URL to a node that has a WebSocket port opened. This can be either from a provider like infura or through a self-hosted Geth/Nethermind node.
The basic subscription will just print the data as received. It can be tested by doing the following:
>>> from sub3 import RPCMaker, Sub3
#RPCMaker is for easy formatting of JSON-RPC calls
>>> rpc = RPCMaker.new_heads()
>>> sub = Sub3("ws://localhost:8546", rpc)
>>> sub.start()
#Connection to the node
connected
#Successful answer from the JSONRPC request
{"jsonrpc":"2.0","id":"1","result":"0x1aaa6ce63bae0597ceadd723fd05e6db"}
#Starts receiving data
{
"jsonrpc":"2.0",
"method":"eth_subscription",
"params":{"subscription":"0x1aaa6ce63bae0597ceadd723fd05e6db",
"result":{"parentHash":"0x65906581" [...]}
}The data processing can easily be customized by sub-classing the Sub3 class
like so:
from sub3 import Sub3
class NewClient(Sub3):
async def on_data(self, data):
# add your own data processing logic
async def on_closed(self, error):
# add your processing of `closed` message
async def on_error(self, error):
# add your processing of `error` message
rpc = RPCMaker.new_heads()
sub = NewClient("ws://localhost:8546", rpc)
sub.start()Note
Take note that the functions are Async. if you don't define them as such the client will raise an error.
I made this has a fun side project and it's free for anyone to use. If you like it and wish to donate here's a few of my crypto wallets.
| Ethereum and L2s (0x29006...) | Monero (85tBS7YSrM5...) | Peercoin (PBzj1ZwMDW...) |
|---|---|---|
 |
 |
 |
- Free software: MIT
- Documentation: https://Sub3.readthedocs.io.
⊂(▀¯▀⊂)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent