TypeScript SDK

TOKENS.claimRewards

Prepares a transaction to call the "claimRewards" function on the contract.

Example


import { sendTransaction } from "thirdweb";
import { claimRewards } from "thirdweb/extensions/tokens";
 
const transaction = claimRewards({
 contract,
 asset: ...,
 overrides: {
   ...
 }
});
 
// Send the transaction
await sendTransaction({ transaction, account });


function claimRewards(
  options: BaseTransactionOptions<
    | ClaimRewardsParams
    | { asyncParams: () => Promise<ClaimRewardsParams> }
  >,
): PreparedTransaction<any, AbiFunction, PrepareTransactionOptions>;

Parameters

The options for the "claimRewards" function.

Type


let options: BaseTransactionOptions<
  | ClaimRewardsParams
  | { asyncParams: () => Promise<ClaimRewardsParams> }
>;

Returns


let returnType: PreparedTransaction<
  any,
  AbiFunction,
  PrepareTransactionOptions
>;

A prepared transaction object.