Skip to content

Latest commit

 

History

History
81 lines (61 loc) · 1.78 KB

README.md

File metadata and controls

81 lines (61 loc) · 1.78 KB
Raw

UNA - Universal Node API

Una is a Lightning network node wrapper for multiple backends and for multiple programming languages, written in Rust.

🚧 Una is still in development.

Supported actions

  • Get node info
  • Create invoice
  • Pay invoice
  • Get invoice
  • Decode invoice
  • Invoice events

Supported backends

  • LND (REST)
  • Core Lightning
  • Eclair (REST) (>= v0.6.2)
  • LndHub
  • LndHub.go V2
  • LNBits

Supported programming languages

  • Rust
  • Node.js
  • Python

Want another action, backend or programming language? Open an issue

⚠️ The following documentation is concerning the Rust version which is the code base for all other bindings.

Other programming languages documentations can be found in the bindings folder.

Usage (Rust)

🚧 TODO

Usage (CLI)

Build

cargo run --package una-proto-builder
cargo build --bin una-cli

Choose your backend

LND

una-cli --backend LndRest --url https://127.0.0.1:8081 --macaroon HEX_MACAROON --tls_certificate HEX_CERTIFICATE

Core Lightning

una-cli --backend ClnGrpc --url https://127.0.0.1:11002 --tls_certificate HEX_TSL_CERTIFICATE --tls_client_key HEX_CLIENT_KEY --tls_client_certificate HEX_TLS_CLIENT_CERTIFICATE

Eclair

una-cli --backend EclairRest --url http://127.0.0.1:8283 --username USERNAME  --password PASSWORD

Actions

Get node info

una-cli ... info

Create invoice

una-cli ... createinvoice 1000 description

Get invoice

una-cli ... getinvoice 4d961f2bdda9cb9c4c64739e928ca06d2921357fe437a59214809828bba0dde2