Rewards Platform ->

The easiest way to get started is to use the rewards platform.

​
Overview

Open format is an on-chain reward system. At it’s core is a set of smart contracts that we call a dApp (decentralised app).

We are currently in the process of updating our documentation. If you need any assistance, please reach out to us on Discord for support.

​
Rewards

Reward tokens and badges based on members contributions. Assets can be created before hand in the platform or dynamically using the SDK.

To reward those assets set up triggers in your server-side code.

​
Rewarding token example

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);

​
Leaderboards

Create simple leaderboards using the API leaderboard endpoint or with no-code BuildShip leaderboard template.

​
Webhooks

Use webhooks to notify users in real-time for channels like Discord and Slack.


Get Started ->

Create your dApp and get an API key.