fix: Start without cache file (#2976)

#2830 introduced a bug that clio couldn't start without having a cache
file. This PR fixes the problem.

.clang-format

@@ -22,7 +22,7 @@ BreakBeforeBinaryOperators: false
 BreakBeforeBraces: WebKit
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializersBeforeComma: true
-ColumnLimit: 120
+ColumnLimit: 100
 CommentPragmas: "^ IWYU pragma:"
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
 ConstructorInitializerIndentWidth: 4

.cmake-format.yaml

@@ -1,245 +0,0 @@
-_help_parse: Options affecting listfile parsing
-parse:
-  _help_additional_commands:
-    - Specify structure for custom cmake functions
-  additional_commands:
-    foo:
-      flags:
-        - BAR
-        - BAZ
-      kwargs:
-        HEADERS: "*"
-        SOURCES: "*"
-        DEPENDS: "*"
-  _help_override_spec:
-    - Override configurations per-command where available
-  override_spec: {}
-  _help_vartags:
-    - Specify variable tags.
-  vartags: []
-  _help_proptags:
-    - Specify property tags.
-  proptags: []
-_help_format: Options affecting formatting.
-format:
-  _help_disable:
-    - Disable formatting entirely, making cmake-format a no-op
-  disable: false
-  _help_line_width:
-    - How wide to allow formatted cmake files
-  line_width: 120
-  _help_tab_size:
-    - How many spaces to tab for indent
-  tab_size: 2
-  _help_use_tabchars:
-    - If true, lines are indented using tab characters (utf-8
-    - 0x09) instead of <tab_size> space characters (utf-8 0x20).
-    - In cases where the layout would require a fractional tab
-    - character, the behavior of the  fractional indentation is
-    - governed by <fractional_tab_policy>
-  use_tabchars: false
-  _help_fractional_tab_policy:
-    - If <use_tabchars> is True, then the value of this variable
-    - indicates how fractional indentions are handled during
-    - whitespace replacement. If set to 'use-space', fractional
-    - indentation is left as spaces (utf-8 0x20). If set to
-    - "`round-up` fractional indentation is replaced with a single"
-    - tab character (utf-8 0x09) effectively shifting the column
-    - to the next tabstop
-  fractional_tab_policy: use-space
-  _help_max_subgroups_hwrap:
-    - If an argument group contains more than this many sub-groups
-    - (parg or kwarg groups) then force it to a vertical layout.
-  max_subgroups_hwrap: 4
-  _help_max_pargs_hwrap:
-    - If a positional argument group contains more than this many
-    - arguments, then force it to a vertical layout.
-  max_pargs_hwrap: 5
-  _help_max_rows_cmdline:
-    - If a cmdline positional group consumes more than this many
-    - lines without nesting, then invalidate the layout (and nest)
-  max_rows_cmdline: 2
-  _help_separate_ctrl_name_with_space:
-    - If true, separate flow control names from their parentheses
-    - with a space
-  separate_ctrl_name_with_space: true
-  _help_separate_fn_name_with_space:
-    - If true, separate function names from parentheses with a
-    - space
-  separate_fn_name_with_space: false
-  _help_dangle_parens:
-    - If a statement is wrapped to more than one line, than dangle
-    - the closing parenthesis on its own line.
-  dangle_parens: true
-  _help_dangle_align:
-    - If the trailing parenthesis must be 'dangled' on its on
-    - "line, then align it to this reference: `prefix`: the start"
-    - "of the statement,  `prefix-indent`: the start of the"
-    - "statement, plus one indentation  level, `child`: align to"
-    - the column of the arguments
-  dangle_align: prefix
-  _help_min_prefix_chars:
-    - If the statement spelling length (including space and
-    - parenthesis) is smaller than this amount, then force reject
-    - nested layouts.
-  min_prefix_chars: 4
-  _help_max_prefix_chars:
-    - If the statement spelling length (including space and
-    - parenthesis) is larger than the tab width by more than this
-    - amount, then force reject un-nested layouts.
-  max_prefix_chars: 10
-  _help_max_lines_hwrap:
-    - If a candidate layout is wrapped horizontally but it exceeds
-    - this many lines, then reject the layout.
-  max_lines_hwrap: 2
-  _help_line_ending:
-    - What style line endings to use in the output.
-  line_ending: unix
-  _help_command_case:
-    - Format command names consistently as 'lower' or 'upper' case
-  command_case: canonical
-  _help_keyword_case:
-    - Format keywords consistently as 'lower' or 'upper' case
-  keyword_case: unchanged
-  _help_always_wrap:
-    - A list of command names which should always be wrapped
-  always_wrap: []
-  _help_enable_sort:
-    - If true, the argument lists which are known to be sortable
-    - will be sorted lexicographicall
-  enable_sort: true
-  _help_autosort:
-    - If true, the parsers may infer whether or not an argument
-    - list is sortable (without annotation).
-  autosort: true
-  _help_require_valid_layout:
-    - By default, if cmake-format cannot successfully fit
-    - everything into the desired linewidth it will apply the
-    - last, most aggressive attempt that it made. If this flag is
-    - True, however, cmake-format will print error, exit with non-
-    - zero status code, and write-out nothing
-  require_valid_layout: false
-  _help_layout_passes:
-    - A dictionary mapping layout nodes to a list of wrap
-    - decisions. See the documentation for more information.
-  layout_passes: {}
-_help_markup: Options affecting comment reflow and formatting.
-markup:
-  _help_bullet_char:
-    - What character to use for bulleted lists
-  bullet_char: "*"
-  _help_enum_char:
-    - What character to use as punctuation after numerals in an
-    - enumerated list
-  enum_char: .
-  _help_first_comment_is_literal:
-    - If comment markup is enabled, don't reflow the first comment
-    - block in each listfile. Use this to preserve formatting of
-    - your copyright/license statements.
-  first_comment_is_literal: false
-  _help_literal_comment_pattern:
-    - If comment markup is enabled, don't reflow any comment block
-    - which matches this (regex) pattern. Default is `None`
-    - (disabled).
-  literal_comment_pattern: null
-  _help_fence_pattern:
-    - Regular expression to match preformat fences in comments
-    - default= ``r'^\s*([`~]{3}[`~]*)(.*)$'``
-  fence_pattern: ^\s*([`~]{3}[`~]*)(.*)$
-  _help_ruler_pattern:
-    - Regular expression to match rulers in comments default=
-    - '``r''^\s*[^\w\s]{3}.*[^\w\s]{3}$''``'
-  ruler_pattern: ^\s*[^\w\s]{3}.*[^\w\s]{3}$
-  _help_explicit_trailing_pattern:
-    - If a comment line matches starts with this pattern then it
-    - is explicitly a trailing comment for the preceding
-    - argument. Default is '#<'
-  explicit_trailing_pattern: "#<"
-  _help_hashruler_min_length:
-    - If a comment line starts with at least this many consecutive
-    - hash characters, then don't lstrip() them off. This allows
-    - for lazy hash rulers where the first hash char is not
-    - separated by space
-  hashruler_min_length: 10
-  _help_canonicalize_hashrulers:
-    - If true, then insert a space between the first hash char and
-    - remaining hash chars in a hash ruler, and normalize its
-    - length to fill the column
-  canonicalize_hashrulers: true
-  _help_enable_markup:
-    - enable comment markup parsing and reflow
-  enable_markup: true
-_help_lint: Options affecting the linter
-lint:
-  _help_disabled_codes:
-    - a list of lint codes to disable
-  disabled_codes: []
-  _help_function_pattern:
-    - regular expression pattern describing valid function names
-  function_pattern: "[0-9a-z_]+"
-  _help_macro_pattern:
-    - regular expression pattern describing valid macro names
-  macro_pattern: "[0-9A-Z_]+"
-  _help_global_var_pattern:
-    - regular expression pattern describing valid names for
-    - variables with global (cache) scope
-  global_var_pattern: "[A-Z][0-9A-Z_]+"
-  _help_internal_var_pattern:
-    - regular expression pattern describing valid names for
-    - variables with global scope (but internal semantic)
-  internal_var_pattern: _[A-Z][0-9A-Z_]+
-  _help_local_var_pattern:
-    - regular expression pattern describing valid names for
-    - variables with local scope
-  local_var_pattern: "[a-z][a-z0-9_]+"
-  _help_private_var_pattern:
-    - regular expression pattern describing valid names for
-    - privatedirectory variables
-  private_var_pattern: _[0-9a-z_]+
-  _help_public_var_pattern:
-    - regular expression pattern describing valid names for public
-    - directory variables
-  public_var_pattern: "[A-Z][0-9A-Z_]+"
-  _help_argument_var_pattern:
-    - regular expression pattern describing valid names for
-    - function/macro arguments and loop variables.
-  argument_var_pattern: "[a-z][a-z0-9_]+"
-  _help_keyword_pattern:
-    - regular expression pattern describing valid names for
-    - keywords used in functions or macros
-  keyword_pattern: "[A-Z][0-9A-Z_]+"
-  _help_max_conditionals_custom_parser:
-    - In the heuristic for C0201, how many conditionals to match
-    - within a loop in before considering the loop a parser.
-  max_conditionals_custom_parser: 2
-  _help_min_statement_spacing:
-    - Require at least this many newlines between statements
-  min_statement_spacing: 1
-  _help_max_statement_spacing:
-    - Require no more than this many newlines between statements
-  max_statement_spacing: 2
-  max_returns: 6
-  max_branches: 12
-  max_arguments: 5
-  max_localvars: 15
-  max_statements: 50
-_help_encode: Options affecting file encoding
-encode:
-  _help_emit_byteorder_mark:
-    - If true, emit the unicode byte-order mark (BOM) at the start
-    - of the file
-  emit_byteorder_mark: false
-  _help_input_encoding:
-    - Specify the encoding of the input file. Defaults to utf-8
-  input_encoding: utf-8
-  _help_output_encoding:
-    - Specify the encoding of the output file. Defaults to utf-8.
-    - Note that cmake only claims to support utf-8 so be careful
-    - when using anything else
-  output_encoding: utf-8
-_help_misc: Miscellaneous configurations options.
-misc:
-  _help_per_command:
-    - A dictionary containing any per-command configuration
-    - overrides. Currently only `command_case` is supported.
-  per_command: {}

.gersemi/definitions.cmake

@@ -0,0 +1,19 @@
+# Custom CMake command definitions for gersemi formatting.
+# These stubs teach gersemi the signatures of project-specific commands
+# so it can format their invocations correctly.
+
+function(setup_target_for_coverage_gcovr)
+    set(options NONE)
+    set(oneValueArgs BASE_DIRECTORY NAME FORMAT)
+    set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
+    cmake_parse_arguments(
+        THIS_FUNCTION_PREFIX
+        "${options}"
+        "${oneValueArgs}"
+        "${multiValueArgs}"
+        ${ARGN}
+    )
+endfunction()
+
+function(append_coverage_compiler_flags_to_target name mode)
+endfunction()

.gersemirc

@@ -0,0 +1 @@
+definitions: [.gersemi]

.github/actions/build-clio/action.yml

@@ -14,7 +14,7 @@ runs:
   using: composite
   steps:
     - name: Get number of processors
-      uses: XRPLF/actions/.github/actions/get-nproc@046b1620f6bfd6cd0985dc82c3df02786801fe0a
+      uses: XRPLF/actions/get-nproc@cf0433aa74563aead044a1e395610c96d65a37cf
       id: nproc
       with:
         subtract: ${{ inputs.nproc_subtract }}

.github/actions/build-docker-image/action.yml

@@ -34,14 +34,14 @@ runs:
   steps:
     - name: Login to DockerHub
       if: ${{ inputs.push_image == 'true' && inputs.dockerhub_repo != '' }}
-      uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+      uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
       with:
         username: ${{ env.DOCKERHUB_USER }}
         password: ${{ env.DOCKERHUB_PW }}
 
     - name: Login to GitHub Container Registry
       if: ${{ inputs.push_image == 'true' }}
-      uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+      uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
       with:
         registry: ghcr.io
         username: ${{ github.repository_owner }}
@@ -50,9 +50,9 @@ runs:
     - uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0
       with:
         cache-image: false
-    - uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
+    - uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
 
-    - uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # v5.9.0
+    - uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0
       id: meta
       with:
         images: ${{ inputs.images }}

.github/actions/cmake/action.yml

@@ -37,6 +37,10 @@ inputs:
     description: Whether to generate Debian package
     required: true
     default: "false"
+  version:
+    description: Version of the clio_server binary
+    required: false
+    default: ""
 
 runs:
   using: composite
@@ -57,6 +61,19 @@ runs:
         STATIC: "${{ inputs.static == 'true' && 'ON' || 'OFF' }}"
         TIME_TRACE: "${{ inputs.time_trace == 'true' && 'ON' || 'OFF' }}"
         PACKAGE: "${{ inputs.package == 'true' && 'ON' || 'OFF' }}"
+        # GitHub creates a merge commit for a PR
+        # https://www.kenmuse.com/blog/the-many-shas-of-a-github-pull-request/
+        #
+        # We:
+        # - explicitly provide branch name
+        # - use `github.head_ref` to get the SHA of last commit in the PR branch
+        #
+        # This way it works both for PRs and pushes to branches.
+        GITHUB_BRANCH_NAME: "${{ github.head_ref || github.ref_name }}"
+        GITHUB_HEAD_SHA: "${{ github.event.pull_request.head.sha || github.sha }}"
+        #
+        # If tag is being pushed, or it's a nightly release, we use that version.
+        FORCE_CLIO_VERSION: ${{ inputs.version }}
       run: |
         cmake \
           -B "${BUILD_DIR}" \

.github/actions/code-coverage/action.yml

@@ -24,7 +24,7 @@ runs:
           -j8 --exclude-throw-branches
 
     - name: Archive coverage report
-      uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+      uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
       with:
         name: coverage-report.xml
         path: build/coverage_report.xml

.github/actions/conan/action.yml

@@ -21,10 +21,6 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Create build directory
-      shell: bash
-      run: mkdir -p "${{ inputs.build_dir }}"
-
     - name: Run conan
       shell: bash
       env:

.github/scripts/conan/generate_matrix.py

@@ -4,7 +4,7 @@ import json
 
 LINUX_OS = ["heavy", "heavy-arm64"]
 LINUX_CONTAINERS = [
-    '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+    '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
 ]
 LINUX_COMPILERS = ["gcc", "clang"]
 

.github/scripts/conan/init.sh

@@ -40,9 +40,9 @@ mkdir -p "$PROFILES_DIR"
 
 if [[ "$(uname)" == "Darwin" ]]; then
     create_profile_with_sanitizers "apple-clang" "$APPLE_CLANG_PROFILE"
-    echo "include(apple-clang)" > "$PROFILES_DIR/default"
+    echo "include(apple-clang)" >"$PROFILES_DIR/default"
 else
     create_profile_with_sanitizers "clang" "$CLANG_PROFILE"
     create_profile_with_sanitizers "gcc" "$GCC_PROFILE"
-    echo "include(gcc)" > "$PROFILES_DIR/default"
+    echo "include(gcc)" >"$PROFILES_DIR/default"
 fi

.github/scripts/conan/regenerate_lockfile.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+set -ex
+
+TEMP_DIR=$(mktemp -d)
+trap "rm -rf $TEMP_DIR" EXIT
+
+echo "Using temporary CONAN_HOME: $TEMP_DIR"
+
+# We use a temporary Conan home to avoid polluting the user's existing Conan
+# configuration and to not use local cache (which leads to non-reproducible lockfiles).
+export CONAN_HOME="$TEMP_DIR"
+
+# Ensure that the xrplf remote is the first to be consulted, so any recipes we
+# patched are used. We also add it there to not created huge diff when the
+# official Conan Center Index is updated.
+conan remote add --force --index 0 xrplf https://conan.ripplex.io
+
+# Delete any existing lockfile.
+rm -f conan.lock
+
+# Create a new lockfile that is compatible with macOS.
+# It should also work on Linux.
+conan lock create . \
+    --profile:all=.github/scripts/conan/apple-clang-17.profile

.github/scripts/execute-tests-under-sanitizer.sh

@@ -1,46 +0,0 @@
-#!/bin/bash
-
-set -o pipefail
-
-# Note: This script is intended to be run from the root of the repository.
-#
-# This script runs each unit-test separately and generates reports from the currently active sanitizer.
-# Output is saved in ./.sanitizer-report in the root of the repository
-
-if [[ -z "$1" ]]; then
-    cat <<EOF
-
-                                    ERROR
------------------------------------------------------------------------------
-     Path to clio_tests should be passed as first argument to the script.
------------------------------------------------------------------------------
-
-EOF
-    exit 1
-fi
-
-TEST_BINARY=$1
-
-if [[ ! -f "$TEST_BINARY" ]]; then
-  echo "Test binary not found: $TEST_BINARY"
-  exit 1
-fi
-
-TESTS=$($TEST_BINARY --gtest_list_tests | awk '/^  / {print suite $1} !/^  / {suite=$1}')
-
-OUTPUT_DIR="./.sanitizer-report"
-mkdir -p "$OUTPUT_DIR"
-
-export TSAN_OPTIONS="die_after_fork=0"
-export MallocNanoZone='0' # for MacOSX
-
-for TEST in $TESTS; do
-  OUTPUT_FILE="$OUTPUT_DIR/${TEST//\//_}.log"
-  $TEST_BINARY --gtest_filter="$TEST" > "$OUTPUT_FILE" 2>&1
-
-  if [ $? -ne 0 ]; then
-    echo "'$TEST' failed a sanitizer check."
-  else
-    rm "$OUTPUT_FILE"
-  fi
-done

.github/scripts/prepare-release-artifacts.sh

@@ -20,5 +20,5 @@ for artifact_name in $(ls); do
     rm "${artifact_name}/${BINARY_NAME}"
     rm -r "${artifact_name}"
 
-    sha256sum "./${artifact_name}.zip" > "./${artifact_name}.zip.sha256sum"
+    sha256sum "./${artifact_name}.zip" >"./${artifact_name}.zip.sha256sum"
 done

.github/workflows/build-clio-docker-image.yml

@@ -48,11 +48,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Download Clio binary from artifact
         if: ${{ inputs.artifact_name != null }}
-        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+        uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           name: ${{ inputs.artifact_name }}
           path: ./docker/clio/artifact/

.github/workflows/build.yml

@@ -23,6 +23,7 @@ on:
       - "cmake/**"
       - "src/**"
       - "tests/**"
+      - "benchmarks/**"
 
       - docs/config-description.md
   workflow_dispatch:
@@ -49,7 +50,7 @@ jobs:
         build_type: [Release, Debug]
         container:
           [
-            '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }',
+            '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }',
           ]
         static: [true]
 
@@ -79,7 +80,7 @@ jobs:
     uses: ./.github/workflows/reusable-build.yml
     with:
       runs_on: heavy
-      container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+      container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
       conan_profile: gcc
       build_type: Debug
       download_ccache: true
@@ -92,35 +93,17 @@ jobs:
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-  package:
-    name: Build packages
-
-    uses: ./.github/workflows/reusable-build.yml
-    with:
-      runs_on: heavy
-      container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
-      conan_profile: gcc
-      build_type: Release
-      download_ccache: true
-      upload_ccache: false
-      code_coverage: false
-      static: true
-      upload_clio_server: false
-      package: true
-      targets: package
-      analyze_build_time: false
-
   check_config:
     name: Check Config Description
     needs: build-and-test
     runs-on: heavy
     container:
-      image: ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+      image: ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
-      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           name: clio_server_Linux_Release_gcc
 

.github/workflows/check-libxrpl.yml

@@ -21,17 +21,17 @@ jobs:
     name: Build Clio / `libXRPL ${{ github.event.client_payload.version }}`
     runs-on: heavy
     container:
-      image: ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+      image: ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
       - name: Prepare runner
-        uses: XRPLF/actions/.github/actions/prepare-runner@8abb0722cbff83a9a2dc7d06c473f7a4964b7382
+        uses: XRPLF/actions/prepare-runner@2cbf481018d930656e9276fcc20dc0e3a0be5b6d
         with:
-          disable_ccache: true
+          enable_ccache: false
 
       - name: Update libXRPL version requirement
         run: |
@@ -59,7 +59,7 @@ jobs:
         run: strip build/clio_tests
 
       - name: Upload clio_tests
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: clio_tests_check_libxrpl
           path: build/clio_tests
@@ -69,10 +69,10 @@ jobs:
     needs: build
     runs-on: heavy
     container:
-      image: ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+      image: ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
 
     steps:
-      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           name: clio_tests_check_libxrpl
 
@@ -92,7 +92,7 @@ jobs:
       issues: write
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Create an issue
         uses: ./.github/actions/create-issue

.github/workflows/check-pr-title.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: ytanikin/pr-conventional-commits@b72758283dcbee706975950e96bc4bf323a8d8c0 # 1.4.2
+      - uses: ytanikin/pr-conventional-commits@fda730cb152c05a849d6d84325e50c6182d9d1e9 # 1.5.1
         with:
           task_types: '["build","feat","fix","docs","test","ci","style","refactor","perf","chore"]'
           add_label: false

.github/workflows/clang-tidy.yml

@@ -31,7 +31,7 @@ jobs:
     if: github.event_name != 'push' || contains(github.event.head_commit.message, 'clang-tidy auto fixes')
     runs-on: heavy
     container:
-      image: ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+      image: ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
 
     permissions:
       contents: write
@@ -39,14 +39,14 @@ jobs:
       pull-requests: write
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
       - name: Prepare runner
-        uses: XRPLF/actions/.github/actions/prepare-runner@8abb0722cbff83a9a2dc7d06c473f7a4964b7382
+        uses: XRPLF/actions/prepare-runner@2cbf481018d930656e9276fcc20dc0e3a0be5b6d
         with:
-          disable_ccache: true
+          enable_ccache: false
 
       - name: Run conan
         uses: ./.github/actions/conan
@@ -59,30 +59,33 @@ jobs:
           conan_profile: ${{ env.CONAN_PROFILE }}
 
       - name: Get number of processors
-        uses: XRPLF/actions/.github/actions/get-nproc@046b1620f6bfd6cd0985dc82c3df02786801fe0a
+        uses: XRPLF/actions/get-nproc@cf0433aa74563aead044a1e395610c96d65a37cf
         id: nproc
 
-      - name: Run clang-tidy
+      - name: Run clang-tidy (several times)
         continue-on-error: true
-        id: run_clang_tidy
+        id: clang_tidy
         run: |
-          run-clang-tidy-${{ env.LLVM_TOOLS_VERSION }} -p build -j "${{ steps.nproc.outputs.nproc }}" -fix -quiet 1>output.txt
+          # We run clang-tidy several times, because some fixes may enable new fixes in subsequent runs.
+          CLANG_TIDY_COMMAND="run-clang-tidy-${{ env.LLVM_TOOLS_VERSION }} -p build -j ${{ steps.nproc.outputs.nproc }} -fix -quiet"
+          ${CLANG_TIDY_COMMAND} ||
+          ${CLANG_TIDY_COMMAND} ||
+          ${CLANG_TIDY_COMMAND}
+
+      - name: Check for changes
+        id: files_changed
+        continue-on-error: true
+        run: |
+          git diff --exit-code
 
       - name: Fix local includes and clang-format style
-        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
+        if: ${{ steps.files_changed.outcome != 'success' }}
         run: |
           pre-commit run --all-files fix-local-includes || true
           pre-commit run --all-files clang-format || true
 
-      - name: Print issues found
-        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
-        run: |
-          sed -i '/error\||/!d' ./output.txt
-          cat output.txt
-          rm output.txt
-
       - name: Create an issue
-        if: ${{ steps.run_clang_tidy.outcome != 'success' && github.event_name != 'pull_request' }}
+        if: ${{ (steps.clang_tidy.outcome != 'success' || steps.files_changed.outcome != 'success') && github.event_name != 'pull_request' }}
         id: create_issue
         uses: ./.github/actions/create-issue
         env:
@@ -95,7 +98,7 @@ jobs:
             List of the issues found: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/
 
       - uses: crazy-max/ghaction-import-gpg@e89d40939c28e39f97cf32126055eeae86ba74ec # v6.3.0
-        if: ${{ steps.run_clang_tidy.outcome != 'success' && github.event_name != 'pull_request' }}
+        if: ${{ steps.files_changed.outcome != 'success' && github.event_name != 'pull_request' }}
         with:
           gpg_private_key: ${{ secrets.ACTIONS_GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.ACTIONS_GPG_PASSPHRASE }}
@@ -103,8 +106,8 @@ jobs:
           git_commit_gpgsign: true
 
       - name: Create PR with fixes
-        if: ${{ steps.run_clang_tidy.outcome != 'success' && github.event_name != 'pull_request' }}
-        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
+        if: ${{ steps.files_changed.outcome != 'success' && github.event_name != 'pull_request' }}
+        uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
         env:
           GH_REPO: ${{ github.repository }}
           GH_TOKEN: ${{ github.token }}
@@ -119,5 +122,5 @@ jobs:
           reviewers: "godexsoft,kuznetsss,PeterChen13579,mathbunnyru"
 
       - name: Fail the job
-        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
+        if: ${{ steps.clang_tidy.outcome != 'success' || steps.files_changed.outcome != 'success' }}
         run: exit 1

.github/workflows/docs.yml

@@ -18,18 +18,18 @@ jobs:
   build:
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+      image: ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
 
     steps:
       - name: Checkout
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           lfs: true
 
       - name: Prepare runner
-        uses: XRPLF/actions/.github/actions/prepare-runner@8abb0722cbff83a9a2dc7d06c473f7a4964b7382
+        uses: XRPLF/actions/prepare-runner@2cbf481018d930656e9276fcc20dc0e3a0be5b6d
         with:
-          disable_ccache: true
+          enable_ccache: false
 
       - name: Create build directory
         run: mkdir build_docs

.github/workflows/nightly.yml

@@ -28,8 +28,20 @@ defaults:
     shell: bash
 
 jobs:
+  get_date:
+    name: Get Date
+    runs-on: ubuntu-latest
+    outputs:
+      date: ${{ steps.get_date.outputs.date }}
+    steps:
+      - name: Get current date
+        id: get_date
+        run: |
+          echo "date=$(date +'%Y%m%d')" >> $GITHUB_OUTPUT
+
   build-and-test:
     name: Build and Test
+    needs: get_date
 
     strategy:
       fail-fast: false
@@ -43,17 +55,17 @@ jobs:
             conan_profile: gcc
             build_type: Release
             static: true
-            container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+            container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
           - os: heavy
             conan_profile: gcc
             build_type: Debug
             static: true
-            container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+            container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
           - os: heavy
             conan_profile: gcc.ubsan
             build_type: Release
             static: false
-            container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+            container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
 
     uses: ./.github/workflows/reusable-build-test.yml
     with:
@@ -67,9 +79,31 @@ jobs:
       upload_clio_server: true
       download_ccache: false
       upload_ccache: false
+      version: nightly-${{ needs.get_date.outputs.date }}
+
+  package:
+    name: Build debian package
+    needs: get_date
+
+    uses: ./.github/workflows/reusable-build.yml
+    with:
+      runs_on: heavy
+      container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
+      conan_profile: gcc
+      build_type: Release
+      download_ccache: false
+      upload_ccache: false
+      code_coverage: false
+      static: true
+      upload_clio_server: false
+      package: true
+      version: nightly-${{ needs.get_date.outputs.date }}
+      targets: package
+      analyze_build_time: false
 
   analyze_build_time:
     name: Analyze Build Time
+    needs: get_date
 
     strategy:
       fail-fast: false
@@ -77,7 +111,7 @@ jobs:
         include:
           - os: heavy
             conan_profile: clang
-            container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+            container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
             static: true
           - os: macos15
             conan_profile: apple-clang
@@ -96,20 +130,10 @@ jobs:
       upload_clio_server: false
       targets: all
       analyze_build_time: true
-
-  get_date:
-    name: Get Date
-    runs-on: ubuntu-latest
-    outputs:
-      date: ${{ steps.get_date.outputs.date }}
-    steps:
-      - name: Get current date
-        id: get_date
-        run: |
-          echo "date=$(date +'%Y%m%d')" >> $GITHUB_OUTPUT
+      version: nightly-${{ needs.get_date.outputs.date }}
 
   nightly_release:
-    needs: [build-and-test, get_date]
+    needs: [build-and-test, package, get_date]
     uses: ./.github/workflows/reusable-release.yml
     with:
       delete_pattern: "nightly-*"
@@ -145,7 +169,7 @@ jobs:
       issues: write
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Create an issue
         uses: ./.github/actions/create-issue

.github/workflows/pre-commit-autoupdate.yml

@@ -12,7 +12,7 @@ on:
 
 jobs:
   auto-update:
-    uses: XRPLF/actions/.github/workflows/pre-commit-autoupdate.yml@afbcbdafbe0ce5439492fb87eda6441371086386
+    uses: XRPLF/actions/.github/workflows/pre-commit-autoupdate.yml@8b19d3462e52cd8ea4d76b4c8d0f7533e7469c15
     with:
       sign_commit: true
       committer: "Clio CI <skuznetsov@ripple.com>"

.github/workflows/pre-commit.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   run-hooks:
-    uses: XRPLF/actions/.github/workflows/pre-commit.yml@34790936fae4c6c751f62ec8c06696f9c1a5753a
+    uses: XRPLF/actions/.github/workflows/pre-commit.yml@56de1bdf19639e009639a50b8d17c28ca954f267
     with:
       runs_on: heavy
-      container: '{ "image": "ghcr.io/xrplf/clio-pre-commit:c117f470f2ef954520ab5d1c8a5ed2b9e68d6f8a" }'
+      container: '{ "image": "ghcr.io/xrplf/clio-pre-commit:14342e087ceb8b593027198bf9ef06a43833c696" }'

.github/workflows/release.yml

@@ -29,7 +29,7 @@ jobs:
             conan_profile: gcc
             build_type: Release
             static: true
-            container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+            container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
 
     uses: ./.github/workflows/reusable-build-test.yml
     with:
@@ -43,10 +43,29 @@ jobs:
       upload_clio_server: true
       download_ccache: false
       upload_ccache: false
-      expected_version: ${{ github.event_name == 'push' && github.ref_name || '' }}
+      version: ${{ github.event_name == 'push' && github.ref_name || '' }}
+
+  package:
+    name: Build debian package
+
+    uses: ./.github/workflows/reusable-build.yml
+    with:
+      runs_on: heavy
+      container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
+      conan_profile: gcc
+      build_type: Release
+      download_ccache: false
+      upload_ccache: false
+      code_coverage: false
+      static: true
+      upload_clio_server: false
+      package: true
+      version: ${{ github.event_name == 'push' && github.ref_name || '' }}
+      targets: package
+      analyze_build_time: false
 
   release:
-    needs: build-and-test
+    needs: [build-and-test, package]
     uses: ./.github/workflows/reusable-release.yml
     with:
       delete_pattern: ""

.github/workflows/reusable-build-test.yml

@@ -63,18 +63,18 @@ on:
         type: string
         default: all
 
-      expected_version:
-        description: Expected version of the clio_server binary
-        required: false
-        type: string
-        default: ""
-
       package:
         description: Whether to generate Debian package
         required: false
         type: boolean
         default: false
 
+      version:
+        description: Version of the clio_server binary
+        required: false
+        type: string
+        default: ""
+
 jobs:
   build:
     uses: ./.github/workflows/reusable-build.yml
@@ -90,8 +90,8 @@ jobs:
       upload_clio_server: ${{ inputs.upload_clio_server }}
       targets: ${{ inputs.targets }}
       analyze_build_time: false
-      expected_version: ${{ inputs.expected_version }}
       package: ${{ inputs.package }}
+      version: ${{ inputs.version }}
 
   test:
     needs: build

.github/workflows/reusable-build.yml

@@ -60,17 +60,17 @@ on:
         required: true
         type: boolean
 
-      expected_version:
-        description: Expected version of the clio_server binary
-        required: false
-        type: string
-        default: ""
-
       package:
         description: Whether to generate Debian package
         required: false
         type: boolean
 
+      version:
+        description: Version of the clio_server binary
+        required: false
+        type: string
+        default: ""
+
     secrets:
       CODECOV_TOKEN:
         required: false
@@ -88,20 +88,16 @@ jobs:
     steps:
       - name: Cleanup workspace
         if: ${{ runner.os == 'macOS' }}
-        uses: XRPLF/actions/.github/actions/cleanup-workspace@ea9970b7c211b18f4c8bcdb28c29f5711752029f
+        uses: XRPLF/actions/cleanup-workspace@c7d9ce5ebb03c752a354889ecd870cadfc2b1cd4
 
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
-          # We need to fetch tags to have correct version in the release
-          # The workaround is based on https://github.com/actions/checkout/issues/1467
-          fetch-tags: true
-          ref: ${{ github.ref }}
 
       - name: Prepare runner
-        uses: XRPLF/actions/.github/actions/prepare-runner@8abb0722cbff83a9a2dc7d06c473f7a4964b7382
+        uses: XRPLF/actions/prepare-runner@2cbf481018d930656e9276fcc20dc0e3a0be5b6d
         with:
-          disable_ccache: ${{ !inputs.download_ccache }}
+          enable_ccache: ${{ inputs.download_ccache }}
 
       - name: Setup conan on macOS
         if: ${{ runner.os == 'macOS' }}
@@ -117,7 +113,7 @@ jobs:
 
       - name: Restore ccache cache
         if: ${{ inputs.download_ccache && github.ref != 'refs/heads/develop' }}
-        uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+        uses: actions/cache/restore@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
         with:
           path: ${{ env.CCACHE_DIR }}
           key: ${{ steps.cache_key.outputs.key }}
@@ -139,6 +135,7 @@ jobs:
           static: ${{ inputs.static }}
           time_trace: ${{ inputs.analyze_build_time }}
           package: ${{ inputs.package }}
+          version: ${{ inputs.version }}
 
       - name: Build Clio
         uses: ./.github/actions/build-clio
@@ -154,7 +151,7 @@ jobs:
 
       - name: Upload build time analyze report
         if: ${{ inputs.analyze_build_time }}
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: build_time_report_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
           path: build_time_report.txt
@@ -162,12 +159,12 @@ jobs:
       - name: Show ccache's statistics and zero it
         if: ${{ inputs.download_ccache }}
         run: |
-          ccache --show-stats
+          ccache --show-stats -vv
           ccache --zero-stats
 
       - name: Save ccache cache
         if: ${{ inputs.upload_ccache && github.ref == 'refs/heads/develop' }}
-        uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+        uses: actions/cache/save@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
         with:
           path: ${{ env.CCACHE_DIR }}
           key: ${{ steps.cache_key.outputs.key }}
@@ -182,28 +179,28 @@ jobs:
 
       - name: Upload clio_server
         if: ${{ inputs.upload_clio_server && !inputs.code_coverage && !inputs.analyze_build_time }}
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: clio_server_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
           path: build/clio_server
 
       - name: Upload clio_tests
         if: ${{ !inputs.code_coverage && !inputs.analyze_build_time && !inputs.package }}
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: clio_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
           path: build/clio_tests
 
       - name: Upload clio_integration_tests
         if: ${{ !inputs.code_coverage && !inputs.analyze_build_time && !inputs.package }}
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: clio_integration_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
           path: build/clio_integration_tests
 
       - name: Upload Clio Linux package
         if: ${{ inputs.package }}
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: clio_deb_package_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
           path: build/*.deb
@@ -218,15 +215,20 @@ jobs:
         if: ${{ inputs.code_coverage }}
         uses: ./.github/actions/code-coverage
 
-      - name: Verify expected version
-        if: ${{ inputs.expected_version != '' }}
+      - name: Verify version is expected
+        if: ${{ inputs.version != '' }}
         env:
-          INPUT_EXPECTED_VERSION: ${{ inputs.expected_version }}
+          INPUT_VERSION: ${{ inputs.version }}
+          BUILD_TYPE: ${{ inputs.build_type }}
         run: |
           set -e
-          EXPECTED_VERSION="clio-${INPUT_EXPECTED_VERSION}"
-          actual_version=$(./build/clio_server --version)
-          if [[ "$actual_version" != "$EXPECTED_VERSION" ]]; then
+          EXPECTED_VERSION="clio-${INPUT_VERSION}"
+          if [[ "${BUILD_TYPE}" == "Debug" ]]; then
+            EXPECTED_VERSION="${EXPECTED_VERSION}+DEBUG"
+          fi
+
+          actual_version=$(./build/clio_server --version | head -n 1)
+          if [[ "${actual_version}" != "${EXPECTED_VERSION}" ]]; then
             echo "Expected version '${EXPECTED_VERSION}', but got '${actual_version}'"
             exit 1
           fi

.github/workflows/reusable-release.yml

@@ -46,7 +46,7 @@ jobs:
   release:
     runs-on: heavy
     container:
-      image: ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+      image: ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
     env:
       GH_REPO: ${{ github.repository }}
       GH_TOKEN: ${{ github.token }}
@@ -55,20 +55,28 @@ jobs:
       contents: write
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
       - name: Prepare runner
-        uses: XRPLF/actions/.github/actions/prepare-runner@8abb0722cbff83a9a2dc7d06c473f7a4964b7382
+        uses: XRPLF/actions/prepare-runner@2cbf481018d930656e9276fcc20dc0e3a0be5b6d
         with:
-          disable_ccache: true
+          enable_ccache: false
 
-      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           path: release_artifacts
           pattern: clio_server_*
 
+      - name: Prepare release artifacts
+        run: .github/scripts/prepare-release-artifacts.sh release_artifacts
+
+      - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
+        with:
+          path: release_artifacts
+          pattern: clio_deb_package_*
+
       - name: Create release notes
         env:
           RELEASE_HEADER: ${{ inputs.header }}
@@ -83,14 +91,10 @@ jobs:
           LAST_TAG="$(gh release view --json tagName -q .tagName --repo XRPLF/clio)"
           LAST_TAG_COMMIT="$(git rev-parse $LAST_TAG)"
           BASE_COMMIT="$(git merge-base HEAD $LAST_TAG_COMMIT)"
-          git-cliff "${BASE_COMMIT}..HEAD" --ignore-tags "nightly|-b|-rc"
-          cat CHANGELOG.md >> "${RUNNER_TEMP}/release_notes.md"
-
-      - name: Prepare release artifacts
-        run: .github/scripts/prepare-release-artifacts.sh release_artifacts
+          git-cliff "${BASE_COMMIT}..HEAD" --ignore-tags "nightly|-b|-rc" >> "${RUNNER_TEMP}/release_notes.md"
 
       - name: Upload release notes
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: release_notes_${{ inputs.version }}
           path: "${RUNNER_TEMP}/release_notes.md"
@@ -122,4 +126,4 @@ jobs:
             --target "${GITHUB_SHA}" \
             ${DRAFT_OPTION} \
             --notes-file "${RUNNER_TEMP}/release_notes.md" \
-            ./release_artifacts/clio_server*
+            ./release_artifacts/clio_*

.github/workflows/reusable-test.yml

@@ -45,54 +45,29 @@ jobs:
 
     if: ${{ inputs.run_unit_tests }}
 
-    env:
-      # TODO: remove completely when we have fixed all currently existing issues with sanitizers
-      SANITIZER_IGNORE_ERRORS: ${{ endsWith(inputs.conan_profile, '.tsan') }}
-
     steps:
       - name: Cleanup workspace
         if: ${{ runner.os == 'macOS' }}
-        uses: XRPLF/actions/.github/actions/cleanup-workspace@ea9970b7c211b18f4c8bcdb28c29f5711752029f
+        uses: XRPLF/actions/cleanup-workspace@c7d9ce5ebb03c752a354889ecd870cadfc2b1cd4
 
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
-      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           name: clio_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
 
       - name: Make clio_tests executable
         run: chmod +x ./clio_tests
 
-      - name: Run clio_tests (regular)
-        if: ${{ env.SANITIZER_IGNORE_ERRORS == 'false' }}
+      - name: Run clio_tests
+        continue-on-error: true
+        id: run_clio_tests
         run: ./clio_tests
 
-      - name: Run clio_tests (sanitizer errors ignored)
-        if: ${{ env.SANITIZER_IGNORE_ERRORS == 'true' }}
-        run: ./.github/scripts/execute-tests-under-sanitizer.sh ./clio_tests
-
-      - name: Check for sanitizer report
-        if: ${{ env.SANITIZER_IGNORE_ERRORS == 'true' }}
-        id: check_report
-        run: |
-          if ls .sanitizer-report/* 1> /dev/null 2>&1; then
-            echo "found_report=true" >> $GITHUB_OUTPUT
-          else
-            echo "found_report=false" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Upload sanitizer report
-        if: ${{ env.SANITIZER_IGNORE_ERRORS == 'true' && steps.check_report.outputs.found_report == 'true' }}
-        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
-        with:
-          name: sanitizer_report_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
-          path: .sanitizer-report/*
-          include-hidden-files: true
-
       - name: Create an issue
-        if: ${{ false && env.SANITIZER_IGNORE_ERRORS == 'true' && steps.check_report.outputs.found_report == 'true' }}
+        if: ${{ steps.run_clio_tests.outcome == 'failure' && endsWith(inputs.conan_profile, 'san') }}
         uses: ./.github/actions/create-issue
         env:
           GH_TOKEN: ${{ github.token }}
@@ -100,10 +75,13 @@ jobs:
           labels: "bug"
           title: "[${{ inputs.conan_profile }}] reported issues"
           body: >
-            Clio tests failed one or more sanitizer checks when built with ${{ inputs.conan_profile }}`.
+            Clio tests failed one or more sanitizer checks when built with `${{ inputs.conan_profile }}`.
 
             Workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/
-            Reports are available as artifacts.
+
+      - name: Fail the job if clio_tests failed
+        if: ${{ steps.run_clio_tests.outcome == 'failure' }}
+        run: exit 1
 
   integration_tests:
     name: Integration testing
@@ -124,13 +102,19 @@ jobs:
     steps:
       - name: Cleanup workspace
         if: ${{ runner.os == 'macOS' }}
-        uses: XRPLF/actions/.github/actions/cleanup-workspace@ea9970b7c211b18f4c8bcdb28c29f5711752029f
+        uses: XRPLF/actions/cleanup-workspace@c7d9ce5ebb03c752a354889ecd870cadfc2b1cd4
 
-      - name: Spin up scylladb
+      - name: Delete and start colima (macOS)
+        # This is a temporary workaround for colima issues on macOS runners
         if: ${{ runner.os == 'macOS' }}
-        timeout-minutes: 3
         run: |
-          docker rm --force scylladb || true
+          colima delete --force
+          colima start
+
+      - name: Spin up scylladb (macOS)
+        if: ${{ runner.os == 'macOS' }}
+        timeout-minutes: 1
+        run: |
           docker run \
             --detach \
             --name scylladb \
@@ -142,11 +126,15 @@ jobs:
             --memory 16G \
             scylladb/scylla
 
+      - name: Wait for scylladb container to be healthy (macOS)
+        if: ${{ runner.os == 'macOS' }}
+        timeout-minutes: 1
+        run: |
           until [ "$(docker inspect -f '{{.State.Health.Status}}' scylladb)" == "healthy" ]; do
-            sleep 5
+            sleep 1
           done
 
-      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           name: clio_integration_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
 

.github/workflows/reusable-upload-coverage-report.yml

@@ -16,19 +16,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           fetch-depth: 0
 
       - name: Download report artifact
-        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+        uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           name: coverage-report.xml
           path: build
 
       - name: Upload coverage report
         if: ${{ hashFiles('build/coverage_report.xml') != '' }}
-        uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
         with:
           files: build/coverage_report.xml
           fail_ci_if_error: true

.github/workflows/sanitizers.yml

@@ -15,7 +15,6 @@ on:
       - ".github/actions/**"
       - "!.github/actions/build-docker-image/**"
       - "!.github/actions/create-issue/**"
-      - .github/scripts/execute-tests-under-sanitizer.sh
 
       - CMakeLists.txt
       - conanfile.py
@@ -44,7 +43,7 @@ jobs:
     uses: ./.github/workflows/reusable-build-test.yml
     with:
       runs_on: heavy
-      container: '{ "image": "ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7" }'
+      container: '{ "image": "ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696" }'
       download_ccache: false
       upload_ccache: false
       conan_profile: ${{ matrix.compiler }}${{ matrix.sanitizer_ext }}

.github/workflows/update-docker-ci.yml

@@ -56,11 +56,11 @@ jobs:
     needs: repo
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47.0.0
+        uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v47.0.1
         with:
           files: "docker/compilers/gcc/**"
 
@@ -94,11 +94,11 @@ jobs:
     needs: repo
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46.0.5
+        uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v47.0.1
         with:
           files: "docker/compilers/gcc/**"
 
@@ -132,20 +132,20 @@ jobs:
     needs: [repo, gcc-amd64, gcc-arm64]
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47.0.0
+        uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v47.0.1
         with:
           files: "docker/compilers/gcc/**"
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
+        uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
 
       - name: Login to GitHub Container Registry
         if: ${{ github.event_name != 'pull_request' }}
-        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -153,7 +153,7 @@ jobs:
 
       - name: Login to DockerHub
         if: ${{ github.repository_owner == 'XRPLF' && github.event_name != 'pull_request' }}
-        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
         with:
           username: ${{ secrets.DOCKERHUB_USER }}
           password: ${{ secrets.DOCKERHUB_PW }}
@@ -183,11 +183,11 @@ jobs:
     needs: repo
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47.0.0
+        uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v47.0.1
         with:
           files: "docker/compilers/clang/**"
 
@@ -219,11 +219,11 @@ jobs:
     needs: [repo, gcc-merge]
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47.0.0
+        uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v47.0.1
         with:
           files: "docker/tools/**"
 
@@ -250,11 +250,11 @@ jobs:
     needs: [repo, gcc-merge]
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46.0.5
+        uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v47.0.1
         with:
           files: "docker/tools/**"
 
@@ -281,20 +281,20 @@ jobs:
     needs: [repo, tools-amd64, tools-arm64]
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47.0.0
+        uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v47.0.1
         with:
           files: "docker/tools/**"
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
+        uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
 
       - name: Login to GitHub Container Registry
         if: ${{ github.event_name != 'pull_request' }}
-        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -316,7 +316,7 @@ jobs:
     needs: [repo, tools-merge]
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - uses: ./.github/actions/build-docker-image
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -338,7 +338,7 @@ jobs:
     needs: [repo, gcc-merge, clang, tools-merge]
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - uses: ./.github/actions/build-docker-image
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/upload-conan-deps.yml

@@ -22,6 +22,7 @@ on:
 
       - .github/actions/conan/action.yml
       - ".github/scripts/conan/**"
+      - "!.github/scripts/conan/regenerate_lockfile.sh"
 
       - conanfile.py
       - conan.lock
@@ -32,6 +33,7 @@ on:
 
       - .github/actions/conan/action.yml
       - ".github/scripts/conan/**"
+      - "!.github/scripts/conan/regenerate_lockfile.sh"
 
       - conanfile.py
       - conan.lock
@@ -50,7 +52,7 @@ jobs:
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Calculate conan matrix
         id: set-matrix
@@ -73,12 +75,12 @@ jobs:
       CONAN_PROFILE: ${{ matrix.compiler }}${{ matrix.sanitizer_ext }}
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Prepare runner
-        uses: XRPLF/actions/.github/actions/prepare-runner@8abb0722cbff83a9a2dc7d06c473f7a4964b7382
+        uses: XRPLF/actions/prepare-runner@2cbf481018d930656e9276fcc20dc0e3a0be5b6d
         with:
-          disable_ccache: true
+          enable_ccache: false
 
       - name: Setup conan on macOS
         if: ${{ runner.os == 'macOS' }}

.gitignore

@@ -4,8 +4,11 @@
 .build
 .cache
 .vscode
+.zed
 .python-version
 .DS_Store
 .sanitizer-report
 CMakeUserPresets.json
 config.json
+CLAUDE.md
+.claude/**

.pre-commit-config.yaml

@@ -29,12 +29,12 @@ repos:
 
   # Autoformat: YAML, JSON, Markdown, etc.
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: 5ba47274f9b181bce26a5150a725577f3c336011 # frozen: v3.6.2
+    rev: c2bc67fe8f8f549cc489e00ba8b45aa18ee713b1 # frozen: v3.8.1
     hooks:
       - id: prettier
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: 192ad822316c3a22fb3d3cc8aa6eafa0b8488360 # frozen: v0.45.0
+    rev: 76b3d32d3f4b965e1d6425253c59407420ae2c43 # frozen: v0.47.0
     hooks:
       - id: markdownlint-fix
         exclude: LICENSE.md
@@ -58,6 +58,17 @@ repos:
             --ignore-words=pre-commit-hooks/codespell_ignore.txt,
           ]
 
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: ea488cebbfd88a5f50b8bd95d5c829d0bb76feb8 # frozen: 26.1.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/scop/pre-commit-shfmt
+    rev: 2a30809d16bc7a60d9b97353c797f42b510d3368 # frozen: v3.12.0-2
+    hooks:
+      - id: shfmt
+        args: ["-i", "4", "--write"]
+
   # Running some C++ hooks before clang-format
   # to ensure that the style is consistent.
   - repo: local
@@ -83,17 +94,16 @@ repos:
         language: script
 
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: 719856d56a62953b8d2839fb9e851f25c3cfeef8 # frozen: v21.1.2
+    rev: cd481d7b0bfb5c7b3090c21846317f9a8262e891 # frozen: v22.1.0
     hooks:
       - id: clang-format
         args: [--style=file]
         types: [c++]
 
-  - repo: https://github.com/cheshirekow/cmake-format-precommit
-    rev: e2c2116d86a80e72e7146a06e68b7c228afc6319 # frozen: v0.6.13
+  - repo: https://github.com/BlankSpruce/gersemi
+    rev: 0.26.0
     hooks:
-      - id: cmake-format
-        additional_dependencies: [PyYAML]
+      - id: gersemi
 
   - repo: local
     hooks:

CMakeLists.txt

@@ -1,7 +1,10 @@
 cmake_minimum_required(VERSION 3.20)
 
-project(clio VERSION ${CLIO_VERSION} HOMEPAGE_URL "https://github.com/XRPLF/clio"
-        DESCRIPTION "An XRP Ledger API Server"
+project(
+    clio
+    VERSION ${CLIO_VERSION}
+    HOMEPAGE_URL "https://github.com/XRPLF/clio"
+    DESCRIPTION "An XRP Ledger API Server"
 )
 
 # =========================== Options ====================================== #
@@ -15,7 +18,11 @@ option(package "Create distribution packages" FALSE)
 option(lint "Run clang-tidy checks during compilation" FALSE)
 option(static "Statically linked Clio" FALSE)
 option(snapshot "Build snapshot tool" FALSE)
-option(time_trace "Build using -ftime-trace to create compiler trace reports" FALSE)
+option(
+    time_trace
+    "Build using -ftime-trace to create compiler trace reports"
+    FALSE
+)
 
 # ========================================================================== #
 set(san "" CACHE STRING "Add sanitizer instrumentation")
@@ -35,9 +42,9 @@ add_library(clio_options INTERFACE)
 target_compile_features(clio_options INTERFACE cxx_std_23) # Clio needs c++23 but deps can remain c++20 for now
 target_include_directories(clio_options INTERFACE ${CMAKE_SOURCE_DIR}/src)
 
-if (verbose)
-  set(CMAKE_VERBOSE_MAKEFILE TRUE)
-endif ()
+if(verbose)
+    set(CMAKE_VERBOSE_MAKEFILE TRUE)
+endif()
 
 # Clio tweaks and checks
 include(CheckCompiler)
@@ -57,37 +64,43 @@ include(deps/spdlog)
 add_subdirectory(src)
 add_subdirectory(tests)
 
-if (benchmark)
-  add_subdirectory(benchmarks)
-endif ()
+if(benchmark)
+    add_subdirectory(benchmarks)
+endif()
 
 # Enable selected sanitizer if enabled via `san`
-if (san)
-  set(SUPPORTED_SANITIZERS "address" "thread" "memory" "undefined")
-  if (NOT san IN_LIST SUPPORTED_SANITIZERS)
-    message(FATAL_ERROR "Error: Unsupported sanitizer '${san}'. Supported values are: ${SUPPORTED_SANITIZERS}.")
-  endif ()
+if(san)
+    set(SUPPORTED_SANITIZERS "address" "thread" "memory" "undefined")
+    if(NOT san IN_LIST SUPPORTED_SANITIZERS)
+        message(
+            FATAL_ERROR
+            "Error: Unsupported sanitizer '${san}'. Supported values are: ${SUPPORTED_SANITIZERS}."
+        )
+    endif()
 
-  # Sanitizers recommend minimum of -O1 for reasonable performance so we enable it for debug builds
-  set(SAN_OPTIMIZATION_FLAG "")
-  if (CMAKE_BUILD_TYPE STREQUAL "Debug")
-    set(SAN_OPTIMIZATION_FLAG -O1)
-  endif ()
-  target_compile_options(clio_options INTERFACE ${SAN_OPTIMIZATION_FLAG} ${SAN_FLAG} -fno-omit-frame-pointer)
+    # Sanitizers recommend minimum of -O1 for reasonable performance so we enable it for debug builds
+    set(SAN_OPTIMIZATION_FLAG "")
+    if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+        set(SAN_OPTIMIZATION_FLAG -O1)
+    endif()
+    target_compile_options(
+        clio_options
+        INTERFACE ${SAN_OPTIMIZATION_FLAG} ${SAN_FLAG} -fno-omit-frame-pointer
+    )
 
-  target_link_libraries(clio_options INTERFACE ${SAN_FLAG} ${SAN_LIB})
-endif ()
+    target_link_libraries(clio_options INTERFACE ${SAN_FLAG} ${SAN_LIB})
+endif()
 
 # Generate `docs` target for doxygen documentation if enabled Note: use `make docs` to generate the documentation
-if (docs)
-  add_subdirectory(docs)
-endif ()
+if(docs)
+    add_subdirectory(docs)
+endif()
 
 include(install/install)
-if (package)
-  include(ClioPackage)
-endif ()
+if(package)
+    include(ClioPackage)
+endif()
 
-if (snapshot)
-  add_subdirectory(tools/snapshot)
-endif ()
+if(snapshot)
+    add_subdirectory(tools/snapshot)
+endif()

CONTRIBUTING.md

@@ -180,6 +180,7 @@ Existing maintainers can resign, or be subject to a vote for removal at the behe
 - [kuznetsss](https://github.com/kuznetsss) (Ripple)
 - [legleux](https://github.com/legleux) (Ripple)
 - [PeterChen13579](https://github.com/PeterChen13579) (Ripple)
+- [mathbunnyru](https://github.com/mathbunnyru) (Ripple)
 
 ### Honorable ex-Maintainers
 

benchmarks/CMakeLists.txt

@@ -1,18 +1,27 @@
 add_executable(clio_benchmark)
 
 target_sources(
-  clio_benchmark
-  PRIVATE # Common
-          Main.cpp
-          Playground.cpp
-          # ExecutionContext
-          util/async/ExecutionContextBenchmarks.cpp
-          # Logger
-          util/log/LoggerBenchmark.cpp
+    clio_benchmark
+    PRIVATE
+        # Common
+        Main.cpp
+        Playground.cpp
+        # ExecutionContext
+        util/async/ExecutionContextBenchmarks.cpp
+        # Logger
+        util/log/LoggerBenchmark.cpp
+        # WorkQueue
+        rpc/WorkQueueBenchmarks.cpp
 )
 
 include(deps/gbench)
 
 target_include_directories(clio_benchmark PRIVATE .)
-target_link_libraries(clio_benchmark PUBLIC clio_util benchmark::benchmark_main spdlog::spdlog)
-set_target_properties(clio_benchmark PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
+target_link_libraries(
+    clio_benchmark
+    PRIVATE clio_rpc clio_util benchmark::benchmark_main spdlog::spdlog
+)
+set_target_properties(
+    clio_benchmark
+    PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}
+)

benchmarks/rpc/WorkQueueBenchmarks.cpp

@@ -0,0 +1,153 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#include "rpc/WorkQueue.hpp"
+#include "util/Assert.hpp"
+#include "util/config/Array.hpp"
+#include "util/config/ConfigConstraints.hpp"
+#include "util/config/ConfigDefinition.hpp"
+#include "util/config/ConfigValue.hpp"
+#include "util/config/Types.hpp"
+#include "util/log/Logger.hpp"
+#include "util/prometheus/Prometheus.hpp"
+
+#include <benchmark/benchmark.h>
+#include <boost/asio/steady_timer.hpp>
+
+#include <algorithm>
+#include <atomic>
+#include <cassert>
+#include <chrono>
+#include <cstddef>
+#include <cstdint>
+#include <mutex>
+#include <thread>
+#include <vector>
+
+using namespace rpc;
+using namespace util::config;
+
+namespace {
+
+auto const kCONFIG = ClioConfigDefinition{
+    {"prometheus.compress_reply", ConfigValue{ConfigType::Boolean}.defaultValue(true)},
+    {"prometheus.enabled", ConfigValue{ConfigType::Boolean}.defaultValue(true)},
+    {"log.channels.[].channel", Array{ConfigValue{ConfigType::String}}},
+    {"log.channels.[].level", Array{ConfigValue{ConfigType::String}}},
+    {"log.level", ConfigValue{ConfigType::String}.defaultValue("info")},
+    {"log.format",
+     ConfigValue{ConfigType::String}.defaultValue(R"(%Y-%m-%d %H:%M:%S.%f %^%3!l:%n%$ - %v)")},
+    {"log.is_async", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
+    {"log.enable_console", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
+    {"log.directory", ConfigValue{ConfigType::String}.optional()},
+    {"log.rotation_size",
+     ConfigValue{ConfigType::Integer}.defaultValue(2048).withConstraint(gValidateUint32)},
+    {"log.directory_max_files",
+     ConfigValue{ConfigType::Integer}.defaultValue(25).withConstraint(gValidateUint32)},
+    {"log.tag_style", ConfigValue{ConfigType::String}.defaultValue("none")},
+};
+
+// this should be a fixture but it did not work with Args very well
+void
+init()
+{
+    static std::once_flag kONCE;
+    std::call_once(kONCE, [] {
+        PrometheusService::init(kCONFIG);
+        (void)util::LogService::init(kCONFIG);
+    });
+}
+
+}  // namespace
+
+static void
+benchmarkWorkQueue(benchmark::State& state)
+{
+    init();
+
+    auto const wqThreads = static_cast<uint32_t>(state.range(0));
+    auto const maxQueueSize = static_cast<uint32_t>(state.range(1));
+    auto const clientThreads = static_cast<uint32_t>(state.range(2));
+    auto const itemsPerClient = static_cast<uint32_t>(state.range(3));
+    auto const clientProcessingMs = static_cast<uint32_t>(state.range(4));
+
+    for (auto _ : state) {
+        std::atomic_size_t totalExecuted = 0uz;
+        std::atomic_size_t totalQueued = 0uz;
+
+        state.PauseTiming();
+        WorkQueue queue(wqThreads, maxQueueSize);
+        state.ResumeTiming();
+
+        std::vector<std::thread> threads;
+        threads.reserve(clientThreads);
+
+        for (auto t = 0uz; t < clientThreads; ++t) {
+            threads.emplace_back([&] {
+                for (auto i = 0uz; i < itemsPerClient; ++i) {
+                    totalQueued += static_cast<std::size_t>(queue.postCoro(
+                        [&clientProcessingMs, &totalExecuted](auto yield) {
+                            ++totalExecuted;
+
+                            boost::asio::steady_timer timer(
+                                yield.get_executor(), std::chrono::milliseconds{clientProcessingMs}
+                            );
+                            timer.async_wait(yield);
+
+                            std::this_thread::sleep_for(std::chrono::microseconds{10});
+                        },
+                        /* isWhiteListed = */ false
+                    ));
+                }
+            });
+        }
+
+        for (auto& t : threads)
+            t.join();
+
+        queue.stop();
+
+        ASSERT(totalExecuted == totalQueued, "Totals don't match");
+        ASSERT(totalQueued <= itemsPerClient * clientThreads, "Queued more than requested");
+
+        if (maxQueueSize == 0) {
+            ASSERT(
+                totalQueued == itemsPerClient * clientThreads, "Queued exactly the expected amount"
+            );
+        } else {
+            ASSERT(
+                totalQueued >= std::min(maxQueueSize, itemsPerClient * clientThreads),
+                "Queued less than expected"
+            );
+        }
+    }
+}
+
+// Usage example:
+/*
+  ./clio_benchmark \
+    --benchmark_repetitions=10 \
+    --benchmark_display_aggregates_only=true \
+    --benchmark_min_time=1x \
+    --benchmark_filter="WorkQueue"
+*/
+// TODO: figure out what happens on 1 thread
+BENCHMARK(benchmarkWorkQueue)
+    ->ArgsProduct({{2, 4, 8, 16}, {0, 5'000}, {4, 8, 16}, {1'000, 10'000}, {10, 100, 250}})
+    ->Unit(benchmark::kMillisecond);

benchmarks/util/log/LoggerBenchmark.cpp

@@ -62,8 +62,9 @@ uniqueLogDir()
 {
     auto const epochTime = std::chrono::high_resolution_clock::now().time_since_epoch();
     auto const tmpDir = std::filesystem::temp_directory_path();
-    std::string const dirName =
-        fmt::format("logs_{}", std::chrono::duration_cast<std::chrono::microseconds>(epochTime).count());
+    std::string const dirName = fmt::format(
+        "logs_{}", std::chrono::duration_cast<std::chrono::microseconds>(epochTime).count()
+    );
     return tmpDir / "clio_benchmark" / dirName;
 }
 
@@ -108,7 +109,8 @@ benchmarkConcurrentFileLogging(benchmark::State& state)
                     channel, fileSink, spdlog::thread_pool(), spdlog::async_overflow_policy::block
                 );
                 spdlog::register_logger(logger);
-                Logger const threadLogger = BenchmarkLoggingInitializer::getLogger(std::move(logger));
+                Logger const threadLogger =
+                    BenchmarkLoggingInitializer::getLogger(std::move(logger));
 
                 barrier.arrive_and_wait();
 
@@ -124,13 +126,16 @@ benchmarkConcurrentFileLogging(benchmark::State& state)
         spdlog::shutdown();
 
         auto const end = std::chrono::high_resolution_clock::now();
-        state.SetIterationTime(std::chrono::duration_cast<std::chrono::duration<double>>(end - start).count());
+        state.SetIterationTime(
+            std::chrono::duration_cast<std::chrono::duration<double>>(end - start).count()
+        );
 
         std::filesystem::remove_all(logDir);
     }
 
     auto const totalMessages = numThreads * messagesPerThread;
-    state.counters["TotalMessagesRate"] = benchmark::Counter(totalMessages, benchmark::Counter::kIsRate);
+    state.counters["TotalMessagesRate"] =
+        benchmark::Counter(totalMessages, benchmark::Counter::kIsRate);
     state.counters["Threads"] = numThreads;
     state.counters["MessagesPerThread"] = messagesPerThread;
 }

