Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ChainSafe/mina-rs

Rust implementation of the Mina protocol, targeting Wasm and ARM architectures.
https://github.com/ChainSafe/mina-rs

Last synced: 9 days ago
JSON representation

Rust implementation of the Mina protocol, targeting Wasm and ARM architectures.

Host: GitHub
URL: https://github.com/ChainSafe/mina-rs
Owner: ChainSafe
Archived: true
Created: 2021-05-06T15:05:05.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-09-30T03:55:16.000Z (about 2 years ago)
Last Synced: 2024-08-02T03:07:38.695Z (3 months ago)
Language: Rust
Size: 39 MB
Stars: 163
Watchers: 18
Forks: 29
Open Issues: 27
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-blockchain-rust - Mina Protocol

README

# Mina-rs

[](https://opensource.org/licenses/Apache-2.0)
[](https://discord.gg/Vx4uHpNM)

[![Continuous integration](https://github.com/ChainSafe/mina-rs/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/ChainSafe/mina-rs/actions/workflows/build-and-test.yml)
[![codecov](https://codecov.io/gh/ChainSafe/mina-rs/branch/main/graph/badge.svg?token=7YXISNRW48)](https://codecov.io/gh/ChainSafe/mina-rs)
[![dependency status](https://deps.rs/repo/github/ChainSafe/mina-rs/status.svg?style=flat-square)](https://deps.rs/repo/github/ChainSafe/mina-rs)

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](https://chainsafe.github.io/mina-rs/rustdoc/)

## Building

Mina builds with the latest stable version of Rust. See [installation instructions for your OS](https://www.rust-lang.org/tools/install).

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

```shell
cargo build
```

from the project root

## Running Tests

All crate unit tests can be run by running

```shell
cargo test
```

### Serialization tests

Serialization tests only can be run by

```shell
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

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

cd to the serialization tests crate directory

```shell
cd protocol/test-serialization
```

and then run tests with either

```shell
wasm-pack test --node --release
```

```shell
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](mailto:[email protected]).

## License

Mina-rs is licensed under [Apache 2.0](https://github.com/ChainSafe/mina-rs/blob/main/LICENSE).