[CI] clang-tidy auto fixes

Fix: https://github.com/XRPLF/clio/issues/910

.clang-format

@@ -1,5 +1,5 @@
 ---
-Language:        Cpp
+Language: Cpp
 AccessModifierOffset: -4
 AlignAfterOpenBracket: BlockIndent
 AlignConsecutiveAssignments: false
@@ -22,31 +22,31 @@ BreakBeforeBinaryOperators: false
 BreakBeforeBraces: WebKit
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializersBeforeComma: true
-ColumnLimit:     120
-CommentPragmas:  '^ IWYU pragma:'
+ColumnLimit: 120
+CommentPragmas: "^ IWYU pragma:"
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
 ConstructorInitializerIndentWidth: 4
 ContinuationIndentWidth: 4
 Cpp11BracedListStyle: true
 DerivePointerAlignment: false
-DisableFormat:   false
+DisableFormat: false
 ExperimentalAutoDetectBinPacking: false
 FixNamespaceComments: true
-ForEachMacros:   [ Q_FOREACH,  BOOST_FOREACH ]
+ForEachMacros: [Q_FOREACH, BOOST_FOREACH]
 IncludeBlocks: Regroup
 IncludeCategories:
-  - Regex:           '^".*"$'
-    Priority:        1
-  - Regex:           '^<.*\.(h|hpp)>$'
-    Priority:        2
-  - Regex:           '^<.*>$'
-    Priority:        3
-  - Regex:           '.*'
-    Priority:        4
-IncludeIsMainRegex: '$'
+  - Regex: '^".*"$'
+    Priority: 1
+  - Regex: '^<.*\.(h|hpp)>$'
+    Priority: 2
+  - Regex: "^<.*>$"
+    Priority: 3
+  - Regex: ".*"
+    Priority: 4
+IncludeIsMainRegex: "$"
 IndentCaseLabels: true
 IndentFunctionDeclarationAfterType: false
-IndentWidth:     4
+IndentWidth: 4
 IndentWrappedFunctionNames: false
 IndentRequiresClause: true
 RequiresClausePosition: OwnLine
@@ -63,18 +63,18 @@ PenaltyExcessCharacter: 1000000
 PenaltyReturnTypeOnItsOwnLine: 200
 PointerAlignment: Left
 QualifierAlignment: Right
-ReflowComments:  true
-SortIncludes:    true
+ReflowComments: true
+SortIncludes: true
 SpaceAfterCStyleCast: false
 SpaceBeforeAssignmentOperators: true
 SpaceBeforeParens: ControlStatements
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
-SpacesInAngles:  false
+SpacesInAngles: false
 SpacesInContainerLiterals: true
 SpacesInCStyleCastParentheses: false
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
-Standard:        Cpp11
-TabWidth:        8
-UseTab:          Never
+Standard: Cpp11
+TabWidth: 8
+UseTab: Never

.clang-tidy

@@ -1,5 +1,5 @@
 ---
-Checks: '-*,
+Checks: "-*,
   bugprone-argument-comment,
   bugprone-assert-side-effect,
   bugprone-bad-signal-to-kill-thread,
@@ -8,6 +8,7 @@ Checks: '-*,
   bugprone-chained-comparison,
   bugprone-compare-pointer-to-member-virtual-function,
   bugprone-copy-constructor-init,
+  bugprone-crtp-constructor-accessibility,
   bugprone-dangling-handle,
   bugprone-dynamic-static-initializers,
   bugprone-empty-catch,
@@ -33,9 +34,11 @@ Checks: '-*,
   bugprone-non-zero-enum-to-bool-conversion,
   bugprone-optional-value-conversion,
   bugprone-parent-virtual-call,
+  bugprone-pointer-arithmetic-on-polymorphic-object,
   bugprone-posix-return,
   bugprone-redundant-branch-condition,
   bugprone-reserved-identifier,
+  bugprone-return-const-ref-from-parameter,
   bugprone-shared-ptr-array-mismatch,
   bugprone-signal-handler,
   bugprone-signed-char-misuse,
@@ -55,6 +58,7 @@ Checks: '-*,
   bugprone-suspicious-realloc-usage,
   bugprone-suspicious-semicolon,
   bugprone-suspicious-string-compare,
+  bugprone-suspicious-stringview-data-usage,
   bugprone-swapped-arguments,
   bugprone-switch-missing-default-case,
   bugprone-terminating-continue,
@@ -97,10 +101,12 @@ Checks: '-*,
   modernize-make-unique,
   modernize-pass-by-value,
   modernize-type-traits,
+  modernize-use-designated-initializers,
   modernize-use-emplace,
   modernize-use-equals-default,
   modernize-use-equals-delete,
   modernize-use-override,
+  modernize-use-ranges,
   modernize-use-starts-ends-with,
   modernize-use-std-numbers,
   modernize-use-using,
@@ -121,9 +127,12 @@ Checks: '-*,
   readability-convert-member-functions-to-static,
   readability-duplicate-include,
   readability-else-after-return,
+  readability-enum-initial-value,
   readability-implicit-bool-conversion,
   readability-inconsistent-declaration-parameter-name,
+  readability-identifier-naming,
   readability-make-member-function-const,
+  readability-math-missing-parentheses,
   readability-misleading-indentation,
   readability-non-const-parameter,
   readability-redundant-casting,
@@ -135,14 +144,48 @@ Checks: '-*,
   readability-simplify-boolean-expr,
   readability-static-accessed-through-instance,
   readability-static-definition-in-anonymous-namespace,
-  readability-suspicious-call-argument
-  '
+  readability-suspicious-call-argument,
+  readability-use-std-min-max
+  "
 
 CheckOptions:
   readability-braces-around-statements.ShortStatementLines: 2
+  readability-identifier-naming.MacroDefinitionCase: UPPER_CASE
+  readability-identifier-naming.ClassCase: CamelCase
+  readability-identifier-naming.StructCase: CamelCase
+  readability-identifier-naming.UnionCase: CamelCase
+  readability-identifier-naming.EnumCase: CamelCase
+  readability-identifier-naming.EnumConstantCase: CamelCase
+  readability-identifier-naming.ScopedEnumConstantCase: CamelCase
+  readability-identifier-naming.GlobalConstantCase: UPPER_CASE
+  readability-identifier-naming.GlobalConstantPrefix: "k"
+  readability-identifier-naming.GlobalVariableCase: CamelCase
+  readability-identifier-naming.GlobalVariablePrefix: "g"
+  readability-identifier-naming.ConstexprFunctionCase: camelBack
+  readability-identifier-naming.ConstexprMethodCase: camelBack
+  readability-identifier-naming.ClassMethodCase: camelBack
+  readability-identifier-naming.ClassMemberCase: camelBack
+  readability-identifier-naming.ClassConstantCase: UPPER_CASE
+  readability-identifier-naming.ClassConstantPrefix: "k"
+  readability-identifier-naming.StaticConstantCase: UPPER_CASE
+  readability-identifier-naming.StaticConstantPrefix: "k"
+  readability-identifier-naming.StaticVariableCase: UPPER_CASE
+  readability-identifier-naming.StaticVariablePrefix: "k"
+  readability-identifier-naming.ConstexprVariableCase: UPPER_CASE
+  readability-identifier-naming.ConstexprVariablePrefix: "k"
+  readability-identifier-naming.LocalConstantCase: camelBack
+  readability-identifier-naming.LocalVariableCase: camelBack
+  readability-identifier-naming.TemplateParameterCase: CamelCase
+  readability-identifier-naming.ParameterCase: camelBack
+  readability-identifier-naming.FunctionCase: camelBack
+  readability-identifier-naming.MemberCase: camelBack
+  readability-identifier-naming.PrivateMemberSuffix: _
+  readability-identifier-naming.ProtectedMemberSuffix: _
+  readability-identifier-naming.PublicMemberSuffix: ""
+  readability-identifier-naming.FunctionIgnoredRegexp: ".*tag_invoke.*"
   bugprone-unsafe-functions.ReportMoreUnsafeFunctions: true
   bugprone-unused-return-value.CheckedReturnTypes: ::std::error_code;::std::error_condition;::std::errc
-  misc-include-cleaner.IgnoreHeaders: '.*/(detail|impl)/.*;.*(expected|unexpected).*'
+  misc-include-cleaner.IgnoreHeaders: '.*/(detail|impl)/.*;.*(expected|unexpected).*;.*ranges_lower_bound\.h;time.h;stdlib.h;__chrono/.*;fmt/chrono.h;boost/uuid/uuid_hash.hpp'
 
 HeaderFilterRegex: '^.*/(src|tests)/.*\.(h|hpp)$'
-WarningsAsErrors: '*'
+WarningsAsErrors: "*"

.clangd

@@ -8,3 +8,6 @@ Diagnostics:
     IgnoreHeader:
       - ".*/(detail|impl)/.*"
       - ".*expected.*"
+      - ".*ranges_lower_bound.h"
+      - "time.h"
+      - "stdlib.h"

.cmake-format.yaml

@@ -1,222 +1,222 @@
 _help_parse: Options affecting listfile parsing
 parse:
   _help_additional_commands:
-  - Specify structure for custom cmake functions
+    - Specify structure for custom cmake functions
   additional_commands:
     foo:
       flags:
-      - BAR
-      - BAZ
+        - BAR
+        - BAZ
       kwargs:
-        HEADERS: '*'
-        SOURCES: '*'
-        DEPENDS: '*'
+        HEADERS: "*"
+        SOURCES: "*"
+        DEPENDS: "*"
   _help_override_spec:
-  - Override configurations per-command where available
+    - Override configurations per-command where available
   override_spec: {}
   _help_vartags:
-  - Specify variable tags.
+    - Specify variable tags.
   vartags: []
   _help_proptags:
-  - Specify property tags.
+    - Specify property tags.
   proptags: []
 _help_format: Options affecting formatting.
 format:
   _help_disable:
-  - Disable formatting entirely, making cmake-format a no-op
+    - Disable formatting entirely, making cmake-format a no-op
   disable: false
   _help_line_width:
-  - How wide to allow formatted cmake files
+    - How wide to allow formatted cmake files
   line_width: 120
   _help_tab_size:
-  - How many spaces to tab for indent
+    - 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>
+    - 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
+    - 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.
+    - 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.
+    - 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)
+    - 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
+    - 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
+    - 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.
+    - 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
+    - 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.
+    - 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.
+    - 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.
+    - 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.
+    - What style line endings to use in the output.
   line_ending: unix
   _help_command_case:
-  - Format command names consistently as 'lower' or 'upper' case
+    - Format command names consistently as 'lower' or 'upper' case
   command_case: canonical
   _help_keyword_case:
-  - Format keywords consistently as 'lower' or 'upper' 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
+    - 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
+    - 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).
+    - 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
+    - By default, if cmake-format cannot successfully fit
+    - everything into the desired linewidth it will apply the
+    - last, most aggressive attempt that it made. If this flag is
+    - True, however, cmake-format will print error, exit with non-
+    - zero status code, and write-out nothing
   require_valid_layout: false
   _help_layout_passes:
-  - A dictionary mapping layout nodes to a list of wrap
-  - decisions. See the documentation for more information.
+    - 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: '*'
+    - What character to use for bulleted lists
+  bullet_char: "*"
   _help_enum_char:
