Release 0.15.0 (#1334)

c-lightning-REST to clnrest migration.

.github/docs/Application_configurations.md

@@ -21,11 +21,12 @@ parameters have `default` values for initial setup and can be updated after RTL
       "lnNode": "<Node name to uniquely identify the node in the UI, Required>",
       "lnImplementation": "<LNP implementation, Allowed values LND/CLN/ECL, Required>",
       "Authentication": {
-        "macaroonPath": "<Path for the folder containing 'admin.macaroon' (LND)/'access.macaroon' (CLN) file, Required for LND & CLN>",
+        "macaroonPath": "<Path for the folder containing 'admin.macaroon' for LND node, Required for LND>",
+        "runePath": "<Complete path including filename for CLN rune for the node, Required for CLN>",
+        "lnApiPassword": "<Password to be used for ECL API authentication. Mandatory only for ECL if the configPath is missing>"
         "swapMacaroonPath": "<Path for the folder containing 'loop.macaroon' (LND), Required for LND Loop>",
         "boltzMacaroonPath": "<Path for the folder containing 'admin.macaroon' (Boltz), Required for Boltz Swaps>",
         "configPath": "<Full path of the lnd.conf/core 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, Optional>",
@@ -59,7 +60,8 @@ LN_SERVER_URL (LN server URL for LNP REST APIs, default https://127.0.0.1:8080)
 SWAP_SERVER_URL (Swap server URL for REST APIs, default http://127.0.0.1:8081) (Optional)<br />
 BOLTZ_SERVER_URL (Boltz server URL for REST APIs, default http://127.0.0.1:9003) (Optional)<br />
 CONFIG_PATH (Full path of the LNP .conf file including the file name) (Optional for LND & CLN, Mandatory for ECL if LN_API_PASSWORD is undefined)<br />
-MACAROON_PATH (Path for the folder containing 'admin.macaroon' (LND)/'access.macaroon' (CLN) file, Required for LND & CLN)<br />
+MACAROON_PATH (Path for the folder containing 'admin.macaroon' for LND, Required for LND)<br />
+RUNE_PATH (Complete path for the file containing 'rune' for CLN where the file should define the rune in 'LIGHTNING_RUNE="your-rune"' format, Required for CLN)<br />
 SWAP_MACAROON_PATH (Path for the folder containing Loop's 'loop.macaroon', optional)<br />
 BOLTZ_MACAROON_PATH (Path for the folder containing Boltz's 'admin.macaroon', optional)<br />
 RTL_SSO (1 - single sign on via an external cookie, 0 - stand alone RTL authentication, Required)<br />

.github/docs/CLN_command_coverage.md

@@ -1,71 +0,0 @@
-### Core Lightning Commands Covered on RTL
-
-=== bitcoin ===
-- [x] feerates
-- [x] newaddr
-- [ ] txdiscard
-- [ ] txprepare
-- [ ] txsend
-- [x] withdraw
-
-=== channels ===
-- [x] close
-- [ ] fundchannel_cancel
-- [ ] fundchannel_complete
-- [ ] fundchannel_start
-- [x] getroute
-- [x] listchannels
-- [x] listforwards
-- [x] setchannelfee
-
-=== network ===
-- [x] connect
-- [x] disconnect
-- [x] listnodes
-- [x] listpeers
-- [ ] ping
-
-=== payment ===
-- [ ] createonion
-- [x] decodepay
-- [x] delexpiredinvoice
-- [ ] delinvoice
-- [x] invoice
-- [x] listinvoices
-- [x] listsendpays
-- [ ] listtransactions
-- [ ] sendonion
-- [ ] sendpay
-- [ ] waitanyinvoice
-- [ ] waitinvoice
-- [ ] waitsendpay
-
-=== plugin ===
-- [ ] autocleaninvoice
-- [ ] estimatefees
-- [x] fundchannel
-- [ ] getchaininfo
-- [ ] getrawblockbyheight
-- [ ] getutxout
-- [x] listpays
-- [x] pay
-- [ ] paystatus
-- [ ] plugin
-- [ ] sendrawtransaction
-
-=== utility ===
-- [ ] check
-- [x] checkmessage
-- [x] getinfo
-- [ ] getlog
-- [ ] getsharedsecret
-- [ ] help
-- [ ] listconfigs
-- [x] listfunds
-- [x] signmessage
-- [ ] stop
-- [ ] waitblockheight
-
-=== developer ===   
-- [ ] dev-listaddrs
-- [ ] dev-rescan-outputs

.github/docs/Core_lightning_setup.md

@@ -17,8 +17,9 @@ Follow the below steps to install and setup RTL to run on Core Lightning.
 ### <a name="prereq"></a>Pre-requisites:
 1. Functioning Core Lightning node. Follow install instructions on their [github](https://github.com/ElementsProject/lightning)
 2. NodeJS - Can be downloaded [here](https://nodejs.org/en/download)
-3. Cl-REST - Ensure that `cl-rest` API server is installed and running. Install instructions [here](https://github.com/Ride-The-Lightning/c-lightning-REST)
-4. Copy the `access.macaroon` file from `cl-rest` to the device, on which RTL will be installed
+3. clnrest - Ensure that core lightning's `clnrest` API server is configured. Configuration instructions [here](https://docs.corelightning.org/docs/rest#configuration)
+4. Create/reuse a rune created by core-lightning. Check [`createrune`](https://docs.corelightning.org/reference/lightning-createrune) and [`showrunes`](https://docs.corelightning.org/reference/lightning-showrunes) commands documentation for more details.
+4. Copy the `rune` and save it in a file named `.commando`, on which RTL will be installed.
 
 ### <a name="arch"></a>Architecture
 ![](../screenshots/RTL-CLN-Arch-2.png)
@@ -50,12 +51,12 @@ If there is an error with `upstream dependency conflict` message then replace `n
 ### <a name="prep"></a>Prep for Execution
 RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app. 
 * Rename the file `Sample-RTL-Config.json` to `RTL-Config.json` located at`./RTL`..
-* Locate the complete path of the readable `access.macaroon` from `cl-rest` on your node.
+* Locate the complete path of the readable `.commando` file on your node.
 * Modify the RTL conf file per the example file below
 
 Ensure that the follow values are correct per your config:
 * `lnImplementation` - This should be `CLN`, indicating that RTL is connecting to a core lightning node.
-* `macaroonPath` - Path of the folder containing `access.macaroon` file from cl-rest server.
+* `runePath` - Path of the folder including filename which contains `rune` for the node. This rune in the file should be saved in  `LIGHTNING_RUNE="your-rune"` format.
 * `lnServerUrl` - complete url with ip address and port of the cl-rest server.
 * `multiPass` - Specify the password (in plain text) to access RTL. This password will be hashed and not stored as plain text.
 * `configPath` (optional) - File path of the core lightning config file, if RTL server is local to the core lightning server.
@@ -77,7 +78,7 @@ Ensure that the follow values are correct per your config:
       "lnNode": "Core Lightning Testnet # 1",
       "lnImplementation": "CLN",
       "Authentication": {
-        "macaroonPath": "<Modify to include the path of the folder with access.macaroon>",
+        "runePath": "<Modify to include the path of the folder including filename which contains `rune`>",
         "configPath": "<Optional - Config file path for core lightning>"
       },
       "Settings": {

.github/docs/LND_API_coverage.md

@@ -1,57 +0,0 @@
-[Intro](../README.md) -- [Application Features](Application_features.md) -- [Road Map](Roadmap.md) -- **LND API Coverage** -- [Application Configurations](Application_configurations.md)
-
-- [x] GenSeed
-- [x] InitWallet
-- [x] UnlockWallet
-- [ ] ChangePassword
-- [x] WalletBalance
-- [x] ChannelBalance
-- [x] GetTransactions
-- [ ] EstimateFee
-- [x] SendCoins
-- [ ] ListUnspent
-- [ ] SubscribeTransactions
-- [ ] SendMany
-- [x] NewAddress
-- [x] SignMessage
-- [x] VerifyMessage
-- [x] ConnectPeer
-- [x] DisconnectPeer
-- [x] ListPeers
-- [x] GetInfo
-- [x] PendingChannels
-- [x] ListChannels
-- [ ] SubscribeChannelEvents
-- [x] ClosedChannels
-- [ ] OpenChannelSync
-- [x] OpenChannel
-- [x] CloseChannel
-- [ ] AbandonChannel
-- [x] SendPayment
-- [ ] SendPaymentSync
-- [ ] SendToRoute
-- [ ] SendToRouteSync
-- [x] AddInvoice
-- [x] ListInvoices
-- [ ] LookupInvoice
-- [ ] SubscribeInvoices
-- [x] DecodePayReq
-- [x] ListPayments
-- [ ] DeleteAllPayments
-- [ ] DescribeGraph
-- [x] GetChanInfo
-- [x] GetNodeInfo
-- [x] QueryRoutes
-- [x] GetNetworkInfo
-- [ ] StopDaemon
-- [ ] SubscribeChannelGraph
-- [ ] DebugLevel
-- [x] FeeReport
-- [x] UpdateChannelPolicy
-- [x] ForwardingHistory
-- [x] ExportChannelBackup
-- [x] ExportAllChannelBackups
-- [x] VerifyChanBackup
-- [x] RestoreChannelBackups
-- [ ] SubscribeChannelBackups
-- [ ] Messages

.github/docs/Multi_node_setup.md

@@ -30,7 +30,8 @@ This step is only required to configure the nodes, which will be remotely connec
 12. `swapServerUrl` must be set to the swap service url. e.g. https://127.0.0.1:8081.
 13. `boltzServerUrl` must be set to the boltz service url. e.g. https://127.0.0.1:9003.
 14. `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.
-15. `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.
+15. `lnApiPassword` is mandatory if 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.
+16. `runePath` is mandatory for CLN implementation. It should be set to the local path of the folder including filename containing rune value. This rune value in the file should be saved in  `LIGHTNING_RUNE="your-rune"` format.
 
 #### 3. Restart RTL