@jayvdb/react-native-lightning-experimental

react-native-lightning

⚠️ This is pre-alpha software. Please use as your own risk.

Description

This library hopes to simplify the process of adding Lightning via LND's Neutrino to any React-Native app.

Android Installation:

Video Walkthrough: [TODO]

If you have any trouble, please use this commit as a reference to what needs to be changed/added to your project to get everything working.

1. Install Dependencies:

    yarn add react-native-lightning buffer
    yarn add -D rn-nodeify
    yarn install
   

2. Start the project:

   react-native run-android

Example Usage

import lnd from 'react-native-lightning';
const lndConf = new LndConf(Networks.regtest);

...

const res = await lnd.start(lndConf);
if (res.isOk()) {
  //Lnd started
}

iOS Installation (In Progress)

Manual (Android/iOS):

1. yarn add react-native-lightning buffer react-native-randombytes

2. Add the following to the end of your postinstall script in yourproject/package.json:

3. Copy necessary files over for Android & iOS respectively (Note: Create the directories if they do not exist):

   • Android - Copy LndNativeModule.java & LndNativePackage.java to android/app/src/main/java/com/yourproject/ and be sure to replace "com.rnlightning" at the top of each file with the name of your own project.
   • iOS - Copy LndReactModule.h & LndReactModule.m to ios/lightning/.

4. Generate the Lndmobile.aar & Lndmobile.framework files.

   • Option 1 - Generate them locally with lnd v0.9:
     • To generate these files, please follow the instructions detailed in the README of Lightning Lab's Lightning App here.
   • Option 2 - Download pre-generated files:
     • If you do not wish to generate these files locally you can download them here instead. However, I highly recommend you opt for option 1.

5. Add the Lndmobile.aar & Lndmobile.framework files to the project:

   • Add the Lndmobile.aar file to android/Lndmobile
   • Add the Lndmobile.framework file to ios/lightning

6. Add packages.add(new LndNativePackage()); to "getPackages" in MainApplication.java just above return packages"

7. For Android you'll need these additional dependencies in YourProject/android/app/build.gradle:

• implementation 'com.google.protobuf:protobuf-java:3.13.0'
• implementation 'com.android.support:multidex:1.0.3'
• Then Add multiDexEnabled true under defaultConfig in the same gradle file.

8. Start the project:
   • iOS: react-native run-ios
   • Android: react-native run-android