Merge pull request #36 from janezpodhostnik/janez/add-observabilitiy

Added observability to the DependencyAudit contract

contracts/DependencyAudit.cdc

@@ -122,10 +122,42 @@ access(all) contract DependencyAudit {
         }
     }
 
-    access(self) fun getBoundaries(): Boundaries? {
+    access(all) fun getBoundaries(): Boundaries? {
         return self.account.copy<Boundaries>(from: /storage/flowDependencyAuditBoundaries)
     }
 
+    access(all) fun getCurrentFailureProbability(): UFix64 {
+        if !DependencyAudit.panicOnUnstaged {
+            return 0.0 as UFix64
+        }
+
+        let maybeBoundaries = self.getBoundaries()
+        if maybeBoundaries == nil {
+            return 1.0 as UFix64
+        }
+
+        let boundaries = maybeBoundaries!
+
+        let startBlock: UInt64 = boundaries.start
+        let endBlock: UInt64 = boundaries.end
+        let currentBlock: UInt64 = getCurrentBlock().height
+
+        if startBlock >= endBlock {
+            return 1.0 as UFix64
+        }
+        if currentBlock >= endBlock {
+            return 1.0 as UFix64
+        }
+        if currentBlock < startBlock {
+            return 0.0 as UFix64
+        }
+
+        let dif = endBlock - startBlock
+        let currentDif = currentBlock - startBlock
+
+        return UFix64(currentDif) / UFix64(dif)
+    }
+
     access(self) fun setBoundaries(boundaries: Boundaries) {
         self.account.load<Boundaries>(from: /storage/flowDependencyAuditBoundaries)
         self.account.save(boundaries, to: /storage/flowDependencyAuditBoundaries)

scripts/dependency-audit/get_boundaries.cdc

@@ -0,0 +1,5 @@
+import "DependencyAudit"
+
+access(all) fun main(): DependencyAudit.Boundaries? {
+    return DependencyAudit.getBoundaries()
+}

scripts/dependency-audit/get_failure_probability.cdc

@@ -0,0 +1,5 @@
+import "DependencyAudit"
+
+access(all) fun main(): UFix64 {
+    return DependencyAudit.getCurrentFailureProbability()
+}

scripts/dependency-audit/get_should_panic_on_unstaged.cdc

@@ -0,0 +1,5 @@
+import "DependencyAudit"
+
+access(all) fun main(): Boolean {
+    return DependencyAudit.panicOnUnstaged
+}

tests/dependency_audit_tests.cdc

@@ -317,6 +317,15 @@ access(all) fun testBoundaries() {
     )
     Test.expect(commitResult, Test.beSucceeded())
 
+    let probability = (executeScript(
+        "../scripts/dependency-audit/get_failure_probability.cdc",
+        []
+    ).returnValue as! UFix64?)!
+
+    // depends on the block, so its better to check the range
+    Test.expect(probability, Test.beGreaterThan(0.5))
+    Test.expect(probability, Test.beLessThan(0.7))
+
     var i = 0
     var failCount = 0
     while i < 10 {