Skip to content

Elfo Node CLI - Monitor subscriptions, Trigger payments, Earn Fees

License

Notifications You must be signed in to change notification settings

elfo-protocol/elfo-node

Repository files navigation

Elfo Protocol

Protocol for Subscription Payments on Solana

Tutorials Discord Chat License

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]

Elfo node CLI

[This Repository]

Elfo Javascript SDK

[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

$ 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
...

installation

Commands

elfo config

configure elfo node

USAGE
  $ elfo config

DESCRIPTION
  configure elfo node

EXAMPLES
  $ elfo config

configuration See code: dist/commands/config.ts

elfo register

register elfo node

USAGE
  $ elfo register [-f]

FLAGS
  -f, --force  force re-register

DESCRIPTION
  register elfo node

EXAMPLES
  $ elfo register

  $ elfo register --force

registration See code: dist/commands/register.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

monitor See code: dist/commands/monitor.ts

About

Elfo Node CLI - Monitor subscriptions, Trigger payments, Earn Fees

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published