feat(bitgo): add api version input

add api version input to prebuildTransactionTss method

BG-57753

Author: ipelaez-simtlix

modules/bitgo/test/v2/unit/wallet.ts

@@ -1682,6 +1682,18 @@ describe('V2 Wallet:', function () {
         }).should.be.rejectedWith('transaction type not supported: stake');
       });
 
+      it('should fail for full api version compatibility', async function () {
+        await custodialTssWallet.prebuildTransaction({
+          reqId,
+          apiVersion: 'lite',
+          recipients: [{
+            address: '6DadkZcx9JZgeQUDbHh12cmqCpaqehmVxv6sGy49jrah',
+            amount: '1000',
+          }],
+          type: 'transfer',
+        }).should.be.rejectedWith(`Custodial and ECDSA MPC algorithm must always use 'full' api version`);
+      });
+
       it('should build a single recipient transfer transaction for full', async function () {
         const recipients = [{
           address: '6DadkZcx9JZgeQUDbHh12cmqCpaqehmVxv6sGy49jrah',
@@ -1942,6 +1954,44 @@ describe('V2 Wallet:', function () {
         intent.isTss!.should.equal(true);
         intent.intentType.should.equal('fillNonce');
       });
+
+      it('should build a single recipient transfer transaction providing apiVersion parameter as "full" ', async function () {
+        const recipients = [{
+          address: '6DadkZcx9JZgeQUDbHh12cmqCpaqehmVxv6sGy49jrah',
+          amount: '1000',
+        }];
+
+        const prebuildTxWithIntent = sandbox.stub(TssUtils.prototype, 'prebuildTxWithIntent');
+        prebuildTxWithIntent.resolves(txRequestFull);
+        prebuildTxWithIntent.calledOnceWithExactly({
+          reqId,
+          recipients,
+          intentType: 'payment',
+        }, 'full');
+
+        const txPrebuild = await custodialTssWallet.prebuildTransaction({
+          reqId,
+          apiVersion: 'full',
+          recipients,
+          type: 'transfer',
+        });
+
+        txPrebuild.should.deepEqual({
+          walletId: tssWallet.id(),
+          wallet: custodialTssWallet,
+          txRequestId: 'id',
+          txHex: 'ababcdcd',
+          buildParams: {
+            apiVersion: 'full',
+            recipients,
+            type: 'transfer',
+          },
+          feeInfo: {
+            fee: 5000,
+            feeString: '5000',
+          },
+        });
+      });
     });
 
     describe('Transaction signing', function () {

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

@@ -453,11 +453,21 @@ export class Sol extends BaseCoin {
 
     await tssUtils!.deleteSignatureShares(txRequestId);
     const recreated = await tssUtils!.getTxRequest(txRequestId);
+    let txHex = '';
+    if (recreated.unsignedTxs) {
+      txHex = recreated.unsignedTxs[0]?.serializedTxHex;
+    } else {
+      txHex = recreated.transactions ? recreated.transactions[0]?.unsignedTx.serializedTxHex : '';
+    }
+
+    if (!txHex) {
+      throw new Error('Missing serialized tx hex');
+    }
 
     return Promise.resolve({
       ...params,
       txPrebuild: recreated,
-      txHex: recreated.unsignedTxs[0].serializedTxHex,
+      txHex,
     });
   }
 

modules/sdk-core/src/bitgo/utils/tss/baseTypes.ts

@@ -2,7 +2,7 @@ import { SerializedKeyPair } from 'openpgp';
 import { IRequestTracer } from '../../../api';
 import { KeychainsTriplet } from '../../baseCoin';
 import { ApiKeyShare, Keychain } from '../../keychain';
-import { Memo, WalletType } from '../../wallet';
+import { ApiVersion, Memo, WalletType } from '../../wallet';
 import { EDDSA, GShare, SignShare, YShare } from '../../../account-lib/mpc/tss';
 import { KeyShare } from './ecdsa';
 
@@ -227,6 +227,7 @@ export type TSSParams = {
   txRequest: string | TxRequest; // can be either a string or TxRequest
   prv: string;
   reqId: IRequestTracer;
+  apiVersion?: ApiVersion;
 };
 
 export type TSSParamsForMessage = TSSParams & {

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

@@ -457,7 +457,7 @@ export class EddsaUtils extends baseTSSUtils<KeyShare> {
     let txRequestResolved: TxRequest;
     let txRequestId: string;
 
-    const { txRequest, prv } = params;
+    const { txRequest, prv, apiVersion } = params;
 
     if (typeof txRequest === 'string') {
       txRequestResolved = await getTxRequest(this.bitgo, this.wallet.id(), txRequest);
@@ -495,7 +495,14 @@ export class EddsaUtils extends baseTSSUtils<KeyShare> {
     const bitgoGpgKey = await getBitgoGpgPubKey(this.bitgo);
     const encryptedSignerShare = await encryptText(signerShare, bitgoGpgKey);
 
-    await offerUserToBitgoRShare(this.bitgo, this.wallet.id(), txRequestId, userSignShare, encryptedSignerShare);
+    await offerUserToBitgoRShare(
+      this.bitgo,
+      this.wallet.id(),
+      txRequestId,
+      userSignShare,
+      encryptedSignerShare,
+      apiVersion
+    );
 
     const bitgoToUserRShare = await getBitgoToUserRShare(this.bitgo, this.wallet.id(), txRequestId);
 
@@ -507,7 +514,7 @@ export class EddsaUtils extends baseTSSUtils<KeyShare> {
       signablePayload
     );
 
-    await sendUserToBitgoGShare(this.bitgo, this.wallet.id(), txRequestId, userToBitGoGShare);
+    await sendUserToBitgoGShare(this.bitgo, this.wallet.id(), txRequestId, userToBitGoGShare, apiVersion);
 
     return await getTxRequest(this.bitgo, this.wallet.id(), txRequestId);
   }

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

@@ -52,6 +52,8 @@ export interface BuildTokenEnablementOptions extends PrebuildTransactionOptions
   enableTokens: TokenEnablement[];
 }
 
+export type ApiVersion = 'lite' | 'full';
+
 export interface PrebuildTransactionOptions {
   reqId?: IRequestTracer;
   recipients?: {
@@ -104,6 +106,7 @@ export interface PrebuildTransactionOptions {
   lowFeeTxid?: string;
   isTss?: boolean;
   custodianTransactionId?: string;
+  apiVersion?: ApiVersion;
 }
 
 export interface PrebuildAndSignTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {
@@ -143,6 +146,7 @@ export interface WalletSignTransactionOptions extends WalletSignBaseOptions {
   txPrebuild?: TransactionPrebuild;
   customRShareGeneratingFunction?: CustomRShareGeneratingFunction;
   customGShareGeneratingFunction?: CustomGShareGeneratingFunction;
+  apiVersion?: ApiVersion;
   [index: string]: unknown;
 }
 

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

@@ -151,6 +151,7 @@ export class Wallet implements IWallet {
   prebuildWhitelistedParams(): string[] {
     return [
       'addressType',
+      'apiVersion',
       'changeAddress',
       'consolidateAddresses',
       'cpfpFeeRate',
@@ -1537,7 +1538,7 @@ export class Wallet implements IWallet {
    * @return {*}
    */
   async signTransaction(params: WalletSignTransactionOptions = {}): Promise<SignedTransaction | TxRequest> {
-    const { txPrebuild } = params;
+    const { txPrebuild, apiVersion } = params;
 
     if (_.isFunction(params.customGShareGeneratingFunction) && _.isFunction(params.customRShareGeneratingFunction)) {
       // invoke external signer TSS for EdDSA workflow
@@ -1555,7 +1556,7 @@ export class Wallet implements IWallet {
     });
 
     if (this._wallet.multisigType === 'tss') {
-      return this.signTransactionTss({ ...presign, prv: this.getUserPrv(presign as GetUserPrvOptions) });
+      return this.signTransactionTss({ ...presign, prv: this.getUserPrv(presign as GetUserPrvOptions), apiVersion });
     }
 
     let { pubs } = params;
@@ -2526,8 +2527,16 @@ export class Wallet implements IWallet {
   private async prebuildTransactionTss(params: PrebuildTransactionOptions = {}): Promise<PrebuildTransactionResult> {
     const reqId = params.reqId || new RequestTracer();
     this.bitgo.setRequestTracer(reqId);
+    if (
+      params.apiVersion === 'lite' &&
+      (this._wallet.type === 'custodial' || this.baseCoin.getMPCAlgorithm() === 'ecdsa')
+    ) {
+      throw new Error(`Custodial and ECDSA MPC algorithm must always use 'full' api version`);
+    }
+
     const apiVersion =
-      this._wallet.type === 'custodial' || this.baseCoin.getMPCAlgorithm() === 'ecdsa' ? 'full' : 'lite';
+      params.apiVersion ||
+      (this._wallet.type === 'custodial' || this.baseCoin.getMPCAlgorithm() === 'ecdsa' ? 'full' : 'lite');
 
     // Two options different implementations of fees seems to now be supported, for now we will support both to be backwards compatible
     // TODO(BG-59685): deprecate one of these so that we have a single way to pass fees
@@ -2704,6 +2713,7 @@ export class Wallet implements IWallet {
         txRequest: params.txPrebuild.txRequestId,
         prv: params.prv,
         reqId: params.reqId || new RequestTracer(),
+        apiVersion: params.apiVersion,
       });
       return {
         txRequestId: signedTxRequest.txRequestId,
@@ -2789,7 +2799,7 @@ export class Wallet implements IWallet {
     }
 
     // ECDSA TSS uses TxRequestFull
-    if (this.baseCoin.getMPCAlgorithm() === 'ecdsa') {
+    if (this.baseCoin.getMPCAlgorithm() === 'ecdsa' || params.apiVersion === 'full') {
       return signedTransaction;
     }