Once you have completed the pre-requisites for your operating system, follow these steps:
-
Clone this repository:
git clone https://github.com/openmina/openmina.git
-
Navigate to the repository:
cd openmina
-
Run the following command to start the demo:
docker compose -f docker-compose.local.producers.yml up --pull always
-
Open you browser and visit http://localhost:8070
The Open Mina Node is a Mina node written completely in Rust and capable of verifying blocks of transactions, producing blocks and generating SNARKs.
In the design of the Open Mina node, we are utilizing much of the same logic as in the Mina Web Node. The key difference is that unlike the Web Node, which is an in-browser node with limited resources, the Open Mina node is able to perform resource-intensive tasks such as SNARK proof generation.
Current functionalities | In Development | Future Plans |
---|---|---|
☑ Produce and prove blocks (with and without transactions). | ☐ Receiving and broadcasting transactions from/into the transaction pool. | ☐ Direct transfer of MINA funds using Webnode |
☑ Produce SNARK proofs for transactions. | ☐ A block replayer that uses data from the archive nodes | ☐ O1JS support for Webnode. |
☑ Connect to the network and sync up to the best tip block | ||
☑ Validate and apply new blocks and transactions to update consensus and ledger state. | ||
☑ Broadcast messages: blocks, SNARK pool |
Please note that receiving and broadcasting transactions from/into the transaction pool is already possible, but is still an early alpha version and needs more work.
We've added two new pages to the node's front end:
Shows a list of the transactions from the pool and a side panel detail.
The benchmarks page helps us to send transactions. The transactions are signed in the front end by the Mina signer. Every user can send transactions and they can see in the mempool whether the transactions were sent by their node.
Run the Open Mina block producer node by following this guide.
Run:
docker compose up --pull always
Then visit http://localhost:8070 in your browser.
By default, docker compose up
will use the latest node and frontend images available (tagged with latest
), but specific versions can be selected by using the OPENMINA_TAG
and OPENMINA_FRONTEND_TAG
variables.
This installation guide has been tested on Debian and Ubuntu and should work on most distributions of Linux.
Pre-requisites:
Ubuntu or Debian-based Linux distribution with the following packages installed:
curl
git
libssl-dev
pkg-config
protobuf-compiler
build-essential
Example (debian-based):
# Either using "sudo" or as the "root" user
sudo apt install curl git libssl-dev pkg-config protobuf-compiler build-essential
Example (macOS):
If you have not yet installed homebrew:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install curl git openssl pkg-config protobuf gcc make
Steps (for Debian-based Linux distros and macOS):
Open up the command line and enter the following:
And then:
# Install rustup and set the default Rust toolchain to 1.79 (newer versions work too)
curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain 1.79
# Setup the current shell with rustup
source "$HOME/.cargo/env"
# Clone the openmina repository
git clone https://github.com/openmina/openmina.git
cd openmina/
# Build and run the node
cargo run --release -p cli node
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install [email protected]
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
source ~/.bashrc
nvm install 20.11.1
Download Node.js v20.11.1 from the official website, open the installer and follow the prompts to complete the installation.
npm install -g @angular/[email protected]
Open a terminal and navigate to this project's root directory
cd PROJECT_LOCATION/openmina/frontend
Install the dependencies
npm install
npm start
- core/ - Provides basic types needed to be shared across different components of the node.
- ledger/ - Mina ledger implementation in Rust.
- snark/ - Snark/Proof verification.
- p2p/ - P2p implementation for OpenMina node.
- node/ - Combines all the business logic of the node.
- cli/ - OpenMina cli.
- frontend/ - OpenMina frontend.
Details regarding architecture
- Why we are developing Open Mina
- What is Open Mina?
- Core components
- Developer tools
- Testing
- How to run
- External links