Skip to content

Latest commit

 

History

History
1685 lines (1026 loc) · 41.1 KB

ERC4626Router.md

File metadata and controls

1685 lines (1026 loc) · 41.1 KB

solidity-hardhat-template / Exports / ERC4626Router

Class: ERC4626Router

Hierarchy

  • BaseContract

    ERC4626Router

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ERC4626Router(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:107

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
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<string>
allowance (arg0: string, arg1: string, overrides?: CallOverrides) => Promise<BigNumber>
approve (spender: string, amount: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
asset (overrides?: CallOverrides) => Promise<string>
balanceOf (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
convertToAssets (shares: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
convertToShares (assets: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
decimals (overrides?: CallOverrides) => Promise<number>
deposit (assets: BigNumberish, receiver: string, overrides?: CallOverrides) => Promise<BigNumber>
maxDeposit (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
maxMint (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
maxRedeem (owner: string, overrides?: CallOverrides) => Promise<BigNumber>
maxWithdraw (owner: string, overrides?: CallOverrides) => Promise<BigNumber>
mint (shares: BigNumberish, receiver: string, overrides?: CallOverrides) => Promise<BigNumber>
name (overrides?: CallOverrides) => Promise<string>
nonces (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
permit (owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: CallOverrides) => Promise<void>
previewDeposit (assets: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
previewMint (shares: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
previewRedeem (shares: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
previewWithdraw (assets: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
redeem (shares: BigNumberish, receiver: string, owner: string, overrides?: CallOverrides) => Promise<BigNumber>
symbol (overrides?: CallOverrides) => Promise<string>
totalAssets (overrides?: CallOverrides) => Promise<BigNumber>
totalSupply (overrides?: CallOverrides) => Promise<BigNumber>
transfer (to: string, amount: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
transferFrom (from: string, to: string, amount: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
withdraw (assets: BigNumberish, receiver: string, owner: string, overrides?: CallOverrides) => Promise<BigNumber>

Overrides

BaseContract.callStatic

Defined in

types/ethers-contracts/ERC4626Router.d.ts:532


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
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<BigNumber>
allowance (arg0: string, arg1: string, overrides?: CallOverrides) => Promise<BigNumber>
approve (spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
asset (overrides?: CallOverrides) => Promise<BigNumber>
balanceOf (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
convertToAssets (shares: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
convertToShares (assets: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
decimals (overrides?: CallOverrides) => Promise<BigNumber>
deposit (assets: BigNumberish, receiver: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
maxDeposit (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
maxMint (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
maxRedeem (owner: string, overrides?: CallOverrides) => Promise<BigNumber>
maxWithdraw (owner: string, overrides?: CallOverrides) => Promise<BigNumber>
mint (shares: BigNumberish, receiver: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
name (overrides?: CallOverrides) => Promise<BigNumber>
nonces (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
permit (owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
previewDeposit (assets: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
previewMint (shares: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
previewRedeem (shares: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
previewWithdraw (assets: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
redeem (shares: BigNumberish, receiver: string, owner: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
symbol (overrides?: CallOverrides) => Promise<BigNumber>
totalAssets (overrides?: CallOverrides) => Promise<BigNumber>
totalSupply (overrides?: CallOverrides) => Promise<BigNumber>
transfer (to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
transferFrom (from: string, to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
withdraw (assets: BigNumberish, receiver: string, owner: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

Defined in

types/ethers-contracts/ERC4626Router.d.ts:744


filters

filters: Object

Type declaration

Name Type
Approval (owner?: null | string, spender?: null | string, amount?: null) => TypedEventFilter<[string, string, BigNumber], { amount: BigNumber ; owner: string ; spender: string }>
Approval(address,address,uint256) (owner?: null | string, spender?: null | string, amount?: null) => TypedEventFilter<[string, string, BigNumber], { amount: BigNumber ; owner: string ; spender: string }>
Deposit (caller?: null | string, owner?: null | string, assets?: null, shares?: null) => TypedEventFilter<[string, string, BigNumber, BigNumber], { assets: BigNumber ; caller: string ; owner: string ; shares: BigNumber }>
Deposit(address,address,uint256,uint256) (caller?: null | string, owner?: null | string, assets?: null, shares?: null) => TypedEventFilter<[string, string, BigNumber, BigNumber], { assets: BigNumber ; caller: string ; owner: string ; shares: BigNumber }>
Transfer (from?: null | string, to?: null | string, amount?: null) => TypedEventFilter<[string, string, BigNumber], { amount: BigNumber ; from: string ; to: string }>
Transfer(address,address,uint256) (from?: null | string, to?: null | string, amount?: null) => TypedEventFilter<[string, string, BigNumber], { amount: BigNumber ; from: string ; to: string }>
Withdraw (caller?: null | string, receiver?: null | string, owner?: null | string, assets?: null, shares?: null) => TypedEventFilter<[string, string, string, BigNumber, BigNumber], { assets: BigNumber ; caller: string ; owner: string ; receiver: string ; shares: BigNumber }>
Withdraw(address,address,address,uint256,uint256) (caller?: null | string, receiver?: null | string, owner?: null | string, assets?: null, shares?: null) => TypedEventFilter<[string, string, string, BigNumber, BigNumber], { assets: BigNumber ; caller: string ; owner: string ; receiver: string ; shares: BigNumber }>

Overrides

BaseContract.filters

Defined in

types/ethers-contracts/ERC4626Router.d.ts:652


functions

functions: Object

Type declaration

Name Type
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<[string]>
allowance (arg0: string, arg1: string, overrides?: CallOverrides) => Promise<[BigNumber]>
approve (spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
asset (overrides?: CallOverrides) => Promise<[string]>
balanceOf (arg0: string, overrides?: CallOverrides) => Promise<[BigNumber]>
convertToAssets (shares: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
convertToShares (assets: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
decimals (overrides?: CallOverrides) => Promise<[number]>
deposit (assets: BigNumberish, receiver: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
maxDeposit (arg0: string, overrides?: CallOverrides) => Promise<[BigNumber]>
maxMint (arg0: string, overrides?: CallOverrides) => Promise<[BigNumber]>
maxRedeem (owner: string, overrides?: CallOverrides) => Promise<[BigNumber]>
maxWithdraw (owner: string, overrides?: CallOverrides) => Promise<[BigNumber]>
mint (shares: BigNumberish, receiver: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
name (overrides?: CallOverrides) => Promise<[string]>
nonces (arg0: string, overrides?: CallOverrides) => Promise<[BigNumber]>
permit (owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
previewDeposit (assets: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
previewMint (shares: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
previewRedeem (shares: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
previewWithdraw (assets: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
redeem (shares: BigNumberish, receiver: string, owner: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
symbol (overrides?: CallOverrides) => Promise<[string]>
totalAssets (overrides?: CallOverrides) => Promise<[BigNumber]>
totalSupply (overrides?: CallOverrides) => Promise<[BigNumber]>
transfer (to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
transferFrom (from: string, to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
withdraw (assets: BigNumberish, receiver: string, owner: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>

Overrides

BaseContract.functions

Defined in

types/ethers-contracts/ERC4626Router.d.ts:294


interface

interface: ERC4626RouterInterface

Overrides

BaseContract.interface

Defined in

types/ethers-contracts/ERC4626Router.d.ts:292


populateTransaction

populateTransaction: Object

Type declaration

Name Type
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<PopulatedTransaction>
allowance (arg0: string, arg1: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
approve (spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
asset (overrides?: CallOverrides) => Promise<PopulatedTransaction>
balanceOf (arg0: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
convertToAssets (shares: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
convertToShares (assets: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
decimals (overrides?: CallOverrides) => Promise<PopulatedTransaction>
deposit (assets: BigNumberish, receiver: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
maxDeposit (arg0: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
maxMint (arg0: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
maxRedeem (owner: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
maxWithdraw (owner: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
mint (shares: BigNumberish, receiver: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
name (overrides?: CallOverrides) => Promise<PopulatedTransaction>
nonces (arg0: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
permit (owner: string, spender: string, value: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
previewDeposit (assets: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
previewMint (shares: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
previewRedeem (shares: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
previewWithdraw (assets: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
redeem (shares: BigNumberish, receiver: string, owner: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
symbol (overrides?: CallOverrides) => Promise<PopulatedTransaction>
totalAssets (overrides?: CallOverrides) => Promise<PopulatedTransaction>
totalSupply (overrides?: CallOverrides) => Promise<PopulatedTransaction>
transfer (to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
transferFrom (from: string, to: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
withdraw (assets: BigNumberish, receiver: string, owner: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

Defined in

types/ethers-contracts/ERC4626Router.d.ts:864


provider

Readonly provider: Provider

Inherited from

BaseContract.provider

Defined in

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


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

DOMAIN_SEPARATOR

DOMAIN_SEPARATOR(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:414


_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


allowance

allowance(arg0, arg1, overrides?): Promise<BigNumber>

Parameters

Name Type
arg0 string
arg1 string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:416


approve

approve(spender, amount, overrides?): Promise<ContractTransaction>

Parameters

Name Type
spender string
amount BigNumberish
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:422


asset

asset(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:428


attach

attach(addressOrName): ERC4626Router

Parameters

Name Type
addressOrName string

Returns

ERC4626Router

Overrides

BaseContract.attach

Defined in

types/ethers-contracts/ERC4626Router.d.ts:253


balanceOf

balanceOf(arg0, overrides?): Promise<BigNumber>

Parameters

Name Type
arg0 string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:430


connect

connect(signerOrProvider): ERC4626Router

Parameters

Name Type
signerOrProvider string | Signer | Provider

Returns

ERC4626Router

Overrides

BaseContract.connect

Defined in

types/ethers-contracts/ERC4626Router.d.ts:252


convertToAssets

convertToAssets(shares, overrides?): Promise<BigNumber>

Parameters

Name Type
shares BigNumberish
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:432


convertToShares

convertToShares(assets, overrides?): Promise<BigNumber>

Parameters

Name Type
assets BigNumberish
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:437


decimals

decimals(overrides?): Promise<number>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<number>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:442


deployed

deployed(): Promise<ERC4626Router>

Returns

Promise<ERC4626Router>

Overrides

BaseContract.deployed

Defined in

types/ethers-contracts/ERC4626Router.d.ts:254


deposit

deposit(assets, receiver, overrides?): Promise<ContractTransaction>

Parameters

Name Type
assets BigNumberish
receiver string
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:444


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


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

types/ethers-contracts/ERC4626Router.d.ts:256

listeners(eventName?): Listener[]

Parameters

Name Type
eventName? string

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

types/ethers-contracts/ERC4626Router.d.ts:279


maxDeposit

maxDeposit(arg0, overrides?): Promise<BigNumber>

Parameters

Name Type
arg0 string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:450


maxMint

maxMint(arg0, overrides?): Promise<BigNumber>

Parameters

Name Type
arg0 string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:452


maxRedeem

maxRedeem(owner, overrides?): Promise<BigNumber>

Parameters

Name Type
owner string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:454


maxWithdraw

maxWithdraw(owner, overrides?): Promise<BigNumber>

Parameters

Name Type
owner string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:456


mint

mint(shares, receiver, overrides?): Promise<ContractTransaction>

Parameters

Name Type
shares BigNumberish
receiver string
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:458


name

name(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:464


nonces

nonces(arg0, overrides?): Promise<BigNumber>

Parameters

Name Type
arg0 string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:466


off

off<EventArgsArray, EventArgsObject>(eventFilter, listener): ERC4626Router

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

ERC4626Router

Overrides

BaseContract.off

Defined in

types/ethers-contracts/ERC4626Router.d.ts:259

off(eventName, listener): ERC4626Router

Parameters

Name Type
eventName string
listener Listener

Returns

ERC4626Router

Overrides

BaseContract.off

Defined in

types/ethers-contracts/ERC4626Router.d.ts:280


on

on<EventArgsArray, EventArgsObject>(eventFilter, listener): ERC4626Router

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

ERC4626Router

Overrides

BaseContract.on

Defined in

types/ethers-contracts/ERC4626Router.d.ts:263

on(eventName, listener): ERC4626Router

Parameters

Name Type
eventName string
listener Listener

Returns

ERC4626Router

Overrides

BaseContract.on

Defined in

types/ethers-contracts/ERC4626Router.d.ts:281


once

once<EventArgsArray, EventArgsObject>(eventFilter, listener): ERC4626Router

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

ERC4626Router

Overrides

BaseContract.once

Defined in

types/ethers-contracts/ERC4626Router.d.ts:267

once(eventName, listener): ERC4626Router

Parameters

Name Type
eventName string
listener Listener

Returns

ERC4626Router

Overrides

BaseContract.once

Defined in

types/ethers-contracts/ERC4626Router.d.ts:282


permit

permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<ContractTransaction>

Parameters

Name Type
owner string
spender string
value BigNumberish
deadline BigNumberish
v BigNumberish
r BytesLike
s BytesLike
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:468


previewDeposit

previewDeposit(assets, overrides?): Promise<BigNumber>

Parameters

Name Type
assets BigNumberish
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:479


previewMint

previewMint(shares, overrides?): Promise<BigNumber>

Parameters

Name Type
shares BigNumberish
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:484


previewRedeem

previewRedeem(shares, overrides?): Promise<BigNumber>

Parameters

Name Type
shares BigNumberish
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:489


previewWithdraw

previewWithdraw(assets, overrides?): Promise<BigNumber>

Parameters

Name Type
assets BigNumberish
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:494


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

types/ethers-contracts/ERC4626Router.d.ts:286


redeem

redeem(shares, receiver, owner, overrides?): Promise<ContractTransaction>

Parameters

Name Type
shares BigNumberish
receiver string
owner string
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:499


removeAllListeners

removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter): ERC4626Router

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

Name Type
eventFilter TypedEventFilter<EventArgsArray, EventArgsObject>

Returns

ERC4626Router

Overrides

BaseContract.removeAllListeners

Defined in

types/ethers-contracts/ERC4626Router.d.ts:275

removeAllListeners(eventName?): ERC4626Router

Parameters

Name Type
eventName? string

Returns

ERC4626Router

Overrides

BaseContract.removeAllListeners

Defined in

types/ethers-contracts/ERC4626Router.d.ts:284


removeListener

removeListener<EventArgsArray, EventArgsObject>(eventFilter, listener): ERC4626Router

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

ERC4626Router

Overrides

BaseContract.removeListener

Defined in

types/ethers-contracts/ERC4626Router.d.ts:271

removeListener(eventName, listener): ERC4626Router

Parameters

Name Type
eventName string
listener Listener

Returns

ERC4626Router

Overrides

BaseContract.removeListener

Defined in

types/ethers-contracts/ERC4626Router.d.ts:283


symbol

symbol(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:506


totalAssets

totalAssets(overrides?): Promise<BigNumber>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:508


totalSupply

totalSupply(overrides?): Promise<BigNumber>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:510


transfer

transfer(to, amount, overrides?): Promise<ContractTransaction>

Parameters

Name Type
to string
amount BigNumberish
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:512


transferFrom

transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>

Parameters

Name Type
from string
to string
amount BigNumberish
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:518


withdraw

withdraw(assets, receiver, owner, overrides?): Promise<ContractTransaction>

Parameters

Name Type
assets BigNumberish
receiver string
owner string
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

types/ethers-contracts/ERC4626Router.d.ts:525


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


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


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