Merge pull request #6821 from BitGo/BTC-2415

feat(abstract-utxo): add BIP322 message serialization format

Author: davidkaplanbitgo

modules/abstract-utxo/src/transaction/bip322.ts

@@ -0,0 +1,35 @@
+import { decodeOrElse } from '@bitgo/sdk-core';
+import * as t from 'io-ts';
+
+const BIP322MessageInfo = t.type({
+  address: t.string,
+  message: t.string,
+  pubkeys: t.array(t.string),
+  scriptType: t.union([
+    t.literal('p2sh'),
+    t.literal('p2shP2wsh'),
+    t.literal('p2wsh'),
+    t.literal('p2tr'),
+    t.literal('p2trMusig2'),
+  ]),
+});
+
+export type BIP322MessageInfo = t.TypeOf<typeof BIP322MessageInfo>;
+
+const BIP322MessageBroadcastable = t.type({
+  txHex: t.string,
+  messageInfo: t.array(BIP322MessageInfo),
+});
+
+export type BIP322MessageBroadcastable = t.TypeOf<typeof BIP322MessageBroadcastable>;
+
+export function serializeBIP322BroadcastableMessage(message: BIP322MessageBroadcastable): string {
+  return Buffer.from(JSON.stringify(message), 'utf8').toString('hex');
+}
+
+export function deserializeBIP322BroadcastableMessage(hex: string): BIP322MessageBroadcastable {
+  const json = JSON.parse(Buffer.from(hex, 'hex').toString('utf8'));
+  return decodeOrElse(BIP322MessageBroadcastable.name, BIP322MessageBroadcastable, json, (error) => {
+    throw new Error(`Failed to decode ${BIP322MessageBroadcastable.name}: ${error}`);
+  });
+}

modules/abstract-utxo/test/bip322.ts

@@ -0,0 +1,48 @@
+import assert from 'assert';
+
+import {
+  BIP322MessageBroadcastable,
+  deserializeBIP322BroadcastableMessage,
+  serializeBIP322BroadcastableMessage,
+} from '../src/transaction/bip322';
+
+describe('BIP322', function () {
+  describe('BIP322MessageBroadcastable', () => {
+    it('should serialize and deserialize correctly', () => {
+      const message: BIP322MessageBroadcastable = {
+        txHex: '010203',
+        messageInfo: [
+          {
+            address: 'someAddress',
+            message: 'someMessage',
+            pubkeys: ['pubkey1', 'pubkey2'],
+            scriptType: 'p2sh',
+          },
+        ],
+      };
+
+      const serialized = serializeBIP322BroadcastableMessage(message);
+      const deserialized = deserializeBIP322BroadcastableMessage(serialized);
+      assert.deepStrictEqual(deserialized, message);
+    });
+
+    it('should fail if there is an unsupported script type', function () {
+      const message = {
+        txHex: '010203',
+        messageInfo: [
+          {
+            address: 'someAddress',
+            message: 'someMessage',
+            pubkeys: ['pubkey1', 'pubkey2'],
+            scriptType: 'unsupported',
+          },
+        ],
+      } as unknown as BIP322MessageBroadcastable;
+
+      const serialized = serializeBIP322BroadcastableMessage(message);
+      assert.throws(() => {
+        deserializeBIP322BroadcastableMessage(serialized);
+      });
+    });
+  });
+});