https://github.com/bumi/lnd-native-companion

https://github.com/bumi/lnd-native-companion

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bumi/lnd-native-companion
• Owner: bumi
• Created: 2020-12-27T11:14:26.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-27T00:12:25.000Z (almost 4 years ago)
• Last Synced: 2024-11-03T10:53:25.935Z (10 days ago)
• Language: JavaScript
• Size: 522 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LND Companion

Native companion app for the [lightning browser extension](https://github.com/bumi/lightning-browser-extension) to connect to an LND node. 

Under development!

## Development

### 1. Setup Electron

I am currently not sure what's the best development setup for this.

The [native messaging host application](https://developer.chrome.com/docs/apps/nativeMessaging/#native-messaging-host-manifest) requires 

a `path` to an executable to be specified. The browser communicates via stdin/stdout with the native companion. 

Currenty I am using [prebuilt electron binaries](https://www.electronjs.org/docs/tutorial/application-distribution#with-prebuilt-binaries) to run it in development

Download the [prebuild binaries](https://github.com/electron/electron/releases) and clone this repository in a folder named `app` in the Electron's `resources` folder.

OSX: 

```

electron/Electron.app/Contents/Resources/app/

├── package.json

├── index.js

└── ...

```

Windows and Linux:

```

electron/resources/app

├── package.json

├── index.js

└── ...

```

Then use the absolute path to Electron.app on macOS, electron on Linux, or electron.exe on Windows in your host JSON file (joule.json).

On OSX you have to use the full path to the `Electron` executable in your Electron.app. For example: 

`/Users/bumi/src/lightning/lnd-native-companion/Electron.app/Contents/MacOS/Electron`

### 2. Configure native messaging host

Currently I've only used Chrome for development.

Copy or link the `joule.json` to `/etc/opt/chrome/native-messaging-hosts/joule.json` and configure the `path` as described above and check if the ID in the `allowed_origins` list matches with the ID of the browser extension.

### 3. Run local react.js server

    $ npm start

This should serve the frontend app on port 3000. 

Do not open the app in the browser. (it opens by default, just close it... it does not work in the browser)

### Install the browser extension

Now install the [lightning-browser-extension](https://github.com/bumi/lightning-browser-extension)

## Logs

We use [electron-log](https://www.npmjs.com/package/electron-log) for logging. (you can not log to STDOUT because 

that's how the browser communicates with the companion)

By default, it writes logs to the following locations:

on Linux: `~/.config/{app name}/logs/{process type}.log`

on macOS: `~/Library/Logs/{app name}/{process type}.log`

on Windows: `%USERPROFILE%\AppData\Roaming\{app name}\logs\{process type}.log`

e.g.

    $ tail -f ~/.config/lnd-native-companion/logs/main.log ~/.config/lnd-native-companion/logs/renderer.log 

## HELP?

The setup and everything is still very rough. Please reach out or create an issue, I am happy to help.