Merge pull request #6371 from BitGo/coin-4593-build-and-send-message-scripts

chore: build and sign message sample scripts

Author: bhavidhingra

examples/ts/build-message.ts

@@ -0,0 +1,40 @@
+/**
+ * Pre-build a message from the wallet
+ *
+ * This tool will help you see how to use the BitGo API to easily build
+ * a message from a wallet.
+ *
+ * Copyright 2025, BitGo, Inc.  All Rights Reserved.
+ */
+
+import {BitGoAPI} from '@bitgo/sdk-api';
+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({
+  accessToken: process.env.TESTNET_ACCESS_TOKEN,
+  env: 'test', // Change this to env: 'production' when you are ready for production
+});
+
+// Set the coin name to match the blockchain and network
+// doge = dogecoin, tdoge = testnet dogecoin
+const coin = 'hteth';
+bitgo.register(coin, Hteth.createInstance);
+
+const id = '';
+
+async function main() {
+  const wallet = await bitgo.coin(coin).wallets().get({ id });
+  console.log(`Wallet label: ${wallet.label()}`);
+
+  const txRequest = await wallet.buildSignMessageRequest({
+    message: {
+      messageRaw: 'Hello, BitGo!',
+      messageStandardType: MessageStandardType.EIP191,
+    },
+  });
+  console.dir(txRequest);
+}
+
+main().catch((e) => console.log(e));

examples/ts/sign-message.ts

@@ -0,0 +1,32 @@
+/**
+ * Sign a Message from an MPC wallet at BitGo.
+ *
+ * Copyright 2025, BitGo, Inc.  All Rights Reserved.
+ */
+import { BitGo } from 'bitgo';
+import { MessageStandardType } from '@bitgo/sdk-core';
+
+const bitgo = new BitGo({ env: 'test' });
+
+const coin = 'hteth';
+const basecoin = bitgo.coin(coin);
+const accessToken = '';
+const walletId = '';
+const walletPassphrase = '';
+
+async function signMessage(): Promise<void> {
+  await bitgo.authenticateWithAccessToken({ accessToken });
+  const walletInstance = await basecoin.wallets().get({ id: walletId });
+
+  const messageTxn = await walletInstance.signMessage({
+    message: {
+      messageRaw: 'Hello BitGo!',
+      messageStandardType: MessageStandardType.EIP191,
+    },
+    walletPassphrase,
+  });
+
+  console.log(messageTxn);
+}
+
+signMessage().catch(console.error);

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

@@ -9,33 +9,34 @@ import * as nock from 'nock';
 import * as _ from 'lodash';
 
 import {
+  BaseTssUtils,
   common,
   CustomSigningFunction,
+  Ecdsa,
   ECDSAUtils,
   EDDSAUtils,
+  GetUserPrvOptions,
+  Keychains,
+  KeyType,
+  ManageUnspentsOptions,
+  MessageStandardType,
+  MessageTypes,
+  PopulatedIntent,
+  PrebuildTransactionWithIntentOptions,
   RequestTracer,
+  SendManyOptions,
+  SignatureShareType,
+  SignedMessage,
+  SignTypedDataVersion,
   TokenType,
   TssUtils,
   TxRequest,
-  Wallet,
-  SignatureShareType,
-  Ecdsa,
-  Keychains,
+  TxRequestVersion,
   TypedData,
   TypedMessage,
-  MessageTypes,
-  SignTypedDataVersion,
-  GetUserPrvOptions,
-  ManageUnspentsOptions,
-  SignedMessage,
-  BaseTssUtils,
-  KeyType,
-  SendManyOptions,
-  PopulatedIntent,
-  TxRequestVersion,
+  Wallet,
   WalletSignMessageOptions,
   WalletSignTypedDataOptions,
-  PrebuildTransactionWithIntentOptions,
 } from '@bitgo/sdk-core';
 
 import { TestBitGo } from '@bitgo/sdk-test';
