Skip to main content

Universal multi-chain distributed blockchain listener SDK

Project description

Chain Listener SDK

A universal multi-chain distributed blockchain listener SDK that provides reusable multi-chain monitoring capabilities. The SDK focuses on asynchronous blockchain event listening and data processing, offering flexible solutions for different business scenarios.

Features

  • Universal Multi-Chain Support: Ethereum, BSC, Polygon, Arbitrum, Optimism, Avalanche, Solana, TRON, Kava, Osmosis, Base
  • Distributed Architecture: Support for multi-instance deployment with automatic load balancing
  • Event-Driven: Callback-based event processing with user-defined handlers
  • Fault Tolerant: Automatic failover and recovery mechanisms
  • High Performance: Async/await architecture with efficient event processing
  • Flexible Deployment: From simple standalone to distributed cluster

Quick Start

Codex Skill

This repository now includes a Codex skill bundle at codex-skills/chain-listener-event-ops.

  • Analyst workflow: generate JSONL/CSV capture listeners for on-chain event sampling and downstream analysis
  • Developer workflow: generate event consumer scaffolds for callback-based integrations

Example scaffold command:

poetry run python codex-skills/chain-listener-event-ops/scripts/scaffold_listener.py \
  --persona analyst \
  --chain-name bsc \
  --chain-type bsc \
  --contract-name USDC \
  --contract-address 0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d \
  --abi-path examples/bsc_usdc_transfer_listener/usdc_erc20_abi.json \
  --event Transfer \
  --output examples/generated/bsc_usdc_transfer_capture.py

To make the skill globally available in Codex, copy or symlink the skill folder into $CODEX_HOME/skills/.

Documentation

Development

Setup

# Install Poetry
pip install poetry

# Install dependencies
poetry install

# Activate virtual environment
poetry env activate

Code Quality

# Format code
black src/ tests/

# Type checking
mypy src/

# Linting
flake8 src/ tests/

License

[License Name]

Contributing

Please read our contributing guidelines and code of conduct before submitting pull requests.

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

chain_listener-0.2.12.tar.gz (47.1 kB view details)

Uploaded Source

Built Distribution

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

chain_listener-0.2.12-py3-none-any.whl (58.6 kB view details)

Uploaded Python 3

File details

Details for the file chain_listener-0.2.12.tar.gz.

File metadata

  • Download URL: chain_listener-0.2.12.tar.gz
  • Upload date:
  • Size: 47.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.14.0 Darwin/25.1.0

File hashes

Hashes for chain_listener-0.2.12.tar.gz
Algorithm Hash digest
SHA256 631838de382de5ed94887e74edd5960a3a51227da0d13529ad7ce599d275d875
MD5 49bb38100dc73940924637e66bc8704a
BLAKE2b-256 8928efa17cb080df3be19f8a133a8161ce6dfc477e0c450ab596f48ca6f16ce1

See more details on using hashes here.

File details

Details for the file chain_listener-0.2.12-py3-none-any.whl.

File metadata

  • Download URL: chain_listener-0.2.12-py3-none-any.whl
  • Upload date:
  • Size: 58.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.14.0 Darwin/25.1.0

File hashes

Hashes for chain_listener-0.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 dc0b9480a0ec8b075f968ff30bc240c40ab4dcb800486654ee27000f457a7af6
MD5 1fbec10139defa6da75b47aa9d703ed8
BLAKE2b-256 a05c52abe342fc99d12848c8856ce5b471132a241c200efdf7adfd92813f5919

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