Last update: October 8, 2021

yearn-vaults / Modules / BaseRouter / BaseRouter

Class: BaseRouter

BaseRouter.BaseRouter

Hierarchy

• BaseContract

↳ BaseRouter

Table of contents

Constructors

• constructor

Properties

• _deployedPromise
• _runningEvents
• _wrappedEmits
• address
• callStatic
• deployTransaction
• estimateGas
• filters
• functions
• interface
• populateTransaction
• provider
• resolvedAddress
• signer

Methods

• _checkRunningEvents
• _deployed
• _wrapEvent
• allVaults
• attach
• bestVault
• connect
• deployed
• emit
• fallback
• listenerCount
• listeners
• off
• on
• once
• queryFilter
• registry
• removeAllListeners
• removeListener
• setRegistry
• totalAssets
• totalVaultBalance
• getContractAddress
• getInterface
• isIndexed

Constructors

constructor

• new BaseRouter(addressOrName, contractInterface, signerOrProvider?)

Parameters

Name	Type
addressOrName	string
contractInterface	ContractInterface
signerOrProvider?	Signer | Provider

Inherited from

BaseContract.constructor

Defined in

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

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

BaseContract._deployedPromise

Defined in

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

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

BaseContract._runningEvents

Defined in

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

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

BaseContract._wrappedEmits

Defined in

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

---

address

• Readonly address: string

Inherited from

BaseContract.address

Defined in

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

---

callStatic

• callStatic: Object

Type declaration

Name	Type
allVaults	(token: string, overrides?: CallOverrides) => Promise<string[]>
bestVault	(token: string, overrides?: CallOverrides) => Promise<string>
registry	(overrides?: CallOverrides) => Promise<string>
setRegistry	(_registry: string, overrides?: CallOverrides) => Promise<void>
totalAssets	(token: string, overrides?: CallOverrides) => Promise<BigNumber>
totalVaultBalance	(token: string, account: string, overrides?: CallOverrides) => Promise<BigNumber>

Overrides

BaseContract.callStatic

Defined in

typechain/BaseRouter.d.ts:147

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

BaseContract.deployTransaction

