Merge pull request #179 from lightninglabs/full-remote-mode

Add remote mode for faraday, loopd and poold

Author: guggero

cmd/litd/main.go

@@ -14,7 +14,7 @@ func main() {
 	err := terminal.New().Run()
 	var flagErr *flags.Error
 	isFlagErr := errors.As(err, &flagErr)
-	if err != nil && (!isFlagErr ||	flagErr.Type != flags.ErrHelp) {
+	if err != nil && (!isFlagErr || flagErr.Type != flags.ErrHelp) {
 		_, _ = fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}

config.go

@@ -32,14 +32,13 @@ node:
   --uipassword=My$trongP@ssword \
   --letsencrypt \
   --letsencrypthost=loop.merchant.com \
+  --network=testnet \
   --lnd-mode=integrated \
   --lnd.lnddir=/root/.lnd \
   --lnd.alias=merchant \
   --lnd.externalip=loop.merchant.com \
   --lnd.rpclisten=0.0.0.0:10009 \
   --lnd.listen=0.0.0.0:9735 \
-  --lnd.bitcoin.active \
-  --lnd.bitcoin.testnet \
   --lnd.bitcoin.node=bitcoind \
   --lnd.bitcoind.rpchost=localhost \
   --lnd.bitcoind.rpcuser=testnetuser \
@@ -75,6 +74,7 @@ httpslisten=0.0.0.0:8443
 letsencrypt=true
 letsencrypthost=loop.merchant.com
 lnd-mode=integrated
+network=testnet
 
 # Lnd
 lnd.lnddir=~/.lnd
@@ -85,8 +85,6 @@ lnd.listen=0.0.0.0:9735
 lnd.debuglevel=debug
 
 # Lnd - bitcoin
-lnd.bitcoin.active=true
-lnd.bitcoin.testnet=true
 lnd.bitcoin.node=bitcoind
 
 # Lnd - bitcoind
@@ -151,13 +149,12 @@ For `lnd`:
   ```text
   # New flag to tell LiT to run its own lnd in integrated mode. We need to set
   # this because "remote" is the new default value if we don't specify anything.
+  # We also don't need to explicitly activate the Bitcoin network anymore as
+  # that is the default for LiT.
   lnd-mode=integrated
 
   # Application Options
   lnd.alias=merchant
-  
-  # bitcoin
-  lnd.bitcoin.active=true
   ```
 
 - if you use command line arguments for configuration, add the `lnd.` prefix to
@@ -271,11 +268,10 @@ relevant parts shown here):
 
 ```text
 lnd-mode=integrated
+network=testnet
 
 lnd.lnddir=~/.lnd
 lnd.rpclisten=0.0.0.0:10009
-
-lnd.bitcoin.testnet=true
 ```
 
 Because all components listen on the same gRPC port and use the same TLS

doc/config-lnd-integrated.md

@@ -49,14 +49,46 @@ Visit https://localhost:8443 to access LiT.
 
 ## Additional Configuration
 
-The "remote" mode means that `lnd` is started as a standalone process, possibly on another
+The default "remote" mode means that `lnd` is started as a standalone process, possibly on another
 host, and `litd` connects to it, right after starting its UI server. Once the connection
 to the remote `lnd` node has been established, `litd` then goes ahead and starts
 `faraday`, `pool` and `loop` and connects them to that `lnd` node as well.
 
-Currently the UI server cannot connect to `loop`, `pool` or `faraday` daemons
-that aren't running in the same process. But that feature will also be available
-in future versions.
+### Connecting LiT to a remote faraday node
+
+To instruct LiT to not start its own integrated `faraday` daemon but instead
+connect to an existing node, use the following configuration options:
+
+```text
+faraday-mode=remote
+remote.faraday.rpcserver=<externally-reachable-ip-address>:8465
+remote.faraday.macaroonpath=/some/folder/with/faraday/data/faraday.macaroon
+remote.faraday.tlscertpath=/some/folder/with/faraday/data/tls.cert
+```
+
+### Connecting LiT to a remote loopd node
+
+To instruct LiT to not start its own integrated `loopd` daemon but instead
+connect to an existing node, use the following configuration options:
+
+```text
+loop-mode=remote
+remote.loop.rpcserver=<externally-reachable-ip-address>:11010
+remote.loop.macaroonpath=/some/folder/with/loop/data/loop.macaroon
+remote.loop.tlscertpath=/some/folder/with/loop/data/tls.cert
+```
+
+### Connecting LiT to a remote poold node
+
+To instruct LiT to not start its own integrated `poold` daemon but instead
+connect to an existing node, use the following configuration options:
+
+```text
+pool-mode=remote
+remote.pool.rpcserver=<externally-reachable-ip-address>:12010
+remote.pool.macaroonpath=/some/folder/with/pool/data/pool.macaroon
+remote.pool.tlscertpath=/some/folder/with/pool/data/tls.cert
+```
 
 ## Use command line parameters only
 
@@ -89,8 +121,8 @@ and `faraday` (optional):
   --letsencrypt \
   --letsencrypthost=loop.merchant.com \
   --lit-dir=~/.lit \
+  --network=testnet \
   --remote.lit-debuglevel=debug \
-  --remote.lnd.network=testnet \
   --remote.lnd.rpcserver=some-other-host:10009 \
   --remote.lnd.macaroonpath=/some/folder/with/lnd/data/admin.macaroon \
   --remote.lnd.tlscertpath=/some/folder/with/lnd/data/tls.cert \
@@ -135,12 +167,12 @@ uipassword=My$trongP@ssword
 letsencrypt=true
 letsencrypthost=loop.merchant.com
 lit-dir=~/.lit
+network=testnet
 
 # Remote options
 remote.lit-debuglevel=debug
 
 # Remote lnd options
-remote.lnd.network=testnet
 remote.lnd.rpcserver=some-other-host:10009
 remote.lnd.macaroonpath=/some/folder/with/lnd/data/admin.macaroon
 remote.lnd.tlscertpath=/some/folder/with/lnd/data/tls.cert
@@ -180,8 +212,8 @@ configuration (only relevant parts shown here):
 ```text
 httpslisten=0.0.0.0:8443
 lit-dir=~/.lit
+network=testnet
 
-remote.lnd.network=testnet
 remote.lnd.rpcserver=some-other-host:10009
 remote.lnd.macaroonpath=/some/folder/with/lnd/data/admin.macaroon
 remote.lnd.tlscertpath=/some/folder/with/lnd/data/tls.cert

doc/config-lnd-remote.md

@@ -79,8 +79,7 @@ httpslisten=0.0.0.0:8443
 letsencrypt=1
 letsencrypthost=terminal.mydomain.com
 lnd-mode=integrated
-
-lnd.bitcoin.testnet=true
+network=testnet
 ```
 
 ### Example `lncli` command

doc/letsencrypt.md

@@ -8,12 +8,6 @@ rpclisten=0.0.0.0:10009
 Copy the following files that are located in your `~/.lnd/data/chain/bitcoin/mainnet` directory on your remote machine to `/some/folder/with/lnd/data/` on your local machine (where you’ll be running LiT):
 - tls.cert
 - admin.macaroon
-- chainnotifier.macaroon
-- invoices.macaroon
-- readonly.macaroon
-- router.macaroon
-- signer.macaroon
-- walletkit.macaroon
 
 Create a `lit.conf` file. The default location LiT will look for the configuration file depends on your operating system:
 - MacOS: `~/Library/Application Support/Lit/lit.conf`