Class RewardsAPI

Readonlycontext

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>

depositLbaUsdc

• depositLbaUsdc(params): Promise<ContractTransactionResponse>

• Deposit USDC into the LBA pool

  Parameters

  • params: VrtxTokenAmountParams

  Returns Promise<ContractTransactionResponse>

withdrawLbaUsdc

• withdrawLbaUsdc(params): Promise<ContractTransactionResponse>

• Withdraw USDC from the LBA pool

  Parameters

  • params: VrtxTokenAmountParams

  Returns Promise<ContractTransactionResponse>

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>

claimLiquidTokens

• claimLiquidTokens(params): Promise<ContractTransactionResponse>

• Claim earned VRTX tokens

  Parameters

  • params: ClaimLiquidTokensParams

  Returns Promise<ContractTransactionResponse>

claimAndStakeLiquidTokens

• claimAndStakeLiquidTokens(params): Promise<ContractTransactionResponse>

• Claim earned VRTX tokens and stake them

  Parameters

  • params: ClaimLiquidTokensParams

  Returns Promise<ContractTransactionResponse>

claimLbaRewards

• claimLbaRewards(): Promise<ContractTransactionResponse>

• Claim VRTX rewards associated with keeping liquidity in the LBA

  Returns Promise<ContractTransactionResponse>

stake

• stake(params): Promise<ContractTransactionResponse>

• Stake VRTX tokens

  Parameters

  • params: VrtxTokenAmountParams

  Returns Promise<ContractTransactionResponse>

unstake

• unstake(params): Promise<ContractTransactionResponse>

• Unstake VRTX tokens, unstaked tokens that are unlocked will need to be withdrawn

  Parameters

  • params: VrtxTokenAmountParams

  Returns Promise<ContractTransactionResponse>

withdrawUnstakedTokens

• withdrawUnstakedTokens(): Promise<ContractTransactionResponse>

• Claim unlocked tokens that were previously unstaked

  Returns Promise<ContractTransactionResponse>

claimStakingRewards

• claimStakingRewards(): Promise<ContractTransactionResponse>

• Claim staking rewards (in USDC)

  Returns Promise<ContractTransactionResponse>

claimAndStakeStakingRewards

• claimAndStakeStakingRewards(): Promise<ContractTransactionResponse>

• Claim staking rewards (in USDC), swap for VRTX, and stake the VRTX

  Returns Promise<ContractTransactionResponse>

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>

getStakingRewardsEstimatedVrtxSwapAmount

• getStakingRewardsEstimatedVrtxSwapAmount(address): Promise<bigint>

• Estimates the output amount of the USDC -> VRTX swap when executing claim + stake

  Parameters

  • address: {
        address: string;
    }

    • address: string

  Returns Promise<bigint>