Giter Club home page Giter Club logo

openmina's Introduction

The Open Mina Node

Openmina Daily Changelog release-badge Apache licensed

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.

Overview of the Node’s current functionalities

Currently, with the Open Mina node, you can:

  • 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.
  • Produce SNARKs to complete SNARK work.
  • Broadcast messages: blocks, SNARK pool

We are working on the following:

  • Produce SNARKs in Rust (currently we use OCaml subprocess for that)

In the future, we plan to implement:

  • Direct transfer of MINA funds
  • Block production
  • SNARK proof generation for transactions
  • SnarkyJS support for Rust node, thanks to which you will be able to directly inject simple transactions, such as transferring Mina funds from one account to another.
  • The ability to record/replay all blocks

How to launch (with docker compose):

Run:

docker compose up

Then visit http://localhost:8070 in your browser.

How to launch (without docker compose):

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.

Steps (for Debian-based Linux distros):

Open up the command line and enter the following:

apt install curl git

curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain nightly-2023-10-07

source "$HOME/.cargo/env"

git clone https://github.com/openmina/openmina.git

cd openmina/

cargo run --release -p cli node

How to launch the UI:

Prerequisites

The following tools are required to launch the UI:

  • Node.js
  • npm
  • Angular CLI

Here are the steps to install these tools:

1. Node.js

Download and install Node.js for your OS, which includes Node Package Manager (npm).

  • After installing Node.js, verify your installation:

    node -v

    This command should print the version number of your Node.js installation.

2. npm

  • Verify that you are running a version of npm that is at least 6.x.x or higher:

    npm -v

    This command should print the version number of your npm installation.

3. Angular CLI

  • Install the Angular CLI globally:

    npm install -g @angular/cli

    This command installs the Angular CLI globally on your system.

  • Verify your Angular CLI installation:

    ng version

    This command should print the version number of your Angular CLI installation.

Steps (for any OS)

Open the command line, navigate to the openmina directory and then run

cd frontend
npm install
npm start

Open your browser and navigate to http://localhost:4200.

Repository Structure

  • 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.
    • native/ - OS specific pieces of the node, which is used to run the node natively (Linux/Mac/Windows).
    • testing/ - Testing framework for OpenMina node.
  • cli/ - OpenMina cli.
  • frontend/ - OpenMina frontend.

Details regarding architecture

The Open Mina Documentation

openmina's People

Contributors

adonagy avatar akoptelov avatar binier avatar directcuteo avatar dkuehr avatar janslobodnik avatar jurajselep avatar sebastiencs avatar tizoc avatar vlad9486 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.