Changed project name(from sparse tree to partial tree)

Author: wanseob

.travis.yml

@@ -36,10 +36,10 @@ deploy:
   on:
     condition: $NEXT != $CURRENT_VERSION
     tags: true
-    repo: commitground/solidity-sparse-tree
+    repo: commitground/solidity-partial-tree
   on:
     branch: develop
-    repo: commitground/solidity-sparse-tree
+    repo: commitground/solidity-partial-tree
 - provider: npm
   email: email@wanseob.com
   api_key:
@@ -48,15 +48,15 @@ deploy:
   on:
     condition: $LATEST != $CURRENT_VERSION
     tags: true
-    repo: commitground/solidity-sparse-tree
+    repo: commitground/solidity-partial-tree
   on:
     branch: master
-    repo: commitground/solidity-sparse-tree
+    repo: commitground/solidity-partial-tree
 
 - provider: releases
   api_key:
     secure: V5eGBJvkmXzwZ0op21QgUupDnRAmSVUpAX7mtuHn+vJqNlv+A5aYP+vpngxDktHj/yzqxI4zjFoifyhZPpKMfHNqg9XG6XY8wyoD2MmQdqULFa7jrIqW/HcdTBsSJYSWvC2K5/B0Agd9zII7mKkK2Qdk4IMB7mIZ2MXLhZOyik288YY+h3tNGDq+A7oOmj3/VyxKtLq6YRQLGvB7KdJw2UFhuC0WUOsUwX7dVytwphB1V4lC5c4hci9tyeqKP55bf5R5B5m4cGhBPSm647Baz41MO9JA01sjQSi84ho6k/tOmR3zbeFHNpMfZc4HZfP52VNKkClH0SGSqWQYjJeXwcs3xFG6TE+lDPcPAE7a6983LIYm2W97aaq1RiYSshbc3+6bYUjURxJNzjHVmDRI0OVqLc0sBVcvK4Z7lhp0T4sgGAdn2Up1RAmHySHSJq/It0C7BOzHAggpY5wDTzR0UZOtGajPF7bRmiAbeFHC6TCqBPq4Ao88+HoyRJzya0OrL+vmLUpdK7UXgCn2z/043oEjp+3GP7AllshZxeqmuzy/gsrjcERPtn8LvnffYO0dBA40e0AyuZbu+ArMU+xDKnLUITb8Ue7rXYEVs7crVHJVSYegXghCvVeD5WAjlOaKZ8kzKKI2u6r26FdIptUMSThBfjPQuqqZVXA+dxc22g0=
   on:
     tags: true
-    repo: commitground/solidity-sparse-tree
+    repo: commitground/solidity-partial-tree
     branch: master

README.md