@@ -3414,6 +3415,10 @@ describe('V2 Wallet:', function () {
 
     describe('Message Signing', function () {
       const txHash = '0xrrrsss1b';
+      const messageRaw = 'hello world';
+      const messageEncoded = Buffer.from(`\u0019Ethereum Signed Message:\n${messageRaw.length}${messageRaw}`).toString(
+        'hex'
+      );
       const txRequestForMessageSigning: TxRequest = {
         txRequestId: reqId.toString(),
         transactions: [],
@@ -3438,19 +3443,19 @@ describe('V2 Wallet:', function () {
             signatureShares: [{ from: SignatureShareType.USER, to: SignatureShareType.USER, share: '' }],
             combineSigShare: '0:rrr:sss:3',
             txHash,
+            messageEncoded,
           },
         ],
       };
       let signTxRequestForMessage;
       const messageSigningCoins = ['teth', 'tpolygon'];
-      const messageRaw = 'test';
       const expected: SignedMessage = {
         txRequestId: reqId.toString(),
         txHash,
         signature: txHash,
         messageRaw,
         coin: 'teth',
-        messageEncoded: Buffer.from('\u0019Ethereum Signed Message:\n4test').toString('hex'),
+        messageEncoded,
       };
 
       beforeEach(async function () {
@@ -3467,14 +3472,27 @@ describe('V2 Wallet:', function () {
         nock.cleanAll();
       });
 
-      it('should throw error for unsupported coins', async function () {
-        await tssSolWallet
-          .signMessage({
-            reqId,
-            message: { messageRaw },
-            prv: 'secretKey',
-          })
-          .should.be.rejectedWith('Message signing not supported for Testnet Solana');
+      describe('should throw error for unsupported coins', function () {
+        it('sol signMessage', async function () {
+          await tssSolWallet
+            .signMessage({
+              reqId,
+              message: { messageRaw },
+              prv: 'secretKey',
+            })
+            .should.be.rejectedWith('Message signing not supported for Testnet Solana');
+        });
+
+        it('sol create signMessage tx request', async function () {
+          await tssSolWallet
+            .buildSignMessageRequest({
+              message: {
+                messageRaw,
+                messageStandardType: MessageStandardType.EIP191,
+              },
+            })
+            .should.be.rejectedWith('Message signing not supported for Testnet Solana');
+        });
       });
 
       messageSigningCoins.map((coinName) => {
@@ -3483,7 +3501,19 @@ describe('V2 Wallet:', function () {
         tssEthWallet = new Wallet(bitgo, bitgo.coin(coinName), ethWalletData);
         const txRequestId = txRequestForMessageSigning.txRequestId;
 
-        it('should sign message', async function () {
+        it('should create tx Request with signMessage intent', async function () {
+          nock(bgUrl).post(`/api/v2/wallet/${tssEthWallet.id()}/msgrequests`).reply(200, txRequestForMessageSigning);
+
+          const txRequest = await tssEthWallet.buildSignMessageRequest({
+            message: {
+              messageRaw,
+              messageStandardType: MessageStandardType.EIP191,
+            },
+          });
+          txRequest.should.deepEqual(txRequestForMessageSigning);
+        });
+
+        it(`[${coinName}] should sign message`, async function () {
           const signMessageTssSpy = sinon.spy(tssEthWallet, 'signMessageTss' as any);
           nock(bgUrl)
             .get(
@@ -3495,7 +3525,7 @@ describe('V2 Wallet:', function () {
 
           const signMessage = await tssEthWallet.signMessage({
             reqId,
-            message: { messageRaw, txRequestId },
+            message: { messageRaw, txRequestId, messageStandardType: MessageStandardType.EIP191 },
             prv: 'secretKey',
           });
           signMessage.should.deepEqual(expectedWithCoinField);
@@ -3505,14 +3535,14 @@ describe('V2 Wallet:', function () {
           );
         });
 
-        it('should sign message when custodianMessageId is provided', async function () {
+        it(`[${coinName}] should sign message when custodianMessageId is provided`, async function () {
           const signMessageTssSpy = sinon.spy(tssEthWallet, 'signMessageTss' as any);
-          nock(bgUrl).post(`/api/v2/wallet/${tssEthWallet.id()}/txrequests`).reply(200, txRequestForMessageSigning);
+          nock(bgUrl).post(`/api/v2/wallet/${tssEthWallet.id()}/msgrequests`).reply(200, txRequestForMessageSigning);
 
           const signMessage = await tssEthWallet.signMessage({
             custodianMessageId: 'unittest',
             reqId,
-            message: { messageRaw },
+            message: { messageRaw, messageStandardType: MessageStandardType.EIP191 },
             prv: 'secretKey',
           });
           signMessage.should.deepEqual(expectedWithCoinField);
@@ -3522,13 +3552,13 @@ describe('V2 Wallet:', function () {
           );
         });
 
-        it('should sign message when txRequestId not provided', async function () {
+        it(`[${coinName}] should sign message when txRequestId not provided`, async function () {
           const signMessageTssSpy = sinon.spy(tssEthWallet, 'signMessageTss' as any);
-          nock(bgUrl).post(`/api/v2/wallet/${tssEthWallet.id()}/txrequests`).reply(200, txRequestForMessageSigning);
+          nock(bgUrl).post(`/api/v2/wallet/${tssEthWallet.id()}/msgrequests`).reply(200, txRequestForMessageSigning);
 
           const signMessage = await tssEthWallet.signMessage({
             reqId,
-            message: { messageRaw },
+            message: { messageRaw, messageStandardType: MessageStandardType.EIP191 },
             prv: 'secretKey',
           });
           signMessage.should.deepEqual(expectedWithCoinField);
@@ -3542,7 +3572,7 @@ describe('V2 Wallet:', function () {
           await tssEthWallet
             .signMessage({
               reqId,
-              message: { messageRaw, txRequestId },
+              message: { messageRaw, txRequestId, messageStandardType: MessageStandardType.EIP191 },
               prv: '',
             })
             .should.be.rejectedWith('keychain does not have property encryptedPrv');

modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts

@@ -419,6 +419,7 @@ export interface SignedMessage {
   signature: string;
   messageRaw: string;
   messageEncoded?: string;
+  messageStandardType?: MessageStandardType;
   txRequestId: string;
 }