rsmt2d-rs


Report a Bug - Request a Feature - Ask a Question

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/stark-rocket/rsmt2d-rs/test?style=flat-square&logo=github) [![Project license](https://img.shields.io/github/license/stark-rocket/rsmt2d-rs.svg?style=flat-square)](LICENSE) [![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/stark-rocket/rsmt2d-rs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

Table of Contents


About

Rust implementation of two dimensional Reed-Solomon merkle tree data availability scheme.

This technique is used by Celestia for their data availability sampling solution.

The scheme is described in the Fraud and Data Availability Proofs: Maximising Light Client Security and Scaling Blockchains with Dishonest Majorities.

The implementation is inspired by the rsmt go implementation.

The 2D Reed-Solomon Merkle-Tree data architecture looks like this:

architecture

Getting Started

Prerequisites

Installation

[TODO]

Usage

Roadmap

See the open issues for a list of proposed features (and known issues).

Support

Reach out to the maintainer at one of the following places:

Project assistance

If you want to say thank you or/and support active development of rsmt2d-rs:

Together, we can make rsmt2d-rs better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

For a full list of all authors and contributors, see the contributors page.

Security

rsmt2d-rs follows good practices of security, but 100% security cannot be assured. rsmt2d-rs is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements