Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nlok5923/midenbase


https://github.com/nlok5923/midenbase

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
# Miden Rollup protocol










Description and core structures for the Miden Rollup protocol.



**WARNING:** This project is in an alpha stage. It has not been audited and may contain bugs and security flaws. This implementation is NOT ready for production use.



## Overview



Miden is a zero-knowledge rollup for high-throughput and private applications. Miden allows users to execute and prove transactions locally (i.e., on their devices) and commit only the proofs of the executed transactions to the network.



If you want to join the technical discussion or learn more about the project, please check out



* the [documentation](https://0xpolygonmiden.github.io/miden-base/).

* the [Discord](https://discord.gg/0xpolygondevs)

* the [Repo](https://github.com/0xPolygonMiden)

* the [Roadmap](roadmap.md)



## Status and features



Polygon Miden is currently on release v0.1. This is an early version of the protocol and its components. We expect to keep making changes (including breaking changes) to all components.



### Feature highlights



* **Private accounts**. The Miden Operator tracks only commitments to account data in the public database. The users are responsible for keeping track of the state of their accounts.

* **Private notes**. Like with private accounts, the Miden Operator tracks only commitments to notes in the public database. Users need to communicate note details to each other via side-channels.

* **Local transactions**. Users can execute and prove transactions locally on their devices. The Miden Operator verifies the proofs and if the proofs are valid, updates the state of the rollup accordingly.

* **Standard account**. Users can create accounts using a small number of standard account interfaces (e.g., basic wallet). In the future, the set of standard smart contracts will be expanded.

* **Standard notes**. Can create notes using standardized note scripts such as pay-to-ID (`P2ID`) and atomic swap (`SWAP`). In the future, the set of standardized notes will be expanded.



### Planned features



* **Public accounts**. With public accounts users will be able to store the entire state of their accounts on-chain, thus, eliminating the need to keep track of account states locally (albeit by sacrificing privacy and at a higher cost).

* **Public notes**. With public notes, the users will be able to store all note details on-chain, thus, eliminating the need to communicate note details via side-channels. Encrypted on-chain notes will also be supported in the future.

* **More storage types**. In addition to storing a limited set of simple values, the accounts will be able to store data in storage maps (mapping 256-bit keys to 256-bit values) and storage arrays.

* **Network transactions**. Users will be able to create notes intended for network execution. Such notes will be included into transactions executed and proven by the Miden operator.



## Project structure



| Crate                    | Description |

| ------------------------ | ----------- |

| [objects](objects)       | Contains core components defining the Miden rollup protocol. |

| [miden-lib](miden-lib)   | Contains the code of the Miden rollup kernels and standardized smart contracts. |

| [miden-tx](miden-tx)     | Contains tool for creating, executing, and proving Miden rollup transaction. |

| [mock](mock)             | Contains utilities to help with testing Miden rollup components.|



## Testing



To test the crates contained in this repo, you can run the following command:



```shell

make test

```



Some of the functions in this project are computationally intensive and may take a significant amount of time to compile and complete during testing. To ensure optimal results we use the `make test` command. It enables the running of tests in release mode and using specific configurations replicates the test conditions of the development mode and verifies all debug assertions. For more information refer to the [Makefile](./Makefile) for the specific commands and configurations that have been chosen.



## License



This project is [MIT licensed](./LICENSE)