Merge pull request #7679 from BitGo/BTC-2829

feat: add LTC cross-chain recovery support

TICKET: WIN-8147

Author: davidkaplanbitgo

modules/abstract-utxo/src/recovery/crossChainRecovery.ts

@@ -113,6 +113,40 @@ export async function isWalletAddress(wallet: IWallet | WalletV1, address: strin
   }
 }
 
+/**
+ * Convert a Litecoin P2SH address from M... format (scriptHash 0x32) to the legacy 3... format (scriptHash 0x05).
+ * This is needed for cross-chain recovery when LTC was sent to a BTC address, because the BTC wallet
+ * stores addresses in the 3... format while the LTC blockchain returns addresses in M... format.
+ *
+ * @param address - LTC address to convert
+ * @param network - The Litecoin network
+ * @returns The address in legacy 3... format, or the original address if it's not a P2SH address
+ */
+export function convertLtcAddressToLegacyFormat(address: string, network: utxolib.Network): string {
+  try {
+    // Try to decode as bech32 - these don't need conversion
+    utxolib.address.fromBech32(address);
+    return address;
+  } catch (e) {
+    // Not bech32, continue to base58
+  }
+
+  try {
+    const decoded = utxolib.address.fromBase58Check(address, network);
+    // Only convert P2SH addresses (scriptHash), not P2PKH (pubKeyHash)
+    if (decoded.version === network.scriptHash) {
+      // Convert to legacy format using Bitcoin's scriptHash (0x05)
+      const legacyScriptHash = utxolib.networks.bitcoin.scriptHash;
+      return utxolib.address.toBase58Check(decoded.hash, legacyScriptHash, network);
+    }
+    // P2PKH or other - return unchanged
+    return address;
+  } catch (e) {
+    // If decoding fails, return the original address
+    return address;
+  }
+}
+
 /**
  * @param coin
  * @param txid
@@ -137,7 +171,18 @@ async function getAllRecoveryOutputs<TNumber extends number | bigint = number>(
         // in non legacy format. However, we want to keep the address in the same format as the response since we
         // are going to hit the API again to fetch address unspents.
         const canonicalAddress = coin.canonicalAddress(output.address);
-        const isWalletOwned = await isWalletAddress(wallet, canonicalAddress);
+        let isWalletOwned = await isWalletAddress(wallet, canonicalAddress);
+
+        // For LTC cross-chain recovery: if the address isn't found, try the legacy format.
+        // When LTC is sent to a BTC address, the LTC blockchain returns M... addresses
+        // but the BTC wallet stores addresses in 3... format.
+        if (!isWalletOwned && coin.getFamily() === 'ltc') {
+          const legacyAddress = convertLtcAddressToLegacyFormat(output.address, coin.network);
+          if (legacyAddress !== output.address) {
+            isWalletOwned = await isWalletAddress(wallet, legacyAddress);
+          }
+        }
+
         return isWalletOwned ? output.address : null;
       })
     )

modules/abstract-utxo/test/unit/recovery/crossChainRecovery.ts

@@ -14,6 +14,7 @@ import {
   getWallet,
   supportedCrossChainRecoveries,
   generateAddress,
+  convertLtcAddressToLegacyFormat,
 } from '../../../src';
 import {
   getFixture,
@@ -327,3 +328,32 @@ describe(`Cross-Chain Recovery getWallet`, async function () {
     }
   });
 });
+
+describe('convertLtcAddressToLegacyFormat', function () {
+  const ltcNetwork = utxolib.networks.litecoin;
+
+  it('should convert M... P2SH address to 3... legacy format', function () {
+    // These two addresses represent the same underlying script hash:
+    // - MNQ7zkgMsaV67rsjA3JuP59RC5wxRXpwgE is the LTC format (scriptHash 0x32)
+    // - 3GBygsGPvTdfKMbq4AKZZRu1sPMWPEsBfd is the BTC format (scriptHash 0x05)
+    const ltcAddress = 'MNQ7zkgMsaV67rsjA3JuP59RC5wxRXpwgE';
+    const expectedLegacyAddress = '3GBygsGPvTdfKMbq4AKZZRu1sPMWPEsBfd';
+
+    const legacyAddress = convertLtcAddressToLegacyFormat(ltcAddress, ltcNetwork);
+    assert.strictEqual(legacyAddress, expectedLegacyAddress);
+  });
+
+  it('should convert MD68PsdheKxcYsrVLyZRXgoSDLnB1MdVtE to legacy format', function () {
+    const address = 'MD68PsdheKxcYsrVLyZRXgoSDLnB1MdVtE';
+    const legacyAddress = convertLtcAddressToLegacyFormat(address, ltcNetwork);
+
+    // Should start with '3' (legacy BTC P2SH format)
+    assert.ok(legacyAddress.startsWith('3'), `Expected address to start with '3', got: ${legacyAddress}`);
+  });
+
+  it('should not modify bech32 addresses', function () {
+    const bech32Address = 'ltc1qgrl8zpndsklaa9swgd5vevyxmx5x63vcrl7dk4';
+    const result = convertLtcAddressToLegacyFormat(bech32Address, ltcNetwork);
+    assert.strictEqual(result, bech32Address);
+  });
+});

modules/sdk-core/package.json

@@ -2,15 +2,32 @@
   "name": "@bitgo/sdk-core",
   "version": "36.22.0",
   "description": "core library functions for BitGoJS",
-  "main": "./dist/src/index.js",
-  "types": "./dist/src/index.d.ts",
+  "main": "./dist/cjs/src/index.js",
+  "module": "./dist/esm/index.js",
+  "browser": "./dist/esm/index.js",
+  "types": "./dist/cjs/src/index.d.ts",
   "files": [
-    "dist"
+    "dist/cjs",
+    "dist/esm"
   ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/src/index.d.ts",
+        "default": "./dist/cjs/src/index.js"
+      }
+    }
+  },
   "scripts": {
     "test": "yarn unit-test",
     "unit-test": "nyc -- mocha --recursive test",
-    "build": "yarn tsc --build --incremental --verbose .",
+    "build": "yarn build:cjs && yarn build:esm",
+    "build:cjs": "yarn tsc --build --incremental --verbose .",
+    "build:esm": "yarn tsc --project tsconfig.esm.json",
     "fmt": "prettier --write .",
     "check-fmt": "prettier --check '**/*.{ts,js,json}'",
     "clean": "rm -r ./dist",

modules/sdk-core/src/bitgo/tss/eddsa/eddsa.ts

@@ -23,7 +23,7 @@ import {
 } from '../../utils';
 import { BaseTransaction } from '../../../account-lib';
 import { Ed25519Bip32HdTree } from '@bitgo/sdk-lib-mpc';
-import _ = require('lodash');
+import _ from 'lodash';
 import { commonVerifyWalletSignature, getTxRequest, sendSignatureShare } from '../common';
 import { IRequestTracer } from '../../../api';
 

modules/sdk-core/tsconfig.esm.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm",
+    "rootDir": "./src",
+    "module": "ES2020",
+    "target": "ES2020",
+    "moduleResolution": "bundler",
+    "lib": ["ES2020", "DOM"],
+    "declaration": true,
+    "declarationMap": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "test", "dist"],
+  "references": []
+}

modules/sdk-core/tsconfig.json

@@ -1,8 +1,10 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "outDir": "./dist",
+    "outDir": "./dist/cjs",
     "rootDir": "./",
+    "module": "node16",
+    "moduleResolution": "node16",
     "strictPropertyInitialization": false,
     "esModuleInterop": true,
     "typeRoots": ["../../types", "./node_modules/@types", "../../node_modules/@types"]