@trezo/evm 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,281 @@
+import { Abi, ExtractAbiFunctionNames, AbiParametersToPrimitiveTypes, ExtractAbiFunction, Address, ExtractAbiEventNames, ExtractAbiEvent } from 'abitype';
+export { Abi, AbiParameterToPrimitiveType, AbiParametersToPrimitiveTypes, ExtractAbiEvent, ExtractAbiEventNames, ExtractAbiFunction, ExtractAbiFunctionNames } from 'abitype';
+import * as Chains from 'viem/chains';
+import { ethers } from 'ethers';
+import React from 'react';
+
+type EvmAbiType = Abi;
+type EvmAbiFunctionArgsTuple<TAbi extends Abi, FnName extends ExtractAbiFunctionNames<TAbi>> = AbiParametersToPrimitiveTypes<ExtractAbiFunction<TAbi, FnName>["inputs"]>;
+type EvmAbiFunctionReturn<TAbi extends EvmAbiType, FnName extends ExtractAbiFunctionNames<TAbi>> = ExtractAbiFunction<TAbi, FnName>["outputs"] extends readonly [] ? void : AbiParametersToPrimitiveTypes<ExtractAbiFunction<TAbi, FnName>["outputs"]>[0];
+
+type ConnectkitConfig = {
+    projectId: string;
+    metadata: {
+        appName: string;
+        appIcon?: string;
+        appDescription?: string;
+        appUrl?: string;
+    };
+};
+
+type ReownConfig = {
+    projectId: string;
+    ssr?: boolean;
+    metadata: {
+        name: string;
+        description: string;
+        url: string;
+        icons: string[];
+    };
+};
+
+/**
+ * ---------------------------------------------------------------------------
+ * ⚠️  AUTO-GENERATED FILE — DO NOT EDIT MANUALLY
+ * ---------------------------------------------------------------------------
+ *
+ * Generated by:
+ *   scripts/genokit.ts
+ *
+ * Any manual changes will be overwritten.
+ *
+ * To update kits:
+ *   1. Add/remove files in src/kits/
+ *   2. Run:
+ *        pnpm tsx scripts/genokit.ts
+ *
+ * ---------------------------------------------------------------------------
+ */
+
+type EvmKitConfigType = {
+    name: "connectkit";
+    config: ConnectkitConfig;
+} | {
+    name: "reown";
+    config: ReownConfig;
+};
+
+declare const EvmChains: typeof Chains;
+type EvmAddressType = Address;
+type EvmChainsType = typeof EvmChains;
+type EvmConfigType<TAbi extends EvmAbiType> = {
+    abi: TAbi;
+    address: EvmAddressType;
+    chains: [Chains.Chain, ...Chains.Chain[]];
+    rpcUrl?: string;
+    kit: EvmKitConfigType;
+};
+
+type EvmStoreType<TAbi extends EvmAbiType> = {
+    wallet: {
+        isConnected: boolean;
+        isConnecting: boolean;
+        address?: EvmAddressType;
+        chainId?: number;
+        error?: Error;
+    };
+    provider: {
+        isAvailable: boolean;
+        error?: Error;
+    };
+    _signer?: ethers.Signer;
+    _provider?: ethers.Provider;
+    _contract?: ethers.Contract;
+    _abi?: TAbi;
+};
+
+declare function create<TAbi extends EvmAbiType>(config: EvmConfigType<TAbi>): {
+    (): {
+        call: {
+            queryFn: <FnName extends ExtractAbiFunctionNames<TAbi, "view" | "pure">>(functionName: FnName, args: EvmAbiFunctionArgsTuple<TAbi, FnName>) => Promise<{
+                data?: EvmAbiFunctionReturn<TAbi, FnName>;
+                error?: Error;
+            }>;
+            mutateFn: <FnName extends ExtractAbiFunctionNames<TAbi, "nonpayable" | "payable">>(functionName: FnName, args: EvmAbiFunctionArgsTuple<TAbi, FnName>) => Promise<{
+                data?: {
+                    hash: string;
+                };
+                error?: Error;
+            }>;
+            listenFn: <EventName extends ExtractAbiEventNames<TAbi>>(eventName: EventName, listener: (...args: AbiParametersToPrimitiveTypes<ExtractAbiEvent<TAbi, EventName>["inputs"]>) => void) => (() => void);
+        };
+        web3Provider: {
+            isAvailable: boolean;
+            error?: Error;
+        };
+        wallet: {
+            account: {
+                isConnected: boolean;
+                isConnecting: boolean;
+                address?: EvmAddressType;
+                chainId?: number;
+                error?: Error;
+            };
+        };
+    };
+    call: {
+        queryFn: <FnName extends ExtractAbiFunctionNames<TAbi, "view" | "pure">>(functionName: FnName, args: EvmAbiFunctionArgsTuple<TAbi, FnName>) => Promise<{
+            data?: EvmAbiFunctionReturn<TAbi, FnName>;
+            error?: Error;
+        }>;
+        mutateFn: <FnName extends ExtractAbiFunctionNames<TAbi, "nonpayable" | "payable">>(functionName: FnName, args: EvmAbiFunctionArgsTuple<TAbi, FnName>) => Promise<{
+            data?: {
+                hash: string;
+            };
+            error?: Error;
+        }>;
+        listenFn: <EventName extends ExtractAbiEventNames<TAbi>>(eventName: EventName, listener: (...args: AbiParametersToPrimitiveTypes<ExtractAbiEvent<TAbi, EventName>["inputs"]>) => void) => (() => void);
+    };
+    getState: () => EvmStoreType<TAbi>;
+    subscribe: (onStoreChange: () => void) => () => void;
+    Provider: React.FC<{
+        children: React.ReactNode;
+    }>;
+    ConnectButton: React.FC<{
+        label?: string;
+        showBalance?: boolean;
+        showAvatar?: boolean;
+        children?: (props: any) => React.ReactNode;
+    }>;
+} & {
+    call: {
+        queryFn: <FnName extends ExtractAbiFunctionNames<TAbi, "view" | "pure">>(functionName: FnName, args: EvmAbiFunctionArgsTuple<TAbi, FnName>) => Promise<{
+            data?: EvmAbiFunctionReturn<TAbi, FnName>;
+            error?: Error;
+        }>;
+        mutateFn: <FnName extends ExtractAbiFunctionNames<TAbi, "nonpayable" | "payable">>(functionName: FnName, args: EvmAbiFunctionArgsTuple<TAbi, FnName>) => Promise<{
+            data?: {
+                hash: string;
+            };
+            error?: Error;
+        }>;
+        listenFn: <EventName extends ExtractAbiEventNames<TAbi>>(eventName: EventName, listener: (...args: AbiParametersToPrimitiveTypes<ExtractAbiEvent<TAbi, EventName>["inputs"]>) => void) => (() => void);
+    };
+    getState: () => EvmStoreType<TAbi>;
+    subscribe: (onStoreChange: () => void) => () => void;
+    Provider: React.FC<{
+        children: React.ReactNode;
+    }>;
+    ConnectButton: React.FC<{
+        label?: string;
+        showBalance?: boolean;
+        showAvatar?: boolean;
+        children?: (props: any) => React.ReactNode;
+    }>;
+};
+
+/**
+ * Throws an Error with a specified message.
+ *
+ * This utility can be used to enforce required parameters or invalid states.
+ *
+ * @param message - Optional custom error message. Defaults to `"An unexpected error occurred"`.
+ *
+ * @throws Always throws an `Error` with the provided message.
+ *
+ * @example
+ * throwError("Invalid contract address");
+ * // Throws Error: "Invalid contract address"
+ *
+ * @example
+ * throwError();
+ * // Throws Error: "An unexpected error occurred"
+ */
+declare function throwError(message?: string): never;
+/**
+ * mapEthersError
+ * ------------------------------------------------------------
+ * Converts low-level Ethers.js / RPC / wallet errors into
+ * human-readable messages suitable for UI display.
+ *
+ * Ethereum libraries such as ethers.js emit structured errors
+ * that include a `code` property. These codes represent
+ * categories such as:
+ *
+ * - Blockchain execution errors
+ * - Wallet interaction errors
+ * - RPC/network failures
+ * - Argument validation problems
+ *
+ * This utility normalizes those errors into friendly messages.
+ *
+ * References:
+ * https://docs.ethers.org/v6/api/utils/errors/
+ */
+declare const mapEthersError: (error: any) => string;
+
+interface PollConfig {
+    provider: ethers.Provider;
+    contract: ethers.Contract;
+    eventName: string;
+    intervalMs?: number;
+}
+/**
+ * Manually polls for logs when eth_newFilter is unavailable
+ */
+declare const createEventPoller: ({ provider, contract, eventName, intervalMs }: PollConfig, listener: (...args: any[]) => void) => () => void;
+
+/**
+ * Converts a value from Wei to Ether.
+ *
+ * Uses `ethers.formatEther` to format the smallest Ethereum unit (Wei)
+ * into a human-readable Ether value.
+ *
+ * @param num - The value in Wei.
+ *
+ * @returns A string representing the value converted to Ether.
+ *
+ * @example
+ * fromWei(1000000000000000000)
+ * // "1.0"
+ */
+declare const fromWei: (value: bigint | string | number, decimals?: number) => string;
+/**
+ * Converts a value from Ether to Wei.
+ *
+ * Uses `ethers.parseEther` to convert a human-readable Ether value
+ * into Wei, the smallest Ethereum unit.
+ *
+ * @param num - The Ether value to convert.
+ *
+ * @returns A bigint representing the value in Wei.
+ *
+ * @example
+ * toWei(1)
+ * // 1000000000000000000n
+ */
+declare const toWei: (value: string, decimals?: number) => bigint;
+/**
+ * Formats an Ethereum address into a shortened, human-readable string.
+ *
+ * Keeps the first 4 characters of the address and a specified number of characters at the end.
+ * The middle (or end) can be replaced with a custom separator. Supported separators
+ * are `"..."`, `"-"`, `">"`, `"→"`.
+ *
+ * @param address - The full Ethereum address to format.
+ * @param options - Optional formatting options:
+ *   - `endChars` - Number of characters to keep at the end (default `6`).
+ *   - `separator` - String to place between start and end. Suggestions: `"..." | "-" | ">" | "→"` (default `"..."`).
+ *   - `position` - `"middle"` (default) or `"end"`. `"end"` appends the separator after the start characters.
+ *
+ * @returns The formatted address string.
+ *
+ * @example
+ * formatAddress("0x742d35Cc6634C0532925a3b844Bc454e4438f44e")
+ * // "0x74d3...38f44e"
+ *
+ * @example
+ * formatAddress("0x742d35Cc6634C0532925a3b844Bc454e4438f44e", { endChars: 4, separator: "→" })
+ * // "0x74d3→f44e"
+ *
+ * @example
+ * formatAddress("0x742d35Cc6634C0532925a3b844Bc454e4438f44e", { endChars: 0, separator: "...", position: "end" })
+ * // "0x74d3..."
+ */
+declare function formatAddress(address: string, options?: {
+    endChars?: number;
+    separator?: "..." | "-" | ">" | "→";
+    position?: "middle" | "end";
+}): string;
+
+export { type EvmAbiFunctionArgsTuple, type EvmAbiFunctionReturn, type EvmAbiType, type EvmAddressType, EvmChains, type EvmChainsType, type EvmConfigType, type EvmStoreType, create, createEventPoller, formatAddress, fromWei, mapEthersError, throwError, toWei };