refactor: added a "common" package to share code between packages

.codebuild/buildspec.yml

@@ -14,6 +14,7 @@ env:
     CONFIRM_FIRST_ADDRESS: true
     VOIDED_TX_OFFSET: 20
     TX_HISTORY_MAX_COUNT: 50
+    CREATE_NFT_MAX_RETRIES: 3
     dev_DEFAULT_SERVER: "https://wallet-service.private-nodes.testnet.hathor.network/v1a/"
     dev_WS_DOMAIN: "ws.dev.wallet-service.testnet.hathor.network"
     dev_NETWORK: "testnet"

.github/workflows/main.yml

@@ -40,7 +40,7 @@ jobs:
         nix_path: nixpkgs=channel:nixos-unstable
         extra_nix_config: |
           experimental-features = nix-command flakes
-          
+
     - name: Cache Nix
       uses: DeterminateSystems/magic-nix-cache-action@v2
 
@@ -59,6 +59,10 @@ jobs:
         CI_DB_HOST: 127.0.0.1
         CI_DB_PORT: 3306
 
+    - name: Run tests on the common modules project
+      run: |
+        nix develop . -c yarn workspace @wallet-service/common run test
+
     - name: Run tests on the daemon
       run: |
         nix develop . -c yarn workspace sync-daemon run test

.gitignore

@@ -7,8 +7,11 @@ dist
 coverage/
 packages/daemon/dist
 packages/daemon/node_modules
+packages/common/node_modules
 packages/wallet-service/node_modules
 packages/wallet-service/.serverless
 packages/wallet-service/.webpack
 packages/wallet-service/.env*
+packages/wallet-service/.warmup
 .yarn/
+.env.*

.yarnrc.yml

@@ -2,6 +2,7 @@ compressionLevel: mixed
 
 enableGlobalCache: false
 
-nmHoistingLimits: dependencies
+# Without this setting, the common package is hoisted in the root node_modules, causing the serverless-monorepo plugin to fail
+nmHoistingLimits: workspaces
 
 nodeLinker: node-modules

package.json

@@ -2,6 +2,7 @@
   "name": "hathor-wallet-service",
   "version": "1.5.0",
   "workspaces": [
+    "packages/common",
     "packages/daemon",
     "packages/wallet-service"
   ],
@@ -11,14 +12,34 @@
   "nohoist": [
     "**"
   ],
-  "repository": "[email protected]:HathorNetwork/hathor-wallet-service-sync_daemon.git",
+  "repository": "[email protected]:HathorNetwork/hathor-wallet-service.git",
   "author": "André Abadesso <[email protected]>",
   "private": true,
   "devDependencies": {
-    "dotenv": "^16.3.1",
-    "mysql2": "^3.6.1",
-    "sequelize": "^6.33.0",
-    "sequelize-cli": "^6.6.1"
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.4.0",
+    "@typescript-eslint/parser": "^7.4.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.9.0",
+    "mysql2": "^3.9.3",
+    "sequelize": "^6.37.2",
+    "sequelize-cli": "^6.6.2"
   },
-  "packageManager": "[email protected]"
+  "packageManager": "[email protected]",
+  "dependencies": {
+    "@aws-sdk/client-apigatewaymanagementapi": "3.540.0",
+    "@aws-sdk/client-lambda": "3.540.0",
+    "@aws-sdk/client-sqs": "3.540.0",
+    "@hathor/wallet-lib": "0.39.0",
+    "@wallet-service/common": "1.5.0",
+    "bip32": "^4.0.0",
+    "bitcoinjs-lib": "^6.1.5",
+    "bitcoinjs-message": "^2.2.0",
+    "jest": "^29.7.0",
+    "tiny-secp256k1": "^2.2.3",
+    "winston": "3.13.0"
+  }
 }

packages/common/README.md

@@ -0,0 +1 @@
+# Common utils for the wallet-service

