Class GaugeInterface<T>

Type parameters

T: ChainId

Hierarchy

ServiceInterface<T>
- GaugeInterface

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GaugeInterface<T>(yearn: Yearn<T>, chainId: T, ctx: Context): GaugeInterface<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 GaugeInterface<T>

Properties

chainId

chainId: 1 | 10 | 250 | 1337 | 42161

ctx

events

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

Protected yearn

yearn: Yearn<T>

Methods

approveStake

approveStake<P>(props: P): WriteTransactionResult<P>

- Defined in src/interfaces/gauge.ts:426
Approve the token amount to allow to be used to stake

Type parameters
- P: ApproveStakeProps
Parameters
- props: P
Returns WriteTransactionResult<P>
TransactionResponse | PopulatedTransaction

balances

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

- Defined in src/interfaces/gauge.ts:340
Get all Gauge underlying token balances of an account

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

claimAllRewards

claimAllRewards<P>(props: P): WriteTransactionResult<P>

- Defined in src/interfaces/gauge.ts:543
Claim rewards from all Gauges and Voting Escrow

Type parameters
- P: ClaimAllRewardsProps
Parameters
- props: P
Returns WriteTransactionResult<P>
TransactionResponse | PopulatedTransaction

claimRewards

claimRewards<P>(props: P): WriteTransactionResult<P>

- Defined in src/interfaces/gauge.ts:518
Claim reward tokens from a Gauge

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

get

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

- Defined in src/interfaces/gauge.ts:80
Get all Gauges

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

getDynamic

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

- Defined in src/interfaces/gauge.ts:130
Get dynamic properties of Gauges

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

getStakeAllowance

getStakeAllowance(__namedParameters: { accountAddress: string; gaugeAddress: string; tokenAddress: string }): Promise<TokenAllowance>

- Defined in src/interfaces/gauge.ts:404
Fetch the token amount that has been allowed to be used to stake

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

getStatic

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

- Defined in src/interfaces/gauge.ts:99
Get static properties of Gauges

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

Private getSupportedAddresses

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

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

metadataOf

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

- Defined in src/interfaces/gauge.ts:278
Get the Gauges user metadata of an account

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

positionsOf

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

- Defined in src/interfaces/gauge.ts:209
Get all Gauge positions of an account

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

stake

stake<P>(props: P): WriteTransactionResult<P>

- Defined in src/interfaces/gauge.ts:458
Stake an amount of tokens into a Gauge

Type parameters
- P: StakeProps
Parameters
- props: P
Returns WriteTransactionResult<P>
TransactionResponse | PopulatedTransaction

tokens

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

- Defined in src/interfaces/gauge.ts:372
Get all Gauge underlying tokens

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

unstake

unstake<P>(props: P): WriteTransactionResult<P>

- Defined in src/interfaces/gauge.ts:484
Unstake an amount of tokens from a Gauge

Type parameters
- P: UnstakeProps
Parameters
- props: P
Returns WriteTransactionResult<P>
TransactionResponse | PopulatedTransaction

Generated using TypeDoc