reward.distribute

Distributes rewards to opted-in token holders.

Usage

Use the reward.distribute action on the Viem client to distribute rewards to token holders.

import { parseEther } from 'viem'
import { client } from './viem.config'
 
const { amount, funder, receipt } =
  await client.reward.distributeSync({
    amount: parseEther('1000'),
    token: '0x20c0000000000000000000000000000000000001',
  })
 
console.log('Amount:', amount)
Amount: 1000000000000000000000n
console.log('Funder:', funder)
Funder: 0x...

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.distribute action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { parseEther } from 'viem'
import { client } from './viem.config'
 
const hash = await client.reward.distribute({
  amount: parseEther('1000'),
  token: '0x20c0000000000000000000000000000000000001',
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args: { amount, funder } } 
  = Actions.reward.distribute.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** Amount distributed */
  amount: bigint
  /** Address that funded the distribution */
  funder: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
}

Parameters

amount

• Type: bigint

The amount of tokens to distribute. Must be greater than 0.

token

• Type: Address

Address of the TIP-20 token.

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.