cliff.toml

@@ -49,8 +49,6 @@ postprocessors = [
 ]
 # render body even when there are no releases to process
 # render_always = true
-# output file path
-output = "CHANGELOG.md"
 
 [git]
 # parse the commits based on https://www.conventionalcommits.org

cmake/Ccache.cmake

@@ -1,5 +1,5 @@
 find_program(CCACHE_PATH "ccache")
-if (CCACHE_PATH)
-  set(CMAKE_CXX_COMPILER_LAUNCHER "${CCACHE_PATH}")
-  message(STATUS "Using ccache: ${CCACHE_PATH}")
-endif ()
+if(CCACHE_PATH)
+    set(CMAKE_CXX_COMPILER_LAUNCHER "${CCACHE_PATH}")
+    message(STATUS "Using ccache: ${CCACHE_PATH}")
+endif()

cmake/CheckCompiler.cmake

@@ -1,42 +1,48 @@
-if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
-  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 16)
-    message(FATAL_ERROR "Clang 16+ required for building clio")
-  endif ()
-  set(is_clang TRUE)
-elseif (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
-  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 15)
-    message(FATAL_ERROR "AppleClang 15+ required for building clio")
-  endif ()
-  set(is_appleclang TRUE)
-elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 12)
-    message(FATAL_ERROR "GCC 12+ required for building clio")
-  endif ()
-  set(is_gcc TRUE)
-else ()
-  message(FATAL_ERROR "Supported compilers: AppleClang 15+, Clang 16+, GCC 12+")
-endif ()
+if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+    if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 16)
+        message(FATAL_ERROR "Clang 16+ required for building clio")
+    endif()
+    set(is_clang TRUE)
+elseif(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
+    if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 15)
+        message(FATAL_ERROR "AppleClang 15+ required for building clio")
+    endif()
+    set(is_appleclang TRUE)
+elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 12)
+        message(FATAL_ERROR "GCC 12+ required for building clio")
+    endif()
+    set(is_gcc TRUE)
+else()
+    message(
+        FATAL_ERROR
+        "Supported compilers: AppleClang 15+, Clang 16+, GCC 12+"
+    )
+endif()
 
