VotingEscrowInterface

Type parameters

T: ChainId

Hierarchy

ServiceInterface<T>
- VotingEscrowInterface

Constructors

constructor

new VotingEscrowInterface<T>(yearn: Yearn<T>, chainId: T, ctx: Context): VotingEscrowInterface<T>

Inherited from ServiceInterface<T>.constructor
- Defined in src/common.ts:27
Type parameters
- T: 1 | 10 | 250 | 1337 | 42161
Parameters
- yearn: Yearn<T>
- chainId: T
- ctx: Context
Returns VotingEscrowInterface<T>

Properties

chainId

chainId: 1 | 10 | 250 | 1337 | 42161

ctx

ctx: Context

events

events: Emittery<Record<string, unknown>, Record<string, unknown> & OmnipresentEventData, never>

Protected yearn

yearn: Yearn<T>

Methods

approveLock

approveLock(props: P): WriteTransactionResult

- Defined in src/interfaces/votingEscrow.ts:436
Approve the token amount to allow to be used to lock

Type parameters
- P: ApproveLockProps
Parameters
- props: P
Returns WriteTransactionResult
TransactionResponse | PopulatedTransaction

balances

balances(__namedParameters: { accountAddress: string; addresses?: string[] }): Promise<Balance[]>

- Defined in src/interfaces/votingEscrow.ts:286
Get all Voting Escrows underlying token balances of an account

Parameters
- __namedParameters: { accountAddress: string; addresses?: string[] }
 - accountAddress: string
 - Optional addresses?: string[]
Returns Promise<Balance[]>
Balance array

claimRewards

claimRewards(props: P): WriteTransactionResult

- Defined in src/interfaces/votingEscrow.ts:597
Claim reward tokens from from Voting Escrow

Type parameters
- P: ClaimRewardsProps
Parameters
- props: P
Returns WriteTransactionResult
TransactionResponse | PopulatedTransaction

extendLockTime

extendLockTime(props: P): WriteTransactionResult

- Defined in src/interfaces/votingEscrow.ts:522
Extend the time to lock the tokens on the Voting Escrow

Type parameters
- P: ExtendLockTimeProps
Parameters
- props: P
Returns WriteTransactionResult
TransactionResponse | PopulatedTransaction

get

get(addresses: { addresses?: string[] }): Promise<VotingEscrow[]>

- Defined in src/interfaces/votingEscrow.ts:88
Get all Voting Escrow assets

Parameters
- addresses: { addresses?: string[] }
 
 filter, if not provided, all are returned
 - Optional addresses?: string[]
Returns Promise<VotingEscrow[]>
VotingEscrow array

getDynamic

getDynamic(addresses: { addresses?: string[] }): Promise<VotingEscrowDynamic[]>

- Defined in src/interfaces/votingEscrow.ts:136
Get dynamic properties of Voting Escrows

Parameters
- addresses: { addresses?: string[] }
 
 filter, if not provided, all are returned
 - Optional addresses?: string[]
Returns Promise<VotingEscrowDynamic[]>
VotingEscrowDynamic array

getExpectedTransactionOutcome

getExpectedTransactionOutcome(__namedParameters: { accountAddress: string; amount?: string; time?: number; tokenAddress: string; votingEscrowAddress: string; votingEscrowTransactionType: VotingEscrowTransactionType }): Promise<TransactionOutcome>

- Defined in src/interfaces/votingEscrow.ts:323
Get the expected outcome of executing a transaction

Parameters
- __namedParameters: { accountAddress: string; amount?: string; time?: number; tokenAddress: string; votingEscrowAddress: string; votingEscrowTransactionType: VotingEscrowTransactionType }
 - accountAddress: string
 - Optional amount?: string
 - Optional time?: number
 - tokenAddress: string
 - votingEscrowAddress: string
 - votingEscrowTransactionType: VotingEscrowTransactionType
Returns Promise<TransactionOutcome>
ExpectedOutcome

getLockAllowance

getLockAllowance(__namedParameters: { accountAddress: string; tokenAddress: string; votingEscrowAddress: string }): Promise<TokenAllowance>

- Defined in src/interfaces/votingEscrow.ts:415
Fetch the token amount that has been allowed to be used to lock

Parameters
- __namedParameters: { accountAddress: string; tokenAddress: string; votingEscrowAddress: string }
 - accountAddress: string
 - tokenAddress: string
 - votingEscrowAddress: string
Returns Promise<TokenAllowance>
TokenAllowance

getStatic

getStatic(addresses: { addresses?: string[] }): Promise<VotingEscrowStatic[]>

- Defined in src/interfaces/votingEscrow.ts:107
Get static properties of Voting Escrows

Parameters
- addresses: { addresses?: string[] }
 
 filter, if not provided, all are returned
 - Optional addresses?: string[]
Returns Promise<VotingEscrowStatic[]>
VotingEscrowStatic array

Private getSupportedAddresses

getSupportedAddresses(__namedParameters: { addresses?: string[] }): Promise<string[]>

