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 / AffiliateToken / AffiliateToken

Class: AffiliateToken

AffiliateToken.AffiliateToken

Hierarchy

  • BaseContract

↳ AffiliateToken

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new AffiliateToken(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
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<string>
DOMAIN_TYPEHASH (overrides?: CallOverrides) => Promise<string>
PERMIT_TYPEHASH (overrides?: CallOverrides) => Promise<string>
acceptAffiliate (overrides?: CallOverrides) => Promise<void>
affiliate (overrides?: CallOverrides) => Promise<string>
allVaults() (overrides?: CallOverrides) => Promise<string[]>
allVaults(address) (token: string, overrides?: CallOverrides) => Promise<string[]>
allowance (owner: string, spender: 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<number>
decreaseAllowance (spender: string, subtractedValue: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
deposit() (overrides?: CallOverrides) => Promise<BigNumber>
deposit(uint256) (amount: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
increaseAllowance (spender: string, addedValue: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
migrate() (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>
nonces (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
pendingAffiliate (overrides?: CallOverrides) => Promise<string>
permit (owner: string, spender: string, amount: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: CallOverrides) => Promise<void>
pricePerShare (overrides?: CallOverrides) => Promise<BigNumber>
registry (overrides?: CallOverrides) => Promise<string>
setAffiliate (_affiliate: string, 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 (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) (shares: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>

Overrides

BaseContract.callStatic

Defined in

typechain/AffiliateToken.d.ts:607


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
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<BigNumber>
DOMAIN_TYPEHASH (overrides?: CallOverrides) => Promise<BigNumber>
PERMIT_TYPEHASH (overrides?: CallOverrides) => Promise<BigNumber>
acceptAffiliate (overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
affiliate (overrides?: CallOverrides) => Promise<BigNumber>
allVaults() (overrides?: CallOverrides) => Promise<BigNumber>
allVaults(address) (token: string, overrides?: CallOverrides) => Promise<BigNumber>
allowance (owner: string, spender: 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() (overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
deposit(uint256) (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(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>
nonces (arg0: string, overrides?: CallOverrides) => Promise<BigNumber>
pendingAffiliate (overrides?: CallOverrides) => Promise<BigNumber>
permit (owner: string, spender: string, amount: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
pricePerShare (overrides?: CallOverrides) => Promise<BigNumber>
registry (overrides?: CallOverrides) => Promise<BigNumber>
setAffiliate (_affiliate: string, 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 (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) (shares: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

Defined in

typechain/AffiliateToken.d.ts:788


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/AffiliateToken.d.ts:750


functions

• functions: Object

Type declaration

Name Type
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<[string]>
DOMAIN_TYPEHASH (overrides?: CallOverrides) => Promise<[string]>
PERMIT_TYPEHASH (overrides?: CallOverrides) => Promise<[string]>
acceptAffiliate (overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
affiliate (overrides?: CallOverrides) => Promise<[string]>
allVaults() (overrides?: CallOverrides) => Promise<[string[]]>
allVaults(address) (token: string, overrides?: CallOverrides) => Promise<[string[]]>
allowance (owner: string, spender: 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]>
bestVault() (overrides?: CallOverrides) => Promise<[string]>
bestVault(address) (token: string, overrides?: CallOverrides) => Promise<[string]>
decimals (overrides?: CallOverrides) => Promise<[number]>
decreaseAllowance (spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
deposit() (overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
deposit(uint256) (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(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]>
nonces (arg0: string, overrides?: CallOverrides) => Promise<[BigNumber]>
pendingAffiliate (overrides?: CallOverrides) => Promise<[string]>
permit (owner: string, spender: string, amount: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
pricePerShare (overrides?: CallOverrides) => Promise<[BigNumber]>
registry (overrides?: CallOverrides) => Promise<[string]>
setAffiliate (_affiliate: string, 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]>
totalVaultBalance(address) (account: string, overrides?: CallOverrides) => Promise<[BigNumber]>
totalVaultBalance(address,address) (token: string, account: string, overrides?: CallOverrides) => Promise<[BigNumber] & { balance: 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) (shares: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>

Overrides

BaseContract.functions

Defined in

typechain/AffiliateToken.d.ts:295


interface

• interface: AffiliateTokenInterface

Overrides

BaseContract.interface

Defined in

typechain/AffiliateToken.d.ts:293


populateTransaction

• populateTransaction: Object

Type declaration

Name Type
DOMAIN_SEPARATOR (overrides?: CallOverrides) => Promise<PopulatedTransaction>
DOMAIN_TYPEHASH (overrides?: CallOverrides) => Promise<PopulatedTransaction>
PERMIT_TYPEHASH (overrides?: CallOverrides) => Promise<PopulatedTransaction>
acceptAffiliate (overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
affiliate (overrides?: CallOverrides) => Promise<PopulatedTransaction>
allVaults() (overrides?: CallOverrides) => Promise<PopulatedTransaction>
allVaults(address) (token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
allowance (owner: string, spender: 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() (overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
deposit(uint256) (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(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>
nonces (arg0: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
pendingAffiliate (overrides?: CallOverrides) => Promise<PopulatedTransaction>
permit (owner: string, spender: string, amount: BigNumberish, deadline: BigNumberish, v: BigNumberish, r: BytesLike, s: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
pricePerShare (overrides?: CallOverrides) => Promise<PopulatedTransaction>
registry (overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAffiliate (_affiliate: string, 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 (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) (shares: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

Defined in

typechain/AffiliateToken.d.ts:945


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

DOMAIN_SEPARATOR

▸ DOMAIN_SEPARATOR(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:452


DOMAIN_TYPEHASH

▸ DOMAIN_TYPEHASH(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:454


PERMIT_TYPEHASH

▸ PERMIT_TYPEHASH(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:456


_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


acceptAffiliate

▸ acceptAffiliate(overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:458


affiliate

▸ affiliate(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:462


allVaults()

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

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string[]>

Defined in

typechain/AffiliateToken.d.ts:464


allVaults(address)

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

Parameters

Name Type
token string
overrides? CallOverrides

Returns

Promise<string[]>

Defined in

typechain/AffiliateToken.d.ts:466


allowance

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

Parameters

Name Type
owner string
spender string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:471


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/AffiliateToken.d.ts:477


attach

▸ attach(addressOrName): AffiliateToken

Parameters

Name Type
addressOrName string

Returns

AffiliateToken

Overrides

BaseContract.attach

Defined in

typechain/AffiliateToken.d.ts:254


balanceOf

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

Parameters

Name Type
account string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:483


bestVault()

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

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:490


bestVault(address)

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

Parameters

Name Type
token string
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:485


connect

▸ connect(signerOrProvider): AffiliateToken

Parameters

Name Type
signerOrProvider string | Provider | Signer

Returns

AffiliateToken

Overrides

BaseContract.connect

Defined in

typechain/AffiliateToken.d.ts:253


decimals

▸ decimals(overrides?): Promise<number>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<number>

Defined in

typechain/AffiliateToken.d.ts:492


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/AffiliateToken.d.ts:494


deployed

▸ deployed(): Promise<AffiliateToken>

Returns

Promise<AffiliateToken>

Overrides

BaseContract.deployed

Defined in

typechain/AffiliateToken.d.ts:255


deposit()

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:505


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/AffiliateToken.d.ts:500


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/AffiliateToken.d.ts:509


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/AffiliateToken.d.ts:257

▸ listeners(eventName?): Listener[]

Parameters

Name Type
eventName? string

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

typechain/AffiliateToken.d.ts:280


migrate()

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:526


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/AffiliateToken.d.ts:521


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/AffiliateToken.d.ts:515


name

▸ name(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:530


nonces

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

Parameters

Name Type
arg0 string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:532


off

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

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

AffiliateToken

Overrides

BaseContract.off

Defined in

typechain/AffiliateToken.d.ts:260

▸ off(eventName, listener): AffiliateToken

Parameters

Name Type
eventName string
listener Listener

Returns

AffiliateToken

Overrides

BaseContract.off

Defined in

typechain/AffiliateToken.d.ts:281


on

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

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

AffiliateToken

Overrides

BaseContract.on

Defined in

typechain/AffiliateToken.d.ts:264

▸ on(eventName, listener): AffiliateToken

Parameters

Name Type
eventName string
listener Listener

Returns

AffiliateToken

Overrides

BaseContract.on

Defined in

typechain/AffiliateToken.d.ts:282


once

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

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

AffiliateToken

Overrides

BaseContract.once

Defined in

typechain/AffiliateToken.d.ts:268

▸ once(eventName, listener): AffiliateToken

Parameters

Name Type
eventName string
listener Listener

Returns

AffiliateToken

Overrides

BaseContract.once

Defined in

typechain/AffiliateToken.d.ts:283


pendingAffiliate

▸ pendingAffiliate(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:534


permit

▸ permit(owner, spender, amount, deadline, v, r, s, overrides?): Promise<ContractTransaction>

Parameters

Name Type
owner string
spender string
amount BigNumberish
deadline BigNumberish
v BigNumberish
r BytesLike
s BytesLike
overrides? Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:536


pricePerShare

▸ pricePerShare(overrides?): Promise<BigNumber>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:547


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/AffiliateToken.d.ts:287


registry

▸ registry(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:549


removeAllListeners

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

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

Name Type
eventFilter TypedEventFilter<EventArgsArray, EventArgsObject>

Returns

AffiliateToken

Overrides

BaseContract.removeAllListeners

Defined in

typechain/AffiliateToken.d.ts:276

▸ removeAllListeners(eventName?): AffiliateToken

Parameters

Name Type
eventName? string

Returns

AffiliateToken

Overrides

BaseContract.removeAllListeners

Defined in

typechain/AffiliateToken.d.ts:285


removeListener

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

Type parameters

Name Type
EventArgsArray extends any[]
EventArgsObject EventArgsObject

Parameters

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

Returns

AffiliateToken

Overrides

BaseContract.removeListener

Defined in

typechain/AffiliateToken.d.ts:272

▸ removeListener(eventName, listener): AffiliateToken

Parameters

Name Type
eventName string
listener Listener

Returns

AffiliateToken

Overrides

BaseContract.removeListener

Defined in

typechain/AffiliateToken.d.ts:284


setAffiliate

▸ setAffiliate(_affiliate, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:551


setRegistry

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:556


symbol

▸ symbol(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:561


token

▸ token(overrides?): Promise<string>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<string>

Defined in

typechain/AffiliateToken.d.ts:563


totalAssets()

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

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:565


totalAssets(address)

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

Parameters

Name Type
token string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:567


totalSupply

▸ totalSupply(overrides?): Promise<BigNumber>

Parameters

Name Type
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:572


totalVaultBalance(address)

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

Parameters

Name Type
account string
overrides? CallOverrides

Returns

Promise<BigNumber>

Defined in

typechain/AffiliateToken.d.ts:580


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/AffiliateToken.d.ts:574


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/AffiliateToken.d.ts:585


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/AffiliateToken.d.ts:591


withdraw()

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:603


withdraw(uint256)

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

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

typechain/AffiliateToken.d.ts:598


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

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