smt

• Overview
• Documentation
• Tests
• Benchmarks
• Release Tags

Overview

This is a Go library that implements a Sparse Merkle Trie for a key-value map. The trie implements the same optimizations specified in the Libra whitepaper, to reduce the number of hash operations required per trie operation to $O(k)$ where $k$ is the number of non-empty elements in the trie. And is implemented in a similar way to the JMT whitepaper, with additional features and proof mechanics.

Documentation

Documentation for the different aspects of this library, the trie, proofs and all its different components can be found in the docs directory:

• Sparse Merkle Trie - Core SMT implementation and usage
• Merkle Sum Trie - SMST implementation with sum capabilities
• Benchmarks - Performance benchmarks and analysis
• MapStore Interface - Key-value store interface documentation
• Badger Store - BadgerDB storage backend implementation
• FAQ - Frequently asked questions

Tests

To run all tests (excluding benchmarks) run the following command:

make test_all

To test the badger submodule that provides a more fully featured key-value store, run the following command:

make test_badger

Benchmarks

To run the full suite of benchmarks simply run the following command:

make benchmark_all

To view pre-ran results of the entire benchmarking suite see benchmarks

Release Tags

You can tag and publish a new release by using one of the following commands:

make release_tag_rc
make release_tag_dev
make release_tag_minor
make release_tag_major

Create a release on GitHub with the tag and the release notes on GitHub.