feat(sdk-core): use common isMessageWhitelisted() function

bhavidhingra · bhavidhingra · commit fcdec4df5d2f · 2025-08-09T12:50:29.000+05:30
TICKET: SC-2419
diff --git a/examples/ts/build-message.ts b/examples/ts/build-message.ts
@@ -8,9 +8,8 @@
  */
 
 import {BitGoAPI} from '@bitgo/sdk-api';
-import {MessageStandardType} from "@bitgo/sdk-core";
+import {MessageStandardType, getMidnightGlacierDropMsg} from "@bitgo/sdk-core";
 import {Hteth} from "@bitgo/sdk-coin-eth";
-import {MIDNIGHT_TNC_HASH} from "@bitgo/account-lib";
 require('dotenv').config({ path: '../../.env' });
 
 const bitgo = new BitGoAPI({
@@ -30,7 +29,8 @@ async function main() {
   console.log(`Wallet label: ${wallet.label()}`);
 
   const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
-  const testnetMessageRaw = `STAR 12345678 to ${adaTestnetDestinationAddress} ${MIDNIGHT_TNC_HASH}`;
+  const allocationAmt = 12345678;
+  const testnetMessageRaw = getMidnightGlacierDropMsg(adaTestnetDestinationAddress, allocationAmt);
 
   const txRequest = await wallet.buildSignMessageRequest({
     message: {
diff --git a/examples/ts/sign-message.ts b/examples/ts/sign-message.ts
@@ -4,8 +4,7 @@
  * Copyright 2025, BitGo, Inc.  All Rights Reserved.
  */
 import { BitGo } from 'bitgo';
-import { MessageStandardType } from '@bitgo/sdk-core';
-import { MIDNIGHT_TNC_HASH } from "@bitgo/account-lib";
+import { getMidnightGlacierDropMsg, MessageStandardType } from '@bitgo/sdk-core';
 
 const bitgo = new BitGo({ env: 'test' });
 
@@ -20,7 +19,8 @@ async function signMessage(): Promise<void> {
   const walletInstance = await basecoin.wallets().get({ id: walletId });
 
   const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
-  const testnetMessageRaw = `STAR 12345678 to ${adaTestnetDestinationAddress} ${MIDNIGHT_TNC_HASH}`;
+  const allocationAmt = 12345678;
+  const testnetMessageRaw = getMidnightGlacierDropMsg(adaTestnetDestinationAddress, allocationAmt);
 
   const messageTxn = await walletInstance.signMessage({
     message: {
diff --git a/modules/account-lib/src/index.ts b/modules/account-lib/src/index.ts
@@ -206,9 +206,6 @@ export { Vet };
 import * as CosmosSharedCoin from '@bitgo/sdk-coin-cosmos';
 export { CosmosSharedCoin };
 
-import { isMessageWhitelisted, MIDNIGHT_TNC_HASH, MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE } from './utils';
-export { isMessageWhitelisted, MIDNIGHT_TNC_HASH, MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE };
-
 const coinBuilderMap = {
   trx: Trx.WrappedBuilder,
   ttrx: Trx.WrappedBuilder,
diff --git a/modules/account-lib/src/utils/index.ts b/modules/account-lib/src/utils/index.ts
@@ -18,5 +18,3 @@ export function register(coinName: string): BaseUtils {
   }
   throw new NotSupported(`${coinName} util factory not supported`);
 }
-
-export * from './messages';
diff --git a/modules/account-lib/test/unit/utils/messages/index.ts b/modules/account-lib/test/unit/utils/messages/index.ts
@@ -1,9 +1,10 @@
 import should from 'should';
 import {
-  MIDNIGHT_TNC_HASH,
+  getMidnightGlacierDropMsg,
   isMessageWhitelisted,
   MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE,
-} from '../../../../src/utils';
+  MIDNIGHT_TNC_HASH,
+} from '@bitgo/sdk-core';
 
 describe('Message validation', () => {
   describe('isMessageWhitelisted', () => {
@@ -12,17 +13,18 @@ describe('Message validation', () => {
     const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
     const adaMainnetDestinationAddress =
       'addr1q9k6u7lhf467y2f8skr2dafldx2npsd8fymq0mslnj0t44nd4ealwnt4ug5j0pvx5m6n76v4xrq6wjfkqlhpl8y7httq2m9cmu';
+    const allocationAmt = 100;
 
     it('should validate testnet message matching the Midnight glacier drop claim template', () => {
-      const messageRaw = `STAR 100 to ${adaTestnetDestinationAddress} ${MIDNIGHT_TNC_HASH}`;
+      const messageRaw = getMidnightGlacierDropMsg(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 = `STAR 100 to ${adaMainnetDestinationAddress} ${MIDNIGHT_TNC_HASH}`;
+      const messageRaw = getMidnightGlacierDropMsg(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 { MessageStandardType } from '@bitgo/sdk-core';
-import { MIDNIGHT_TNC_HASH } from '../../src/utils';
+import { getMidnightGlacierDropMsg, MessageStandardType } from '@bitgo/sdk-core';
 
 describe('verifyMessage', () => {
   const adaTestnetOriginAddress = 'addr_test1wz4h6068hs93n8j5ar88fgzz6sfnw8krng09xx0mmf36m8c7j9yap';
   const adaTestnetDestinationAddress = 'addr_test1vz7xs7ceu4xx9n5xn57lfe86vrwddqpp77vjwq5ptlkh49cqy3wur';
-  const testnetMessageRaw = `STAR 100 to ${adaTestnetDestinationAddress} ${MIDNIGHT_TNC_HASH}`;
+  const allocationAmt = 100;
+  const testnetMessageRaw = getMidnightGlacierDropMsg(adaTestnetDestinationAddress, allocationAmt);
 
   describe('EIP191 Message', function () {
     const eip191MessageBuilder = accountLib
diff --git a/modules/sdk-coin-ada/src/lib/messages/cip8/cip8MessageBuilder.ts b/modules/sdk-coin-ada/src/lib/messages/cip8/cip8MessageBuilder.ts
@@ -1,7 +1,12 @@
 import { Cip8Message } from './cip8Message';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
-import { BaseMessageBuilder, IMessage, MessageOptions, MessageStandardType } from '@bitgo/sdk-core';
-import { MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE } from '@bitgo/account-lib';
+import {
+  BaseMessageBuilder,
+  IMessage,
+  MessageOptions,
+  MessageStandardType,
+  MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE,
+} from '@bitgo/sdk-core';
 
 /**
  * Builder for CIP-8 messages
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessage.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessage.ts
@@ -5,7 +5,7 @@ import {
   MessageOptions,
   MessagePayload,
   MessageStandardType,
-} from '../../../bitgo';
+} from './messageTypes';
 import { IMessage } from './iface';
 import { serializeSignatures, Signature } from '../iface';
 
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessageBuilder.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessageBuilder.ts
@@ -1,8 +1,8 @@
-import { BroadcastableMessage, MessageOptions, MessagePayload, MessageStandardType } from '../../../bitgo';
+import { BroadcastableMessage, MessageOptions, MessagePayload, MessageStandardType } from './messageTypes';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { IMessage, IMessageBuilder } from './iface';
 import { deserializeSignatures, Signature } from '../iface';
-import { isMessageWhitelisted } from '@bitgo/account-lib';
+import { isMessageWhitelisted } from './index';
 
 /**
  * Base Message Builder
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessageBuilderFactory.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/baseMessageBuilderFactory.ts
@@ -1,6 +1,6 @@
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { IMessageBuilder, IMessageBuilderFactory } from './iface';
-import { BroadcastableMessage, MessageStandardType } from '../../../bitgo';
+import { BroadcastableMessage, MessageStandardType } from './messageTypes';
 import { deserializeSignatures } from '../iface';
 
 /**
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/iface.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/iface.ts
@@ -1,4 +1,4 @@
-import { BroadcastableMessage, MessageMetadata, MessagePayload, MessageStandardType } from '../../../bitgo';
+import { BroadcastableMessage, MessageMetadata, MessagePayload, MessageStandardType } from './messageTypes';
 import { Signature } from '../iface';
 
 /**
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/index.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/index.ts
@@ -3,3 +3,6 @@ export * from './baseMessageBuilder';
 export * from './baseMessageBuilderFactory';
 export * from './iface';
 export * from './simple';
+export * from './messageTypes';
+export * from './midnight';
+export * from './utils';
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/messageTypes.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/messageTypes.ts
@@ -1,5 +1,5 @@
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
-import { SerializedSignature, Signature } from '../../account-lib';
+import { SerializedSignature, Signature } from '../iface';
 
 /**
  * Supported message signing standard types
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/midnight.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/midnight.ts
@@ -0,0 +1,12 @@
+export const MIDNIGHT_TNC_HASH = '31a6bab50a84b8439adcfb786bb2020f6807e6e8fda629b424110fc7bb1c6b8b';
+
+/*
+ * matches a message that starts with "STAR ", followed by a number,
+ * then " to addr" or " to addr_test1", followed by a 50+ character alphanumeric address,
+ * and ends with the midnight TnC hash
+ */
+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 {
+  return `STAR ${allocationAmt} to ${cardanoDestAddr} ${MIDNIGHT_TNC_HASH}`;
+}
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/simple/simpleMessage.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/simple/simpleMessage.ts
@@ -1,5 +1,5 @@
 import { BaseMessage } from '../baseMessage';
-import { MessageOptions, MessageStandardType } from '../../../../bitgo';
+import { MessageOptions, MessageStandardType } from '../messageTypes';
 
 /**
  * Implementation of String Message
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
@@ -1,9 +1,9 @@
 import { SimpleMessage } from './simpleMessage';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { BaseMessageBuilder } from '../baseMessageBuilder';
-import { MessageOptions, MessageStandardType } from '../../../../bitgo';
+import { MessageOptions, MessageStandardType } from '../messageTypes';
 import { IMessage } from '../iface';
-import { MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE } from '@bitgo/account-lib';
+import { MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE } from '../midnight';
 
 /**
  * Builder for string messages
diff --git a/modules/sdk-core/src/account-lib/baseCoin/messages/utils.ts b/modules/sdk-core/src/account-lib/baseCoin/messages/utils.ts
@@ -1,12 +1,3 @@
-export const MIDNIGHT_TNC_HASH = '31a6bab50a84b8439adcfb786bb2020f6807e6e8fda629b424110fc7bb1c6b8b';
-
-/*
- * matches a message that starts with "STAR ", followed by a number,
- * then " to addr" or " to addr_test1", followed by a 50+ character alphanumeric address,
- * and ends with the midnight TnC hash
- */
-export const MIDNIGHT_GLACIER_DROP_CLAIM_MESSAGE_TEMPLATE = `STAR \\d+ to addr(?:1|_test1)[a-z0-9]{50,} ${MIDNIGHT_TNC_HASH}`;
-
 /**
  * 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.
diff --git a/modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts b/modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts
@@ -11,10 +11,10 @@ import EddsaUtils, { PrebuildTransactionWithIntentOptions, TxRequest } from '../
 import { CreateAddressFormat, CustomSigningFunction, IWallet, IWallets, Wallet, WalletData, Memo } from '../wallet';
 
 import { IWebhooks } from '../webhook/iWebhooks';
-import { TransactionType } from '../../account-lib';
+import { MessageStandardType, TransactionType } from '../../account-lib';
 import { IInscriptionBuilder } from '../inscriptionBuilder';
 import { Hash } from 'crypto';
-import { MessageStandardType, MPCTx, PopulatedIntent, TokenType } from '../utils';
+import { MPCTx, PopulatedIntent, TokenType } from '../utils';
 
 export const multisigTypes = {
   onchain: 'onchain',
diff --git a/modules/sdk-core/src/bitgo/utils/index.ts b/modules/sdk-core/src/bitgo/utils/index.ts
@@ -10,6 +10,5 @@ export * from './util';
 export * from './decode';
 export * from './notEmpty';
 export * from './wallet';
-export * from './messageTypes';
 
 export { openpgpUtils };
diff --git a/modules/sdk-core/src/bitgo/utils/tss/baseTSSUtils.ts b/modules/sdk-core/src/bitgo/utils/tss/baseTSSUtils.ts
@@ -44,7 +44,7 @@ import { RequestTracer } from '../util';
 import { envRequiresBitgoPubGpgKeyConfig, getBitgoMpcGpgPubKey } from '../../tss/bitgoPubKeys';
 import { getBitgoGpgPubKey } from '../opengpgUtils';
 import assert from 'assert';
-import { MessageStandardType } from '../messageTypes';
+import { MessageStandardType } from '../../../account-lib';
 
 /**
  * BaseTssUtil class which different signature schemes have to extend
diff --git a/modules/sdk-core/src/bitgo/utils/tss/baseTypes.ts b/modules/sdk-core/src/bitgo/utils/tss/baseTypes.ts
@@ -9,7 +9,7 @@ import { KeyShare } from './ecdsa';
 import { EcdsaTypes } from '@bitgo/sdk-lib-mpc';
 import { TssEcdsaStep1ReturnMessage, TssEcdsaStep2ReturnMessage, TxRequestChallengeResponse } from '../../tss/types';
 import { AShare, DShare, SShare } from '../../tss/ecdsa/types';
-import { MessageStandardType } from '../messageTypes';
+import { MessageStandardType } from '../../../account-lib';
 
 export type TxRequestVersion = 'full' | 'lite';
 export interface HopParams {

Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,3 @@ export function register(coinName: string): BaseUtils {`
`18`	`18`	`}`
`19`	`19`	throw new NotSupported(`${coinName} util factory not supported`);
`20`	`20`	`}`
`21`		`-`
`22`		`-export * from './messages';`