@avalabs/vm-module-types 0.0.10 → 0.0.12

package/dist/types.d.ts

@@ -0,0 +1,489 @@
+import { z } from 'zod';
+import { TransactionRequest } from 'ethers';
+import { JsonRpcError, OptionalDataWithOptionalCause, EthereumProviderError } from '@metamask/rpc-errors';
+
+declare enum TransactionType {
+    BRIDGE = "Bridge",
+    SWAP = "Swap",
+    SEND = "Send",
+    RECEIVE = "Receive",
+    NFT_BUY = "NFTBuy",
+    APPROVE = "Approve",
+    TRANSFER = "Transfer",
+    NFT_SEND = "NFTSend",
+    NFT_RECEIVE = "NFTReceive",
+    AIRDROP = "Airdrop",
+    FILL_ORDER = "FillOrder",
+    UNWRAP = "Unwrap",
+    UNKNOWN = "UNKNOWN"
+}
+declare enum TokenType {
+    NATIVE = "NATIVE",
+    ERC20 = "ERC20",
+    ERC721 = "ERC721",
+    ERC1155 = "ERC1155"
+}
+type NetworkFees = {
+    low: {
+        maxPriorityFeePerGas: bigint;
+        maxFeePerGas: bigint;
+    };
+    medium: {
+        maxPriorityFeePerGas: bigint;
+        maxFeePerGas: bigint;
+    };
+    high: {
+        maxPriorityFeePerGas: bigint;
+        maxFeePerGas: bigint;
+    };
+    baseFee: bigint;
+};
+declare enum RpcMethod {
+    ETH_SEND_TRANSACTION = "eth_sendTransaction",
+    SIGN_TYPED_DATA_V3 = "eth_signTypedData_v3",
+    SIGN_TYPED_DATA_V4 = "eth_signTypedData_v4",
+    SIGN_TYPED_DATA_V1 = "eth_signTypedData_v1",
+    SIGN_TYPED_DATA = "eth_signTypedData",
+    PERSONAL_SIGN = "personal_sign",
+    ETH_SIGN = "eth_sign"
+}
+type DappInfo = {
+    name: string;
+    url: string;
+    icon: string;
+};
+type RpcRequest = {
+    requestId: string;
+    sessionId: string;
+    method: RpcMethod;
+    chainId: Caip2ChainId;
+    params: unknown;
+    dappInfo: DappInfo;
+    context?: Record<string, unknown>;
+};
+type RpcError = JsonRpcError<OptionalDataWithOptionalCause> | EthereumProviderError<OptionalDataWithOptionalCause>;
+type RpcResponse<R = unknown, E extends RpcError = JsonRpcError<OptionalDataWithOptionalCause>> = {
+    result: R;
+} | {
+    error: E;
+};
+type Network = {
+    chainId: number;
+    chainName: string;
+    rpcUrl: string;
+    networkToken: NetworkToken;
+    utilityAddresses?: {
+        multicall: string;
+    };
+    logoUrl?: string;
+    isTestnet?: boolean;
+    explorerUrl?: string;
+};
+interface Module {
+    getManifest: () => Manifest | undefined;
+    getBalances: () => Promise<string>;
+    getTransactionHistory: (params: GetTransactionHistory) => Promise<TransactionHistoryResponse>;
+    getNetworkFee: (network: Network) => Promise<NetworkFees>;
+    getAddress: () => Promise<string>;
+    getTokens: (network: Network) => Promise<NetworkContractToken[]>;
+    onRpcRequest: (request: RpcRequest, network: Network) => Promise<RpcResponse>;
+}
+type GetTransactionHistory = {
+    network: Network;
+    address: string;
+    nextPageToken?: string;
+    offset?: number;
+};
+type TransactionHistoryResponse = {
+    transactions: Transaction[];
+    nextPageToken?: string;
+};
+type Transaction = {
+    isContractCall: boolean;
+    isIncoming: boolean;
+    isOutgoing: boolean;
+    isSender: boolean;
+    timestamp: number;
+    hash: string;
+    from: string;
+    to: string;
+    tokens: TxToken[];
+    gasPrice?: string;
+    gasUsed: string;
+    txType?: TransactionType;
+    chainId: string;
+    method?: string;
+    explorerLink: string;
+};
+interface TxToken {
+    decimal?: string;
+    name: string;
+    symbol: string;
+    amount: string;
+    imageUri?: string;
+    from?: RichAddress;
+    to?: RichAddress;
+    collectableTokenId?: string;
+    type: TokenType;
+}
+type RichAddress = {
+    /**
+     * The contract name.
+     */
+    name?: string;
+    /**
+     * The contract symbol.
+     */
+    symbol?: string;
+    /**
+     * The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
+     */
+    decimals?: number;
+    /**
+     * The logo uri for the address.
+     */
+    logoUri?: string;
+    /**
+     * A wallet or contract address in mixed-case checksum encoding.
+     */
+    address: string;
+};
+interface NetworkToken {
+    name: string;
+    symbol: string;
+    description: string;
+    decimals: number;
+    logoUri: string;
+}
+interface NetworkContractToken {
+    address: string;
+    chainId?: number;
+    color?: string;
+    contractType: string;
+    decimals: number;
+    logoUri?: string;
+    name: string;
+    symbol: string;
+}
+declare const manifestSchema: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodString;
+    description: z.ZodString;
+    sources: z.ZodObject<{
+        module: z.ZodObject<{
+            checksum: z.ZodString;
+            location: z.ZodObject<{
+                npm: z.ZodObject<{
+                    filePath: z.ZodString;
+                    packageName: z.ZodString;
+                    registry: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                }, {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            }, {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        }, {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        }>;
+        provider: z.ZodOptional<z.ZodObject<{
+            checksum: z.ZodString;
+            location: z.ZodObject<{
+                npm: z.ZodObject<{
+                    filePath: z.ZodString;
+                    packageName: z.ZodString;
+                    registry: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                }, {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            }, {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        }, {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        module: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        };
+        provider?: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        } | undefined;
+    }, {
+        module: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        };
+        provider?: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        } | undefined;
+    }>;
+    network: z.ZodObject<{
+        chainIds: z.ZodArray<z.ZodString, "many">;
+        namespaces: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        chainIds: string[];
+        namespaces: string[];
+    }, {
+        chainIds: string[];
+        namespaces: string[];
+    }>;
+    cointype: z.ZodString;
+    permissions: z.ZodObject<{
+        rpc: z.ZodObject<{
+            dapps: z.ZodBoolean;
+            methods: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            dapps: boolean;
+            methods: string[];
+        }, {
+            dapps: boolean;
+            methods: string[];
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        rpc: {
+            dapps: boolean;
+            methods: string[];
+        };
+    }, {
+        rpc: {
+            dapps: boolean;
+            methods: string[];
+        };
+    }>;
+    manifestVersion: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    version: string;
+    description: string;
+    sources: {
+        module: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        };
+        provider?: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        } | undefined;
+    };
+    network: {
+        chainIds: string[];
+        namespaces: string[];
+    };
+    cointype: string;
+    permissions: {
+        rpc: {
+            dapps: boolean;
+            methods: string[];
+        };
+    };
+    manifestVersion: string;
+}, {
+    name: string;
+    version: string;
+    description: string;
+    sources: {
+        module: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        };
+        provider?: {
+            checksum: string;
+            location: {
+                npm: {
+                    filePath: string;
+                    packageName: string;
+                    registry: string;
+                };
+            };
+        } | undefined;
+    };
+    network: {
+        chainIds: string[];
+        namespaces: string[];
+    };
+    cointype: string;
+    permissions: {
+        rpc: {
+            dapps: boolean;
+            methods: string[];
+        };
+    };
+    manifestVersion: string;
+}>;
+type Manifest = z.infer<typeof manifestSchema>;
+declare const parseManifest: (params: unknown) => z.SafeParseReturnType<unknown, Manifest>;
+type Caip2ChainId = string;
+type Hex = `0x${string}`;
+declare enum Environment {
+    PRODUCTION = "production",
+    DEV = "dev"
+}
+type DisplayData = {
+    title: string;
+    network: {
+        chainId: number;
+        name: string;
+        logoUrl?: string;
+    };
+    messageDetails?: string;
+    transactionDetails?: {
+        website: string;
+        from: string;
+        to: string;
+        data?: string;
+    };
+    networkFeeSelector?: boolean;
+};
+/**
+ * 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"
+}
+type SigningData = {
+    type: SigningDataType.EVM_TRANSACTION;
+    account: string;
+    chainId: number;
+    data: TransactionRequest;
+} | {
+    type: SigningDataType.EVM_MESSAGE_ETH_SIGN;
+    account: string;
+    chainId: number;
+    data: string;
+};
+type ApprovalParams = {
+    request: RpcRequest;
+    displayData: DisplayData;
+    signingData: SigningData;
+};
+type ApprovalResponse = {
+    result: Hex;
+} | {
+    error: RpcError;
+};
+interface ApprovalController {
+    requestApproval: (params: ApprovalParams) => Promise<ApprovalResponse>;
+    onTransactionConfirmed: (txHash: Hex) => void;
+    onTransactionReverted: (txHash: Hex) => void;
+}
+
+export { ApprovalController, ApprovalParams, ApprovalResponse, Caip2ChainId, DappInfo, DisplayData, Environment, GetTransactionHistory, Hex, Manifest, Module, Network, NetworkContractToken, NetworkFees, NetworkToken, RpcError, RpcMethod, RpcRequest, RpcResponse, SigningData, SigningDataType, TokenType, Transaction, TransactionHistoryResponse, TransactionType, TxToken, parseManifest };

package/dist/types.js

@@ -0,0 +1,3 @@
+export { e as Environment, c as RpcMethod, f as SigningDataType, b as TokenType, a as TransactionType, d as parseManifest } from './chunk-ODMEO2D7.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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

package/package.json

@@ -1,14 +1,25 @@
 {
   "name": "@avalabs/vm-module-types",
-  "version": "0.0.10",
-  "main": "src/index.ts",
+  "version": "0.0.12",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "type": "module",
   "dependencies": {
-    "zod": "3.23.8"
+    "zod": "3.23.8",
+    "@metamask/rpc-errors": "6.3.0",
+    "ethers": "6.8.1"
   },
   "devDependencies": {
-    "eslint-config-custom": "0.0.1"
+    "tsup": "7.2.0",
+    "@internal/tsup-config": "0.0.1",
+    "eslint-config-custom": "0.0.2"
+  },
+  "peerDependencies": {
+    "ethers": "^6.8.1"
   },
   "scripts": {
+    "build": "tsup",
     "lint": "eslint \"src/**/*.ts\""
   }
 }

