Revert "refactor: import should without (=)"

bhavidhingra · bhavidhingra · commit a25a1af3a9a8 · 2025-08-09T16:32:48.000+05:30
This reverts commit 516c30a. TICKET: SC-2419
diff --git a/examples/ts/build-message.ts b/examples/ts/build-message.ts
@@ -8,7 +8,7 @@
  */
 
 import {BitGoAPI} from '@bitgo/sdk-api';
-import {MessageStandardType, getMidnightGlacierDropMsg} from "@bitgo/sdk-core";
+import {MessageStandardType, getMidnightGlacierDropClaimMsg} from "@bitgo/sdk-core";
 import {Hteth} from "@bitgo/sdk-coin-eth";
 require('dotenv').config({ path: '../../.env' });
 
@@ -30,7 +30,7 @@ async function main() {
 
   const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
   const allocationAmt = 12345678;
-  const testnetMessageRaw = getMidnightGlacierDropMsg(adaTestnetDestinationAddress, allocationAmt);
+  const testnetMessageRaw = getMidnightGlacierDropClaimMsg(adaTestnetDestinationAddress, allocationAmt);
 
   const txRequest = await wallet.buildSignMessageRequest({
     message: {
diff --git a/examples/ts/sign-message.ts b/examples/ts/sign-message.ts
@@ -4,7 +4,7 @@
  * Copyright 2025, BitGo, Inc.  All Rights Reserved.
  */
 import { BitGo } from 'bitgo';
-import { getMidnightGlacierDropMsg, MessageStandardType } from '@bitgo/sdk-core';
+import { getMidnightGlacierDropClaimMsg, MessageStandardType } from '@bitgo/sdk-core';
 
 const bitgo = new BitGo({ env: 'test' });
 
@@ -20,7 +20,7 @@ async function signMessage(): Promise<void> {
 
   const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
   const allocationAmt = 12345678;
-  const testnetMessageRaw = getMidnightGlacierDropMsg(adaTestnetDestinationAddress, allocationAmt);
+  const testnetMessageRaw = getMidnightGlacierDropClaimMsg(adaTestnetDestinationAddress, allocationAmt);
 
   const messageTxn = await walletInstance.signMessage({
     message: {
diff --git a/modules/abstract-eth/src/lib/messages/eip191/eip191MessageBuilder.ts b/modules/abstract-eth/src/lib/messages/eip191/eip191MessageBuilder.ts
@@ -22,4 +22,10 @@ export class Eip191MessageBuilder extends BaseMessageBuilder {
   async buildMessage(options: MessageOptions): Promise<IMessage> {
     return new EIP191Message(options);
   }
+
+  protected getWhitelistedMessageTemplates(): Record<string, string> {
+    // EIP-191 does not have whitelisted message templates
+    // This means all messages are allowed
+    return {};
+  }
 }
diff --git a/modules/account-lib/src/index.ts b/modules/account-lib/src/index.ts
@@ -429,15 +429,13 @@ export async function verifyMessage(
   try {
     const messageBuilderFactory = getMessageBuilderFactory(coinName);
     const messageBuilder = messageBuilderFactory.getMessageBuilder(messageStandardType);
-    messageBuilder.setPayload(messageRaw);
-    const message = await messageBuilder.build();
-    const isValidMessageEncoded = await message.verifyEncodedPayload(messageEncoded, metadata);
-    if (!isValidMessageEncoded) {
+    if (!messageBuilder || !messageBuilder.isMessageWhitelisted(messageRaw)) {
       return false;
     }
-    return messageBuilder.isMessageWhitelisted(messageRaw);
+    messageBuilder.setPayload(messageRaw);
+    const message = await messageBuilder.build();
+    return await message.verifyEncodedPayload(messageEncoded, metadata);
   } catch (e) {
-    console.error(`Error verifying message for coin ${coinName}:`, e);
     return false;
   }
 }
diff --git a/modules/account-lib/test/unit/utils/messages/index.ts b/modules/account-lib/test/unit/utils/messages/index.ts
@@ -1,30 +1,32 @@
 import should from 'should';
 import {
-  getMidnightGlacierDropMsg,
+  getMidnightGlacierDropClaimMsg,
   isMessageWhitelisted,
   MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE,
   MIDNIGHT_TNC_HASH,
 } from '@bitgo/sdk-core';
 
 describe('Message validation', () => {
   describe('isMessageWhitelisted', () => {
-    const whitelistedMessageTemplates = [MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE];
+    const whitelistedMessageTemplates: Record<string, string> = {
+      midnightGDClaimMsgTemplate: MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE,
+    };
 
     const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
     const adaMainnetDestinationAddress =
       'addr1q9k6u7lhf467y2f8skr2dafldx2npsd8fymq0mslnj0t44nd4ealwnt4ug5j0pvx5m6n76v4xrq6wjfkqlhpl8y7httq2m9cmu';
     const allocationAmt = 100;
 
     it('should validate testnet message matching the Midnight glacier drop claim template', () => {
-      const messageRaw = getMidnightGlacierDropMsg(adaTestnetDestinationAddress, allocationAmt);
+      const messageRaw = getMidnightGlacierDropClaimMsg(adaTestnetDestinationAddress, allocationAmt);
 
       const result = isMessageWhitelisted(whitelistedMessageTemplates, messageRaw);
 
       should.equal(result, true);
     });
 
     it('should validate mainnet message matching the Midnight glacier drop claim template', () => {
-      const messageRaw = getMidnightGlacierDropMsg(adaMainnetDestinationAddress, allocationAmt);
+      const messageRaw = getMidnightGlacierDropClaimMsg(adaMainnetDestinationAddress, allocationAmt);
 
       const result = isMessageWhitelisted(whitelistedMessageTemplates, messageRaw);
 
diff --git a/modules/account-lib/test/unit/verifyMessage.ts b/modules/account-lib/test/unit/verifyMessage.ts
@@ -1,12 +1,12 @@
 import should from 'should';
 import * as accountLib from '../../src';
-import { getMidnightGlacierDropMsg, MessageStandardType } from '@bitgo/sdk-core';
+import { getMidnightGlacierDropClaimMsg, MessageStandardType } from '@bitgo/sdk-core';
 
 describe('verifyMessage', () => {
   const adaTestnetOriginAddress = 'addr_test1wz4h6068hs93n8j5ar88fgzz6sfnw8krng09xx0mmf36m8c7j9yap';
   const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
   const allocationAmt = 100;
-  const testnetMessageRaw = getMidnightGlacierDropMsg(adaTestnetDestinationAddress, allocationAmt);
+  const testnetMessageRaw = getMidnightGlacierDropClaimMsg(adaTestnetDestinationAddress, allocationAmt);
 
   describe('EIP191 Message', function () {
     const eip191MessageBuilder = accountLib
diff --git a/modules/sdk-coin-ada/test/unit/ada.ts b/modules/sdk-coin-ada/test/unit/ada.ts
@@ -2,7 +2,7 @@
  * @prettier
  */
 
-import should from 'should';
+import should = require('should');
 import { randomBytes } from 'crypto';
 import * as sinon from 'sinon';
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
diff --git a/modules/sdk-coin-asi/test/unit/asi.ts b/modules/sdk-coin-asi/test/unit/asi.ts
@@ -1,4 +1,4 @@
-import should from 'should';
+import should = require('should');
 import BigNumber from 'bignumber.js';
 import sinon from 'sinon';
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
diff --git a/modules/sdk-coin-atom/test/unit/atom.ts b/modules/sdk-coin-atom/test/unit/atom.ts
@@ -19,7 +19,7 @@ import {
   wrwUser,
   wrwUserDkls,
 } from '../resources/atom';
-import should from 'should';
+import should = require('should');
 
 describe('ATOM', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-baby/test/unit/baby.ts b/modules/sdk-coin-baby/test/unit/baby.ts
@@ -4,7 +4,7 @@ import BigNumber from 'bignumber.js';
 import sinon from 'sinon';
 import { Baby, Tbaby } from '../../src';
 import { TEST_SEND_MANY_TX, TEST_SEND_TX, TEST_TX_WITH_MEMO, address } from '../resources/baby';
-import should from 'should';
+import should = require('should');
 import utils from '../../src/lib/utils';
 
 describe('Babylon', function () {
diff --git a/modules/sdk-coin-bld/test/unit/bld.ts b/modules/sdk-coin-bld/test/unit/bld.ts
@@ -17,7 +17,7 @@ import {
   TEST_WITHDRAW_REWARDS_TX,
   wrwUser,
 } from '../resources/bld';
-import should from 'should';
+import should = require('should');
 
 describe('BLD', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-coreum/test/unit/coreum.ts b/modules/sdk-coin-coreum/test/unit/coreum.ts
@@ -19,7 +19,7 @@ import {
   testnetAddress,
   wrwUser,
 } from '../resources/tcoreum';
-import should from 'should';
+import should = require('should');
 
 describe('Coreum', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-cronos/test/unit/cronos.ts b/modules/sdk-coin-cronos/test/unit/cronos.ts
@@ -1,4 +1,4 @@
-import should from 'should';
+import should = require('should');
 import BigNumber from 'bignumber.js';
 import sinon from 'sinon';
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
diff --git a/modules/sdk-coin-dot/test/unit/dot.ts b/modules/sdk-coin-dot/test/unit/dot.ts
@@ -1,7 +1,7 @@
 import { BitGoAPI } from '@bitgo/sdk-api';
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
 import { randomBytes } from 'crypto';
-import should from 'should';
+import should = require('should');
 import { Dot, Tdot, KeyPair } from '../../src';
 import * as testData from '../fixtures';
 import { chainName, txVersion, genesisHash, specVersion } from '../resources';
diff --git a/modules/sdk-coin-hash/test/unit/hash.ts b/modules/sdk-coin-hash/test/unit/hash.ts
@@ -18,7 +18,7 @@ import {
   testnetAddress,
   wrwUser,
 } from '../resources/hash';
-import should from 'should';
+import should = require('should');
 
 describe('HASH', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-initia/test/unit/initia.ts b/modules/sdk-coin-initia/test/unit/initia.ts
@@ -1,4 +1,4 @@
-import should from 'should';
+import should = require('should');
 import BigNumber from 'bignumber.js';
 import sinon from 'sinon';
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
diff --git a/modules/sdk-coin-injective/test/unit/injective.ts b/modules/sdk-coin-injective/test/unit/injective.ts
@@ -18,7 +18,7 @@ import {
   TEST_WITHDRAW_REWARDS_TX,
   wrwUser,
 } from '../resources/injective';
-import should from 'should';
+import should = require('should');
 import nock = require('nock');
 
 describe('INJ', function () {
diff --git a/modules/sdk-coin-islm/test/unit/islm.ts b/modules/sdk-coin-islm/test/unit/islm.ts
@@ -12,7 +12,7 @@ import {
   TEST_WITHDRAW_REWARDS_TX,
   address,
 } from '../resources/islm';
-import should from 'should';
+import should = require('should');
 
 describe('Islm', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-mantra/test/unit/mantra.ts b/modules/sdk-coin-mantra/test/unit/mantra.ts
@@ -5,7 +5,7 @@ import sinon from 'sinon';
 import { Mantra, Tmantra } from '../../src';
 import utils from '../../src/lib/utils';
 import { TEST_SEND_MANY_TX, TEST_SEND_TX, TEST_TX_WITH_MEMO, address } from '../resources/mantra';
-import should from 'should';
+import should = require('should');
 
 describe('Mantra', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-osmo/test/unit/osmo.ts b/modules/sdk-coin-osmo/test/unit/osmo.ts
@@ -18,7 +18,7 @@ import {
   TEST_WITHDRAW_REWARDS_TX,
   wrwUser,
 } from '../resources/osmo';
-import should from 'should';
+import should = require('should');
 
 describe('OSMO', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-rune/test/unit/rune.ts b/modules/sdk-coin-rune/test/unit/rune.ts
@@ -10,7 +10,7 @@ import { RuneUtils } from '../../src/lib/utils';
 import { mainnetAddress } from '../resources/rune';
 import { TEST_SEND_TX, TEST_TX_WITH_MEMO, testnetAddress, wrwUser } from '../resources/trune';
 const bech32 = require('bech32-buffer');
-import should from 'should';
+import should = require('should');
 
 describe('Rune', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-sei/test/unit/sei.ts b/modules/sdk-coin-sei/test/unit/sei.ts
@@ -17,7 +17,7 @@ import {
   TEST_WITHDRAW_REWARDS_TX,
   wrwUser,
 } from '../resources/sei';
-import should from 'should';
+import should = require('should');
 
 describe('SEI', function () {
   let bitgo: TestBitGoAPI;
diff --git a/modules/sdk-coin-tia/test/unit/tia.ts b/modules/sdk-coin-tia/test/unit/tia.ts
@@ -21,7 +21,7 @@ import {
   TEST_WITHDRAW_REWARDS_TX,
   wrwUser,
 } from '../resources/tia';
-import should from 'should';
+import should = require('should');
 import nock = require('nock');
 
 describe('TIA', function () {
diff --git a/modules/sdk-coin-zeta/test/unit/zeta.ts b/modules/sdk-coin-zeta/test/unit/zeta.ts
@@ -20,7 +20,7 @@ import {
   mockAccountDetailsResponse,
   wrwUser,
 } from '../resources/zeta';
-import should from 'should';
+import should = require('should');
 import nock = require('nock');
 
 describe('Zeta', function () {
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessageBuilder.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessageBuilder.ts
@@ -2,7 +2,7 @@ import { BroadcastableMessage, MessageOptions, MessagePayload, MessageStandardTy
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { IMessage, IMessageBuilder } from './iface';
 import { deserializeSignatures, Signature } from '../iface';
-import { isMessageWhitelisted } from './index';
+import { isMessageWhitelisted, MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE } from './index';
 
 /**
  * Base Message Builder
@@ -13,7 +13,7 @@ export abstract class BaseMessageBuilder implements IMessageBuilder {
   protected type: MessageStandardType;
   protected signatures: Signature[] = [];
   protected signers: string[] = [];
-  protected whitelistedMessageTemplates: string[] = [];
+  protected whitelistedMessageTemplates: Record<string, string> = {};
   protected metadata?: Record<string, unknown> = {};
   protected digest?: string;
 
@@ -28,6 +28,7 @@ export abstract class BaseMessageBuilder implements IMessageBuilder {
   ) {
     this.coinConfig = coinConfig;
     this.type = messageType;
+    this.whitelistedMessageTemplates = this.getWhitelistedMessageTemplates();
   }
 
   /**
@@ -173,4 +174,11 @@ export abstract class BaseMessageBuilder implements IMessageBuilder {
     };
     return this.build();
   }
+
+  protected getWhitelistedMessageTemplates(): Record<string, string> {
+    return {
+      midnightGDClaimMsgTemplate: MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE,
+      // Add more whitelisted templates as needed
+    };
+  }
 }
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/iface.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/iface.ts
@@ -137,9 +137,11 @@ export interface IMessageBuilder {
   getPayload(): MessagePayload | undefined;
 
   /**
-   * Checks if the message string is whitelisted
+   * Checks if the message string is whitelisted.
+   * Some message standards like EIP-191 allow any message
+   *
    * @param messageRaw The raw message string to check
-   * @return True if the message is whitelisted, false otherwise
+   * @return True if the message builder allows any message or the message is whitelisted, false otherwise
    */
   isMessageWhitelisted(messageRaw: string): boolean;
 
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/midnight.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/midnight.ts
@@ -7,6 +7,6 @@ export const MIDNIGHT_TNC_HASH = '31a6bab50a84b8439adcfb786bb2020f6807e6e8fda629
  */
 export const MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE = `STAR \\d+ to addr(?:1|_test1)[a-z0-9]{50,} ${MIDNIGHT_TNC_HASH}`;
 
-export function getMidnightGlacierDropMsg(cardanoDestAddr: string, allocationAmt: number): string {
+export function getMidnightGlacierDropClaimMsg(cardanoDestAddr: string, allocationAmt: number): string {
   return `STAR ${allocationAmt} to ${cardanoDestAddr} ${MIDNIGHT_TNC_HASH}`;
 }
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/simple/simpleMessageBuilder.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/simple/simpleMessageBuilder.ts
@@ -3,7 +3,6 @@ import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { BaseMessageBuilder } from '../baseMessageBuilder';
 import { MessageOptions, MessageStandardType } from '../messageTypes';
 import { IMessage } from '../iface';
-import { MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE } from '../midnight';
 
 /**
  * Builder for string messages
@@ -15,10 +14,6 @@ export class SimpleMessageBuilder extends BaseMessageBuilder {
    */
   public constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig, MessageStandardType.SIMPLE);
-    this.whitelistedMessageTemplates = [
-      MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE,
-      // Add more templates as needed
-    ];
   }
 
   /**
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/utils.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/utils.ts
@@ -2,15 +2,15 @@
  * Validates a message against a set of whitelisted templates.
  * The templates can contain placeholders like {{variable}} which will be replaced with a wildcard in the regex.
  *
- * @param whitelistedMessageTemplates - An array of whitelisted message templates.
+ * @param whitelistedMessageTemplates - A record of whitelisted message templates.
  * @param {string} messageRaw - The raw message to validate.
  * @returns {boolean} - Returns true if the message matches any of the whitelisted templates, false otherwise.
  */
-export function isMessageWhitelisted(whitelistedMessageTemplates: string[], messageRaw: string): boolean {
-  if (!whitelistedMessageTemplates || whitelistedMessageTemplates.length === 0) {
+export function isMessageWhitelisted(whitelistedMessageTemplates: Record<string, string>, messageRaw: string): boolean {
+  if (!whitelistedMessageTemplates || !Object.keys(whitelistedMessageTemplates).length) {
     return true;
   }
-  return whitelistedMessageTemplates.some((template) => {
+  return Object.values(whitelistedMessageTemplates).some((template) => {
     const regex = new RegExp(`^${template}$`, 's'); // 's' flag to match newlines
     return regex.test(messageRaw);
   });
diff --git a/modules/sdk-core/test/unit/account-lib/mpc/tss/ecdsa/fixtures.ts b/modules/sdk-core/test/unit/account-lib/mpc/tss/ecdsa/fixtures.ts
@@ -1,4 +1,4 @@
-import { PrivateKey, PublicKey } from 'paillier-bigint';
+import { KeyPair, PrivateKey, PublicKey } from 'paillier-bigint';
 
 const publicKeys: PublicKey[] = [
   new PublicKey(
@@ -27,7 +27,7 @@ const publicKeys: PublicKey[] = [
   ),
 ];
 
-export const paillierKeyPairs: { publicKey: PublicKey; privateKey: PrivateKey }[] = [
+export const paillierKeyPairs: KeyPair[] = [
   {
     publicKey: publicKeys[0],
     privateKey: new PrivateKey(

Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,10 @@ export class Eip191MessageBuilder extends BaseMessageBuilder {`
`22`	`22`	`async buildMessage(options: MessageOptions): Promise<IMessage> {`
`23`	`23`	`return new EIP191Message(options);`
`24`	`24`	`}`
	`25`	`+`
	`26`	`+ protected getWhitelistedMessageTemplates(): Record<string, string> {`
	`27`	`+ // EIP-191 does not have whitelisted message templates`
	`28`	`+ // This means all messages are allowed`
	`29`	`+ return {};`
	`30`	`+ }`
`25`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import should from 'should';`
	`1`	`+import should = require('should');`
`2`	`2`	`import BigNumber from 'bignumber.js';`
`3`	`3`	`import sinon from 'sinon';`
`4`	`4`	`import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';`