Class RewardsAPI

Hierarchy

RewardsExecuteAPI<this> & RewardsQueryAPI<this>
- RewardsAPI

Index

Constructors

Properties

Methods

withdrawLbaLiquidity claimLiquidTokens claimAndStakeLiquidTokens claimLbaRewards migrateStakingV2 stake stakeV2 unstake unstakeV2 unstakeV2Slow withdrawUnstakedTokens withdrawUnstakedV2Tokens claimStakingRewards claimAndStakeStakingRewards claimFoundationRewards

Constructors

constructor

new RewardsAPI(context): RewardsAPI
Parameters
- context: VertexClientContext
Returns RewardsAPI
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).constructor
- Defined in packages/client/src/apis/base.ts:7

Properties

`Readonly`context

context: VertexClientContext

Methods

withdrawLbaLiquidity

withdrawLbaLiquidity(params): Promise<`0x${string}`>
Withdraw LP liquidity tokens from the LBA pool after the AMM has been created
Parameters
- params: VrtxTokenAmountParams
Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).withdrawLbaLiquidity
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:11

claimLiquidTokens

claimLiquidTokens(params): Promise<`0x${string}`>
Claim earned VRTX tokens
Parameters
- params: ClaimLiquidTokensParams
Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).claimLiquidTokens
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:20

claimAndStakeLiquidTokens

claimAndStakeLiquidTokens(params): Promise<`0x${string}`>
Claim earned VRTX tokens and stake them
Parameters
- params: ClaimLiquidTokensParams
Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).claimAndStakeLiquidTokens
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:29

claimLbaRewards

claimLbaRewards(): Promise<`0x${string}`>
Claim VRTX rewards associated with keeping liquidity in the LBA

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).claimLbaRewards
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:38

migrateStakingV2

migrateStakingV2(): Promise<`0x${string}`>
Migrate VRTX tokens from the old staking contract to the new staking contract

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).migrateStakingV2
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:45

stake

stake(params): Promise<`0x${string}`>
Stake VRTX tokens
Parameters
- params: VrtxTokenAmountParams
Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).stake
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:52

stakeV2

stakeV2(params): Promise<`0x${string}`>
Stake V2 VRTX tokens
Parameters
- params: VrtxTokenAmountParams
Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).stakeV2
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:61

unstake

unstake(params): Promise<`0x${string}`>
Unstake VRTX tokens, unstaked tokens that are unlocked will need to be withdrawn
Parameters
- params: VrtxTokenAmountParams
Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).unstake
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:70

unstakeV2

unstakeV2(): Promise<`0x${string}`>
Unstake V2 VRTX tokens, unstake tokens instantly with a penalty that is redistributed

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).unstakeV2
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:79

unstakeV2Slow

unstakeV2Slow(): Promise<`0x${string}`>
Unstake V2 VRTX tokens, unstaked tokens that are unlocked will need to be claimed after 21 day locking period

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).unstakeV2Slow
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:87

withdrawUnstakedTokens

withdrawUnstakedTokens(): Promise<`0x${string}`>
Claim unlocked tokens that were previously unstaked

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).withdrawUnstakedTokens
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:94

withdrawUnstakedV2Tokens

withdrawUnstakedV2Tokens(): Promise<`0x${string}`>
Claim unlocked V2 tokens that were previously unstaked

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).withdrawUnstakedV2Tokens
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:101

claimStakingRewards

claimStakingRewards(): Promise<`0x${string}`>
Claim staking rewards (in USDC)

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).claimStakingRewards
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:108

claimAndStakeStakingRewards

claimAndStakeStakingRewards(): Promise<`0x${string}`>
Claim staking rewards (in USDC), swap for VRTX, and stake the VRTX

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).claimAndStakeStakingRewards
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:115

claimFoundationRewards

claimFoundationRewards(): Promise<`0x${string}`>
Claims all available foundation rewards. Foundation rewards are tokens associated with the chain. For example, ARB on Arbitrum. Typically, foundations for these chains will issue rewards for us to give to users.

Returns Promise<`0x${string}`>
Inherited from Mixin(RewardsExecuteAPI, RewardsQueryAPI).claimFoundationRewards
- Defined in packages/client/src/apis/rewards/RewardsExecuteAPI.ts:123