From cf71a4d897b4204bcc745a58dfcec60c7f7097a7 Mon Sep 17 00:00:00 2001 From: Shahana Farooqui Date: Mon, 16 Mar 2020 12:06:30 -0400 Subject: [PATCH] Loop documentation updated Loop documentation updated --- README.md | 3 ++- connect.js | 2 +- docs/Application_configurations | 3 ++- docs/Multi-Node-setup.md | 3 ++- docs/RTL_setups.md | 3 ++- sample-RTL-Config.json | 1 + 6 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cce1810d..19271b22 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,8 @@ Example RTL-Config.json: "bitcoindConfigPath": "", "enableLogging": true, "fiatConversion": false, - "lnServerUrl": "" + "lnServerUrl": "", + "swapServerUrl": "" } } ] diff --git a/connect.js b/connect.js index fc6613b3..ca664d6d 100644 --- a/connect.js +++ b/connect.js @@ -64,7 +64,7 @@ connect.setDefaultConfig = () => { channelBackupPath: channelBackupPath, enableLogging: false, lnServerUrl: "https://localhost:8080/v1", - swapServerUrl: "https://localhost:8081/v1", + swapServerUrl: "http://localhost:8081/v1", fiatConversion: false } } diff --git a/docs/Application_configurations b/docs/Application_configurations index 582b908f..5fc81026 100644 --- a/docs/Application_configurations +++ b/docs/Application_configurations @@ -30,7 +30,8 @@ parameters have `default` values for initial setup and can be updated after RTL "enableLogging": , "fiatConversion": , "currencyUnit": "", - "lnServerUrl": "", } } ] diff --git a/docs/Multi-Node-setup.md b/docs/Multi-Node-setup.md index 76a6fc7e..54cb7c6f 100644 --- a/docs/Multi-Node-setup.md +++ b/docs/Multi-Node-setup.md @@ -24,7 +24,8 @@ This step is only required to configure the nodes, which will be remotely connec 6. `nodes` section is a json array, with each element of the array representing the specific parameters for the LND node to connect with. `index` must be a number and start with 1. This number must be unique for each node in the array. For each element, two items need to be configured for each node on the network (`macaroonPath` and `lnServerUrl`). 7. `macaroonPath` should be set to the local path of the folder containing `admin.macaroon` file for each node. Each node must have a different folder for the `admin.macaroon` on the RTL server. 8. `lnServerUrl` must be set to the service url for LND/C Lightining REST APIs for each node, with the unique ip address of the node hosting lnd/clightning e.g. https://192.168.0.1:8080/v1 OR https://192.168.0.1:3001/v1. In this case the ip address of the node hosting lnd/clightning is '192.168.0.1' -9. `configPath` and `bitcoindConfigPath` are optional parameters which can be set only if the RTL is running locally on the same node. Else it can be set to "" or removed from the conf file all together. +9. `swapServerUrl` must be set to the swap service url. e.g. http://localhost:8081/v1. +10. `configPath` and `bitcoindConfigPath` are optional parameters which can be set only if the RTL is running locally on the same node. Else it can be set to "" or removed from the conf file all together. #### 3. Restart RTL diff --git a/docs/RTL_setups.md b/docs/RTL_setups.md index 5808e674..2bb0c732 100644 --- a/docs/RTL_setups.md +++ b/docs/RTL_setups.md @@ -37,7 +37,8 @@ If your running RTL and LND on different devices on your local LAN, certain conf "bitcoindConfigPath": "", "enableLogging": false, "fiatConversion": false, - "lnServerUrl": ":8080/v1; e.g. https://192.168.0.1:8080/v1>" + "lnServerUrl": ":8080/v1; e.g. https://192.168.0.1:8080/v1>", + "swapServerUrl": ":8081/v1>", } } ] diff --git a/sample-RTL-Config.json b/sample-RTL-Config.json index c4683c54..96bf0ca9 100644 --- a/sample-RTL-Config.json +++ b/sample-RTL-Config.json @@ -23,6 +23,7 @@ "channelBackupPath": "C:\\Users\\shaha\\backup\\node-1", "enableLogging": false, "lnServerUrl": "https://localhost:8080/v1", + "swapServerUrl": "http://localhost:8081/v1", "fiatConversion": false } }