rsmt2d-rs 0.0.1

Rust implementation of two dimensional Reed-Solomon merkle tree data availability scheme.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

<div align="center">
  <h1>rsmt2d-rs</h1>
  <br />
  <a href="https://github.com/stark-rocket/rsmt2d-rs/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a>
  -
  <a href="https://github.com/stark-rocket/rsmt2d-rs/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a>
  -
  <a href="https://github.com/stark-rocket/rsmt2d-rs/discussions">Ask a Question</a>
</div>

<div align="center">
<br />

![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)

</div>

<details open="open">
<summary>Table of Contents</summary>

- [Report a Bug](#report-a-bug)
- [Request a Feature](#request-a-feature)
- [About](#about)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Support](#support)
- [Project assistance](#project-assistance)
- [Contributing](#contributing)
- [Authors \& contributors](#authors--contributors)
- [Security](#security)
- [License](#license)
- [Acknowledgements](#acknowledgements)

</details>

---

## 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](https://arxiv.org/pdf/1809.09044.pdf).

The implementation is inspired by the [rsmt go implementation](https://github.com/celestiaorg/rsmt2d).

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

![architecture](./docs/images/rsmt2d-architecture.png)

## Getting Started

### Prerequisites

- [Rust](https://www.rust-lang.org/tools/install)

### Installation

> **[TODO]**

## Usage

## Roadmap

See the [open issues](https://github.com/stark-rocket/rsmt2d-rs/issues) for a list of proposed features (and known issues).

- [Top Feature Requests](https://github.com/stark-rocket/rsmt2d-rs/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/stark-rocket/rsmt2d-rs/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Newest Bugs](https://github.com/stark-rocket/rsmt2d-rs/issues?q=is%3Aopen+is%3Aissue+label%3Abug)

## Support

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

- [GitHub Discussions](https://github.com/stark-rocket/rsmt2d-rs/discussions)
- Contact options listed on [this GitHub profile](https://github.com/stark-rocket)

## Project assistance

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

- Add a [GitHub Star](https://github.com/stark-rocket/rsmt2d-rs) to the project.
- Tweet about the rsmt2d-rs.
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog.

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](docs/CONTRIBUTING.md), and thank you for being involved!

## Authors & contributors

For a full list of all authors and contributors, see [the contributors page](https://github.com/stark-rocket/rsmt2d-rs/contributors).

## 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](docs/SECURITY.md)._

## License

This project is licensed under the **MIT license**.

See [LICENSE](LICENSE) for more information.

## Acknowledgements

- Huge props to Celestia of course for the original implementation in [Go](https://github.com/celestiaorg/rsmt2d) and the [paper](https://arxiv.org/pdf/1809.09044.pdf).