-  - What character to use as punctuation after numerals in an
-  - enumerated list
+    - 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.
+    - 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).
+    - 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}[`~]*)(.*)$'``
+    - 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}$''``'
+    - 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: '#<'
+    - If a comment line matches starts with this pattern then it
+    - is explicitly a trailing comment for the preceding
+    - argument. Default is '#<'
+  explicit_trailing_pattern: "#<"
   _help_hashruler_min_length:
-  - If a comment line starts with at least this many consecutive
-  - hash characters, then don't lstrip() them off. This allows
-  - for lazy hash rulers where the first hash char is not
-  - separated by space
+    - 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
+    - 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 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
+    - a list of lint codes to disable
   disabled_codes: []
   _help_function_pattern:
-  - regular expression pattern describing valid function names
-  function_pattern: '[0-9a-z_]+'
+    - 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_]+'
+    - 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_]+'
+    - 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)
+    - 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_]+'
+    - 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
+    - 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_]+'
+    - 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_]+'
+    - 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_]+'
+    - 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.
+    - 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
+    - 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
+    - Require no more than this many newlines between statements
   max_statement_spacing: 2
   max_returns: 6
   max_branches: 12
@@ -226,20 +226,20 @@ lint:
 _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
+    - 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
+    - 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
+    - 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.
+    - A dictionary containing any per-command configuration
+    - overrides. Currently only `command_case` is supported.
   per_command: {}

.codecov.yml

@@ -9,3 +9,14 @@ coverage:
       default:
         target: 20% # Need to bump this number https://docs.codecov.com/docs/commit-status#patch-status
         threshold: 2%
+
+# `codecov/codecov-action` reruns `gcovr` if build files present
+# That's why we run it in a separate workflow
+# This ignore list is not currently used
+#
+# More info: https://github.com/XRPLF/clio/pull/2066
+ignore:
+  - "tests"
+  - "src/data/cassandra/"
+  - "src/data/CassandraBackend.hpp"
+  - "src/data/BackendFactory.*"

.githooks/check-format

@@ -1,105 +0,0 @@
-#!/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/pre-commit

@@ -1,8 +0,0 @@
-#!/bin/bash
-
-# This script is intended to be run from the root of the repository.
-
-source .githooks/check-format
-#source .githooks/check-docs
-
-# TODO: Fix Doxygen issue with reference links. See https://github.com/XRPLF/clio/issues/1431

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,29 +3,34 @@ name: Bug report
 about: Create a report to help us improve
 title: "[Title with short description] (Version: [Clio version])"
 labels: bug
-assignees: ''
-
+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

@@ -3,21 +3,24 @@ name: Feature request
 about: Suggest an idea for this project
 title: "[Title with short description] (Version: [Clio version])"
 labels: enhancement
-assignees: ''
-
+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

@@ -3,8 +3,7 @@ name: Question
 about: A question in form of an issue
 title: "[Title with short description] (Version: Clio version)"
 labels: question
-assignees: ''
-
+assignees: ""
 ---
 
 <!-- Please search existing issues to avoid creating duplicates. -->
@@ -12,7 +11,9 @@ assignees: ''
 <!-- 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/build_clio/action.yml

@@ -1,18 +1,29 @@
 name: Build clio
 description: Build clio in build directory
+
 inputs:
-  target:
-    description: Build target name
+  targets:
+    description: Space-separated build target names
     default: all
+  subtract_threads:
+    description: An option for the action get_number_of_threads. See get_number_of_threads
+    required: true
+    default: "0"
+
 runs:
   using: composite
   steps:
     - name: Get number of threads
       uses: ./.github/actions/get_number_of_threads
       id: number_of_threads
+      with:
+        subtract_threads: ${{ inputs.subtract_threads }}
 
-    - name: Build Clio
+    - name: Build targets
       shell: bash
       run: |
         cd build
-        cmake --build . --parallel ${{ steps.number_of_threads.outputs.threads_number }} --target ${{ inputs.target }}
+        cmake \
+          --build . \
+          --parallel ${{ steps.number_of_threads.outputs.threads_number }} \
+          --target ${{ inputs.targets }}

.github/actions/build_docker_image/action.yml

@@ -0,0 +1,72 @@
+name: Build and push Docker image
+description: Build and push Docker image to DockerHub and GitHub Container Registry
+
+inputs:
+  images:
+    description: Name of the images to use as a base name
+    required: true
+  dockerhub_repo:
+    description: DockerHub repository name
+    required: true
+  push_image:
+    description: Whether to push the image to the registry (true/false)
+    required: true
+  directory:
+    description: The directory containing the Dockerfile
+    required: true
+  tags:
+    description: Comma separated tags to apply to the image
+    required: true
+  platforms:
+    description: Platforms to build the image for (e.g. linux/amd64,linux/arm64)
+    required: true
+  description:
+    description: Short description of the image
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Login to DockerHub
+      if: ${{ inputs.push_image == 'true' }}
+      uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
+      with:
+        username: ${{ env.DOCKERHUB_USER }}
+        password: ${{ env.DOCKERHUB_PW }}
+
+    - name: Login to GitHub Container Registry
+      if: ${{ inputs.push_image == 'true' }}
+      uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
+      with:
+        registry: ghcr.io
+        username: ${{ github.repository_owner }}
+        password: ${{ env.GITHUB_TOKEN }}
+
+    - uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
+      with:
+        cache-image: false
+    - uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0
+
+    - uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0
+      id: meta
+      with:
+        images: ${{ inputs.images }}
+        tags: ${{ inputs.tags }}
+
+    - name: Build and push
+      uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
+      with:
+        context: ${{ inputs.directory }}
+        platforms: ${{ inputs.platforms }}
+        push: ${{ inputs.push_image == 'true' }}
+        tags: ${{ steps.meta.outputs.tags }}
+
+    - name: Update DockerHub description
+      if: ${{ inputs.push_image == 'true' }}
+      uses: peter-evans/dockerhub-description@432a30c9e07499fd01da9f8a49f0faf9e0ca5b77 # v4.0.2
+      with:
+        username: ${{ env.DOCKERHUB_USER }}
+        password: ${{ env.DOCKERHUB_PW }}
+        repository: ${{ inputs.dockerhub_repo }}
+        short-description: ${{ inputs.description }}
+        readme-filepath: ${{ inputs.directory }}/README.md

.github/actions/code_coverage/action.yml

@@ -1,21 +1,26 @@
 name: Generate code coverage report
 description: Run tests, generate code coverage report and upload it to codecov.io
+
 runs:
   using: composite
+
   steps:
     - name: Run tests
       shell: bash
       run: |
         build/clio_tests
 
+    # Please keep exclude list in sync with .codecov.yml
     - name: Run gcovr
       shell: bash
       run: |
-        gcovr -e tests \
+        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
+          --xml build/coverage_report.xml \
+          -j8 --exclude-throw-branches
 
     - name: Archive coverage report
       uses: actions/upload-artifact@v4

.github/actions/create_issue/action.yml

@@ -1,5 +1,6 @@
 name: Create an issue
 description: Create an issue
+
 inputs:
   title:
     description: Issue title
@@ -10,26 +11,31 @@ inputs:
   labels:
     description: Comma-separated list of labels
     required: true
-    default: 'bug'
+    default: "bug"
   assignees:
     description: Comma-separated list of assignees
     required: true
-    default: 'cindyyan317,godexsoft,kuznetsss'
+    default: "godexsoft,kuznetsss,PeterChen13579"
+
 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
-
-
+    - 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

@@ -1,5 +1,6 @@
 name: Run conan and cmake
 description: Run conan and cmake
+
 inputs:
   conan_profile:
     description: Conan profile name
@@ -7,19 +8,37 @@ inputs:
   conan_cache_hit:
     description: Whether conan cache has been downloaded
     required: true
-    default: 'false'
+    default: "false"
   build_type:
     description: Build type for third-party libraries and clio. Could be 'Release', 'Debug'
     required: true
-    default: 'Release'
+    default: "Release"
+  build_integration_tests:
+    description: Whether to build integration tests
+    required: true
+    default: "true"
   code_coverage:
     description: Whether conan's coverage option should be on or not
     required: true
-    default: 'false'
+    default: "false"
   static:
     description: Whether Clio is to be statically linked
     required: true
-    default: 'false'
+    default: "false"
+  sanitizer:
+    description: Sanitizer to use
+    required: true
+    default: "false"
+    choices:
+      - "false"
+      - "tsan"
+      - "asan"
+      - "ubsan"
+  time_trace:
+    description: Whether to enable compiler trace reports
+    required: true
+    default: "false"
+
 runs:
   using: composite
   steps:
@@ -33,14 +52,37 @@ runs:
         BUILD_OPTION: "${{ inputs.conan_cache_hit == 'true' && 'missing' || '' }}"
         CODE_COVERAGE: "${{ inputs.code_coverage == 'true' && 'True' || 'False' }}"
         STATIC_OPTION: "${{ inputs.static == 'true' && 'True' || 'False' }}"
+        INTEGRATION_TESTS_OPTION: "${{ inputs.build_integration_tests == 'true' && 'True' || 'False' }}"
+        TIME_TRACE: "${{ inputs.time_trace == 'true' && 'True' || 'False' }}"
       run: |
         cd build
-        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 }}
+        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="${INTEGRATION_TESTS_OPTION}" \
+          -o clio:lint=False \
+          -o clio:coverage="${CODE_COVERAGE}" \
+          -o clio:time_trace="${TIME_TRACE}" \
+          --profile ${{ inputs.conan_profile }}
 
     - name: Run cmake
       shell: bash
       env:
         BUILD_TYPE: "${{ inputs.build_type }}"
+        SANITIZER_OPTION: |
+          ${{ inputs.sanitizer == 'tsan' && '-Dsan=thread' ||
+              inputs.sanitizer == 'ubsan' && '-Dsan=undefined' ||
+              inputs.sanitizer == 'asan' && '-Dsan=address' ||
+              '' }}
       run: |
         cd build
-        cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=${{ inputs.build_type }} ${{ inputs.extra_cmake_args }} .. -G Ninja
+        cmake \
+          -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake \
+          -DCMAKE_BUILD_TYPE="${BUILD_TYPE}" \
+          ${SANITIZER_OPTION} \
+          .. \
+          -G Ninja

.github/actions/get_number_of_threads/action.yml

@@ -1,9 +1,16 @@
 name: Get number of threads
 description: Determines number of threads to use on macOS and Linux
+
+inputs:
+  subtract_threads:
+    description: How many threads to subtract from the calculated number
+    required: true
+    default: "0"
 outputs:
   threads_number:
     description: Number of threads to use
     value: ${{ steps.number_of_threads_export.outputs.num }}
+
 runs:
   using: composite
   steps:
@@ -19,8 +26,11 @@ runs:
       shell: bash
       run: echo "num=$(($(nproc) - 2))" >> $GITHUB_OUTPUT
 
-    - name: Export output variable
-      shell: bash
+    - name: Shift and export number of threads
       id: number_of_threads_export
+      shell: bash
       run: |
-        echo "num=${{ steps.mac_threads.outputs.num || steps.linux_threads.outputs.num }}" >> $GITHUB_OUTPUT
+        num_of_threads=${{ steps.mac_threads.outputs.num || steps.linux_threads.outputs.num }}
+        shift_by=${{ inputs.subtract_threads }}
+        shifted=$((num_of_threads - shift_by))
+        echo "num=$(( shifted > 1 ? shifted : 1 ))" >> $GITHUB_OUTPUT

.github/actions/git_common_ancestor/action.yml

@@ -1,9 +1,11 @@
 name: Git common ancestor
 description: Find the closest common commit
+
 outputs:
   commit:
     description: Hash of commit
     value: ${{ steps.find_common_ancestor.outputs.commit }}
+
 runs:
   using: composite
   steps:

.github/actions/prepare_runner/action.yml

@@ -1,9 +1,11 @@
 name: Prepare runner
 description: Install packages, set environment variables, create directories
+
 inputs:
   disable_ccache:
     description: Whether ccache should be disabled
     required: true
+
 runs:
   using: composite
   steps:
@@ -11,8 +13,37 @@ runs:
       if: ${{ runner.os == 'macOS' }}
       shell: bash
       run: |
-          brew install llvm@14 pkg-config ninja bison cmake ccache jq gh conan@1
-          echo "/opt/homebrew/opt/conan@1/bin" >> $GITHUB_PATH
+        brew install \
+          bison \
+          ca-certificates \
+          ccache \
+          clang-build-analyzer \
+          conan@1 \
+          gh \
+          jq \
+          llvm@14 \
+          ninja \
+          pkg-config
+        echo "/opt/homebrew/opt/conan@1/bin" >> $GITHUB_PATH
+
+    - name: Install CMake 3.31.6 on mac
+      if: ${{ runner.os == 'macOS' }}
+      shell: bash
+      run: |
+        # Uninstall any existing cmake
+        brew uninstall cmake --ignore-dependencies || true
+
+        # Download specific cmake formula
+        FORMULA_URL="https://raw.githubusercontent.com/Homebrew/homebrew-core/b4e46db74e74a8c1650b38b1da222284ce1ec5ce/Formula/c/cmake.rb"
+        FORMULA_EXPECTED_SHA256="c7ec95d86f0657638835441871e77541165e0a2581b53b3dd657cf13ad4228d4"
+
+        mkdir -p /tmp/homebrew-formula
+        curl -s -L $FORMULA_URL -o /tmp/homebrew-formula/cmake.rb
+
+        echo "$FORMULA_EXPECTED_SHA256  /tmp/homebrew-formula/cmake.rb" | shasum -a 256 -c
+
+        # Install cmake from the specific formula with force flag
+        brew install --formula --force /tmp/homebrew-formula/cmake.rb
 
     - name: Fix git permissions on Linux
       if: ${{ runner.os == 'Linux' }}
@@ -44,5 +75,3 @@ runs:
       run: |
         mkdir -p $CCACHE_DIR
         mkdir -p $CONAN_USER_HOME/.conan
-
-

.github/actions/restore_cache/action.yml

@@ -1,5 +1,6 @@
 name: Restore cache
 description: Find and restores conan and ccache cache
+
 inputs:
   conan_dir:
     description: Path to .conan directory
@@ -17,7 +18,7 @@ inputs:
   code_coverage:
     description: Whether code coverage is on
     required: true
-    default: 'false'
+    default: "false"
 outputs:
   conan_hash:
     description: Hash to use as a part of conan cache key
@@ -28,6 +29,7 @@ outputs:
   ccache_cache_hit:
     description: True if ccache cache has been downloaded
     value: ${{ steps.ccache_cache.outputs.cache-hit }}
+
 runs:
   using: composite
   steps:

.github/actions/save_cache/action.yml

@@ -1,5 +1,6 @@
 name: Save cache
 description: Save conan and ccache cache for develop branch
+
 inputs:
   conan_dir:
     description: Path to .conan directory
@@ -28,7 +29,8 @@ inputs:
   code_coverage:
     description: Whether code coverage is on
     required: true
-    default: 'false'
+    default: "false"
+
 runs:
   using: composite
   steps:
@@ -55,5 +57,3 @@ runs:
       with:
         path: ${{ inputs.ccache_dir }}
         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,43 +1,26 @@
 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
-    value: ${{ steps.conan_export_output.outputs.conan_profile }}
+
 runs:
   using: composite
   steps:
-    - name: On mac
+    - name: Create conan profile on macOS
       if: ${{ runner.os == 'macOS' }}
       shell: bash
       env:
-        CONAN_PROFILE: apple_clang_15
-      id: conan_setup_mac
+        CONAN_PROFILE: ${{ inputs.conan_profile }}
       run: |
-        echo "Creating $CONAN_PROFILE conan profile";
+        echo "Creating $CONAN_PROFILE conan profile"
         conan profile new $CONAN_PROFILE --detect --force
         conan profile update settings.compiler.libcxx=libc++ $CONAN_PROFILE
         conan profile update settings.compiler.cppstd=20 $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
-      if: ${{ runner.os == 'Linux' }}
-      shell: bash
-      id: conan_setup_linux
-      run: |
-        echo "created_conan_profile=${{ inputs.conan_profile }}" >> $GITHUB_OUTPUT
-
-    - name: Export output variable
-      shell: bash
-      id: conan_export_output
-      run: |
-        echo "conan_profile=${{ steps.conan_setup_mac.outputs.created_conan_profile || steps.conan_setup_linux.outputs.created_conan_profile }}" >> $GITHUB_OUTPUT
 
     - name: Add conan-non-prod artifactory
       shell: bash
@@ -48,5 +31,3 @@ runs:
         else
             echo "Conan-non-prod is available"
         fi
-
-

.github/actions/test/Dockerfile

@@ -1,6 +0,0 @@
-FROM cassandra:4.0.4
-
-RUN apt-get update && apt-get install -y postgresql
-COPY entrypoint.sh /entrypoint.sh
-
-ENTRYPOINT ["/entrypoint.sh"]

.github/actions/test/entrypoint.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-
-pg_ctlcluster 12 main start
-su postgres -c"psql -c\"alter user postgres with password 'postgres'\""
-su cassandra -c "/opt/cassandra/bin/cassandra -R"
-sleep 90
-chmod +x ./clio_tests
-./clio_tests

.github/dependabot.yml

@@ -0,0 +1,157 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/build_clio/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/build_docker_image/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/code_coverage/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/create_issue/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/generate/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/get_number_of_threads/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/git_common_ancestor/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/prepare_runner/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/restore_cache/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/save_cache/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop
+
+  - package-ecosystem: github-actions
+    directory: .github/actions/setup_conan/
+    schedule:
+      interval: weekly
+      day: monday
+      time: "04:00"
+      timezone: Etc/GMT
+    reviewers:
+      - XRPLF/clio-dev-team
+    commit-message:
+      prefix: "ci: [DEPENDABOT] "
+    target-branch: develop

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

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

.github/workflows/build.yml

@@ -1,4 +1,5 @@
 name: Build
+
 on:
   push:
     branches: [master, release/*, develop]
@@ -6,212 +7,96 @@ on:
     branches: [master, release/*, develop]
   workflow_dispatch:
 
+concurrency:
+  # Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  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
+  build-and-test:
+    name: Build and Test
 
-      - 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 linter
-        id: run_linter
-        run: |
-          ./.githooks/check-docs
-        shell: bash
-
-  build:
-    name: Build
-    needs:
-      - check_format
-      - check_docs
     strategy:
       fail-fast: false
       matrix:
+        os: [heavy]
+        conan_profile: [gcc, clang]
+        build_type: [Release, Debug]
+        container: ['{ "image": "ghcr.io/xrplf/clio-ci:latest" }']
+        static: [true]
+
         include:
-          - os: heavy
-            container:
-              image: rippleci/clio_ci:latest
+          - os: macos15
+            conan_profile: default_apple_clang
             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
-            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
+            container: ""
             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: ./.github/workflows/build_and_test.yml
+    with:
+      runs_on: ${{ matrix.os }}
+      container: ${{ matrix.container }}
+      conan_profile: ${{ matrix.conan_profile }}
+      build_type: ${{ matrix.build_type }}
+      static: ${{ matrix.static }}
+      run_unit_tests: true
+      run_integration_tests: false
+      upload_clio_server: true
 
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
+  code_coverage:
+    name: Run Code Coverage
 
-      - name: Prepare runner
-        uses: ./.github/actions/prepare_runner
-        with:
-          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 }}
-
-      - 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: ${{ matrix.build_type }}
-          code_coverage: ${{ matrix.code_coverage }}
-          static: ${{ matrix.static }}
-
-      - name: Build Clio
-        uses: ./.github/actions/build_clio
-
-      - name: Show ccache's statistics
-        shell: bash
-        id: ccache_stats
-        run: |
-          ccache -s > /tmp/ccache.stats
-          miss_rate=$(cat /tmp/ccache.stats | grep 'Misses' | head -n1 | sed 's/.*(\(.*\)%).*/\1/')
-          echo "miss_rate=${miss_rate}" >> $GITHUB_OUTPUT
-          cat /tmp/ccache.stats
-
-      - name: Strip tests
-        if: ${{ !matrix.code_coverage }}
-        run: strip build/clio_tests && strip build/clio_integration_tests
-
-      - name: Upload clio_server
-        uses: actions/upload-artifact@v4
-        with:
-          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@v4
-        with:
-          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
-        with:
-          conan_dir: ${{ env.CONAN_USER_HOME }}/.conan
-          conan_hash: ${{ steps.restore_cache.outputs.conan_hash }}
-          conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }}
-          ccache_dir: ${{ env.CCACHE_DIR }}
-          ccache_cache_hit: ${{ steps.restore_cache.outputs.ccache_cache_hit }}
-          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 }}
-        uses: ./.github/actions/code_coverage
-
-  upload_coverage_report:
-    name: Codecov
-    needs: build
-    uses: ./.github/workflows/upload_coverage_report.yml
+    uses: ./.github/workflows/build_impl.yml
+    with:
+      runs_on: heavy
+      container: '{ "image": "ghcr.io/xrplf/clio-ci:latest" }'
+      conan_profile: gcc
+      build_type: Debug
+      disable_cache: false
+      code_coverage: true
+      static: true
+      upload_clio_server: false
+      targets: all
+      sanitizer: "false"
+      analyze_build_time: false
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-  test:
-    name: Run Tests
-    needs: build
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os: heavy
-            container:
-              image: rippleci/clio_ci:latest
-            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 }}
+  check_config:
+    name: Check Config Description
+    needs: build-and-test
+    runs-on: heavy
+    container:
+      image: ghcr.io/xrplf/clio-ci:latest
 
     steps:
-      - name: Clean workdir
-        if: ${{ runner.os == 'macOS' }}
-        uses: kuznetsss/workspace-cleanup@1.0
+      - uses: actions/checkout@v4
 
       - uses: actions/download-artifact@v4
         with:
-          name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}_${{ matrix.conan_profile }}
-      - name: Run clio_tests
+          name: clio_server_Linux_Release_gcc
+
+      - name: Compare Config Description
+        shell: bash
         run: |
-          chmod +x ./clio_tests
-          ./clio_tests
+          repoConfigFile=docs/config-description.md
+          if ! [ -f ${repoConfigFile} ]; then
+            echo "Config Description markdown file is missing in docs folder"
+            exit 1
+          fi
+
+          chmod +x ./clio_server
+          configDescriptionFile=config_description_new.md
+          ./clio_server -d ${configDescriptionFile}
+
+          configDescriptionHash=$(sha256sum ${configDescriptionFile} | cut -d' ' -f1)
+          repoConfigHash=$(sha256sum ${repoConfigFile} | cut -d' ' -f1)
+
+          if [ ${configDescriptionHash} != ${repoConfigHash} ]; then
+            echo "Markdown file is not up to date"
+            diff -u "${repoConfigFile}" "${configDescriptionFile}"
+            rm -f ${configDescriptionFile}
+            exit 1
+          fi
+          rm -f ${configDescriptionFile}
+          exit 0

.github/workflows/build_and_test.yml

@@ -0,0 +1,92 @@
+name: Reusable build and test
+
+on:
+  workflow_call:
+    inputs:
+      runs_on:
+        description: Runner to run the job on
+        required: true
+        type: string
+
+      container:
+        description: "The container object as a JSON string (leave empty to run natively)"
+        required: true
+        type: string
+
+      conan_profile:
+        description: Conan profile to use
+        required: true
+        type: string
+
+      build_type:
+        description: Build type
+        required: true
+        type: string
+
+      disable_cache:
+        description: Whether ccache and conan cache should be disabled
+        required: false
+        type: boolean
+        default: false
+
+      static:
+        description: Whether to build static binaries
+        required: true
+        type: boolean
+        default: true
+
+      run_unit_tests:
+        description: Whether to run unit tests
+        required: true
+        type: boolean
+
+      run_integration_tests:
+        description: Whether to run integration tests
+        required: true
+        type: boolean
+        default: false
+
+      upload_clio_server:
+        description: Whether to upload clio_server
+        required: true
+        type: boolean
+
+      targets:
+        description: Space-separated build target names
+        required: false
+        type: string
+        default: all
+
+      sanitizer:
+        description: Sanitizer to use
+        required: false
+        type: string
+        default: "false"
+
+jobs:
+  build:
+    uses: ./.github/workflows/build_impl.yml
+    with:
+      runs_on: ${{ inputs.runs_on }}
+      container: ${{ inputs.container }}
+      conan_profile: ${{ inputs.conan_profile }}
+      build_type: ${{ inputs.build_type }}
+      disable_cache: ${{ inputs.disable_cache }}
+      code_coverage: false
+      static: ${{ inputs.static }}
+      upload_clio_server: ${{ inputs.upload_clio_server }}
+      targets: ${{ inputs.targets }}
+      sanitizer: ${{ inputs.sanitizer }}
+      analyze_build_time: false
+
+  test:
+    needs: build
+    uses: ./.github/workflows/test_impl.yml
+    with:
+      runs_on: ${{ inputs.runs_on }}
+      container: ${{ inputs.container }}
+      conan_profile: ${{ inputs.conan_profile }}
+      build_type: ${{ inputs.build_type }}
+      run_unit_tests: ${{ inputs.run_unit_tests }}
+      run_integration_tests: ${{ inputs.run_integration_tests }}
+      sanitizer: ${{ inputs.sanitizer }}

.github/workflows/build_clio_docker_image.yml

@@ -0,0 +1,100 @@
+name: Build and publish Clio docker image
+
+on:
+  workflow_call:
+    inputs:
+      tags:
+        required: true
+        type: string
+        description: Comma separated tags for docker image
+      artifact_name:
+        type: string
+        description: Name of Github artifact to put into docker image
+      strip_binary:
+        type: boolean
+        description: Whether to strip clio binary
+        default: true
+      publish_image:
+        type: boolean
+        description: Whether to publish docker image
+        required: true
+
+  workflow_dispatch:
+    inputs:
+      tags:
+        required: true
+        type: string
+        description: Comma separated tags for docker image
+      clio_server_binary_url:
+        required: true
+        type: string
+        description: Url to download clio_server binary from
+      binary_sha256:
+        required: true
+        type: string
+        description: sha256 hash of the binary
+      strip_binary:
+        type: boolean
+        description: Whether to strip clio binary
+        default: true
+
+jobs:
+  build_and_publish_image:
+    name: Build and publish image
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download Clio binary from artifact
+        if: ${{ inputs.artifact_name != null }}
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.artifact_name }}
+          path: ./docker/clio/artifact/
+
+      - name: Download Clio binary from url
+        if: ${{ inputs.clio_server_binary_url != null }}
+        shell: bash
+        run: |
+          wget ${{inputs.clio_server_binary_url}} -P ./docker/clio/artifact/
+          if [ "$(sha256sum ./docker/clio/clio_server | awk '{print $1}')" != "${{inputs.binary_sha256}}" ]; then
+            echo "Binary sha256 sum doesn't match"
+            exit 1
+          fi
+      - name: Unpack binary
+        shell: bash
+        run: |
+          sudo apt update && sudo apt install -y tar unzip
+          cd docker/clio/artifact
+          artifact=$(find . -type f)
+          if [[ $artifact == *.zip ]]; then
+            unzip $artifact
+          elif [[ $artifact == *.tar.gz ]]; then
+            tar -xvf $artifact
+          fi
+          mv clio_server ../
+          cd ../
+          rm -rf ./artifact
+
+      - name: Strip binary
+        if: ${{ inputs.strip_binary }}
+        shell: bash
+        run: strip ./docker/clio/clio_server
+
+      - name: Build Docker image
+        uses: ./.github/actions/build_docker_image
+        env:
+          DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}
+          DOCKERHUB_PW: ${{ secrets.DOCKERHUB_PW }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          images: |
+            rippleci/clio
+            ghcr.io/xrplf/clio
+          dockerhub_repo: rippleci/clio
+          push_image: ${{ inputs.publish_image }}
+          directory: docker/clio
+          tags: ${{ inputs.tags }}
+          platforms: linux/amd64
+          description: Clio is an XRP Ledger API server.

.github/workflows/build_impl.yml

@@ -0,0 +1,206 @@
+name: Reusable build
+
+on:
+  workflow_call:
+    inputs:
+      runs_on:
+        description: Runner to run the job on
+        required: true
+        type: string
+
+      container:
+        description: "The container object as a JSON string (leave empty to run natively)"
+        required: true
+        type: string
+
+      conan_profile:
+        description: Conan profile to use
+        required: true
+        type: string
+
+      build_type:
+        description: Build type
+        required: true
+        type: string
+
+      disable_cache:
+        description: Whether ccache and conan cache should be disabled
+        required: false
+        type: boolean
+
+      code_coverage:
+        description: Whether to enable code coverage
+        required: true
+        type: boolean
+
+      static:
+        description: Whether to build static binaries
+        required: true
+        type: boolean
+
+      upload_clio_server:
+        description: Whether to upload clio_server
+        required: true
+        type: boolean
+
+      targets:
+        description: Space-separated build target names
+        required: true
+        type: string
+
+      sanitizer:
+        description: Sanitizer to use
+        required: true
+        type: string
+
+      analyze_build_time:
+        description: Whether to enable build time analysis
+        required: true
+        type: boolean
+
+    secrets:
+      CODECOV_TOKEN:
+        required: false
+
+jobs:
+  build:
+    name: Build ${{ inputs.container != '' && 'in container' || 'natively' }}
+    runs-on: ${{ inputs.runs_on }}
+    container: ${{ inputs.container != '' && fromJson(inputs.container) || null }}
+
+    steps:
+      - name: Clean workdir
+        if: ${{ runner.os == 'macOS' }}
+        uses: kuznetsss/workspace-cleanup@80b9863b45562c148927c3d53621ef354e5ae7ce # v1.0
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Prepare runner
+        uses: ./.github/actions/prepare_runner
+        with:
+          disable_ccache: ${{ inputs.disable_cache }}
+
+      - name: Setup conan
+        uses: ./.github/actions/setup_conan
+        with:
+          conan_profile: ${{ inputs.conan_profile }}
+
+      - name: Restore cache
+        if: ${{ !inputs.disable_cache }}
+        uses: ./.github/actions/restore_cache
+        id: restore_cache
+        with:
+          conan_dir: ${{ env.CONAN_USER_HOME }}/.conan
+          conan_profile: ${{ inputs.conan_profile }}
+          ccache_dir: ${{ env.CCACHE_DIR }}
+          build_type: ${{ inputs.build_type }}
+          code_coverage: ${{ inputs.code_coverage }}
+
+      - name: Run conan and cmake
+        uses: ./.github/actions/generate
+        with:
+          conan_profile: ${{ inputs.conan_profile }}
+          conan_cache_hit: ${{ !inputs.disable_cache && steps.restore_cache.outputs.conan_cache_hit }}
+          build_type: ${{ inputs.build_type }}
+          code_coverage: ${{ inputs.code_coverage }}
+          static: ${{ inputs.static }}
+          sanitizer: ${{ inputs.sanitizer }}
+          time_trace: ${{ inputs.analyze_build_time }}
+
+      - name: Build Clio
+        uses: ./.github/actions/build_clio
+        with:
+          targets: ${{ inputs.targets }}
+
+      - name: Show build time analyze report
+        if: ${{ inputs.analyze_build_time }}
+        run: |
+          ClangBuildAnalyzer --all build/ build_time_report.bin
+          ClangBuildAnalyzer --analyze build_time_report.bin > build_time_report.txt
+          cat build_time_report.txt
+        shell: bash
+
+      - name: Upload build time analyze report
+        if: ${{ inputs.analyze_build_time }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: build_time_report_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
+          path: build_time_report.txt
+
+      - name: Show ccache's statistics
+        if: ${{ !inputs.disable_cache }}
+        shell: bash
+        id: ccache_stats
+        run: |
+          ccache -s > /tmp/ccache.stats
+          miss_rate=$(cat /tmp/ccache.stats | grep 'Misses' | head -n1 | sed 's/.*(\(.*\)%).*/\1/')
+          echo "miss_rate=${miss_rate}" >> $GITHUB_OUTPUT
+          cat /tmp/ccache.stats
+
+      - name: Strip unit_tests
+        if: inputs.sanitizer == 'false' && !inputs.code_coverage && !inputs.analyze_build_time
+        run: strip build/clio_tests
+
+      - name: Strip integration_tests
+        if: inputs.sanitizer == 'false' && !inputs.code_coverage && !inputs.analyze_build_time
+        run: strip build/clio_integration_tests
+
+      - name: Upload clio_server
+        if: inputs.upload_clio_server && !inputs.code_coverage && !inputs.analyze_build_time
+        uses: actions/upload-artifact@v4
+        with:
+          name: clio_server_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
+          path: build/clio_server
+
+      - name: Upload clio_tests
+        if: ${{ !inputs.code_coverage && !inputs.analyze_build_time }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: clio_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
+          path: build/clio_tests
+
+      - name: Upload clio_integration_tests
+        if: ${{ !inputs.code_coverage && !inputs.analyze_build_time }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: clio_integration_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
+          path: build/clio_integration_tests
+
+      - name: Save cache
+        if: ${{ !inputs.disable_cache && github.ref == 'refs/heads/develop' }}
+        uses: ./.github/actions/save_cache
+        with:
+          conan_dir: ${{ env.CONAN_USER_HOME }}/.conan
+          conan_hash: ${{ steps.restore_cache.outputs.conan_hash }}
+          conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }}
+          ccache_dir: ${{ env.CCACHE_DIR }}
+          ccache_cache_hit: ${{ steps.restore_cache.outputs.ccache_cache_hit }}
+          ccache_cache_miss_rate: ${{ steps.ccache_stats.outputs.miss_rate }}
+          build_type: ${{ inputs.build_type }}
+          code_coverage: ${{ inputs.code_coverage }}
+          conan_profile: ${{ inputs.conan_profile }}
+
+      # This is run as part of the build job, because it requires the following:
+      # - source code
+      # - generated source code (Build.cpp)
+      # - conan packages
+      # - .gcno files in build directory
+      #
+      # It's all available in the build job, but not in the test job
+      - name: Run code coverage
+        if: ${{ inputs.code_coverage }}
+        uses: ./.github/actions/code_coverage
+
+  # `codecov/codecov-action` will rerun `gcov` if it's available and build directory is present
+  # To prevent this from happening, we run this action in a separate workflow
+  #
+  # More info: https://github.com/XRPLF/clio/pull/2066
+  upload_coverage_report:
+    if: ${{ inputs.code_coverage }}
+    name: Codecov
+    needs: build
+    uses: ./.github/workflows/upload_coverage_report.yml
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/check_libxrpl.yml

@@ -1,19 +1,28 @@
 name: Check new libXRPL
+
 on:
   repository_dispatch:
     types: [check_libxrpl]
 
+concurrency:
+  # Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CONAN_PROFILE: gcc
+
 jobs:
   build:
     name: Build Clio / `libXRPL ${{ github.event.client_payload.version }}`
     runs-on: [self-hosted, heavy]
     container:
-      image: rippleci/clio_ci:latest
+      image: ghcr.io/xrplf/clio-ci:latest
 
     steps:
       - uses: actions/checkout@v4
         with:
-            fetch-depth: 0
+          fetch-depth: 0
 
       - name: Update libXRPL version requirement
         shell: bash
@@ -23,18 +32,17 @@ jobs:
       - 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: gcc
+          conan_profile: ${{ env.CONAN_PROFILE }}
 
       - name: Run conan and cmake
         uses: ./.github/actions/generate
         with:
-          conan_profile: ${{ steps.conan.outputs.conan_profile }}
+          conan_profile: ${{ env.CONAN_PROFILE }}
           conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }}
           build_type: Release
 
@@ -47,7 +55,7 @@ jobs:
       - name: Upload clio_tests
         uses: actions/upload-artifact@v4
         with:
-          name: clio_tests_libxrpl-${{ github.event.client_payload.version }}
+          name: clio_tests_check_libxrpl
           path: build/clio_tests
 
   run_tests:
@@ -55,12 +63,12 @@ jobs:
     needs: build
     runs-on: [self-hosted, heavy]
     container:
-      image: rippleci/clio_ci:latest
+      image: ghcr.io/xrplf/clio-ci:latest
 
     steps:
       - uses: actions/download-artifact@v4
         with:
-          name: clio_tests_libxrpl-${{ github.event.client_payload.version }}
+          name: clio_tests_check_libxrpl
 
       - name: Run clio_tests
         run: |
@@ -71,10 +79,12 @@ jobs:
     name: Create an issue on failure
     needs: [build, run_tests]
     if: ${{ always() && contains(needs.*.result, 'failure') }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
+
     permissions:
       contents: write
       issues: write
+
     steps:
       - uses: actions/checkout@v4
 
@@ -83,8 +93,8 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
         with:
-          labels: 'compatibility,bug'
-          title: 'Proposed libXRPL check failed'
+          labels: "compatibility,bug"
+          title: "Proposed libXRPL check failed"
           body: >
             Clio build or tests failed against `libXRPL ${{ github.event.client_payload.version }}`.
 

.github/workflows/check_pr_title.yml

@@ -0,0 +1,17 @@
+name: Check PR title
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+    branches: [develop]
+
+jobs:
+  check_title:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: ytanikin/pr-conventional-commits@8267db1bacc237419f9ed0228bb9d94e94271a1d # v1.4.1
+        with:
+          task_types: '["build","feat","fix","docs","test","ci","style","refactor","perf","chore"]'
+          add_label: false
+          custom_labels: '{"build":"build", "feat":"enhancement", "fix":"bug", "docs":"documentation", "test":"testability", "ci":"ci", "style":"refactoring", "refactor":"refactoring", "perf":"performance", "chore":"tooling"}'

.github/workflows/clang-tidy.yml

@@ -1,20 +1,29 @@
 name: Clang-tidy check
+
 on:
   schedule:
-    - cron: "0 6 * * 1-5"
+    - cron: "0 9 * * 1-5"
   workflow_dispatch:
   pull_request:
     branches: [develop]
     paths:
       - .clang_tidy
       - .github/workflows/clang-tidy.yml
-  workflow_call:
+
+concurrency:
+  # Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CONAN_PROFILE: clang
 
 jobs:
   clang_tidy:
-    runs-on: [self-hosted, Linux]
+    runs-on: heavy
     container:
-      image: rippleci/clio_ci:latest
+      image: ghcr.io/xrplf/clio-ci:latest
+
     permissions:
       contents: write
       issues: write
@@ -32,9 +41,8 @@ jobs:
 
       - name: Setup conan
         uses: ./.github/actions/setup_conan
-        id: conan
         with:
-          conan_profile: clang
+          conan_profile: ${{ env.CONAN_PROFILE }}
 
       - name: Restore cache
         uses: ./.github/actions/restore_cache
@@ -42,12 +50,12 @@ jobs:
         with:
           conan_dir: ${{ env.CONAN_USER_HOME }}/.conan
           ccache_dir: ${{ env.CCACHE_DIR }}
-          conan_profile: ${{ steps.conan.outputs.conan_profile }}
+          conan_profile: ${{ env.CONAN_PROFILE }}
 
       - name: Run conan and cmake
         uses: ./.github/actions/generate
         with:
-          conan_profile: ${{ steps.conan.outputs.conan_profile }}
+          conan_profile: ${{ env.CONAN_PROFILE }}
           conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }}
           build_type: Release
 
@@ -60,13 +68,13 @@ jobs:
         shell: bash
         id: run_clang_tidy
         run: |
-          run-clang-tidy-18 -p build -j ${{ steps.number_of_threads.outputs.threads_number }} -fix -quiet 1>output.txt
+          run-clang-tidy-19 -p build -j ${{ steps.number_of_threads.outputs.threads_number }} -fix -quiet 1>output.txt
 
-      - name: Check format
+      - name: Fix local includes
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}
         continue-on-error: true
         shell: bash
-        run: ./.githooks/check-format
+        run: pre-commit run --all-files fix-local-includes
 
       - name: Print issues found
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}
@@ -83,13 +91,13 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
         with:
-          title: 'Clang-tidy found bugs in code 🐛'
+          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
+      - uses: crazy-max/ghaction-import-gpg@e89d40939c28e39f97cf32126055eeae86ba74ec # v6.3.0
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}
         with:
           gpg_private_key: ${{ secrets.ACTIONS_GPG_PRIVATE_KEY }}
@@ -99,7 +107,7 @@ jobs:
 
       - name: Create PR with fixes
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
         env:
           GH_REPO: ${{ github.repository }}
           GH_TOKEN: ${{ github.token }}
@@ -109,9 +117,9 @@ jobs:
           branch: "clang_tidy/autofix"
           branch-suffix: timestamp
           delete-branch: true
-          title: "[CI] clang-tidy auto fixes"
+          title: "style: clang-tidy auto fixes"
           body: "Fixes #${{ steps.create_issue.outputs.created_issue_id }}. Please review and commit clang-tidy fixes."
-          reviewers: "cindyyan317,godexsoft,kuznetsss"
+          reviewers: "godexsoft,kuznetsss,PeterChen13579"
 
       - name: Fail the job
         if: ${{ steps.run_clang_tidy.outcome != 'success' }}

.github/workflows/clang-tidy_on_fix_merged.yml

@@ -1,4 +1,5 @@
 name: Restart clang-tidy workflow
+
 on:
   push:
     branches: [develop]
@@ -6,7 +7,7 @@ on:
 
 jobs:
   restart_clang_tidy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     permissions:
       actions: write
@@ -17,7 +18,7 @@ jobs:
         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)
+          passed=$(if [[ $(git log -1 --pretty=format:%s | grep 'style: clang-tidy auto fixes') ]]; then echo 'true' ; else echo 'false' ; fi)
           echo "passed=$passed" >> $GITHUB_OUTPUT
 
       - name: Run clang-tidy workflow

.github/workflows/docs.yml

@@ -1,4 +1,5 @@
 name: Documentation
+
 on:
   push:
     branches: [develop]
@@ -10,7 +11,8 @@ permissions:
   id-token: write
 
 concurrency:
-  group: "pages"
+  # Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
+  group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
@@ -18,30 +20,31 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     continue-on-error: true
     container:
-      image: rippleci/clio_ci:latest
+      image: ghcr.io/xrplf/clio-ci:latest
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with: 
+        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
+        uses: actions/configure-pages@v5
 
       - 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

.github/workflows/nightly.yml

@@ -1,184 +1,116 @@
 name: Nightly release
+
 on:
   schedule:
-    - cron:  '0 5 * * 1-5'
+    - cron: "0 8 * * 1-5"
   workflow_dispatch:
+  pull_request:
+    paths:
+      - ".github/workflows/nightly.yml"
+      - ".github/workflows/build_clio_docker_image.yml"
+
+concurrency:
+  # Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  build:
-    name: Build clio
+  build-and-test:
+    name: Build and Test
+
     strategy:
       fail-fast: false
       matrix:
         include:
-          - os: macos14
+          - os: macos15
+            conan_profile: default_apple_clang
             build_type: Release
+            static: false
           - os: heavy
+            conan_profile: gcc
             build_type: Release
-            container:
-              image: rippleci/clio_ci:latest
+            static: true
+            container: '{ "image": "ghcr.io/xrplf/clio-ci:latest" }'
           - os: heavy
+            conan_profile: gcc
             build_type: Debug
-            container:
-              image: rippleci/clio_ci:latest
-    runs-on: [self-hosted, "${{ matrix.os }}"]
-    container: ${{ matrix.container }}
+            static: true
+            container: '{ "image": "ghcr.io/xrplf/clio-ci:latest" }'
 
-    steps:
-      - name: Clean workdir
-        if: ${{ runner.os == 'macOS' }}
-        uses: kuznetsss/workspace-cleanup@1.0
+    uses: ./.github/workflows/build_and_test.yml
+    with:
+      runs_on: ${{ matrix.os }}
+      container: ${{ matrix.container }}
+      conan_profile: ${{ matrix.conan_profile }}
+      build_type: ${{ matrix.build_type }}
+      static: ${{ matrix.static }}
+      run_unit_tests: true
+      run_integration_tests: ${{ matrix.os != 'macos15' }}
+      upload_clio_server: true
+      disable_cache: true
 
-      - uses: actions/checkout@v4
-        with:
-            fetch-depth: 0
+  analyze_build_time:
+    name: Analyze Build Time
 
-      - 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: ${{ matrix.build_type }}
-
-      - name: Build Clio
-        uses: ./.github/actions/build_clio
-
-      - name: Strip tests
-        run: strip build/clio_tests && strip build/clio_integration_tests
-
-      - name: Upload clio_tests
-        uses: actions/upload-artifact@v4
-        with:
-          name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}
-          path: build/clio_*tests
-
-      - name: Compress clio_server
-        shell: bash
-        run: |
-            cd build
-            tar czf ./clio_server_${{ runner.os }}_${{ matrix.build_type }}.tar.gz ./clio_server
-
-      - name: Upload clio_server
-        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
-
-
-  run_tests:
-    needs: build
     strategy:
       fail-fast: false
       matrix:
         include:
-          - 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:
-      - 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
-  
-  # 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
+          # TODO: Enable when we have at least ubuntu 22.04
+          # as ClangBuildAnalyzer requires relatively modern glibc
+          #
+          # - os: heavy
+          #   conan_profile: clang
+          #   container: '{ "image": "ghcr.io/xrplf/clio-ci:latest" }'
+          #   static: true
+          - os: macos15
+            conan_profile: default_apple_clang
+            container: ""
+            static: false
+    uses: ./.github/workflows/build_impl.yml
+    with:
+      runs_on: ${{ matrix.os }}
+      container: ${{ matrix.container }}
+      conan_profile: ${{ matrix.conan_profile }}
+      build_type: Release
+      disable_cache: true
+      code_coverage: false
+      static: ${{ matrix.static }}
+      upload_clio_server: false
+      targets: all
+      sanitizer: "false"
+      analyze_build_time: true
 
   nightly_release:
-    needs: run_tests
-    runs-on: ubuntu-20.04
-    env:
-      GH_REPO: ${{ github.repository }}
-      GH_TOKEN: ${{ github.token }}
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v4
+    needs: build-and-test
+    uses: ./.github/workflows/release_impl.yml
+    with:
+      overwrite_release: true
+      title: "Clio development (nightly) build"
+      version: nightly
+      notes_header_file: nightly_notes.md
 
-      - uses: actions/download-artifact@v4
-        with:
-          path: nightly_release
-
-      - name: Prepare files
-        shell: bash
-        run: |
-          cp ${{ github.workspace }}/.github/workflows/nightly_notes.md "${RUNNER_TEMP}/nightly_notes.md"
-          cd nightly_release
-          rm -r clio_*tests*
-          for d in $(ls); do
-            archive_name=$(ls $d)
-            mv ${d}/${archive_name} ./
-            rm -r $d
-            sha256sum ./$archive_name > ./${archive_name}.sha256sum
-            cat ./$archive_name.sha256sum >> "${RUNNER_TEMP}/nightly_notes.md"
-          done
-          echo '```' >> "${RUNNER_TEMP}/nightly_notes.md"
-
-      - name: Remove current nightly release and nightly tag
-        shell: bash
-        run: |
-          gh release delete nightly --yes || true
-          git push origin :nightly || true
-
-      - name: Publish nightly release
-        shell: bash
-        run: |
-          gh release create nightly --prerelease --title "Clio development (nightly) build" \
-            --target $GITHUB_SHA --notes-file "${RUNNER_TEMP}/nightly_notes.md" \
-            ./nightly_release/clio_server*
+  build_and_publish_docker_image:
+    uses: ./.github/workflows/build_clio_docker_image.yml
+    needs: build-and-test
+    secrets: inherit
+    with:
+      tags: |
+        type=raw,value=nightly
+        type=raw,value=${{ github.sha }}
+      artifact_name: clio_server_Linux_Release_gcc
+      strip_binary: true
+      publish_image: ${{ github.event_name != 'pull_request' }}
 
   create_issue_on_failure:
-    needs: [build, run_tests, nightly_release]
-    if: ${{ always() && contains(needs.*.result, 'failure') }}
-    runs-on: ubuntu-20.04
+    needs: [build-and-test, nightly_release, build_and_publish_docker_image]
+    if: ${{ always() && contains(needs.*.result, 'failure') && github.event_name != 'pull_request' }}
+    runs-on: ubuntu-latest
+
     permissions:
       contents: write
       issues: write
+
     steps:
       - uses: actions/checkout@v4
 
@@ -187,7 +119,7 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
         with:
-          title: 'Nightly release failed 🌙'
+          title: "Nightly release failed 🌙"
           body: >
             Nightly release failed:
 

.github/workflows/nightly_notes.md

@@ -1,6 +1,7 @@
+# Release notes
+
 > **Note:** Please remember that this is a development release and it is not recommended for production use.
 
-Changelog (including previous releases): https://github.com/XRPLF/clio/commits/nightly
+Changelog (including previous releases): <https://github.com/XRPLF/clio/commits/nightly>
 
 ## SHA256 checksums
-```

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

@@ -0,0 +1,39 @@
+name: Pre-commit auto-update
+
+on:
+  # every first day of the month
+  schedule:
+    - cron: "0 0 1 * *"
+  # on demand
+  workflow_dispatch:
+
+jobs:
+  auto-update:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - run: pip install pre-commit
+      - run: pre-commit autoupdate
+      - run: pre-commit run --all-files
+
+      - uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
+        if: always()
+        env:
+          GH_REPO: ${{ github.repository }}
+          GH_TOKEN: ${{ github.token }}
+        with:
+          branch: update/pre-commit-hooks
+          title: Update pre-commit hooks
+          commit-message: "style: update pre-commit hooks"
+          body: Update versions of pre-commit hooks to latest version.
+          reviewers: "godexsoft,kuznetsss,PeterChen13579,mathbunnyru"

.github/workflows/pre-commit.yml

@@ -0,0 +1,28 @@
+name: Run pre-commit hooks
+
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+  workflow_dispatch:
+
+jobs:
+  run-hooks:
+    runs-on: heavy
+    container:
+      image: ghcr.io/xrplf/clio-ci:latest
+
+    steps:
+      - name: Checkout Repo ⚡️
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Prepare runner
+        uses: ./.github/actions/prepare_runner
+        with:
+          disable_ccache: true
+
+      - name: Run pre-commit ✅
+        run: pre-commit run --all-files

.github/workflows/release_impl.yml

@@ -0,0 +1,78 @@
+name: Make release
+
+on:
+  workflow_call:
+    inputs:
+      overwrite_release:
+        description: "Overwrite the current release and tag"
+        required: true
+        type: boolean
+
+      title:
+        description: "Release title"
+        required: true
+        type: string
+
+      version:
+        description: "Release version"
+        required: true
+        type: string
+
+      notes_header_file:
+        description: "Release notes header file"
+        required: true
+        type: string
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      GH_REPO: ${{ github.repository }}
+      GH_TOKEN: ${{ github.token }}
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          path: release_artifacts
+          pattern: clio_server_*
+
+      - name: Prepare files
+        shell: bash
+        working-directory: release_artifacts
+        run: |
+          cp ${{ github.workspace }}/.github/workflows/${{ inputs.notes_header_file }} "${RUNNER_TEMP}/release_notes.md"
+          echo '' >> "${RUNNER_TEMP}/release_notes.md"
+          echo '```' >> "${RUNNER_TEMP}/release_notes.md"
+
+          for d in $(ls); do
+            archive_name=$(ls $d)
+            mv ${d}/${archive_name} ./
+            rm -r $d
+            sha256sum ./$archive_name > ./${archive_name}.sha256sum
+            cat ./$archive_name.sha256sum >> "${RUNNER_TEMP}/release_notes.md"
+          done
+
+          echo '```' >> "${RUNNER_TEMP}/release_notes.md"
+
+      - name: Remove current release and tag
+        if: ${{ github.event_name != 'pull_request' && inputs.overwrite_release }}
+        shell: bash
+        run: |
+          gh release delete ${{ inputs.version }} --yes || true
+          git push origin :${{ inputs.version }} || true
+
+      - name: Publish release
+        if: ${{ github.event_name != 'pull_request' }}
+        shell: bash
+        run: |
+          gh release create ${{ inputs.version }} \
+            ${{ inputs.overwrite_release && '--prerelease' || '' }} \
+            --title "${{ inputs.title }}" \
+            --target $GITHUB_SHA \
+            --notes-file "${RUNNER_TEMP}/release_notes.md" \
+            ./release_artifacts/clio_server*

.github/workflows/sanitizers.yml

@@ -0,0 +1,43 @@
+name: Run tests with sanitizers
+
+on:
+  schedule:
+    - cron: "0 4 * * 1-5"
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - ".github/workflows/sanitizers.yml"
+
+concurrency:
+  # Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-test:
+    name: Build and Test
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - sanitizer: tsan
+            compiler: gcc
+          - sanitizer: asan
+            compiler: gcc
+          - sanitizer: ubsan
+            compiler: gcc
+
+    uses: ./.github/workflows/build_and_test.yml
+    with:
+      runs_on: heavy
+      container: '{ "image": "ghcr.io/xrplf/clio-ci:latest" }'
+      disable_cache: true
+      conan_profile: ${{ matrix.compiler }}.${{ matrix.sanitizer }}
+      build_type: Release
+      static: false
+      run_unit_tests: true
+      run_integration_tests: false
+      upload_clio_server: false
+      targets: clio_tests clio_integration_tests
+      sanitizer: ${{ matrix.sanitizer }}

.github/workflows/test_impl.yml

@@ -0,0 +1,138 @@
+name: Reusable test
+
+on:
+  workflow_call:
+    inputs:
+      runs_on:
+        description: Runner to run the job on
+        required: true
+        type: string
+
+      container:
+        description: "The container object as a JSON string (leave empty to run natively)"
+        required: true
+        type: string
+
+      conan_profile:
+        description: Conan profile to use
+        required: true
+        type: string
+
+      build_type:
+        description: Build type
+        required: true
+        type: string
+
+      run_unit_tests:
+        description: Whether to run unit tests
+        required: true
+        type: boolean
+
+      run_integration_tests:
+        description: Whether to run integration tests
+        required: true
+        type: boolean
+
+      sanitizer:
+        description: Sanitizer to use
+        required: true
+        type: string
+
+jobs:
+  unit_tests:
+    name: Unit testing ${{ inputs.container != '' && 'in container' || 'natively' }}
+    runs-on: ${{ inputs.runs_on }}
+    container: ${{ inputs.container != '' && fromJson(inputs.container) || null }}
+
+    if: inputs.run_unit_tests
+
+    steps:
+      - name: Clean workdir
+        if: ${{ runner.os == 'macOS' }}
+        uses: kuznetsss/workspace-cleanup@80b9863b45562c148927c3d53621ef354e5ae7ce # v1.0
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: clio_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
+
+      - name: Make clio_tests executable
+        shell: bash
+        run: chmod +x ./clio_tests
+
+      - name: Run clio_tests (regular)
+        if: inputs.sanitizer == 'false'
+        run: ./clio_tests
+
+      - name: Run clio_tests (sanitizer)
+        if: inputs.sanitizer != 'false'
+        run: ./.github/scripts/execute-tests-under-sanitizer ./clio_tests
+
+      - name: Check for sanitizer report
+        if: inputs.sanitizer != 'false'
+        shell: bash
+        id: check_report
+        run: |
+          if ls .sanitizer-report/* 1> /dev/null 2>&1; then
+            echo "found_report=true" >> $GITHUB_OUTPUT
+          else
+            echo "found_report=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Upload sanitizer report
+        if: inputs.sanitizer != 'false' && steps.check_report.outputs.found_report == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ inputs.conan_profile }}_report
+          path: .sanitizer-report/*
+          include-hidden-files: true
+
+      # TODO: enable when we have fixed all currently existing issues from sanitizers
+      - name: Create an issue
+        if: false && inputs.sanitizer != 'false' && steps.check_report.outputs.found_report == 'true'
+        uses: ./.github/actions/create_issue
+        env:
+          GH_TOKEN: ${{ github.token }}
+        with:
+          labels: "bug"
+          title: "[${{ inputs.conan_profile }}] reported issues"
+          body: >
+            Clio tests failed one or more sanitizer checks when built with ${{ inputs.conan_profile }}`.
+
+            Workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/
+            Reports are available as artifacts.
+
+  integration_tests:
+    name: Integration testing ${{ inputs.container != '' && 'in container' || 'natively' }}
+    runs-on: ${{ inputs.runs_on }}
+    container: ${{ inputs.container != '' && fromJson(inputs.container) || null }}
+
+    if: inputs.run_integration_tests
+
+    services:
+      scylladb:
+        image: "scylladb/scylla"
+        options: >-
+          --health-cmd "cqlsh -e 'describe cluster'"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - name: Clean workdir
+        if: ${{ runner.os == 'macOS' }}
+        uses: kuznetsss/workspace-cleanup@80b9863b45562c148927c3d53621ef354e5ae7ce # v1.0
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: clio_integration_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ inputs.conan_profile }}
+
+      # To be enabled back once docker in mac runner arrives
+      # https://github.com/XRPLF/clio/issues/1400
+      - name: Run clio_integration_tests
+        run: |
+          chmod +x ./clio_integration_tests
+          ./clio_integration_tests --backend_host=scylladb

.github/workflows/update_docker_ci.yml

@@ -1,47 +1,50 @@
 name: Update CI docker image
+
 on:
   pull_request:
     paths:
-      - 'docker/ci/**'
-      - 'docker/compilers/**'
+      - "docker/ci/**"
+      - "docker/compilers/**"
       - .github/workflows/update_docker_ci.yml
+      - ".github/actions/build_docker_image/**"
   push:
     branches: [develop]
     paths:
-      - 'docker/ci/**'        # CI image must update when either its dockerfile changes
-      - 'docker/compilers/**' # or any compilers changed and were pushed by hand
+      # CI image must update when either its Dockerfile changes
+      # or any compilers changed and were pushed by hand
+      - "docker/ci/**"
+      - "docker/compilers/**"
       - .github/workflows/update_docker_ci.yml
+      - ".github/actions/build_docker_image/**"
   workflow_dispatch:
 
+concurrency:
+  # Only cancel in-progress jobs or runs for the current workflow - matches against branch & tags
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build_and_push:
     name: Build and push docker image
     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 }}
-          password: ${{ secrets.DOCKERHUB_PW }}
 
+    steps:
       - uses: actions/checkout@v4
-      - uses: docker/setup-qemu-action@v3
-      - uses: docker/setup-buildx-action@v3
-      - uses: docker/metadata-action@v5
-        id: meta
+      - uses: ./.github/actions/build_docker_image
+        env:
+          DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}
+          DOCKERHUB_PW: ${{ secrets.DOCKERHUB_PW }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          images: rippleci/clio_ci
+          images: |
+            rippleci/clio_ci
+            ghcr.io/xrplf/clio-ci
+          dockerhub_repo: rippleci/clio_ci
+          push_image: ${{ github.event_name != 'pull_request' }}
+          directory: docker/ci
           tags: |
             type=raw,value=latest
             type=raw,value=gcc_12_clang_16
-            type=raw,value=${{ env.GITHUB_SHA }}
-
-      - name: Build and push
-        uses: docker/build-push-action@v5
-        with:
-          context: ${{ github.workspace }}/docker/ci
+            type=raw,value=${{ github.sha }}
           platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta.outputs.tags }}
-
+          description: CI image for XRPLF/clio.

.github/workflows/upload_coverage_report.yml

@@ -1,4 +1,5 @@
 name: Upload report
+
 on:
   workflow_dispatch:
   workflow_call:
@@ -9,7 +10,8 @@ on:
 jobs:
   upload_report:
     name: Upload report
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v4
         with:
@@ -23,13 +25,9 @@ jobs:
 
       - name: Upload coverage report
         if: ${{ hashFiles('build/coverage_report.xml') != '' }}
-        uses: wandalen/wretry.action@v1.4.10
+        uses: codecov/codecov-action@ad3126e916f78f00edff4ed0317cf185271ccc2d # v5.4.2
         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
+          files: build/coverage_report.xml
+          fail_ci_if_error: true
+          verbose: true
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -6,6 +6,7 @@
 .vscode
 .python-version
 .DS_Store
+.sanitizer-report
 CMakeUserPresets.json
 config.json
-src/main/impl/Build.cpp
+src/util/build/Build.cpp

.markdownlint.yaml

@@ -0,0 +1,6 @@
+# Default state for all rules
+default: true
+
+# MD013/line-length - Line length
+MD013:
+  line_length: 1000

.pre-commit-config.yaml

@@ -0,0 +1,118 @@
+---
+# pre-commit is a tool to perform a predefined set of tasks manually and/or
+# automatically before git commits are made.
+#
+# Config reference: https://pre-commit.com/#pre-commit-configyaml---top-level
+#
+# Common tasks
+#
+# - Run on all files:   pre-commit run --all-files
+# - Register git hooks: pre-commit install --install-hooks
+#
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  # `pre-commit sample-config` default hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: end-of-file-fixer
+        exclude: ^docs/doxygen-awesome-theme/
+      - id: trailing-whitespace
+        exclude: ^docs/doxygen-awesome-theme/
+
+  # Autoformat: YAML, JSON, Markdown, etc.
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.5.3
+    hooks:
+      - id: prettier
+        exclude: ^docs/doxygen-awesome-theme/
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.44.0
+    hooks:
+      - id: markdownlint-fix
+        exclude: LICENSE.md
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.31.2
+    hooks:
+      - id: typos
+
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v19.1.7
+    hooks:
+      - id: clang-format
+        args: [--style=file]
+        types: [c++]
+
+  - repo: https://github.com/cheshirekow/cmake-format-precommit
+    rev: v0.6.13
+    hooks:
+      - id: cmake-format
+        additional_dependencies: [PyYAML]
+
+  - repo: local
+    hooks:
+      - id: check-no-h-files
+        name: No .h files
+        entry: There should be no .h files in this repository
+        language: fail
+        files: \.h$
+
+  - repo: local
+    hooks:
+      - id: gofmt
+        name: Go Format
+        entry: pre-commit-hooks/run-go-fmt.sh
+        types: [go]
+        language: golang
+        description: "Runs `gofmt`, requires golang"
+      - id: check-docs
+        name: Check Doxygen Documentation
+        entry: pre-commit-hooks/check-doxygen-docs.sh
+        types: [text]
+        language: system
+        pass_filenames: false
+      - id: fix-local-includes
+        name: Fix Local Includes
+        entry: pre-commit-hooks/fix-local-includes.sh
+        types: [c++]
+        language: system
+        pass_filenames: false
+      - id: verify-commits
+        name: Verify Commits
+        entry: pre-commit-hooks/verify-commits.sh
+        types: [text]
+        language: system
+        pass_filenames: false
+
+  - repo: local
+    hooks:
+      - id: lfs-post-checkout
+        name: LFS Post Checkout
+        entry: pre-commit-hooks/lfs/post-checkout
+        types: [text]
+        stages: [post-checkout]
+        language: system
+      - id: lfs-post-commit
+        name: LFS Post Commit
+        entry: pre-commit-hooks/lfs/post-commit
+        types: [text]
+        stages: [post-commit]
+        language: system
+      - id: lfs-post-merge
+        name: LFS Post Merge
+        entry: pre-commit-hooks/lfs/post-merge
+        types: [text]
+        stages: [post-merge]
+        language: system
+      - id: lfs-pre-push
+        name: LFS Pre Push
+        entry: pre-commit-hooks/lfs/pre-push
+        types: [text]
+        stages: [pre-push]
+        language: system

CMakeLists.txt

@@ -16,6 +16,9 @@ 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)
+option(snapshot "Build snapshot tool" FALSE)
+option(time_trace "Build using -ftime-trace to create compiler trace reports" FALSE)
+
 # ========================================================================== #
 set(san "" CACHE STRING "Add sanitizer instrumentation")
 set(CMAKE_EXPORT_COMPILE_COMMANDS TRUE)
@@ -65,15 +68,21 @@ endif ()
 
 # Enable selected sanitizer if enabled via `san`
 if (san)
+  set(SUPPORTED_SANITIZERS "address" "thread" "memory" "undefined")
+  list(FIND SUPPORTED_SANITIZERS "${san}" INDEX)
+  if (INDEX EQUAL -1)
+    message(FATAL_ERROR "Error: Unsupported sanitizer '${san}'. Supported values are: ${SUPPORTED_SANITIZERS}.")
+  endif ()
+
   target_compile_options(
-    clio PUBLIC # Sanitizers recommend minimum of -O1 for reasonable performance
-                $<$<CONFIG:Debug>:-O1> ${SAN_FLAG} -fno-omit-frame-pointer
+    clio_options INTERFACE # 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>
+    clio_options INTERFACE $<$<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_link_libraries(clio_options INTERFACE ${SAN_FLAG} ${SAN_LIB})
 endif ()
 
 # Generate `docs` target for doxygen documentation if enabled Note: use `make docs` to generate the documentation
@@ -85,3 +94,7 @@ include(install/install)
 if (packaging)
   include(cmake/packaging.cmake) # This file exists only in build runner
 endif ()
+
+if (snapshot)
+  add_subdirectory(tools/snapshot)
+endif ()

CONTRIBUTING.md

@@ -1,39 +1,47 @@
 # Contributing
+
 Thank you for your interest in contributing to the `clio` project 🙏
 
+## Workflow
+
 To contribute, please:
+
 1. Fork the repository under your own user.
 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 the relevant subfolder under `tests`.
-6. Ensure your code passes automated checks (e.g. clang-format)
+6. Ensure your code passes [automated checks](#pre-commit-hooks)
 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.
 
 > **Note:** Please read the [Style guide](#style-guide).
 
-## Install git hooks
-Please run the following command in order to use git hooks that are helpful for `clio` development.
+### `pre-commit` hooks
 
-``` bash
-git config --local core.hooksPath .githooks
+To ensure code quality and style, we use [`pre-commit`](https://pre-commit.com/).
+
+Run the following command to enable `pre-commit` hooks that help with Clio development:
+
+```bash
+pip3 install pre-commit
+pre-commit install
 ```
 
-## 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.
+`pre-commit` takes care of running each tool in [`.pre-commit-config.yaml`](https://github.com/XRPLF/clio/blob/develop/.pre-commit-config.yaml) in a separate environment.
 
-## Git commands
-This sections offers a detailed look at the git commands you will need to use to get your PR submitted. 
+`pre-commit` also attempts to automatically use Doxygen to verify that everything public in the codebase has doc comments.
+If Doxygen is not installed, the hook issues a warning and recommends installing 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.
 At this point it's assumed that you have already finished working on your feature/bug.
 
 > **Important:** Before you issue any of the commands below, please hit the `Sync fork` button and make sure your fork's `develop` branch is up-to-date with the main `clio` repository.
 
-``` bash
+```bash
 # Create a backup of your branch
 git branch <your feature branch>_bk
 
@@ -43,18 +51,20 @@ git pull origin develop
 git checkout <your feature branch>
 git rebase -i develop
 ```
+
 For each commit in the list other than the first one, enter `s` to squash.
 After this is done, you will have the opportunity to write a message for the squashed commit.
 
 > **Hint:** Please use **imperative mood** in the commit message, and capitalize the first word.
 
-``` bash
+```bash
 # You should now have a single commit on top of a commit in `develop`
 git log
 ```
+
 > **Note:** If there are merge conflicts, please resolve them now.
 
-``` bash
+```bash
 # Use the same commit message as you did above
 git commit -m 'Your message'
 git rebase --continue
@@ -62,24 +72,30 @@ git rebase --continue
 
 > **Important:** If you have no GPG keys set up, please follow [this tutorial](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)
 
-``` bash
+```bash
 # Sign the commit with your GPG key, and push your changes
 git commit --amend -S
 git push --force
 ```
 
-## Use ccache (optional)
+### 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 is available.
 
+### Opening a pull request
+
+When a pull request is open CI will perform checks on the new code.
+Title of the pull request and squashed commit should follow [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
+
+### Fixing issues found during code review
 
-## Fixing issues found during code review
 While your code is in review, it's possible that some changes will be requested by reviewer(s).
 This section describes the process of adding your fixes.
 
 We assume that you already made the required changes on your feature branch.
 
-``` bash
+```bash
 # Add the changed code
 git add <paths to add>
 
@@ -91,62 +107,72 @@ git commit -S -m "[FOLD] Your commit message"
 git push
 ```
 
-## After code review
+### After code review
+
 When your PR is approved and ready to merge, use `Squash and merge`.
 The button for that is near the bottom of the PR's page on GitHub.
 
 > **Important:** Please leave the automatically-generated mention/link to the PR in the subject line **and** in the description field add `"Fix #ISSUE_ID"` (replacing `ISSUE_ID` with yours) if the PR fixes an issue.
 > **Note:** See [issues](https://github.com/XRPLF/clio/issues) to find the `ISSUE_ID` for the feature/bug you were working on.
 
-# Style guide
+## Style guide
+
 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 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.
+### Formatting
+
+Code must conform to `clang-format`, unless the result is unreasonably difficult to read or maintain.
+In most cases the `pre-commit` hook takes care of formatting and fixes any issues automatically.
+To manually format your code, run `pre-commit run clang-format --files <your changed files>` for C++ files, and `pre-commit run cmake-format --files <your changed files>` for CMake files.
+
+### Documentation
 
-## 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.
-* Proliferation of new files and classes unless it improves readability or/and compilation time.
-* Unmanaged memory allocation and raw pointers.
-* Macros (unless they add significant value.)
-* Lambda patterns (unless these add significant value.)
-* CPU or architecture-specific code unless there is a good reason to include it, and where it is used guard it with macros and provide explanatory comments.
-* Importing new libraries unless there is a very good reason to do so.
+### Avoid
 
-## Seek to
-* Extend functionality of existing code rather than creating new code.
-* Prefer readability over terseness where important logic is concerned.
-* Inline functions that are not used or are not likely to be used elsewhere in the codebase.
-* Use clear and self-explanatory names for functions, variables, structs and classes.
-* Use TitleCase for classes, structs and filenames, camelCase for function and variable names, lower case for namespaces and folders.
-* Provide as many comments as you feel that a competent programmer would need to understand what your code does.
+- Proliferation of nearly identical code.
+- Proliferation of new files and classes unless it improves readability or/and compilation time.
+- Unmanaged memory allocation and raw pointers.
+- Macros (unless they add significant value.)
+- Lambda patterns (unless these add significant value.)
+- CPU or architecture-specific code unless there is a good reason to include it, and where it is used guard it with macros and provide explanatory comments.
+- Importing new libraries unless there is a very good reason to do so.
+
+### Seek to
+
+- Extend functionality of existing code rather than creating new code.
+- Prefer readability over terseness where important logic is concerned.
+- Inline functions that are not used or are not likely to be used elsewhere in the codebase.
+- Use clear and self-explanatory names for functions, variables, structs and classes.
+- Use TitleCase for classes, structs and filenames, camelCase for function and variable names, lower case for namespaces and folders.
+- Provide as many comments as you feel that a competent programmer would need to understand what your code does.
+
+## Maintainers
 
-# Maintainers
 Maintainers are ecosystem participants with elevated access to the repository. They are able to push new code, make decisions on when a release should be made, etc.
 
-## Code Review
+### Code Review
+
 A PR must be reviewed and approved by at least one of the maintainers before it can be merged.
 
-## Adding and Removing
+### Adding and Removing
+
 New maintainers can be proposed by two existing maintainers, subject to a vote by a quorum of the existing maintainers. A minimum of 50% support and a 50% participation is required. In the event of a tie vote, the addition of the new maintainer will be rejected.
 
 Existing maintainers can resign, or be subject to a vote for removal at the behest of two existing maintainers. A minimum of 60% agreement and 50% participation are required. The XRP Ledger Foundation will have the ability, for cause, to remove an existing maintainer without a vote.
 
-## Existing Maintainers
+### Existing Maintainers
 
-* [cindyyan317](https://github.com/cindyyan317) (Ripple)
-* [godexsoft](https://github.com/godexsoft) (Ripple)
-* [kuznetsss](https://github.com/kuznetsss) (Ripple)
-* [legleux](https://github.com/legleux) (Ripple)
+- [godexsoft](https://github.com/godexsoft) (Ripple)
+- [kuznetsss](https://github.com/kuznetsss) (Ripple)
+- [legleux](https://github.com/legleux) (Ripple)
+- [PeterChen13579](https://github.com/PeterChen13579) (Ripple)
 
-## Honorable ex-Maintainers
+### Honorable ex-Maintainers
 
-* [cjcobb23](https://github.com/cjcobb23) (ex-Ripple)
-* [natenichols](https://github.com/natenichols) (ex-Ripple)
+- [cindyyan317](https://github.com/cindyyan317) (ex-Ripple)
+- [cjcobb23](https://github.com/cjcobb23) (ex-Ripple)
+- [natenichols](https://github.com/natenichols) (ex-Ripple)

LICENSE.md

@@ -1,8 +1,7 @@
 ISC License
 
-Copyright (c) 2022, the clio developers 
+Copyright (c) 2022, 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.
-

README.md

@@ -1,4 +1,4 @@
-# <img src='./docs/img/xrpl-logo.svg' width='40' valign="top" /> Clio
+# <img src='./docs/img/xrpl-logo.svg' width='40' valign="top" /> Clio <!-- markdownlint-disable-line MD033 MD045 -->
 
 [![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)
@@ -16,9 +16,9 @@ Multiple Clio nodes can share access to the same dataset, which allows for a hig
 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`.
+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]  
+> [!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
@@ -28,7 +28,6 @@ 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**:

_typos.toml

@@ -0,0 +1,22 @@
+[default]
+# This allows to ignore account ids in tests and private keys
+# More info: https://github.com/crate-ci/typos/issues/415
+extend-ignore-re = [
+    "[a-z-A-Z0-9]{33}",
+    "[a-z-A-Z0-9]{34}",
+    "[a-z-A-Z0-9]{64}",
+]
+
+[default.extend-identifiers]
+# (S)tring
+tring = "tring"
+trings = "trings"
+
+ASSERTs = "ASSERTs"
+EXCLUDEs = "EXCLUDEs"
+
+ser = "ser"
+
+[default.extend-words]
+strat = "strat"
+datas = "datas"

benchmarks/CMakeLists.txt

@@ -12,5 +12,5 @@ target_sources(
 include(deps/gbench)
 
 target_include_directories(clio_benchmark PRIVATE .)
-target_link_libraries(clio_benchmark PUBLIC clio benchmark::benchmark_main)
+target_link_libraries(clio_benchmark PUBLIC clio_etl benchmark::benchmark_main)
 set_target_properties(clio_benchmark PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})

benchmarks/util/async/ExecutionContextBenchmarks.cpp

@@ -31,7 +31,6 @@
 #include <cstdint>
 #include <latch>
 #include <optional>
-#include <stdexcept>
 #include <thread>
 #include <vector>
 
@@ -189,10 +188,10 @@ public:
 static auto
 generateData()
 {
-    constexpr auto TOTAL = 10'000;
+    constexpr auto kTOTAL = 10'000;
     std::vector<uint64_t> data;
-    data.reserve(TOTAL);
-    for (auto i = 0; i < TOTAL; ++i)
+    data.reserve(kTOTAL);
+    for (auto i = 0; i < kTOTAL; ++i)
         data.push_back(util::Random::uniform(1, 100'000'000));
 
     return data;
@@ -209,7 +208,7 @@ benchmarkThreads(benchmark::State& state)
 }
 
 template <typename CtxType>
-void
+static void
 benchmarkExecutionContextBatched(benchmark::State& state)
 {
     auto data = generateData();
@@ -220,7 +219,7 @@ benchmarkExecutionContextBatched(benchmark::State& state)
 }
 
 template <typename CtxType>
-void
+static void
 benchmarkAnyExecutionContextBatched(benchmark::State& state)
 {
     auto data = generateData();

cliff.toml

@@ -0,0 +1,92 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | filter(attribute="merge_commit", value=false) | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }} {% if commit.remote.username %}by @{{ commit.remote.username }}{% endif %}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+output = "CHANGELOG.md"
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style.*[Cc]lang-tidy auto fixes", skip = true },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore: Commits", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+  { message = ".*", group = "<!-- 10 -->💼 Other" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+
+ignore_tags = "^.*-[b|rc].*"
+
+[remote.github]
+owner = "XRPLF"
+repo = "clio"

cmake/Build.cpp.in

@@ -17,25 +17,26 @@
 */
 //==============================================================================
 
-#include "main/Build.hpp"
+#include "util/build/Build.hpp"
 
 #include <string>
 
-namespace Build {
-static constexpr char versionString[] = "@CLIO_VERSION@";
+namespace util::build {
+
+static constexpr char versionString[] = "@CLIO_VERSION@"; // NOLINT(readability-identifier-naming)
 
 std::string const&
 getClioVersionString()
 {
-    static std::string const value = versionString;
+    static std::string const value = versionString; // NOLINT(readability-identifier-naming)
     return value;
 }
 
 std::string const&
 getClioFullVersionString()
 {
-    static std::string const value = "clio-" + getClioVersionString();
+    static std::string const value = "clio-" + getClioVersionString(); // NOLINT(readability-identifier-naming)
     return value;
 }
 
-}  // namespace Build
+}  // namespace util::build

cmake/ClangTidy.cmake

@@ -8,7 +8,7 @@ if (lint)
     endif ()
     message(STATUS "Using clang-tidy from CLIO_CLANG_TIDY_BIN")
   else ()
-    find_program(_CLANG_TIDY_BIN NAMES "clang-tidy-18" "clang-tidy" REQUIRED)
+    find_program(_CLANG_TIDY_BIN NAMES "clang-tidy-19" "clang-tidy" REQUIRED)
   endif ()
 
   if (NOT _CLANG_TIDY_BIN)

cmake/ClioVersion.cmake

@@ -45,4 +45,4 @@ 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)
+configure_file(${CMAKE_CURRENT_LIST_DIR}/Build.cpp.in ${CMAKE_CURRENT_LIST_DIR}/../src/util/build/Build.cpp)

