Merge pull request #6872 from BitGo/COIN-5193-EVMkeyring

feat(sdk-core): EVM keyring wallet and address creation changes

Author: nvjsr

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

@@ -208,6 +208,7 @@ export interface SupplementGenerateWalletOptions {
   type: 'hot' | 'cold' | 'custodial';
   subType?: 'lightningCustody' | 'lightningSelfCustody' | 'onPrem';
   coinSpecific?: { [coinName: string]: unknown };
+  referenceWalletId?: string;
 }
 
 export interface FeeEstimateOptions {

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

@@ -500,6 +500,8 @@ export interface CreateAddressOptions {
   derivedAddress?: string;
   index?: number;
   onToken?: string;
+  referenceCoin?: string;
+  referenceAddress?: string;
 }
 
 export interface UpdateAddressOptions {

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

@@ -70,6 +70,7 @@ export interface GenerateWalletOptions {
   commonKeychain?: string;
   type?: 'hot' | 'cold' | 'custodial';
   subType?: 'lightningCustody' | 'lightningSelfCustody';
+  referenceWalletId?: string;
 }
 
 export const GenerateLightningWalletOptionsCodec = t.strict(
@@ -170,6 +171,7 @@ export interface AddWalletOptions {
   initializationTxs?: any;
   disableTransactionNotifications?: boolean;
   gasPrice?: number;
+  referenceWalletId?: string;
 }
 
 type KeySignatures = {

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

@@ -1251,6 +1251,8 @@ export class Wallet implements IWallet {
       baseAddress,
       allowSkipVerifyAddress = true,
       onToken,
+      referenceCoin,
+      referenceAddress,
     } = params;
 
     if (!_.isUndefined(chain)) {
@@ -1325,6 +1327,30 @@ export class Wallet implements IWallet {
       }
     }
 
+    // Validate EVM keyring params, referenceAddress is required and referenceCoin is optional for EVM keyring
+    if (!_.isUndefined(referenceAddress)) {
+      if (!_.isString(referenceAddress)) {
+        throw new Error('referenceAddress has to be a string');
+      }
+      if (!this.baseCoin.isEVM()) {
+        throw new Error('referenceAddress is only supported for EVM chains');
+      }
+      if (!this.baseCoin.isValidAddress(referenceAddress)) {
+        throw new Error('referenceAddress must be a valid address');
+      }
+      addressParams.referenceAddress = referenceAddress;
+
+      if (!_.isUndefined(referenceCoin)) {
+        if (!_.isString(referenceCoin)) {
+          throw new Error('referenceCoin has to be a string');
+        }
+        addressParams.referenceCoin = referenceCoin;
+      }
+    } else if (!_.isUndefined(referenceCoin)) {
+      // referenceCoin cannot be used without referenceAddress
+      throw new Error('referenceAddress is required when using referenceCoin for EVM keyring');
+    }
+
     // get keychains for address verification
     const keychains = await Promise.all(this._wallet.keys.map((k) => this.baseCoin.keychains().get({ id: k, reqId })));
     const rootAddress = _.get(this._wallet, 'receiveAddress.address');

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

@@ -101,8 +101,21 @@ export class Wallets implements IWallets {
       throw new Error('missing required string parameter label');
     }
 
-    // no need to pass keys for (single) custodial wallets
-    if (params.type !== 'custodial') {
+    // Validate referenceWalletId parameter
+    if (params.referenceWalletId) {
+      if (!_.isString(params.referenceWalletId)) {
+        throw new Error('invalid referenceWalletId argument, expecting string');
+      }
+      if (!this.baseCoin.isEVM()) {
+        throw new Error('referenceWalletId is only supported for EVM chains');
+      }
+    }
+
+    // For wallets with referenceWalletId, skip multisig validation as configuration is inherited
+    if (params.referenceWalletId) {
+      // Skip all multisig validation - configuration will be inherited from reference wallet
+    } else if (params.type !== 'custodial') {
+      // Standard validation for non-custodial wallets without referenceWalletId
       if (Array.isArray(params.keys) === false || !_.isNumber(params.m) || !_.isNumber(params.n)) {
         throw new Error('invalid argument');
       }
@@ -272,9 +285,10 @@ export class Wallets implements IWallets {
       throw new Error('missing required string parameter label');
     }
 
-    const { type = 'hot', label, passphrase, enterprise, isDistributedCustody } = params;
+    const { type = 'hot', label, passphrase, enterprise, isDistributedCustody, referenceWalletId } = params;
     const isTss = params.multisigType === 'tss' && this.baseCoin.supportsTss();
     const canEncrypt = !!passphrase && typeof passphrase === 'string';
+    const isEVMWithReference = this.baseCoin.isEVM() && referenceWalletId;
 
     const walletParams: SupplementGenerateWalletOptions = {
       label: label,
@@ -284,6 +298,11 @@ export class Wallets implements IWallets {
       type: !!params.userKey && params.multisigType !== 'onchain' ? 'cold' : type,
     };
 
+    // Add referenceWalletId to walletParams if provided for EVM chains
+    if (isEVMWithReference) {
+      walletParams.referenceWalletId = referenceWalletId;
+    }
+
     if (!_.isUndefined(params.passcodeEncryptionCode)) {
       if (!_.isString(params.passcodeEncryptionCode)) {
         throw new Error('passcodeEncryptionCode must be a string');
@@ -297,15 +316,59 @@ export class Wallets implements IWallets {
       walletParams.enterprise = enterprise;
     }
 
+    // Validate referenceWalletId for EVM keyring
+    if (!_.isUndefined(referenceWalletId)) {
+      if (!_.isString(referenceWalletId)) {
+        throw new Error('invalid referenceWalletId argument, expecting string');
+      }
+      if (!this.baseCoin.isEVM()) {
+        throw new Error('referenceWalletId is only supported for EVM chains');
+      }
+    }
+
     // EVM TSS wallets must use wallet version 3, 5 and 6
+    // Skip this validation for EVM keyring wallets as they inherit version from reference wallet
     if (
       isTss &&
       this.baseCoin.isEVM() &&
+      !referenceWalletId &&
       !(params.walletVersion === 3 || params.walletVersion === 5 || params.walletVersion === 6)
     ) {
       throw new Error('EVM TSS wallets are only supported for wallet version 3, 5 and 6');
     }
 
+    // Handle EVM keyring wallet creation with referenceWalletId
+    if (isEVMWithReference) {
+      // For EVM keyring wallets, multisigType will be inferred from the reference wallet
+      // No need to explicitly validate TSS requirement here as it will be handled by bgms
+
+      // For EVM keyring wallets, we use the add method directly with referenceWalletId
+      // This bypasses the normal key generation process since keys are shared via keyring
+      const addWalletParams = {
+        label,
+        referenceWalletId,
+      };
+
+      const newWallet = await this.bitgo.post(this.baseCoin.url('/wallet/add')).send(addWalletParams).result();
+
+      // For EVM keyring wallets, we need to get the keychains from the reference wallet
+      const userKeychain = this.baseCoin.keychains().get({ id: newWallet.keys[KeyIndices.USER] });
+      const backupKeychain = this.baseCoin.keychains().get({ id: newWallet.keys[KeyIndices.BACKUP] });
+      const bitgoKeychain = this.baseCoin.keychains().get({ id: newWallet.keys[KeyIndices.BITGO] });
+
+      const [userKey, backupKey, bitgoKey] = await Promise.all([userKeychain, backupKeychain, bitgoKeychain]);
+
+      const result: WalletWithKeychains = {
+        wallet: new Wallet(this.bitgo, this.baseCoin, newWallet),
+        userKeychain: userKey,
+        backupKeychain: backupKey,
+        bitgoKeychain: bitgoKey,
+        responseType: 'WalletWithKeychains',
+      };
+
+      return result;
+    }
+
     if (isTss) {
       if (!this.baseCoin.supportsTss()) {
         throw new Error(`coin ${this.baseCoin.getFamily()} does not support TSS at this time`);

modules/sdk-core/test/unit/account-lib/mpc/tss/ecdsa/ecdsa.ts

@@ -21,7 +21,8 @@ import { loadWebAssembly } from '@bitgo/sdk-opensslbytes';
 
 const openSSLBytes = loadWebAssembly().buffer;
 
-describe('ecdsa tss', function () {
+describe('ecdsa tss', function (this: Mocha.Context) {
+  this.timeout(60000);
   const ecdsa = new Ecdsa();
 
   let signCombine1: SignCombineRT, signCombine2: SignCombineRT;