5.4.8.0, 2024-04-10, leisure

Added
 - build: add option for sanitizers #2553 (@div72)
 - build: CMake: Initial Windows support (MSYS2) #2733 (@CyberTailor)

Changed
 - build: enforce SSE2 on x86 targets #2746 (@div72)
 - consensus: Update checkpoint data for mainnet and testnet #2756 (@jamescowens)
 - gui, util: Enhance verify checkpoints fail handling; use RegistryBookmarks for DB passivation #2758 (@jamescowens)

Removed

Fixed
 - build, depends: fix compilation with XCode 15 #2747 (@div72)
 - Fix man page installation path for cmake builds #2749 (@theMarix)
 - consensus, mrc, sidestake: add mrc fees to staker to rewards to be allocated via sidestaking #2753 (@jamescowens)
 - Fix Systemd unit install location #2754 (@theMarix)
 - scraper: Corrections to scraper_net after removal of cntPartsRcvd decrement and increment #2755 (@jamescowens)
 - rpc: fix setban segfault #2757 (@div72)

Author: jamescowens

.github/workflows/ci.yml

@@ -23,6 +23,11 @@ jobs:
                     script-id: native
                   - name: x86_64 Linux  [GOAL install]  [GUI]  [bionic]  [no depends]
                     script-id: native_old
+                  - name: x86_64 Linux  [ASan]  [LSan]  [UBSan]  [integer]  [jammy]  [no depends]
+                    script-id: native_asan
+                  # FIXME: depends is unable to compile Qt with clang.
+                  # - name: x86_64 Linux  [TSan]  [GUI]  [jammy]
+                  #  script-id: native_tsan
                   - name: macOS 10.14  [GOAL deploy]  [GUI]  [no tests]  [focal]
                     script-id: mac
         env:

.github/workflows/cmake-ci.yml

@@ -192,3 +192,87 @@ jobs:
                   name: testlog-macos-${{matrix.tag}}
                   path: ${{github.workspace}}/build/Testing/Temporary/LastTest.log
                   retention-days: 7
+
+    test-msys2:
+        runs-on: windows-latest
+        defaults:
+            run:
+                shell: msys2 {0}
+        env:
+            CCACHE_DIR: ${{github.workspace}}\ccache
+            CCACHE_MAXSIZE: 400M
+            CCACHE_COMPILERCHECK: content
+        strategy:
+            matrix:
+                tag:
+                    - minimal
+                    - no-asm
+                    - gui-full
+                include:
+                    - tag: no-asm
+                      deps: null
+                      options: -DUSE_ASM=OFF
+                    - tag: gui-full
+                      deps: >-
+                          miniupnpc:p
+                          qrencode:p
+                          qt5-base:p
+                          qt5-tools:p
+                      options: >-
+                          -DENABLE_GUI=ON
+                          -DENABLE_QRENCODE=ON
+                          -DENABLE_UPNP=ON
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+            - name: Setup MSYS2
+              uses: msys2/setup-msys2@v2
+              with:
+                  msystem: UCRT64
+                  update: true
+                  install: >-
+                      make
+                      ninja
+                  pacboy: >-
+                      ${{matrix.deps}}
+                      boost:p
+                      ccache:p
+                      cmake:p
+                      curl:p
+                      libzip:p
+                      openssl:p
+                      toolchain:p
+            - name: Configure
+              run: |
+                  cmake -B ./build -G Ninja \
+                      -DCMAKE_C_COMPILER_LAUNCHER=ccache \
+                      -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
+                      ${{matrix.options}} \
+                      -DBUILD_SHARED_LIBS=OFF -DENABLE_TESTS=ON
+            - name: Restore cache
+              uses: actions/cache/restore@v3
+              if: always()
+              with:
+                  path: ${{env.CCACHE_DIR}}
+                  key: ccache-msys2-${{matrix.tag}}-${{github.run_id}}
+                  restore-keys: |
+                      ccache-msys2-${{matrix.tag}}-
+            - name: Build
+              run: |
+                  cmake --build ./build -v -j $NUMBER_OF_PROCESSORS
+            - name: Save cache
+              uses: actions/cache/save@v3
+              if: always()
+              with:
+                  path: ${{env.CCACHE_DIR}}
+                  key: ccache-msys2-${{matrix.tag}}-${{github.run_id}}
+            - name: Run tests
+              run: |
+                  ctest --test-dir ./build -j $NUMBER_OF_PROCESSORS
+            - name: Upload test logs
+              uses: actions/upload-artifact@v3
+              if: always()
+              with:
+                  name: testlog-msys-${{matrix.tag}}
+                  path: ${{github.workspace}}\build\Testing\Temporary\LastTest.log
+                  retention-days: 7

