Interface Router

interface Router {
    WETH9: TypedContractMethod<[], [string], "view">;
    [internal]: any;
    cancelSwap(bytes32): TypedContractMethod<[cancelIdentifier: BytesLike], [void], "nonpayable">;
    cancelSwap(bytes32,bool): TypedContractMethod<[cancelIdentifier: BytesLike, state: boolean], [void], "nonpayable">;
    execute(bytes,bytes[]): TypedContractMethod<[commands: BytesLike, inputs: BytesLike[]], [void], "payable">;
    execute(bytes,bytes[],uint256): TypedContractMethod<[commands: BytesLike, inputs: BytesLike[], deadline: BigNumberish], [void], "payable">;
    fallback: null | WrappedFallback;
    filters: {};
    interface: RouterInterface;
    onCatalystCall: TypedContractMethod<[purchasedTokens: BigNumberish, data: BytesLike], [void], "nonpayable">;
    runner: null | ContractRunner;
    swapIdentifier: TypedContractMethod<[arg0: AddressLike, arg1: BytesLike], [boolean], "view">;
    target: string | Addressable;
    addListener(event, listener): Promise<Router>;
    attach(target): BaseContract;
    connect(runner?): Router;
    deploymentTransaction(): null | ContractTransactionResponse;
    emit(event, ...args): Promise<boolean>;
    getAddress(): Promise<string>;
    getDeployedCode(): Promise<null | string>;
    getEvent(key): ContractEvent<any[]>;
    getFunction<T>(key): T;
    getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[cancelIdentifier: BytesLike], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[cancelIdentifier: BytesLike, state: boolean], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[commands: BytesLike, inputs: BytesLike[]], [void], "payable">;
    getFunction(nameOrSignature): TypedContractMethod<[commands: BytesLike, inputs: BytesLike[], deadline: BigNumberish], [void], "payable">;
    getFunction(nameOrSignature): TypedContractMethod<[purchasedTokens: BigNumberish, data: BytesLike], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[arg0: AddressLike, arg1: BytesLike], [boolean], "view">;
    listenerCount(event?): Promise<number>;
    listeners<TCEvent>(event): Promise<TypedListener<TCEvent>[]>;
    listeners(eventName?): Promise<Listener[]>;
    off(event, listener?): Promise<Router>;
    on<TCEvent>(event, listener): Promise<Router>;
    on<TCEvent>(filter, listener): Promise<Router>;
    once<TCEvent>(event, listener): Promise<Router>;
    once<TCEvent>(filter, listener): Promise<Router>;
    queryFilter<TCEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>;
    queryFilter<TCEvent>(filter, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>;
    queryTransaction(hash): Promise<EventLog[]>;
    removeAllListeners<TCEvent>(event?): Promise<Router>;
    removeListener(event, listener): Promise<Router>;
    waitForDeployment(): Promise<Router>;
}

Hierarchy

  • BaseContract
    • Router

Properties

WETH9 [internal] cancelSwap(bytes32) cancelSwap(bytes32,bool) execute(bytes,bytes[]) execute(bytes,bytes[],uint256) fallback filters interface onCatalystCall runner swapIdentifier target

Methods

addListener attach connect deploymentTransaction emit getAddress getDeployedCode getEvent getFunction listenerCount listeners off on once queryFilter queryTransaction removeAllListeners removeListener waitForDeployment

Properties

WETH9

WETH9: TypedContractMethod<[], [string], "view">

Readonly [internal]

[internal]: any

@_ignore:

cancelSwap(bytes32)

cancelSwap(bytes32): TypedContractMethod<[cancelIdentifier: BytesLike], [void], "nonpayable">

cancelSwap(bytes32,bool)

cancelSwap(bytes32,bool): TypedContractMethod<[cancelIdentifier: BytesLike, state: boolean], [void], "nonpayable">

execute(bytes,bytes[])

execute(bytes,bytes[]): TypedContractMethod<[commands: BytesLike, inputs: BytesLike[]], [void], "payable">

execute(bytes,bytes[],uint256)

execute(bytes,bytes[],uint256): TypedContractMethod<[commands: BytesLike, inputs: BytesLike[], deadline: BigNumberish], [void], "payable">

Readonly fallback

fallback: null | WrappedFallback

The fallback or receive function if any.

filters

filters: {}

Type declaration

