Last update: October 8, 2021

yearn-vaults / Modules / YToken / YToken

Class: YToken

YToken.YToken

Hierarchy

BaseContract

↳ YToken

Table of contents

Constructors

constructor

Properties

Methods

Constructors

constructor

• new YToken(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
`allVaults()`	(`overrides?`: `CallOverrides`) => `Promise`<`string`[]>
`allVaults(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`string`[]>
`allowance`	(`arg0`: `string`, `arg1`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`bestVault()`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`bestVault(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`string`>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`decreaseAllowance`	(`spender`: `string`, `subtractedValue`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`deposit`	(`amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`increaseAllowance`	(`spender`: `string`, `addedValue`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`migrate()`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`migrate(address[],bytes[])`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`migrate(address[],bytes[],address,uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `user`: `string`, `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`migrate(address[],bytes[],uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`migrate(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`migrate(uint256,uint256)`	(`amount`: `BigNumberish`, `maxMigrationLoss`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`permitAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`>
`registry`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`revokeAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`>
`setRegistry`	(`_registry`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`totalAssets()`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalAssets(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalVaultBalance(address)`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalVaultBalance(address,address)`	(`token`: `string`, `account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`transfer`	(`receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`transferFrom`	(`sender`: `string`, `receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`withdraw`	(`amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>

Overrides

BaseContract.callStatic

Defined in

typechain/YToken.d.ts:523

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
`allVaults()`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`allVaults(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`allowance`	(`arg0`: `string`, `arg1`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`bestVault()`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`bestVault(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`decreaseAllowance`	(`spender`: `string`, `subtractedValue`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`deposit`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`increaseAllowance`	(`spender`: `string`, `addedValue`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`migrate()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`migrate(address[],bytes[])`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`migrate(address[],bytes[],address,uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `user`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`migrate(address[],bytes[],uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`migrate(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`migrate(uint256,uint256)`	(`amount`: `BigNumberish`, `maxMigrationLoss`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`permitAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`registry`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`revokeAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`setRegistry`	(`_registry`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalAssets()`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalAssets(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalVaultBalance(address)`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`totalVaultBalance(address,address)`	(`token`: `string`, `account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`transfer`	(`receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`transferFrom`	(`sender`: `string`, `receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>
`withdraw`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`BigNumber`>

Overrides

BaseContract.estimateGas

Defined in

typechain/YToken.d.ts:704

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

functions

• functions: Object

Type declaration

Name	Type
`allVaults()`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`[]]>
`allVaults(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`string`[]]>
`allowance`	(`arg0`: `string`, `arg1`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `balance`: `BigNumber` }>
`bestVault()`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`bestVault(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`decreaseAllowance`	(`spender`: `string`, `subtractedValue`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`deposit`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`increaseAllowance`	(`spender`: `string`, `addedValue`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`migrate()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`migrate(address[],bytes[])`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`migrate(address[],bytes[],address,uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `user`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`migrate(address[],bytes[],uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`migrate(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`migrate(uint256,uint256)`	(`amount`: `BigNumberish`, `maxMigrationLoss`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`permitAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`registry`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`revokeAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`setRegistry`	(`_registry`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`totalAssets()`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`totalAssets(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `assets`: `BigNumber` }>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `total`: `BigNumber` }>
`totalVaultBalance(address)`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`totalVaultBalance(address,address)`	(`token`: `string`, `account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `balance`: `BigNumber` }>
`transfer`	(`receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`transferFrom`	(`sender`: `string`, `receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>
`withdraw`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`ContractTransaction`>

Overrides

BaseContract.functions

Defined in

typechain/YToken.d.ts:224

interface

• interface: YTokenInterface

Overrides

BaseContract.interface

Defined in

typechain/YToken.d.ts:222

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
`allVaults()`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`allVaults(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`allowance`	(`arg0`: `string`, `arg1`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`approve`	(`spender`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`balanceOf`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`bestVault()`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`bestVault(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`decimals`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`decreaseAllowance`	(`spender`: `string`, `subtractedValue`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`deposit`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`increaseAllowance`	(`spender`: `string`, `addedValue`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`migrate()`	(`overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`migrate(address[],bytes[])`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`migrate(address[],bytes[],address,uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `user`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`migrate(address[],bytes[],uint256)`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`migrate(uint256)`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`migrate(uint256,uint256)`	(`amount`: `BigNumberish`, `maxMigrationLoss`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`name`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`permitAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`registry`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`revokeAll`	(`vaults`: `string`[], `signatures`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`setRegistry`	(`_registry`: `string`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`symbol`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`token`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`totalAssets()`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`totalAssets(address)`	(`token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`totalSupply`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`totalVaultBalance(address)`	(`account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`totalVaultBalance(address,address)`	(`token`: `string`, `account`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`transfer`	(`receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`transferFrom`	(`sender`: `string`, `receiver`: `string`, `amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>
`withdraw`	(`amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` \| `Promise`<`string`> }) => `Promise`<`PopulatedTransaction`>

Overrides

BaseContract.populateTransaction

Defined in

typechain/YToken.d.ts:852

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

allVaults()

▸ allVaults()(overrides?): Promise<string[]>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string[]>

Defined in

typechain/YToken.d.ts:377

allVaults(address)

▸ allVaults(address)(token, overrides?): Promise<string[]>

Parameters

Name	Type
`token`	`string`
`overrides?`	`CallOverrides`

Returns

Promise<string[]>

Defined in

typechain/YToken.d.ts:379

allowance

▸ allowance(arg0, arg1, overrides?): Promise<BigNumber>

Parameters

Name	Type
`arg0`	`string`
`arg1`	`string`
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:384

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

attach

▸ attach(addressOrName): YToken

Parameters

Name	Type
`addressOrName`	`string`

Returns

YToken

Overrides

BaseContract.attach

Defined in

typechain/YToken.d.ts:183

balanceOf

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

Parameters

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

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:396

bestVault()

▸ bestVault()(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/YToken.d.ts:403

bestVault(address)

▸ bestVault(address)(token, overrides?): Promise<string>

Parameters

Name	Type
`token`	`string`
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/YToken.d.ts:398

connect

▸ connect(signerOrProvider): YToken

Parameters

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

Returns

YToken

Overrides

BaseContract.connect

Defined in

typechain/YToken.d.ts:182

decimals

▸ decimals(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:405

decreaseAllowance

▸ decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:407

deployed

▸ deployed(): Promise<YToken>

Returns

Promise<YToken>

Overrides

BaseContract.deployed

Defined in

typechain/YToken.d.ts:184

deposit

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:413

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

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

increaseAllowance

▸ increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:418

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

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
`eventName?`	`string`

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

typechain/YToken.d.ts:209

migrate()

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:448

migrate(address[],bytes[])

▸ migrate(address[],bytes[])(vaults, signatures, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`vaults`	`string`[]
`signatures`	`BytesLike`[]
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:424

migrate(address[],bytes[],address,uint256)

▸ migrate(address[],bytes[],address,uint256)(vaults, signatures, user, amount, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`vaults`	`string`[]
`signatures`	`BytesLike`[]
`user`	`string`
`amount`	`BigNumberish`
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:452

migrate(address[],bytes[],uint256)

▸ migrate(address[],bytes[],uint256)(vaults, signatures, amount, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`vaults`	`string`[]
`signatures`	`BytesLike`[]
`amount`	`BigNumberish`
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:436

migrate(uint256)

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:443

migrate(uint256,uint256)

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:430

name

▸ name(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/YToken.d.ts:460

off

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

Type parameters

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

Parameters

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

Returns

YToken

Overrides

BaseContract.off

Defined in

typechain/YToken.d.ts:189

▸ off(eventName, listener): YToken

Parameters

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

Returns

YToken

Overrides

BaseContract.off

Defined in

typechain/YToken.d.ts:210

on

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

Type parameters

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

Parameters

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

Returns

YToken

Overrides

BaseContract.on

Defined in

typechain/YToken.d.ts:193

▸ on(eventName, listener): YToken

Parameters

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

Returns

YToken

Overrides

BaseContract.on

Defined in

typechain/YToken.d.ts:211

once

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

Type parameters

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

Parameters

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

Returns

YToken

Overrides

BaseContract.once

Defined in

typechain/YToken.d.ts:197

▸ once(eventName, listener): YToken

Parameters

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

Returns

YToken

Overrides

BaseContract.once

Defined in

typechain/YToken.d.ts:212

permitAll

▸ permitAll(vaults, signatures, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`vaults`	`string`[]
`signatures`	`BytesLike`[]
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:462

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

registry

▸ registry(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/YToken.d.ts:468

removeAllListeners

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

Type parameters

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

Parameters

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

Returns

YToken

Overrides

BaseContract.removeAllListeners

Defined in

typechain/YToken.d.ts:205

▸ removeAllListeners(eventName?): YToken

Parameters

Name	Type
`eventName?`	`string`

Returns

YToken

Overrides

BaseContract.removeAllListeners

Defined in

typechain/YToken.d.ts:214

removeListener

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

Type parameters

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

Parameters

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

Returns

YToken

Overrides

BaseContract.removeListener

Defined in

typechain/YToken.d.ts:201

▸ removeListener(eventName, listener): YToken

Parameters

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

Returns

YToken

Overrides

BaseContract.removeListener

Defined in

typechain/YToken.d.ts:213

revokeAll

▸ revokeAll(vaults, signatures, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
`vaults`	`string`[]
`signatures`	`BytesLike`[]
`overrides?`	`Overrides` & { `from?`: `string` \| `Promise`<`string`> }

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:470

setRegistry

▸ setRegistry(_registry, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:476

symbol

▸ symbol(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/YToken.d.ts:481

token

▸ token(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Defined in

typechain/YToken.d.ts:483

totalAssets()

▸ totalAssets()(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:485

totalAssets(address)

▸ totalAssets(address)(token, overrides?): Promise<BigNumber>

Parameters

Name	Type
`token`	`string`
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:487

totalSupply

▸ totalSupply(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:492

totalVaultBalance(address)

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

Parameters

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

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:500

totalVaultBalance(address,address)

▸ totalVaultBalance(address,address)(token, account, overrides?): Promise<BigNumber>

Parameters

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

Returns

Promise<BigNumber>

Defined in

typechain/YToken.d.ts:494

transfer

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:505

transferFrom

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:511

withdraw

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/YToken.d.ts:518

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