# @elfo/node

> Elfo Node CLI

Latest version **0.0.6** (published 2022-03-16) · Apache2.0 license · 0 weekly downloads

## Install

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

Provides the command `elfo`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2022-03-16 |
| First published | 2022-03-07 |
| Weekly downloads | 0 |
| License | Apache2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 12 |
| Unpacked size | 42.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Irshad Nilam @irshadnilam |
| Maintainers | irsd61 |
| Keywords | elfo, elfo-node, elfo-cli, solana, solana subscriptions |

## Links

- npm: https://www.npmjs.com/package/@elfo/node
- Repository: https://github.com/elfo-protocol/elfo-node
- Issues: https://github.com/elfo-protocol/elfo-node/issues
- npm.io page: https://npm.io/package/@elfo/node

## Dependencies (12)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [tslib](https://npm.io/package/tslib.md) ~2.3.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.1
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.0
- [@elfo/sdk](https://npm.io/package/@elfo/sdk.md) ^0.0.6
- [commander](https://npm.io/package/commander.md) ^9.0.0
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1.5.3
- [randomcolor](https://npm.io/package/randomcolor.md) ^0.6.2
- [@elfo/draftlog](https://npm.io/package/@elfo/draftlog.md) ^1.0.14
- [@types/randomcolor](https://npm.io/package/@types/randomcolor.md) ^0.5.6
- [@project-serum/anchor](https://npm.io/package/@project-serum/anchor.md) ^0.22.1
- [@solana/buffer-layout](https://npm.io/package/@solana/buffer-layout.md) ^4.0.0

## Recent versions

- 0.0.6 (latest) — 2022-03-16
- 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
[This Repository]

### Elfo Javascript SDK
[[github.com/elfo-protocol/elfo-sdk](https://github.com/elfo-protocol/elfo-sdk)]

---
# Elfo node CLI
A cli to register nodes to elfo-protocol. Registered nodes will be able to monitor subscriptions and trigger payments. 

For every successful payment trigger, nodes will earn fees. 

## Usage
<!-- usage -->
```sh-session
$ npm install -g @elfo/node
$ elfo COMMAND
running command...
$ elfo (--version)
@elfo/node/0.0.6 linux-x64 node-v16.14.0
$ elfo --help [COMMAND]
USAGE
  $ elfo COMMAND
...
```
<!-- usagestop -->
## Commands
<!-- commands -->
* [`elfo config`](#elfo-config)
* [`elfo monitor`](#elfo-monitor)
* [`elfo register`](#elfo-register)

## `elfo config`

configure subrina node

```
USAGE
  $ elfo config

DESCRIPTION
  configure subrina node

EXAMPLES
  $ elfo config
```

_See code: [dist/commands/config.ts](https://github.com/elfo-protocol/elfo-node/blob/v0.0.6/dist/commands/config.ts)_

## `elfo monitor`

monitor subscription plans and trigger payments

```
USAGE
  $ elfo monitor [-l <value>] [-s <value>]

FLAGS
  -l, --list=<value>    a txt file with a list of subscription plan account public keys
  -s, --single=<value>  a subscription plan account public key

DESCRIPTION
  monitor subscription plans and trigger payments

EXAMPLES
  $ elfo monitor --list ~/subscriptin-plans-to-monitor.txt

  $ elfo monitor --single BJwb4SgNxDL9se5ZzZJ58ub9Adcj2XNfRs8GgVXKybyu

  $ elfo monitor
```

_See code: [dist/commands/monitor.ts](https://github.com/elfo-protocol/elfo-node/blob/v0.0.6/dist/commands/monitor.ts)_

## `elfo register`

register subrina node

```
USAGE
  $ elfo register [-f]

FLAGS
  -f, --force  force re-register

DESCRIPTION
  register subrina node

EXAMPLES
  $ elfo register

  $ elfo register --force
```

_See code: [dist/commands/register.ts](https://github.com/elfo-protocol/elfo-node/blob/v0.0.6/dist/commands/register.ts)_
<!-- commandsstop -->

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