@auxo-dev/zkapp-offchain-storage
v1.0.6
Published
<p align="center"> <a href="http://auxo.fund/" target="blank"><img src="https://lh3.googleusercontent.com/u/0/drive-viewer/AKGpihbOeavm7ejNaJLr70jxI0YLtj_KzKk7pzjyfbrBPxKRCmXIhEmhLftyPX_ZgOTdpE_B9uoPmiyP1NhBTIShqW8rtQhusA=w2388-h1376" alt="Auxo Logo"
Readme
Auxo Libs
Description
This library provides offchain storage APIs for Mina's zkApp, wrap around the Merkle Tree data structure.
To implement these APIs, developers need to:
- Specify the storage's size - Merkle Trees' height (except for key-value storage)
- Define data structure for a record and how to commit them in a single Field value (254-bit).
- How to calculate an index value.
Features
OneLevelStorage: Abstract class for a simple storage with predefined size of record.
TwoLevelStorage: Abstract class for a nested storage (two level of MT) with predefined size of record.
KeyValueStorage: Abstract class for a key value storage with 254-bit of key's length.
How to build
npm run buildHow to run tests
npm run test
npm run testw # watch modeHow to run coverage
npm run coverage