# @elfo/sdk

> Javascript library to interact with elfo protocol.

Latest version **0.0.6** (published 2022-03-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @elfo/sdk
pnpm add @elfo/sdk
yarn add @elfo/sdk
bun add @elfo/sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2022-03-15 |
| First published | 2022-03-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Irshad Nilam |
| Maintainers | irsd61 |

## Links

- npm: https://www.npmjs.com/package/@elfo/sdk
- Repository: https://github.com/elfo-protocol/elfo-sdk
- Homepage: https://github.com/elfo-protocol/elfo-sdk#readme
- Issues: https://github.com/elfo-protocol/elfo-sdk/issues
- npm.io page: https://npm.io/package/@elfo/sdk

## Dependencies (2)

- [@solana/spl-token](https://npm.io/package/@solana/spl-token.md) ^0.2.0
- [@project-serum/anchor](https://npm.io/package/@project-serum/anchor.md) ^0.22.1

## Recent versions

- 0.0.6 (latest) — 2022-03-15
- 0.0.5 — 2022-03-13
- 0.0.4 — 2022-03-08
- 0.0.3 — 2022-03-07
- 0.0.2 — 2022-03-07
- 0.0.1 — 2022-03-07

## README

<div align="center">
  <img height="170x" src="https://i.imgur.com/DfZCJAd.png?width=746&height=746" />

  <h1>Elfo Protocol</h1>

  <p>
    <strong>Protocol for Subscription Payments on Solana</strong>
  </p>

  <p>
    <a href="https://github.com/elfo-protocol/elfo-sdk"><img alt="Tutorials" src="https://img.shields.io/badge/sdk-javascript-informational" /></a>
    <a href="https://discord.gg/QT3WgFrC"><img alt="Discord Chat" src="https://img.shields.io/discord/951843923649769522?color=yellowgreen" /></a>
    <a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/github/license/elfo-protocol/elfo-core?color=blueviolet" /></a>
  </p>
</div>

Elfo Protocol enables subscription payment on Solana blockchain.

The protocol consists of three main componenets.

### Core program (smart contract)
[[github.com/elfo-protocol/elfo-core](https://github.com/elfo-protocol/elfo-core)]


### Elfo node CLI
[[github.com/elfo-protocol/elfo-node](https://github.com/elfo-protocol/elfo-node)]

### Elfo Javascript SDK
[This Repository]

---

# Elfo Javascript SDK

This is the Javascript (Typescript) SDK to interact with [elfo protocol programs](https://github.com/elfo-protocol/elfo-core)

## Installation

### yarn

```
yarn add @elfo-protocol/sdk
```

### npm

```
npm -i @elfo-protocol/sdk
```

## Usage
View api documentation [here](docs/modules.md)

---
_Source: https://npm.io/package/@elfo/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._