cmake/Settings.cmake

@@ -39,7 +39,43 @@ if (is_appleclang)
   list(APPEND COMPILER_FLAGS -Wreorder-init-list)
 endif ()
 
+if (san)
+  # When building with sanitizers some compilers will actually produce extra warnings/errors. We don't want this yet, at
+  # least not until we have fixed all runtime issues reported by the sanitizers. Once that is done we can start removing
+  # some of these and trying to fix it in our codebase. We can never remove all of below because most of them are
+  # reported from deep inside libraries like boost or libxrpl.
+  #
+  # TODO: Address in https://github.com/XRPLF/clio/issues/1885
+  list(
+    APPEND
+    COMPILER_FLAGS
+    -Wno-error=tsan # Disables treating TSAN warnings as errors
+    -Wno-tsan # Disables TSAN warnings (thread-safety analysis)
+    -Wno-uninitialized # Disables warnings about uninitialized variables (AddressSanitizer, UndefinedBehaviorSanitizer,
+                       # etc.)
+    -Wno-stringop-overflow # Disables warnings about potential string operation overflows (AddressSanitizer)
+    -Wno-unsafe-buffer-usage # Disables warnings about unsafe memory operations (AddressSanitizer)
+    -Wno-frame-larger-than # Disables warnings about stack frame size being too large (AddressSanitizer)
+    -Wno-unused-function # Disables warnings about unused functions (LeakSanitizer, memory-related issues)
+    -Wno-unused-but-set-variable # Disables warnings about unused variables (MemorySanitizer)
+    -Wno-thread-safety-analysis # Disables warnings related to thread safety usage (ThreadSanitizer)
+    -Wno-thread-safety # Disables warnings related to thread safety usage (ThreadSanitizer)
+    -Wno-sign-compare # Disables warnings about signed/unsigned comparison (UndefinedBehaviorSanitizer)
+    -Wno-nonnull # Disables warnings related to null pointer dereferencing (UndefinedBehaviorSanitizer)
+    -Wno-address # Disables warnings about address-related issues (UndefinedBehaviorSanitizer)
+    -Wno-array-bounds # Disables array bounds checks (UndefinedBehaviorSanitizer)
+  )
+endif ()
+
 # See https://github.com/cpp-best-practices/cppbestpractices/blob/master/02-Use_the_Tools_Available.md#gcc--clang for
 # the flags description
 
