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.

This project is sponsored by:

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.1.0.tar.gz (18.7 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.1.0-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cherry_etl-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0707abceb9ede1836e4e4387c4945a09daa72c735f4987dc603b17bde67d958a
MD5 329b26c2fce9ab95b3e677e8a7de4ab5
BLAKE2b-256 9d1e2d513a619f9a8b27f8391f253544831098114c62d3aea1b352d9c26fad01

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cherry_etl-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f16df55f1d7dec8e44510d2c71e3990dd02b5efebb43dabea0dcedfef52c2491
MD5 27ea14047054ccdf0dc2ec7817210785
BLAKE2b-256 0adf0f2fe1ba505d4b4653e1aa0631f11c9402a68fba3cc98a20adac598a86a9

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