fix: Add upper bound to limit

'type' should not matter if 'full' or 'accounts' is false. Relax the
restriction for 'type'

.clang-tidy

@@ -4,6 +4,9 @@ Checks: '-*,
   bugprone-assert-side-effect,
   bugprone-bad-signal-to-kill-thread,
   bugprone-bool-pointer-implicit-conversion,
+  bugprone-casting-through-void,
+  bugprone-chained-comparison,
+  bugprone-compare-pointer-to-member-virtual-function,
   bugprone-copy-constructor-init,
   bugprone-dangling-handle,
   bugprone-dynamic-static-initializers,
@@ -11,6 +14,8 @@ Checks: '-*,
   bugprone-fold-init-type,
   bugprone-forward-declaration-namespace,
   bugprone-inaccurate-erase,
+  bugprone-inc-dec-in-conditions,
+  bugprone-incorrect-enable-if,
   bugprone-incorrect-roundings,
   bugprone-infinite-loop,
   bugprone-integer-division,
@@ -21,15 +26,16 @@ Checks: '-*,
   bugprone-misplaced-pointer-arithmetic-in-alloc,
   bugprone-misplaced-widening-cast,
   bugprone-move-forwarding-reference,
+  bugprone-multi-level-implicit-pointer-conversion,
   bugprone-multiple-new-in-one-expression,
   bugprone-multiple-statement-macro,
   bugprone-no-escape,
   bugprone-non-zero-enum-to-bool-conversion,
+  bugprone-optional-value-conversion,
   bugprone-parent-virtual-call,
   bugprone-posix-return,
   bugprone-redundant-branch-condition,
   bugprone-reserved-identifier,
-  bugprone-unused-return-value,
   bugprone-shared-ptr-array-mismatch,
   bugprone-signal-handler,
   bugprone-signed-char-misuse,
@@ -60,16 +66,20 @@ Checks: '-*,
   bugprone-unhandled-self-assignment,
   bugprone-unique-ptr-array-mismatch,
   bugprone-unsafe-functions,
+  bugprone-unused-local-non-trivial-variable,
   bugprone-unused-raii,
+  bugprone-unused-return-value,
   bugprone-use-after-move,
   bugprone-virtual-near-miss,
   cppcoreguidelines-init-variables,
   cppcoreguidelines-misleading-capture-default-by-value,
+  cppcoreguidelines-no-suspend-with-lock,
   cppcoreguidelines-pro-type-member-init,
   cppcoreguidelines-pro-type-static-cast-downcast,
   cppcoreguidelines-rvalue-reference-param-not-moved,
   cppcoreguidelines-use-default-member-init,
   cppcoreguidelines-virtual-class-destructor,
+  hicpp-ignored-remove-result,
   llvm-namespace-comment,
   misc-const-correctness,
   misc-definitions-in-headers,
@@ -91,6 +101,8 @@ Checks: '-*,
   modernize-use-equals-default,
   modernize-use-equals-delete,
   modernize-use-override,
+  modernize-use-starts-ends-with,
+  modernize-use-std-numbers,
   modernize-use-using,
   performance-faster-string-find,
   performance-for-range-copy,
@@ -100,7 +112,8 @@ Checks: '-*,
   performance-move-constructor-init,
   performance-no-automatic-move,
   performance-trivially-destructible,
-  readability-avoid-const-params-in-decls,
+  readability-avoid-nested-conditional-operator,
+  readability-avoid-return-with-void-value,
   readability-braces-around-statements,
   readability-const-return-type,
   readability-container-contains,
@@ -113,9 +126,12 @@ Checks: '-*,
   readability-make-member-function-const,
   readability-misleading-indentation,
   readability-non-const-parameter,
+  readability-redundant-casting,
   readability-redundant-declaration,
+  readability-redundant-inline-specifier,
   readability-redundant-member-init,
   readability-redundant-string-init,
+  readability-reference-to-constructed-temporary,
   readability-simplify-boolean-expr,
   readability-static-accessed-through-instance,
   readability-static-definition-in-anonymous-namespace,
@@ -125,9 +141,8 @@ Checks: '-*,
 CheckOptions:
   readability-braces-around-statements.ShortStatementLines: 2
   bugprone-unsafe-functions.ReportMoreUnsafeFunctions: true
-  bugprone-unused-return-value.CheckedReturnTypes: ::std::error_code;::std::error_condition;::std::errc;::std::expected
-  misc-include-cleaner.IgnoreHeaders: '.*/(detail|impl)/.*'
+  bugprone-unused-return-value.CheckedReturnTypes: ::std::error_code;::std::error_condition;::std::errc
+  misc-include-cleaner.IgnoreHeaders: '.*/(detail|impl)/.*;.*(expected|unexpected).*'
 
-HeaderFilterRegex: '^.*/(src|unittests)/.*\.(h|hpp)$'
+HeaderFilterRegex: '^.*/(src|tests)/.*\.(h|hpp)$'
 WarningsAsErrors: '*'
-

.clangd

@@ -1,5 +1,10 @@
+CompileFlags:
+  Add: [-D__cpp_concepts=202002]
+
 Diagnostics:
   UnusedIncludes: Strict
   MissingIncludes: Strict
   Includes:
-    IgnoreHeader: ".*/(detail|impl)/.*"
+    IgnoreHeader:
+      - ".*/(detail|impl)/.*"
+      - ".*expected.*"

.cmake-format.yaml

@@ -0,0 +1,245 @@
+_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: 6
+  _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 agressive 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 preceeding
+  - 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: {}

.gitattributes

@@ -0,0 +1,2 @@
+*.png filter=lfs diff=lfs merge=lfs -text
+*.svg filter=lfs diff=lfs merge=lfs -text

.githooks/check-docs

@@ -0,0 +1,62 @@
+#!/bin/bash
+
+# Note: This script is intended to be run from the root of the repository.
+#
+# Not really a hook but should be used to check the completness of documentation for added code, otherwise CI will come for you.
+# It's good to have /tmp as the output so that consecutive runs are fast but no clutter in the repository.
+
+echo "+ Checking documentation..."
+
+ROOT=$(pwd)
+DOXYGEN=$(command -v doxygen)
+TMPDIR=${ROOT}/.cache/doxygen
+TMPFILE=${TMPDIR}/docs.log
+DOCDIR=${TMPDIR}/out
+
+if [ -z "$DOXYGEN" ]; then
+    # No hard error if doxygen is not installed yet
+    cat <<EOF
+
+                                   WARNING
+-----------------------------------------------------------------------------
+        'doxygen' is required to check documentation.
+        Please install it for next time. For the time being it's on CI.
+-----------------------------------------------------------------------------
+
+EOF
+    exit 0
+fi
+
+mkdir -p ${DOCDIR} > /dev/null 2>&1
+pushd ${DOCDIR} > /dev/null 2>&1
+
+cat ${ROOT}/docs/Doxyfile | \
+sed \
+    -e "s/\${LINT}/YES/" \
+    -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\)")
+
+rm -rf ${TMPFILE} > /dev/null 2>&1
+popd > /dev/null 2>&1
+
+if [[ ! -z "$OUT" ]]; then
+    cat <<EOF
+
+                                    ERROR
+-----------------------------------------------------------------------------
+                      Found issues with documentation:
+
+$OUT
+-----------------------------------------------------------------------------
+
+EOF
+    exit 2
+fi

.githooks/check-format

@@ -0,0 +1,105 @@
+#!/bin/bash
+
+# Note: This script is intended to be run from the root of the repository.
+#
+# This script checks the format of the code and cmake files.
+# In many cases it will automatically fix the issues and abort the commit.
+
+echo "+ Checking code format..."
+
+# paths to check and re-format
+sources="src tests"
+formatter="clang-format -i"
+version=$($formatter --version | grep -o '[0-9\.]*')
+
+if [[ "18.0.0" > "$version" ]]; then
+    cat <<EOF
+
+                                    ERROR
+-----------------------------------------------------------------------------
+            A minimum of version 18 of `which clang-format` is required.
+            Your version is $version.
+            Please fix paths and run again.
+-----------------------------------------------------------------------------
+
+EOF
+    exit 3
+fi
+
+# check there is no .h headers, only .hpp
+wrong_headers=$(find $sources -name "*.h" | sed 's/^/        - /')
+if [[ ! -z "$wrong_headers" ]]; then
+    cat <<EOF
+
+                                    ERROR
+-----------------------------------------------------------------------------
+       Found .h headers in the source code. Please rename them to .hpp:
+
+$wrong_headers
+-----------------------------------------------------------------------------
+
+EOF
+    exit 2
+fi
+
+if ! command -v cmake-format &> /dev/null; then
+    cat <<EOF
+
+                                    ERROR
+-----------------------------------------------------------------------------
+        'cmake-format' is required to run this script.
+        Please install it and run again.
+-----------------------------------------------------------------------------
+
+EOF
+    exit 3
+fi
+
+function grep_code {
+    grep -l "${1}" ${sources} -r --include \*.hpp --include \*.cpp
+}
+
+GNU_SED=$(sed --version 2>&1 | grep -q 'GNU' && echo true || echo false)
+
+if [[ "$GNU_SED" == "false" ]]; then # macOS sed
+    # make all includes to be <...> style
+    grep_code '#include ".*"' | xargs sed -i '' -E 's|#include "(.*)"|#include <\1>|g'
+
+    # make local includes to be "..." style
+    main_src_dirs=$(find ./src -maxdepth 1 -type d -exec basename {} \; | tr '\n' '|' | sed 's/|$//' | sed 's/|/\\|/g')
+    grep_code "#include <\($main_src_dirs\)/.*>" | xargs sed -i '' -E "s|#include <(($main_src_dirs)/.*)>|#include \"\1\"|g"
+else
+    # make all includes to be <...> style
+    grep_code '#include ".*"' | xargs sed -i -E 's|#include "(.*)"|#include <\1>|g'
+
+    # make local includes to be "..." style
+    main_src_dirs=$(find ./src -maxdepth 1 -type d  -exec basename {} \; | paste -sd '|' | sed 's/|/\\|/g')
+    grep_code "#include <\($main_src_dirs\)/.*>" | xargs sed -i -E "s|#include <(($main_src_dirs)/.*)>|#include \"\1\"|g"
+fi
+
+cmake_dirs=$(echo cmake $sources)
+cmake_files=$(find $cmake_dirs -type f \( -name "CMakeLists.txt" -o -name "*.cmake" \))
+cmake_files=$(echo $cmake_files ./CMakeLists.txt)
+
+first=$(git diff $sources $cmake_files)
+find $sources -type f \( -name '*.cpp' -o -name '*.hpp' -o -name '*.ipp' \) -print0 | xargs -0 $formatter
+cmake-format -i $cmake_files
+second=$(git diff $sources $cmake_files)
+changes=$(diff <(echo "$first") <(echo "$second"))
+changes_number=$(echo -n "$changes" | wc -l | sed -e 's/^[[:space:]]*//')
+
+if [ "$changes_number" != "0" ]; then
+    cat <<\EOF
+
+                                   WARNING
+-----------------------------------------------------------------------------
+  Automatically re-formatted code with 'clang-format' - commit was aborted.
+  Please manually add any updated files and commit again.
+-----------------------------------------------------------------------------
+
+EOF
+    if [[ "$1" == "--diff" ]]; then
+        echo "$changes"
+    fi
+    exit 1
+fi

.githooks/post-checkout

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-checkout' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+git lfs post-checkout "$@"

.githooks/post-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+git lfs post-commit "$@"

.githooks/post-merge

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-merge' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+git lfs post-merge "$@"

.githooks/pre-commit

@@ -1,61 +1,8 @@
 #!/bin/bash
 
-exec 1>&2
+# This script is intended to be run from the root of the repository.
 
-# paths to check and re-format
-sources="src unittests"
-formatter="clang-format -i"
-version=$($formatter --version | grep -o '[0-9\.]*')
-
-if [[ "17.0.0" > "$version" ]]; then
-    cat <<EOF
-
-                                    ERROR
------------------------------------------------------------------------------
-            A minimum of version 17 of `which clang-format` is required.
-            Your version is $version.
-            Please fix paths and run again.
------------------------------------------------------------------------------
-
-EOF
-    exit 2
-fi
-
-function grep_code {
-    grep -l "${1}" ${sources} -r --include \*.h --include \*.cpp
-}
-
-if [[ "$OSTYPE" == "darwin"* ]]; then
-    # make all includes to be <...> style
-    grep_code '#include ".*"' | xargs sed -i '' -E 's|#include "(.*)"|#include <\1>|g'
-
-    # make local includes to be "..." style
-    main_src_dirs=$(find ./src -maxdepth 1 -type d -exec basename {} \; | tr '\n' '|' | sed 's/|$//' | sed 's/|/\\|/g')
-    grep_code "#include <\($main_src_dirs\)/.*>" | xargs sed -i '' -E "s|#include <(($main_src_dirs)/.*)>|#include \"\1\"|g"
-else
-    # make all includes to be <...> style
-    grep_code '#include ".*"' | xargs sed -i -E 's|#include "(.*)"|#include <\1>|g'
-
-    # make local includes to be "..." style
-    main_src_dirs=$(find ./src -type d -maxdepth 1 -exec basename {} \; | paste -sd '|' | sed 's/|/\\|/g')
-    grep_code "#include <\($main_src_dirs\)/.*>" | xargs sed -i -E "s|#include <(($main_src_dirs)/.*)>|#include \"\1\"|g"
-fi
-
-first=$(git diff $sources)
-find $sources -type f \( -name '*.cpp' -o -name '*.h' -o -name '*.ipp' \) -print0 | xargs -0 $formatter
-second=$(git diff $sources)
-changes=$(diff <(echo "$first") <(echo "$second") | wc -l | sed -e 's/^[[:space:]]*//')
-
-if [ "$changes" != "0" ]; then
-    cat <<\EOF
-
-                                   WARNING
------------------------------------------------------------------------------
-  Automatically re-formatted code with `clang-format` - commit was aborted.
-  Please manually add any updated files and commit again.
------------------------------------------------------------------------------
-
-EOF
-    exit 1
-fi
+source .githooks/check-format
+#source .githooks/check-docs
 
+# TODO: Fix Doxygen issue with reference links. See https://github.com/XRPLF/clio/issues/1431

