Merge pull request #5248 from BitGo/BTC-1450.add-isDescriptorWallet

feat(abstract-utxo): add isDescriptorWalletData

Author: OttoAllmendinger

modules/abstract-utxo/src/descriptor/descriptorWallet.ts

@@ -0,0 +1,21 @@
+import * as t from 'io-ts';
+import { NamedDescriptor } from './NamedDescriptor';
+import { AbstractUtxoCoinWalletData } from '../abstractUtxoCoin';
+import { DescriptorMap, toDescriptorMap } from '../core/descriptor';
+
+type DescriptorWalletData = AbstractUtxoCoinWalletData & {
+  coinSpecific: {
+    descriptors: NamedDescriptor[];
+  };
+};
+
+export function isDescriptorWalletData(obj: AbstractUtxoCoinWalletData): obj is DescriptorWalletData {
+  if ('coinSpecific' in obj && 'descriptors' in obj.coinSpecific) {
+    return t.array(NamedDescriptor).is(obj.coinSpecific.descriptors);
+  }
+  return false;
+}
+
+export function getDescriptorMapFromWalletData(wallet: DescriptorWalletData): DescriptorMap {
+  return toDescriptorMap(wallet.coinSpecific.descriptors);
+}

modules/abstract-utxo/src/descriptor/index.ts

@@ -1,3 +1,4 @@
 export { Miniscript, Descriptor } from '@bitgo/wasm-miniscript';
 export { assertDescriptorWalletAddress } from './assertDescriptorWalletAddress';
 export { NamedDescriptor } from './NamedDescriptor';
+export { isDescriptorWalletData, getDescriptorMapFromWalletData } from './descriptorWallet';

modules/abstract-utxo/test/descriptor/descriptorWallet.ts

@@ -0,0 +1,21 @@
+import assert from 'assert';
+import { getDescriptorMapFromWalletData, isDescriptorWalletData } from '../../src/descriptor';
+import { AbstractUtxoCoinWalletData } from '../../src';
+import { getDescriptorMap } from '../core/descriptor/descriptor.utils';
+
+describe('isDescriptorWalletData', function () {
+  const descriptorMap = getDescriptorMap('Wsh2Of3');
+  it('should return true for valid DescriptorWalletData', function () {
+    const walletData: AbstractUtxoCoinWalletData = {
+      coinSpecific: {
+        descriptors: [...descriptorMap.entries()].map(([name, descriptor]) => ({
+          name,
+          value: descriptor.toString(),
+        })),
+      },
+    } as unknown as AbstractUtxoCoinWalletData;
+
+    assert(isDescriptorWalletData(walletData));
+    assert.strictEqual(getDescriptorMapFromWalletData(walletData).size, descriptorMap.size);
+  });
+});