@avalabs/vm-module-types 0.0.15 → 0.0.17

package/dist/rpc.d.cts

@@ -1,6 +1,7 @@
 import { TransactionRequest } from 'ethers';
 import { Caip2ChainId, Hex } from './common.cjs';
 import { JsonRpcError, OptionalDataWithOptionalCause, EthereumProviderError } from '@metamask/rpc-errors';
+import { BalanceChange, TokenApprovals } from './transaction-simulation.cjs';
 import './token.cjs';
 
 declare enum RpcMethod {
@@ -10,10 +11,7 @@ declare enum RpcMethod {
     SIGN_TYPED_DATA_V1 = "eth_signTypedData_v1",
     SIGN_TYPED_DATA = "eth_signTypedData",
     PERSONAL_SIGN = "personal_sign",
-    ETH_SIGN = "eth_sign",
-    WALLET_ADD_ETHEREUM_CHAIN = "wallet_addEthereumChain",
-    WALLET_SWITCH_ETHEREUM_CHAIN = "wallet_switchEthereumChain",
-    WALLET_GET_ETHEREUM_CHAIN = "wallet_getEthereumChain"
+    ETH_SIGN = "eth_sign"
 }
 type DappInfo = {
     name: string;
@@ -35,47 +33,90 @@ type RpcResponse<R = unknown, E extends RpcError = JsonRpcError<OptionalDataWith
 } | {
     error: E;
 };
+interface MessageTypeProperty {
+    name: string;
+    type: string;
+}
+interface MessageTypes {
+    EIP712Domain: MessageTypeProperty[];
+    [additionalProperties: string]: MessageTypeProperty[];
+}
+interface TypedData<T extends MessageTypes> {
+    types: T;
+    primaryType: keyof T;
+    domain: Record<string, unknown>;
+    message: Record<string, unknown>;
+}
+type TypedDataV1 = {
+    name: string;
+    type: string;
+    value: unknown;
+}[];
 type DisplayData = {
     title: string;
+    dAppInfo?: {
+        name: string;
+        action: string;
+        logoUri?: string;
+    };
     network: {
         chainId: number;
         name: string;
         logoUri?: string;
     };
+    account?: string;
     messageDetails?: string;
     transactionDetails?: {
         website: string;
         from: string;
         to: string;
         data?: string;
+        type?: string;
     };
     networkFeeSelector?: boolean;
+    disclaimer?: string;
+    alert?: Alert;
+    balanceChange?: BalanceChange;
+    tokenApprovals?: TokenApprovals;
 };
-/**
- * Enum for different types of signing data.
- */
-declare enum SigningDataType {
-    EVM_TRANSACTION = "evm_transaction",
-    EVM_MESSAGE_ETH_SIGN = "evm_message_eth_sign",
-    EVM_MESSAGE_PERSONAL_SIGN = "evm_message_personal_sign",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA = "evm_message_eth_sign_typed_data",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V1 = "evm_message_eth_sign_typed_data_v1",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V3 = "evm_message_eth_sign_typed_data_v3",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V4 = "evm_message_eth_sign_typed_data_v4",
-    AVALANCHE_TRANSACTION = "avalanche_transaction",
-    AVALANCHE_MESSAGE = "avalanche_message",
-    BTC_TRANSACTION = "btc_transaction"
+declare enum AlertType {
+    WARNING = "Warning",
+    DANGER = "Danger",
+    INFO = "Info"
 }
+type AlertDetails = {
+    title: string;
+    description: string;
+    detailedDescription?: string;
+    actionTitles?: {
+        proceed: string;
+        reject: string;
+    };
+};
+type Alert = {
+    type: AlertType;
+    details: AlertDetails;
+};
 type SigningData = {
-    type: SigningDataType.EVM_TRANSACTION;
+    type: RpcMethod.ETH_SEND_TRANSACTION;
     account: string;
     chainId: number;
     data: TransactionRequest;
 } | {
-    type: SigningDataType.EVM_MESSAGE_ETH_SIGN;
+    type: RpcMethod.ETH_SIGN | RpcMethod.PERSONAL_SIGN;
     account: string;
     chainId: number;
     data: string;
+} | {
+    type: RpcMethod.SIGN_TYPED_DATA | RpcMethod.SIGN_TYPED_DATA_V1;
+    account: string;
+    chainId: number;
+    data: TypedData<MessageTypes> | TypedDataV1;
+} | {
+    type: RpcMethod.SIGN_TYPED_DATA_V3 | RpcMethod.SIGN_TYPED_DATA_V4;
+    account: string;
+    chainId: number;
+    data: TypedData<MessageTypes>;
 };
 type ApprovalParams = {
     request: RpcRequest;
@@ -93,4 +134,4 @@ interface ApprovalController {
     onTransactionReverted: (txHash: Hex) => void;
 }
 
-export { ApprovalController, ApprovalParams, ApprovalResponse, DappInfo, DisplayData, RpcError, RpcMethod, RpcRequest, RpcResponse, SigningData, SigningDataType };
+export { Alert, AlertDetails, AlertType, ApprovalController, ApprovalParams, ApprovalResponse, DappInfo, DisplayData, MessageTypeProperty, MessageTypes, RpcError, RpcMethod, RpcRequest, RpcResponse, SigningData, TypedData, TypedDataV1 };

package/dist/rpc.d.ts

@@ -1,6 +1,7 @@
 import { TransactionRequest } from 'ethers';
 import { Caip2ChainId, Hex } from './common.js';
 import { JsonRpcError, OptionalDataWithOptionalCause, EthereumProviderError } from '@metamask/rpc-errors';
+import { BalanceChange, TokenApprovals } from './transaction-simulation.js';
 import './token.js';
 
 declare enum RpcMethod {
@@ -10,10 +11,7 @@ declare enum RpcMethod {
     SIGN_TYPED_DATA_V1 = "eth_signTypedData_v1",
     SIGN_TYPED_DATA = "eth_signTypedData",
     PERSONAL_SIGN = "personal_sign",
-    ETH_SIGN = "eth_sign",
-    WALLET_ADD_ETHEREUM_CHAIN = "wallet_addEthereumChain",
-    WALLET_SWITCH_ETHEREUM_CHAIN = "wallet_switchEthereumChain",
-    WALLET_GET_ETHEREUM_CHAIN = "wallet_getEthereumChain"
+    ETH_SIGN = "eth_sign"
 }
 type DappInfo = {
     name: string;
@@ -35,47 +33,90 @@ type RpcResponse<R = unknown, E extends RpcError = JsonRpcError<OptionalDataWith
 } | {
     error: E;
 };
+interface MessageTypeProperty {
+    name: string;
+    type: string;
+}
+interface MessageTypes {
+    EIP712Domain: MessageTypeProperty[];
+    [additionalProperties: string]: MessageTypeProperty[];
+}
+interface TypedData<T extends MessageTypes> {
+    types: T;
+    primaryType: keyof T;
+    domain: Record<string, unknown>;
+    message: Record<string, unknown>;
+}
+type TypedDataV1 = {
+    name: string;
+    type: string;
+    value: unknown;
+}[];
 type DisplayData = {
     title: string;
+    dAppInfo?: {
+        name: string;
+        action: string;
+        logoUri?: string;
+    };
     network: {
         chainId: number;
         name: string;
         logoUri?: string;
     };
+    account?: string;
     messageDetails?: string;
     transactionDetails?: {
         website: string;
         from: string;
         to: string;
         data?: string;
+        type?: string;
     };
     networkFeeSelector?: boolean;
+    disclaimer?: string;
+    alert?: Alert;
+    balanceChange?: BalanceChange;
+    tokenApprovals?: TokenApprovals;
 };
-/**
- * Enum for different types of signing data.
- */
-declare enum SigningDataType {
-    EVM_TRANSACTION = "evm_transaction",
-    EVM_MESSAGE_ETH_SIGN = "evm_message_eth_sign",
-    EVM_MESSAGE_PERSONAL_SIGN = "evm_message_personal_sign",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA = "evm_message_eth_sign_typed_data",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V1 = "evm_message_eth_sign_typed_data_v1",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V3 = "evm_message_eth_sign_typed_data_v3",
-    EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V4 = "evm_message_eth_sign_typed_data_v4",
-    AVALANCHE_TRANSACTION = "avalanche_transaction",
-    AVALANCHE_MESSAGE = "avalanche_message",
-    BTC_TRANSACTION = "btc_transaction"
+declare enum AlertType {
+    WARNING = "Warning",
+    DANGER = "Danger",
+    INFO = "Info"
 }
+type AlertDetails = {
+    title: string;
+    description: string;
+    detailedDescription?: string;
+    actionTitles?: {
+        proceed: string;
+        reject: string;
+    };
+};
+type Alert = {
+    type: AlertType;
+    details: AlertDetails;
+};
 type SigningData = {
-    type: SigningDataType.EVM_TRANSACTION;
+    type: RpcMethod.ETH_SEND_TRANSACTION;
     account: string;
     chainId: number;
     data: TransactionRequest;
 } | {
-    type: SigningDataType.EVM_MESSAGE_ETH_SIGN;
+    type: RpcMethod.ETH_SIGN | RpcMethod.PERSONAL_SIGN;
     account: string;
     chainId: number;
     data: string;
+} | {
+    type: RpcMethod.SIGN_TYPED_DATA | RpcMethod.SIGN_TYPED_DATA_V1;
+    account: string;
+    chainId: number;
+    data: TypedData<MessageTypes> | TypedDataV1;
+} | {
+    type: RpcMethod.SIGN_TYPED_DATA_V3 | RpcMethod.SIGN_TYPED_DATA_V4;
+    account: string;
+    chainId: number;
+    data: TypedData<MessageTypes>;
 };
 type ApprovalParams = {
     request: RpcRequest;
@@ -93,4 +134,4 @@ interface ApprovalController {
     onTransactionReverted: (txHash: Hex) => void;
 }
 
-export { ApprovalController, ApprovalParams, ApprovalResponse, DappInfo, DisplayData, RpcError, RpcMethod, RpcRequest, RpcResponse, SigningData, SigningDataType };
+export { Alert, AlertDetails, AlertType, ApprovalController, ApprovalParams, ApprovalResponse, DappInfo, DisplayData, MessageTypeProperty, MessageTypes, RpcError, RpcMethod, RpcRequest, RpcResponse, SigningData, TypedData, TypedDataV1 };

package/dist/rpc.js

@@ -1,3 +1,3 @@
-export { a as RpcMethod, b as SigningDataType } from './chunk-FKFLXQOJ.js';
+export { b as AlertType, a as RpcMethod } from './chunk-RKFOXZ35.js';
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=rpc.js.map

package/dist/token.cjs

@@ -1,12 +1,12 @@
 'use strict';
 
-var chunkKVTVJNN4_cjs = require('./chunk-KVTVJNN4.cjs');
+var chunk2KGTZTXY_cjs = require('./chunk-2KGTZTXY.cjs');
 
 
 
 Object.defineProperty(exports, 'TokenType', {
 	enumerable: true,
-	get: function () { return chunkKVTVJNN4_cjs.a; }
+	get: function () { return chunk2KGTZTXY_cjs.a; }
 });
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=token.cjs.map

package/dist/token.d.cts

@@ -1,3 +1,10 @@
+declare enum TokenType {
+    NATIVE = "NATIVE",
+    ERC20 = "ERC20",
+    ERC721 = "ERC721",
+    ERC1155 = "ERC1155",
+    NONERC = "NONERC"
+}
 interface NetworkToken {
     name: string;
     symbol: string;
@@ -5,21 +12,37 @@ interface NetworkToken {
     logoUri?: string;
     description?: string;
 }
-interface NetworkContractToken {
+type NetworkContractToken = ERC20Token | ERC1155Token | ERC721Token | NONERCToken;
+interface ERC20Token {
     address: string;
     chainId?: number;
     color?: string;
-    contractType: string;
+    type: TokenType.ERC20;
     decimals: number;
     logoUri?: string;
     name: string;
     symbol: string;
 }
-declare enum TokenType {
-    NATIVE = "NATIVE",
-    ERC20 = "ERC20",
-    ERC721 = "ERC721",
-    ERC1155 = "ERC1155"
+interface ERC1155Token {
+    address: string;
+    type: TokenType.ERC1155;
+    logoUri?: string;
+    name?: string;
+    symbol?: string;
+}
+interface ERC721Token {
+    address: string;
+    type: TokenType.ERC721;
+    logoUri?: string;
+    name?: string;
+    symbol?: string;
+}
+interface NONERCToken {
+    address: string;
+    type: TokenType.NONERC;
+    logoUri?: string;
+    name?: string;
+    symbol?: string;
 }
 
-export { NetworkContractToken, NetworkToken, TokenType };
+export { ERC1155Token, ERC20Token, ERC721Token, NONERCToken, NetworkContractToken, NetworkToken, TokenType };

package/dist/token.d.ts

@@ -1,3 +1,10 @@
+declare enum TokenType {
+    NATIVE = "NATIVE",
+    ERC20 = "ERC20",
+    ERC721 = "ERC721",
+    ERC1155 = "ERC1155",
+    NONERC = "NONERC"
+}
 interface NetworkToken {
     name: string;
     symbol: string;
@@ -5,21 +12,37 @@ interface NetworkToken {
     logoUri?: string;
     description?: string;
 }
-interface NetworkContractToken {
+type NetworkContractToken = ERC20Token | ERC1155Token | ERC721Token | NONERCToken;
+interface ERC20Token {
     address: string;
     chainId?: number;
     color?: string;
-    contractType: string;
+    type: TokenType.ERC20;
     decimals: number;
     logoUri?: string;
     name: string;
     symbol: string;
 }
-declare enum TokenType {
-    NATIVE = "NATIVE",
-    ERC20 = "ERC20",
-    ERC721 = "ERC721",
-    ERC1155 = "ERC1155"
+interface ERC1155Token {
+    address: string;
+    type: TokenType.ERC1155;
+    logoUri?: string;
+    name?: string;
+    symbol?: string;
+}
+interface ERC721Token {
+    address: string;
+    type: TokenType.ERC721;
+    logoUri?: string;
+    name?: string;
+    symbol?: string;
+}
+interface NONERCToken {
+    address: string;
+    type: TokenType.NONERC;
+    logoUri?: string;
+    name?: string;
+    symbol?: string;
 }
 
-export { NetworkContractToken, NetworkToken, TokenType };
+export { ERC1155Token, ERC20Token, ERC721Token, NONERCToken, NetworkContractToken, NetworkToken, TokenType };

package/dist/token.js

@@ -1,3 +1,3 @@
-export { a as TokenType } from './chunk-TSO5BGJ4.js';
+export { a as TokenType } from './chunk-7Y6UGMPZ.js';
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=token.js.map

package/dist/transaction-simulation.cjs

@@ -0,0 +1,6 @@
+'use strict';
+
+require('./chunk-47KTBBRA.cjs');
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=transaction-simulation.cjs.map

package/dist/transaction-simulation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/transaction-simulation.d.cts

@@ -0,0 +1,27 @@
+import { NetworkContractToken, NetworkToken } from './token.cjs';
+
+type BalanceChange = {
+    ins: TokenDiff[];
+    outs: TokenDiff[];
+};
+type TokenDiff = {
+    token: NetworkContractToken | NetworkToken;
+    items: TokenDiffItem[];
+};
+type TokenDiffItem = {
+    displayValue: string;
+    usdPrice: string | undefined;
+};
+type TokenApproval = {
+    token: NetworkContractToken;
+    spenderAddress: string;
+    value?: string;
+    usdPrice?: string;
+    logoUri?: string;
+};
+type TokenApprovals = {
+    isEditable: boolean;
+    approvals: TokenApproval[];
+};
+
+export { BalanceChange, TokenApproval, TokenApprovals, TokenDiff, TokenDiffItem };

package/dist/transaction-simulation.d.ts

@@ -0,0 +1,27 @@
+import { NetworkContractToken, NetworkToken } from './token.js';
+
+type BalanceChange = {
+    ins: TokenDiff[];
+    outs: TokenDiff[];
+};
+type TokenDiff = {
+    token: NetworkContractToken | NetworkToken;
+    items: TokenDiffItem[];
+};
+type TokenDiffItem = {
+    displayValue: string;
+    usdPrice: string | undefined;
+};
+type TokenApproval = {
+    token: NetworkContractToken;
+    spenderAddress: string;
+    value?: string;
+    usdPrice?: string;
+    logoUri?: string;
+};
+type TokenApprovals = {
+    isEditable: boolean;
+    approvals: TokenApproval[];
+};
+
+export { BalanceChange, TokenApproval, TokenApprovals, TokenDiff, TokenDiffItem };

package/dist/transaction-simulation.js

@@ -0,0 +1,3 @@
+import './chunk-P6AM7I3B.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=transaction-simulation.js.map

package/dist/transaction-simulation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avalabs/vm-module-types",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "@avalabs/glacier-sdk": "v2.8.0-alpha.193",
     "@avalabs/utils-sdk": "2.8.0-alpha.193",
     "@internal/tsup-config": "0.0.1",
-    "eslint-config-custom": "0.0.3"
+    "eslint-config-custom": "0.0.1"
   },
   "peerDependencies": {
     "ethers": "^6.8.1"

package/src/index.ts

@@ -7,3 +7,4 @@ export * from './network-fee';
 export * from './rpc';
 export * from './token';
 export * from './transaction-history';
+export * from './transaction-simulation';

package/src/network-fee.ts

@@ -2,6 +2,6 @@ export type NetworkFees = {
   low: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
   medium: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
   high: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
-  baseFee: bigint;
+  baseFee?: bigint;
   isFixedFee: boolean;
 };

package/src/rpc.ts

@@ -1,6 +1,7 @@
 import type { TransactionRequest } from 'ethers';
 import type { Caip2ChainId, Hex } from './common';
 import type { JsonRpcError, EthereumProviderError, OptionalDataWithOptionalCause } from '@metamask/rpc-errors';
+import type { BalanceChange, TokenApprovals } from './transaction-simulation';
 
 export enum RpcMethod {
   /* EVM */
@@ -11,9 +12,6 @@ export enum RpcMethod {
   SIGN_TYPED_DATA = 'eth_signTypedData',
   PERSONAL_SIGN = 'personal_sign',
   ETH_SIGN = 'eth_sign',
-  WALLET_ADD_ETHEREUM_CHAIN = 'wallet_addEthereumChain',
-  WALLET_SWITCH_ETHEREUM_CHAIN = 'wallet_switchEthereumChain',
-  WALLET_GET_ETHEREUM_CHAIN = 'wallet_getEthereumChain',
 }
 
 export type DappInfo = {
@@ -44,56 +42,98 @@ export type RpcResponse<R = unknown, E extends RpcError = JsonRpcError<OptionalD
       error: E;
     };
 
+export interface MessageTypeProperty {
+  name: string;
+  type: string;
+}
+
+export interface MessageTypes {
+  EIP712Domain: MessageTypeProperty[];
+  [additionalProperties: string]: MessageTypeProperty[];
+}
+
+export interface TypedData<T extends MessageTypes> {
+  types: T;
+  primaryType: keyof T;
+  domain: Record<string, unknown>;
+  message: Record<string, unknown>;
+}
+
+export type TypedDataV1 = { name: string; type: string; value: unknown }[];
+
 export type DisplayData = {
   title: string;
+  dAppInfo?: {
+    name: string;
+    action: string;
+    logoUri?: string;
+  };
   network: {
     chainId: number;
     name: string;
     logoUri?: string;
   };
+  account?: string;
   messageDetails?: string;
   transactionDetails?: {
     website: string;
     from: string;
     to: string;
     data?: string;
+    type?: string;
   };
   networkFeeSelector?: boolean;
+  disclaimer?: string;
+  alert?: Alert;
+  balanceChange?: BalanceChange;
+  tokenApprovals?: TokenApprovals;
 };
 
-/**
- * Enum for different types of signing data.
- */
-export enum SigningDataType {
-  // EVM signing data types
-  EVM_TRANSACTION = 'evm_transaction',
-  EVM_MESSAGE_ETH_SIGN = 'evm_message_eth_sign',
-  EVM_MESSAGE_PERSONAL_SIGN = 'evm_message_personal_sign',
-  EVM_MESSAGE_ETH_SIGN_TYPED_DATA = 'evm_message_eth_sign_typed_data',
-  EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V1 = 'evm_message_eth_sign_typed_data_v1',
-  EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V3 = 'evm_message_eth_sign_typed_data_v3',
-  EVM_MESSAGE_ETH_SIGN_TYPED_DATA_V4 = 'evm_message_eth_sign_typed_data_v4',
-
-  // Avalanche signing data types
-  AVALANCHE_TRANSACTION = 'avalanche_transaction',
-  AVALANCHE_MESSAGE = 'avalanche_message',
-
-  // Bitcoin signing data types
-  BTC_TRANSACTION = 'btc_transaction',
+export enum AlertType {
+  WARNING = 'Warning',
+  DANGER = 'Danger',
+  INFO = 'Info',
 }
 
+export type AlertDetails = {
+  title: string;
+  description: string;
+  detailedDescription?: string;
+  actionTitles?: {
+    proceed: string;
+    reject: string;
+  };
+};
+
+export type Alert = {
+  type: AlertType;
+  details: AlertDetails;
+};
+
 export type SigningData =
   | {
-      type: SigningDataType.EVM_TRANSACTION;
+      type: RpcMethod.ETH_SEND_TRANSACTION;
       account: string;
       chainId: number;
       data: TransactionRequest;
     }
   | {
-      type: SigningDataType.EVM_MESSAGE_ETH_SIGN;
+      type: RpcMethod.ETH_SIGN | RpcMethod.PERSONAL_SIGN;
       account: string;
       chainId: number;
       data: string;
+    }
+  | {
+      type: RpcMethod.SIGN_TYPED_DATA | RpcMethod.SIGN_TYPED_DATA_V1;
+      account: string;
+      chainId: number;
+      data: TypedData<MessageTypes> | TypedDataV1;
+    }
+  | {
+      type: RpcMethod.SIGN_TYPED_DATA_V3 | RpcMethod.SIGN_TYPED_DATA_V4;
+      account: string;
+      chainId: number;
+      data: TypedData<MessageTypes>;
     };
 
 export type ApprovalParams = {