reward.setRecipient

Sets or changes the reward recipient for a token holder.

Usage

example.ts

import {  } from 'wagmi/tempo'
import {  } from './config'

const { , ,  } = await ..(, {
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  : '0x20c0000000000000000000000000000000000000',
})

.('Holder:', )
.('Recipient:', )
Holder: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
Recipient: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb

config.ts

import { createConfig, http } from 'wagmi'
import { tempoTestnet } from 'wagmi/chains'
import { KeyManager, webAuthn } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [
    webAuthn({
      keyManager: KeyManager.localStorage(),
    }),
  ],
  chains: [tempoTestnet],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempoTestnet.id]: http(),
  },
})

Opt Out of Rewards

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

import {  } from 'wagmi/tempo'
import {  } from './config'

await ..(, {
  : '0x0000000000000000000000000000000000000000',
  : '0x20c0000000000000000000000000000000000000',
})

Delegate Rewards

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

import {  } from 'wagmi/tempo'
import {  } from './config'

await ..(, {
  : '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
  : '0x20c0000000000000000000000000000000000000',
})

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 as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.reward.setRecipient(config, {
  recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { holder, recipient } }
  = viem_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
}

TIP

Rewards are automatically distributed to the current recipient before changing. This happens during any balance-changing operation (transfers, mints, burns).

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. Defaults to connected Wagmi account.

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.

Viem

• reward.setRecipient