Merge pull request #7112 from BitGo/SC-3303

fix(sdk-core): fix TransactionType check

Author: noel-bitgo

modules/bitgo/test/v2/fixtures/staking/tavaxpStakingFixtures.ts

@@ -0,0 +1,55 @@
+export const updatedStakingRequest = {
+  id: '52676686-0d86-4ae6-8216-3465cb228615',
+  stakingRequestId: '75de4133-6bea-4507-841a-b19f7672e1f7',
+  delegationId: '27d726f9-3061-4f73-b40c-703962449b24',
+  createdDate: '2025-03-25T13:43:07.942063Z',
+  transactionType: 'delegate',
+  status: 'READY',
+  statusModifiedDate: '2025-03-25T13:43:07.942063Z',
+  amount: '1260000000',
+  buildParams: {
+    type: 'AddPermissionlessValidator',
+    stakingOptions: {
+      nodeID: 'NodeID-Hj5HbEgZU51cQXKzg6NScAhcgqPmA4Bd4',
+      blsPublicKey:
+        '0xad9e9476b701edec88e53b1c314456053b3cf846a1192117872e41455f440c074d6ee89530d45e88f79ac0eda06f2887',
+      blsSignature:
+        '0xa94d6182edbd953516b262f17565a65d98f5741549cd70d2423abff750bb4b8d982d482376b189142ff8aa4705615fee14be6174610860e9c003aa4aeaa613b1732abf3cd0c9c42fa5856345644068c0d1f9fa1d9af32e20b14fca02983260bc',
+      amount: '1260000000',
+      delegationFeeRate: 2,
+      durationSeconds: '86400',
+    },
+  },
+};
+
+export const unsignedStakingTransaction = {
+  txHex:
+    '0x000000000019000000050000000000000000000000000000000000000000000000000000000000000000000000013d9bdac0ed1d761330cf680efdeb1a42159eb387d6d2950c96f7d28f61bbe2aa00000007000000000df28e80000000000000000000000002000000033c21b92ba7e44eb0c7e1b9616fe5e759305285c74375e5b8deda05808c72b104500560061c38fc2bc07fd92fb1deaf9e6136ac4b60f6d16d79f1d1d700000002107e156978c655c09751b159cb1a7b5aaf0d72dda88ecff279865fd6db35ab38000000003d9bdac0ed1d761330cf680efdeb1a42159eb387d6d2950c96f7d28f61bbe2aa00000005000000001d9f9e400000000200000000000000011a6a5e9b720f9eb30ee25fc6bd5b9e82e0b4e37ae94394c6699792bf3fbe1e98000000003d9bdac0ed1d761330cf680efdeb1a42159eb387d6d2950c96f7d28f61bbe2aa00000005000000003b6d034000000002000000000000000100000000b7770f8cb7f68e67a2f555129f21bb85628a35720000000066105d10000000006611ae90000000004b1a130000000000000000000000000000000000000000000000000000000000000000000000001cad9e9476b701edec88e53b1c314456053b3cf846a1192117872e41455f440c074d6ee89530d45e88f79ac0eda06f2887a94d6182edbd953516b262f17565a65d98f5741549cd70d2423abff750bb4b8d982d482376b189142ff8aa4705615fee14be6174610860e9c003aa4aeaa613b1732abf3cd0c9c42fa5856345644068c0d1f9fa1d9af32e20b14fca02983260bc000000013d9bdac0ed1d761330cf680efdeb1a42159eb387d6d2950c96f7d28f61bbe2aa00000007000000004b1a1300000000000000000000000002000000033c21b92ba7e44eb0c7e1b9616fe5e759305285c74375e5b8deda05808c72b104500560061c38fc2bc07fd92fb1deaf9e6136ac4b60f6d16d79f1d1d70000000b000000000000000000000002000000033c21b92ba7e44eb0c7e1b9616fe5e759305285c74375e5b8deda05808c72b104500560061c38fc2bc07fd92fb1deaf9e6136ac4b60f6d16d79f1d1d70000000b000000000000000000000002000000033c21b92ba7e44eb0c7e1b9616fe5e759305285c74375e5b8deda05808c72b104500560061c38fc2bc07fd92fb1deaf9e6136ac4b60f6d16d79f1d1d700004e200000000200000009000000022d890d61be44a625929c5978869af170b9af025ff71fc319e6000fd6640a1da234801497ba23c58f80a6f025c92a0433accd1279457d9d9dc5643bdc340d831d01238536ee684fddedd8d9dbc6afe35dfa3c9634ef22a5060df998bdff84e27b962010e760c655a676576a5e503703ba7153fcc86862c96db06393e77c15cc28170000000009000000022d890d61be44a625929c5978869af170b9af025ff71fc319e6000fd6640a1da234801497ba23c58f80a6f025c92a0433accd1279457d9d9dc5643bdc340d831d01238536ee684fddedd8d9dbc6afe35dfa3c9634ef22a5060df998bdff84e27b962010e760c655a676576a5e503703ba7153fcc86862c96db06393e77c15cc2817003b5e792a',
+  recipients: [
+    {
+      amount: '1260000000',
+      address: 'NodeID-Hj5HbEgZU51cQXKzg6NScAhcgqPmA4Bd4',
+    },
+  ],
+  buildParams: {
+    type: 'AddPermissionlessValidator',
+    stakingOptions: {
+      nodeID: 'NodeID-Hj5HbEgZU51cQXKzg6NScAhcgqPmA4Bd4',
+      blsPublicKey:
+        '0xad9e9476b701edec88e53b1c314456053b3cf846a1192117872e41455f440c074d6ee89530d45e88f79ac0eda06f2887',
+      blsSignature:
+        '0xa94d6182edbd953516b262f17565a65d98f5741549cd70d2423abff750bb4b8d982d482376b189142ff8aa4705615fee14be6174610860e9c003aa4aeaa613b1732abf3cd0c9c42fa5856345644068c0d1f9fa1d9af32e20b14fca02983260bc',
+      amount: '1260000000',
+      delegationFeeRate: 2,
+      durationSeconds: '86400',
+    },
+  },
+  stakingParams: {
+    requestId: '75de4133-6bea-4507-841a-b19f7672e1f7',
+    amount: '1260000000',
+    coin: 'tavaxp',
+    validator: 'NodeID-Hj5HbEgZU51cQXKzg6NScAhcgqPmA4Bd4',
+    actionType: 'DELEGATE',
+  },
+  coin: 'tavaxp',
+};

