https://github.com/berachain/bera-reth-exex-template
🐻⛓️Template for building Bera-Reth Execution Extensions - indexers, bots, and real-time analytics made simple 🐻⛓️
https://github.com/berachain/bera-reth-exex-template
bera-reth berachain exex reth reth-sdk
Last synced: 10 months ago
JSON representation
🐻⛓️Template for building Bera-Reth Execution Extensions - indexers, bots, and real-time analytics made simple 🐻⛓️
- Host: GitHub
- URL: https://github.com/berachain/bera-reth-exex-template
- Owner: berachain
- License: apache-2.0
- Created: 2025-08-21T00:26:50.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-21T01:10:54.000Z (10 months ago)
- Last Synced: 2025-08-21T02:38:19.395Z (10 months ago)
- Topics: bera-reth, berachain, exex, reth, reth-sdk
- Language: Shell
- Homepage:
- Size: 74.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bera-Reth ExEx Template
Template for building indexers, trading bots, real-time analytics and more on Berachain using [Execution Extensions (ExEx)](https://reth.rs/exex/overview/).
## Quick Start
```bash
# 1. Clone this template (or your version) and beacon-kit
git clone https://github.com/berachain/bera-reth-exex-template.git
cd bera-reth-exex-template
git clone https://github.com/berachain/beacon-kit.git ../beacon-kit
# 2. Run with BeaconKit integration
make start-local # Runs indefinitely, Ctrl+C to stop
```
This starts both BeaconKit and Bera-Reth with the ExEx, logging PoL transactions in real-time.
## Production Deployment
For mainnet and testnet deployments, build the production Docker image:
```bash
make docker-build
```
The resulting image can be used as a **drop-in replacement** for the official bera-reth Docker image, as long as the bera-reth version in `Cargo.toml` matches the required version for your network. Simply replace `berachain/bera-reth` with your custom ExEx image in your deployment configuration.
## Using This Template
When using this repository as a template, update the following:
### Required Changes
1. **Package name** in `Cargo.toml`:
```toml
[package]
name = "your-exex-name" # Change from "bera-reth-exex-template"
```
2. **Docker labels** in `Dockerfile`:
```dockerfile
LABEL org.opencontainers.image.source=https://github.com/your-org/your-repo
```
## Development
Edit `src/exex.rs` to customize the exex. Find more information on the [official docs](https://reth.rs/exex/overview/#how-do-i-build-an-execution-extension)
Run `make help` to see all available commands.
## License
Apache-2.0