@arbitrum/sdk
Version:
Typescript library client-side interactions with Arbitrum
318 lines (317 loc) • 19.2 kB
TypeScript
import { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, 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 L2GatewayTokenInterface extends utils.Interface {
contractName: "L2GatewayToken";
functions: {
"DOMAIN_SEPARATOR()": FunctionFragment;
"allowance(address,address)": FunctionFragment;
"approve(address,uint256)": FunctionFragment;
"balanceOf(address)": FunctionFragment;
"bridgeBurn(address,uint256)": FunctionFragment;
"bridgeMint(address,uint256)": FunctionFragment;
"decimals()": FunctionFragment;
"decreaseAllowance(address,uint256)": FunctionFragment;
"increaseAllowance(address,uint256)": FunctionFragment;
"l1Address()": FunctionFragment;
"l2Gateway()": FunctionFragment;
"name()": FunctionFragment;
"nonces(address)": FunctionFragment;
"permit(address,address,uint256,uint256,uint8,bytes32,bytes32)": FunctionFragment;
"symbol()": FunctionFragment;
"totalSupply()": FunctionFragment;
"transfer(address,uint256)": FunctionFragment;
"transferAndCall(address,uint256,bytes)": FunctionFragment;
"transferFrom(address,address,uint256)": FunctionFragment;
};
encodeFunctionData(functionFragment: "DOMAIN_SEPARATOR", values?: undefined): string;
encodeFunctionData(functionFragment: "allowance", values: [string, string]): string;
encodeFunctionData(functionFragment: "approve", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "balanceOf", values: [string]): string;
encodeFunctionData(functionFragment: "bridgeBurn", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "bridgeMint", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "decimals", values?: undefined): string;
encodeFunctionData(functionFragment: "decreaseAllowance", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "increaseAllowance", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "l1Address", values?: undefined): string;
encodeFunctionData(functionFragment: "l2Gateway", values?: undefined): string;
encodeFunctionData(functionFragment: "name", values?: undefined): string;
encodeFunctionData(functionFragment: "nonces", values: [string]): string;
encodeFunctionData(functionFragment: "permit", values: [
string,
string,
BigNumberish,
BigNumberish,
BigNumberish,
BytesLike,
BytesLike
]): string;
encodeFunctionData(functionFragment: "symbol", values?: undefined): string;
encodeFunctionData(functionFragment: "totalSupply", values?: undefined): string;
encodeFunctionData(functionFragment: "transfer", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "transferAndCall", values: [string, BigNumberish, BytesLike]): string;
encodeFunctionData(functionFragment: "transferFrom", values: [string, string, BigNumberish]): string;
decodeFunctionResult(functionFragment: "DOMAIN_SEPARATOR", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "allowance", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "approve", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "balanceOf", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "bridgeBurn", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "bridgeMint", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "decimals", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "decreaseAllowance", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "increaseAllowance", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "l1Address", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "l2Gateway", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "name", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "nonces", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "permit", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "symbol", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "totalSupply", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transfer", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transferAndCall", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transferFrom", data: BytesLike): Result;
events: {
"Approval(address,address,uint256)": EventFragment;
"Initialized(uint8)": EventFragment;
"Transfer(address,address,uint256,bytes)": EventFragment;
};
getEvent(nameOrSignatureOrTopic: "Approval"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Transfer"): EventFragment;
}
export type ApprovalEvent = TypedEvent<[
string,
string,
BigNumber
], {
owner: string;
spender: string;
value: BigNumber;
}>;
export type ApprovalEventFilter = TypedEventFilter<ApprovalEvent>;
export type InitializedEvent = TypedEvent<[number], {
version: number;
}>;
export type InitializedEventFilter = TypedEventFilter<InitializedEvent>;
export type Transfer_address_address_uint256_bytes_Event = TypedEvent<[
string,
string,
BigNumber,
string
], {
from: string;
to: string;
value: BigNumber;
data: string;
}>;
export type Transfer_address_address_uint256_bytes_EventFilter = TypedEventFilter<Transfer_address_address_uint256_bytes_Event>;
export type Transfer_address_address_uint256_Event = TypedEvent<[
string,
string,
BigNumber
], {
from: string;
to: string;
value: BigNumber;
}>;
export type Transfer_address_address_uint256_EventFilter = TypedEventFilter<Transfer_address_address_uint256_Event>;
export interface L2GatewayToken extends BaseContract {
contractName: "L2GatewayToken";
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: L2GatewayTokenInterface;
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: {
DOMAIN_SEPARATOR(overrides?: CallOverrides): Promise<[string]>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<[BigNumber]>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
balanceOf(account: string, overrides?: CallOverrides): Promise<[BigNumber]>;
bridgeBurn(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
bridgeMint(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
decimals(overrides?: CallOverrides): Promise<[number]>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
l1Address(overrides?: CallOverrides): Promise<[string]>;
l2Gateway(overrides?: CallOverrides): Promise<[string]>;
name(overrides?: CallOverrides): Promise<[string]>;
nonces(owner: string, overrides?: CallOverrides): Promise<[BigNumber]>;
permit(owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
symbol(overrides?: CallOverrides): Promise<[string]>;
totalSupply(overrides?: CallOverrides): Promise<[BigNumber]>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
transferAndCall(_to: string, _value: BigNumberish, _data: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
};
DOMAIN_SEPARATOR(overrides?: CallOverrides): Promise<string>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>;
bridgeBurn(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
bridgeMint(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
decimals(overrides?: CallOverrides): Promise<number>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
l1Address(overrides?: CallOverrides): Promise<string>;
l2Gateway(overrides?: CallOverrides): Promise<string>;
name(overrides?: CallOverrides): Promise<string>;
nonces(owner: string, overrides?: CallOverrides): Promise<BigNumber>;
permit(owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
symbol(overrides?: CallOverrides): Promise<string>;
totalSupply(overrides?: CallOverrides): Promise<BigNumber>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
transferAndCall(_to: string, _value: BigNumberish, _data: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<ContractTransaction>;
callStatic: {
DOMAIN_SEPARATOR(overrides?: CallOverrides): Promise<string>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>;
approve(spender: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>;
bridgeBurn(account: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>;
bridgeMint(account: string, amount: BigNumberish, overrides?: CallOverrides): Promise<void>;
decimals(overrides?: CallOverrides): Promise<number>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
l1Address(overrides?: CallOverrides): Promise<string>;
l2Gateway(overrides?: CallOverrides): Promise<string>;
name(overrides?: CallOverrides): Promise<string>;
nonces(owner: string, overrides?: CallOverrides): Promise<BigNumber>;
permit(owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: CallOverrides): Promise<void>;
symbol(overrides?: CallOverrides): Promise<string>;
totalSupply(overrides?: CallOverrides): Promise<BigNumber>;
transfer(to: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
transferAndCall(_to: string, _value: BigNumberish, _data: BytesLike, overrides?: CallOverrides): Promise<boolean>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
};
filters: {
"Approval(address,address,uint256)"(owner?: string | null, spender?: string | null, value?: null): ApprovalEventFilter;
Approval(owner?: string | null, spender?: string | null, value?: null): ApprovalEventFilter;
"Initialized(uint8)"(version?: null): InitializedEventFilter;
Initialized(version?: null): InitializedEventFilter;
"Transfer(address,address,uint256,bytes)"(from?: string | null, to?: string | null, value?: null, data?: null): Transfer_address_address_uint256_bytes_EventFilter;
"Transfer(address,address,uint256)"(from?: string | null, to?: string | null, value?: null): Transfer_address_address_uint256_EventFilter;
};
estimateGas: {
DOMAIN_SEPARATOR(overrides?: CallOverrides): Promise<BigNumber>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>;
bridgeBurn(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
bridgeMint(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
decimals(overrides?: CallOverrides): Promise<BigNumber>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
l1Address(overrides?: CallOverrides): Promise<BigNumber>;
l2Gateway(overrides?: CallOverrides): Promise<BigNumber>;
name(overrides?: CallOverrides): Promise<BigNumber>;
nonces(owner: string, overrides?: CallOverrides): Promise<BigNumber>;
permit(owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
symbol(overrides?: CallOverrides): Promise<BigNumber>;
totalSupply(overrides?: CallOverrides): Promise<BigNumber>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
transferAndCall(_to: string, _value: BigNumberish, _data: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<BigNumber>;
};
populateTransaction: {
DOMAIN_SEPARATOR(overrides?: CallOverrides): Promise<PopulatedTransaction>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
balanceOf(account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
bridgeBurn(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
bridgeMint(account: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
decimals(overrides?: CallOverrides): Promise<PopulatedTransaction>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
l1Address(overrides?: CallOverrides): Promise<PopulatedTransaction>;
l2Gateway(overrides?: CallOverrides): Promise<PopulatedTransaction>;
name(overrides?: CallOverrides): Promise<PopulatedTransaction>;
nonces(owner: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
permit(owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
symbol(overrides?: CallOverrides): Promise<PopulatedTransaction>;
totalSupply(overrides?: CallOverrides): Promise<PopulatedTransaction>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
transferAndCall(_to: string, _value: BigNumberish, _data: BytesLike, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string | Promise<string>;
}): Promise<PopulatedTransaction>;
};
}