Interface IExchangeHelper

Hierarchy

BaseContract
- IExchangeHelper

Properties

`Readonly` [internal]

[internal]: any

@_ignore:

`Readonly` fallback

fallback: null | WrappedFallback

The fallback or receive function if any.

filters

filters: {}

Type declaration

interface

interface: IExchangeHelperInterface

`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.

swapWithToken

swapWithToken: TypedContractMethod<[sourceToken: AddressLike, targetToken: AddressLike, sourceTokenAmount: BigNumberish, callee: AddressLike, allowanceTarget: AddressLike, data: BytesLike, refundAddress: AddressLike], [[bigint, bigint] & {
amountOut: bigint;
sourceLeft: bigint;
}], "nonpayable">

`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<IExchangeHelper>
Alias for [on].
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IExchangeHelper>
Inherited from BaseContract.addListener
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:147

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
Inherited from BaseContract.attach
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:66

connect

connect(runner?): IExchangeHelper
Parameters
- Optional runner: null | ContractRunner
Returns IExchangeHelper
Overrides BaseContract.connect
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:17

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
Inherited from BaseContract.deploymentTransaction
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:86

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>
Inherited from BaseContract.emit
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:123

getAddress

getAddress(): Promise<string>
Return the resolved address of this Contract.

Returns Promise<string>
Inherited from BaseContract.getAddress
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:70

getDeployedCode

getDeployedCode(): Promise<null | string>
Return the deployed bytecode or null if no bytecode is found.

Returns Promise<null | string>
Inherited from BaseContract.getDeployedCode
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:74

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[]>
Inherited from BaseContract.getEvent
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:98

getFunction

getFunction<T>(key): T
Type Parameters
- T extends ContractMethod<any[], any, any, T> = ContractMethod<any[], any, any>
Parameters
- key: string | FunctionFragment
Returns T
Overrides BaseContract.getFunction
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:43
getFunction(nameOrSignature): TypedContractMethod<[sourceToken: AddressLike, targetToken: AddressLike, sourceTokenAmount: BigNumberish, callee: AddressLike, allowanceTarget: AddressLike, data: BytesLike, refundAddress: AddressLike], [[bigint, bigint] & {
amountOut: bigint;
sourceLeft: bigint;
}], "nonpayable">
Parameters
- nameOrSignature: "swapWithToken"
Returns TypedContractMethod<[sourceToken: AddressLike, targetToken: AddressLike, sourceTokenAmount: BigNumberish, callee: AddressLike, allowanceTarget: AddressLike, data: BytesLike, refundAddress: AddressLike], [[bigint, bigint] & {
amountOut: bigint;
sourceLeft: bigint;
}], "nonpayable">
Overrides BaseContract.getFunction
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:44

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>
Inherited from BaseContract.listenerCount
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:128

listeners

listeners<TCEvent>(event): Promise<TypedListener<TCEvent>[]>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
Returns Promise<TypedListener<TCEvent>[]>
Overrides BaseContract.listeners
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:26
listeners(eventName?): Promise<Listener[]>
Parameters
- Optional eventName: string
Returns Promise<Listener[]>
Overrides BaseContract.listeners
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:27

off

off(event, listener?): Promise<IExchangeHelper>
Remove the %%listener%% from the listeners for %%event%% or remove all listeners if unspecified.
Parameters
- event: ContractEventName
- Optional listener: Listener
Returns Promise<IExchangeHelper>
Inherited from BaseContract.off
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:138

on

on<TCEvent>(event, listener): Promise<IExchangeHelper>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IExchangeHelper>
Overrides BaseContract.on
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:22
on<TCEvent>(filter, listener): Promise<IExchangeHelper>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IExchangeHelper>
Overrides BaseContract.on
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:23

once

once<TCEvent>(event, listener): Promise<IExchangeHelper>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IExchangeHelper>
Overrides BaseContract.once
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:24
once<TCEvent>(filter, listener): Promise<IExchangeHelper>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IExchangeHelper>
Overrides BaseContract.once
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:25

queryFilter

queryFilter<TCEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- Optional fromBlockOrBlockhash: string | number
- Optional toBlock: string | number
Returns Promise<TypedEventLog<TCEvent>[]>
Overrides BaseContract.queryFilter
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:20
queryFilter<TCEvent>(filter, fromBlockOrBlockhash?, toBlock?): 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>[]>
Overrides BaseContract.queryFilter
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:21

queryTransaction

queryTransaction(hash): Promise<EventLog[]>
@_ignore:
Parameters
- hash: string
Returns Promise<EventLog[]>
Inherited from BaseContract.queryTransaction
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:102

removeAllListeners

removeAllListeners<TCEvent>(event?): Promise<IExchangeHelper>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- Optional event: TCEvent
Returns Promise<IExchangeHelper>
Overrides BaseContract.removeAllListeners
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:28

removeListener

removeListener(event, listener): Promise<IExchangeHelper>
Alias for [off].
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IExchangeHelper>
Inherited from BaseContract.removeListener
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:151

waitForDeployment

waitForDeployment(): Promise<IExchangeHelper>
Returns Promise<IExchangeHelper>
Overrides BaseContract.waitForDeployment
- Defined in node_modules/@premia/v3-abi/typechain/IExchangeHelper.d.ts:18

Interface IExchangeHelper

Hierarchy

Index

Properties

Methods

Properties

Readonly [internal]

Readonly fallback

filters

Type declaration

interface

Readonly runner

swapWithToken

Readonly target

Methods

addListener

Parameters

event: ContractEventName

listener: Listener

Returns Promise<IExchangeHelper>

attach

Parameters

target: string | Addressable

Returns BaseContract

connect

Parameters

Optional runner: null | ContractRunner

Returns IExchangeHelper

deploymentTransaction

Returns null | ContractTransactionResponse

emit

Parameters

event: ContractEventName

Rest ...args: any[]

Returns Promise<boolean>

getAddress

Returns Promise<string>

getDeployedCode

Returns Promise<null | string>

getEvent

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: "swapWithToken"

Returns TypedContractMethod<[sourceToken: AddressLike, targetToken: AddressLike, sourceTokenAmount: BigNumberish, callee: AddressLike, allowanceTarget: AddressLike, data: BytesLike, refundAddress: AddressLike], [[bigint, bigint] & { amountOut: bigint; sourceLeft: bigint; }], "nonpayable">

listenerCount

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

Parameters

event: ContractEventName

Optional listener: Listener

Returns Promise<IExchangeHelper>

on

Type Parameters

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

Parameters

event: TCEvent

listener: TypedListener<TCEvent>

Returns Promise<IExchangeHelper>

Type Parameters

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

Parameters

`Readonly` [internal]

`Readonly` fallback

`Readonly` runner

`Readonly` target

`Optional` runner: null | ContractRunner

`Rest` ...args: any[]

Returns TypedContractMethod<[sourceToken: AddressLike, targetToken: AddressLike, sourceTokenAmount: BigNumberish, callee: AddressLike, allowanceTarget: AddressLike, data: BytesLike, refundAddress: AddressLike], [[bigint, bigint] & {
amountOut: bigint;
sourceLeft: bigint;
}], "nonpayable">

`Optional` event: ContractEventName

`Optional` eventName: string

`Optional` listener: Listener

`Optional` fromBlockOrBlockhash: string | number

`Optional` toBlock: string | number

`Optional` fromBlockOrBlockhash: string | number

`Optional` toBlock: string | number

`Optional` event: TCEvent