validator stats (#49)

open-web3-stack · Aug 5, 2024 · 31277d2 · 31277d2
1 parent 5368b1a
commit 31277d2
Show file tree

Hide file tree

Showing 7 changed files with 118 additions and 20 deletions.
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -9,6 +9,7 @@ disabled_rules:
     - blanket_disable_command
     - type_body_length
     - identifier_name
+    - function_parameter_count
 
 excluded:
     - "**/.build"

diff --git a/Blockchain/Sources/Blockchain/Runtime.swift b/Blockchain/Sources/Blockchain/Runtime.swift
@@ -1,7 +1,10 @@
+import Utils
+
 // the STF
 public final class Runtime {
     public enum Error: Swift.Error {
         case safroleError(SafroleError)
+        case invalidValidatorEd25519Key
     }
 
     public let config: ProtocolConfigRef
@@ -13,6 +16,7 @@ public final class Runtime {
     public func apply(block: BlockRef, state prevState: StateRef) throws(Error) -> StateRef {
         var newState = prevState.value
         newState.lastBlock = block
+
         let res = newState.updateSafrole(
             slot: block.header.timeslotIndex, entropy: newState.entropyPool.0, extrinsics: block.extrinsic.tickets
         )
@@ -23,6 +27,45 @@ public final class Runtime {
             throw .safroleError(err)
         }
 
+        newState.activityStatistics = updateValidatorActivityStatistics(block: block, state: prevState)
+
         return StateRef(newState)
     }
+
+    // TODO: add tests
+    public func updateValidatorActivityStatistics(block: BlockRef, state: StateRef) -> ValidatorActivityStatistics {
+        let epochLength = UInt32(config.value.epochLength)
+        let currentEpoch = state.value.timeslot / epochLength
+        let newEpoch = block.header.timeslotIndex / epochLength
+        let isEpochChange = currentEpoch != newEpoch
+
+        var acc = isEpochChange ? ConfigFixedSizeArray<_, ProtocolConfig.TotalNumberOfValidators>(
+            config: config, defaultValue: ValidatorActivityStatistics.StatisticsItem.dummy(config: config)
+        ) : state.value.activityStatistics.accumulator
+
+        let prev = isEpochChange ? state.value.activityStatistics.accumulator : state.value.activityStatistics.previous
+
+        var item = acc[block.header.authorIndex]
+        item.blocks += 1
+        item.tickets += UInt32(block.extrinsic.tickets.tickets.count)
+        item.preimages += UInt32(block.extrinsic.preimages.preimages.count)
+        item.preimagesBytes += UInt32(block.extrinsic.preimages.preimages.reduce(into: 0) { $0 += $1.size })
+
+        acc[block.header.authorIndex] = item
+
+        for report in block.extrinsic.reports.guarantees {
+            for cred in report.credential {
+                acc[cred.index].guarantees += 1
+            }
+        }
+
+        for assurance in block.extrinsic.availability.assurances {
+            acc[assurance.validatorIndex].assurances += 1
+        }
+
+        return ValidatorActivityStatistics(
+            accumulator: acc,
+            previous: prev
+        )
+    }
 }
diff --git a/Blockchain/Sources/Blockchain/Types/ExtrinsicGuarantees.swift b/Blockchain/Sources/Blockchain/Types/ExtrinsicGuarantees.swift
@@ -2,12 +2,25 @@ import ScaleCodec
 import Utils
 
 public struct ExtrinsicGuarantees: Sendable, Equatable {
+    public struct IndexAndSignature: Sendable, Equatable {
+        public var index: UInt32
+        public var signature: Ed25519Signature
+
+        public init(
+            index: UInt32,
+            signature: Ed25519Signature
+        ) {
+            self.index = index
+            self.signature = signature
+        }
+    }
+
     public struct GuaranteeItem: Sendable, Equatable {
         public var coreIndex: CoreIndex
         public var workReport: WorkReport
         public var timeslot: TimeslotIndex
         public var credential: LimitedSizeArray<
-            Ed25519Signature,
+            IndexAndSignature,
             ConstInt2,
             ConstInt3
         >
@@ -17,7 +30,7 @@ public struct ExtrinsicGuarantees: Sendable, Equatable {
             workReport: WorkReport,
             timeslot: TimeslotIndex,
             credential: LimitedSizeArray<
-                Ed25519Signature,
+                IndexAndSignature,
                 ConstInt2,
                 ConstInt3
             >
@@ -42,16 +55,12 @@ public struct ExtrinsicGuarantees: Sendable, Equatable {
     ) {
         self.guarantees = guarantees
     }
-
-    public init(config: ProtocolConfigRef) {
-        guarantees = ConfigLimitedSizeArray(config: config)
-    }
 }
 
 extension ExtrinsicGuarantees: Dummy {
     public typealias Config = ProtocolConfigRef
     public static func dummy(config: Config) -> ExtrinsicGuarantees {
-        ExtrinsicGuarantees(config: config)
+        ExtrinsicGuarantees(guarantees: ConfigLimitedSizeArray(config: config))
     }
 }
 
@@ -84,3 +93,17 @@ extension ExtrinsicGuarantees.GuaranteeItem: ScaleCodec.Encodable {
         try encoder.encode(credential)
     }
 }
+
+extension ExtrinsicGuarantees.IndexAndSignature: ScaleCodec.Codable {
+    public init(from decoder: inout some ScaleCodec.Decoder) throws {
+        try self.init(
+            index: decoder.decode(),
+            signature: decoder.decode()
+        )
+    }
+
+    public func encode(in encoder: inout some ScaleCodec.Encoder) throws {
+        try encoder.encode(index)
+        try encoder.encode(signature)
+    }
+}
diff --git a/Blockchain/Sources/Blockchain/Types/Header.swift b/Blockchain/Sources/Blockchain/Types/Header.swift
@@ -36,8 +36,8 @@ public struct Header: Sendable, Equatable {
     // Ho: offenders markers
     public var offendersMarkers: [Ed25519PublicKey]
 
-    // Hi: a Bandersnatch block author index
-    public var authorKey: ValidatorIndex
+    // Hi: block author index
+    public var authorIndex: ValidatorIndex
 
     // Hv: the entropy-yielding vrf signature
     public var vrfSignature: BandersnatchSignature
@@ -57,7 +57,7 @@ public struct Header: Sendable, Equatable {
         >?,
         judgementsMarkers: [Data32],
         offendersMarkers: [Ed25519PublicKey],
-        authorKey: UInt32,
+        authorIndex: UInt32,
         vrfSignature: BandersnatchSignature,
         seal: BandersnatchSignature
     ) {
@@ -69,7 +69,7 @@ public struct Header: Sendable, Equatable {
         self.winningTickets = winningTickets
         self.judgementsMarkers = judgementsMarkers
         self.offendersMarkers = offendersMarkers
-        self.authorKey = authorKey
+        self.authorIndex = authorIndex
         self.vrfSignature = vrfSignature
         self.seal = seal
     }
@@ -95,7 +95,7 @@ extension Header: Dummy {
             winningTickets: nil,
             judgementsMarkers: [],
             offendersMarkers: [],
-            authorKey: 0,
+            authorIndex: 0,
             vrfSignature: BandersnatchSignature(),
             seal: BandersnatchSignature()
         )
@@ -113,7 +113,7 @@ extension Header: ScaleCodec.Encodable {
             winningTickets: ConfigFixedSizeArray(config: config, from: &decoder),
             judgementsMarkers: decoder.decode(),
             offendersMarkers: decoder.decode(),
-            authorKey: decoder.decode(),
+            authorIndex: decoder.decode(),
             vrfSignature: decoder.decode(),
             seal: decoder.decode()
         )
@@ -128,7 +128,7 @@ extension Header: ScaleCodec.Encodable {
         try encoder.encode(winningTickets)
         try encoder.encode(judgementsMarkers)
         try encoder.encode(offendersMarkers)
-        try encoder.encode(authorKey)
+        try encoder.encode(authorIndex)
         try encoder.encode(vrfSignature)
         try encoder.encode(seal)
     }

diff --git a/Blockchain/Sources/Blockchain/Types/ValidatorActivityStatistics.swift b/Blockchain/Sources/Blockchain/Types/ValidatorActivityStatistics.swift
@@ -33,16 +33,36 @@ public struct ValidatorActivityStatistics: Sendable, Equatable {
         }
     }
 
-    public var accumulator: ConfigFixedSizeArray<StatisticsItem, ProtocolConfig.TotalNumberOfValidators>
-    public var current: ConfigFixedSizeArray<StatisticsItem, ProtocolConfig.TotalNumberOfValidators>
+    public var accumulator:
+        ConfigFixedSizeArray<StatisticsItem, ProtocolConfig.TotalNumberOfValidators>
+    public var previous:
+        ConfigFixedSizeArray<StatisticsItem, ProtocolConfig.TotalNumberOfValidators>
 }
 
 extension ValidatorActivityStatistics: Dummy {
     public typealias Config = ProtocolConfigRef
     public static func dummy(config: Config) -> ValidatorActivityStatistics {
         ValidatorActivityStatistics(
-            accumulator: ConfigFixedSizeArray(config: config),
-            current: ConfigFixedSizeArray(config: config)
+            accumulator: ConfigFixedSizeArray(
+                config: config, defaultValue: StatisticsItem.dummy(config: config)
+            ),
+            previous: ConfigFixedSizeArray(
+                config: config, defaultValue: StatisticsItem.dummy(config: config)
+            )
+        )
+    }
+}
+
+extension ValidatorActivityStatistics.StatisticsItem: Dummy {
+    public typealias Config = ProtocolConfigRef
+    public static func dummy(config _: Config) -> ValidatorActivityStatistics.StatisticsItem {
+        ValidatorActivityStatistics.StatisticsItem(
+            blocks: 0,
+            tickets: 0,
+            preimages: 0,
+            preimagesBytes: 0,
+            guarantees: 0,
+            assurances: 0
         )
     }
 }
@@ -51,13 +71,13 @@ extension ValidatorActivityStatistics: ScaleCodec.Encodable {
     public init(config: ProtocolConfigRef, from decoder: inout some ScaleCodec.Decoder) throws {
         try self.init(
             accumulator: ConfigFixedSizeArray(config: config, from: &decoder),
-            current: ConfigFixedSizeArray(config: config, from: &decoder)
+            previous: ConfigFixedSizeArray(config: config, from: &decoder)
         )
     }
 
     public func encode(in encoder: inout some ScaleCodec.Encoder) throws {
         try encoder.encode(accumulator)
-        try encoder.encode(current)
+        try encoder.encode(previous)
     }
 }
 

diff --git a/Utils/Sources/Utils/ConfigLimitedSizeArray.swift b/Utils/Sources/Utils/ConfigLimitedSizeArray.swift
@@ -75,6 +75,16 @@ extension ConfigLimitedSizeArray: RandomAccessCollection {
         }
     }
 
+    public subscript(position: UInt32) -> T {
+        get {
+            array[Int(position)]
+        }
+        set {
+            array[Int(position)] = newValue
+            validate()
+        }
+    }
+
     public func index(after i: Int) -> Int {
         i + 1
     }

diff --git a/Utils/Sources/Utils/Ed25519.swift b/Utils/Sources/Utils/Ed25519.swift
@@ -32,6 +32,7 @@ public struct Ed25519 {
         guard let publicKey = try? Curve25519.Signing.PublicKey(rawRepresentation: publicKey.data) else {
             return false
         }
+
         return publicKey.isValidSignature(signature.data, for: message)
     }
 }