The Mina Indexer is a redesigned version of the software collectively called the "Mina archive node."
Note: As the project is in active development, be aware that the public APIs and functionalities are subject to change.
Working with the Mina Archive Node can be complex and time-consuming. It requires the exact configuration of multiple components — a Mina Node, an Archive Node, and a Postgres database — and an in-depth knowledge of SQL and the Mina blockchain.
Additionally, even with a proper setup, the Archive Node system is prone to missing blocks, creating gaps in the data. These gaps require manual intervention for resolution, which adds layers of complexity to the system's management.
A major problem with the Archive Node is its reliance on a pg_dump
from a currently active node for initial setup. This approach
centralizes data, necessitating trust from the operator's side.
The Mina Indexer addresses this by simplifying the initial configuration by using precomputed blocks as the source of truth, bypassing the need for external database dumps.
We designed the Mina Indexer to be a comprehensive replacement for the Mina Archive Node, providing an easier-to-use and more accessible platform with integrated full support for the Rosetta API. We aim to streamline blockchain interaction for developers within the Mina ecosystem by providing developers and operators with a better toolset optimized for the Mina ecosystem.
This project utilizes Nix Flakes for development and building. Install Nix here and enable Flakes using the guide here. No additional dependencies are needed.
Create your development environment using nix develop '.?submodules=1'. This prepares your system with the necessary
dependencies, compilers, and development tools, eliminating the need
for an independent Rust installation. For VSCode, enhance your
experience with the Nix Environment Selector extension by linking it
to shell.nix. Alternatively, configure your IDE environment with
direnv.
To build the mina-indexer binaries, run the following command:
nix build '.?submodules=1'This will compile the binaries and place them in ./result/bin.
Execute unit tests to validate code functionality with:
nix-shell --run "just test-unit"To perform regression tests, which check for new bugs in existing features after updates, use:
nix-shell --run "just test-regression"Copyright 2022-2023 Mina Foundation, Inc.
Free use of this software is granted under the terms of the Mozilla Public License 2.0.
This project uses C4(Collective Code Construction Contract) process for contributions.
"providing an easier-to-use and more accessible platform" seems a little redundant, I think you really only need "easier-to-use platform"
"integrated full support" --> Sounds a little clunky to me. I don't know that you need the word "integrated", maybe just say "full support"
Otherwise, looks good man! Great work :)