-if (san)
-  string(TOLOWER ${san} san)
-  set(SAN_FLAG "-fsanitize=${san}")
-  set(SAN_LIB "")
-  if (is_gcc)
-    if (san STREQUAL "address")
-      set(SAN_LIB "asan")
-    elseif (san STREQUAL "thread")
-      set(SAN_LIB "tsan")
-    elseif (san STREQUAL "memory")
-      set(SAN_LIB "msan")
-    elseif (san STREQUAL "undefined")
-      set(SAN_LIB "ubsan")
-    endif ()
-  endif ()
-  set(_saved_CRL ${CMAKE_REQUIRED_LIBRARIES})
-  set(CMAKE_REQUIRED_LIBRARIES "${SAN_FLAG};${SAN_LIB}")
-  check_cxx_compiler_flag(${SAN_FLAG} COMPILER_SUPPORTS_SAN)
-  set(CMAKE_REQUIRED_LIBRARIES ${_saved_CRL})
-  if (NOT COMPILER_SUPPORTS_SAN)
-    message(FATAL_ERROR "${san} sanitizer does not seem to be supported by your compiler")
-  endif ()
-endif ()
+if(san)
+    string(TOLOWER ${san} san)
+    set(SAN_FLAG "-fsanitize=${san}")
+    set(SAN_LIB "")
+    if(is_gcc)
+        if(san STREQUAL "address")
+            set(SAN_LIB "asan")
+        elseif(san STREQUAL "thread")
+            set(SAN_LIB "tsan")
+        elseif(san STREQUAL "memory")
+            set(SAN_LIB "msan")
+        elseif(san STREQUAL "undefined")
+            set(SAN_LIB "ubsan")
+        endif()
+    endif()
+    set(_saved_CRL ${CMAKE_REQUIRED_LIBRARIES})
+    set(CMAKE_REQUIRED_LIBRARIES "${SAN_FLAG};${SAN_LIB}")
+    check_cxx_compiler_flag(${SAN_FLAG} COMPILER_SUPPORTS_SAN)
+    set(CMAKE_REQUIRED_LIBRARIES ${_saved_CRL})
+    if(NOT COMPILER_SUPPORTS_SAN)
+        message(
+            FATAL_ERROR
+            "${san} sanitizer does not seem to be supported by your compiler"
+        )
+    endif()
+endif()

cmake/ClangTidy.cmake

@@ -1,33 +1,41 @@
-if (lint)
+if(lint)
+    # Find clang-tidy binary
+    if(DEFINED ENV{CLIO_CLANG_TIDY_BIN})
+        set(_CLANG_TIDY_BIN $ENV{CLIO_CLANG_TIDY_BIN})
+        if((NOT EXISTS ${_CLANG_TIDY_BIN}) OR IS_DIRECTORY ${_CLANG_TIDY_BIN})
+            message(
+                FATAL_ERROR
+                "$ENV{CLIO_CLANG_TIDY_BIN} no such file. Check CLIO_CLANG_TIDY_BIN env variable"
+            )
+        endif()
+        message(STATUS "Using clang-tidy from CLIO_CLANG_TIDY_BIN")
+    else()
+        find_program(
+            _CLANG_TIDY_BIN
+            NAMES "clang-tidy-20" "clang-tidy"
+            REQUIRED
+        )
+    endif()
 
-  # Find clang-tidy binary
-  if (DEFINED ENV{CLIO_CLANG_TIDY_BIN})
-    set(_CLANG_TIDY_BIN $ENV{CLIO_CLANG_TIDY_BIN})
-    if ((NOT EXISTS ${_CLANG_TIDY_BIN}) OR IS_DIRECTORY ${_CLANG_TIDY_BIN})
-      message(FATAL_ERROR "$ENV{CLIO_CLANG_TIDY_BIN} no such file. Check CLIO_CLANG_TIDY_BIN env variable")
-    endif ()
-    message(STATUS "Using clang-tidy from CLIO_CLANG_TIDY_BIN")
-  else ()
-    find_program(_CLANG_TIDY_BIN NAMES "clang-tidy-20" "clang-tidy" REQUIRED)
-  endif ()
+    if(NOT _CLANG_TIDY_BIN)
+        message(
+            FATAL_ERROR
+            "clang-tidy binary not found. Please set the CLIO_CLANG_TIDY_BIN environment variable or install clang-tidy."
+        )
+    endif()
 
-  if (NOT _CLANG_TIDY_BIN)
-    message(
-      FATAL_ERROR
-        "clang-tidy binary not found. Please set the CLIO_CLANG_TIDY_BIN environment variable or install clang-tidy."
-    )
-  endif ()
+    # Support for https://github.com/matus-chochlik/ctcache
+    find_program(CLANG_TIDY_CACHE_PATH NAMES "clang-tidy-cache")
+    if(CLANG_TIDY_CACHE_PATH)
+        set(_CLANG_TIDY_CMD
+            "${CLANG_TIDY_CACHE_PATH};${_CLANG_TIDY_BIN}"
+            CACHE STRING
+            "A combined command to run clang-tidy with caching wrapper"
+        )
+    else()
+        set(_CLANG_TIDY_CMD "${_CLANG_TIDY_BIN}")
+    endif()
 
-  # Support for https://github.com/matus-chochlik/ctcache
-  find_program(CLANG_TIDY_CACHE_PATH NAMES "clang-tidy-cache")
-  if (CLANG_TIDY_CACHE_PATH)
-    set(_CLANG_TIDY_CMD "${CLANG_TIDY_CACHE_PATH};${_CLANG_TIDY_BIN}"
-        CACHE STRING "A combined command to run clang-tidy with caching wrapper"
-    )
-  else ()
-    set(_CLANG_TIDY_CMD "${_CLANG_TIDY_BIN}")
-  endif ()
-
-  set(CMAKE_CXX_CLANG_TIDY "${_CLANG_TIDY_CMD};--quiet")
-  message(STATUS "Using clang-tidy: ${CMAKE_CXX_CLANG_TIDY}")
-endif ()
+    set(CMAKE_CXX_CLANG_TIDY "${_CLANG_TIDY_CMD};--quiet")
+    message(STATUS "Using clang-tidy: ${CMAKE_CXX_CLANG_TIDY}")
+endif()

cmake/ClioVersion.cmake

@@ -1,47 +1,67 @@
 find_package(Git REQUIRED)
 
-set(GIT_COMMAND describe --tags --exact-match)
+if(DEFINED ENV{GITHUB_BRANCH_NAME})
+    set(GIT_BUILD_BRANCH $ENV{GITHUB_BRANCH_NAME})
+    set(GIT_COMMIT_HASH $ENV{GITHUB_HEAD_SHA})
+else()
+    set(GIT_COMMAND branch --show-current)
+    execute_process(
+        COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND}
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+        OUTPUT_VARIABLE GIT_BUILD_BRANCH
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        COMMAND_ERROR_IS_FATAL ANY
+    )
+
+    set(GIT_COMMAND rev-parse HEAD)
+    execute_process(
+        COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND}
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+        OUTPUT_VARIABLE GIT_COMMIT_HASH
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        COMMAND_ERROR_IS_FATAL ANY
+    )
+endif()
+
 execute_process(
-  COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND}
-  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-  OUTPUT_VARIABLE TAG
-  RESULT_VARIABLE RC
-  ERROR_VARIABLE ERR
-  OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_STRIP_TRAILING_WHITESPACE
+    COMMAND date +%Y%m%d%H%M%S
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    OUTPUT_VARIABLE BUILD_DATE
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    COMMAND_ERROR_IS_FATAL ANY
 )
 
-if (RC EQUAL 0)
-  message(STATUS "Found tag '${TAG}' in git. Will use it as Clio version")
-  set(CLIO_VERSION "${TAG}")
-  set(DOC_CLIO_VERSION "${TAG}")
-else ()
-  message(STATUS "Error finding tag in git: ${ERR}")
-  message(STATUS "Will use 'YYYYMMDDHMS-<branch>-<git-rev>' as Clio version")
+message(STATUS "Git branch: ${GIT_BUILD_BRANCH}")
+message(STATUS "Git commit hash: ${GIT_COMMIT_HASH}")
+message(STATUS "Build date: ${BUILD_DATE}")
 
-  set(GIT_COMMAND show -s --date=format:%Y%m%d%H%M%S --format=%cd)
-  execute_process(
-    COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} OUTPUT_VARIABLE DATE
-    OUTPUT_STRIP_TRAILING_WHITESPACE COMMAND_ERROR_IS_FATAL ANY
-  )
+if(
+    DEFINED ENV{FORCE_CLIO_VERSION}
+    AND NOT "$ENV{FORCE_CLIO_VERSION}" STREQUAL ""
+)
+    message(
+        STATUS
+        "Using explicitly provided '${FORCE_CLIO_VERSION}' as Clio version"
+    )
 
-  set(GIT_COMMAND branch --show-current)
-  execute_process(
-    COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} OUTPUT_VARIABLE BRANCH
-    OUTPUT_STRIP_TRAILING_WHITESPACE COMMAND_ERROR_IS_FATAL ANY
-  )
+    set(CLIO_VERSION "$ENV{FORCE_CLIO_VERSION}")
+    set(DOC_CLIO_VERSION "$ENV{FORCE_CLIO_VERSION}")
+else()
+    message(
+        STATUS
+        "Using 'YYYYMMDDHMS-<branch>-<git short rev>' as Clio version"
+    )
 
-  set(GIT_COMMAND rev-parse --short HEAD)
-  execute_process(
-    COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} OUTPUT_VARIABLE REV
-    OUTPUT_STRIP_TRAILING_WHITESPACE COMMAND_ERROR_IS_FATAL ANY
-  )
+    string(SUBSTRING ${GIT_COMMIT_HASH} 0 7 GIT_COMMIT_HASH_SHORT)
 
-  set(CLIO_VERSION "${DATE}-${BRANCH}-${REV}")
-  set(DOC_CLIO_VERSION "develop")
-endif ()
+    set(CLIO_VERSION
+        "${BUILD_DATE}-${GIT_BUILD_BRANCH}-${GIT_COMMIT_HASH_SHORT}"
+    )
+    set(DOC_CLIO_VERSION "develop")
+endif()
 
-if (CMAKE_BUILD_TYPE MATCHES Debug)
-  set(CLIO_VERSION "${CLIO_VERSION}+DEBUG")
-endif ()
+if(CMAKE_BUILD_TYPE MATCHES Debug)
+    set(CLIO_VERSION "${CLIO_VERSION}+DEBUG")
+endif()
 
 message(STATUS "Build version: ${CLIO_VERSION}")

cmake/CodeCoverage.cmake

@@ -106,78 +106,120 @@ option(CODE_COVERAGE_VERBOSE "Verbose information" FALSE)
 # Check prereqs
 find_program(GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/scripts/test)
 
-if (DEFINED CODE_COVERAGE_GCOV_TOOL)
-  set(GCOV_TOOL "${CODE_COVERAGE_GCOV_TOOL}")
-elseif (DEFINED ENV{CODE_COVERAGE_GCOV_TOOL})
-  set(GCOV_TOOL "$ENV{CODE_COVERAGE_GCOV_TOOL}")
-elseif ("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
-  if (APPLE)
-    execute_process(COMMAND xcrun -f llvm-cov OUTPUT_VARIABLE LLVMCOV_PATH OUTPUT_STRIP_TRAILING_WHITESPACE)
-  else ()
-    find_program(LLVMCOV_PATH llvm-cov)
-  endif ()
-  if (LLVMCOV_PATH)
-    set(GCOV_TOOL "${LLVMCOV_PATH} gcov")
-  endif ()
-elseif ("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
-  find_program(GCOV_PATH gcov)
-  set(GCOV_TOOL "${GCOV_PATH}")
-endif ()
+if(DEFINED CODE_COVERAGE_GCOV_TOOL)
+    set(GCOV_TOOL "${CODE_COVERAGE_GCOV_TOOL}")
+elseif(DEFINED ENV{CODE_COVERAGE_GCOV_TOOL})
+    set(GCOV_TOOL "$ENV{CODE_COVERAGE_GCOV_TOOL}")
+elseif("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
+    if(APPLE)
+        execute_process(
+            COMMAND xcrun -f llvm-cov
+            OUTPUT_VARIABLE LLVMCOV_PATH
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+    else()
+        find_program(LLVMCOV_PATH llvm-cov)
+    endif()
+    if(LLVMCOV_PATH)
+        set(GCOV_TOOL "${LLVMCOV_PATH} gcov")
+    endif()
+elseif("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
+    find_program(GCOV_PATH gcov)
+    set(GCOV_TOOL "${GCOV_PATH}")
+endif()
 
 # Check supported compiler (Clang, GNU and Flang)
 get_property(LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES)
-foreach (LANG ${LANGUAGES})
-  if ("${CMAKE_${LANG}_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
-    if ("${CMAKE_${LANG}_COMPILER_VERSION}" VERSION_LESS 3)
-      message(FATAL_ERROR "Clang version must be 3.0.0 or greater! Aborting...")
-    endif ()
-  elseif (NOT "${CMAKE_${LANG}_COMPILER_ID}" MATCHES "GNU" AND NOT "${CMAKE_${LANG}_COMPILER_ID}" MATCHES
-                                                               "(LLVM)?[Ff]lang"
-  )
-    message(FATAL_ERROR "Compiler is not GNU or Flang! Aborting...")
-  endif ()
-endforeach ()
+foreach(LANG ${LANGUAGES})
+    if("${CMAKE_${LANG}_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
+        if("${CMAKE_${LANG}_COMPILER_VERSION}" VERSION_LESS 3)
+            message(
+                FATAL_ERROR
+                "Clang version must be 3.0.0 or greater! Aborting..."
+            )
+        endif()
+    elseif(
+        NOT "${CMAKE_${LANG}_COMPILER_ID}" MATCHES "GNU"
+        AND NOT "${CMAKE_${LANG}_COMPILER_ID}" MATCHES "(LLVM)?[Ff]lang"
+    )
+        message(FATAL_ERROR "Compiler is not GNU or Flang! Aborting...")
+    endif()
+endforeach()
 
 set(COVERAGE_COMPILER_FLAGS "-g --coverage" CACHE INTERNAL "")
-if (CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Clang)")
-  include(CheckCXXCompilerFlag)
-  check_cxx_compiler_flag(-fprofile-abs-path HAVE_cxx_fprofile_abs_path)
-  if (HAVE_cxx_fprofile_abs_path)
-    set(COVERAGE_CXX_COMPILER_FLAGS "${COVERAGE_COMPILER_FLAGS} -fprofile-abs-path")
-  endif ()
-  include(CheckCCompilerFlag)
-  check_c_compiler_flag(-fprofile-abs-path HAVE_c_fprofile_abs_path)
-  if (HAVE_c_fprofile_abs_path)
-    set(COVERAGE_C_COMPILER_FLAGS "${COVERAGE_COMPILER_FLAGS} -fprofile-abs-path")
-  endif ()
-endif ()
+if(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Clang)")
+    include(CheckCXXCompilerFlag)
+    check_cxx_compiler_flag(-fprofile-abs-path HAVE_cxx_fprofile_abs_path)
+    if(HAVE_cxx_fprofile_abs_path)
+        set(COVERAGE_CXX_COMPILER_FLAGS
+            "${COVERAGE_COMPILER_FLAGS} -fprofile-abs-path"
+        )
+    endif()
+    include(CheckCCompilerFlag)
+    check_c_compiler_flag(-fprofile-abs-path HAVE_c_fprofile_abs_path)
+    if(HAVE_c_fprofile_abs_path)
+        set(COVERAGE_C_COMPILER_FLAGS
+            "${COVERAGE_COMPILER_FLAGS} -fprofile-abs-path"
+        )
+    endif()
+endif()
 
-set(CMAKE_Fortran_FLAGS_COVERAGE ${COVERAGE_COMPILER_FLAGS}
-    CACHE STRING "Flags used by the Fortran compiler during coverage builds." FORCE
+set(CMAKE_Fortran_FLAGS_COVERAGE
+    ${COVERAGE_COMPILER_FLAGS}
+    CACHE STRING
+    "Flags used by the Fortran compiler during coverage builds."
+    FORCE
 )
-set(CMAKE_CXX_FLAGS_COVERAGE ${COVERAGE_COMPILER_FLAGS}
-    CACHE STRING "Flags used by the C++ compiler during coverage builds." FORCE
+set(CMAKE_CXX_FLAGS_COVERAGE
+    ${COVERAGE_COMPILER_FLAGS}
+    CACHE STRING
+    "Flags used by the C++ compiler during coverage builds."
+    FORCE
 )
-set(CMAKE_C_FLAGS_COVERAGE ${COVERAGE_COMPILER_FLAGS}
-    CACHE STRING "Flags used by the C compiler during coverage builds." FORCE
+set(CMAKE_C_FLAGS_COVERAGE
+    ${COVERAGE_COMPILER_FLAGS}
+    CACHE STRING
+    "Flags used by the C compiler during coverage builds."
+    FORCE
 )
-set(CMAKE_EXE_LINKER_FLAGS_COVERAGE "" CACHE STRING "Flags used for linking binaries during coverage builds." FORCE)
-set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE ""
-    CACHE STRING "Flags used by the shared libraries linker during coverage builds." FORCE
+set(CMAKE_EXE_LINKER_FLAGS_COVERAGE
+    ""
+    CACHE STRING
+    "Flags used for linking binaries during coverage builds."
+    FORCE
+)
+set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
+    ""
+    CACHE STRING
+    "Flags used by the shared libraries linker during coverage builds."
+    FORCE
 )
 mark_as_advanced(
-  CMAKE_Fortran_FLAGS_COVERAGE CMAKE_CXX_FLAGS_COVERAGE CMAKE_C_FLAGS_COVERAGE CMAKE_EXE_LINKER_FLAGS_COVERAGE
-  CMAKE_SHARED_LINKER_FLAGS_COVERAGE
+    CMAKE_Fortran_FLAGS_COVERAGE
+    CMAKE_CXX_FLAGS_COVERAGE
+    CMAKE_C_FLAGS_COVERAGE
+    CMAKE_EXE_LINKER_FLAGS_COVERAGE
+    CMAKE_SHARED_LINKER_FLAGS_COVERAGE
 )
 
-get_property(GENERATOR_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
-if (NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG))
-  message(WARNING "Code coverage results with an optimised (non-Debug) build may be misleading")
-endif () # NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG)
+get_property(
+    GENERATOR_IS_MULTI_CONFIG
+    GLOBAL
+    PROPERTY GENERATOR_IS_MULTI_CONFIG
+)
+if(NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG))
+    message(
+        WARNING
+        "Code coverage results with an optimised (non-Debug) build may be misleading"
+    )
+endif() # NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG)
 
-if (CMAKE_C_COMPILER_ID STREQUAL "GNU" OR CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
-  link_libraries(gcov)
-endif ()
+if(
+    CMAKE_C_COMPILER_ID STREQUAL "GNU"
+    OR CMAKE_Fortran_COMPILER_ID STREQUAL "GNU"
+)
+    link_libraries(gcov)
+endif()
 
 # Defines a target for running and collection code coverage information Builds dependencies, runs the given executable
 # and outputs reports. NOTE! The executable should always have a ZERO as exit code otherwise the coverage generation
@@ -191,171 +233,236 @@ endif ()
 # defaults to xml) EXCLUDE "src/dir1/*" "src/dir2/*"      # Patterns to exclude (can be relative #  to BASE_DIRECTORY,
 # with CMake 3.4+) ) The user can set the variable GCOVR_ADDITIONAL_ARGS to supply additional flags to the GCVOR
 # command.
-function (setup_target_for_coverage_gcovr)
-  set(options NONE)
-  set(oneValueArgs BASE_DIRECTORY NAME FORMAT)
-  set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
-  cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
-
-  if (NOT GCOV_TOOL)
-    message(FATAL_ERROR "Could not find gcov or llvm-cov tool! Aborting...")
-  endif ()
-
-  if (NOT GCOVR_PATH)
-    message(FATAL_ERROR "Could not find gcovr tool! Aborting...")
-  endif ()
-
-  # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR
-  if (DEFINED Coverage_BASE_DIRECTORY)
-    get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE)
-  else ()
-    set(BASEDIR ${PROJECT_SOURCE_DIR})
-  endif ()
-
-  if (NOT DEFINED Coverage_FORMAT)
-    set(Coverage_FORMAT xml)
-  endif ()
-
-  if ("--output" IN_LIST GCOVR_ADDITIONAL_ARGS)
-    message(FATAL_ERROR "Unsupported --output option detected in GCOVR_ADDITIONAL_ARGS! Aborting...")
-  else ()
-    if ((Coverage_FORMAT STREQUAL "html-details") OR (Coverage_FORMAT STREQUAL "html-nested"))
-      set(GCOVR_OUTPUT_FILE ${PROJECT_BINARY_DIR}/${Coverage_NAME}/index.html)
-      set(GCOVR_CREATE_FOLDER ${PROJECT_BINARY_DIR}/${Coverage_NAME})
-    elseif (Coverage_FORMAT STREQUAL "html-single")
-      set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.html)
-    elseif ((Coverage_FORMAT STREQUAL "json-summary") OR (Coverage_FORMAT STREQUAL "json-details")
-            OR (Coverage_FORMAT STREQUAL "coveralls")
+function(setup_target_for_coverage_gcovr)
+    set(options NONE)
+    set(oneValueArgs BASE_DIRECTORY NAME FORMAT)
+    set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
+    cmake_parse_arguments(
+        Coverage
+        "${options}"
+        "${oneValueArgs}"
+        "${multiValueArgs}"
+        ${ARGN}
     )
-      set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.json)
-    elseif (Coverage_FORMAT STREQUAL "txt")
-      set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.txt)
-    elseif (Coverage_FORMAT STREQUAL "csv")
-      set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.csv)
-    else ()
-      set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.xml)
-    endif ()
-  endif ()
 
-  if ((Coverage_FORMAT STREQUAL "cobertura") OR (Coverage_FORMAT STREQUAL "xml"))
-    list(APPEND GCOVR_ADDITIONAL_ARGS --cobertura "${GCOVR_OUTPUT_FILE}")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --cobertura-pretty)
-    set(Coverage_FORMAT cobertura) # overwrite xml
-  elseif (Coverage_FORMAT STREQUAL "sonarqube")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --sonarqube "${GCOVR_OUTPUT_FILE}")
-  elseif (Coverage_FORMAT STREQUAL "json-summary")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --json-summary "${GCOVR_OUTPUT_FILE}")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --json-summary-pretty)
-  elseif (Coverage_FORMAT STREQUAL "json-details")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --json "${GCOVR_OUTPUT_FILE}")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --json-pretty)
-  elseif (Coverage_FORMAT STREQUAL "coveralls")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --coveralls "${GCOVR_OUTPUT_FILE}")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --coveralls-pretty)
-  elseif (Coverage_FORMAT STREQUAL "csv")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --csv "${GCOVR_OUTPUT_FILE}")
-  elseif (Coverage_FORMAT STREQUAL "txt")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --txt "${GCOVR_OUTPUT_FILE}")
-  elseif (Coverage_FORMAT STREQUAL "html-single")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --html "${GCOVR_OUTPUT_FILE}")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --html-self-contained)
-  elseif (Coverage_FORMAT STREQUAL "html-nested")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --html-nested "${GCOVR_OUTPUT_FILE}")
-  elseif (Coverage_FORMAT STREQUAL "html-details")
-    list(APPEND GCOVR_ADDITIONAL_ARGS --html-details "${GCOVR_OUTPUT_FILE}")
-  else ()
-    message(FATAL_ERROR "Unsupported output style ${Coverage_FORMAT}! Aborting...")
-  endif ()
+    if(NOT GCOV_TOOL)
+        message(FATAL_ERROR "Could not find gcov or llvm-cov tool! Aborting...")
+    endif()
 
