Interface IOracleAdapter

Hierarchy

  • BaseContract
    • IOracleAdapter

Properties

[internal] describePricingPath fallback filters getPrice getPriceAt interface isPairSupported runner target upsertPair

Methods

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

Properties

Readonly [internal]

[internal]: any

@_ignore:

describePricingPath

describePricingPath: TypedContractMethod<[token: AddressLike], [[bigint, string[][], bigint[]] & {
    adapterType: bigint;
    decimals: bigint[];
    path: string[][];
}], "view">

Readonly fallback

fallback: null | WrappedFallback

The fallback or receive function if any.

filters

filters: {}

Type declaration

    getPrice

    getPrice: TypedContractMethod<[tokenIn: AddressLike, tokenOut: AddressLike], [bigint], "view">

    getPriceAt

    getPriceAt: TypedContractMethod<[tokenIn: AddressLike, tokenOut: AddressLike, target: BigNumberish], [bigint], "view">

    interface

    interface: IOracleAdapterInterface

    isPairSupported

    isPairSupported: TypedContractMethod<[tokenA: AddressLike, tokenB: AddressLike], [[boolean, boolean] & {
        hasPath: boolean;
        isCached: boolean;
    }], "view">

    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.

    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.

    upsertPair

    upsertPair: TypedContractMethod<[tokenA: AddressLike, tokenB: AddressLike], [void], "nonpayable">

    Methods

    addListener

    • Alias for [on].

      Parameters

      • event: ContractEventName
      • listener: Listener

      Returns Promise<IOracleAdapter>

    attach

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

      Parameters

      • target: string | Addressable

      Returns BaseContract

    connect

    • Parameters

      • Optional runner: null | ContractRunner

      Returns IOracleAdapter

    deploymentTransaction

    • 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 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

    • Return the resolved address of this Contract.

      Returns Promise<string>

    getDeployedCode

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

      Returns Promise<null | string>

    getEvent

    • 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

    • Type Parameters

      • T extends ContractMethod<any[], any, any, T> = ContractMethod<any[], any, any>

      Parameters

      • key: string | FunctionFragment

      Returns T

    • Parameters

      • nameOrSignature: "describePricingPath"

      Returns TypedContractMethod<[token: AddressLike], [[bigint, string[][], bigint[]] & {
          adapterType: bigint;
          decimals: bigint[];
          path: string[][];
      }], "view">

    • Parameters

      • nameOrSignature: "getPrice"

      Returns TypedContractMethod<[tokenIn: AddressLike, tokenOut: AddressLike], [bigint], "view">

    • Parameters

      • nameOrSignature: "getPriceAt"

      Returns TypedContractMethod<[tokenIn: AddressLike, tokenOut: AddressLike, target: BigNumberish], [bigint], "view">

    • Parameters

      • nameOrSignature: "isPairSupported"

      Returns TypedContractMethod<[tokenA: AddressLike, tokenB: AddressLike], [[boolean, boolean] & {
          hasPath: boolean;
          isCached: boolean;
      }], "view">

    • Parameters

      • nameOrSignature: "upsertPair"

      Returns TypedContractMethod<[tokenA: AddressLike, tokenB: AddressLike], [void], "nonpayable">

    listenerCount

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

      Parameters

      • Optional event: ContractEventName

      Returns Promise<number>

    listeners

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • event: TCEvent

      Returns Promise<TypedListener<TCEvent>[]>

    • Parameters

      • Optional eventName: string

      Returns Promise<Listener[]>

    off

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

      Parameters

      • event: ContractEventName
      • Optional listener: Listener

      Returns Promise<IOracleAdapter>

    on

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • event: TCEvent
      • listener: TypedListener<TCEvent>

      Returns Promise<IOracleAdapter>

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • filter: TypedDeferredTopicFilter<TCEvent>
      • listener: TypedListener<TCEvent>

      Returns Promise<IOracleAdapter>

    once

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • event: TCEvent
      • listener: TypedListener<TCEvent>

      Returns Promise<IOracleAdapter>

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • filter: TypedDeferredTopicFilter<TCEvent>
      • listener: TypedListener<TCEvent>

      Returns Promise<IOracleAdapter>

    queryFilter

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • event: TCEvent
      • Optional fromBlockOrBlockhash: string | number
      • Optional toBlock: string | number

      Returns Promise<TypedEventLog<TCEvent>[]>

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • filter: TypedDeferredTopicFilter<TCEvent>
      • Optional fromBlockOrBlockhash: string | number
      • Optional toBlock: string | number

      Returns Promise<TypedEventLog<TCEvent>[]>

    queryTransaction

    • @_ignore:

      Parameters

      • hash: string

      Returns Promise<EventLog[]>

    removeAllListeners

    • Type Parameters

      • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

      Parameters

      • Optional event: TCEvent

      Returns Promise<IOracleAdapter>

    removeListener

    • Alias for [off].

      Parameters

      • event: ContractEventName
      • listener: Listener

      Returns Promise<IOracleAdapter>

    waitForDeployment

    • Returns Promise<IOracleAdapter>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc