`reward.setRecipient`

Sets or changes the reward recipient for a token holder.

Usage

Use the reward.setRecipient action on the Viem client to opt in to rewards or change your reward recipient.

example.ts

import { client, token } from './viem.config'
 
const { holder, receipt, recipient } = await client.reward.setRecipientSync({
  recipient: client.account.address, // receive rewards directly
  token,
})
 
console.log('Holder:', holder)
Holder: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
console.log('Recipient:', recipient)Recipient: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266

Opt Out of Rewards

Set recipient to the zero address to opt out from rewards distribution:

import { client, token } from './viem.config'
 
await client.reward.setRecipientSync({
  recipient: '0x0000000000000000000000000000000000000000',
  token,
})

Delegate Rewards

Set recipient to another address to delegate your rewards to them:

import { client, token } from './viem.config'
 
await client.reward.setRecipientSync({
  recipient: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
  token,
})

Asynchronous Usage

The example above uses a *Sync variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync reward.setRecipient action and wait for inclusion manually:

import { Actions } from 'tempo.ts/viem'
import { client, token } from './viem.config'
 
const hash = await client.reward.setRecipient({
  recipient: client.account.address,
  token,
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args: { holder, recipient } } 
  = Actions.reward.setRecipient.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** Token holder address who set their reward recipient */
  holder: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Reward recipient address (zero address indicates opt-out) */
  recipient: Address
}

Parameters

recipient

Type: Address

The reward recipient address. Use zero address to opt out of rewards.

token

Type: Address

The TIP20 token address.

account (optional)

Type: Account | Address

Account that will be used to send the transaction.

feeToken (optional)

Type: Address | bigint

Fee token for the transaction.

Can be a TIP-20 token address or ID.

feePayer (optional)

Type: Account | true

Fee payer for the transaction.

Can be a Viem Account, or true if a Fee Payer Service will be used.

gas (optional)

Type: bigint

Gas limit for the transaction.

maxFeePerGas (optional)

Type: bigint

Max fee per gas for the transaction.

maxPriorityFeePerGas (optional)

Type: bigint

Max priority fee per gas for the transaction.

nonce (optional)

Type: number

Nonce for the transaction.

nonceKey (optional)

Type: 'random' | bigint

Nonce key for the transaction. Use 'random' to generate a random nonce key.

validBefore (optional)

Type: number

Unix timestamp before which the transaction must be included.

validAfter (optional)

Type: number

Unix timestamp after which the transaction can be included.

throwOnReceiptRevert (optional)

Type: boolean
Default: true

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to *Sync actions.