    interface

    interface: RouterInterface

    onCatalystCall

    onCatalystCall: TypedContractMethod<[purchasedTokens: BigNumberish, data: BytesLike], [void], "nonpayable">

    Readonly runner

    runner: null | ContractRunner

    The connected runner. This is generally a [[Provider]] or a [[Signer]], which dictates what operations are supported.

    For example, a Contract connected to a [[Provider]] may only execute read-only operations.

    swapIdentifier

    swapIdentifier: TypedContractMethod<[arg0: AddressLike, arg1: BytesLike], [boolean], "view">

    Readonly target

    target: string | Addressable

    The target to connect to.

    This can be an address, ENS name or any [[Addressable]], such as another contract. To get the resovled address, use the getAddress method.

    Methods

    addListener

    • addListener(event, listener): Promise<Router>

    • Alias for [on].

      Parameters

      • event: ContractEventName
      • listener: Listener

      Returns Promise<Router>

    attach

    • attach(target): BaseContract

    • Return a new Contract instance with the same ABI and runner, but a different %%target%%.

      Parameters

      • target: string | Addressable

      Returns BaseContract

    connect

    deploymentTransaction

    • deploymentTransaction(): null | ContractTransactionResponse

    • Return the transaction used to deploy this contract.

      This is only available if this instance was returned from a [[ContractFactory]].

      Returns null | ContractTransactionResponse

    emit

    • emit(event, ...args): Promise<boolean>

    • Emit an %%event%% calling all listeners with %%args%%.

      Resolves to true if any listeners were called.

      Parameters

      • event: ContractEventName
      • Rest ...args: any[]

      Returns Promise<boolean>

    getAddress

    • getAddress(): Promise<string>

    • Return the resolved address of this Contract.

      Returns Promise<string>

    getDeployedCode

    • getDeployedCode(): Promise<null | string>

    • Return the deployed bytecode or null if no bytecode is found.

      Returns Promise<null | string>

    getEvent

    • getEvent(key): ContractEvent<any[]>

    • Return the event for a given name. This is useful when a contract event name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

      Parameters

      • key: string | EventFragment

      Returns ContractEvent<any[]>

    getFunction

    listenerCount

    • listenerCount(event?): Promise<number>

    • Resolves to the number of listeners of %%event%% or the total number of listeners if unspecified.

      Parameters

      • Optional event: ContractEventName

      Returns Promise<number>

    listeners

    off

    • off(event, listener?): Promise<Router>

    • Remove the %%listener%% from the listeners for %%event%% or remove all listeners if unspecified.

      Parameters

      • event: ContractEventName
      • Optional listener: Listener

      Returns Promise<Router>

    on

    once

    queryFilter

    queryTransaction

    • queryTransaction(hash): Promise<EventLog[]>

    • @_ignore:

      Parameters

      • hash: string

      Returns Promise<EventLog[]>

    removeAllListeners

    removeListener

    • removeListener(event, listener): Promise<Router>

    • Alias for [off].

      Parameters

      • event: ContractEventName
      • listener: Listener

      Returns Promise<Router>

    waitForDeployment

    Settings

    Member Visibility

    Theme

    On This Page

    WETH9[internal]cancelSwap(bytes32)cancelSwap(bytes32,bool)execute(bytes,bytes[])execute(bytes,bytes[],uint256)fallbackfiltersinterfaceonCatalystCallrunnerswapIdentifiertargetaddListenerattachconnectdeploymentTransactionemitgetAddressgetDeployedCodegetEventgetFunctionlistenerCountlistenersoffononcequeryFilterqueryTransactionremoveAllListenersremoveListenerwaitForDeployment