@avalabs/vm-module-types 0.0.13 → 0.0.16

package/dist/types.d.cts

@@ -1,516 +0,0 @@
-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 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"
-}
-declare enum XChainTransactionType {
-    BASE_TX = "BaseTx",
-    CREATE_ASSET_TX = "CreateAssetTx",
-    OPERATION_TX = "OperationTx",
-    IMPORT_TX = "ImportTx",
-    EXPORT_TX = "ExportTx",
-    UNKNOWN = "UNKNOWN"
-}
-declare enum TokenType {
-    NATIVE = "NATIVE",
-    ERC20 = "ERC20",
-    ERC721 = "ERC721",
-    ERC1155 = "ERC1155"
-}
-type NetworkFees = {
-    low: {
-        maxFeePerGas: bigint;
-        maxPriorityFeePerGas?: bigint;
-    };
-    medium: {
-        maxFeePerGas: bigint;
-        maxPriorityFeePerGas?: bigint;
-    };
-    high: {
-        maxFeePerGas: bigint;
-        maxPriorityFeePerGas?: bigint;
-    };
-    baseFee: bigint;
-    isFixedFee: boolean;
-};
-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 | PChainTransactionType | XChainTransactionType;
-    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, PChainTransactionType, RpcError, RpcMethod, RpcRequest, RpcResponse, SigningData, SigningDataType, TokenType, Transaction, TransactionHistoryResponse, TransactionType, TxToken, XChainTransactionType, parseManifest };