+if (time_trace)
+  if (is_clang OR is_appleclang)
+    list(APPEND COMPILER_FLAGS -ftime-trace)
+  else ()
+    message(FATAL_ERROR "Clang or AppleClang is required to use `-ftime-trace`")
+  endif ()
+endif ()
+
 target_compile_options(clio_options INTERFACE ${COMPILER_FLAGS})

cmake/deps/libbacktrace.cmake

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

conanfile.py

@@ -1,6 +1,7 @@
 from conan import ConanFile
 from conan.tools.cmake import CMake, CMakeToolchain, cmake_layout
 
+
 class Clio(ConanFile):
     name = 'clio'
     license = 'ISC'
@@ -19,16 +20,19 @@ class Clio(ConanFile):
         '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
+        'snapshot': [True, False],            # build export/import snapshot tool
+        'time_trace': [True, False]           # build using -ftime-trace to create compiler trace reports
     }
 
     requires = [
-        'boost/1.82.0',
+        'boost/1.83.0',
         'cassandra-cpp-driver/2.17.0',
         'fmt/10.1.1',
         'protobuf/3.21.9',
         'grpc/1.50.1',
-        'openssl/1.1.1u',
-        'xrpl/2.2.0',
+        'openssl/1.1.1v',
+        'xrpl/2.4.0',
+        'zlib/1.3.1',
         'libbacktrace/cci.20210118'
     ]
 
