Metadata-Version: 2.4
Name: chain-listener
Version: 0.2.11
Summary: Universal multi-chain distributed blockchain listener SDK
License: MIT
License-File: LICENSE
Keywords: blockchain,ethereum,listener,events,web3
Author: Chain Listener Team
Author-email: team@chainlistener.dev
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Office/Business
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: aiohttp (>=3.9.0,<4.0.0)
Requires-Dist: aioredis (>=2.0.0,<3.0.0)
Requires-Dist: anchorpy (==0.17.2)
Requires-Dist: async-limiter (>=1.0.0,<2.0.0)
Requires-Dist: async-timeout (>=4.0.3,<5.0.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: motor (>=3.3.0,<4.0.0)
Requires-Dist: pydantic (>=2.5.0,<3.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: solana (==0.30.2)
Requires-Dist: solders (==0.18.1)
Requires-Dist: tronpy (>=0.5.0,<0.6.0)
Requires-Dist: typing-extensions (>=4.8.0,<5.0.0)
Requires-Dist: web3 (>=6.11.0,<7.0.0)
Project-URL: Documentation, https://chain-listener.readthedocs.io
Project-URL: Homepage, https://github.com/chain-listener/chain-listener
Project-URL: Repository, https://github.com/chain-listener/chain-listener
Description-Content-Type: text/markdown

# 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:

```bash
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

- [Architecture Overview](docs/architecture.md)
- [Configuration Guide](docs/configuration.md)
- [API Reference](docs/api.md)
- [Examples](examples/)

## Development

### Setup

```bash
# Install Poetry
pip install poetry

# Install dependencies
poetry install

# Activate virtual environment
poetry env activate
```

### Code Quality

```bash
# 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.