- Defined in src/interfaces/votingEscrow.ts:614
Parameters
- __namedParameters: { addresses?: string[] }
 - Optional addresses?: string[]
Returns Promise<string[]>

Private getVotingPower

getVotingPower(lockAmount: string, unlockTime: number): string

- Defined in src/interfaces/votingEscrow.ts:627
Parameters
- lockAmount: string
- unlockTime: number
Returns string

increaseLockAmount

increaseLockAmount(props: P): WriteTransactionResult

- Defined in src/interfaces/votingEscrow.ts:496
Increase the amount of tokens locked on the Voting Escrow

Type parameters
- P: IncreaseLockAMountProps
Parameters
- props: P
Returns WriteTransactionResult
TransactionResponse | PopulatedTransaction

lock

lock(props: P): WriteTransactionResult

- Defined in src/interfaces/votingEscrow.ts:469
Lock an amount of tokens into a Voting Escrow for the specified amount of time

Type parameters
- P: LockProps
Parameters
- props: P
Returns WriteTransactionResult
TransactionResponse | PopulatedTransaction

metadataOf

metadataOf(__namedParameters: { accountAddress: string; addresses?: string[] }): Promise<VotingEscrowUserMetadata[]>

- Defined in src/interfaces/votingEscrow.ts:245
Get the Voting Escrows user metadata of an account

Parameters
- __namedParameters: { accountAddress: string; addresses?: string[] }
 - accountAddress: string
 - Optional addresses?: string[]
Returns Promise<VotingEscrowUserMetadata[]>

positionsOf

positionsOf(__namedParameters: { accountAddress: string; addresses?: string[] }): Promise<Position[]>

- Defined in src/interfaces/votingEscrow.ts:174
Get all Voting Escrows positions of an account

Parameters
- __namedParameters: { accountAddress: string; addresses?: string[] }
 - accountAddress: string
 - Optional addresses?: string[]
Returns Promise<Position[]>
Position array

tokens

tokens(addresses: { addresses?: string[] }): Promise<Token[]>

- Defined in src/interfaces/votingEscrow.ts:383
Get all Voting Escrows underlying tokens

Parameters
- addresses: { addresses?: string[] }
 
 filter, if not provided, all are returned
 - Optional addresses?: string[]
Returns Promise<Token[]>
Token array

withdrawLocked

withdrawLocked(props: P): WriteTransactionResult

- Defined in src/interfaces/votingEscrow.ts:573
Withdraw locked tokens from Voting Escrow with a penalty

Type parameters
- P: WithdrawLockedProps
Parameters
- props: P
Returns WriteTransactionResult
TransactionResponse | PopulatedTransaction

withdrawUnlocked

withdrawUnlocked(props: P): WriteTransactionResult

- Defined in src/interfaces/votingEscrow.ts:547
Withdraw unlocked tokens from Voting Escrow

Type parameters
- P: WithdrawUnlockedProps
Parameters
- props: P
Returns WriteTransactionResult
TransactionResponse | PopulatedTransaction

Type parameters

T: ChainId

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T: 1 | 10 | 250 | 1337 | 42161

Parameters

yearn: Yearn<T>

chainId: T

ctx: Context

Returns VotingEscrowInterface<T>

Properties

chainId

ctx

events

Protected yearn

Methods

approveLock

Type parameters

P: ApproveLockProps

Parameters

props: P

Returns WriteTransactionResult<P>

balances

Parameters

__namedParameters: { accountAddress: string; addresses?: string[] }

accountAddress: string

Optional addresses?: string[]

Returns Promise<Balance[]>

claimRewards

Type parameters

P: ClaimRewardsProps

Parameters

props: P

Returns WriteTransactionResult<P>

extendLockTime

Type parameters

P: ExtendLockTimeProps

Parameters

props: P

Returns WriteTransactionResult<P>

get

Parameters

addresses: { addresses?: string[] }

Optional addresses?: string[]

Returns Promise<VotingEscrow[]>

getDynamic

Parameters

addresses: { addresses?: string[] }

Optional addresses?: string[]

Returns Promise<VotingEscrowDynamic[]>

getExpectedTransactionOutcome

Parameters

__namedParameters: { accountAddress: string; amount?: string; time?: number; tokenAddress: string; votingEscrowAddress: string; votingEscrowTransactionType: VotingEscrowTransactionType }

accountAddress: string

Optional amount?: string

Optional time?: number

tokenAddress: string

votingEscrowAddress: string

votingEscrowTransactionType: VotingEscrowTransactionType

Returns Promise<TransactionOutcome>

getLockAllowance

Parameters

__namedParameters: { accountAddress: string; tokenAddress: string; votingEscrowAddress: string }

accountAddress: string

tokenAddress: string

votingEscrowAddress: string

Returns Promise<TokenAllowance>

getStatic

Parameters

addresses: { addresses?: string[] }

Optional addresses?: string[]

Returns Promise<VotingEscrowStatic[]>

Private getSupportedAddresses

Parameters