-  # Collect excludes (CMake 3.4+: Also compute absolute paths)
-  set(GCOVR_EXCLUDES "")
-  foreach (EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_GCOVR_EXCLUDES})
-    if (CMAKE_VERSION VERSION_GREATER 3.4)
-      get_filename_component(EXCLUDE ${EXCLUDE} ABSOLUTE BASE_DIR ${BASEDIR})
-    endif ()
-    list(APPEND GCOVR_EXCLUDES "${EXCLUDE}")
-  endforeach ()
-  list(REMOVE_DUPLICATES GCOVR_EXCLUDES)
+    if(NOT GCOVR_PATH)
+        message(FATAL_ERROR "Could not find gcovr tool! Aborting...")
+    endif()
 
-  # Combine excludes to several -e arguments
-  set(GCOVR_EXCLUDE_ARGS "")
-  foreach (EXCLUDE ${GCOVR_EXCLUDES})
-    list(APPEND GCOVR_EXCLUDE_ARGS "-e")
-    list(APPEND GCOVR_EXCLUDE_ARGS "${EXCLUDE}")
-  endforeach ()
+    # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR
+    if(DEFINED Coverage_BASE_DIRECTORY)
+        get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE)
+    else()
+        set(BASEDIR ${PROJECT_SOURCE_DIR})
+    endif()
 
-  # Set up commands which will be run to generate coverage data Run tests
-  set(GCOVR_EXEC_TESTS_CMD ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS})
+    if(NOT DEFINED Coverage_FORMAT)
+        set(Coverage_FORMAT xml)
+    endif()
 
-  # Create folder
-  if (DEFINED GCOVR_CREATE_FOLDER)
-    set(GCOVR_FOLDER_CMD ${CMAKE_COMMAND} -E make_directory ${GCOVR_CREATE_FOLDER})
-  else ()
-    set(GCOVR_FOLDER_CMD echo) # dummy
-  endif ()
+    if("--output" IN_LIST GCOVR_ADDITIONAL_ARGS)
+        message(
+            FATAL_ERROR
+            "Unsupported --output option detected in GCOVR_ADDITIONAL_ARGS! Aborting..."
+        )
+    else()
+        if(
+            (Coverage_FORMAT STREQUAL "html-details")
+            OR (Coverage_FORMAT STREQUAL "html-nested")
+        )
+            set(GCOVR_OUTPUT_FILE
+                ${PROJECT_BINARY_DIR}/${Coverage_NAME}/index.html
+            )
+            set(GCOVR_CREATE_FOLDER ${PROJECT_BINARY_DIR}/${Coverage_NAME})
+        elseif(Coverage_FORMAT STREQUAL "html-single")
+            set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.html)
+        elseif(
+            (Coverage_FORMAT STREQUAL "json-summary")
+            OR (Coverage_FORMAT STREQUAL "json-details")
+            OR (Coverage_FORMAT STREQUAL "coveralls")
+        )
+            set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.json)
+        elseif(Coverage_FORMAT STREQUAL "txt")
+            set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.txt)
+        elseif(Coverage_FORMAT STREQUAL "csv")
+            set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.csv)
+        else()
+            set(GCOVR_OUTPUT_FILE ${Coverage_NAME}.xml)
+        endif()
+    endif()
 
-  # Running gcovr
-  set(GCOVR_CMD
-      ${GCOVR_PATH}
-      --gcov-executable
-      ${GCOV_TOOL}
-      --gcov-ignore-parse-errors=negative_hits.warn_once_per_file
-      -r
-      ${BASEDIR}
-      ${GCOVR_ADDITIONAL_ARGS}
-      ${GCOVR_EXCLUDE_ARGS}
-      --object-directory=${PROJECT_BINARY_DIR}
-  )
+    if(
+        (Coverage_FORMAT STREQUAL "cobertura")
+        OR (Coverage_FORMAT STREQUAL "xml")
+    )
+        list(APPEND GCOVR_ADDITIONAL_ARGS --cobertura "${GCOVR_OUTPUT_FILE}")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --cobertura-pretty)
+        set(Coverage_FORMAT cobertura) # overwrite xml
+    elseif(Coverage_FORMAT STREQUAL "sonarqube")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --sonarqube "${GCOVR_OUTPUT_FILE}")
+    elseif(Coverage_FORMAT STREQUAL "json-summary")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --json-summary "${GCOVR_OUTPUT_FILE}")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --json-summary-pretty)
+    elseif(Coverage_FORMAT STREQUAL "json-details")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --json "${GCOVR_OUTPUT_FILE}")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --json-pretty)
+    elseif(Coverage_FORMAT STREQUAL "coveralls")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --coveralls "${GCOVR_OUTPUT_FILE}")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --coveralls-pretty)
+    elseif(Coverage_FORMAT STREQUAL "csv")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --csv "${GCOVR_OUTPUT_FILE}")
+    elseif(Coverage_FORMAT STREQUAL "txt")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --txt "${GCOVR_OUTPUT_FILE}")
+    elseif(Coverage_FORMAT STREQUAL "html-single")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --html "${GCOVR_OUTPUT_FILE}")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --html-self-contained)
+    elseif(Coverage_FORMAT STREQUAL "html-nested")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --html-nested "${GCOVR_OUTPUT_FILE}")
+    elseif(Coverage_FORMAT STREQUAL "html-details")
+        list(APPEND GCOVR_ADDITIONAL_ARGS --html-details "${GCOVR_OUTPUT_FILE}")
+    else()
+        message(
+            FATAL_ERROR
+            "Unsupported output style ${Coverage_FORMAT}! Aborting..."
+        )
+    endif()
 
-  if (CODE_COVERAGE_VERBOSE)
-    message(STATUS "Executed command report")
+    # Collect excludes (CMake 3.4+: Also compute absolute paths)
+    set(GCOVR_EXCLUDES "")
+    foreach(
+        EXCLUDE
+        ${Coverage_EXCLUDE}
+        ${COVERAGE_EXCLUDES}
+        ${COVERAGE_GCOVR_EXCLUDES}
+    )
+        if(CMAKE_VERSION VERSION_GREATER 3.4)
+            get_filename_component(
+                EXCLUDE
+                ${EXCLUDE}
+                ABSOLUTE
+                BASE_DIR ${BASEDIR}
+            )
+        endif()
+        list(APPEND GCOVR_EXCLUDES "${EXCLUDE}")
+    endforeach()
+    list(REMOVE_DUPLICATES GCOVR_EXCLUDES)
 
-    message(STATUS "Command to run tests: ")
-    string(REPLACE ";" " " GCOVR_EXEC_TESTS_CMD_SPACED "${GCOVR_EXEC_TESTS_CMD}")
-    message(STATUS "${GCOVR_EXEC_TESTS_CMD_SPACED}")
+    # Combine excludes to several -e arguments
+    set(GCOVR_EXCLUDE_ARGS "")
+    foreach(EXCLUDE ${GCOVR_EXCLUDES})
+        list(APPEND GCOVR_EXCLUDE_ARGS "-e")
+        list(APPEND GCOVR_EXCLUDE_ARGS "${EXCLUDE}")
+    endforeach()
 
-    if (NOT GCOVR_FOLDER_CMD STREQUAL "echo")
-      message(STATUS "Command to create a folder: ")
-      string(REPLACE ";" " " GCOVR_FOLDER_CMD_SPACED "${GCOVR_FOLDER_CMD}")
-      message(STATUS "${GCOVR_FOLDER_CMD_SPACED}")
-    endif ()
+    # Set up commands which will be run to generate coverage data Run tests
+    set(GCOVR_EXEC_TESTS_CMD ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS})
 
-    message(STATUS "Command to generate gcovr coverage data: ")
-    string(REPLACE ";" " " GCOVR_CMD_SPACED "${GCOVR_CMD}")
-    message(STATUS "${GCOVR_CMD_SPACED}")
-  endif ()
+    # Create folder
+    if(DEFINED GCOVR_CREATE_FOLDER)
+        set(GCOVR_FOLDER_CMD
+            ${CMAKE_COMMAND}
+            -E
+            make_directory
+            ${GCOVR_CREATE_FOLDER}
+        )
+    else()
+        set(GCOVR_FOLDER_CMD echo) # dummy
+    endif()
 
-  add_custom_target(
-    ${Coverage_NAME}
-    COMMAND ${GCOVR_EXEC_TESTS_CMD}
-    COMMAND ${GCOVR_FOLDER_CMD}
-    COMMAND ${GCOVR_CMD}
-    BYPRODUCTS ${GCOVR_OUTPUT_FILE}
-    WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
-    DEPENDS ${Coverage_DEPENDENCIES}
-    VERBATIM # Protect arguments to commands
-    COMMENT "Running gcovr to produce code coverage report."
-  )
+    # Running gcovr
+    set(GCOVR_CMD
+        ${GCOVR_PATH}
+        --gcov-executable
+        ${GCOV_TOOL}
+        --gcov-ignore-parse-errors=negative_hits.warn_once_per_file
+        -r
+        ${BASEDIR}
+        ${GCOVR_ADDITIONAL_ARGS}
+        ${GCOVR_EXCLUDE_ARGS}
+        --object-directory=${PROJECT_BINARY_DIR}
+    )
 
-  # Show info where to find the report
-  add_custom_command(
-    TARGET ${Coverage_NAME} POST_BUILD COMMAND ;
-    COMMENT "Code coverage report saved in ${GCOVR_OUTPUT_FILE} formatted as ${Coverage_FORMAT}"
-  )
-endfunction () # setup_target_for_coverage_gcovr
+    if(CODE_COVERAGE_VERBOSE)
+        message(STATUS "Executed command report")
 
-function (append_coverage_compiler_flags)
-  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
-  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
-  message(STATUS "Appending code coverage compiler flags: ${COVERAGE_COMPILER_FLAGS}")
-endfunction () # append_coverage_compiler_flags
+        message(STATUS "Command to run tests: ")
+        string(
+            REPLACE ";"
+            " "
+            GCOVR_EXEC_TESTS_CMD_SPACED
+            "${GCOVR_EXEC_TESTS_CMD}"
+        )
+        message(STATUS "${GCOVR_EXEC_TESTS_CMD_SPACED}")
+
+        if(NOT GCOVR_FOLDER_CMD STREQUAL "echo")
+            message(STATUS "Command to create a folder: ")
+            string(
+                REPLACE ";"
+                " "
+                GCOVR_FOLDER_CMD_SPACED
+                "${GCOVR_FOLDER_CMD}"
+            )
+            message(STATUS "${GCOVR_FOLDER_CMD_SPACED}")
+        endif()
+
+        message(STATUS "Command to generate gcovr coverage data: ")
+        string(REPLACE ";" " " GCOVR_CMD_SPACED "${GCOVR_CMD}")
+        message(STATUS "${GCOVR_CMD_SPACED}")
+    endif()
+
+    add_custom_target(
+        ${Coverage_NAME}
+        COMMAND ${GCOVR_EXEC_TESTS_CMD}
+        COMMAND ${GCOVR_FOLDER_CMD}
+        COMMAND ${GCOVR_CMD}
+        BYPRODUCTS ${GCOVR_OUTPUT_FILE}
+        WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+        DEPENDS ${Coverage_DEPENDENCIES}
+        VERBATIM # Protect arguments to commands
+        COMMENT "Running gcovr to produce code coverage report."
+    )
+
+    # Show info where to find the report
+    add_custom_command(
+        TARGET ${Coverage_NAME}
+        POST_BUILD
+        COMMAND ;
+        COMMENT
+            "Code coverage report saved in ${GCOVR_OUTPUT_FILE} formatted as ${Coverage_FORMAT}"
+    )
+endfunction() # setup_target_for_coverage_gcovr
+
+function(append_coverage_compiler_flags)
+    set(CMAKE_C_FLAGS
+        "${CMAKE_C_FLAGS} ${COVERAGE_COMPILER_FLAGS}"
+        PARENT_SCOPE
+    )
+    set(CMAKE_CXX_FLAGS
+        "${CMAKE_CXX_FLAGS} ${COVERAGE_COMPILER_FLAGS}"
+        PARENT_SCOPE
+    )
+    set(CMAKE_Fortran_FLAGS
+        "${CMAKE_Fortran_FLAGS} ${COVERAGE_COMPILER_FLAGS}"
+        PARENT_SCOPE
+    )
+    message(
+        STATUS
+        "Appending code coverage compiler flags: ${COVERAGE_COMPILER_FLAGS}"
+    )
+endfunction() # append_coverage_compiler_flags
 
 # Setup coverage for specific library
-function (append_coverage_compiler_flags_to_target name mode)
-  separate_arguments(_flag_list NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}")
-  target_compile_options(${name} ${mode} ${_flag_list})
-  if (CMAKE_C_COMPILER_ID STREQUAL "GNU" OR CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
-    target_link_libraries(${name} ${mode} gcov)
-  endif ()
-endfunction ()
+function(append_coverage_compiler_flags_to_target name mode)
+    separate_arguments(_flag_list NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}")
+    target_compile_options(${name} ${mode} ${_flag_list})
+    if(
+        CMAKE_C_COMPILER_ID STREQUAL "GNU"
+        OR CMAKE_Fortran_COMPILER_ID STREQUAL "GNU"
+    )
+        target_link_libraries(${name} ${mode} gcov)
+    endif()
+endfunction()

cmake/Docs.cmake

@@ -12,9 +12,9 @@ set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
 configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT})
 add_custom_target(
-  docs
-  COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
-  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-  COMMENT "Generating API documentation with Doxygen"
-  VERBATIM
+    docs
+    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Generating API documentation with Doxygen"
+    VERBATIM
 )

cmake/Linker.cmake

@@ -1,11 +1,11 @@
-if (DEFINED CMAKE_LINKER_TYPE)
-  message(STATUS "Custom linker is already set: ${CMAKE_LINKER_TYPE}")
-  return()
-endif ()
+if(DEFINED CMAKE_LINKER_TYPE)
+    message(STATUS "Custom linker is already set: ${CMAKE_LINKER_TYPE}")
+    return()
+endif()
 
 find_program(MOLD_PATH mold)
 
-if (MOLD_PATH AND CMAKE_SYSTEM_NAME STREQUAL "Linux")
-  message(STATUS "Using Mold linker: ${MOLD_PATH}")
-  set(CMAKE_LINKER_TYPE MOLD)
-endif ()
+if(MOLD_PATH AND CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    message(STATUS "Using Mold linker: ${MOLD_PATH}")
+    set(CMAKE_LINKER_TYPE MOLD)
+endif()

cmake/Settings.cmake

@@ -30,53 +30,58 @@ set(COMPILER_FLAGS
 # TODO: re-enable when we change CI #884 if (is_gcc AND NOT lint) list(APPEND COMPILER_FLAGS -Wduplicated-branches
 # -Wduplicated-cond -Wlogical-op -Wuseless-cast ) endif ()
 
-if (is_clang)
-  list(APPEND COMPILER_FLAGS -Wshadow # gcc is to aggressive with shadowing
-                                      # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78147
-  )
-endif ()
+if(is_clang)
+    # gcc is too aggressive with shadowing
+    # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78147
+    list(APPEND COMPILER_FLAGS -Wshadow)
+endif()
 
-if (is_appleclang)
-  list(APPEND COMPILER_FLAGS -Wreorder-init-list)
-endif ()
+if(is_appleclang)
+    list(APPEND COMPILER_FLAGS -Wreorder-init-list)
+endif()
 
-if (san)
-  # When building with sanitizers some compilers will actually produce extra warnings/errors. We don't want this yet, at
-  # least not until we have fixed all runtime issues reported by the sanitizers. Once that is done we can start removing
-  # some of these and trying to fix it in our codebase. We can never remove all of below because most of them are
-  # reported from deep inside libraries like boost or libxrpl.
-  #
-  # TODO: Address in https://github.com/XRPLF/clio/issues/1885
-  list(
-    APPEND
-    COMPILER_FLAGS
-    -Wno-error=tsan # Disables treating TSAN warnings as errors
-    -Wno-tsan # Disables TSAN warnings (thread-safety analysis)
-    -Wno-uninitialized # Disables warnings about uninitialized variables (AddressSanitizer, UndefinedBehaviorSanitizer,
-                       # etc.)
-    -Wno-stringop-overflow # Disables warnings about potential string operation overflows (AddressSanitizer)
-    -Wno-unsafe-buffer-usage # Disables warnings about unsafe memory operations (AddressSanitizer)
-    -Wno-frame-larger-than # Disables warnings about stack frame size being too large (AddressSanitizer)
-    -Wno-unused-function # Disables warnings about unused functions (LeakSanitizer, memory-related issues)
-    -Wno-unused-but-set-variable # Disables warnings about unused variables (MemorySanitizer)
-    -Wno-thread-safety-analysis # Disables warnings related to thread safety usage (ThreadSanitizer)
-    -Wno-thread-safety # Disables warnings related to thread safety usage (ThreadSanitizer)
-    -Wno-sign-compare # Disables warnings about signed/unsigned comparison (UndefinedBehaviorSanitizer)
-    -Wno-nonnull # Disables warnings related to null pointer dereferencing (UndefinedBehaviorSanitizer)
-    -Wno-address # Disables warnings about address-related issues (UndefinedBehaviorSanitizer)
-    -Wno-array-bounds # Disables array bounds checks (UndefinedBehaviorSanitizer)
-  )
-endif ()
+if(san)
+    # When building with sanitizers some compilers will actually produce extra warnings/errors. We don't want this yet,
+    # at least not until we have fixed all runtime issues reported by the sanitizers. Once that is done we can start
+    # removing some of these and trying to fix it in our codebase. We can never remove all of below because most of them
+    # are reported from deep inside libraries like boost or libxrpl.
+    #
+    # TODO: Address in https://github.com/XRPLF/clio/issues/1885
+    list(
+        APPEND COMPILER_FLAGS
+        -Wno-error=tsan # Disables treating TSAN warnings as errors
+        -Wno-tsan # Disables TSAN warnings (thread-safety analysis)
+        -Wno-uninitialized # Disables warnings about uninitialized variables (AddressSanitizer,
+        # UndefinedBehaviorSanitizer, etc.)
+        -Wno-stringop-overflow # Disables warnings about potential string operation overflows (AddressSanitizer)
+        -Wno-unsafe-buffer-usage # Disables warnings about unsafe memory operations (AddressSanitizer)
+        -Wno-frame-larger-than # Disables warnings about stack frame size being too large (AddressSanitizer)
+        -Wno-unused-function # Disables warnings about unused functions (LeakSanitizer, memory-related issues)
+        -Wno-unused-but-set-variable # Disables warnings about unused variables (MemorySanitizer)
+        -Wno-thread-safety-analysis # Disables warnings related to thread safety usage (ThreadSanitizer)
+        -Wno-thread-safety # Disables warnings related to thread safety usage (ThreadSanitizer)
+        -Wno-sign-compare # Disables warnings about signed/unsigned comparison (UndefinedBehaviorSanitizer)
+        -Wno-nonnull # Disables warnings related to null pointer dereferencing (UndefinedBehaviorSanitizer)
+        -Wno-address # Disables warnings about address-related issues (UndefinedBehaviorSanitizer)
+        -Wno-array-bounds # Disables array bounds checks (UndefinedBehaviorSanitizer)
+    )
+endif()
 
 # See https://github.com/cpp-best-practices/cppbestpractices/blob/master/02-Use_the_Tools_Available.md#gcc--clang for
 # the flags description
 
-if (time_trace)
-  if (is_clang OR is_appleclang)
-    list(APPEND COMPILER_FLAGS -ftime-trace)
-  else ()
-    message(FATAL_ERROR "Clang or AppleClang is required to use `-ftime-trace`")
-  endif ()
-endif ()
+if(time_trace)
+    if(is_clang OR is_appleclang)
+        list(APPEND COMPILER_FLAGS -ftime-trace)
+    else()
+        message(
+            FATAL_ERROR
+            "Clang or AppleClang is required to use `-ftime-trace`"
+        )
+    endif()
+endif()
 
 target_compile_options(clio_options INTERFACE ${COMPILER_FLAGS})
+
+# Add debug symbols for all builds, including Release. This is needed to get useful stack traces in production.
+target_compile_options(clio_options INTERFACE -g)

cmake/SourceLocation.cmake

@@ -1,11 +1,17 @@
 include(CheckIncludeFileCXX)
 
 check_include_file_cxx("source_location" SOURCE_LOCATION_AVAILABLE)
-if (SOURCE_LOCATION_AVAILABLE)
-  target_compile_definitions(clio_options INTERFACE "HAS_SOURCE_LOCATION")
-endif ()
+if(SOURCE_LOCATION_AVAILABLE)
+    target_compile_definitions(clio_options INTERFACE "HAS_SOURCE_LOCATION")
+endif()
 
-check_include_file_cxx("experimental/source_location" EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)
-if (EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)
-  target_compile_definitions(clio_options INTERFACE "HAS_EXPERIMENTAL_SOURCE_LOCATION")
-endif ()
+check_include_file_cxx(
+    "experimental/source_location"
+    EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE
+)
+if(EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)
+    target_compile_definitions(
+        clio_options
+        INTERFACE "HAS_EXPERIMENTAL_SOURCE_LOCATION"
+    )
+endif()

cmake/deps/Boost.cmake

@@ -1,4 +1,10 @@
 set(Boost_USE_STATIC_LIBS ON)
 set(Boost_USE_STATIC_RUNTIME ON)
 
-find_package(Boost 1.82 REQUIRED CONFIG COMPONENTS program_options coroutine system log log_setup)
+find_package(
+    Boost
+    1.82
+    REQUIRED
+    CONFIG
+    COMPONENTS program_options coroutine system log log_setup
+)

cmake/deps/OpenSSL.cmake

@@ -1,3 +1,6 @@
 find_package(OpenSSL 1.1.1 REQUIRED CONFIG)
 
-set_target_properties(OpenSSL::SSL PROPERTIES INTERFACE_COMPILE_DEFINITIONS OPENSSL_NO_SSL2)
+set_target_properties(
+    OpenSSL::SSL
+    PROPERTIES INTERFACE_COMPILE_DEFINITIONS OPENSSL_NO_SSL2
+)

cmake/deps/libbacktrace.cmake

@@ -1,11 +1,14 @@
-if ("${san}" STREQUAL "")
-  target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_LINK)
-  target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_USE_BACKTRACE)
-  find_package(libbacktrace REQUIRED CONFIG)
-else ()
-  # Some sanitizers (TSAN and ASAN for sure) can't be used with libbacktrace because they have their own backtracing
-  # capabilities and there are conflicts. In any case, this makes sure Clio code knows that backtrace is not available.
-  # See relevant conan profiles for sanitizers where we disable stacktrace in Boost explicitly.
-  target_compile_definitions(clio_options INTERFACE CLIO_WITHOUT_STACKTRACE)
-  message(STATUS "Sanitizer enabled, disabling stacktrace")
-endif ()
+if("${san}" STREQUAL "")
+    target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_LINK)
+    target_compile_definitions(
+        clio_options
+        INTERFACE BOOST_STACKTRACE_USE_BACKTRACE
+    )
+    find_package(libbacktrace REQUIRED CONFIG)
+else()
+    # Some sanitizers (TSAN and ASAN for sure) can't be used with libbacktrace because they have their own backtracing
+    # capabilities and there are conflicts. In any case, this makes sure Clio code knows that backtrace is not
+    # available. See relevant conan profiles for sanitizers where we disable stacktrace in Boost explicitly.
+    target_compile_definitions(clio_options INTERFACE CLIO_WITHOUT_STACKTRACE)
+    message(STATUS "Sanitizer enabled, disabling stacktrace")
+endif()

cmake/deps/spdlog.cmake

@@ -1,5 +1,5 @@
 find_package(spdlog REQUIRED)
 
-if (NOT TARGET spdlog::spdlog)
-  message(FATAL_ERROR "spdlog::spdlog target not found")
-endif ()
+if(NOT TARGET spdlog::spdlog)
+    message(FATAL_ERROR "spdlog::spdlog target not found")
+endif()

cmake/install/clio.service.in

@@ -0,0 +1,17 @@
+[Unit]
+Description=Clio XRPL API server
+Documentation=https://github.com/XRPLF/clio.git
+
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=simple
+ExecStart=@CLIO_INSTALL_DIR@/bin/clio_server @CLIO_INSTALL_DIR@/etc/config.json
+Restart=on-failure
+User=clio
+Group=clio
+LimitNOFILE=65536
+
+[Install]
+WantedBy=multi-user.target

cmake/install/install.cmake

@@ -1,5 +1,10 @@
 set(CLIO_INSTALL_DIR "/opt/clio")
-set(CMAKE_INSTALL_PREFIX "${CLIO_INSTALL_DIR}" CACHE PATH "Install prefix" FORCE)
+set(CMAKE_INSTALL_PREFIX
+    "${CLIO_INSTALL_DIR}"
+    CACHE PATH
+    "Install prefix"
+    FORCE
+)
 
 set(CPACK_PACKAGING_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}")
 
@@ -10,4 +15,17 @@ install(TARGETS clio_server DESTINATION "${CMAKE_INSTALL_BINDIR}")
 file(READ docs/examples/config/example-config.json config)
 string(REGEX REPLACE "./clio_log" "/var/log/clio/" config "${config}")
 file(WRITE ${CMAKE_BINARY_DIR}/install-config.json "${config}")
-install(FILES ${CMAKE_BINARY_DIR}/install-config.json DESTINATION etc RENAME config.json)
+install(
+    FILES ${CMAKE_BINARY_DIR}/install-config.json
+    DESTINATION etc
+    RENAME config.json
+)
+
+configure_file(
+    "${CMAKE_SOURCE_DIR}/cmake/install/clio.service.in"
+    "${CMAKE_BINARY_DIR}/clio.service"
+)
+install(
+    FILES "${CMAKE_BINARY_DIR}/clio.service"
+    DESTINATION /lib/systemd/system
+)

cmake/pkg/postinst

@@ -10,37 +10,36 @@ CLIO_BIN="$CLIO_PREFIX/bin/${CLIO_EXECUTABLE}"
 CLIO_CONFIG="$CLIO_PREFIX/etc/config.json"
 
 case "$1" in
-    configure)
-        if ! id -u "$USER_NAME" >/dev/null 2>&1; then
-            # Users who should not have a home directory should have their home directory set to /nonexistent
-            # https://www.debian.org/doc/debian-policy/ch-opersys.html#non-existent-home-directories
-            useradd \
-                --system \
-                --home-dir /nonexistent \
-                --no-create-home \
-                --shell /usr/sbin/nologin \
-                --comment "system user for ${CLIO_EXECUTABLE}" \
-                --user-group \
-                ${USER_NAME}
-        fi
+configure)
+    if ! id -u "$USER_NAME" >/dev/null 2>&1; then
+        # Users who should not have a home directory should have their home directory set to /nonexistent
+        # https://www.debian.org/doc/debian-policy/ch-opersys.html#non-existent-home-directories
+        useradd \
+            --system \
+            --home-dir /nonexistent \
+            --no-create-home \
+            --shell /usr/sbin/nologin \
+            --comment "system user for ${CLIO_EXECUTABLE}" \
+            --user-group \
+            ${USER_NAME}
+    fi
 
-        install -d -o "$USER_NAME" -g "$GROUP_NAME" /var/log/clio
+    install -d -o "$USER_NAME" -g "$GROUP_NAME" /var/log/clio
 
-        if [ -f "$CLIO_CONFIG" ]; then
-            chown "$USER_NAME:$GROUP_NAME" "$CLIO_CONFIG"
-        fi
+    if [ -f "$CLIO_CONFIG" ]; then
+        chown "$USER_NAME:$GROUP_NAME" "$CLIO_CONFIG"
+    fi
 
-        chown -R "$USER_NAME:$GROUP_NAME" "$CLIO_PREFIX"
+    chown -R "$USER_NAME:$GROUP_NAME" "$CLIO_PREFIX"
 
