chore: build and sign message sample script

TICKET: COIN-4593

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

@@ -19,6 +19,7 @@ import {
   Keychains,
   KeyType,
   ManageUnspentsOptions,
+  MessageStandardType,
   MessageTypes,
   PopulatedIntent,
   PrebuildTransactionWithIntentOptions,
@@ -3480,8 +3481,11 @@ describe('V2 Wallet:', function () {
 
         it('sol create signMessage tx request', async function () {
           await tssSolWallet
-            .createSignMessageRequest({
-              messageRaw,
+            .buildSignMessageRequest({
+              message: {
+                messageRaw,
+                messageStandardType: MessageStandardType.EIP191,
+              },
             })
             .should.be.rejectedWith('Message signing not supported for Testnet Solana');
         });
@@ -3496,13 +3500,16 @@ describe('V2 Wallet:', 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.createSignMessageRequest({
-            messageRaw,
+          const txRequest = await tssEthWallet.buildSignMessageRequest({
+            message: {
+              messageRaw,
+              messageStandardType: MessageStandardType.EIP191,
+            },
           });
           txRequest.should.deepEqual(txRequestForMessageSigning);
         });
 
-        it('should sign message', async function () {
+        it(`[${coinName}] should sign message`, async function () {
           const signMessageTssSpy = sinon.spy(tssEthWallet, 'signMessageTss' as any);
           nock(bgUrl)
             .get(
@@ -3514,7 +3521,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);
@@ -3524,7 +3531,7 @@ 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);
 
@@ -3541,7 +3548,7 @@ 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);
 

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

@@ -14,7 +14,7 @@ import { IWebhooks } from '../webhook/iWebhooks';
 import { TransactionType } from '../../account-lib';
 import { IInscriptionBuilder } from '../inscriptionBuilder';
 import { Hash } from 'crypto';
-import { MPCTx, PopulatedIntent, TokenType } from '../utils';
+import { MessageStandardType, MPCTx, PopulatedIntent, TokenType } from '../utils';
 
 export const multisigTypes = {
   onchain: 'onchain',
@@ -301,6 +301,7 @@ export interface TransactionPrebuild extends BaseSignable {
 export interface Message extends BaseSignable {
   messageRaw: string;
   messageEncoded?: string;
+  messageStandardType?: MessageStandardType;
 }
 
 export interface MessageTypeProperty {
@@ -418,6 +419,7 @@ export interface SignedMessage {
   signature: string;
   messageRaw: string;
   messageEncoded?: string;
+  messageStandardType?: MessageStandardType;
   txRequestId: string;
 }
 

modules/sdk-core/src/bitgo/utils/tss/baseTSSUtils.ts

@@ -1,4 +1,5 @@
 import { IRequestTracer } from '../../../api';
+import * as openpgp from 'openpgp';
 import { Key, readKey, SerializedKeyPair } from 'openpgp';
 import { IBaseCoin, KeychainsTriplet } from '../../baseCoin';
 import { BitGoBase } from '../../bitgoBase';
@@ -10,40 +11,40 @@ import * as _ from 'lodash';
 import {
   BitgoGPGPublicKey,
   BitgoHeldBackupKeyShare,
+  CommitmentShareRecord,
+  CreateBitGoKeychainParamsBase,
+  CreateKeychainParamsBase,
+  CustomCommitmentGeneratingFunction,
   CustomGShareGeneratingFunction,
+  CustomKShareGeneratingFunction,
+  CustomMPCv2SigningRound1GeneratingFunction,
+  CustomMPCv2SigningRound2GeneratingFunction,
+  CustomMPCv2SigningRound3GeneratingFunction,
+  CustomMuDeltaShareGeneratingFunction,
+  CustomPaillierModulusGetterFunction,
   CustomRShareGeneratingFunction,
+  CustomSShareGeneratingFunction,
+  EncryptedSignerShareRecord,
+  IntentOptionsForMessage,
+  IntentOptionsForTypedData,
   ITssUtils,
+  PopulatedIntentForMessageSigning,
+  PopulatedIntentForTypedDataSigning,
   PrebuildTransactionWithIntentOptions,
+  RequestType,
   SignatureShareRecord,
   TSSParams,
-  TxRequest,
-  TxRequestVersion,
-  CreateKeychainParamsBase,
-  IntentOptionsForMessage,
-  PopulatedIntentForMessageSigning,
-  IntentOptionsForTypedData,
-  PopulatedIntentForTypedDataSigning,
-  CreateBitGoKeychainParamsBase,
-  CommitmentShareRecord,
-  EncryptedSignerShareRecord,
-  CustomCommitmentGeneratingFunction,
   TSSParamsForMessage,
-  RequestType,
-  CustomPaillierModulusGetterFunction,
-  CustomKShareGeneratingFunction,
-  CustomMuDeltaShareGeneratingFunction,
-  CustomSShareGeneratingFunction,
-  CustomMPCv2SigningRound1GeneratingFunction,
-  CustomMPCv2SigningRound2GeneratingFunction,
-  CustomMPCv2SigningRound3GeneratingFunction,
   TSSParamsWithPrv,
+  TxRequest,
+  TxRequestVersion,
 } from './baseTypes';
 import { GShare, SignShare } from '../../../account-lib/mpc/tss';
 import { RequestTracer } from '../util';
-import * as openpgp from 'openpgp';
 import { envRequiresBitgoPubGpgKeyConfig, getBitgoMpcGpgPubKey } from '../../tss/bitgoPubKeys';
 import { getBitgoGpgPubKey } from '../opengpgUtils';
 import assert from 'assert';
+import { MessageStandardType } from '../messageTypes';
 
 /**
  * BaseTssUtil class which different signature schemes have to extend
@@ -356,6 +357,7 @@ export default class BaseTssUtils<KeyShare> extends MpcUtils implements ITssUtil
 
   /**
    * Create a tx request from params for message signing
+   * @deprecated Use createSignMessageRequest instead
    *
    * @param params
    * @param apiVersion
@@ -386,7 +388,7 @@ export default class BaseTssUtils<KeyShare> extends MpcUtils implements ITssUtil
    * @param params - the parameters for the sign message request
    * @param apiVersion - the API version to use, defaults to 'full'
    */
-  async createSignMessageRequest(
+  async buildSignMessageRequest(
     params: IntentOptionsForMessage,
     apiVersion: TxRequestVersion = 'full'
   ): Promise<TxRequest> {
@@ -402,11 +404,11 @@ export default class BaseTssUtils<KeyShare> extends MpcUtils implements ITssUtil
       memo: params.memo?.value,
       isTss: params.isTss,
       messageRaw: params.messageRaw,
-      messageStandardType: params.messageStandardType,
+      messageStandardType: params.messageStandardType ?? MessageStandardType.UNKNOWN,
       messageEncoded: params.messageEncoded ?? '',
     };
 
-    return this.createSignMessageRequestBase(intent, apiVersion, params.reqId);
+    return this.buildSignMessageRequestBase(intent, apiVersion, params.reqId);
   }
 
   /**
@@ -467,7 +469,7 @@ export default class BaseTssUtils<KeyShare> extends MpcUtils implements ITssUtil
    *
    * @private
    */
-  private async createSignMessageRequestBase(
+  private async buildSignMessageRequestBase(
     intent: PopulatedIntentForMessageSigning,
     apiVersion: TxRequestVersion,
     reqId?: IRequestTracer

modules/sdk-core/src/bitgo/wallet/iWallet.ts

@@ -27,6 +27,7 @@ import {
   CustomSShareGeneratingFunction,
   TokenEnablement,
   TokenTransferRecipientParams,
+  TxRequest,
 } from '../utils';
 import { SerializedNtilde } from '../../account-lib/mpc/tss/ecdsa/types';
 import { IAddressBook } from '../address-book';
@@ -909,6 +910,7 @@ export interface IWallet {
   sendTokenEnablement(params?: PrebuildAndSignTransactionOptions): Promise<any>;
   sendTokenEnablements(params?: BuildTokenEnablementOptions): Promise<any>;
   signMessage(params: WalletSignMessageOptions): Promise<SignedMessage>;
+  buildSignMessageRequest(params: WalletSignMessageOptions): Promise<TxRequest>;
   signTypedData(params: WalletSignTypedDataOptions): Promise<SignedMessage>;
   fetchCrossChainUTXOs(params: FetchCrossChainUTXOsOptions): Promise<CrossChainUTXO[]>;
   getChallengesForEcdsaSigning(): Promise<WalletEcdsaChallenges>;