Skip to main content

Library for building blockchain pipelines

Project description

Cherry

PyPI version

Python framework for building blockchain data pipelines.

Cherry is in the early stages of development, so the API is changing, and we are still figuring things out.

We would love to help you get started and get your feedback on our telegram channel.

Core libraries we use for ingesting/decoding/validating/transforming blockchain data are implemented in cherry-core repo.

Features

  • Ingest data from multiple providers with a uniform interface. This makes switching providers as easy as changing a couple lines in config.
  • Prebuilt functionality to decode/validate/transform blockchain data.
  • Support for both Ethereum (EVM) and Solana (SVM) based blockchains.
  • Write data into Clickhouse, Iceberg, Deltalake, Parquet/Arrow (via pyarrow).
  • Keep datasets fresh with continuous ingestion.

Status

We are still trying to figure out our core use cases and trying to build up to them. Here is a rough roadmap::

  • Add option to ingest Solana data from geyser plugin/RPC.
  • Add option to ingest EVM data from Ethereum RPC.
  • Implement more advanced validation.
  • Add more writers like DuckDB, PostgreSQL.
  • Build an end-to-end testing flow so we can test the framework and users can test their pipelines using the same flow.
  • Build a benchmark flow so we can optimize the framework and user can optimize their pipelines using the same flow. This will also make it easy to compare performance of providers and writers.
  • Implement more blockchain formats like SUI, Aptos, Fuel.
  • Implement automatic rollback handling. Currently we don't handle rollbacks so we stay behind the tip of the chain in order to avoid writing wrong data.

Usage Examples

See examples directory.

Can run examples with uv run examples/{example_name}/main.py --provider {sqd or hypersync}

For examples that require databases or other infra, run docker-compose -f examples/{example_name}/docker-compose.yaml up -d to start the necessary docker containers. Can run docker-compose -f examples/{example_name}/docker-compose.yaml down -v after running the example to stop the docker containers and delete the data.

Logging

Python code uses the standard logging module of python, so it can be configured according to python docs.

Set RUST_LOG environment variable according to env_logger docs in order to see logs from rust modules.

To run an example with trace level logging for rust modules:

RUST_LOG=trace uv run examples/{example_name}/main.py --provider {sqd or hypersync}

Development

This repo uses uv for development.

  • Format the code with uv run ruff format
  • Lint the code with uv run ruff check
  • Run type checks with uv run pyright

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cherry_etl-0.0.4.tar.gz (75.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cherry_etl-0.0.4-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file cherry_etl-0.0.4.tar.gz.

File metadata

  • Download URL: cherry_etl-0.0.4.tar.gz
  • Upload date:
  • Size: 75.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.4

File hashes

Hashes for cherry_etl-0.0.4.tar.gz
Algorithm Hash digest
SHA256 20348f72b083bbb4ee2dfaaa57e55a2f2a677db70a2528ea18f2c110a87a6095
MD5 2c68a67eba870a7e9ace7f3dd2201f75
BLAKE2b-256 48a9440f110cf4b122d9188ccab27849769bca7532a536f65e67a0c84d186c0b

See more details on using hashes here.

File details

Details for the file cherry_etl-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: cherry_etl-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 17.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.4

File hashes

Hashes for cherry_etl-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 747a13f5d193c57fe18683380d91705f340d2a30fbca69026704991844e76df3
MD5 75e5bdc8990497c3ec9a5a505ac7eb1c
BLAKE2b-256 c804850244d9d8c9943bbcfe230bf315d7ded6ef8d59d9071e5efaaccf0c518d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page