-        ln -sf "$CLIO_BIN" "/usr/bin/${CLIO_EXECUTABLE}"
+    ln -sf "$CLIO_BIN" "/usr/bin/${CLIO_EXECUTABLE}"
 
-        ;;
-    abort-upgrade|abort-remove|abort-deconfigure)
-        ;;
-    *)
-        echo "postinst called with unknown argument \`$1'" >&2
-        exit 1
-        ;;
+    ;;
+abort-upgrade | abort-remove | abort-deconfigure) ;;
+*)
+    echo "postinst called with unknown argument \`$1'" >&2
+    exit 1
+    ;;
 esac
 
 exit 0

conan.lock

@@ -1,55 +1,59 @@
 {
     "version": "0.5",
     "requires": [
-        "zlib/1.3.1#b8bc2603263cf7eccbd6e17e66b0ed76%1756234269.497",
-        "xxhash/0.8.3#681d36a0a6111fc56e5e45ea182c19cc%1756234289.683",
-        "xrpl/3.0.0-rc1#f5c8ecd42bdf511ad36f57bc702dacd2%1762975621.294",
-        "sqlite3/3.49.1#8631739a4c9b93bd3d6b753bac548a63%1756234266.869",
-        "spdlog/1.15.3#3ca0e9e6b83af4d0151e26541d140c86%1754401846.61",
-        "soci/4.0.3#a9f8d773cd33e356b5879a4b0564f287%1756234262.318",
-        "re2/20230301#dfd6e2bf050eb90ddd8729cfb4c844a4%1756234257.976",
+        "zlib/1.3.1#b8bc2603263cf7eccbd6e17e66b0ed76%1765850150.075",
+        "xxhash/0.8.3#681d36a0a6111fc56e5e45ea182c19cc%1765850149.987",
+        "xrpl/3.1.0#3d408ab8c8020014fa7dd52bc7cc7ea8%1769706825.165",
+        "sqlite3/3.49.1#8631739a4c9b93bd3d6b753bac548a63%1765850149.926",
+        "spdlog/1.17.0#bcbaaf7147bda6ad24ffbd1ac3d7142c%1768312128.781",
+        "soci/4.0.3#a9f8d773cd33e356b5879a4b0564f287%1765850149.46",
+        "re2/20230301#ca3b241baec15bd31ea9187150e0b333%1765850148.103",
         "rapidjson/cci.20220822#1b9d8c2256876a154172dc5cfbe447c6%1754325007.656",
-        "protobuf/3.21.12#d927114e28de9f4691a6bbcdd9a529d1%1756234251.614",
+        "protobuf/3.21.12#44ee56c0a6eea0c19aeeaca680370b88%1764175361.456",
         "openssl/1.1.1w#a8f0792d7c5121b954578a7149d23e03%1756223730.729",
-        "nudb/2.0.9#fb8dfd1a5557f5e0528114c2da17721e%1763150366.909",
+        "nudb/2.0.9#0432758a24204da08fee953ec9ea03cb%1769436073.32",
         "minizip/1.2.13#9e87d57804bd372d6d1e32b1871517a3%1754325004.374",
-        "lz4/1.10.0#59fc63cac7f10fbe8e05c7e62c2f3504%1756234228.999",
+        "lz4/1.10.0#59fc63cac7f10fbe8e05c7e62c2f3504%1765850143.914",
         "libuv/1.46.0#dc28c1f653fa197f00db5b577a6f6011%1754325003.592",
-        "libiconv/1.17#1e65319e945f2d31941a9d28cc13c058%1756223727.64",
-        "libbacktrace/cci.20210118#a7691bfccd8caaf66309df196790a5a1%1756230911.03",
-        "libarchive/3.8.1#5cf685686322e906cb42706ab7e099a8%1756234256.696",
+        "libiconv/1.17#1e65319e945f2d31941a9d28cc13c058%1765842973.492",
+        "libbacktrace/cci.20210118#a7691bfccd8caaf66309df196790a5a1%1765842973.03",
+        "libarchive/3.8.1#ffee18995c706e02bf96e7a2f7042e0d%1765850144.736",
         "http_parser/2.9.4#98d91690d6fd021e9e624218a85d9d97%1754325001.385",
-        "gtest/1.14.0#f8f0757a574a8dd747d16af62d6eb1b7%1754325000.842",
+        "gtest/1.17.0#5224b3b3ff3b4ce1133cbdd27d53ee7d%1768312129.152",
         "grpc/1.50.1#02291451d1e17200293a409410d1c4e1%1756234248.958",
-        "fmt/11.2.0#579bb2cdf4a7607621beea4eb4651e0f%1754324999.086",
+        "fmt/12.1.0#50abab23274d56bb8f42c94b3b9a40c7%1763984116.926",
         "doctest/2.4.11#a4211dfc329a16ba9f280f9574025659%1756234220.819",
-        "date/3.0.4#f74bbba5a08fa388256688743136cb6f%1756234217.493",
-        "cassandra-cpp-driver/2.17.0#e50919efac8418c26be6671fd702540a%1754324997.363",
-        "c-ares/1.34.5#b78b91e7cfb1f11ce777a285bbf169c6%1756234217.915",
-        "bzip2/1.0.8#00b4a4658791c1f06914e087f0e792f5%1756234261.716",
-        "boost/1.83.0#5d975011d65b51abb2d2f6eb8386b368%1754325043.336",
+        "date/3.0.4#862e11e80030356b53c2c38599ceb32b%1765850143.772",
+        "cassandra-cpp-driver/2.17.0#bd3934138689482102c265d01288a316%1764175359.611",
+        "c-ares/1.34.5#5581c2b62a608b40bb85d965ab3ec7c8%1765850144.336",
+        "bzip2/1.0.8#c470882369c2d95c5c77e970c0c7e321%1765850143.837",
+        "boost/1.83.0#91d8b1572534d2c334d6790e3c34d0c1%1764175359.61",
         "benchmark/1.9.4#ce4403f7a24d3e1f907cd9da4b678be4%1754578869.672",
-        "abseil/20230802.1#f0f91485b111dc9837a68972cb19ca7b%1756234220.907"
+        "abseil/20230802.1#90ba607d4ee8fb5fb157c3db540671fc%1764175359.429"
     ],
     "build_requires": [
-        "zlib/1.3.1#b8bc2603263cf7eccbd6e17e66b0ed76%1756234269.497",
-        "protobuf/3.21.12#d927114e28de9f4691a6bbcdd9a529d1%1756234251.614",
-        "cmake/3.31.8#dde3bde00bb843687e55aea5afa0e220%1756234232.89",
-        "b2/5.3.3#107c15377719889654eb9a162a673975%1756234226.28"
+        "zlib/1.3.1#b8bc2603263cf7eccbd6e17e66b0ed76%1765850150.075",
+        "protobuf/3.21.12#44ee56c0a6eea0c19aeeaca680370b88%1764175361.456",
+        "cmake/4.2.0#ae0a44f44a1ef9ab68fd4b3e9a1f8671%1765850153.937",
+        "cmake/3.31.10#313d16a1aa16bbdb2ca0792467214b76%1765850153.479",
+        "b2/5.3.3#107c15377719889654eb9a162a673975%1765850144.355"
     ],
     "python_requires": [],
     "overrides": {
-        "boost/1.83.0": [
+        "protobuf/3.21.12#44ee56c0a6eea0c19aeeaca680370b88": [
             null,
-            "boost/1.83.0#5d975011d65b51abb2d2f6eb8386b368"
+            "protobuf/3.21.12"
         ],
-        "protobuf/3.21.12": [
+        "boost/1.83.0#91d8b1572534d2c334d6790e3c34d0c1": [
             null,
-            "protobuf/3.21.12#d927114e28de9f4691a6bbcdd9a529d1"
+            "boost/1.83.0#91d8b1572534d2c334d6790e3c34d0c1"
         ],
         "lz4/1.9.4": [
             "lz4/1.10.0"
         ],
+        "boost/1.90.0": [
+            "boost/1.83.0"
+        ],
         "sqlite3/3.44.2": [
             "sqlite3/3.49.1"
         ]

conanfile.py

@@ -3,62 +3,60 @@ from conan.tools.cmake import CMake, CMakeToolchain, cmake_layout
 
 
 class ClioConan(ConanFile):
-    name = 'clio'
-    license = 'ISC'
-    author = 'Alex Kremer <akremer@ripple.com>, John Freeman <jfreeman@ripple.com>, Ayaz Salikhov <asalikhov@ripple.com>'
-    url = 'https://github.com/xrplf/clio'
-    description = 'Clio RPC server'
-    settings = 'os', 'compiler', 'build_type', 'arch'
+    name = "clio"
+    license = "ISC"
+    author = "Alex Kremer <akremer@ripple.com>, John Freeman <jfreeman@ripple.com>, Ayaz Salikhov <asalikhov@ripple.com>"
+    url = "https://github.com/xrplf/clio"
+    description = "Clio RPC server"
+    settings = "os", "compiler", "build_type", "arch"
     options = {}
 
     requires = [
-        'boost/1.83.0',
-        'cassandra-cpp-driver/2.17.0',
-        'fmt/11.2.0',
-        'protobuf/3.21.12',
-        'grpc/1.50.1',
-        'openssl/1.1.1w',
-        'xrpl/3.0.0-rc1',
-        'zlib/1.3.1',
-        'libbacktrace/cci.20210118',
-        'spdlog/1.15.3',
+        "cassandra-cpp-driver/2.17.0",
+        "fmt/12.1.0",
+        "grpc/1.50.1",
+        "libbacktrace/cci.20210118",
+        "openssl/1.1.1w",
+        "protobuf/3.21.12",
+        "spdlog/1.17.0",
+        "xrpl/3.1.0",
+        "zlib/1.3.1",
     ]
 
     default_options = {
-        'xrpl/*:tests': False,
-        'xrpl/*:rocksdb': False,
-        'cassandra-cpp-driver/*:shared': False,
-        'date/*:header_only': True,
-        'grpc/*:shared': False,
-        'grpc/*:secure': True,
-        'libpq/*:shared': False,
-        'lz4/*:shared': False,
-        'openssl/*:shared': False,
-        'protobuf/*:shared': False,
-        'protobuf/*:with_zlib': True,
-        'snappy/*:shared': False,
-        'gtest/*:no_main': True,
+        "cassandra-cpp-driver/*:shared": False,
+        "date/*:header_only": True,
+        "grpc/*:secure": True,
+        "grpc/*:shared": False,
+        "gtest/*:no_main": True,
+        "libpq/*:shared": False,
+        "lz4/*:shared": False,
+        "openssl/*:shared": False,
+        "protobuf/*:shared": False,
+        "protobuf/*:with_zlib": True,
+        "snappy/*:shared": False,
+        "xrpl/*:rocksdb": False,
+        "xrpl/*:tests": False,
     }
 
-    exports_sources = (
-        'CMakeLists.txt', 'cmake/*', 'src/*'
-    )
+    exports_sources = ("CMakeLists.txt", "cmake/*", "src/*")
 
     def requirements(self):
-        self.requires('gtest/1.14.0')
-        self.requires('benchmark/1.9.4')
+        self.requires("boost/1.83.0", force=True)
+        self.requires("gtest/1.17.0")
+        self.requires("benchmark/1.9.4")
 
     def configure(self):
-        if self.settings.compiler == 'apple-clang':
-            self.options['boost'].visibility = 'global'
+        if self.settings.compiler == "apple-clang":
+            self.options["boost"].visibility = "global"
 
     def layout(self):
         cmake_layout(self)
         # Fix this setting to follow the default introduced in Conan 1.48
         # to align with our build instructions.
-        self.folders.generators = 'build/generators'
+        self.folders.generators = "build/generators"
 
-    generators = 'CMakeDeps'
+    generators = "CMakeDeps"
 
     def generate(self):
         tc = CMakeToolchain(self)

docker/ci/Dockerfile

@@ -36,7 +36,6 @@ RUN apt-get update \
         libmpfr-dev \
         libncurses-dev \
         make \
-        ninja-build \
         wget \
         zip \
     && apt-get clean \
@@ -55,7 +54,7 @@ RUN pip install -q --no-cache-dir \
         # lxml 6.0.0 is not compatible with our image
         'lxml<6.0.0' \
         cmake \
-        conan==2.22.1 \
+        conan==2.24.0 \
         gcovr \
         # We're adding pre-commit to this image as well,
         # because clang-tidy workflow requires it
@@ -107,6 +106,7 @@ COPY --from=clio-tools \
     /usr/local/bin/git-cliff \
     /usr/local/bin/gh \
     /usr/local/bin/gdb \
+    /usr/local/bin/ninja \
     /usr/local/bin/
 
 WORKDIR /root

docker/ci/README.md

@@ -5,16 +5,17 @@ It is used in [Clio Github Actions](https://github.com/XRPLF/clio/actions) but c
 
 The image is based on Ubuntu 20.04 and contains:
 
-- ccache 4.12.1
+- ccache 4.12.2
 - Clang 19
 - ClangBuildAnalyzer 1.6.0
-- Conan 2.22.1
-- Doxygen 1.15.0
+- Conan 2.24.0
+- Doxygen 1.16.1
 - GCC 15.2.0
-- GDB 16.3
-- gh 2.82.1
-- git-cliff 2.10.1
+- GDB 17.1
+- gh 2.83.2
+- git-cliff 2.11.0
 - mold 2.40.4
+- Ninja 1.13.2
 - Python 3.8
 - and some other useful tools
 

docker/develop/compose.yaml

@@ -1,6 +1,6 @@
 services:
   clio_develop:
-    image: ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+    image: ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
     volumes:
       - clio_develop_conan_data:/root/.conan2/p
       - clio_develop_ccache:/root/.ccache

docker/develop/run

@@ -2,7 +2,7 @@
 
 script_dir=$(dirname $0)
 
-pushd $script_dir > /dev/null
+pushd $script_dir >/dev/null
 
 function start_container {
     if [ -z "$(docker ps -q -f name=clio_develop)" ]; then
@@ -41,21 +41,26 @@ EOF
 }
 
 case $1 in
-    -h|--help)
-        print_help ;;
+-h | --help)
+    print_help
+    ;;
 
-    -t|--terminal)
-        open_terminal ;;
+-t | --terminal)
+    open_terminal
+    ;;
 
-    -s|--stop)
-        stop_container ;;
+-s | --stop)
+    stop_container
+    ;;
 
-    -*)
-        echo "Unknown option: $1"
-        print_help ;;
+-*)
+    echo "Unknown option: $1"
+    print_help
+    ;;
 
-    *)
-        run "$@" ;;
+*)
+    run "$@"
+    ;;
 esac
 
-popd > /dev/null
+popd >/dev/null

docker/tools/Dockerfile

@@ -12,7 +12,6 @@ ARG BUILD_VERSION=0
 
 RUN apt-get update \
     && apt-get install -y --no-install-recommends --no-install-suggests \
-        ninja-build \
         python3 \
         python3-pip \
         software-properties-common \
@@ -24,6 +23,15 @@ RUN apt-get update \
 
 WORKDIR /tmp
 
+ARG NINJA_VERSION=1.13.2
+
+RUN wget --progress=dot:giga "https://github.com/ninja-build/ninja/archive/refs/tags/v${NINJA_VERSION}.tar.gz" \
+    && tar xf "v${NINJA_VERSION}.tar.gz" \
+    && cd "ninja-${NINJA_VERSION}" \
+    && ./configure.py --bootstrap \
+    && mv ninja /usr/local/bin/ninja \
+    && rm -rf /tmp/* /var/tmp/*
+
 ARG MOLD_VERSION=2.40.4
 RUN wget --progress=dot:giga "https://github.com/rui314/mold/archive/refs/tags/v${MOLD_VERSION}.tar.gz" \
     && tar xf "v${MOLD_VERSION}.tar.gz" \
@@ -34,7 +42,7 @@ RUN wget --progress=dot:giga "https://github.com/rui314/mold/archive/refs/tags/v
     && ninja install \
     && rm -rf /tmp/* /var/tmp/*
 
-ARG CCACHE_VERSION=4.12.1
+ARG CCACHE_VERSION=4.12.2
 RUN wget --progress=dot:giga "https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz" \
     && tar xf "ccache-${CCACHE_VERSION}.tar.gz" \
     && cd "ccache-${CCACHE_VERSION}" \
@@ -51,7 +59,7 @@ RUN apt-get update \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-ARG DOXYGEN_VERSION=1.15.0
+ARG DOXYGEN_VERSION=1.16.1
 RUN wget --progress=dot:giga "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.src.tar.gz" \
     && tar xf "doxygen-${DOXYGEN_VERSION}.src.tar.gz" \
     && cd "doxygen-${DOXYGEN_VERSION}" \
@@ -71,13 +79,13 @@ RUN wget --progress=dot:giga "https://github.com/aras-p/ClangBuildAnalyzer/archi
     && ninja install \
     && rm -rf /tmp/* /var/tmp/*
 
-ARG GIT_CLIFF_VERSION=2.10.1
+ARG GIT_CLIFF_VERSION=2.11.0
 RUN wget --progress=dot:giga "https://github.com/orhun/git-cliff/releases/download/v${GIT_CLIFF_VERSION}/git-cliff-${GIT_CLIFF_VERSION}-x86_64-unknown-linux-musl.tar.gz" \
     && tar xf git-cliff-${GIT_CLIFF_VERSION}-x86_64-unknown-linux-musl.tar.gz \
     && mv git-cliff-${GIT_CLIFF_VERSION}/git-cliff /usr/local/bin/git-cliff \
     && rm -rf /tmp/* /var/tmp/*
 
-ARG GH_VERSION=2.82.1
+ARG GH_VERSION=2.83.2
 RUN wget --progress=dot:giga "https://github.com/cli/cli/releases/download/v${GH_VERSION}/gh_${GH_VERSION}_linux_${TARGETARCH}.tar.gz" \
     && tar xf gh_${GH_VERSION}_linux_${TARGETARCH}.tar.gz \
     && mv gh_${GH_VERSION}_linux_${TARGETARCH}/bin/gh /usr/local/bin/gh \
@@ -92,7 +100,7 @@ RUN apt-get update \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-ARG GDB_VERSION=16.3
+ARG GDB_VERSION=17.1
 RUN wget --progress=dot:giga "https://sourceware.org/pub/gdb/releases/gdb-${GDB_VERSION}.tar.gz" \
     && tar xf "gdb-${GDB_VERSION}.tar.gz" \
     && cd "gdb-${GDB_VERSION}" \

docs/build-clio.md

@@ -97,30 +97,14 @@ Now you should be able to download the prebuilt dependencies (including `xrpl` p
 
 #### Conan lockfile
 
-To achieve reproducible dependencies, we use [Conan lockfile](https://docs.conan.io/2/tutorial/versioning/lockfiles.html).
+To achieve reproducible dependencies, we use a [Conan lockfile](https://docs.conan.io/2/tutorial/versioning/lockfiles.html).
 
 The `conan.lock` file in the repository contains a "snapshot" of the current dependencies.
 It is implicitly used when running `conan` commands, you don't need to specify it.
 
 You have to update this file every time you add a new dependency or change a revision or version of an existing dependency.
 
-> [!NOTE]
-> Conan uses local cache by default when creating a lockfile.
->
-> To ensure, that lockfile creation works the same way on all developer machines, you should clear the local cache before creating a new lockfile.
-
-To create a new lockfile, run the following commands in the repository root:
-
-```bash
-conan remove '*' --confirm
-rm conan.lock
-# This ensure that xrplf remote is the first to be consulted
-conan remote add --force --index 0 xrplf https://conan.ripplex.io
-conan lock create .
-```
-
-> [!NOTE]
-> If some dependencies are exclusive for some OS, you may need to run the last command for them adding `--profile:all <PROFILE>`.
+To update a lockfile, run from the repository root: `./.github/scripts/conan/regenerate_lockfile.sh`
 
 ## Building Clio
 
@@ -191,7 +175,7 @@ Open the `index.html` file in your browser to see the documentation pages.
 It is also possible to build Clio using [Docker](https://www.docker.com/) if you don't want to install all the dependencies on your machine.
 
 ```sh
-docker run -it ghcr.io/xrplf/clio-ci:77387d8f9f13aea8f23831d221ac3e7683bb69b7
+docker run -it ghcr.io/xrplf/clio-ci:14342e087ceb8b593027198bf9ef06a43833c696
 git clone https://github.com/XRPLF/clio
 cd clio
 ```

docs/config-description.md

@@ -457,6 +457,14 @@ This document provides a list of all available Clio configuration properties in
 - **Constraints**: None
 - **Description**: Max allowed difference between the latest sequence in DB and in cache file. If the cache file is too old (contains too low latest sequence) Clio will reject using it.
 
+### cache.file.async_save
+
+- **Required**: True
+- **Type**: boolean
+- **Default value**: `False`
+- **Constraints**: None
+- **Description**: When false, Clio waits for cache saving to finish before shutting down. When true, cache saving runs in parallel with other shutdown operations.
+
 ### log.channels.[].channel
 
 - **Required**: False

docs/run-clio.md

@@ -93,3 +93,42 @@ To completely disable Prometheus metrics add `"prometheus": { "enabled": false }
 It is important to know that Clio responds to Prometheus request only if they are admin requests. If you are using the admin password feature, the same password should be provided in the Authorization header of Prometheus requests.
 
 You can find an example Docker Compose file, with Prometheus and Grafana configs, in [examples/infrastructure](../docs/examples/infrastructure/).
+
+## Ledger cache file
+
+Since version 2.7.0, Clio supports saving the ledger cache to a local file on shutdown and loading it on startup. This feature is disabled by default but can significantly improve restart times.
+
+### Benefits
+
+- **Faster startup**: Loading cache from a file takes less than a minute, compared to 40-90 minutes on Mainnet when loading from the database.
+- **Reduced database load**: Clio doesn't put extra load on the database when starting with a cache file.
+- **Improved availability**: Faster restart times mean less downtime during maintenance or updates.
+
+> [!NOTE]
+> This feature only works when Clio is restarted. When starting Clio for the first time, the cache must be loaded from `rippled` or the database as usual.
+
+### Configuration
+
+To enable the ledger cache file feature, specify the [`cache.file.path`](./config-description.md#cachefilepath) option in your `config.json`:
+
+```json
+"cache": {
+    "file": {
+        "path": "/path/to/cache/file"
+    }
+}
+```
+
+You can optionally configure additional settings such as [`cache.file.max_sequence_age`](./config-description.md#cachefilemax_sequence_age) and [`cache.file.async_save`](./config-description.md#cachefileasync_save) to fine-tune the behavior. For a complete list of available options and their default values, see the [Configuration Description](./config-description.md#cachefilepath) documentation.
+
+### How it works
+
+1. **On shutdown**: Clio saves the current ledger cache to the specified file path. The file includes a hash for integrity verification.
+2. **On startup**: Clio checks if a cache file exists at the configured path. If the file exists, Clio will:
+   - Verify the file's integrity to ensure it is complete and not corrupted.
+   - Compare the latest ledger sequence in the cache file with the latest sequence in the database.
+   - Use the cache file only if the difference is less than [`cache.file.max_sequence_age`](./config-description.md#cachefilemax_sequence_age).
+   - If validation fails or the cache is too old, Clio will fall back to loading from the database.
+
+> [!IMPORTANT]
+> The cache file path should point to a location with sufficient disk space. On typical deployments, the cache file size can be several gigabytes.

pre-commit-hooks/check-doxygen-docs.sh

@@ -45,7 +45,7 @@ if [[ "1.14.0" > "$version" ]]; then
 
                                     ERROR
 -----------------------------------------------------------------------------
-        A minimum of version 1.14 of `which doxygen` is required.
+        A minimum of version 1.14 of $(which doxygen) is required.
         Your version is $version. Please upgrade it.
 
         Your changes may fail CI checks.
@@ -55,26 +55,26 @@ EOF
     exit 0
 fi
 
-mkdir -p ${DOCDIR} > /dev/null 2>&1
-pushd ${DOCDIR} > /dev/null 2>&1
+mkdir -p ${DOCDIR} >/dev/null 2>&1
+pushd ${DOCDIR} >/dev/null 2>&1
 
-cat ${ROOT}/docs/Doxyfile | \
-sed \
-    -e "s/\${LINT}/YES/" \
-    -e "s/\${WARN_AS_ERROR}/NO/" \
-    -e "s!\${SOURCE}!${ROOT}!" \
-    -e "s/\${USE_DOT}/NO/" \
-    -e "s/\${EXCLUDES}/impl/" \
-| ${DOXYGEN} - 2> ${TMPFILE} 1> /dev/null
+cat ${ROOT}/docs/Doxyfile |
+    sed \
+        -e "s/\${LINT}/YES/" \
+        -e "s/\${WARN_AS_ERROR}/NO/" \
+        -e "s!\${SOURCE}!${ROOT}!" \
+        -e "s/\${USE_DOT}/NO/" \
+        -e "s/\${EXCLUDES}/impl/" |
+    ${DOXYGEN} - 2>${TMPFILE} 1>/dev/null
 
 # We don't want to check for default values and typedefs as well as for member variables
-OUT=$(cat ${TMPFILE} \
-    | grep -v "=default" \
-    | grep -v "\(variable\)" \
-    | grep -v "\(typedef\)")
+OUT=$(cat ${TMPFILE} |
+    grep -v "=default" |
+    grep -v "\(variable\)" |
+    grep -v "\(typedef\)")
 
-rm -rf ${TMPFILE} > /dev/null 2>&1
-popd > /dev/null 2>&1
+rm -rf ${TMPFILE} >/dev/null 2>&1
+popd >/dev/null 2>&1
 
 if [[ ! -z "$OUT" ]]; then
     cat <<EOF

pre-commit-hooks/fix-local-includes.sh

@@ -23,10 +23,10 @@ fix_includes() {
     file_path_fixed="${file_path}.tmp.fixed"
 
     # Make all includes to be <...> style
-    sed -E 's|#include "(.*)"|#include <\1>|g' "$file_path" > "$file_path_all_global"
+    sed -E 's|#include "(.*)"|#include <\1>|g' "$file_path" >"$file_path_all_global"
 
     # Make local includes to be "..." style
-    sed -E "s|#include <(($main_src_dirs)/.*)>|#include \"\1\"|g" "$file_path_all_global" > "$file_path_fixed"
+    sed -E "s|#include <(($main_src_dirs)/.*)>|#include \"\1\"|g" "$file_path_all_global" >"$file_path_fixed"
     rm "$file_path_all_global"
 
     # Check if the temporary file is different from the original file

pre-commit-hooks/json_in_cpp.py

@@ -4,7 +4,6 @@ import argparse
 import re
 from pathlib import Path
 
-
 PATTERN = r'R"JSON\((.*?)\)JSON"'
 
 
@@ -40,6 +39,7 @@ def fix_colon_spacing(cpp_content: str) -> str:
         raw_json = match.group(1)
         raw_json = re.sub(r'":\n\s*(\[|\{)', r'": \1', raw_json)
         return f'R"JSON({raw_json})JSON"'
+
     return re.sub(PATTERN, replace_json, cpp_content, flags=re.DOTALL)
 
 
@@ -49,12 +49,12 @@ def fix_indentation(cpp_content: str) -> str:
 
     lines = cpp_content.splitlines()
 
-    ends_with_newline = cpp_content.endswith('\n')
+    ends_with_newline = cpp_content.endswith("\n")
 
     def find_indentation(line: str) -> int:
         return len(line) - len(line.lstrip())
 
-    for (line_num, (line, next_line)) in enumerate(zip(lines[:-1], lines[1:])):
+    for line_num, (line, next_line) in enumerate(zip(lines[:-1], lines[1:])):
         if "JSON(" in line and ")JSON" not in line:
             indent = find_indentation(line)
             next_indent = find_indentation(next_line)
@@ -69,7 +69,11 @@ def fix_indentation(cpp_content: str) -> str:
                     if ")JSON" in lines[i]:
                         lines[i] = " " * indent + lines[i].lstrip()
                         break
-                    lines[i] = lines[i][by_how_much:] if by_how_much > 0 else " " * (-by_how_much) + lines[i]
+                    lines[i] = (
+                        lines[i][by_how_much:]
+                        if by_how_much > 0
+                        else " " * (-by_how_much) + lines[i]
+                    )
 
     result = "\n".join(lines)
 

pre-commit-hooks/run-go-fmt.sh

@@ -4,7 +4,7 @@
 #
 set -e -o pipefail
 
-if ! command -v gofmt &> /dev/null ; then
+if ! command -v gofmt &>/dev/null; then
     echo "gofmt not installed or available in the PATH" >&2
     exit 1
 fi

pre-commit-hooks/verify-commits.sh

@@ -1,5 +1,4 @@
-#!/bin/sh
-
+#!/bin/bash
 
 # git for-each-ref refs/tags  # see which tags are annotated and which are lightweight. Annotated tags are "tag" objects.
 # # Set these so your commits and tags are always signed
@@ -7,7 +6,7 @@
 # git config tag.gpgsign true
 
 verify_commit_signed() {
-    if git verify-commit HEAD &> /dev/null; then
+    if git verify-commit HEAD &>/dev/null; then
         :
         # echo "HEAD commit seems signed..."
     else
@@ -17,7 +16,7 @@ verify_commit_signed() {
 }
 
 verify_tag() {
-    if git describe --exact-match --tags HEAD &> /dev/null; then
+    if git describe --exact-match --tags HEAD &>/dev/null; then
         : # You might be ok to push
         # echo "Tag is annotated."
         return 0
@@ -28,7 +27,7 @@ verify_tag() {
 }
 
 verify_tag_signed() {
-    if git verify-tag "$version" &> /dev/null ; then
+    if git verify-tag "$version" &>/dev/null; then
         : # ok, I guess we'll let you push
         # echo "Tag appears signed"
         return 0
@@ -40,11 +39,11 @@ verify_tag_signed() {
 }
 
 # Check some things if we're pushing a branch called "release/"
-if echo "$PRE_COMMIT_REMOTE_BRANCH" | grep ^refs\/heads\/release\/ &> /dev/null ; then
+if echo "$PRE_COMMIT_REMOTE_BRANCH" | grep ^refs\/heads\/release\/ &>/dev/null; then
     version=$(git tag --points-at HEAD)
     echo "Looks like you're trying to push a $version release..."
     echo "Making sure you've signed and tagged it."
-    if verify_commit_signed && verify_tag && verify_tag_signed ; then
+    if verify_commit_signed && verify_tag && verify_tag_signed; then
         : # Ok, I guess you can push
     else
         exit 1

src/app/CMakeLists.txt

@@ -1,13 +1,11 @@
 add_library(clio_app)
-target_sources(clio_app PRIVATE CliArgs.cpp ClioApplication.cpp Stopper.cpp WebHandlers.cpp)
+target_sources(
+    clio_app
+    PRIVATE CliArgs.cpp ClioApplication.cpp Stopper.cpp WebHandlers.cpp
+)
 
 target_link_libraries(
-  clio_app
-  PUBLIC clio_cluster
-         clio_etl
-         clio_feed
-         clio_migration
-         clio_rpc
-         clio_web
-  PRIVATE Boost::program_options
+    clio_app
+    PUBLIC clio_cluster clio_etl clio_feed clio_migration clio_rpc clio_web
+    PRIVATE Boost::program_options
 )

src/app/CliArgs.cpp

@@ -58,12 +58,16 @@ CliArgs::parse(int argc, char const* argv[])
     positional.add("conf", 1);
 
     auto const printHelp = [&description]() {
-        std::cout << "Clio server " << util::build::getClioFullVersionString() << "\n\n" << description;
+        std::cout << "Clio server " << util::build::getClioFullVersionString() << "\n\n"
+                  << description;
     };
 
     po::variables_map parsed;
     try {
-        po::store(po::command_line_parser(argc, argv).options(description).positional(positional).run(), parsed);
+        po::store(
+            po::command_line_parser(argc, argv).options(description).positional(positional).run(),
+            parsed
+        );
         po::notify(parsed);
     } catch (po::error const& e) {
         std::cerr << "Error: " << e.what() << std::endl << std::endl;
@@ -77,14 +81,18 @@ CliArgs::parse(int argc, char const* argv[])
     }
 
     if (parsed.contains("version")) {
-        std::cout << util::build::getClioFullVersionString() << '\n';
+        std::cout << util::build::getClioFullVersionString() << '\n'
+                  << "Git commit hash: " << util::build::getGitCommitHash() << '\n'
+                  << "Git build branch: " << util::build::getGitBuildBranch() << '\n'
+                  << "Build date: " << util::build::getBuildDate() << '\n';
         return Action{Action::Exit{EXIT_SUCCESS}};
     }
 
     if (parsed.contains("config-description")) {
         std::filesystem::path const filePath = parsed["config-description"].as<std::string>();
 
-        auto const res = util::config::ClioConfigDescription::generateConfigDescriptionToFile(filePath);
+        auto const res =
+            util::config::ClioConfigDescription::generateConfigDescriptionToFile(filePath);
         if (res.has_value())
             return Action{Action::Exit{EXIT_SUCCESS}};
 
@@ -96,15 +104,22 @@ CliArgs::parse(int argc, char const* argv[])
 
     if (parsed.contains("migrate")) {
         auto const opt = parsed["migrate"].as<std::string>();
-        if (opt == "status")
-            return Action{Action::Migrate{.configPath = std::move(configPath), .subCmd = MigrateSubCmd::status()}};
-        return Action{Action::Migrate{.configPath = std::move(configPath), .subCmd = MigrateSubCmd::migration(opt)}};
+        if (opt == "status") {
+            return Action{Action::Migrate{
+                .configPath = std::move(configPath), .subCmd = MigrateSubCmd::status()
+            }};
+        }
+        return Action{Action::Migrate{
+            .configPath = std::move(configPath), .subCmd = MigrateSubCmd::migration(opt)
+        }};
     }
 
     if (parsed.contains("verify"))
         return Action{Action::VerifyConfig{.configPath = std::move(configPath)}};
 
-    return Action{Action::Run{.configPath = std::move(configPath), .useNgWebServer = parsed.contains("ng-web-server")}};
+    return Action{Action::Run{
+        .configPath = std::move(configPath), .useNgWebServer = parsed.contains("ng-web-server")
+    }};
 }
 
 }  // namespace app

src/app/CliArgs.hpp

@@ -79,7 +79,8 @@ public:
         /**
          * @brief Apply a function to the action.
          *
-         * @tparam Processors Action processors types. Must be callable with the action type and return int.
+         * @tparam Processors Action processors types. Must be callable with the action type and
+         * return int.
          * @param processors Action processors.
          * @return Exit code.
          */

