@avalabs/evm-module 0.0.11 → 0.0.13

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

@@ -0,0 +1,240 @@
+import { parseRequestParams } from './schema';
+import { z } from 'zod';
+
+it('should return success for valid params', () => {
+  const paramsList = [
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+      },
+    ],
+  ];
+
+  for (const params of paramsList) {
+    const result = parseRequestParams(params);
+
+    expect(result.success).toBe(true);
+    expect(result.data).toEqual(params);
+  }
+});
+
+it('should return error for invalid params', () => {
+  const paramsList = [
+    // missing "from"
+    [
+      {
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // invalid "from"
+    [
+      {
+        from: '0x123',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // missing "to"
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // invalid "to"
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x123',
+        data: '0xdata',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // non-hex "value"
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: 'value',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // non-hex "gas"
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0x5208',
+        gas: 'gas',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // non-hex "gasPrice"
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0x5208',
+        gas: '0x5208',
+        gasPrice: 'gasPrice',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // non-hex "maxFeePerGas"
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0x5208',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: 'maxFeePerGas',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // non-hex "maxPriorityFeePerGas"
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0x5208',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: 'maxPriorityFeePerGas',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+    // multiple transactions
+    [
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+      {
+        from: '0x1234567890123456789012345678901234567890',
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xdata',
+        value: '0xvalue',
+        gas: '0x5208',
+        gasPrice: '0x5208',
+        maxFeePerGas: '0x5208',
+        maxPriorityFeePerGas: '0x5208',
+        nonce: '12',
+        chainId: '1',
+      },
+    ],
+  ];
+
+  for (const params of paramsList) {
+    const result = parseRequestParams([params]);
+    expect(result.success).toBe(false);
+    expect(result.error).toBeInstanceOf(z.ZodError);
+  }
+});

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

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+
+const transactionSchema = z.object({
+  from: z.string().length(42),
+  to: z.string().length(42),
+  data: z.string().optional(),
+  value: z.string().startsWith('0x').optional(),
+  gas: z.string().startsWith('0x').optional(),
+  gasPrice: z.string().startsWith('0x').optional(),
+  maxFeePerGas: z.string().startsWith('0x').optional(),
+  maxPriorityFeePerGas: z.string().startsWith('0x').optional(),
+  nonce: z.string().optional(),
+  chainId: z.string().optional(),
+});
+
+const paramsSchema = z.array(transactionSchema).length(1);
+
+export const parseRequestParams = (params: unknown) => {
+  return paramsSchema.safeParse(params);
+};

package/src/handlers/get-network-fee/get-network-fee.test.ts

@@ -3,7 +3,7 @@ import { FeeData, JsonRpcProvider } from 'ethers';
 
 const params = {
   glacierApiUrl: 'https://glacier-api.avax.network',
-  chainId: 'eip155:1',
+  chainId: 1,
   chainName: 'Ethereum Mainnet',
   rpcUrl: 'https://mainnet.infura.io/v3/1234567890',
 };
@@ -38,6 +38,7 @@ describe('get-network-fee', () => {
         maxFeePerGas: 4000000000n,
         maxPriorityFeePerGas: 3000000000n,
       },
+      isFixedFee: false,
     });
   });
 });

package/src/handlers/get-network-fee/get-network-fee.ts

@@ -1,5 +1,6 @@
-import type { GetNetworkFeeParams, NetworkFees } from '@avalabs/vm-module-types';
+import type { NetworkFees } from '@avalabs/vm-module-types';
 import { getProvider } from '../../utils/get-provider';
