Documentation updated for ECL lnApiPassword

Documentation updated for ECL lnApiPassword

README.md

@@ -94,7 +94,8 @@ Example RTL-Config.json:
       "lnImplementation": "LND",
       "Authentication": {
         "macaroonPath": "<Complete path of the folder containing admin.macaroon for the node # 1>",
-        "configPath": "<Optional:Path of the lnd.conf if present locally or empty>"
+        "configPath": "<Optional:Path of the .conf if present locally or empty>",
+        "lnApiPassword": "<Optional:Can be used to provide password in ECL implementation>"
       },
       "Settings": {
         "userPersona": "OPERATOR",

connect.js

@@ -146,7 +146,7 @@ connect.validateNodeConfig = (config) => {
       } else {
         common.nodes[idx].config_path = '';
       }
-      if (common.nodes[idx].ln_implementation === 'ECL' && common.nodes[idx].config_path !== '') {
+      if (common.nodes[idx].ln_implementation === 'ECL' && common.nodes[idx].ln_api_password === '' && common.nodes[idx].config_path !== '') {
         try {
           let exists = fs.existsSync(common.nodes[idx].config_path);
           if (exists) {

docs/Application_configurations

@@ -20,7 +20,8 @@ parameters have `default` values for initial setup and can be updated after RTL
       "lnImplementation": "<LNP implementation, Allowed values LND/CLT/ECL. Default 'LND', Required>",
       "Authentication": {
         "macaroonPath": "<Path for the folder containing 'admin.macaroon' (LND)/'access.macaroon' (CLT) file, Required for LND & CLT>",
-        "configPath": "<Full path of the lnd.conf/c-lightning config/eclair.conf file including the file name, if present locally, Optional for LND & CLT, Mandatory for ECL>"
+        "configPath": "<Full path of the lnd.conf/c-lightning config/eclair.conf file including the file name, if present locally, Optional, only mandatory for ECL if the lnApiPassword is missing>",
+        "lnApiPassword": "<Password to be used for ECL API authentication. Mandatory only for ECL if the configPath is missing>"
       },
       "Settings": {
         "userPersona": "<User persona to tailor the data on UI. Allowed values MERCHANT, OPERATOR. Default MERCHANT, Required>",

docs/Eclair-setup.md

@@ -48,7 +48,8 @@ Ensure that the follow values are correct per your config:
 * `lnImplementation` - This should be `ECL`, indicating that RTL is connecting to an Eclair node.
 * `lnServerUrl` - complete url with ip address and port of the eclair server.
 * `multiPass` - Specify the password (in plain text) to access RTL. This password will be hashed and not stored as plain text.
-* `configPath` (Mandatory) - Full path of the folder containing `eclair.conf` including the file name for the basic password authentication through `eclair.api.password`.
+* `configPath` (Optinal) - Full path of the folder containing `eclair.conf` including the file name. Can be used for the basic password authentication through `eclair.api.password`.
+* `lnApiPassword` (Mandatory if configPath is missing) - The same value from eclair.conf's eclair.api.password should be provided directly here. It will be used for Eclair API authentication. 
 
 ```
 {
@@ -64,7 +65,8 @@ Ensure that the follow values are correct per your config:
       "lnNode": "Eclair Testnet # 1",
       "lnImplementation": "ECL",
       "Authentication": {
-        "configPath": "<Mandatory - Config file path, including .conf file, for authentication>"
+        "configPath": "<Optional - Config file path, including .conf file>",
+        "lnApiPassword": "<Mandatory - Password used for API authentication>",
       },
       "Settings": {
         "userPersona": "OPERATOR",
@@ -77,7 +79,7 @@ Ensure that the follow values are correct per your config:
       }
     }
   ],
-  "multiPass": <password required for accessing RTL>
+  "multiPass": "<password required for accessing RTL>"
 }
 ```
 ### <a name="start"></a>Start the server and access the app

docs/Multi-Node-setup.md

@@ -26,6 +26,7 @@ This step is only required to configure the nodes, which will be remotely connec
 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. `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.
+11. `lnApiPassword` is mandatory in the ln implementation is ECL and configPath is missing. It is used to provide password for API authentication. It will be ignored in other ln implementations.
 
 #### 3. Restart RTL