@rosen-bridge/bitcoin-scanner 0.1.0-52fc0239

package/tests/mocked/axiosRpc.mock.ts

@@ -0,0 +1,28 @@
+import RateLimitedAxios from '@rosen-bridge/rate-limited-axios';
+import axios from '@rosen-bridge/rate-limited-axios';
+import { vi } from 'vitest';
+
+export const axiosInstance = {
+  get: vi.fn(),
+  post: vi.fn(),
+};
+
+/**
+ * mocks axios.get function
+ * @param result
+ */
+export const mockAxiosPost = (result: unknown) => {
+  axiosInstance.post.mockResolvedValueOnce({
+    data: result,
+  });
+};
+
+/**
+ * resets axios functions mocks and call counts
+ */
+export const resetAxiosMock = () => {
+  axiosInstance.post.mockReset();
+  vi.spyOn(axios, 'create').mockReturnValue(
+    axiosInstance as unknown as RateLimitedAxios
+  );
+};

package/tests/network/BitcoinRpcNetwork.spec.ts

@@ -0,0 +1,112 @@
+import {
+  axiosInstance,
+  mockAxiosPost,
+  resetAxiosMock,
+} from '../mocked/axiosRpc.mock';
+import * as testData from '../bitcoinRpcTestData';
+import { BitcoinRpcNetwork } from '../../lib/network/BitcoinRpcNetwork';
+
+describe('BitcoinRpcNetwork', () => {
+  let network: BitcoinRpcNetwork;
+
+  beforeEach(() => {
+    resetAxiosMock();
+    network = new BitcoinRpcNetwork('', 1);
+    network['generateRandomId'] = () =>
+      '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e';
+  });
+
+  describe('getBlockAtHeight', () => {
+    /**
+     * @target `BitcoinRpcNetwork.getBlockAtHeight` should return block info successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return block hash
+     * - mock axios to return block header
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected block info
+     * - axios.post should got called 2 times
+     *   - to get block hash with mocked block height
+     *   - to get block header with mocked block hash
+     */
+    it('should return block info successfully', async () => {
+      mockAxiosPost(testData.getBlockHashResponse);
+      mockAxiosPost(testData.getBlockHeaderResponse);
+
+      const result = await network.getBlockAtHeight(testData.blockHeight);
+
+      expect(result).toEqual(testData.block);
+      expect(axiosInstance.post).toHaveBeenCalledTimes(2);
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblockhash',
+        params: [testData.blockHeight],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblockheader',
+        params: [testData.blockHash, true],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+    });
+  });
+
+  describe('getCurrentHeight', () => {
+    /**
+     * @target `BitcoinRpcNetwork.getCurrentHeight` should return current height successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return blockchain info
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected height
+     * - axios.post should got called once to get chain info with no param
+     */
+    it('should return current height successfully', async () => {
+      mockAxiosPost(testData.getBlockchainInfoResponse);
+
+      const result = await network.getCurrentHeight();
+
+      expect(result).toEqual(testData.currentBlockHeight);
+      expect(axiosInstance.post).toHaveBeenCalledTimes(1);
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblockchaininfo',
+        params: [],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+    });
+  });
+
+  describe('getBlockTxs', () => {
+    /**
+     * @target `BitcoinRpcNetwork.getBlockTxs` should return block transactions successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return block header
+     * - mock axios to return block transactions 3 times (3 pages)
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected txs
+     * - axios.post should got called once to get block with mocked block hash and verbosity 2
+     */
+    it('should return block transactions successfully', async () => {
+      mockAxiosPost(testData.getBlockResponse);
+
+      const result = await network.getBlockTxs(testData.blockHash);
+
+      expect(result).toEqual(testData.getBlockResponse.result.tx);
+      expect(axiosInstance.post).toHaveBeenCalledTimes(1);
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblock',
+        params: [testData.blockHash, 2],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+    });
+  });
+});

package/tests/network/DogeRpcNetwork.spec.ts

