Merge pull request #118 from BoltzExchange/swaptree-compare

SwapTree compare function
BoltzExchange · Mar 22, 2024 · a3cbe6d · a3cbe6d
2 parents d75f189 + ce129fa
commit a3cbe6d
Show file tree

Hide file tree

Showing 10 changed files with 417 additions and 175 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -7,7 +7,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest]
-        node-version: [18, 20]
+        node-version: [18, 20, 21]
 
     runs-on: ${{ matrix.platform }}
 

diff --git a/contracts/lib/forge-std b/contracts/lib/forge-std
diff --git a/contracts/test/ERC20SwapTest.sol b/contracts/test/ERC20SwapTest.sol
@@ -40,7 +40,7 @@ contract ERC20SwapTest is Test {
         sigUtils = new SigUtils(swap.DOMAIN_SEPARATOR(), swap.TYPEHASH_REFUND());
     }
 
-    function testCorrectVersion() external {
+    function testCorrectVersion() external view {
         assertEq(swap.version(), 3);
     }
 
@@ -49,7 +49,7 @@ contract ERC20SwapTest is Test {
         require(!success);
     }
 
-    function testHashSwapValues() external {
+    function testHashSwapValues() external view {
         uint256 timelock = block.number;
 
         assertEq(

diff --git a/contracts/test/EtherSwapTest.sol b/contracts/test/EtherSwapTest.sol
@@ -35,7 +35,7 @@ contract EtherSwapTest is Test {
 
     receive() payable external {}
 
-    function testCorrectVersion() external {
+    function testCorrectVersion() external view {
         assertEq(swap.version(), 3);
     }
 
@@ -44,7 +44,7 @@ contract EtherSwapTest is Test {
         require(!success);
     }
 
-    function testHashSwapValues() external {
+    function testHashSwapValues() external view {
         uint256 timelock = block.number;
 
         assertEq(

diff --git a/lib/Boltz.ts b/lib/Boltz.ts
@@ -28,6 +28,7 @@ import swapTree, {
   extractClaimPublicKeyFromSwapTree,
   extractRefundPublicKeyFromSwapTree,
 } from './swap/SwapTree';
+import { compareTrees } from './swap/SwapTreeCompare';
 import * as SwapTreeSerializer from './swap/SwapTreeSerializer';
 import * as SwapUtils from './swap/SwapUtils';
 import * as TaprootUtils from './swap/TaprootUtils';
@@ -57,6 +58,7 @@ export {
   targetFee,
   swapScript,
   detectSwap,
+  compareTrees,
   detectPreimage,
   reverseSwapTree,
   reverseSwapScript,

diff --git a/lib/swap/SwapDetector.ts b/lib/swap/SwapDetector.ts
@@ -49,7 +49,7 @@ export const detectSwap = <
         vout,
         type: scriptMatch[0],
         ...output,
-      } as DetectedSwap<T>;
+      } as unknown as DetectedSwap<T>;
     }
   }
 

diff --git a/lib/swap/SwapTreeCompare.ts b/lib/swap/SwapTreeCompare.ts
@@ -0,0 +1,26 @@
+import { Taptree } from 'bitcoinjs-lib/src/types';
+import { SwapTree, Tapleaf } from '../consts/Types';
+
+const compareLeaf = (leaf: Tapleaf, compareLeaf: Tapleaf) =>
+  leaf.version === compareLeaf.version &&
+  leaf.output.equals(compareLeaf.output);
+
+const compareTree = (tree: Taptree, compare: Taptree) => {
+  if (Array.isArray(tree) !== Array.isArray(compare)) {
+    return false;
+  }
+
+  if (Array.isArray(tree) && Array.isArray(compare)) {
+    return (
+      tree.length === compare.length &&
+      tree.every((leaf, i) => compareTree(leaf, compare[i]))
+    );
+  } else {
+    return compareLeaf(tree as Tapleaf, compare as Tapleaf);
+  }
+};
+
+export const compareTrees = <T extends SwapTree>(
+  tree: T,
+  compare: T,
+): boolean => compareTree(tree.tree, compare.tree);
+0 −3		.gitmodules
+1 −1		README.md
+1 −1		foundry.toml
+0 −1		lib/ds-test
+1 −1		scripts/vm.py
+518 −225		src/StdAssertions.sol
+3 −1		src/StdChains.sol
+7 −11		src/StdJson.sol
+201 −106		src/StdStorage.sol
+179 −0		src/StdToml.sol
+4 −4		src/Test.sol
+525 −1		src/Vm.sol
+51 −33		src/mocks/MockERC20.sol
+46 −32		src/mocks/MockERC721.sol
+39 −909		test/StdAssertions.t.sol
+29 −24		test/StdChains.t.sol
+18 −10		test/StdCheats.t.sol
+49 −0		test/StdJson.t.sol
+8 −8		test/StdMath.t.sol
+159 −11		test/StdStorage.t.sol
+49 −0		test/StdToml.t.sol
+18 −18		test/StdUtils.t.sol
+3 −3		test/Vm.t.sol
+8 −0		test/fixtures/test.json
+6 −0		test/fixtures/test.toml
+1 −1		test/mocks/MockERC20.t.sol
+1 −1		test/mocks/MockERC721.t.sol