+import { rpcErrors } from '@metamask/rpc-errors';
 
 const DEFAULT_PRESETS = {
   LOW: 1n,
@@ -11,33 +12,30 @@ const BASE_PRIORITY_FEE_WEI = 500000000n; //0.5 GWei
 
 /**
  * Returns {@link NetworkFees} based on {@link DEFAULT_PRESETS} multipliers.
- * @param glacierApiUrl
- * @param glacierApiKey
- * @params GetNetworkFeeParams
  * @throws Error if provider does not support eip-1559
  */
 export async function getNetworkFee({
-  glacierApiUrl,
-  glacierApiKey,
   chainId,
   chainName,
   rpcUrl,
   multiContractAddress,
-}: GetNetworkFeeParams & {
+}: {
+  chainId: number;
+  chainName: string;
+  rpcUrl: string;
   glacierApiUrl: string;
-  glacierApiKey?: string;
+  multiContractAddress?: string;
 }): Promise<NetworkFees> {
   const provider = getProvider({
-    glacierApiUrl,
-    glacierApiKey,
     chainId,
     chainName,
     rpcUrl,
     multiContractAddress,
   });
+
   const { maxFeePerGas: maxFeePerGasInWei } = await provider.getFeeData();
   if (!maxFeePerGasInWei) {
-    throw new Error('Pre-EIP-1559 networks are not supported');
+    throw rpcErrors.internal('Pre-EIP-1559 networks are not supported');
   }
 
   const lowMaxTip = BASE_PRIORITY_FEE_WEI * DEFAULT_PRESETS.LOW;
@@ -57,5 +55,6 @@ export async function getNetworkFee({
       maxFeePerGas: maxFeePerGasInWei + highMaxTip,
       maxPriorityFeePerGas: highMaxTip,
     },
+    isFixedFee: false,
   };
 }

package/src/handlers/get-tokens/get-tokens.ts

@@ -1,4 +1,5 @@
 import type { NetworkContractToken } from '@avalabs/vm-module-types';
+import { rpcErrors } from '@metamask/rpc-errors';
 
 export async function getTokens({
   chainId,
@@ -10,7 +11,7 @@ export async function getTokens({
   const response = await fetch(`${proxyApiUrl}/tokens?evmChainId=${chainId}`);
 
   if (!response.ok) {
-    throw new Error(`Failed to fetch tokens for chainId ${chainId}`);
+    throw rpcErrors.internal(`Failed to fetch tokens for chainId ${chainId}`);
   }
 
   return response.json();

package/src/handlers/get-transaction-history/converters/etherscan-transaction-converter/get-transaction-from-etherscan.ts

@@ -1,6 +1,6 @@
 import { convertTransactionNormal } from './convert-transaction-normal';
 import { convertTransactionERC20 } from './convert-transaction-erc20';
-import type { GetTransactionHistory, TransactionHistoryResponse } from '@avalabs/vm-module-types';
+import type { NetworkToken, TransactionHistoryResponse } from '@avalabs/vm-module-types';
 import { getErc20Txs, getNormalTxs } from '@avalabs/etherscan-sdk';
 
 interface EtherscanPagination {
@@ -10,13 +10,21 @@ interface EtherscanPagination {
 
 export const getTransactionFromEtherscan = async ({
   isTestnet,
-  chainId,
   networkToken,
   explorerUrl,
+  chainId,
   address,
   nextPageToken,
   offset,
-}: GetTransactionHistory): Promise<TransactionHistoryResponse> => {
+}: {
+  isTestnet?: boolean;
+  networkToken: NetworkToken;
+  explorerUrl: string;
+  chainId: number;
+  address: string;
+  nextPageToken?: string;
+  offset?: number;
+}): Promise<TransactionHistoryResponse> => {
   /*
   Using JSON for nextPageToken because this function is managing both the Normal
   and ERC20 queries. It encodes the current page and the queries that should be

package/src/handlers/get-transaction-history/converters/evm-transaction-converter/get-transaction-from-glacier.test.ts

@@ -46,7 +46,6 @@ describe('get-transactions-from-glacier', () => {
   it('should have returned error with missing glacier api url', async () => {
     try {
       await getTransactionsFromGlacier({
-        isTestnet: false,
         networkToken: {
           name: 'networkToken',
           symbol: 'networkToken',
@@ -59,6 +58,7 @@ describe('get-transactions-from-glacier', () => {
         address: 'address',
         nextPageToken: 'nextPageToken',
         offset: 1,
+        glacierApiUrl: 'glacierApiUrl',
       });
     } catch (error) {
       expect(error).toEqual(new Error('Glacier API URL is required'));
@@ -67,7 +67,6 @@ describe('get-transactions-from-glacier', () => {
   it('should have returned empty response when listTransaction failed', async () => {
     mockListTransactions.mockRejectedValue(new Error('failed to list transactions'));
     const result = await getTransactionsFromGlacier({
-      isTestnet: false,
       networkToken: {
         name: 'networkToken',
         symbol: 'networkToken',
@@ -101,7 +100,6 @@ describe('get-transactions-from-glacier', () => {
       ],
     });
     const result = await getTransactionsFromGlacier({
-      isTestnet: false,
       networkToken: {
         name: 'networkToken',
         symbol: 'networkToken',
@@ -135,7 +133,6 @@ describe('get-transactions-from-glacier', () => {
       ],
     });
     const result = await getTransactionsFromGlacier({
-      isTestnet: false,
       networkToken: {
         name: 'networkToken',
         symbol: 'networkToken',
@@ -159,7 +156,6 @@ describe('get-transactions-from-glacier', () => {
   it('should have returned response', async () => {
     mockListTransactions.mockResolvedValue(mockListTransactionDetailsResponse);
     const result = await getTransactionsFromGlacier({
-      isTestnet: false,
       networkToken: {
         name: 'networkToken',
         symbol: 'networkToken',

package/src/handlers/get-transaction-history/converters/evm-transaction-converter/get-transactions-from-glacier.ts

@@ -1,5 +1,6 @@
-import type { GetTransactionHistory, TransactionHistoryResponse } from '@avalabs/vm-module-types';
+import type { NetworkToken, TransactionHistoryResponse } from '@avalabs/vm-module-types';
 import { Glacier } from '@avalabs/glacier-sdk';
+import { rpcErrors } from '@metamask/rpc-errors';
 import { convertTransaction } from './convert-transaction';
 
 export const getTransactionsFromGlacier = async ({
@@ -10,9 +11,17 @@ export const getTransactionsFromGlacier = async ({
   nextPageToken,
   offset,
   glacierApiUrl,
-}: GetTransactionHistory): Promise<TransactionHistoryResponse> => {
+}: {
+  chainId: number;
+  explorerUrl: string;
+  networkToken: NetworkToken;
+  address: string;
+  nextPageToken?: string;
+  offset?: number;
+  glacierApiUrl: string;
+}): Promise<TransactionHistoryResponse> => {
   if (!glacierApiUrl) {
-    throw new Error('Glacier API URL is required');
+    throw rpcErrors.invalidParams('Glacier API URL is required');
   }
 
   const glacierSdk = new Glacier({ BASE: glacierApiUrl });

package/src/handlers/get-transaction-history/get-transaction-history.test.ts

@@ -13,6 +13,7 @@ jest.mock('./converters/etherscan-transaction-converter/get-transaction-from-eth
 describe('get-transaction-history', () => {
   it('should have called getTransactionFromEtherscan', async () => {
     await getTransactionHistory({
+      glacierApiUrl: 'glacierApiUrl',
       chainId: 1,
       isTestnet: false,
       networkToken: {
@@ -31,6 +32,7 @@ describe('get-transaction-history', () => {
   });
   it('should have called getTransactionsFromGlacier', async () => {
     await getTransactionHistory({
+      glacierApiUrl: 'glacierApiUrl',
       chainId: 41334,
       isTestnet: false,
       networkToken: {

package/src/handlers/get-transaction-history/get-transaction-history.ts

@@ -1,6 +1,6 @@
 import { getTransactionFromEtherscan } from './converters/etherscan-transaction-converter/get-transaction-from-etherscan';
 import { isEthereumChainId } from './utils/is-ethereum-chain-id';
-import type { GetTransactionHistory, TransactionHistoryResponse } from '@avalabs/vm-module-types';
+import type { NetworkToken, TransactionHistoryResponse } from '@avalabs/vm-module-types';
 import { getTransactionsFromGlacier } from './converters/evm-transaction-converter/get-transactions-from-glacier';
 
 export const getTransactionHistory = async ({
@@ -12,7 +12,16 @@ export const getTransactionHistory = async ({
   nextPageToken,
   offset,
   glacierApiUrl,
-}: GetTransactionHistory): Promise<TransactionHistoryResponse> => {
+}: {
+  chainId: number;
+  isTestnet?: boolean;
+  networkToken: NetworkToken;
+  explorerUrl: string;
+  address: string;
+  nextPageToken?: string;
+  offset?: number;
+  glacierApiUrl: string;
+}): Promise<TransactionHistoryResponse> => {
   if (isEthereumChainId(chainId)) {
     return getTransactionFromEtherscan({
       isTestnet,
@@ -25,7 +34,6 @@ export const getTransactionHistory = async ({
     });
   }
   return getTransactionsFromGlacier({
-    isTestnet,
     networkToken,
     explorerUrl,
     chainId,

package/src/index.ts

@@ -1,72 +1,2 @@
-import type {
-  Module,
-  Manifest,
-  NetworkFees,
-  GetTransactionHistory,
-  RpcRequest,
-  GetNetworkFeeParams,
-} from '@avalabs/vm-module-types';
-import { parseManifest } from '@avalabs/vm-module-types';
-import { getNetworkFee } from './handlers/get-network-fee/get-network-fee';
-import { getTransactionHistory } from './handlers/get-transaction-history/get-transaction-history';
-import { getTokens } from './handlers/get-tokens/get-tokens';
-import ManifestJson from './manifest.json';
-
-export class EvmModule implements Module {
-  #glacierApiUrl: string;
-  #glacierApiKey?: string;
-  #proxyApiUrl: string;
-
-  constructor({
-    glacierApiUrl,
-    glacierApiKey,
-    proxyApiUrl,
-  }: {
-    glacierApiUrl: string;
-    glacierApiKey?: string;
-    proxyApiUrl: string;
-  }) {
-    this.#glacierApiUrl = glacierApiUrl;
-    this.#glacierApiKey = glacierApiKey;
-    this.#proxyApiUrl = proxyApiUrl;
-  }
-  getAddress(): Promise<string> {
-    return Promise.resolve('EVM address');
-  }
-
-  getBalances(): Promise<string> {
-    return Promise.resolve('EVM balances');
-  }
-
-  getManifest(): Manifest | undefined {
-    const result = parseManifest(ManifestJson);
-    return result.success ? result.data : undefined;
-  }
-
-  getNetworkFee({ chainId, chainName, rpcUrl, multiContractAddress }: GetNetworkFeeParams): Promise<NetworkFees> {
-    return getNetworkFee({
-      glacierApiUrl: this.#glacierApiUrl,
-      glacierApiKey: this.#glacierApiKey,
-      chainId,
-      chainName,
-      rpcUrl,
-      multiContractAddress,
-    });
-  }
-
-  getTransactionHistory(params: GetTransactionHistory) {
-    return getTransactionHistory({ ...params, glacierApiUrl: this.#glacierApiUrl });
-  }
-
-  getTokens(chainId: number) {
-    return getTokens({ chainId, proxyApiUrl: this.#proxyApiUrl });
-  }
-
-  async onRpcRequest(request: RpcRequest) {
-    // TODO implement the RPC request handler
-    switch (request.method) {
-      default:
-        return { error: new Error(`Method ${request.method} not supported`) };
-    }
-  }
-}
+export * from './module';
+export * from './types';

package/src/module.ts

@@ -0,0 +1,95 @@
+import type {
+  Module,
+  Manifest,
+  NetworkFees,
+  GetTransactionHistory,
+  RpcRequest,
+  Environment,
+  Network,
+  ApprovalController,
+} from '@avalabs/vm-module-types';
+import { rpcErrors } from '@metamask/rpc-errors';
+import { RpcMethod, parseManifest } from '@avalabs/vm-module-types';
+import { getTokens } from './handlers/get-tokens/get-tokens';
+import { getNetworkFee } from './handlers/get-network-fee/get-network-fee';
+import { getTransactionHistory } from './handlers/get-transaction-history/get-transaction-history';
+import ManifestJson from '../manifest.json';
+import { getEnv } from './env';
+import { ethSendTransaction } from './handlers/eth-send-transaction/eth-send-transaction';
+
+export class EvmModule implements Module {
+  #glacierApiUrl: string;
+  #proxyApiUrl: string;
+  #approvalController: ApprovalController;
+
+  constructor({
+    approvalController,
+    environment,
+  }: {
+    approvalController: ApprovalController;
+    environment: Environment;
+  }) {
+    const { glacierApiUrl, proxyApiUrl } = getEnv(environment);
+    this.#glacierApiUrl = glacierApiUrl;
+    this.#proxyApiUrl = proxyApiUrl;
+    this.#approvalController = approvalController;
+  }
+
+  getAddress(): Promise<string> {
+    return Promise.resolve('EVM address');
+  }
+
+  getBalances(): Promise<string> {
+    return Promise.resolve('EVM balances');
+  }
+
+  getManifest(): Manifest | undefined {
+    const result = parseManifest(ManifestJson);
+    return result.success ? result.data : undefined;
+  }
+
+  getNetworkFee(network: Network): Promise<NetworkFees> {
+    const { chainId, chainName, rpcUrl, utilityAddresses } = network;
+    return getNetworkFee({
+      chainId,
+      chainName,
+      rpcUrl,
+      multiContractAddress: utilityAddresses?.multicall,
+      glacierApiUrl: this.#glacierApiUrl,
+    });
+  }
+
+  getTransactionHistory(params: GetTransactionHistory) {
+    const { network, address, nextPageToken, offset } = params;
+    const { chainId, isTestnet, networkToken, explorerUrl = '' } = network;
+
+    return getTransactionHistory({
+      chainId,
+      isTestnet,
+      networkToken,
+      explorerUrl,
+      address,
+      nextPageToken,
+      offset,
+      glacierApiUrl: this.#glacierApiUrl,
+    });
+  }
+
+  getTokens(network: Network) {
+    const { chainId } = network;
+    return getTokens({ chainId, proxyApiUrl: this.#proxyApiUrl });
+  }
+
+  async onRpcRequest(request: RpcRequest, network: Network) {
+    switch (request.method) {
+      case RpcMethod.ETH_SEND_TRANSACTION:
+        return ethSendTransaction({
+          request,
+          network,
+          approvalController: this.#approvalController,
+        });
+      default:
+        return { error: rpcErrors.methodNotSupported(`Method ${request.method} not supported`) };
+    }
+  }
+}

package/src/types.ts

@@ -1,3 +1,16 @@
 import { TransactionType } from '@avalabs/vm-module-types';
 
 export const NonContractCallTypes = [TransactionType.SEND, TransactionType.RECEIVE, TransactionType.TRANSFER];
+
+export type TransactionParams = {
+  from: string;
+  to: string;
+  data?: string;
+  value?: string;
+  gas?: string;
+  gasPrice?: string;
+  maxFeePerGas?: string;
+  maxPriorityFeePerGas?: string;
+  nonce?: string;
+  chainId?: string;
+};