@arbitrum/sdk/dist/lib/abi/ArbSys.d.ts

Typescript library client-side interactions with Arbitrum

import { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, PayableOverrides, PopulatedTransaction, Signer, utils } from "ethers";
import { FunctionFragment, Result, EventFragment } from "@ethersproject/abi";
import { Listener, Provider } from "@ethersproject/providers";
import { TypedEventFilter, TypedEvent, TypedListener, OnEvent } from "./common";
export interface ArbSysInterface extends utils.Interface {
    contractName: "ArbSys";
    functions: {
        "arbBlockHash(uint256)": FunctionFragment;
        "arbBlockNumber()": FunctionFragment;
        "arbChainID()": FunctionFragment;
        "arbOSVersion()": FunctionFragment;
        "getStorageGasAvailable()": FunctionFragment;
        "isTopLevelCall()": FunctionFragment;
        "mapL1SenderContractAddressToL2Alias(address,address)": FunctionFragment;
        "myCallersAddressWithoutAliasing()": FunctionFragment;
        "sendMerkleTreeState()": FunctionFragment;
        "sendTxToL1(address,bytes)": FunctionFragment;
        "wasMyCallersAddressAliased()": FunctionFragment;
        "withdrawEth(address)": FunctionFragment;
    };
    encodeFunctionData(functionFragment: "arbBlockHash", values: [BigNumberish]): string;
    encodeFunctionData(functionFragment: "arbBlockNumber", values?: undefined): string;
    encodeFunctionData(functionFragment: "arbChainID", values?: undefined): string;
    encodeFunctionData(functionFragment: "arbOSVersion", values?: undefined): string;
    encodeFunctionData(functionFragment: "getStorageGasAvailable", values?: undefined): string;
    encodeFunctionData(functionFragment: "isTopLevelCall", values?: undefined): string;
    encodeFunctionData(functionFragment: "mapL1SenderContractAddressToL2Alias", values: [string, string]): string;
    encodeFunctionData(functionFragment: "myCallersAddressWithoutAliasing", values?: undefined): string;
    encodeFunctionData(functionFragment: "sendMerkleTreeState", values?: undefined): string;
    encodeFunctionData(functionFragment: "sendTxToL1", values: [string, BytesLike]): string;
    encodeFunctionData(functionFragment: "wasMyCallersAddressAliased", values?: undefined): string;
    encodeFunctionData(functionFragment: "withdrawEth", values: [string]): string;
    decodeFunctionResult(functionFragment: "arbBlockHash", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "arbBlockNumber", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "arbChainID", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "arbOSVersion", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getStorageGasAvailable", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "isTopLevelCall", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "mapL1SenderContractAddressToL2Alias", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "myCallersAddressWithoutAliasing", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "sendMerkleTreeState", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "sendTxToL1", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "wasMyCallersAddressAliased", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "withdrawEth", data: BytesLike): Result;
    events: {
        "L2ToL1Transaction(address,address,uint256,uint256,uint256,uint256,uint256,uint256,uint256,bytes)": EventFragment;
        "L2ToL1Tx(address,address,uint256,uint256,uint256,uint256,uint256,uint256,bytes)": EventFragment;
        "SendMerkleUpdate(uint256,bytes32,uint256)": EventFragment;
    };
    getEvent(nameOrSignatureOrTopic: "L2ToL1Transaction"): EventFragment;
    getEvent(nameOrSignatureOrTopic: "L2ToL1Tx"): EventFragment;
    getEvent(nameOrSignatureOrTopic: "SendMerkleUpdate"): EventFragment;
}
export type L2ToL1TransactionEvent = TypedEvent<[
    string,
    string,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    string
], {
    caller: string;
    destination: string;
    uniqueId: BigNumber;
    batchNumber: BigNumber;
    indexInBatch: BigNumber;
    arbBlockNum: BigNumber;
    ethBlockNum: BigNumber;
    timestamp: BigNumber;
    callvalue: BigNumber;
    data: string;
}>;
export type L2ToL1TransactionEventFilter = TypedEventFilter<L2ToL1TransactionEvent>;
export type L2ToL1TxEvent = TypedEvent<[
    string,
    string,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    string
], {
    caller: string;
    destination: string;
    hash: BigNumber;
    position: BigNumber;
    arbBlockNum: BigNumber;
    ethBlockNum: BigNumber;
    timestamp: BigNumber;
    callvalue: BigNumber;
    data: string;
}>;
export type L2ToL1TxEventFilter = TypedEventFilter<L2ToL1TxEvent>;
export type SendMerkleUpdateEvent = TypedEvent<[
    BigNumber,
    string,
    BigNumber
], {
    reserved: BigNumber;
    hash: string;
    position: BigNumber;
}>;
export type SendMerkleUpdateEventFilter = TypedEventFilter<SendMerkleUpdateEvent>;
export interface ArbSys extends BaseContract {
    contractName: "ArbSys";
    connect(signerOrProvider: Signer | Provider | string): this;
    attach(addressOrName: string): this;
    deployed(): Promise<this>;
    interface: ArbSysInterface;
    queryFilter<TEvent extends TypedEvent>(event: TypedEventFilter<TEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TEvent>>;
    listeners<TEvent extends TypedEvent>(eventFilter?: TypedEventFilter<TEvent>): Array<TypedListener<TEvent>>;
    listeners(eventName?: string): Array<Listener>;
    removeAllListeners<TEvent extends TypedEvent>(eventFilter: TypedEventFilter<TEvent>): this;
    removeAllListeners(eventName?: string): this;
    off: OnEvent<this>;
    on: OnEvent<this>;
    once: OnEvent<this>;
    removeListener: OnEvent<this>;
    functions: {
        arbBlockHash(arbBlockNum: BigNumberish, overrides?: CallOverrides): Promise<[string]>;
        arbBlockNumber(overrides?: CallOverrides): Promise<[BigNumber]>;
        arbChainID(overrides?: CallOverrides): Promise<[BigNumber]>;
        arbOSVersion(overrides?: CallOverrides): Promise<[BigNumber]>;
        getStorageGasAvailable(overrides?: CallOverrides): Promise<[BigNumber]>;
        isTopLevelCall(overrides?: CallOverrides): Promise<[boolean]>;
        mapL1SenderContractAddressToL2Alias(sender: string, unused: string, overrides?: CallOverrides): Promise<[string]>;
        myCallersAddressWithoutAliasing(overrides?: CallOverrides): Promise<[string]>;
        sendMerkleTreeState(overrides?: CallOverrides): Promise<[
            BigNumber,
            string,
            string[]
        ] & {
            size: BigNumber;
            root: string;
            partials: string[];
        }>;
        sendTxToL1(destination: string, data: BytesLike, overrides?: PayableOverrides & {
            from?: string | Promise<string>;
        }): Promise<ContractTransaction>;
        wasMyCallersAddressAliased(overrides?: CallOverrides): Promise<[boolean]>;
        withdrawEth(destination: string, overrides?: PayableOverrides & {
            from?: string | Promise<string>;
        }): Promise<ContractTransaction>;
    };
    arbBlockHash(arbBlockNum: BigNumberish, overrides?: CallOverrides): Promise<string>;
    arbBlockNumber(overrides?: CallOverrides): Promise<BigNumber>;
    arbChainID(overrides?: CallOverrides): Promise<BigNumber>;
    arbOSVersion(overrides?: CallOverrides): Promise<BigNumber>;
    getStorageGasAvailable(overrides?: CallOverrides): Promise<BigNumber>;
    isTopLevelCall(overrides?: CallOverrides): Promise<boolean>;
    mapL1SenderContractAddressToL2Alias(sender: string, unused: string, overrides?: CallOverrides): Promise<string>;
    myCallersAddressWithoutAliasing(overrides?: CallOverrides): Promise<string>;
    sendMerkleTreeState(overrides?: CallOverrides): Promise<[
        BigNumber,
        string,
        string[]
    ] & {
        size: BigNumber;
        root: string;
        partials: string[];
    }>;
    sendTxToL1(destination: string, data: BytesLike, overrides?: PayableOverrides & {
        from?: string | Promise<string>;
    }): Promise<ContractTransaction>;
    wasMyCallersAddressAliased(overrides?: CallOverrides): Promise<boolean>;
    withdrawEth(destination: string, overrides?: PayableOverrides & {
        from?: string | Promise<string>;
    }): Promise<ContractTransaction>;
    callStatic: {
        arbBlockHash(arbBlockNum: BigNumberish, overrides?: CallOverrides): Promise<string>;
        arbBlockNumber(overrides?: CallOverrides): Promise<BigNumber>;
        arbChainID(overrides?: CallOverrides): Promise<BigNumber>;
        arbOSVersion(overrides?: CallOverrides): Promise<BigNumber>;
        getStorageGasAvailable(overrides?: CallOverrides): Promise<BigNumber>;
        isTopLevelCall(overrides?: CallOverrides): Promise<boolean>;
        mapL1SenderContractAddressToL2Alias(sender: string, unused: string, overrides?: CallOverrides): Promise<string>;
        myCallersAddressWithoutAliasing(overrides?: CallOverrides): Promise<string>;
        sendMerkleTreeState(overrides?: CallOverrides): Promise<[
            BigNumber,
            string,
            string[]
        ] & {
            size: BigNumber;
            root: string;
            partials: string[];
        }>;
        sendTxToL1(destination: string, data: BytesLike, overrides?: CallOverrides): Promise<BigNumber>;
        wasMyCallersAddressAliased(overrides?: CallOverrides): Promise<boolean>;
        withdrawEth(destination: string, overrides?: CallOverrides): Promise<BigNumber>;
    };
    filters: {
        "L2ToL1Transaction(address,address,uint256,uint256,uint256,uint256,uint256,uint256,uint256,bytes)"(caller?: null, destination?: string | null, uniqueId?: BigNumberish | null, batchNumber?: BigNumberish | null, indexInBatch?: null, arbBlockNum?: null, ethBlockNum?: null, timestamp?: null, callvalue?: null, data?: null): L2ToL1TransactionEventFilter;
        L2ToL1Transaction(caller?: null, destination?: string | null, uniqueId?: BigNumberish | null, batchNumber?: BigNumberish | null, indexInBatch?: null, arbBlockNum?: null, ethBlockNum?: null, timestamp?: null, callvalue?: null, data?: null): L2ToL1TransactionEventFilter;
        "L2ToL1Tx(address,address,uint256,uint256,uint256,uint256,uint256,uint256,bytes)"(caller?: null, destination?: string | null, hash?: BigNumberish | null, position?: BigNumberish | null, arbBlockNum?: null, ethBlockNum?: null, timestamp?: null, callvalue?: null, data?: null): L2ToL1TxEventFilter;
        L2ToL1Tx(caller?: null, destination?: string | null, hash?: BigNumberish | null, position?: BigNumberish | null, arbBlockNum?: null, ethBlockNum?: null, timestamp?: null, callvalue?: null, data?: null): L2ToL1TxEventFilter;
        "SendMerkleUpdate(uint256,bytes32,uint256)"(reserved?: BigNumberish | null, hash?: BytesLike | null, position?: BigNumberish | null): SendMerkleUpdateEventFilter;
        SendMerkleUpdate(reserved?: BigNumberish | null, hash?: BytesLike | null, position?: BigNumberish | null): SendMerkleUpdateEventFilter;
    };
    estimateGas: {
        arbBlockHash(arbBlockNum: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
        arbBlockNumber(overrides?: CallOverrides): Promise<BigNumber>;
        arbChainID(overrides?: CallOverrides): Promise<BigNumber>;
        arbOSVersion(overrides?: CallOverrides): Promise<BigNumber>;
        getStorageGasAvailable(overrides?: CallOverrides): Promise<BigNumber>;
        isTopLevelCall(overrides?: CallOverrides): Promise<BigNumber>;
        mapL1SenderContractAddressToL2Alias(sender: string, unused: string, overrides?: CallOverrides): Promise<BigNumber>;
        myCallersAddressWithoutAliasing(overrides?: CallOverrides): Promise<BigNumber>;
        sendMerkleTreeState(overrides?: CallOverrides): Promise<BigNumber>;
        sendTxToL1(destination: string, data: BytesLike, overrides?: PayableOverrides & {
            from?: string | Promise<string>;
        }): Promise<BigNumber>;
        wasMyCallersAddressAliased(overrides?: CallOverrides): Promise<BigNumber>;
        withdrawEth(destination: string, overrides?: PayableOverrides & {
            from?: string | Promise<string>;
        }): Promise<BigNumber>;
    };
    populateTransaction: {
        arbBlockHash(arbBlockNum: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        arbBlockNumber(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        arbChainID(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        arbOSVersion(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        getStorageGasAvailable(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        isTopLevelCall(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        mapL1SenderContractAddressToL2Alias(sender: string, unused: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        myCallersAddressWithoutAliasing(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        sendMerkleTreeState(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        sendTxToL1(destination: string, data: BytesLike, overrides?: PayableOverrides & {
            from?: string | Promise<string>;
        }): Promise<PopulatedTransaction>;
        wasMyCallersAddressAliased(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        withdrawEth(destination: string, overrides?: PayableOverrides & {
            from?: string | Promise<string>;
        }): Promise<PopulatedTransaction>;
    };
}