Merge pull request #4987 from BitGo/COIN-1929-support-v4-cold-and-custody-recovery-transaction-for-ETH-POLYGON-and-AVAXC

fix: v4 cold and custody ccr recovery txn

Author: venkateshv1266

modules/abstract-eth/src/abstractEthLikeNewCoins.ts

@@ -161,6 +161,7 @@ export interface SignTransactionOptions extends BaseSignTransactionOptions, Sign
   gasPrice?: number;
   custodianTransactionId?: string;
   common?: EthLikeCommon.default;
+  walletVersion?: number;
 }
 
 export type SignedTransaction = HalfSignedTransaction | FullySignedTransaction;
@@ -196,6 +197,7 @@ export interface OfflineVaultTxInfo {
   halfSigned?: HalfSignedTransaction;
   feesUsed?: FeesUsed;
   isEvmBasedCrossChainRecovery?: boolean;
+  walletVersion?: number;
 }
 
 interface UnformattedTxInfo {
@@ -1005,6 +1007,9 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
       .transfer()
       .coin(this.staticsCoin?.name as string)
       .key(new KeyPairLib({ prv: params.prv }).getKeys().prv!);
+    if (params.walletVersion) {
+      txBuilder.walletVersion(params.walletVersion);
+    }
     const transaction = await txBuilder.build();
 
     const recipients = transaction.outputs.map((output) => ({ address: output.address, amount: output.value }));
@@ -1633,8 +1638,8 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
       txBuilder.walletVersion(4);
     }
 
-    // If gasLimit was not passed as a param, then fetch the gasLimit from Explorer
-    if (!params.gasLimit && !userKey.startsWith('xpub')) {
+    // If gasLimit was not passed as a param or if it is not cold/custody wallet, then fetch the gasLimit from Explorer
+    if (!params.gasLimit && userKey && !userKey.startsWith('xpub')) {
       const sendData = txBuilder.getSendData();
       gasLimit = await this.getGasLimitFromExternalAPI(
         params.bitgoFeeAddress as string,
@@ -1671,6 +1676,7 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
       amount: batchExecutionInfo.totalAmount,
       backupKeyNonce: bitgoFeeAddressNonce,
       eip1559: params.eip1559,
+      ...(txBuilder.getWalletVersion() === 4 ? { walletVersion: txBuilder.getWalletVersion() } : {}),
     };
     _.extend(response, txInfo);
     response.nextContractSequenceId = response.contractSequenceId;
@@ -1803,7 +1809,7 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
       txBuilder.walletVersion(4);
     }
 
-    if (!params.gasLimit && !userKey.startsWith('xpub')) {
+    if (!params.gasLimit && userKey && !userKey.startsWith('xpub')) {
       const sendData = txBuilder.getSendData();
       gasLimit = await this.getGasLimitFromExternalAPI(
         params.bitgoFeeAddress as string,
@@ -1840,6 +1846,7 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
       amount: txAmount.toString(),
       backupKeyNonce: bitgoFeeAddressNonce,
       eip1559: params.eip1559,
+      ...(txBuilder.getWalletVersion() === 4 ? { walletVersion: txBuilder.getWalletVersion() } : {}),
     };
     _.extend(response, txInfo);
     response.nextContractSequenceId = response.contractSequenceId;

modules/abstract-eth/src/lib/transactionBuilder.ts

@@ -854,4 +854,11 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     }
     this._feeAddress = address;
   }
+
+  /**
+   * Get the wallet version for wallet
+   */
+  public getWalletVersion(): number {
+    return this._walletVersion;
+  }
 }

modules/sdk-coin-avaxc/src/avaxc.ts

@@ -358,19 +358,22 @@ export class AvaxC extends AbstractEthLikeNewCoins {
 
   /**
    * Queries avax.network for the token balance of an address
-   * @param {string} address - the AVAXC address
+   * @param {string} walletContractAddress - the AVAXC address
+   * @param {string} tokenContractAddress - the Token contract address
    * @returns {Promise<BigNumber>} address balance
    */
-  async queryAddressTokenBalance(address: string, contractAddress: string): Promise<BN> {
+  async queryAddressTokenBalance(tokenContractAddress: string, walletContractAddress: string): Promise<BN> {
     // get token balance using contract call
-    const tokenBalanceData = optionalDeps.ethAbi.simpleEncode('balanceOf(address)', address).toString('hex');
+    const tokenBalanceData = optionalDeps.ethAbi
+      .simpleEncode('balanceOf(address)', walletContractAddress)
+      .toString('hex');
     const tokenBalanceDataHex = optionalDeps.ethUtil.addHexPrefix(tokenBalanceData);
     const result = await this.recoveryBlockchainExplorerQuery({
       jsonrpc: '2.0',
       method: 'eth_call',
       params: [
         {
-          to: contractAddress,
+          to: tokenContractAddress,
           data: tokenBalanceDataHex,
         },
         'latest',
@@ -379,7 +382,9 @@ export class AvaxC extends AbstractEthLikeNewCoins {
     });
     // throw if the result does not exist or the result is not a valid number
     if (!result || !result.result || isNaN(result.result)) {
-      throw new Error(`Could not obtain address token balance for ${address} from avax.network, got: ${result.result}`);
+      throw new Error(
+        `Could not obtain address token balance for ${walletContractAddress} from avax.network, got: ${result.result}`
+      );
     }
     const tokenBalanceHex = result.result;
     return new optionalDeps.ethUtil.BN(tokenBalanceHex.slice(2), 16);
@@ -657,7 +662,7 @@ export class AvaxC extends AbstractEthLikeNewCoins {
     let txAmount;
     if (params.tokenContractAddress) {
       // get token balance of wallet
-      txAmount = await this.queryAddressTokenBalance(params.walletContractAddress, params.tokenContractAddress);
+      txAmount = await this.queryAddressTokenBalance(params.tokenContractAddress, params.walletContractAddress);
     } else {
       // get balance of wallet and deduct fees to get transaction amount
       txAmount = await this.queryAddressBalance(params.walletContractAddress);
@@ -1012,6 +1017,9 @@ export class AvaxC extends AbstractEthLikeNewCoins {
     const txBuilder = this.getTransactionBuilder() as TransactionBuilder;
     txBuilder.from(params.txPrebuild.txHex);
     txBuilder.transfer().key(new AvaxcKeyPair({ prv: params.prv }).getKeys().prv!);
+    if (params.walletVersion) {
+      txBuilder.walletVersion(params.walletVersion);
+    }
     const transaction = await txBuilder.build();
 
     const recipients = transaction.outputs.map((output) => ({ address: output.address, amount: output.value }));

modules/sdk-coin-avaxc/src/iface.ts

@@ -172,6 +172,7 @@ export interface AvaxSignTransactionOptions extends BaseSignTransactionOptions {
   prv: string;
   custodianTransactionId?: string;
   isLastSignature?: boolean;
+  walletVersion?: number;
 }
 
 export interface HalfSignedTransaction extends HalfSignedAccountTransaction {