[WIP] Balancesharing plugin

balancesharing/README.md

@@ -1,7 +1,11 @@
-# Balance Sharin Plugin
+# Balance Sharing Plugin
 
 This is Work in Progress by Michael Ziegler and Rene Pickhadt from NTNU to extend the Lightning Network Protocol with the ability of nodes sharing their balance information with neighbors. This is needed to provide JIT-Routing functionality. Read more on: https://wiki.fulmo.org/wiki/Challenges_May_2020#JIT_Routing_.2F_Sharing_balance_information
 
+The current plugin is just able to encode and decode two new custom messages and send them out. The query message is exposed via the apicommand `lightning-cli foafbalance {direction} {amt}`
+
+Currently the results are writen to the logfile. in future they need to be cached and processed. In particular if the command line API should continue to exist (we recommend against this) there should be timeout of the queries.
+
 ## Installation
 
 
@@ -27,6 +31,12 @@ note that if you use the autoreload plugin you MUST pass the path the the balanc
 lightningd --network regtest --autoreload-plugin=/path/to/plugins/balancesharing/balancesharing.py
 ```
 
+if you want to run in regtest without setting up your own lightning cannels you can put 2 files in this directory which are the output from `listchannels` and `listfunds` command. by executing the following two commands on some lightning node and copy the two files.
+
+```
+lightning-cli listfunds > funds.json
+lightning-cli listchannels > channels.json
+```
 
 For general plugin installation instructions see the repos main
 [README.md](https://github.com/lightningd/plugins/blob/master/README.md#Installation)