@m3s/wallet/dist/types/interfaces/index.d.ts

A flexible wallet interface supporting multiple blockchain wallet types, including EVM wallets and Web3Auth integration

import { ethers } from "ethers";
import { IAdapterIdentity, IAdapterLifecycle, NetworkConfig } from "@m3s/shared";
import { WalletEvent } from "../enums/index.js";
/**
 * Event emitter capabilities
 */
interface IEventEmitter {
    on(event: WalletEvent | string, listener: (...args: any[]) => void): void;
    off(event: WalletEvent | string, listener: (...args: any[]) => void): void;
}
/**
 * Message signing capabilities
 */
interface IMessageSigner {
    signMessage(message: string | Uint8Array): Promise<string>;
    verifySignature(message: string | Uint8Array | EIP712TypedData, signature: string, address: string): Promise<boolean>;
}
/**
 * Transaction signing and sending capabilities
 */
interface ITransactionHandler {
    signTransaction(tx: GenericTransactionData): Promise<string>;
    sendTransaction(tx: GenericTransactionData): Promise<string>;
}
/**
 * EIP-712 typed data signing capabilities
 */
interface ITypedDataSigner {
    signTypedData(data: EIP712TypedData): Promise<string>;
}
/**
 * Gas estimation and management for EVM chains
 */
interface IGasEstimation {
    getGasPrice(): Promise<bigint>;
    estimateGas(tx: GenericTransactionData): Promise<EstimatedFeeData>;
}
/**
 * Token operations for EVM chains
 */
interface ITokenOperations {
    callContract(to: string, data: string): Promise<string>;
}
/**
 * Transaction receipt and status checking
 */
interface ITransactionStatus {
    getTransactionReceipt(txHash: string): Promise<ethers.TransactionReceipt | null>;
}
interface IRPCHandler {
    /**
     * Get ALL configured RPC URLs for ALL chains
     */
    getAllChainRpcs(): Record<string, string[]>;
    /**
     * Update ALL RPC configurations at once
     */
    updateAllChainRpcs(multiChainRpcs: Record<string, string[]>): Promise<void>;
}
/**
 * Core wallet interface - only essential wallet operations
 */
export interface ICoreWallet extends IAdapterIdentity, IAdapterLifecycle {
    disconnect(): void | Promise<void>;
    isConnected(): boolean;
    getAccounts(): Promise<string[]>;
    getBalance(account?: string): Promise<AssetBalance>;
    getNetwork(): Promise<NetworkConfig>;
    setProvider(providerConfig: NetworkConfig): Promise<void>;
}
/**
 * Complete EVM wallet interface - composed of all EVM-specific capabilities
 */
export interface IEVMWallet extends ICoreWallet, IEventEmitter, IMessageSigner, ITransactionHandler, ITypedDataSigner, IGasEstimation, ITokenOperations, IRPCHandler, ITransactionStatus {
    callContract(to: string, data: string): Promise<string>;
}
export interface EIP712TypedData {
    /**
     * The EIP-712 domain separator components.
     */
    domain: {
        name?: string;
        version?: string;
        chainId?: string | number | bigint;
        verifyingContract?: string;
        salt?: string | Uint8Array;
    };
    /**
     * The type definitions for the structured data.
     * Maps type names to arrays of fields (name and type).
     */
    types: Record<string, Array<{
        name: string;
        type: string;
    }>>;
    /**
     * The primary data object (value) to be signed.
     * Its structure must correspond to the definitions in `types`.
     */
    value: Record<string, any>;
}
export interface GenericTransactionData {
    to?: string;
    /** Amount of the native asset to send (e.g., "0.01" for ETH, "1000000" for lamports). Adapter handles conversion. */
    value?: string;
    /** Transaction data or payload. */
    data?: string | Uint8Array;
    /** Adapter-specific options (e.g., gas settings, compute units, nonce). */
    options?: TransactionOptions;
}
export interface AssetBalance {
    /** The raw balance amount in the smallest unit (e.g., wei, lamports). */
    amount: string;
    /** The number of decimals for the asset. */
    decimals: number;
    /** The symbol of the native asset (e.g., "ETH", "SOL"). */
    symbol: string;
    /** Optional: A human-readable formatted version of the balance. */
    formattedAmount?: string;
}
export interface EstimatedFeeData {
    gasLimit: bigint | string;
    gasPrice?: string;
    maxFeePerGas?: string;
    maxPriorityFeePerGas?: string;
}
interface TransactionOptions {
    chainId?: number | string;
    gasLimit?: string | bigint;
    gasPrice?: string;
    maxFeePerGas?: string;
    maxPriorityFeePerGas?: string;
    nonce?: number;
    [key: string]: any;
}
export {};
//# sourceMappingURL=index.d.ts.map