reward.getUserRewardInfo
Gets reward information for a specific account.
Usage
import { client } from './viem.config'
const { rewardBalance, rewardPerToken, rewardRecipient } =
await client.reward.getUserRewardInfo({
account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
token: '0x20c0000000000000000000000000000000000001',
})
console.log('Reward recipient:', rewardRecipient)
Reward recipient: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('Reward balance:', rewardBalance)
Reward balance: 1000000000000000000n
console.log('Reward per token:', rewardPerToken)
Reward per token: 385802469135802469135nimport { Account, createClient } from 'viem/tempo'
export const client = createClient({
account: Account.fromSecp256k1('0x...'),
})Return Type
type ReturnType = {
/** Accumulated reward balance claimable by the account */
rewardBalance: bigint
/** Reward per token checkpoint for the account */
rewardPerToken: bigint
/** Current reward recipient address (zero address if opted out) */
rewardRecipient: Address
}Parameters
account
- Type:
Address
Address of the account to get reward info for.
token
- Type:
Address
Address of the TIP-20 token.
blockNumber (optional)
- Type:
bigint
Block number to read the state from.
blockOverrides (optional)
- Type:
BlockOverrides
Block overrides to apply to the state.
blockTag (optional)
- Type:
BlockTag
Block tag to read the state from.
stateOverride (optional)
- Type:
StateOverride
State override to apply.