@avalabs/evm-module 0.0.22 → 0.1.0

package/src/handlers/eth-send-transaction/eth-send-transaction.test.ts

@@ -1,572 +0,0 @@
-import { ethSendTransaction } from './eth-send-transaction';
-import { parseRequestParams } from './schema';
-import { estimateGasLimit } from '../../utils/estimate-gas-limit';
-import { getNonce } from '../../utils/get-nonce';
-import { rpcErrors } from '@metamask/rpc-errors';
-import {
-  AlertType,
-  RpcMethod,
-  TokenType,
-  type ApprovalController,
-  type Network,
-  NetworkVMType,
-} from '@avalabs/vm-module-types';
-import { ZodError } from 'zod';
-import { getProvider } from '../../utils/get-provider';
-import Blockaid from '@blockaid/client';
-
-const mockGetProvider = getProvider as jest.MockedFunction<typeof getProvider>;
-
-const PROXY_API_URL = 'https://proxy-api.avax.network';
-
-jest.mock('./schema');
-jest.mock('../../utils/estimate-gas-limit');
-jest.mock('../../utils/get-nonce');
-jest.mock('../../utils/get-provider');
-jest.mock('@blockaid/client', () => {
-  return jest.fn().mockImplementation(() => {
-    return {
-      evm: {
-        transaction: {
-          scan: jest.fn().mockResolvedValue({ validation: { result_type: 'Benign' } }),
-        },
-        jsonRpc: {
-          scan: jest.fn(),
-        },
-      },
-    };
-  });
-});
-
-const mockOnTransactionConfirmed = jest.fn();
-const mockOnTransactionReverted = jest.fn();
-const mockApprovalController: jest.Mocked<ApprovalController> = {
-  requestApproval: jest.fn(),
-  onTransactionConfirmed: mockOnTransactionConfirmed,
-  onTransactionReverted: mockOnTransactionReverted,
-};
-
-const mockParseRequestParams = parseRequestParams as jest.MockedFunction<typeof parseRequestParams>;
-const mockEstimateGasLimit = estimateGasLimit as jest.MockedFunction<typeof estimateGasLimit>;
-const mockGetNonce = getNonce as jest.MockedFunction<typeof getNonce>;
-const mockSend = jest.fn();
-const mockWaitForTransaction = jest.fn();
-
-const mockProvider = {
-  send: mockSend,
-  waitForTransaction: mockWaitForTransaction,
-};
-
-// @ts-expect-error missing properties
-mockGetProvider.mockReturnValue(mockProvider);
-const testNetwork: Network = {
-  isTestnet: false,
-  chainId: 1,
-  chainName: 'chainName',
-  rpcUrl: 'rpcUrl',
-  logoUri: 'logoUri',
-  utilityAddresses: { multicall: 'multiContractAddress' },
-  networkToken: {
-    name: 'Ethereum',
-    symbol: 'ETH',
-    decimals: 9,
-    description: 'Ethereum Token',
-    logoUri: 'some logo uri',
-  },
-  vmName: NetworkVMType.EVM,
-};
-
-const testParams = { from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue', nonce: '12', gas: '0x5208' };
-
-const testRequestParams = () => ({
-  request: {
-    requestId: '1',
-    sessionId: '2',
-    method: RpcMethod.ETH_SEND_TRANSACTION,
-    chainId: 'eip155:1',
-    dappInfo: { url: 'https://example.com', name: 'dapp', icon: 'icon' },
-    params: [testParams],
-  },
-  network: testNetwork,
-  approvalController: mockApprovalController,
-  proxyApiUrl: PROXY_API_URL,
-});
-
-const displayData = {
-  title: 'Approve Transaction',
-  network: {
-    chainId: testNetwork.chainId,
-    name: testNetwork.chainName,
-    logoUri: testNetwork.logoUri,
-  },
-  transactionDetails: {
-    website: 'example.com',
-    from: '0xfrom',
-    to: '0xto',
-    data: '0xdata',
-  },
-  networkFeeSelector: true,
-  alert: undefined,
-  tokenApprovals: undefined,
-  balanceChange: undefined,
-};
-
-const signingData = {
-  type: 'eth_sendTransaction',
-  account: '0xfrom',
-  chainId: 1,
-  data: {
-    type: 2,
-    nonce: 12,
-    gasLimit: 21000,
-    to: '0xto',
-    from: '0xfrom',
-    data: '0xdata',
-    value: '0xvalue',
-  },
-};
-
-const testTxHash = '0xtxhash';
-
-describe('eth_sendTransaction handler', () => {
-  beforeEach(() => {
-    jest.clearAllMocks();
-
-    mockParseRequestParams.mockReturnValue({
-      success: true,
-      data: [testParams],
-    });
-
-    mockApprovalController.requestApproval.mockResolvedValue({ result: testTxHash });
-  });
-
-  it('should return error if request params are invalid', async () => {
-    mockParseRequestParams.mockReturnValue({
-      success: false,
-      error: new Error('Invalid params') as ZodError,
-    });
-
-    const response = await ethSendTransaction(testRequestParams());
-
-    expect(response).toEqual({
-      error: rpcErrors.invalidParams('Transaction params are invalid'),
-    });
-  });
-
-  it('should calculate gas limit if not provided', async () => {
-    mockParseRequestParams.mockReturnValue({
-      success: true,
-      data: [{ from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue', nonce: '12' }],
-    });
-    mockEstimateGasLimit.mockResolvedValue(21000);
-
-    const requestParams = testRequestParams();
-
-    await ethSendTransaction(requestParams);
-
-    expect(mockGetProvider).toHaveBeenCalledWith({
-      chainId: 1,
-      chainName: 'chainName',
-      rpcUrl: 'rpcUrl',
-      multiContractAddress: 'multiContractAddress',
-      pollingInterval: 1000,
-    });
-
-    expect(mockEstimateGasLimit).toHaveBeenCalledWith({
-      provider: mockProvider,
-      transactionParams: { from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue' },
-    });
-
-    expect(mockApprovalController.requestApproval).toHaveBeenCalledWith({
-      request: requestParams.request,
-      displayData,
-      signingData,
-    });
-  });
-
-  it('should calculate nonce if not provided', async () => {
-    mockParseRequestParams.mockReturnValue({
-      success: true,
-      data: [{ from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue', gas: '0x5208' }],
-    });
-    mockGetNonce.mockResolvedValue(12);
-
-    const requestParams = testRequestParams();
-    await ethSendTransaction(requestParams);
-
-    expect(mockGetProvider).toHaveBeenCalledWith({
-      chainId: 1,
-      chainName: 'chainName',
-      rpcUrl: 'rpcUrl',
-      multiContractAddress: 'multiContractAddress',
-      pollingInterval: 1000,
-    });
-
-    expect(mockGetNonce).toHaveBeenCalledWith({
-      provider: mockProvider,
-      from: '0xfrom',
-    });
-
-    expect(mockApprovalController.requestApproval).toHaveBeenCalledWith({
-      request: requestParams.request,
-      displayData,
-      signingData,
-    });
-  });
-
-  it('should calculate both gas and nonce if not provided', async () => {
-    mockParseRequestParams.mockReturnValue({
-      success: true,
-      data: [{ from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue' }],
-    });
-    mockGetNonce.mockResolvedValue(12);
-    mockEstimateGasLimit.mockResolvedValue(21000);
-
-    const requestParams = testRequestParams();
-    await ethSendTransaction(requestParams);
-
-    expect(mockGetProvider).toHaveBeenCalledWith({
-      chainId: 1,
-      chainName: 'chainName',
-      rpcUrl: 'rpcUrl',
-      multiContractAddress: 'multiContractAddress',
-      pollingInterval: 1000,
-    });
-
-    expect(mockGetNonce).toHaveBeenCalledWith({
-      provider: mockProvider,
-      from: '0xfrom',
-    });
-
-    expect(mockEstimateGasLimit).toHaveBeenCalledWith({
-      provider: mockProvider,
-      transactionParams: { from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue' },
-    });
-
-    expect(mockApprovalController.requestApproval).toHaveBeenCalledWith({
-      request: requestParams.request,
-      displayData,
-      signingData,
-    });
-  });
-
-  it('should add alert object with Warning type to displayData when validation result is Warning', async () => {
-    testWithValidationResultType('Warning');
-  });
-
-  it('should add alert object with Warning type to displayData when validation result is Error', async () => {
-    testWithValidationResultType('Error');
-  });
-
-  it('should add alert object with Danger type to displayData when validation result is Malicious', async () => {
-    testWithValidationResultType('Malicious');
-  });
-
-  it('should process transaction and add token approvals and balance changes to displayData', async () => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    (Blockaid as any).mockImplementation(() => ({
-      evm: {
-        transaction: {
-          scan: jest.fn().mockResolvedValue({
-            validation: { result_type: 'Benign' },
-            simulation: {
-              status: 'Success',
-              account_summary: {
-                exposures: [
-                  {
-                    asset: {
-                      type: TokenType.ERC20,
-                      address: '0xTokenAddress',
-                      name: 'TokenName',
-                      symbol: 'TKN',
-                      decimals: 18,
-                      logo_url: 'logo_url',
-                    },
-                    spenders: {
-                      '0xSpenderAddress': {
-                        exposure: [{ raw_value: '1', usd_price: '1' }],
-                      },
-                    },
-                  },
-                ],
-                assets_diffs: [
-                  {
-                    asset: {
-                      name: 'TokenName',
-                      symbol: 'TKN',
-                      decimals: 18,
-                      logo_url: 'logo_url',
-                      type: TokenType.ERC20,
-                      address: '0xTokenAddress',
-                    },
-                    in: [{ value: '1', usd_price: '1' }],
-                    out: [{ value: '1', usd_price: '1' }],
-                  },
-                ],
-              },
-            },
-          }),
-        },
-      },
-    }));
-
-    mockParseRequestParams.mockReturnValue({
-      success: true,
-      data: [{ from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue', nonce: '12', gas: '0x5208' }],
-    });
-
-    const requestParams = testRequestParams();
-
-    await ethSendTransaction(requestParams);
-
-    expect(mockGetProvider).toHaveBeenCalledWith({
-      chainId: 1,
-      chainName: 'chainName',
-      rpcUrl: 'rpcUrl',
-      multiContractAddress: 'multiContractAddress',
-      pollingInterval: 1000,
-    });
-
-    expect(mockApprovalController.requestApproval).toHaveBeenCalledWith({
-      request: requestParams.request,
-      displayData: {
-        ...displayData,
-        tokenApprovals: {
-          isEditable: true,
-          approvals: [
-            {
-              token: {
-                type: TokenType.ERC20,
-                address: '0xTokenAddress',
-                name: 'TokenName',
-                symbol: 'TKN',
-                decimals: 18,
-                logoUri: 'logo_url',
-              },
-              spenderAddress: '0xSpenderAddress',
-              value: '1',
-              usdPrice: '1',
-              logoUri: 'logo_url',
-            },
-          ],
-        },
-        balanceChange: {
-          ins: [
-            {
-              token: {
-                type: TokenType.ERC20,
-                address: '0xTokenAddress',
-                name: 'TokenName',
-                symbol: 'TKN',
-                decimals: 18,
-                logoUri: 'logo_url',
-              },
-              items: [
-                {
-                  displayValue: '1',
-                  usdPrice: '1',
-                },
-              ],
-            },
-          ],
-          outs: [
-            {
-              token: {
-                type: TokenType.ERC20,
-                address: '0xTokenAddress',
-                name: 'TokenName',
-                symbol: 'TKN',
-                decimals: 18,
-                logoUri: 'logo_url',
-              },
-              items: [
-                {
-                  displayValue: '1',
-                  usdPrice: '1',
-                },
-              ],
-            },
-          ],
-        },
-      },
-      signingData,
-    });
-  });
-
-  it('should return error if gas limit calculation fails', async () => {
-    mockParseRequestParams.mockReturnValue({
-      success: true,
-      data: [{ from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue', nonce: '12' }],
-    });
-
-    mockEstimateGasLimit.mockRejectedValue(new Error('gas calculation error'));
-
-    const requestParams = testRequestParams();
-    const response = await ethSendTransaction(requestParams);
-
-    expect(response).toEqual({
-      error: rpcErrors.internal('Unable to calculate gas limit'),
-    });
-  });
-
-  it('should return error if nonce calculation fails', async () => {
-    mockParseRequestParams.mockReturnValue({
-      success: true,
-      data: [{ from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue', gas: '0x5208' }],
-    });
-    mockGetNonce.mockRejectedValue(new Error('Nonce calculation error'));
-
-    const requestParams = testRequestParams();
-    const response = await ethSendTransaction(requestParams);
-
-    expect(response).toEqual({
-      error: rpcErrors.internal('Unable to calculate nonce'),
-    });
-  });
-
-  describe('approval succeeds', () => {
-    beforeEach(() => {
-      jest.clearAllMocks();
-
-      mockApprovalController.requestApproval.mockResolvedValue({ result: testTxHash });
-      mockSend.mockResolvedValue(testTxHash);
-    });
-
-    it('should broadcast the signed transaction and return transaction hash', async () => {
-      const requestParams = testRequestParams();
-      const response = await ethSendTransaction(requestParams);
-
-      expect(mockGetProvider).toHaveBeenCalledWith({
-        chainId: 1,
-        chainName: 'chainName',
-        rpcUrl: 'rpcUrl',
-        multiContractAddress: 'multiContractAddress',
-        pollingInterval: 1000,
-      });
-
-      expect(mockSend).toHaveBeenCalledWith('eth_sendRawTransaction', [testTxHash]);
-
-      expect(response).toStrictEqual({ result: testTxHash });
-    });
-
-    it('should notify when transaction is confirmed', async () => {
-      mockWaitForTransaction.mockResolvedValue({ status: 1 });
-
-      const requestParams = testRequestParams();
-      const response = await ethSendTransaction(requestParams);
-
-      expect(mockGetProvider).toHaveBeenCalledWith({
-        chainId: 1,
-        chainName: 'chainName',
-        rpcUrl: 'rpcUrl',
-        multiContractAddress: 'multiContractAddress',
-        pollingInterval: 1000,
-      });
-
-      expect(response).toStrictEqual({ result: testTxHash });
-
-      expect(mockWaitForTransaction).toHaveBeenCalledWith(testTxHash);
-
-      expect(mockOnTransactionConfirmed).toHaveBeenCalledWith(testTxHash);
-    });
-
-    it('should notify when transaction is reverted', async () => {
-      mockWaitForTransaction.mockResolvedValue({ status: 0 });
-
-      const requestParams = testRequestParams();
-      const response = await ethSendTransaction(requestParams);
-
-      expect(mockGetProvider).toHaveBeenCalledWith({
-        chainId: 1,
-        chainName: 'chainName',
-        rpcUrl: 'rpcUrl',
-        multiContractAddress: 'multiContractAddress',
-        pollingInterval: 1000,
-      });
-
-      expect(response).toStrictEqual({ result: testTxHash });
-
-      expect(mockWaitForTransaction).toHaveBeenCalledWith(testTxHash);
-
-      expect(mockOnTransactionReverted).toHaveBeenCalledWith(testTxHash);
-    });
-  });
-
-  describe('approval fails', () => {
-    it('should return error', async () => {
-      mockApprovalController.requestApproval.mockResolvedValue({ error: rpcErrors.internal('something went wrong') });
-
-      const requestParams = testRequestParams();
-      const response = await ethSendTransaction(requestParams);
-
-      expect(response).toStrictEqual({ error: rpcErrors.internal('something went wrong') });
-    });
-  });
-});
-
-const testWithValidationResultType = async (resultType: 'Warning' | 'Error' | 'Malicious') => {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  (Blockaid as any).mockImplementation(() => ({
-    evm: {
-      transaction: {
-        scan: jest.fn().mockResolvedValue({
-          validation: { result_type: resultType },
-          simulation: { status: 'Success', account_summary: { exposures: [], assets_diffs: [] } },
-        }),
-      },
-    },
-  }));
-
-  mockParseRequestParams.mockReturnValue({
-    success: true,
-    data: [{ from: '0xfrom', to: '0xto', data: '0xdata', value: '0xvalue', nonce: '12', gas: '0x5208' }],
-  });
-
-  const requestParams = testRequestParams();
-
-  await ethSendTransaction(requestParams);
-
-  expect(mockGetProvider).toHaveBeenCalledWith({
-    chainId: 1,
-    chainName: 'chainName',
-    rpcUrl: 'rpcUrl',
-    multiContractAddress: 'multiContractAddress',
-    pollingInterval: 1000,
-  });
-
-  if (resultType === 'Malicious') {
-    expect(mockApprovalController.requestApproval).toHaveBeenCalledWith({
-      request: requestParams.request,
-      displayData: {
-        ...displayData,
-        alert: {
-          type: AlertType.DANGER,
-          details: {
-            title: 'Scam Transaction',
-            description: 'This transaction is malicious, do not proceed.',
-            actionTitles: {
-              reject: 'Reject Transaction',
-              proceed: 'Proceed Anyway',
-            },
-          },
-        },
-      },
-      signingData,
-    });
-  } else {
-    expect(mockApprovalController.requestApproval).toHaveBeenCalledWith({
-      request: requestParams.request,
-      displayData: {
-        ...displayData,
-        alert: {
-          type: AlertType.WARNING,
-          details: {
-            title: 'Suspicious Transaction',
-            description: 'Use caution, this transaction may be malicious.',
-          },
-        },
-      },
-      signingData,
-    });
-  }
-};