Class ERC4626

Hierarchy

Model<ERC4626Methods>
- ERC4626

Implements

Deployable

Constructors

constructor

new ERC4626(web3Connection: Web3Connection | Web3ConnectionOptions, contractAddress?: string): ERC4626

Overrides Model.constructor
- Defined in src/models/erc4626.ts:19
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
Returns ERC4626

Properties

Private _asset

_asset: null | ERC20 = null

Protected _contract

_contract: Web3Contract<ERC4626Methods, any>

Private _decimals

_decimals: number = -1

Readonly abi

abi: AbiItem[]

Optional Readonly contractAddress

contractAddress?: string

Accessors

account

get account(): Account

Inherited from Model.account
- Defined in src/base/model.ts:48
Returns the Account associated with this connection

Returns Account

asset

get asset(): null | ERC20

- Defined in src/models/erc4626.ts:93
Returns null | ERC20

Protected connection

get connection(): Web3Connection

Inherited from Model.connection
- Defined in src/base/model.ts:38
Pointer to the Web3Connection assigned to this contract class

Returns Web3Connection

contract

get contract(): Web3Contract<Methods, any>

Inherited from Model.contract
- Defined in src/base/model.ts:21
Returns the Web3Contract class representing this contract

Returns Web3Contract<Methods, any>

web3

get web3(): default

Inherited from Model.web3
- Defined in src/base/model.ts:43
Returns the Web3 class assigned to this connection

Returns default

Methods

allowance

allowance(owner: string, spender: string): Promise<string>

- Defined in src/models/erc4626.ts:42
Parameters
- owner: string
- spender: string
Returns Promise<string>

approve

