Skip to content

Latest commit

 

History

History
132 lines (109 loc) · 3.37 KB

readme.md

File metadata and controls

132 lines (109 loc) · 3.37 KB

LNI - Lightning Node Interface

logo

LNI - Lightning Node Interface. Connect to the major lightning node implementations with a standard interface. CLN, LND, LNDK, Phoenixd, LNURL (BOLT 11 and BOLT 12). Binding support for Android, IOS, React-Native, Typescript, JavaScript, Linux, Windows and Mac

### Examples

# LND
let lnd_node = LndNode::new("test_macaroon".to_string(), "https://127.0.0.1:8080".to_string());
let lnd_result =  lnd_node.pay_invoice("invoice".to_string());
println!("Pay LND invoice result {}", lnd_result);
let lnd_txns = lnd_node.get_wallet_transactions("wallet_id".to_string());
lnd_txns.iter().for_each(|txn| {
    println!("LND Transaction amount: {}, date: {}, memo: {}", txn.amount(), txn.date(), txn.memo()); 
});
let lnd_macaroon = lnd_node.key();

# CLN
let cln_node = ClnNode::new("test_rune".to_string(), "https://127.0.0.1:8081".to_string());
let cln_result =  cln_node.pay_invoice("invoice".to_string());
println!("Pay CLN invoice result {}", cln_result);
let cln_txns = cln_node.get_wallet_transactions("wallet_id".to_string());
cln_txns.iter().for_each(|txn| {
    println!("CLN Transaction amount: {}, date: {}, memo: {}", txn.amount(), txn.date(), txn.memo()); 
});
let cln_rune = cln_node.key();


### Payments
lni.create_invoice(amount, expiration, memo, BOLT11 | BOLT12)
lni.pay_invoice()
lni.fetch_invoice_from_offer('lno***')
lni.decode_invoice(invoice)
lni.check_invoice_status(invoice)

### Node Management
lni.get_info()
lni.get_transactions(limit, skip)
lni.wallet_balance()

### Channel Management
lni.fetch_channel_info()

### Event Polling
await lni.on_invoice_events(invoice_id, (event) =>{
    console.log("Callback result:", result);
})

Event Polling

LNI does some simple event polling over http to get some basic invoice status events. Polling is used instead of a heavier grpc/pubsub/ websocket event system to make sure the lib runs cross platform and stays lightweight.

Build

cd lni
./install-deps.sh
cargo clean
cargo build
cargo test
cd ..

Example

cd examples/rust
cargo build
cargo run
cd ../../

Bindings

  • Wasm for Javascript and Typescript
cd lni
./build-wasm.sh
cd ../

cd examples/typescript
npm run start
cd ../../
  • react-native-lni (uniffi-bindgen-react-native)
# see https://github.com/lightning-node-interface/react-native-lni
# guide https://jhugman.github.io/uniffi-bindgen-react-native/guides/getting-started.html 

cd examples/react-native
yarn
yarn example start
cd ../../

Tor

Use Tor socks if connecting to a .onion hidden service by passing in socks5 proxy.

Inpiration

Project Structure

This project structure was inpired by this https://github.com/ianthetechie/uniffi-starter/ with the intention of automating the creation of react-native-lni https://jhugman.github.io/uniffi-bindgen-react-native/guides/getting-started.html

Todo

  • make interface
  • wasm
  • uniffi bindings for Android and IOS
  • react-native - uniffi-bindgen-react-native
  • implement lightning nodes
    • phoenixd
    • cln
    • lndk
    • ldknode
    • lnd
    • eclair