Router

@node-fi/sdk-core / Exports / Router

Interface: Router

Hierarchy

• BaseContract

  ↳ Router

Table of contents

Properties

• _deployedPromise
• _runningEvents
• _wrappedEmits
• address
• callStatic
• deployTransaction
• estimateGas
• filters
• functions
• interface
• off
• on
• once
• populateTransaction
• provider
• removeListener
• resolvedAddress
• signer

Methods

• FEE_DENOMINATOR
• _checkRunningEvents
• _deployed
• _wrapEvent
• attach
• connect
• defaultAdminFee
• deployed
• emit
• fallback
• getOutputAmount
• listenerCount
• listeners
• owner
• queryFilter
• removeAllListeners
• renounceOwnership
• setAdmin
• setAdminFee
• setPartnerAdmin
• setPartnerFee
• swapExactInputForOutput
• transferOwnership

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

BaseContract._deployedPromise

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:100

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

BaseContract._runningEvents

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:101

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

▪ [eventTag: string]: (...args: any[]) => void

Inherited from

BaseContract._wrappedEmits

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:104

---

address

• Readonly address: string

Inherited from

BaseContract.address

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:79

---

callStatic

• callStatic: Object

Type declaration

Name	Type
FEE_DENOMINATOR	(overrides?: CallOverrides) => Promise<BigNumber>
defaultAdminFee	(overrides?: CallOverrides) => Promise<BigNumber>
getOutputAmount	(path: PromiseOrValue<string>[], pairs: PromiseOrValue<string>[], extras: PromiseOrValue<BytesLike>[], inputAmount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber>
owner	(overrides?: CallOverrides) => Promise<string>
renounceOwnership	(overrides?: CallOverrides) => Promise<void>
setAdmin	(addr: PromiseOrValue<string>, isAdmin: PromiseOrValue<boolean>, overrides?: CallOverrides) => Promise<void>
setAdminFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
setPartnerAdmin	(partnerId: PromiseOrValue<BigNumberish>, admin: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setPartnerFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
swapExactInputForOutput	(details: SwapPayloadStruct, overrides?: CallOverrides) => Promise<BigNumber>
transferOwnership	(newOwner: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>

Overrides

BaseContract.callStatic

Defined in

packages/sdk-core/src/generated/Router.ts:369

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

BaseContract.deployTransaction

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:99

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
FEE_DENOMINATOR	(overrides?: CallOverrides) => Promise<BigNumber>
defaultAdminFee	(overrides?: CallOverrides) => Promise<BigNumber>
getOutputAmount	(path: PromiseOrValue<string>[], pairs: PromiseOrValue<string>[], extras: PromiseOrValue<BytesLike>[], inputAmount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber>
owner	(overrides?: CallOverrides) => Promise<BigNumber>
renounceOwnership	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
setAdmin	(addr: PromiseOrValue<string>, isAdmin: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
setAdminFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
setPartnerAdmin	(partnerId: PromiseOrValue<BigNumberish>, admin: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
setPartnerFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
swapExactInputForOutput	(details: SwapPayloadStruct, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
transferOwnership	(newOwner: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

Defined in

packages/sdk-core/src/generated/Router.ts:464

---

filters

• filters: Object

Type declaration

Name	Type
FeeChanged	(partnerId?: null | PromiseOrValue<BigNumberish>, initiator?: null | PromiseOrValue<string>, isAdminFee?: null | PromiseOrValue<boolean>, oldFee?: null, newFee?: null) => FeeChangedEventFilter
FeeChanged(uint256,address,bool,uint256,uint256)	(partnerId?: null | PromiseOrValue<BigNumberish>, initiator?: null | PromiseOrValue<string>, isAdminFee?: null | PromiseOrValue<boolean>, oldFee?: null, newFee?: null) => FeeChangedEventFilter
OwnershipTransferred	(previousOwner?: null | PromiseOrValue<string>, newOwner?: null | PromiseOrValue<string>) => OwnershipTransferredEventFilter
OwnershipTransferred(address,address)	(previousOwner?: null | PromiseOrValue<string>, newOwner?: null | PromiseOrValue<string>) => OwnershipTransferredEventFilter
Swap	(sender?: null | PromiseOrValue<string>, to?: null, input?: null | PromiseOrValue<string>, output?: null | PromiseOrValue<string>, inputAmount?: null, outputAmount?: null) => SwapEventFilter
Swap(address,address,address,address,uint256,uint256)	(sender?: null | PromiseOrValue<string>, to?: null, input?: null | PromiseOrValue<string>, output?: null | PromiseOrValue<string>, inputAmount?: null, outputAmount?: null) => SwapEventFilter

Overrides

BaseContract.filters

Defined in

packages/sdk-core/src/generated/Router.ts:421

---

functions

• functions: Object

Type declaration

Name	Type
FEE_DENOMINATOR	(overrides?: CallOverrides) => Promise<[BigNumber]>
defaultAdminFee	(overrides?: CallOverrides) => Promise<[BigNumber]>
getOutputAmount	(path: PromiseOrValue<string>[], pairs: PromiseOrValue<string>[], extras: PromiseOrValue<BytesLike>[], inputAmount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[BigNumber] & { outputAmount: BigNumber }>
owner	(overrides?: CallOverrides) => Promise<[string]>
renounceOwnership	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setAdmin	(addr: PromiseOrValue<string>, isAdmin: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setAdminFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setPartnerAdmin	(partnerId: PromiseOrValue<BigNumberish>, admin: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setPartnerFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
swapExactInputForOutput	(details: SwapPayloadStruct, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
transferOwnership	(newOwner: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>

Overrides

BaseContract.functions

Defined in

packages/sdk-core/src/generated/Router.ts:263

---

interface

• interface: RouterInterface

Overrides

BaseContract.interface

Defined in

packages/sdk-core/src/generated/Router.ts:242

---

off

• off: OnEvent<Router>

Overrides

BaseContract.off

Defined in

packages/sdk-core/src/generated/Router.ts:258

---

on

• on: OnEvent<Router>

Overrides

BaseContract.on

Defined in

packages/sdk-core/src/generated/Router.ts:259

---

once

• once: OnEvent<Router>

Overrides

BaseContract.once

Defined in

packages/sdk-core/src/generated/Router.ts:260

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
FEE_DENOMINATOR	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
defaultAdminFee	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getOutputAmount	(path: PromiseOrValue<string>[], pairs: PromiseOrValue<string>[], extras: PromiseOrValue<BytesLike>[], inputAmount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
renounceOwnership	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setAdmin	(addr: PromiseOrValue<string>, isAdmin: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setAdminFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setPartnerAdmin	(partnerId: PromiseOrValue<BigNumberish>, admin: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setPartnerFee	(partnerId: PromiseOrValue<BigNumberish>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
swapExactInputForOutput	(details: SwapPayloadStruct, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
transferOwnership	(newOwner: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

Defined in

packages/sdk-core/src/generated/Router.ts:518

---

provider

• Readonly provider: Provider

Inherited from

BaseContract.provider

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:82

---

removeListener

• removeListener: OnEvent<Router>

Overrides

BaseContract.removeListener

Defined in

packages/sdk-core/src/generated/Router.ts:261

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

BaseContract.resolvedAddress

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:98

---

signer

• Readonly signer: Signer

Inherited from

BaseContract.signer

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:81

Methods

FEE_DENOMINATOR

▸ FEE_DENOMINATOR(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

packages/sdk-core/src/generated/Router.ts:317

---

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
runningEvent	RunningEvent

Returns

void

Inherited from

BaseContract._checkRunningEvents

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:121

---

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
blockTag?	BlockTag

Returns

Promise<Contract>

Inherited from

BaseContract._deployed

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:114

---

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
runningEvent	RunningEvent
log	Log
listener	Listener

Returns

Event

Inherited from

BaseContract._wrapEvent

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:122

---

attach

▸ attach(addressOrName): Router

Parameters

Name	Type
addressOrName	string

Returns

Router

Overrides

BaseContract.attach

Defined in

packages/sdk-core/src/generated/Router.ts:239

---

connect

▸ connect(signerOrProvider): Router

Parameters

Name	Type
signerOrProvider	string | Signer | Provider

Returns

Router

Overrides

BaseContract.connect

Defined in

packages/sdk-core/src/generated/Router.ts:238

---

defaultAdminFee

▸ defaultAdminFee(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

packages/sdk-core/src/generated/Router.ts:319

---

deployed

▸ deployed(): Promise<Router>

Returns

Promise<Router>

Overrides

BaseContract.deployed

Defined in

packages/sdk-core/src/generated/Router.ts:240

---

emit

▸ emit(eventName, ...args): boolean

Parameters

Name	Type
eventName	string | EventFilter
...args	any[]

Returns

boolean

Inherited from

BaseContract.emit

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:127

---

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
overrides?	TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

BaseContract.fallback

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:115

---

getOutputAmount

▸ getOutputAmount(path, pairs, extras, inputAmount, overrides?): Promise<BigNumber>

Parameters

Name	Type
path	PromiseOrValue<string>[]
pairs	PromiseOrValue<string>[]
extras	PromiseOrValue<BytesLike>[]
inputAmount	PromiseOrValue<BigNumberish>
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

packages/sdk-core/src/generated/Router.ts:356

---

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
eventName?	string | EventFilter

Returns

number

Inherited from

BaseContract.listenerCount

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:128

---

listeners

▸ listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter?	TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Overrides

BaseContract.listeners

Defined in

packages/sdk-core/src/generated/Router.ts:250

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

packages/sdk-core/src/generated/Router.ts:253

---

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Defined in

packages/sdk-core/src/generated/Router.ts:321

---

queryFilter

▸ queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
event	TypedEventFilter<TEvent>
fromBlockOrBlockhash?	string | number
toBlock?	string | number

Returns

Promise<TEvent[]>

Overrides

BaseContract.queryFilter

Defined in

packages/sdk-core/src/generated/Router.ts:244

---

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): Router

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

Router

Overrides

BaseContract.removeAllListeners

Defined in

packages/sdk-core/src/generated/Router.ts:254

▸ removeAllListeners(eventName?): Router

Parameters

Name	Type
eventName?	string

Returns

Router

Overrides

BaseContract.removeAllListeners

Defined in

packages/sdk-core/src/generated/Router.ts:257

---

renounceOwnership

▸ renounceOwnership(overrides?): Promise<ContractTransaction>

Parameters

Name	Type
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Defined in

packages/sdk-core/src/generated/Router.ts:323

---

setAdmin

▸ setAdmin(addr, isAdmin, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
addr	PromiseOrValue<string>
isAdmin	PromiseOrValue<boolean>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Defined in

packages/sdk-core/src/generated/Router.ts:332

---

setAdminFee

▸ setAdminFee(partnerId, feeNumerator, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
partnerId	PromiseOrValue<BigNumberish>
feeNumerator	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Defined in

packages/sdk-core/src/generated/Router.ts:350

---

setPartnerAdmin

▸ setPartnerAdmin(partnerId, admin, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
partnerId	PromiseOrValue<BigNumberish>
admin	PromiseOrValue<string>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Defined in

packages/sdk-core/src/generated/Router.ts:338

---

setPartnerFee

▸ setPartnerFee(partnerId, feeNumerator, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
partnerId	PromiseOrValue<BigNumberish>
feeNumerator	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Defined in

packages/sdk-core/src/generated/Router.ts:344

---

swapExactInputForOutput

▸ swapExactInputForOutput(details, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
details	SwapPayloadStruct
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Defined in

packages/sdk-core/src/generated/Router.ts:364

---

transferOwnership

▸ transferOwnership(newOwner, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
newOwner	PromiseOrValue<string>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Defined in

packages/sdk-core/src/generated/Router.ts:327