feat(sdk-core): add custom logger with sensitive data sanitization

rishikeshdadam136 · rishikeshdadam136 · commit 8249eba4c5b2 · 2026-02-04T18:49:53.000+05:30
Implements custom logger to prevent token exposure in test/staging environments. Replaced 111 console statements across 52 files with logger that redacts sensitive keys (token, bearer, prv, privatekey, password, otp) and v2x bearer tokens. Technical changes: - Created sanitizeLog.ts with recursive sanitization (O(1) Set lookups) - Created logger.ts with conditional sanitization (test/staging only) - Exported logger from sdk-core for SDK-wide access - Updated 52 files across express, sdk-core, sdk-api, abstract, coin, and utility modules Ticket: WP-7503
diff --git a/modules/abstract-utxo/src/transaction/fixedScript/verifyTransaction.ts b/modules/abstract-utxo/src/transaction/fixedScript/verifyTransaction.ts
@@ -1,7 +1,7 @@
 import buildDebug from 'debug';
 import _ from 'lodash';
 import BigNumber from 'bignumber.js';
-import { BitGoBase, logger, TxIntentMismatchError, IBaseCoin } from '@bitgo/sdk-core';
+import { BitGoBase, TxIntentMismatchError, IBaseCoin } from '@bitgo/sdk-core';
 import * as utxolib from '@bitgo/utxo-lib';
 
 import { AbstractUtxoCoin, VerifyTransactionOptions } from '../../abstractUtxoCoin';
@@ -106,7 +106,7 @@ export async function verifyTransaction<TNumber extends bigint | number>(
   } else if (!disableNetworking) {
     // these keys were obtained online and their signatures were not verified
     // this could be dangerous
-    logger.info('unsigned keys obtained online are being used for address verification');
+    console.log('unsigned keys obtained online are being used for address verification');
   }
 
   if (parsedTransaction.needsCustomChangeKeySignatureVerification) {
diff --git a/modules/unspents/bin/generate_tables.ts b/modules/unspents/bin/generate_tables.ts
@@ -1,4 +1,3 @@
-import { logger } from '@bitgo/sdk-core';
 import * as fs from 'fs/promises';
 import * as utxolib from '@bitgo/utxo-lib';
 
@@ -90,6 +89,6 @@ function generateDocument() {
 if (require.main === module) {
   const outfile = 'docs/input-costs.md';
   fs.writeFile(outfile, generateDocument())
-    .then(() => logger.log('wrote to', outfile))
-    .catch((e) => logger.error(e));
+    .then(() => console.log('wrote to', outfile))
+    .catch((e) => console.error(e));
 }
diff --git a/modules/utxo-bin/src/args/parseString.ts b/modules/utxo-bin/src/args/parseString.ts
@@ -1,6 +1,5 @@
 import * as process from 'process';
 import * as fs from 'fs';
-import { logger } from '@bitgo/sdk-core';
 
 type Format = 'hex' | 'base64';
 export function stringToBuffer(data: string, format: Format | Format[]): Buffer {
@@ -99,8 +98,8 @@ export async function argToString(argv: ReadStringOptions, input?: string): Prom
     if (input) {
       throw new Error(`conflicting arguments`);
     }
-    logger.log('Reading from stdin. Please paste hex-encoded transaction data.');
-    logger.log('After inserting data, press Ctrl-D to finish. Press Ctrl-C to cancel.');
+    console.log('Reading from stdin. Please paste hex-encoded transaction data.');
+    console.log('After inserting data, press Ctrl-D to finish. Press Ctrl-C to cancel.');
     if (process.stdin.isTTY) {
       input = await readStdin();
     } else {
diff --git a/modules/utxo-bin/src/commands/cmdAddress/cmdGenerate.ts b/modules/utxo-bin/src/commands/cmdAddress/cmdGenerate.ts
@@ -1,6 +1,5 @@
 import * as utxolib from '@bitgo/utxo-lib';
 import { CommandModule } from 'yargs';
-import { logger } from '@bitgo/sdk-core';
 
 import { getNetworkOptionsDemand, keyOptions, KeyOptions } from '../../args';
 import {
@@ -71,9 +70,9 @@ export const cmdGenerateFixedScript: CommandModule<unknown, ArgsGenerateAddressF
       index: getIndexRangeFromArgv(argv),
     })) {
       if (argv.format === 'tree') {
-        logger.log(formatAddressTree(address));
+        console.log(formatAddressTree(address));
       } else {
-        logger.log(formatFixedScriptAddress(address, argv.format));
+        console.log(formatFixedScriptAddress(address, argv.format));
       }
     }
   },
@@ -110,9 +109,9 @@ export const cmdFromDescriptor: CommandModule<unknown, ArgsGenerateDescriptorAdd
       index: getIndexRangeFromArgv(argv),
     })) {
       if (argv.format === 'tree') {
-        logger.log(formatAddressTree(address));
+        console.log(formatAddressTree(address));
       } else {
-        logger.log(formatDescriptorAddress(address, argv.format));
+        console.log(formatDescriptorAddress(address, argv.format));
       }
     }
   },
