Merge pull request #37 from lightninglabs/main

[Releases] v0.0.1-alpha.rc1

Author: kaloudis

.gitignore

@@ -1,2 +1,3 @@
 *.DS_Store
 node_modules/
+dist/

README.md

@@ -1,26 +1,32 @@
-# @lightninglabs/lnc
+# @lightninglabs/lnc-web
 
 ## A npm module for Lightning Node Connect
 
 ## API Design
+
 #### Set-up and connection
 
 The constructor for the LNC object takes a parameters object with the three following fields:
 
-- `pairingPhrase` (string, required): Your LNC pairing phrase
-- `serverHost` (string): Specify a custom Lightning Node Connect proxy server. If not specified we'll default to `mailbox.terminal.lightning.today:443`
-- `wasmClientCode` (string): Custom location for the WASM client code. Can be remote or local. If not specified we’ll default to our instance on our CDN.
+-   `pairingPhrase` (string): Your LNC pairing phrase
+-   `serverHost` (string): Specify a custom Lightning Node Connect proxy server. If not specified we'll default to `mailbox.terminal.lightning.today:443`.
+-   `wasmClientCode` (string): Custom location for the WASM client code. Can be remote or local. If not specified we’ll default to our instance on our CDN.
+-   `namespace` (string): JavaScript namespace used for the main WASM calls. You can maintain multiple connections if you use different namespaces. If not specified we'll default to `default`.
+-   `password` (string): By default, this module will handle storage of your local and remote keys for you in local storage. We highly recommend encrypting that data with a password you set here.
 
 ```
-import LNC from ‘@lightninglabs/lnc’;
+import LNC from ‘@lightninglabs/lnc-web’;
 
 const pairingPhrase = ‘artefact morning piano photo consider light’;
+const password = 'u*E0F?gU\d($N&Ckh8u)tLm';
 
 // default connection using WASM from CDN
 // WASM loaded on object creation
 // default host: mailbox.terminal.lightning.today:443
+// password used for encrypting credentials
 const lnc = new LNC({
-   pairingPhrase
+   pairingPhrase,
+   password
 });
 
 // using custom Lightning Node Connect proxy server
@@ -32,7 +38,7 @@ const lnc = new LNC({
 // using WASM pulled into app
 const lnc = new LNC({
    pairingPhrase,
-   wasmClientCode: ‘​​wasm-client.wasm’
+   wasmClientCode: ‘/path/to/​​wasm-client.wasm’
 });
 
 // using WASM from external link
@@ -74,7 +80,6 @@ const poolAccount = await pool.trader.initAccount(100000000, 1000);
 const insights = await faraday.channelInsights();
 ```
 
-
 #### Subscriptions
 
 ```
@@ -84,11 +89,13 @@ const { lnd } = lnc;
 lnd.lightning.subscribeTransactions(
    params,
    transaction => handleNewData(transaction),
+   error => handleError(error),
 );
 
 lnd.lightning.subscribeChannelEvents(
    params,
    event => handleNewChannelEventData(event),
+   error => handleError(error),
 );
 ```
 

demos/connect-demo/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

demos/connect-demo/.prettierrc.json

@@ -0,0 +1,20 @@
+{
+  "overrides": [
+    {
+      "files": [".prettierrc", ".babelrc", ".eslintrc", ".stylelintrc"],
+      "options": {
+        "parser": "json"
+      }
+    }
+  ],
+  "printWidth": 90,
+  "proseWrap": "always",
+  "singleQuote": true,
+  "useTabs": false,
+  "semi": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "arrowParens": "avoid"
+}

demos/connect-demo/README.md

@@ -0,0 +1,53 @@
+# LNC Demo - Basic Connect
+
+This demo showcases the most basic flow to connect from a browser to a Lightning Terminal
+(litd) node using the `lnc-web` NPM package.
+
+## Running the demo
+
+To run the demo, you'll need to have NodeJS installed and a Lightning Terminal node
+accessible that you can obtain a pairing phrase from.
+
+1. Clone this repo
+   ```sh
+   $ git clone https://github.com/lightninglabs/lnc-web.git
+   $ cd lnc-web/demos/connect-demo
+   ```
+2. Install the dependencies
+   ```sh
+   $ npm install
+   ```
+3. Start the web app
+   ```sh
+   $ npm start
+   ```
+   Your browser should open to http://localhost:3000 and you should see the home page
+   below
+
+## Screenshots
+
+### Welcome page with Connect button
+
+![1_welcome](./public/img/1_welcome.png)
+
+### Connect page
+
+Enter your pairing phrase and a new password to use so you don't need to login again
+
+![2_connect](./public/img/2_connect.png)
+
+### Welcome page when connected
+
+After connecting to your node, you'll be redirected back to the welcome page, but now it
+will display some information obtained from calling `GetInfo` on `lnd`.
+
+![3_connected](./public/img/3_connected.png)
+
+### Login page
+
+If you reload the page or click the Logout link, you will be taken back to the Welcome
+page. It will detect that you have already connected from this browser in the past and
+display a "Login" button instead of "Connect". When you click "Login", you'll be take to
+the Login page where you only need to provide your password to reconnect to your node.
+
+![4_login](./public/img/4_login.png)