src/app/ClioApplication.cpp

@@ -29,6 +29,8 @@
 #include "etl/ETLService.hpp"
 #include "etl/LoadBalancer.hpp"
 #include "etl/NetworkValidatedLedgers.hpp"
+#include "etl/SystemState.hpp"
+#include "etl/WriterState.hpp"
 #include "feed/SubscriptionManager.hpp"
 #include "migration/MigrationInspectorFactory.hpp"
 #include "rpc/Counters.hpp"
@@ -91,6 +93,7 @@ ClioApplication::ClioApplication(util::config::ClioConfigDefinition const& confi
 {
     LOG(util::LogService::info()) << "Clio version: " << util::build::getClioFullVersionString();
     signalsHandler_.subscribeToStop([this]() { appStopper_.stop(); });
+    appStopper_.setOnComplete([this]() { signalsHandler_.notifyGracefulShutdownComplete(); });
 }
 
 int
@@ -120,7 +123,11 @@ ClioApplication::run(bool const useNgWebServer)
     // Interface to the database
     auto backend = data::makeBackend(config_, cache);
 
-    cluster::ClusterCommunicationService clusterCommunicationService{backend};
+    auto systemState = etl::SystemState::makeSystemState(config_);
+
+    cluster::ClusterCommunicationService clusterCommunicationService{
+        backend, std::make_unique<etl::WriterState>(systemState, cache)
+    };
     clusterCommunicationService.run();
 
     auto const amendmentCenter = std::make_shared<data::AmendmentCenter const>(backend);
@@ -129,14 +136,15 @@ ClioApplication::run(bool const useNgWebServer)
         auto const migrationInspector = migration::makeMigrationInspector(config_, backend);
         // Check if any migration is blocking Clio server starting.
         if (migrationInspector->isBlockingClio() and backend->hardFetchLedgerRangeNoThrow()) {
-            LOG(util::LogService::error())
-                << "Existing Migration is blocking Clio, Please complete the database migration first.";
+            LOG(util::LogService::error()) << "Existing Migration is blocking Clio, Please "
+                                              "complete the database migration first.";
             return EXIT_FAILURE;
         }
     }
 
     // Manages clients subscribed to streams
-    auto subscriptions = feed::SubscriptionManager::makeSubscriptionManager(config_, backend, amendmentCenter);
+    auto subscriptions =
+        feed::SubscriptionManager::makeSubscriptionManager(config_, backend, amendmentCenter);
 
     // Tracks which ledgers have been validated by the network
     auto ledgers = etl::NetworkValidatedLedgers::makeValidatedLedgers();
@@ -149,8 +157,11 @@ ClioApplication::run(bool const useNgWebServer)
         config_, ioc, backend, subscriptions, std::make_unique<util::MTRandomGenerator>(), ledgers
     );
 
-    // ETL is responsible for writing and publishing to streams. In read-only mode, ETL only publishes
-    auto etl = etl::ETLService::makeETLService(config_, ctx, backend, subscriptions, balancer, ledgers);
+    // ETL is responsible for writing and publishing to streams. In read-only mode, ETL only
+    // publishes
+    auto etl = etl::ETLService::makeETLService(
+        config_, std::move(systemState), ctx, backend, subscriptions, balancer, ledgers
+    );
 
     auto workQueue = rpc::WorkQueue::makeWorkQueue(config_);
     auto counters = rpc::Counters::makeCounters(workQueue);
@@ -160,15 +171,19 @@ ClioApplication::run(bool const useNgWebServer)
     );
 
     using RPCEngineType = rpc::RPCEngine<rpc::Counters>;
-    auto const rpcEngine =
-        RPCEngineType::makeRPCEngine(config_, backend, balancer, dosGuard, workQueue, counters, handlerProvider);
+    auto const rpcEngine = RPCEngineType::makeRPCEngine(
+        config_, backend, balancer, dosGuard, workQueue, counters, handlerProvider
+    );
 
     if (useNgWebServer or config_.get<bool>("server.__ng_web_server")) {
-        web::ng::RPCServerHandler<RPCEngineType> handler{config_, backend, rpcEngine, etl, dosGuard};
+        web::ng::RPCServerHandler<RPCEngineType> handler{
+            config_, backend, rpcEngine, etl, dosGuard
+        };
 
         auto expectedAdminVerifier = web::makeAdminVerificationStrategy(config_);
         if (not expectedAdminVerifier.has_value()) {
-            LOG(util::LogService::error()) << "Error creating admin verifier: " << expectedAdminVerifier.error();
+            LOG(util::LogService::error())
+                << "Error creating admin verifier: " << expectedAdminVerifier.error();
             return EXIT_FAILURE;
         }
         auto const adminVerifier = std::move(expectedAdminVerifier).value();
@@ -182,7 +197,7 @@ ClioApplication::run(bool const useNgWebServer)
             return EXIT_FAILURE;
         }
 
-        httpServer->onGet("/metrics", MetricsHandler{adminVerifier});
+        httpServer->onGet("/metrics", MetricsHandler{adminVerifier, workQueue});
         httpServer->onGet("/health", HealthCheckHandler{});
         httpServer->onGet("/cache_state", CacheStateHandler{cache});
         auto requestHandler = RequestHandler{adminVerifier, handler};
@@ -196,7 +211,16 @@ ClioApplication::run(bool const useNgWebServer)
         }
 
         appStopper_.setOnStop(
-            Stopper::makeOnStopCallback(httpServer.value(), *balancer, *etl, *subscriptions, *backend, cacheSaver, ioc)
+            Stopper::makeOnStopCallback(
+                httpServer.value(),
+                *balancer,
+                *etl,
+                *subscriptions,
+                *backend,
+                cacheSaver,
+                clusterCommunicationService,
+                ioc
+            )
         );
 
         // Blocks until stopped.
@@ -208,11 +232,22 @@ ClioApplication::run(bool const useNgWebServer)
     }
 
     // Init the web server
-    auto handler = std::make_shared<web::RPCServerHandler<RPCEngineType>>(config_, backend, rpcEngine, etl, dosGuard);
+    auto handler = std::make_shared<web::RPCServerHandler<RPCEngineType>>(
+        config_, backend, rpcEngine, etl, dosGuard
+    );
 
     auto const httpServer = web::makeHttpServer(config_, ioc, dosGuard, handler, cache);
     appStopper_.setOnStop(
-        Stopper::makeOnStopCallback(*httpServer, *balancer, *etl, *subscriptions, *backend, cacheSaver, ioc)
+        Stopper::makeOnStopCallback(
+            *httpServer,
+            *balancer,
+            *etl,
+            *subscriptions,
+            *backend,
+            cacheSaver,
+            clusterCommunicationService,
+            ioc
+        )
     );
 
     // Blocks until stopped.

src/app/Stopper.cpp

@@ -38,7 +38,18 @@ Stopper::~Stopper()
 void
 Stopper::setOnStop(std::function<void(boost::asio::yield_context)> cb)
 {
-    util::spawn(ctx_, std::move(cb));
+    util::spawn(ctx_, [this, cb = std::move(cb)](auto yield) {
+        cb(yield);
+
+        if (onCompleteCallback_)
+            onCompleteCallback_();
+    });
+}
+
+void
+Stopper::setOnComplete(std::function<void()> cb)
+{
+    onCompleteCallback_ = std::move(cb);
 }
 
 void

src/app/Stopper.hpp

@@ -19,6 +19,7 @@
 
 #pragma once
 
+#include "cluster/Concepts.hpp"
 #include "data/BackendInterface.hpp"
 #include "data/LedgerCacheSaver.hpp"
 #include "etl/ETLServiceInterface.hpp"
@@ -38,11 +39,13 @@
 namespace app {
 
 /**
- * @brief Application stopper class. On stop it will create a new thread to run all the shutdown tasks.
+ * @brief Application stopper class. On stop it will create a new thread to run all the shutdown
+ * tasks.
  */
 class Stopper {
     boost::asio::io_context ctx_;
     std::thread worker_;
+    std::function<void()> onCompleteCallback_;
 
 public:
     /**
@@ -58,6 +61,14 @@ public:
     void
     setOnStop(std::function<void(boost::asio::yield_context)> cb);
 
+    /**
+     * @brief Set the callback to be called when graceful shutdown completes.
+     *
+     * @param cb The callback to be called when shutdown completes.
+     */
+    void
+    setOnComplete(std::function<void()> cb);
+
     /**
      * @brief Stop the application and run the shutdown tasks.
      */
@@ -73,10 +84,14 @@ public:
      * @param subscriptions The subscription manager to stop.
      * @param backend The backend to stop.
      * @param cacheSaver The ledger cache saver
+     * @param clusterCommunicationService The cluster communication service to stop.
      * @param ioc The io_context to stop.
      * @return The callback to be called on application stop.
      */
-    template <web::SomeServer ServerType, data::SomeLedgerCacheSaver LedgerCacheSaverType>
+    template <
+        web::SomeServer ServerType,
+        data::SomeLedgerCacheSaver LedgerCacheSaverType,
+        cluster::SomeClusterCommunicationService ClusterCommunicationServiceType>
     static std::function<void(boost::asio::yield_context)>
     makeOnStopCallback(
         ServerType& server,
@@ -85,6 +100,7 @@ public:
         feed::SubscriptionManagerInterface& subscriptions,
         data::BackendInterface& backend,
         LedgerCacheSaverType& cacheSaver,
+        ClusterCommunicationServiceType& clusterCommunicationService,
         boost::asio::io_context& ioc
     )
     {
@@ -102,6 +118,8 @@ public:
             });
             coroutineGroup.asyncWait(yield);
 
+            clusterCommunicationService.stop();
+
             etl.stop();
             LOG(util::LogService::info()) << "ETL stopped";
 

src/app/VerifyConfig.hpp

@@ -41,7 +41,8 @@ parseConfig(std::string_view configPath)
 
     auto const json = ConfigFileJson::makeConfigFileJson(configPath);
     if (!json.has_value()) {
-        std::cerr << "Error parsing json from config: " << configPath << "\n" << json.error().error << std::endl;
+        std::cerr << "Error parsing json from config: " << configPath << "\n"
+                  << json.error().error << std::endl;
         return false;
     }
     auto const errors = getClioConfig().parse(json.value());

src/app/WebHandlers.cpp

@@ -19,7 +19,10 @@
 
 #include "app/WebHandlers.hpp"
 
+#include "rpc/Errors.hpp"
+#include "rpc/WorkQueue.hpp"
 #include "util/Assert.hpp"
+#include "util/CoroutineGroup.hpp"
 #include "util/prometheus/Http.hpp"
 #include "web/AdminVerificationStrategy.hpp"
 #include "web/SubscriptionContextInterface.hpp"
@@ -31,6 +34,7 @@
 #include <boost/asio/spawn.hpp>
 #include <boost/beast/http/status.hpp>
 
+#include <functional>
 #include <memory>
 #include <optional>
 #include <string>
@@ -47,9 +51,9 @@ OnConnectCheck::operator()(web::ng::Connection const& connection)
 {
     dosguard_.get().increment(connection.ip());
     if (not dosguard_.get().isOk(connection.ip())) {
-        return std::unexpected{
-            web::ng::Response{boost::beast::http::status::too_many_requests, "Too many requests", connection}
-        };
+        return std::unexpected{web::ng::Response{
+            boost::beast::http::status::too_many_requests, "Too many requests", connection
+        }};
     }
 
     return {};
@@ -76,8 +80,11 @@ DisconnectHook::operator()(web::ng::Connection const& connection)
     dosguard_.get().decrement(connection.ip());
 }
 
-MetricsHandler::MetricsHandler(std::shared_ptr<web::AdminVerificationStrategy> adminVerifier)
-    : adminVerifier_{std::move(adminVerifier)}
+MetricsHandler::MetricsHandler(
+    std::shared_ptr<web::AdminVerificationStrategy> adminVerifier,
+    rpc::WorkQueue& workQueue
+)
+    : adminVerifier_{std::move(adminVerifier)}, workQueue_{std::ref(workQueue)}
 {
 }
 
@@ -86,19 +93,47 @@ MetricsHandler::operator()(
     web::ng::Request const& request,
     web::ng::ConnectionMetadata& connectionMetadata,
     web::SubscriptionContextPtr,
-    boost::asio::yield_context
+    boost::asio::yield_context yield
 )
 {
-    auto const maybeHttpRequest = request.asHttpRequest();
-    ASSERT(maybeHttpRequest.has_value(), "Got not a http request in Get");
-    auto const& httpRequest = maybeHttpRequest->get();
+    std::optional<web::ng::Response> response;
+    util::CoroutineGroup coroutineGroup{yield, 1};
+    auto const onTaskComplete = coroutineGroup.registerForeign(yield);
+    ASSERT(onTaskComplete.has_value(), "Coroutine group can't be full");
 
-    // FIXME(#1702): Using veb server thread to handle prometheus request. Better to post on work queue.
-    auto maybeResponse = util::prometheus::handlePrometheusRequest(
-        httpRequest, adminVerifier_->isAdmin(httpRequest, connectionMetadata.ip())
+    bool const postSuccessful = workQueue_.get().postCoro(
+        [this, &request, &response, &onTaskComplete = onTaskComplete.value(), &connectionMetadata](
+            boost::asio::yield_context
+        ) mutable {
+            auto const maybeHttpRequest = request.asHttpRequest();
+            ASSERT(maybeHttpRequest.has_value(), "Got not a http request in Get");
+            auto const& httpRequest = maybeHttpRequest->get();
+
+            auto maybeResponse = util::prometheus::handlePrometheusRequest(
+                httpRequest, adminVerifier_->isAdmin(httpRequest, connectionMetadata.ip())
+            );
+            ASSERT(maybeResponse.has_value(), "Got unexpected request for Prometheus");
+            response = web::ng::Response{std::move(maybeResponse).value(), request};
+            // notify the coroutine group that the foreign task is done
+            onTaskComplete();
+        },
+        /* isWhiteListed= */ true,
+        rpc::WorkQueue::Priority::High
     );
-    ASSERT(maybeResponse.has_value(), "Got unexpected request for Prometheus");
-    return web::ng::Response{std::move(maybeResponse).value(), request};
+
+    if (!postSuccessful) {
+        return web::ng::Response{
+            boost::beast::http::status::too_many_requests,
+            rpc::makeError(rpc::RippledError::rpcTOO_BUSY),
+            request
+        };
+    }
+
+    // Put the coroutine to sleep until the foreign task is done
+    coroutineGroup.asyncWait(yield);
+    ASSERT(response.has_value(), "Woke up coroutine without setting response");
+
+    return std::move(response).value();
 }
 
 web::ng::Response
@@ -147,7 +182,9 @@ CacheStateHandler::operator()(
     if (cache_.get().isFull())
         return web::ng::Response{boost::beast::http::status::ok, kCACHE_CHECK_LOADED_HTML, request};
 
-    return web::ng::Response{boost::beast::http::status::service_unavailable, kCACHE_CHECK_NOT_LOADED_HTML, request};
+    return web::ng::Response{
+        boost::beast::http::status::service_unavailable, kCACHE_CHECK_NOT_LOADED_HTML, request
+    };
 }
 
 }  // namespace app

src/app/WebHandlers.hpp

@@ -21,6 +21,7 @@
 
 #include "data/LedgerCacheInterface.hpp"
 #include "rpc/Errors.hpp"
+#include "rpc/WorkQueue.hpp"
 #include "util/log/Logger.hpp"
 #include "web/AdminVerificationStrategy.hpp"
 #include "web/SubscriptionContextInterface.hpp"
@@ -67,8 +68,8 @@ public:
 };
 
 /**
- * @brief A function object that is called when the IP of a connection changes (usually if proxy detected).
- * This is used to update the DOS guard.
+ * @brief A function object that is called when the IP of a connection changes (usually if proxy
+ * detected). This is used to update the DOS guard.
  */
 class IpChangeHook {
     std::reference_wrapper<web::dosguard::DOSGuardInterface> dosguard_;
@@ -119,20 +120,27 @@ public:
  */
 class MetricsHandler {
     std::shared_ptr<web::AdminVerificationStrategy> adminVerifier_;
+    std::reference_wrapper<rpc::WorkQueue> workQueue_;
 
 public:
     /**
      * @brief Construct a new MetricsHandler object
      *
-     * @param adminVerifier The AdminVerificationStrategy to use for verifying the connection for admin access.
+     * @param adminVerifier The AdminVerificationStrategy to use for verifying the connection for
+     * admin access.
+     * @param workQueue The WorkQueue to use for handling the request.
      */
-    MetricsHandler(std::shared_ptr<web::AdminVerificationStrategy> adminVerifier);
+    MetricsHandler(
+        std::shared_ptr<web::AdminVerificationStrategy> adminVerifier,
+        rpc::WorkQueue& workQueue
+    );
 
     /**
      * @brief The call of the function object.
      *
      * @param request The request to handle.
      * @param connectionMetadata The connection metadata.
+     * @param yield The yield context.
      * @return The response to the request.
      */
     web::ng::Response
@@ -140,7 +148,7 @@ public:
         web::ng::Request const& request,
         web::ng::ConnectionMetadata& connectionMetadata,
         web::SubscriptionContextPtr,
-        boost::asio::yield_context
+        boost::asio::yield_context yield
     );
 };
 
@@ -210,10 +218,14 @@ public:
     /**
      * @brief Construct a new RequestHandler object
      *
-     * @param adminVerifier The AdminVerificationStrategy to use for verifying the connection for admin access.
+     * @param adminVerifier The AdminVerificationStrategy to use for verifying the connection for
+     * admin access.
      * @param rpcHandler The RPC handler to use for handling the request.
      */
-    RequestHandler(std::shared_ptr<web::AdminVerificationStrategy> adminVerifier, RpcHandlerType& rpcHandler)
+    RequestHandler(
+        std::shared_ptr<web::AdminVerificationStrategy> adminVerifier,
+        RpcHandlerType& rpcHandler
+    )
         : adminVerifier_(std::move(adminVerifier)), rpcHandler_(rpcHandler)
     {
     }

src/cluster/Backend.cpp

@@ -0,0 +1,136 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#include "cluster/Backend.hpp"
+
+#include "cluster/ClioNode.hpp"
+#include "data/BackendInterface.hpp"
+#include "etl/WriterState.hpp"
+
+#include <boost/asio/spawn.hpp>
+#include <boost/asio/thread_pool.hpp>
+#include <boost/json/parse.hpp>
+#include <boost/json/serialize.hpp>
+#include <boost/json/value.hpp>
+#include <boost/json/value_from.hpp>
+#include <boost/json/value_to.hpp>
+#include <boost/uuid/random_generator.hpp>
+#include <boost/uuid/uuid.hpp>
+#include <fmt/format.h>
+
+#include <chrono>
+#include <memory>
+#include <utility>
+#include <vector>
+
+namespace cluster {
+
+Backend::Backend(
+    boost::asio::thread_pool& ctx,
+    std::shared_ptr<data::BackendInterface> backend,
+    std::unique_ptr<etl::WriterStateInterface const> writerState,
+    std::chrono::steady_clock::duration readInterval,
+    std::chrono::steady_clock::duration writeInterval
+)
+    : backend_(std::move(backend))
+    , writerState_(std::move(writerState))
+    , readerTask_(readInterval, ctx)
+    , writerTask_(writeInterval, ctx)
+    , selfUuid_(std::make_shared<boost::uuids::uuid>(boost::uuids::random_generator{}()))
+{
+}
+
+void
+Backend::run()
+{
+    readerTask_.run([this](boost::asio::yield_context yield) {
+        auto clusterData = doRead(yield);
+        onNewState_(selfUuid_, std::make_shared<ClusterData>(std::move(clusterData)));
+    });
+
+    writerTask_.run([this]() { doWrite(); });
+}
+
+Backend::~Backend()
+{
+    stop();
+}
+
+void
+Backend::stop()
+{
+    readerTask_.stop();
+    writerTask_.stop();
+}
+
+ClioNode::CUuid
+Backend::selfId() const
+{
+    return selfUuid_;
+}
+
+Backend::ClusterData
+Backend::doRead(boost::asio::yield_context yield)
+{
+    BackendInterface::ClioNodesDataFetchResult expectedResult;
+    try {
+        expectedResult = backend_->fetchClioNodesData(yield);
+    } catch (...) {
+        expectedResult = std::unexpected{"Failed to fetch Clio nodes data"};
+    }
+
+    if (!expectedResult.has_value()) {
+        return std::unexpected{std::move(expectedResult).error()};
+    }
+
+    std::vector<ClioNode> otherNodesData;
+    for (auto const& [uuid, nodeDataStr] : expectedResult.value()) {
+        if (uuid == *selfUuid_) {
+            continue;
+        }
+
+        boost::system::error_code errorCode;
+        auto const json = boost::json::parse(nodeDataStr, errorCode);
+        if (errorCode.failed()) {
+            return std::unexpected{fmt::format("Error parsing json from DB: {}", nodeDataStr)};
+        }
+
+        auto expectedNodeData = boost::json::try_value_to<ClioNode>(json);
+        if (expectedNodeData.has_error()) {
+            return std::unexpected{
+                fmt::format("Error converting json to ClioNode: {}", nodeDataStr)
+            };
+        }
+        *expectedNodeData->uuid = uuid;
+        otherNodesData.push_back(std::move(expectedNodeData).value());
+    }
+    otherNodesData.push_back(ClioNode::from(selfUuid_, *writerState_));
+    return otherNodesData;
+}
+
+void
+Backend::doWrite()
+{
+    auto const selfData = ClioNode::from(selfUuid_, *writerState_);
+    boost::json::value jsonValue{};
+    boost::json::value_from(selfData, jsonValue);
+    backend_->writeNodeMessage(*selfData.uuid, boost::json::serialize(jsonValue.as_object()));
+}
+
+}  // namespace cluster

src/cluster/Backend.hpp

@@ -0,0 +1,148 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#pragma once
+
+#include "cluster/ClioNode.hpp"
+#include "cluster/impl/RepeatedTask.hpp"
+#include "data/BackendInterface.hpp"
+#include "etl/WriterState.hpp"
+#include "util/log/Logger.hpp"
+
+#include <boost/asio/any_io_executor.hpp>
+#include <boost/asio/cancellation_signal.hpp>
+#include <boost/asio/execution_context.hpp>
+#include <boost/asio/executor.hpp>
+#include <boost/asio/spawn.hpp>
+#include <boost/asio/strand.hpp>
+#include <boost/asio/thread_pool.hpp>
+#include <boost/signals2/connection.hpp>
+#include <boost/signals2/signal.hpp>
+#include <boost/signals2/variadic_signal.hpp>
+#include <boost/uuid/uuid.hpp>
+
+#include <chrono>
+#include <concepts>
+#include <memory>
+#include <string>
+#include <vector>
+
+namespace cluster {
+
+/**
+ * @brief Backend communication handler for cluster state synchronization.
+ *
+ * This class manages reading and writing cluster state information to/from the backend database.
+ * It periodically reads the state of other nodes in the cluster and writes the current node's
+ * state, enabling cluster-wide coordination and awareness.
+ */
+class Backend {
+public:
+    /** @brief Type representing cluster data result - either a vector of nodes or an error message
+     */
+    using ClusterData = std::expected<std::vector<ClioNode>, std::string>;
+
+private:
+    util::Logger log_{"ClusterCommunication"};
+
+    std::shared_ptr<data::BackendInterface> backend_;
+    std::unique_ptr<etl::WriterStateInterface const> writerState_;
+
+    impl::RepeatedTask<boost::asio::thread_pool> readerTask_;
+    impl::RepeatedTask<boost::asio::thread_pool> writerTask_;
+
+    ClioNode::Uuid selfUuid_;
+
+    boost::signals2::signal<void(ClioNode::CUuid, std::shared_ptr<ClusterData const>)> onNewState_;
+
+public:
+    /**
+     * @brief Construct a Backend communication handler.
+     *
+     * @param ctx The execution context for asynchronous operations
+     * @param backend Interface to the backend database
+     * @param writerState State indicating whether this node is writing to the database
+     * @param readInterval How often to read cluster state from the backend
+     * @param writeInterval How often to write this node's state to the backend
+     */
+    Backend(
+        boost::asio::thread_pool& ctx,
+        std::shared_ptr<data::BackendInterface> backend,
+        std::unique_ptr<etl::WriterStateInterface const> writerState,
+        std::chrono::steady_clock::duration readInterval,
+        std::chrono::steady_clock::duration writeInterval
+    );
+
+    ~Backend();
+
+    Backend(Backend&&) = delete;
+    Backend&
+    operator=(Backend&&) = delete;
+    Backend(Backend const&) = delete;
+    Backend&
+    operator=(Backend const&) = delete;
+
+    /**
+     * @brief Start the backend read and write tasks.
+     *
+     * Begins periodic reading of cluster state from the backend and writing of this node's state.
+     */
+    void
+    run();
+
+    /**
+     * @brief Stop the backend read and write tasks.
+     *
+     * Stops all periodic tasks and waits for them to complete.
+     */
+    void
+    stop();
+
+    /**
+     * @brief Subscribe to new cluster state notifications.
+     *
+     * @tparam S Callable type accepting (ClioNode::cUUID, ClusterData)
+     * @param s Subscriber callback to be invoked when new cluster state is available
+     * @return A connection object that can be used to unsubscribe
+     */
+    template <typename S>
+        requires std::invocable<S, ClioNode::CUuid, std::shared_ptr<ClusterData const>>
+    boost::signals2::connection
+    subscribeToNewState(S&& s)
+    {
+        return onNewState_.connect(s);
+    }
+
+    /**
+     * @brief Get the UUID of this node in the cluster.
+     *
+     * @return The UUID of this node.
+     */
+    ClioNode::CUuid
+    selfId() const;
+
+private:
+    ClusterData
+    doRead(boost::asio::yield_context yield);
+
+    void
+    doWrite();
+};
+
+}  // namespace cluster