@@ -0,0 +1,111 @@
+import {
+  axiosInstance,
+  mockAxiosPost,
+  resetAxiosMock,
+} from '../mocked/axiosRpc.mock';
+import * as testData from '../dogeRpcTestData';
+import { DogeRpcNetwork } from '../../lib/network/DogeRpcNetwork';
+
+describe('DogeRpcNetwork', () => {
+  let network: DogeRpcNetwork;
+
+  beforeEach(() => {
+    resetAxiosMock();
+    network = new DogeRpcNetwork('', 1);
+    network['generateRandomId'] = () =>
+      '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e';
+  });
+
+  describe('getBlockAtHeight', () => {
+    /**
+     * @target `DogeRpcNetwork.getBlockAtHeight` should return block info successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return block hash
+     * - mock axios to return block header
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected block info
+     * - axios.post should got called 2 times
+     *   - to get block hash with mocked block height
+     *   - to get block header with mocked block hash
+     */
+    it('should return block info successfully', async () => {
+      mockAxiosPost(testData.getBlockHashResponse);
+      mockAxiosPost(testData.getBlockSummaryResponse);
+
+      const result = await network.getBlockAtHeight(testData.blockHeight);
+
+      expect(result).toEqual(testData.block);
+      expect(axiosInstance.post).toHaveBeenCalledTimes(2);
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblockhash',
+        params: [testData.blockHeight],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblock',
+        params: [testData.blockHash, 1],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+    });
+  });
+
+  describe('getCurrentHeight', () => {
+    /**
+     * @target `DogeRpcNetwork.getCurrentHeight` should return current height successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return blockchain info
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected height
+     * - axios.post should got called once to get chain info with no param
+     */
+    it('should return current height successfully', async () => {
+      mockAxiosPost(testData.getBlockchainInfoResponse);
+
+      const result = await network.getCurrentHeight();
+
+      expect(result).toEqual(testData.currentBlockHeight);
+      expect(axiosInstance.post).toHaveBeenCalledTimes(1);
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblockchaininfo',
+        params: [],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+    });
+  });
+
+  describe('getBlockTxs', () => {
+    /**
+     * @target `DogeRpcNetwork.getBlockTxs` should return block transactions successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return block with transactions
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected txs
+     * - axios.post should got called once to get block with mocked block hash and verbosity 2
+     */
+    it('should return block transactions successfully', async () => {
+      mockAxiosPost(testData.getBlockResponse);
+
+      const result = await network.getBlockTxs(testData.blockHash);
+
+      expect(result).toEqual(testData.getBlockResponse.result.tx);
+      expect(axiosInstance.post).toHaveBeenCalledTimes(1);
+      expect(axiosInstance.post).toHaveBeenCalledWith('', {
+        method: 'getblock',
+        params: [testData.blockHash, 2],
+        id: '19774cdc6bc663926590dc2fe7bfe77ba57a5343aaa16db5ffc377e95663fd4e',
+      });
+    });
+  });
+});

package/tests/network/EsploraNetwork.spec.ts

@@ -0,0 +1,106 @@
+import {
+  axiosInstance,
+  mockAxiosGet,
+  resetAxiosMock,
+} from '../mocked/axiosEsplora.mock';
+import * as testData from '../bitcoinEsploraTestData';
+import { EsploraNetwork } from '../../lib/network/EsploraNetwork';
+
+describe('EsploraNetwork', () => {
+  let network: EsploraNetwork;
+
+  beforeEach(() => {
+    resetAxiosMock();
+    network = new EsploraNetwork('', 1);
+  });
+
+  describe('getBlockAtHeight', () => {
+    /**
+     * @target `EsploraNetwork.getBlockAtHeight` should return block info successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return block hash
+     * - mock axios to return block header
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected block info
+     * - axios.get should got called 2 times
+     *   - with mocked block height
+     *   - with mocked block hash
+     */
+    it('should return block info successfully', async () => {
+      mockAxiosGet(testData.blockHash);
+      mockAxiosGet(testData.blockResponse);
+
+      const result = await network.getBlockAtHeight(testData.blockHeight);
+
+      expect(result).toEqual(testData.block);
+      expect(axiosInstance.get).toHaveBeenCalledTimes(2);
+      expect(axiosInstance.get).toHaveBeenCalledWith(
+        expect.stringContaining(String(testData.blockHeight))
+      );
+      expect(axiosInstance.get).toHaveBeenCalledWith(
+        expect.stringContaining(testData.blockHash)
+      );
+    });
+  });
+
+  describe('getCurrentHeight', () => {
+    /**
+     * @target `EsploraNetwork.getCurrentHeight` should return current height successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return block height
+     * - run test
+     * - check returned value
+     * @expected
+     * - it should be expected height
+     */
+    it('should return current height successfully', async () => {
+      mockAxiosGet(testData.blockHeight);
+
+      const result = await network.getCurrentHeight();
+
+      expect(result).toEqual(testData.blockHeight);
+    });
+  });
+
+  describe('getBlockTxs', () => {
+    /**
+     * @target `EsploraNetwork.getBlockTxs` should return block transactions successfully
+     * @dependencies
+     * @scenario
+     * - mock axios to return block header
+     * - mock axios to return block transactions 3 times (3 pages)
+     * - run test
+     * - check returned value
+     * - check if function got called
+     * @expected
+     * - it should be expected height
+     * - axios.get should got called 3 times
+     *   - with mocked block hash and starting index 0
+     *   - with mocked block hash and starting index 25
+     */
+    it('should return block transactions successfully', async () => {
+      mockAxiosGet(testData.blockResponse);
+      mockAxiosGet(testData.blockTxsPage0);
+      mockAxiosGet(testData.blockTxsPage1);
+
+      const result = await network.getBlockTxs(testData.blockHash);
+
+      expect(result).toEqual([
+        ...testData.blockTxsPage0,
+        ...testData.blockTxsPage1,
+      ]);
+      expect(axiosInstance.get).toHaveBeenCalledTimes(3);
+      expect(axiosInstance.get).toHaveBeenCalledWith(
+        expect.stringContaining(`${testData.blockHash}/txs/0`)
+      );
+      expect(axiosInstance.get).toHaveBeenCalledWith(
+        expect.stringContaining(`${testData.blockHash}/txs/25`)
+      );
+    });
+  });
+});

package/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./lib"
+  },
+  "exclude": ["tests", "vitest.config.ts"],
+  "references": [
+    { "path": "../../abstract-scanner" },
+    { "path": "../../scanner-interfaces/tsconfig.build.json" }
+  ]
+}