@avalabs/vm-module-types 0.0.11 → 0.0.13

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',
@@ -16,6 +18,34 @@ export enum TransactionType {
   UNKNOWN = 'UNKNOWN',
 }
 
+export enum PChainTransactionType {
+  ADD_VALIDATOR_TX = 'AddValidatorTx',
+  ADD_SUBNET_VALIDATOR_TX = 'AddSubnetValidatorTx',
+  ADD_DELEGATOR_TX = 'AddDelegatorTx',
+  CREATE_CHAIN_TX = 'CreateChainTx',
+  CREATE_SUBNET_TX = 'CreateSubnetTx',
+  IMPORT_TX = 'ImportTx',
+  EXPORT_TX = 'ExportTx',
+  ADVANCE_TIME_TX = 'AdvanceTimeTx',
+  REWARD_VALIDATOR_TX = 'RewardValidatorTx',
+  REMOVE_SUBNET_VALIDATOR_TX = 'RemoveSubnetValidatorTx',
+  TRANSFORM_SUBNET_TX = 'TransformSubnetTx',
+  ADD_PERMISSIONLESS_VALIDATOR_TX = 'AddPermissionlessValidatorTx',
+  ADD_PERMISSIONLESS_DELEGATOR_TX = 'AddPermissionlessDelegatorTx',
+  BASE_TX = 'BaseTx',
+  TRANSFER_SUBNET_OWNERSHIP_TX = 'TransferSubnetOwnershipTx',
+  UNKNOWN = 'UNKNOWN',
+}
+
+export enum XChainTransactionType {
+  BASE_TX = 'BaseTx',
+  CREATE_ASSET_TX = 'CreateAssetTx',
+  OPERATION_TX = 'OperationTx',
+  IMPORT_TX = 'ImportTx',
+  EXPORT_TX = 'ExportTx',
+  UNKNOWN = 'UNKNOWN',
+}
+
 export enum TokenType {
   NATIVE = 'NATIVE',
   ERC20 = 'ERC20',
@@ -24,10 +54,11 @@ export enum TokenType {
 }
 
 export type NetworkFees = {
-  low: { maxPriorityFeePerGas: bigint; maxFeePerGas: bigint };
-  medium: { maxPriorityFeePerGas: bigint; maxFeePerGas: bigint };
-  high: { maxPriorityFeePerGas: bigint; maxFeePerGas: bigint };
+  low: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
+  medium: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
+  high: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
   baseFee: bigint;
+  isFixedFee: boolean;
 };
 
 export enum RpcMethod {
@@ -39,17 +70,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 +100,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 = {
@@ -105,7 +147,7 @@ export type Transaction = {
   tokens: TxToken[];
   gasPrice?: string;
   gasUsed: string;
-  txType?: TransactionType;
+  txType?: TransactionType | PChainTransactionType | XChainTransactionType;
   chainId: string; // chainId from ActiveNetwork used to fetch tx
   method?: string;
   explorerLink: string;
@@ -203,3 +245,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'] });