Earn SDK

Earn SDK is a client and server SDK for building applications that can interact with various earning functionality on the Fuse network.

Table of Contents

• Getting Started
  • Requirements
  • Installation
  • Classes
• Development
  • Dependencies
  • Test

Getting Started

The steps needed to get started with the Earn SDK with a few examples are provided below.

Requirements

• Node.js 12+

Installation

Earn is available as a package on NPM and it can be installed using either npm or yarn package managers.

npm install -S @fuseio/earn-sdk

or

yarn add @fuseio/earn-sdk

Classes

The Earn sdk exposes SingleRewardProgram and MultiRewardProgram classes which can be used to interact with the single and multi reward programs.

Development

The steps needed to get started started developing the SDK are provided below

Dependencies

To get set up run the command below to install SDK dependencies:

npm install

or

yarn

Lint

To run the linter run:

npm run lint

or

yarn lint