@arbitrum/sdk
Version:
Typescript library client-side interactions with Arbitrum
159 lines (158 loc) • 7.61 kB
TypeScript
import { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, 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 declare namespace IL2Forwarder {
type L2ForwarderParamsStruct = {
owner: string;
l2Token: string;
l3FeeTokenL2Addr: string;
routerOrInbox: string;
to: string;
gasLimit: BigNumberish;
gasPriceBid: BigNumberish;
maxSubmissionCost: BigNumberish;
};
type L2ForwarderParamsStructOutput = [
string,
string,
string,
string,
string,
BigNumber,
BigNumber,
BigNumber
] & {
owner: string;
l2Token: string;
l3FeeTokenL2Addr: string;
routerOrInbox: string;
to: string;
gasLimit: BigNumber;
gasPriceBid: BigNumber;
maxSubmissionCost: BigNumber;
};
}
export interface L2ForwarderInterface extends utils.Interface {
contractName: "L2Forwarder";
functions: {
"bridgeToL3((address,address,address,address,address,uint256,uint256,uint256))": FunctionFragment;
"initialize(address)": FunctionFragment;
"l2ForwarderFactory()": FunctionFragment;
"owner()": FunctionFragment;
"rescue(address[],uint256[],bytes[])": FunctionFragment;
};
encodeFunctionData(functionFragment: "bridgeToL3", values: [IL2Forwarder.L2ForwarderParamsStruct]): string;
encodeFunctionData(functionFragment: "initialize", values: [string]): string;
encodeFunctionData(functionFragment: "l2ForwarderFactory", values?: undefined): string;
encodeFunctionData(functionFragment: "owner", values?: undefined): string;
encodeFunctionData(functionFragment: "rescue", values: [string[], BigNumberish[], BytesLike[]]): string;
decodeFunctionResult(functionFragment: "bridgeToL3", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "l2ForwarderFactory", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "rescue", data: BytesLike): Result;
events: {
"BridgedToL3(uint256,uint256)": EventFragment;
"Rescued(address[],uint256[],bytes[])": EventFragment;
};
getEvent(nameOrSignatureOrTopic: "BridgedToL3"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Rescued"): EventFragment;
}
export type BridgedToL3Event = TypedEvent<[
BigNumber,
BigNumber
], {
tokenAmount: BigNumber;
feeAmount: BigNumber;
}>;
export type BridgedToL3EventFilter = TypedEventFilter<BridgedToL3Event>;
export type RescuedEvent = TypedEvent<[
string[],
BigNumber[],
string[]
], {
targets: string[];
values: BigNumber[];
datas: string[];
}>;
export type RescuedEventFilter = TypedEventFilter<RescuedEvent>;
export interface L2Forwarder extends BaseContract {
contractName: "L2Forwarder";
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: L2ForwarderInterface;
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: {
bridgeToL3(params: IL2Forwarder.L2ForwarderParamsStruct, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
initialize(_owner: string, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
l2ForwarderFactory(overrides?: CallOverrides): Promise<[string]>;
owner(overrides?: CallOverrides): Promise<[string]>;
rescue(targets: string[], values: BigNumberish[], datas: BytesLike[], overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
};
bridgeToL3(params: IL2Forwarder.L2ForwarderParamsStruct, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
initialize(_owner: string, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
l2ForwarderFactory(overrides?: CallOverrides): Promise<string>;
owner(overrides?: CallOverrides): Promise<string>;
rescue(targets: string[], values: BigNumberish[], datas: BytesLike[], overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
callStatic: {
bridgeToL3(params: IL2Forwarder.L2ForwarderParamsStruct, overrides?: CallOverrides): Promise<void>;
initialize(_owner: string, overrides?: CallOverrides): Promise<void>;
l2ForwarderFactory(overrides?: CallOverrides): Promise<string>;
owner(overrides?: CallOverrides): Promise<string>;
rescue(targets: string[], values: BigNumberish[], datas: BytesLike[], overrides?: CallOverrides): Promise<void>;
};
filters: {
"BridgedToL3(uint256,uint256)"(tokenAmount?: null, feeAmount?: null): BridgedToL3EventFilter;
BridgedToL3(tokenAmount?: null, feeAmount?: null): BridgedToL3EventFilter;
"Rescued(address[],uint256[],bytes[])"(targets?: null, values?: null, datas?: null): RescuedEventFilter;
Rescued(targets?: null, values?: null, datas?: null): RescuedEventFilter;
};
estimateGas: {
bridgeToL3(params: IL2Forwarder.L2ForwarderParamsStruct, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
initialize(_owner: string, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
l2ForwarderFactory(overrides?: CallOverrides): Promise<BigNumber>;
owner(overrides?: CallOverrides): Promise<BigNumber>;
rescue(targets: string[], values: BigNumberish[], datas: BytesLike[], overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
};
populateTransaction: {
bridgeToL3(params: IL2Forwarder.L2ForwarderParamsStruct, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
initialize(_owner: string, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
l2ForwarderFactory(overrides?: CallOverrides): Promise<PopulatedTransaction>;
owner(overrides?: CallOverrides): Promise<PopulatedTransaction>;
rescue(targets: string[], values: BigNumberish[], datas: BytesLike[], overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
};
}