.githooks/pre-push

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'pre-push' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+git lfs pre-push "$@"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Title with short description] (Version: [Clio version])"
+labels: bug
+assignees: ''
+
+---
+
+<!-- Please search existing issues to avoid creating duplicates. -->
+<!-- Kindly refrain from posting any credentials or sensitive information in this issue -->
+
+## Issue Description
+<!-- Provide a summary for your issue/bug. -->
+
+## Steps to Reproduce
+<!-- List in detail the exact steps to reproduce the unexpected behavior of the software. -->
+
+## Expected Result
+<!-- Explain in detail what behavior you expected to happen. -->
+
+## Actual Result
+<!-- Explain in detail what behavior actually happened. -->
+
+## Environment
+<!-- Please describe your environment setup (such as Ubuntu 20.04.2 with Boost 1.82). -->
+<!-- Please use the version returned by './clio_server --version' as the version number -->
+
+## Supporting Files
+<!-- If you have supporting files such as a log, feel free to post a link here using Github Gist. -->
+<!-- Consider adding configuration files with private information removed via Github Gist. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Title with short description] (Version: [Clio version])"
+labels: enhancement
+assignees: ''
+
+---
+
+<!-- Please search existing issues to avoid creating duplicates. -->
+<!-- Kindly refrain from posting any credentials or sensitive information in this issue -->
+
+## Summary
+<!-- Provide a summary to the feature request -->
+
+## Motivation
+<!-- Why do we need this feature? -->
+
+## Solution
+<!-- What is the solution? -->
+
+## Paths Not Taken
+<!-- What other alternatives have been considered? -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,18 @@
+---
+name: Question
+about: A question in form of an issue
+title: "[Title with short description] (Version: Clio version)"
+labels: question
+assignees: ''
+
+---
+
+<!-- Please search existing issues to avoid creating duplicates. -->
+<!-- Consider starting a [discussion](https://github.com/XRPLF/clio/discussions) instead. -->
+<!-- Kindly refrain from posting any credentials or sensitive information in this issue -->
+
+## Question
+<!-- Your question -->
+
+## Paths Not Taken
+<!-- If applicable, what other alternatives have been considered? -->

.github/actions/clang_format/action.yml

@@ -1,36 +0,0 @@
-name: Check format
-description: Check format using clang-format-17
-runs:
-  using: composite
-  steps:
-    - name: Add llvm repo
-      run: |
-        echo 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-17 main' | sudo tee -a /etc/apt/sources.list
-        wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
-      shell: bash
-
-    - name: Install packages
-      run: |
-        sudo apt update -qq
-        sudo apt install -y jq clang-format-17
-        sudo rm /usr/bin/clang-format
-        sudo ln -s /usr/bin/clang-format-17 /usr/bin/clang-format
-      shell: bash
-
-    - name: Run formatter
-      continue-on-error: true
-      id: run_formatter
-      run: |
-        ./.githooks/pre-commit
-      shell: bash
-
-    - name: Check for differences
-      id: assert
-      shell: bash
-      run: |
-        git diff --color --exit-code | tee "clang-format.patch"
-
-    - name: Fail job
-      if: ${{ steps.run_formatter.outcome != 'success' }}
-      shell: bash
-      run: exit 1

.github/actions/code_coverage/action.yml

@@ -6,24 +6,20 @@ runs:
     - name: Run tests
       shell: bash
       run: |
-        build/clio_tests --gtest_filter="-BackendCassandraBaseTest*:BackendCassandraTest*:BackendCassandraFactoryTestWithDB*"
+        build/clio_tests
 
     - name: Run gcovr
       shell: bash
       run: |
-        gcovr -e unittests --xml build/coverage_report.xml -j8 --exclude-throw-branches
+        gcovr -e tests \
+          -e src/data/cassandra \
+          -e src/data/CassandraBackend.hpp \
+          -e 'src/data/BackendFactory.*' \
+          --xml build/coverage_report.xml -j8 --exclude-throw-branches
 
     - name: Archive coverage report
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: coverage-report.xml
         path: build/coverage_report.xml
         retention-days: 30
-
-    - name: Upload coverage report
-      uses: codecov/codecov-action@v3
-      with:
-        files: build/coverage_report.xml
-        fail_ci_if_error: true
-        verbose: true
-        token: ${{ env.CODECOV_TOKEN }}

.github/actions/create_issue/action.yml

@@ -0,0 +1,35 @@
+name: Create an issue
+description: Create an issue
+inputs:
+  title:
+    description: Issue title
+    required: true
+  body:
+    description: Issue body
+    required: true
+  labels:
+    description: Comma-separated list of labels
+    required: true
+    default: 'bug'
+  assignees:
+    description: Comma-separated list of assignees
+    required: true
+    default: 'cindyyan317,godexsoft,kuznetsss'
+outputs:
+  created_issue_id:
+    description: Created issue id
+    value: ${{ steps.create_issue.outputs.created_issue }}
+runs:
+  using: composite
+  steps:
+      - name: Create an issue
+        id: create_issue
+        shell: bash
+        run: |
+          echo -e '${{ inputs.body }}' > issue.md
+          gh issue create --assignee '${{ inputs.assignees }}' --label '${{ inputs.labels }}' --title '${{ inputs.title }}' --body-file ./issue.md > create_issue.log
+          created_issue=$(cat create_issue.log | sed 's|.*/||')
+          echo "created_issue=$created_issue" >> $GITHUB_OUTPUT
+          rm create_issue.log issue.md
+
+

.github/actions/generate/action.yml

@@ -16,6 +16,10 @@ inputs:
     description: Whether conan's coverage option should be on or not
     required: true
     default: 'false'
+  static:
+    description: Whether Clio is to be statically linked
+    required: true
+    default: 'false'
 runs:
   using: composite
   steps:
@@ -28,9 +32,10 @@ runs:
       env:
         BUILD_OPTION: "${{ inputs.conan_cache_hit == 'true' && 'missing' || '' }}"
         CODE_COVERAGE: "${{ inputs.code_coverage == 'true' && 'True' || 'False' }}"
+        STATIC_OPTION: "${{ inputs.static == 'true' && 'True' || 'False' }}"
       run: |
         cd build
-        conan install .. -of . -b $BUILD_OPTION -s build_type=${{ inputs.build_type }} -o clio:tests=True -o clio:lint=False -o clio:coverage="${CODE_COVERAGE}" --profile ${{ inputs.conan_profile }}
+        conan install .. -of . -b $BUILD_OPTION -s build_type=${{ inputs.build_type }} -o clio:static="${STATIC_OPTION}" -o clio:tests=True -o clio:integration_tests=True -o clio:lint=False -o clio:coverage="${CODE_COVERAGE}" --profile ${{ inputs.conan_profile }}
 
     - name: Run cmake
       shell: bash

.github/actions/prepare_runner/action.yml

@@ -11,7 +11,8 @@ runs:
       if: ${{ runner.os == 'macOS' }}
       shell: bash
       run: |
-          brew install llvm@14 pkg-config ninja bison cmake ccache jq gh
+          brew install llvm@14 pkg-config ninja bison cmake ccache jq gh conan@1
+          echo "/opt/homebrew/opt/conan@1/bin" >> $GITHUB_PATH
 
     - name: Fix git permissions on Linux
       if: ${{ runner.os == 'Linux' }}

.github/actions/restore_cache/action.yml

@@ -4,6 +4,9 @@ inputs:
   conan_dir:
     description: Path to .conan directory
     required: true
+  conan_profile:
+    description: Conan profile name
+    required: true
   ccache_dir:
     description: Path to .ccache directory
     required: true
@@ -44,16 +47,16 @@ runs:
         echo "hash=$hash" >> $GITHUB_OUTPUT
 
     - name: Restore conan cache
-      uses: actions/cache/restore@v3
+      uses: actions/cache/restore@v4
       id: conan_cache
       with:
         path: ${{ inputs.conan_dir }}/data
-        key: clio-conan_data-${{ runner.os }}-${{ inputs.build_type }}-develop-${{ steps.conan_hash.outputs.hash }}
+        key: clio-conan_data-${{ runner.os }}-${{ inputs.build_type }}-${{ inputs.conan_profile }}-develop-${{ steps.conan_hash.outputs.hash }}
 
     - name: Restore ccache cache
-      uses: actions/cache/restore@v3
+      uses: actions/cache/restore@v4
       id: ccache_cache
       if: ${{ env.CCACHE_DISABLE != '1' }}
       with:
         path: ${{ inputs.ccache_dir }}
-        key: clio-ccache-${{ runner.os }}-${{ inputs.build_type }}${{ inputs.code_coverage == 'true' && '-code_coverage' || '' }}-develop-${{ steps.git_common_ancestor.outputs.commit }}
+        key: clio-ccache-${{ runner.os }}-${{ inputs.build_type }}${{ inputs.code_coverage == 'true' && '-code_coverage' || '' }}-${{ inputs.conan_profile }}-develop-${{ steps.git_common_ancestor.outputs.commit }}

.github/actions/save_cache/action.yml

@@ -4,6 +4,9 @@ inputs:
   conan_dir:
     description: Path to .conan directory
     required: true
+  conan_profile:
+    description: Conan profile name
+    required: true
   conan_hash:
     description: Hash to use as a part of conan cache key
     required: true
@@ -41,16 +44,16 @@ runs:
 
     - name: Save conan cache
       if: ${{ inputs.conan_cache_hit != 'true' }}
-      uses: actions/cache/save@v3
+      uses: actions/cache/save@v4
       with:
         path: ${{ inputs.conan_dir }}/data
-        key: clio-conan_data-${{ runner.os }}-${{ inputs.build_type }}-develop-${{ inputs.conan_hash }}
+        key: clio-conan_data-${{ runner.os }}-${{ inputs.build_type }}-${{ inputs.conan_profile }}-develop-${{ inputs.conan_hash }}
 
     - name: Save ccache cache
       if: ${{ inputs.ccache_cache_hit != 'true' || inputs.ccache_cache_miss_rate == '100.0' }}
-      uses: actions/cache/save@v3
+      uses: actions/cache/save@v4
       with:
         path: ${{ inputs.ccache_dir }}
-        key: clio-ccache-${{ runner.os }}-${{ inputs.build_type }}${{ inputs.code_coverage == 'true' && '-code_coverage' || '' }}-develop-${{ steps.git_common_ancestor.outputs.commit }}
+        key: clio-ccache-${{ runner.os }}-${{ inputs.build_type }}${{ inputs.code_coverage == 'true' && '-code_coverage' || '' }}-${{ inputs.conan_profile }}-develop-${{ steps.git_common_ancestor.outputs.commit }}
 
 

.github/actions/setup_conan/action.yml

@@ -1,5 +1,9 @@
 name: Setup conan
 description: Setup conan profile and artifactory
+inputs:
+  conan_profile:
+    description: Conan profile name
+    required: true
 outputs:
   conan_profile:
     description: Created conan profile name
@@ -11,19 +15,15 @@ runs:
       if: ${{ runner.os == 'macOS' }}
       shell: bash
       env:
-        CONAN_PROFILE: clio_clang_14
+        CONAN_PROFILE: apple_clang_15
       id: conan_setup_mac
       run: |
         echo "Creating $CONAN_PROFILE conan profile";
-        clang_path="$(brew --prefix llvm@14)/bin/clang"
-        clang_cxx_path="$(brew --prefix llvm@14)/bin/clang++"
         conan profile new $CONAN_PROFILE --detect --force
-        conan profile update settings.compiler=clang $CONAN_PROFILE
-        conan profile update settings.compiler.version=14 $CONAN_PROFILE
+        conan profile update settings.compiler.libcxx=libc++ $CONAN_PROFILE
         conan profile update settings.compiler.cppstd=20 $CONAN_PROFILE
-        conan profile update "conf.tools.build:compiler_executables={\"c\": \"$clang_path\", \"cpp\": \"$clang_cxx_path\"}" $CONAN_PROFILE
-        conan profile update env.CC="$clang_path" $CONAN_PROFILE
-        conan profile update env.CXX="$clang_cxx_path" $CONAN_PROFILE
+        conan profile update env.CXXFLAGS=-DBOOST_ASIO_DISABLE_CONCEPTS $CONAN_PROFILE
+        conan profile update "conf.tools.build:cxxflags+=[\"-DBOOST_ASIO_DISABLE_CONCEPTS\"]" $CONAN_PROFILE
         echo "created_conan_profile=$CONAN_PROFILE" >> $GITHUB_OUTPUT
 
     - name: On linux
@@ -31,7 +31,7 @@ runs:
       shell: bash
       id: conan_setup_linux
       run: |
-        echo "created_conan_profile=default" >> $GITHUB_OUTPUT
+        echo "created_conan_profile=${{ inputs.conan_profile }}" >> $GITHUB_OUTPUT
 
     - name: Export output variable
       shell: bash

.github/scripts/update-libxrpl-version

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Note: This script is intended to be run from the root of the repository.
+#
+# This script modifies conanfile.py such that the specified version of libXRPL is used.
+
+if [[ -z "$1" ]]; then
+    cat <<EOF
+
+                                    ERROR
+-----------------------------------------------------------------------------
+            Version should be passed as first argument to the script.
+-----------------------------------------------------------------------------
+
+EOF
+    exit 1
+fi
+
+VERSION=$1
+GNU_SED=$(sed --version 2>&1 | grep -q 'GNU' && echo true || echo false)
+
+echo "+ Updating required libXRPL version to $VERSION"
+
+if [[ "$GNU_SED" == "false" ]]; then
+    sed -i '' -E "s|'xrpl/[a-zA-Z0-9\\.\\-]+'|'xrpl/$VERSION'|g" conanfile.py
+else
+    sed -i -E "s|'xrpl/[a-zA-Z0-9\\.\\-]+'|'xrpl/$VERSION'|g" conanfile.py
+fi

.github/workflows/build.yml

@@ -6,19 +6,42 @@ on:
     branches: [master, release/*, develop]
   workflow_dispatch:
 
- 
 jobs:
-  lint:
+  check_format:
     name: Check format
     runs-on: ubuntu-20.04
+    container:
+      image: rippleci/clio_ci:latest
+    steps:
+      - name: Fix git permissions on Linux
+        shell: bash
+        run: git config --global --add safe.directory $PWD
+
+      - uses: actions/checkout@v4
+      - name: Run formatters
+        id: run_formatters
+        run: |
+          ./.githooks/check-format --diff
+        shell: bash
+  
+  check_docs:
+    name: Check documentation
+    runs-on: ubuntu-20.04
+    container:
+      image: rippleci/clio_ci:latest
     steps:
       - uses: actions/checkout@v4
-      - name: Run clang-format
-        uses: ./.github/actions/clang_format
+      - name: Run linter
+        id: run_linter
+        run: |
+          ./.githooks/check-docs
+        shell: bash
 
   build:
     name: Build
-    needs: lint
+    needs:
+      - check_format
+      - check_docs
     strategy:
       fail-fast: false
       matrix:
@@ -27,37 +50,63 @@ jobs:
             container:
               image: rippleci/clio_ci:latest
             build_type: Release
+            conan_profile: gcc
             code_coverage: false
+            static: true
           - os: heavy
             container:
               image: rippleci/clio_ci:latest
             build_type: Debug
+            conan_profile: gcc
             code_coverage: true
-          - os: macOS
+            static: true
+          - os: heavy
+            container:
+              image: rippleci/clio_ci:latest
+            build_type: Release
+            conan_profile: clang
+            code_coverage: false
+            static: true
+          - os: heavy
+            container:
+              image: rippleci/clio_ci:latest
+            build_type: Debug
+            conan_profile: clang
+            code_coverage: false
+            static: true
+          - os: macos14
             build_type: Release
             code_coverage: false
+            static: false
     runs-on: [self-hosted, "${{ matrix.os }}"]
     container: ${{ matrix.container }}
 
     steps:
+      - name: Clean workdir
+        if: ${{ runner.os == 'macOS' }}
+        uses: kuznetsss/workspace-cleanup@1.0
+
       - uses: actions/checkout@v4
         with:
-            fetch-depth: 0
+          fetch-depth: 0
 
       - name: Prepare runner
         uses: ./.github/actions/prepare_runner
         with:
-            disable_ccache: false
+          disable_ccache: false
 
       - name: Setup conan
         uses: ./.github/actions/setup_conan
         id: conan
+        with:
+          conan_profile: ${{ matrix.conan_profile }}
 
       - name: Restore cache
         uses: ./.github/actions/restore_cache
         id: restore_cache
         with:
           conan_dir: ${{ env.CONAN_USER_HOME }}/.conan
+          conan_profile: ${{ steps.conan.outputs.conan_profile }}
           ccache_dir: ${{ env.CCACHE_DIR }}
           build_type: ${{ matrix.build_type }}
           code_coverage: ${{ matrix.code_coverage }}
@@ -69,6 +118,7 @@ jobs:
           conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }}
           build_type: ${{ matrix.build_type }}
           code_coverage: ${{ matrix.code_coverage }}
+          static: ${{ matrix.static }}
 
       - name: Build Clio
         uses: ./.github/actions/build_clio
@@ -84,20 +134,20 @@ jobs:
 
       - name: Strip tests
         if: ${{ !matrix.code_coverage }}
-        run: strip build/clio_tests
+        run: strip build/clio_tests && strip build/clio_integration_tests
 
       - name: Upload clio_server
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: clio_server_${{ runner.os }}_${{ matrix.build_type }}
-          path: build/clio_server      
+          name: clio_server_${{ runner.os }}_${{ matrix.build_type }}_${{ steps.conan.outputs.conan_profile }}
+          path: build/clio_server
 
       - name: Upload clio_tests
         if: ${{ !matrix.code_coverage }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: clio_tests_${{ runner.os }}
-          path: build/clio_tests
+          name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}_${{ steps.conan.outputs.conan_profile }}
+          path: build/clio_*tests
 
       - name: Save cache
         uses: ./.github/actions/save_cache
@@ -110,15 +160,20 @@ jobs:
           ccache_cache_miss_rate: ${{ steps.ccache_stats.outputs.miss_rate }}
           build_type: ${{ matrix.build_type }}
           code_coverage: ${{ matrix.code_coverage }}
+          conan_profile: ${{ steps.conan.outputs.conan_profile }}
 
       # TODO: This is not a part of build process but it is the easiest way to do it here.
       # It will be refactored in https://github.com/XRPLF/clio/issues/1075
       - name: Run code coverage
         if: ${{ matrix.code_coverage }}
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         uses: ./.github/actions/code_coverage
 
+  upload_coverage_report:
+    name: Codecov
+    needs: build
+    uses: ./.github/workflows/upload_coverage_report.yml
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   test:
     name: Run Tests
@@ -130,15 +185,33 @@ jobs:
           - os: heavy
             container:
               image: rippleci/clio_ci:latest
-          - os: macOS
+            conan_profile: gcc
+            build_type: Release
+          - os: heavy
+            container:
+              image: rippleci/clio_ci:latest
+            conan_profile: clang
+            build_type: Release
+          - os: heavy
+            container:
+              image: rippleci/clio_ci:latest
+            conan_profile: clang
+            build_type: Debug
+          - os: macos14
+            conan_profile: apple_clang_15
+            build_type: Release
     runs-on: [self-hosted, "${{ matrix.os }}"]
     container: ${{ matrix.container }}
 
     steps:
-      - uses: actions/download-artifact@v3
+      - name: Clean workdir
+        if: ${{ runner.os == 'macOS' }}
+        uses: kuznetsss/workspace-cleanup@1.0
+
+      - uses: actions/download-artifact@v4
         with:
-          name: clio_tests_${{ runner.os }}
+          name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}_${{ matrix.conan_profile }}
       - name: Run clio_tests
         run: |
           chmod +x ./clio_tests
-          ./clio_tests --gtest_filter="-BackendCassandraBaseTest*:BackendCassandraTest*:BackendCassandraFactoryTestWithDB*"
+          ./clio_tests

.github/workflows/check_libxrpl.yml

@@ -0,0 +1,91 @@
+name: Check new libXRPL
+on:
+  repository_dispatch:
+    types: [check_libxrpl]
+
+jobs:
+  build:
+    name: Build Clio / `libXRPL ${{ github.event.client_payload.version }}`
+    runs-on: [self-hosted, heavy]
+    container:
+      image: rippleci/clio_ci:latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+            fetch-depth: 0
+
+      - name: Update libXRPL version requirement
+        shell: bash
+        run: |
+          ./.github/scripts/update-libxrpl-version ${{ github.event.client_payload.version }}
+
+      - name: Prepare runner
+        uses: ./.github/actions/prepare_runner
+        with:
+            disable_ccache: true
+
+      - name: Setup conan
+        uses: ./.github/actions/setup_conan
+        id: conan
+        with:
+          conan_profile: gcc
+
+      - name: Run conan and cmake
+        uses: ./.github/actions/generate
+        with:
+          conan_profile: ${{ steps.conan.outputs.conan_profile }}
+          conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }}
+          build_type: Release
+
+      - name: Build Clio
+        uses: ./.github/actions/build_clio
+
+      - name: Strip tests
+        run: strip build/clio_tests
+
+      - name: Upload clio_tests
+        uses: actions/upload-artifact@v4
+        with:
+          name: clio_tests_libxrpl-${{ github.event.client_payload.version }}
+          path: build/clio_tests
+
+  run_tests:
+    name: Run tests
+    needs: build
+    runs-on: [self-hosted, heavy]
+    container:
+      image: rippleci/clio_ci:latest
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: clio_tests_libxrpl-${{ github.event.client_payload.version }}
+
+      - name: Run clio_tests
+        run: |
+          chmod +x ./clio_tests
+          ./clio_tests
+
+  create_issue_on_failure:
+    name: Create an issue on failure
+    needs: [build, run_tests]
+    if: ${{ always() && contains(needs.*.result, 'failure') }}
+    runs-on: ubuntu-20.04
+    permissions:
+      contents: write
+      issues: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create an issue
+        uses: ./.github/actions/create_issue
+        env:
+          GH_TOKEN: ${{ github.token }}
+        with:
+          labels: 'compatibility,bug'
+          title: 'Proposed libXRPL check failed'
+          body: >
+            Clio build or tests failed against `libXRPL ${{ github.event.client_payload.version }}`.
+
+            Workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/

.github/workflows/clang-tidy.yml

@@ -1,13 +1,14 @@
 name: Clang-tidy check
 on:
   schedule:
-    - cron:  '0 6 * * 1-5'
+    - cron: "0 6 * * 1-5"
   workflow_dispatch:
   pull_request:
     branches: [develop]
     paths:
       - .clang_tidy
       - .github/workflows/clang-tidy.yml
+  workflow_call:
 
 jobs:
   clang_tidy:
@@ -22,16 +23,18 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-            fetch-depth: 0
+          fetch-depth: 0
 
       - name: Prepare runner
         uses: ./.github/actions/prepare_runner
         with:
-            disable_ccache: true
+          disable_ccache: true
 
       - name: Setup conan
         uses: ./.github/actions/setup_conan
         id: conan
+        with:
+          conan_profile: clang
 
       - name: Restore cache
         uses: ./.github/actions/restore_cache
@@ -39,6 +42,7 @@ jobs:
         with:
           conan_dir: ${{ env.CONAN_USER_HOME }}/.conan
           ccache_dir: ${{ env.CCACHE_DIR }}
+          conan_profile: ${{ steps.conan.outputs.conan_profile }}
 
       - name: Run conan and cmake
         uses: ./.github/actions/generate
@@ -56,13 +60,13 @@ jobs:
         shell: bash
         id: run_clang_tidy
         run: |
-          run-clang-tidy-17 -p build -j ${{ steps.number_of_threads.outputs.threads_number }} -fix -quiet 1>output.txt
+          run-clang-tidy-18 -p build -j ${{ steps.number_of_threads.outputs.threads_number }} -fix -quiet 1>output.txt
 
-      - name: Run pre-commit hook
+      - name: Check format
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}
         continue-on-error: true
         shell: bash
-        run: ./.githooks/pre-commit
+        run: ./.githooks/check-format
 
       - name: Print issues found
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}
@@ -75,18 +79,18 @@ jobs:
       - name: Create an issue
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}
         id: create_issue
-        shell: bash
+        uses: ./.github/actions/create_issue
         env:
           GH_TOKEN: ${{ github.token }}
-        run: |
-          echo -e 'Clang-tidy found issues in the code:\n' > issue.md
-          echo -e "List of the issues found: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/" >> issue.md
-          gh issue create --assignee 'cindyyan317,godexsoft,kuznetsss' --label bug --title 'Clang-tidy found bugs in code🐛' --body-file ./issue.md > create_issue.log
-          created_issue=$(cat create_issue.log | sed 's|.*/||')
-          echo "created_issue=$created_issue" >> $GITHUB_OUTPUT
-          rm create_issue.log issue.md
+        with:
+          title: 'Clang-tidy found bugs in code 🐛'
+          body: >
+            Clang-tidy found issues in the code:
+
+            List of the issues found: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/
 
       - uses: crazy-max/ghaction-import-gpg@v5
+        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
         with:
           gpg_private_key: ${{ secrets.ACTIONS_GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.ACTIONS_GPG_PASSPHRASE }}
@@ -100,14 +104,14 @@ jobs:
           GH_REPO: ${{ github.repository }}
           GH_TOKEN: ${{ github.token }}
         with:
-          commit-message: '[CI] clang-tidy auto fixes'
+          commit-message: "[CI] clang-tidy auto fixes"
           committer: Clio CI <skuznetsov@ripple.com>
-          branch: 'clang_tidy/autofix'
+          branch: "clang_tidy/autofix"
           branch-suffix: timestamp
           delete-branch: true
-          title: '[CI] clang-tidy auto fixes'
-          body: 'Fixes #${{ steps.create_issue.outputs.created_issue }}. Please review and commit clang-tidy fixes.'
-          reviewers: 'cindyyan317,godexsoft,kuznetsss'
+          title: "[CI] clang-tidy auto fixes"
+          body: "Fixes #${{ steps.create_issue.outputs.created_issue_id }}. Please review and commit clang-tidy fixes."
+          reviewers: "cindyyan317,godexsoft,kuznetsss"
 
       - name: Fail the job
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}

.github/workflows/clang-tidy_on_fix_merged.yml

@@ -0,0 +1,29 @@
+name: Restart clang-tidy workflow
+on:
+  push:
+    branches: [develop]
+  workflow_dispatch:
+
+jobs:
+  restart_clang_tidy:
+    runs-on: ubuntu-20.04
+
+    permissions:
+      actions: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check last commit matches clang-tidy auto fixes
+        id: check
+        shell: bash
+        run: |
+          passed=$(if [[ $(git log -1 --pretty=format:%s | grep '\[CI\] clang-tidy auto fixes') ]]; then echo 'true' ; else echo 'false' ; fi)
+          echo "passed=$passed" >> $GITHUB_OUTPUT
+
+      - name: Run clang-tidy workflow
+        if: ${{ contains(steps.check.outputs.passed, 'true') }}
+        shell: bash
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+        run: gh workflow run clang-tidy.yml

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: Documentation
+on:
+  push:
+    branches: [develop]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-20.04
+    continue-on-error: true
+    container:
+      image: rippleci/clio_ci:latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with: 
+          lfs: true
+
+      - name: Build docs
+        run: |
+          mkdir -p build_docs && cd build_docs
+          cmake ../docs && cmake --build . --target docs
+      
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build_docs/html
+          name: docs-develop
+      
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: docs-develop

.github/workflows/nightly.yml

@@ -11,7 +11,7 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - os: macOS
+          - os: macos14
             build_type: Release
           - os: heavy
             build_type: Release
@@ -25,6 +25,10 @@ jobs:
     container: ${{ matrix.container }}
 
     steps:
+      - name: Clean workdir
+        if: ${{ runner.os == 'macOS' }}
+        uses: kuznetsss/workspace-cleanup@1.0
+
       - uses: actions/checkout@v4
         with:
             fetch-depth: 0
@@ -37,6 +41,8 @@ jobs:
       - name: Setup conan
         uses: ./.github/actions/setup_conan
         id: conan
+        with:
+          conan_profile: gcc
 
       - name: Run conan and cmake
         uses: ./.github/actions/generate
@@ -49,13 +55,13 @@ jobs:
         uses: ./.github/actions/build_clio
 
       - name: Strip tests
-        run: strip build/clio_tests
+        run: strip build/clio_tests && strip build/clio_integration_tests
 
       - name: Upload clio_tests
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}
-          path: build/clio_tests
+          path: build/clio_*tests
 
       - name: Compress clio_server
         shell: bash
