@avalabs/vm-module-types 0.0.13 → 0.0.16

package/src/types.ts

@@ -1,328 +0,0 @@
-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',
-  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',
-}
-
-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',
-  ERC721 = 'ERC721',
-  ERC1155 = 'ERC1155',
-}
-
-export type NetworkFees = {
-  low: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
-  medium: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
-  high: { maxFeePerGas: bigint; maxPriorityFeePerGas?: bigint };
-  baseFee: bigint;
-  isFixedFee: boolean;
-};
-
-export enum RpcMethod {
-  /* EVM */
-  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',
-}
-
-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 RpcError =
-  | JsonRpcError<OptionalDataWithOptionalCause>
-  | EthereumProviderError<OptionalDataWithOptionalCause>;
-
-export type RpcResponse<R = unknown, E extends RpcError = JsonRpcError<OptionalDataWithOptionalCause>> =
-  | {
-      result: R;
-    }
-  | {
-      error: E;
-    };
-
-export type Network = {
-  chainId: number;
-  chainName: string;
-  rpcUrl: string;
-  networkToken: NetworkToken;
-  utilityAddresses?: {
-    multicall: string;
-  };
-  logoUrl?: string;
-  isTestnet?: boolean;
-  explorerUrl?: string;
-};
-
-export 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>;
-}
-
-export type GetTransactionHistory = {
-  network: Network;
-  address: string;
-  nextPageToken?: string;
-  offset?: number;
-};
-
-export type TransactionHistoryResponse = {
-  transactions: Transaction[];
-  nextPageToken?: string;
-};
-
-export 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 | PChainTransactionType | XChainTransactionType;
-  chainId: string; // chainId from ActiveNetwork used to fetch tx
-  method?: string;
-  explorerLink: string;
-};
-
-export 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;
-};
-
-export interface NetworkToken {
-  name: string;
-  symbol: string;
-  description: string;
-  decimals: number;
-  logoUri: string;
-}
-
-export interface NetworkContractToken {
-  address: string;
-  chainId?: number;
-  color?: string;
-  contractType: string;
-  decimals: number;
-  logoUri?: string;
-  name: string;
-  symbol: string;
-}
-
-const sourceSchema = object({
-  checksum: string(),
-  location: object({
-    npm: object({
-      filePath: string(),
-      packageName: string(),
-      registry: string(),
-    }),
-  }),
-});
-
-const manifestSchema = object({
-  name: string(),
-  version: string(),
-  description: string(),
-  sources: object({
-    module: sourceSchema,
-    provider: sourceSchema.optional(),
-  }),
-  network: object({
-    chainIds: string().array(),
-    namespaces: string().array(),
-  }),
-  cointype: string(),
-  permissions: object({
-    rpc: object({
-      dapps: boolean(),
-      methods: string().array(),
-    }),
-  }),
-  manifestVersion: string(),
-});
-
-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;
-}