Defined in

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

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
allVaults	(token: string, overrides?: CallOverrides) => Promise<BigNumber>
bestVault	(token: string, overrides?: CallOverrides) => Promise<BigNumber>
registry	(overrides?: CallOverrides) => Promise<BigNumber>
setRegistry	(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
totalAssets	(token: string, overrides?: CallOverrides) => Promise<BigNumber>
totalVaultBalance	(token: string, account: string, overrides?: CallOverrides) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

Defined in

typechain/BaseRouter.d.ts:167

---

filters

• filters: Object

Overrides

BaseContract.filters

Defined in

typechain/BaseRouter.d.ts:165

---

functions

• functions: Object

Type declaration

Name	Type
allVaults	(token: string, overrides?: CallOverrides) => Promise<[string[]]>
bestVault	(token: string, overrides?: CallOverrides) => Promise<[string]>
registry	(overrides?: CallOverrides) => Promise<[string]>
setRegistry	(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
totalAssets	(token: string, overrides?: CallOverrides) => Promise<[BigNumber] & { assets: BigNumber }>
totalVaultBalance	(token: string, account: string, overrides?: CallOverrides) => Promise<[BigNumber] & { balance: BigNumber }>

Overrides

BaseContract.functions

Defined in

typechain/BaseRouter.d.ts:104

---

interface

• interface: BaseRouterInterface

Overrides

BaseContract.interface

Defined in

typechain/BaseRouter.d.ts:102

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
allVaults	(token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
bestVault	(token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
registry	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setRegistry	(_registry: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
totalAssets	(token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
totalVaultBalance	(token: string, account: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

Defined in

typechain/BaseRouter.d.ts:188

---

provider

• Readonly provider: Provider

Inherited from

BaseContract.provider

Defined in

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

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

BaseContract.resolvedAddress

Defined in

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

---

signer

• Readonly signer: Signer

Inherited from

BaseContract.signer

Defined in

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

Methods

_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:117

---

_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:110

---

_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:118

---

allVaults

▸ allVaults(token, overrides?): Promise<string[]>

Parameters

Name	Type
token	string
overrides?	CallOverrides

Returns

Promise<string[]>

Defined in

typechain/BaseRouter.d.ts:128

---

attach

▸ attach(addressOrName): BaseRouter

Parameters

Name	Type
addressOrName	string

Returns

BaseRouter

Overrides

BaseContract.attach

Defined in

typechain/BaseRouter.d.ts:63

---

bestVault

▸ bestVault(token, overrides?): Promise<string>

Parameters

Name	Type
token	string
overrides?	CallOverrides

Returns

Promise<string>

Defined in

typechain/BaseRouter.d.ts:130

---

connect

▸ connect(signerOrProvider): BaseRouter

Parameters

Name	Type
signerOrProvider	string | Provider | Signer

Returns

BaseRouter

Overrides

BaseContract.connect

Defined in

typechain/BaseRouter.d.ts:62

---

deployed

▸ deployed(): Promise<BaseRouter>

Returns

Promise<BaseRouter>

Overrides

BaseContract.deployed

Defined in

typechain/BaseRouter.d.ts:64

---

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:123

---

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:111

---

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:124

---

listeners

▸ listeners<EventArgsArray, EventArgsObject>(eventFilter?): TypedListener<EventArgsArray, EventArgsObject>[]

Type parameters

Name	Type
EventArgsArray	extends any[]
EventArgsObject	EventArgsObject

Parameters

Name	Type
eventFilter?	TypedEventFilter<EventArgsArray, EventArgsObject>

Returns

TypedListener<EventArgsArray, EventArgsObject>[]

Overrides

BaseContract.listeners

Defined in

typechain/BaseRouter.d.ts:66

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

typechain/BaseRouter.d.ts:89

---

off

▸ off<EventArgsArray, EventArgsObject>(eventFilter, listener): BaseRouter

Type parameters

Name	Type
EventArgsArray	extends any[]
EventArgsObject	EventArgsObject

Parameters

Name	Type
eventFilter	TypedEventFilter<EventArgsArray, EventArgsObject>
listener	TypedListener<EventArgsArray, EventArgsObject>

Returns

BaseRouter

Overrides

BaseContract.off

Defined in

typechain/BaseRouter.d.ts:69

▸ off(eventName, listener): BaseRouter

Parameters

Name	Type
eventName	string
listener	Listener

Returns

BaseRouter

Overrides

BaseContract.off

Defined in

typechain/BaseRouter.d.ts:90

---

on

▸ on<EventArgsArray, EventArgsObject>(eventFilter, listener): BaseRouter

Type parameters

Name	Type
EventArgsArray	extends any[]
EventArgsObject	EventArgsObject

Parameters

Name	Type
eventFilter	TypedEventFilter<EventArgsArray, EventArgsObject>
listener	TypedListener<EventArgsArray, EventArgsObject>

Returns

BaseRouter

Overrides

BaseContract.on

Defined in

typechain/BaseRouter.d.ts:73

▸ on(eventName, listener): BaseRouter

Parameters

Name	Type
eventName	string
listener	Listener

Returns

BaseRouter

Overrides

BaseContract.on

Defined in

typechain/BaseRouter.d.ts:91

---

once

▸ once<EventArgsArray, EventArgsObject>(eventFilter, listener): BaseRouter

Type parameters

Name	Type
EventArgsArray	extends any[]
EventArgsObject	EventArgsObject

Parameters

Name	Type
eventFilter	TypedEventFilter<EventArgsArray, EventArgsObject>
listener	TypedListener<EventArgsArray, EventArgsObject>

Returns

BaseRouter

Overrides

BaseContract.once

Defined in

typechain/BaseRouter.d.ts:77

▸ once(eventName, listener): BaseRouter

Parameters

Name	Type
eventName	string
listener	Listener

Returns

BaseRouter

Overrides

BaseContract.once

Defined in

typechain/BaseRouter.d.ts:92

---

queryFilter

▸ queryFilter<EventArgsArray, EventArgsObject>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

Type parameters

Name	Type
EventArgsArray	extends any[]
EventArgsObject	EventArgsObject

Parameters

Name	Type
event	TypedEventFilter<EventArgsArray, EventArgsObject>
fromBlockOrBlockhash?	string | number
toBlock?	string | number

Returns

Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

Overrides

BaseContract.queryFilter

Defined in

typechain/BaseRouter.d.ts:96

---

registry

▸ registry(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Defined in

typechain/BaseRouter.d.ts:132

---

removeAllListeners

▸ removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter): BaseRouter

Type parameters

Name	Type
EventArgsArray	extends any[]
EventArgsObject	EventArgsObject

Parameters

Name	Type
eventFilter	TypedEventFilter<EventArgsArray, EventArgsObject>

Returns

BaseRouter

Overrides

BaseContract.removeAllListeners

Defined in

typechain/BaseRouter.d.ts:85

▸ removeAllListeners(eventName?): BaseRouter

Parameters

Name	Type
eventName?	string

Returns

BaseRouter

Overrides

BaseContract.removeAllListeners

Defined in

typechain/BaseRouter.d.ts:94

---

removeListener

▸ removeListener<EventArgsArray, EventArgsObject>(eventFilter, listener): BaseRouter

Type parameters

Name	Type
EventArgsArray	extends any[]
EventArgsObject	EventArgsObject

Parameters

Name	Type
eventFilter	TypedEventFilter<EventArgsArray, EventArgsObject>
listener	TypedListener<EventArgsArray, EventArgsObject>

Returns

BaseRouter

Overrides

BaseContract.removeListener

Defined in

typechain/BaseRouter.d.ts:81

▸ removeListener(eventName, listener): BaseRouter

Parameters

Name	Type
eventName	string
listener	Listener

Returns

BaseRouter

Overrides

BaseContract.removeListener

Defined in

typechain/BaseRouter.d.ts:93

---

setRegistry

▸ setRegistry(_registry, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_registry	string
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

typechain/BaseRouter.d.ts:134

---

totalAssets

▸ totalAssets(token, overrides?): Promise<BigNumber>

Parameters

Name	Type
token	string
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/BaseRouter.d.ts:139

---

totalVaultBalance

▸ totalVaultBalance(token, account, overrides?): Promise<BigNumber>

Parameters

Name	Type
token	string
account	string
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/BaseRouter.d.ts:141

---

getContractAddress

▸ Static getContractAddress(transaction): string

Parameters

Name	Type
transaction	Object
transaction.from	string
transaction.nonce	BigNumberish

Returns

string

Inherited from

BaseContract.getContractAddress

Defined in

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

---

getInterface

▸ Static getInterface(contractInterface): Interface

Parameters

Name	Type
contractInterface	ContractInterface

Returns

Interface

Inherited from

BaseContract.getInterface

Defined in

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

---

isIndexed

▸ Static isIndexed(value): value is Indexed

Parameters

Name	Type
value	any

Returns

value is Indexed

Inherited from

BaseContract.isIndexed

Defined in

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