https://github.com/fuseio/earn-sdk
https://github.com/fuseio/earn-sdk
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fuseio/earn-sdk
- Owner: fuseio
- Created: 2021-07-09T12:11:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T12:16:50.000Z (over 1 year ago)
- Last Synced: 2025-10-26T21:05:10.756Z (8 months ago)
- Language: TypeScript
- Size: 228 KB
- Stars: 1
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](#getting-started)
- [Requirements](#requirements)
- [Installation](#installation)
- [Classes](#Classes)
- [Development](#development)
- [Dependencies](#dependencies)
- [Test](#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.
```bash
npm install -S @fuseio/earn-sdk
```
or
```bash
yarn add @fuseio/earn-sdk
```
### Classes
The Earn sdk exposes [SingleRewardProgram](https://github.com/fuseio/earn-sdk/blob/master/docs/classes/SingleRewardProgram.md) and [MultiRewardProgram](https://github.com/fuseio/earn-sdk/blob/master/docs/classes/MultiRewardProgram.md) 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:
```bash
npm install
```
or
```bash
yarn
```
### Lint
To run the linter run:
```bash
npm run lint
```
or
```bash
yarn lint
```