fix: invalid websocket schema (#850)

* fix: websocket transaction schema is different from what server is sending

* tests: added test on checking for new address generation on websocket update

* refactor: passing eslint

Author: andreabadesso

__tests__/wallet/connection.test.ts

@@ -47,35 +47,67 @@ describe('WalletConnection', () => {
 
   describe('websocket transaction events', () => {
     const validTransaction = {
-      tx_id: '00003eeb2ce22e80e0fa72d8afb0b8b01f8919faac94cb3a3b4900782d0f399f',
-      nonce: 123,
-      timestamp: Date.now(),
-      version: 1,
-      weight: 1,
-      parents: ['parent1', 'parent2'],
+      tx_id: '00000e0e193894909fc85dad8a778a8e7904de30362f53b4839e93cc315648e6',
+      nonce: 16488190,
+      timestamp: 1745940424,
+      version: 2,
+      voided: false,
+      weight: 17.43270481128759,
+      parents: [
+        '000000003a90c27be4093663ef1e1eb1564aa5462f282d86fc062add717b059a',
+        '0000762414270482d75b7c759d1b8bc7341a884084004042fb70eafe11a01eb6',
+      ],
       inputs: [
         {
-          address: 'HH5As5aLtzFkcbmbXZmE65wSd22GqPWq2T',
-          timelock: null,
-          type: 'P2PKH',
+          tx_id: '0000762414270482d75b7c759d1b8bc7341a884084004042fb70eafe11a01eb6',
+          index: 0,
+          value: 1n,
+          token_data: 0,
+          script: {
+            type: 'Buffer' as const,
+            data: [
+              118, 169, 20, 107, 97, 132, 123, 120, 0, 1, 243, 13, 222, 197, 107, 73, 138, 22, 138,
+              241, 2, 209, 72, 136, 172,
+            ],
+          },
+          token: '00',
+          decoded: {
+            type: 'P2PKH',
+            address: 'HGJuWWGgRQ2roCfcmt5MCBJZx3yMYRz8dq',
+            timelock: null,
+          },
         },
       ],
       outputs: [
         {
-          address: 'HH5As5aLtzFkcbmbXZmE65wSd22GqPWq2T',
-          timelock: null,
-          type: 'P2PKH',
+          value: 100n,
+          token_data: 1,
+          script: {
+            type: 'Buffer' as const,
+            data: [
+              118, 169, 20, 69, 227, 122, 171, 130, 223, 106, 158, 121, 173, 64, 26, 133, 156, 27,
+              199, 10, 82, 191, 81, 136, 172,
+            ],
+          },
+          decodedScript: null,
+          token: '00000e0e193894909fc85dad8a778a8e7904de30362f53b4839e93cc315648e6',
+          locked: false,
+          index: 0,
+          decoded: {
+            type: 'P2PKH',
+            address: 'HCtfX7Pz98ihXjPKCEugFHduVeuHgSXRcy',
+            timelock: null,
+          },
         },
       ],
-      height: 100,
-      token_name: 'Test Token',
+      height: 0,
+      token_name: 'Test',
       token_symbol: 'TST',
-      signal_bits: 1,
-      voided: false,
+      signal_bits: 0,
     };
 
     const invalidTransaction = {
-      // Missing required fields
+      // Missing required fields, this remains a simple invalid object
       tx_id: '00003eeb2ce22e80e0fa72d8afb0b8b01f8919faac94cb3a3b4900782d0f399f',
     };
 

__tests__/wallet/wallet.test.ts

@@ -10,7 +10,12 @@ import Mnemonic from 'bitcore-mnemonic';
 import { mockAxiosAdapter } from '../__mock_helpers__/axios-adapter.mock';
 import HathorWalletServiceWallet from '../../src/wallet/wallet';
 import Network from '../../src/models/network';
-import { GetAddressesObject, WsTransaction, CreateWalletAuthData } from '../../src/wallet/types';
+import {
+  GetAddressesObject,
+  WsTransaction,
+  CreateWalletAuthData,
+  AddressInfoObject,
+} from '../../src/wallet/types';
 import config from '../../src/config';
 import {
   buildSuccessTxByIdTokenDataResponse,
@@ -102,6 +107,106 @@ test('getAddressAtIndex', async () => {
   await expect(wallet.getAddressAtIndex(0)).rejects.toThrow('Error getting wallet addresses.');
 });
 
+describe('onNewTx', () => {
+  const requestPassword = jest.fn();
+  const network = new Network('testnet');
+  const seed = defaultWalletSeed;
+
+  it('should call getNewAddresses if an output address is in newAddresses', async () => {
+    const wallet = new HathorWalletServiceWallet({
+      requestPassword,
+      seed,
+      network,
+    });
+
+    const testAddress = 'testAddress1';
+    // @ts-expect-error: Monkey-patching wallet instance
+    wallet.newAddresses = [
+      { address: testAddress, index: 0, addressPath: "m/0'/0/0" },
+    ] as AddressInfoObject[];
+
+    const getNewAddressesSpy = jest
+      // @ts-expect-error: Monkey-patching wallet instance
+      .spyOn(wallet, 'getNewAddresses')
+      .mockResolvedValue(undefined);
+
+    const newTx: WsTransaction = {
+      tx_id: 'tx1',
+      nonce: 0,
+      timestamp: 0,
+      signal_bits: 0,
+      version: 1,
+      weight: 1,
+      parents: [],
+      inputs: [],
+      outputs: [
+        {
+          value: 100n,
+          token_data: 0,
+          script: { type: 'Buffer', data: [] },
+          token: 'HTR',
+          decoded: {
+            type: 'P2PKH',
+            address: testAddress,
+            timelock: null,
+          },
+          locked: false,
+          index: 0,
+        },
+      ],
+    };
+
+    await wallet.onNewTx(newTx);
+
+    expect(getNewAddressesSpy).toHaveBeenCalled();
+  });
+
+  it('should not call getNewAddresses if no output address is in newAddresses', async () => {
+    const wallet = new HathorWalletServiceWallet({
+      requestPassword,
+      seed,
+      network,
+    });
+
+    // @ts-expect-error: Monkey-patching newAddresses
+    wallet.newAddresses = [
+      { address: 'otherAddress', index: 0, addressPath: "m/0'/0/0" },
+    ] as AddressInfoObject[];
+
+    const getNewAddressesSpy = jest.spyOn(wallet, 'getNewAddresses').mockResolvedValue(undefined);
+
+    const newTx: WsTransaction = {
+      tx_id: 'tx2',
+      nonce: 0,
+      timestamp: 0,
+      signal_bits: 0,
+      version: 1,
+      weight: 1,
+      parents: [],
+      inputs: [],
+      outputs: [
+        {
+          value: 100n,
+          token_data: 0,
+          script: { type: 'Buffer', data: [] },
+          token: 'HTR',
+          decoded: {
+            type: 'P2PKH',
+            address: 'someRandomAddress',
+            timelock: null,
+          },
+          locked: false,
+          index: 0,
+        },
+      ],
+    };
+
+    await wallet.onNewTx(newTx);
+
+    expect(getNewAddressesSpy).not.toHaveBeenCalled();
+  });
+});
+
 test('getTxBalance', async () => {
   const requestPassword = jest.fn();
   const network = new Network('testnet');

__tests__/wallet/walletSchemas.test.ts

@@ -776,64 +776,130 @@ describe('Wallet API Schemas', () => {
   });
 
   describe('wsTransactionSchema', () => {
+    const validWsTxData = {
+      tx_id: '00000e0e193894909fc85dad8a778a8e7904de30362f53b4839e93cc315648e6',
+      nonce: 16488190,
+      timestamp: 1745940424,
+      version: 2,
+      voided: false,
+      weight: 17.43270481128759,
+      parents: [
+        '000000003a90c27be4093663ef1e1eb1564aa5462f282d86fc062add717b059a',
+        '0000762414270482d75b7c759d1b8bc7341a884084004042fb70eafe11a01eb6',
+      ],
+      inputs: [
+        {
+          tx_id: '0000762414270482d75b7c759d1b8bc7341a884084004042fb70eafe11a01eb6',
+          index: 0,
+          value: 1n, // Use BigInt notation
+          token_data: 0,
+          script: {
+            type: 'Buffer',
+            data: [
+              118, 169, 20, 107, 97, 132, 123, 120, 0, 1, 243, 13, 222, 197, 107, 73, 138, 22, 138,
+              241, 2, 209, 72, 136, 172,
+            ],
+          },
+          token: '00',
+          decoded: {
+            type: 'P2PKH',
+            address: 'HGJuWWGgRQ2roCfcmt5MCBJZx3yMYRz8dq',
+            timelock: null,
+          },
+        },
+      ],
+      outputs: [
+        {
+          value: 100n, // Use BigInt notation
+          token_data: 1,
+          script: {
+            type: 'Buffer',
+            data: [
+              118, 169, 20, 69, 227, 122, 171, 130, 223, 106, 158, 121, 173, 64, 26, 133, 156, 27,
+              199, 10, 82, 191, 81, 136, 172,
+            ],
+          },
+          decodedScript: null,
+          token: '00000e0e193894909fc85dad8a778a8e7904de30362f53b4839e93cc315648e6',
+          locked: false,
+          index: 0,
+          decoded: {
+            type: 'P2PKH',
+            address: 'HCtfX7Pz98ihXjPKCEugFHduVeuHgSXRcy',
+            timelock: null,
+          },
+        },
+      ],
+      height: 0,
+      token_name: 'Test',
+      token_symbol: 'TST',
+      signal_bits: 0,
+    };
+
     it('should validate valid websocket transaction', () => {
-      const validData = {
-        tx_id: tx1,
-        nonce: 1,
-        timestamp: 1234567890,
-        version: 1,
-        voided: false,
-        weight: 1,
-        parents: ['parent1'],
+      expect(() => wsTransactionSchema.parse(validWsTxData)).not.toThrow();
+    });
+
+    it('should validate websocket transaction with null height', () => {
+      const dataWithNullHeight = {
+        ...validWsTxData,
+        height: null,
+      };
+      expect(() => wsTransactionSchema.parse(dataWithNullHeight)).not.toThrow();
+    });
+
+    it('should validate websocket transaction with omitted height', () => {
+      const { height: _height, ...dataWithoutHeight } = validWsTxData;
+      expect(() => wsTransactionSchema.parse(dataWithoutHeight)).not.toThrow();
+    });
+
+    it('should reject invalid websocket transaction (bad input structure)', () => {
+      const invalidData = {
+        ...validWsTxData,
         inputs: [
           {
+            // Missing many required fields from wsTxInputSchema
             address: addr1,
             timelock: null,
             type: 'P2PKH',
           },
         ],
+      };
+      expect(() => wsTransactionSchema.parse(invalidData)).toThrow();
+    });
+
+    it('should reject invalid websocket transaction (bad output structure)', () => {
+      const invalidData = {
+        ...validWsTxData,
         outputs: [
           {
+            // Missing many required fields from wsTxOutputSchema
             address: addr2,
             timelock: null,
             type: 'P2PKH',
           },
         ],
-        height: 1,
-        token_name: 'Token 1',
-        token_symbol: 'T1',
-        signal_bits: 0,
       };
-      expect(() => wsTransactionSchema.parse(validData)).not.toThrow();
+      expect(() => wsTransactionSchema.parse(invalidData)).toThrow();
     });
 
-    it('should reject invalid websocket transaction', () => {
+    it('should reject invalid websocket transaction (bad nonce type)', () => {
       const invalidData = {
-        tx_id: tx1,
-        nonce: '1', // should be number
-        timestamp: 1234567890,
-        version: 1,
-        voided: false,
-        weight: 1,
-        parents: ['parent1'],
-        inputs: [
-          {
-            address: addr1,
-            timelock: null,
-            type: 'P2PKH',
-          },
-        ],
+        ...validWsTxData,
+        nonce: '16488190', // Nonce should be number
+      };
+      expect(() => wsTransactionSchema.parse(invalidData)).toThrow();
+    });
+
+    it('should reject invalid websocket transaction (invalid token id in output)', () => {
+      const invalidData = {
+        ...validWsTxData,
         outputs: [
           {
-            address: addr2,
-            timelock: null,
-            type: 'P2PKH',
+            ...validWsTxData.outputs[0],
+            token: 'invalid-token-id', // Invalid token ID format
           },
         ],
-        height: 1,
-        token_name: 'Token 1',
-        token_symbol: 'T1',
-        signal_bits: 0,
       };
       expect(() => wsTransactionSchema.parse(invalidData)).toThrow();
     });