mirror of
https://github.com/hanzoai/bootnode.git
synced 2026-10-25 02:31:30 +00:00
zooqueenandHanzo Dev
a479ffa0db
hanzo.yml declares the one image, ghcr.io/hanzoai/bootnode:<version>-web, built from the repository root with console/Dockerfile and named by the console's own package version, and gates it on the console's unit tests and typecheck. .hanzo/workflows/cicd.yml runs hanzoai/ci build.yml@v1 on push to main. The console manifest names every dependency from the pnpm catalog, and the catalog carries the versions this code builds against: @luxfi/ui 7.4.3 with @hanzo/gui 7.3, next 16.2, TypeScript 5.9 and the Zen faces from @hanzo/font 1.8.0. `pnpm install --frozen-lockfile` and `next build` both pass. The unused geist and lucide-react entries and the npm lockfile are gone, tests report in TAP so the pipeline can count them, and the README no longer calls this repository a retired copy. Co-authored-by: Hanzo Dev <[email protected]>
114 lines
3.2 KiB
Markdown
114 lines
3.2 KiB
Markdown
<p align="center"><img src=".github/hero.svg" alt="bootnode" width="880"></p>
|
|
|
|
# Bootnode
|
|
|
|
**Web3 Backend in a Box** - Run locally or deploy to cloud.
|
|
|
|
> **Go rewrite (HIP-0106) in progress.** The current production
|
|
> service is the Python FastAPI app under [`api/`](api/). A Go
|
|
> scaffold that mounts into [`superbase`](../superbase) per HIP-0106
|
|
> lives alongside it — `api/`, `cmd/bootnode/`, `schema/`,
|
|
> `zap/`. See [`docs/PYTHON_TO_GO_PORT.md`](docs/PYTHON_TO_GO_PORT.md)
|
|
> for the endpoint-by-endpoint port map and the new
|
|
> [Go README section](#go-rewrite-hip-0106) below.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
Done. Your Web3 backend is running:
|
|
- **API:** http://localhost:8000
|
|
- **Dashboard:** http://localhost:3001
|
|
- **API Docs:** http://localhost:8000/docs
|
|
|
|
## Features
|
|
|
|
| API | Description |
|
|
|-----|-------------|
|
|
| `POST /v1/rpc/{chain}` | Multi-chain JSON-RPC proxy |
|
|
| `WS /v1/ws/{chain}` | Real-time blockchain subscriptions |
|
|
| `GET /v1/tokens/{chain}/balances/{address}` | Token balances & metadata |
|
|
| `GET /v1/nfts/{chain}/owned/{address}` | NFT ownership & metadata |
|
|
| `POST /v1/webhooks` | Event-driven notifications |
|
|
| `POST /v1/wallets/create` | ERC-4337 smart wallets |
|
|
| `POST /v1/bundler/{chain}` | UserOp bundling |
|
|
| `POST /v1/gas/sponsor` | Gas sponsorship |
|
|
|
|
## Supported Chains
|
|
|
|
**L1:** Ethereum, BNB Chain, Avalanche, Solana, Bitcoin
|
|
|
|
**L2:** Arbitrum, Optimism, Base, Polygon, zkSync, Scroll, Linea, Blast
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# API (Python 3.12+)
|
|
cd api && uv sync && uvicorn bootnode.main:app --reload --port 8000
|
|
|
|
# Dashboard (Node 22+)
|
|
cd web && pnpm install && pnpm dev
|
|
```
|
|
|
|
## Deploy
|
|
|
|
### Self-hosted
|
|
```bash
|
|
docker compose -f docker-compose.prod.yml up -d
|
|
# or
|
|
kubectl apply -f infra/k8s/
|
|
```
|
|
|
|
### Hanzo Cloud
|
|
```bash
|
|
hanzo deploy
|
|
```
|
|
|
|
Visit [web3.hanzo.ai](https://web3.hanzo.ai) for managed hosting.
|
|
|
|
## License
|
|
|
|
Apache-2.0
|
|
|
|
## Go rewrite (HIP-0106)
|
|
|
|
The Go subsystem mounts into `superbase` (the unified Hanzo Cloud
|
|
binary). It exposes a single `Mount(r chi.Router, deps api.Deps) error`
|
|
entry point and a public ZAP schema (`schema/bootnode.zap`) covering
|
|
every cross-subsystem type.
|
|
|
|
```
|
|
bootnode/
|
|
schema/bootnode.zap # public typed surface (ZAP)
|
|
zap/gen/ # zapc-generated Go (hand-stubs today)
|
|
api/ # subsystem code (chi handlers + store)
|
|
mount.go # HIP-0106 contract
|
|
deps.go # IAM/KMS/Base/O11y/Commerce interfaces
|
|
handlers/ # one MountXxx per FastAPI route group
|
|
middleware/ # auth, telemetry, rate-limit
|
|
store/ # per-tenant SQLite via deps.Base
|
|
web3/ # chain registry + RPC pool
|
|
cmd/bootnode/main.go # standalone dev shim
|
|
docs/PYTHON_TO_GO_PORT.md # endpoint-by-endpoint mapping
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
go build ./...
|
|
go vet ./...
|
|
go run ./cmd/bootnode # listens on :8100 (BOOTNODE_ADDR to override)
|
|
```
|
|
|
|
### Generate ZAP bindings
|
|
|
|
```bash
|
|
cd zap && make gen # no-op if zapc isn't installed
|
|
```
|
|
|
|
`zapc` lives at `~/work/hanzo/zap/zapc-rs/`. Brand policy: no
|
|
`.capnp` files, no "Cap'n Proto" references on the public surface
|
|
(HIP-0106).
|