soul-wallet-lib/dist/utils/bundler.d.ts

The EIP-4337 library for Soul-Wallet

/// <reference types="node" />
import { ethers } from "ethers";
import { UserOperation } from "../entity/userOperation";
import EventEmitter from 'events';
import { IUserOpReceipt } from "../interface/IUserOpReceipt";
import { IResult } from "../interface/IResult";
import { IEstimateUserOpGasResult } from "../interface/IEstimateUserOpGasResult";
import { IUserOperation } from "../interface/IUserOperation";
export declare class ApiTimeOut {
    web3ApiRequestTimeout: number;
    web3ApiResponseTimeout: number;
    bundlerApiRequestTimeout: number;
    bundlerApiResponseTimeout: number;
}
/**
 * bundler utils
 * @class Bundler
 */
export declare class Bundler {
    private _entryPoint;
    private _etherProvider;
    private _bundlerApi?;
    private _eoaPrivateKey?;
    private _wallet?;
    private _entryPointContract?;
    private _timeout;
    private _chainId;
    /**
     * Bundler utils
     * @constructor Bundler
     * @param {String} entryPoint the entry point address
     * @param {ethers.providers.BaseProvider} etherProvider the ethers.js provider e.g. ethers.provider
     * @param {String} bundlerApiOrEOAPrivateKey the bundler api url or the EOA private key
     * @param {ApiTimeOut?} timeout the timeout
     * @returns {Bundler}
     */
    constructor(entryPoint: string, etherProvider: ethers.providers.BaseProvider, bundlerApiOrEOAPrivateKey: string, timeout?: ApiTimeOut);
    private rpcRequest;
    private _init;
    /**
     * init the bundler
     * @returns {Promise<void>}
     */
    init(): Promise<void>;
    /**
     * get bundler supported chainid
     * @returns {Promise<String>} supported chainid
     */
    eth_chainId(timeout?: number): Promise<string>;
    /**
     * get bundler supported entry points
     * @returns {Promise<String[]>} supported entry points
     */
    eth_supportedEntryPoints(timeout?: number): Promise<string[]>;
    /**
     * send user operation via bundler
     * @param {UserOperation} userOp
     * @returns {Promise<String>} user operation hash
     */
    eth_sendUserOperation(userOp: UserOperation, timeout?: number): Promise<string>;
    private recoveryWallet;
    /**
     *
     *
     * @param {UserOperation} userOp
     * @param {number} [timeout]
     * @return {*}  {Promise<IEstimateUserOpGasResult>}
     * @memberof Bundler
     */
    eth_estimateUserOperationGas(userOp: UserOperation, timeout?: number): Promise<IEstimateUserOpGasResult>;
    private _getUserOperationEvent;
    eth_getUserOperationReceipt(userOpHash: string, timeout?: number): Promise<IUserOpReceipt | {
        userOpHash: string;
        sender: any;
        nonce: any;
        actualGasCost: any;
        actualGasUsed: any;
        success: any;
        logs: never[];
        receipt: ethers.providers.TransactionReceipt;
    } | null>;
    eth_getUserOperationByHash(userOpHash: string): Promise<void>;
    private sleep;
    /**
     * send user operation via bundler
     *
     * @param {UserOperation} userOp
     * @param {number} [timeout] default 30s
     * @param {number} [receiptTimeout=0]
     * @param {number} [receiptInterval=1000 * 6]
     * @return {*}
     * @memberof Bundler
     */
    sendUserOperation(userOp: UserOperation, timeout?: number, receiptTimeout?: number, receiptInterval?: number): EventEmitter;
    private decodeExecutionResult;
    private decodeFailedOp;
    private decodeValidationResult;
    /**
     * “semi-valid” signature for calculating the gas cost
     *
     * @param {UserOperation} op
     * @return {*}  {UserOperation}
     * @memberof Bundler
     */
    semiValidSignature(op: UserOperation): IUserOperation;
    /**
     * simulateHandleOp
     * @param {UserOperation} op
     * @returns {Promise<IResult>} result
     */
    simulateHandleOp(op: UserOperation, target?: string, targetCallData?: string): Promise<IResult>;
    /**
     * simulateValidation
     * @param {UserOperation} op
     * @returns {Promise<IResult>} result
     */
    simulateValidation(op: UserOperation): Promise<IResult>;
    private _simulateValidation;
}