{"id":13564419,"url":"https://github.com/pokt-network/smt","last_synced_at":"2025-03-17T12:19:23.789Z","repository":{"id":152285586,"uuid":"606546928","full_name":"pokt-network/smt","owner":"pokt-network","description":"A Go library that implements a Sparse Merkle Trie for a key-value map.","archived":false,"fork":false,"pushed_at":"2024-08-22T17:52:31.000Z","size":4354,"stargazers_count":16,"open_issues_count":8,"forks_count":4,"subscribers_count":12,"default_branch":"main","last_synced_at":"2024-12-05T09:12:41.419Z","etag":null,"topics":["key-value-store","sparse-merkle-sum-trie","sparse-merkle-tree","sparse-merkle-trie","sum-tree","trie"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/pokt-network/smt","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"celestiaorg/smt","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pokt-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":"audits/240612_Thesis_Defense-Pokt_Network_Sparse_Merkel_Tree_Security_Audit_Report.pdf","citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-25T20:20:20.000Z","updated_at":"2024-08-22T17:50:51.000Z","dependencies_parsed_at":"2024-04-11T21:47:22.205Z","dependency_job_id":"dcd28733-0ef7-4999-8303-f52acd1e6ca9","html_url":"https://github.com/pokt-network/smt","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pokt-network%2Fsmt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pokt-network%2Fsmt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pokt-network%2Fsmt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pokt-network%2Fsmt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pokt-network","download_url":"https://codeload.github.com/pokt-network/smt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244031084,"owners_count":20386534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["key-value-store","sparse-merkle-sum-trie","sparse-merkle-tree","sparse-merkle-trie","sum-tree","trie"],"created_at":"2024-08-01T13:01:31.043Z","updated_at":"2025-03-17T12:19:23.769Z","avatar_url":"https://github.com/pokt-network.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# smt \u003c!-- omit in toc --\u003e\n\n[![Tag](https://img.shields.io/github/v/tag/pokt-network/smt.svg?sort=semver)](https://img.shields.io/github/v/tag/pokt-network/smt.svg?sort=semver)\n[![GoDoc](https://godoc.org/github.com/pokt-network/smt?status.svg)](https://godoc.org/github.com/pokt-network/smt)\n![Go Version](https://img.shields.io/github/go-mod/go-version/pokt-network/smt)\n[![Go Report Card](https://goreportcard.com/badge/github.com/pokt-network/smt)](https://goreportcard.com/report/github.com/pokt-network/smt)\n[![Tests](https://github.com/pokt-network/smt/actions/workflows/test.yml/badge.svg)](https://github.com/pokt-network/smt/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/pokt-network/smt/branch/main/graph/badge.svg)](https://codecov.io/gh/pokt-network/smt)\n\n\u003c!-- toc --\u003e\n\n- [Overview](#overview)\n- [Documentation](#documentation)\n- [Tests](#tests)\n- [Benchmarks](#benchmarks)\n- [Release Tags](#release-tags)\n  - [Tagging a new release](#tagging-a-new-release)\n  - [Push and Release](#push-and-release)\n\n\u003c!-- tocstop --\u003e\n\n**NOTE: Requires Go 1.20.12+**\n\n## Overview\n\nThis is a Go library that implements a Sparse Merkle Trie for a key-value map.\nThe trie implements the same optimisations specified in the [Libra whitepaper],\nto reduce the number of hash operations required per trie operation to $O(k)$\nwhere $k$ is the number of non-empty elements in the trie. And is implemented\nin a similar way to the [JMT whitepaper], with additional features and proof\nmechanics.\n\n## Documentation\n\nDocumentation for the different aspects of this library, the trie, proofs and\nall its different components can be found in the [docs](./docs/) directory.\n\n## Tests\n\nTo run all tests (excluding benchmarks) run the following command:\n\n```sh\nmake test_all\n```\n\nTo test the `badger` submodule that provides a more fully featured key-value\nstore, run the following command:\n\n```sh\nmake test_badger\n```\n\n## Benchmarks\n\nTo run the full suite of benchmarks simply run the following command:\n\n```sh\nmake benchmark_all\n```\n\nTo view pre-ran results of the entire benchmarking suite see\n[benchmarks](./docs/benchmarks.md)\n\n[jmt whitepaper]: https://developers.diem.com/papers/jellyfish-merkle-tree/2021-01-14.pdf\n[libra whitepaper]: https://diem-developers-components.netlify.app/papers/the-diem-blockchain/2020-05-26.pdf\n\n## Release Tags\n\nYou can tag and publish a new release by following the instructions bellow.\n\n### Tagging a new release\n\nFor a bug fix:\n\n```bash\nmake tag_bug_fix\n```\n\nFor a minor release run:\n\n```bash\nmake tag_minor_release\n```\n\n### Push and Release\n\nThen, push the tag to the repository:\n\n```bash\ngit push origin v\u003crelease\u003e\n```\n\nCreate a release on GitHub with the tag and the release notes [here](https://github.com/pokt-network/smt/releases/new).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpokt-network%2Fsmt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpokt-network%2Fsmt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpokt-network%2Fsmt/lists"}