@@ -43,7 +47,9 @@ class Clio(ConanFile):
         'coverage': False,
         'lint': False,
         'docs': False,
-        
+        'snapshot': False,
+        'time_trace': False,
+
         'xrpl/*:tests': False,
         'xrpl/*:rocksdb': False,
         'cassandra-cpp-driver/*:shared': False,
@@ -75,11 +81,12 @@ class Clio(ConanFile):
 
     def layout(self):
         cmake_layout(self)
-        # Fix this setting to follow the default introduced in Conan 1.48 
+        # Fix this setting to follow the default introduced in Conan 1.48
         # to align with our build instructions.
         self.folders.generators = 'build/generators'
 
     generators = 'CMakeDeps'
+
     def generate(self):
         tc = CMakeToolchain(self)
         tc.variables['verbose'] = self.options.verbose
@@ -91,6 +98,8 @@ class Clio(ConanFile):
         tc.variables['docs'] = self.options.docs
         tc.variables['packaging'] = self.options.packaging
         tc.variables['benchmark'] = self.options.benchmark
+        tc.variables['snapshot'] = self.options.snapshot
+        tc.variables['time_trace'] = self.options.time_trace
         tc.generate()
 
     def build(self):

docker/ci/Dockerfile

@@ -6,11 +6,12 @@ SHELL ["/bin/bash", "-c"]
 USER root
 WORKDIR /root
 
-ENV CCACHE_VERSION=4.8.3 \
-    LLVM_TOOLS_VERSION=18 \
+ENV CCACHE_VERSION=4.10.2 \
+    LLVM_TOOLS_VERSION=19 \
     GH_VERSION=2.40.0 \
-    DOXYGEN_VERSION=1.10.0
- 
+    DOXYGEN_VERSION=1.12.0 \
+    CLANG_BUILD_ANALYZER_VERSION=1.6.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 \
@@ -20,9 +21,8 @@ RUN apt-get -qq update \
 # Install packages
 RUN apt update -qq \
     && 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/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 \
+    clang-tidy-${LLVM_TOOLS_VERSION} clang-tools-${LLVM_TOOLS_VERSION} \
+    && pip3 install -q --upgrade --no-cache-dir pip && pip3 install -q --no-cache-dir conan==1.62 gcovr cmake==3.31.6 pre-commit \
     && apt-get clean && apt remove -y software-properties-common
 
 # Install gcc-12 and make ldconfig aware of the new libstdc++ location (for gcc)
