Skip to content
You are reading the development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.
Last update: October 8, 2021

yearn-vaults / Modules / VaultAPI / VaultAPIInterface

Interface: VaultAPIInterface

VaultAPI.VaultAPIInterface

Hierarchy

  • Interface

VaultAPIInterface

Table of contents

Properties

Methods

Properties

_abiCoder

Readonly _abiCoder: AbiCoder

Inherited from

ethers.utils.Interface._abiCoder

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:50


_isInterface

Readonly _isInterface: boolean

Inherited from

ethers.utils.Interface._isInterface

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:51


deploy

Readonly deploy: ConstructorFragment

Inherited from

ethers.utils.Interface.deploy

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:49


errors

Readonly errors: Object

Index signature

▪ [name: string]: ErrorFragment

Inherited from

ethers.utils.Interface.errors

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:37


events

events: Object

Type declaration

Name Type
Approval(address,address,uint256) EventFragment
Transfer(address,address,uint256) EventFragment

Overrides

ethers.utils.Interface.events

Defined in

typechain/VaultAPI.d.ts:199


fragments

Readonly fragments: readonly Fragment[]

Inherited from

ethers.utils.Interface.fragments

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:36


functions

functions: Object

Type declaration

Name Type
allowance(address,address) FunctionFragment
apiVersion() FunctionFragment
approve(address,uint256) FunctionFragment
balanceOf(address) FunctionFragment
creditAvailable() FunctionFragment
debtOutstanding() FunctionFragment
decimals() FunctionFragment
deposit(uint256,address) FunctionFragment
depositLimit() FunctionFragment
expectedReturn() FunctionFragment
governance() FunctionFragment
guardian() FunctionFragment
management() FunctionFragment
maxAvailableShares() FunctionFragment
name() FunctionFragment
permit(address,address,uint256,uint256,bytes) FunctionFragment
pricePerShare() FunctionFragment
report(uint256,uint256,uint256) FunctionFragment
revokeStrategy() FunctionFragment
strategies(address) FunctionFragment
symbol() FunctionFragment
token() FunctionFragment
totalAssets() FunctionFragment
totalSupply() FunctionFragment
transfer(address,uint256) FunctionFragment
transferFrom(address,address,uint256) FunctionFragment
withdraw(uint256,address) FunctionFragment

Overrides

ethers.utils.Interface.functions

Defined in

typechain/VaultAPI.d.ts:23


structs

Readonly structs: Object

Index signature

▪ [name: string]: any

Inherited from

ethers.utils.Interface.structs

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:46

Methods

_decodeParams

_decodeParams(params, data): Result

Parameters

Name Type
params readonly ParamType[]
data BytesLike

Returns

Result

Inherited from

ethers.utils.Interface._decodeParams

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:63


_encodeParams

_encodeParams(params, values): string

Parameters

Name Type
params readonly ParamType[]
values readonly any[]

Returns

string

Inherited from

ethers.utils.Interface._encodeParams

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:64


decodeErrorResult

decodeErrorResult(fragment, data): Result

Parameters

Name Type
fragment string | ErrorFragment
data BytesLike

Returns

Result

Inherited from

ethers.utils.Interface.decodeErrorResult

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:66


decodeEventLog

decodeEventLog(eventFragment, data, topics?): Result

Parameters

Name Type
eventFragment string | EventFragment
data BytesLike
topics? readonly string[]

Returns

Result

Inherited from

ethers.utils.Interface.decodeEventLog

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:77


decodeFunctionData

decodeFunctionData(functionFragment, data): Result

Parameters

Name Type
functionFragment string | FunctionFragment
data BytesLike

Returns

Result

Inherited from

ethers.utils.Interface.decodeFunctionData

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:68


decodeFunctionResult

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "allowance"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:141

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "apiVersion"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:142

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "approve"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:143

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "balanceOf"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:144

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "creditAvailable"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:145

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "debtOutstanding"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:149

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "decimals"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:153

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "deposit"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:154

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "depositLimit"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:155

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "expectedReturn"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:159

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "governance"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:163

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "guardian"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:164

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "management"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:165

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "maxAvailableShares"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:166

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "name"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:170

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "permit"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:171

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "pricePerShare"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:172

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "report"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:176

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "revokeStrategy"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:177

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "strategies"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:181

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "symbol"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:182

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "token"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:183

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "totalAssets"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:184

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "totalSupply"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:188

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "transfer"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:192

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "transferFrom"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:193

decodeFunctionResult(functionFragment, data): Result

Parameters

Name Type
functionFragment "withdraw"
data BytesLike

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/VaultAPI.d.ts:197


encodeDeploy

encodeDeploy(values?): string

Parameters

Name Type
values? readonly any[]

Returns

string

Inherited from

ethers.utils.Interface.encodeDeploy

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:65


