@avalabs/evm-module 0.0.16 → 0.0.18

package/src/handlers/eth-sign/eth-sign.ts

@@ -5,7 +5,8 @@ import {
   type DisplayData,
   type RpcRequest,
   RpcMethod,
-  BannerType,
+  type Alert,
+  AlertType,
 } from '@avalabs/vm-module-types';
 import { rpcErrors } from '@metamask/rpc-errors';
 import { toUtf8String } from 'ethers';
@@ -13,15 +14,18 @@ import { beautifySimpleMessage, beautifyComplexMessage } from './utils/beautify-
 import { parseRequestParams } from './schemas/parse-request-params/parse-request-params';
 import { isTypedDataV1 } from './utils/typeguards';
 import { isTypedDataValid } from './utils/is-typed-data-valid';
+import { processJsonRpcSimulation } from '../../utils/process-transaction-simulation';
 
 export const ethSign = async ({
   request,
   network,
   approvalController,
+  proxyApiUrl,
 }: {
   request: RpcRequest;
   network: Network;
   approvalController: ApprovalController;
+  proxyApiUrl: string;
 }) => {
   const result = parseRequestParams({ method: request.method, params: request.params });
 
@@ -46,14 +50,16 @@ export const ethSign = async ({
   let signingData: SigningData | undefined;
   let messageDetails: string | undefined;
   let disclaimer: string | undefined;
-  let banner: DisplayData['banner'] | undefined;
+  let alert: Alert | undefined;
 
   if (typedDataValidationResult && !typedDataValidationResult.isValid) {
-    banner = {
-      type: BannerType.WARNING,
-      title: 'Warning: Verify Message Content',
-      description: 'This message contains non-standard elements.',
-      detailedDescription: (typedDataValidationResult.error as Error).toString(),
+    alert = {
+      type: AlertType.INFO,
+      details: {
+        title: 'Warning: Verify Message Content',
+        description: 'This message contains non-standard elements.',
+        detailedDescription: (typedDataValidationResult.error as Error).toString(),
+      },
     };
   }
 
@@ -106,8 +112,20 @@ export const ethSign = async ({
     };
   }
 
+  const {
+    alert: prioritizedAlert,
+    balanceChange,
+    tokenApprovals,
+  } = await processJsonRpcSimulation({
+    request,
+    proxyApiUrl,
+    accountAddress: address,
+    chainId: network.chainId,
+    data: { method, params: request.params },
+    dAppUrl: request.dappInfo.url,
+  });
+
   const displayData: DisplayData = {
-    banner,
     title: 'Sign Message',
     dAppInfo: {
       name: request.dappInfo.name,
@@ -122,6 +140,9 @@ export const ethSign = async ({
     account: address,
     messageDetails,
     disclaimer,
+    alert: prioritizedAlert ?? alert,
+    balanceChange,
+    tokenApprovals,
   };
 
   // prompt user for approval

package/src/handlers/get-balances/evm-balance-service/get-erc20-balances.test.ts

@@ -1,6 +1,7 @@
 import { BN } from 'bn.js';
 import { getErc20Balances } from './get-erc20-balances';
 import { ethers } from 'ethers';
+import { TokenType } from '@avalabs/vm-module-types';
 
 describe('get-erc20-balances', () => {
   it('should return erc20 token balances', async () => {
@@ -18,7 +19,7 @@ describe('get-erc20-balances', () => {
           symbol: 'ETH',
           decimals: 18,
           logoUri: 'https://example.com/logo.png',
-          contractType: 'ERC-20',
+          type: TokenType.ERC20,
         },
       ],
       provider: {
@@ -67,7 +68,6 @@ describe('get-erc20-balances', () => {
         balanceDisplayValue: '1',
         balanceInCurrency: 1000,
         priceInCurrency: 1000,
-        contractType: 'ERC-20',
         type: 'ERC20',
         change24: 0,
         marketCap: 0,

package/src/handlers/get-balances/evm-balance-service/get-erc20-balances.ts

@@ -1,13 +1,11 @@
 import { numberToBN, bnToBig, balanceToDisplayValue } from '@avalabs/utils-sdk';
-import { TokenType, type Network, type NetworkContractToken, type TokenWithBalance } from '@avalabs/vm-module-types';
+import { TokenType, type ERC20Token, type Network, type TokenWithBalance } from '@avalabs/vm-module-types';
 import { ethers, type Provider } from 'ethers';
 import ERC20 from '@openzeppelin/contracts/build/contracts/ERC20.json';
 import type { TokenService } from '@internal/utils';
 import { VsCurrencyType } from '@avalabs/coingecko-sdk';
 import BN from 'bn.js';
 
-const DEFAULT_DECIMALS = 18;
-
 export const getErc20Balances = async ({
   provider,
   tokenService,
@@ -20,7 +18,7 @@ export const getErc20Balances = async ({
   tokenService: TokenService;
   address: string;
   currency: string;
-  tokens: NetworkContractToken[];
+  tokens: ERC20Token[];
   network: Network;
 }): Promise<Record<string, TokenWithBalance>> => {
   const coingeckoPlatformId = network.pricingProviders?.coingecko.assetPlatformId;
@@ -31,7 +29,7 @@ export const getErc20Balances = async ({
     tokens.map(async (token) => {
       const contract = new ethers.Contract(token.address, ERC20.abi, provider);
       const balanceBig = await contract.balanceOf?.(userAddress);
-      const balance = new BN(balanceBig) || numberToBN(0, token.decimals || DEFAULT_DECIMALS);
+      const balance = new BN(balanceBig) || numberToBN(0, token.decimals);
 
       const tokenWithBalance = {
         ...token,
@@ -41,7 +39,7 @@ export const getErc20Balances = async ({
       return tokenWithBalance;
     }),
   ).then((res) => {
-    return res.reduce<(NetworkContractToken & { balance: BN })[]>((acc, result) => {
+    return res.reduce<(ERC20Token & { balance: BN })[]>((acc, result) => {
       return result.status === 'fulfilled' && !result.value.balance.isZero() ? [...acc, result.value] : acc;
     }, []);
   });

package/src/handlers/get-balances/get-balances.test.ts

@@ -48,7 +48,6 @@ describe('get-balances', () => {
           balanceDisplayValue: '1',
           balanceInCurrency: 1,
           priceInCurrency: 1,
-          contractType: 'ERC-20',
           type: TokenType.ERC20,
           change24: 0,
           marketCap: 0,
@@ -89,7 +88,6 @@ describe('get-balances', () => {
           balanceInCurrency: 1,
           chainId: 1,
           change24: 0,
-          contractType: 'ERC-20',
           decimals: 18,
           logoUri: 'https://s3.us-east-2.amazonaws.com/nomics-api/static/images/currencies/dai.svg',
           marketCap: 0,
@@ -138,7 +136,6 @@ describe('get-balances', () => {
               symbol: 'DAI2',
               decimals: 18,
               logoUri: 'https://s3.us-east-2.amazonaws.com/nomics-api/static/images/currencies/dai.svg',
-              contractType: 'ERC-20',
               type: TokenType.ERC20,
             },
           ]),
@@ -178,7 +175,6 @@ describe('get-balances', () => {
           balanceDisplayValue: '1',
           balanceInCurrency: 1,
           priceInCurrency: 1,
-          contractType: 'ERC-20',
           type: TokenType.ERC20,
           change24: 0,
           marketCap: 0,
@@ -219,7 +215,6 @@ describe('get-balances', () => {
           balanceInCurrency: 1,
           chainId: 2,
           change24: 0,
-          contractType: 'ERC-20',
           decimals: 18,
           logoUri: 'https://s3.us-east-2.amazonaws.com/nomics-api/static/images/currencies/dai.svg',
           marketCap: 0,

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

@@ -1,4 +1,11 @@
-import type { GetBalancesResponse, GetBalancesParams, Storage } from '@avalabs/vm-module-types';
+import {
+  type GetBalancesResponse,
+  type GetBalancesParams,
+  type Storage,
+  TokenType,
+  type NetworkContractToken,
+  type ERC20Token,
+} from '@avalabs/vm-module-types';
 import { getErc20Balances } from './evm-balance-service/get-erc20-balances';
 import { TokenService } from '@internal/utils';
 import { getProvider } from '../../utils/get-provider';
@@ -37,7 +44,7 @@ export const getBalances = async ({
         });
 
         const erc20Tokens = await getErc20BalancesFromGlacier({
-          customTokens,
+          customTokens: customTokens.filter(isERC20Token),
           glacierService,
           currency,
           chainId,
@@ -80,7 +87,7 @@ export const getBalances = async ({
           tokenService,
           address,
           currency,
-          tokens: allTokens,
+          tokens: allTokens.filter(isERC20Token),
         });
 
         return {
@@ -107,3 +114,7 @@ export const getBalances = async ({
 
   return filterBalances;
 };
+
+function isERC20Token(token: NetworkContractToken): token is ERC20Token {
+  return token.type === TokenType.ERC20;
+}

package/src/handlers/get-balances/glacier-balance-service/get-erc20-balances.test.ts

@@ -50,7 +50,6 @@ describe('get-erc20-balances', () => {
         balanceDisplayValue: '1',
         balanceInCurrency: 1000,
         priceInCurrency: 1000,
-        contractType: 'ERC-20',
         type: 'ERC20',
         change24: 0,
         marketCap: 0,

package/src/handlers/get-balances/glacier-balance-service/get-erc20-balances.ts

@@ -2,12 +2,13 @@ import { balanceToDisplayValue, bnToBig } from '@avalabs/utils-sdk';
 import {
   TokenType,
   type TokenWithBalanceERC20,
-  type NetworkContractToken,
   type TokenWithBalance,
+  type ERC20Token,
 } from '@avalabs/vm-module-types';
 import { CurrencyCode, Erc20TokenBalance } from '@avalabs/glacier-sdk';
 import BN from 'bn.js';
 import type { EvmGlacierService } from '../../../services/glacier-service/glacier-service';
+import { DEFAULT_DECIMALS } from '../../../constants';
 
 export const getErc20Balances = async ({
   glacierService,
@@ -20,7 +21,7 @@ export const getErc20Balances = async ({
   address: string;
   currency: string;
   chainId: number;
-  customTokens: NetworkContractToken[];
+  customTokens: ERC20Token[];
 }): Promise<Record<string, TokenWithBalance>> => {
   const tokensWithBalance: TokenWithBalanceERC20[] = [];
   /**
@@ -37,7 +38,9 @@ export const getErc20Balances = async ({
       pageToken: nextPageToken,
     });
 
-    tokensWithBalance.push(...convertErc20ToTokenWithBalance(response.erc20TokenBalances, Number(chainId)));
+    tokensWithBalance.push(
+      ...convertErc20TokenWithBalanceToTokenWithBalance(response.erc20TokenBalances, Number(chainId)),
+    );
     nextPageToken = response.nextPageToken;
   } while (nextPageToken);
 
@@ -47,7 +50,7 @@ export const getErc20Balances = async ({
    * tokens are only used for swap, bridge and tx parsing.
    */
   return [
-    ...convertNetworkTokenToTokenWithBalance(customTokens),
+    ...convertErc20TokenToTokenWithBalance(customTokens),
     ...tokensWithBalance, // this needs to be second in the list so it overwrites its zero balance counterpart if there is one
   ].reduce(
     (acc, token) => {
@@ -57,10 +60,11 @@ export const getErc20Balances = async ({
   );
 };
 
-const convertNetworkTokenToTokenWithBalance = (tokens: NetworkContractToken[]): TokenWithBalanceERC20[] => {
+const convertErc20TokenToTokenWithBalance = (tokens: ERC20Token[]): TokenWithBalanceERC20[] => {
   return tokens.map((token) => {
     return {
       ...token,
+      decimals: token.decimals ?? DEFAULT_DECIMALS,
       type: TokenType.ERC20,
       balance: new BN(0),
       balanceInCurrency: 0,
@@ -74,7 +78,7 @@ const convertNetworkTokenToTokenWithBalance = (tokens: NetworkContractToken[]):
   });
 };
 
-const convertErc20ToTokenWithBalance = (
+const convertErc20TokenWithBalanceToTokenWithBalance = (
   tokenBalances: Erc20TokenBalance[],
   chainId: number,
 ): TokenWithBalanceERC20[] => {
@@ -97,7 +101,6 @@ const convertErc20ToTokenWithBalance = (
       balanceDisplayValue,
       balanceInCurrency,
       priceInCurrency,
-      contractType: 'ERC-20',
       type: TokenType.ERC20,
       change24: 0,
       marketCap: 0,

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

@@ -28,7 +28,7 @@ describe('get-tokens', () => {
           address: '0xB31f66AA3C1e785363F0875A1B74E27b85FD66c7',
           name: 'Wrapped AVAX',
           symbol: 'WAVAX',
-          contractType: 'ERC-20',
+          type: 'ERC20',
           chainId: 43114,
           decimals: 18,
         },
@@ -36,7 +36,7 @@ describe('get-tokens', () => {
           address: '0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E',
           name: 'USD Coin',
           symbol: 'USDC',
-          contractType: 'ERC-20',
+          type: 'ERC20',
           chainId: 43114,
           decimals: 6,
         },
@@ -58,7 +58,7 @@ describe('get-tokens', () => {
           address: '0xdAC17F958D2ee523a2206206994597C13D831ec7',
           name: 'Tether USD',
           symbol: 'USDT',
-          contractType: 'ERC-20',
+          type: 'ERC20',
           chainId: 1,
           decimals: 6,
         },
@@ -66,7 +66,7 @@ describe('get-tokens', () => {
           address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
           name: 'USDCoin',
           symbol: 'USDC',
-          contractType: 'ERC-20',
+          type: 'ERC20',
           chainId: 1,
           decimals: 6,
         },
@@ -74,7 +74,7 @@ describe('get-tokens', () => {
           address: '0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599',
           name: 'Wrapped BTC',
           symbol: 'WBTC',
-          contractType: 'ERC-20',
+          type: 'ERC20',
           chainId: 1,
           decimals: 8,
         },
@@ -82,7 +82,7 @@ describe('get-tokens', () => {
           address: '0x514910771AF9Ca656af840dff83E8264EcF986CA',
           name: 'ChainLink Token',
           symbol: 'LINK',
-          contractType: 'ERC-20',
+          type: 'ERC20',
           chainId: 1,
           decimals: 18,
         },

package/src/module.ts

@@ -98,6 +98,7 @@ export class EvmModule implements Module {
           request,
           network,
           approvalController: this.#approvalController,
+          proxyApiUrl: this.#proxyApiUrl,
         });
       case RpcMethod.PERSONAL_SIGN:
       case RpcMethod.ETH_SIGN:
@@ -109,6 +110,7 @@ export class EvmModule implements Module {
           request,
           network,
           approvalController: this.#approvalController,
+          proxyApiUrl: this.#proxyApiUrl,
         });
       default:
         return { error: rpcErrors.methodNotSupported(`Method ${request.method} not supported`) };

package/src/types.ts

@@ -14,3 +14,12 @@ export type TransactionParams = {
   nonce?: string;
   chainId?: string;
 };
+
+export enum ERC20TransactionType {
+  TOTAL_SUPPLY = 'totalSupply',
+  BALANCE_OF = 'balanceOf',
+  TRANSFER = 'transfer',
+  TRANSFER_FROM = 'transferFrom',
+  APPROVE = 'approve',
+  ALLOWANCE = 'allowance',
+}

package/src/utils/parse-erc20-transaction-type.ts

@@ -0,0 +1,35 @@
+import { Interface } from 'ethers';
+import ERC20 from '@openzeppelin/contracts/build/contracts/ERC20.json';
+import { ERC20TransactionType } from '../types';
+
+export const parseERC20TransactionType = (transaction: {
+  data?: string;
+  value?: string;
+}): ERC20TransactionType | undefined => {
+  if (!transaction.data) {
+    return undefined;
+  }
+
+  try {
+    const contractInterface = new Interface(ERC20.abi);
+
+    const description = contractInterface.parseTransaction({
+      data: transaction.data,
+      value: transaction.value,
+    });
+
+    const functionName = description?.name ?? description?.fragment?.name;
+
+    if (functionName && isERC20TransactionType(functionName)) {
+      return functionName;
+    }
+
+    return undefined;
+  } catch (e) {
+    return undefined;
+  }
+};
+
+function isERC20TransactionType(value: string): value is ERC20TransactionType {
+  return Object.values(ERC20TransactionType).includes(value as ERC20TransactionType);
+}

package/src/utils/process-transaction-simulation.test.ts

@@ -0,0 +1,105 @@
+import Blockaid from '@blockaid/client';
+import { processBalanceChange } from './process-transaction-simulation';
+
+jest.mock('@blockaid/client', () => {
+  return jest.fn().mockImplementation(() => {
+    return {};
+  });
+});
+
+describe('processBalanceChange', () => {
+  it('should sort asset diffs correctly within ins and outs', () => {
+    const assetDiffs: Blockaid.AssetDiff[] = [
+      {
+        asset: {
+          type: 'ERC20',
+          address: '0xTokenAddress1',
+          name: 'TokenName1',
+          symbol: 'TKN1',
+          decimals: 18,
+          logo_url: 'logo_url1',
+        },
+        in: [
+          { value: '1', usd_price: '1', raw_value: '0x1' },
+          { value: '2', usd_price: '2', raw_value: '0x2' },
+        ],
+        out: [
+          { value: '3', usd_price: '3', raw_value: '0x3' },
+          { value: '1', usd_price: '1', raw_value: '0x1' },
+        ],
+      },
+      {
+        asset: {
+          type: 'ERC20',
+          address: '0xTokenAddress2',
+          name: 'TokenName2',
+          symbol: 'TKN2',
+          decimals: 18,
+          logo_url: 'logo_url2',
+        },
+        in: [{ value: '4', usd_price: '4', raw_value: '0x4' }],
+        out: [{ value: '5', usd_price: '5', raw_value: '0x5' }],
+      },
+    ];
+
+    const result = processBalanceChange(assetDiffs);
+
+    // Verify sorting logic for 'ins'
+    expect(result?.ins).toEqual([
+      {
+        token: {
+          type: 'ERC20',
+          address: '0xTokenAddress2',
+          name: 'TokenName2',
+          symbol: 'TKN2',
+          decimals: 18,
+          logoUri: 'logo_url2',
+        },
+        items: [{ displayValue: '4', usdPrice: '4' }],
+      },
+      {
+        token: {
+          type: 'ERC20',
+          address: '0xTokenAddress1',
+          name: 'TokenName1',
+          symbol: 'TKN1',
+          decimals: 18,
+          logoUri: 'logo_url1',
+        },
+        items: [
+          { displayValue: '1', usdPrice: '1' },
+          { displayValue: '2', usdPrice: '2' },
+        ],
+      },
+    ]);
+
+    // Verify sorting logic for 'outs'
+    expect(result?.outs).toEqual([
+      {
+        token: {
+          type: 'ERC20',
+          address: '0xTokenAddress2',
+          name: 'TokenName2',
+          symbol: 'TKN2',
+          decimals: 18,
+          logoUri: 'logo_url2',
+        },
+        items: [{ displayValue: '5', usdPrice: '5' }],
+      },
+      {
+        token: {
+          type: 'ERC20',
+          address: '0xTokenAddress1',
+          name: 'TokenName1',
+          symbol: 'TKN1',
+          decimals: 18,
+          logoUri: 'logo_url1',
+        },
+        items: [
+          { displayValue: '3', usdPrice: '3' },
+          { displayValue: '1', usdPrice: '1' },
+        ],
+      },
+    ]);
+  });
+});