Merge pull request #7932 from BitGo/BTC-2963.pass-wallet

feat(sdk-core, abstract-utxo): enhance explainTransaction with wallet context

Author: OttoAllmendinger

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -87,7 +87,7 @@ import {
 import { assertFixedScriptWalletAddress } from './address/fixedScript';
 import { isSdkBackend, ParsedTransaction, SdkBackend } from './transaction/types';
 import { decodePsbtWith, encodeTransaction, stringToBufferTryFormats } from './transaction/decode';
-import { toBip32Triple, UtxoKeychain } from './keychains';
+import { fetchKeychains, toBip32Triple, UtxoKeychain } from './keychains';
 import { verifyKeySignature, verifyUserPublicKey } from './verifyKey';
 import { getPolicyForEnv } from './descriptor/validatePolicy';
 import { signTransaction } from './transaction/signTransaction';
@@ -875,8 +875,16 @@ export abstract class AbstractUtxoCoin
    * @param params
    */
   override async explainTransaction<TNumber extends number | bigint = number>(
-    params: ExplainTransactionOptions<TNumber>
+    params: ExplainTransactionOptions<TNumber>,
+    wallet?: IWallet
   ): Promise<TransactionExplanation> {
+    if (!params.pubs) {
+      // if no pubs are provided, opportunistically fetch the keychains from the wallet
+      if (wallet) {
+        const keychains = await fetchKeychains(this, wallet);
+        params.pubs = toBip32Triple(keychains).map((k) => k.neutered().toBase58()) as Triple<string>;
+      }
+    }
     return explainTx(this.decodeTransactionFromPrebuild(params), params, this.name);
   }
 

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

@@ -583,7 +583,10 @@ export interface IBaseCoin {
     backup: string;
     bitgo: string;
   }>;
-  explainTransaction(options: Record<string, any>): Promise<ITransactionExplanation<any, string | number> | undefined>;
+  explainTransaction(
+    options: Record<string, any>,
+    wallet?: IWallet
+  ): Promise<ITransactionExplanation<any, string | number> | undefined>;
   verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
   verifyAddress(params: VerifyAddressOptions): Promise<boolean>;
   isWalletAddress(params: VerifyAddressOptions | TssVerifyAddressOptions, wallet?: IWallet): Promise<boolean>;

modules/sdk-core/src/bitgo/staking/stakingWallet.ts

@@ -405,7 +405,7 @@ export class StakingWallet implements IStakingWallet {
       return;
     }
 
-    const explainedTransaction = await coin.explainTransaction(result);
+    const explainedTransaction = await coin.explainTransaction(result, this.wallet);
     const mismatchErrors: string[] = [];
 
     if (buildParams?.recipients && buildParams.recipients.length > 0) {