@@ -64,7 +70,7 @@ jobs:
             tar czf ./clio_server_${{ runner.os }}_${{ matrix.build_type }}.tar.gz ./clio_server
 
       - name: Upload clio_server
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: clio_server_${{ runner.os }}_${{ matrix.build_type }}
           path: build/clio_server_${{ runner.os }}_${{ matrix.build_type }}.tar.gz
@@ -76,23 +82,52 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - os: macOS
+          - os: macos14
             build_type: Release
+            integration_tests: false
           - os: heavy
             build_type: Release
+            container:
+              image: rippleci/clio_ci:latest
+            integration_tests: true  
           - os: heavy
             build_type: Debug
+            container:
+              image: rippleci/clio_ci:latest
+            integration_tests: true  
     runs-on: [self-hosted, "${{ matrix.os }}"]
+    container: ${{ matrix.container }}
+
+    services:
+      scylladb:
+        image: ${{ (matrix.integration_tests) && 'scylladb/scylla' || '' }}
+        options: >-
+          --health-cmd "cqlsh -e 'describe cluster'" 
+          --health-interval 10s 
+          --health-timeout 5s 
+          --health-retries 5
 
     steps:
-      - uses: actions/download-artifact@v3
+      - name: Clean workdir
+        if: ${{ runner.os == 'macOS' }}
+        uses: kuznetsss/workspace-cleanup@1.0
+
+      - uses: actions/download-artifact@v4
         with:
           name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}
 
       - name: Run clio_tests
         run: |
           chmod +x ./clio_tests
-          ./clio_tests --gtest_filter="-BackendCassandraBaseTest*:BackendCassandraTest*:BackendCassandraFactoryTestWithDB*"
+          ./clio_tests
+  
+  # To be enabled back once docker in mac runner arrives
+  # https://github.com/XRPLF/clio/issues/1400
+      - name: Run clio_integration_tests
+        if: matrix.integration_tests 
+        run: |
+          chmod +x ./clio_integration_tests
+          ./clio_integration_tests --backend_host=scylladb
 
   nightly_release:
     needs: run_tests
@@ -105,7 +140,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           path: nightly_release
 
@@ -114,7 +149,7 @@ jobs:
         run: |
           cp ${{ github.workspace }}/.github/workflows/nightly_notes.md "${RUNNER_TEMP}/nightly_notes.md"
           cd nightly_release
-          rm -r clio_tests*
+          rm -r clio_*tests*
           for d in $(ls); do
             archive_name=$(ls $d)
             mv ${d}/${archive_name} ./
@@ -136,3 +171,24 @@ jobs:
           gh release create nightly --prerelease --title "Clio development (nightly) build" \
             --target $GITHUB_SHA --notes-file "${RUNNER_TEMP}/nightly_notes.md" \
             ./nightly_release/clio_server*
+
+  create_issue_on_failure:
+    needs: [build, run_tests, nightly_release]
+    if: ${{ always() && contains(needs.*.result, 'failure') }}
+    runs-on: ubuntu-20.04
+    permissions:
+      contents: write
+      issues: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create an issue
+        uses: ./.github/actions/create_issue
+        env:
+          GH_TOKEN: ${{ github.token }}
+        with:
+          title: 'Nightly release failed 🌙'
+          body: >
+            Nightly release failed:
+
+            Workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/

.github/workflows/update_docker_ci.yml

@@ -1,18 +1,25 @@
 name: Update CI docker image
 on:
+  pull_request:
+    paths:
+      - 'docker/ci/**'
+      - 'docker/compilers/**'
+      - .github/workflows/update_docker_ci.yml
   push:
     branches: [develop]
     paths:
-      - 'docker/ci/**'
+      - 'docker/ci/**'        # CI image must update when either its dockerfile changes
+      - 'docker/compilers/**' # or any compilers changed and were pushed by hand
       - .github/workflows/update_docker_ci.yml
   workflow_dispatch:
 
 jobs:
   build_and_push:
     name: Build and push docker image
-    runs-on: ubuntu-20.04
+    runs-on: [self-hosted, heavy]
     steps:
       - name: Login to DockerHub
+        if: ${{ github.event_name != 'pull_request' }}
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USER }}
@@ -27,7 +34,7 @@ jobs:
           images: rippleci/clio_ci
           tags: |
             type=raw,value=latest
-            type=raw,value=gcc_11
+            type=raw,value=gcc_12_clang_16
             type=raw,value=${{ env.GITHUB_SHA }}
 
       - name: Build and push
@@ -35,6 +42,6 @@ jobs:
         with:
           context: ${{ github.workspace }}/docker/ci
           platforms: linux/amd64,linux/arm64
-          push: true
+          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
 

.github/workflows/upload_coverage_report.yml

@@ -0,0 +1,35 @@
+name: Upload report
+on:
+  workflow_dispatch:
+  workflow_call:
+    secrets:
+      CODECOV_TOKEN:
+        required: true
+
+jobs:
+  upload_report:
+    name: Upload report
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download report artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report.xml
+          path: build
+
+      - name: Upload coverage report
+        if: ${{ hashFiles('build/coverage_report.xml') != '' }}
+        uses: wandalen/wretry.action@v1.4.10
+        with:
+          action: codecov/codecov-action@v4
+          with: |
+            files: build/coverage_report.xml 
+            fail_ci_if_error: false
+            verbose: true
+            token: ${{ secrets.CODECOV_TOKEN }}
+          attempt_limit: 5
+          attempt_delay: 10000

.gitignore

@@ -1,9 +1,11 @@
 *clio*.log
 /build*/
+.devcontainer
 .build
 .cache
 .vscode
 .python-version
+.DS_Store
 CMakeUserPresets.json
 config.json
 src/main/impl/Build.cpp

CMake/Ccache.cmake

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

CMake/CheckCompiler.cmake

@@ -1,42 +0,0 @@
-if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
-  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14)
-    message (FATAL_ERROR "Clang 14+ required for building clio")
-  endif ()
-  set (is_clang TRUE)
-elseif (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
-  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14)
-    message (FATAL_ERROR "AppleClang 14+ required for building clio")
-  endif ()
-  set (is_appleclang TRUE)
-elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 11)
-    message (FATAL_ERROR "GCC 11+ required for building clio")
-  endif ()
-  set (is_gcc TRUE)
-else ()
-  message (FATAL_ERROR "Supported compilers: AppleClang 14+, Clang 14+, GCC 11+")
-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,31 +0,0 @@
-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-17" "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 ()
-
-  # 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 ()

CMake/ClioVersion.cmake

