Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/commitground/solidity-partial-tree

Solidity implementation of partial merkle tree for a light weight side chain execution verification
https://github.com/commitground/solidity-partial-tree

chain light merkle partial side solidity tree

Last synced: 18 days ago
JSON representation

Solidity implementation of partial merkle tree for a light weight side chain execution verification

Host: GitHub
URL: https://github.com/commitground/solidity-partial-tree
Owner: commitground
License: mit
Created: 2018-11-20T17:33:18.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2019-04-09T06:13:58.000Z (over 5 years ago)
Last Synced: 2024-10-18T14:58:40.497Z (28 days ago)
Topics: chain, light, merkle, partial, side, solidity, tree
Language: JavaScript
Homepage:
Size: 635 KB
Stars: 13
Watchers: 5
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Solidity Partial Merkle Tree

## Credits 

This implementation is based on [Christian Reitwießner](https://github.com/chriseth)'s [patricia-trie](https://github.com/chriseth/patricia-trie) 

##### latest released version

[![npm](https://img.shields.io/npm/v/solidity-partial-tree/latest.svg)](https://www.npmjs.com/package/solidity-partial-tree)

[![Build Status](https://travis-ci.org/commitground/solidity-partial-tree.svg?branch=master)](https://travis-ci.org/commitground/solidity-partial-tree)

[![Coverage Status](https://coveralls.io/repos/github/commitground/solidity-partial-tree/badge.svg?branch=master)](https://coveralls.io/github/commitground/solidity-partial-tree?branch=develop)

##### in progress

[![npm](https://img.shields.io/npm/v/solidity-partial-tree/next.svg)](https://www.npmjs.com/package/solidity-partial-tree)

[![Build Status](https://travis-ci.org/commitground/solidity-partial-tree.svg?branch=develop)](https://travis-ci.org/commitground/solidity-partial-tree)

[![Coverage Status](https://coveralls.io/repos/github/commitground/solidity-partial-tree/badge.svg?branch=develop)](https://coveralls.io/github/commitground/solidity-partial-tree?branch=develop)

[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

## Usage

```bash

npm i solidity-partial-tree

npm i solidity-patricia-tree

```

```solidity

pragma solidity ^0.4.24;

import {PatriciaTree} from "solidity-patricia-tree/contracts/tree.sol";

import {PartialMerkleTree} from "solidity-partial-tree/contracts/tree.sol";

contract TestPartialMerkleTree {

    using PartialMerkleTree for PartialMerkleTree.Tree;

    using PatriciaTree for PatriciaTree.Tree;

    PatriciaTree.Tree patriciaTree;

    PartialMerkleTree.Tree partialTree;

    /**

     * @dev we can reenact merkle tree transformation by submitting only referred siblings instead of submitting all nodes

     */

    function testOnChainProof() public {

        // update merkle root

        patriciaTree.insert("key1", "val1");

        patriciaTree.insert("key2", "val2");

        patriciaTree.insert("key3", "val3");

        // root hash of patricia tree @ phase A

        bytes32 phaseAOfPatriciaTree = patriciaTree.getRootHash();

        // get siblings to update "key1"

        uint branchMask;

        bytes32[] memory siblings;

        (branchMask, siblings) = patriciaTree.getProof("key1");

        // Init partial tree with the root hash

        partialTree.initialize(phaseAOfPatriciaTree);

        // commit branch (we submit sibling data here)

        partialTree.commitBranch("key1", "val1", branchMask, siblings);

        // Update key1 of patricia tree

        patriciaTree.insert("key1", "val4");

        // Update key1 of partial tree

        partialTree.insert("key1", "val4");

        // get updated root hashes of each tree

        bytes32 phaseBOfPatriciaTree = patriciaTree.getRootHash();

        bytes32 phaseBOfPartialTree = partialTree.getRootHash();

        // We have succeeded to reenact merkle tree transformation without submitting all node data

        require(phaseBOfPatriciaTree == phaseBOfPartialTree);

    }

}

```

## Development 

### Pre-requisites

```bash

npm install -g truffle

npm install -g ganache-cli

npm install

```

### Tests

```bash

npm run test

```

## Contributors

- [Wanseob Lim](https://github.com/james-lim)<[[email protected]](mailto:[email protected])>

## License

[MIT LICENSE](./LICENSE)