src/cluster/CMakeLists.txt

@@ -1,5 +1,13 @@
 add_library(clio_cluster)
 
-target_sources(clio_cluster PRIVATE ClioNode.cpp ClusterCommunicationService.cpp)
+target_sources(
+    clio_cluster
+    PRIVATE
+        Backend.cpp
+        ClioNode.cpp
+        ClusterCommunicationService.cpp
+        Metrics.cpp
+        WriterDecider.cpp
+)
 
 target_link_libraries(clio_cluster PRIVATE clio_util clio_data)

src/cluster/ClioNode.cpp

@@ -19,6 +19,7 @@
 
 #include "cluster/ClioNode.hpp"
 
+#include "etl/WriterState.hpp"
 #include "util/TimeUtils.hpp"
 
 #include <boost/json/conversion.hpp>
@@ -26,39 +27,86 @@
 #include <boost/json/value.hpp>
 #include <boost/uuid/uuid.hpp>
 
+#include <chrono>
+#include <cstdint>
 #include <memory>
 #include <stdexcept>
 #include <string>
 #include <string_view>
+#include <utility>
 
 namespace cluster {
 
 namespace {
 
-struct Fields {
+struct JsonFields {
     static constexpr std::string_view const kUPDATE_TIME = "update_time";
+    static constexpr std::string_view const kDB_ROLE = "db_role";
+    static constexpr std::string_view const kETL_STARTED = "etl_started";
+    static constexpr std::string_view const kCACHE_IS_FULL = "cache_is_full";
 };
 
 }  // namespace
 
+ClioNode
+ClioNode::from(ClioNode::Uuid uuid, etl::WriterStateInterface const& writerState)
+{
+    auto const dbRole = [&writerState]() {
+        if (writerState.isReadOnly()) {
+            return ClioNode::DbRole::ReadOnly;
+        }
+        if (writerState.isFallback()) {
+            return ClioNode::DbRole::Fallback;
+        }
+
+        return writerState.isWriting() ? ClioNode::DbRole::Writer : ClioNode::DbRole::NotWriter;
+    }();
+    return ClioNode{
+        .uuid = std::move(uuid),
+        .updateTime = std::chrono::system_clock::now(),
+        .dbRole = dbRole,
+        .etlStarted = writerState.isEtlStarted(),
+        .cacheIsFull = writerState.isCacheFull()
+    };
+}
+
 void
 tag_invoke(boost::json::value_from_tag, boost::json::value& jv, ClioNode const& node)
 {
     jv = {
-        {Fields::kUPDATE_TIME, util::systemTpToUtcStr(node.updateTime, ClioNode::kTIME_FORMAT)},
+        {JsonFields::kUPDATE_TIME, util::systemTpToUtcStr(node.updateTime, ClioNode::kTIME_FORMAT)},
+        {JsonFields::kDB_ROLE, static_cast<int64_t>(node.dbRole)},
+        {JsonFields::kETL_STARTED, node.etlStarted},
+        {JsonFields::kCACHE_IS_FULL, node.cacheIsFull}
     };
 }
 
 ClioNode
 tag_invoke(boost::json::value_to_tag<ClioNode>, boost::json::value const& jv)
 {
-    auto const& updateTimeStr = jv.as_object().at(Fields::kUPDATE_TIME).as_string();
-    auto const updateTime = util::systemTpFromUtcStr(std::string(updateTimeStr), ClioNode::kTIME_FORMAT);
+    auto const& updateTimeStr = jv.as_object().at(JsonFields::kUPDATE_TIME).as_string();
+    auto const updateTime =
+        util::systemTpFromUtcStr(std::string(updateTimeStr), ClioNode::kTIME_FORMAT);
     if (!updateTime.has_value()) {
         throw std::runtime_error("Failed to parse update time");
     }
 
-    return ClioNode{.uuid = std::make_shared<boost::uuids::uuid>(), .updateTime = updateTime.value()};
+    auto const dbRoleValue = jv.as_object().at(JsonFields::kDB_ROLE).as_int64();
+    if (dbRoleValue > static_cast<int64_t>(ClioNode::DbRole::MAX))
+        throw std::runtime_error("Invalid db_role value");
+
+    auto const etlStarted = jv.as_object().at(JsonFields::kETL_STARTED).as_bool();
+    auto const cacheIsFull = jv.as_object().at(JsonFields::kCACHE_IS_FULL).as_bool();
+
+    return ClioNode{
+        // Json data doesn't contain uuid so leaving it empty here. It will be filled outside of
+        // this parsing
+        .uuid = std::make_shared<boost::uuids::uuid>(),
+        .updateTime = updateTime.value(),
+        .dbRole = static_cast<ClioNode::DbRole>(dbRoleValue),
+        .etlStarted = etlStarted,
+        .cacheIsFull = cacheIsFull
+    };
 }
 
 }  // namespace cluster

src/cluster/ClioNode.hpp

@@ -19,6 +19,8 @@
 
 #pragma once
 
+#include "etl/WriterState.hpp"
+
 #include <boost/json/conversion.hpp>
 #include <boost/json/value.hpp>
 #include <boost/uuid/uuid.hpp>
@@ -37,16 +39,40 @@ struct ClioNode {
      */
     static constexpr char const* kTIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ";
 
-    // enum class WriterRole {
-    //     ReadOnly,
-    //     NotWriter,
-    //     Writer
-    // };
+    /**
+     * @brief Database role of a node in the cluster.
+     *
+     * Roles are used to coordinate which node writes to the database:
+     * - ReadOnly: Node is configured to never write (strict read-only mode)
+     * - NotWriter: Node can write but is currently not the designated writer
+     * - Writer: Node is actively writing to the database
+     * - Fallback: Node is using the fallback writer decision mechanism
+     *
+     * When any node in the cluster is in Fallback mode, the entire cluster switches
+     * from the cluster communication mechanism to the slower but more reliable
+     * database-based conflict detection mechanism.
+     */
+    enum class DbRole { ReadOnly = 0, NotWriter = 1, Writer = 2, Fallback = 3, MAX = 3 };
 
-    std::shared_ptr<boost::uuids::uuid> uuid;          ///< The UUID of the node.
-    std::chrono::system_clock::time_point updateTime;  ///< The time the data about the node was last updated.
+    using Uuid = std::shared_ptr<boost::uuids::uuid>;
+    using CUuid = std::shared_ptr<boost::uuids::uuid const>;
 
-    // WriterRole writerRole;
+    Uuid uuid;  ///< The UUID of the node.
+    std::chrono::system_clock::time_point
+        updateTime;    ///< The time the data about the node was last updated.
+    DbRole dbRole;     ///< The database role of the node
+    bool etlStarted;   ///< Whether the ETL monitor has started on this node
+    bool cacheIsFull;  ///< Whether the ledger cache is fully loaded on this node
+
+    /**
+     * @brief Create a ClioNode from writer state.
+     *
+     * @param uuid The UUID of the node
+     * @param writerState The writer state to determine the node's database role
+     * @return A ClioNode with the current time and role derived from writerState
+     */
+    static ClioNode
+    from(Uuid uuid, etl::WriterStateInterface const& writerState);
 };
 
 void

src/cluster/ClusterCommunicationService.cpp

@@ -19,98 +19,37 @@
 
 #include "cluster/ClusterCommunicationService.hpp"
 
-#include "cluster/ClioNode.hpp"
 #include "data/BackendInterface.hpp"
-#include "util/Assert.hpp"
-#include "util/Spawn.hpp"
-#include "util/log/Logger.hpp"
-
-#include <boost/asio/bind_cancellation_slot.hpp>
-#include <boost/asio/cancellation_type.hpp>
-#include <boost/asio/error.hpp>
-#include <boost/asio/spawn.hpp>
-#include <boost/asio/steady_timer.hpp>
-#include <boost/asio/use_future.hpp>
-#include <boost/json/parse.hpp>
-#include <boost/json/serialize.hpp>
-#include <boost/json/value.hpp>
-#include <boost/json/value_from.hpp>
-#include <boost/json/value_to.hpp>
-#include <boost/uuid/random_generator.hpp>
-#include <boost/uuid/uuid.hpp>
+#include "etl/WriterState.hpp"
 
 #include <chrono>
 #include <ctime>
-#include <latch>
 #include <memory>
-#include <string>
 #include <utility>
-#include <vector>
-
-namespace {
-constexpr auto kTOTAL_WORKERS = 2uz;  // 1 reading and 1 writing worker (coroutines)
-}  // namespace
 
 namespace cluster {
 
 ClusterCommunicationService::ClusterCommunicationService(
     std::shared_ptr<data::BackendInterface> backend,
+    std::unique_ptr<etl::WriterStateInterface> writerState,
     std::chrono::steady_clock::duration readInterval,
     std::chrono::steady_clock::duration writeInterval
 )
-    : backend_(std::move(backend))
-    , readInterval_(readInterval)
-    , writeInterval_(writeInterval)
-    , finishedCountdown_(kTOTAL_WORKERS)
-    , selfData_{ClioNode{
-          .uuid = std::make_shared<boost::uuids::uuid>(boost::uuids::random_generator{}()),
-          .updateTime = std::chrono::system_clock::time_point{}
-      }}
+    : backend_(ctx_, std::move(backend), writerState->clone(), readInterval, writeInterval)
+    , writerDecider_(ctx_, std::move(writerState))
 {
-    nodesInClusterMetric_.set(1);  // The node always sees itself
-    isHealthy_ = true;
 }
 
 void
 ClusterCommunicationService::run()
 {
-    ASSERT(not running_ and not stopped_, "Can only be ran once");
-    running_ = true;
-
-    util::spawn(strand_, [this](boost::asio::yield_context yield) {
-        boost::asio::steady_timer timer(yield.get_executor());
-        boost::system::error_code ec;
-
-        while (running_) {
-            timer.expires_after(readInterval_);
-            auto token = cancelSignal_.slot();
-            timer.async_wait(boost::asio::bind_cancellation_slot(token, yield[ec]));
-
-            if (ec == boost::asio::error::operation_aborted or not running_)
-                break;
-
-            doRead(yield);
-        }
-
-        finishedCountdown_.count_down(1);
+    backend_.subscribeToNewState([this](auto&&... args) {
+        metrics_.onNewState(std::forward<decltype(args)>(args)...);
     });
-
-    util::spawn(strand_, [this](boost::asio::yield_context yield) {
-        boost::asio::steady_timer timer(yield.get_executor());
-        boost::system::error_code ec;
-
-        while (running_) {
-            doWrite();
-            timer.expires_after(writeInterval_);
-            auto token = cancelSignal_.slot();
-            timer.async_wait(boost::asio::bind_cancellation_slot(token, yield[ec]));
-
-            if (ec == boost::asio::error::operation_aborted or not running_)
-                break;
-        }
-
-        finishedCountdown_.count_down(1);
+    backend_.subscribeToNewState([this](auto&&... args) {
+        writerDecider_.onNewState(std::forward<decltype(args)>(args)...);
     });
+    backend_.run();
 }
 
 ClusterCommunicationService::~ClusterCommunicationService()
@@ -121,107 +60,7 @@ ClusterCommunicationService::~ClusterCommunicationService()
 void
 ClusterCommunicationService::stop()
 {
-    if (stopped_)
-        return;
-
-    stopped_ = true;
-
-    // for ASAN to see through concurrency correctly we need to exit all coroutines before joining the ctx
-    running_ = false;
-
-    // cancelSignal_ is not thread safe so we execute emit on the same strand
-    boost::asio::spawn(
-        strand_, [this](auto&&) { cancelSignal_.emit(boost::asio::cancellation_type::all); }, boost::asio::use_future
-    )
-        .wait();
-    finishedCountdown_.wait();
-
-    ctx_.join();
-}
-
-std::shared_ptr<boost::uuids::uuid>
-ClusterCommunicationService::selfUuid() const
-{
-    // Uuid never changes so it is safe to copy it without using strand_
-    return selfData_.uuid;
-}
-
-ClioNode
-ClusterCommunicationService::selfData() const
-{
-    ClioNode result{};
-    util::spawn(strand_, [this, &result](boost::asio::yield_context) { result = selfData_; });
-    return result;
-}
-
-std::expected<std::vector<ClioNode>, std::string>
-ClusterCommunicationService::clusterData() const
-{
-    if (not isHealthy_) {
-        return std::unexpected{"Service is not healthy"};
-    }
-    std::vector<ClioNode> result;
-    util::spawn(strand_, [this, &result](boost::asio::yield_context) {
-        result = otherNodesData_;
-        result.push_back(selfData_);
-    });
-    return result;
-}
-
-void
-ClusterCommunicationService::doRead(boost::asio::yield_context yield)
-{
-    otherNodesData_.clear();
-
-    BackendInterface::ClioNodesDataFetchResult expectedResult;
-    try {
-        expectedResult = backend_->fetchClioNodesData(yield);
-    } catch (...) {
-        expectedResult = std::unexpected{"Failed to fecth Clio nodes data"};
-    }
-
-    if (!expectedResult.has_value()) {
-        LOG(log_.error()) << "Failed to fetch nodes data";
-        isHealthy_ = false;
-        return;
-    }
-
-    // Create a new vector here to not have partially parsed data in otherNodesData_
-    std::vector<ClioNode> otherNodesData;
-    for (auto const& [uuid, nodeDataStr] : expectedResult.value()) {
-        if (uuid == *selfData_.uuid) {
-            continue;
-        }
-
-        boost::system::error_code errorCode;
-        auto const json = boost::json::parse(nodeDataStr, errorCode);
-        if (errorCode.failed()) {
-            LOG(log_.error()) << "Error parsing json from DB: " << nodeDataStr;
-            isHealthy_ = false;
-            return;
-        }
-
-        auto expectedNodeData = boost::json::try_value_to<ClioNode>(json);
-        if (expectedNodeData.has_error()) {
-            LOG(log_.error()) << "Error converting json to ClioNode: " << json;
-            isHealthy_ = false;
-            return;
-        }
-        *expectedNodeData->uuid = uuid;
-        otherNodesData.push_back(std::move(expectedNodeData).value());
-    }
-    otherNodesData_ = std::move(otherNodesData);
-    nodesInClusterMetric_.set(otherNodesData_.size() + 1);
-    isHealthy_ = true;
-}
-
-void
-ClusterCommunicationService::doWrite()
-{
-    selfData_.updateTime = std::chrono::system_clock::now();
-    boost::json::value jsonValue{};
-    boost::json::value_from(selfData_, jsonValue);
-    backend_->writeNodeMessage(*selfData_.uuid, boost::json::serialize(jsonValue.as_object()));
+    backend_.stop();
 }
 
 }  // namespace cluster

src/cluster/ClusterCommunicationService.hpp

@@ -19,13 +19,12 @@
 
 #pragma once
 
-#include "cluster/ClioNode.hpp"
-#include "cluster/ClusterCommunicationServiceInterface.hpp"
+#include "cluster/Backend.hpp"
+#include "cluster/Concepts.hpp"
+#include "cluster/Metrics.hpp"
+#include "cluster/WriterDecider.hpp"
 #include "data/BackendInterface.hpp"
-#include "util/log/Logger.hpp"
-#include "util/prometheus/Bool.hpp"
-#include "util/prometheus/Gauge.hpp"
-#include "util/prometheus/Prometheus.hpp"
+#include "etl/WriterState.hpp"
 
 #include <boost/asio/cancellation_signal.hpp>
 #include <boost/asio/spawn.hpp>
@@ -33,67 +32,51 @@
 #include <boost/asio/thread_pool.hpp>
 #include <boost/uuid/uuid.hpp>
 
-#include <atomic>
 #include <chrono>
-#include <latch>
 #include <memory>
-#include <string>
-#include <vector>
 
 namespace cluster {
 
 /**
- * @brief Service to post and read messages to/from the cluster. It uses a backend to communicate with the cluster.
+ * @brief Service to post and read messages to/from the cluster. It uses a backend to communicate
+ * with the cluster.
  */
-class ClusterCommunicationService : public ClusterCommunicationServiceInterface {
-    util::prometheus::GaugeInt& nodesInClusterMetric_ = PrometheusService::gaugeInt(
-        "cluster_nodes_total_number",
-        {},
-        "Total number of nodes this node can detect in the cluster."
-    );
-    util::prometheus::Bool isHealthy_ = PrometheusService::boolMetric(
-        "cluster_communication_is_healthy",
-        {},
-        "Whether cluster communication service is operating healthy (1 - healthy, 0 - we have a problem)"
-    );
-
-    // TODO: Use util::async::CoroExecutionContext after https://github.com/XRPLF/clio/issues/1973 is implemented
+class ClusterCommunicationService : public ClusterCommunicationServiceTag {
+    // TODO: Use util::async::CoroExecutionContext after https://github.com/XRPLF/clio/issues/1973
+    // is implemented
     boost::asio::thread_pool ctx_{1};
-    boost::asio::strand<boost::asio::thread_pool::executor_type> strand_ = boost::asio::make_strand(ctx_);
-
-    util::Logger log_{"ClusterCommunication"};
-
-    std::shared_ptr<data::BackendInterface> backend_;
-
-    std::chrono::steady_clock::duration readInterval_;
-    std::chrono::steady_clock::duration writeInterval_;
-
-    boost::asio::cancellation_signal cancelSignal_;
-    std::latch finishedCountdown_;
-    std::atomic_bool running_ = false;
-    bool stopped_ = false;
-
-    ClioNode selfData_;
-    std::vector<ClioNode> otherNodesData_;
+    Backend backend_;
+    Metrics metrics_;
+    WriterDecider writerDecider_;
 
 public:
-    static constexpr std::chrono::milliseconds kDEFAULT_READ_INTERVAL{2100};
-    static constexpr std::chrono::milliseconds kDEFAULT_WRITE_INTERVAL{1200};
+    static constexpr std::chrono::milliseconds kDEFAULT_READ_INTERVAL{1000};
+    static constexpr std::chrono::milliseconds kDEFAULT_WRITE_INTERVAL{1000};
+
     /**
      * @brief Construct a new Cluster Communication Service object.
      *
      * @param backend The backend to use for communication.
+     * @param writerState The state showing whether clio is writing to the database.
      * @param readInterval The interval to read messages from the cluster.
      * @param writeInterval The interval to write messages to the cluster.
      */
     ClusterCommunicationService(
         std::shared_ptr<data::BackendInterface> backend,
+        std::unique_ptr<etl::WriterStateInterface> writerState,
         std::chrono::steady_clock::duration readInterval = kDEFAULT_READ_INTERVAL,
         std::chrono::steady_clock::duration writeInterval = kDEFAULT_WRITE_INTERVAL
     );
 
     ~ClusterCommunicationService() override;
 
+    ClusterCommunicationService(ClusterCommunicationService&&) = delete;
+    ClusterCommunicationService(ClusterCommunicationService const&) = delete;
+    ClusterCommunicationService&
+    operator=(ClusterCommunicationService&&) = delete;
+    ClusterCommunicationService&
+    operator=(ClusterCommunicationService const&) = delete;
+
     /**
      * @brief Start the service.
      */
@@ -105,44 +88,6 @@ public:
      */
     void
     stop();
-
-    ClusterCommunicationService(ClusterCommunicationService&&) = delete;
-    ClusterCommunicationService(ClusterCommunicationService const&) = delete;
-    ClusterCommunicationService&
-    operator=(ClusterCommunicationService&&) = delete;
-    ClusterCommunicationService&
-    operator=(ClusterCommunicationService const&) = delete;
-
-    /**
-     * @brief Get the UUID of the current node.
-     *
-     * @return The UUID of the current node.
-     */
-    std::shared_ptr<boost::uuids::uuid>
-    selfUuid() const;
-
-    /**
-     * @brief Get the data of the current node.
-     *
-     * @return The data of the current node.
-     */
-    ClioNode
-    selfData() const override;
-
-    /**
-     * @brief Get the data of all nodes in the cluster (including self).
-     *
-     * @return The data of all nodes in the cluster or error if the service is not healthy.
-     */
-    std::expected<std::vector<ClioNode>, std::string>
-    clusterData() const override;
-
-private:
-    void
-    doRead(boost::asio::yield_context yield);
-
-    void
-    doWrite();
 };
 
 }  // namespace cluster

src/cluster/Concepts.hpp

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#pragma once
+
+#include <concepts>
+
+namespace cluster {
+
+/**
+ * @brief Tag type for cluster communication service implementations.
+ *
+ * This tag is used to identify types that implement cluster communication functionality.
+ * Types should inherit from this tag to be recognized as cluster communication services.
+ */
+struct ClusterCommunicationServiceTag {
+    virtual ~ClusterCommunicationServiceTag() = default;
+};
+
+template <typename T>
+concept SomeClusterCommunicationService = std::derived_from<T, ClusterCommunicationServiceTag>;
+
+}  // namespace cluster

src/cluster/Metrics.cpp

@@ -17,38 +17,31 @@
 */
 //==============================================================================
 
-#pragma once
+#include "cluster/Metrics.hpp"
 
+#include "cluster/Backend.hpp"
 #include "cluster/ClioNode.hpp"
 
-#include <expected>
-#include <string>
-#include <vector>
+#include <memory>
 
 namespace cluster {
 
-/**
- * @brief Interface for the cluster communication service.
- */
-class ClusterCommunicationServiceInterface {
-public:
-    virtual ~ClusterCommunicationServiceInterface() = default;
+Metrics::Metrics()
+{
+    nodesInClusterMetric_.set(1);  // The node always sees itself
+    isHealthy_ = true;
+}
 
-    /**
-     * @brief Get the data of the current node.
-     *
-     * @return The data of the current node.
-     */
-    [[nodiscard]] virtual ClioNode
-    selfData() const = 0;
-
-    /**
-     * @brief Get the data of all nodes in the cluster (including self).
-     *
-     * @return The data of all nodes in the cluster or error if the service is not healthy.
-     */
-    [[nodiscard]] virtual std::expected<std::vector<ClioNode>, std::string>
-    clusterData() const = 0;
-};
+void
+Metrics::onNewState(ClioNode::CUuid, std::shared_ptr<Backend::ClusterData const> clusterData)
+{
+    if (clusterData->has_value()) {
+        isHealthy_ = true;
+        nodesInClusterMetric_.set(clusterData->value().size());
+    } else {
+        isHealthy_ = false;
+        nodesInClusterMetric_.set(1);
+    }
+}
 
 }  // namespace cluster

src/cluster/Metrics.hpp

@@ -0,0 +1,78 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#pragma once
+
+#include "cluster/Backend.hpp"
+#include "cluster/ClioNode.hpp"
+#include "util/prometheus/Bool.hpp"
+#include "util/prometheus/Gauge.hpp"
+#include "util/prometheus/Prometheus.hpp"
+
+#include <memory>
+
+namespace cluster {
+
+/**
+ * @brief Manages Prometheus metrics for cluster communication and node tracking.
+ *
+ * This class tracks cluster-related metrics including:
+ * - Total number of nodes detected in the cluster
+ * - Health status of cluster communication
+ */
+class Metrics {
+    /** @brief Gauge tracking the total number of nodes visible in the cluster */
+    util::prometheus::GaugeInt& nodesInClusterMetric_ = PrometheusService::gaugeInt(
+        "cluster_nodes_total_number",
+        {},
+        "Total number of nodes this node can detect in the cluster."
+    );
+
+    /** @brief Boolean metric indicating whether cluster communication is healthy */
+    util::prometheus::Bool isHealthy_ = PrometheusService::boolMetric(
+        "cluster_communication_is_healthy",
+        {},
+        "Whether cluster communication service is operating healthy (1 - healthy, 0 - we have a "
+        "problem)"
+    );
+
+public:
+    /**
+     * @brief Constructs a Metrics instance and initializes metrics.
+     *
+     * Sets the initial node count to 1 (self) and marks communication as healthy.
+     */
+    Metrics();
+
+    /**
+     * @brief Updates metrics based on new cluster state.
+     *
+     * This callback is invoked when cluster state changes. It updates:
+     * - Health status based on whether cluster data is available
+     * - Node count to reflect the current cluster size
+     *
+     * @param uuid The UUID of the node (unused in current implementation)
+     * @param clusterData Shared pointer to the current cluster data; may be empty if communication
+     * failed
+     */
+    void
+    onNewState(ClioNode::CUuid uuid, std::shared_ptr<Backend::ClusterData const> clusterData);
+};
+
+}  // namespace cluster

src/cluster/WriterDecider.cpp

@@ -0,0 +1,121 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#include "cluster/WriterDecider.hpp"
+
+#include "cluster/Backend.hpp"
+#include "cluster/ClioNode.hpp"
+#include "etl/WriterState.hpp"
+#include "util/Assert.hpp"
+#include "util/Spawn.hpp"
+
+#include <boost/asio/thread_pool.hpp>
+
+#include <algorithm>
+#include <memory>
+#include <utility>
+#include <vector>
+
+namespace cluster {
+
+WriterDecider::WriterDecider(
+    boost::asio::thread_pool& ctx,
+    std::unique_ptr<etl::WriterStateInterface> writerState
+)
+    : ctx_(ctx), writerState_(std::move(writerState))
+{
+}
+
+void
+WriterDecider::onNewState(
+    ClioNode::CUuid selfId,
+    std::shared_ptr<Backend::ClusterData const> clusterData
+)
+{
+    if (not clusterData->has_value())
+        return;
+
+    util::spawn(
+        ctx_,
+        [writerState = writerState_->clone(),
+         selfId = std::move(selfId),
+         clusterData = clusterData->value()](auto&&) mutable {
+            auto const selfData = std::ranges::find_if(
+                clusterData, [&selfId](ClioNode const& node) { return node.uuid == selfId; }
+            );
+            ASSERT(selfData != clusterData.end(), "Self data should always be in the cluster data");
+
+            if (selfData->dbRole == ClioNode::DbRole::Fallback) {
+                return;
+            }
+
+            if (selfData->dbRole == ClioNode::DbRole::ReadOnly) {
+                writerState->giveUpWriting();
+                return;
+            }
+
+            // If any node in the cluster is in Fallback mode, the entire cluster must switch
+            // to the fallback writer decision mechanism for consistency
+            if (std::ranges::any_of(clusterData, [](ClioNode const& node) {
+                    return node.dbRole == ClioNode::DbRole::Fallback;
+                })) {
+                writerState->setWriterDecidingFallback();
+                return;
+            }
+
+            // We are not ReadOnly and there is no Fallback in the cluster
+            std::ranges::sort(clusterData, [](ClioNode const& lhs, ClioNode const& rhs) {
+                return *lhs.uuid < *rhs.uuid;
+            });
+
+            auto it = std::ranges::find_if(clusterData, [](ClioNode const& node) {
+                return node.etlStarted and node.cacheIsFull and
+                    (node.dbRole == ClioNode::DbRole::NotWriter or
+                     node.dbRole == ClioNode::DbRole::Writer);
+            });
+
+            auto electNode = [&selfId, &writerState](auto it) {
+                if (*it->uuid == *selfId) {
+                    writerState->startWriting();
+                } else {
+                    writerState->giveUpWriting();
+                }
+            };
+            if (it != clusterData.end()) {
+                electNode(it);
+                return;
+            }
+
+            // Try to find a node with at least started ETL
+            it = std::ranges::find_if(clusterData, [](ClioNode const& node) {
+                return node.etlStarted and
+                    (node.dbRole == ClioNode::DbRole::NotWriter or
+                     node.dbRole == ClioNode::DbRole::Writer);
+            });
+
+            if (it != clusterData.end()) {
+                electNode(it);
+                return;
+            }
+            writerState->giveUpWriting();
+        }
+    );
+}
+
+}  // namespace cluster

src/cluster/WriterDecider.hpp

@@ -0,0 +1,79 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#pragma once
+
+#include "cluster/Backend.hpp"
+#include "cluster/ClioNode.hpp"
+#include "etl/WriterState.hpp"
+
+#include <boost/asio/thread_pool.hpp>
+
+#include <memory>
+
+namespace cluster {
+
+/**
+ * @brief Decides which node in the cluster should be the writer based on cluster state.
+ *
+ * This class monitors cluster state changes and determines whether the current node
+ * should act as the writer to the database. The decision is made by:
+ * 1. Sorting all nodes by UUID for deterministic ordering
+ * 2. Selecting the first node that is allowed to write (not ReadOnly)
+ * 3. Activating writing on this node if it's the current node, otherwise deactivating
+ *
+ * This ensures only one node in the cluster actively writes to the database at a time.
+ */
+class WriterDecider {
+    /** @brief Thread pool for spawning asynchronous tasks */
+    boost::asio::thread_pool& ctx_;
+
+    /** @brief Interface for controlling the writer state of this node */
+    std::unique_ptr<etl::WriterStateInterface> writerState_;
+
+public:
+    /**
+     * @brief Constructs a WriterDecider.
+     *
+     * @param ctx Thread pool for executing asynchronous operations
+     * @param writerState Writer state interface for controlling write operations
+     */
+    WriterDecider(
+        boost::asio::thread_pool& ctx,
+        std::unique_ptr<etl::WriterStateInterface> writerState
+    );
+
+    /**
+     * @brief Handles cluster state changes and decides whether this node should be the writer.
+     *
+     * This method is called when cluster state changes. It asynchronously:
+     * - Sorts all nodes by UUID to establish a deterministic order
+     * - Identifies the first node allowed to write (not ReadOnly)
+     * - Activates writing if this node is selected, otherwise deactivates writing
+     * - Logs a warning if no nodes in the cluster are allowed to write
+     *
+     * @param selfId The UUID of the current node
+     * @param clusterData Shared pointer to current cluster data; may be empty if communication
+     * failed
+     */
+    void
+    onNewState(ClioNode::CUuid selfId, std::shared_ptr<Backend::ClusterData const> clusterData);
+};
+
+}  // namespace cluster

src/cluster/impl/RepeatedTask.hpp

@@ -0,0 +1,109 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2025, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#pragma once
+
+#include "util/Assert.hpp"
+#include "util/Spawn.hpp"
+
+#include <boost/asio/bind_cancellation_slot.hpp>
+#include <boost/asio/cancellation_signal.hpp>
+#include <boost/asio/cancellation_type.hpp>
+#include <boost/asio/error.hpp>
+#include <boost/asio/executor.hpp>
+#include <boost/asio/spawn.hpp>
+#include <boost/asio/steady_timer.hpp>
+#include <boost/asio/strand.hpp>
+
+#include <atomic>
+#include <chrono>
+#include <concepts>
+#include <semaphore>
+
+namespace cluster::impl {
+
+// TODO: Try to replace util::Repeat by this. https://github.com/XRPLF/clio/issues/2926
+template <typename Context>
+class RepeatedTask {
+    std::chrono::steady_clock::duration interval_;
+    boost::asio::strand<typename Context::executor_type> strand_;
+
+    enum class State { Running, Stopped };
+    std::atomic<State> state_ = State::Stopped;
+
+    std::binary_semaphore semaphore_{0};
+    boost::asio::steady_timer timer_;
+
+public:
+    RepeatedTask(std::chrono::steady_clock::duration interval, Context& ctx)
+        : interval_(interval), strand_(boost::asio::make_strand(ctx)), timer_(strand_)
+    {
+    }
+
+    ~RepeatedTask()
+    {
+        stop();
+    }
+
+    template <typename Fn>
+        requires std::invocable<Fn, boost::asio::yield_context> or std::invocable<Fn>
+    void
+    run(Fn&& f)
+    {
+        ASSERT(state_ == State::Stopped, "Can only be ran once");
+        state_ = State::Running;
+        util::spawn(strand_, [this, f = std::forward<Fn>(f)](boost::asio::yield_context yield) {
+            boost::system::error_code ec;
+
+            while (state_ == State::Running) {
+                timer_.expires_after(interval_);
+                timer_.async_wait(yield[ec]);
+
+                if (ec or state_ != State::Running)
+                    break;
+
+                if constexpr (std::invocable<decltype(f), boost::asio::yield_context>) {
+                    f(yield);
+                } else {
+                    f();
+                }
+            }
+
+            semaphore_.release();
+        });
+    }
+
+    void
+    stop()
+    {
+        if (auto expected = State::Running;
+            not state_.compare_exchange_strong(expected, State::Stopped))
+            return;  // Already stopped or not started
+
+        std::binary_semaphore cancelSemaphore{0};
+        boost::asio::post(strand_, [this, &cancelSemaphore]() {
+            timer_.cancel();
+            cancelSemaphore.release();
+        });
+        cancelSemaphore.acquire();
+        semaphore_.acquire();
+    }
+};
+
+}  // namespace cluster::impl

src/data/AmendmentCenter.cpp

@@ -57,10 +57,15 @@ supportedAmendments()
 }
 
 bool
-lookupAmendment(auto const& allAmendments, std::vector<ripple::uint256> const& ledgerAmendments, std::string_view name)
+lookupAmendment(
+    auto const& allAmendments,
+    std::vector<ripple::uint256> const& ledgerAmendments,
+    std::string_view name
+)
 {
     namespace rg = std::ranges;
-    if (auto const am = rg::find(allAmendments, name, &data::Amendment::name); am != rg::end(allAmendments))
+    if (auto const am = rg::find(allAmendments, name, &data::Amendment::name);
+        am != rg::end(allAmendments))
         return rg::find(ledgerAmendments, am->feature) != rg::end(ledgerAmendments);
     return false;
 }
@@ -70,9 +75,12 @@ lookupAmendment(auto const& allAmendments, std::vector<ripple::uint256> const& l
 namespace data {
 namespace impl {
 
-WritingAmendmentKey::WritingAmendmentKey(std::string amendmentName) : AmendmentKey{std::move(amendmentName)}
+WritingAmendmentKey::WritingAmendmentKey(std::string amendmentName)
+    : AmendmentKey{std::move(amendmentName)}
 {
-    ASSERT(not supportedAmendments().contains(name), "Attempt to register the same amendment twice");
+    ASSERT(
+        not supportedAmendments().contains(name), "Attempt to register the same amendment twice"
+    );
     supportedAmendments().insert(name);
 }
 
@@ -96,7 +104,8 @@ operator ripple::uint256() const
     return Amendment::getAmendmentId(name);
 }
 
-AmendmentCenter::AmendmentCenter(std::shared_ptr<data::BackendInterface> const& backend) : backend_{backend}
+AmendmentCenter::AmendmentCenter(std::shared_ptr<data::BackendInterface> const& backend)
+    : backend_{backend}
 {
     namespace rg = std::ranges;
     namespace vs = std::views;
@@ -108,7 +117,8 @@ AmendmentCenter::AmendmentCenter(std::shared_ptr<data::BackendInterface> const&
                 .name = name,
                 .feature = Amendment::getAmendmentId(name),
                 .isSupportedByXRPL = support != ripple::AmendmentSupport::Unsupported,
-                .isSupportedByClio = rg::find(supportedAmendments(), name) != rg::end(supportedAmendments()),
+                .isSupportedByClio =
+                    rg::find(supportedAmendments(), name) != rg::end(supportedAmendments()),
                 .isRetired = support == ripple::AmendmentSupport::Retired
             };
         }),
@@ -144,26 +154,44 @@ AmendmentCenter::isEnabled(AmendmentKey const& key, uint32_t seq) const
 }
 
 bool
-AmendmentCenter::isEnabled(boost::asio::yield_context yield, AmendmentKey const& key, uint32_t seq) const
+AmendmentCenter::isEnabled(
+    boost::asio::yield_context yield,
+    AmendmentKey const& key,
+    uint32_t seq
+) const
 {
-    if (auto const listAmendments = fetchAmendmentsList(yield, seq); listAmendments)
-        return lookupAmendment(all_, *listAmendments, key);
-
+    try {
+        if (auto const listAmendments = fetchAmendmentsList(yield, seq); listAmendments)
+            return lookupAmendment(all_, *listAmendments, key);
+    } catch (std::runtime_error const&) {
+        return false;  // Some old ledger does not contain Amendments ledger object so do best we
+                       // can for now
+    }
     return false;
 }
 
 std::vector<bool>
-AmendmentCenter::isEnabled(boost::asio::yield_context yield, std::vector<AmendmentKey> const& keys, uint32_t seq) const
+AmendmentCenter::isEnabled(
+    boost::asio::yield_context yield,
+    std::vector<AmendmentKey> const& keys,
+    uint32_t seq
+) const
 {
     namespace rg = std::ranges;
 
-    if (auto const listAmendments = fetchAmendmentsList(yield, seq); listAmendments) {
-        std::vector<bool> out;
-        rg::transform(keys, std::back_inserter(out), [this, &listAmendments](auto const& key) {
-            return lookupAmendment(all_, *listAmendments, key);
-        });
+    try {
+        if (auto const listAmendments = fetchAmendmentsList(yield, seq); listAmendments) {
+            std::vector<bool> out;
+            rg::transform(keys, std::back_inserter(out), [this, &listAmendments](auto const& key) {
+                return lookupAmendment(all_, *listAmendments, key);
+            });
 
-        return out;
+            return out;
+        }
+    } catch (std::runtime_error const&) {
+        return std::vector<bool>(
+            keys.size(), false
+        );  // Some old ledger does not contain Amendments ledger object so do best we can for now
     }
 
     return std::vector<bool>(keys.size(), false);
@@ -172,7 +200,11 @@ AmendmentCenter::isEnabled(boost::asio::yield_context yield, std::vector<Amendme
 Amendment const&
 AmendmentCenter::getAmendment(AmendmentKey const& key) const
 {
-    ASSERT(supported_.contains(key), "The amendment '{}' must be present in supported amendments list", key.name);
+    ASSERT(
+        supported_.contains(key),
+        "The amendment '{}' must be present in supported amendments list",
+        key.name
+    );
     return supported_.at(key);
 }
 
@@ -192,7 +224,8 @@ std::optional<std::vector<ripple::uint256>>
 AmendmentCenter::fetchAmendmentsList(boost::asio::yield_context yield, uint32_t seq) const
 {
     // the amendments should always be present on the ledger
-    auto const amendments = backend_->fetchLedgerObject(ripple::keylet::amendments().key, seq, yield);
+    auto const amendments =
+        backend_->fetchLedgerObject(ripple::keylet::amendments().key, seq, yield);
     if (not amendments.has_value())
         throw std::runtime_error("Amendments ledger object must be present in the database");
 

src/data/AmendmentCenter.hpp

@@ -62,9 +62,9 @@ struct WritingAmendmentKey : AmendmentKey {
  */
 struct Amendments {
     // NOTE: if Clio wants to report it supports an Amendment it should be listed here.
-    // Whether an amendment is obsolete and/or supported by libxrpl is extracted directly from libxrpl.
-    // If an amendment is in the list below it just means Clio did whatever changes needed to support it.
-    // Most of the time it's going to be no changes at all.
+    // Whether an amendment is obsolete and/or supported by libxrpl is extracted directly from
+    // libxrpl. If an amendment is in the list below it just means Clio did whatever changes needed
+    // to support it. Most of the time it's going to be no changes at all.
 
     /** @cond */
     // NOLINTBEGIN(readability-identifier-naming)
@@ -152,6 +152,7 @@ struct Amendments {
     REGISTER(fixDirectoryLimit);
     REGISTER(fixIncludeKeyletFields);
     REGISTER(fixTokenEscrowV1);
+    REGISTER(LendingProtocol);
 
     // Obsolete but supported by libxrpl
     REGISTER(CryptoConditionsSuite);
@@ -176,6 +177,7 @@ struct Amendments {
     REGISTER(fix1512);
     REGISTER(fix1523);
     REGISTER(fix1528);
+    REGISTER(fixBatchInnerSigs);
     // NOLINTEND(readability-identifier-naming)
     /** @endcond */
 };
@@ -254,7 +256,11 @@ public:
      * @return A vector of bools representing enabled state for each of the given keys
      */
     [[nodiscard]] std::vector<bool>
-    isEnabled(boost::asio::yield_context yield, std::vector<AmendmentKey> const& keys, uint32_t seq) const final;
+    isEnabled(
+        boost::asio::yield_context yield,
+        std::vector<AmendmentKey> const& keys,
+        uint32_t seq
+    ) const final;
 
     /**
      * @brief Get an amendment

src/data/AmendmentCenterInterface.hpp

@@ -92,7 +92,11 @@ public:
      * @return A vector of bools representing enabled state for each of the given keys
      */
     [[nodiscard]] virtual std::vector<bool>
-    isEnabled(boost::asio::yield_context yield, std::vector<AmendmentKey> const& keys, uint32_t seq) const = 0;
+    isEnabled(
+        boost::asio::yield_context yield,
+        std::vector<AmendmentKey> const& keys,
+        uint32_t seq
+    ) const = 0;
 
     /**
      * @brief Get an amendment

src/data/BackendCounters.cpp

@@ -41,7 +41,10 @@ std::vector<std::int64_t> const kHISTOGRAM_BUCKETS{1, 2, 5, 10, 20, 50, 100, 200
 std::int64_t
 durationInMillisecondsSince(std::chrono::steady_clock::time_point const startTime)
 {
-    return std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now() - startTime).count();
+    return std::chrono::duration_cast<std::chrono::milliseconds>(
+               std::chrono::steady_clock::now() - startTime
+    )
+        .count();
 }
 
 }  // namespace
@@ -144,7 +147,10 @@ BackendCounters::registerReadStarted(std::uint64_t const count)
 }
 
 void
-BackendCounters::registerReadFinished(std::chrono::steady_clock::time_point const startTime, std::uint64_t const count)
+BackendCounters::registerReadFinished(
+    std::chrono::steady_clock::time_point const startTime,
+    std::uint64_t const count
+)
 {
     asyncReadCounters_.registerFinished(count);
     auto const duration = durationInMillisecondsSince(startTime);
@@ -238,7 +244,8 @@ void
 BackendCounters::AsyncOperationCounters::registerError(std::uint64_t count)
 {
     ASSERT(
-        pendingCounter_.get().value() >= static_cast<std::int64_t>(count), "Error operations can't be more than pending"
+        pendingCounter_.get().value() >= static_cast<std::int64_t>(count),
+        "Error operations can't be more than pending"
     );
     pendingCounter_.get() -= count;
     errorCounter_.get() += count;

src/data/BackendCounters.hpp

@@ -46,7 +46,9 @@ concept SomeBackendCounters = requires(T a) {
     { a.registerWriteFinished(std::chrono::steady_clock::time_point{}) } -> std::same_as<void>;
     { a.registerWriteRetry() } -> std::same_as<void>;
     { a.registerReadStarted(std::uint64_t{}) } -> std::same_as<void>;
-    { a.registerReadFinished(std::chrono::steady_clock::time_point{}, std::uint64_t{}) } -> std::same_as<void>;
+    {
+        a.registerReadFinished(std::chrono::steady_clock::time_point{}, std::uint64_t{})
+    } -> std::same_as<void>;
     { a.registerReadRetry(std::uint64_t{}) } -> std::same_as<void>;
     { a.registerReadError(std::uint64_t{}) } -> std::same_as<void>;
     { a.report() } -> std::same_as<boost::json::object>;

src/data/BackendInterface.cpp

@@ -128,7 +128,8 @@ BackendInterface::fetchLedgerObjects(
             misses.push_back(keys[i]);
         }
     }
-    LOG(log_.trace()) << "Cache hits = " << keys.size() - misses.size() << " - cache misses = " << misses.size();
+    LOG(log_.trace()) << "Cache hits = " << keys.size() - misses.size()
+                      << " - cache misses = " << misses.size();
 
     if (!misses.empty()) {
         auto objs = doFetchLedgerObjects(misses, sequence, yield);
@@ -192,7 +193,9 @@ BackendInterface::fetchBookOffers(
     ripple::uint256 const bookEnd = ripple::getQualityNext(book);
     ripple::uint256 uTipIndex = book;
     std::vector<ripple::uint256> keys;
-    auto getMillis = [](auto diff) { return std::chrono::duration_cast<std::chrono::milliseconds>(diff).count(); };
+    auto getMillis = [](auto diff) {
+        return std::chrono::duration_cast<std::chrono::milliseconds>(diff).count();
+    };
     auto begin = std::chrono::system_clock::now();
     std::uint32_t numSucc = 0;
     std::uint32_t numPages = 0;
@@ -233,20 +236,23 @@ BackendInterface::fetchBookOffers(
     auto mid = std::chrono::system_clock::now();
     auto objs = fetchLedgerObjects(keys, ledgerSequence, yield);
     for (size_t i = 0; i < keys.size() && i < limit; ++i) {
-        LOG(log_.trace()) << "Key = " << ripple::strHex(keys[i]) << " blob = " << ripple::strHex(objs[i])
+        LOG(log_.trace()) << "Key = " << ripple::strHex(keys[i])
+                          << " blob = " << ripple::strHex(objs[i])
                           << " ledgerSequence = " << ledgerSequence;
         ASSERT(!objs[i].empty(), "Ledger object can't be empty");
         page.offers.push_back({keys[i], objs[i]});
     }
     auto end = std::chrono::system_clock::now();
     LOG(log_.debug()) << "Fetching " << std::to_string(keys.size()) << " offers took "
-                      << std::to_string(getMillis(mid - begin)) << " milliseconds. Fetching next dir took "
-                      << std::to_string(succMillis) << " milliseconds. Fetched next dir " << std::to_string(numSucc)
-                      << " times"
-                      << " Fetching next page of dir took " << std::to_string(pageMillis) << " milliseconds"
-                      << ". num pages = " << std::to_string(numPages) << ". Fetching all objects took "
-                      << std::to_string(getMillis(end - mid))
-                      << " milliseconds. total time = " << std::to_string(getMillis(end - begin)) << " milliseconds"
+                      << std::to_string(getMillis(mid - begin))
+                      << " milliseconds. Fetching next dir took " << std::to_string(succMillis)
+                      << " milliseconds. Fetched next dir " << std::to_string(numSucc) << " times"
+                      << " Fetching next page of dir took " << std::to_string(pageMillis)
+                      << " milliseconds"
+                      << ". num pages = " << std::to_string(numPages)
+                      << ". Fetching all objects took " << std::to_string(getMillis(end - mid))
+                      << " milliseconds. total time = " << std::to_string(getMillis(end - begin))
+                      << " milliseconds"
                       << " book = " << ripple::strHex(book);
 
     return page;
@@ -273,7 +279,8 @@ BackendInterface::updateRange(uint32_t newMax)
     if (range_.has_value() and newMax < range_->maxSequence) {
         ASSERT(
             false,
-            "Range shouldn't exist yet or newMax should be at least range->maxSequence. newMax = {}, "
+            "Range shouldn't exist yet or newMax should be at least range->maxSequence. newMax = "
+            "{}, "
             "range->maxSequence = {}",
             newMax,
             range_->maxSequence
@@ -339,8 +346,8 @@ BackendInterface::fetchLedgerPage(
         if (!objects[i].empty()) {
             page.objects.push_back({keys[i], std::move(objects[i])});
         } else if (!outOfOrder) {
-            LOG(log_.error()) << "Deleted or non-existent object in successor table. key = " << ripple::strHex(keys[i])
-                              << " - seq = " << ledgerSequence;
+            LOG(log_.error()) << "Deleted or non-existent object in successor table. key = "
+                              << ripple::strHex(keys[i]) << " - seq = " << ledgerSequence;
             std::stringstream msg;
             for (size_t j = 0; j < objects.size(); ++j) {
                 msg << " - " << ripple::strHex(keys[j]);

src/data/BackendInterface.hpp

@@ -109,18 +109,23 @@ synchronous(FnType&& func)
     using R = typename boost::result_of<FnType(boost::asio::yield_context)>::type;
     if constexpr (!std::is_same_v<R, void>) {
         R res;
-        util::spawn(ctx, [_ = boost::asio::make_work_guard(ctx), &func, &res](auto yield) { res = func(yield); });
+        util::spawn(ctx, [_ = boost::asio::make_work_guard(ctx), &func, &res](auto yield) {
+            res = func(yield);
+        });
 
         ctx.run();
         return res;
     } else {
-        util::spawn(ctx, [_ = boost::asio::make_work_guard(ctx), &func](auto yield) { func(yield); });
+        util::spawn(ctx, [_ = boost::asio::make_work_guard(ctx), &func](auto yield) {
+            func(yield);
+        });
         ctx.run();
     }
 }
 
 /**
- * @brief Synchronously execute the given function object and retry until no DatabaseTimeout is thrown.
+ * @brief Synchronously execute the given function object and retry until no DatabaseTimeout is
+ * thrown.
  *
  * @tparam FnType The type of function object to execute
  * @param func The function object to execute
@@ -225,7 +230,8 @@ public:
     fetchLedgerRange() const;
 
     /**
-     * @brief Fetch the specified number of account root object indexes by page, the accounts need to exist for seq.
+     * @brief Fetch the specified number of account root object indexes by page, the accounts need
+     * to exist for seq.
      *
      * @param number The number of accounts to fetch
      * @param pageSize The maximum number of accounts per page
@@ -296,7 +302,10 @@ public:
      * @return A vector of TransactionAndMetadata matching the given hashes
      */
     virtual std::vector<TransactionAndMetadata>
-    fetchTransactions(std::vector<ripple::uint256> const& hashes, boost::asio::yield_context yield) const = 0;
+    fetchTransactions(
+        std::vector<ripple::uint256> const& hashes,
+        boost::asio::yield_context yield
+    ) const = 0;
 
     /**
      * @brief Fetches all transactions for a specific account.
@@ -325,7 +334,10 @@ public:
      * @return Results as a vector of TransactionAndMetadata
      */
     virtual std::vector<TransactionAndMetadata>
-    fetchAllTransactionsInLedger(std::uint32_t ledgerSequence, boost::asio::yield_context yield) const = 0;
+    fetchAllTransactionsInLedger(
+        std::uint32_t ledgerSequence,
+        boost::asio::yield_context yield
+    ) const = 0;
 
     /**
      * @brief Fetches all transaction hashes from a specific ledger.
@@ -335,7 +347,10 @@ public:
      * @return Hashes as ripple::uint256 in a vector
      */
     virtual std::vector<ripple::uint256>
-    fetchAllTransactionHashesInLedger(std::uint32_t ledgerSequence, boost::asio::yield_context yield) const = 0;
+    fetchAllTransactionHashesInLedger(
+        std::uint32_t ledgerSequence,
+        boost::asio::yield_context yield
+    ) const = 0;
 
     /**
      * @brief Fetches a specific NFT.
@@ -346,7 +361,11 @@ public:
      * @return NFT object on success; nullopt otherwise
      */
     virtual std::optional<NFT>
-    fetchNFT(ripple::uint256 const& tokenID, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const = 0;
+    fetchNFT(
+        ripple::uint256 const& tokenID,
+        std::uint32_t ledgerSequence,
+        boost::asio::yield_context yield
+    ) const = 0;
 
     /**
      * @brief Fetches all transactions for a specific NFT.
@@ -376,7 +395,8 @@ public:
      * @param limit Paging limit.
      * @param cursorIn Optional cursor to allow us to pick up from where we last left off.
      * @param yield Currently executing coroutine.
-     * @return NFTs issued by this account, or this issuer/taxon combination if taxon is passed and an optional marker
+     * @return NFTs issued by this account, or this issuer/taxon combination if taxon is passed and
+     * an optional marker
      */
     virtual NFTsAndCursor
     fetchNFTsByIssuer(
@@ -410,8 +430,8 @@ public:
     /**
      * @brief Fetches a specific ledger object.
      *
-     * Currently the real fetch happens in doFetchLedgerObject and fetchLedgerObject attempts to fetch from Cache first
-     * and only calls out to the real DB if a cache miss occurred.
+     * Currently the real fetch happens in doFetchLedgerObject and fetchLedgerObject attempts to
+     * fetch from Cache first and only calls out to the real DB if a cache miss occurred.
      *
      * @param key The key of the object
      * @param sequence The ledger sequence to fetch for
@@ -419,7 +439,11 @@ public:
      * @return The object as a Blob on success; nullopt otherwise
      */
     std::optional<Blob>
-    fetchLedgerObject(ripple::uint256 const& key, std::uint32_t sequence, boost::asio::yield_context yield) const;
+    fetchLedgerObject(
+        ripple::uint256 const& key,
+        std::uint32_t sequence,
+        boost::asio::yield_context yield
+    ) const;
 
     /**
      * @brief Fetches a specific ledger object sequence.
@@ -432,13 +456,18 @@ public:
      * @return The sequence in unit32_t on success; nullopt otherwise
      */
     std::optional<std::uint32_t>
-    fetchLedgerObjectSeq(ripple::uint256 const& key, std::uint32_t sequence, boost::asio::yield_context yield) const;
+    fetchLedgerObjectSeq(
+        ripple::uint256 const& key,
+        std::uint32_t sequence,
+        boost::asio::yield_context yield
+    ) const;
 
     /**
      * @brief Fetches all ledger objects by their keys.
      *
-     * Currently the real fetch happens in doFetchLedgerObjects and fetchLedgerObjects attempts to fetch from Cache
-     * first and only calls out to the real DB for each of the keys that was not found in the cache.
+     * Currently the real fetch happens in doFetchLedgerObjects and fetchLedgerObjects attempts to
+     * fetch from Cache first and only calls out to the real DB for each of the keys that was not
+     * found in the cache.
      *
      * @param keys A vector with the keys of the objects to fetch
      * @param sequence The ledger sequence to fetch for
@@ -461,7 +490,11 @@ public:
      * @return The object as a Blob on success; nullopt otherwise
      */
     virtual std::optional<Blob>
-    doFetchLedgerObject(ripple::uint256 const& key, std::uint32_t sequence, boost::asio::yield_context yield) const = 0;
+    doFetchLedgerObject(
+        ripple::uint256 const& key,
+        std::uint32_t sequence,
+        boost::asio::yield_context yield
+    ) const = 0;
 
     /**
      * @brief The database-specific implementation for fetching a ledger object sequence.
@@ -531,13 +564,18 @@ public:
      * @return The successor on success; nullopt otherwise
      */
     std::optional<LedgerObject>
-    fetchSuccessorObject(ripple::uint256 key, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const;
+    fetchSuccessorObject(
+        ripple::uint256 key,
+        std::uint32_t ledgerSequence,
+        boost::asio::yield_context yield
+    ) const;
 
     /**
      * @brief Fetches the successor key.
      *
-     * Thea real fetch happens in doFetchSuccessorKey. This function will attempt to lookup the successor in the cache
-     * first and only if it's not found in the cache will it fetch from the actual DB.
+     * Thea real fetch happens in doFetchSuccessorKey. This function will attempt to lookup the
+     * successor in the cache first and only if it's not found in the cache will it fetch from the
+     * actual DB.
      *
      * @param key The key to fetch for
      * @param ledgerSequence The ledger sequence to fetch for
@@ -545,7 +583,11 @@ public:
      * @return The successor key on success; nullopt otherwise
      */
     std::optional<ripple::uint256>
-    fetchSuccessorKey(ripple::uint256 key, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const;
+    fetchSuccessorKey(
+        ripple::uint256 key,
+        std::uint32_t ledgerSequence,
+        boost::asio::yield_context yield
+    ) const;
 
     /**
      * @brief Database-specific implementation of fetching the successor key
@@ -556,7 +598,11 @@ public:
      * @return The successor on success; nullopt otherwise
      */
     virtual std::optional<ripple::uint256>
-    doFetchSuccessorKey(ripple::uint256 key, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const = 0;
+    doFetchSuccessorKey(
+        ripple::uint256 key,
+        std::uint32_t ledgerSequence,
+        boost::asio::yield_context yield
+    ) const = 0;
 
     /**
      * @brief Fetches book offers.
@@ -583,7 +629,10 @@ public:
      * @return The status of the migrator if found; nullopt otherwise
      */
     virtual std::optional<std::string>
-    fetchMigratorStatus(std::string const& migratorName, boost::asio::yield_context yield) const = 0;
+    fetchMigratorStatus(
+        std::string const& migratorName,
+        boost::asio::yield_context yield
+    ) const = 0;
 
     /** @brief Return type for fetchClioNodesData() method */
     using ClioNodesDataFetchResult =
@@ -601,7 +650,8 @@ public:
     /**
      * @brief Synchronously fetches the ledger range from DB.
      *
-     * This function just wraps hardFetchLedgerRange(boost::asio::yield_context) using synchronous(FnType&&).
+     * This function just wraps hardFetchLedgerRange(boost::asio::yield_context) using
+     * synchronous(FnType&&).
      *
      * @return The ledger range if available; nullopt otherwise
      */