summary: first cut of my sumary plugin (needs c-lightning 0.7-rc2 or above)

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>

summary/README.md

@@ -0,0 +1,26 @@
+# Summary plugin
+
+This plugin is a little hack to show a summary of your node, including
+fiat amounts.
+
+## Options:
+
+* --summary-currency: Currency ticker to look up on bitaverage (default: `USD`)
+* --summary-currency-prefix: Prefix when printing currency (default: `USD $`)
+
+## Example Usage
+
+```
+$ lightning-cli summary | json_pp
+{
+   "network" : "TESTNET",
+   "utxo_amount" : "1.20119332000btc = USD $4582.22",
+   "avail_in" : "2.06940379btc = USD $7894.20",
+   "avail_out" : "0.27095103btc = USD $1033.60",
+   "my_address" : "031a3478d481b92e3c28810228252898c5f0d82fc4d07f5210c4f34d4aba56b769@165.227.30.200",
+   "num_channels" : 31,
+   "num_utxos" : 5,
+   "num_connected" : 1,
+   "num_gossipers" : 32
+}
+```

summary/summary.py

@@ -0,0 +1,120 @@
+#!/usr/bin/env python3
+from lightning import Plugin, Millisatoshi
+import json
+import requests
+import threading
+import time
+
+plugin = Plugin(autopatch=True)
+
+
+class PriceThread(threading.Thread):
+    def run(self):
+        try:
+            r = requests.get('https://apiv2.bitcoinaverage.com/convert/global'
+                             '?from=BTC&to={}&amount=1'.format(plugin.currency))
+            plugin.fiat_per_btc = json.loads(r.content)['price']
+        except Exception:
+            pass
+        # Six hours is more than often enough for polling
+        time.sleep(6*3600)
+
+
+def to_fiatstr(msat: Millisatoshi):
+    return "{}{:.2f}".format(plugin.currency_prefix,
+                              int(msat) / 10**11 * plugin.fiat_per_btc)
+
+
+@plugin.method("summary")
+def summary(plugin):
+    """Gets summary information about this node."""
+
+    reply = {}
+    info = plugin.rpc.getinfo()
+    funds = plugin.rpc.listfunds()
+    peers = plugin.rpc.listpeers()
+
+    # Make it stand out if we're not on mainnet.
+    if info['network'] != 'bitcoin':
+        reply['network'] = info['network'].upper()
+
+    if not plugin.my_address:
+        reply['warning_no_address'] = "NO PUBLIC ADDRESSES"
+    else:
+        reply['my_address'] = plugin.my_address
+
+    utxo_amount = Millisatoshi(0)
+    reply['num_utxos'] = 0
+    for f in funds['outputs']:
+        if f['status'] != 'confirmed':
+            continue
+        utxo_amount += f['amount_msat']
+        reply['num_utxos'] += 1
+    reply['utxo_amount'] = utxo_amount.to_btc_str()
+
+    avail_out = Millisatoshi(0)
+    avail_in = Millisatoshi(0)
+    reply['num_channels'] = 0
+    reply['num_connected'] = 0
+    reply['num_gossipers'] = info['num_peers']
+    for p in peers['peers']:
+        for c in p['channels']:
+            if c['state'] != 'CHANNELD_NORMAL':
+                continue
+            if p['connected']:
+                reply['num_connected'] += 1
+                reply['num_gossipers'] -= 1
+            if c['our_reserve_msat'] < c['to_us_msat']:
+                avail_out += c['to_us_msat'] - c['our_reserve_msat']
+            # We have to derive amount to them
+            to_them_msat = c['total_msat'] - c['to_us_msat']
+            if c['their_reserve_msat'] < to_them_msat:
+                avail_in += to_them_msat - c['their_reserve_msat']
+            reply['num_channels'] += 1
+    reply['avail_out'] = avail_out.to_btc_str()
+    reply['avail_in'] = avail_in.to_btc_str()
+
+    if plugin.fiat_per_btc:
+        reply['utxo_amount'] += ' = ' + to_fiatstr(utxo_amount)
+        reply['avail_out'] += ' = ' + to_fiatstr(avail_out)
+        reply['avail_in'] += ' = ' + to_fiatstr(avail_in)
+
+    return reply
+
+
+@plugin.init()
+def init(options, configuration, plugin):
+    plugin.currency = options['summary-currency']
+    plugin.currency_prefix = options['summary-currency-prefix']
+    info = plugin.rpc.getinfo()
+
+    # Try to grab conversion price
+    PriceThread().start()
+
+    # Prefer IPv4, otherwise take any to give out address.
+    best_address = None
+    for a in info['address']:
+        if best_address is None:
+            best_address = a
+        elif a['type'] == 'ipv4' and best_address['type'] != 'ipv4':
+            best_address = a
+
+    if best_address:
+        plugin.my_address = info['id'] + '@' + best_address['address']
+        if best_address['port'] != 9735:
+            plugin.my_address += ':' + str(best_address['port'])
+
+    plugin.log("Plugin summary.py initialized")
+
+
+plugin.add_option(
+    'summary-currency',
+    'USD',
+    'What currency should I look up on btcaverage?'
+)
+plugin.add_option(
+    'summary-currency-prefix',
+    'USD $',
+    'What prefix to use for currency'
+)
+plugin.run()