Last update: October 8, 2021

yearn-vaults / Modules / YToken / YTokenInterface

Interface: YTokenInterface

YToken.YTokenInterface

Hierarchy

Interface

↳ YTokenInterface

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/YToken.d.ts:160

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
`allVaults()`	`FunctionFragment`
`allowance(address,address)`	`FunctionFragment`
`approve(address,uint256)`	`FunctionFragment`
`balanceOf(address)`	`FunctionFragment`
`bestVault(address)`	`FunctionFragment`
`decimals()`	`FunctionFragment`
`decreaseAllowance(address,uint256)`	`FunctionFragment`
`deposit(uint256)`	`FunctionFragment`
`increaseAllowance(address,uint256)`	`FunctionFragment`
`migrate(address[],bytes[])`	`FunctionFragment`
`name()`	`FunctionFragment`
`permitAll(address[],bytes[])`	`FunctionFragment`
`registry()`	`FunctionFragment`
`revokeAll(address[],bytes[])`	`FunctionFragment`
`setRegistry(address)`	`FunctionFragment`
`symbol()`	`FunctionFragment`
`token()`	`FunctionFragment`
`totalAssets()`	`FunctionFragment`
`totalSupply()`	`FunctionFragment`
`totalVaultBalance(address,address)`	`FunctionFragment`
`transfer(address,uint256)`	`FunctionFragment`
`transferFrom(address,address,uint256)`	`FunctionFragment`
`withdraw(uint256)`	`FunctionFragment`

Overrides

ethers.utils.Interface.functions

Defined in

typechain/YToken.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`	`"allVaults"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:115

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"allowance"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:116

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"approve"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:117

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"balanceOf"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:118

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"bestVault"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:119

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"decimals"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:120

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"decreaseAllowance"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:121

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"deposit"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:125

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"increaseAllowance"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:126

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"migrate"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:130

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"name"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:131

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"permitAll"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:132

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"registry"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:133

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"revokeAll"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:134

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"setRegistry"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:135

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"symbol"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:139

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"token"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:140

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"totalAssets"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:141

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"totalSupply"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:145

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"totalVaultBalance"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:149

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"transfer"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:153

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"transferFrom"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:154

▸ decodeFunctionResult(functionFragment, data): Result

Parameters

Name	Type
`functionFragment`	`"withdraw"`
`data`	`BytesLike`

Returns

Result

Overrides

ethers.utils.Interface.decodeFunctionResult

Defined in

typechain/YToken.d.ts:158

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`	`"allVaults"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:49

▸ encodeFunctionData(functionFragment, values): string

Parameters

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

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:50

▸ encodeFunctionData(functionFragment, values): string

Parameters

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

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:54

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"balanceOf"`
`values`	[`string`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:58

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"bestVault"`
`values`	[`string`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:59

▸ encodeFunctionData(functionFragment, values?): string

Parameters

Name	Type
`functionFragment`	`"decimals"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:60

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"decreaseAllowance"`
`values`	[`string`, `BigNumberish`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:61

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"deposit"`
`values`	[`BigNumberish`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:65

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"increaseAllowance"`
`values`	[`string`, `BigNumberish`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:69

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"migrate"`
`values`	[`string`[], `BytesLike`[]]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:73

▸ encodeFunctionData(functionFragment, values?): string

Parameters

Name	Type
`functionFragment`	`"name"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:77

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"permitAll"`
`values`	[`string`[], `BytesLike`[]]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:78

▸ encodeFunctionData(functionFragment, values?): string

Parameters

Name	Type
`functionFragment`	`"registry"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:82

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"revokeAll"`
`values`	[`string`[], `BytesLike`[]]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:83

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"setRegistry"`
`values`	[`string`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:87

▸ encodeFunctionData(functionFragment, values?): string

Parameters

Name	Type
`functionFragment`	`"symbol"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:88

▸ encodeFunctionData(functionFragment, values?): string

Parameters

Name	Type
`functionFragment`	`"token"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:89

▸ encodeFunctionData(functionFragment, values?): string

Parameters

Name	Type
`functionFragment`	`"totalAssets"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:90

▸ encodeFunctionData(functionFragment, values?): string

Parameters

Name	Type
`functionFragment`	`"totalSupply"`
`values?`	`undefined`

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:94

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"totalVaultBalance"`
`values`	[`string`, `string`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:98

▸ encodeFunctionData(functionFragment, values): string

Parameters

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

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:102

▸ encodeFunctionData(functionFragment, values): string

Parameters

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

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:106

▸ encodeFunctionData(functionFragment, values): string

Parameters

Name	Type
`functionFragment`	`"withdraw"`
`values`	[`BigNumberish`]

Returns

string

Overrides

ethers.utils.Interface.encodeFunctionData

Defined in

typechain/YToken.d.ts:110

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/YToken.d.ts:165

▸ getEvent(nameOrSignatureOrTopic): EventFragment

Parameters

Name	Type
`nameOrSignatureOrTopic`	`"Transfer"`

Returns

EventFragment

Overrides

ethers.utils.Interface.getEvent

Defined in

typechain/YToken.d.ts:166

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