initial commit

built on: https://github.com/krypdkat/qubicbob

big thanks to @krypdkat for open sourcing qubicbob!!!

Author: J0ET0M

.dockerignore

@@ -0,0 +1,7 @@
+build/
+.git/
+*.o
+*.a
+*.so
+.vscode/
+.idea/

.github/workflows/ci.yml

@@ -0,0 +1,11 @@
+name: CI
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+jobs:
+  build-linux:
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      configuration: Release

.github/workflows/linux-build.yml

@@ -0,0 +1,60 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Bob-Linux
+
+on:
+  workflow_call:
+    inputs:
+      configuration:
+        description: "Build configuration"
+        required: true
+        default: "Release"
+        type: string
+      build_dir:
+        description: "Build directory"
+        required: false
+        default: "build"
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      artifact-path: ${{ steps.build.outputs.path }}
+    steps:
+      # Checkout source
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Install dependencies
+      - name: Install CMake and dependencies
+        run: |
+          sudo apt update -y;
+          wget https://apt.llvm.org/llvm.sh; chmod +x llvm.sh; sudo ./llvm.sh 20;
+          sudo apt install vim net-tools tmux cmake git libjsoncpp-dev build-essential cmake uuid-dev libhiredis-dev zlib1g-dev unzip -y;
+
+      # Configure the project
+      - name: Configure with CMake
+        run: |
+          cmake -S . -B ${{ inputs.build_dir }} \
+            -DCMAKE_BUILD_TYPE=${{ inputs.configuration }} \
+            -DCMAKE_C_COMPILER=clang-20 \
+            -DCMAKE_CXX_COMPILER=clang++-20
+
+      # Build the project
+      - name: Build with Make
+        run: cmake --build ${{ inputs.build_dir }} --config ${{ inputs.configuration }} -- -j$(nproc)
+
+      # Upload build artifacts
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: BobLinuxBuild-${{ inputs.configuration }}
+          path: |
+            ${{ inputs.build_dir }}

.github/workflows/release.yml

@@ -0,0 +1,34 @@
+name: Release
+on:
+  push:
+    tags: ["*"]
+
+env:
+  RELEASE_BUILD_DIR: "build"
+  BUILD_CONFIGURATION: "Release"
+
+jobs:
+  build-linux:
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      configuration: Release
+      build_dir: build
+
+  publish-linux:
+    needs: build-linux
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download Linux build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: BobLinuxBuild-${{ env.BUILD_CONFIGURATION }}
+          path: ${{ env.RELEASE_BUILD_DIR }}
+
+      - name: Create release package
+        uses: softprops/action-gh-release@v2
+        with:
+          name: "BOB ${{ github.ref_name }}"
+          body: "Automated release of Bob version ${{ github.ref_name }}"
+          files: ${{ env.RELEASE_BUILD_DIR }}/bob
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+.idea/*
+build/*
+cmake-build-*

ANATOMY_OF_BOB.MD

@@ -0,0 +1,33 @@
+# The anatomy of BOB
+
+## Core Processors
+
+The core of BOB consists of four main processors dedicated to syncing and verifying network data.
+
+* **Thread #1: Tick Data Requester**
+    * This thread constantly queries the network for new tick data, votes, and transactions.
+    * It performs a pre-check to ensure data sufficiency (e.g., 451+ votes agree to execute the same tick, or 226+ votes agree on an empty tick).
+
+* **Thread #2: Logging Event Requester**
+    * This thread queries the network for logging and event data on a per-tick basis, adhering to the Qubic logging event protocol.
+    * It first requests the `logId` range for each transaction within a tick and then fetches all associated logging data for that tick.
+
+* **Thread #3: Data Integrity Verifier**
+    * This thread verifies the integrity of all data collected by the threads above.
+    * As logging events represent the most primitive actions in Qubic, they are used to reconstruct and validate the Spectrum and Universe every tick.
+
+* **Thread #4: Indexer**
+    * After the data has been successfully verified, this thread indexes it to ensure it is easily searchable.
+
+---
+
+## Additional Modules
+
+Beside the core processors, BOB also features two optional modules that can be disabled without halting its functionality.
+
+* **TCP Server**
+    * This server mimics the behavior of a core baremetal for critical request/response cycles (e.g., requests for `tickData`, `votes`, `transactions`).
+    * Its purpose is to help strengthen the existing network.
+
+* **REST API Server**
+    * This server provides a developer-friendly interface for builders to access all the indexed data mentioned above.