@@ -1,19 +1,19 @@
-# Solidity Sparse Tree
+# Solidity Partial Merkle Tree
 
 ## Credits 
 
 This implementation is based on [Christian Reitwießner](https://github.com/chriseth)'s [patricia-tree](https://github.com/chriseth/patricia-tree) 
 
 
 ##### latest released version
-[![npm](https://img.shields.io/npm/v/solidity-sparse-tree/latest.svg)](https://www.npmjs.com/package/solidity-sparse-tree)
-[![Build Status](https://travis-ci.org/commitground/solidity-sparse-tree.svg?branch=master)](https://travis-ci.org/commitground/solidity-sparse-tree)
-[![Coverage Status](https://coveralls.io/repos/github/commitground/solidity-sparse-tree/badge.svg?branch=master)](https://coveralls.io/github/commitground/solidity-sparse-tree?branch=develop)
+[![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-sparse-tree/next.svg)](https://www.npmjs.com/package/solidity-sparse-tree)
-[![Build Status](https://travis-ci.org/commitground/solidity-sparse-tree.svg?branch=develop)](https://travis-ci.org/commitground/solidity-sparse-tree)
-[![Coverage Status](https://coveralls.io/repos/github/commitground/solidity-sparse-tree/badge.svg?branch=develop)](https://coveralls.io/github/commitground/solidity-sparse-tree?branch=develop)
+[![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)
 
@@ -22,27 +22,27 @@ This implementation is based on [Christian Reitwießner](https://github.com/chri
 ## Usage
 
 ```bash
-npm i solidity-sparse-tree
+npm i solidity-partial-tree
 npm i solidity-patricia-tree
 ```
 
 ```solidity
 pragma solidity ^0.4.24;
 
-import {SparseTree} from "solidity-sparse-tree/contracts/tree.sol";
 import {PatriciaTree} from "solidity-patricia-tree/contracts/tree.sol";
+import {PartialMerkleTree} from "solidity-partial-tree/contracts/tree.sol";
 
-contract TestSparseTree {
-    using SparseTree for SparseTree.Tree;
+contract TestPartialMerkleTree {
+    using PartialMerkleTree for PartialMerkleTree.Tree;
     using PatriciaTree for PatriciaTree.Tree;
 
     PatriciaTree.Tree patriciaTree;
-    SparseTree.Tree sparseTree;
+    PartialMerkleTree.Tree partialTree;
 
     /**
      * @dev we can reenact merkle tree transformation by submitting only referred siblings instead of submitting all nodes
      */
-    function testSparseTree() public {
+    function testOnChainProof() public {
         // update merkle root
         patriciaTree.insert("key1", "val1");
         patriciaTree.insert("key2", "val2");
@@ -56,23 +56,23 @@ contract TestSparseTree {
         bytes32[] memory siblings;
         (branchMask, siblings) = patriciaTree.getProof("key1");
 
-        // Init sparse tree with the root hash
-        sparseTree.initialize(phaseAOfPatriciaTree);
+        // Init partial tree with the root hash
+        partialTree.initialize(phaseAOfPatriciaTree);
         // commit branch (we submit sibling data here)
-        sparseTree.commitBranch("key1", "val1", branchMask, siblings);
+        partialTree.commitBranch("key1", "val1", branchMask, siblings);
 
         // Update key1 of patricia tree
         patriciaTree.insert("key1", "val4");
 
-        // Update key1 of sparse tree
-        sparseTree.insert("key1", "val4");
+        // Update key1 of partial tree
+        partialTree.insert("key1", "val4");
 
         // get updated root hashes of each tree
         bytes32 phaseBOfPatriciaTree = patriciaTree.getRootHash();
-        bytes32 phaseBOfSparseTree = sparseTree.getRootHash();
+        bytes32 phaseBOfPartialTree = partialTree.getRootHash();
 
         // We have succeeded to reenact merkle tree transformation without submitting all node data
-        require(phaseBOfPatriciaTree == phaseBOfSparseTree);
+        require(phaseBOfPatriciaTree == phaseBOfPartialTree);
     }
 }
 ```
@@ -90,9 +90,6 @@ npm install
 
 ### Tests
 
-Test cases include the information about how the functions work, but also includes a demo scenario.
-Running and reading the test cases will help you understand how it works.
-
 ```bash
 npm run test
 ```

contracts/data.sol

@@ -12,7 +12,7 @@ library D {
     }
 
     struct Edge {
-        bytes32 header; // variable for sparse tree  <email@wanseob.com>
+        bytes32 header; // variable for partial merkle tree  <email@wanseob.com>
         bytes32 node;
         Label label;
     }

contracts/implementation.sol

@@ -1,10 +1,10 @@
 pragma solidity ^0.4.24;
 
-import {SparseTree} from "./tree.sol";
+import {PartialMerkleTree} from "./tree.sol";
 
-contract SparseTreeImplementation {
-    using SparseTree for SparseTree.Tree;
-    SparseTree.Tree tree;
+contract PartialMerkleTreeImplementation {
+    using PartialMerkleTree for PartialMerkleTree.Tree;
+    PartialMerkleTree.Tree tree;
 
     constructor () public {
     }
@@ -37,6 +37,6 @@ contract SparseTreeImplementation {
     }
 
     function verifyProof(bytes32 rootHash, bytes key, bytes value, uint branchMask, bytes32[] siblings) public pure {
-        SparseTree.verifyProof(rootHash, key, value, branchMask, siblings);
+        PartialMerkleTree.verifyProof(rootHash, key, value, branchMask, siblings);
     }
 }

contracts/tree.sol

@@ -8,7 +8,7 @@ import {D} from "./data.sol";
  Based on patricia-trie implementation of chriseth
  */
 
-library SparseTree {
+library PartialMerkleTree {
     using D for D.Edge;
 
     struct Tree {

migrations/2_deploy_contracts.js

@@ -1,5 +1,5 @@
-const Tree = artifacts.require('SparseTree')
-const Implementation = artifacts.require('SparseTreeImplementation')
+const Tree = artifacts.require('PartialMerkleTree')
+const Implementation = artifacts.require('PartialMerkleTreeImplementation')
 
 module.exports = function (deployer) {
   deployer.deploy(Tree).then(() => {

package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "solidity-sparse-tree",
+  "name": "solidity-partial-tree",
   "version": "1.0.0",
-  "description": "Sparse Tree solidity implemenation",
+  "description": "Solidity implementation of partial merkle tree",
   "directories": {
     "test": "test"
   },
@@ -24,19 +24,19 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/commitground/solidity-sparse-tree.git"
+    "url": "git+https://github.com/commitground/solidity-partial-tree.git"
   },
   "keywords": [
     "Solidity",
-    "Sparse",
+    "Partial",
     "Patricia",
     "Merkle",
     "Tree"
   ],
   "author": "Wanseob Lim<email@wanseob.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/commitground/solidity-sparse-tree/issues"
+    "url": "https://github.com/commitground/solidity-partial-tree/issues"
   },
-  "homepage": "https://github.com/commitground/solidity-sparse-tree#readme"
+  "homepage": "https://github.com/commitground/solidity-partial-tree#readme"
 }

package.json

@@ -3,16 +3,16 @@ const assert = chai.assert
 const BigNumber = web3.BigNumber
 const should = chai.use(require('chai-bignumber')(BigNumber)).should()
 
-const SparseTreeImplementation = artifacts.require('SparseTreeImplementation')
+const PartialMerkleTreeImplementation = artifacts.require('PartialMerkleTreeImplementation')
 const { toNodeObject, progress } = require('./utils')
 
 const ZERO = '0x0000000000000000000000000000000000000000000000000000000000000000'
 
-contract('SparseTree', async ([_, primary, nonPrimary]) => {
-  context('SparseTree is also a kind of patricia merkle tree', async () => {
+contract('PartialMerkleTree', async ([_, primary, nonPrimary]) => {
+  context('PartialMerkleTree is also a kind of patricia merkle tree', async () => {
     let tree
-    beforeEach('deploy SparseTree', async () => {
-      tree = await SparseTreeImplementation.new({ from: primary })
+    beforeEach('deploy PartialMerkleTree', async () => {
+      tree = await PartialMerkleTreeImplementation.new({ from: primary })
     })
     describe('insert()', async () => {
       it('should not use gas more than 1 million', async () => {
@@ -84,7 +84,7 @@ contract('SparseTree', async ([_, primary, nonPrimary]) => {
         let rootHashOfFirstTree = await tree.getRootHash()
 
         // deploy a second tree
-        let secondTree = await SparseTreeImplementation.new({ from: primary })
+        let secondTree = await PartialMerkleTreeImplementation.new({ from: primary })
         // insert same items into the second tree
         for (const key of Object.keys(items)) {
           await progress.log(`Insert items into the second tree (${key}, ${items[key]})`, 500)
@@ -152,8 +152,8 @@ contract('SparseTree', async ([_, primary, nonPrimary]) => {
     let siblingsForKey1
     let referredValueForKey1
     before(async () => {
-      treeA = await SparseTreeImplementation.new()
-      treeB = await SparseTreeImplementation.new()
+      treeA = await PartialMerkleTreeImplementation.new()
+      treeB = await PartialMerkleTreeImplementation.new()
 
       await treeA.insert('key1', 'val1')
       await treeA.insert('key2', 'val2')