Merge pull request #6446 from BitGo/coin-4755-msg-signing-support-ada-sol

feat(account-lib): return hex broadcastable message string

Author: bhavidhingra

examples/ts/build-message.ts

@@ -8,8 +8,9 @@
  */
 
 import {BitGoAPI} from '@bitgo/sdk-api';
+import {MessageStandardType} from "@bitgo/sdk-core";
+import {MIDNIGHT_TNC_HASH} from "@bitgo/account-lib/dist/src/utils";
 import {Hteth} from "@bitgo/sdk-coin-eth";
-import {MessageStandardType} from "@bitgo/sdk-core"; // Replace with your given coin (e.g. Ltc, Tltc)
 require('dotenv').config({ path: '../../.env' });
 
 const bitgo = new BitGoAPI({
@@ -28,9 +29,12 @@ async function main() {
   const wallet = await bitgo.coin(coin).wallets().get({ id });
   console.log(`Wallet label: ${wallet.label()}`);
 
+  const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
+  const testnetMessageRaw = `STAR 12345678 to ${adaTestnetDestinationAddress} ${MIDNIGHT_TNC_HASH}`;
+
   const txRequest = await wallet.buildSignMessageRequest({
     message: {
-      messageRaw: 'Hello, BitGo!',
+      messageRaw: testnetMessageRaw,
       messageStandardType: MessageStandardType.EIP191,
     },
   });

modules/abstract-eth/test/unit/messages/eip191/eip191Message.ts

@@ -145,7 +145,8 @@ describe('EIP191 Message', () => {
         metadata: fixtures.eip191.metadata,
       });
 
-      const broadcastString = await message.toBroadcastString();
+      const broadcastHex = await message.toBroadcastString();
+      const broadcastString = Buffer.from(broadcastHex, 'hex').toString();
       const parsedBroadcast = JSON.parse(broadcastString);
       const expectedSerializedSignatures = serializeSignatures([fixtures.eip191.signature]);
 

modules/sdk-core/src/account-lib/baseCoin/messages/baseMessage.ts

@@ -160,7 +160,8 @@ export abstract class BaseMessage implements IMessage {
    */
   async toBroadcastString(): Promise<string> {
     const broadcastable = await this.toBroadcastFormat();
-    return JSON.stringify(broadcastable);
+    const broadcastableStr = JSON.stringify(broadcastable);
+    return Buffer.from(broadcastableStr).toString('hex');
   }
 
   /**

modules/sdk-core/src/account-lib/baseCoin/messages/baseMessageBuilderFactory.ts

@@ -44,11 +44,12 @@ export abstract class BaseMessageBuilderFactory implements IMessageBuilderFactor
 
   /**
    * Parses a broadcastable message and gets the message builder based on the message type.
-   * @param broadcastString The broadcastable message to parse
+   * @param broadcastHex The broadcastable message to parse
    * @returns A message builder instance for the parsed broadcastable message type
    */
-  fromBroadcastString(broadcastString: string): IMessageBuilder {
-    const broadcastMessage = JSON.parse(broadcastString) as BroadcastableMessage;
+  fromBroadcastString(broadcastHex: string): IMessageBuilder {
+    const broadcastStr = Buffer.from(broadcastHex).toString();
+    const broadcastMessage = JSON.parse(broadcastStr) as BroadcastableMessage;
     return this.fromBroadcastFormat(broadcastMessage);
   }
 }

modules/sdk-core/test/unit/account-lib/baseCoin/messages/baseMessage.ts

@@ -210,7 +210,7 @@ describe('Base Message', () => {
   });
 
   describe('toBroadcastString', () => {
-    it('should serialize the broadcastable format to JSON string', async () => {
+    it('should serialize the broadcastable format to hex string', async () => {
       const { payload, type, metadata, signers, signatures } = messageSamples.eip191;
 
       const message = new TestMessage({
@@ -230,7 +230,8 @@ describe('Base Message', () => {
         signablePayload: 'SGVsbG8gQml0R28h',
       };
 
-      const broadcastString = await message.toBroadcastString();
+      const broadcastHex = await message.toBroadcastString();
+      const broadcastString = Buffer.from(broadcastHex, 'hex').toString();
       const parsed = JSON.parse(broadcastString);
 
       should.deepEqual(parsed, expectedBroadcastString);

modules/sdk-core/test/unit/account-lib/baseCoin/messages/baseMessageBuilder.ts

@@ -177,7 +177,7 @@ describe('Base Message Builder', () => {
     builder.setType(MessageStandardType.EIP191).setPayload(payload).setSignatures(signatures).setSigners(signers);
 
     const message = await builder.build();
-    const broadcastString = await message.toBroadcastString();
+    const broadcastHex = await message.toBroadcastString();
 
     const expectedJson = JSON.stringify({
       type: MessageStandardType.EIP191,
@@ -187,7 +187,8 @@ describe('Base Message Builder', () => {
       metadata: { encoding: 'utf8' },
       signablePayload: 'c2VyaWFsaXplIG1l',
     });
+    const expectedHex = Buffer.from(expectedJson).toString('hex');
 
-    should.equal(broadcastString, expectedJson);
+    should.equal(broadcastHex, expectedHex);
   });
 });