1+ <div align =" center " >
2+ <img src =" website/static/img/rust-node-social-card.svg " alt =" Mina Rust Node - Fast and secure implementation of the Mina protocol in Rust " width =" 600px " >
3+ </div >
4+
15<div align =" center " >
26 <picture >
37 <source media="(prefers-color-scheme: dark)" srcset="docs/assets/OpenMinaGH_Light.svg">
48 <source media="(prefers-color-scheme: light)" srcset="docs/assets/OpenMinaGH_Dark.svg">
5- <img alt="The Open Mina Node is a fast and secure implementation of the Mina protocol in Rust."
9+ <img alt="The Mina Rust Node is a fast and secure implementation of the Mina protocol in Rust."
610 src="docs/assets/OpenMinaGH_Light.svg"
711 width="152px">
812 </picture >
913
1014![ Beta] [ beta-badge ] [ ![ release-badge]] [ release-link ]
1115[ ![ Changelog] [ changelog-badge ]] [ changelog ] [ ![ Apache licensed]] [ Apache link ]
1216
13- _ The ** Open Mina Node** is a fast and secure implementation of the Mina protocol
17+ _ The ** Mina Rust Node** is a fast and secure implementation of the Mina protocol
1418in ** Rust** ._ _ Currently in ** public beta** , join our
1519[ Discord community] ( https://discord.com/channels/484437221055922177/1290662938734231552 )
1620to help test future releases._
@@ -21,24 +25,19 @@ to help test future releases._
2125
2226## Getting Started
2327
24- ### Building from Source
28+ For comprehensive installation and setup instructions, visit our documentation
29+ website:
2530
26- - [ Rust Node] ( /docs/building-from-source-guide.md#how-to-build-and-launch-a-node-from-source )
27- and [ Dashboards] ( ./docs/building-from-source-guide.md#how-to-launch-the-ui )
28- - [ Web Node] ( /docs/local-webnode.md )
31+ ** [ Complete Setup Guide →] ( https://o1-labs.github.io/openmina/docs/node-operators/getting-started ) **
2932
30- ### Run Node on Devnet via Docker
33+ ### Quick Links
3134
32- - [ Non-Block Producing Node] ( /docs/alpha-testing-guide.md ) Connect to peers and
33- sync a node on the devnet; no devnet stake needed.
34- - [ Block Producing Node] ( /docs/block-producer-guide.md ) Produce blocks on the
35- devnet; sufficient devnet stake needed.
36- - [ Local Block Production Demo] ( /docs/local-demo-guide.md ) Produce blocks on a
37- custom local chain without devnet stake.
38- - [ Devnet Archive Node] ( /docs/archive-node-guide.md ) Run an archive node on
39- devnet.
35+ - ** [ Docker Installation] ( https://o1-labs.github.io/openmina/docs/node-operators/docker-installation ) **
36+ - ** [ Building from Source] ( https://o1-labs.github.io/openmina/docs/node-operators/building-from-source ) **
37+ - ** [ Block Producer Setup] ( https://o1-labs.github.io/openmina/docs/node-operators/block-producer ) **
38+ - ** [ Archive Node] ( https://o1-labs.github.io/openmina/docs/node-operators/archive-node ) **
4039
41- <img src =" docs/assets /NodeUI.png" alt =" Block production Node UI " >
40+ <img src =" website/static/img /NodeUI.png" alt =" Block production Node UI " >
4241
4342---
4443
@@ -49,52 +48,39 @@ to help test future releases._
4948
5049## Core Features
5150
52- - ** Mina Network** : Connect to peers, sync up, broadcast messages
53- - ** Block Production** : Produces, validates, and applies blocks according to
54- Mina's consensus.
55- - ** SNARK Generation** : Produce SNARK proofs for transactions
56- - ** Debugging** : A block replayer that uses data from the archive nodes
51+ The Mina Rust Node implements the complete Mina protocol in Rust, including
52+ network connectivity, block production, SNARK generation, and debugging tools.
53+
54+ ** [ Learn More About Architecture →] ( https://o1-labs.github.io/openmina/docs/developers/getting-started ) **
5755
5856## Repository Structure
5957
6058- [ core/] ( core ) - Provides basic types needed to be shared across different
6159 components of the node.
6260- [ ledger/] ( ledger ) - Mina ledger implementation in Rust.
6361- [ snark/] ( snark ) - Snark/Proof verification.
64- - [ p2p/] ( p2p ) - P2p implementation for OpenMina node .
62+ - [ p2p/] ( p2p ) - P2p implementation for Mina Rust Node .
6563- [ node/] ( node ) - Combines all the business logic of the node.
6664 - [ native/] ( node/native ) - OS specific pieces of the node, which is used to
6765 run the node natively (Linux/Mac/Windows).
68- - [ testing/] ( node/testing ) - Testing framework for OpenMina node.
69- - [ cli/] ( cli ) - OpenMina cli.
70- - [ frontend/] ( frontend ) - OpenMina frontend.
71-
72- ## The Open Mina Documentation
73-
74- ### What is Open Mina?
75-
76- - [ Why we are developing Open Mina] ( docs/why-openmina.md )
77-
78- ### Core components
79-
80- - [ P2P communication] ( https://github.com/openmina/openmina/blob/documentation/docs/p2p_service.md )
81- - [ GossipSub] ( https://github.com/openmina/mina-wiki/blob/3ea9041e52fb2e606918f6c60bd3a32b8652f016/p2p/mina-gossip.md )
82- - [ Scan state] ( docs/scan-state.md )
83- - [ SNARKs] ( docs/snark-work.md )
84-
85- ### Developer tools
66+ - [ testing/] ( node/testing ) - Testing framework for Mina Rust Node.
67+ - [ cli/] ( cli ) - Mina Rust Node CLI.
68+ - [ frontend/] ( frontend ) - Mina Rust Node frontend.
8669
87- - [ Front End ] ( ./docs/building-from-source-guide.md#how-to-launch-the-ui )
70+ ## Documentation
8871
89- ### Testing Framework for Mina
72+ For complete documentation, guides, and tutorials, visit:
9073
91- - [ Full Testing Documentation ] ( docs/testing/testing.md )
74+ ** [ https://o1-labs.github.io/openmina ] ( https://o1-labs.github.io/openmina ) **
9275
93- ### How to run
76+ ### Key Documentation Sections
9477
95- - [ Non-Block Producing Node] ( ./docs/alpha-testing-guide.md )
96- - [ Block Producing Node] ( ./docs/block-producer-guide.md )
97- - [ Local Block Production Demo] ( ./docs/local-demo-guide.md )
78+ - ** [ Node Operators] ( https://o1-labs.github.io/openmina/docs/node-operators/getting-started ) ** -
79+ Installation and operation guides
80+ - ** [ Developers] ( https://o1-labs.github.io/openmina/docs/developers/getting-started ) ** -
81+ Architecture and contribution guides
82+ - ** [ API Documentation] ( https://o1-labs.github.io/openmina/api-docs/ ) ** -
83+ Comprehensive API reference
9884
9985[ changelog ] : ./CHANGELOG.md
10086[ beta-badge ] : https://img.shields.io/badge/status-beta-yellow
0 commit comments