Class RewardsExecuteAPI

Hierarchy (view full)

BaseVertexAPI
- RewardsExecuteAPI

Index

Constructors

Properties

Methods

claimTokensToLba depositLbaUsdc withdrawLbaUsdc withdrawLbaLiquidity claimLiquidTokens claimAndStakeLiquidTokens claimLbaRewards stake unstake withdrawUnstakedTokens claimStakingRewards claimAndStakeStakingRewards claimFoundationRewards

Constructors

constructor

new RewardsExecuteAPI(context): RewardsExecuteAPI
Parameters
- context: VertexClientContext
Returns RewardsExecuteAPI
Inherited from BaseVertexAPI.constructor
- Defined in apis/base.ts:12

Properties

`Readonly`context

context: VertexClientContext

Methods

claimTokensToLba

claimTokensToLba(params): Promise<ContractTransactionResponse>
Claim VRTX tokens received during the airdrop phase to be deposited into the LBA pool
Parameters
- params: VrtxTokenAmountParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:19

depositLbaUsdc

depositLbaUsdc(params): Promise<ContractTransactionResponse>
Deposit USDC into the LBA pool
Parameters
- params: VrtxTokenAmountParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:38

withdrawLbaUsdc

withdrawLbaUsdc(params): Promise<ContractTransactionResponse>
Withdraw USDC from the LBA pool
Parameters
- params: VrtxTokenAmountParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:47

withdrawLbaLiquidity

withdrawLbaLiquidity(params): Promise<ContractTransactionResponse>
Withdraw LP liquidity tokens from the LBA pool after the AMM has been created
Parameters
- params: VrtxTokenAmountParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:56

claimLiquidTokens

claimLiquidTokens(params): Promise<ContractTransactionResponse>
Claim earned VRTX tokens
Parameters
- params: ClaimLiquidTokensParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:65

claimAndStakeLiquidTokens

claimAndStakeLiquidTokens(params): Promise<ContractTransactionResponse>
Claim earned VRTX tokens and stake them
Parameters
- params: ClaimLiquidTokensParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:76

claimLbaRewards

claimLbaRewards(): Promise<ContractTransactionResponse>
Claim VRTX rewards associated with keeping liquidity in the LBA

Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:85

stake

stake(params): Promise<ContractTransactionResponse>
Stake VRTX tokens
Parameters
- params: VrtxTokenAmountParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:92

unstake

unstake(params): Promise<ContractTransactionResponse>
Unstake VRTX tokens, unstaked tokens that are unlocked will need to be withdrawn
Parameters
- params: VrtxTokenAmountParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:99

withdrawUnstakedTokens

withdrawUnstakedTokens(): Promise<ContractTransactionResponse>
Claim unlocked tokens that were previously unstaked

Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:106

claimStakingRewards

claimStakingRewards(): Promise<ContractTransactionResponse>
Claim staking rewards (in USDC)

Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:113

claimAndStakeStakingRewards

claimAndStakeStakingRewards(): Promise<ContractTransactionResponse>
Claim staking rewards (in USDC), swap for VRTX, and stake the VRTX

Returns Promise<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:120

claimFoundationRewards

claimFoundationRewards(): Promise<ContractTransactionResponse>
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<ContractTransactionResponse>
- Defined in apis/rewards/RewardsExecuteAPI.ts:128