Merge branch 'main' into fab-20250303

Author: joaomlneto

.idea/kotlinc.xml

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

.vscode/settings.json

@@ -1,4 +1,4 @@
-FROM node:20.18.1-alpine AS nodejs-base
+FROM node:20.18.2-alpine AS nodejs-base
 
 # Generate the OpenAPI docs and build the Java application
 FROM gradle:8 AS java-builder

Dockerfile

@@ -1,11 +1,22 @@
-# ByzzBench
+# ByzzBench - a BFT Protocol Benchmarking Suite
 
-BFT Protocol Benchmarking Suite
+[![Build Docker Image](https://github.com/joaomlneto/byzzbench/actions/workflows/docker-build.yml/badge.svg)](https://github.com/joaomlneto/byzzbench/actions/workflows/docker-build.yml)
+
+> ByzzBench is a benchmark suite designed to evaluate the performance of testing algorithms in detecting bugs in
+> Byzantine
+> Fault Tolerance (BFT) protocols. It is designed to be modular and extensible, allowing for easy integration of new
+> protocols and scenarios.
+>
+> ByzzBench is designed for a standardized implementation of BFT protocols and their execution in a controlled testing
+> environment, controlling the nondeterminism in concurrency, network and process faults in the protocol execution,
+> enabling the functionality to enforce particular execution scenarios and thereby facilitating the implementation of
+> testing algorithm for BFT protocols.
 
 This is a Gradle monorepo that contains the following modules:
 
-- `simulator`: The core benchmarking suite. Currently also includes the protocol implementations.
-- `webui`: A web interface for the benchmarking suite.
+- `simulator`: The core benchmarking suite, written in Java/Spring Boot. It currently also includes the protocol
+  implementations.
+- `webui`: A web interface for the benchmarking suite, written in React/NextJS.
 
 ## Prerequisites
 
@@ -32,8 +43,8 @@ Installing JDK:
 
 1. Through Eclipse Adoptium:
 
-   - Download the version you need (JDK-21)
-   - When installing, select "Set or override JAVA_HOME variable"
+    - Download the version you need (JDK-21)
+    - When installing, select "Set or override JAVA_HOME variable"
 
 2. Through Windows Package Manager - "winget":
 
@@ -157,59 +168,3 @@ See additional documentation in the [docs](docs) directory.
 - [Implementing new BFT Protocols](docs/implementing-protocols.md)
 - [Reproducing Schedules](docs/reproducing-schedules.md)
 - [User Interface](docs/user-interface.md)
-
-## Simulator Structure
-
-```mermaid
----
-title: Simulator Components
----
-classDiagram
-    class Event {
-        -int eventId
-    }
-    class Transport {
-    }
-    class MessageEvent {
-        -String senderId
-        -String recipientId
-        -MessagePayload message
-        -MessageStatus status
-    }
-    class TimeoutEvent {
-    }
-    class MessageStatus {
-        <<Enumeration>>
-        QUEUED
-        DELIVERED
-        DROPPED
-    }
-    class MessagePayload {
-        <<Interface>>
-        +String getType()
-    }
-    class Replica {
-        <<Abstract>>
-        +String getType()
-    }
-    class CommitLog {
-        <<Abstract>>
-        addEntry()
-    }
-    class TotalOrderCommitLog {
-        addEntry()
-    }
-    class PartialOrderCommitLog {
-        addEntry()
-    }
-    Event <|-- MessageEvent
-    Event <|-- TimeoutEvent
-    MessageEvent -- MessageStatus
-    MessageEvent -- MessagePayload
-    CommitLog -- Replica
-    Transport o-- Event
-    Transport o-- Replica
-    Replica --> Event: emits, receives
-    CommitLog <|-- TotalOrderCommitLog
-    CommitLog <|-- PartialOrderCommitLog
-```

README.md

@@ -58,3 +58,60 @@ check whether safety invariants of distributed consensus are broken.
       order, and this can lead to non-deterministic behavior. Use our own `DeterministicCompletableFuture`, which will
       execute the tasks in the order they were submitted to it.
 
+## Components
+
+The diagram below includes the relevant ByzzBench components for implementing a new BFT protocol.
+
+```mermaid
+---
+title: Simulator Components
+---
+classDiagram
+    class Event {
+        -int eventId
+    }
+    class Transport {
+    }
+    class MessageEvent {
+        -String senderId
+        -String recipientId
+        -MessagePayload message
+        -MessageStatus status
+    }
+    class TimeoutEvent {
+    }
+    class MessageStatus {
+        <<Enumeration>>
+        QUEUED
+        DELIVERED
+        DROPPED
+    }
+    class MessagePayload {
+        <<Interface>>
+        +String getType()
+    }
+    class Replica {
+        <<Abstract>>
+        +String getType()
+    }
+    class CommitLog {
+        <<Abstract>>
+        addEntry()
+    }
+    class TotalOrderCommitLog {
+        addEntry()
+    }
+    class PartialOrderCommitLog {
+        addEntry()
+    }
+    Event <|-- MessageEvent
+    Event <|-- TimeoutEvent
+    MessageEvent -- MessageStatus
+    MessageEvent -- MessagePayload
+    CommitLog -- Replica
+    Transport o-- Event
+    Transport o-- Replica
+    Replica --> Event: emits, receives
+    CommitLog <|-- TotalOrderCommitLog
+    CommitLog <|-- PartialOrderCommitLog
+```

docs/implementing-protocols.md

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1 @@
+{"events":[{"type":"ClientRequest","eventId":2,"createdAt":1736960554.6270425,"status":"DELIVERED","recipientId":"B","senderId":"C0","timestamp":1736960554627,"payload":{"timestamp":1736960554627,"operation":"C0/1","signed":false,"signedBy":null,"type":"DefaultClientRequest"},"deliveredAt":null},{"type":"ClientRequest","eventId":9,"createdAt":1736960554.6280425,"status":"DELIVERED","recipientId":"B","senderId":"C1","timestamp":1736960554628,"payload":{"timestamp":1736960554628,"operation":"C1/1","signed":false,"signedBy":null,"type":"DefaultClientRequest"},"deliveredAt":null},{"type":"Message","eventId":16,"createdAt":1736960556.0801437,"status":"DELIVERED","recipientId":"A","senderId":"B","timestamp":0,"payload":{"viewNumber":1,"sequenceNumber":1,"digest":"CtMEMkjjICiJ0zfwSspofgpOE5M=","request":{"operation":"C0/1","timestamp":1736960554627,"clientId":"C0","signed":false,"signedBy":null,"type":"REQUEST"},"signed":true,"signedBy":"B","type":"PREPARE"},"deliveredAt":null},{"type":"Message","eventId":18,"createdAt":1736960556.0801437,"status":"DELIVERED","recipientId":"D","senderId":"B","timestamp":0,"payload":{"viewNumber":1,"sequenceNumber":1,"digest":"CtMEMkjjICiJ0zfwSspofgpOE5M=","request":{"operation":"C0/1","timestamp":1736960554627,"clientId":"C0","signed":false,"signedBy":null,"type":"REQUEST"},"signed":true,"signedBy":"B","type":"PREPARE"},"deliveredAt":null},{"type":"Message","eventId":21,"createdAt":1736960556.0811455,"status":"DELIVERED","recipientId":"D","senderId":"B","timestamp":0,"payload":{"viewNumber":1,"sequenceNumber":1,"digest":"CtMEMkjjICiJ0zfwSspofgpOE5M=","request":{"operation":"C0/1","timestamp":1736960554627,"clientId":"C0","signed":false,"signedBy":null,"type":"REQUEST"},"replicaId":"B","speculativeHistory":{"history":{},"empty":true,"greatestSeqNumber":0,"requests":{}},"signed":true,"signedBy":"B","type":"COMMIT"},"deliveredAt":null},{"type":"Message","eventId":31,"createdAt":1736960562.4083266,"status":"DELIVERED","recipientId":"D","senderId":"A","timestamp":0,"payload":{"viewNumber":1,"sequenceNumber":1,"digest":"CtMEMkjjICiJ0zfwSspofgpOE5M=","request":{"operation":"C0/1","timestamp":1736960554627,"clientId":"C0","signed":false,"signedBy":null,"type":"REQUEST"},"replicaId":"A","speculativeHistory":{"history":{"1":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"}},"empty":false,"greatestSeqNumber":1,"requests":{"1":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"}}},"signed":true,"signedBy":"A","type":"COMMIT"},"deliveredAt":null},{"type":"ClientRequest","eventId":13,"createdAt":1736960554.6280425,"status":"DELIVERED","recipientId":"D","senderId":"C1","timestamp":1736960554628,"payload":{"timestamp":1736960554628,"operation":"C1/1","signed":false,"signedBy":null,"type":"DefaultClientRequest"},"deliveredAt":null},{"type":"Timeout","eventId":42,"createdAt":1736960574.9117787,"status":"DELIVERED","description":"REQUEST1736960554628","nodeId":"D","timeout":10,"expiresAt":10.001,"task":{},"recipientId":"D","deliveredAt":null},{"type":"Timeout","eventId":22,"createdAt":1736960556.9483867,"status":"DELIVERED","description":"REQUEST1736960554628","nodeId":"B","timeout":10,"expiresAt":10.002,"task":{},"recipientId":"B","deliveredAt":null},{"type":"MutateMessage","eventId":52,"senderId":"B","recipientId":"C","payload":{"eventId":24,"mutatorId":"hbft-prepare-sec-dec"},"createdAt":1736960584.0889707,"status":"DELIVERED","deliveredAt":null},{"type":"Message","eventId":24,"createdAt":1736960556.9483867,"status":"DELIVERED","recipientId":"C","senderId":"B","timestamp":0,"payload":{"viewNumber":1,"sequenceNumber":1,"digest":"vK5bH85oOq0vaso+TSfV+PLPXFE=","request":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"},"signed":true,"signedBy":"B","type":"PREPARE"},"deliveredAt":null},{"type":"Message","eventId":47,"createdAt":1736960576.5642834,"status":"DELIVERED","recipientId":"C","senderId":"D","timestamp":0,"payload":{"newViewNumber":2,"speculativeHistoryP":null,"speculativeHistoryQ":null,"requestsR":{"1":{"operation":"C0/1","timestamp":1736960554627,"clientId":"C0","signed":false,"signedBy":null,"type":"REQUEST"}},"replicaId":"D","signed":true,"signedBy":"D","type":"VIEW-CHANGE"},"deliveredAt":null},{"type":"MutateMessage","eventId":56,"senderId":"B","recipientId":"C","payload":{"eventId":50,"mutatorId":"hbft-view-change-remove-first-request"},"createdAt":1736960613.561314,"status":"DELIVERED","deliveredAt":null},{"type":"MutateMessage","eventId":57,"senderId":"B","recipientId":"C","payload":{"eventId":50,"mutatorId":"hbft-view-change-decrement-last-request-seqNum"},"createdAt":1736960617.884014,"status":"DELIVERED","deliveredAt":null},{"type":"Message","eventId":50,"createdAt":1736960579.971162,"status":"DELIVERED","recipientId":"C","senderId":"B","timestamp":0,"payload":{"newViewNumber":2,"speculativeHistoryP":null,"speculativeHistoryQ":null,"requestsR":{"1":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"}},"replicaId":"B","signed":true,"signedBy":"B","type":"VIEW-CHANGE"},"deliveredAt":null},{"type":"Message","eventId":62,"createdAt":1736960619.5324345,"status":"DELIVERED","recipientId":"A","senderId":"C","timestamp":0,"payload":{"newViewNumber":2,"viewChangeProofs":[{"newViewNumber":2,"speculativeHistoryP":null,"speculativeHistoryQ":null,"requestsR":{"1":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"}},"replicaId":"B","signed":true,"signedBy":"B","type":"VIEW-CHANGE"},{"newViewNumber":2,"speculativeHistoryP":null,"speculativeHistoryQ":null,"requestsR":{"1":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"}},"replicaId":"C","signed":true,"signedBy":"C","type":"VIEW-CHANGE"},{"newViewNumber":2,"speculativeHistoryP":null,"speculativeHistoryQ":null,"requestsR":{"1":{"operation":"C0/1","timestamp":1736960554627,"clientId":"C0","signed":false,"signedBy":null,"type":"REQUEST"}},"replicaId":"D","signed":true,"signedBy":"D","type":"VIEW-CHANGE"}],"checkpoint":{"sequenceNumber":0,"history":null},"speculativeHistory":{"history":{"1":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"}},"empty":false,"greatestSeqNumber":1,"requests":{"1":{"operation":"C1/1","timestamp":1736960554628,"clientId":"C1","signed":false,"signedBy":null,"type":"REQUEST"}}},"signed":true,"signedBy":"C","type":"NEW-VIEW"},"deliveredAt":null}],"brokenInvariants":[],"scenarioId":"hbft","finalized":false}

schedules/hbft known violation.json

@@ -25,16 +25,22 @@ repositories {
     mavenCentral()
 }
 
-extra["vaadinVersion"] = "24.6.0"
+//extra["vaadinVersion"] = "24.6.4"
 
 dependencies {
     implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
     compileOnly("org.projectlombok:lombok")
     annotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
     annotationProcessor("org.projectlombok:lombok")
     testImplementation("org.springframework.boot:spring-boot-starter-test")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     implementation("org.springframework.boot:spring-boot-starter-validation")
+    runtimeOnly("com.h2database:h2")
+    implementation("org.xerial:sqlite-jdbc:3.34.0")
+
+    // sqlite dialect
+    //implementation("org.hibernate:hibernate-community-dialects:5.6.3.Final")
 
     //implementation("org.springdoc:springdoc-openapi-ui:1.8.0")
     // either API (just documentation) or API + UI (documentation + Swagger UI)
@@ -51,11 +57,11 @@ dependencies {
     implementation("com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2")
 }
 
-dependencyManagement {
+/*dependencyManagement {
     imports {
         mavenBom("com.vaadin:vaadin-bom:${property("vaadinVersion")}")
     }
-}
+}*/
 
 tasks.withType<Test> {
     useJUnitPlatform()

schedules/hbft-bug-or-potential-violation.json

@@ -176,7 +176,7 @@ public final void setupScenario() {
             this.markReplicaFaulty(replicaIds.get(i));
         }
 
-        this.getClients().values().forEach(Client::initialize);
+        //this.getClients().values().forEach(Client::initialize);
         this.getNodes().values().forEach(Node::initialize);
         this.scheduler.initializeScenario(this);
     }

schedules/hbft-random-0-0-violation.json

@@ -1,11 +1,12 @@
 package byzzbench.simulator;
 
+import byzzbench.simulator.protocols.hbft.message.ClientRequestMessage;
 import byzzbench.simulator.transport.MessagePayload;
 import byzzbench.simulator.utils.NonNull;
 import com.fasterxml.jackson.annotation.JsonIgnore;
-import lombok.Builder;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
+import lombok.experimental.SuperBuilder;
 
 import java.io.Serializable;
 import java.time.Duration;
@@ -19,7 +20,7 @@
  * The client is responsible for sending requests to the replicas in the system.
  */
 @Getter
-@Builder
+@SuperBuilder
 @RequiredArgsConstructor
 public class Client implements Serializable, Node {
     /**
@@ -53,18 +54,25 @@ public class Client implements Serializable, Node {
     @Override
     public void initialize() {
         // Send the first request
-//        this.sendRequest("A");
+        this.sendRequest();
         //System.out.println("CLIENT TIMEOUT SETUP");
         //this.setTimeout("sendRequest", this::sendRequest, Duration.ofSeconds(1));
     }
 
     /**
-     * Sends a request to a replica in the system.
+     * Sends a request to any replica in the system.
      */
-    public void sendRequest(String senderId) {
+    public void sendRequest() {
         String recipientId = this.getScenario().getReplicas().keySet().iterator().next();
-        String requestId = String.format("%s/%d", this.id, this.requestSequenceNumber.getAndIncrement());
-        this.getScenario().getTransport().sendClientRequest(this.id, requestId, senderId);
+        this.sendRequest(recipientId);
+    }
+
+    /**
+     * Sends a request to a given replica in the system.
+     */
+    public void sendRequest(String recipientId) {
+        MessagePayload payload = new ClientRequestMessage(this.getCurrentTime().toEpochMilli(), recipientId);
+        this.getScenario().getTransport().sendMessage(this, payload, recipientId);
     }
 
     /**
@@ -76,7 +84,7 @@ public void sendRequest(String senderId) {
     public void handleMessage(String senderId, MessagePayload reply) {
         this.replies.add(reply);
         if (this.requestSequenceNumber.get() < this.maxRequests) {
-            this.sendRequest(senderId);
+            this.sendRequest();
         }
     }
 
@@ -94,7 +102,7 @@ public Instant getCurrentTime() {
      * @return the timer object
      */
     public long setTimeout(String name, Runnable r, Duration timeout) {
-        return this.scenario.getTransport().setTimeout(this, r, timeout);
+        return this.scenario.getTransport().setTimeout(this, r, timeout, "REQUEST");
     }
 
     /**