packages/wallet-service/events/nftCreationTx.ts → packages/common/__tests__/events/nftCreationTx.ts

@@ -12,7 +12,7 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
 
 import { Context } from 'aws-lambda';
-import { Transaction } from '@src/types';
+import { Transaction, TxOutput } from '../../src/types';
 
 /**
  * A sample transaction for a NFT creation, as obtained by a wallet's history methods
@@ -149,11 +149,12 @@ export function getTransaction(): Transaction {
       spent_by: o.spent_by,
       token_data: o.token_data,
       locked: false,
-    })),
+    })) as TxOutput[],
     height: 8,
     token_name: nftCreationTx.token_name,
     token_symbol: nftCreationTx.token_symbol,
   };
+
   return result;
 }
 

packages/common/__tests__/utils/alerting.utils.mock.ts

@@ -0,0 +1,4 @@
+export const mockedAddAlert = jest.fn();
+export default jest.mock('@src/utils/alerting.utils', () => ({
+  addAlert: mockedAddAlert.mockReturnValue(Promise.resolve()),
+}));

packages/wallet-service/tests/utils/nft.utils.test.ts → packages/common/__tests__/utils/nft.utils.test.ts

@@ -1,12 +1,32 @@
+// @ts-ignore: Using old wallet-lib version, no types exported
 import hathorLib from '@hathor/wallet-lib';
-import { mockedAddAlert } from '@tests/utils/alerting.utils.mock';
+import { mockedAddAlert } from './alerting.utils.mock';
 import { Severity } from '@src/types';
-import { MAX_METADATA_UPDATE_RETRIES, NftUtils } from '@src/utils/nft.utils';
-import { getHandlerContext, getTransaction } from '@events/nftCreationTx';
+import { NftUtils } from '@src/utils/nft.utils';
+import { getHandlerContext, getTransaction } from '../events/nftCreationTx';
 import {
   LambdaClient as LambdaClientMock,
   InvokeCommandOutput,
 } from '@aws-sdk/client-lambda';
+import { Logger } from 'winston';
+
+jest.mock('winston', () => {
+  class FakeLogger {
+    warn() {
+      return jest.fn();
+    }
+    error() {
+      return jest.fn();
+    }
+    info() {
+      return jest.fn();
+    }
+  };
+
+  return {
+    Logger: FakeLogger,
+  }
+});
 
 jest.mock('@aws-sdk/client-lambda', () => {
   const mLambda = { send: jest.fn() };
@@ -17,19 +37,23 @@ jest.mock('@aws-sdk/client-lambda', () => {
   };
 });
 
+const network = new hathorLib.Network('testnet');
+const logger = new Logger();
+
 describe('shouldInvokeNftHandlerForTx', () => {
   it('should return false for a NFT transaction if the feature is disabled', () => {
     expect.hasAssertions();
 
     // Preparation
     const tx = getTransaction();
-    const isNftTransaction = NftUtils.isTransactionNFTCreation(tx);
+    const isNftTransaction = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(isNftTransaction).toStrictEqual(true);
 
     expect(process.env.NFT_AUTO_REVIEW_ENABLED).not.toStrictEqual('true');
 
     // Execution
-    const result = NftUtils.shouldInvokeNftHandlerForTx(tx);
+    // @ts-ignore
+    const result = NftUtils.shouldInvokeNftHandlerForTx(tx, network, logger);
 
     // Assertion
     expect(result).toBe(false);
@@ -40,14 +64,14 @@ describe('shouldInvokeNftHandlerForTx', () => {
 
     // Preparation
     const tx = getTransaction();
-    const isNftTransaction = NftUtils.isTransactionNFTCreation(tx);
+    const isNftTransaction = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(isNftTransaction).toStrictEqual(true);
 
     const oldValue = process.env.NFT_AUTO_REVIEW_ENABLED;
     process.env.NFT_AUTO_REVIEW_ENABLED = 'true';
 
     // Execution
-    const result = NftUtils.shouldInvokeNftHandlerForTx(tx);
+    const result = NftUtils.shouldInvokeNftHandlerForTx(tx, network, logger);
 
     // Assertion
     expect(result).toBe(true);
@@ -70,21 +94,21 @@ describe('isTransactionNFTCreation', () => {
     // Incorrect version
     tx = getTransaction();
     tx.version = hathorLib.constants.DEFAULT_TX_VERSION;
-    result = NftUtils.isTransactionNFTCreation(tx);
+    result = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(result).toBe(false);
     expect(spyCreateTx).not.toHaveBeenCalled();
 
     // Missing name
     tx = getTransaction();
     tx.token_name = undefined;
-    result = NftUtils.isTransactionNFTCreation(tx);
+    result = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(result).toBe(false);
     expect(spyCreateTx).not.toHaveBeenCalled();
 
     // Missing symbol
     tx = getTransaction();
     tx.token_symbol = undefined;
-    result = NftUtils.isTransactionNFTCreation(tx);
+    result = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(result).toBe(false);
     expect(spyCreateTx).not.toHaveBeenCalled();
 
@@ -101,7 +125,7 @@ describe('isTransactionNFTCreation', () => {
 
     // Validation
     const tx = getTransaction();
-    const result = NftUtils.isTransactionNFTCreation(tx);
+    const result = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(result).toBe(true);
 
     // Reverting mocks
@@ -113,7 +137,7 @@ describe('isTransactionNFTCreation', () => {
 
     // Validation
     const tx = getTransaction();
-    const result = NftUtils.isTransactionNFTCreation(tx);
+    const result = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(result).toBe(true);
   });
 
@@ -128,7 +152,7 @@ describe('isTransactionNFTCreation', () => {
 
     // Validation
     const tx = getTransaction();
-    const result = NftUtils.isTransactionNFTCreation(tx);
+    const result = NftUtils.isTransactionNFTCreation(tx, network, logger);
     expect(result).toBe(false);
 
     // Reverting mocks
@@ -154,11 +178,11 @@ describe('createOrUpdateNftMetadata', () => {
     const expectedUpdateResponse = { updated: 'ok' };
 
     spyUpdateMetadata.mockImplementation(async () => expectedUpdateResponse);
-    const result = await NftUtils.createOrUpdateNftMetadata('sampleUid');
+    const result = await NftUtils.createOrUpdateNftMetadata('sampleUid', 5, logger);
 
     expect(spyUpdateMetadata).toHaveBeenCalledTimes(1);
 
-    expect(spyUpdateMetadata).toHaveBeenCalledWith('sampleUid', expectedUpdateRequest);
+    expect(spyUpdateMetadata).toHaveBeenCalledWith('sampleUid', expectedUpdateRequest, 5, logger);
     expect(result).toBeUndefined(); // The method returns void
   });
 });
@@ -181,7 +205,7 @@ describe('_updateMetadata', () => {
     const oldStage = process.env.STAGE;
     process.env.STAGE = 'dev'; // Testing all code branches, including the developer ones, for increased coverage
 
-    const result = await NftUtils._updateMetadata('sampleUid', { sampleData: 'fake' });
+    const result = await NftUtils._updateMetadata('sampleUid', { sampleData: 'fake' }, 5, logger);
     expect(result).toStrictEqual(expectedLambdaResponse);
     process.env.STAGE = oldStage;
   });
@@ -197,7 +221,7 @@ describe('_updateMetadata', () => {
     };
     const mLambdaClient = new LambdaClientMock({});
     (mLambdaClient.send as jest.Mocked<any>).mockImplementation(async () => {
-        if (failureCount < MAX_METADATA_UPDATE_RETRIES - 1) {
+        if (failureCount < 4) {
           ++failureCount;
           return {
             StatusCode: 500,
@@ -207,7 +231,7 @@ describe('_updateMetadata', () => {
         return expectedLambdaResponse;
     });
 
-    const result = await NftUtils._updateMetadata('sampleUid', { sampleData: 'fake' });
+    const result = await NftUtils._updateMetadata('sampleUid', { sampleData: 'fake' }, 5, logger);
     expect(result).toStrictEqual(expectedLambdaResponse);
   });
 
@@ -218,7 +242,7 @@ describe('_updateMetadata', () => {
     let failureCount = 0;
     const mLambdaClient = new LambdaClientMock({});
     (mLambdaClient.send as jest.Mocked<any>).mockImplementation(() => {
-      if (failureCount < MAX_METADATA_UPDATE_RETRIES) {
+      if (failureCount < 5) {
         ++failureCount;
         return {
           StatusCode: 500,
@@ -232,7 +256,7 @@ describe('_updateMetadata', () => {
     });
 
     // eslint-disable-next-line jest/valid-expect
-    expect(NftUtils._updateMetadata('sampleUid', { sampleData: 'fake' }))
+    expect(NftUtils._updateMetadata('sampleUid', { sampleData: 'fake' }, network, logger))
       .rejects.toThrow(new Error('Metadata update failed for tx_id: sampleUid.'));
   });
 });
@@ -249,7 +273,7 @@ describe('invokeNftHandlerLambda', () => {
     const mLambdaClient = new LambdaClientMock({});
     (mLambdaClient.send as jest.Mocked<any>).mockImplementationOnce(async () => expectedLambdaResponse);
 
-    await expect(NftUtils.invokeNftHandlerLambda('sampleUid')).resolves.toBeUndefined();
+    await expect(NftUtils.invokeNftHandlerLambda('sampleUid', 'local', logger)).resolves.toBeUndefined();
   });
 
   it('should throw when payload response status is invalid', async () => {
@@ -263,14 +287,15 @@ describe('invokeNftHandlerLambda', () => {
     };
     (mLambdaClient.send as jest.Mocked<any>).mockImplementation(() => expectedLambdaResponse);
 
-    await expect(NftUtils.invokeNftHandlerLambda('sampleUid'))
+    await expect(NftUtils.invokeNftHandlerLambda('sampleUid', 'local', logger))
       .rejects.toThrow(new Error('onNewNftEvent lambda invoke failed for tx: sampleUid'));
 
     expect(mockedAddAlert).toHaveBeenCalledWith(
       'Error on NFTHandler lambda',
       'Erroed on invokeNftHandlerLambda invocation',
       Severity.MINOR,
       { TxId: 'sampleUid' },
+      logger,
     );
   });
 });

packages/common/jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  roots: ["<rootDir>/__tests__"],
+  testRegex: ".*\\.test\\.ts$",
+  moduleNameMapper: {
+    '^@src/(.*)$': '<rootDir>/src/$1',
+    '^@tests/(.*)$': '<rootDir>/__tests__/$1',
+    '^@events/(.*)$': '<rootDir>/__tests__/events/$1',
+  },
+  transform: {
+    "^.+\\.ts$": ["ts-jest", {
+      tsconfig: "./tsconfig.json",
+      babelConfig: {
+        sourceMaps: true,
+      }
+    }]
+  },
+  moduleFileExtensions: ["ts", "js", "json", "node"]
+};

packages/common/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@wallet-service/common",
+  "version": "1.5.0",
+  "packageManager": "[email protected]",
+  "scripts": {
+    "test": "jest --runInBand --collectCoverage --detectOpenHandles --forceExit"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-lambda": "3.540.0",
+    "@hathor/wallet-lib": "0.39.0",
+    "winston": "^3.13.0"
+  },
+  "devDependencies": {
+    "@types/aws-lambda": "^8.10.136",
+    "@types/node": "^20.11.30",
+    "jest": "^29.6.4",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.3"
+  }
+}