@@ -1,39 +0,0 @@
-#[===================================================================[
-   write version to source
-#]===================================================================]
-
-find_package (Git REQUIRED)
-
-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)
-
-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)
-
-if (BRANCH STREQUAL "")
-  set (BRANCH "dev")
-endif ()
-
-if (NOT (BRANCH MATCHES master OR BRANCH MATCHES release/*)) # for develop and any other branch name YYYYMMDDHMS-<branch>-<git-rev>
-  execute_process (COMMAND date +%Y%m%d%H%M%S OUTPUT_VARIABLE DATE OUTPUT_STRIP_TRAILING_WHITESPACE)
-  set (VERSION "${DATE}-${BRANCH}-${REV}")
-else ()
-  set (GIT_COMMAND describe --tags)
-  execute_process (COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} 
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-    OUTPUT_VARIABLE TAG_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
-  set (VERSION "${TAG_VERSION}-${REV}")
-endif ()
-
-if (CMAKE_BUILD_TYPE MATCHES Debug)
-  set (VERSION "${VERSION}+DEBUG")
-endif ()
-
-message (STATUS "Build version: ${VERSION}")
-set (clio_version "${VERSION}")
-
-configure_file (CMake/Build.cpp.in ${CMAKE_SOURCE_DIR}/src/main/impl/Build.cpp)

CMake/CodeCoverage.cmake

@@ -1,440 +0,0 @@
-# Copyright (c) 2012 - 2017, Lars Bilke
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-#
-# 1. Redistributions of source code must retain the above copyright notice, this
-#    list of conditions and the following disclaimer.
-#
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-#    this list of conditions and the following disclaimer in the documentation
-#    and/or other materials provided with the distribution.
-#
-# 3. Neither the name of the copyright holder nor the names of its contributors
-#    may be used to endorse or promote products derived from this software without
-#    specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-#
-# CHANGES:
-#
-# 2012-01-31, Lars Bilke
-# - Enable Code Coverage
-#
-# 2013-09-17, Joakim Söderberg
-# - Added support for Clang.
-# - Some additional usage instructions.
-#
-# 2016-02-03, Lars Bilke
-# - Refactored functions to use named parameters
-#
-# 2017-06-02, Lars Bilke
-# - Merged with modified version from github.com/ufz/ogs
-#
-# 2019-05-06, Anatolii Kurotych
-# - Remove unnecessary --coverage flag
-#
-# 2019-12-13, FeRD (Frank Dana)
-# - Deprecate COVERAGE_LCOVR_EXCLUDES and COVERAGE_GCOVR_EXCLUDES lists in favor
-#   of tool-agnostic COVERAGE_EXCLUDES variable, or EXCLUDE setup arguments.
-# - CMake 3.4+: All excludes can be specified relative to BASE_DIRECTORY
-# - All setup functions: accept BASE_DIRECTORY, EXCLUDE list
-# - Set lcov basedir with -b argument
-# - Add automatic --demangle-cpp in lcovr, if 'c++filt' is available (can be
-#   overridden with NO_DEMANGLE option in setup_target_for_coverage_lcovr().)
-# - Delete output dir, .info file on 'make clean'
-# - Remove Python detection, since version mismatches will break gcovr
-# - Minor cleanup (lowercase function names, update examples...)
-#
-# 2019-12-19, FeRD (Frank Dana)
-# - Rename Lcov outputs, make filtered file canonical, fix cleanup for targets
-#
-# 2020-01-19, Bob Apthorpe
-# - Added gfortran support
-#
-# 2020-02-17, FeRD (Frank Dana)
-# - Make all add_custom_target()s VERBATIM to auto-escape wildcard characters
-#   in EXCLUDEs, and remove manual escaping from gcovr targets
-#
-# 2021-01-19, Robin Mueller
-# - Add CODE_COVERAGE_VERBOSE option which will allow to print out commands which are run
-# - Added the option for users to set the GCOVR_ADDITIONAL_ARGS variable to supply additional
-#   flags to the gcovr command
-#
-# 2020-05-04, Mihchael Davis
-#     - Add -fprofile-abs-path to make gcno files contain absolute paths
-#     - Fix BASE_DIRECTORY not working when defined
-#     - Change BYPRODUCT from folder to index.html to stop ninja from complaining about double defines
-#
-# 2021-05-10, Martin Stump
-#     - Check if the generator is multi-config before warning about non-Debug builds
-#
-# 2022-02-22, Marko Wehle
-#     - Change gcovr output from -o <filename> for --xml <filename> and --html <filename> output respectively.
-#       This will allow for Multiple Output Formats at the same time by making use of GCOVR_ADDITIONAL_ARGS, e.g. GCOVR_ADDITIONAL_ARGS "--txt".
-#
-# 2022-09-28, Sebastian Mueller
-#     - fix append_coverage_compiler_flags_to_target to correctly add flags
-#     - replace "-fprofile-arcs -ftest-coverage" with "--coverage" (equivalent)
-#
-# 2023-12-15, Bronek Kozicki
-#     - remove setup_target_for_coverage_lcov (slow) and setup_target_for_coverage_fastcov (no support for Clang)
-#     - fix Clang support by adding find_program( ... llvm-cov )
-#     - add Apple Clang support by adding execute_process( COMMAND xcrun -f llvm-cov ... )
-#     - add CODE_COVERAGE_GCOV_TOOL to explicitly select gcov tool and disable find_program
-#     - replace both functions setup_target_for_coverage_gcovr_* with single setup_target_for_coverage_gcovr
-#     - add support for all gcovr output formats
-#
-# USAGE:
-#
-# 1. Copy this file into your cmake modules path.
-#
-# 2. Add the following line to your CMakeLists.txt (best inside an if-condition
-#    using a CMake option() to enable it just optionally):
-#      include(CodeCoverage)
-#
-# 3. Append necessary compiler flags for all supported source files:
-#      append_coverage_compiler_flags()
-#    Or for specific target:
-#      append_coverage_compiler_flags_to_target(YOUR_TARGET_NAME)
-#
-# 3.a (OPTIONAL) Set appropriate optimization flags, e.g. -O0, -O1 or -Og
-#
-# 4. If you need to exclude additional directories from the report, specify them
-#    using full paths in the COVERAGE_EXCLUDES variable before calling
-#    setup_target_for_coverage_*().
-#    Example:
-#      set(COVERAGE_EXCLUDES
-#          '${PROJECT_SOURCE_DIR}/src/dir1/*'
-#          '/path/to/my/src/dir2/*')
-#    Or, use the EXCLUDE argument to setup_target_for_coverage_*().
-#    Example:
-#      setup_target_for_coverage_gcovr(
-#          NAME coverage
-#          EXECUTABLE testrunner
-#          EXCLUDE "${PROJECT_SOURCE_DIR}/src/dir1/*" "/path/to/my/src/dir2/*")
-#
-# 4.a NOTE: With CMake 3.4+, COVERAGE_EXCLUDES or EXCLUDE can also be set
-#     relative to the BASE_DIRECTORY (default: PROJECT_SOURCE_DIR)
-#     Example:
-#       set(COVERAGE_EXCLUDES "dir1/*")
-#       setup_target_for_coverage_gcovr(
-#           NAME coverage
-#           EXECUTABLE testrunner
-#           FORMAT html-details
-#           BASE_DIRECTORY "${PROJECT_SOURCE_DIR}/src"
-#           EXCLUDE "dir2/*")
-#
-# 4.b If you need to pass specific options to gcovr, specify them in
-#     GCOVR_ADDITIONAL_ARGS variable.
-#     Example:
-#       set (GCOVR_ADDITIONAL_ARGS --exclude-throw-branches --exclude-noncode-lines -s)
-#       setup_target_for_coverage_gcovr(
-#           NAME coverage
-#           EXECUTABLE testrunner
-#           EXCLUDE "src/dir1" "src/dir2")
-#
-# 5. Use the functions described below to create a custom make target which
-#    runs your test executable and produces a code coverage report.
-#
-# 6. Build a Debug build:
-#      cmake -DCMAKE_BUILD_TYPE=Debug ..
-#      make
-#      make my_coverage_target
-
-include(CMakeParseArguments)
-
-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()
-
-# 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()
-
-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()
-
-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_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 )
-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 )
-
-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()
-
-# 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 will not complete.
-#
-# setup_target_for_coverage_gcovr(
-#     NAME ctest_coverage                    # New target name
-#     EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
-#     DEPENDENCIES executable_target         # Dependencies to build first
-#     BASE_DIRECTORY "../"                   # Base directory for report
-#                                            #  (defaults to PROJECT_SOURCE_DIR)
-#     FORMAT "cobertura"                     # Output format, one of:
-#                                            #  xml cobertura sonarqube json-summary
-#                                            #  json-details coveralls csv txt
-#                                            #  html-single html-nested html-details
-#                                            #  (xml is an alias to cobertura;
-#                                            #  if no format is set, 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"))
-            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()
-
-    # 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)
-
-    # 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 up commands which will be run to generate coverage data
-    # Run tests
-    set(GCOVR_EXEC_TESTS_CMD
-        ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
-    )
-
-    # 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()
-
-    # 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(CODE_COVERAGE_VERBOSE)
-        message(STATUS "Executed command report")
-
-        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)
-    separate_arguments(_flag_list NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}")
-    target_compile_options(${name} PRIVATE ${_flag_list})
-    if(CMAKE_C_COMPILER_ID STREQUAL "GNU" OR CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
-        target_link_libraries(${name} PRIVATE gcov)
-    endif()
-endfunction()

CMake/Docs.cmake

@@ -1,11 +0,0 @@
-find_package (Doxygen REQUIRED)
-
-set (DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
-set (DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
-
-configure_file (${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
-add_custom_target (docs
-    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
-    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-    COMMENT "Generating API documentation with Doxygen"
-    VERBATIM)

CMake/Settings.cmake

@@ -1,46 +0,0 @@
-set(COMPILER_FLAGS
-  -Wall
-  -Wcast-align
-  -Wdouble-promotion
-  -Wextra
-  -Werror
-  -Wformat=2
-  -Wimplicit-fallthrough
-  -Wmisleading-indentation
-  -Wno-narrowing
-  -Wno-deprecated-declarations
-  -Wno-dangling-else
-  -Wno-unused-but-set-variable
-  -Wnon-virtual-dtor
-  -Wnull-dereference
-  -Wold-style-cast
-  -pedantic
-  -Wpedantic
-  -Wunused
-)
-
-#TODO: reenable 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_appleclang)
-  list(APPEND COMPILER_FLAGS
-    -Wreorder-init-list
-  )
-endif ()
-
-# See https://github.com/cpp-best-practices/cppbestpractices/blob/master/02-Use_the_Tools_Available.md#gcc--clang for the flags description
-
-target_compile_options (clio PUBLIC ${COMPILER_FLAGS})

CMake/SourceLocation.cmake

@@ -1,11 +0,0 @@
-include (CheckIncludeFileCXX)
-
-check_include_file_cxx ("source_location" SOURCE_LOCATION_AVAILABLE)
-if (SOURCE_LOCATION_AVAILABLE) 
-    target_compile_definitions (clio PUBLIC "HAS_SOURCE_LOCATION")
-endif ()
-
-check_include_file_cxx ("experimental/source_location" EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)
-if (EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)     
-    target_compile_definitions (clio PUBLIC "HAS_EXPERIMENTAL_SOURCE_LOCATION")
-endif ()

CMake/deps/Boost.cmake

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

CMake/deps/OpenSSL.cmake

@@ -1,5 +0,0 @@
-find_package (OpenSSL 1.1.1 REQUIRED)
-
-set_target_properties (OpenSSL::SSL PROPERTIES
-  INTERFACE_COMPILE_DEFINITIONS OPENSSL_NO_SSL2
-)

CMake/deps/Threads.cmake

@@ -1,2 +0,0 @@
-set (THREADS_PREFER_PTHREAD_FLAG ON)
-find_package (Threads)

CMake/deps/cassandra.cmake

@@ -1 +0,0 @@
-find_package (cassandra-cpp-driver REQUIRED)

CMake/deps/gtest.cmake

@@ -1,4 +0,0 @@
-find_package (GTest REQUIRED)
-
-enable_testing ()
-include (GoogleTest)

CMake/deps/libbacktrace.cmake

@@ -1,3 +0,0 @@
-target_compile_definitions(clio PUBLIC BOOST_STACKTRACE_LINK)
-target_compile_definitions(clio PUBLIC BOOST_STACKTRACE_USE_BACKTRACE)
-find_package(libbacktrace REQUIRED)

CMake/deps/libfmt.cmake

@@ -1 +0,0 @@
-find_package (fmt REQUIRED)

CMake/deps/libxrpl.cmake

@@ -1 +0,0 @@
-find_package (xrpl REQUIRED)

CMake/install/install.cmake

@@ -1,14 +0,0 @@
-set (CLIO_INSTALL_DIR "/opt/clio")
-set (CMAKE_INSTALL_PREFIX ${CLIO_INSTALL_DIR})
-
-install (TARGETS clio_server DESTINATION bin)
-
-file (READ 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)
-
-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)
-

CMakeLists.txt

@@ -1,345 +1,87 @@
-cmake_minimum_required(VERSION 3.16.3)
-project(clio)
+cmake_minimum_required(VERSION 3.20)
 
+set(CMAKE_PROJECT_INCLUDE_BEFORE ${CMAKE_CURRENT_SOURCE_DIR}/cmake/ClioVersion.cmake)
+
+project(clio VERSION ${CLIO_VERSION} HOMEPAGE_URL "https://github.com/XRPLF/clio"
+        DESCRIPTION "An XRP Ledger API Server"
+)
+
+# =========================== Options ====================================== #
+option(verbose "Verbose build" FALSE)
+option(tests "Build unit tests" FALSE)
+option(integration_tests "Build integration tests" FALSE)
+option(benchmark "Build benchmarks" FALSE)
+option(docs "Generate doxygen docs" FALSE)
+option(coverage "Build test coverage report" FALSE)
+option(packaging "Create distribution packages" FALSE)
+option(lint "Run clang-tidy checks during compilation" FALSE)
+option(static "Statically linked Clio" FALSE)
 # ========================================================================== #
-#                                   Options                                  #
-# ========================================================================== #
-option (verbose   "Verbose build"                                     FALSE)
-option (tests     "Build tests"                                       FALSE)
-option (docs      "Generate doxygen docs"                             FALSE)
-option (coverage  "Build test coverage report"                        FALSE)
-option (packaging "Create distribution packages"                      FALSE)
-option (lint      "Run clang-tidy checks during compilation"          FALSE)
-# ========================================================================== #
-set (san "" CACHE STRING "Add sanitizer instrumentation")
-set (CMAKE_EXPORT_COMPILE_COMMANDS TRUE)
-set_property (CACHE san PROPERTY STRINGS ";undefined;memory;address;thread")
+set(san "" CACHE STRING "Add sanitizer instrumentation")
+set(CMAKE_EXPORT_COMPILE_COMMANDS TRUE)
+set_property(CACHE san PROPERTY STRINGS ";undefined;memory;address;thread")
 # ========================================================================== #
 
+set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
+
 # Include required modules
-include (CMake/Ccache.cmake)
-include (CheckCXXCompilerFlag)
-include (CMake/ClangTidy.cmake)
+include(Ccache)
+include(CheckCXXCompilerFlag)
+include(ClangTidy)
 
-# Set coverage build options
-if (tests AND coverage)
-  include (CMake/CodeCoverage.cmake)
-  append_coverage_compiler_flags()
-endif()
+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)
+  set(CMAKE_VERBOSE_MAKEFILE TRUE)
 endif ()
 
 if (packaging)
-  add_definitions (-DPKG=1)
+  add_definitions(-DPKG=1)
+  target_compile_definitions(clio_options INTERFACE PKG=1)
 endif ()
 
-add_library (clio)
-
 # Clio tweaks and checks
-include (CMake/CheckCompiler.cmake)
-include (CMake/Settings.cmake)
-include (CMake/ClioVersion.cmake)
-include (CMake/SourceLocation.cmake)
+include(CheckCompiler)
+include(Settings)
+include(SourceLocation)
 
 # Clio deps
-include (CMake/deps/libxrpl.cmake)
-include (CMake/deps/Boost.cmake)
-include (CMake/deps/OpenSSL.cmake)
-include (CMake/deps/Threads.cmake)
-include (CMake/deps/libfmt.cmake)
-include (CMake/deps/cassandra.cmake)
-include (CMake/deps/libbacktrace.cmake)
+include(deps/libxrpl)
+include(deps/Boost)
+include(deps/OpenSSL)
+include(deps/Threads)
+include(deps/libfmt)
+include(deps/cassandra)
+include(deps/libbacktrace)
 
-# TODO: Include directory will be wrong when installed.
-target_include_directories (clio PUBLIC src)
-target_compile_features (clio PUBLIC cxx_std_20)
+add_subdirectory(src)
+add_subdirectory(tests)
 
-target_link_libraries (clio
-  PUBLIC Boost::boost
-  PUBLIC Boost::coroutine
-  PUBLIC Boost::program_options
-  PUBLIC Boost::system
-  PUBLIC Boost::log
-  PUBLIC Boost::log_setup
-  PUBLIC Boost::stacktrace_backtrace
-  PUBLIC cassandra-cpp-driver::cassandra-cpp-driver
-  PUBLIC fmt::fmt
-  PUBLIC OpenSSL::Crypto
-  PUBLIC OpenSSL::SSL
-  PUBLIC xrpl::libxrpl
-  PUBLIC dl
-  PUBLIC libbacktrace::libbacktrace
-
-  INTERFACE Threads::Threads
-)
-
-if (is_gcc)
-  # FIXME: needed on gcc for now
-  target_compile_definitions (clio PUBLIC BOOST_ASIO_DISABLE_CONCEPTS)
-endif ()
-
-target_sources (clio PRIVATE
-  ## Main
-  src/main/impl/Build.cpp
-  ## Backend
-  src/data/BackendCounters.cpp
-  src/data/BackendInterface.cpp
-  src/data/LedgerCache.cpp
-  src/data/cassandra/impl/Future.cpp
-  src/data/cassandra/impl/Cluster.cpp
-  src/data/cassandra/impl/Batch.cpp
-  src/data/cassandra/impl/Result.cpp
-  src/data/cassandra/impl/Tuple.cpp
-  src/data/cassandra/impl/SslContext.cpp
-  src/data/cassandra/Handle.cpp
-  src/data/cassandra/SettingsProvider.cpp
-  ## ETL
-  src/etl/Source.cpp
-  src/etl/ProbingSource.cpp
-  src/etl/NFTHelpers.cpp
-  src/etl/ETLService.cpp
-  src/etl/ETLState.cpp
-  src/etl/LoadBalancer.cpp
-  src/etl/impl/ForwardCache.cpp
-  ## Feed
-  src/feed/SubscriptionManager.cpp
-  src/feed/impl/TransactionFeed.cpp
-  src/feed/impl/LedgerFeed.cpp
-  src/feed/impl/ProposedTransactionFeed.cpp
-  src/feed/impl/SingleFeedBase.cpp
-  ## Web
-  src/web/impl/AdminVerificationStrategy.cpp
-  src/web/IntervalSweepHandler.cpp
-  src/web/Resolver.cpp
-  ## RPC
-  src/rpc/Errors.cpp
-  src/rpc/Factories.cpp
-  src/rpc/AMMHelpers.cpp
-  src/rpc/RPCHelpers.cpp
-  src/rpc/Counters.cpp
-  src/rpc/WorkQueue.cpp
-  src/rpc/common/Specs.cpp
-  src/rpc/common/Validators.cpp
-  src/rpc/common/MetaProcessors.cpp
-  src/rpc/common/impl/APIVersionParser.cpp
-  src/rpc/common/impl/HandlerProvider.cpp
-  ## RPC handlers
-  src/rpc/handlers/AccountChannels.cpp
-  src/rpc/handlers/AccountCurrencies.cpp
-  src/rpc/handlers/AccountInfo.cpp
-  src/rpc/handlers/AccountLines.cpp
-  src/rpc/handlers/AccountNFTs.cpp
-  src/rpc/handlers/AccountObjects.cpp
-  src/rpc/handlers/AccountOffers.cpp
-  src/rpc/handlers/AccountTx.cpp
-  src/rpc/handlers/AMMInfo.cpp
-  src/rpc/handlers/BookChanges.cpp
-  src/rpc/handlers/BookOffers.cpp
-  src/rpc/handlers/DepositAuthorized.cpp
-  src/rpc/handlers/GatewayBalances.cpp
-  src/rpc/handlers/Ledger.cpp
-  src/rpc/handlers/LedgerData.cpp
-  src/rpc/handlers/LedgerEntry.cpp
-  src/rpc/handlers/LedgerRange.cpp
-  src/rpc/handlers/NFTsByIssuer.cpp
-  src/rpc/handlers/NFTBuyOffers.cpp
-  src/rpc/handlers/NFTHistory.cpp
-  src/rpc/handlers/NFTInfo.cpp
-  src/rpc/handlers/NFTOffersCommon.cpp
-  src/rpc/handlers/NFTSellOffers.cpp
-  src/rpc/handlers/NoRippleCheck.cpp
-  src/rpc/handlers/Random.cpp
-  src/rpc/handlers/TransactionEntry.cpp
-  ## Util
-  src/util/config/Config.cpp
-  src/util/log/Logger.cpp
-  src/util/prometheus/Http.cpp
-  src/util/prometheus/Label.cpp
-  src/util/prometheus/MetricBase.cpp
-  src/util/prometheus/MetricBuilder.cpp
-  src/util/prometheus/MetricsFamily.cpp
-  src/util/prometheus/OStream.cpp
-  src/util/prometheus/Prometheus.cpp
-  src/util/Random.cpp
-  src/util/Taggable.cpp
-  src/util/TerminationHandler.cpp
-)
-
-# Clio server
-add_executable (clio_server src/main/Main.cpp)
-target_link_libraries (clio_server PRIVATE clio)
-target_link_options(clio_server
-  PRIVATE
-    $<$<AND:$<NOT:$<BOOL:${APPLE}>>,$<NOT:$<BOOL:${san}>>>:-static-libstdc++ -static-libgcc>
-)
-
-# Unittesting
-if (tests)
-  set (TEST_TARGET clio_tests)
-  add_executable (${TEST_TARGET}
-    # Common
-    unittests/Main.cpp
-    unittests/Playground.cpp
-    unittests/LoggerTests.cpp
-    unittests/ConfigTests.cpp
-    unittests/ProfilerTests.cpp
-    unittests/JsonUtilTests.cpp
-    unittests/DOSGuardTests.cpp
-    unittests/util/AssertTests.cpp
-    unittests/util/BatchingTests.cpp
-    unittests/util/TestObject.cpp
-    unittests/util/StringUtils.cpp
-    unittests/util/prometheus/CounterTests.cpp
-    unittests/util/prometheus/GaugeTests.cpp
-    unittests/util/prometheus/HistogramTests.cpp
-    unittests/util/prometheus/HttpTests.cpp
-    unittests/util/prometheus/LabelTests.cpp
-    unittests/util/prometheus/MetricBuilderTests.cpp
-    unittests/util/prometheus/MetricsFamilyTests.cpp
-    unittests/util/prometheus/OStreamTests.cpp
-    # ETL
-    unittests/etl/ExtractionDataPipeTests.cpp
-    unittests/etl/ExtractorTests.cpp
-    unittests/etl/TransformerTests.cpp
-    unittests/etl/CacheLoaderTests.cpp
-    unittests/etl/AmendmentBlockHandlerTests.cpp
-    unittests/etl/LedgerPublisherTests.cpp
-    unittests/etl/ETLStateTests.cpp
-    # RPC
-    unittests/rpc/ErrorTests.cpp
-    unittests/rpc/BaseTests.cpp
-    unittests/rpc/RPCHelpersTests.cpp
-    unittests/rpc/CountersTests.cpp
-    unittests/rpc/APIVersionTests.cpp
-    unittests/rpc/ForwardingProxyTests.cpp
-    unittests/rpc/WorkQueueTests.cpp
-    unittests/rpc/AmendmentsTests.cpp
-    unittests/rpc/JsonBoolTests.cpp
-    ## RPC handlers
-    unittests/rpc/handlers/DefaultProcessorTests.cpp
-    unittests/rpc/handlers/TestHandlerTests.cpp
-    unittests/rpc/handlers/AccountCurrenciesTests.cpp
-    unittests/rpc/handlers/AccountLinesTests.cpp
-    unittests/rpc/handlers/AccountTxTests.cpp
-    unittests/rpc/handlers/AccountOffersTests.cpp
-    unittests/rpc/handlers/AccountInfoTests.cpp
-    unittests/rpc/handlers/AccountChannelsTests.cpp
-    unittests/rpc/handlers/AccountNFTsTests.cpp
-    unittests/rpc/handlers/BookOffersTests.cpp
-    unittests/rpc/handlers/DepositAuthorizedTests.cpp
-    unittests/rpc/handlers/GatewayBalancesTests.cpp
-    unittests/rpc/handlers/TxTests.cpp
-    unittests/rpc/handlers/TransactionEntryTests.cpp
-    unittests/rpc/handlers/LedgerEntryTests.cpp
-    unittests/rpc/handlers/LedgerRangeTests.cpp
-    unittests/rpc/handlers/NoRippleCheckTests.cpp
-    unittests/rpc/handlers/ServerInfoTests.cpp
-    unittests/rpc/handlers/PingTests.cpp
-    unittests/rpc/handlers/RandomTests.cpp
-    unittests/rpc/handlers/NFTInfoTests.cpp
-    unittests/rpc/handlers/NFTBuyOffersTests.cpp
-    unittests/rpc/handlers/NFTsByIssuerTest.cpp
-    unittests/rpc/handlers/NFTSellOffersTests.cpp
-    unittests/rpc/handlers/NFTHistoryTests.cpp
-    unittests/rpc/handlers/SubscribeTests.cpp
-    unittests/rpc/handlers/UnsubscribeTests.cpp
-    unittests/rpc/handlers/LedgerDataTests.cpp
-    unittests/rpc/handlers/AccountObjectsTests.cpp
-    unittests/rpc/handlers/BookChangesTests.cpp
-    unittests/rpc/handlers/LedgerTests.cpp
-    unittests/rpc/handlers/VersionHandlerTests.cpp
-    unittests/rpc/handlers/AMMInfoTests.cpp
-    # Backend
-    unittests/data/BackendFactoryTests.cpp
-    unittests/data/BackendCountersTests.cpp
-    unittests/data/cassandra/BaseTests.cpp
-    unittests/data/cassandra/BackendTests.cpp
-    unittests/data/cassandra/RetryPolicyTests.cpp
-    unittests/data/cassandra/SettingsProviderTests.cpp
-    unittests/data/cassandra/ExecutionStrategyTests.cpp
-    unittests/data/cassandra/AsyncExecutorTests.cpp
-    # Webserver
-    unittests/web/AdminVerificationTests.cpp
-    unittests/web/ServerTests.cpp
-    unittests/web/RPCServerHandlerTests.cpp
-    unittests/web/WhitelistHandlerTests.cpp
-    unittests/web/SweepHandlerTests.cpp
-    # Feed
-    unittests/feed/SubscriptionManagerTests.cpp
-    unittests/feed/SingleFeedBaseTests.cpp
-    unittests/feed/ProposedTransactionFeedTests.cpp
-    unittests/feed/BookChangesFeedTests.cpp
-    unittests/feed/LedgerFeedTests.cpp
-    unittests/feed/TransactionFeedTests.cpp
-    unittests/feed/ForwardFeedTests.cpp
-    unittests/feed/TrackableSignalTests.cpp)
-
-  include (CMake/deps/gtest.cmake)
-
-  # See https://github.com/google/googletest/issues/3475
-  gtest_discover_tests (clio_tests DISCOVERY_TIMEOUT 10)
-
-  # Fix for dwarf5 bug on ci
-  target_compile_options (clio PUBLIC -gdwarf-4)
-
-  target_compile_definitions (${TEST_TARGET} PUBLIC UNITTEST_BUILD)
-  target_include_directories (${TEST_TARGET} PRIVATE unittests)
-  target_link_libraries (${TEST_TARGET} PUBLIC clio gtest::gtest)
-
-  # Generate `coverage_report` target if coverage is enabled
-  if (coverage)
-    if (DEFINED CODE_COVERAGE_REPORT_FORMAT)
-      set(CODE_COVERAGE_FORMAT ${CODE_COVERAGE_REPORT_FORMAT})
-    else()
-      set(CODE_COVERAGE_FORMAT html-details)
-    endif()
-
-    if (DEFINED CODE_COVERAGE_TESTS_ARGS)
-      set(TESTS_ADDITIONAL_ARGS ${CODE_COVERAGE_TESTS_ARGS})
-      separate_arguments(TESTS_ADDITIONAL_ARGS)
-    else()
-      set(TESTS_ADDITIONAL_ARGS "")
-    endif()
-
-    set (GCOVR_ADDITIONAL_ARGS --exclude-throw-branches -s)
-
-    setup_target_for_coverage_gcovr(
-        NAME coverage_report
-        FORMAT ${CODE_COVERAGE_FORMAT}
-        EXECUTABLE clio_tests
-        EXECUTABLE_ARGS --gtest_brief=1 ${TESTS_ADDITIONAL_ARGS}
-        EXCLUDE "unittests"
-        DEPENDENCIES clio_tests
-    )
-  endif ()
+if (benchmark)
+  add_subdirectory(benchmarks)
 endif ()
 
 # Enable selected sanitizer if enabled via `san`
 if (san)
-  target_compile_options (clio
-    PUBLIC
-      # Sanitizers recommend minimum of -O1 for reasonable performance
-      $<$<CONFIG:Debug>:-O1>
-      ${SAN_FLAG}
-      -fno-omit-frame-pointer)
-  target_compile_definitions (clio
-    PUBLIC
-      $<$<STREQUAL:${san},address>:SANITIZER=ASAN>
-      $<$<STREQUAL:${san},thread>:SANITIZER=TSAN>
-      $<$<STREQUAL:${san},memory>:SANITIZER=MSAN>
-      $<$<STREQUAL:${san},undefined>:SANITIZER=UBSAN>)
-  target_link_libraries (clio INTERFACE ${SAN_FLAG} ${SAN_LIB})
+  target_compile_options(
+    clio PUBLIC # Sanitizers recommend minimum of -O1 for reasonable performance
+                $<$<CONFIG:Debug>:-O1> ${SAN_FLAG} -fno-omit-frame-pointer
+  )
+  target_compile_definitions(
+    clio PUBLIC $<$<STREQUAL:${san},address>:SANITIZER=ASAN> $<$<STREQUAL:${san},thread>:SANITIZER=TSAN>
+                $<$<STREQUAL:${san},memory>:SANITIZER=MSAN> $<$<STREQUAL:${san},undefined>:SANITIZER=UBSAN>
+  )
+  target_link_libraries(clio INTERFACE ${SAN_FLAG} ${SAN_LIB})
 endif ()
 
-# Generate `docs` target for doxygen documentation if enabled
-# Note: use `make docs` to generate the documentation
+# Generate `docs` target for doxygen documentation if enabled Note: use `make docs` to generate the documentation
 if (docs)
-  include (CMake/Docs.cmake)
+  add_subdirectory(docs)
 endif ()
 
-include (CMake/install/install.cmake)
+include(install/install)
 if (packaging)
-  include (CMake/packaging.cmake) # This file exists only in build runner
+  include(cmake/packaging.cmake) # This file exists only in build runner
 endif ()

CONTRIBUTING.md

@@ -6,7 +6,7 @@ To contribute, please:
 2. Create a new branch on which to commit/push your changes.
 3. Write and test your code.
 4. Ensure that your code compiles with the provided build engine and update the provided build engine as part of your PR where needed and where appropriate.
-5. Where applicable, write test cases for your code and include those in `unittests`.
+5. Where applicable, write test cases for your code and include those in the relevant subfolder under `tests`.
 6. Ensure your code passes automated checks (e.g. clang-format)
 7. Squash your commits (i.e. rebase) into as few commits as is reasonable to describe your changes at a high level (typically a single commit for a small change). See below for more details.
 8. Open a PR to the main repository onto the _develop_ branch, and follow the provided template.
@@ -20,6 +20,12 @@ Please run the following command in order to use git hooks that are helpful for
 git config --local core.hooksPath .githooks
 ```
 
+## Git hooks dependencies
+The pre-commit hook requires `clang-format >= 18.0.0` and `cmake-format` to be installed on your machine.
+`clang-format` can be installed using `brew` on macOS and default package manager on Linux.
+`cmake-format` can be installed using `pip`.
+The hook will also attempt to automatically use `doxygen` to verify that everything public in the codebase is covered by doc comments. If `doxygen` is not installed, the hook will raise a warning suggesting to install `doxygen` for future commits.
+
 ## Git commands
 This sections offers a detailed look at the git commands you will need to use to get your PR submitted. 
 Please note that there are more than one way to do this and these commands are provided for your convenience.
@@ -63,8 +69,8 @@ git push --force
 ```
 
 ## Use ccache (optional)
-Clio uses ccache to speed up compilation. If you want to use it, please make sure it is installed on your machine.
-CMake will automatically detect it and use it if it's available.
+Clio uses `ccache` to speed up compilation. If you want to use it, please make sure it is installed on your machine.
+CMake will automatically detect it and use it if it is available.
 
 
 ## Fixing issues found during code review
@@ -96,8 +102,14 @@ The button for that is near the bottom of the PR's page on GitHub.
 This is a non-exhaustive list of recommended style guidelines. These are not always strictly enforced and serve as a way to keep the codebase coherent.
 
 ## Formatting
-Code must conform to `clang-format` version 17, unless the result would be unreasonably difficult to read or maintain.
-To change your code to conform use `clang-format -i <your changed files>`.
+Code must conform to `clang-format` version 18, unless the result would be unreasonably difficult to read or maintain.
+In most cases the pre-commit hook will take care of formatting and will fix any issues automatically.
+To manually format your code, use `clang-format -i <your changed files>` for C++ files and `cmake-format -i <your changed files>` for CMake files.
+
+## Documentation
+All public namespaces, classes and functions must be covered by doc (`doxygen`) comments. Everything that is not within a nested `impl` namespace is considered public.
+
+> **Note:** Keep in mind that this is enforced by Clio's CI and your build will fail if newly added public code lacks documentation.
 
 ## Avoid
 * Proliferation of nearly identical code.

Doxyfile

@@ -1,16 +0,0 @@
-PROJECT_NAME           = "Clio"
-INPUT                  = ../src ../unittests
-EXCLUDE_PATTERNS       = *Test*.cpp *Test*.h
-RECURSIVE              = YES
-HAVE_DOT               = YES
-
-QUIET                  = YES
-WARNINGS               = NO
-WARN_NO_PARAMDOC       = NO
-WARN_IF_INCOMPLETE_DOC = NO
-WARN_IF_UNDOCUMENTED   = NO
-
-GENERATE_LATEX         = NO
-GENERATE_HTML          = YES
-
-SORT_MEMBERS_CTORS_1ST = YES

README.md

@@ -1,408 +1,50 @@
-# Clio
+# <img src='./docs/img/xrpl-logo.svg' width='40' valign="top" /> Clio
+
 [![Build status](https://github.com/XRPLF/clio/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/XRPLF/clio/actions/workflows/build.yml?query=branch%3Adevelop)
 [![Nightly release status](https://github.com/XRPLF/clio/actions/workflows/nightly.yml/badge.svg?branch=develop)](https://github.com/XRPLF/clio/actions/workflows/nightly.yml?query=branch%3Adevelop)
 [![Clang-tidy checks status](https://github.com/XRPLF/clio/actions/workflows/clang-tidy.yml/badge.svg?branch=develop)](https://github.com/XRPLF/clio/actions/workflows/clang-tidy.yml?query=branch%3Adevelop)
 [![Code coverage develop branch](https://codecov.io/gh/XRPLF/clio/branch/develop/graph/badge.svg?)](https://app.codecov.io/gh/XRPLF/clio)
 
-Clio is an XRP Ledger API server. Clio is optimized for RPC calls, over WebSocket or JSON-RPC. 
-Validated historical ledger and transaction data are stored in a more space-efficient format,
-using up to 4 times less space than rippled. Clio can be configured to store data in Apache Cassandra or ScyllaDB,
-allowing for scalable read throughput. Multiple Clio nodes can share access to the same dataset, 
-allowing for a highly available cluster of Clio nodes, without the need for redundant data storage or computation.
+Clio is an XRP Ledger API server optimized for RPC calls over WebSocket or JSON-RPC.
+It stores validated historical ledger and transaction data in a more space efficient format, and uses up to 4 times less space than [rippled](https://github.com/XRPLF/rippled).
 
-Clio offers the full rippled API, with the caveat that Clio by default only returns validated data.
-This means that `ledger_index` defaults to `validated` instead of `current` for all requests.
-Other non-validated data is also not returned, such as information about queued transactions.
-For requests that require access to the p2p network, such as `fee` or `submit`, Clio automatically forwards the request to a rippled node and propagates the response back to the client. 
-To access non-validated data for *any* request, simply add `ledger_index: "current"` to the request, and Clio will forward the request to rippled.
+Clio can be configured to store data in [Apache Cassandra](https://cassandra.apache.org/_/index.html) or [ScyllaDB](https://www.scylladb.com/), enabling scalable read throughput.
+Multiple Clio nodes can share access to the same dataset, which allows for a highly available cluster of Clio nodes without the need for redundant data storage or computation.
 
-Clio does not connect to the peer-to-peer network. Instead, Clio extracts data from a group of specified rippled nodes. Running Clio requires access to at least one rippled node
-from which data can be extracted. The rippled node does not need to be running on the same machine as Clio.
+## 📡 Clio and `rippled`
+
+Clio offers the full `rippled` API, with the caveat that Clio by default only returns validated data. This means that `ledger_index` defaults to `validated` instead of `current` for all requests. Other non-validated data, such as information about queued transactions, is also not returned.
+
+Clio retrieves data from a designated group of `rippled` nodes instead of connecting to the peer-to-peer network.
+For requests that require access to the peer-to-peer network, such as `fee` or `submit`, Clio automatically forwards the request to a `rippled` node and propagates the response back to the client. To access non-validated data for *any* request, simply add `ledger_index: "current"` to the request, and Clio will forward the request to `rippled`.
+
+> [!NOTE]  
+> Clio requires access to at least one `rippled` node, which can run on the same machine as Clio or separately.
+
+## 📚 Learn more about Clio
+
+Below are some useful docs to learn more about Clio.
+
+**For Developers**:
+
+- [How to build Clio](./docs/build-clio.md)
+- [Metrics and static analysis](./docs/metrics-and-static-analysis.md)
+- [Coverage report](./docs/coverage-report.md)
+
+**For Operators**:
+
+- [How to configure Clio and rippled](./docs/configure-clio.md)
+- [How to run Clio](./docs/run-clio.md)
+- [Logging](./docs/logging.md)
+- [Troubleshooting guide](./docs/trouble_shooting.md)
+
+**General reference material:**
+
+- [API reference](https://xrpl.org/http-websocket-apis.html)
+- [Developer docs](https://xrplf.github.io/clio)
+- [Clio documentation](https://xrpl.org/the-clio-server.html#the-clio-server)
+
+## 🆘 Help
 
-## Help
 Feel free to open an [issue](https://github.com/XRPLF/clio/issues) if you have a feature request or something doesn't work as expected.
-If you have any questions about building, running, contributing, using clio or any other, you could always start a new [discussion](https://github.com/XRPLF/clio/discussions).
-
-## Requirements
-1. Access to a Cassandra cluster or ScyllaDB cluster. Can be local or remote.
-2. Access to one or more rippled nodes. Can be local or remote.
-
-## Building
-
-Clio is built with CMake and uses Conan for managing dependencies. 
-It is written in C++20 and therefore requires a modern compiler.
-
-## Prerequisites 
-
-### Minimum Requirements
-
-- [Python 3.7](https://www.python.org/downloads/)
-- [Conan 1.55](https://conan.io/downloads.html)
-- [CMake 3.16](https://cmake.org/download/)
-- [**Optional**] [GCovr](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) (needed for code coverage generation)
-- [**Optional**] [CCache](https://ccache.dev/) (speeds up compilation if you are going to compile Clio often)
-
-| Compiler    | Version |
-|-------------|---------|
-| GCC         | 11      |
-| Clang       | 14      |
-| Apple Clang | 14.0.3  |
-
-### Conan configuration
-
-Clio does not require anything but default settings in your (`~/.conan/profiles/default`) Conan profile. It's best to have no extra flags specified. 
-> Mac example:
-```
-[settings]
-os=Macos
-os_build=Macos
-arch=armv8
-arch_build=armv8
-compiler=apple-clang
-compiler.version=14
-compiler.libcxx=libc++
-build_type=Release
-compiler.cppstd=20
-```
-> Linux example:
-```
-[settings]
-os=Linux
-os_build=Linux
-arch=x86_64
-arch_build=x86_64
-compiler=gcc
-compiler.version=11
-compiler.libcxx=libstdc++11
-build_type=Release
-compiler.cppstd=20
-```
-
-### Artifactory
-
-1. Make sure artifactory is setup with Conan
-```sh
-conan remote add --insert 0 conan-non-prod http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod
-```
-Now you should be able to download prebuilt `xrpl` package on some platforms.
-
-2. Remove old packages you may have cached: 
-```sh 
-conan remove -f xrpl
-```
-
-## Building Clio
-
-Navigate to Clio's root directory and perform
-```sh
-mkdir build && cd build
-conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False
-cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
-cmake --build . --parallel 8 # or without the number if you feel extra adventurous
-```
-If all goes well, `conan install` will find required packages and `cmake` will do the rest. you should end up with `clio_server` and `clio_tests` in the `build` directory (the current directory).
-
-> **Tip:** You can omit the `-o tests=True` in `conan install` command above if you don't want to build `clio_tests`.
-
-> **Tip:** To generate a Code Coverage report, include `-o coverage=True` in the `conan install` command above, along with `-o tests=True` to enable tests. After running the `cmake` commands, execute `make clio_tests-ccov`. The coverage report will be found at `clio_tests-llvm-cov/index.html`.
-
-## Building Clio with Docker
-
-It is possible to build Clio using docker if you don't want to install all the dependencies on your machine.
-```sh
-docker run -it rippleci/clio_ci:latest
-git clone https://github.com/XRPLF/clio
-mkdir build && cd build
-conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False
-cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
-cmake --build . --parallel 8 # or without the number if you feel extra adventurous
-```
-
-## Running
-```sh
-./clio_server config.json
-```
-
-Clio needs access to a rippled server. The config files of rippled and Clio need
-to match in a certain sense.
-Clio needs to know:
-- the IP of rippled
-- the port on which rippled is accepting unencrypted WebSocket connections
-- the port on which rippled is handling gRPC requests
-
-rippled needs to open:
-- a port to accept unencrypted websocket connections
-- a port to handle gRPC requests, with the IP(s) of Clio specified in the `secure_gateway` entry
-
-The example configs of rippled and Clio are setups such that minimal changes are
-required. When running locally, the only change needed is to uncomment the `port_grpc`
-section of the rippled config. When running Clio and rippled on separate machines,
-in addition to uncommenting the `port_grpc` section, a few other steps must be taken:
-1. change the `ip` of the first entry of `etl_sources` to the IP where your rippled
-server is running
-2. open a public, unencrypted WebSocket port on your rippled server
-3. change the IP specified in `secure_gateway` of `port_grpc` section of the rippled config
-to the IP of your Clio server. This entry can take the form of a comma-separated list if
-you are running multiple Clio nodes.
-
-
-In addition, the parameter `start_sequence` can be included and configured within the top level of the config file. This parameter specifies the sequence of first ledger to extract if the database is empty. Note that ETL extracts ledgers in order and that no backfilling functionality currently exists, meaning Clio will not retroactively learn ledgers older than the one you specify. Choosing to specify this or not will yield the following behavior:
-- If this setting is absent and the database is empty, ETL will start with the next ledger validated by the network. 
-- If this setting is present and the database is not empty, an exception is thrown.
-
-In addition, the optional parameter `finish_sequence` can be added to the json file as well, specifying where the ledger can stop.
-
-To add `start_sequence` and/or `finish_sequence` to the config.json file appropriately, they will be on the same top level of precedence as other parameters (such as `database`, `etl_sources`, `read_only`, etc.) and be specified with an integer. Here is an example snippet from the config file:
-
-```json
-"start_sequence": 12345,
-"finish_sequence": 54321
-```
-
-The parameters `ssl_cert_file` and `ssl_key_file` can also be added to the top level of precedence of our Clio config. `ssl_cert_file` specifies the filepath for your SSL cert while `ssl_key_file` specifies the filepath for your SSL key. It is up to you how to change ownership of these folders for your designated Clio user. Your options include:
-- Copying the two files as root somewhere that's accessible by the Clio user, then running `sudo chown` to your user
-- Changing the permissions directly so it's readable by your Clio user
-- Running Clio as root (strongly discouraged)
-
-An example of how to specify `ssl_cert_file` and `ssl_key_file` in the config:
-
-```json
-"server": {
-    "ip": "0.0.0.0",
-    "port": 51233
-},
-"ssl_cert_file": "/full/path/to/cert.file",
-"ssl_key_file": "/full/path/to/key.file"
-```
-
-Once your config files are ready, start rippled and Clio. It doesn't matter which you
-start first, and it's fine to stop one or the other and restart at any given time.
-
-Clio will wait for rippled to sync before extracting any ledgers. If there is already
-data in Clio's database, Clio will begin extraction with the ledger whose sequence
-is one greater than the greatest sequence currently in the database. Clio will wait
-for this ledger to be available. Be aware that the behavior of rippled is to sync to
-the most recent ledger on the network, and then backfill. If Clio is extracting ledgers
-from rippled, and then rippled is stopped for a significant amount of time and then restarted, rippled
-will take time to backfill to the next ledger that Clio wants. The time it takes is proportional
-to the amount of time rippled was offline for. Also be aware that the amount rippled backfills
-are dependent on the online_delete and ledger_history config values; if these values
-are small, and rippled is stopped for a significant amount of time, rippled may never backfill
-to the ledger that Clio wants. To avoid this situation, it is advised to keep history
-proportional to the amount of time that you expect rippled to be offline. For example, if you
-expect rippled to be offline for a few days from time to time, you should keep at least
-a few days of history. If you expect rippled to never be offline, then you can keep a very small
-amount of history.
-
-Clio can use multiple rippled servers as a data source. Simply add more entries to
-the `etl_sources` section. Clio will load balance requests across the servers specified
-in this list. As long as one rippled server is up and synced, Clio will continue
-extracting ledgers.
-
-In contrast to rippled, Clio will answer RPC requests for the data already in the
-database as soon as the server starts. Clio doesn't wait to sync to the network, or
-for rippled to sync.
-
-When starting Clio with a fresh database, Clio needs to download a ledger in full.
-This can take some time, and depends on database throughput. With a moderately fast
-database, this should take less than 10 minutes. If you did not properly set `secure_gateway`
-in the `port_grpc` section of rippled, this step will fail. Once the first ledger
-is fully downloaded, Clio only needs to extract the changed data for each ledger,
-so extraction is much faster and Clio can keep up with rippled in real-time. Even under
-intense load, Clio should not lag behind the network, as Clio is not processing the data,
-and is simply writing to a database. The throughput of Clio is dependent on the throughput
-of your database, but a standard Cassandra or Scylla deployment can handle
-the write load of the XRP Ledger without any trouble. Generally the performance considerations
-come on the read side, and depends on the number of RPC requests your Clio nodes
-are serving. Be aware that very heavy read traffic can impact write throughput. Again, this
-is on the database side, so if you are seeing this, upgrade your database.
-
-It is possible to run multiple Clio nodes that share access to the same database.
-The Clio nodes don't need to know about each other. You can simply spin up more Clio
-nodes pointing to the same database as you wish, and shut them down as you wish.
-On startup, each Clio node queries the database for the latest ledger. If this latest
-ledger does not change for some time, the Clio node begins extracting ledgers
-and writing to the database. If the Clio node detects a ledger that it is trying to
-write has already been written, the Clio node will backoff and stop writing. If later
-the Clio node sees no ledger written for some time, it will start writing again.
-This algorithm ensures that at any given time, one and only one Clio node is writing
-to the database.
-
-It is possible to force Clio to only read data, and to never become a writer.
-To do this, set `read_only: true` in the config. One common setup is to have a
-small number of writer nodes that are inaccessible to clients, with several
-read only nodes handling client requests. The number of read only nodes can be scaled
-up or down in response to request volume.
-
-When using multiple rippled servers as data sources and multiple Clio nodes,
-each Clio node should use the same set of rippled servers as sources. The order doesn't matter.
-The only reason not to do this is if you are running servers in different regions, and
-you want the Clio nodes to extract from servers in their region. However, if you
-are doing this, be aware that database traffic will be flowing across regions,
-which can cause high latencies. A possible alternative to this is to just deploy
-a database in each region, and the Clio nodes in each region use their region's database.
-This is effectively two systems.
-
-Clio supports API versioning as [described here](https://xrpl.org/request-formatting.html#api-versioning).
-It's possible to configure `minimum`, `maximum` and `default` version like so:
-```json
-"api_version": {
-    "min": 1,
-    "max": 2,
-    "default": 1
-}
-```
-All of the above are optional.
-Clio will fallback to hardcoded defaults when not specified in the config file or configured values are outside
-of the minimum and maximum supported versions hardcoded in `src/rpc/common/APIVersion.h`.
-> **Note:** See `example-config.json` for more details. 
-
-## Admin rights for requests
-
-By default clio checks admin privileges by IP address from request (only `127.0.0.1` is considered to be an admin).
-It is not very secure because the IP could be spoofed.
-For a better security `admin_password` could be provided in the `server` section of clio's config:
-```json
-"server": {
-    "admin_password": "secret"
-}
-```
-If the password is presented in the config, clio will check the Authorization header (if any) in each request for the password.
-The Authorization header should contain type `Password` and the password from the config, e.g. `Password secret`.
-Exactly equal password gains admin rights for the request or a websocket connection.
-
-## Prometheus metrics collection
-
-Clio natively supports Prometheus metrics collection. It accepts Prometheus requests on the port configured in `server` section of config.
-Prometheus metrics are enabled by default. To disable it add `"prometheus": { "enabled": false }` to the config.
-It is important to know that clio responds to Prometheus request only if they are admin requests, so Prometheus should be configured to send admin password in header.
-There is an example of docker-compose file, Prometheus and Grafana configs in [examples/infrastructure](examples/infrastructure).
-
-## Using clang-tidy for static analysis
-
-Minimum clang-tidy version required is 17.0.
-Clang-tidy could be run by cmake during building the project.
-For that provide the option `-o lint=True` for `conan install` command:
-```sh
-conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=True
-```
-By default cmake will try to find clang-tidy automatically in your system.
-To force cmake use desired binary set `CLIO_CLANG_TIDY_BIN` environment variable as path to clang-tidy binary.
-E.g.:
-```sh
-export CLIO_CLANG_TIDY_BIN=/opt/homebrew/opt/llvm@17/bin/clang-tidy
-```
-
-## Coverage report
-
-Coverage report is intended for the developers using compilers GCC
-or Clang (including Apple Clang). It is generated by the build target `coverage_report`,
-which is only enabled when both `tests` and `coverage` options are set, e.g. with
-`-o coverage=True -o tests=True` in `conan`
-
-Prerequisites for the coverage report:
-
-- [gcovr tool](https://gcovr.com/en/stable/getting-started.html) (can be installed e.g. with `pip install gcovr`)
-- `gcov` for GCC (installed with the compiler by default) or
-- `llvm-cov` for Clang (installed with the compiler by default, also on Apple)
-- `Debug` build type
-
-Coverage report is created when the following steps are completed, in order:
-
-1. `clio_tests` binary built with the instrumentation data, enabled by the `coverage`
-   option mentioned above
-2. completed run of unit tests, which populates coverage capture data
-3. completed run of `gcovr` tool (which internally invokes either `gcov` or `llvm-cov`)
-   to assemble both instrumentation data and coverage capture data into a coverage report
-
-Above steps are automated into a single target `coverage_report`. The instrumented
-`clio_tests` binary can be also used for running regular unit tests. In case of a
-spurious failure of unit tests, it is possile to re-run `coverage_report` target without
-rebuilding the `clio_tests` binary (since it is simply a dependency of the coverage report target).
-
-The default coverage report format is `html-details`, but the developers
-can override it to any of the formats listed in `CMake/CodeCoverage.cmake`
-by setting `CODE_COVERAGE_REPORT_FORMAT` variable in `cmake`. For example, CI
-is setting this parameter to `xml` for the [codecov](codecov.io) integration.
-
-In case if some unit tests predictably fail e.g. due to absence of a Cassandra database, it is possible
-to set unit tests options in `CODE_COVERAGE_TESTS_ARGS` cmake variable, as demonstrated below:
-
-```
-cd .build
-conan install .. --output-folder . --build missing --settings build_type=Debug -o tests=True -o coverage=True
-cmake -DCODE_COVERAGE_REPORT_FORMAT=json-details -DCMAKE_BUILD_TYPE=Debug -DCODE_COVERAGE_TESTS_ARGS="--gtest_filter=-BackendCassandra*" -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake ..
-cmake --build . --target coverage_report
-```
-
-After `coverage_report` target is completed, the generated coverage report will be
-stored inside the build directory, as either of:
-
-- file named `coverage_report.*`, with a suitable extension for the report format, or
-- directory named `coverage_report`, with `index.html` and other files inside, for `html-details` or `html-nested` report formats.
-
-
-## Developing against `rippled` in standalone mode
-
-If you wish you develop against a `rippled` instance running in standalone
-mode there are a few quirks of both clio and rippled you need to keep in mind.
-You must:
-
-1. Advance the `rippled` ledger to at least ledger 256
-2. Wait 10 minutes before first starting clio against this standalone node.
-
-## Logging
-Clio provides several logging options, all are configurable via the config file and are detailed below.
-
-`log_level`: The minimum level of severity at which the log message will be outputted by default.
-Severity options are `trace`, `debug`, `info`, `warning`, `error`, `fatal`. Defaults to `info`.
-
-`log_format`: The format of log lines produced by clio. Defaults to `"%TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message%"`.
-Each of the variables expands like so
-- `TimeStamp`: The full date and time of the log entry
-- `SourceLocation`: A partial path to the c++ file and the line number in said file (`source/file/path:linenumber`)  
-- `ThreadID`: The ID of the thread the log entry is written from
-- `Channel`: The channel that this log entry was sent to
-- `Severity`: The severity (aka log level) the entry was sent at
-- `Message`: The actual log message
-
-`log_channels`: An array of json objects, each overriding properties for a logging `channel`. 
-At the moment of writing, only `log_level` can be overriden using this mechanism.
-
-Each object is of this format:
-```json
-{
-    "channel": "Backend",
-    "log_level": "fatal"
-}
-``` 
-If no override is present for a given channel, that channel will log at the severity specified by the global `log_level`.
-Overridable log channels: `Backend`, `WebServer`, `Subscriptions`, `RPC`, `ETL` and `Performance`.
-
-> **Note:** See `example-config.json` for more details. 
-
-`log_to_console`: Enable/disable log output to console. Options are `true`/`false`. Defaults to true.
-
-`log_directory`: Path to the directory where log files are stored. If such directory doesn't exist, Clio will create it. If not specified, logs are not written to a file.
-
-`log_rotation_size`: The max size of the log file in **megabytes** before it will rotate into a smaller file. Defaults to 2GB.
-
-`log_directory_max_size`: The max size of the log directory in **megabytes** before old log files will be
-deleted to free up space. Defaults to 50GB.
-
-`log_rotation_hour_interval`: The time interval in **hours** after the last log rotation to automatically
-rotate the current log file. Defaults to 12 hours.
-
-Note, time-based log rotation occurs dependently on size-based log rotation, where if a
-size-based log rotation occurs, the timer for the time-based rotation will reset.
-
-`log_tag_style`: Tag implementation to use. Must be one of:
-- `uint`: Lock free and threadsafe but outputs just a simple unsigned integer 
-- `uuid`: Threadsafe and outputs a UUID tag
-- `none`: Don't use tagging at all
-
-## Cassandra / Scylla Administration
-
-Since Clio relies on either Cassandra or Scylla for its database backend, here are some important considerations:
-
-- Scylla, by default, will reserve all free RAM on a machine for itself. If you are running `rippled` or other services on the same machine, restrict its memory usage using the `--memory` argument: https://docs.scylladb.com/getting-started/scylla-in-a-shared-environment/
+If you have any questions about building, running, contributing, using Clio or any other, you could always start a new [discussion](https://github.com/XRPLF/clio/discussions).

RELEASENOTES.md

@@ -1,23 +0,0 @@
-# Release Notes
-
-This document contains the release notes for `clio_server`, an XRP Ledger API Server.
-
-To build and run `clio_server`, follow the instructions in [README.md](https://github.com/XRPLF/clio).
-
-If you find issues or have a new idea, please open [an issue](https://github.com/XRPLF/clio/issues).
-
-# Releases
-
-## 0.1.0
-
-Clio is an XRP Ledger API server. Clio is optimized for RPC calls, over websocket or JSON-RPC. Validated historical ledger and transaction data is stored in a more space efficient format, using up to 4 times less space than rippled.
-
-Clio uses Cassandra or ScyllaDB, allowing for scalable read throughput. Multiple clio nodes can share access to the same dataset, allowing for a highly available cluster of clio nodes, without the need for redundant data storage or computation.
-
-**0.1.0** is the first beta of Project Clio. It contains:
--  `./src/backend` is the BackendInterface. This provides an abstraction for reading and writing information to a database.
--  `./src/etl` is the ReportingETL. The classes in this folder are used to extract information from the P2P network and write it to a database, either locally or over the network.
--  `./src/rpc` contains RPC handlers that are called by clients. These handlers should expose the same API as rippled.
--  `./src/subscriptions` contains the SubscriptionManager. This manages publishing to clients subscribing to streams or accounts.
--  `./src/webserver` contains a flex server that handles both http/s and ws/s traffic on a single port.
--  `./unittests` simple unit tests that write to and read from a database to verify that the ETL works.

benchmarks/CMakeLists.txt

@@ -0,0 +1,16 @@
+add_executable(clio_benchmark)
+
+target_sources(
+  clio_benchmark
+  PRIVATE # Common
+          Main.cpp
+          Playground.cpp
+          # ExecutionContext
+          util/async/ExecutionContextBenchmarks.cpp
+)
+
+include(deps/gbench)
+
+target_include_directories(clio_benchmark PRIVATE .)
+target_link_libraries(clio_benchmark PUBLIC clio benchmark::benchmark_main)
+set_target_properties(clio_benchmark PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})

benchmarks/Main.cpp

@@ -0,0 +1,22 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2023, 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 <benchmark/benchmark.h>
+
+BENCHMARK_MAIN();

benchmarks/Playground.cpp

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2023, 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.
+*/
+//==============================================================================
+
+/*
+ * Use this file for temporary benchmarks and implementations.
+ * Usage example:
+ * ```
+ * ./clio_benchmarks
+ *     --benchmark_time_unit=ms
+ *     --benchmark_repetitions=10
+ *     --benchmark_display_aggregates_only=true
+ *     --benchmark_min_time=1x
+ *     --benchmark_filter="Playground"
+ * ```
+ *
+ * Note: Please don't push your temporary work to the repo.
+ */
+
+// #include <benchmark/benchmark.h>
+
+// static void
+// benchmarkPlaygroundTest1(benchmark::State& state)
+// {
+//     for (auto _ : state) {
+//         // ...
+//     }
+// }
+
+// BENCHMARK(benchmarkPlaygroundTest1);

benchmarks/util/async/ExecutionContextBenchmarks.cpp

@@ -0,0 +1,268 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2024, 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 "etl/ETLHelpers.hpp"
+#include "util/Random.hpp"
+#include "util/async/AnyExecutionContext.hpp"
+#include "util/async/AnyOperation.hpp"
+#include "util/async/context/BasicExecutionContext.hpp"
+#include "util/async/context/SyncExecutionContext.hpp"
+
+#include <benchmark/benchmark.h>
+
+#include <chrono>
+#include <cstddef>
+#include <cstdint>
+#include <latch>
+#include <optional>
+#include <stdexcept>
+#include <thread>
+#include <vector>
+
+using namespace util;
+using namespace util::async;
+
+class TestThread {
+    std::vector<std::thread> threads_;
+    etl::ThreadSafeQueue<std::optional<uint64_t>> q_;
+    etl::ThreadSafeQueue<uint64_t> res_;
+
+public:
+    TestThread(std::vector<uint64_t> const& data) : q_(data.size()), res_(data.size())
+    {
+        for (auto el : data)
+            q_.push(el);
+    }
+
+    ~TestThread()
+    {
+        for (auto& t : threads_) {
+            if (t.joinable())
+                t.join();
+        }
+    }
+
+    void
+    run(std::size_t numThreads)
+    {
+        std::latch completion{numThreads};
+        for (std::size_t i = 0; i < numThreads; ++i) {
+            q_.push(std::nullopt);
+            threads_.emplace_back([this, &completion]() { process(completion); });
+        }
+
+        completion.wait();
+    }
+
+private:
+    void
+    process(std::latch& completion)
+    {
+        while (auto v = q_.pop()) {
+            if (not v.has_value())
+                break;
+
+            res_.push(v.value() * v.value());
+        }
+
+        completion.count_down(1);
+    }
+};
+
+template <typename CtxType>
+class TestExecutionContextBatched {
+    etl::ThreadSafeQueue<std::optional<uint64_t>> q_;
+    etl::ThreadSafeQueue<uint64_t> res_;
+    std::size_t batchSize_;
+
+public:
+    TestExecutionContextBatched(std::vector<uint64_t> const& data, std::size_t batchSize = 5000u)
+        : q_(data.size()), res_(data.size()), batchSize_(batchSize)
+    {
+        for (auto el : data)
+            q_.push(el);
+    }
+
+    void
+    run(std::size_t numThreads)
+    {
+        using OpType = typename CtxType::template StoppableOperation<void>;
+
+        CtxType ctx{numThreads};
+        std::vector<OpType> operations;
+
+        for (std::size_t i = 0; i < numThreads; ++i) {
+            q_.push(std::nullopt);
+
+            operations.push_back(ctx.execute(
+                [this](auto stopRequested) {
+                    bool hasMore = true;
+                    auto doOne = [this] {
+                        auto v = q_.pop();
+                        if (not v.has_value())
+                            return false;
+
+                        res_.push(v.value() * v.value());
+                        return true;
+                    };
+
+                    while (not stopRequested and hasMore) {
+                        for (std::size_t i = 0; i < batchSize_ and hasMore; ++i)
+                            hasMore = doOne();
+                    }
+                },
+                std::chrono::seconds{5}
+            ));
+        }
+
+        for (auto& op : operations)
+            op.wait();
+    }
+};
+
+template <typename CtxType>
+class TestAnyExecutionContextBatched {
+    etl::ThreadSafeQueue<std::optional<uint64_t>> q_;
+    etl::ThreadSafeQueue<uint64_t> res_;
+    std::size_t batchSize_;
+
+public:
+    TestAnyExecutionContextBatched(std::vector<uint64_t> const& data, std::size_t batchSize = 5000u)
+        : q_(data.size()), res_(data.size()), batchSize_(batchSize)
+    {
+        for (auto el : data)
+            q_.push(el);
+    }
+
+    void
+    run(std::size_t numThreads)
+    {
+        CtxType ctx{numThreads};
+        AnyExecutionContext anyCtx{ctx};
+        std::vector<AnyOperation<void>> operations;
+
+        for (std::size_t i = 0; i < numThreads; ++i) {
+            q_.push(std::nullopt);
+
+            operations.push_back(anyCtx.execute(
+                [this](auto stopRequested) {
+                    bool hasMore = true;
+                    auto doOne = [this] {
+                        auto v = q_.pop();
+                        if (not v.has_value())
+                            return false;
+
+                        res_.push(v.value() * v.value());
+                        return true;
+                    };
+
+                    while (not stopRequested and hasMore) {
+                        for (std::size_t i = 0; i < batchSize_ and hasMore; ++i)
+                            hasMore = doOne();
+                    }
+                },
+                std::chrono::seconds{5}
+            ));
+        }
+
+        for (auto& op : operations)
+            op.wait();
+    }
+};
+
+static auto
+generateData()
+{
+    constexpr auto TOTAL = 10'000;
+    std::vector<uint64_t> data;
+    data.reserve(TOTAL);
+    for (auto i = 0; i < TOTAL; ++i)
+        data.push_back(util::Random::uniform(1, 100'000'000));
+
+    return data;
+}
+
+static void
+benchmarkThreads(benchmark::State& state)
+{
+    auto data = generateData();
+    for (auto _ : state) {
+        TestThread t{data};
+        t.run(state.range(0));
+    }
+}
+
+template <typename CtxType>
+void
+benchmarkExecutionContextBatched(benchmark::State& state)
+{
+    auto data = generateData();
+    for (auto _ : state) {
+        TestExecutionContextBatched<CtxType> t{data, state.range(1)};
+        t.run(state.range(0));
+    }
+}
+
+template <typename CtxType>
+void
+benchmarkAnyExecutionContextBatched(benchmark::State& state)
+{
+    auto data = generateData();
+    for (auto _ : state) {
+        TestAnyExecutionContextBatched<CtxType> t{data, state.range(1)};
+        t.run(state.range(0));
+    }
+}
+
+// Simplest implementation using async queues and std::thread
+BENCHMARK(benchmarkThreads)->Arg(1)->Arg(2)->Arg(4)->Arg(8);
+
+// Same implementation using each of the available execution contexts
+BENCHMARK(benchmarkExecutionContextBatched<PoolExecutionContext>)
+    ->ArgsProduct({
+        {1, 2, 4, 8},             // threads
+        {500, 1000, 5000, 10000}  // batch size
+    });
+BENCHMARK(benchmarkExecutionContextBatched<CoroExecutionContext>)
+    ->ArgsProduct({
+        {1, 2, 4, 8},             // threads
+        {500, 1000, 5000, 10000}  // batch size
+    });
+BENCHMARK(benchmarkExecutionContextBatched<SyncExecutionContext>)
+    ->ArgsProduct({
+        {1, 2, 4, 8},             // threads
+        {500, 1000, 5000, 10000}  // batch size
+    });
+
+// Same implementations going thru AnyExecutionContext
+BENCHMARK(benchmarkAnyExecutionContextBatched<PoolExecutionContext>)
+    ->ArgsProduct({
+        {1, 2, 4, 8},             // threads
+        {500, 1000, 5000, 10000}  // batch size
+    });
+BENCHMARK(benchmarkAnyExecutionContextBatched<CoroExecutionContext>)
+    ->ArgsProduct({
+        {1, 2, 4, 8},             // threads
+        {500, 1000, 5000, 10000}  // batch size
+    });
+BENCHMARK(benchmarkAnyExecutionContextBatched<SyncExecutionContext>)
+    ->ArgsProduct({
+        {1, 2, 4, 8},             // threads
+        {500, 1000, 5000, 10000}  // batch size
+    });

cmake/Build.cpp.in

@@ -17,12 +17,12 @@
 */
 //==============================================================================
 
-#include "main/Build.h"
+#include "main/Build.hpp"
 
 #include <string>
 
 namespace Build {
-static constexpr char versionString[] = "@VERSION@";
+static constexpr char versionString[] = "@CLIO_VERSION@";
 
 std::string const&
 getClioVersionString()

cmake/Ccache.cmake

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

cmake/CheckCompiler.cmake

@@ -0,0 +1,42 @@
+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 ()

cmake/ClangTidy.cmake

@@ -0,0 +1,33 @@
+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-18" "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 ()
+
+  # 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 ()

cmake/ClioVersion.cmake

@@ -0,0 +1,48 @@
+#[===================================================================[
+   write version to source
+#]===================================================================]
+
+find_package(Git REQUIRED)
+
+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
+)
+
+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
+)
+
+if (BRANCH STREQUAL "")
+  set(BRANCH "dev")
+endif ()
+
+if (NOT (BRANCH MATCHES master OR BRANCH MATCHES release/*)) # for develop and any other branch name
+                                                             # YYYYMMDDHMS-<branch>-<git-rev>
+  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_CURRENT_SOURCE_DIR} OUTPUT_VARIABLE DATE
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+  )
+  set(CLIO_VERSION "${DATE}-${BRANCH}-${REV}")
+  set(DOC_CLIO_VERSION "develop")
+else ()
+  set(GIT_COMMAND describe --tags)
+  execute_process(
+    COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} OUTPUT_VARIABLE CLIO_TAG_VERSION
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+  )
+  set(CLIO_VERSION "${CLIO_TAG_VERSION}")
+  set(DOC_CLIO_VERSION "${CLIO_TAG_VERSION}")
+endif ()
+
+if (CMAKE_BUILD_TYPE MATCHES Debug)
+  set(CLIO_VERSION "${CLIO_VERSION}+DEBUG")
+endif ()
+
+message(STATUS "Build version: ${CLIO_VERSION}")
+
+configure_file(${CMAKE_CURRENT_LIST_DIR}/Build.cpp.in ${CMAKE_CURRENT_LIST_DIR}/../src/main/impl/Build.cpp)

cmake/CodeCoverage.cmake

@@ -0,0 +1,361 @@
+# Copyright (c) 2012 - 2017, Lars Bilke All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+# following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+#   disclaimer.
+#
+# 1. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+#   disclaimer in the documentation and/or other materials provided with the distribution.
+#
+# 1. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
+#   products derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# CHANGES:
+#
+# 2012-01-31, Lars Bilke - Enable Code Coverage
+#
+# 2013-09-17, Joakim Söderberg - Added support for Clang. - Some additional usage instructions.
+#
+# 2016-02-03, Lars Bilke - Refactored functions to use named parameters
+#
+# 2017-06-02, Lars Bilke - Merged with modified version from github.com/ufz/ogs
+#
+# 2019-05-06, Anatolii Kurotych - Remove unnecessary --coverage flag
+#
+# 2019-12-13, FeRD (Frank Dana) - Deprecate COVERAGE_LCOVR_EXCLUDES and COVERAGE_GCOVR_EXCLUDES lists in favor of
+# tool-agnostic COVERAGE_EXCLUDES variable, or EXCLUDE setup arguments. - CMake 3.4+: All excludes can be specified
+# relative to BASE_DIRECTORY - All setup functions: accept BASE_DIRECTORY, EXCLUDE list - Set lcov basedir with -b
+# argument - Add automatic --demangle-cpp in lcovr, if 'c++filt' is available (can be overridden with NO_DEMANGLE option
+# in setup_target_for_coverage_lcovr().) - Delete output dir, .info file on 'make clean' - Remove Python detection,
+# since version mismatches will break gcovr - Minor cleanup (lowercase function names, update examples...)
+#
+# 2019-12-19, FeRD (Frank Dana) - Rename Lcov outputs, make filtered file canonical, fix cleanup for targets
+#
+# 2020-01-19, Bob Apthorpe - Added gfortran support
+#
+# 2020-02-17, FeRD (Frank Dana) - Make all add_custom_target()s VERBATIM to auto-escape wildcard characters in EXCLUDEs,
+# and remove manual escaping from gcovr targets
+#
+# 2021-01-19, Robin Mueller - Add CODE_COVERAGE_VERBOSE option which will allow to print out commands which are run -
+# Added the option for users to set the GCOVR_ADDITIONAL_ARGS variable to supply additional flags to the gcovr command
+#
+# 2020-05-04, Mihchael Davis - Add -fprofile-abs-path to make gcno files contain absolute paths - Fix BASE_DIRECTORY not
+# working when defined - Change BYPRODUCT from folder to index.html to stop ninja from complaining about double defines
+#
+# 2021-05-10, Martin Stump - Check if the generator is multi-config before warning about non-Debug builds
+#
+# 2022-02-22, Marko Wehle - Change gcovr output from -o <filename> for --xml <filename> and --html <filename> output
+# respectively. This will allow for Multiple Output Formats at the same time by making use of GCOVR_ADDITIONAL_ARGS,
+# e.g. GCOVR_ADDITIONAL_ARGS "--txt".
+#
+# 2022-09-28, Sebastian Mueller - fix append_coverage_compiler_flags_to_target to correctly add flags - replace
+# "-fprofile-arcs -ftest-coverage" with "--coverage" (equivalent)
+#
+# 2023-12-15, Bronek Kozicki - remove setup_target_for_coverage_lcov (slow) and setup_target_for_coverage_fastcov (no
+# support for Clang) - fix Clang support by adding find_program( ... llvm-cov ) - add Apple Clang support by adding
+# execute_process( COMMAND xcrun -f llvm-cov ... ) - add CODE_COVERAGE_GCOV_TOOL to explicitly select gcov tool and
+# disable find_program - replace both functions setup_target_for_coverage_gcovr_* with single
+# setup_target_for_coverage_gcovr - add support for all gcovr output formats
+#
+# USAGE:
+#
+# 1. Copy this file into your cmake modules path.
+#
+# 1. Add the following line to your CMakeLists.txt (best inside an if-condition using a CMake option() to enable it just
+#   optionally): include(CodeCoverage)
+#
+# 1. Append necessary compiler flags for all supported source files: append_coverage_compiler_flags() Or for specific
+#   target: append_coverage_compiler_flags_to_target(YOUR_TARGET_NAME)
+#
+# 3.a (OPTIONAL) Set appropriate optimization flags, e.g. -O0, -O1 or -Og
+#
+# 1. If you need to exclude additional directories from the report, specify them using full paths in the
+#   COVERAGE_EXCLUDES variable before calling setup_target_for_coverage_*(). Example: set(COVERAGE_EXCLUDES
+# '${PROJECT_SOURCE_DIR}/src/dir1/*'
+# '/path/to/my/src/dir2/*') Or, use the EXCLUDE argument to setup_target_for_coverage_*(). Example:
+# setup_target_for_coverage_gcovr( NAME coverage EXECUTABLE testrunner EXCLUDE "${PROJECT_SOURCE_DIR}/src/dir1/*"
+# "/path/to/my/src/dir2/*")
+#
+# 4.a NOTE: With CMake 3.4+, COVERAGE_EXCLUDES or EXCLUDE can also be set relative to the BASE_DIRECTORY (default:
+# PROJECT_SOURCE_DIR) Example: set(COVERAGE_EXCLUDES "dir1/*") setup_target_for_coverage_gcovr( NAME coverage EXECUTABLE
+# testrunner FORMAT html-details BASE_DIRECTORY "${PROJECT_SOURCE_DIR}/src" EXCLUDE "dir2/*")
+#
+# 4.b If you need to pass specific options to gcovr, specify them in GCOVR_ADDITIONAL_ARGS variable. Example: set
+# (GCOVR_ADDITIONAL_ARGS --exclude-throw-branches --exclude-noncode-lines -s) setup_target_for_coverage_gcovr( NAME
+# coverage EXECUTABLE testrunner EXCLUDE "src/dir1" "src/dir2")
+#
+# 1. Use the functions described below to create a custom make target which runs your test executable and produces a code
+#   coverage report.
+#
+# 1. Build a Debug build: cmake -DCMAKE_BUILD_TYPE=Debug .. make make my_coverage_target
+
+include(CMakeParseArguments)
+
+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 ()
+
+# 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 ()
+
+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 ()
+
+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_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
+)
+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
+)
+
+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 ()
+
+# 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
+# will not complete.
+#
+# setup_target_for_coverage_gcovr( NAME ctest_coverage                    # New target name EXECUTABLE ctest -j
+# ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR DEPENDENCIES executable_target         # Dependencies to build
+# first BASE_DIRECTORY "../"                   # Base directory for report #  (defaults to PROJECT_SOURCE_DIR) FORMAT
+# "cobertura"                     # Output format, one of: #  xml cobertura sonarqube json-summary #  json-details
+# coveralls csv txt #  html-single html-nested html-details #  (xml is an alias to cobertura; #  if no format is set,
+# 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")
+    )
+      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 ()
+
+  # 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)
+
+  # 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 up commands which will be run to generate coverage data Run tests
+  set(GCOVR_EXEC_TESTS_CMD ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS})
+
+  # 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 ()
+
+  # 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 (CODE_COVERAGE_VERBOSE)
+    message(STATUS "Executed command report")
+
+    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 ()

cmake/Docs.cmake

@@ -0,0 +1,20 @@
+find_package(Doxygen REQUIRED)
+
+# See Doxyfile for these settings:
+set(SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/..)
+set(USE_DOT "YES")
+set(LINT "NO")
+set(EXCLUDES "")
+# ---
+
+set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
+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
+)

cmake/Settings.cmake

@@ -0,0 +1,45 @@
+set(COMPILER_FLAGS
+    -Wall
+    -Wcast-align
+    -Wdouble-promotion
+    -Wextra
+    -Werror
+    -Wformat=2
+    -Wimplicit-fallthrough
+    -Wmisleading-indentation
+    -Wno-narrowing
+    -Wno-deprecated-declarations
+    -Wno-dangling-else
+    -Wno-unused-but-set-variable
+    -Wnon-virtual-dtor
+    -Wnull-dereference
+    -Wold-style-cast
+    -pedantic
+    -Wpedantic
+    -Wunused
+    # FIXME: The following bunch are needed for gcc12 atm.
+    -Wno-missing-requires
+    -Wno-restrict
+    -Wno-null-dereference
+    -Wno-maybe-uninitialized
+    -Wno-unknown-warning-option # and this to work with clang
+    # TODO: Address these and others in https://github.com/XRPLF/clio/issues/1273
+)
+
+# TODO: reenable 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_appleclang)
+  list(APPEND COMPILER_FLAGS -Wreorder-init-list)
+endif ()
+
+# See https://github.com/cpp-best-practices/cppbestpractices/blob/master/02-Use_the_Tools_Available.md#gcc--clang for
+# the flags description
+
+target_compile_options(clio_options INTERFACE ${COMPILER_FLAGS})

cmake/SourceLocation.cmake

@@ -0,0 +1,11 @@
+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 ()
+
+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

@@ -0,0 +1,4 @@
+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)

cmake/deps/OpenSSL.cmake

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

cmake/deps/Threads.cmake

@@ -0,0 +1,2 @@
+set(THREADS_PREFER_PTHREAD_FLAG ON)
+find_package(Threads REQUIRED)

cmake/deps/cassandra.cmake

@@ -0,0 +1 @@
+find_package(cassandra-cpp-driver REQUIRED CONFIG)

cmake/deps/gbench.cmake

@@ -0,0 +1 @@
+find_package(benchmark REQUIRED CONFIG)

cmake/deps/gtest.cmake

@@ -0,0 +1,4 @@
+find_package(GTest REQUIRED)
+
+enable_testing()
+include(GoogleTest)

cmake/deps/libbacktrace.cmake

@@ -0,0 +1,3 @@
+target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_LINK)
+target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_USE_BACKTRACE)
+find_package(libbacktrace REQUIRED CONFIG)

cmake/deps/libfmt.cmake

@@ -0,0 +1 @@
+find_package(fmt REQUIRED CONFIG)

cmake/deps/libxrpl.cmake

@@ -0,0 +1 @@
+find_package(xrpl REQUIRED CONFIG)

cmake/install/install.cmake

@@ -0,0 +1,13 @@
+set(CLIO_INSTALL_DIR "/opt/clio")
+set(CMAKE_INSTALL_PREFIX ${CLIO_INSTALL_DIR})
+
+install(TARGETS clio_server DESTINATION bin)
+
+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)
+
+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)

conanfile.py

@@ -1,7 +1,6 @@
 from conan import ConanFile
 from conan.tools.cmake import CMake, CMakeToolchain, cmake_layout
 
-
 class Clio(ConanFile):
     name = 'clio'
     license = 'ISC'
@@ -10,36 +9,43 @@ class Clio(ConanFile):
     description = 'Clio RPC server'
     settings = 'os', 'compiler', 'build_type', 'arch'
     options = {
-        'fPIC': [True, False],
+        'static': [True, False],              # static linkage
+        'fPIC': [True, False],                # unused?
         'verbose': [True, False],
-        'tests': [True, False],     # build unit tests; create `clio_tests` binary
-        'docs': [True, False],      # doxygen API docs; create custom target 'docs'
-        'packaging': [True, False], # create distribution packages
-        'coverage': [True, False],  # build for test coverage report; create custom target `clio_tests-ccov`
-        'lint': [True, False],      # run clang-tidy checks during compilation
+        'tests': [True, False],               # build unit tests; create `clio_tests` binary
+        'integration_tests': [True, False],   # build integration tests; create `clio_integration_tests` binary
+        'benchmark': [True, False],           # build benchmarks; create `clio_benchmarks` binary
+        'docs': [True, False],                # doxygen API docs; create custom target 'docs'
+        'packaging': [True, False],           # create distribution packages
+        'coverage': [True, False],            # build for test coverage report; create custom target `clio_tests-ccov`
+        'lint': [True, False],                # run clang-tidy checks during compilation
     }
 
     requires = [
         'boost/1.82.0',
         'cassandra-cpp-driver/2.17.0',
         'fmt/10.1.1',
-        'protobuf/3.21.12',
+        'protobuf/3.21.9',
         'grpc/1.50.1',
         'openssl/1.1.1u',
-        'xrpl/2.0.0',
+        'xrpl/2.2.0',
         'libbacktrace/cci.20210118'
     ]
 
     default_options = {
+        'static': False,
         'fPIC': True,
         'verbose': False,
         'tests': False,
+        'integration_tests': False,
+        'benchmark': False,
         'packaging': False,
         'coverage': False,
         'lint': False,
         'docs': False,
         
         'xrpl/*:tests': False,
+        'xrpl/*:rocksdb': False,
         'cassandra-cpp-driver/*:shared': False,
         'date/*:header_only': True,
         'grpc/*:shared': False,
@@ -54,12 +60,14 @@ class Clio(ConanFile):
     }
 
     exports_sources = (
-        'CMakeLists.txt', 'CMake/*', 'src/*'
+        'CMakeLists.txt', 'cmake/*', 'src/*'
     )
 
     def requirements(self):
-        if self.options.tests:
+        if self.options.tests or self.options.integration_tests:
             self.requires('gtest/1.14.0')
+        if self.options.benchmark:
+            self.requires('benchmark/1.8.3')
 
     def configure(self):
         if self.settings.compiler == 'apple-clang':
@@ -75,11 +83,14 @@ class Clio(ConanFile):
     def generate(self):
         tc = CMakeToolchain(self)
         tc.variables['verbose'] = self.options.verbose
+        tc.variables['static'] = self.options.static
         tc.variables['tests'] = self.options.tests
+        tc.variables['integration_tests'] = self.options.integration_tests
         tc.variables['coverage'] = self.options.coverage
         tc.variables['lint'] = self.options.lint
         tc.variables['docs'] = self.options.docs
         tc.variables['packaging'] = self.options.packaging
+        tc.variables['benchmark'] = self.options.benchmark
         tc.generate()
 
     def build(self):

docker/centos/Dockerfile

@@ -1,49 +0,0 @@
-# FROM centos:7 as deps
-FROM centos:7 as build
-
-ENV CLIO_DIR=/opt/clio/
-# ENV OPENSSL_DIR=/opt/openssl
-
-RUN yum -y install git epel-release centos-release-scl perl-IPC-Cmd openssl
-RUN yum install -y devtoolset-11
-ENV version=3.16
-ENV build=3
-# RUN curl -OJL https://cmake.org/files/v$version/cmake-$version.$build.tar.gz
-COPY docker/shared/install_cmake.sh /install_cmake.sh
-RUN /install_cmake.sh 3.16.3 /usr/local
-RUN source /opt/rh/devtoolset-11/enable
-WORKDIR /tmp
-# RUN mkdir $OPENSSL_DIR && cd $OPENSSL_DIR
-COPY docker/centos/build_git_centos7.sh build_git_centos7.sh
-
-RUN ./build_git_centos7.sh
-RUN git clone https://github.com/openssl/openssl
-WORKDIR /tmp/openssl
-RUN git checkout OpenSSL_1_1_1q
-#--prefix=/usr --openssldir=/etc/ssl --libdir=lib no-shared zlib-dynamic
-RUN SSLDIR=$(openssl version -d | cut -d: -f2 | tr -d [:space:]\") && ./config -fPIC --prefix=/usr --openssldir=${SSLDIR} zlib shared && \
-    make -j $(nproc) && \
-    make install_sw
-WORKDIR /tmp
-# FROM centos:7 as build
-
-RUN git clone https://github.com/xrplf/clio.git
-COPY docker/shared/build_boost.sh build_boost.sh
-ENV OPENSSL_ROOT=/opt/local/openssl
-ENV BOOST_ROOT=/boost
-RUN source scl_source enable devtoolset-11 && /tmp/build_boost.sh 1.75.0
-RUN yum install -y bison flex
-RUN yum install -y rpmdevtools rpmlint
-RUN source /opt/rh/devtoolset-11/enable && cd /tmp/clio && \
-    cmake -B build -DBUILD_TESTS=1 && \
-    cmake --build build --parallel $(nproc)
-RUN mkdir output
-RUN strip clio/build/clio_server && strip clio/build/clio_tests
-RUN cp clio/build/clio_tests output/ && cp clio/build/clio_server output/
-RUN cp clio/example-config.json output/example-config.json
-
-FROM centos:7
-COPY --from=build /tmp/output /clio
-RUN mkdir -p /opt/clio/etc && mv /clio/example-config.json /opt/clio/etc/config.json
-
-CMD ["/clio/clio_server", "/opt/clio/etc/config.json"]

docker/centos/build_git_centos7.sh

@@ -1,18 +0,0 @@
-#!/usr/bin/env bash
-
-set -ex
-GIT_VERSION="2.37.1"
-curl -OJL https://github.com/git/git/archive/refs/tags/v${GIT_VERSION}.tar.gz
-tar zxvf git-${GIT_VERSION}.tar.gz
-cd git-${GIT_VERSION}
-
-yum install -y centos-release-scl epel-release
-yum update -y
-yum install -y devtoolset-11 autoconf gnu-getopt gettext zlib-devel  libcurl-devel
-
-source /opt/rh/devtoolset-11/enable
-make configure
-./configure
-make git -j$(nproc)
-make install git
-git  --version | cut -d ' ' -f3

docker/centos/install_cmake.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-set -eo pipefail
-
-CMAKE_VERSION=${1:-"3.16.3"}
-cd /tmp
-URL="https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-linux-x86_64.tar.gz"
-curl -OJLs $URL
-tar xzvf cmake-${CMAKE_VERSION}-Linux-x86_64.tar.gz
-mv cmake-${CMAKE_VERSION}-Linux-x86_64 /opt/
-ln -s /opt/cmake-${CMAKE_VERSION}-Linux-x86_64/bin/cmake /usr/local/bin/cmake

docker/ci/dockerfile

@@ -1,67 +1,100 @@
-FROM ubuntu:focal
+FROM rippleci/clio_clang:16
 ARG DEBIAN_FRONTEND=noninteractive
 ARG TARGETARCH
 
+SHELL ["/bin/bash", "-c"]
 USER root
-WORKDIR /root/
+WORKDIR /root
 
-ENV GCC_VERSION=11 \
-    CCACHE_VERSION=4.8.3 \
-    LLVM_TOOLS_VERSION=17 \
-    GH_VERSION=2.40.0
+ENV CCACHE_VERSION=4.8.3 \
+    LLVM_TOOLS_VERSION=18 \
+    GH_VERSION=2.40.0 \
+    DOXYGEN_VERSION=1.10.0
  
 # Add repositories
 RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends --no-install-suggests gnupg wget curl software-properties-common \
-    && add-apt-repository -y ppa:ubuntu-toolchain-r/test \
-    && wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | apt-key add - \
-    && apt-add-repository 'deb https://apt.kitware.com/ubuntu/ focal main' \
     && echo "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-${LLVM_TOOLS_VERSION} main" >> /etc/apt/sources.list \
     && wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add -
 
 # Install packages
 RUN apt update -qq \
-    && apt install -y --no-install-recommends --no-install-suggests cmake python3 python3-pip sudo git \
-    ninja-build make pkg-config libzstd-dev libzstd1 g++-${GCC_VERSION} jq \
+    && apt install -y --no-install-recommends --no-install-suggests python3 python3-pip git git-lfs make ninja-build flex bison jq graphviz \
     clang-format-${LLVM_TOOLS_VERSION} clang-tidy-${LLVM_TOOLS_VERSION} clang-tools-${LLVM_TOOLS_VERSION} \
-    && update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-${GCC_VERSION} 100 \
-    && update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-${GCC_VERSION} 100 \
-    && update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCC_VERSION} 100 \
-    && update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-${GCC_VERSION} 100 \
-    && update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-${GCC_VERSION} 100 \
-    && update-alternatives --install /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-${GCC_VERSION} 100 \
-    && update-alternatives --install /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-${GCC_VERSION} 100 \
-    && apt-get clean && apt remove -y software-properties-common \
-    && pip3 install  -q --upgrade --no-cache-dir pip \
-    && pip3 install  -q --no-cache-dir conan==1.62 gcovr
+    && update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-${LLVM_TOOLS_VERSION} 100 \
+    && pip3 install -q --upgrade --no-cache-dir pip && pip3 install -q --no-cache-dir conan==1.62 gcovr cmake cmake-format \
+    && apt-get clean && apt remove -y software-properties-common
+
+# Install gcc-12 and make ldconfig aware of the new libstdc++ location (for gcc)
+# Note: Clang is using libc++ instead
+COPY --from=rippleci/clio_gcc:12.3.0 /gcc12.deb /
+RUN apt update && apt-get install -y binutils libc6-dev \
+    && dpkg -i /gcc12.deb \
+    && rm -rf /gcc12.deb \
+    && ldconfig
+
+# Rewire to use gcc-12 as default compiler
+RUN update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-12 100 \
+    && update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-12 100 \
+    && update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 100 \
+    && update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-12 100 \
+    && update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-12 100 \
+    && update-alternatives --install /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-12 100 \
+    && update-alternatives --install /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-12 100
+
+WORKDIR /tmp
 
 # Install ccache from source
-WORKDIR /tmp
 RUN wget "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}" \
     && mkdir build && cd build \
     && cmake -GNinja -DCMAKE_BUILD_TYPE=Release .. \
-    && ninja && cp ./ccache /usr/bin/ccache
+    && cmake --build . --target install \
+    && rm -rf /tmp/* /var/tmp/*
+
+# Install doxygen from source
+RUN wget "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}" \
+    && mkdir build && cd build \
+    && cmake -GNinja -DCMAKE_BUILD_TYPE=Release .. \
+    && cmake --build . --target install \
+    && rm -rf /tmp/* /var/tmp/*
 
 # Install gh
 RUN wget 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/bin/gh
+    && mv gh_${GH_VERSION}_linux_${TARGETARCH}/bin/gh /usr/bin/gh \
+    && rm -rf /tmp/* /var/tmp/*
 
-# Clean up
-RUN rm -rf  /tmp/* /var/tmp/*
-
-WORKDIR /root/
+WORKDIR /root
 # Using root by default is not very secure but github checkout action doesn't work with any other user
 # https://github.com/actions/checkout/issues/956
 # And Github Actions doc recommends using root
 # https://docs.github.com/en/actions/creating-actions/dockerfile-support-for-github-actions#user
 
 # Setup conan
-RUN conan profile new default --detect \
-    && conan profile update settings.compiler.cppstd=20 default \
-    && conan profile update settings.compiler.libcxx=libstdc++11 default \
-    && conan remote add --insert 0 conan-non-prod http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod
+RUN conan remote add --insert 0 conan-non-prod http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod
 
+# Note: intentionally leaving cppstd=20
+RUN conan profile new gcc --detect \
+    && conan profile update settings.compiler=gcc gcc \
+    && conan profile update settings.compiler.version=12 gcc \
+    && conan profile update settings.compiler.cppstd=20 gcc \
+    && conan profile update settings.compiler.libcxx=libstdc++11 gcc \
+    && conan profile update env.CC=/usr/bin/gcc-12 gcc \
+    && conan profile update env.CXX=/usr/bin/g++-12 gcc \
+    && conan profile update "conf.tools.build:compiler_executables={\"c\": \"/usr/bin/gcc-12\", \"cpp\": \"/usr/bin/g++-12\"}" gcc
 
+RUN conan profile new clang --detect \
+    && conan profile update settings.compiler=clang clang \
+    && conan profile update settings.compiler.version=16 clang \
+    && conan profile update settings.compiler.cppstd=20 clang \
+    && conan profile update settings.compiler.libcxx=libc++ clang \
+    && conan profile update env.CC=/usr/bin/clang-16 clang \
+    && conan profile update env.CXX=/usr/bin/clang++-16 clang \
+    && conan profile update env.CXXFLAGS="-DBOOST_ASIO_DISABLE_CONCEPTS" clang \
+    && conan profile update "conf.tools.build:compiler_executables={\"c\": \"/usr/bin/clang-16\", \"cpp\": \"/usr/bin/clang++-16\"}" clang 
+
+RUN echo "include(gcc)" >> .conan/profiles/default

docker/clio_docker/centos/build_boost.sh

@@ -1,13 +0,0 @@
-#!/usr/bin/env bash
-set -exu
-
-#yum install wget lz4 lz4-devel git llvm13-static.x86_64 llvm13-devel.x86_64 devtoolset-11-binutils zlib-static
-# it's either those or link=static that halves the failures. probably link=static
-BOOST_VERSION=$1
-BOOST_VERSION_=$(echo ${BOOST_VERSION} | tr . _)
-echo "BOOST_VERSION: ${BOOST_VERSION}"
-echo "BOOST_VERSION_: ${BOOST_VERSION_}"
-curl -OJLs "https://boostorg.jfrog.io/artifactory/main/release/${BOOST_VERSION}/source/boost_${BOOST_VERSION_}.tar.gz"
-tar zxf "boost_${BOOST_VERSION_}.tar.gz"
-cd boost_${BOOST_VERSION_} && ./bootstrap.sh && ./b2 --without-python link=static -j$(nproc)
-mkdir -p /boost && mv boost /boost && mv stage /boost

docker/clio_docker/centos/build_git_centos7.sh

@@ -1,18 +0,0 @@
-#!/usr/bin/env bash
-
-set -ex
-GIT_VERSION="2.37.1"
-curl -OJL https://github.com/git/git/archive/refs/tags/v${GIT_VERSION}.tar.gz
-tar zxvf git-${GIT_VERSION}.tar.gz
-cd git-${GIT_VERSION}
-
-yum install -y centos-release-scl epel-release
-yum update -y
-yum install -y devtoolset-11 autoconf gnu-getopt gettext zlib-devel  libcurl-devel
-
-source /opt/rh/devtoolset-11/enable
-make configure
-./configure
-make git -j$(nproc)
-make install git
-git  --version | cut -d ' ' -f3

docker/clio_docker/centos/dockerfile

@@ -1,34 +0,0 @@
-FROM centos:7
-
-ENV CLIO_DIR=/opt/clio/
-# ENV OPENSSL_DIR=/opt/openssl
-
-RUN yum -y install git epel-release centos-release-scl perl-IPC-Cmd openssl
-RUN yum install -y devtoolset-11
-ENV version=3.16
-ENV build=3
-# RUN curl -OJL https://cmake.org/files/v$version/cmake-$version.$build.tar.gz
-COPY install_cmake.sh /install_cmake.sh
-RUN /install_cmake.sh 3.16.3 /usr/local
-RUN source /opt/rh/devtoolset-11/enable
-WORKDIR /tmp
-# RUN mkdir $OPENSSL_DIR && cd $OPENSSL_DIR
-COPY build_git_centos7.sh build_git_centos7.sh
-
-RUN ./build_git_centos7.sh
-RUN git clone https://github.com/openssl/openssl
-WORKDIR /tmp/openssl
-RUN git checkout OpenSSL_1_1_1q
-#--prefix=/usr --openssldir=/etc/ssl --libdir=lib no-shared zlib-dynamic
-RUN SSLDIR=$(openssl version -d | cut -d: -f2 | tr -d [:space:]\") && ./config -fPIC --prefix=/usr --openssldir=${SSLDIR} zlib shared && \
-    make -j $(nproc) && \
-    make install_sw
-WORKDIR /tmp
-RUN git clone https://github.com/xrplf/clio.git
-COPY build_boost.sh build_boost.sh
-ENV OPENSSL_ROOT=/opt/local/openssl
-ENV BOOST_ROOT=/boost
-RUN source scl_source enable devtoolset-11 && /tmp/build_boost.sh 1.75.0
-RUN yum install -y bison flex
-RUN source /opt/rh/devtoolset-11/enable && \
-    cd /tmp/clio && cmake -B build -Dtests=0 -Dlocal_libarchive=1 -Dunity=0 -DBUILD_TESTS=0 && cmake --build build --parallel $(nproc)

docker/clio_docker/centos/install_cmake.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-set -eo pipefail
-
-CMAKE_VERSION=${1:-"3.16.3"}
-cd /tmp
-URL="https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-linux-x86_64.tar.gz"
-curl -OJLs $URL
-tar xzvf cmake-${CMAKE_VERSION}-Linux-x86_64.tar.gz
-mv cmake-${CMAKE_VERSION}-Linux-x86_64 /opt/
-ln -s /opt/cmake-${CMAKE_VERSION}-Linux-x86_64/bin/cmake /usr/local/bin/cmake

docker/compilers/clang-16/dockerfile

@@ -0,0 +1,19 @@
+FROM ubuntu:focal 
+ARG DEBIAN_FRONTEND=noninteractive
+ARG TARGETARCH
+
+SHELL ["/bin/bash", "-c"]
+USER root
+WORKDIR /root
+
+ENV CLANG_VERSION=16
+
+RUN apt update -qq \
+    && apt install -qq -y --no-install-recommends --no-install-suggests \
+    wget software-properties-common gnupg
+
+RUN wget https://apt.llvm.org/llvm.sh \
+    && chmod +x llvm.sh \
+    && ./llvm.sh ${CLANG_VERSION} \
+    && rm -rf llvm.sh \
+    && apt-get install -y libc++-16-dev libc++abi-16-dev

docker/compilers/gcc-12/control.m4

@@ -0,0 +1,6 @@
+Package: gcc-12-ubuntu-UBUNTUVERSION
+Version: VERSION
+Architecture: TARGETARCH
+Maintainer: Alex Kremer <akremer@ripple.com>
+Description: Gcc VERSION build for ubuntu UBUNTUVERSION
+Depends: binutils, libc6-dev

docker/compilers/gcc-12/dockerfile

@@ -0,0 +1,74 @@
+FROM ubuntu:focal as build
+
+ARG DEBIAN_FRONTEND=noninteractive
+ARG TARGETARCH
+ARG UBUNTU_VERSION=20.04
+ARG GCC_VERSION=12.3.0
+ARG BUILD_VERSION=1
+
+RUN apt update && apt install -y wget build-essential file flex libz-dev libzstd-dev
+RUN wget https://gcc.gnu.org/pub/gcc/releases/gcc-$GCC_VERSION/gcc-$GCC_VERSION.tar.gz \
+    && tar xf gcc-$GCC_VERSION.tar.gz \
+    && cd /gcc-$GCC_VERSION && ./contrib/download_prerequisites
+
+RUN mkdir /${TARGETARCH}-gcc-12
+WORKDIR /${TARGETARCH}-gcc-12
+RUN /gcc-$GCC_VERSION/configure \
+    --with-pkgversion="clio-build-$BUILD_VERSION https://github.com/XRPLF/clio" \
+    --enable-languages=c,c++ \
+    --prefix=/usr \
+    --with-gcc-major-version-only \
+    --program-suffix=-12 \
+    --enable-shared \
+    --enable-linker-build-id \
+    --libexecdir=/usr/lib \
+    --without-included-gettext \
+    --enable-threads=posix \
+    --libdir=/usr/lib \
+    --disable-nls \
+    --enable-clocale=gnu \
+    --enable-libstdcxx-backtrace=yes \
+    --enable-libstdcxx-debug \
+    --enable-libstdcxx-time=yes \
+    --with-default-libstdcxx-abi=new \
+    --enable-gnu-unique-object \
+    --disable-vtable-verify \
+    --enable-plugin \
+    --enable-default-pie \
+    --with-system-zlib \
+    --enable-libphobos-checking=release \
+    --with-target-system-zlib=auto \
+    --disable-werror \
+    --enable-cet \
+    --disable-multilib \
+    --without-cuda-driver \
+    --enable-checking=release \
+    && make -j`nproc` \
+    && make install-strip DESTDIR=/gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION \
+    && mkdir -p /gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION/usr/share/gdb/auto-load/usr/lib64 \
+    && mv /gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION/usr/lib64/libstdc++.so.6.0.30-gdb.py /gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION/usr/share/gdb/auto-load/usr/lib64/libstdc++.so.6.0.30-gdb.py
+
+# Generate deb
+WORKDIR /
+COPY control.m4 /
+COPY ld.so.conf /gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION/etc/ld.so.conf.d/1-gcc-12.conf
+
+RUN mkdir /gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION/DEBIAN \
+    && m4 -P -DUBUNTU_VERSION=$UBUNTU_VERSION -DVERSION=$GCC_VERSION-$BUILD_VERSION -DTARGETARCH=$TARGETARCH control.m4 > /gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION/DEBIAN/control \
+    && dpkg-deb --build --root-owner-group /gcc-$GCC_VERSION-$BUILD_VERSION-ubuntu-$UBUNTU_VERSION /gcc12.deb
+
+# Create final image
+FROM ubuntu:focal as gcc
+COPY --from=build /gcc12.deb /
+
+# Make gcc-12 available but also leave gcc12.deb for others to copy if needed
+RUN apt update && apt-get install -y binutils libc6-dev \
+    && dpkg -i /gcc12.deb 
+
+RUN update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-12 100 \
+    && update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-12 100 \
+    && update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 100 \
+    && update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-12 100 \
+    && update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-12 100 \
+    && update-alternatives --install /usr/bin/gcov-dump gcov-dump /usr/bin/gcov-dump-12 100 \
+    && update-alternatives --install /usr/bin/gcov-tool gcov-tool /usr/bin/gcov-tool-12 100

docker/compilers/gcc-12/ld.so.conf

@@ -0,0 +1,2 @@
+# Path to the directory containing libstdc++.so.6
+/usr/lib64

docker/develop/compose.yaml

@@ -0,0 +1,16 @@
+version: '3.7'
+services:
+  clio_develop:
+    image: rippleci/clio_ci:latest
+    volumes:
+      - clio_develop_conan_data:/root/.conan/data
+      - clio_develop_ccache:/root/.ccache
+      - ../../:/root/clio
+      - clio_develop_build:/root/clio/build_docker
+    working_dir: /root/clio/build_docker
+    tty: true
+
+volumes:
+  clio_develop_conan_data:
+  clio_develop_ccache:
+  clio_develop_build:

docker/develop/run

@@ -0,0 +1,62 @@
+#!/bin/bash
+
+script_dir=$(dirname $0)
+
+pushd $script_dir > /dev/null
+
+function start_container {
+    if [ -z "$(docker ps -q -f name=clio_develop)" ]; then
+        docker compose up -d
+    fi
+}
+
+function run {
+    start_container
+    docker compose exec clio_develop "$@"
+}
+
+function stop_container {
+    docker compose down
+}
+
+function open_terminal {
+    start_container
+    docker compose exec clio_develop /bin/bash
+}
+
+function print_help {
+    cat <<EOF
+run: Run a command inside the development container.
+
+Usage:
+    run [options or command]
+
+If no options are provided, the command will be executed inside the container.
+
+Options:
+-h, --help      Show this help message and exit.
+-t, --terminal  Open a terminal inside the container.
+-s, --stop      Stop the container.
+EOF
+}
+
+case $1 in
+    -h|--help)
+        print_help ;;
+
+    -t|--terminal)
+        open_terminal ;;
+
+    -s|--stop)
+        stop_container ;;
+
+    -*)
+        echo "Unknown option: $1"
+        print_help ;;
+
+    *)
+        run "$@" ;;
+esac
+
+popd > /dev/null
+

docker/shared/build_boost.sh

@@ -1,13 +0,0 @@
-#!/usr/bin/env bash
-set -exu
-
-#yum install wget lz4 lz4-devel git llvm13-static.x86_64 llvm13-devel.x86_64 devtoolset-11-binutils zlib-static
-# it's either those or link=static that halves the failures. probably link=static
-BOOST_VERSION=$1
-BOOST_VERSION_=$(echo ${BOOST_VERSION} | tr . _)
-echo "BOOST_VERSION: ${BOOST_VERSION}"
-echo "BOOST_VERSION_: ${BOOST_VERSION_}"
-curl -OJLs "https://boostorg.jfrog.io/artifactory/main/release/${BOOST_VERSION}/source/boost_${BOOST_VERSION_}.tar.gz"
-tar zxf "boost_${BOOST_VERSION_}.tar.gz"
-cd boost_${BOOST_VERSION_} && ./bootstrap.sh && ./b2 --without-python link=static -j$(nproc)
-mkdir -p /boost && mv boost /boost && mv stage /boost

docker/shared/install_cmake.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-set -eo pipefail
-
-CMAKE_VERSION=${1:-"3.16.3"}
-cd /tmp
-URL="https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-linux-x86_64.tar.gz"
-curl -OJLs $URL
-tar xzvf cmake-${CMAKE_VERSION}-Linux-x86_64.tar.gz
-mv cmake-${CMAKE_VERSION}-Linux-x86_64 /opt/
-ln -s /opt/cmake-${CMAKE_VERSION}-Linux-x86_64/bin/cmake /usr/local/bin/cmake

docker/shared/install_openssl.sh

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-set -e

docker/ubuntu/Dockerfile

@@ -1,24 +0,0 @@
-FROM ubuntu:20.04 AS boost
-
-RUN apt-get update && apt-get install -y build-essential
-ARG BOOST_VERSION_=1_75_0
-ARG BOOST_VERSION=1.75.0
-COPY docker/shared/build_boost.sh .
-RUN apt install -y curl
-RUN ./build_boost.sh ${BOOST_VERSION}
-ENV BOOST_ROOT=/boost
-
-FROM ubuntu:20.04 AS build
-ENV BOOST_ROOT=/boost
-COPY --from=boost /boost /boost
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get update && apt-get install --no-install-recommends -y build-essential software-properties-common pkg-config libssl-dev wget curl gpg git zlib1g-dev bison flex autoconf lsb-release
-RUN apt install -y gpg-agent
-RUN wget https://apt.llvm.org/llvm.sh
-RUN chmod +x llvm.sh && ./llvm.sh 14 && ./llvm.sh 15
-# COPY . /clio
-## Install cmake
-ARG CMAKE_VERSION=3.16.3
-COPY docker/shared/install_cmake.sh .
-RUN ./install_cmake.sh ${CMAKE_VERSION}
-ENV PATH="/opt/local/cmake/bin:$PATH"

docs/CMakeLists.txt

@@ -0,0 +1,8 @@
+cmake_minimum_required(VERSION 3.20)
+project(docs)
+
+include(${CMAKE_CURRENT_SOURCE_DIR}/../cmake/ClioVersion.cmake)
+
+# Generate `docs` target for doxygen documentation
+# Note: use `cmake --build . --target docs` from your `build` directory to generate the documentation
+include(${CMAKE_CURRENT_SOURCE_DIR}/../cmake/Docs.cmake)

docs/Doxyfile

@@ -0,0 +1,44 @@
+PROJECT_NAME           = "Clio"
+PROJECT_LOGO           = ${SOURCE}/docs/img/xrpl-logo.svg
+PROJECT_NUMBER         = ${DOC_CLIO_VERSION}
+PROJECT_BRIEF          = The XRP Ledger API server.
+
+EXTRACT_ALL            = NO
+EXTRACT_PRIVATE        = NO
+EXTRACT_PACKAGE        = YES
+EXTRACT_STATIC         = YES
+EXTRACT_LOCAL_CLASSES  = NO
+EXTRACT_ANON_NSPACES   = NO
+
+SORT_MEMBERS_CTORS_1ST = YES
+
+INPUT                  = ${SOURCE}/src
+EXCLUDE_SYMBOLS        = ${EXCLUDES}
+RECURSIVE              = YES
+HAVE_DOT               = ${USE_DOT}
+
+QUIET                  = YES
+WARNINGS               = ${LINT}
+WARN_NO_PARAMDOC       = ${LINT}
+WARN_IF_INCOMPLETE_DOC = ${LINT}
+WARN_IF_UNDOCUMENTED   = ${LINT}
+
+GENERATE_LATEX         = NO
+GENERATE_HTML          = YES
+
+SORT_MEMBERS_CTORS_1ST = YES
+
+GENERATE_TREEVIEW      = YES
+DISABLE_INDEX          = NO
+FULL_SIDEBAR           = NO
+HTML_HEADER            = ${SOURCE}/docs/doxygen-awesome-theme/header.html
+HTML_EXTRA_STYLESHEET  = ${SOURCE}/docs/doxygen-awesome-theme/doxygen-awesome.css \
+                         ${SOURCE}/docs/doxygen-awesome-theme/doxygen-awesome-sidebar-only.css \
+                         ${SOURCE}/docs/doxygen-awesome-theme/doxygen-awesome-sidebar-only-darkmode-toggle.css 
+HTML_EXTRA_FILES       = ${SOURCE}/docs/doxygen-awesome-theme/doxygen-awesome-darkmode-toggle.js \
+                         ${SOURCE}/docs/doxygen-awesome-theme/doxygen-awesome-interactive-toc.js
+
+HTML_COLORSTYLE        = LIGHT
+HTML_COLORSTYLE_HUE    = 209
+HTML_COLORSTYLE_SAT    = 255
+HTML_COLORSTYLE_GAMMA  = 113

docs/build-clio.md

@@ -0,0 +1,143 @@
+# How to build Clio
+
+Clio is built with [CMake](https://cmake.org/) and uses [Conan](https://conan.io/) for managing dependencies. It is written in C++20 and therefore requires a modern compiler.
+
+## Minimum Requirements
+
+- [Python 3.7](https://www.python.org/downloads/)
+- [Conan 1.55](https://conan.io/downloads.html)
+- [CMake 3.20](https://cmake.org/download/)
+- [**Optional**] [GCovr](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html): needed for code coverage generation
+- [**Optional**] [CCache](https://ccache.dev/): speeds up compilation if you are going to compile Clio often
+
+| Compiler    | Version |
+|-------------|---------|
+| GCC         | 12.3    |
+| Clang       | 16      |
+| Apple Clang | 15      |
+
+### Conan Configuration
+
+Clio does not require anything other than `compiler.cppstd=20` in your (`~/.conan/profiles/default`) Conan profile.
+
+> [!NOTE]
+> Although Clio is built using C++23, it's required to set `compiler.cppstd=20` for the time being as some of Clio's dependencies are not yet capable of building under C++23.
+
+> Mac example:
+
+```
+[settings]
+os=Macos
+os_build=Macos
+arch=armv8
+arch_build=armv8
+compiler=apple-clang
+compiler.version=15
+compiler.libcxx=libc++
+build_type=Release
+compiler.cppstd=20
+[conf]
+tools.build:cxxflags+=["-DBOOST_ASIO_DISABLE_CONCEPTS"]
+```
+
+> Linux example:
+
+```
+[settings]
+os=Linux
+os_build=Linux
+arch=x86_64
+arch_build=x86_64
+compiler=gcc
+compiler.version=12
+compiler.libcxx=libstdc++11
+build_type=Release
+compiler.cppstd=20
+```
+
+#### Artifactory
+
+Make sure artifactory is setup with Conan.
+
+```sh
+conan remote add --insert 0 conan-non-prod http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod
+```
+
+Now you should be able to download the prebuilt `xrpl` package on some platforms.
+
+> [!NOTE]
+> You may need to edit the `~/.conan/remotes.json` file to ensure that this newly added artifactory is listed last. Otherwise, you could see compilation errors when building the project with gcc version 13 (or newer).
+
+Remove old packages you may have cached.
+
+```sh
+conan remove -f xrpl
+```
+
+## Building Clio
+
+Navigate to Clio's root directory and run:
+
+```sh
+mkdir build && cd build
+conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False
+cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
+cmake --build . --parallel 8 # or without the number if you feel extra adventurous
+```
+
+> [!TIP]
+> You can omit the `-o tests=True` if you don't want to build `clio_tests`.
+
+If successful, `conan install` will find the required packages and `cmake` will do the rest. You should see `clio_server` and `clio_tests` in the `build` directory (the current directory).
+
+> [!TIP]
+> To generate a Code Coverage report, include `-o coverage=True` in the `conan install` command above, along with `-o tests=True` to enable tests. After running the `cmake` commands, execute `make clio_tests-ccov`. The coverage report will be found at `clio_tests-llvm-cov/index.html`.
+
+> [!NOTE]
+> If you've built Clio before and the build is now failing, it's likely due to updated dependencies. Try deleting the build folder and then rerunning the Conan and CMake commands mentioned above.
+
+### Generating API docs for Clio
+
+The API documentation for Clio is generated by [Doxygen](https://www.doxygen.nl/index.html). If you want to generate the API documentation when building Clio, make sure to install Doxygen on your system.
+
+To generate the API docs:
+
+1. First, include `-o docs=True` in the conan install command. For example:
+
+    ```sh
+    mkdir build && cd build
+    conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False -o docs=True
+    ```
+
+2. Once that has completed successfully, run the `cmake` command and add the `--target docs` option:
+
+   ```sh
+   cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
+   cmake --build . --parallel 8 --target docs
+   ```
+
+3. Go to `build/docs/html` to view the generated files.
+
+    Open the `index.html` file in your browser to see the documentation pages.
+
+    ![API index page](./img/doxygen-docs-output.png "API index page")
+
+## Building Clio with Docker
+
+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 rippleci/clio_ci:latest
+git clone https://github.com/XRPLF/clio
+mkdir build && cd build
+conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False
+cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
+cmake --build . --parallel 8 # or without the number if you feel extra adventurous
+```
+
+## Developing against `rippled` in standalone mode
+
+If you wish to develop against a `rippled` instance running in standalone mode there are a few quirks of both Clio and `rippled` that you need to keep in mind. You must:
+
+1. Advance the `rippled` ledger to at least ledger 256.
+2. Wait 10 minutes before first starting Clio against this standalone node.