search

ChainSafe / mina-rs

Rust implementation of the Mina protocol, targeting Wasm and ARM architectures.
167 stars 29 forks source link

readme

Mina-rs

Apache License Discord

Continuous integration codecov dependency status

An implementation of Mina protocol in Rust, with focus on web and Wasm compatibility

As you can probably tell this is a WIP! Don't use for anything yet

Rust doc of main branch can be found here

Building

Mina builds with the latest stable version of Rust. See installation instructions for your OS.

There isn't yet a binary to build. All of the crates can be built by running

cargo build

from the project root

Running Tests

All crate unit tests can be run by running

cargo test

Serialization tests

Serialization tests only can be run by

cargo test -p test-serialization

It is also possible to run the serialization tests in a Wasm environment using wasm-pack. First install wasm-pack with

curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh

cd to the serialization tests crate directory

cd protocol/test-serialization

and then run tests with either

wasm-pack test --node --release

or

wasm-pack test --headless --chrome --release --features browser

ChainSafe Security Policy

Reporting a Security Bug

We take all security issues seriously, if you believe you have found a security issue within a ChainSafe project please notify us immediately. If an issue is confirmed, we will take all necessary precautions to ensure a statement and patch release is made in a timely manner.

Please email us a description of the flaw and any related information (e.g. reproduction steps, version) to security at chainsafe dot io.

License

Mina-rs is licensed under Apache 2.0.