Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@litecoinfoundation/react-native-lndltc

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@litecoinfoundation/react-native-lndltc

React Native library for Lightning Litecoin

  • 0.0.7
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
13
Maintainers
1
Weekly downloads
 
Created
Source

react-native-lndltc

:warning: This is pre-alpha software. Please use at your own risk.

Description

This library simplies React Native apps adding LNDltc integration.

Getting started

npm i -s @litecoinfoundation/react-native-lndltc
#or
yarn add @litecoinfoundation/react-native-lndltc

iOS installation

cd ios && pod install && cd ../

Android installation

open android/app/build.gradle and add the below line to dependencies

implementation files("../../lightning/Lndmobile.aar")

Usage

import lnd, {
    ENetworks,
    LndConf,
	ss_lnrpc
} from '@litecoinfoundation/react-native-lndltc';

const lndConf = new LndConf(ENetworks.regtest);
const res = await lnd.start(lndConf);
if (res.isErr()) {
    //Lnd failed to start
    console.error(res.error)
}

//LND state changes
lnd.stateService.subscribeToStateChanges(
	(res: Result<ss_lnrpc.WalletState>) => {
		if (res.isOk()) {
			setLndState(res.value);
		}
	},
	() => {
        //Subscription has ended
    },
);


//Subscribe to LND logs
const logListener = lnd.addLogListener((message) => {
    console.log(message);
});

//Unsubscribe if listening component is unmounted
lnd.removeLogListener(logListener);

//All function results can be checked with res.isOk() or res.isErr()
const res = await lnd.getInfo();
if (res.isErr()) {
    console.log(res.error.message);
}

if (res.isOk()) {
    console.log(res.value);
}

//Use subscribeToOnChainTransactions/subscribeToInvoices for real time transaction updates
lnd.subscribeToOnChainTransactions(
    (res) => {
        if (res.isOk()) {
            const { amount, blockHeight, numConfirmations } = res.value;
            
            alert(`Received ${amount} sats on chain in block ${blockHeight}`)
        }
    },
    (res) => {
        //If this fails ever then we need to subscribe again
        console.error(res);
    },
);


Using neutrino headers cache

Initial neutrino sync times can take a while for first time users. This is a trusted setup that allows the app to download a cached pre-synced archive of the neutrino headers. This speeds up the time it takes for LND to become usable as syncing doesn't need to start from scratch.

#Add these dependencies to your app
yarn add react-native-fs react-native-zip-archive  
#or
npm i react-native-fs react-native-zip-archive -S 

cd ios && pod install && cd ../

Using it:

import lndCache from '@litecoinfoundation/react-native-lndltc/dist/utils/neutrino-cache';
lndCache.addStateListener(
    (state: ICachedNeutrinoDBDownloadState) => {
      setMessage(JSON.stringify(state));
    },
);

await lndCache.downloadCache(ENetworks.testnet);
await startLnd();

Keywords

FAQs

Package last updated on 20 Jun 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc