Contract Compatibility (#459)

* Reversing the order of siblings in merkle proofs such that the first in the list is the leaf sibling
* making token type a uint instead of a bool
* fixing unit tests that reversed siblings
* bumping contracts tests timeou
* Changing sleep test since it tests something we cannot control

packages/contracts/package.json

@@ -7,7 +7,7 @@
     "build/**/.js"
   ],
   "scripts": {
-    "test": "waffle waffle-config.json && mocha --require ts-node/register 'test/**/*.spec.ts'",
+    "test": "waffle waffle-config.json && mocha --require ts-node/register 'test/**/*.spec.ts' --timeout 5000",
     "lint": "tslint --format stylish --project .",
     "fix": "prettier --config ./.prettierrc.js --write 'index.ts' '{src,test}/**/*.ts'",
     "build": "waffle waffle-config.json && tsc -p .",

packages/contracts/test/helpers/RollupBlock.ts

@@ -83,9 +83,9 @@ export class RollupBlock {
       hexStrToBuf(this.encodedTransitions[transitionIndex])
     )
     const path = bufToHexString(blockInclusion.key.toBuffer('B', 32))
-    const siblings = blockInclusion.siblings
-      .map((sibBuf) => bufToHexString(sibBuf))
-      .reverse()
+    const siblings = blockInclusion.siblings.map((sibBuf) =>
+      bufToHexString(sibBuf)
+    )
     return {
       blockNumber: this.blockNumber,
       transitionIndex,

packages/contracts/test/merklization/RollupMerkleUtils.spec.ts

@@ -155,11 +155,9 @@ describe('RollupMerkleUtils', () => {
           )
           // Extract the values we need for the proof in the form we need them
           const path = bufToHexString(inclusionProof.key.toBuffer('B', 32))
-          // Extract the siblings but reverse the order (reversed order is what is expected by the contract
-          // which verifies bottom to top as opposed to top to bottom.
-          const siblings = inclusionProof.siblings
-            .map((sibBuf) => bufToHexString(sibBuf))
-            .reverse()
+          const siblings = inclusionProof.siblings.map((sibBuf) =>
+            bufToHexString(sibBuf)
+          )
           const isValid = await rollupMerkleUtils.verify(
             bufToHexString(inclusionProof.rootHash),
             bufToHexString(inclusionProof.value),
@@ -200,11 +198,9 @@ describe('RollupMerkleUtils', () => {
           )
           // Extract the values we need for the proof in the form we need them
           const path = bufToHexString(inclusionProof.key.toBuffer('B', 32))
-          // Extract the siblings but reverse the order (reversed order is what is expected by the contract
-          // which verifies bottom to top as opposed to top to bottom.
-          const siblings = inclusionProof.siblings
-            .map((sibBuf) => bufToHexString(sibBuf))
-            .reverse()
+          const siblings = inclusionProof.siblings.map((sibBuf) =>
+            bufToHexString(sibBuf)
+          )
           await rollupMerkleUtils.store(
             bufToHexString(inclusionProof.value),
             path,

packages/contracts/test/rollup-chain-manager/RollupChain.spec.ts

@@ -407,9 +407,7 @@ describe('RollupChain', () => {
         )
         // Here we're storing the siblings in the format we need them!
         siblings.push(
-          inclusionProof.siblings
-            .map((sibBuf) => bufToHexString(sibBuf))
-            .reverse()
+          inclusionProof.siblings.map((sibBuf) => bufToHexString(sibBuf))
         )
       }
 

packages/core/src/app/block-production/merkle-tree.ts

@@ -120,14 +120,16 @@ export class SparseMerkleTreeImpl implements SparseMerkleTree {
         inclusionProof.value,
         inclusionProof.key
       )
+
+      let siblingIndex = 0
       let parent: MerkleTreeNode = child
       const nodesToStore: MerkleTreeNode[] = [child]
       for (let parentDepth = this.height - 2; parentDepth >= 0; parentDepth--) {
         child = parent
 
         const childDepth: number = parentDepth + 1
         // Since there's no root sibling, each sibling is one index lower
-        const childSiblingHash: Buffer = inclusionProof.siblings[childDepth - 1]
+        const childSiblingHash: Buffer = inclusionProof.siblings[siblingIndex++]
         parent = this.calculateParentNode(
           child,
           childSiblingHash,
@@ -283,7 +285,7 @@ export class SparseMerkleTreeImpl implements SparseMerkleTree {
         rootHash: this.root.hash,
         key: leafKey,
         value: leafValue,
-        siblings,
+        siblings: siblings.reverse(),
       }
     })
   }
@@ -323,7 +325,7 @@ export class SparseMerkleTreeImpl implements SparseMerkleTree {
       rootHash: this.root.hash,
       key: leafKey,
       value: SparseMerkleTreeImpl.emptyBuffer,
-      siblings,
+      siblings: siblings.reverse(),
     })
   }
 

packages/core/test/app/block-production/merkle-tree.spec.ts

@@ -47,7 +47,7 @@ const verifyEmptyTreeWithDepth = async (
     rootHash: await tree.getRootHash(),
     key,
     value: SparseMerkleTreeImpl.emptyBuffer,
-    siblings: siblings.reverse(),
+    siblings,
   }
 
   assert(
@@ -794,9 +794,9 @@ describe('SparseMerkleTreeImpl', () => {
       assert(proof.siblings.length === 2)
 
       let hash: Buffer = zeroHash
-      assert(proof.siblings[1].equals(hash))
-      hash = bufferHashFunction(hashBuffer.fill(hash, 0, 32).fill(hash, 32))
       assert(proof.siblings[0].equals(hash))
+      hash = bufferHashFunction(hashBuffer.fill(hash, 0, 32).fill(hash, 32))
+      assert(proof.siblings[1].equals(hash))
 
       assert(proof.rootHash.equals(await tree.getRootHash()))
     })
@@ -821,9 +821,9 @@ describe('SparseMerkleTreeImpl', () => {
       assert(proof.siblings.length === 2)
 
       let hash: Buffer = zeroHash
-      assert(proof.siblings[1].equals(hash))
-      hash = bufferHashFunction(hashBuffer.fill(hash, 0, 32).fill(hash, 32))
       assert(proof.siblings[0].equals(hash))
+      hash = bufferHashFunction(hashBuffer.fill(hash, 0, 32).fill(hash, 32))
+      assert(proof.siblings[1].equals(hash))
 
       assert(proof.rootHash.equals(await tree.getRootHash()))
     })
@@ -858,11 +858,11 @@ describe('SparseMerkleTreeImpl', () => {
 
       assert(proof.siblings.length === 2)
       let hash: Buffer = bufferHashFunction(oneData)
-      assert(proof.siblings[1].equals(hash))
+      assert(proof.siblings[0].equals(hash))
       hash = bufferHashFunction(
         hashBuffer.fill(zeroHash, 0, 32).fill(zeroHash, 32)
       )
-      assert(proof.siblings[0].equals(hash))
+      assert(proof.siblings[1].equals(hash))
 
       assert(proof.rootHash.equals(await tree.getRootHash()))
 
@@ -874,12 +874,11 @@ describe('SparseMerkleTreeImpl', () => {
 
       assert(proof.siblings.length === 2)
       hash = bufferHashFunction(zeroData)
-      assert(proof.siblings[1].equals(hash))
+      assert(proof.siblings[0].equals(hash))
       hash = bufferHashFunction(
         hashBuffer.fill(zeroHash, 0, 32).fill(zeroHash, 32)
       )
-      assert(proof.siblings[0].equals(hash))
-
+      assert(proof.siblings[1].equals(hash))
       assert(proof.rootHash.equals(await tree.getRootHash()))
     })
 
@@ -918,11 +917,11 @@ describe('SparseMerkleTreeImpl', () => {
       assert(proof.siblings.length === 2)
 
       let hash: Buffer = zeroHash
-      assert(proof.siblings[1].equals(hash))
+      assert(proof.siblings[0].equals(hash))
       hash = bufferHashFunction(
         hashBuffer.fill(bufferHashFunction(twoData), 0, 32).fill(zeroHash, 32)
       )
-      assert(proof.siblings[0].equals(hash))
+      assert(proof.siblings[1].equals(hash))
       assert(proof.rootHash.equals(await tree.getRootHash()))
 
       // Check Proof for TWO
@@ -934,11 +933,11 @@ describe('SparseMerkleTreeImpl', () => {
       assert(proof.siblings.length === 2)
 
       hash = zeroHash
-      assert(proof.siblings[1].equals(hash))
+      assert(proof.siblings[0].equals(hash))
       hash = bufferHashFunction(
         hashBuffer.fill(bufferHashFunction(zeroData), 0, 32).fill(zeroHash, 32)
       )
-      assert(proof.siblings[0].equals(hash))
+      assert(proof.siblings[1].equals(hash))
 
       assert(proof.rootHash.equals(await tree.getRootHash()))
     })

packages/core/test/app/utils/misc.spec.ts

@@ -17,7 +17,8 @@ describe('Miscellanous Utils', () => {
       const end = Date.now()
       const diff = end - start
 
-      diff.should.be.closeTo(100, 10)
+      diff.should.be.greaterThan(99)
+      diff.should.be.lessThan(150)
     })
   })
 

packages/wallet/src/serialization/common.ts

@@ -5,12 +5,12 @@ export const abi = new ethers.utils.AbiCoder()
 export const transferAbiTypes = [
   'address', // sender address
   'address', // recipient address
-  'bool', // token type
+  'uint', // token type
   'uint32', // amount
 ]
 export const swapAbiTypes = [
   'address', // sender address
-  'bool', // token type
+  'uint', // token type
   'uint32', // amount
   'uint32', // min output amount
   'uint', // timeout
@@ -23,7 +23,7 @@ export const swapTransitionAbiTypes = [
   'bytes32', // state root
   'uint32', // sender slot
   'uint32', // uniswap slot
-  'bool', // token type
+  'uint', // token type
   'uint32', // input amount
   'uint32', // min output amount
   'uint', // timeout
@@ -33,7 +33,7 @@ export const transferTransitionAbiTypes = [
   'bytes32', // state root
   'uint32', // sender slot
   'uint32', // recipient slot
-  'bool', // token type
+  'uint', // token type
   'uint32', // amount
   'bytes', // transaction signature
 ]
@@ -42,7 +42,7 @@ export const createAndTransferTransitionAbiTypes = [
   'uint32', // sender slot
   'uint32', // recipient slot
   'address', // created public key
-  'bool', // token type
+  'uint', // token type
   'uint32', // amount
   'bytes', // transaction signature
 ]