Aleo Explorer

The "official" instance

Description

An open-source blockchain explorer for Aleo.

It contains a node that connects to another peer to fetch blockchain data. This node is NOT validating blocks. Only connect to peers that you trust.

mainnet-newdb branch

This branch uses Postgres for all data storage. Redis is no longer required, and (almost) full data history is stored in the database.
You will need to resync from scratch if you are switching from the mainnet branch.

Prerequisites

• Python 3.10 or 3.11.4+ (3.11.0 - 3.11.3 won't work)
• Postgres 14+
• Rust 1.81+
• aleo-explorer-rust
• aleo-explorer-wasm (optional for old frontend)
• (optional) setproctitle for custom process names

Usage

1. Import the database schema from pg_dump.sql.
2. Configure through .env file. See .env.example for reference.
3. Install dependencies with uv sync (this will install aleo-explorer-rust; Rust toolchain is still required). If not using uv, install requirements.txt and aleo-explorer-rust manually.
4. Compile aleo-explorer-wasm, install to webui/static/rust{.js,_bg.wasm} with wasm-bindgen. (not working right now)
5. Run with uv run python -m main (or PYTHONPATH=src python -m main if not installed).

Use in docker

docker-compose up -d

A better frontend?

A new frontend is being developed in aleo-explorer-frontend. You can preview it if you can find the deployment URL.

As such, the current frontend code contained in this repository (webui) is planned to be deprecated. The new frontend uses webapi to communicate with the backend.

License

AGPL-3.0-or-later