CHANGELOG.md

@@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [5.4.8.0], 2024-04-10, leisure
+
+### Added
+ - build: add option for sanitizers #2553 (@div72)
+ - build: CMake: Initial Windows support (MSYS2) #2733 (@CyberTailor)
+
+### Changed
+ - build: enforce SSE2 on x86 targets #2746 (@div72)
+ - consensus: Update checkpoint data for mainnet and testnet #2756 (@jamescowens)
+ - gui, util: Enhance verify checkpoints fail handling; use RegistryBookmarks for DB passivation #2758 (@jamescowens)
+
+### Removed
+
+### Fixed
+ - build, depends: fix compilation with XCode 15 #2747 (@div72)
+ - Fix man page installation path for cmake builds #2749 (@theMarix)
+ - consensus, mrc, sidestake: add mrc fees to staker to rewards to be allocated via sidestaking #2753 (@jamescowens)
+ - Fix Systemd unit install location #2754 (@theMarix)
+ - scraper: Corrections to scraper_net after removal of cntPartsRcvd decrement and increment #2755 (@jamescowens)
+ - rpc: fix setban segfault #2757 (@div72)
+
 ## [5.4.7.0], 2024-03-13, leisure
 
 ### Added

CMakeLists.txt

@@ -7,12 +7,31 @@
 # CMake support is experimental. Use with caution and report any bugs.
 
 cmake_minimum_required(VERSION 3.18)
+set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" "${CMAKE_CURRENT_SOURCE_DIR}/build-aux/cmake")
+
+
+# Hunter Package Manager
+# ======================
+
+# Windows doesn't yet have a package manager that can be used for managing
+# dependencies, so we use Hunter on it.
+option(HUNTER_ENABLED "Enable Hunter package manager" OFF)
+include(HunterGate)
+HunterGate(
+    URL "https://github.com/cpp-pm/hunter/archive/refs/tags/v0.25.3.tar.gz"
+    SHA1 "0dfbc2cb5c4cf7e83533733bdfd2125ff96680cb"
+    FILEPATH "${CMAKE_CURRENT_SOURCE_DIR}/build-aux/cmake/Hunter/config.cmake"
+)
+
+
+# Project configuration
+# =====================
 
 project("Gridcoin"
-    VERSION 5.4.7.0
+    VERSION 5.4.8.0
     DESCRIPTION "POS-based cryptocurrency that rewards BOINC computation"
     HOMEPAGE_URL "https://gridcoin.us"
-    LANGUAGES ASM C CXX
+    LANGUAGES C CXX
 )
 
 set(CLIENT_VERSION_IS_RELEASE "true")
@@ -24,33 +43,38 @@ set(COPYRIGHT_HOLDERS_FINAL "The Gridcoin developers")
 # =======================
 
 set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 set(CMAKE_C_VISIBILITY_PRESET hidden)
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
 