modules/bitgo/test/v2/fixtures/staking/topethStakingFixtures.ts

@@ -1,97 +1,3 @@
-export const newStakingRequest = {
-  id: '75de4133-6bea-4507-841a-b19f7672e1f7',
-  requestingUserId: '5cb525d7e1b1328103076788fd6a07f9',
-  type: 'STAKE',
-  enterpriseId: '61c0ff41174c4e0007ae78b2a0bea1ec',
-  walletId: '674f61528414869237480e6997ea7954',
-  walletType: 'hot',
-  withdrawalAddress: '0x1d1a245741bd7d603747a23d30f4c91682a29926',
-  coin: 'topeth:wct',
-  status: 'NEW',
-  statusModifiedDate: '2025-03-25T13:43:07.808717Z',
-  createdDate: '2025-03-25T13:43:07.808708Z',
-  delegations: [],
-  transactions: [],
-  totalStaked: '0',
-  amount: '1000000000000000000',
-  durationSeconds: '1209600',
-};
-
-export const stakingReadyToSign = {
-  id: '75de4133-6bea-4507-841a-b19f7672e1f7',
-  requestingUserId: '5cb525d7e1b1328103076788fd6a07f9',
-  type: 'STAKE',
-  enterpriseId: '61c0ff41174c4e0007ae78b2a0bea1ec',
-  walletId: '674f61528414869237480e6997ea7954',
-  walletType: 'hot',
-  withdrawalAddress: '0x1d1a245741bd7d603747a23d30f4c91682a29926',
-  coin: 'topeth:wct',
-  status: 'READY',
-  statusModifiedDate: '2025-03-25T13:43:08.883527Z',
-  createdDate: '2025-03-25T13:43:07.808708Z',
-  delegations: [
-    {
-      id: '27d726f9-3061-4f73-b40c-703962449b24',
-      delegationAddress: '0x1d1a245741bd7d603747a23d30f4c91682a29926',
-      provider: 'Unknown',
-      withdrawalAddress: '0x1d1a245741bd7d603747a23d30f4c91682a29926',
-      delegated: '0',
-      coin: 'topeth:wct',
-      walletId: '674f61528414869237480e6997ea7954',
-      properties: {
-        type: 'WCT',
-      },
-      status: 'PENDING',
-      rewards: '0',
-      lockedRewards: '0',
-      pendingUnstake: '0',
-      pendingStake: '1000000000000000000',
-      reserved: '0',
-      pendingReserved: '0',
-      apy: '0',
-      unstakeable: false,
-      pendingClaimRewards: '0',
-      permissionAttributes: {
-        staking: {
-          enabled: false,
-          disabledReason: 'Delegation is not active.',
-          allowClientToUseOwnValidator: false,
-        },
-        unstaking: {
-          enabled: false,
-          disabledReason: 'Delegation is not active.',
-        },
-      },
-    },
-  ],
-  transactions: [
-    {
-      id: '52676686-0d86-4ae6-8216-3465cb228615',
-      stakingRequestId: '75de4133-6bea-4507-841a-b19f7672e1f7',
-      delegationId: '27d726f9-3061-4f73-b40c-703962449b24',
-      createdDate: '2025-03-25T13:43:07.942063Z',
-      transactionType: 'authorize',
-      status: 'READY',
-      statusModifiedDate: '2025-03-25T13:43:07.942063Z',
-      amount: '1000000000000000000',
-    },
-    {
-      id: 'ac56e1fc-3077-487f-a4f4-78061aa74300',
-      stakingRequestId: '75de4133-6bea-4507-841a-b19f7672e1f7',
-      delegationId: '27d726f9-3061-4f73-b40c-703962449b24',
-      createdDate: '2025-03-25T13:43:07.942138Z',
-      transactionType: 'delegate',
-      status: 'WAITING',
-      statusModifiedDate: '2025-03-25T13:43:07.942138Z',
-      amount: '1000000000000000000',
-    },
-  ],
-  totalStaked: '0',
-  amount: '1000000000000000000',
-  durationSeconds: '1209600',
-  fiatValue: 20.63776884676185,
-};
-
 export const updatedStakingRequest = {
   id: '52676686-0d86-4ae6-8216-3465cb228615',
   stakingRequestId: '75de4133-6bea-4507-841a-b19f7672e1f7',

modules/bitgo/test/v2/unit/staking/stakingWalletNonTSS.ts

@@ -3,6 +3,7 @@ import * as _ from 'lodash';
 import nock = require('nock');
 import fixtures from '../../fixtures/staking/stakingWallet';
 import * as opethFixtures from '../../fixtures/staking/topethStakingFixtures';
+import * as avaxpStakingFixtures from '../../fixtures/staking/tavaxpStakingFixtures';
 
 import {
   Enterprise,
@@ -27,15 +28,18 @@ describe('non-TSS Staking Wallet', function () {
   let maticBaseCoin;
   let btcBaseCoin;
   let topethWctBaseCoin;
+  let tavaxpBaseCoin;
   let enterprise;
   let ethWalletData: any;
   let btcWalletData: any;
   let topethWctStakingWalletData: WalletData;
+  let tavaxpStakingWalletData: WalletData;
   let btcDescriptorWalletData: any;
   let ethStakingWallet: StakingWallet;
   let maticStakingWallet: StakingWallet;
   let btcStakingWallet: StakingWallet;
   let topethWctStakingWallet: StakingWallet;
+  let tavaxpStakingWallet: StakingWallet;
 
   before(function () {
     bitgo = TestBitGo.decorate(BitGo, { env: 'mock', microservicesUri } as any);
@@ -47,6 +51,7 @@ describe('non-TSS Staking Wallet', function () {
     btcBaseCoin = bitgo.coin('btc');
     btcBaseCoin.keychains();
     topethWctBaseCoin = bitgo.coin('topeth:wct');
+    tavaxpBaseCoin = bitgo.coin('tavaxp');
 
     enterprise = new Enterprise(bitgo, ethBaseCoin, {
       id: '5cf940949449412d00f53b3d92dbcaa3',
@@ -98,10 +103,29 @@ describe('non-TSS Staking Wallet', function () {
       enterprise: enterprise.id,
     };
 
+    tavaxpStakingWalletData = {
+      approvalsRequired: 0,
+      balance: 0,
+      balanceString: '',
+      coinSpecific: {} as WalletCoinSpecific,
+      confirmedBalance: 0,
+      confirmedBalanceString: '',
+      keys: [],
+      label: '',
+      multisigType: 'onchain',
+      pendingApprovals: [],
+      spendableBalance: 0,
+      spendableBalanceString: '',
+      id: 'tavaxpStakingWalletId',
+      coin: 'tavaxp',
+      enterprise: enterprise.id,
+    };
+
     const ethWallet = new Wallet(bitgo, ethBaseCoin, ethWalletData);
     const maticWallet = new Wallet(bitgo, maticBaseCoin, maticWalletData);
     const btcWallet = new Wallet(bitgo, btcBaseCoin, btcWalletData);
     topethWctStakingWallet = new Wallet(bitgo, topethWctBaseCoin, topethWctStakingWalletData).toStakingWallet();
+    tavaxpStakingWallet = new Wallet(bitgo, tavaxpBaseCoin, tavaxpStakingWalletData).toStakingWallet();
 
     ethStakingWallet = ethWallet.toStakingWallet();
     maticStakingWallet = maticWallet.toStakingWallet();
@@ -434,4 +458,34 @@ describe('non-TSS Staking Wallet', function () {
         .should.be.rejectedWith(expectedErrorMessage);
     });
   });
+
+  describe('TAVAXP Staking', function () {
+    it('should build and validate transaction', async function () {
+      const unsignedTransaction: PrebuildTransactionResult = {
+        walletId: tavaxpStakingWallet.walletId,
+        ...avaxpStakingFixtures.unsignedStakingTransaction,
+      } as PrebuildTransactionResult;
+      const stakingTransaction: StakingTransaction = avaxpStakingFixtures.updatedStakingRequest;
+
+      nock(microservicesUri)
+        .get(
+          `/api/staking/v1/${tavaxpStakingWallet.coin}/wallets/${tavaxpStakingWallet.walletId}/requests/${stakingTransaction.stakingRequestId}/transactions/${stakingTransaction.id}`
+        )
+        .query({ expandBuildParams: true })
+        .reply(200, stakingTransaction);
+
+      nock(microservicesUri)
+        .get(`/api/v2/tavaxp/wallet/${tavaxpStakingWallet.walletId}`)
+        .reply(200, tavaxpStakingWalletData);
+
+      nock(microservicesUri)
+        .post(`/api/v2/tavaxp/wallet/${tavaxpStakingWallet.walletId}/tx/build`)
+        .reply(200, unsignedTransaction);
+
+      // tx validation happens before signing, so we can skip it
+      sinon.stub(tavaxpStakingWallet, 'sign').resolves();
+
+      await tavaxpStakingWallet.buildAndSign({ walletPassphrase: 'passphrase' }, stakingTransaction);
+    });
+  });
 });

modules/sdk-core/src/account-lib/baseCoin/enum.ts

@@ -87,6 +87,24 @@ export enum TransactionType {
   FlushERC721,
   // Flush ERC1155 tokens from a forwarder address to base address
   FlushERC1155,
+
+  // trx
+  FREEZE,
+  VOTE,
+  UNFREEZE,
+  WITHDRAW_EXPIRE_UNFREEZE,
+  CLAIM_REWARDS,
+
+  // cspr and stx
+  stakingLock,
+  // stx
+  'self-stack',
+
+  // btc,
+  staking,
+
+  // cspr
+  stakingUnlock,
 }
 
 /**

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

@@ -28,6 +28,7 @@ import { ITssUtils, RequestTracer, TssUtils } from '../utils';
 import assert from 'assert';
 import { transactionRecipientsMatch } from '../utils/transactionUtils';
 import debug from 'debug';
+import { TransactionType } from '../../account-lib';
 
 export class StakingWallet implements IStakingWallet {
   private readonly bitgo: BitGoBase;
@@ -442,7 +443,11 @@ export class StakingWallet implements IStakingWallet {
       );
     }
 
-    if (buildParams?.type && (explainedTransaction as any).type !== buildParams.type) {
+    if (
+      buildParams?.type &&
+      (explainedTransaction as any).type !== undefined &&
+      TransactionType[buildParams.type] !== (explainedTransaction as any).type
+    ) {
       mismatchErrors.push(
         `Transaction type mismatch. Expected: '${buildParams.type}', Got: '${(explainedTransaction as any).type}'`
       );
@@ -458,18 +463,6 @@ export class StakingWallet implements IStakingWallet {
       }
     }
 
-    if (buildParams?.aptosCustomTransactionParams) {
-      if (
-        !isEqual((explainedTransaction as any).aptosCustomTransactionParams, buildParams.aptosCustomTransactionParams)
-      ) {
-        mismatchErrors.push(
-          `Aptos custom transaction parameters mismatch. Expected: ${JSON.stringify(
-            buildParams.aptosCustomTransactionParams
-          )}, Got: ${JSON.stringify((explainedTransaction as any).aptosCustomTransactionParams)}`
-        );
-      }
-    }
-
     if (mismatchErrors.length > 0) {
       const errorMessage = `Staking transaction validation failed before signing: ${mismatchErrors.join('; ')}`;
       debug(errorMessage);