ees-sdk/dist/src/EESSDK.d.ts

SDK for EES (Ethereum Execution Service)

import { TransactionReceipt, PublicClient, WalletClient, WatchEventReturnType } from 'viem';
import { Job, JobSpecification, FeeModuleInput, FeeCalculationMinimum, ContractCallOptions, ProtocolConfig, ExecutorInfo, EpochInfo, CommitData } from './types';
export declare class EESSDK {
    private publicClient;
    private walletClient;
    private protocolConfig;
    private constructor();
    static init(configProviderAddress: `0x${string}`, publicClient: PublicClient, walletClient?: WalletClient): Promise<EESSDK>;
    private fetchAndSetConfig;
    getAllowance(token: `0x${string}`, allower: `0x${string}`, spender: `0x${string}`): Promise<bigint>;
    getBalance(token: `0x${string}`, account: `0x${string}`): Promise<bigint>;
    getProtocolConfig(): ProtocolConfig;
    private checkProtocolConfig;
    getTokenPrice(oracleAddress: `0x${string}`, token: `0x${string}`, auxData: `0x${string}`): Promise<readonly [bigint, boolean]>;
    getJobsArrayLength(): Promise<bigint>;
    getJobs(indices: bigint[]): Promise<Job[]>;
    private executeTransaction;
    createJob(jobSpecification: JobSpecification, sponsor: `0x${string}`, sponsorSignature: `0x${string}`, ownerSignature: `0x${string}`, index: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
        jobIndex?: bigint;
    }>;
    deleteJob(index: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    watchCreatedJobs(application: `0x${string}`, onCreatedJob: (index: bigint) => any): WatchEventReturnType;
    watchExecutedJobs(application: `0x${string}`, onExecutedJob: (index: bigint) => any): WatchEventReturnType;
    watchDeletedJobs(application: `0x${string}`, onDeletedJob: (index: bigint) => any): WatchEventReturnType;
    signJobSpecificationSponsor(jobSpecification: JobSpecification): Promise<`0x${string}`>;
    signJobSpecificationOwner(jobSpecification: JobSpecification): Promise<`0x${string}`>;
    signFeeModuleInput(feeModuleInput: FeeModuleInput): Promise<`0x${string}`>;
    getExecutorInfo(executors: `0x${string}`[]): Promise<ExecutorInfo[]>;
    getEpochInfo(): Promise<EpochInfo>;
    getCommitData(executors: `0x${string}`[]): Promise<CommitData[]>;
    executeBatch(indices: bigint[], gasLimits: bigint[], feeRecipient: `0x${string}`, jobRegistryIndex: number, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
        failedIndices?: bigint[];
    }>;
    estimateBatchExecutionGas(indices: bigint[], gasLimits: bigint[], feeRecipient: `0x${string}`, jobRegistryIndex: number): Promise<bigint>;
    estimateExecutionGas(index: bigint, feeRecipient: `0x${string}`): Promise<bigint>;
    revokeSponsorship(index: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    approveFeeToken(token: `0x${string}`, amount: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    approveAppToken(application: `0x${string}`, token: `0x${string}`, amount: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    approveStakingToken(amount: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    calculateCurrentFee<T extends FeeCalculationMinimum>(job: T): Promise<{
        fee: bigint;
        token: `0x${string}`;
    } | null>;
    initiateEpoch(options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    stake(modules: `0x${string}`[], options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    unstake(options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    topup(amount: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    commit(epoch: bigint, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
        secret: `0x${string}`;
    }>;
    reveal(secret: `0x${string}`, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    slashInactiveExecutor(executor: `0x${string}`, recipient: `0x${string}`, round: number, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    slashCommitter(executor: `0x${string}`, recipient: `0x${string}`, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    batchSlash(committerExecutors: `0x${string}`[], inactiveExecutors: `0x${string}`[], rounds: number[], recipient: `0x${string}`, options?: ContractCallOptions): Promise<{
        transactionHash: `0x${string}`;
        transactionReceipt?: TransactionReceipt;
    }>;
    getEpoch(): Promise<bigint>;
    jobIsExpired(job: Job): boolean;
    jobInExecutionWindow(job: Job): boolean;
    jobIsDeleted(job: Job): boolean;
    modulesToBitset(modules: `0x${string}`[]): bigint;
    private formatJobData;
}