Merge pull request #5247 from BitGo/BTC-1450.move-outputdifference-test

refactor(abstract-utxo): move outputDifference test to abstract-utxo module

Author: OttoAllmendinger

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -536,7 +536,7 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
    * @param second
    * @returns {Array} All outputs that are in the first array but not in the second
    */
-  protected static outputDifference(first: Output[], second: Output[]): Output[] {
+  public static outputDifference(first: Output[], second: Output[]): Output[] {
     const keyFunc = ({ address, amount }: Output): string => `${address}:${amount}`;
     const groupedOutputs = _.groupBy(first, keyFunc);
 

modules/abstract-utxo/test/outputDifference.ts

@@ -0,0 +1,96 @@
+import 'should';
+
+import { AbstractUtxoCoin } from '../src';
+
+describe('Missing output detection', function () {
+  it('should recognize count mismatch dupes', function () {
+    const expectedOutputs = [
+      {
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+        amount: '300000',
+      },
+      {
+        amount: '300000',
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+      },
+    ];
+
+    const actualOutputs = [
+      {
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+        amount: 300000,
+      },
+      {
+        address: '2N2womedYhTC3YCDtviFte5G7teQczpVcds',
+        amount: 15349374,
+      },
+    ];
+
+    // missing should be one entry of the two
+    const missingOutputs = AbstractUtxoCoin.outputDifference(expectedOutputs, actualOutputs);
+
+    missingOutputs.length.should.equal(1);
+    missingOutputs[0].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
+    missingOutputs[0].amount.should.equal('300000');
+  });
+
+  it('should be order-agnostic', function () {
+    const expectedOutputs = [
+      {
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+        amount: '300000',
+      },
+      {
+        amount: '300000',
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+      },
+    ];
+
+    const actualOutputs = [
+      {
+        address: '2N2womedYhTC3YCDtviFte5G7teQczpVcds',
+        amount: 15349374,
+      },
+      {
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+        amount: 300000,
+      },
+    ];
+    // missing should be one entry of the two
+
+    const missingOutputs = AbstractUtxoCoin.outputDifference(expectedOutputs, actualOutputs);
+
+    missingOutputs.length.should.equal(1);
+    missingOutputs[0].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
+    missingOutputs[0].amount.should.equal('300000');
+  });
+
+  it('should preserve all dupes', function () {
+    const expectedOutputs = [
+      {
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+        amount: '300000',
+      },
+      {
+        amount: '300000',
+        address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
+      },
+    ];
+
+    const actualOutputs = [
+      {
+        address: '2N2womedYhTC3YCDtviFte5G7teQczpVcds',
+        amount: 15349374,
+      },
+    ];
+    // missing should be one entry of the two
+
+    const missingOutputs = AbstractUtxoCoin.outputDifference(expectedOutputs, actualOutputs);
+
+    missingOutputs.length.should.equal(2);
+    missingOutputs[0].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
+    missingOutputs[1].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
+    missingOutputs[0].amount.should.equal('300000');
+    missingOutputs[1].amount.should.equal('300000');
+  });
+});

modules/bitgo/test/v2/unit/baseCoin.ts

@@ -146,100 +146,4 @@ describe('V2 Base Coin:', function () {
       holeskyToken.getFamily().should.equal('eth');
     });
   });
-
-  describe('Missing output detection', function () {
-    it('should recognize count mismatch dupes', function () {
-      const expectedOutputs = [
-        {
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-          amount: '300000',
-        },
-        {
-          amount: '300000',
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-        },
-      ];
-
-      const actualOutputs = [
-        {
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-          amount: 300000,
-        },
-        {
-          address: '2N2womedYhTC3YCDtviFte5G7teQczpVcds',
-          amount: 15349374,
-        },
-      ];
-      // missing should be one entry of the two
-
-      const utxoBasecoin = bitgo.coin('tltc');
-      const missingOutputs = utxoBasecoin.constructor.outputDifference(expectedOutputs, actualOutputs);
-
-      missingOutputs.length.should.equal(1);
-      missingOutputs[0].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
-      missingOutputs[0].amount.should.equal('300000');
-    });
-
-    it('should be order-agnostic', function () {
-      const expectedOutputs = [
-        {
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-          amount: '300000',
-        },
-        {
-          amount: '300000',
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-        },
-      ];
-
-      const actualOutputs = [
-        {
-          address: '2N2womedYhTC3YCDtviFte5G7teQczpVcds',
-          amount: 15349374,
-        },
-        {
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-          amount: 300000,
-        },
-      ];
-      // missing should be one entry of the two
-
-      const utxoBasecoin = bitgo.coin('tltc');
-      const missingOutputs = utxoBasecoin.constructor.outputDifference(expectedOutputs, actualOutputs);
-
-      missingOutputs.length.should.equal(1);
-      missingOutputs[0].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
-      missingOutputs[0].amount.should.equal('300000');
-    });
-
-    it('should preserve all dupes', function () {
-      const expectedOutputs = [
-        {
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-          amount: '300000',
-        },
-        {
-          amount: '300000',
-          address: '2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ',
-        },
-      ];
-
-      const actualOutputs = [
-        {
-          address: '2N2womedYhTC3YCDtviFte5G7teQczpVcds',
-          amount: 15349374,
-        },
-      ];
-      // missing should be one entry of the two
-
-      const utxoBasecoin = bitgo.coin('tltc');
-      const missingOutputs = utxoBasecoin.constructor.outputDifference(expectedOutputs, actualOutputs);
-
-      missingOutputs.length.should.equal(2);
-      missingOutputs[0].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
-      missingOutputs[1].address.should.equal('2N6eb6Gosm2jt4o3djFLjb4kuKyPgAj8teZ');
-      missingOutputs[0].amount.should.equal('300000');
-      missingOutputs[1].amount.should.equal('300000');
-    });
-  });
 });