package/src/types.ts

@@ -1,4 +1,6 @@
 import { object, string, boolean, z } from 'zod';
+import type { TransactionRequest } from 'ethers';
+import type { JsonRpcError, EthereumProviderError, OptionalDataWithOptionalCause } from '@metamask/rpc-errors';
 
 export enum TransactionType {
   BRIDGE = 'Bridge',
@@ -39,17 +41,29 @@ 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 = {
+  name: string;
+  url: string;
+  icon: string;
+};
+
 export type RpcRequest = {
+  requestId: string;
+  sessionId: string;
   method: RpcMethod;
+  chainId: Caip2ChainId;
   params: unknown;
+  dappInfo: DappInfo;
+  context?: Record<string, unknown>; // for storing additional context information that's only relevant to the consumer
 };
 
-export type RpcResponse<R = unknown, E extends Error = Error> =
+export type RpcError =
+  | JsonRpcError<OptionalDataWithOptionalCause>
+  | EthereumProviderError<OptionalDataWithOptionalCause>;
+
+export type RpcResponse<R = unknown, E extends RpcError = JsonRpcError<OptionalDataWithOptionalCause>> =
   | {
       result: R;
     }
@@ -57,35 +71,34 @@ export type RpcResponse<R = unknown, E extends Error = Error> =
       error: E;
     };
 
