fix(sdk-coin-stx): return required fields for unsigned sweep

Ticket: COIN-3893

Author: ravibitgo

modules/sdk-coin-stx/src/lib/iface.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { ClarityValue, PayloadType } from '@stacks/transactions';
+import { TransactionExplanation as BaseTransactionExplanation } from '@bitgo/sdk-core';
 
 export interface TxData {
   id: string;
@@ -107,6 +108,14 @@ export interface RecoveryOptions {
   contractId?: string;
 }
 
+export interface RecoveryInfo extends BaseTransactionExplanation {
+  txHex: string;
+  feeInfo?: {
+    fee: string;
+  };
+  coin?: string;
+}
+
 export interface RecoveryTransaction {
   txHex: string;
 }

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

@@ -42,11 +42,13 @@ import { findContractTokenNameUsingContract, findTokenNameByContract, getAddress
 import {
   AddressDetails,
   NativeStxBalance,
+  RecoveryInfo,
   RecoveryOptions,
   RecoveryTransaction,
   SingleFungibleTokenBalance,
   StxNonceResponse,
   StxTxnFeeEstimationResponse,
+  TxData,
 } from './lib/iface';
 import { TransferBuilder } from './lib/transferBuilder';
 import { FungibleTokenTransferBuilder } from './lib/fungibleTokenTransferBuilder';
@@ -410,6 +412,23 @@ export class Stx extends BaseCoin {
     }
   }
 
+  /**
+   * Format for offline vault signing
+   * @param {BaseTransaction} tx - base transaction
+   * @returns {Promise<RecoveryInfo>}
+   */
+  protected async formatForOfflineVault(tx: BaseTransaction): Promise<RecoveryInfo> {
+    const txJson: TxData = tx.toJson();
+    const transactionExplanation: RecoveryInfo = (await this.explainTransaction({
+      txHex: tx.toBroadcastFormat(),
+      feeInfo: { fee: txJson.fee },
+    })) as RecoveryInfo;
+    transactionExplanation.coin = this.getChain();
+    transactionExplanation.feeInfo = { fee: txJson.fee };
+    transactionExplanation.txHex = tx.toBroadcastFormat();
+    return transactionExplanation;
+  }
+
   /**
    * Get the recoverable amount & fee after subtracting the txn fee
    * @param {String} serializedHex - serialized txn hex
@@ -667,9 +686,9 @@ export class Stx extends BaseCoin {
    * @param {String} params.bitgoKey - encrypted bitgo public key
    * @param {String} params.walletPassphrase - wallet password
    * @param {String} params.contractId - contract id of the token (mandatory for token recovery)
-   * @returns {Promise<RecoveryTransaction>} RecoveryTransaction.txHex - hex of serialized transaction (signed or unsigned)
+   * @returns {Promise<RecoveryInfo|RecoveryTransaction>} RecoveryTransaction.txHex - hex of serialized transaction (signed or unsigned)
    */
-  async recover(params: RecoveryOptions): Promise<RecoveryTransaction> {
+  async recover(params: RecoveryOptions): Promise<RecoveryInfo | RecoveryTransaction> {
     if (!this.isValidAddress(params.rootAddress)) {
       throw new Error('invalid root address!');
     }
@@ -713,12 +732,9 @@ export class Stx extends BaseCoin {
       contractAddressInput: contractAddress,
       contractName: contractName,
     });
-    const serializedTx: string = tx.toBroadcastFormat();
 
     if (isUnsignedSweep) {
-      return {
-        txHex: serializedTx,
-      };
+      return await this.formatForOfflineVault(tx);
     }
     // check the private key & sign
     if (!keys[0].privateKey) {

modules/sdk-coin-stx/test/unit/sip10Token.ts

@@ -6,7 +6,7 @@ import { ITransactionRecipient, Wallet, Memo } from '@bitgo/sdk-core';
 
 import { Sip10Token } from '../../src';
 import * as testData from '../fixtures';
-import { RecoveryOptions, RecoveryTransaction } from '../../src/lib/iface';
+import { RecoveryInfo, RecoveryOptions, RecoveryTransaction } from '../../src/lib/iface';
 import assert from 'assert';
 
 describe('Sip10Token:', function () {
@@ -309,9 +309,12 @@ describe('Sip10Token:', function () {
         bitgoKey: testData.COLD_WALLET_PUBLIC_KEY_INFO.BITGO_PUB_KEY,
         contractId: 'STAG18E45W613FZ3H4ZMF6QHH426EXM5QTSAVWYH.tsip6dp-token',
       };
-      const response: RecoveryTransaction = await basecoin.recover(recoveryOptions);
+      const response: RecoveryInfo = (await basecoin.recover(recoveryOptions)) as RecoveryInfo;
       response.should.have.property('txHex');
+      response.should.have.property('coin');
+      response.should.have.property('feeInfo');
       assert.deepEqual(response.txHex, testData.COLD_WALLET_TOKEN_UNSIGNED_SWEEP_TX_HEX, 'tx hex not matching!');
+      assert.deepEqual(response.coin, 'tstx:tsip6dp', 'coin not matching!');
     });
 
     it('should fail with insufficient balance when native stx balance is lower than fee for sip10', async () => {

modules/sdk-coin-stx/test/unit/stx.ts

@@ -9,7 +9,7 @@ import { cvToString } from '@stacks/transactions';
 
 import * as testData from '../fixtures';
 import { Stx, StxLib, Tstx } from '../../src';
-import { RecoveryOptions, RecoveryTransaction } from '../../src/lib/iface';
+import { RecoveryInfo, RecoveryOptions, RecoveryTransaction } from '../../src/lib/iface';
 
 const { KeyPair } = StxLib;
 
@@ -399,9 +399,12 @@ describe('STX:', function () {
         recoveryDestination: testData.DESTINATION_ADDRESS_WRW,
         bitgoKey: testData.COLD_WALLET_PUBLIC_KEY_INFO.BITGO_PUB_KEY,
       };
-      const response: RecoveryTransaction = await basecoin.recover(recoveryOptions);
+      const response: RecoveryInfo = await basecoin.recover(recoveryOptions);
       response.should.have.property('txHex');
+      response.should.have.property('coin');
+      response.should.have.property('feeInfo');
       assert.deepEqual(response.txHex, testData.COLD_WALLET_UNSIGNED_SWEEP_TX_HEX, 'tx hex not matching!');
+      assert.deepEqual(response.coin, 'tstx', 'coin not matching!');
     });
 
     it('should throw invalid root address when root address is missing or invalid', async function () {