Interface IERC4626

Hierarchy

BaseContract
- IERC4626

Properties

`Readonly` [internal]

[internal]: any

allowance

allowance: TypedContractMethod<[holder: AddressLike, spender: AddressLike], [bigint], "view">

approve

approve: TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

asset

asset: TypedContractMethod<[], [string], "view">

balanceOf

balanceOf: TypedContractMethod<[account: AddressLike], [bigint], "view">

convertToAssets

convertToAssets: TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">

convertToShares

convertToShares: TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">

decimals

decimals: TypedContractMethod<[], [bigint], "view">

deposit

deposit: TypedContractMethod<[assetAmount: BigNumberish, receiver: AddressLike], [bigint], "nonpayable">

`Readonly` fallback

fallback: null | WrappedFallback

filters

filters: {
    Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Deposit(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Withdraw(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Deposit(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Withdraw(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

interface

interface: IERC4626Interface

maxDeposit

maxDeposit: TypedContractMethod<[receiver: AddressLike], [bigint], "view">

maxMint

maxMint: TypedContractMethod<[receiver: AddressLike], [bigint], "view">

maxRedeem

maxRedeem: TypedContractMethod<[owner: AddressLike], [bigint], "view">

maxWithdraw

maxWithdraw: TypedContractMethod<[owner: AddressLike], [bigint], "view">

mint

mint: TypedContractMethod<[shareAmount: BigNumberish, receiver: AddressLike], [bigint], "nonpayable">

name

name: TypedContractMethod<[], [string], "view">

previewDeposit

previewDeposit: TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">

previewMint

previewMint: TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">

previewRedeem

previewRedeem: TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">

previewWithdraw

previewWithdraw: TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">

redeem

redeem: TypedContractMethod<[shareAmount: BigNumberish, receiver: AddressLike, owner: AddressLike], [bigint], "nonpayable">

`Readonly` runner

runner: null | ContractRunner

symbol

symbol: TypedContractMethod<[], [string], "view">

`Readonly` target

target: string | Addressable

totalAssets

totalAssets: TypedContractMethod<[], [bigint], "view">

totalSupply

totalSupply: TypedContractMethod<[], [bigint], "view">

transfer

transfer: TypedContractMethod<[recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

transferFrom

transferFrom: TypedContractMethod<[holder: AddressLike, recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">

withdraw

withdraw: TypedContractMethod<[assetAmount: BigNumberish, receiver: AddressLike, owner: AddressLike], [bigint], "nonpayable">

Methods

addListener

addListener(event, listener): Promise<IERC4626>
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IERC4626>
Inherited from BaseContract.addListener
- Defined in node_modules/ethers/types/contract/contract.d.ts:42

attach

attach(addressOrName): IERC4626
Parameters
- addressOrName: AddressLike
Returns IERC4626
- Defined in src/typechain/IERC4626.ts:297

connect

connect(runner?): BaseContract
Parameters
- Optional runner: null | ContractRunner
Returns BaseContract
Overrides BaseContract.connect
- Defined in src/typechain/IERC4626.ts:296

deployed

deployed(): Promise<IERC4626>
Returns Promise<IERC4626>
- Defined in src/typechain/IERC4626.ts:298

deploymentTransaction

deploymentTransaction(): null | ContractTransactionResponse
Returns null | ContractTransactionResponse
Inherited from BaseContract.deploymentTransaction
- Defined in node_modules/ethers/types/contract/contract.d.ts:30

emit

emit(event, ...args): Promise<boolean>
Parameters
- event: ContractEventName
- Rest ...args: any[]
Returns Promise<boolean>
Inherited from BaseContract.emit
- Defined in node_modules/ethers/types/contract/contract.d.ts:37

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Inherited from BaseContract.getAddress
- Defined in node_modules/ethers/types/contract/contract.d.ts:27

getDeployedCode

getDeployedCode(): Promise<null | string>
Returns Promise<null | string>
Inherited from BaseContract.getDeployedCode
- Defined in node_modules/ethers/types/contract/contract.d.ts:28

getEvent

getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Approval"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IERC4626.ts:557
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Deposit"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IERC4626.ts:564
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Transfer"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IERC4626.ts:571
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Withdraw"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IERC4626.ts:578

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 src/typechain/IERC4626.ts:445
getFunction(nameOrSignature): TypedContractMethod<[holder: AddressLike, spender: AddressLike], [bigint], "view">
Parameters
- nameOrSignature: "allowance"
Returns TypedContractMethod<[holder: AddressLike, spender: AddressLike], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:449
getFunction(nameOrSignature): TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
Parameters
- nameOrSignature: "approve"
Returns TypedContractMethod<[spender: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:456
getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">
Parameters
- nameOrSignature: "asset"
Returns TypedContractMethod<[], [string], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:463
getFunction(nameOrSignature): TypedContractMethod<[account: AddressLike], [bigint], "view">
Parameters
- nameOrSignature: "balanceOf"
Returns TypedContractMethod<[account: AddressLike], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:466
getFunction(nameOrSignature): TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">
Parameters
- nameOrSignature: "convertToAssets"
Returns TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:469
getFunction(nameOrSignature): TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">
Parameters
- nameOrSignature: "convertToShares"
Returns TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:472
getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">
Parameters
- nameOrSignature: "decimals"
Returns TypedContractMethod<[], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:475
getFunction(nameOrSignature): TypedContractMethod<[assetAmount: BigNumberish, receiver: AddressLike], [bigint], "nonpayable">
Parameters
- nameOrSignature: "deposit"
Returns TypedContractMethod<[assetAmount: BigNumberish, receiver: AddressLike], [bigint], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:478
getFunction(nameOrSignature): TypedContractMethod<[receiver: AddressLike], [bigint], "view">
Parameters
- nameOrSignature: "maxDeposit"
Returns TypedContractMethod<[receiver: AddressLike], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:485
getFunction(nameOrSignature): TypedContractMethod<[receiver: AddressLike], [bigint], "view">
Parameters
- nameOrSignature: "maxMint"
Returns TypedContractMethod<[receiver: AddressLike], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:488
getFunction(nameOrSignature): TypedContractMethod<[owner: AddressLike], [bigint], "view">
Parameters
- nameOrSignature: "maxRedeem"
Returns TypedContractMethod<[owner: AddressLike], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:491
getFunction(nameOrSignature): TypedContractMethod<[owner: AddressLike], [bigint], "view">
Parameters
- nameOrSignature: "maxWithdraw"
Returns TypedContractMethod<[owner: AddressLike], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:494
getFunction(nameOrSignature): TypedContractMethod<[shareAmount: BigNumberish, receiver: AddressLike], [bigint], "nonpayable">
Parameters
- nameOrSignature: "mint"
Returns TypedContractMethod<[shareAmount: BigNumberish, receiver: AddressLike], [bigint], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:497
getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">
Parameters
- nameOrSignature: "name"
Returns TypedContractMethod<[], [string], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:504
getFunction(nameOrSignature): TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">
Parameters
- nameOrSignature: "previewDeposit"
Returns TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:507
getFunction(nameOrSignature): TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">
Parameters
- nameOrSignature: "previewMint"
Returns TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:510
getFunction(nameOrSignature): TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">
Parameters
- nameOrSignature: "previewRedeem"
Returns TypedContractMethod<[shareAmount: BigNumberish], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:513
getFunction(nameOrSignature): TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">
Parameters
- nameOrSignature: "previewWithdraw"
Returns TypedContractMethod<[assetAmount: BigNumberish], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:516
getFunction(nameOrSignature): TypedContractMethod<[shareAmount: BigNumberish, receiver: AddressLike, owner: AddressLike], [bigint], "nonpayable">
Parameters
- nameOrSignature: "redeem"
Returns TypedContractMethod<[shareAmount: BigNumberish, receiver: AddressLike, owner: AddressLike], [bigint], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:519
getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">
Parameters
- nameOrSignature: "symbol"
Returns TypedContractMethod<[], [string], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:526
getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">
Parameters
- nameOrSignature: "totalAssets"
Returns TypedContractMethod<[], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:529
getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">
Parameters
- nameOrSignature: "totalSupply"
Returns TypedContractMethod<[], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:532
getFunction(nameOrSignature): TypedContractMethod<[recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
Parameters
- nameOrSignature: "transfer"
Returns TypedContractMethod<[recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:535
getFunction(nameOrSignature): TypedContractMethod<[holder: AddressLike, recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
Parameters
- nameOrSignature: "transferFrom"
Returns TypedContractMethod<[holder: AddressLike, recipient: AddressLike, amount: BigNumberish], [boolean], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:542
getFunction(nameOrSignature): TypedContractMethod<[assetAmount: BigNumberish, receiver: AddressLike, owner: AddressLike], [bigint], "nonpayable">
Parameters
- nameOrSignature: "withdraw"
Returns TypedContractMethod<[assetAmount: BigNumberish, receiver: AddressLike, owner: AddressLike], [bigint], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IERC4626.ts:549

listenerCount

listenerCount(event?): Promise<number>
Parameters
- Optional event: ContractEventName
Returns Promise<number>
Inherited from BaseContract.listenerCount
- Defined in node_modules/ethers/types/contract/contract.d.ts:38

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 src/typechain/IERC4626.ts:331
listeners(eventName?): Promise<Listener[]>
Parameters
- Optional eventName: string
Returns Promise<Listener[]>
Overrides BaseContract.listeners
- Defined in src/typechain/IERC4626.ts:334

off

off(event, listener?): Promise<IERC4626>
Parameters
- event: ContractEventName
- Optional listener: Listener
Returns Promise<IERC4626>
Inherited from BaseContract.off
- Defined in node_modules/ethers/types/contract/contract.d.ts:40

on

on<TCEvent>(event, listener): Promise<IERC4626>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IERC4626>
Overrides BaseContract.on
- Defined in src/typechain/IERC4626.ts:313
on<TCEvent>(filter, listener): Promise<IERC4626>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IERC4626>
Overrides BaseContract.on
- Defined in src/typechain/IERC4626.ts:317

once

once<TCEvent>(event, listener): Promise<IERC4626>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IERC4626>
Overrides BaseContract.once
- Defined in src/typechain/IERC4626.ts:322
once<TCEvent>(filter, listener): Promise<IERC4626>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IERC4626>
Overrides BaseContract.once
- Defined in src/typechain/IERC4626.ts:326

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 src/typechain/IERC4626.ts:302
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 src/typechain/IERC4626.ts:307

queryTransaction

queryTransaction(hash): Promise<EventLog[]>
Parameters
- hash: string
Returns Promise<EventLog[]>
Inherited from BaseContract.queryTransaction
- Defined in node_modules/ethers/types/contract/contract.d.ts:33

removeAllListeners

removeAllListeners<TCEvent>(event?): Promise<IERC4626>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- Optional event: TCEvent
Returns Promise<IERC4626>
Overrides BaseContract.removeAllListeners
- Defined in src/typechain/IERC4626.ts:335

removeListener

removeListener(event, listener): Promise<IERC4626>
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IERC4626>
Inherited from BaseContract.removeListener
- Defined in node_modules/ethers/types/contract/contract.d.ts:43

waitForDeployment

waitForDeployment(): Promise<IERC4626>
Returns Promise<IERC4626>
Inherited from BaseContract.waitForDeployment
- Defined in node_modules/ethers/types/contract/contract.d.ts:29

Interface IERC4626

Hierarchy

Index

Properties

Methods

Properties

Readonly [internal]

allowance

approve

asset

balanceOf

convertToAssets

convertToShares

decimals

deposit

Readonly fallback

filters

Type declaration

Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Deposit(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Withdraw(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

interface

maxDeposit

maxMint

maxRedeem

maxWithdraw

mint

name

previewDeposit

previewMint

previewRedeem

previewWithdraw

redeem

Readonly runner

symbol

Readonly target

totalAssets

totalSupply

transfer

transferFrom

withdraw

Methods

addListener

Parameters

event: ContractEventName

listener: Listener

Returns Promise<IERC4626>

attach

Parameters

addressOrName: AddressLike

Returns IERC4626

connect

Parameters

Optional runner: null | ContractRunner

Returns BaseContract

deployed

Returns Promise<IERC4626>

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

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Parameters

key: "Deposit"

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

`Readonly` [internal]

`Readonly` fallback

`Readonly` runner

`Readonly` target

`Optional` runner: null | ContractRunner

`Rest` ...args: any[]