-export type Chain = {
+export type Network = {
+  chainId: number;
+  chainName: string;
+  rpcUrl: string;
+  networkToken: NetworkToken;
+  utilityAddresses?: {
+    multicall: string;
+  };
+  logoUrl?: string;
   isTestnet?: boolean;
-  chainId?: string;
-  chainName?: string;
-  rpcUrl?: string;
-  multiContractAddress?: string;
+  explorerUrl?: string;
 };
 
-export type GetNetworkFeeParams = Chain;
-
 export interface Module {
   getManifest: () => Manifest | undefined;
   getBalances: () => Promise<string>;
   getTransactionHistory: (params: GetTransactionHistory) => Promise<TransactionHistoryResponse>;
-  getNetworkFee: (params: GetNetworkFeeParams) => Promise<NetworkFees>;
+  getNetworkFee: (network: Network) => Promise<NetworkFees>;
   getAddress: () => Promise<string>;
-  getTokens: (chainId: number) => Promise<NetworkContractToken[]>;
-  onRpcRequest: (request: RpcRequest) => Promise<RpcResponse>;
+  getTokens: (network: Network) => Promise<NetworkContractToken[]>;
+  onRpcRequest: (request: RpcRequest, network: Network) => Promise<RpcResponse>;
 }
 
 export type GetTransactionHistory = {
-  chainId: number;
-  isTestnet: boolean;
-  networkToken: NetworkToken;
-  explorerUrl: string;
+  network: Network;
   address: string;
   nextPageToken?: string;
   offset?: number;
-  glacierApiUrl?: string;
 };
 
 export type TransactionHistoryResponse = {
@@ -203,3 +216,84 @@ export type Manifest = z.infer<typeof manifestSchema>;
 export const parseManifest = (params: unknown): z.SafeParseReturnType<unknown, Manifest> => {
   return manifestSchema.safeParse(params);
 };
+
+export type Caip2ChainId = string;
+
+export type Hex = `0x${string}`;
+
+export enum Environment {
+  PRODUCTION = 'production',
+  DEV = 'dev',
+}
+
+export type DisplayData = {
+  title: string;
+  network: {
+    chainId: number;
+    name: string;
+    logoUrl?: string;
+  };
+  messageDetails?: string;
+  transactionDetails?: {
+    website: string;
+    from: string;
+    to: string;
+    data?: string;
+  };
+  networkFeeSelector?: boolean;
+};
+
+/**
+ * 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 type SigningData =
+  | {
+      type: SigningDataType.EVM_TRANSACTION;
+      account: string;
+      chainId: number;
+      data: TransactionRequest;
+    }
+  | {
+      type: SigningDataType.EVM_MESSAGE_ETH_SIGN;
+      account: string;
+      chainId: number;
+      data: string;
+    };
+
+export type ApprovalParams = {
+  request: RpcRequest;
+  displayData: DisplayData;
+  signingData: SigningData;
+};
+
+export type ApprovalResponse =
+  | {
+      result: Hex;
+    }
+  | {
+      error: RpcError;
+    };
+
+export interface ApprovalController {
+  requestApproval: (params: ApprovalParams) => Promise<ApprovalResponse>;
+  onTransactionConfirmed: (txHash: Hex) => void;
+  onTransactionReverted: (txHash: Hex) => void;
+}

package/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "@internal/tsconfig/tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./dist",
-    "composite": true
+    "tsBuildInfoFile": ".tsbuildinfo"
   },
   "include": ["src"]
 }

package/tsup.config.ts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'tsup';
+import { baseConfig } from '@internal/tsup-config';
+
+export default defineConfig({ ...baseConfig, entry: ['src/*.ts'] });