@@ -62,8 +62,14 @@ RUN wget "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN
     && cmake --build . --target install \
     && rm -rf /tmp/* /var/tmp/*
 
+# Install ClangBuildAnalyzer
+RUN wget "https://github.com/aras-p/ClangBuildAnalyzer/releases/download/v${CLANG_BUILD_ANALYZER_VERSION}/ClangBuildAnalyzer-linux" \
+    && chmod +x ClangBuildAnalyzer-linux \
+    && mv ClangBuildAnalyzer-linux /usr/bin/ClangBuildAnalyzer \
+    && 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 \
+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 \
     && rm -rf /tmp/* /var/tmp/*
@@ -72,7 +78,7 @@ 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
+# https://docs.github.com/en/actions/sharing-automations/creating-actions/dockerfile-support-for-github-actions#user
 
 # Setup conan
 RUN conan remote add --insert 0 conan-non-prod http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod
@@ -95,6 +101,13 @@ RUN conan profile new clang --detect \
     && 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 
+    && 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
+
+COPY conan/gcc.asan /root/.conan/profiles
+COPY conan/gcc.tsan /root/.conan/profiles
+COPY conan/gcc.ubsan /root/.conan/profiles
+COPY conan/clang.asan /root/.conan/profiles
+COPY conan/clang.tsan /root/.conan/profiles
+COPY conan/clang.ubsan /root/.conan/profiles

docker/ci/README.md

@@ -0,0 +1,17 @@
+# CI image for XRPLF/clio
+
+This image contains an environment to build [Clio](https://github.com/XRPLF/clio), check code and documentation.
+It is used in [Clio Github Actions](https://github.com/XRPLF/clio/actions) but can also be used to compile Clio locally.
+
+The image is based on Ubuntu 20.04 and contains:
+
+- clang 16.0.6
+- gcc 12.3
+- doxygen 1.12
+- gh 2.40
+- ccache 4.10.2
+- conan 1.62
+- and some other useful tools
+
+Conan is set up to build Clio without any additional steps. There are two preset conan profiles: `clang` and `gcc` to use corresponding compiler. By default conan is setup to use `gcc`.
+Sanitizer builds for `ASAN`, `TSAN` and `UBSAN` are enabled via conan profiles for each of the supported compilers. These can be selected using the following pattern (all lowercase): `[compiler].[sanitizer]` (e.g. `--profile gcc.tsan`).

docker/ci/conan/clang.asan

@@ -0,0 +1,9 @@
+include(clang)
+
+[options]
+boost:extra_b2_flags="cxxflags=\"-fsanitize=address\" linkflags=\"-fsanitize=address\""
+boost:without_stacktrace=True
+[env]
+CFLAGS="-fsanitize=address"
+CXXFLAGS="-fsanitize=address"
+LDFLAGS="-fsanitize=address"

docker/ci/conan/clang.tsan

@@ -0,0 +1,9 @@
+include(clang)
+
+[options]
+boost:extra_b2_flags="cxxflags=\"-fsanitize=thread\" linkflags=\"-fsanitize=thread\""
+boost:without_stacktrace=True
+[env]
+CFLAGS="-fsanitize=thread"
+CXXFLAGS="-fsanitize=thread"
+LDFLAGS="-fsanitize=thread"

docker/ci/conan/clang.ubsan

@@ -0,0 +1,9 @@
+include(clang)
+
+[options]
+boost:extra_b2_flags="cxxflags=\"-fsanitize=undefined\" linkflags=\"-fsanitize=undefined\""
+boost:without_stacktrace=True
+[env]
+CFLAGS="-fsanitize=undefined"
+CXXFLAGS="-fsanitize=undefined"
+LDFLAGS="-fsanitize=undefined"

docker/ci/conan/gcc.asan

@@ -0,0 +1,9 @@
+include(gcc)
+
+[options]
+boost:extra_b2_flags="cxxflags=\"-fsanitize=address\" linkflags=\"-fsanitize=address\""
+boost:without_stacktrace=True
+[env]
+CFLAGS="-fsanitize=address"
+CXXFLAGS="-fsanitize=address"
+LDFLAGS="-fsanitize=address"

docker/ci/conan/gcc.tsan

@@ -0,0 +1,9 @@
+include(gcc)
+
+[options]
+boost:extra_b2_flags="cxxflags=\"-fsanitize=thread\" linkflags=\"-fsanitize=thread\""
+boost:without_stacktrace=True
+[env]
+CFLAGS="-fsanitize=thread"
+CXXFLAGS="-fsanitize=thread"
+LDFLAGS="-fsanitize=thread"

docker/ci/conan/gcc.ubsan

@@ -0,0 +1,9 @@
+include(gcc)
+
+[options]
+boost:extra_b2_flags="cxxflags=\"-fsanitize=undefined\" linkflags=\"-fsanitize=undefined\""
+boost:without_stacktrace=True
+[env]
+CFLAGS="-fsanitize=undefined"
+CXXFLAGS="-fsanitize=undefined"
+LDFLAGS="-fsanitize=undefined"

docker/clio/Dockerfile

@@ -0,0 +1,16 @@
+FROM ubuntu:22.04
+
+COPY ./clio_server /opt/clio/bin/clio_server
+
+RUN ln -s /opt/clio/bin/clio_server /usr/local/bin/clio_server && \
+    mkdir -p /opt/clio/etc/ && \
+    mkdir -p /opt/clio/log/ && \
+    groupadd -g 10001 clio && \
+    useradd -u 10000 -g 10001 -s /bin/bash clio && \
+    chown clio:clio /opt/clio/log && \
+    apt update && \
+    apt install -y libatomic1
+
+USER clio
+ENTRYPOINT ["/opt/clio/bin/clio_server"]
+CMD ["--conf", "/opt/clio/etc/config.json"]

docker/clio/README.md

@@ -0,0 +1,25 @@
+# Clio official docker image
+
+[Clio](https://github.com/XRPLF/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 space efficient format.
+
+This image contains `clio_server` binary allowing users to run Clio easily.
+
+## Clio configuration file
+
+Please note that while Clio requires a configuration file, this image doesn't include any default config.
+Your configuration file should be mounted under the path `/opt/clio/etc/config.json`.
+Clio repository provides an [example](https://github.com/XRPLF/clio/blob/develop/docs/examples/config/example-config.json) of the configuration file.
+
+Config file recommendations:
+
+- Set `log_to_console` to `false` if you want to avoid logs being written to `stdout`.
+- Set `log_directory` to `/opt/clio/log` to store logs in a volume.
+
+## Usage
+
+The following command can be used to run Clio in docker (assuming server's port is `51233` in your config):
+
+```bash
+docker run -d -v <path to your config.json>:/opt/clio/etc/config.json -v <path to store logs>:/opt/clio/log -p 51233:51233 rippleci/clio
+```

docker/compilers/clang-16/Dockerfile

@@ -1,4 +1,4 @@
-FROM ubuntu:focal 
+FROM ubuntu:focal
 ARG DEBIAN_FRONTEND=noninteractive
 ARG TARGETARCH
 

docker/compilers/gcc-12/Dockerfile

@@ -63,7 +63,7 @@ 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 
+    && 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 \

docker/develop/compose.yaml

@@ -1,7 +1,6 @@
-version: '3.7'
 services:
   clio_develop:
-    image: rippleci/clio_ci:latest
+    image: ghcr.io/xrplf/clio-ci:latest
     volumes:
       - clio_develop_conan_data:/root/.conan/data
       - clio_develop_ccache:/root/.ccache

docker/develop/run

@@ -59,4 +59,3 @@ case $1 in
 esac
 
 popd > /dev/null
-

docs/CMakeLists.txt

@@ -3,6 +3,8 @@ project(docs)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../cmake/ClioVersion.cmake)
 
+# cmake-format: off
 # Generate `docs` target for doxygen documentation
 # Note: use `cmake --build . --target docs` from your `build` directory to generate the documentation
+# cmake-format: on
 include(${CMAKE_CURRENT_SOURCE_DIR}/../cmake/Docs.cmake)

docs/Doxyfile

@@ -34,7 +34,7 @@ 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 
+                         ${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
 

docs/build-clio.md

@@ -11,7 +11,7 @@ Clio is built with [CMake](https://cmake.org/) and uses [Conan](https://conan.io
 - [**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      |
@@ -23,9 +23,9 @@ Clio does not require anything other than `compiler.cppstd=20` in your (`~/.cona
 > [!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:
+**Mac example**:
 
-```
+```text
 [settings]
 os=Macos
 os_build=Macos
@@ -40,9 +40,9 @@ compiler.cppstd=20
 tools.build:cxxflags+=["-DBOOST_ASIO_DISABLE_CONCEPTS"]
 ```
 
-> Linux example:
+**Linux example**:
 
-```
+```text
 [settings]
 os=Linux
 os_build=Linux
@@ -93,6 +93,8 @@ If successful, `conan install` will find the required packages and `cmake` will
 > [!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`.
 
+<!-- markdownlint-disable-line MD028 -->
+
 > [!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.
 
@@ -104,10 +106,10 @@ 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
-    ```
+   ```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:
 
@@ -118,16 +120,16 @@ To generate the API 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.
+   Open the `index.html` file in your browser to see the documentation pages.
 
-    ![API index page](./img/doxygen-docs-output.png "API index page")
+   ![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
+docker run -it ghcr.io/xrplf/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
@@ -141,3 +143,60 @@ If you wish to develop against a `rippled` instance running in standalone mode t
 
 1. Advance the `rippled` ledger to at least ledger 256.
 2. Wait 10 minutes before first starting Clio against this standalone node.
+
+## Building with a Custom `libxrpl`
+
+Sometimes, during development, you need to build against a custom version of `libxrpl`. (For example, you may be developing compatibility for a proposed amendment that is not yet merged to the main `rippled` codebase.) To build Clio with compatibility for a custom fork or branch of `rippled`, follow these steps:
+
+1. First, pull/clone the appropriate `rippled` fork and switch to the branch you want to build. For example, the following example uses an in-development build with [XLS-33d Multi-Purpose Tokens](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0033d-multi-purpose-tokens):
+
+   ```sh
+   git clone https://github.com/shawnxie999/rippled/
+   cd rippled
+   git switch mpt-1.1
+   ```
+
+2. Export a custom package to your local Conan store using a user/channel:
+
+   ```sh
+   conan export . my/feature
+   ```
+
+3. Patch your local Clio build to use the right package.
+
+   Edit `conanfile.py` (from the Clio repository root). Replace the `xrpl` requirement with the custom package version from the previous step. This must also include the current version number from your `rippled` branch. For example:
+
+   ```py
+   # ... (excerpt from conanfile.py)
+       requires = [
+       'boost/1.82.0',
+       'cassandra-cpp-driver/2.17.0',
+       'fmt/10.1.1',
+       'protobuf/3.21.9',
+       'grpc/1.50.1',
+       'openssl/1.1.1u',
+       'xrpl/2.3.0-b1@my/feature', # Update this line
+       'libbacktrace/cci.20210118'
+   ]
+   ```
+
+4. Build Clio as you would have before.
+
+   See [Building Clio](#building-clio) for details.
+
+## Using `clang-tidy` for static analysis
+
+The minimum [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) version required is 19.0.
+
+Clang-tidy can be run by Cmake when building the project. To achieve this, you just need to provide the option `-o lint=True` for the `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 to use your desired binary, set the `CLIO_CLANG_TIDY_BIN` environment variable to the path of the `clang-tidy` binary. For example:
+
+```sh
+export CLIO_CLANG_TIDY_BIN=/opt/homebrew/opt/llvm@19/bin/clang-tidy
+```

docs/config-description.md

@@ -0,0 +1,592 @@
+# Clio Config Description
+
+This document provides a list of all available Clio configuration properties in detail.
+
+> [!NOTE]
+> Dot notation in configuration key names represents nested fields. For example, **database.scylladb** refers to the _scylladb_ field inside the _database_ object. If a key name includes "[]", it indicates that the nested field is an array (e.g., etl_sources.[]).
+
+## Configuration Details
+
+### database.type
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `cassandra`
+- **Constraints**: The value must be one of the following: `cassandra`.
+- **Description**: Specifies the type of database used for storing and retrieving data required by the Clio server. Both ScyllaDB and Cassandra can serve as backends for Clio; however, this value must be set to `cassandra`.
+
+### database.cassandra.contact_points
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `localhost`
+- **Constraints**: None
+- **Description**: A list of IP addresses or hostnames for the initial cluster nodes (Cassandra or ScyllaDB) that the client connects to when establishing a database connection. If you're running Clio locally, set this value to `localhost` or `127.0.0.1`.
+
+### database.cassandra.secure_connect_bundle
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The configuration file that contains the necessary credentials and connection details for securely connecting to a Cassandra database cluster.
+
+### database.cassandra.port
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The port number used to connect to the Cassandra database.
+
+### database.cassandra.keyspace
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `clio`
+- **Constraints**: None
+- **Description**: The Cassandra keyspace to use for the database. If you don't provide a value, this is set to `clio` by default.
+
+### database.cassandra.replication_factor
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `3`
+- **Constraints**: The minimum value is `0`. The maximum value is `65535`.
+- **Description**: Represents the number of replicated nodes for ScyllaDB. For more details see [Fault Tolerance Replication Factor](https://university.scylladb.com/courses/scylla-essentials-overview/lessons/high-availability/topic/fault-tolerance-replication-factor/).
+
+### database.cassandra.table_prefix
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: An optional field to specify a prefix for the Cassandra database table names.
+
+### database.cassandra.max_write_requests_outstanding
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `10000`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: Represents the maximum number of outstanding write requests. Write requests are API calls that write to the database.
+
+### database.cassandra.max_read_requests_outstanding
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `100000`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: Maximum number of outstanding read requests. Read requests are API calls that read from the database.
+
+### database.cassandra.threads
+
+- **Required**: True
+- **Type**: int
+- **Default value**: The number of available CPU cores.
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: Represents the number of threads that will be used for database operations.
+
+### database.cassandra.core_connections_per_host
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1`
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The number of core connections per host for the Cassandra database.
+
+### database.cassandra.queue_size_io
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: Defines the queue size of the input/output (I/O) operations in Cassandra.
+
+### database.cassandra.write_batch_size
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `20`
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: Represents the batch size for write operations in Cassandra.
+
+### database.cassandra.connect_timeout
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The maximum amount of time in seconds that the system waits for a database connection to be established.
+
+### database.cassandra.request_timeout
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The maximum amount of time in seconds that the system waits for a request to be fetched from the database.
+
+### database.cassandra.username
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The username used for authenticating with the database.
+
+### database.cassandra.password
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The password used for authenticating with the database.
+
+### database.cassandra.certfile
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The path to the SSL/TLS certificate file used to establish a secure connection between the client and the Cassandra database.
+
+### allow_no_etl
+
+- **Required**: True
+- **Type**: boolean
+- **Default value**: `True`
+- **Constraints**: None
+- **Description**: If set to `True`, allows Clio to start without any ETL source.
+
+### etl_sources.[].ip
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: The value must be a valid IP address.
+- **Description**: The IP address of the ETL source.
+
+### etl_sources.[].ws_port
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The WebSocket port of the ETL source.
+
+### etl_sources.[].grpc_port
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The gRPC port of the ETL source.
+
+### forwarding.cache_timeout
+
+- **Required**: True
+- **Type**: double
+- **Default value**: `0`
+- **Constraints**: The value must be a positive double number.
+- **Description**: Specifies the timeout duration (in seconds) for the forwarding cache used in `rippled` communication. A value of `0` means disabling this feature.
+
+### forwarding.request_timeout
+
+- **Required**: True
+- **Type**: double
+- **Default value**: `10`
+- **Constraints**: The value must be a positive double number.
+- **Description**: Specifies the timeout duration (in seconds) for the forwarding request used in `rippled` communication.
+
+### rpc.cache_timeout
+
+- **Required**: True
+- **Type**: double
+- **Default value**: `0`
+- **Constraints**: The value must be a positive double number.
+- **Description**: Specifies the timeout duration (in seconds) for RPC cache response to timeout. A value of `0` means disabling this feature.
+
+### num_markers
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `256`.
+- **Description**: Specifies the number of coroutines used to download the initial ledger.
+
+### dos_guard.whitelist.[]
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The list of IP addresses to whitelist for DOS protection.
+
+### dos_guard.max_fetches
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1000000`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The maximum number of fetch operations allowed by DOS guard.
+
+### dos_guard.max_connections
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `20`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The maximum number of concurrent connections for a specific IP address.
+
+### dos_guard.max_requests
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `20`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The maximum number of requests allowed for a specific IP address.
+
+### dos_guard.sweep_interval
+
+- **Required**: True
+- **Type**: double
+- **Default value**: `1`
+- **Constraints**: The value must be a positive double number.
+- **Description**: Interval in seconds for DOS guard to sweep(clear) its state.
+
+### workers
+
+- **Required**: True
+- **Type**: int
+- **Default value**: The number of available CPU cores.
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The number of threads used to process RPC requests.
+
+### server.ip
+
+- **Required**: True
+- **Type**: string
+- **Default value**: None
+- **Constraints**: The value must be a valid IP address.
+- **Description**: The IP address of the Clio HTTP server.
+
+### server.port
+
+- **Required**: True
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The port number of the Clio HTTP server.
+
+### server.max_queue_size
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The maximum size of the server's request queue. If set to `0`, this means there is no queue size limit.
+
+### server.local_admin
+
+- **Required**: False
+- **Type**: boolean
+- **Default value**: None
+- **Constraints**: None
+- **Description**: Indicates if requests from `localhost` are allowed to call Clio admin-only APIs. Note that this setting cannot be enabled together with [server.admin_password](#serveradmin_password).
+
+### server.admin_password
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The password for Clio admin-only APIs. Note that this setting cannot be enabled together with [server.local_admin](#serveradmin_password).
+
+### server.processing_policy
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `parallel`
+- **Constraints**: The value must be one of the following: `parallel`, `sequent`.
+- **Description**: For the `sequent` policy, requests from a single client connection are processed one by one, with the next request read only after the previous one is processed. For the `parallel` policy, Clio will accept all requests and process them in parallel, sending a reply for each request as soon as it is ready.
+
+### server.parallel_requests_limit
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: This is an optional parameter, used only if the `processing_strategy` is `parallel`. It limits the number of requests processed in parallel for a single client connection. If not specified, no limit is enforced.
+
+### server.ws_max_sending_queue_size
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1500`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: Maximum queue size for sending subscription data to clients. This queue buffers data when a client is slow to receive it, ensuring delivery once the client is ready.
+
+### prometheus.enabled
+
+- **Required**: True
+- **Type**: boolean
+- **Default value**: `False`
+- **Constraints**: None
+- **Description**: Enables or disables Prometheus metrics.
+
+### prometheus.compress_reply
+
+- **Required**: True
+- **Type**: boolean
+- **Default value**: `False`
+- **Constraints**: None
+- **Description**: Enables or disables compression of Prometheus responses.
+
+### io_threads
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `2`
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The number of input/output (I/O) threads. The value cannot be less than `1`.
+
+### subscription_workers
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The number of worker threads or processes that are responsible for managing and processing subscription-based tasks from `rippled`.
+
+### graceful_period
+
+- **Required**: True
+- **Type**: double
+- **Default value**: `10`
+- **Constraints**: The value must be a positive double number.
+- **Description**: The number of milliseconds the server waits to shutdown gracefully. If Clio does not shutdown gracefully after the specified value, it will be killed instead.
+
+### cache.num_diffs
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `32`
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The number of cursors generated is the number of changed (without counting deleted) objects in the latest `cache.num_diffs` number of ledgers. Cursors are workers that load the ledger cache from the position of markers concurrently. For more information, please read [README.md](../src/etl/README.md).
+
+### cache.num_markers
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `48`
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: Specifies how many markers are placed randomly within the cache. These markers define the positions on the ledger that will be loaded concurrently by the workers. The higher the number, the more places within the cache we potentially cover.
+
+### cache.num_cursors_from_diff
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `0`
+- **Constraints**: The minimum value is `0`. The maximum value is `65535`.
+- **Description**: `cache.num_cursors_from_diff` number of cursors are generated by looking at the number of changed objects in the most recent ledger. If number of changed objects in current ledger is not enough, it will keep reading previous ledgers until it hit `cache.num_cursors_from_diff`. If set to `0`, the system defaults to generating cursors based on `cache.num_diffs`.
+
+### cache.num_cursors_from_account
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `0`
+- **Constraints**: The minimum value is `0`. The maximum value is `65535`.
+- **Description**: `cache.num_cursors_from_diff` of cursors are generated by reading accounts in `account_tx` table. If set to `0`, the system defaults to generating cursors based on `cache.num_diffs`.
+
+### cache.page_fetch_size
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `512`
+- **Constraints**: The minimum value is `1`. The maximum value is `65535`.
+- **Description**: The number of ledger objects to fetch concurrently per marker.
+
+### cache.load
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `async`
+- **Constraints**: The value must be one of the following: `sync`, `async`, `none`.
+- **Description**: The strategy used for Cache loading.
+
+### log_channels.[].channel
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: The value must be one of the following: `General`, `WebServer`, `Backend`, `RPC`, `ETL`, `Subscriptions`, `Performance`, `Migration`.
+- **Description**: The name of the log channel.
+
+### log_channels.[].log_level
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: The value must be one of the following: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `count`.
+- **Description**: The log level for the specific log channel.
+
+### log_level
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `info`
+- **Constraints**: The value must be one of the following: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `count`.
+- **Description**: The general logging level of Clio. This level is applied to all log channels that do not have an explicitly defined logging level.
+
+### log_format
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `%TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message%`
+- **Constraints**: None
+- **Description**: The format string for log messages. The format is described here: <https://www.boost.org/doc/libs/1_83_0/libs/log/doc/html/log/tutorial/formatters.html>.
+
+### log_to_console
+
+- **Required**: True
+- **Type**: boolean
+- **Default value**: `True`
+- **Constraints**: None
+- **Description**: Enables or disables logging to the console.
+
+### log_directory
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The directory path for the log files.
+
+### log_rotation_size
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `2048`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The log rotation size in megabytes. When the log file reaches this particular size, a new log file starts.
+
+### log_directory_max_size
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `51200`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The maximum size of the log directory in megabytes.
+
+### log_rotation_hour_interval
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `12`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: Represents the interval (in hours) for log rotation. If the current log file reaches this value in logging, a new log file starts.
+
+### log_tag_style
+
+- **Required**: True
+- **Type**: string
+- **Default value**: `none`
+- **Constraints**: The value must be one of the following: `int`, `uint`, `null`, `none`, `uuid`.
+- **Description**: Log tags are unique identifiers for log messages. `uint`/`int` starts logging from 0 and increments, making it faster. In contrast, `uuid` generates a random unique identifier, which adds overhead.
+
+### extractor_threads
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: Number of threads used to extract data from ETL source.
+
+### read_only
+
+- **Required**: True
+- **Type**: boolean
+- **Default value**: `True`
+- **Constraints**: None
+- **Description**: Indicates if the server is allowed to write data to the database.
+
+### start_sequence
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: If specified, the ledger index Clio will start writing to the database from.
+
+### finish_sequence
+
+- **Required**: False
+- **Type**: int
+- **Default value**: None
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: If specified, the final ledger that Clio will write to the database.
+
+### ssl_cert_file
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The path to the SSL certificate file.
+
+### ssl_key_file
+
+- **Required**: False
+- **Type**: string
+- **Default value**: None
+- **Constraints**: None
+- **Description**: The path to the SSL key file.
+
+### api_version.default
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1`
+- **Constraints**: The minimum value is `1`. The maximum value is `3`.
+- **Description**: The default API version that the Clio server will run on.
+
+### api_version.min
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `1`
+- **Constraints**: The minimum value is `1`. The maximum value is `3`.
+- **Description**: The minimum API version allowed to use.
+
+### api_version.max
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `3`
+- **Constraints**: The minimum value is `1`. The maximum value is `3`.
+- **Description**: The maximum API version allowed to use.
+
+### migration.full_scan_threads
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `2`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The number of threads used to scan the table.
+
+### migration.full_scan_jobs
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `4`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The number of coroutines used to scan the table.
+
+### migration.cursors_per_job
+
+- **Required**: True
+- **Type**: int
+- **Default value**: `100`
+- **Constraints**: The minimum value is `1`. The maximum value is `4294967295`.
+- **Description**: The number of cursors each job will scan.

docs/configure-clio.md

@@ -18,7 +18,8 @@ Clio needs access to a `rippled` server in order to work. The following configur
 
    - A port to handle gRPC requests, with the IP(s) of Clio specified in the `secure_gateway` entry
 
-The example configs of [rippled](https://github.com/XRPLF/rippled/blob/develop/cfg/rippled-example.cfg) and [Clio](../docs/examples/config/example-config.json) are set up in a way that minimal changes are required.
+The example configs of [rippled](https://github.com/XRPLF/rippled/blob/develop/cfg/rippled-example.cfg) and [Clio](../docs/examples/config/example-config.json) are set up in a way that minimal changes are required. However, if you want to view all configuration keys available in Clio, see [config-description.md](./config-description.md).
+
 When running locally, the only change needed is to uncomment the `port_grpc` section of the `rippled` config.
 
 If you're running Clio and `rippled` on separate machines, in addition to uncommenting the `port_grpc` section, a few other steps must be taken:
@@ -52,7 +53,7 @@ Here is an example snippet from the config file:
 
 ## SSL
 
-The parameters `ssl_cert_file` and `ssl_key_file` can also be added to the top level of precedence of our Clio config. The `ssl_cert_file` field 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. 
+The parameters `ssl_cert_file` and `ssl_key_file` can also be added to the top level of precedence of our Clio config. The `ssl_cert_file` field 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:
 

docs/examples/config/cloud-example-config.json

@@ -1,43 +0,0 @@
-/*
- * This is an example configuration file. Please do not use without modifying to suit your needs.
- */
-{
-    "database": {
-        "type": "cassandra",
-        "cassandra": {
-            // This option can be used to setup a secure connect bundle connection
-            "secure_connect_bundle": "[path/to/zip. ignore if using contact_points]",
-            // The following options are used only if using contact_points
-            "contact_points": "[ip. ignore if using secure_connect_bundle]",
-            "port": "[port. ignore if using_secure_connect_bundle]",
-            // Authentication settings
-            "username": "[username, if any]",
-            "password": "[password, if any]",
-            // Other common settings
-            "keyspace": "clio",
-            "max_write_requests_outstanding": 25000,
-            "max_read_requests_outstanding": 30000,
-            "threads": 8
-        }
-    },
-    "etl_sources": [
-        {
-            "ip": "[rippled ip]",
-            "ws_port": "6006",
-            "grpc_port": "50051"
-        }
-    ],
-    "dos_guard": {
-        "whitelist": [
-            "127.0.0.1"
-        ]
-    },
-    "server": {
-        "ip": "0.0.0.0",
-        "port": 8080
-    },
-    "log_level": "debug",
-    "log_file": "./clio.log",
-    "extractor_threads": 8,
-    "read_only": false
-}