approve(spender: string, amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:47
Parameters
- spender: string
- amount: number
Returns Promise<TransactionReceipt<any>>

assetAddress

assetAddress(): Promise<string>

- Defined in src/models/erc4626.ts:95
Returns Promise<string>

balanceOf

balanceOf(account: string): Promise<string>

- Defined in src/models/erc4626.ts:51
Parameters
- account: string
Returns Promise<string>

callTx

callTx<ReturnData>(method: ContractCallMethod<ReturnData>): Promise<ReturnData>

Inherited from Model.callTx
- Defined in src/base/model.ts:93
Return a property value from the contract

Type Parameters
- ReturnData = any
Parameters
- method: ContractCallMethod<ReturnData>
Returns Promise<ReturnData>

connect

connect(): Promise<boolean>

Inherited from Model.connect
- Defined in src/base/model.ts:72
Alias for Web3Connection.connect(); Will load contract if success

Returns Promise<boolean>

convertToAssets

convertToAssets(shares: number): Promise<string>

- Defined in src/models/erc4626.ts:109
Parameters
- shares: number
Returns Promise<string>

convertToShares

convertToShares(assets: number): Promise<string>

- Defined in src/models/erc4626.ts:103
Parameters
- assets: number
Returns Promise<string>

decimals

decimals(): Promise<number>

- Defined in src/models/erc4626.ts:86
Returns Promise<number>

decreaseAllowance

decreaseAllowance(spender: string, subtractedValue: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:56
Parameters
- spender: string
- subtractedValue: number
Returns Promise<TransactionReceipt<any>>

Protected deploy

deploy(deployOptions: DeployOptions, account?: Account): Promise<TransactionReceipt<any>>

Inherited from Model.deploy
- Defined in src/base/model.ts:147
Deploy the loaded abi contract

Parameters
- deployOptions: DeployOptions
- Optional account: Account
Returns Promise<TransactionReceipt<any>>

deployJsonAbi

deployJsonAbi(erc20Address: string, name: string, symbol: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/erc4626.ts:23
Parameters
- erc20Address: string
- name: string
- symbol: string
Returns Promise<TransactionReceipt<any>>

deposit

deposit(assets: number, receiver: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:156
Parameters
- assets: number
- receiver: string
Returns Promise<TransactionReceipt<any>>

getApprovalEvents

getApprovalEvents(filter: PastEventOptions): XPromiseEvent<ApprovalEvent>

- Defined in src/models/erc4626.ts:175
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<ApprovalEvent>

getDepositEvents

getDepositEvents(filter: PastEventOptions): XPromiseEvent<DepositEvent>

- Defined in src/models/erc4626.ts:179
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<DepositEvent>

getTransferEvents

getTransferEvents(filter: PastEventOptions): XPromiseEvent<TransferEvent>

- Defined in src/models/erc4626.ts:183
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<TransferEvent>

getWithdrawEvents

getWithdrawEvents(filter: PastEventOptions): XPromiseEvent<WithdrawEvent>

- Defined in src/models/erc4626.ts:187
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<WithdrawEvent>

increaseAllowance

increaseAllowance(spender: string, addedValue: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:61
Parameters
- spender: string
- addedValue: number
Returns Promise<TransactionReceipt<any>>

loadAbi

loadAbi(): void

Inherited from Model.loadAbi
- Defined in src/base/model.ts:53
Permissive way of initializing the contract, used primarily for deploys. Prefer to use loadContract

Returns void

loadContract

loadContract(): Promise<void>

Overrides Model.loadContract
- Defined in src/models/erc4626.ts:34
Preferred way of initializing and loading a contract

Returns Promise<void>

maxDeposit

maxDeposit(arg1: string): Promise<number>

- Defined in src/models/erc4626.ts:115
Parameters
- arg1: string
Returns Promise<number>

maxMint

maxMint(arg1: string): Promise<number>

- Defined in src/models/erc4626.ts:119
Parameters
- arg1: string
Returns Promise<number>

maxRedeem

maxRedeem(owner: string): Promise<string>

- Defined in src/models/erc4626.ts:128
Parameters
- owner: string
Returns Promise<string>

maxWithdraw

maxWithdraw(owner: string): Promise<string>

- Defined in src/models/erc4626.ts:123
Parameters
- owner: string
Returns Promise<string>

mint

mint(shares: number, receiver: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:161
Parameters
- shares: number
- receiver: string
Returns Promise<TransactionReceipt<any>>

name

name(): Promise<string>

- Defined in src/models/erc4626.ts:65
Returns Promise<string>

previewDeposit

previewDeposit(assets: number): Promise<string>

- Defined in src/models/erc4626.ts:132
Parameters
- assets: number
Returns Promise<string>

previewMint

previewMint(shares: number): Promise<string>

- Defined in src/models/erc4626.ts:138
Parameters
- shares: number
Returns Promise<string>

previewRedeem

previewRedeem(shares: number): Promise<string>

- Defined in src/models/erc4626.ts:144
Parameters
- shares: number
Returns Promise<string>

previewWithdraw

previewWithdraw(assets: number): Promise<string>

- Defined in src/models/erc4626.ts:150
Parameters
- assets: number
Returns Promise<string>

redeem

redeem(shares: number, receiver: string, owner: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:170
Parameters
- shares: number
- receiver: string
- owner: string
Returns Promise<TransactionReceipt<any>>

sendTx

sendTx(method: ContractSendMethod, value?: any): Promise<TransactionReceipt<any>>

Inherited from Model.sendTx
- Defined in src/base/model.ts:100
Interact with, or change a value of, a property on the contract

Parameters
- method: ContractSendMethod
- Optional value: any
Returns Promise<TransactionReceipt<any>>

sendUnsignedTx

sendUnsignedTx(method: ContractSendMethod, value?: any, __namedParameters?: Partial<Web3ConnectionOptions>): Promise<TransactionReceipt<any>>

Inherited from Model.sendUnsignedTx
- Defined in src/base/model.ts:118
Send unsigned transaction

Parameters
- method: ContractSendMethod
- Optional value: any
- __namedParameters: Partial<Web3ConnectionOptions> = {}
Returns Promise<TransactionReceipt<any>>

start

start(): Promise<void>

Inherited from Model.start
- Defined in src/base/model.ts:85
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

symbol

symbol(): Promise<string>

- Defined in src/models/erc4626.ts:69
Returns Promise<string>

totalAssets

totalAssets(): Promise<string>

- Defined in src/models/erc4626.ts:99
Returns Promise<string>

totalSupply

totalSupply(): Promise<string>

- Defined in src/models/erc4626.ts:73
Returns Promise<string>

transfer

transfer(recipient: string, amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:77
Parameters
- recipient: string
- amount: number
Returns Promise<TransactionReceipt<any>>

transferFrom

transferFrom(sender: string, recipient: string, amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:81
Parameters
- sender: string
- recipient: string
- amount: number
Returns Promise<TransactionReceipt<any>>

withdraw

withdraw(assets: number, receiver: string, owner: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc4626.ts:165
Parameters
- assets: number
- receiver: string
- owner: string
Returns Promise<TransactionReceipt<any>>

Generated using TypeDoc