feat: add DebtRatio

richardschneider · richardschneider · commit 8ee03ff52542 · 2019-06-15T19:38:50.000+12:00
diff --git a/src/CoreApi/BitswapLedger.cs b/src/CoreApi/BitswapLedger.cs
@@ -51,5 +51,19 @@ public class BitswapLedger
         /// </value>
         public ulong DataSent { get; set; }
 
+        /// <summary>
+        ///   The calculated debt to the peer.
+        /// </summary>
+        /// <value>
+        ///   <see cref="DataSent"/> divided by <see cref="DataReceived"/>.
+        /// </value>
+        public float DebtRatio
+        {
+            get
+            {
+                return (float)DataSent / (float)(DataReceived + 1); // +1 is to prevent division by zero
+            }
+        }
+
     }
 }
diff --git a/test/CoreApi/BitswapLedgerTest.cs b/test/CoreApi/BitswapLedgerTest.cs
@@ -18,8 +18,21 @@ public void Defaults()
             Assert.AreEqual(0ul, ledger.BlocksSent);
             Assert.AreEqual(0ul, ledger.DataReceived);
             Assert.AreEqual(0ul, ledger.DataSent);
+            Assert.AreEqual(0f, ledger.DebtRatio);
         }
 
+        [TestMethod]
+        public void DebtRatio_Positive()
+        {
+            var ledger = new BitswapLedger { DataSent = 1024 * 1024 };
+            Assert.IsTrue(ledger.DebtRatio >= 1);
+        }
 
+        [TestMethod]
+        public void DebtRatio_Negative()
+        {
+            var ledger = new BitswapLedger { DataReceived = 1024 * 1024 };
+            Assert.IsTrue(ledger.DebtRatio < 1);
+        }
     }
 }