docs/examples/config/example-config.json

@@ -2,135 +2,144 @@
  * This is an example configuration file. Please do not use without modifying to suit your needs.
  */
 {
-    "database": {
-        "type": "cassandra",
-        "cassandra": {
-            "contact_points": "127.0.0.1",
-            "port": 9042,
-            "keyspace": "clio",
-            "replication_factor": 1,
-            "table_prefix": "",
-            "max_write_requests_outstanding": 25000,
-            "max_read_requests_outstanding": 30000,
-            "threads": 8,
-            //
-            // Advanced options. USE AT OWN RISK:
-            // ---
-            "core_connections_per_host": 1, // Defaults to 1
-            "write_batch_size": 20 // Defaults to 20
-            //
-            // Below options will use defaults from cassandra driver if left unspecified.
-            // See https://docs.datastax.com/en/developer/cpp-driver/2.17/api/struct.CassCluster/ for details.
-            // 
-            // "queue_size_io": 2
-            //
-            // ---
-        }
-    },
-    "allow_no_etl": false, // Allow Clio to run without valid ETL source, otherwise Clio will stop if ETL check fails
-    "etl_sources": [
-        {
-            "ip": "127.0.0.1",
-            "ws_port": "6006",
-            "grpc_port": "50051"
-        }
-    ],
-    "forwarding": {
-        "cache_timeout": 0.250, // in seconds, could be 0, which means no cache
-        "request_timeout": 10.0 // time for Clio to wait for rippled to reply on a forwarded request (default is 10 seconds)
-    },
-    "dos_guard": {
-        // Comma-separated list of IPs to exclude from rate limiting
-        "whitelist": [
-            "127.0.0.1"
-        ],
-        //
-        // The below values are the default values and are only specified here
-        // for documentation purposes. The rate limiter currently limits
-        // connections and bandwidth per IP. The rate limiter looks at the raw
-        // IP of a client connection, and so requests routed through a load
-        // balancer will all have the same IP and be treated as a single client.
-        //
-        "max_fetches": 1000000, // Max bytes per IP per sweep interval
-        "max_connections": 20, // Max connections per IP
-        "max_requests": 20, // Max connections per IP per sweep interval
-        "sweep_interval": 1 // Time in seconds before resetting max_fetches and max_requests
-    },
-    "server": {
-        "ip": "0.0.0.0",
-        "port": 51233,
-        // Max number of requests to queue up before rejecting further requests.
-        // Defaults to 0, which disables the limit.
-        "max_queue_size": 500,
-        // If request contains header with authorization, Clio will check if it matches the prefix 'Password ' + this value's sha256 hash
-        // If matches, the request will be considered as admin request
-        "admin_password": "xrp",
-        // If local_admin is true, Clio will consider requests come from 127.0.0.1 as admin requests
-        // It's true by default unless admin_password is set,'local_admin' : true and 'admin_password' can not be set at the same time
-        "local_admin": false
-    },
-    // Time in seconds for graceful shutdown. Defaults to 10 seconds. Not fully implemented yet.
-    "graceful_period": 10.0,
-    // Overrides log level on a per logging channel.
-    // Defaults to global "log_level" for each unspecified channel.
-    "log_channels": [
-        {
-            "channel": "Backend",
-            "log_level": "fatal"
-        },
-        {
-            "channel": "WebServer",
-            "log_level": "info"
-        },
-        {
-            "channel": "Subscriptions",
-            "log_level": "info"
-        },
-        {
-            "channel": "RPC",
-            "log_level": "error"
-        },
-        {
-            "channel": "ETL",
-            "log_level": "debug"
-        },
-        {
-            "channel": "Performance",
-            "log_level": "trace"
-        }
-    ],
-    "cache": {
-        // Configure this to use either "num_diffs", "num_cursors_from_diff", or "num_cursors_from_account". By default, Clio uses "num_diffs".
-        "num_diffs": 32, // Generate the cursors from the latest ledger diff, then use the cursors to partition the ledger to load concurrently. The cursors number is affected by the busyness of the network.
-        // "num_cursors_from_diff": 3200, // Read the cursors from the diff table until we have enough cursors to partition the ledger to load concurrently. 
-        // "num_cursors_from_account": 3200, // Read the cursors from the account table until we have enough cursors to partition the ledger to load concurrently.
-        "num_markers": 48, // The number of markers is the number of coroutines to load the cache concurrently.
-        "page_fetch_size": 512, // The number of rows to load for each page.
-        "load": "async" // "sync" to load cache synchronously  or "async" to load cache asynchronously or "none"/"no" to turn off the cache.
-    },
-    "prometheus": {
-        "enabled": true,
-        "compress_reply": true
-    },
-    "log_level": "info",
-    // Log format (this is the default format)
-    "log_format": "%TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message%",
-    "log_to_console": true,
-    // Clio logs to file in the specified directory only if "log_directory" is set
-    // "log_directory": "./clio_log",
-    "log_rotation_size": 2048,
-    "log_directory_max_size": 51200,
-    "log_rotation_hour_interval": 12,
-    "log_tag_style": "uint",
-    "extractor_threads": 8,
-    "read_only": false,
-    // "start_sequence": [integer] the ledger index to start from,
-    // "finish_sequence": [integer] the ledger index to finish at,
-    // "ssl_cert_file" : "/full/path/to/cert.file",
-    // "ssl_key_file" : "/full/path/to/key.file"
-    "api_version": {
-        "min": 1, // Minimum API version supported (could be 1 or 2)
-        "max": 2, // Maximum API version supported (could be 1 or 2, but >= min)
-        "default": 1 // Clio behaves the same as rippled by default
+  "database": {
+    "type": "cassandra",
+    "cassandra": {
+      "contact_points": "127.0.0.1",
+      "port": 9042,
+      "keyspace": "clio",
+      "replication_factor": 1,
+      "table_prefix": "",
+      "max_write_requests_outstanding": 25000,
+      "max_read_requests_outstanding": 30000,
+      "threads": 8,
+      //
+      // Advanced options. USE AT OWN RISK:
+      // ---
+      "core_connections_per_host": 1, // Defaults to 1
+      "write_batch_size": 20 // Defaults to 20
+      //
+      // Below options will use defaults from cassandra driver if left unspecified.
+      // See https://docs.datastax.com/en/developer/cpp-driver/2.17/api/struct.CassCluster/ for details.
+      //
+      // "queue_size_io": 2
+      //
+      // ---
     }
+  },
+  "allow_no_etl": false, // Allow Clio to run without valid ETL source, otherwise Clio will stop if ETL check fails
+  "etl_sources": [
+    {
+      "ip": "127.0.0.1",
+      "ws_port": "6005",
+      "grpc_port": "50051"
+    }
+  ],
+  "forwarding": {
+    "cache_timeout": 0.25, // in seconds, could be 0, which means no cache
+    "request_timeout": 10.0 // time for Clio to wait for rippled to reply on a forwarded request (default is 10 seconds)
+  },
+  "rpc": {
+    "cache_timeout": 0.5 // in seconds, could be 0, which means no cache for rpc
+  },
+  "dos_guard": {
+    // Comma-separated list of IPs to exclude from rate limiting
+    "whitelist": ["127.0.0.1"],
+    //
+    // The below values are the default values and are only specified here
+    // for documentation purposes. The rate limiter currently limits
+    // connections and bandwidth per IP. The rate limiter looks at the raw
+    // IP of a client connection, and so requests routed through a load
+    // balancer will all have the same IP and be treated as a single client.
+    //
+    "max_fetches": 1000000, // Max bytes per IP per sweep interval
+    "max_connections": 20, // Max connections per IP
+    "max_requests": 20, // Max connections per IP per sweep interval
+    "sweep_interval": 1 // Time in seconds before resetting max_fetches and max_requests
+  },
+  "server": {
+    "ip": "0.0.0.0",
+    "port": 51233,
+    // Max number of requests to queue up before rejecting further requests.
+    // Defaults to 0, which disables the limit.
+    "max_queue_size": 500,
+    // If request contains header with authorization, Clio will check if it matches the prefix 'Password ' + this value's sha256 hash
+    // If matches, the request will be considered as admin request
+    "admin_password": "xrp",
+    // If local_admin is true, Clio will consider requests come from 127.0.0.1 as admin requests
+    // It's true by default unless admin_password is set,'local_admin' : true and 'admin_password' can not be set at the same time
+    "local_admin": false,
+    "processing_policy": "parallel", // Could be "sequent" or "parallel".
+    // For sequent policy request from one client connection will be processed one by one and the next one will not be read before
+    // the previous one is processed. For parallel policy Clio will take all requests and process them in parallel and
+    // send a reply for each request whenever it is ready.
+    "parallel_requests_limit": 10, // Optional parameter, used only if "processing_strategy" is "parallel". It limits the number of requests for one client connection processed in parallel. Infinite if not specified.
+    // Max number of responses to queue up before sent successfully. If a client's waiting queue is too long, the server will close the connection.
+    "ws_max_sending_queue_size": 1500,
+    "__ng_web_server": false // Use ng web server. This is a temporary setting which will be deleted after switching to ng web server
+  },
+  // Time in seconds for graceful shutdown. Defaults to 10 seconds. Not fully implemented yet.
+  "graceful_period": 10.0,
+  // Overrides log level on a per logging channel.
+  // Defaults to global "log_level" for each unspecified channel.
+  "log_channels": [
+    {
+      "channel": "Backend",
+      "log_level": "fatal"
+    },
+    {
+      "channel": "WebServer",
+      "log_level": "info"
+    },
+    {
+      "channel": "Subscriptions",
+      "log_level": "info"
+    },
+    {
+      "channel": "RPC",
+      "log_level": "error"
+    },
+    {
+      "channel": "ETL",
+      "log_level": "debug"
+    },
+    {
+      "channel": "Performance",
+      "log_level": "trace"
+    }
+  ],
+  "cache": {
+    // Configure this to use either "num_diffs", "num_cursors_from_diff", or "num_cursors_from_account". By default, Clio uses "num_diffs".
+    "num_diffs": 32, // Generate the cursors from the latest ledger diff, then use the cursors to partition the ledger to load concurrently. The cursors number is affected by the busyness of the network.
+    // "num_cursors_from_diff": 3200, // Read the cursors from the diff table until we have enough cursors to partition the ledger to load concurrently.
+    // "num_cursors_from_account": 3200, // Read the cursors from the account table until we have enough cursors to partition the ledger to load concurrently.
+    "num_markers": 48, // The number of markers is the number of coroutines to load the cache concurrently.
+    "page_fetch_size": 512, // The number of rows to load for each page.
+    "load": "async" // "sync" to load cache synchronously  or "async" to load cache asynchronously or "none"/"no" to turn off the cache.
+  },
+  "prometheus": {
+    "enabled": true,
+    "compress_reply": true
+  },
+  "log_level": "info",
+  // Log format (this is the default format)
+  "log_format": "%TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message%",
+  "log_to_console": true,
+  // Clio logs to file in the specified directory only if "log_directory" is set
+  // "log_directory": "./clio_log",
+  "log_rotation_size": 2048,
+  "log_directory_max_size": 51200,
+  "log_rotation_hour_interval": 12,
+  "log_tag_style": "uint",
+  "extractor_threads": 8,
+  "read_only": false,
+  // "start_sequence": [integer] the ledger index to start from,
+  // "finish_sequence": [integer] the ledger index to finish at,
+  // "ssl_cert_file" : "/full/path/to/cert.file",
+  // "ssl_key_file" : "/full/path/to/key.file"
+  "api_version": {
+    "min": 1, // Minimum API version supported (could be 1 or 2)
+    "max": 2, // Maximum API version supported (could be 1 or 2, but >= min)
+    "default": 1 // Clio behaves the same as rippled by default
+  }
 }

docs/examples/infrastructure/README.md

@@ -1,10 +1,15 @@
 # Example of clio monitoring infrastructure
 
+> [!WARNING]
+> This is only an example of Grafana dashboard for Clio. It was created for demonstration purposes only and may contain errors.
+> Clio team would not recommend to relate on data from this dashboard or use it for monitoring your Clio instances.
+
 This directory contains an example of docker based infrastructure to collect and visualise metrics from clio.
 
 The structure of the directory:
+
 - `compose.yaml`
-   Docker-compose file with Prometheus and Grafana set up.
+  Docker-compose file with Prometheus and Grafana set up.
 - `prometheus.yaml`
   Defines metrics collection from Clio and Prometheus itself.
   Demonstrates how to setup Clio target and Clio's admin authorisation in Prometheus.
@@ -20,6 +25,6 @@ The structure of the directory:
 1. Make sure you have `docker` and `docker-compose` installed.
 2. Run `docker-compose up -d` from this directory. It will start docker containers with Prometheus and Grafana.
 3. Open [http://localhost:3000/dashboards](http://localhost:3000/dashboards). Grafana login `admin`, password `grafana`.
-There will be preconfigured Clio dashboard.
+   There will be preconfigured Clio dashboard.
 
 If Clio is not running yet launch Clio to see metrics. Some of the metrics may appear only after requests to Clio.

docs/examples/infrastructure/compose.yaml

@@ -6,7 +6,7 @@ services:
     volumes:
       - ./prometheus.yaml:/etc/prometheus/prometheus.yml
     command:
-      - '--config.file=/etc/prometheus/prometheus.yml'
+      - "--config.file=/etc/prometheus/prometheus.yml"
   grafana:
     image: grafana/grafana
     ports:

docs/examples/infrastructure/grafana/clio_dashboard.json

@@ -20,7 +20,6 @@
   "graphTooltip": 0,
   "id": 1,
   "links": [],
-  "liveNow": false,
   "panels": [
     {
       "datasource": {
@@ -79,10 +78,9 @@
         "graphMode": "area",
         "justifyMode": "auto",
         "orientation": "auto",
+        "percentChangeColorMode": "standard",
         "reduceOptions": {
-          "calcs": [
-            "lastNotNull"
-          ],
+          "calcs": ["lastNotNull"],
           "fields": "",
           "values": false
         },
@@ -90,7 +88,7 @@
         "textMode": "auto",
         "wideLayout": true
       },
-      "pluginVersion": "10.4.0",
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -159,10 +157,9 @@
         "graphMode": "area",
         "justifyMode": "auto",
         "orientation": "auto",
+        "percentChangeColorMode": "standard",
         "reduceOptions": {
-          "calcs": [
-            "lastNotNull"
-          ],
+          "calcs": ["lastNotNull"],
           "fields": "",
           "values": false
         },
@@ -170,7 +167,7 @@
         "textMode": "auto",
         "wideLayout": true
       },
-      "pluginVersion": "10.4.0",
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -243,10 +240,9 @@
         "graphMode": "area",
         "justifyMode": "auto",
         "orientation": "auto",
+        "percentChangeColorMode": "standard",
         "reduceOptions": {
-          "calcs": [
-            "lastNotNull"
-          ],
+          "calcs": ["lastNotNull"],
           "fields": "",
           "values": false
         },
@@ -254,7 +250,7 @@
         "textMode": "auto",
         "wideLayout": true
       },
-      "pluginVersion": "10.4.0",
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -327,10 +323,9 @@
         "graphMode": "area",
         "justifyMode": "auto",
         "orientation": "auto",
+        "percentChangeColorMode": "standard",
         "reduceOptions": {
-          "calcs": [
-            "lastNotNull"
-          ],
+          "calcs": ["lastNotNull"],
           "fields": "",
           "values": false
         },
@@ -338,7 +333,7 @@
         "textMode": "auto",
         "wideLayout": true
       },
-      "pluginVersion": "10.4.0",
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -373,6 +368,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -435,6 +431,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -491,6 +488,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -552,6 +550,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -586,6 +585,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -647,6 +647,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -681,6 +682,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -742,6 +744,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -776,6 +779,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -837,6 +841,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -872,6 +877,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -934,6 +940,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -941,7 +948,7 @@
             "uid": "PBFA97CFB590B2093"
           },
           "editorMode": "code",
