Quickstart

1

Installation

npm install @openformat/sdk ethers@^5

yarn add @openformat/sdk ethers@^5

pnpm add @openformat/sdk ethers@^5

bun add @openformat/sdk ethers@^5

2

Setup

Create a community (called an app in the SDK) in the Platform or create an app via the sdk.

3

Instantiate SDK

To instantiate the SDK you will need the following:

appID can be found on your communities page in the platform
signer is the private key from the account that created the community (app)

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 APP_ID = "Insert your app ID here";
const SIGNER = process.env.PRIVATE_KEY;

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

Overview

API

SDKs

Rewards Platform ->