-set(CMAKE_MSVC_RUNTIME_LIBRARY MultiThreaded)
-
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 
-# Remove '-DNDEBUG' from flags because we need asserts
-string(REPLACE "NDEBUG" "_NDEBUG" CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}")
-string(REPLACE "NDEBUG" "_NDEBUG" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
-
+if(MSVC)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+        message(FATAL_ERROR "It's not yet possible to build Gridcoin with MSVC")
+    endif()
+    add_compile_options(/U NDEBUG)
+else()
+    add_compile_options(-UNDEBUG)
+endif()
 
-# Load modules from the source tree
-# =================================
 
-set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" "${CMAKE_CURRENT_SOURCE_DIR}/build-aux/cmake")
+# Load CMake modules
+# ==================
 
 include(CheckCXXSymbolExists)
 include(CheckFunctionExists)
 include(CheckIncludeFile)
 include(CheckPIESupported)
+include(CheckSymbolExists)
+
 include(CheckSSE)
 include(CheckStrerrorR)
-include(CheckSymbolExists)
+include(HunterGate)
 include(VersionFromGit)
 
+
 # Define options
 # ==============
 
@@ -60,6 +84,8 @@ option(ENABLE_GUI       "Enable Qt-based GUI" OFF)
 option(ENABLE_DOCS      "Build Doxygen documentation" OFF)
 option(ENABLE_TESTS     "Build tests" OFF)
 option(LUPDATE          "Update translation files" OFF)
+option(STATIC_LIBS      "Prefer static variants of system libraries" ${WIN32})
+option(STATIC_RUNTIME   "Link runtime statically" ${WIN32})
 
 # CPU-dependent options
 option(ENABLE_SSE41     "Build code that uses SSE4.1 intrinsics" ${HAS_SSE41})
@@ -74,30 +100,51 @@ option(ENABLE_QRENCODE  "Enable generation of QR Codes for receiving payments" O
 option(ENABLE_UPNP      "Enable UPnP port mapping support" OFF)
 option(DEFAULT_UPNP     "Turn UPnP on startup" OFF)
 option(USE_DBUS         "Enable DBus support" OFF)
+
+# Bundled packages
 option(SYSTEM_BDB	    "Find system installation of Berkeley DB CXX 5.3" OFF)
 option(SYSTEM_LEVELDB   "Find system installation of leveldb" OFF)
 option(SYSTEM_SECP256K1 "Find system installation of libsecp256k1 with pkg-config" OFF)
 option(SYSTEM_UNIVALUE  "Find system installation of Univalue with pkg-config" OFF)
 option(SYSTEM_XXD       "Find system xxd binary" OFF)
 
+# Hunter packages
+option(BUNDLED_BOOST    "Use the bundled version of Boost" ${HUNTER_ENABLED})
+option(BUNDLED_CURL     "Use the bundled version of cURL" ${HUNTER_ENABLED})
+option(BUNDLED_LIBZIP   "Use the bundled version of libzip" ${HUNTER_ENABLED})
+option(BUNDLED_OPENSSL  "Use the bundled version of OpenSSL" ${HUNTER_ENABLED})
+option(BUNDLED_QT       "Use the bundled version of Qt" ${HUNTER_ENABLED})
 
-# Find dependencies
-# =================
+
+# Handle dependencies
+# ===================
+
+set(QT5_MINIMUM_VERSION 5.9.5)
+set(QT5_COMPONENTS Concurrent Core Gui LinguistTools Network Widgets)
+set(QT5_HUNTER_COMPONENTS qtbase qttools)
+if(USE_DBUS)
+    list(APPEND QT5_COMPONENTS DBus)
+endif()
+if(ENABLE_TESTS)
+    list(APPEND QT5_COMPONENTS Test)
+endif()
 
 set(BOOST_MINIMUM_VERSION 1.63.0)
-set(QT5_MINIMUM_VERSION 5.15.0)
+set(BOOST_COMPONENTS filesystem iostreams thread)
+set(BOOST_HUNTER_COMPONENTS ${BOOST_COMPONENTS})
+if(ENABLE_TESTS)
+    list(APPEND BOOST_COMPONENTS unit_test_framework)
+    list(APPEND BOOST_HUNTER_COMPONENTS test)
+endif()
 
 find_package(Atomics REQUIRED)
-find_package(Boost ${BOOST_MINIMUM_VERSION} COMPONENTS filesystem iostreams thread REQUIRED)
-find_package(CURL COMPONENTS HTTP HTTPS SSL REQUIRED)
-find_package(OpenSSL REQUIRED)
 find_package(Threads REQUIRED)
-find_package(libzip REQUIRED)
 
 if(SYSTEM_BDB)
     find_package(BerkeleyDB 5.3...<5.4 COMPONENTS CXX REQUIRED)
 else()
-    find_program(MAKE_EXE NAMES gmake nmake make)
+    find_program(SH_EXE NAMES sh bash REQUIRED)
+    find_program(MAKE_EXE NAMES gmake nmake make REQUIRED)
 endif()
 
 if(SYSTEM_LEVELDB)
@@ -114,35 +161,59 @@ if(SYSTEM_UNIVALUE)
     pkg_check_modules(UNIVALUE REQUIRED IMPORTED_TARGET libunivalue)
 endif()
 
-if(ENABLE_GUI)
-    find_package(Qt5 ${QT5_MINIMUM_VERSION} REQUIRED COMPONENTS
-        Concurrent
-        Core
-        Gui
-        LinguistTools
-        Network
-        Widgets
-    )
-
-    if(USE_DBUS)
-        find_package(Qt5 ${QT5_MINIMUM_VERSION} COMPONENTS DBus REQUIRED)
-    endif()
+if(BUNDLED_BOOST)
+    hunter_add_package(Boost COMPONENTS ${BOOST_HUNTER_COMPONENTS})
+endif()
+find_package(Boost ${BOOST_MINIMUM_VERSION} COMPONENTS ${BOOST_COMPONENTS} CONFIG REQUIRED)
+
+if(BUNDLED_OPENSSL)
+    hunter_add_package(OpenSSL)
+endif()
+find_package(OpenSSL REQUIRED)
+
+if(BUNDLED_CURL)
+    hunter_add_package(CURL)
+    find_package(CURL CONFIG REQUIRED)
+else()
+    find_package(CURL REQUIRED)
+endif()
+
+if(BUNDLED_LIBZIP)
+    hunter_add_package(libzip)
+endif()
+find_package(libzip CONFIG REQUIRED)
+
+if(USE_ASM)
+    enable_language(ASM)
+endif()
 
-    if(ENABLE_TESTS)
-        find_package(Qt5 ${QT5_MINIMUM_VERSION} COMPONENTS Test REQUIRED)
+if(ENABLE_GUI)
+    if(BUNDLED_QT)
+        hunter_add_package(Qt COMPONENTS ${QT5_HUNTER_COMPONENTS})
     endif()
+    find_package(Qt5 ${QT5_MINIMUM_VERSION} COMPONENTS ${QT5_COMPONENTS} REQUIRED)
 
     if(ENABLE_QRENCODE)
         pkg_check_modules(QRENCODE REQUIRED IMPORTED_TARGET libqrencode)
     endif()
+
+    # Compatibility macros
+    if(Qt5Core_VERSION VERSION_LESS 5.15.0)
+        macro(qt_create_translation)
+            qt5_create_translation(${ARGN})
+        endmacro()
+
+        macro(qt_add_translation)
+            qt5_add_translation(${ARGN})
+        endmacro()
+    endif()
 endif()
 
 if(ENABLE_UPNP)
     pkg_check_modules(MINIUPNPC REQUIRED IMPORTED_TARGET miniupnpc>=1.9)
 endif()
 
 if(ENABLE_TESTS)
-    find_package(Boost ${BOOST_MINIMUM_VERSION} COMPONENTS unit_test_framework REQUIRED)
     enable_testing()
 
     if(SYSTEM_XXD)
@@ -175,12 +246,25 @@ endif()
 set(CMAKE_POSITION_INDEPENDENT_CODE ${ENABLE_PIE})
 
 # Set compiler flags
-if (APPLE)
+if(APPLE)
     add_compile_options(-Wno-error=deprecated-declarations)
     add_compile_options(-Wno-error=thread-safety-analysis)
     add_compile_options(-Wno-error=thread-safety-reference)
 endif()
 
+if(STATIC_LIBS)
+    set(CMAKE_LINK_SEARCH_START_STATIC ON)
+    set(CMAKE_FIND_LIBRARY_SUFFIXES "${CMAKE_STATIC_LIBRARY_SUFFIX}")
+endif()
+
+if(STATIC_RUNTIME)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "^(GNU|Clang)\$")
+        list(APPEND RUNTIME_LIBS -static-libgcc -static-libstdc++)
+    elseif(MSVC)
+        set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+    endif()
+endif()
+
 # Set endianness
 if(CMAKE_CXX_BYTE_ORDER EQUAL BIG_ENDIAN)
     set(WORDS_BIGENDIAN 1)