diff --git a/modules/utxo-bin/src/commands/cmdAddress/cmdParse.ts b/modules/utxo-bin/src/commands/cmdAddress/cmdParse.ts
@@ -1,6 +1,5 @@
 import * as utxolib from '@bitgo/utxo-lib';
 import * as yargs from 'yargs';
-import { logger } from '@bitgo/sdk-core';
 
 import { AddressParser } from '../../AddressParser';
 import { formatTreeOrJson, FormatTreeOrJson, getNetworkOptions } from '../../args';
@@ -34,6 +33,6 @@ export const cmdParse = {
 
   handler(argv: yargs.Arguments<ArgsParseAddress>): void {
     const parsed = getAddressParser(argv).parse(argv.address);
-    logger.log(formatString(parsed, argv));
+    console.log(formatString(parsed, argv));
   },
 } as const;
diff --git a/modules/utxo-bin/src/commands/cmdBip32.ts b/modules/utxo-bin/src/commands/cmdBip32.ts
@@ -1,7 +1,6 @@
 import * as crypto from 'crypto';
 
 import * as yargs from 'yargs';
-import { logger } from '@bitgo/sdk-core';
 import { CommandModule } from 'yargs';
 import * as utxolib from '@bitgo/utxo-lib';
 
@@ -28,7 +27,7 @@ export const cmdBip32Parse: CommandModule<unknown, ArgsBip32Generate> = {
       .option('derive', { type: 'string', description: 'show xpub derived with path' });
   },
   handler(argv): void {
-    logger.log(formatString(parseBip32(argv.bip32Key, { derive: argv.derive }), argv));
+    console.log(formatString(parseBip32(argv.bip32Key, { derive: argv.derive }), argv));
   },
 };
 
@@ -44,8 +43,8 @@ export const cmdBip32Generate: CommandModule<unknown, GenerateBip32Args> = {
   },
   handler(argv) {
     const key = utxolib.bip32.fromSeed(crypto.createHash('sha256').update(argv.seed).digest());
-    logger.log(key.toBase58());
-    logger.log(key.neutered().toBase58());
+    console.log(key.toBase58());
+    console.log(key.neutered().toBase58());
   },
 };
 
diff --git a/modules/utxo-bin/src/commands/cmdDescriptor/fromFixedScript.ts b/modules/utxo-bin/src/commands/cmdDescriptor/fromFixedScript.ts
@@ -1,6 +1,5 @@
 import { CommandModule } from 'yargs';
 import * as utxolib from '@bitgo/utxo-lib';
-import { logger } from '@bitgo/sdk-core';
 import { getNamedDescriptorsForRootWalletKeys } from '@bitgo/utxo-core/descriptor';
 
 import {
@@ -52,9 +51,9 @@ export const cmdFromFixedScript: CommandModule<unknown, ArgsFixedScriptToDescrip
       [...descriptorMap].map(([name, descriptor]) => [name, descriptor?.toString() ?? null])
     );
     if (argv.format === 'tree') {
-      logger.log(formatObjAsTree('descriptors', obj));
+      console.log(formatObjAsTree('descriptors', obj));
     } else if (argv.format === 'json') {
-      logger.log(JSON.stringify(obj, null, 2));
+      console.log(JSON.stringify(obj, null, 2));
     } else {
       throw new Error(`Invalid format: ${argv.format}. Expected 'tree' or 'json'.`);
     }
diff --git a/modules/utxo-bin/src/commands/cmdParseScript.ts b/modules/utxo-bin/src/commands/cmdParseScript.ts
@@ -1,6 +1,5 @@
 import * as utxolib from '@bitgo/utxo-lib';
 import * as yargs from 'yargs';
-import { logger } from '@bitgo/sdk-core';
 
 import { ScriptParser } from '../ScriptParser';
 import { formatTreeOrJson, FormatTreeOrJson, stringToBuffer, getNetworkOptionsDemand } from '../args';
@@ -31,6 +30,6 @@ export const cmdParseScript = {
   handler(argv: yargs.Arguments<ArgsParseScript>): void {
     const script = stringToBuffer(argv.script, 'hex');
     const parsed = getScriptParser(argv).parse(script);
-    logger.log(formatString(parsed, { ...argv, all: true }));
+    console.log(formatString(parsed, { ...argv, all: true }));
   },
 };
diff --git a/modules/utxo-bin/src/commands/cmdParseTx.ts b/modules/utxo-bin/src/commands/cmdParseTx.ts
@@ -1,6 +1,5 @@
 import * as utxolib from '@bitgo/utxo-lib';
 import * as yargs from 'yargs';
