@auxo-dev/zkapp-offchain-storage v1.0.6

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

1. OneLevelStorage: Abstract class for a simple storage with predefined size of record.

2. TwoLevelStorage: Abstract class for a nested storage (two level of MT) with predefined size of record.

3. KeyValueStorage: Abstract class for a key value storage with 254-bit of key's length.

How to build

npm run build

How to run tests

npm run test
npm run testw # watch mode

How to run coverage

npm run coverage

License

Apache-2.0