Rewards Platform ->

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

Installation

npm install @openformat/sdk ethers@^5
2

Setup

Create a community in the Platform or create an app via the sdk.

3

Instantiate SDK with your dApp

To instantiate the SDK you will need the following:

  • dApp ID can be found on your communities page in the platform
  • private key can be exported from your profile in the platform
    if you connected an existing wallet it will be found in your wallet client e.g metamask

Always store private keys securely as environment variables or in secure storage systems. Never hardcode your private key in your source code or commit them to version control (e.g., Git).

import { OpenFormatSDK, Chains } from "@openformat/sdk";

const DAPP_ID = "Insert your dApp ID here";
const PRIVATE_KEY = process.env.PRIVATE_KEY;

const sdk = new OpenFormatSDK({
  appId: DAPP_ID,
  signer: PRIVATE_KEY,
  network: Chains.arbitrumSepolia,
});

You are now all setup, ready to start rewarding XP and badges

API ReferenceReward XP