-import { logger } from '@bitgo/sdk-core';
 
 import {
   argToString,
@@ -157,7 +156,7 @@ export const cmdParseTx = {
     });
 
     if (argv.parseAsUnknown) {
-      logger.log(formatString(parseUnknown(new Parser(), 'tx', tx), argv));
+      console.log(formatString(parseUnknown(new Parser(), 'tx', tx), argv));
       return;
     }
 
@@ -177,6 +176,6 @@ export const cmdParseTx = {
           : undefined,
     });
 
-    logger.log(formatString(parsed, argv));
+    console.log(formatString(parsed, argv));
   },
 } as const;
diff --git a/modules/utxo-bin/src/commands/cmdPsbt/withPsbt.ts b/modules/utxo-bin/src/commands/cmdPsbt/withPsbt.ts
@@ -1,6 +1,5 @@
 import * as fs from 'fs/promises';
 import * as utxolib from '@bitgo/utxo-lib';
-import { logger } from '@bitgo/sdk-core';
 
 import { argToString, getNetworkOptionsDemand, readStringOptions } from '../../args';
 import { Buffer } from 'buffer';
@@ -73,7 +72,7 @@ export async function emitOutput(value: utxolib.Psbt | Buffer | string, args: In
     }
     await fs.writeFile(path, value);
   } else {
-    logger.log(value);
+    console.log(value);
   }
 }
 
diff --git a/modules/utxo-bin/src/fetch.ts b/modules/utxo-bin/src/fetch.ts
@@ -1,7 +1,6 @@
 import * as fs from 'fs';
 import * as process from 'process';
 import { promisify } from 'util';
-import { logger } from '@bitgo/sdk-core';
 
 import * as utxolib from '@bitgo/utxo-lib';
 import * as blockapis from '@bitgo/blockapis';
@@ -116,7 +115,7 @@ export async function fetchOutputSpends(
   try {
     return await getApi(httpClient, tx.network).getTransactionSpends(tx.getId());
   } catch (e) {
-    logger.error(`error fetching spends for tx ${tx.getId()}: ${e}`);
+    console.error(`error fetching spends for tx ${tx.getId()}: ${e}`);
     return [];
   }
 }
diff --git a/modules/utxo-lib/src/payments/p2tr.ts b/modules/utxo-lib/src/payments/p2tr.ts
@@ -1,7 +1,6 @@
 // SegWit version 1 P2TR output type for Taproot defined in
 // https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki
 
-import { logger } from '@bitgo/sdk-core';
 import { networks } from '../networks';
 import { script as bscript, Payment, PaymentOpts, lazy } from 'bitcoinjs-lib';
 import * as taproot from '../taproot';
@@ -178,7 +177,7 @@ export function p2tr(a: Payment, opts?: PaymentOpts): Payment {
   lazy.prop(o, 'tapTree', () => {
     if (!a.redeems) return;
     if (a.redeems.find(({ depth }) => depth === undefined)) {
-      logger.warn(
+      console.warn(
         'Deprecation Warning: Weight-based tap tree construction will be removed in the future. ' +
           'Please use depth-first coding as specified in BIP-0371.'
       );
diff --git a/modules/utxo-lib/src/transaction_builder.ts b/modules/utxo-lib/src/transaction_builder.ts
@@ -1,4 +1,3 @@
-import { logger } from '@bitgo/sdk-core';
 import * as types from 'bitcoinjs-lib/src/types';
 import { address as baddress, p2trPayments } from './';
 import * as bufferutils from 'bitcoinjs-lib/src/bufferutils';
@@ -1290,7 +1289,7 @@ function getSigningData<TNumber extends number | bigint = number>(
 ): SigningData<TNumber> {
   let vin: number;
   if (typeof signParams === 'number') {
-    logger.warn(
+    console.warn(
       'DEPRECATED: TransactionBuilder sign method arguments ' + 'will change in v6, please use the TxbSignArg interface'
     );
     vin = signParams;

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`import * as fs from 'fs/promises';`
`2`	`2`	`import * as utxolib from '@bitgo/utxo-lib';`
`3`		`-import { logger } from '@bitgo/sdk-core';`
`4`	`3`
`5`	`4`	`import { argToString, getNetworkOptionsDemand, readStringOptions } from '../../args';`
`6`	`5`	`import { Buffer } from 'buffer';`
`@@ -73,7 +72,7 @@ export async function emitOutput(value: utxolib.Psbt \| Buffer \| string, args: In`
`73`	`72`	`}`
`74`	`73`	`await fs.writeFile(path, value);`
`75`	`74`	`} else {`
`76`		`- logger.log(value);`
	`75`	`+ console.log(value);`
`77`	`76`	`}`
`78`	`77`	`}`
`79`	`78`