Merge pull request #21 from synonymdev/neutrino-cache

Neutrino cache

Author: coreyphillips

.eslintignore

@@ -1,3 +1,3 @@
 node_modules
 dist
-src/*.d.ts
+src/protos

.eslintrc

@@ -20,7 +20,7 @@
   ],
   "rules": {
     "no-param-reassign": "error",
-    "no-shadow": "error",
+    "no-shadow": "off",
     "prettier/prettier": "warn",
     "indent": [
       2,
@@ -35,8 +35,8 @@
     "@typescript-eslint/switch-exhaustiveness-check": "error",
     "@typescript-eslint/consistent-type-definitions": ["error", "type"],
     "@typescript-eslint/explicit-function-return-type": "error",
-    "@typescript-eslint/space-before-function-paren": ["warn", "never"],
     "@typescript-eslint/no-unused-vars": "warn",
-    "@typescript-eslint/strict-boolean-expressions": "off"
+    "@typescript-eslint/strict-boolean-expressions": "off",
+    "@typescript-eslint/restrict-template-expressions": "off"
   }
 }

.gitignore

@@ -1,7 +1,7 @@
 node_modules/
 .idea/
-src/rpc.*
-src/walletunlocker.*
+src/protos/*.ts
+src/protos/*.js
 dist/
 **.DS_Store
 android/build/

README.md

@@ -101,3 +101,31 @@ lnd.subscribeToOnChainTransactions(
 
 
 ```
+
+### 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.
+```bash
+#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:
+
+```javascript
+import lndCache from '@synonymdev/react-native-lightning/dist/utils/neutrino-cache';
+```
+
+```javascript
+lndCache.addStateListener(
+    (state: ICachedNeutrinoDBDownloadState) => {
+      setMessage(JSON.stringify(state));
+    },
+);
+
+await lndCache.downloadCache(ENetworks.testnet);
+await startLnd();
+```

example/App.tsx

@@ -22,8 +22,11 @@ import lnd, {
   ENetworks,
   LndConf,
   TCurrentLndState,
+  ICachedNeutrinoDBDownloadState,
 } from '@synonymdev/react-native-lightning';
 
+import lndCache from '@synonymdev/react-native-lightning/dist/utils/neutrino-cache';
+
 import {emoji} from './src/helpers';
 import PSBT from './src/PSBT';
 import Options from './src/Options';
@@ -57,7 +60,7 @@ const App = () => {
 
       lnd.subscribeToCurrentState(setLndState);
     })();
-  }, []);
+  }, [lndState]);
 
   useEffect(() => {
     if (lndState.walletUnlocked) {
@@ -129,24 +132,41 @@ const App = () => {
               }}
             />
           ) : (
-            <Button
-              title={'Start LND'}
-              onPress={async () => {
-                setMessage('Starting LND...');
-
-                const customFields = {};
-                const lndConf = new LndConf(network, customFields);
-                const res = await lnd.start(lndConf);
-
-                if (res.isErr()) {
-                  setMessage(res.error.message);
-                  console.error(res.error);
-                  return;
-                }
-
-                setMessage(JSON.stringify(res.value));
-              }}
-            />
+            <>
+              <Button
+                title={'Download cached headers then start LND'}
+                onPress={async () => {
+                  setMessage('Downloading cached headers...');
+                  setMessage(JSON.stringify(lndCache));
+                  lndCache.addStateListener(
+                    (state: ICachedNeutrinoDBDownloadState) => {
+                      setMessage(JSON.stringify(state));
+                    },
+                  );
+
+                  await lndCache.downloadCache(ENetworks.testnet);
+                  // await startLnd();
+                }}
+              />
+              <Button
+                title={'Start LND'}
+                onPress={async () => {
+                  setMessage('Starting LND...');
+
+                  const customFields = {};
+                  const lndConf = new LndConf(network, customFields);
+                  const res = await lnd.start(lndConf);
+
+                  if (res.isErr()) {
+                    setMessage(res.error.message);
+                    console.error(res.error);
+                    return;
+                  }
+
+                  setMessage(JSON.stringify(res.value));
+                }}
+              />
+            </>
           )}
 
           {showGenerateSeed ? (

example/ios/Podfile.lock

@@ -185,7 +185,7 @@ PODS:
     - React-cxxreact (= 0.63.4)
     - React-jsi (= 0.63.4)
   - React-jsinspector (0.63.4)
-  - react-native-lightning (0.0.24):
+  - react-native-lightning (0.0.28):
     - React
   - React-RCTActionSheet (0.63.4):
     - React-Core/RCTActionSheetHeaders (= 0.63.4)
@@ -249,6 +249,16 @@ PODS:
     - React-jsi (= 0.63.4)
   - RNCClipboard (1.7.0):
     - React-Core
+  - RNFS (2.18.0):
+    - React
+  - RNZipArchive (6.0.3):
+    - React-Core
+    - RNZipArchive/Core (= 6.0.3)
+    - SSZipArchive (= 2.2.3)
+  - RNZipArchive/Core (6.0.3):
+    - React-Core
+    - SSZipArchive (= 2.2.3)
+  - SSZipArchive (2.2.3)
   - Yoga (1.14.0)
 
 DEPENDENCIES:
@@ -281,11 +291,14 @@ DEPENDENCIES:
   - React-RCTVibration (from `../node_modules/react-native/Libraries/Vibration`)
   - ReactCommon/turbomodule/core (from `../node_modules/react-native/ReactCommon`)
   - "RNCClipboard (from `../node_modules/@react-native-clipboard/clipboard`)"
+  - RNFS (from `../node_modules/react-native-fs`)
+  - RNZipArchive (from `../node_modules/react-native-zip-archive`)
   - Yoga (from `../node_modules/react-native/ReactCommon/yoga`)
 
 SPEC REPOS:
   trunk:
     - boost-for-react-native
+    - SSZipArchive
 
 EXTERNAL SOURCES:
   DoubleConversion:
@@ -342,6 +355,10 @@ EXTERNAL SOURCES:
     :path: "../node_modules/react-native/ReactCommon"
   RNCClipboard:
     :path: "../node_modules/@react-native-clipboard/clipboard"
+  RNFS:
+    :path: "../node_modules/react-native-fs"
+  RNZipArchive:
+    :path: "../node_modules/react-native-zip-archive"
   Yoga:
     :path: "../node_modules/react-native/ReactCommon/yoga"
 
@@ -362,7 +379,7 @@ SPEC CHECKSUMS:
   React-jsi: a0418934cf48f25b485631deb27c64dc40fb4c31
   React-jsiexecutor: 93bd528844ad21dc07aab1c67cb10abae6df6949
   React-jsinspector: 58aef7155bc9a9683f5b60b35eccea8722a4f53a
-  react-native-lightning: 609ccfb42e601a7a075fba5fb1366003a9e287cb
+  react-native-lightning: 6ed013f7c5427d80ab76b63d012cfa5baa95531b
   React-RCTActionSheet: 89a0ca9f4a06c1f93c26067af074ccdce0f40336
   React-RCTAnimation: 1bde3ecc0c104c55df246eda516e0deb03c4e49b
   React-RCTBlob: a97d378b527740cc667e03ebfa183a75231ab0f0
@@ -374,6 +391,9 @@ SPEC CHECKSUMS:
   React-RCTVibration: ae4f914cfe8de7d4de95ae1ea6cc8f6315d73d9d
   ReactCommon: 73d79c7039f473b76db6ff7c6b159c478acbbb3b
   RNCClipboard: 245417a78ab585e0d4d83926c28907e7b2bc24bd
+  RNFS: 3ab21fa6c56d65566d1fb26c2228e2b6132e5e32
+  RNZipArchive: 924d63f15f2838837f8379ee6e9955d8ff4736c4
+  SSZipArchive: 62d4947b08730e4cda640473b0066d209ff033c9
   Yoga: 4bd86afe9883422a7c4028c00e34790f560923d6
 
 PODFILE CHECKSUM: 68dc732fcf33a342148a67cab9f313638be7a515

example/package.json

@@ -11,9 +11,11 @@
   },
   "dependencies": {
     "@react-native-clipboard/clipboard": "^1.7.0",
+    "@synonymdev/react-native-lightning": "link:../",
     "react": "16.13.1",
     "react-native": "0.63.4",
-    "@synonymdev/react-native-lightning": "link:../"
+    "react-native-fs": "^2.18.0",
+    "react-native-zip-archive": "^6.0.3"
   },
   "devDependencies": {
     "@babel/core": "^7.8.4",

example/yarn.lock

@@ -977,6 +977,13 @@
   resolved "https://registry.yarnpkg.com/@protobufjs/utf8/-/utf8-1.1.0.tgz#a777360b5b39a1a2e5106f8e858f2fd2d060c570"
   integrity sha1-p3c2C1s5oaLlEG+OhY8v0tBgxXA=
 
+"@react-native-async-storage/async-storage@^1.15.4":
+  version "1.15.4"
+  resolved "https://registry.yarnpkg.com/@react-native-async-storage/async-storage/-/async-storage-1.15.4.tgz#cdba464ca3bb9f10ec538342cbf2520c06f453ab"
+  integrity sha512-pC0MS6UBuv/YiVAxtzi7CgUed8oCQNYMtGt0yb/I9fI/BWTiJK5cj4YtW2XtL95K5IuvPX/6uGWaouZ8KqXwdg==
+  dependencies:
+    deep-assign "^3.0.0"
+
 "@react-native-clipboard/clipboard@^1.7.0":
   version "1.7.0"
   resolved "https://registry.yarnpkg.com/@react-native-clipboard/clipboard/-/clipboard-1.7.0.tgz#43320841870b82b2f311f375dd5f178da46e244e"
@@ -1760,6 +1767,11 @@ balanced-match@^1.0.0:
   resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767"
   integrity sha1-ibTRmasr7kneFk6gK4nORi1xt2c=
 
+base-64@^0.1.0:
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/base-64/-/base-64-0.1.0.tgz#780a99c84e7d600260361511c4877613bf24f6bb"
+  integrity sha1-eAqZyE59YAJgNhURxId2E78k9rs=
+
 base64-js@^1.1.2, base64-js@^1.2.3, base64-js@^1.5.1:
   version "1.5.1"
   resolved "https://registry.yarnpkg.com/base64-js/-/base64-js-1.5.1.tgz#1b1b440160a5bf7ad40b650f095963481903930a"
@@ -2304,6 +2316,13 @@ decode-uri-component@^0.2.0:
   resolved "https://registry.yarnpkg.com/decode-uri-component/-/decode-uri-component-0.2.0.tgz#eb3913333458775cb84cd1a1fae062106bb87545"
   integrity sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=
 
+deep-assign@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/deep-assign/-/deep-assign-3.0.0.tgz#c8e4c4d401cba25550a2f0f486a2e75bc5f219a2"
+  integrity sha512-YX2i9XjJ7h5q/aQ/IM9PEwEnDqETAIYbggmdDB3HLTlSgo1CxPsj6pvhPG68rq6SVE0+p+6Ywsm5fTYNrYtBWw==
+  dependencies:
+    is-obj "^1.0.0"
+
 deep-is@~0.1.3:
   version "0.1.3"
   resolved "https://registry.yarnpkg.com/deep-is/-/deep-is-0.1.3.tgz#b369d6fb5dbc13eecf524f91b070feedc357cf34"
@@ -3602,6 +3621,11 @@ is-number@^7.0.0:
   resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b"
   integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==
 
+is-obj@^1.0.0:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f"
+  integrity sha1-PkcprB9f3gJc19g6iW2rn09n2w8=
+
 is-plain-object@^2.0.3, is-plain-object@^2.0.4:
   version "2.0.4"
   resolved "https://registry.yarnpkg.com/is-plain-object/-/is-plain-object-2.0.4.tgz#2c163b3fafb1b606d9d17928f05c2a1c38e07677"
@@ -5480,6 +5504,19 @@ react-is@^16.12.0, react-is@^16.8.1, react-is@^16.8.4, react-is@^16.8.6:
   resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4"
   integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==
 
+react-native-fs@^2.18.0:
+  version "2.18.0"
+  resolved "https://registry.yarnpkg.com/react-native-fs/-/react-native-fs-2.18.0.tgz#987b99cc90518ef26663a8d60e62104694b41c21"
+  integrity sha512-9iQhkUNnN2JNED0in06JwZy88YEVyIGKWz4KLlQYxa5Y2U0U2AZh9FUHtA04oWj+xt2LlHh0LFPCzhmNsAsUDg==
+  dependencies:
+    base-64 "^0.1.0"
+    utf8 "^3.0.0"
+
+react-native-zip-archive@^6.0.3:
+  version "6.0.3"
+  resolved "https://registry.yarnpkg.com/react-native-zip-archive/-/react-native-zip-archive-6.0.3.tgz#19dad30565b068b352c55048c8c535a6195f0b46"
+  integrity sha512-EBJJV+owqD8ibBwYvEuvtBWlstHQUaN7QOJbc7shWwtJEgxayRbyVv5gGtUGTnMO2wX+dav+3egHX3s7GacRyA==
+
 react-native@0.63.4:
   version "0.63.4"
   resolved "https://registry.yarnpkg.com/react-native/-/react-native-0.63.4.tgz#2210fdd404c94a5fa6b423c6de86f8e48810ec36"
@@ -6681,6 +6718,11 @@ use@^3.1.0:
   resolved "https://registry.yarnpkg.com/use/-/use-3.1.1.tgz#d50c8cac79a19fbc20f2911f56eb973f4e10070f"
   integrity sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ==
 
+utf8@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/utf8/-/utf8-3.0.0.tgz#f052eed1364d696e769ef058b183df88c87f69d1"
+  integrity sha512-E8VjFIQ/TyQgp+TZfS6l8yp/xWppSAHzidGiRrqe4bK4XP9pTRyKFgGJpO3SN7zdX4DeomTrwaseCHovfpFcqQ==
+
 util-deprecate@~1.0.1:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf"

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synonymdev/react-native-lightning",
   "title": "React Native Lightning",
-  "version": "0.0.24",
+  "version": "0.0.28",
   "description": "React Native wrapper for Lndmobile",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,8 +25,8 @@
     "lint": "yarn run lint:ts",
     "lint:ts": "eslint . --ext .ts,.tsx --fix",
     "protobuf": "yarn run protobuf:rpc && yarn run protobuf:walletunlocker",
-    "protobuf:rpc": "pbjs -t static-module -w commonjs -o dist/rpc.js src/protos/rpc.proto && pbjs -t static-module src/protos/rpc.proto | pbts -o dist/rpc.d.ts - && cp dist/rpc.* ./src/",
-    "protobuf:walletunlocker": "pbjs -t static-module -w commonjs -o dist/walletunlocker.js src/protos/walletunlocker.proto && pbjs -t static-module src/protos/walletunlocker.proto | pbts -o dist/walletunlocker.d.ts - && cp dist/walletunlocker.* ./src/",
+    "protobuf:rpc": "mkdir -p dist/protos && pbjs -t static-module -w commonjs -o dist/protos/rpc.js src/protos/rpc.proto && pbjs -t static-module src/protos/rpc.proto | pbts -o dist/protos/rpc.d.ts - && cp dist/protos/rpc.* ./src/protos/",
+    "protobuf:walletunlocker": "mkdir -p dist/protos && pbjs -t static-module -w commonjs -o dist/protos/walletunlocker.js src/protos/walletunlocker.proto && pbjs -t static-module src/protos/walletunlocker.proto | pbts -o dist/protos/walletunlocker.d.ts - && cp dist/protos/walletunlocker.* ./src/protos/",
     "prepublish": "yarn lint && yarn run build && npm --no-git-tag-version version patch"
   },
   "repository": {
@@ -44,8 +44,8 @@
   "devDependencies": {
     "@react-native-community/eslint-config": "^2.0.0",
     "@types/react-native": "0.62.13",
-    "@typescript-eslint/eslint-plugin": "3.3.0",
-    "@typescript-eslint/parser": "3.3.0",
+    "@typescript-eslint/eslint-plugin": "^4.25.0",
+    "@typescript-eslint/parser": "^4.25.0",
     "eslint": "^7.20.0",
     "eslint-config-prettier": "6.11.0",
     "eslint-config-standard-with-typescript": "18.0.2",
@@ -57,11 +57,13 @@
     "eslint-plugin-standard": "4.0.1",
     "prettier": "^2.2.1",
     "react": "^16.9.0",
-    "typescript": "^4.1.5"
+    "typescript": "^4.2.4"
   },
   "dependencies": {
     "base64-js": "^1.5.1",
-    "protobufjs": "^6.10.2"
+    "protobufjs": "^6.10.2",
+    "react-native-fs": "^2.18.0",
+    "react-native-zip-archive": "^6.0.3"
   },
   "bugs": {
     "url": "https://github.com/synonymdev/react-native-lightning/issues"

react-native-lightning.podspec

@@ -21,10 +21,6 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,swift}"
   s.requires_arc = true
 
-#  s.frameworks   = 'Lndmobile'
   s.vendored_frameworks = 'ios/Lndmobile.framework'
   s.dependency "React"
-  # ...
-  # s.dependency "..."
 end
-