Last update: October 8, 2021

yearn-vaults / Modules / VaultAPI / VaultAPI

Class: VaultAPI

VaultAPI.VaultAPI

Hierarchy

BaseContract

↳ VaultAPI

Table of contents

Constructors

constructor

Properties

Methods

Constructors

constructor

• new VaultAPI(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
`allowance`	(`owner`: `string`, `spender`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`apiVersion`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`creditAvailable`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`debtOutstanding`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`deposit()`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`deposit(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`deposit(uint256,address)`	(`amount`: `BigNumberish`, `recipient`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`depositLimit`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`expectedReturn`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`governance`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`guardian`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`management`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`maxAvailableShares`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`permit`	(`owner`: `string`, `spender`: `string`, `amount`: `BigNumberish`, `expiry`: `BigNumberish`, `signature`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`pricePerShare`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`report`	(`_gain`: `BigNumberish`, `_loss`: `BigNumberish`, `_debtPayment`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`revokeStrategy`	(`overrides?`: `CallOverrides`) => `Promise`<`void`>
`strategies`	(`_strategy`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`] & { `activation`: `BigNumber` ; `debtRatio`: `BigNumber` ; `lastReport`: `BigNumber` ; `maxDebtPerHarvest`: `BigNumber` ; `minDebtPerHarvest`: `BigNumber` ; `performanceFee`: `BigNumber` ; `totalDebt`: `BigNumber` ; `totalGain`: `BigNumber` ; `totalLoss`: `BigNumber` }>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`totalAssets`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`transfer`	(`recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`transferFrom`	(`sender`: `string`, `recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`withdraw()`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`withdraw(uint256)`	(`maxShares`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`withdraw(uint256,address)`	(`maxShares`: `BigNumberish`, `recipient`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>

Overrides

BaseContract.callStatic

Defined in

typechain/VaultAPI.d.ts:539

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
`allowance`	(`owner`: `string`, `spender`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`apiVersion`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`creditAvailable`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`debtOutstanding`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`deposit()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`deposit(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`deposit(uint256,address)`	(`amount`: `BigNumberish`, `recipient`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`depositLimit`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`expectedReturn`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`governance`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`guardian`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`management`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`maxAvailableShares`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`permit`	(`owner`: `string`, `spender`: `string`, `amount`: `BigNumberish`, `expiry`: `BigNumberish`, `signature`: `BytesLike`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`pricePerShare`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`report`	(`_gain`: `BigNumberish`, `_loss`: `BigNumberish`, `_debtPayment`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`revokeStrategy`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`strategies`	(`_strategy`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalAssets`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`transfer`	(`recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`transferFrom`	(`sender`: `string`, `recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`withdraw()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`withdraw(uint256)`	(`maxShares`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`withdraw(uint256,address)`	(`maxShares`: `BigNumberish`, `recipient`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>

Overrides

BaseContract.estimateGas

Defined in

typechain/VaultAPI.d.ts:709

filters

• filters: Object

Type declaration

Name	Type
`Approval`	(`owner?`: `null` \| `string`, `spender?`: `null` \| `string`, `value?`: `null`) => `TypedEventFilter`<[`string`, `string`, `BigNumber`], `Object`>
`Approval(address,address,uint256)`	(`owner?`: `null` \| `string`, `spender?`: `null` \| `string`, `value?`: `null`) => `TypedEventFilter`<[`string`, `string`, `BigNumber`], `Object`>
`Transfer`	(`from?`: `null` \| `string`, `to?`: `null` \| `string`, `value?`: `null`) => `TypedEventFilter`<[`string`, `string`, `BigNumber`], `Object`>
`Transfer(address,address,uint256)`	(`from?`: `null` \| `string`, `to?`: `null` \| `string`, `value?`: `null`) => `TypedEventFilter`<[`string`, `string`, `BigNumber`], `Object`>

Overrides

BaseContract.filters

Defined in

typechain/VaultAPI.d.ts:671

functions

• functions: Object

Type declaration

Name	Type
`allowance`	(`owner`: `string`, `spender`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`apiVersion`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`creditAvailable`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`debtOutstanding`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`deposit()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`deposit(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`deposit(uint256,address)`	(`amount`: `BigNumberish`, `recipient`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`depositLimit`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`expectedReturn`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`governance`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`guardian`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`management`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`maxAvailableShares`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`permit`	(`owner`: `string`, `spender`: `string`, `amount`: `BigNumberish`, `expiry`: `BigNumberish`, `signature`: `BytesLike`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`pricePerShare`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`report`	(`_gain`: `BigNumberish`, `_loss`: `BigNumberish`, `_debtPayment`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`revokeStrategy`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`strategies`	(`_strategy`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[[`BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`] & { `activation`: `BigNumber` ; `debtRatio`: `BigNumber` ; `lastReport`: `BigNumber` ; `maxDebtPerHarvest`: `BigNumber` ; `minDebtPerHarvest`: `BigNumber` ; `performanceFee`: `BigNumber` ; `totalDebt`: `BigNumber` ; `totalGain`: `BigNumber` ; `totalLoss`: `BigNumber` }]>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`totalAssets`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`transfer`	(`recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`transferFrom`	(`sender`: `string`, `recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`withdraw()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`withdraw(uint256)`	(`maxShares`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`withdraw(uint256,address)`	(`maxShares`: `BigNumberish`, `recipient`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>

Overrides

BaseContract.functions

Defined in

typechain/VaultAPI.d.ts:263

interface

• interface: VaultAPIInterface

Overrides

BaseContract.interface

Defined in

typechain/VaultAPI.d.ts:261

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
`allowance`	(`owner`: `string`, `spender`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`apiVersion`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`creditAvailable`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`debtOutstanding`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`deposit()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`deposit(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`deposit(uint256,address)`	(`amount`: `BigNumberish`, `recipient`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`depositLimit`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`expectedReturn`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`governance`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`guardian`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`management`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`maxAvailableShares`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`permit`	(`owner`: `string`, `spender`: `string`, `amount`: `BigNumberish`, `expiry`: `BigNumberish`, `signature`: `BytesLike`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`pricePerShare`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`report`	(`_gain`: `BigNumberish`, `_loss`: `BigNumberish`, `_debtPayment`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`revokeStrategy`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`strategies`	(`_strategy`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`totalAssets`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`transfer`	(`recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`transferFrom`	(`sender`: `string`, `recipient`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`withdraw()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`withdraw(uint256)`	(`maxShares`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`withdraw(uint256,address)`	(`maxShares`: `BigNumberish`, `recipient`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>

Overrides

BaseContract.populateTransaction

Defined in

typechain/VaultAPI.d.ts:825

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

allowance

▸ allowance(owner, spender, overrides?): Promise<BigNumber>

Parameters

Name	Type
`owner`	`string`
`spender`	`string`
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:403

apiVersion

▸ apiVersion(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/VaultAPI.d.ts:409

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

typechain/VaultAPI.d.ts:411

attach

▸ attach(addressOrName): VaultAPI

Parameters

Name	Type
`addressOrName`	`string`

Returns

VaultAPI

Overrides

BaseContract.attach

Defined in

typechain/VaultAPI.d.ts:222

balanceOf

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

Parameters

Name	Type
`account`	`string`
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:417

connect

▸ connect(signerOrProvider): VaultAPI

Parameters

Name	Type
`signerOrProvider`	`string` \| `Provider` \| `Signer`

Returns

VaultAPI

Overrides

BaseContract.connect

Defined in

typechain/VaultAPI.d.ts:221

creditAvailable

▸ creditAvailable(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:419

debtOutstanding

▸ debtOutstanding(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:421

decimals

▸ decimals(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:423

deployed

▸ deployed(): Promise<VaultAPI>

Returns

Promise<VaultAPI>

Overrides

BaseContract.deployed

Defined in

typechain/VaultAPI.d.ts:223

deposit()

▸ deposit()(overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:436

deposit(uint256)

▸ deposit(uint256)(amount, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:431

deposit(uint256,address)

▸ deposit(uint256,address)(amount, recipient, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:425

depositLimit

▸ depositLimit(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:440

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

expectedReturn

▸ expectedReturn(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:442

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

governance

▸ governance(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/VaultAPI.d.ts:444

guardian

▸ guardian(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/VaultAPI.d.ts:446

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/VaultAPI.d.ts:225

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
`eventName?`	`string`

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

typechain/VaultAPI.d.ts:248

management

▸ management(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/VaultAPI.d.ts:448

maxAvailableShares

▸ maxAvailableShares(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:450

name

▸ name(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/VaultAPI.d.ts:452

off

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

Type parameters

Name	Type
`EventArgsArray`	extends `any`[]
`EventArgsObject`	`EventArgsObject`

Parameters

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

Returns

VaultAPI

Overrides

BaseContract.off

Defined in

typechain/VaultAPI.d.ts:228

▸ off(eventName, listener): VaultAPI

Parameters

Name	Type
`eventName`	`string`
`listener`	`Listener`

Returns

VaultAPI

Overrides

BaseContract.off

Defined in

typechain/VaultAPI.d.ts:249

on

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

Type parameters

Name	Type
`EventArgsArray`	extends `any`[]
`EventArgsObject`	`EventArgsObject`

Parameters

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

Returns

VaultAPI

Overrides

BaseContract.on

Defined in

typechain/VaultAPI.d.ts:232

▸ on(eventName, listener): VaultAPI

Parameters

Name	Type
`eventName`	`string`
`listener`	`Listener`

Returns

VaultAPI

Overrides

BaseContract.on

Defined in

typechain/VaultAPI.d.ts:250

once

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

Type parameters

Name	Type
`EventArgsArray`	extends `any`[]
`EventArgsObject`	`EventArgsObject`

Parameters

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

Returns

VaultAPI

Overrides

BaseContract.once

Defined in

typechain/VaultAPI.d.ts:236

▸ once(eventName, listener): VaultAPI

Parameters

Name	Type
`eventName`	`string`
`listener`	`Listener`

Returns

VaultAPI

Overrides

BaseContract.once

Defined in

typechain/VaultAPI.d.ts:251

permit

▸ permit(owner, spender, amount, expiry, signature, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`owner`	`string`
`spender`	`string`
`amount`	`BigNumberish`
`expiry`	`BigNumberish`
`signature`	`BytesLike`
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:454

pricePerShare

▸ pricePerShare(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:463

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/VaultAPI.d.ts:255

removeAllListeners

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

Type parameters

Name	Type
`EventArgsArray`	extends `any`[]
`EventArgsObject`	`EventArgsObject`

Parameters

Name	Type
`eventFilter`	`TypedEventFilter`<`EventArgsArray`, `EventArgsObject`>

Returns

VaultAPI

Overrides

BaseContract.removeAllListeners

Defined in

typechain/VaultAPI.d.ts:244

▸ removeAllListeners(eventName?): VaultAPI

Parameters

Name	Type
`eventName?`	`string`

Returns

VaultAPI

Overrides

BaseContract.removeAllListeners

Defined in

typechain/VaultAPI.d.ts:253

removeListener

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

Type parameters

Name	Type
`EventArgsArray`	extends `any`[]
`EventArgsObject`	`EventArgsObject`

Parameters

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

Returns

VaultAPI

Overrides

BaseContract.removeListener

Defined in

typechain/VaultAPI.d.ts:240

▸ removeListener(eventName, listener): VaultAPI

Parameters

Name	Type
`eventName`	`string`
`listener`	`Listener`

Returns

VaultAPI

Overrides

BaseContract.removeListener

Defined in

typechain/VaultAPI.d.ts:252

report

▸ report(_gain, _loss, _debtPayment, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`_gain`	`BigNumberish`
`_loss`	`BigNumberish`
`_debtPayment`	`BigNumberish`
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:465

revokeStrategy

▸ revokeStrategy(overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:472

strategies

▸ strategies(_strategy, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber] & { activation: BigNumber ; debtRatio: BigNumber ; lastReport: BigNumber ; maxDebtPerHarvest: BigNumber ; minDebtPerHarvest: BigNumber ; performanceFee: BigNumber ; totalDebt: BigNumber ; totalGain: BigNumber ; totalLoss: BigNumber }>

Parameters

Name	Type
`_strategy`	`string`
`overrides?`	`CallOverrides`

Returns

Promise<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber] & { activation: BigNumber ; debtRatio: BigNumber ; lastReport: BigNumber ; maxDebtPerHarvest: BigNumber ; minDebtPerHarvest: BigNumber ; performanceFee: BigNumber ; totalDebt: BigNumber ; totalGain: BigNumber ; totalLoss: BigNumber }>

Defined in

typechain/VaultAPI.d.ts:476

symbol

▸ symbol(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/VaultAPI.d.ts:503

token

▸ token(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/VaultAPI.d.ts:505

totalAssets

▸ totalAssets(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:507

totalSupply

▸ totalSupply(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/VaultAPI.d.ts:509

transfer

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:511

transferFrom

▸ transferFrom(sender, recipient, amount, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`sender`	`string`
`recipient`	`string`
`amount`	`BigNumberish`
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:517

withdraw()

▸ withdraw()(overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:535

withdraw(uint256)

▸ withdraw(uint256)(maxShares, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`maxShares`	`BigNumberish`
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:530

withdraw(uint256,address)

▸ withdraw(uint256,address)(maxShares, recipient, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`maxShares`	`BigNumberish`
`recipient`	`string`
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/VaultAPI.d.ts:524

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