encodeErrorResult

encodeErrorResult(fragment, values?): string

Parameters

Name Type
fragment string | ErrorFragment
values? readonly any[]

Returns

string

Inherited from

ethers.utils.Interface.encodeErrorResult

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:67


encodeEventLog

encodeEventLog(eventFragment, values): Object

Parameters

Name Type
eventFragment EventFragment
values readonly any[]

Returns

Object

Name Type
data string
topics string[]

Inherited from

ethers.utils.Interface.encodeEventLog

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:73


encodeFilterTopics

encodeFilterTopics(eventFragment, values): (string | string[])[]

Parameters

Name Type
eventFragment EventFragment
values readonly any[]

Returns

(string | string[])[]

Inherited from

ethers.utils.Interface.encodeFilterTopics

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:72


encodeFunctionData

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "allowance"
values [string, string]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:53

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "apiVersion"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:57

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "approve"
values [string, BigNumberish]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:61

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "balanceOf"
values [string]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:65

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "creditAvailable"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:66

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "debtOutstanding"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:70

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "decimals"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:74

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "deposit"
values [BigNumberish, string]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:75

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "depositLimit"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:79

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "expectedReturn"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:83

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "governance"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:87

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "guardian"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:91

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "management"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:92

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "maxAvailableShares"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:96

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "name"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:100

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "permit"
values [string, string, BigNumberish, BigNumberish, BytesLike]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:101

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "pricePerShare"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:105

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "report"
values [BigNumberish, BigNumberish, BigNumberish]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:109

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "revokeStrategy"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:113

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "strategies"
values [string]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:117

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "symbol"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:118

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "token"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:119

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "totalAssets"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:120

encodeFunctionData(functionFragment, values?): string

Parameters

Name Type
functionFragment "totalSupply"
values? undefined

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:124

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "transfer"
values [string, BigNumberish]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:128

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "transferFrom"
values [string, string, BigNumberish]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:132

encodeFunctionData(functionFragment, values): string

Parameters

Name Type
functionFragment "withdraw"
values [BigNumberish, string]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/VaultAPI.d.ts:136


encodeFunctionResult

encodeFunctionResult(functionFragment, values?): string

Parameters

Name Type
functionFragment string | FunctionFragment
values? readonly any[]

Returns

string

Inherited from

ethers.utils.Interface.encodeFunctionResult

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:71


format

format(format?): string | string[]

Parameters

Name Type
format? string

Returns

string | string[]

Inherited from

ethers.utils.Interface.format

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:53


getError

getError(nameOrSignatureOrSighash): ErrorFragment

Parameters

Name Type
nameOrSignatureOrSighash string

Returns

ErrorFragment

Inherited from

ethers.utils.Interface.getError

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:60


getEvent

getEvent(nameOrSignatureOrTopic): EventFragment

Parameters

Name Type
nameOrSignatureOrTopic "Approval"

Returns

EventFragment

Overrides

ethers.utils.Interface.getEvent

Defined in

typechain/VaultAPI.d.ts:204

getEvent(nameOrSignatureOrTopic): EventFragment

Parameters

Name Type
nameOrSignatureOrTopic "Transfer"

Returns

EventFragment

Overrides

ethers.utils.Interface.getEvent

Defined in

typechain/VaultAPI.d.ts:205


getEventTopic

getEventTopic(eventFragment): string

Parameters

Name Type
eventFragment string | EventFragment

Returns

string

Inherited from

ethers.utils.Interface.getEventTopic

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:62


getFunction

getFunction(nameOrSignatureOrSighash): FunctionFragment

Parameters

Name Type
nameOrSignatureOrSighash string

Returns

FunctionFragment

Inherited from

ethers.utils.Interface.getFunction

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:58


getSighash

getSighash(fragment): string

Parameters

Name Type
fragment string | ErrorFragment | FunctionFragment

Returns

string

Inherited from

ethers.utils.Interface.getSighash

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:61


parseError

parseError(data): ErrorDescription

Parameters

Name Type
data BytesLike

Returns

ErrorDescription

Inherited from

ethers.utils.Interface.parseError

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:86


parseLog

parseLog(log): LogDescription

Parameters

Name Type
log Object
log.data string
log.topics string[]

Returns

LogDescription

Inherited from

ethers.utils.Interface.parseLog

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:82


parseTransaction

parseTransaction(tx): TransactionDescription

Parameters

Name Type
tx Object
tx.data string
tx.value? BigNumberish

Returns

TransactionDescription

Inherited from

ethers.utils.Interface.parseTransaction

Defined in

node_modules/ethers/node_modules/@ethersproject/abi/lib/interface.d.ts:78

Questions or feedback? You can discuss issues and obtain free support on Yearn Vaults chat channel.
For SushiSwap community support, join the Discord Server None