Merge Development 0.2.0

Development 0.2.0

Author: itamarcps

.github/workflows/c-cpp.yml

@@ -14,100 +14,79 @@ jobs:
   setup:
     runs-on: ubuntu-latest
 
-    container: 
+    container:
       image: debian:bookworm
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
-      
+        uses: actions/checkout@v4
+
       - name: Update apt-get
         run: apt-get update
 
       - name: Install project dependencies
-        run: DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential cmake tmux clang-tidy autoconf libtool pkg-config libabsl-dev libboost-all-dev libc-ares-dev libcrypto++-dev libgrpc-dev libgrpc++-dev librocksdb-dev libscrypt-dev libsnappy-dev libssl-dev zlib1g-dev openssl protobuf-compiler protobuf-compiler-grpc libprotobuf-dev git doxygen
+        run: DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential cmake tmux clang-tidy autoconf libtool pkg-config libabsl-dev libboost-all-dev libc-ares-dev libcrypto++-dev libgrpc-dev libgrpc++-dev librocksdb-dev libscrypt-dev libsnappy-dev libssl-dev zlib1g-dev openssl protobuf-compiler protobuf-compiler-grpc libprotobuf-dev git doxygen curl unzip
 
       - name: Print GCC version
         run: gcc --version
 
       - name: Install CA certificates
         run: apt-get install -y ca-certificates
 
-  build:
+  build_test_and_analyse:
     needs: setup
     runs-on: ubuntu-latest
 
     container: 
       image: debian:bookworm
-
+    env:
+      # https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/
+      BUILD_WRAPPER_OUT_DIR: build_wrapper_output_directory # Directory where build-wrapper output will be placed
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Update apt-get
         run: apt-get update
 
       - name: Install project dependencies
-        run: DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential cmake tmux clang-tidy autoconf libtool pkg-config libabsl-dev libboost-all-dev libc-ares-dev libcrypto++-dev libgrpc-dev libgrpc++-dev librocksdb-dev libscrypt-dev libsnappy-dev libssl-dev zlib1g-dev openssl protobuf-compiler protobuf-compiler-grpc libprotobuf-dev git
-      
-      - name: Configure CMake
-        run: cmake -S . -B build
-
-      - name: Build with CMake
-        run: cmake --build build || cat build/deps/src/ethash-stamp/ethash-configure-*.log
+        run: DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential cmake tmux clang-tidy autoconf libtool pkg-config libabsl-dev libboost-all-dev libc-ares-dev libcrypto++-dev libgrpc-dev libgrpc++-dev librocksdb-dev libscrypt-dev libsnappy-dev libssl-dev zlib1g-dev openssl protobuf-compiler protobuf-compiler-grpc libprotobuf-dev git curl unzip gcovr
 
-      - name: Upload build artifacts
-        uses: actions/upload-artifact@v2
-        with:
-          name: build
-          path: build
+      - name: Install sonar-scanner and build-wrapper
+        uses: SonarSource/sonarcloud-github-c-cpp@v2
 
-  test:
-    needs: build
-    runs-on: ubuntu-latest
+      - name: Configure CMake
+        run: cmake -S . -B build -DSONARQUBE_ANALYSIS=ON -DDEBUG=OFF
 
-    container: 
-      image: debian:bookworm
+      - name: Build with SonarQube BuildWrapper + CMake
+        run: build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} cmake --build build/ --config Release -- -j $(nproc)
 
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-      
-      - name: Download build artifacts
-        uses: actions/download-artifact@v2
-        with:
-          name: build
-          path: build
-      
-      - name: Update apt-get
-        run: apt-get update
-
-      - name: Install project dependencies
-        run: DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential cmake tmux clang-tidy autoconf libtool pkg-config libabsl-dev libboost-all-dev libc-ares-dev libcrypto++-dev libgrpc-dev libgrpc++-dev librocksdb-dev libscrypt-dev libsnappy-dev libssl-dev zlib1g-dev openssl protobuf-compiler protobuf-compiler-grpc libprotobuf-dev git
-        
       - name: Give execute permissions
         run: chmod +x ./build/orbitersdkd-tests
 
       - name: Run Catch2 Tests
-        working-directory: build
-        run: ./orbitersdkd-tests -d yes
+        run: ./build/orbitersdkd-tests -d yes
+
+      - name: Collect coverage into one XML report
+        run: |
+          gcovr --gcov-ignore-parse-errors --sonarqube > coverage.xml
 
+      - name: Run SonarQube Scanner
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+        run: |
+          sonar-scanner --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}" --define sonar.coverageReportPaths=coverage.xml
   documentation:
-    needs: test
+    needs: build_test_and_analyse
     runs-on: ubuntu-latest
 
     container: 
       image: debian:bookworm
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
-      
-      - name: Download build artifacts
-        uses: actions/download-artifact@v2
-        with:
-          name: build
-          path: build
+        uses: actions/checkout@v4
 
       - name : Update apt-get
         run: apt-get update
@@ -121,7 +100,7 @@ jobs:
           doxygen Doxyfile
 
       - name: Publish Documentation
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: Documentation
-          path: docs
+          path: docs

.gitignore

@@ -1,6 +1,8 @@
 ABI/
 build/
+testdump/
 debug.txt
+debug.log
 log.txt
 *.o
 *.gch

CMakeLists.txt

@@ -17,13 +17,15 @@ if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
 endif()
 
 # Project data
-project(orbitersdk VERSION 0.1.2 DESCRIPTION "Sparq subnet")
+project(orbitersdk VERSION 0.2.0 DESCRIPTION "Sparq subnet")
 set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 set(CMAKE_CXX_EXTENSIONS OFF)
 SET(DEBUG ON CACHE BOOL "Debug mode")
 if(DEBUG)
   set(CMAKE_CXX_FLAGS "-O0 -g -fsanitize=address -fno-inline -fno-eliminate-unused-debug-types -fstack-protector -Werror=unused-variable") # Provides faster compile time.
+elseif(SONARQUBE_ANALYSIS)
+  set(CMAKE_CXX_FLAGS "-O0 -g --coverage")
 else()
   set(CMAKE_CXX_FLAGS "-O2 -Werror=unused-variable")
 endif()

Dockerfile

@@ -1,3 +1,7 @@
+# Copyright (c) [2023-2024] [Sparq Network]
+# This software is distributed under the MIT License.
+# See the LICENSE.txt file in the project root for more information.
+
 # Start from a base Debian image
 FROM debian:bookworm
 
@@ -47,4 +51,4 @@ CMD nohup unison -repeat 1 /orbitersdk-volume /orbitersdk-cpp -auto -batch \
     -ignore 'Name {*.o}' \
     -ignore 'Name {*.gch}' \
     > /dev/null 2>&1 & \
-    /bin/bash
+    /bin/bash

Doxyfile

@@ -864,7 +864,7 @@ WARN_NO_PARAMDOC       = NO
 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
 # The default value is: NO.
 
-WARN_AS_ERROR          = FAIL_ON_WARNINGS
+WARN_AS_ERROR          = NO
 
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
@@ -995,7 +995,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = "src/libs" "src/utils/json.hpp" "src/utils/meta_all.hpp" "src/utils/options.cpp"
+EXCLUDE                = "src/libs" "src/libs/json.hpp" "src/libs/meta_all.hpp" "src/utils/options.cpp"
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

README.md

@@ -112,9 +112,12 @@ Note that, when re-deploying, if your wallet or RPC client keeps track of accoun
 The deployed chain will have the following information by default:
 
 * ChainID: **808080**
-* Owner: **0x00dead00665771855a34155f5e7405489df2c3c6**
-* Owner Private Key: **0xe89ef6409c467285bcae9f80ab1cfeb3487cfe61ab28fb7d36443e1daa0c2867**
-* Owner Initial Balance: **1000000000000000000000 wei**
+* Chain Owner: **0x00dead00665771855a34155f5e7405489df2c3c6**
+* Chain Owner Private Key: **0xe89ef6409c467285bcae9f80ab1cfeb3487cfe61ab28fb7d36443e1daa0c2867**
+* Chain Owner Initial Balance: **1000000000000000000000 wei**
+* Genesis Private Key: **0x4d48bdf34d65ef2bed2e4ee9020a7d3162b494ac31d3088153425f286f3d3c8c**
+* Genesis Address: **0x00dead001ae76ac3d3f282ffb8481becdee17357**
+* Genesis Timestamp: **1656356646000000**
 * ContractManager Address: **0x0001cb47ea6d8b55fe44fdd6b1bdb579efb43e61**
 * rdPoS Address: **0xb23aa52dbeda59277ab8a962c69f5971f22904cf**
 * Default RPC URL: **http://127.0.0.1:8090**

docker-compose.yml

@@ -1,3 +1,7 @@
+# Copyright (c) [2023-2024] [Sparq Network]
+# This software is distributed under the MIT License.
+# See the LICENSE.txt file in the project root for more information.
+
 version: '3'
 
 services: