reth-db-py
Bare-bones Python package allowing you to interact with the Reth DB via Python. Written with Rust and Pyo3.
This python wrapper can access node data 2x-4x faster than local RPC calls. Using this package, the most recent block hash can be retrieved in ~300μs on a local reth DB.
Installation
This package has been published to PyPi and can be installed using pip:
pip install reth-db-py
Assets
This package only has two assets made available: DbHandler and TableName.
TableName is an enum that contains the names of the supported tables in the Reth DB. This is used to ensure that the table name you are trying to access is valid.
pub enum TableName {
CanonicalHeaders,
Headers,
Transactions,
TxHashNumber,
}
DbHandler is a struct/class used to interact with the Reth DB. It has two methods, get and list:
get- takes aTableNameand akeyand returns the value associated with that key in the tablelist- takes aTableName, skip, length, and areverseboolean and returns a list of keys and values from the table
impl DbHandler {
pub fn new(db_path: String) -> Self {}
pub fn list(&self, table_name: TableName, skip: usize, len: usize, reverse: bool) -> PyResult<Vec<(String, String)>> {}
pub fn get(&self, table_name: TableName, key: String) -> PyResult<String> {}
}
class DbHandler:
def __init__(self, db_path: str)
def list(self, table_name: TableName, skip: int, len: int, reverse: bool)
def get(self, table_name: TableName, key: str)
Usage
Import reth-db-py assets:
from reth_db_py import DbHandler, TableName
Create a DbHandler instance:
handler = DbHandler("/path/to/db/mdbx.dat")
Get a single block hash from the CanonicalHeaders table:
header_hash = handler.get(TableName.CanonicalHeaders, '17000000')
Get 5 most recent block hashes from the CanonicalHeaders table:
header_list = handler.list(TableName.CanonicalHeaders, 0, 5, True)
Table Docs
Goal is to support all tables in Reth (currently only support 4 tables related to headers and transactions). Reth is still in alpha and the database tables are subject to change. Docs on the tables can be found in the reth repo here.
CanonicalHeaders- contains the block hash for each block numberHeaders- contains the header for each block hashTransactions- contains the transaction for each transaction hashTxHashNumber- contains the block number for each transaction hash
Benchmarks
Speed tests between RPC calls vs. reth-db-py calls (direct db interaction) coming soon.
11 Feb 20, 2024
7 Mar 10, 2024
3 Aug 9, 2023
22 Dec 31, 2022
3 Mar 23, 2022
8 Dec 15, 2022
186 Jan 9, 2023
5.1k Dec 30, 2022
274 Dec 29, 2022
3 Sep 17, 2022
13 Dec 6, 2022
41 Dec 22, 2022
11 Nov 30, 2022
302 Jan 3, 2023
3 Nov 23, 2023
21 Dec 22, 2022
4 Jan 16, 2023
3 Jul 6, 2023