@asoltys/clightning-client

clightning-client-js

JavaScript c-lightning client.

Forked from BHBNETWORK/lightning-client-js.

This repository is published as the clightning-client NPM module. The original library is published as lightning-client (no c).

Installing the client

You can easily install this client using npm by running:

npm install clightning-client

Using the client

Once the client is installed you can use it by loading the main class and instantiating it in this way:

const LightningClient = require('clightning-client');

// This should point to your lightning-rpc unix socket, by default in ~/.lightning/lightning-rpc
const client = LightningClient('/home/bitcoind/.lightning/lightning-rpc');

// Every call returns a Promise
client.getinfo()
    .then(info => console.log(info));

// or with await
id = (await client.getinfo()).id

// a single {key: val} "params" dictionary can be passed (recommended)
res = (await client.invoice({amount_msat: 12345, label: 'hello', description: 'world', cltv: 42}))

// or positional arguments according c-lightning's API, compulsory arguments
// should be set null
res2 = (await client.listchannels(short_channel_id=null, source=id))