feat(sdk-core,sdk-coin-sol): token enablements verify option and type check improvements

TICKET: WP-5744

Author: mtexeira-simtlix

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

@@ -237,16 +237,11 @@ export class Sol extends BaseCoin {
     return Math.pow(10, this._staticsCoin.decimalPlaces);
   }
 
-  verifyTxType(txParams: TransactionParams, actualTypeFromDecoded: string | undefined): void {
-    // do nothing, let the tx fail way down as always
-    const expectedTypeFromUserParams = txParams.type;
-    if (expectedTypeFromUserParams === undefined || actualTypeFromDecoded === undefined) return;
-
-    const correctPrebuildTxType = BLIND_SIGNING_TX_TYPES_TO_CHECK[expectedTypeFromUserParams];
-
-    if (correctPrebuildTxType && correctPrebuildTxType !== actualTypeFromDecoded) {
+  verifyTxType(expectedTypeFromUserParams: string, actualTypeFromDecoded: string | undefined): void {
+    const matchFromUserToDecodedType = BLIND_SIGNING_TX_TYPES_TO_CHECK[expectedTypeFromUserParams];
+    if (matchFromUserToDecodedType !== actualTypeFromDecoded) {
       throw new Error(
-        `Tx type "${actualTypeFromDecoded}" does not match expected txParams type "${expectedTypeFromUserParams}"`
+        `Invalid transaction type on token enablement: expected "${matchFromUserToDecodedType}", got "${actualTypeFromDecoded}".`
       );
     }
   }
@@ -351,8 +346,8 @@ export class Sol extends BaseCoin {
     transaction.fromRawTransaction(rawTxBase64);
     const explainedTx = transaction.explainTransaction();
 
-    this.verifyTxType(txParams, explainedTx.type);
-    if (txParams.type === 'enabletoken') {
+    if (txParams.type === 'enabletoken' && verificationOptions?.verifyTokenEnablement) {
+      this.verifyTxType(txParams.type, explainedTx.type);
       const tokenEnablementsPrebuild = this.throwIfMissingTokenEnablementsOrReturn(explainedTx);
       const enableTokensConfig = this.throwIfMissingEnableTokenConfigOrReturn(txParams);
 

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

@@ -3271,6 +3271,7 @@ describe('SOL:', function () {
         txParams,
         txPrebuild: txPrebuildRaw,
         wallet,
+        verification: { verifyTokenEnablement: true },
       } as unknown as SolVerifyTransactionOptions);
 
       sameIntentTx.should.equal(true);
@@ -3288,8 +3289,12 @@ describe('SOL:', function () {
             txParams,
             txPrebuild: tamperedTxPrebuild,
             wallet,
+            verification: { verifyTokenEnablement: true },
           } as unknown as SolVerifyTransactionOptions),
-        { message: 'Tx type "Send" does not match expected txParams type "enabletoken"' }
+        {
+          message:
+            'Invalid transaction type on token enablement: expected "AssociatedTokenAccountInitialization", got "Send".',
+        }
       );
     });
 
@@ -3304,6 +3309,7 @@ describe('SOL:', function () {
             txParams,
             txPrebuild: tamperedTxPrebuild,
             wallet,
+            verification: { verifyTokenEnablement: true },
           } as unknown as SolVerifyTransactionOptions),
         { message: 'Invalid token name: expected tsol:ray, got tsol:t22mint on token enablement tx' }
       );
@@ -3320,6 +3326,7 @@ describe('SOL:', function () {
             txParams,
             txPrebuild: tamperedTxPrebuild,
             wallet,
+            verification: { verifyTokenEnablement: true },
           } as unknown as SolVerifyTransactionOptions),
         {
           message:

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

@@ -185,6 +185,7 @@ export interface VerificationOptions {
   addresses?: { [address: string]: AddressVerificationData };
   allowPaygoOutput?: boolean;
   considerMigratedFromAddressInternal?: boolean;
+  verifyTokenEnablement?: boolean;
   // Verify transaction is consolidating to wallet's base address
   consolidationToBaseAddress?: boolean;
 }

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

@@ -1,11 +1,15 @@
 /**
  * @prettier
  */
-import * as t from 'io-ts';
+import { TxSendBody } from '@bitgo/public-types';
+import { CoinFamily } from '@bitgo/statics';
 import assert from 'assert';
 import BigNumber from 'bignumber.js';
+import * as t from 'io-ts';
 import * as _ from 'lodash';
+import { IRequestTracer } from '../../api';
 import * as common from '../../common';
+import { AddressBook, IAddressBook } from '../address-book';
 import {
   IBaseCoin,
   NFTTransferOptions,
@@ -25,11 +29,15 @@ import {
   MissingEncryptedKeychainError,
   NeedUserSignupError,
 } from '../errors';
-import * as internal from '../internal/internal';
+import { SubmitTransactionResponse } from '../inscriptionBuilder';
 import { drawKeycard } from '../internal';
+import * as internal from '../internal/internal';
 import { decryptKeychainPrivateKey, Keychain, KeychainWithEncryptedPrv } from '../keychain';
+import { getLightningAuthKey } from '../lightning/lightningWalletUtil';
 import { IPendingApproval, PendingApproval, PendingApprovals } from '../pendingApproval';
+import { GoStakingWallet, StakingWallet } from '../staking';
 import { TradingAccount } from '../trading';
+import { getTxRequest } from '../tss';
 import {
   EddsaUnsignedTransaction,
   inferAddressType,
@@ -41,6 +49,11 @@ import {
   TokenType,
   TxRequest,
 } from '../utils';
+import { postWithCodec } from '../utils/postWithCodec';
+import { EcdsaMPCv2Utils, EcdsaUtils } from '../utils/tss/ecdsa';
+import EddsaUtils from '../utils/tss/eddsa';
+import { getTxRequestApiVersion, validateTxRequestApiVersion } from '../utils/txRequest';
+import { buildParamKeys, BuildParams } from './BuildParams';
 import {
   AccelerateTransactionOptions,
   AddressesByBalanceOptions,
@@ -110,19 +123,6 @@ import {
   WalletSignTypedDataOptions,
   WalletType,
 } from './iWallet';
-import { GoStakingWallet, StakingWallet } from '../staking';
-import EddsaUtils from '../utils/tss/eddsa';
-import { EcdsaMPCv2Utils, EcdsaUtils } from '../utils/tss/ecdsa';
-import { getTxRequest } from '../tss';
-import { buildParamKeys, BuildParams } from './BuildParams';
-import { postWithCodec } from '../utils/postWithCodec';
-import { TxSendBody } from '@bitgo/public-types';
-import { AddressBook, IAddressBook } from '../address-book';
-import { IRequestTracer } from '../../api';
-import { getTxRequestApiVersion, validateTxRequestApiVersion } from '../utils/txRequest';
-import { getLightningAuthKey } from '../lightning/lightningWalletUtil';
-import { SubmitTransactionResponse } from '../inscriptionBuilder';
-import { CoinFamily } from '@bitgo/statics';
 
 const debug = require('debug')('bitgo:v2:wallet');
 
@@ -3231,6 +3231,8 @@ export class Wallet implements IWallet {
    */
   public async sendTokenEnablement(params: PrebuildAndSignTransactionOptions = {}): Promise<any> {
     const teConfig = this.baseCoin.getTokenEnablementConfig();
+    if (params.verification && params.verification.verifyTokenEnablement === undefined)
+      params.verification.verifyTokenEnablement = true;
     if (!teConfig.requiresTokenEnablement) {
       throw new Error(`${this.baseCoin.getFullName()} does not require token enablement transactions`);
     }