Reward tokens in your application when a user completes a specific action, such as registering, completing a task, watching a video or posting a comment.

Before proceeding ensure you’ve instantiated the SDK and created an App.
See the Quickstart to get setup.

1

Get the token address

  • Token addresses are displayed in the platform on the Tokens page.
2

Reward token

import { RewardActionType, RewardType, toWei } from "@openformat/sdk";

const params = [
  {
    // The address of the user who is receiving the token
    receiver: "0x821EFACF307Add10fd9A812624955cbEF943265c",
    // A given ID for an action a user completes in your application
    id: "signed-up",
    // The smart contract address of your token
    address: "0x72092f038f94833f37cc197874ac8c9b02689ac1",
    // The amount of tokens the receiver address will receive
    amount: toWei("10"),
    // The type of transaction to trigger e.g mint or transfer
    actionType: RewardActionType.MINT,
    // The type of reward
    rewardType: RewardType.TOKEN,
    // The URI of the token metadata
    uri: "ipfs://",
  },
];

await sdk.Reward.trigger(params);

Congratulations 🎉 You’ve just rewarded your first 10 tokens.

The leaderboard API endpoint can now be used to quickly setup a leaderboard.