-          "expr": "rpc_method_duration_us{job=\"clio\"}",
+          "expr": "sum by (method) (increase(rpc_method_duration_us[$__interval]))\n / \n sum by (method,) (increase(rpc_method_total_number{status=\"finished\"}[$__interval]))",
           "instant": false,
           "legendFormat": "{{method}}",
           "range": true,
@@ -968,6 +975,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -1029,6 +1037,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -1063,6 +1072,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -1124,6 +1134,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -1158,6 +1169,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 10,
             "gradientMode": "none",
@@ -1223,7 +1235,7 @@
           "sort": "none"
         }
       },
-      "pluginVersion": "10.2.0",
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -1296,6 +1308,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -1357,6 +1370,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -1384,7 +1398,7 @@
           "refId": "B"
         }
       ],
-      "title": "DB Opperations Error Rate",
+      "title": "DB Operations Error Rate",
       "type": "timeseries"
     },
     {
@@ -1404,6 +1418,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -1465,6 +1480,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -1510,6 +1526,7 @@
             "axisLabel": "",
             "axisPlacement": "auto",
             "barAlignment": 0,
+            "barWidthFactor": 0.6,
             "drawStyle": "line",
             "fillOpacity": 0,
             "gradientMode": "none",
@@ -1572,6 +1589,7 @@
           "sort": "none"
         }
       },
+      "pluginVersion": "11.4.0",
       "targets": [
         {
           "datasource": {
@@ -1590,8 +1608,9 @@
       "type": "timeseries"
     }
   ],
+  "preload": false,
   "refresh": "5s",
-  "schemaVersion": 39,
+  "schemaVersion": 40,
   "tags": [],
   "templating": {
     "list": []

docs/examples/infrastructure/grafana/dashboard_local.yaml

@@ -1,13 +1,13 @@
 apiVersion: 1
 
 providers:
-  - name: 'Clio dashboard'
+  - name: "Clio dashboard"
     # <int> Org id. Default to 1
     orgId: 1
     # <string> name of the dashboard folder.
-    folder: ''
+    folder: ""
     # <string> folder UID. will be automatically generated if not specified
-    folderUid: ''
+    folderUid: ""
     # <string> provider type. Default to 'file'
     type: file
     # <bool> disable dashboard deletion

docs/examples/infrastructure/grafana/datasources.yaml

@@ -1,8 +1,8 @@
 apiVersion: 1
 
 datasources:
-- name: Prometheus
-  type: prometheus
-  url: http://prometheus:9090
-  isDefault: true
-  access: proxy
+  - name: Prometheus
+    type: prometheus
+    url: http://prometheus:9090
+    isDefault: true
+    access: proxy

docs/examples/infrastructure/prometheus.yaml

@@ -1,19 +1,19 @@
 scrape_configs:
-- job_name: clio
-  scrape_interval: 5s
-  scrape_timeout: 5s
-  authorization:
-    type: Password
-    # sha256sum from password `xrp`
-    # use echo -n 'your_password' | shasum -a 256 to get hash
-    credentials: 0e1dcf1ff020cceabf8f4a60a32e814b5b46ee0bb8cd4af5c814e4071bd86a18
-  static_configs:
-  - targets:
-    -  host.docker.internal:51233
-- job_name: prometheus
-  honor_timestamps: true
-  scrape_interval: 15s
-  scrape_timeout: 10s
-  static_configs:
-  - targets:
-    - localhost:9090
+  - job_name: clio
+    scrape_interval: 5s
+    scrape_timeout: 5s
+    authorization:
+      type: Password
+      # sha256sum from password `xrp`
+      # use echo -n 'your_password' | shasum -a 256 to get hash
+      credentials: 0e1dcf1ff020cceabf8f4a60a32e814b5b46ee0bb8cd4af5c814e4071bd86a18
+    static_configs:
+      - targets:
+          - host.docker.internal:51233
+  - job_name: prometheus
+    honor_timestamps: true
+    scrape_interval: 15s
+    scrape_timeout: 10s
+    static_configs:
+      - targets:
+          - localhost:9090

docs/logging.md

@@ -8,12 +8,12 @@ The minimum level of severity at which the log message will be outputted by defa
 
 ## `log_format`
 
- The format of log lines produced by Clio. Defaults to `"%TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message%"`.
+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`)  
+- `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
@@ -30,8 +30,8 @@ Each object is of this format:
 
 ```json
 {
-    "channel": "Backend",
-    "log_level": "fatal"
+  "channel": "Backend",
+  "log_level": "fatal"
 }
 ```
 

docs/metrics-and-static-analysis.md

@@ -1,30 +0,0 @@
-# Metrics and static analysis
-
-## Prometheus metrics collection
-
-Clio natively supports [Prometheus](https://prometheus.io/) metrics collection. It accepts Prometheus requests on the port configured in the `server` section of the config.
-
-Prometheus metrics are enabled by default, and replies to `/metrics` are compressed. To disable compression, and have human readable metrics, add `"prometheus": { "enabled": true, "compress_reply": false }` to Clio's config.
-
-To completely disable Prometheus metrics add `"prometheus": { "enabled": false }` to Clio's config.
-
-It is important to know that Clio responds to Prometheus request only if they are admin requests. If you are using the admin password feature, the same password should be provided in the Authorization header of Prometheus requests.
-
-You can find an example docker-compose file, with Prometheus and Grafana configs, in [examples/infrastructure](../docs/examples/infrastructure/).
-
-## Using `clang-tidy` for static analysis
-
-The minimum [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) version required is 17.0.
-
-Clang-tidy can be run by Cmake when building the project. To achieve this, you just need to provide the option `-o lint=True` for the `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 to use your desired binary, set the `CLIO_CLANG_TIDY_BIN` environment variable to the path of the `clang-tidy` binary. For example:
-
-```sh
-export CLIO_CLANG_TIDY_BIN=/opt/homebrew/opt/llvm@17/bin/clang-tidy
-```

docs/run-clio.md

@@ -3,10 +3,11 @@
 ## Prerequisites
 
 - Access to a Cassandra cluster or ScyllaDB cluster. Can be local or remote.
-> [!IMPORTANT]
-> There are some key considerations when using **ScyllaDB**. By default, Scylla reserves 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.
->
-> See [ScyllaDB in a Shared Environment](https://docs.scylladb.com/getting-started/scylla-in-a-shared-environment/) to learn more.
+
+  > [!IMPORTANT]
+  > There are some key considerations when using **ScyllaDB**. By default, Scylla reserves 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.
+  >
+  > See [ScyllaDB in a Shared Environment](https://docs.scylladb.com/getting-started/scylla-in-a-shared-environment/) to learn more.
 
 - Access to one or more `rippled` nodes. Can be local or remote.
 
@@ -80,3 +81,15 @@ Clio will fallback to hardcoded defaults when these values are not specified in
 
 > [!TIP]
 > See the [example-config.json](../docs/examples/config/example-config.json) for more details.
+
+## Prometheus metrics collection
+
+Clio natively supports [Prometheus](https://prometheus.io/) metrics collection. It accepts Prometheus requests on the port configured in the `server` section of the config.
+
+Prometheus metrics are enabled by default, and replies to `/metrics` are compressed. To disable compression, and have human readable metrics, add `"prometheus": { "enabled": true, "compress_reply": false }` to Clio's config.
+
+To completely disable Prometheus metrics add `"prometheus": { "enabled": false }` to Clio's config.
+
+It is important to know that Clio responds to Prometheus request only if they are admin requests. If you are using the admin password feature, the same password should be provided in the Authorization header of Prometheus requests.
+
+You can find an example docker-compose file, with Prometheus and Grafana configs, in [examples/infrastructure](../docs/examples/infrastructure/).

docs/trouble_shooting.md

@@ -1,47 +1,60 @@
 # Troubleshooting Guide
+
 This guide will help you troubleshoot common issues of Clio.
 
 ## Can't connect to DB
+
 If you see the error log message `Could not connect to Cassandra: No hosts available`, this means that Clio can't connect to the database. Check the following:
+
 - Make sure the database is running at the specified address and port.
 - Make sure the database is accessible from the machine where Clio is running.
-You can use [cqlsh](https://pypi.org/project/cqlsh/) to check the connection to the database.
+  You can use [cqlsh](https://pypi.org/project/cqlsh/) to check the connection to the database.
+
 If you would like to run a local ScyllaDB, you can call:
+
 ```sh
-docker run --rm -p 9042:9042 --name clio-scylla -d scylladb/scylla 
+docker run --rm -p 9042:9042 --name clio-scylla -d scylladb/scylla
 ```
 
 ## Check the server status of Clio
+
 To check if Clio is syncing with rippled:
+
 ```sh
 curl -v -d '{"method":"server_info", "params":[{}]}' 127.0.0.1:51233|python3 -m json.tool|grep seq
 ```
+
 If Clio is syncing with rippled, the `seq` value will be increasing.
 
 ## Clio fails to start
+
 If you see the error log message `Failed to fetch ETL state from...`, this means the configured rippled node is not reachable. Check the following:
+
 - Make sure the rippled node is running at the specified address and port.
 - Make sure the rippled node is accessible from the machine where Clio is running.
 
-If you would like to run Clio without an avaliable rippled node, you can add below setting to Clio's configuration file:
-```
+If you would like to run Clio without an available rippled node, you can add below setting to Clio's configuration file:
+
+```text
 "allow_no_etl": true
 ```
 
 ## Clio is not added to secure_gateway in rippled's config
+
 If you see the warning message `AsyncCallData is_unlimited is false.`, this means that Clio is not added to the `secure_gateway` of `port_grpc` session in the rippled configuration file. It will slow down the sync process. Please add Clio's IP to the `secure_gateway` in the rippled configuration file for both grpc and ws port.
 
 ## Clio is slow
+
 To speed up the response time, Clio has a cache inside. However, cache can take time to warm up. If you see slow response time, you can firstly check if cache is still loading.
 You can check the cache status by calling:
+
 ```sh
 curl -v -d '{"method":"server_info", "params":[{}]}' 127.0.0.1:51233|python3 -m json.tool|grep is_full
 curl -v -d '{"method":"server_info", "params":[{}]}' 127.0.0.1:51233|python3 -m json.tool|grep is_enabled
 ```
-If `is_full` is false, it means the cache is still loading. Normally, the Clio can respond quicker if cache finishs loading. If `is_enabled` is false, it means the cache is disabled in the configuration file or there is data corruption in the database. 
+
+If `is_full` is false, it means the cache is still loading. Normally, the Clio can respond quicker if cache finishes loading. If `is_enabled` is false, it means the cache is disabled in the configuration file or there is data corruption in the database.
 
 ## Receive error message `Too many requests`
+
 If client sees the error message `Too many requests`, this means that the client is blocked by Clio's DosGuard protection. You may want to add the client's IP to the whitelist in the configuration file, Or update other your DosGuard settings.
-
-
-

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

@@ -2,7 +2,7 @@
 
 # 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.
+# Not really a hook but should be used to check the completeness 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..."
@@ -13,14 +13,42 @@ TMPDIR=${ROOT}/.cache/doxygen
 TMPFILE=${TMPDIR}/docs.log
 DOCDIR=${TMPDIR}/out
 
+# Check doxygen is at all installed
 if [ -z "$DOXYGEN" ]; then
+    if [[ "${CI}" == "true" ]]; then
+        # If we are in CI, we should fail the check
+        echo "doxygen not found in CI, please install it"
+        exit 1
+    fi
+
     # 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.
+        Please install it for next time.
+
+        Your changes may fail to pass CI once pushed.
+-----------------------------------------------------------------------------
+
+EOF
+    exit 0
+fi
+
+# Check version of doxygen is at least 1.12
+version=$($DOXYGEN --version | grep -o '[0-9\.]*')
+
+if [[ "1.12.0" > "$version" ]]; then
+    # No hard error if doxygen version is not the one we want - let CI deal with it
+    cat <<EOF
+
+                                    ERROR
+-----------------------------------------------------------------------------
+        A minimum of version 1.12 of `which doxygen` is required.
+        Your version is $version. Please upgrade it for next time.
+
+        Your changes may fail to pass CI once pushed.
 -----------------------------------------------------------------------------
 
 EOF

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

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# Note: This script is intended to be run from the root of the repository.
+#
+# This script checks will fix local includes in the C++ code.
+
+# paths to fix include statements
+sources="src tests"
+
+echo "+ Fixing local includes..."
+
+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

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

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+#
+# Capture and print stdout, since gofmt doesn't use proper exit codes
+#
+set -e -o pipefail
+
+if ! command -v gofmt &> /dev/null ; then
+    echo "gofmt not installed or available in the PATH" >&2
+    exit 1
+fi
+
+output="$(gofmt -l -w "$@")"
+echo "$output"
+[[ -z "$output" ]]

pre-commit-hooks/verify-commits.sh

@@ -0,0 +1,54 @@
+#!/bin/sh
+
+
+# git for-each-ref refs/tags  # see which tags are annotated and which are lightweight. Annotated tags are "tag" objects.
+# # Set these so your commits and tags are always signed
+# git config commit.gpgsign true
+# git config tag.gpgsign true
+
+verify_commit_signed() {
+    if git verify-commit HEAD &> /dev/null; then
+        :
+        # echo "HEAD commit seems signed..."
+    else
+        echo "HEAD commit isn't signed!"
+        exit 1
+    fi
+}
+
+verify_tag() {
+    if git describe --exact-match --tags HEAD &> /dev/null; then
+        : # You might be ok to push
+        # echo "Tag is annotated."
+        return 0
+    else
+        echo "Tag for [$version] not an annotated tag."
+        exit 1
+    fi
+}
+
+verify_tag_signed() {
+    if git verify-tag "$version" &> /dev/null ; then
+        : # ok, I guess we'll let you push
+        # echo "Tag appears signed"
+        return 0
+    else
+        echo "$version tag isn't signed"
+        echo "Sign it with [git tag -ams\"$version\" $version]"
+        exit 1
+    fi
+}
+
+while read local_ref local_oid remote_ref remote_oid; do
+    # Check some things if we're pushing a branch called "release/"
+    if echo "$remote_ref" | grep ^refs\/heads\/release\/ &> /dev/null ; then
+        version=$(git tag --points-at HEAD)
+        echo "Looks like you're trying to push a $version release..."
+        echo "Making sure you've signed and tagged it."
+        if verify_commit_signed && verify_tag && verify_tag_signed ; then
+            : # Ok, I guess you can push
+        else
+            exit 1
+        fi
+    fi
+done

src/CMakeLists.txt

@@ -1,7 +1,11 @@
 add_subdirectory(util)
 add_subdirectory(data)
+add_subdirectory(cluster)
 add_subdirectory(etl)
+add_subdirectory(etlng)
 add_subdirectory(feed)
 add_subdirectory(rpc)
 add_subdirectory(web)
+add_subdirectory(migration)
+add_subdirectory(app)
 add_subdirectory(main)