@arbitrum/sdk
Version:
Typescript library client-side interactions with Arbitrum
131 lines (130 loc) • 9.51 kB
TypeScript
import { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, PayableOverrides, PopulatedTransaction, Signer, utils } from "ethers";
import { FunctionFragment, Result } from "@ethersproject/abi";
import { Listener, Provider } from "@ethersproject/providers";
import { TypedEventFilter, TypedEvent, TypedListener, OnEvent } from "./common";
export interface IL1ArbitrumGatewayInterface extends utils.Interface {
contractName: "IL1ArbitrumGateway";
functions: {
"calculateL2TokenAddress(address)": FunctionFragment;
"finalizeInboundTransfer(address,address,address,uint256,bytes)": FunctionFragment;
"getOutboundCalldata(address,address,address,uint256,bytes)": FunctionFragment;
"inbox()": FunctionFragment;
"outboundTransfer(address,address,uint256,uint256,uint256,bytes)": FunctionFragment;
"outboundTransferCustomRefund(address,address,address,uint256,uint256,uint256,bytes)": FunctionFragment;
"supportsInterface(bytes4)": FunctionFragment;
};
encodeFunctionData(functionFragment: "calculateL2TokenAddress", values: [string]): string;
encodeFunctionData(functionFragment: "finalizeInboundTransfer", values: [string, string, string, BigNumberish, BytesLike]): string;
encodeFunctionData(functionFragment: "getOutboundCalldata", values: [string, string, string, BigNumberish, BytesLike]): string;
encodeFunctionData(functionFragment: "inbox", values?: undefined): string;
encodeFunctionData(functionFragment: "outboundTransfer", values: [
string,
string,
BigNumberish,
BigNumberish,
BigNumberish,
BytesLike
]): string;
encodeFunctionData(functionFragment: "outboundTransferCustomRefund", values: [
string,
string,
string,
BigNumberish,
BigNumberish,
BigNumberish,
BytesLike
]): string;
encodeFunctionData(functionFragment: "supportsInterface", values: [BytesLike]): string;
decodeFunctionResult(functionFragment: "calculateL2TokenAddress", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "finalizeInboundTransfer", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getOutboundCalldata", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "inbox", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "outboundTransfer", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "outboundTransferCustomRefund", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "supportsInterface", data: BytesLike): Result;
events: {};
}
export interface IL1ArbitrumGateway extends BaseContract {
contractName: "IL1ArbitrumGateway";
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: IL1ArbitrumGatewayInterface;
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: {
calculateL2TokenAddress(l1ERC20: string, overrides?: CallOverrides): Promise<[string]>;
finalizeInboundTransfer(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
getOutboundCalldata(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<[string]>;
inbox(overrides?: CallOverrides): Promise<[string]>;
outboundTransfer(_token: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
outboundTransferCustomRefund(_l1Token: string, _refundTo: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<[boolean]>;
};
calculateL2TokenAddress(l1ERC20: string, overrides?: CallOverrides): Promise<string>;
finalizeInboundTransfer(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
getOutboundCalldata(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<string>;
inbox(overrides?: CallOverrides): Promise<string>;
outboundTransfer(_token: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
outboundTransferCustomRefund(_l1Token: string, _refundTo: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<boolean>;
callStatic: {
calculateL2TokenAddress(l1ERC20: string, overrides?: CallOverrides): Promise<string>;
finalizeInboundTransfer(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<void>;
getOutboundCalldata(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<string>;
inbox(overrides?: CallOverrides): Promise<string>;
outboundTransfer(_token: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<string>;
outboundTransferCustomRefund(_l1Token: string, _refundTo: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<string>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<boolean>;
};
filters: {};
estimateGas: {
calculateL2TokenAddress(l1ERC20: string, overrides?: CallOverrides): Promise<BigNumber>;
finalizeInboundTransfer(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
getOutboundCalldata(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<BigNumber>;
inbox(overrides?: CallOverrides): Promise<BigNumber>;
outboundTransfer(_token: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
outboundTransferCustomRefund(_l1Token: string, _refundTo: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<BigNumber>;
};
populateTransaction: {
calculateL2TokenAddress(l1ERC20: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
finalizeInboundTransfer(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
getOutboundCalldata(_token: string, _from: string, _to: string, _amount: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>;
inbox(overrides?: CallOverrides): Promise<PopulatedTransaction>;
outboundTransfer(_token: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
outboundTransferCustomRefund(_l1Token: string, _refundTo: string, _to: string, _amount: BigNumberish, _maxGas: BigNumberish, _gasPriceBid: BigNumberish, _data: BytesLike, overrides?: PayableOverrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>;
};
}