UNA - Universal Node API

Una is a Lightning network node wrapper for LND, c-lightning, Eclair, LndHub, LNBits, more...

🚧 Una is still in development.

Supported actions

• Create invoice
• Get invoice
• Invoice events
• Pay invoice
• More to come

Supported backends

• LND (REST)
• c-lightning
• Eclair (REST) (>= v0.6.2)
• LndHub
• LNBits
• Want another implementation? Open an issue

How to use it

// ES Module
import { Una, EBackendType, ICreateInvoice, IInvoice } from 'una-wrapper'
// Common JS
const { Una, EBackendType, ICreateInvoice, IInvoice } = require('una-wrapper')

// LND Rest
const unaWrapper = new Una(EBackendType.LndRest, { url: 'https://127.0.0.1:8080', hexMacaroon: '0201036...311c811' })

// Eclair Rest
const unaWrapper = new Una(EBackendType.EclairRest, { url: 'http://127.0.0.1:8080', user: '', password: 'eclairpw' })

// C-lightning
const unaWrapper = new Una(EBackendType.ClnRest, { url: '127.0.0.1:8080', hexMacaroon: '0201036...311c811' })
const unaWrapper = new Una(EBackendType.ClnSocketTcp, { host: '127.0.0.1', port: 27743 })
const unaWrapper = new Una(EBackendType.ClnSocketUnix, { path: 'unix://root/.lightning/lightning-rpc' })

// LndHub
const unaWrapper = new Una(EBackendType.LndHub, { uri: 'lndhub://login:password@https://lndhub.io/' })
const unaWrapper = new Una(EBackendType.LndHub, { url: 'http://lndhub.io/', login: 'login', password: 'password' })

// Tor is supported for LND Rest, Eclair Rest, C-lightning Rest and LndHub
const unaWrapper = new Una(EBackendType.LndHub, { url: 'http://TorLndhub.onion/', login: 'login', password: 'password' }, 'socks5h://127.0.0.1:9050')

/*
  Create an invoice of 15k satoshis with 'Hello' as memo
  Possible options are the following (from src/interface/i-create-invoice.ts)
  {
    amount: number
    amountMsats: number
    description: string
    descriptionHash: string
    expireIn?: number
    fallbackAddress?: string
    paymentPreimage?: string
  }
*/
const invoiceCreate: ICreateInvoice = { amount: 15000, description: 'Hello' }
const newInvoice = await unaWrapper.createInvoice(invoiceCreate)
// Get invoice created previously
const invoice = await unaWrapper.getInvoice(newInvoice.paymentHash)

/* newInvoice and invoice returns the same result
{
  bolt11: 'lnbcrt150u...0nwpszr675',
  amount: 15000,
  amountMsat: 15000000,
  creationDate: 2021-10-25T20:30:05.000Z,
  expiry: 3600,
  memo: 'Hello',
  settled: false,
  settleDate: null,
  paymentHash: '518a62665a...4ff4364f6f',
  preImage: '8a1ae80c77...fbfd1b1dd7'
}
*/

// Watch invoices changes
unaWrapper.watchInvoices().on('invoice-updated', (invoice: IInvoice) => {
  console.log(invoice)
})

// Pay invoice
const invoicePayed: IInvoicePaid = await unaWrapper.payInvoice({ bolt11: 'lnbcrt150u...0nwpszr675' })
/*
{
  paymentPreimage: 'a001bf8364...9fe90b09fd'
}
*/