Stake Class

Manage staking operations including stake, unstake, claim, and accrue.

Protocol Fees

Staking and unstaking operations incur a variable protocol fee (set by Levr team) that is deducted from the amount.

Constructor

import { Stake, getProject } from 'levr-sdk'

// First get project data
const projectData = await getProject({
  publicClient,
  clankerToken: '0x...',
})

// Then create stake instance
const stake = new Stake({
  wallet: walletClient,
  publicClient,
  project: projectData,
})

Methods

approve(amount)

Approve tokens for staking.

import { parseUnits } from 'viem'

const receipt = await stake.approve(parseUnits('1000', 18))
console.log('Approved:', receipt.transactionHash)

Parameters:

• amount (required): Amount to approve (bigint, string, or number)

Returns: TransactionReceipt

stake(amount)

Stake tokens. Protocol fee is deducted from the amount.

const receipt = await stake.stake(parseUnits('100', 18))
console.log('Staked:', receipt.transactionHash)

Parameters:

• amount (required): Amount to stake (bigint, string, or number)

Returns: TransactionReceipt

unstake(params)

Unstake tokens. Protocol fee is deducted from the amount. Returns the user's new voting power after the unstake for UI simulation.

const { receipt, newVotingPower } = await stake.unstake({
  amount: parseUnits('50', 18),
  to: '0x...', // Optional recipient
})
console.log('Unstaked:', receipt.transactionHash)
console.log('New voting power:', newVotingPower.toString())

Parameters:

• amount (required): Amount to unstake
• to (optional): Recipient address (defaults to sender)

Returns:

• receipt: Transaction receipt
• newVotingPower: User's voting power after the unstake (useful for showing impact in UI)

Note: Partial unstakes reduce your voting power proportionally. If you unstake 30% of your tokens, your time accumulation is reduced by 30%.

claimRewards(params?)

Claim pending rewards.

// Claim all rewards (token + WETH)
const receipt = await stake.claimRewards()

// Or claim specific tokens
const receipt = await stake.claimRewards({
  tokens: ['0x...'], // Array of token addresses
  to: '0x...', // Optional recipient (defaults to sender)
})

console.log('Claimed rewards:', receipt.transactionHash)

Parameters:

• params (optional): Claim configuration
  • tokens (optional): Array of token addresses to claim (defaults to [token, WETH])
  • to (optional): Recipient address (defaults to sender)

Returns: TransactionReceipt

accrueRewards(tokenAddress)

Manually accrue rewards for a specific token. Required before rewards can be claimed.

const receipt = await stake.accrueRewards('0x...')
console.log('Accrued rewards:', receipt.transactionHash)

accrueAllRewards(tokenAddresses)

Manually accrue rewards for multiple tokens in a single transaction using forwarder multicall.

import { WETH } from 'levr-sdk'

const chainId = publicClient.chain?.id
const wethAddress = WETH(chainId)?.address

const tokenAddresses = [projectData.token.address]
if (wethAddress) {
  tokenAddresses.push(wethAddress)
}

const receipt = await stake.accrueAllRewards(tokenAddresses)
console.log('Accrued all rewards:', receipt.transactionHash)

Parameters:

• tokenAddresses (required): Array of token addresses to accrue rewards for

Returns: TransactionReceipt

Note: Requires trustedForwarder in project data for multicall support.

votingPowerOnUnstake(amount, userAddress?)

Simulate voting power after an unstake (without executing).

const result = await stake.votingPowerOnUnstake(
  parseUnits('100', 18),
  '0x...' // Optional: defaults to wallet address
)

console.log('New voting power:', result.formatted)
console.log('Token-days:', result.tokenDays.toString())

Parameters:

• amount (required): Amount to unstake (bigint, string, or number)
• userAddress (optional): User address (defaults to wallet address)

Returns:

{
  tokenDays: bigint
  formatted: string
}

Manual Accrual System

Levr uses explicit reward accrual for security and predictability. You must call accrueRewards() or accrueAllRewards() before claiming to collect fees from the LP locker and update claimable rewards.