From e959bb298e9ac271a86a92b55e4228226e97ea19 Mon Sep 17 00:00:00 2001
From: Andrey Samokhvalov <andrew.shvv@gmail.com>
Date: Wed, 26 Dec 2018 14:37:13 +0300
Subject: [PATCH] topology: define responsibility of package

---
 topology/client.go | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 topology/client.go

diff --git a/topology/client.go b/topology/client.go
new file mode 100644
index 0000000..ac12327
--- /dev/null
+++ b/topology/client.go
@@ -0,0 +1,26 @@
+package topology
+
+// Topology responsibilities:
+//
+// 0. Ask lightning client for querying routes and adding metrics to
+// channels and nodes, so that decision about better path could be made
+// wiser.
+//
+// 1. Store historical changes of lighting network topology:
+// 	1.1 Overall channel change over time.
+//
+// 2. Derive additional metrics about nodes healthiness.
+// 	2.1 Percentage of time node being online.
+// 	2.2 Spam rate of node.
+// 	2.3 Last time node being active.
+//
+// 3. Derive anomalies:
+//	3.1 Drastic network capacity increase / decrease.
+//	3.2 Drastic particular nodes capacity increase / decrease.
+//	3.3 Drastic online percentage change for nodes known to us.
+//
+// 4. Derive additional general metrics about network:
+// 	4.1 Average channel time.
+// 	4.2 Average channel open / close fee.
+// 	4.3 Average channel routing fees.
+type Topology struct{}