concurrent access

This reverts commit 94decc753b.

.clang-format

@@ -1,4 +1,20 @@
 ---
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterClass: true
+  AfterControlStatement: true
+  AfterEnum: false
+  AfterFunction: true
+  AfterNamespace: false
+  AfterObjCDeclaration: true
+  AfterStruct: true
+  AfterUnion: true
+  BeforeCatch: true
+  BeforeElse: true
+  IndentBraces: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 1
+---
 Language: Cpp
 AccessModifierOffset: -4
 AlignAfterOpenBracket: AlwaysBreak
@@ -18,20 +34,7 @@ AlwaysBreakBeforeMultilineStrings: true
 AlwaysBreakTemplateDeclarations: true
 BinPackArguments: false
 BinPackParameters: false
-BraceWrapping:
-  AfterClass: true
-  AfterControlStatement: true
-  AfterEnum: false
-  AfterFunction: true
-  AfterNamespace: false
-  AfterObjCDeclaration: true
-  AfterStruct: true
-  AfterUnion: true
-  BeforeCatch: true
-  BeforeElse: true
-  IndentBraces: false
 BreakBeforeBinaryOperators: false
-BreakBeforeBraces: Custom
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializersBeforeComma: true
 ColumnLimit: 80
@@ -66,8 +69,6 @@ IndentFunctionDeclarationAfterType: false
 IndentRequiresClause: true
 IndentWidth: 4
 IndentWrappedFunctionNames: false
-KeepEmptyLinesAtTheStartOfBlocks: false
-MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
 ObjCSpaceAfterProperty: false
 ObjCSpaceBeforeProtocolList: false
@@ -96,7 +97,7 @@ TabWidth: 8
 UseTab: Never
 QualifierAlignment: Right
 ---
-Language: JavaScript
----
-Language: Json
+Language: Proto
+BasedOnStyle: Google
+ColumnLimit: 0
 IndentWidth: 2

.git-blame-ignore-revs

@@ -12,3 +12,5 @@ fe9a5365b8a52d4acc42eb27369247e6f238a4f9
 9a93577314e6a8d4b4a8368cc9d2b15a5d8303e8
 552377c76f55b403a1c876df873a23d780fcc81c
 97f0747e103f13e26e45b731731059b32f7679ac
+b13370ac0d207217354f1fc1c29aef87769fb8a1
+896b8c3b54a22b0497cb0d1ce95e1095f9a227ce

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

@@ -0,0 +1,62 @@
+# This action installs and optionally uploads Conan dependencies to a remote
+# repository. The dependencies will only be uploaded if the credentials are
+# provided.
+name: Build Conan dependencies
+
+# Note that actions do not support 'type' and all inputs are strings, see
+# https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax#inputs.
+inputs:
+  build_dir:
+    description: "The directory where to build."
+    required: true
+  build_type:
+    description: 'The build type to use ("Debug", "Release").'
+    required: true
+  conan_remote_name:
+    description: "The name of the Conan remote to use."
+    required: true
+  conan_remote_url:
+    description: "The URL of the Conan endpoint to use."
+    required: true
+  conan_remote_username:
+    description: "The username for logging into the Conan remote. If not provided, the dependencies will not be uploaded."
+    required: false
+    default: ""
+  conan_remote_password:
+    description: "The password for logging into the Conan remote. If not provided, the dependencies will not be uploaded."
+    required: false
+    default: ""
+  force_build:
+    description: 'Force building of all dependencies ("true", "false").'
+    required: false
+    default: "false"
+  force_upload:
+    description: 'Force uploading of all dependencies ("true", "false").'
+    required: false
+    default: "false"
+
+runs:
+  using: composite
+  steps:
+    - name: Install Conan dependencies
+      shell: bash
+      run: |
+        echo 'Installing dependencies.'
+        mkdir -p ${{ inputs.build_dir }}
+        cd ${{ inputs.build_dir }}
+        conan install \
+          --output-folder . \
+          --build ${{ inputs.force_build == 'true' && '"*"' || 'missing' }} \
+          --options:host '&:tests=True' \
+          --options:host '&:xrpld=True' \
+          --settings:all build_type=${{ inputs.build_type }} \
+          --format=json ..
+    - name: Upload Conan dependencies
+      if: ${{ inputs.conan_remote_username != '' && inputs.conan_remote_password != '' }}
+      shell: bash
+      working-directory: ${{ inputs.build_dir }}
+      run: |
+        echo "Logging into Conan remote '${{ inputs.conan_remote_name }}' at ${{ inputs.conan_remote_url }}."
+        conan remote login ${{ inputs.conan_remote_name }} "${{ inputs.conan_remote_username }}" --password "${{ inputs.conan_remote_password }}"
+        echo 'Uploading dependencies.'
+        conan upload '*' --confirm --check ${{ inputs.force_upload == 'true' && '--force' || '' }} --remote=${{ inputs.conan_remote_name }}

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

@@ -0,0 +1,95 @@
+# This action build and tests the binary. The Conan dependencies must have
+# already been installed (see the build-deps action).
+name: Build and Test
+
+# Note that actions do not support 'type' and all inputs are strings, see
+# https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax#inputs.
+inputs:
+  build_dir:
+    description: "The directory where to build."
+    required: true
+  build_only:
+    description: 'Whether to only build or to build and test the code ("true", "false").'
+    required: false
+    default: "false"
+  build_type:
+    description: 'The build type to use ("Debug", "Release").'
+    required: true
+  cmake_args:
+    description: "Additional arguments to pass to CMake."
+    required: false
+    default: ""
+  cmake_target:
+    description: "The CMake target to build."
+    required: true
+  codecov_token:
+    description: "The Codecov token to use for uploading coverage reports."
+    required: false
+    default: ""
+  os:
+    description: 'The operating system to use for the build ("linux", "macos", "windows").'
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Configure CMake
+      shell: bash
+      working-directory: ${{ inputs.build_dir }}
+      run: |
+        echo 'Configuring CMake.'
+        cmake \
+          -G '${{ inputs.os == 'windows' && 'Visual Studio 17 2022' || 'Ninja' }}' \
+          -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake \
+          -DCMAKE_BUILD_TYPE=${{ inputs.build_type }} \
+          ${{ inputs.cmake_args }} \
+          ..
+    - name: Build the binary
+      shell: bash
+      working-directory: ${{ inputs.build_dir }}
+      run: |
+        echo 'Building binary.'
+        cmake \
+          --build . \
+          --config ${{ inputs.build_type }} \
+          --parallel $(nproc) \
+          --target ${{ inputs.cmake_target }}
+    - name: Check linking
+      if: ${{ inputs.os == 'linux' }}
+      shell: bash
+      working-directory: ${{ inputs.build_dir }}
+      run: |
+        echo 'Checking linking.'
+        ldd ./rippled
+        if [ "$(ldd ./rippled | grep -E '(libstdc\+\+|libgcc)' | wc -l)" -eq 0 ]; then
+          echo 'The binary is statically linked.'
+        else
+          echo 'The binary is dynamically linked.'
+          exit 1
+        fi
+    - name: Verify voidstar
+      if: ${{ contains(inputs.cmake_args, '-Dvoidstar=ON') }}
+      shell: bash
+      working-directory: ${{ inputs.build_dir }}
+      run: |
+        echo 'Verifying presence of instrumentation.'
+        ./rippled --version | grep libvoidstar
+    - name: Test the binary
+      if: ${{ inputs.build_only == 'false' }}
+      shell: bash
+      working-directory: ${{ inputs.build_dir }}/${{ inputs.os == 'windows' && inputs.build_type || '' }}
+      run: |
+        echo 'Testing binary.'
+        ./rippled --unittest --unittest-jobs $(nproc)
+        ctest -j $(nproc) --output-on-failure
+    - name: Upload coverage report
+      if: ${{ inputs.cmake_target == 'coverage' }}
+      uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
+      with:
+        disable_search: true
+        disable_telem: true
+        fail_ci_if_error: true
+        files: ${{ inputs.build_dir }}/coverage.xml
+        plugins: noop
+        token: ${{ inputs.codecov_token }}
+        verbose: true

.github/actions/build/action.yml

@@ -1,34 +0,0 @@
-name: build
-inputs:
-  generator:
-    default: null
-  configuration:
-    required: true
-  cmake-args:
-    default: null
-  cmake-target:
-    default: all
-# An implicit input is the environment variable `build_dir`.
-runs:
-  using: composite
-  steps:
-    - name: configure
-      shell: bash
-      run: |
-        cd ${build_dir}
-        cmake \
-          ${{ inputs.generator && format('-G "{0}"', inputs.generator) || '' }} \
-          -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake \
-          -DCMAKE_BUILD_TYPE=${{ inputs.configuration }} \
-          -Dtests=TRUE \
-          -Dxrpld=TRUE \
-          ${{ inputs.cmake-args }} \
-          ..
-    - name: build
-      shell: bash
-      run: |
-        cmake \
-          --build ${build_dir} \
-          --config ${{ inputs.configuration }} \
-          --parallel ${NUM_PROCESSORS:-$(nproc)} \
-          --target ${{ inputs.cmake-target }}

.github/actions/dependencies/action.yml

@@ -1,38 +0,0 @@
-name: dependencies
-inputs:
-  configuration:
-    required: true
-# Implicit inputs are the environment variables `build_dir`, CONAN_REMOTE_URL,
-# CONAN_REMOTE_USERNAME, and CONAN_REMOTE_PASSWORD. The latter two are only
-# used to upload newly built dependencies to the Conan remote.
-runs:
-  using: composite
-  steps:
-    - name: add Conan remote
-      if: ${{ env.CONAN_REMOTE_URL != '' }}
-      shell: bash
-      run: |
-        echo "Adding Conan remote 'xrplf' at ${{ env.CONAN_REMOTE_URL }}."
-        conan remote add --index 0 --force xrplf ${{ env.CONAN_REMOTE_URL }}
-        echo "Listing Conan remotes."
-        conan remote list
-    - name: install dependencies
-      shell: bash
-      run: |
-        mkdir -p ${{ env.build_dir }}
-        cd ${{ env.build_dir }}
-        conan install \
-          --output-folder . \
-          --build missing \
-          --options:host "&:tests=True" \
-          --options:host "&:xrpld=True" \
-          --settings:all build_type=${{ inputs.configuration }} \
-          ..
-    - name: upload dependencies
-      if: ${{ env.CONAN_REMOTE_URL != '' && env.CONAN_REMOTE_USERNAME != '' && env.CONAN_REMOTE_PASSWORD != '' && github.ref_type == 'branch' && github.ref_name == github.event.repository.default_branch }}
-      shell: bash
-      run: |
-        echo "Logging into Conan remote 'xrplf' at ${{ env.CONAN_REMOTE_URL }}."
-        conan remote login xrplf "${{ env.CONAN_REMOTE_USERNAME }}" --password "${{ env.CONAN_REMOTE_PASSWORD }}"
-        echo "Uploading dependencies."
-        conan upload '*' --confirm --check --remote xrplf

.github/scripts/levelization/README.md

@@ -50,7 +50,7 @@ that `test` code should _never_ be included in `ripple` code.)
 
 ## Validation
 
-The [levelization.sh](levelization.sh) script takes no parameters,
+The [levelization](generate.sh) script takes no parameters,
 reads no environment variables, and can be run from any directory,
 as long as it is in the expected location in the rippled repo.
 It can be run at any time from within a checked out repo, and will
@@ -72,15 +72,15 @@ It generates many files of [results](results):
   desired as described above. In a perfect repo, this file will be
   empty.
   This file is committed to the repo, and is used by the [levelization
-  Github workflow](../../.github/workflows/levelization.yml) to validate
+  Github workflow](../../workflows/check-levelization.yml) to validate
   that nothing changed.
 - [`ordering.txt`](results/ordering.txt): A list showing relationships
   between modules where there are no loops as they actually exist, as
   opposed to how they are desired as described above.
   This file is committed to the repo, and is used by the [levelization
-  Github workflow](../../.github/workflows/levelization.yml) to validate
+  Github workflow](../../workflows/check-levelization.yml) to validate
   that nothing changed.
-- [`levelization.yml`](../../.github/workflows/levelization.yml)
+- [`levelization.yml`](../../workflows/check-levelization.yml)
   Github Actions workflow to test that levelization loops haven't
   changed. Unfortunately, if changes are detected, it can't tell if
   they are improvements or not, so if you have resolved any issues or
@@ -111,4 +111,4 @@ get those details locally.
 1. Run `levelization.sh`
 2. Grep the modules in `paths.txt`.
    - For example, if a cycle is found `A ~= B`, simply `grep -w
-A Builds/levelization/results/paths.txt | grep -w B`
+A .github/scripts/levelization/results/paths.txt | grep -w B`

.github/scripts/levelization/generate.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Usage: levelization.sh
+# Usage: generate.sh
 # This script takes no parameters, reads no environment variables,
 # and can be run from any directory, as long as it is in the expected
 # location in the repo.
@@ -19,7 +19,7 @@ export LANG=C
 rm -rfv results
 mkdir results
 includes="$( pwd )/results/rawincludes.txt"
-pushd ../..
+pushd ../../..
 echo Raw includes:
 grep -r '^[ ]*#include.*/.*\.h' include src | \
     grep -v boost | tee ${includes}

.github/scripts/strategy-matrix/generate.py

@@ -0,0 +1,174 @@
+#!/usr/bin/env python3
+import argparse
+import itertools
+import json
+import re
+
+'''
+Generate a strategy matrix for GitHub Actions CI.
+
+On each PR commit we will build a selection of Debian, RHEL, Ubuntu, MacOS, and
+Windows configurations, while upon merge into the develop, release, or master
+branches, we will build all configurations, and test most of them.
+
+We will further set additional CMake arguments as follows:
+- All builds will have the `tests`, `werr`, and `xrpld` options.
+- All builds will have the `wextra` option except for GCC 12 and Clang 16.
+- All release builds will have the `assert` option.
+- Certain Debian Bookworm configurations will change the reference fee, enable
+  codecov, and enable voidstar in PRs.
+'''
+def generate_strategy_matrix(all: bool, architecture: list[dict], os: list[dict], build_type: list[str], cmake_args: list[str]) -> dict:
+    configurations = []
+    for architecture, os, build_type, cmake_args in itertools.product(architecture, os, build_type, cmake_args):
+        # The default CMake target is 'all' for Linux and MacOS and 'install'
+        # for Windows, but it can get overridden for certain configurations.
+        cmake_target = 'install' if os["distro_name"] == 'windows' else 'all'
+
+        # We build and test all configurations by default, except for Windows in
+        # Debug, because it is too slow, as well as when code coverage is
+        # enabled as that mode already runs the tests.
+        build_only = False
+        if os['distro_name'] == 'windows' and build_type == 'Debug':
+            build_only = True
+
+        # Only generate a subset of configurations in PRs.
+        if not all:
+            # Debian:
+            # - Bookworm using GCC 13: Release and Unity on linux/arm64, set
+            #   the reference fee to 500.
+            # - Bookworm using GCC 15: Debug and no Unity on linux/amd64, enable
+            #   code coverage.
+            # - Bookworm using Clang 16: Debug and no Unity on linux/arm64,
+            #   enable voidstar.
+            # - Bookworm using Clang 17: Release and no Unity on linux/amd64,
+            #   set the reference fee to 1000.
+            # - Bookworm using Clang 20: Debug and Unity on linux/amd64.
+            if os['distro_name'] == 'debian':
+                skip = True
+                if os['distro_version'] == 'bookworm':
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'gcc-13' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/arm64':
+                        cmake_args = f'-DUNIT_TEST_REFERENCE_FEE=500 {cmake_args}'
+                        skip = False
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'gcc-15' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/amd64':
+                        cmake_args = f'-Dcoverage=ON -Dcoverage_format=xml -DCODE_COVERAGE_VERBOSE=ON -DCMAKE_C_FLAGS=-O0 -DCMAKE_CXX_FLAGS=-O0 {cmake_args}'
+                        cmake_target = 'coverage'
+                        build_only = True
+                        skip = False
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'clang-16' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/arm64':
+                        cmake_args = f'-Dvoidstar=ON {cmake_args}'
+                        skip = False
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'clang-17' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
+                        cmake_args = f'-DUNIT_TEST_REFERENCE_FEE=1000 {cmake_args}'
+                        skip = False
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'clang-20' and build_type == 'Debug' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
+                        skip = False
+                if skip:
+                    continue
+
+            # RHEL:
+            # - 9.4 using GCC 12: Debug and Unity on linux/amd64.
+            # - 9.6 using Clang: Release and no Unity on linux/amd64.
+            if os['distro_name'] == 'rhel':
+                skip = True
+                if os['distro_version'] == '9.4':
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'gcc-12' and build_type == 'Debug' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
+                        skip = False
+                elif os['distro_version'] == '9.6':
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'clang-any' and build_type == 'Release' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/amd64':
+                        skip = False
+                if skip:
+                    continue
+
+            # Ubuntu:
+            # - Jammy using GCC 12: Debug and no Unity on linux/arm64.
+            # - Noble using GCC 14: Release and Unity on linux/amd64.
+            # - Noble using Clang 18: Debug and no Unity on linux/amd64.
+            # - Noble using Clang 19: Release and Unity on linux/arm64.
+            if os['distro_name'] == 'ubuntu':
+                skip = True
+                if os['distro_version'] == 'jammy':
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'gcc-12' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/arm64':
+                        skip = False
+                elif os['distro_version'] == 'noble':
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'gcc-14' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
+                        skip = False
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'clang-18' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/amd64':
+                        skip = False
+                    if f'{os['compiler_name']}-{os['compiler_version']}' == 'clang-19' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/arm64':
+                        skip = False
+                if skip:
+                    continue
+
+            # MacOS:
+            # - Debug and no Unity on macos/arm64.
+            if os['distro_name'] == 'macos' and not (build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'macos/arm64'):
+                continue
+
+            # Windows:
+            # - Release and Unity on windows/amd64.
+            if os['distro_name'] == 'windows' and not (build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'windows/amd64'):
+                continue
+
+
+        # Additional CMake arguments.
+        cmake_args = f'{cmake_args} -Dtests=ON -Dwerr=ON -Dxrpld=ON'
+        if not f'{os['compiler_name']}-{os['compiler_version']}' in ['gcc-12', 'clang-16']:
+            cmake_args = f'{cmake_args} -Dwextra=ON'
+        if build_type == 'Release':
+            cmake_args = f'{cmake_args} -Dassert=ON'
+
+        # We skip all RHEL on arm64 due to a build failure that needs further
+        # investigation.
+        if os['distro_name'] == 'rhel' and architecture['platform'] == 'linux/arm64':
+            continue
+
+        # We skip all clang-20 on arm64 due to boost 1.86 build error
+        if f'{os['compiler_name']}-{os['compiler_version']}' == 'clang-20' and architecture['platform'] == 'linux/arm64':
+            continue
+
+        # Generate a unique name for the configuration, e.g. macos-arm64-debug
+        # or debian-bookworm-gcc-12-amd64-release-unity.
+        config_name = os['distro_name']
+        if (n := os['distro_version']) != '':
+            config_name += f'-{n}'
+        if (n := os['compiler_name']) != '':
+            config_name += f'-{n}'
+        if (n := os['compiler_version']) != '':
+            config_name += f'-{n}'
+        config_name += f'-{architecture['platform'][architecture['platform'].find('/')+1:]}'
+        config_name += f'-{build_type.lower()}'
+        if '-Dunity=ON' in cmake_args:
+            config_name += '-unity'
+
+        # Add the configuration to the list, with the most unique fields first,
+        # so that they are easier to identify in the GitHub Actions UI, as long
+        # names get truncated.
+        configurations.append({
+            'config_name': config_name,
+            'cmake_args': cmake_args,
+            'cmake_target': cmake_target,
+            'build_only': 'true' if build_only else 'false',
+            'build_type': build_type,
+            'os': os,
+            'architecture': architecture,
+        })
+
+    return {'include': configurations}
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-a', '--all', help='Set to generate all configurations (generally used when merging a PR) or leave unset to generate a subset of configurations (generally used when committing to a PR).', action="store_true")
+    parser.add_argument('-c', '--config', help='Path to the JSON file containing the strategy matrix configurations.', required=True, type=str)
+    args = parser.parse_args()
+
+    # Load the JSON configuration file.
+    config = None
+    with open(args.config, 'r') as f:
+        config = json.load(f)
+    if config['architecture'] is None or config['os'] is None or config['build_type'] is None or config['cmake_args'] is None:
+        raise Exception('Invalid configuration file.')
+
+    # Generate the strategy matrix.
+    print(f'matrix={json.dumps(generate_strategy_matrix(args.all, config['architecture'], config['os'], config['build_type'], config['cmake_args']))}')

.github/scripts/strategy-matrix/linux.json

@@ -0,0 +1,154 @@
+{
+  "architecture": [
+    {
+      "platform": "linux/amd64",
+      "runner": ["self-hosted", "Linux", "X64", "heavy"]
+    },
+    {
+      "platform": "linux/arm64",
+      "runner": ["self-hosted", "Linux", "ARM64", "heavy-arm64"]
+    }
+  ],
+  "os": [
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "gcc",
+      "compiler_version": "12"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "gcc",
+      "compiler_version": "13"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "gcc",
+      "compiler_version": "14"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "gcc",
+      "compiler_version": "15"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "clang",
+      "compiler_version": "16"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "clang",
+      "compiler_version": "17"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "clang",
+      "compiler_version": "18"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "clang",
+      "compiler_version": "19"
+    },
+    {
+      "distro_name": "debian",
+      "distro_version": "bookworm",
+      "compiler_name": "clang",
+      "compiler_version": "20"
+    },
+    {
+      "distro_name": "rhel",
+      "distro_version": "9.4",
+      "compiler_name": "gcc",
+      "compiler_version": "12"
+    },
+    {
+      "distro_name": "rhel",
+      "distro_version": "9.4",
+      "compiler_name": "gcc",
+      "compiler_version": "13"
+    },
+    {
+      "distro_name": "rhel",
+      "distro_version": "9.4",
+      "compiler_name": "gcc",
+      "compiler_version": "14"
+    },
+    {
+      "distro_name": "rhel",
+      "distro_version": "9.6",
+      "compiler_name": "gcc",
+      "compiler_version": "13"
+    },
+    {
+      "distro_name": "rhel",
+      "distro_version": "9.6",
+      "compiler_name": "gcc",
+      "compiler_version": "14"
+    },
+    {
+      "distro_name": "rhel",
+      "distro_version": "9.4",
+      "compiler_name": "clang",
+      "compiler_version": "any"
+    },
+    {
+      "distro_name": "rhel",
+      "distro_version": "9.6",
+      "compiler_name": "clang",
+      "compiler_version": "any"
+    },
+    {
+      "distro_name": "ubuntu",
+      "distro_version": "jammy",
+      "compiler_name": "gcc",
+      "compiler_version": "12"
+    },
+    {
+      "distro_name": "ubuntu",
+      "distro_version": "noble",
+      "compiler_name": "gcc",
+      "compiler_version": "13"
+    },
+    {
+      "distro_name": "ubuntu",
+      "distro_version": "noble",
+      "compiler_name": "gcc",
+      "compiler_version": "14"
+    },
+    {
+      "distro_name": "ubuntu",
+      "distro_version": "noble",
+      "compiler_name": "clang",
+      "compiler_version": "16"
+    },
+    {
+      "distro_name": "ubuntu",
+      "distro_version": "noble",
+      "compiler_name": "clang",
+      "compiler_version": "17"
+    },
+    {
+      "distro_name": "ubuntu",
+      "distro_version": "noble",
+      "compiler_name": "clang",
+      "compiler_version": "18"
+    },
+    {
+      "distro_name": "ubuntu",
+      "distro_version": "noble",
+      "compiler_name": "clang",
+      "compiler_version": "19"
+    }
+  ],
+  "build_type": ["Debug", "Release"],
+  "cmake_args": ["-Dunity=OFF", "-Dunity=ON"]
+}

.github/scripts/strategy-matrix/macos.json

@@ -0,0 +1,21 @@
+{
+  "architecture": [
+    {
+      "platform": "macos/arm64",
+      "runner": ["self-hosted", "macOS", "ARM64", "mac-runner-m1"]
+    }
+  ],
+  "os": [
+    {
+      "distro_name": "macos",
+      "distro_version": "",
+      "compiler_name": "",
+      "compiler_version": ""
+    }
+  ],
+  "build_type": ["Debug", "Release"],
+  "cmake_args": [
+    "-Dunity=OFF -DCMAKE_POLICY_VERSION_MINIMUM=3.5",
+    "-Dunity=ON -DCMAKE_POLICY_VERSION_MINIMUM=3.5"
+  ]
+}

.github/scripts/strategy-matrix/windows.json

@@ -0,0 +1,18 @@
+{
+  "architecture": [
+    {
+      "platform": "windows/amd64",
+      "runner": ["windows-latest"]
+    }
+  ],
+  "os": [
+    {
+      "distro_name": "windows",
+      "distro_version": "",
+      "compiler_name": "",
+      "compiler_version": ""
+    }
+  ],
+  "build_type": ["Debug", "Release"],
+  "cmake_args": ["-Dunity=OFF", "-Dunity=ON"]
+}

.github/workflows/build-test.yml

@@ -0,0 +1,219 @@
+# This workflow builds and tests the binary for various configurations.
+name: Build and test
+
+# This workflow can only be triggered by other workflows. Note that the
+# workflow_call event does not support the 'choice' input type, see
+# https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callinputsinput_idtype,
+# so we use 'string' instead.
+on:
+  workflow_call:
+    inputs:
+      build_dir:
+        description: "The directory where to build."
+        required: false
+        type: string
+        default: ".build"
+      conan_remote_name:
+        description: "The name of the Conan remote to use."
+        required: true
+        type: string
+      conan_remote_url:
+        description: "The URL of the Conan endpoint to use."
+        required: true
+        type: string
+      dependencies_force_build:
+        description: "Force building of all dependencies."
+        required: false
+        type: boolean
+        default: false
+      dependencies_force_upload:
+        description: "Force uploading of all dependencies."
+        required: false
+        type: boolean
+        default: false
+      os:
+        description: 'The operating system to use for the build ("linux", "macos", "windows").'
+        required: true
+        type: string
+      strategy_matrix:
+        # TODO: Support additional strategies, e.g. "ubuntu" for generating all Ubuntu configurations.
+        description: 'The strategy matrix to use for generating the configurations ("minimal", "all").'
+        required: false
+        type: string
+        default: "minimal"
+    secrets:
+      codecov_token:
+        description: "The Codecov token to use for uploading coverage reports."
+        required: false
+      conan_remote_username:
+        description: "The username for logging into the Conan remote. If not provided, the dependencies will not be uploaded."
+        required: false
+      conan_remote_password:
+        description: "The password for logging into the Conan remote. If not provided, the dependencies will not be uploaded."
+        required: false
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ inputs.os }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Generate the strategy matrix to be used by the following job.
+  generate-matrix:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+      - name: Set up Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: 3.13
+      - name: Generate strategy matrix
+        working-directory: .github/scripts/strategy-matrix
+        id: generate
+        run: python generate.py ${{ inputs.strategy_matrix == 'all' && '--all' || '' }} --config=${{ inputs.os }}.json >> "${GITHUB_OUTPUT}"
+    outputs:
+      matrix: ${{ steps.generate.outputs.matrix }}
+
+  # Build and test the binary.
+  build-test:
+    needs:
+      - generate-matrix
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.generate-matrix.outputs.matrix) }}
+    runs-on: ${{ matrix.architecture.runner }}
+    container: ${{ inputs.os == 'linux' && format('ghcr.io/xrplf/ci/{0}-{1}:{2}-{3}', matrix.os.distro_name, matrix.os.distro_version, matrix.os.compiler_name, matrix.os.compiler_version) || null }}
+    steps:
+      - name: Check strategy matrix
+        run: |
+          echo 'Operating system distro name: ${{ matrix.os.distro_name }}'
+          echo 'Operating system distro version: ${{ matrix.os.distro_version }}'
+          echo 'Operating system compiler name: ${{ matrix.os.compiler_name }}'
+          echo 'Operating system compiler version: ${{ matrix.os.compiler_version }}'
+          echo 'Architecture platform: ${{ matrix.architecture.platform }}'
+          echo 'Architecture runner: ${{ toJson(matrix.architecture.runner) }}'
+          echo 'Build type: ${{ matrix.build_type }}'
+          echo 'Build only: ${{ matrix.build_only }}'
+          echo 'CMake arguments: ${{ matrix.cmake_args }}'
+          echo 'CMake target: ${{ matrix.cmake_target }}'
+          echo 'Config name: ${{ matrix.config_name }}'
+      - name: Clean workspace (MacOS)
+        if: ${{ inputs.os == 'macos' }}
+        run: |
+          WORKSPACE=${{ github.workspace }}
+          echo "Cleaning workspace '${WORKSPACE}'."
+          if [ -z "${WORKSPACE}" ] || [ "${WORKSPACE}" = "/" ]; then
+            echo "Invalid working directory '${WORKSPACE}'."
+            exit 1
+          fi
+          find "${WORKSPACE}" -depth 1 | xargs rm -rfv
+      - name: Checkout repository
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+      - name: Set up Python (Windows)
+        if: ${{ inputs.os == 'windows' }}
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: 3.13
+      - name: Install build tools (Windows)
+        if: ${{ inputs.os == 'windows' }}
+        run: |
+          echo 'Installing build tools.'
+          pip install wheel conan
+      - name: Check configuration (Windows)
+        if: ${{ inputs.os == 'windows' }}
+        run: |
+          echo 'Checking environment variables.'
+          set
+
+          echo 'Checking CMake version.'
+          cmake --version
+
+          echo 'Checking Conan version.'
+          conan --version
+      - name: Install build tools (MacOS)
+        if: ${{ inputs.os == 'macos' }}
+        run: |
+          echo 'Installing build tools.'
+          brew install --quiet cmake conan ninja coreutils
+      - name: Check configuration (Linux and MacOS)
+        if: ${{ inputs.os == 'linux' || inputs.os == 'macos' }}
+        run: |
+          echo 'Checking path.'
+          echo ${PATH} | tr ':' '\n'
+
+          echo 'Checking environment variables.'
+          env | sort
+
+          echo 'Checking CMake version.'
+          cmake --version
+
+          echo 'Checking compiler version.'
+          ${{ inputs.os == 'linux' && '${CC}' || 'clang' }} --version
+
+          echo 'Checking Conan version.'
+          conan --version
+
+          echo 'Checking Ninja version.'
+          ninja --version
+
+          echo 'Checking nproc version.'
+          nproc --version
+      - name: Set up Conan home directory (MacOS)
+        if: ${{ inputs.os == 'macos' }}
+        run: |
+          echo 'Setting up Conan home directory.'
+          export CONAN_HOME=${{ github.workspace }}/.conan
+          mkdir -p ${CONAN_HOME}
+      - name: Set up Conan home directory (Windows)
+        if: ${{ inputs.os == 'windows' }}
+        run: |
+          echo 'Setting up Conan home directory.'
+          set CONAN_HOME=${{ github.workspace }}\.conan
+          mkdir -p %CONAN_HOME%
+      - name: Set up Conan configuration
+        run: |
+          echo 'Installing configuration.'
+          cat conan/global.conf ${{ inputs.os == 'linux' && '>>' || '>' }} $(conan config home)/global.conf
+
+          echo 'Conan configuration:'
+          conan config show '*'
+      - name: Set up Conan profile
+        run: |
+          echo 'Installing profile.'
+          conan config install conan/profiles/default -tf $(conan config home)/profiles/
+
+          echo 'Conan profile:'
+          conan profile show
+      - name: Set up Conan remote
+        shell: bash
+        run: |
+          echo "Adding Conan remote '${{ inputs.conan_remote_name }}' at ${{ inputs.conan_remote_url }}."
+          conan remote add --index 0 --force ${{ inputs.conan_remote_name }} ${{ inputs.conan_remote_url }}
+
+          echo 'Listing Conan remotes.'
+          conan remote list
+      - name: Build dependencies
+        uses: ./.github/actions/build-deps
+        with:
+          build_dir: ${{ inputs.build_dir }}
+          build_type: ${{ matrix.build_type }}
+          conan_remote_name: ${{ inputs.conan_remote_name }}
+          conan_remote_url: ${{ inputs.conan_remote_url }}
+          conan_remote_username: ${{ secrets.conan_remote_username }}
+          conan_remote_password: ${{ secrets.conan_remote_password }}
+          force_build: ${{ inputs.dependencies_force_build }}
+          force_upload: ${{ inputs.dependencies_force_upload }}
+      - name: Build and test binary
+        uses: ./.github/actions/build-test
+        with:
+          build_dir: ${{ inputs.build_dir }}
+          build_only: ${{ matrix.build_only }}
+          build_type: ${{ matrix.build_type }}
+          cmake_args: ${{ matrix.cmake_args }}
+          cmake_target: ${{ matrix.cmake_target }}
+          codecov_token: ${{ secrets.codecov_token }}
+          os: ${{ inputs.os }}

.github/workflows/check-format.yml

@@ -0,0 +1,75 @@
+# This workflow checks if the code is properly formatted.
+name: Check format
+
+# This workflow can only be triggered by other workflows.
+on: workflow_call
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-format
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    container: ghcr.io/xrplf/ci/tools-rippled-pre-commit
+    steps:
+      # The $GITHUB_WORKSPACE and ${{ github.workspace }} might not point to the
+      # same directory for jobs running in containers. The actions/checkout step
+      # is *supposed* to checkout into $GITHUB_WORKSPACE and then add it to
+      # safe.directory (see instructions at https://github.com/actions/checkout)
+      # but that is apparently not happening for some container images. We
+      # therefore preemptively add both directories to safe.directory. See also
+      # https://github.com/actions/runner/issues/2058 for more details.
+      - name: Configure git safe.directory
+        run: |
+          git config --global --add safe.directory $GITHUB_WORKSPACE
+          git config --global --add safe.directory ${{ github.workspace }}
+      - name: Checkout repository
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+      - name: Check configuration
+        run: |
+          echo 'Checking path.'
+          echo ${PATH} | tr ':' '\n'
+
+          echo 'Checking environment variables.'
+          env | sort
+
+          echo 'Checking pre-commit version.'
+          pre-commit --version
+
+          echo 'Checking clang-format version.'
+          clang-format --version
+
+          echo 'Checking NPM version.'
+          npm --version
+
+          echo 'Checking Node.js version.'
+          node --version
+
+          echo 'Checking prettier version.'
+          prettier --version
+      - name: Format code
+        run: pre-commit run --show-diff-on-failure --color=always --all-files
+      - name: Check for differences
+        env:
+          MESSAGE: |
+            One or more files did not conform to the formatting. Maybe you did
+            not run 'pre-commit' before committing, or your version of
+            'clang-format' or 'prettier' has an incompatibility with the ones
+            used here (see the "Check configuration" step above).
+
+            Run 'pre-commit run --all-files' in your repo, and then commit and
+            push the changes.
+        run: |
+          DIFF=$(git status --porcelain)
+          if [ -n "${DIFF}" ]; then
+            # Print the files that changed to give the contributor a hint about
+            # what to expect when running pre-commit on their own machine.
+            git status
+            echo "${MESSAGE}"
+            exit 1
+          fi

.github/workflows/check-levelization.yml

@@ -0,0 +1,46 @@
+# This workflow checks if the dependencies between the modules are correctly
+# indexed.
+name: Check levelization
+
+# This workflow can only be triggered by other workflows.
+on: workflow_call
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-levelization
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  levelization:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+      - name: Check levelization
+        run: .github/scripts/levelization/generate.sh
+      - name: Check for differences
+        env:
+          MESSAGE: |
+
+            The dependency relationships between the modules in rippled have
+            changed, which may be an improvement or a regression.
+
+            A rule of thumb is that if your changes caused something to be
+            removed from loops.txt, it's probably an improvement, while if
+            something was added, it's probably a regression.
+
+            Run '.github/scripts/levelization/generate.sh' in your repo, commit
+            and push the changes. See .github/scripts/levelization/README.md for
+            more info.
+        run: |
+          DIFF=$(git status --porcelain)
+          if [ -n "${DIFF}" ]; then
+            # Print the differences to give the contributor a hint about what to
+            # expect when running levelization on their own machine.
+            git diff
+            echo "${MESSAGE}"
+            exit 1
+          fi

.github/workflows/check-missing-commits.yml

@@ -0,0 +1,62 @@
+# This workflow checks that all commits in the "master" branch are also in the
+# "release" and "develop" branches, and that all commits in the "release" branch
+# are also in the "develop" branch.
+name: Check for missing commits
+
+# This workflow can only be triggered by other workflows.
+on: workflow_call
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-missing-commits
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+        with:
+          fetch-depth: 0
+      - name: Check for missing commits
+        env:
+          MESSAGE: |
+
+            If you are reading this, then the commits indicated above are missing
+            from the "develop" and/or "release" branch. Do a reverse-merge as soon
+            as possible. See CONTRIBUTING.md for instructions.
+        run: |
+          set -o pipefail
+          # Branches are ordered by how "canonical" they are. Every commit in one
+          # branch should be in all the branches behind it.
+          order=(master release develop)
+          branches=()
+          for branch in "${order[@]}"; do
+            # Check that the branches exist so that this job will work on forked
+            # repos, which don't necessarily have master and release branches.
+            echo "Checking if ${branch} exists."
+            if git ls-remote --exit-code --heads origin \
+              refs/heads/${branch} > /dev/null; then
+              branches+=(origin/${branch})
+            fi
+          done
+
+          prior=()
+          for branch in "${branches[@]}"; do
+            if [[ ${#prior[@]} -ne 0 ]]; then
+              echo "Checking ${prior[@]} for commits missing from ${branch}."
+              git log --oneline --no-merges "${prior[@]}" \
+                ^$branch | tee -a "missing-commits.txt"
+              echo
+            fi
+            prior+=("${branch}")
+          done
+
+          if [[ $(cat missing-commits.txt | wc -l) -ne 0 ]]; then
+            echo "${MESSAGE}"
+            exit 1
+          fi

.github/workflows/clang-format.yml

@@ -1,64 +0,0 @@
-name: clang-format
-
-on:
-  push:
-  pull_request:
-    types: [opened, reopened, synchronize, ready_for_review]
-
-jobs:
-  check:
-    if: ${{ github.event_name == 'push' || github.event.pull_request.draft != true || contains(github.event.pull_request.labels.*.name, 'DraftRunCI') }}
-    runs-on: ubuntu-24.04
-    container: ghcr.io/xrplf/ci/tools-rippled-clang-format
-    steps:
-      # For jobs running in containers, $GITHUB_WORKSPACE and ${{ github.workspace }} might not be the
-      # same directory. The actions/checkout step is *supposed* to checkout into $GITHUB_WORKSPACE and
-      # then add it to safe.directory (see instructions at https://github.com/actions/checkout)
-      # but that's apparently not happening for some container images. We can't be sure what is actually
-      # happening, so let's pre-emptively add both directories to safe.directory. There's a
-      # Github issue opened in 2022 and not resolved in 2025 https://github.com/actions/runner/issues/2058 ¯\_(ツ)_/¯
-      - run: |
-          git config --global --add safe.directory $GITHUB_WORKSPACE
-          git config --global --add safe.directory ${{ github.workspace }}
-      - uses: actions/checkout@v4
-      - name: Format first-party sources
-        run: |
-          clang-format --version
-          find include src tests -type f \( -name '*.cpp' -o -name '*.hpp' -o -name '*.h' -o -name '*.ipp' \) -exec clang-format -i {} +
-      - name: Check for differences
-        id: assert
-        shell: bash
-        run: |
-          set -o pipefail
-          git diff --exit-code | tee "clang-format.patch"
-      - name: Upload patch
-        if: failure() && steps.assert.outcome == 'failure'
-        uses: actions/upload-artifact@v4
-        continue-on-error: true
-        with:
-          name: clang-format.patch
-          if-no-files-found: ignore
-          path: clang-format.patch
-      - name: What happened?
-        if: failure() && steps.assert.outcome == 'failure'
-        env:
-          PREAMBLE: |
-            If you are reading this, you are looking at a failed Github Actions
-            job.  That means you pushed one or more files that did not conform
-            to the formatting specified in .clang-format. That may be because
-            you neglected to run 'git clang-format' or 'clang-format' before
-            committing, or that your version of clang-format has an
-            incompatibility with the one on this
-            machine, which is:
-          SUGGESTION: |
-
-            To fix it, you can do one of two things:
-            1. Download and apply the patch generated as an artifact of this
-               job to your repo, commit, and push.
-            2. Run 'git-clang-format --extensions cpp,h,hpp,ipp develop'
-               in your repo, commit, and push.
-        run: |
-          echo "${PREAMBLE}"
-          clang-format --version
-          echo "${SUGGESTION}"
-          exit 1

.github/workflows/doxygen.yml

@@ -1,37 +0,0 @@
-name: Build and publish Doxygen documentation
-# To test this workflow, push your changes to your fork's `develop` branch.
-on:
-  push:
-    branches:
-      - develop
-      - doxygen
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  documentation:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    container: ghcr.io/xrplf/rippled-build-ubuntu:aaf5e3e
-    steps:
-      - name: checkout
-        uses: actions/checkout@v4
-      - name: check environment
-        run: |
-          echo ${PATH} | tr ':' '\n'
-          cmake --version
-          doxygen --version
-          env | sort
-      - name: build
-        run: |
-          mkdir build
-          cd build
-          cmake -Donly_docs=TRUE ..
-          cmake --build . --target docs --parallel $(nproc)
-      - name: publish
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: build/docs/html

.github/workflows/levelization.yml

@@ -1,53 +0,0 @@
-name: levelization
-
-on:
-  push:
-  pull_request:
-    types: [opened, reopened, synchronize, ready_for_review]
-
-jobs:
-  check:
-    if: ${{ github.event_name == 'push' || github.event.pull_request.draft != true || contains(github.event.pull_request.labels.*.name, 'DraftRunCI') }}
-    runs-on: ubuntu-latest
-    env:
-      CLANG_VERSION: 10
-    steps:
-      - uses: actions/checkout@v4
-      - name: Check levelization
-        run: Builds/levelization/levelization.sh
-      - name: Check for differences
-        id: assert
-        run: |
-          set -o pipefail
-          git diff --exit-code | tee "levelization.patch"
-      - name: Upload patch
-        if: failure() && steps.assert.outcome == 'failure'
-        uses: actions/upload-artifact@v4
-        continue-on-error: true
-        with:
-          name: levelization.patch
-          if-no-files-found: ignore
-          path: levelization.patch
-      - name: What happened?
-        if: failure() && steps.assert.outcome == 'failure'
-        env:
-          MESSAGE: |
-            If you are reading this, you are looking at a failed Github
-            Actions job. That means you changed the dependency relationships
-            between the modules in rippled. That may be an improvement or a
-            regression. This check doesn't judge.
-
-            A rule of thumb, though, is that if your changes caused
-            something to be removed from loops.txt, that's probably an
-            improvement. If something was added, it's probably a regression.
-
-            To fix it, you can do one of two things:
-            1. Download and apply the patch generated as an artifact of this
-               job to your repo, commit, and push.
-            2. Run './Builds/levelization/levelization.sh' in your repo,
-               commit, and push.
-
-            See Builds/levelization/README.md for more info.
-        run: |
-          echo "${MESSAGE}"
-          exit 1

.github/workflows/libxrpl.yml

@@ -1,91 +0,0 @@
-name: Check libXRPL compatibility with Clio
-env:
-  CONAN_REMOTE_URL: https://conan.ripplex.io
-  CONAN_LOGIN_USERNAME_XRPLF: ${{ secrets.CONAN_REMOTE_USERNAME }}
-  CONAN_PASSWORD_XRPLF: ${{ secrets.CONAN_REMOTE_PASSWORD }}
-on:
-  pull_request:
-    paths:
-      - "src/libxrpl/protocol/BuildInfo.cpp"
-      - ".github/workflows/libxrpl.yml"
-    types: [opened, reopened, synchronize, ready_for_review]
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  publish:
-    if: ${{ github.event_name == 'push' || github.event.pull_request.draft != true || contains(github.event.pull_request.labels.*.name, 'DraftRunCI') }}
-    name: Publish libXRPL
-    outputs:
-      outcome: ${{ steps.upload.outputs.outcome }}
-      version: ${{ steps.version.outputs.version }}
-      channel: ${{ steps.channel.outputs.channel }}
-    runs-on: [self-hosted, heavy]
-    container: ghcr.io/xrplf/rippled-build-ubuntu:aaf5e3e
-    steps:
-      - name: Wait for essential checks to succeed
-        uses: lewagon/wait-on-check-action@v1.3.4
-        with:
-          ref: ${{ github.event.pull_request.head.sha || github.sha }}
-          running-workflow-name: wait-for-check-regexp
-          check-regexp: "(dependencies|test).*linux.*" # Ignore windows and mac tests but make sure linux passes
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          wait-interval: 10
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Generate channel
-        id: channel
-        shell: bash
-        run: |
-          echo channel="clio/pr_${{ github.event.pull_request.number }}" | tee ${GITHUB_OUTPUT}
-      - name: Export new package
-        shell: bash
-        run: |
-          conan export . ${{ steps.channel.outputs.channel }}
-      - name: Add Conan remote
-        shell: bash
-        run: |
-          echo "Adding Conan remote 'xrplf' at ${{ env.CONAN_REMOTE_URL }}."
-          conan remote add xrplf ${{ env.CONAN_REMOTE_URL }} --insert 0 --force 
-          echo "Listing Conan remotes."
-          conan remote list
-      - name: Parse new version
-        id: version
-        shell: bash
-        run: |
-          echo version="$(cat src/libxrpl/protocol/BuildInfo.cpp | grep "versionString =" \
-            | awk -F '"' '{print $2}')" | tee ${GITHUB_OUTPUT}
-      - name: Try to authenticate to Conan remote
-        id: remote
-        shell: bash
-        run: |
-          # `conan user` implicitly uses the environment variables CONAN_LOGIN_USERNAME_<REMOTE> and CONAN_PASSWORD_<REMOTE>.
-          # https://docs.conan.io/1/reference/commands/misc/user.html#using-environment-variables
-          # https://docs.conan.io/1/reference/env_vars.html#conan-login-username-conan-login-username-remote-name
-          # https://docs.conan.io/1/reference/env_vars.html#conan-password-conan-password-remote-name
-          echo outcome=$(conan user --remote xrplf --password >&2 \
-            && echo success || echo failure) | tee ${GITHUB_OUTPUT}
-      - name: Upload new package
-        id: upload
-        if: (steps.remote.outputs.outcome == 'success')
-        shell: bash
-        run: |
-          echo "conan upload version ${{ steps.version.outputs.version }} on channel ${{ steps.channel.outputs.channel }}"
-          echo outcome=$(conan upload xrpl/${{ steps.version.outputs.version }}@${{ steps.channel.outputs.channel }} --remote ripple --confirm >&2 \
-            && echo success || echo failure) | tee ${GITHUB_OUTPUT}
-  notify_clio:
-    name: Notify Clio
-    runs-on: ubuntu-latest
-    needs: publish
-    env:
-      GH_TOKEN: ${{ secrets.CLIO_NOTIFY_TOKEN }}
-    steps:
-      - name: Notify Clio about new version
-        if: (needs.publish.outputs.outcome == 'success')
-        shell: bash
-        run: |
-          gh api --method POST -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" \
-          /repos/xrplf/clio/dispatches -f "event_type=check_libxrpl" \
-          -F "client_payload[version]=${{ needs.publish.outputs.version }}@${{ needs.publish.outputs.channel }}" \
-          -F "client_payload[pr]=${{ github.event.pull_request.number }}"

.github/workflows/macos.yml

@@ -1,112 +0,0 @@
-name: macos
-on:
-  pull_request:
-    types: [opened, reopened, synchronize, ready_for_review]
-  push:
-    # If the branches list is ever changed, be sure to change it on all
-    # build/test jobs (nix, macos, windows, instrumentation)
-    branches:
-      # Always build the package branches
-      - develop
-      - release
-      - master
-      # Branches that opt-in to running
-      - "ci/**"
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-# This part of Conan configuration is specific to this workflow only; we do not want
-# to pollute conan/profiles directory with settings which might not work for others
-env:
-  CONAN_REMOTE_URL: https://conan.ripplex.io
-  CONAN_REMOTE_USERNAME: ${{ secrets.CONAN_REMOTE_USERNAME }}
-  CONAN_REMOTE_PASSWORD: ${{ secrets.CONAN_REMOTE_PASSWORD }}
-  # This part of the Conan configuration is specific to this workflow only; we
-  # do not want to pollute the 'conan/profiles' directory with settings that
-  # might not work for other workflows.
-  CONAN_GLOBAL_CONF: |
-    core.download:parallel={{os.cpu_count()}}
-    core.upload:parallel={{os.cpu_count()}}
-    tools.build:jobs={{ (os.cpu_count() * 4/5) | int }}
-    tools.build:verbosity=verbose
-    tools.compilation:verbosity=verbose
-
-jobs:
-  test:
-    if: ${{ github.event_name == 'push' || github.event.pull_request.draft != true || contains(github.event.pull_request.labels.*.name, 'DraftRunCI') }}
-    strategy:
-      matrix:
-        platform:
-          - macos
-        generator:
-          - Ninja
-        configuration:
-          - Release
-    runs-on: [self-hosted, macOS, mac-runner-m1]
-    env:
-      # The `build` action requires these variables.
-      build_dir: .build
-      NUM_PROCESSORS: 12
-    steps:
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - name: install Conan
-        run: |
-          brew install conan
-      - name: install Ninja
-        if: matrix.generator == 'Ninja'
-        run: brew install ninja
-      - name: install python
-        run: |
-          if which python > /dev/null 2>&1; then
-              echo "Python executable exists"
-          else
-              brew install python@3.13
-              ln -s /opt/homebrew/bin/python3 /opt/homebrew/bin/python
-          fi
-      - name: install cmake
-        run: |
-          if which cmake > /dev/null 2>&1; then
-              echo "cmake executable exists"
-          else
-              brew install cmake
-          fi
-      - name: install nproc
-        run: |
-          brew install coreutils
-      - name: check environment
-        run: |
-          env | sort
-          echo ${PATH} | tr ':' '\n'
-          python --version
-          conan --version
-          cmake --version
-          nproc --version
-          echo -n "nproc returns: "
-          nproc
-          system_profiler SPHardwareDataType
-          sysctl -n hw.logicalcpu
-          clang --version
-      - name: configure Conan
-        run: |
-          echo "${CONAN_GLOBAL_CONF}" > $(conan config home)/global.conf
-          conan config install conan/profiles/ -tf $(conan config home)/profiles/
-          conan profile show
-      - name: build dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: ${{ matrix.configuration }}
-      - name: build
-        uses: ./.github/actions/build
-        with:
-          generator: ${{ matrix.generator }}
-          configuration: ${{ matrix.configuration }}
-          cmake-args: "-Dassert=TRUE -Dwerr=TRUE ${{ matrix.cmake-args }}"
-      - name: test
-        run: |
-          n=$(nproc)
-          echo "Using $n test jobs"
-
-          cd ${build_dir}
-          ./rippled --unittest --unittest-jobs $n
-          ctest -j $n --output-on-failure

.github/workflows/missing-commits.yml

@@ -1,60 +0,0 @@
-name: missing-commits
-
-on:
-  push:
-    branches:
-      # Only check that the branches are up to date when updating the
-      # relevant branches.
-      - develop
-      - release
-
-jobs:
-  up_to_date:
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Check for missing commits
-        id: commits
-        env:
-          SUGGESTION: |
-
-            If you are reading this, then the commits indicated above are
-            missing from "develop" and/or "release". Do a reverse-merge
-            as soon as possible. See CONTRIBUTING.md for instructions.
-        run: |
-          set -o pipefail
-          # Branches ordered by how "canonical" they are. Every commit in
-          # one branch should be in all the branches behind it
-          order=( master release develop )
-          branches=()
-          for branch in "${order[@]}"
-          do
-            # Check that the branches exist so that this job will work on
-            # forked repos, which don't necessarily have master and
-            # release branches.
-            if git ls-remote --exit-code --heads origin \
-              refs/heads/${branch} > /dev/null
-            then
-              branches+=( origin/${branch} )
-            fi
-          done
-
-          prior=()
-          for branch in "${branches[@]}"
-          do
-            if [[ ${#prior[@]} -ne 0 ]]
-            then
-              echo "Checking ${prior[@]} for commits missing from ${branch}"
-              git log --oneline --no-merges "${prior[@]}" \
-                ^$branch | tee -a "missing-commits.txt"
-              echo
-            fi
-            prior+=( "${branch}" )
-          done
-          if [[ $( cat missing-commits.txt | wc -l ) -ne 0 ]]
-          then
-            echo "${SUGGESTION}"
-            exit 1
-          fi

.github/workflows/nix.yml

@@ -1,422 +0,0 @@
-name: nix
-on:
-  pull_request:
-    types: [opened, reopened, synchronize, ready_for_review]
-  push:
-    # If the branches list is ever changed, be sure to change it on all
-    # build/test jobs (nix, macos, windows)
-    branches:
-      # Always build the package branches
-      - develop
-      - release
-      - master
-      # Branches that opt-in to running
-      - "ci/**"
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-env:
-  CONAN_REMOTE_URL: https://conan.ripplex.io
-  CONAN_REMOTE_USERNAME: ${{ secrets.CONAN_REMOTE_USERNAME }}
-  CONAN_REMOTE_PASSWORD: ${{ secrets.CONAN_REMOTE_PASSWORD }}
-  # This part of the Conan configuration is specific to this workflow only; we
-  # do not want to pollute the 'conan/profiles' directory with settings that
-  # might not work for other workflows.
-  CONAN_GLOBAL_CONF: |
-    core.download:parallel={{ os.cpu_count() }}
-    core.upload:parallel={{ os.cpu_count() }}
-    tools.build:jobs={{ (os.cpu_count() * 4/5) | int }}
-    tools.build:verbosity=verbose
-    tools.compilation:verbosity=verbose
-
-# This workflow has multiple job matrixes.
-# They can be considered phases because most of the matrices ("test",
-# "coverage", "conan", ) depend on the first ("dependencies").
-#
-# The first phase has a job in the matrix for each combination of
-# variables that affects dependency ABI:
-# platform, compiler, and configuration.
-# It creates a GitHub artifact holding the Conan profile,
-# and builds and caches binaries for all the dependencies.
-# If an Artifactory remote is configured, they are cached there.
-# If not, they are added to the GitHub artifact.
-# GitHub's "cache" action has a size limit (10 GB) that is too small
-# to hold the binaries if they are built locally.
-# We must use the "{upload,download}-artifact" actions instead.
-#
-# The remaining phases have a job in the matrix for each test
-# configuration. They install dependency binaries from the cache,
-# whichever was used, and build and test rippled.
-#
-# "instrumentation" is independent, but is included here because it also
-# builds on linux in the same "on:" conditions.
-
-jobs:
-  dependencies:
-    if: ${{ github.event_name == 'push' || github.event.pull_request.draft != true || contains(github.event.pull_request.labels.*.name, 'DraftRunCI') }}
-    strategy:
-      fail-fast: false
-      matrix:
-        platform:
-          - linux
-        compiler:
-          - gcc
-          - clang
-        configuration:
-          - Debug
-          - Release
-        include:
-          - compiler: gcc
-            compiler_version: 12
-            distro: ubuntu
-            codename: jammy
-          - compiler: clang
-            compiler_version: 16
-            distro: debian
-            codename: bookworm
-    runs-on: [self-hosted, heavy]
-    container: ghcr.io/xrplf/ci/${{ matrix.distro }}-${{ matrix.codename }}:${{ matrix.compiler }}-${{ matrix.compiler_version }}
-    env:
-      build_dir: .build
-    steps:
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - name: check environment
-        run: |
-          echo ${PATH} | tr ':' '\n'
-          lsb_release -a || true
-          ${{ matrix.compiler }}-${{ matrix.compiler_version }} --version
-          conan --version
-          cmake --version
-          env | sort
-      - name: configure Conan
-        run: |
-          echo "${CONAN_GLOBAL_CONF}" >> $(conan config home)/global.conf
-          conan config install conan/profiles/ -tf $(conan config home)/profiles/
-          conan profile show
-      - name: archive profile
-        # Create this archive before dependencies are added to the local cache.
-        run: tar -czf conan.tar.gz -C ${CONAN_HOME} .
-      - name: build dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: ${{ matrix.configuration }}
-      - name: upload archive
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
-        with:
-          name: ${{ matrix.platform }}-${{ matrix.compiler }}-${{ matrix.configuration }}
-          path: conan.tar.gz
-          if-no-files-found: error
-
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        platform:
-          - linux
-        compiler:
-          - gcc
-          - clang
-        configuration:
-          - Debug
-          - Release
-        include:
-          - compiler: gcc
-            compiler_version: 12
-            distro: ubuntu
-            codename: jammy
-          - compiler: clang
-            compiler_version: 16
-            distro: debian
-            codename: bookworm
-        cmake-args:
-          -
-          - "-Dunity=ON"
-    needs: dependencies
-    runs-on: [self-hosted, heavy]
-    container: ghcr.io/xrplf/ci/${{ matrix.distro }}-${{ matrix.codename }}:${{ matrix.compiler }}-${{ matrix.compiler_version }}
-    env:
-      build_dir: .build
-    steps:
-      - name: download cache
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
-        with:
-          name: ${{ matrix.platform }}-${{ matrix.compiler }}-${{ matrix.configuration }}
-      - name: extract cache
-        run: |
-          mkdir -p ${CONAN_HOME}
-          tar -xzf conan.tar.gz -C ${CONAN_HOME}
-      - name: check environment
-        run: |
-          env | sort
-          echo ${PATH} | tr ':' '\n'
-          conan --version
-          cmake --version
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - name: dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: ${{ matrix.configuration }}
-      - name: build
-        uses: ./.github/actions/build
-        with:
-          generator: Ninja
-          configuration: ${{ matrix.configuration }}
-          cmake-args: "-Dassert=TRUE -Dwerr=TRUE ${{ matrix.cmake-args }}"
-      - name: check linking
-        run: |
-          cd ${build_dir}
-          ldd ./rippled
-          if [ "$(ldd ./rippled | grep -E '(libstdc\+\+|libgcc)' | wc -l)" -eq 0 ]; then
-            echo 'The binary is statically linked.'
-          else
-            echo 'The binary is dynamically linked.'
-            exit 1
-          fi
-      - name: test
-        run: |
-          cd ${build_dir}
-          ./rippled --unittest --unittest-jobs $(nproc)
-          ctest -j $(nproc) --output-on-failure
-
-  reference-fee-test:
-    strategy:
-      fail-fast: false
-      matrix:
-        platform:
-          - linux
-        compiler:
-          - gcc
-        configuration:
-          - Debug
-        cmake-args:
-          - "-DUNIT_TEST_REFERENCE_FEE=200"
-          - "-DUNIT_TEST_REFERENCE_FEE=1000"
-    needs: dependencies
-    runs-on: [self-hosted, heavy]
-    container: ghcr.io/xrplf/ci/ubuntu-jammy:gcc-12
-    env:
-      build_dir: .build
-    steps:
-      - name: download cache
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
-        with:
-          name: ${{ matrix.platform }}-${{ matrix.compiler }}-${{ matrix.configuration }}
-      - name: extract cache
-        run: |
-          mkdir -p ${CONAN_HOME}
-          tar -xzf conan.tar.gz -C ${CONAN_HOME}
-      - name: check environment
-        run: |
-          env | sort
-          echo ${PATH} | tr ':' '\n'
-          conan --version
-          cmake --version
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - name: dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: ${{ matrix.configuration }}
-      - name: build
-        uses: ./.github/actions/build
-        with:
-          generator: Ninja
-          configuration: ${{ matrix.configuration }}
-          cmake-args: "-Dassert=TRUE -Dwerr=TRUE ${{ matrix.cmake-args }}"
-      - name: test
-        run: |
-          cd ${build_dir}
-          ./rippled --unittest --unittest-jobs $(nproc)
-          ctest -j $(nproc) --output-on-failure
-
-  coverage:
-    strategy:
-      fail-fast: false
-      matrix:
-        platform:
-          - linux
-        compiler:
-          - gcc
-        configuration:
-          - Debug
-    needs: dependencies
-    runs-on: [self-hosted, heavy]
-    container: ghcr.io/xrplf/ci/ubuntu-jammy:gcc-12
-    env:
-      build_dir: .build
-    steps:
-      - name: download cache
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
-        with:
-          name: ${{ matrix.platform }}-${{ matrix.compiler }}-${{ matrix.configuration }}
-      - name: extract cache
-        run: |
-          mkdir -p ${CONAN_HOME}
-          tar -xzf conan.tar.gz -C ${CONAN_HOME}
-      - name: check environment
-        run: |
-          echo ${PATH} | tr ':' '\n'
-          conan --version
-          cmake --version
-          gcovr --version
-          env | sort
-          ls ${CONAN_HOME}
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - name: dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: ${{ matrix.configuration }}
-      - name: build
-        uses: ./.github/actions/build
-        with:
-          generator: Ninja
-          configuration: ${{ matrix.configuration }}
-          cmake-args: >-
-            -Dassert=TRUE
-            -Dwerr=TRUE
-            -Dcoverage=ON
-            -Dcoverage_format=xml
-            -DCODE_COVERAGE_VERBOSE=ON
-            -DCMAKE_CXX_FLAGS="-O0"
-            -DCMAKE_C_FLAGS="-O0"
-          cmake-target: coverage
-      - name: move coverage report
-        shell: bash
-        run: |
-          mv "${build_dir}/coverage.xml" ./
-      - name: archive coverage report
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
-        with:
-          name: coverage.xml
-          path: coverage.xml
-          retention-days: 30
-      - name: upload coverage report
-        uses: wandalen/wretry.action@v1.4.10
-        with:
-          action: codecov/codecov-action@v4.5.0
-          with: |
-            files: coverage.xml
-            fail_ci_if_error: true
-            disable_search: true
-            verbose: true
-            plugin: noop
-            token: ${{ secrets.CODECOV_TOKEN }}
-          attempt_limit: 5
-          attempt_delay: 210000 # in milliseconds
-
-  conan:
-    needs: dependencies
-    runs-on: [self-hosted, heavy]
-    container:
-      image: ghcr.io/xrplf/ci/ubuntu-jammy:gcc-12
-    env:
-      build_dir: .build
-      platform: linux
-      compiler: gcc
-      compiler_version: 12
-      configuration: Release
-    steps:
-      - name: download cache
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
-        with:
-          name: ${{ env.platform }}-${{ env.compiler }}-${{ env.configuration }}
-      - name: extract cache
-        run: |
-          mkdir -p ${CONAN_HOME}
-          tar -xzf conan.tar.gz -C ${CONAN_HOME}
-      - name: check environment
-        run: |
-          env | sort
-          echo ${PATH} | tr ':' '\n'
-          conan --version
-          cmake --version
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - name: dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: ${{ env.configuration }}
-      - name: export
-        run: |
-          conan export . --version head
-      - name: build
-        run: |
-          cd tests/conan
-          mkdir ${build_dir} && cd ${build_dir}
-          conan install .. \
-            --settings:all build_type=${configuration} \
-            --output-folder . \
-            --build missing
-          cmake .. \
-            -DCMAKE_TOOLCHAIN_FILE:FILEPATH=./build/${configuration}/generators/conan_toolchain.cmake \
-            -DCMAKE_BUILD_TYPE=${configuration}
-          cmake --build .
-          ./example | grep '^[[:digit:]]\+\.[[:digit:]]\+\.[[:digit:]]\+'
-
-  instrumentation-build:
-    needs: dependencies
-    runs-on: [self-hosted, heavy]
-    container: ghcr.io/xrplf/ci/debian-bookworm:clang-16
-    env:
-      build_dir: .build
-    steps:
-      - name: download cache
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
-        with:
-          name: linux-clang-Debug
-
-      - name: extract cache
-        run: |
-          mkdir -p ${CONAN_HOME}
-          tar -xzf conan.tar.gz -C ${CONAN_HOME}
-
-      - name: check environment
-        run: |
-          echo ${PATH} | tr ':' '\n'
-          conan --version
-          cmake --version
-          env | sort
-          ls ${CONAN_HOME}
-
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-
-      - name: dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: Debug
-
-      - name: prepare environment
-        run: |
-          mkdir -p ${build_dir}
-          echo "SOURCE_DIR=$(pwd)" >> $GITHUB_ENV
-          echo "BUILD_DIR=$(pwd)/${build_dir}" >> $GITHUB_ENV
-
-      - name: build with instrumentation
-        run: |
-          cd ${BUILD_DIR}
-          cmake -S ${SOURCE_DIR} -B ${BUILD_DIR} \
-            -Dvoidstar=ON \
-            -Dtests=ON \
-            -Dxrpld=ON \
-            -DCMAKE_BUILD_TYPE=Debug \
-            -DSECP256K1_BUILD_BENCHMARK=OFF \
-            -DSECP256K1_BUILD_TESTS=OFF \
-            -DSECP256K1_BUILD_EXHAUSTIVE_TESTS=OFF \
-            -DCMAKE_TOOLCHAIN_FILE=${BUILD_DIR}/build/generators/conan_toolchain.cmake
-          cmake --build .  --parallel $(nproc)
-
-      - name: verify instrumentation enabled
-        run: |
-          cd ${BUILD_DIR}
-          ./rippled --version | grep libvoidstar
-
-      - name: run unit tests
-        run: |
-          cd ${BUILD_DIR}
-          ./rippled -u --unittest-jobs $(( $(nproc)/4 ))
-          ctest -j $(nproc) --output-on-failure

.github/workflows/notify-clio.yml

@@ -0,0 +1,80 @@
+# This workflow exports the built libxrpl package to the Conan remote on a
+# a channel named after the pull request, and notifies the Clio repository about
+# the new version so it can check for compatibility.
+name: Notify Clio
+
+# This workflow can only be triggered by other workflows.
+on:
+  workflow_call:
+    inputs:
+      conan_remote_name:
+        description: "The name of the Conan remote to use."
+        required: true
+        type: string
+      conan_remote_url:
+        description: "The URL of the Conan endpoint to use."
+        required: true
+        type: string
+    secrets:
+      clio_notify_token:
+        description: "The GitHub token to notify Clio about new versions."
+        required: true
+      conan_remote_username:
+        description: "The username for logging into the Conan remote."
+        required: true
+      conan_remote_password:
+        description: "The password for logging into the Conan remote."
+        required: true
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-clio
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  upload:
+    if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
+    runs-on: ubuntu-latest
+    container: ghcr.io/xrplf/ci/ubuntu-noble:gcc-13
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+      - name: Generate outputs
+        id: generate
+        run: |
+          echo 'Generating user and channel.'
+          echo "user=clio" >> "${GITHUB_OUTPUT}"
+          echo "channel=pr_${{ github.event.pull_request.number }}" >> "${GITHUB_OUTPUT}"
+          echo 'Extracting version.'
+          echo "version=$(cat src/libxrpl/protocol/BuildInfo.cpp | grep "versionString =" | awk -F '"' '{print $2}')" >> "${GITHUB_OUTPUT}"
+      - name: Add Conan remote
+        run: |
+          echo "Adding Conan remote '${{ inputs.conan_remote_name }}' at ${{ inputs.conan_remote_url }}."
+          conan remote add --index 0 --force ${{ inputs.conan_remote_name }} ${{ inputs.conan_remote_url }}
+          echo 'Listing Conan remotes.'
+          conan remote list
+      - name: Log into Conan remote
+        run: conan remote login ${{ inputs.conan_remote_name }} "${{ secrets.conan_remote_username }}" --password "${{ secrets.conan_remote_password }}"
+      - name: Upload package
+        run: |
+          conan export --user=${{ steps.generate.outputs.user }} --channel=${{ steps.generate.outputs.channel }} .
+          conan upload --confirm --check --remote=${{ inputs.conan_remote_name }} xrpl/${{ steps.generate.outputs.version }}@${{ steps.generate.outputs.user }}/${{ steps.generate.outputs.channel }}
+    outputs:
+      channel: ${{ steps.generate.outputs.channel }}
+      version: ${{ steps.generate.outputs.version }}
+
+  notify:
+    needs: upload
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ secrets.clio_notify_token }}
+    steps:
+      - name: Notify Clio
+        run: |
+          gh api --method POST -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" \
+          /repos/xrplf/clio/dispatches -f "event_type=check_libxrpl" \
+          -F "client_payload[version]=${{ needs.upload.outputs.version }}@${{ needs.upload.outputs.user }}/${{ needs.upload.outputs.channel }}" \
+          -F "client_payload[pr]=${{ github.event.pull_request.number }}"

.github/workflows/on-pr.yml

@@ -0,0 +1,118 @@
+# This workflow runs all workflows to check, build and test the project on
+# various Linux flavors, as well as on MacOS and Windows, on every push to a
+# user branch. However, it will not run if the pull request is a draft unless it
+# has the 'DraftRunCI' label.
+name: PR
+
+on:
+  pull_request:
+    paths:
+      - ".github/actions/build-deps/**"
+      - ".github/actions/build-test/**"
+      - ".github/scripts/levelization/**"
+      - ".github/scripts/strategy-matrix/**"
+      - ".github/workflows/build-test.yml"
+      - ".github/workflows/check-format.yml"
+      - ".github/workflows/check-levelization.yml"
+      - ".github/workflows/notify-clio.yml"
+      - ".github/workflows/on-pr.yml"
+      # Keep the list of paths below in sync with those in the `on-trigger.yml`
+      # file.
+      - "cmake/**"
+      - "conan/**"
+      - "external/**"
+      - "include/**"
+      - "src/**"
+      - "tests/**"
+      - ".clang-format"
+      - ".codecov.yml"
+      - ".pre-commit-config.yaml"
+      - "CMakeLists.txt"
+      - "conanfile.py"
+    types:
+      - opened
+      - synchronize
+      - labeled
+      - unlabeled
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  CONAN_REMOTE_NAME: xrplf
+  CONAN_REMOTE_URL: https://conan.ripplex.io
+
+jobs:
+  # This job determines whether the workflow should run. It runs when:
+  # * Opened as a non-draft PR.
+  # * A commit is added to a non-draft PR or the PR has the 'DraftRunCI' label.
+  # * A draft PR has the 'DraftRunCI' label added.
+  # * A non-draft PR has the 'DraftRunCI' label removed.
+  # These checks are in part to ensure the workflow won't run needlessly while
+  # also allowing it to be triggered without having to add a no-op commit. A new
+  # workflow execution can be triggered by adding and then removing the label on
+  # a non-draft PR, or conversely by removing it and then adding it back on a
+  # draft PR; this can be useful in certain cases.
+  should-run:
+    if: >-
+      ${{
+        (github.event.action == 'opened' && !github.event.pull_request.draft) ||
+        (github.event.action == 'synchronize' && (!github.event.pull_request.draft || contains(github.event.pull_request.labels.*.name, 'DraftRunCI'))) ||
+        (github.event.action == 'labeled' && github.event.pull_request.draft && github.event.label.name == 'DraftRunCI') ||
+        (github.event.action == 'unlabeled' && !github.event.pull_request.draft && github.event.label.name == 'DraftRunCI')
+      }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: No-op
+        run: true
+
+  check-format:
+    needs: should-run
+    uses: ./.github/workflows/check-format.yml
+
+  check-levelization:
+    needs: should-run
+    uses: ./.github/workflows/check-levelization.yml
+
+  # This job works around the limitation that GitHub Actions does not support
+  # using environment variables as inputs for reusable workflows.
+  generate-outputs:
+    needs: should-run
+    runs-on: ubuntu-latest
+    steps:
+      - name: No-op
+        run: true
+    outputs:
+      conan_remote_name: ${{ env.CONAN_REMOTE_NAME }}
+      conan_remote_url: ${{ env.CONAN_REMOTE_URL }}
+
+  build-test:
+    needs: generate-outputs
+    uses: ./.github/workflows/build-test.yml
+    strategy:
+      matrix:
+        os: [linux, macos, windows]
+    with:
+      conan_remote_name: ${{ needs.generate-outputs.outputs.conan_remote_name }}
+      conan_remote_url: ${{ needs.generate-outputs.outputs.conan_remote_url }}
+      os: ${{ matrix.os }}
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
+
+  notify-clio:
+    needs:
+      - generate-outputs
+      - build-test
+    uses: ./.github/workflows/notify-clio.yml
+    with:
+      conan_remote_name: ${{ needs.generate-outputs.outputs.conan_remote_name }}
+      conan_remote_url: ${{ needs.generate-outputs.outputs.conan_remote_url }}
+    secrets:
+      clio_notify_token: ${{ secrets.CLIO_NOTIFY_TOKEN }}
+      conan_remote_username: ${{ secrets.CONAN_REMOTE_USERNAME }}
+      conan_remote_password: ${{ secrets.CONAN_REMOTE_PASSWORD }}

.github/workflows/on-trigger.yml

@@ -0,0 +1,115 @@
+# This workflow runs all workflows to build the dependencies required for the
+# project on various Linux flavors, as well as on MacOS and Windows, on a
+# scheduled basis, on merge into the 'develop', 'release', or 'master' branches,
+# or manually. The missing commits check is only run when the code is merged
+# into the 'develop' or 'release' branches, and the documentation is built when
+# the code is merged into the 'develop' branch.
+name: Trigger
+
+on:
+  push:
+    branches:
+      - develop
+      - release
+      - master
+    paths:
+      - ".github/actions/build-deps/**"
+      - ".github/actions/build-test/**"
+      - ".github/scripts/strategy-matrix/**"
+      - ".github/workflows/build-test.yml"
+      - ".github/workflows/check-missing-commits.yml"
+      - ".github/workflows/on-trigger.yml"
+      - ".github/workflows/publish-docs.yml"
+      # Keep the list of paths below in sync with those in `on-pr.yml`.
+      - "cmake/**"
+      - "conan/**"
+      - "external/**"
+      - "include/**"
+      - "src/**"
+      - "tests/**"
+      - ".clang-format"
+      - ".codecov.yml"
+      - ".pre-commit-config.yaml"
+      - "CMakeLists.txt"
+      - "conanfile.py"
+  # Run at 06:32 UTC on every day of the week from Monday through Friday. This
+  # will force all dependencies to be rebuilt, which is useful to verify that
+  # all dependencies can be built successfully. Only the dependencies that
+  # are actually missing from the remote will be uploaded.
+  schedule:
+    - cron: "32 6 * * 1-5"
+  # Run when manually triggered via the GitHub UI or API. If `force_upload` is
+  # true, then the dependencies that were missing (`force_rebuild` is false) or
+  # rebuilt (`force_rebuild` is true) will be uploaded, overwriting existing
+  # dependencies if needed.
+  workflow_dispatch:
+    inputs:
+      dependencies_force_build:
+        description: "Force building of all dependencies."
+        required: false
+        type: boolean
+        default: false
+      dependencies_force_upload:
+        description: "Force uploading of all dependencies."
+        required: false
+        type: boolean
+        default: false
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  CONAN_REMOTE_NAME: xrplf
+  CONAN_REMOTE_URL: https://conan.ripplex.io
+
+jobs:
+  check-missing-commits:
+    if: ${{ github.event_name == 'push' && github.ref_type == 'branch' && contains(fromJSON('["develop", "release"]'), github.ref_name) }}
+    uses: ./.github/workflows/check-missing-commits.yml
+
+  # This job works around the limitation that GitHub Actions does not support
+  # using environment variables as inputs for reusable workflows. It also sets
+  # outputs that depend on the event that triggered the workflow.
+  generate-outputs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check inputs and set outputs
+        id: generate
+        run: |
+          if [[ '${{ github.event_name }}' == 'push' ]]; then
+            echo 'dependencies_force_build=false' >> "${GITHUB_OUTPUT}"
+            echo 'dependencies_force_upload=false' >> "${GITHUB_OUTPUT}"
+          elif [[ '${{ github.event_name }}' == 'schedule' ]]; then
+            echo 'dependencies_force_build=true' >> "${GITHUB_OUTPUT}"
+            echo 'dependencies_force_upload=false' >> "${GITHUB_OUTPUT}"
+          else
+            echo 'dependencies_force_build=${{ inputs.dependencies_force_build }}' >> "${GITHUB_OUTPUT}"
+            echo 'dependencies_force_upload=${{ inputs.dependencies_force_upload }}' >> "${GITHUB_OUTPUT}"
+          fi
+    outputs:
+      conan_remote_name: ${{ env.CONAN_REMOTE_NAME }}
+      conan_remote_url: ${{ env.CONAN_REMOTE_URL }}
+      dependencies_force_build: ${{ steps.generate.outputs.dependencies_force_build }}
+      dependencies_force_upload: ${{ steps.generate.outputs.dependencies_force_upload }}
+
+  build-test:
+    needs: generate-outputs
+    uses: ./.github/workflows/build-test.yml
+    strategy:
+      matrix:
+        os: [linux, macos, windows]
+    with:
+      conan_remote_name: ${{ needs.generate-outputs.outputs.conan_remote_name }}
+      conan_remote_url: ${{ needs.generate-outputs.outputs.conan_remote_url }}
+      dependencies_force_build: ${{ needs.generate-outputs.outputs.dependencies_force_build == 'true' }}
+      dependencies_force_upload: ${{ needs.generate-outputs.outputs.dependencies_force_upload == 'true' }}
+      os: ${{ matrix.os }}
+      strategy_matrix: "all"
+    secrets:
+      conan_remote_username: ${{ secrets.CONAN_REMOTE_USERNAME }}
+      conan_remote_password: ${{ secrets.CONAN_REMOTE_PASSWORD }}

.github/workflows/publish-docs.yml

@@ -0,0 +1,60 @@
+# This workflow builds the documentation for the repository, and publishes it to
+# GitHub Pages when changes are merged into the default branch.
+name: Build and publish documentation
+
+on:
+  push:
+    paths:
+      - ".github/workflows/publish-docs.yml"
+      - "*.md"
+      - "**/*.md"
+      - "docs/**"
+      - "include/**"
+      - "src/libxrpl/**"
+      - "src/xrpld/**"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  BUILD_DIR: .build
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    container: ghcr.io/xrplf/ci/tools-rippled-documentation
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+      - name: Check configuration
+        run: |
+          echo 'Checking path.'
+          echo ${PATH} | tr ':' '\n'
+
+          echo 'Checking environment variables.'
+          env | sort
+
+          echo 'Checking CMake version.'
+          cmake --version
+
+          echo 'Checking Doxygen version.'
+          doxygen --version
+      - name: Build documentation
+        run: |
+          mkdir -p ${{ env.BUILD_DIR }}
+          cd ${{ env.BUILD_DIR }}
+          cmake -Donly_docs=ON ..
+          cmake --build . --target docs --parallel $(nproc)
+      - name: Publish documentation
+        if: ${{ github.ref_type == 'branch' && github.ref_name == github.event.repository.default_branch }}
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ${{ env.BUILD_DIR }}/docs/html

.github/workflows/windows.yml

@@ -1,106 +0,0 @@
-name: windows
-
-on:
-  pull_request:
-    types: [opened, reopened, synchronize, ready_for_review]
-  push:
-    # If the branches list is ever changed, be sure to change it on all
-    # build/test jobs (nix, macos, windows, instrumentation)
-    branches:
-      # Always build the package branches
-      - develop
-      - release
-      - master
-      # Branches that opt-in to running
-      - "ci/**"
-
-# https://docs.github.com/en/actions/using-jobs/using-concurrency
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-env:
-  CONAN_REMOTE_URL: https://conan.ripplex.io
-  CONAN_REMOTE_USERNAME: ${{ secrets.CONAN_REMOTE_USERNAME }}
-  CONAN_REMOTE_PASSWORD: ${{ secrets.CONAN_REMOTE_PASSWORD }}
-  # This part of the Conan configuration is specific to this workflow only; we
-  # do not want to pollute the 'conan/profiles' directory with settings that
-  # might not work for other workflows.
-  CONAN_GLOBAL_CONF: |
-    core.download:parallel={{os.cpu_count()}}
-    core.upload:parallel={{os.cpu_count()}}
-    tools.build:jobs=24
-    tools.build:verbosity=verbose
-    tools.compilation:verbosity=verbose
-
-jobs:
-  test:
-    if: ${{ github.event_name == 'push' || github.event.pull_request.draft != true || contains(github.event.pull_request.labels.*.name, 'DraftRunCI') }}
-    strategy:
-      fail-fast: false
-      matrix:
-        version:
-          - generator: Visual Studio 17 2022
-            runs-on: windows-2022
-        configuration:
-          - type: Release
-            tests: true
-          - type: Debug
-            # Skip running unit tests on debug builds, because they
-            # take an unreasonable amount of time
-            tests: false
-            runtime: d
-    runs-on: ${{ matrix.version.runs-on }}
-    env:
-      build_dir: .build
-    steps:
-      - name: checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - name: choose Python
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065
-        with:
-          python-version: 3.13
-      - name: learn Python cache directory
-        id: pip-cache
-        shell: bash
-        run: |
-          python -m pip install --upgrade pip
-          echo "dir=$(pip cache dir)" | tee ${GITHUB_OUTPUT}
-      - name: restore Python cache directory
-        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-${{ hashFiles('.github/workflows/windows.yml') }}
-      - name: install Conan
-        run: pip install wheel conan
-      - name: check environment
-        run: |
-          dir env:
-          $env:PATH -split ';'
-          python --version
-          conan --version
-          cmake --version
-      - name: configure Conan
-        shell: bash
-        run: |
-          echo "${CONAN_GLOBAL_CONF}" > $(conan config home)/global.conf
-          conan config install conan/profiles/ -tf $(conan config home)/profiles/
-          conan profile show
-      - name: build dependencies
-        uses: ./.github/actions/dependencies
-        with:
-          configuration: ${{ matrix.configuration.type }}
-      - name: build
-        uses: ./.github/actions/build
-        with:
-          generator: "${{ matrix.version.generator }}"
-          configuration: ${{ matrix.configuration.type }}
-          # Hard code for now. Move to the matrix if varied options are needed
-          cmake-args: "-Dassert=TRUE -Dwerr=TRUE -Dreporting=OFF -Dunity=ON"
-          cmake-target: install
-      - name: test
-        shell: bash
-        if: ${{ matrix.configuration.tests }}
-        run: |
-          cd ${build_dir}/${{ matrix.configuration.type }}
-          ./rippled --unittest --unittest-jobs $(nproc)
-          ctest -j $(nproc) --output-on-failure

.gitignore

@@ -37,10 +37,9 @@ Release/*.*
 *.gcov
 
 # Levelization checking
-Builds/levelization/results/rawincludes.txt
-Builds/levelization/results/paths.txt
-Builds/levelization/results/includes/
-Builds/levelization/results/includedby/
+.github/scripts/levelization/results/*
+!.github/scripts/levelization/results/loops.txt
+!.github/scripts/levelization/results/ordering.txt
 
 # Ignore tmp directory.
 tmp
@@ -111,4 +110,4 @@ bld.rippled/
 .vscode
 
 # Suggested in-tree build directory
-/.build/
+/.build*/

.pre-commit-config.yaml

@@ -1,6 +1,64 @@
-# .pre-commit-config.yaml
+# To run pre-commit hooks, first install pre-commit:
+# - `pip install pre-commit==${PRE_COMMIT_VERSION}`
+# - `pip install pre-commit-hooks==${PRE_COMMIT_HOOKS_VERSION}`
+#
+# Depending on your system, you can use `brew install` or `apt install` as well
+# for installing the pre-commit package, but `pip` is needed to install the
+# hooks; you can also use `pipx` if you prefer.
+# Next, install the required formatters:
+# - `pip install clang-format==${CLANG_VERSION}`
+# - `npm install prettier@${PRETTIER_VERSION}`
+#
+# See https://github.com/XRPLF/ci/blob/main/.github/workflows/tools-rippled.yml
+# for the versions used in the CI pipeline. You will need to have the exact same
+# versions of the tools installed on your system to produce the same results as
+# the pipeline.
+#
+# Then, run the following command to install the git hook scripts:
+# - `pre-commit install`
+# You can run all configured hooks against all files with:
+# - `pre-commit run --all-files`
+# To manually run a specific hook, use:
+# - `pre-commit run <hook_id> --all-files`
+# To run the hooks against only the files changed in the current commit, use:
+# - `pre-commit run`
 repos:
-  - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v18.1.8
+  - repo: local
     hooks:
       - id: clang-format
+        name: clang-format
+        language: system
+        entry: clang-format -i
+        files: '\.(cpp|hpp|h|ipp|proto)$'
+      - id: trailing-whitespace
+        name: trailing-whitespace
+        entry: trailing-whitespace-fixer
+        language: system
+        types: [text]
+      - id: end-of-file
+        name: end-of-file
+        entry: end-of-file-fixer
+        language: system
+        types: [text]
+      - id: mixed-line-ending
+        name: mixed-line-ending
+        entry: mixed-line-ending
+        language: system
+        types: [text]
+      - id: check-merge-conflict
+        name: check-merge-conflict
+        entry: check-merge-conflict --assume-in-merge
+        language: system
+        types: [text]
+  - repo: local
+    hooks:
+      - id: prettier
+        name: prettier
+        language: system
+        entry: prettier --ignore-unknown --write
+
+exclude: |
+  (?x)^(
+      external/.*|
+      .github/scripts/levelization/results/.*\.txt
+  )$

.prettierignore

@@ -0,0 +1 @@
+external

CONTRIBUTING.md

@@ -81,7 +81,7 @@ If you create new source files, they must be organized as follows:
 
 The source must be formatted according to the style guide below.
 
-Header includes must be [levelized](./Builds/levelization).
+Header includes must be [levelized](.github/scripts/levelization).
 
 Changes should be usually squashed down into a single commit.
 Some larger or more complicated change sets make more sense,

README.md

@@ -42,7 +42,7 @@ If you are interested in running an **API Server** (including a **Full History S
 Here are some good places to start learning the source code:
 
 - Read the markdown files in the source tree: `src/ripple/**/*.md`.
-- Read [the levelization document](./Builds/levelization) to get an idea of the internal dependency graph.
+- Read [the levelization document](.github/scripts/levelization) to get an idea of the internal dependency graph.
 - In the big picture, the `main` function constructs an `ApplicationImp` object, which implements the `Application` virtual interface. Almost every component in the application takes an `Application&` parameter in its constructor, typically named `app` and stored as a member variable `app_`. This allows most components to depend on any other component.
 
 ### Repository Contents

bin/git/setup-upstreams.sh

@@ -5,7 +5,7 @@ then
   name=$( basename $0 )
   cat <<- USAGE
   Usage: $name <username>
-  
+
   Where <username> is the Github username of the upstream repo. e.g. XRPLF
 USAGE
   exit 0
@@ -83,4 +83,3 @@ fi
 _run git fetch --jobs=$(nproc) upstreams
 
 exit 0
-

bin/git/squash-branches.sh

@@ -5,7 +5,7 @@ then
   name=$( basename $0 )
   cat <<- USAGE
   Usage: $name workbranch base/branch user/branch [user/branch [...]]
-  
+
   * workbranch will be created locally from base/branch
   * base/branch and user/branch may be specified as user:branch to allow
     easy copying from Github PRs
@@ -66,4 +66,3 @@ git push $push HEAD:$b
 git fetch $repo
 -------------------------------------------------------------------
 PUSH
-

cfg/rippled-example.cfg

@@ -396,8 +396,8 @@
 #   true - enables compression
 #   false - disables compression [default].
 #
-#   The rippled server can save bandwidth by compressing its peer-to-peer communications, 
-#   at a cost of greater CPU usage. If you enable link compression, 
+#   The rippled server can save bandwidth by compressing its peer-to-peer communications,
+#   at a cost of greater CPU usage. If you enable link compression,
 #   the server automatically compresses communications with peer servers
 #   that also have link compression enabled.
 #   https://xrpl.org/enable-link-compression.html
@@ -1011,7 +1011,7 @@
 #                           that rippled is still in sync with the network,
 #                           and that the validated ledger is less than
 #                           'age_threshold_seconds' old. If not, then continue
-#                           sleeping for this number of seconds and 
+#                           sleeping for this number of seconds and
 #                           checking until healthy.
 #                           Default is 5.
 #
@@ -1113,7 +1113,7 @@
 #       page_size           Valid values: integer (MUST be power of 2 between 512 and 65536)
 #                           The default is 4096 bytes. This setting determines
 #                           the size of a page in the transaction.db file.
-#                           See https://www.sqlite.org/pragma.html#pragma_page_size 
+#                           See https://www.sqlite.org/pragma.html#pragma_page_size
 #                           for more details about the available options.
 #
 #       journal_size_limit  Valid values: integer

cmake/RippledCompiler.cmake

@@ -16,13 +16,16 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 target_compile_definitions (common
   INTERFACE
     $<$<CONFIG:Debug>:DEBUG _DEBUG>
-    $<$<AND:$<BOOL:${profile}>,$<NOT:$<BOOL:${assert}>>>:NDEBUG>)
-    # ^^^^ NOTE: CMAKE release builds already have NDEBUG
-    # defined, so no need to add it explicitly except for
-    # this special case of (profile ON) and (assert OFF)
-    # -- presumably this is because we don't want profile
-    # builds asserting unless asserts were specifically
-    # requested
+    #[===[
+    NOTE: CMAKE release builds already have NDEBUG defined, so no need to add it
+    explicitly except for the special case of (profile ON) and (assert OFF).
+    Presumably this is because we don't want profile builds asserting unless
+    asserts were specifically requested.
+    ]===]
+    $<$<AND:$<BOOL:${profile}>,$<NOT:$<BOOL:${assert}>>>:NDEBUG>
+    # TODO: Remove once we have migrated functions from OpenSSL 1.x to 3.x.
+    OPENSSL_SUPPRESS_DEPRECATED
+)
 
 if (MSVC)
   # remove existing exception flag since we set it to -EHa

cmake/RippledCore.cmake

@@ -101,7 +101,7 @@ target_link_libraries(xrpl.libxrpl.resource PUBLIC xrpl.libxrpl.protocol)
 
 # Level 06
 add_module(xrpl net)
-target_link_libraries(xrpl.libxrpl.net PUBLIC 
+target_link_libraries(xrpl.libxrpl.net PUBLIC
   xrpl.libxrpl.basics
   xrpl.libxrpl.json
   xrpl.libxrpl.protocol

conan/global.conf

@@ -0,0 +1,9 @@
+# Global configuration for Conan. This is used to set the number of parallel
+# downloads, uploads, and build jobs. The verbosity is set to verbose to
+# provide more information during the build process.
+core:non_interactive=True
+core.download:parallel={{ os.cpu_count() }}
+core.upload:parallel={{ os.cpu_count() }}
+tools.build:jobs={{ (os.cpu_count() * 4/5) | int }}
+tools.build:verbosity=verbose
+tools.compilation:verbosity=verbose

conanfile.py

@@ -27,7 +27,7 @@ class Xrpl(ConanFile):
         'grpc/1.50.1',
         'libarchive/3.8.1',
         'nudb/2.0.9',
-        'openssl/1.1.1w',
+        'openssl/3.5.2',
         'soci/4.0.3',
         'zlib/1.3.1',
     ]

docs/0001-negative-unl/negativeUNLSqDiagram.puml

@@ -5,8 +5,8 @@ skinparam roundcorner 20
 skinparam maxmessagesize 160
 
 actor "Rippled Start" as RS
-participant "Timer" as T 
-participant "NetworkOPs" as NOP 
+participant "Timer" as T
+participant "NetworkOPs" as NOP
 participant "ValidatorList" as VL #lightgreen
 participant "Consensus" as GC
 participant "ConsensusAdaptor" as CA #lightgreen
@@ -20,7 +20,7 @@ VL -> NOP
 NOP -> VL: update trusted validators
 activate VL
 VL -> VL: re-calculate quorum
-hnote over VL#lightgreen: ignore negative listed validators\nwhen calculate quorum 
+hnote over VL#lightgreen: ignore negative listed validators\nwhen calculate quorum
 VL -> NOP
 deactivate VL
 NOP -> GC: start round
@@ -36,14 +36,14 @@ activate GC
 end
 
 alt phase == OPEN
-    alt should close ledger 
+    alt should close ledger
         GC -> GC: phase = ESTABLISH
         GC -> CA: onClose
         activate CA
-            alt sqn%256==0 
+            alt sqn%256==0
             CA -[#green]> RM: <font color=green>getValidations
-            CA -[#green]> CA: <font color=green>create UNLModify Tx 
-            hnote over CA#lightgreen: use validatations of the last 256 ledgers\nto figure out UNLModify Tx candidates.\nIf any, create UNLModify Tx, and add to TxSet.               
+            CA -[#green]> CA: <font color=green>create UNLModify Tx
+            hnote over CA#lightgreen: use validatations of the last 256 ledgers\nto figure out UNLModify Tx candidates.\nIf any, create UNLModify Tx, and add to TxSet.
             end
         CA -> GC
         GC -> CA: propose
@@ -61,14 +61,14 @@ else phase == ESTABLISH
             CA -> CA : build LCL
             hnote over CA #lightgreen: copy negative UNL from parent ledger
             alt sqn%256==0
-                CA -[#green]> CA: <font color=green>Adjust negative UNL 
+                CA -[#green]> CA: <font color=green>Adjust negative UNL
                 CA -[#green]> CA: <font color=green>apply UNLModify Tx
             end
             CA -> CA : validate and send validation message
             activate NOP
                 CA -> NOP : end consensus and\n<b>begin next consensus round
             deactivate NOP
-        deactivate CA        
+        deactivate CA
         hnote over RM: receive validations
     end
 else phase == ACCEPTED
@@ -76,4 +76,4 @@ else phase == ACCEPTED
 end
 deactivate GC
 
-@enduml
+@enduml

docs/0010-ledger-replay/ledger_replay_classes.puml

@@ -4,7 +4,7 @@ class TimeoutCounter {
   #app_ : Application&
 }
 
-TimeoutCounter o-- "1" Application 
+TimeoutCounter o-- "1" Application
 ': app_
 
 Stoppable <.. Application
@@ -14,13 +14,13 @@ class Application {
   -m_inboundLedgers : uptr<InboundLedgers>
 }
 
-Application *-- "1" LedgerReplayer 
+Application *-- "1" LedgerReplayer
 ': m_ledgerReplayer
-Application *-- "1" InboundLedgers 
+Application *-- "1" InboundLedgers
 ': m_inboundLedgers
 
 Stoppable <.. InboundLedgers
-Application "1" --o InboundLedgers 
+Application "1" --o InboundLedgers
 ': app_
 
 class InboundLedgers {
@@ -28,9 +28,9 @@ class InboundLedgers {
 }
 
 Stoppable <.. LedgerReplayer
-InboundLedgers "1" --o LedgerReplayer 
+InboundLedgers "1" --o LedgerReplayer
 ': inboundLedgers_
-Application "1" --o LedgerReplayer 
+Application "1" --o LedgerReplayer
 ': app_
 
 class LedgerReplayer {
@@ -42,17 +42,17 @@ class LedgerReplayer {
   -skipLists_ : hash_map<u256, wptr<SkipListAcquire>>
 }
 
-LedgerReplayer *-- LedgerReplayTask 
+LedgerReplayer *-- LedgerReplayTask
 ': tasks_
-LedgerReplayer o-- LedgerDeltaAcquire 
+LedgerReplayer o-- LedgerDeltaAcquire
 ': deltas_
-LedgerReplayer o-- SkipListAcquire 
+LedgerReplayer o-- SkipListAcquire
 ': skipLists_
 
 TimeoutCounter <.. LedgerReplayTask
-InboundLedgers "1" --o LedgerReplayTask 
+InboundLedgers "1" --o LedgerReplayTask
 ': inboundLedgers_
-LedgerReplayer "1" --o LedgerReplayTask 
+LedgerReplayer "1" --o LedgerReplayTask
 ': replayer_
 
 class LedgerReplayTask {
@@ -63,15 +63,15 @@ class LedgerReplayTask {
   +addDelta(sptr<LedgerDeltaAcquire>)
 }
 
-LedgerReplayTask *-- "1" SkipListAcquire 
+LedgerReplayTask *-- "1" SkipListAcquire
 ': skipListAcquirer_
-LedgerReplayTask *-- LedgerDeltaAcquire 
+LedgerReplayTask *-- LedgerDeltaAcquire
 ': deltas_
 
 TimeoutCounter <.. SkipListAcquire
-InboundLedgers "1" --o SkipListAcquire 
+InboundLedgers "1" --o SkipListAcquire
 ': inboundLedgers_
-LedgerReplayer "1" --o SkipListAcquire 
+LedgerReplayer "1" --o SkipListAcquire
 ': replayer_
 LedgerReplayTask --o SkipListAcquire : implicit via callback
 
@@ -83,9 +83,9 @@ class SkipListAcquire {
 }
 
 TimeoutCounter <.. LedgerDeltaAcquire
-InboundLedgers "1" --o LedgerDeltaAcquire 
+InboundLedgers "1" --o LedgerDeltaAcquire
 ': inboundLedgers_
-LedgerReplayer "1" --o LedgerDeltaAcquire 
+LedgerReplayer "1" --o LedgerDeltaAcquire
 ': replayer_
 LedgerReplayTask --o LedgerDeltaAcquire : implicit via callback
 
@@ -95,4 +95,4 @@ class LedgerDeltaAcquire {
   -replayer_ : LedgerReplayer&
   -dataReadyCallbacks_ : vector<callback>
 }
-@enduml
+@enduml

docs/0010-ledger-replay/ledger_replay_sequence.puml

@@ -38,7 +38,7 @@ deactivate lr
             loop
               lr -> lda : make_shared(ledgerId, ledgerSeq)
               return delta
-              lr -> lrt : addDelta(delta)              
+              lr -> lrt : addDelta(delta)
                 lrt -> lda : addDataCallback(callback)
                 return
               return
@@ -62,7 +62,7 @@ deactivate peer
     lr -> lda : processData(ledgerHeader, txns)
       lda -> lda : notify()
       note over lda: call the callbacks added by\naddDataCallback(callback).
-        lda -> lrt : callback(ledgerId) 
+        lda -> lrt : callback(ledgerId)
         lrt -> lrt : deltaReady(ledgerId)
           lrt -> lrt : tryAdvance()
             loop as long as child can be built
@@ -82,4 +82,4 @@ deactivate peer
 deactivate peer
 
 
-@enduml
+@enduml

external/.clang-format

@@ -1,3 +1,3 @@
 ---
 DisableFormat: true
-SortIncludes: false
+SortIncludes: Never

external/README.md

@@ -1,7 +1,6 @@
 # External Conan recipes
 
-The subdirectories in this directory contain copies of external libraries used
-by rippled.
+The subdirectories in this directory contain external libraries used by rippled.
 
 | Folder           | Upstream                                                       | Description                                                                                  |
 | :--------------- | :------------------------------------------------------------- | :------------------------------------------------------------------------------------------- |

external/ed25519-donna/README.md

@@ -1,12 +1,12 @@
-[ed25519](http://ed25519.cr.yp.to/) is an
-[Elliptic Curve Digital Signature Algortithm](http://en.wikipedia.org/wiki/Elliptic_Curve_DSA),
-developed by [Dan Bernstein](http://cr.yp.to/djb.html),
-[Niels Duif](http://www.nielsduif.nl/),
-[Tanja Lange](http://hyperelliptic.org/tanja),
-[Peter Schwabe](http://www.cryptojedi.org/users/peter/),
+[ed25519](http://ed25519.cr.yp.to/) is an 
+[Elliptic Curve Digital Signature Algortithm](http://en.wikipedia.org/wiki/Elliptic_Curve_DSA), 
+developed by [Dan Bernstein](http://cr.yp.to/djb.html), 
+[Niels Duif](http://www.nielsduif.nl/), 
+[Tanja Lange](http://hyperelliptic.org/tanja), 
+[Peter Schwabe](http://www.cryptojedi.org/users/peter/), 
 and [Bo-Yin Yang](http://www.iis.sinica.edu.tw/pages/byyang/).
 
-This project provides performant, portable 32-bit & 64-bit implementations. All implementations are
+This project provides performant, portable 32-bit & 64-bit implementations. All implementations are 
 of course constant time in regard to secret data.
 
 #### Performance
@@ -52,35 +52,35 @@ are made.
 
 #### Compilation
 
-No configuration is needed **if you are compiling against OpenSSL**.
+No configuration is needed **if you are compiling against OpenSSL**. 
 
 ##### Hash Options
 
 If you are not compiling aginst OpenSSL, you will need a hash function.
 
-To use a simple/**slow** implementation of SHA-512, use `-DED25519_REFHASH` when compiling `ed25519.c`.
+To use a simple/**slow** implementation of SHA-512, use `-DED25519_REFHASH` when compiling `ed25519.c`. 
 This should never be used except to verify the code works when OpenSSL is not available.
 
-To use a custom hash function, use `-DED25519_CUSTOMHASH` when compiling `ed25519.c` and put your
+To use a custom hash function, use `-DED25519_CUSTOMHASH` when compiling `ed25519.c` and put your 
 custom hash implementation in ed25519-hash-custom.h. The hash must have a 512bit digest and implement
 
-    struct ed25519_hash_context;
+	struct ed25519_hash_context;
 
-    void ed25519_hash_init(ed25519_hash_context *ctx);
-    void ed25519_hash_update(ed25519_hash_context *ctx, const uint8_t *in, size_t inlen);
-    void ed25519_hash_final(ed25519_hash_context *ctx, uint8_t *hash);
-    void ed25519_hash(uint8_t *hash, const uint8_t *in, size_t inlen);
+	void ed25519_hash_init(ed25519_hash_context *ctx);
+	void ed25519_hash_update(ed25519_hash_context *ctx, const uint8_t *in, size_t inlen);
+	void ed25519_hash_final(ed25519_hash_context *ctx, uint8_t *hash);
+	void ed25519_hash(uint8_t *hash, const uint8_t *in, size_t inlen);
 
 ##### Random Options
 
 If you are not compiling aginst OpenSSL, you will need a random function for batch verification.
 
-To use a custom random function, use `-DED25519_CUSTOMRANDOM` when compiling `ed25519.c` and put your
+To use a custom random function, use `-DED25519_CUSTOMRANDOM` when compiling `ed25519.c` and put your 
 custom hash implementation in ed25519-randombytes-custom.h. The random function must implement:
 
-    void ED25519_FN(ed25519_randombytes_unsafe) (void *p, size_t len);
+	void ED25519_FN(ed25519_randombytes_unsafe) (void *p, size_t len);
 
-Use `-DED25519_TEST` when compiling `ed25519.c` to use a deterministically seeded, non-thread safe CSPRNG
+Use `-DED25519_TEST` when compiling `ed25519.c` to use a deterministically seeded, non-thread safe CSPRNG 
 variant of Bob Jenkins [ISAAC](http://en.wikipedia.org/wiki/ISAAC_%28cipher%29)
 
 ##### Minor options
@@ -91,79 +91,80 @@ Use `-DED25519_FORCE_32BIT` to force the use of 32 bit routines even when compil
 
 ##### 32-bit
 
-    gcc ed25519.c -m32 -O3 -c
+	gcc ed25519.c -m32 -O3 -c
 
 ##### 64-bit
 
-    gcc ed25519.c -m64 -O3 -c
+	gcc ed25519.c -m64 -O3 -c
 
 ##### SSE2
 
-    gcc ed25519.c -m32 -O3 -c -DED25519_SSE2 -msse2
-    gcc ed25519.c -m64 -O3 -c -DED25519_SSE2
+	gcc ed25519.c -m32 -O3 -c -DED25519_SSE2 -msse2
+	gcc ed25519.c -m64 -O3 -c -DED25519_SSE2
 
 clang and icc are also supported
 
+
 #### Usage
 
 To use the code, link against `ed25519.o -mbits` and:
 
-    #include "ed25519.h"
+	#include "ed25519.h"
 
 Add `-lssl -lcrypto` when using OpenSSL (Some systems don't need -lcrypto? It might be trial and error).
 
 To generate a private key, simply generate 32 bytes from a secure
 cryptographic source:
 
-    ed25519_secret_key sk;
-    randombytes(sk, sizeof(ed25519_secret_key));
+	ed25519_secret_key sk;
+	randombytes(sk, sizeof(ed25519_secret_key));
 
 To generate a public key:
 
-    ed25519_public_key pk;
-    ed25519_publickey(sk, pk);
+	ed25519_public_key pk;
+	ed25519_publickey(sk, pk);
 
 To sign a message:
 
-    ed25519_signature sig;
-    ed25519_sign(message, message_len, sk, pk, signature);
+	ed25519_signature sig;
+	ed25519_sign(message, message_len, sk, pk, signature);
 
 To verify a signature:
 
-    int valid = ed25519_sign_open(message, message_len, pk, signature) == 0;
+	int valid = ed25519_sign_open(message, message_len, pk, signature) == 0;
 
 To batch verify signatures:
 
-    const unsigned char *mp[num] = {message1, message2..}
-    size_t ml[num] = {message_len1, message_len2..}
-    const unsigned char *pkp[num] = {pk1, pk2..}
-    const unsigned char *sigp[num] = {signature1, signature2..}
-    int valid[num]
+	const unsigned char *mp[num] = {message1, message2..}
+	size_t ml[num] = {message_len1, message_len2..}
+	const unsigned char *pkp[num] = {pk1, pk2..}
+	const unsigned char *sigp[num] = {signature1, signature2..}
+	int valid[num]
 
-    /* valid[i] will be set to 1 if the individual signature was valid, 0 otherwise */
-    int all_valid = ed25519_sign_open_batch(mp, ml, pkp, sigp, num, valid) == 0;
+	/* valid[i] will be set to 1 if the individual signature was valid, 0 otherwise */
+	int all_valid = ed25519_sign_open_batch(mp, ml, pkp, sigp, num, valid) == 0;
 
-**Note**: Batch verification uses `ed25519_randombytes_unsafe`, implemented in
-`ed25519-randombytes.h`, to generate random scalars for the verification code.
+**Note**: Batch verification uses `ed25519_randombytes_unsafe`, implemented in 
+`ed25519-randombytes.h`, to generate random scalars for the verification code. 
 The default implementation now uses OpenSSLs `RAND_bytes`.
 
 Unlike the [SUPERCOP](http://bench.cr.yp.to/supercop.html) version, signatures are
-not appended to messages, and there is no need for padding in front of messages.
-Additionally, the secret key does not contain a copy of the public key, so it is
+not appended to messages, and there is no need for padding in front of messages. 
+Additionally, the secret key does not contain a copy of the public key, so it is 
 32 bytes instead of 64 bytes, and the public key must be provided to the signing
 function.
 
 ##### Curve25519
 
-Curve25519 public keys can be generated thanks to
-[Adam Langley](http://www.imperialviolet.org/2013/05/10/fastercurve25519.html)
+Curve25519 public keys can be generated thanks to 
+[Adam Langley](http://www.imperialviolet.org/2013/05/10/fastercurve25519.html) 
 leveraging Ed25519's precomputed basepoint scalar multiplication.
 
-    curved25519_key sk, pk;
-    randombytes(sk, sizeof(curved25519_key));
-    curved25519_scalarmult_basepoint(pk, sk);
+	curved25519_key sk, pk;
+	randombytes(sk, sizeof(curved25519_key));
+	curved25519_scalarmult_basepoint(pk, sk);
 
-Note the name is curved25519, a combination of curve and ed25519, to prevent
+Note the name is curved25519, a combination of curve and ed25519, to prevent 
 name clashes. Performance is slightly faster than short message ed25519
 signing due to both using the same code for the scalar multiply.
 
@@ -179,4 +180,4 @@ with extreme values to ensure they function correctly. SSE2 is now supported.
 
 #### Papers
 
-[Available on the Ed25519 website](http://ed25519.cr.yp.to/papers.html)
+[Available on the Ed25519 website](http://ed25519.cr.yp.to/papers.html)

external/ed25519-donna/fuzz/README.md

@@ -1,78 +1,78 @@
 This code fuzzes ed25519-donna (and optionally ed25519-donna-sse2) against the ref10 implementations of
-[curve25519](https://github.com/floodyberry/supercop/tree/master/crypto_scalarmult/curve25519/ref10) and
+[curve25519](https://github.com/floodyberry/supercop/tree/master/crypto_scalarmult/curve25519/ref10) and 
 [ed25519](https://github.com/floodyberry/supercop/tree/master/crypto_sign/ed25519/ref10).
 
 Curve25519 tests that generating a public key from a secret key
 
 # Building
 
-## \*nix + PHP
+## *nix + PHP
 
 `php build-nix.php (required parameters) (optional parameters)`
 
 Required parameters:
 
-- `--function=[curve25519,ed25519]`
-- `--bits=[32,64]`
+* `--function=[curve25519,ed25519]`
+* `--bits=[32,64]`
 
 Optional parameters:
 
-- `--with-sse2`
+* `--with-sse2`
 
-  Also fuzz against ed25519-donna-sse2
+    Also fuzz against ed25519-donna-sse2
+* `--with-openssl`
 
-- `--with-openssl`
+    Build with OpenSSL's SHA-512.
 
-  Build with OpenSSL's SHA-512.
+    Default: Reference SHA-512 implementation (slow!)
 
-  Default: Reference SHA-512 implementation (slow!)
+* `--compiler=[gcc,clang,icc]`
 
-- `--compiler=[gcc,clang,icc]`
+    Default: gcc
 
-  Default: gcc
+* `--no-asm`
 
-- `--no-asm`
+    Do not use platform specific assembler
 
-  Do not use platform specific assembler
 
 example:
-
-    php build-nix.php --bits=64 --function=ed25519 --with-sse2 --compiler=icc
+    
+    php build-nix.php --bits=64 --function=ed25519 --with-sse2 --compiler=icc 
 
 ## Windows
 
 Create a project with access to the ed25519 files.
 
-If you are not using OpenSSL, add the `ED25519_REFHASH` define to the projects
+If you are not using OpenSSL, add the `ED25519_REFHASH` define to the projects 
 "Properties/Preprocessor/Preprocessor Definitions" option
 
 Add the following files to the project:
 
-- `fuzz/curve25519-ref10.c`
-- `fuzz/ed25519-ref10.c`
-- `fuzz/ed25519-donna.c`
-- `fuzz/ed25519-donna-sse2.c` (optional)
-- `fuzz-[curve25519/ed25519].c` (depending on which you want to fuzz)
+* `fuzz/curve25519-ref10.c`
+* `fuzz/ed25519-ref10.c`
+* `fuzz/ed25519-donna.c`
+* `fuzz/ed25519-donna-sse2.c` (optional)
+* `fuzz-[curve25519/ed25519].c` (depending on which you want to fuzz)
 
-If you are also fuzzing against ed25519-donna-sse2, add the `ED25519_SSE2` define for `fuzz-[curve25519/ed25519].c` under
+If you are also fuzzing against ed25519-donna-sse2, add the `ED25519_SSE2` define for `fuzz-[curve25519/ed25519].c` under 
 its "Properties/Preprocessor/Preprocessor Definitions" option.
 
 # Running
 
-If everything agrees, the program will only output occasional status dots (every 0x1000 passes)
+If everything agrees, the program will only output occasional status dots (every 0x1000 passes) 
 and a 64bit progress count (every 0x20000 passes):
 
     fuzzing:  ref10 curved25519 curved25519-sse2
-
+    
     ................................ [0000000000020000]
     ................................ [0000000000040000]
     ................................ [0000000000060000]
     ................................ [0000000000080000]
     ................................ [00000000000a0000]
     ................................ [00000000000c0000]
-
+ 
 If any of the implementations do not agree with the ref10 implementation, the program will dump
-the random data that was used, the data generated by the ref10 implementation, and diffs of the
+the random data that was used, the data generated by the ref10 implementation, and diffs of the 
 ed25519-donna data against the ref10 data.
 
 ## Example errors
@@ -83,21 +83,21 @@ These are example error dumps (with intentionally introduced errors).
 
 Random data:
 
-- sk, or Secret Key
-- m, or Message
+* sk, or Secret Key
+* m, or Message
 
 Generated data:
 
-- pk, or Public Key
-- sig, or Signature
-- valid, or if the signature of the message is valid with the public key
+* pk, or Public Key
+* sig, or Signature
+* valid, or if the signature of the message is valid with the public key
 
 Dump:
 
     sk:
     0x3b,0xb7,0x17,0x7a,0x66,0xdc,0xb7,0x9a,0x90,0x25,0x07,0x99,0x96,0xf3,0x92,0xef,
     0x78,0xf8,0xad,0x6c,0x35,0x87,0x81,0x67,0x03,0xe6,0x95,0xba,0x06,0x18,0x7c,0x9c,
-
+    
     m:
     0x7c,0x8d,0x3d,0xe1,0x92,0xee,0x7a,0xb8,0x4d,0xc9,0xfb,0x02,0x34,0x1e,0x5a,0x91,
     0xee,0x01,0xa6,0xb8,0xab,0x37,0x3f,0x3d,0x6d,0xa2,0x47,0xe3,0x27,0x93,0x7c,0xb7,
@@ -107,66 +107,67 @@ Dump:
     0x63,0x14,0xe0,0x81,0x52,0xec,0xcd,0xcf,0x70,0x54,0x7d,0xa3,0x49,0x8b,0xf0,0x89,
     0x70,0x07,0x12,0x2a,0xd9,0xaa,0x16,0x01,0xb2,0x16,0x3a,0xbb,0xfc,0xfa,0x13,0x5b,
     0x69,0x83,0x92,0x70,0x95,0x76,0xa0,0x8e,0x16,0x79,0xcc,0xaa,0xb5,0x7c,0xf8,0x7a,
-
+    
     ref10:
     pk:
     0x71,0xb0,0x5e,0x62,0x1b,0xe3,0xe7,0x36,0x91,0x8b,0xc0,0x13,0x36,0x0c,0xc9,0x04,
     0x16,0xf5,0xff,0x48,0x0c,0x83,0x6b,0x88,0x53,0xa2,0xc6,0x0f,0xf7,0xac,0x42,0x04,
-
+    
     sig:
     0x3e,0x05,0xc5,0x37,0x16,0x0b,0x29,0x30,0x89,0xa3,0xe7,0x83,0x08,0x16,0xdd,0x96,
     0x02,0xfa,0x0d,0x44,0x2c,0x43,0xaa,0x80,0x93,0x04,0x58,0x22,0x09,0xbf,0x11,0xa5,
     0xcc,0xa5,0x3c,0x9f,0xa0,0xa4,0x64,0x5a,0x4a,0xdb,0x20,0xfb,0xc7,0x9b,0xfd,0x3f,
     0x08,0xae,0xc4,0x3c,0x1e,0xd8,0xb6,0xb4,0xd2,0x6d,0x80,0x92,0xcb,0x71,0xf3,0x02,
-
+    
     valid: yes
-
+    
     ed25519-donna:
     pk diff:
     ____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,
     ____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,
-
+    
     sig diff:
     0x2c,0xb9,0x25,0x14,0xd0,0x94,0xeb,0xfe,0x46,0x02,0xc2,0xe8,0xa3,0xeb,0xbf,0xb5,
     0x72,0x84,0xbf,0xc1,0x8a,0x32,0x30,0x99,0xf7,0x58,0xfe,0x06,0xa8,0xdc,0xdc,0xab,
     0xb5,0x57,0x03,0x33,0x87,0xce,0x54,0x55,0x6a,0x69,0x8a,0xc4,0xb7,0x2a,0xed,0x97,
     0xb4,0x68,0xe7,0x52,0x7a,0x07,0x55,0x3b,0xa2,0x94,0xd6,0x5e,0xa1,0x61,0x80,0x08,
-
+    
     valid: no
 
-In this case, the generated public key matches, but the generated signature is completely
+In this case, the generated public key matches, but the generated signature is completely 
 different and does not validate.
 
 ### Curve25519
 
 Random data:
 
-- sk, or Secret Key
+* sk, or Secret Key
 
 Generated data:
 
-- pk, or Public Key
+* pk, or Public Key
 
 Dump:
 
     sk:
     0x44,0xec,0x0b,0x0e,0xa2,0x0e,0x9c,0x5b,0x8c,0xce,0x7b,0x1d,0x68,0xae,0x0f,0x9e,
     0x81,0xe2,0x04,0x76,0xda,0x87,0xa4,0x9e,0xc9,0x4f,0x3b,0xf9,0xc3,0x89,0x63,0x70,
-
-
+    
+    
     ref10:
     0x24,0x55,0x55,0xc0,0xf9,0x80,0xaf,0x02,0x43,0xee,0x8c,0x7f,0xc1,0xad,0x90,0x95,
     0x57,0x91,0x14,0x2e,0xf2,0x14,0x22,0x80,0xdd,0x4e,0x3c,0x85,0x71,0x84,0x8c,0x62,
-
-
+    
+    
     curved25519 diff:
     0x12,0xd1,0x61,0x2b,0x16,0xb3,0xd8,0x29,0xf8,0xa3,0xba,0x70,0x4e,0x49,0x4f,0x43,
     0xa1,0x3c,0x6b,0x42,0x11,0x61,0xcc,0x30,0x87,0x73,0x46,0xfb,0x85,0xc7,0x9a,0x35,
-
-
+    
+    
     curved25519-sse2 diff:
     ____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,
     ____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,____,
 
-In this case, curved25519 is totally wrong, while curved25519-sse2 matches the reference
-implementation.
+
+In this case, curved25519 is totally wrong, while curved25519-sse2 matches the reference 
+implementation.

external/secp256k1/CHANGELOG.md

@@ -8,189 +8,153 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.6.0] - 2024-11-04
 
 #### Added
-
-- New module `musig` implements the MuSig2 multisignature scheme according to the [BIP 327 specification](https://github.com/bitcoin/bips/blob/master/bip-0327.mediawiki). See:
-  - Header file `include/secp256k1_musig.h` which defines the new API.
-  - Document `doc/musig.md` for further notes on API usage.
-  - Usage example `examples/musig.c`.
-- New CMake variable `SECP256K1_APPEND_LDFLAGS` for appending linker flags to the build command.
+ - New module `musig` implements the MuSig2 multisignature scheme according to the [BIP 327 specification](https://github.com/bitcoin/bips/blob/master/bip-0327.mediawiki). See:
+   - Header file `include/secp256k1_musig.h` which defines the new API.
+   - Document `doc/musig.md` for further notes on API usage.
+   - Usage example `examples/musig.c`.
+ - New CMake variable `SECP256K1_APPEND_LDFLAGS` for appending linker flags to the build command.
 
 #### Changed
-
-- API functions now use a significantly more robust method to clear secrets from the stack before returning. However, secret clearing remains a best-effort security measure and cannot guarantee complete removal.
-- Any type `secp256k1_foo` can now be forward-declared using `typedef struct secp256k1_foo secp256k1_foo;` (or also `struct secp256k1_foo;` in C++).
-- Organized CMake build artifacts into dedicated directories (`bin/` for executables, `lib/` for libraries) to improve build output structure and Windows shared library compatibility.
+ - API functions now use a significantly more robust method to clear secrets from the stack before returning. However, secret clearing remains a best-effort security measure and cannot guarantee complete removal.
+ - Any type `secp256k1_foo` can now be forward-declared using `typedef struct secp256k1_foo secp256k1_foo;` (or also `struct secp256k1_foo;` in C++).
+ - Organized CMake build artifacts into dedicated directories (`bin/` for executables, `lib/` for libraries) to improve build output structure and Windows shared library compatibility.
 
 #### Removed
-
-- Removed the `secp256k1_scratch_space` struct and its associated functions `secp256k1_scratch_space_create` and `secp256k1_scratch_space_destroy` because the scratch space was unused in the API.
+ - Removed the `secp256k1_scratch_space` struct and its associated functions `secp256k1_scratch_space_create` and `secp256k1_scratch_space_destroy` because the scratch space was unused in the API.
 
 #### ABI Compatibility
-
 The symbols `secp256k1_scratch_space_create` and `secp256k1_scratch_space_destroy` were removed.
 Otherwise, the library maintains backward compatibility with versions 0.3.x through 0.5.x.
 
 ## [0.5.1] - 2024-08-01
 
 #### Added
-
-- Added usage example for an ElligatorSwift key exchange.
+ - Added usage example for an ElligatorSwift key exchange.
 
 #### Changed
-
-- The default size of the precomputed table for signing was changed from 22 KiB to 86 KiB. The size can be changed with the configure option `--ecmult-gen-kb` (`SECP256K1_ECMULT_GEN_KB` for CMake).
-- "auto" is no longer an accepted value for the `--with-ecmult-window` and `--with-ecmult-gen-kb` configure options (this also applies to `SECP256K1_ECMULT_WINDOW_SIZE` and `SECP256K1_ECMULT_GEN_KB` in CMake). To achieve the same configuration as previously provided by the "auto" value, omit setting the configure option explicitly.
+ - The default size of the precomputed table for signing was changed from 22 KiB to 86 KiB. The size can be changed with the configure option `--ecmult-gen-kb` (`SECP256K1_ECMULT_GEN_KB` for CMake).
+ - "auto" is no longer an accepted value for the `--with-ecmult-window` and `--with-ecmult-gen-kb` configure options (this also applies to  `SECP256K1_ECMULT_WINDOW_SIZE` and `SECP256K1_ECMULT_GEN_KB` in CMake). To achieve the same configuration as previously provided by the "auto" value, omit setting the configure option explicitly.
 
 #### Fixed
-
-- Fixed compilation when the extrakeys module is disabled.
+ - Fixed compilation when the extrakeys module is disabled.
 
 #### ABI Compatibility
-
 The ABI is backward compatible with versions 0.5.0, 0.4.x and 0.3.x.
 
 ## [0.5.0] - 2024-05-06
 
 #### Added
-
-- New function `secp256k1_ec_pubkey_sort` that sorts public keys using lexicographic (of compressed serialization) order.
+ - New function `secp256k1_ec_pubkey_sort` that sorts public keys using lexicographic (of compressed serialization) order.
 
 #### Changed
-
-- The implementation of the point multiplication algorithm used for signing and public key generation was changed, resulting in improved performance for those operations.
-  - The related configure option `--ecmult-gen-precision` was replaced with `--ecmult-gen-kb` (`SECP256K1_ECMULT_GEN_KB` for CMake).
-  - This changes the supported precomputed table sizes for these operations. The new supported sizes are 2 KiB, 22 KiB, or 86 KiB (while the old supported sizes were 32 KiB, 64 KiB, or 512 KiB).
+ - The implementation of the point multiplication algorithm used for signing and public key generation was changed, resulting in improved performance for those operations.
+   - The related configure option `--ecmult-gen-precision` was replaced with `--ecmult-gen-kb` (`SECP256K1_ECMULT_GEN_KB` for CMake).
+   - This changes the supported precomputed table sizes for these operations. The new supported sizes are 2 KiB, 22 KiB, or 86 KiB (while the old supported sizes were 32 KiB, 64 KiB, or 512 KiB).
 
 #### ABI Compatibility
-
 The ABI is backward compatible with versions 0.4.x and 0.3.x.
 
 ## [0.4.1] - 2023-12-21
 
 #### Changed
-
-- The point multiplication algorithm used for ECDH operations (module `ecdh`) was replaced with a slightly faster one.
-- Optional handwritten x86_64 assembly for field operations was removed because modern C compilers are able to output more efficient assembly. This change results in a significant speedup of some library functions when handwritten x86_64 assembly is enabled (`--with-asm=x86_64` in GNU Autotools, `-DSECP256K1_ASM=x86_64` in CMake), which is the default on x86_64. Benchmarks with GCC 10.5.0 show a 10% speedup for `secp256k1_ecdsa_verify` and `secp256k1_schnorrsig_verify`.
+ - The point multiplication algorithm used for ECDH operations (module `ecdh`) was replaced with a slightly faster one.
+ - Optional handwritten x86_64 assembly for field operations was removed because modern C compilers are able to output more efficient assembly. This change results in a significant speedup of some library functions when handwritten x86_64 assembly is enabled (`--with-asm=x86_64` in GNU Autotools, `-DSECP256K1_ASM=x86_64` in CMake), which is the default on x86_64. Benchmarks with GCC 10.5.0 show a 10% speedup for `secp256k1_ecdsa_verify` and `secp256k1_schnorrsig_verify`.
 
 #### ABI Compatibility
-
 The ABI is backward compatible with versions 0.4.0 and 0.3.x.
 
 ## [0.4.0] - 2023-09-04
 
 #### Added
-
-- New module `ellswift` implements ElligatorSwift encoding for public keys and x-only Diffie-Hellman key exchange for them.
-  ElligatorSwift permits representing secp256k1 public keys as 64-byte arrays which cannot be distinguished from uniformly random. See:
-  - Header file `include/secp256k1_ellswift.h` which defines the new API.
-  - Document `doc/ellswift.md` which explains the mathematical background of the scheme.
-  - The [paper](https://eprint.iacr.org/2022/759) on which the scheme is based.
-- We now test the library with unreleased development snapshots of GCC and Clang. This gives us an early chance to catch miscompilations and constant-time issues introduced by the compiler (such as those that led to the previous two releases).
+ - New module `ellswift` implements ElligatorSwift encoding for public keys and x-only Diffie-Hellman key exchange for them.
+   ElligatorSwift permits representing secp256k1 public keys as 64-byte arrays which cannot be distinguished from uniformly random. See:
+   - Header file `include/secp256k1_ellswift.h` which defines the new API.
+   - Document `doc/ellswift.md` which explains the mathematical background of the scheme.
+   - The [paper](https://eprint.iacr.org/2022/759) on which the scheme is based.
+ - We now test the library with unreleased development snapshots of GCC and Clang. This gives us an early chance to catch miscompilations and constant-time issues introduced by the compiler (such as those that led to the previous two releases).
 
 #### Fixed
-
-- Fixed symbol visibility in Windows DLL builds, where three internal library symbols were wrongly exported.
+ - Fixed symbol visibility in Windows DLL builds, where three internal library symbols were wrongly exported.
 
 #### Changed
-
-- When consuming libsecp256k1 as a static library on Windows, the user must now define the `SECP256K1_STATIC` macro before including `secp256k1.h`.
+ - When consuming libsecp256k1 as a static library on Windows, the user must now define the `SECP256K1_STATIC` macro before including `secp256k1.h`.
 
 #### ABI Compatibility
-
 This release is backward compatible with the ABI of 0.3.0, 0.3.1, and 0.3.2. Symbol visibility is now believed to be handled properly on supported platforms and is now considered to be part of the ABI. Please report any improperly exported symbols as a bug.
 
 ## [0.3.2] - 2023-05-13
-
 We strongly recommend updating to 0.3.2 if you use or plan to use GCC >=13 to compile libsecp256k1. When in doubt, check the GCC version using `gcc -v`.
 
 #### Security
-
-- Module `ecdh`: Fix "constant-timeness" issue with GCC 13.1 (and potentially future versions of GCC) that could leave applications using libsecp256k1's ECDH module vulnerable to a timing side-channel attack. The fix avoids secret-dependent control flow during ECDH computations when libsecp256k1 is compiled with GCC 13.1.
+ - Module `ecdh`: Fix "constant-timeness" issue with GCC 13.1 (and potentially future versions of GCC) that could leave applications using libsecp256k1's ECDH module vulnerable to a timing side-channel attack. The fix avoids secret-dependent control flow during ECDH computations when libsecp256k1 is compiled with GCC 13.1.
 
 #### Fixed
-
-- Fixed an old bug that permitted compilers to potentially output bad assembly code on x86_64. In theory, it could lead to a crash or a read of unrelated memory, but this has never been observed on any compilers so far.
+ - Fixed an old bug that permitted compilers to potentially output bad assembly code on x86_64. In theory, it could lead to a crash or a read of unrelated memory, but this has never been observed on any compilers so far.
 
 #### Changed
-
-- Various improvements and changes to CMake builds. CMake builds remain experimental.
-  - Made API versioning consistent with GNU Autotools builds.
-  - Switched to `BUILD_SHARED_LIBS` variable for controlling whether to build a static or a shared library.
-  - Added `SECP256K1_INSTALL` variable for the controlling whether to install the build artefacts.
-- Renamed asm build option `arm` to `arm32`. Use `--with-asm=arm32` instead of `--with-asm=arm` (GNU Autotools), and `-DSECP256K1_ASM=arm32` instead of `-DSECP256K1_ASM=arm` (CMake).
+ - Various improvements and changes to CMake builds. CMake builds remain experimental.
+   - Made API versioning consistent with GNU Autotools builds.
+   - Switched to `BUILD_SHARED_LIBS` variable for controlling whether to build a static or a shared library.
+   - Added `SECP256K1_INSTALL` variable for the controlling whether to install the build artefacts.
+ - Renamed asm build option `arm` to `arm32`. Use `--with-asm=arm32` instead of `--with-asm=arm` (GNU Autotools), and `-DSECP256K1_ASM=arm32` instead of `-DSECP256K1_ASM=arm` (CMake).
 
 #### ABI Compatibility
-
 The ABI is compatible with versions 0.3.0 and 0.3.1.
 
 ## [0.3.1] - 2023-04-10
-
 We strongly recommend updating to 0.3.1 if you use or plan to use Clang >=14 to compile libsecp256k1, e.g., Xcode >=14 on macOS has Clang >=14. When in doubt, check the Clang version using `clang -v`.
 
 #### Security
-
-- Fix "constant-timeness" issue with Clang >=14 that could leave applications using libsecp256k1 vulnerable to a timing side-channel attack. The fix avoids secret-dependent control flow and secret-dependent memory accesses in conditional moves of memory objects when libsecp256k1 is compiled with Clang >=14.
+ - Fix "constant-timeness" issue with Clang >=14 that could leave applications using libsecp256k1 vulnerable to a timing side-channel attack. The fix avoids secret-dependent control flow and secret-dependent memory accesses in conditional moves of memory objects when libsecp256k1 is compiled with Clang >=14.
 
 #### Added
-
-- Added tests against [Project Wycheproof's](https://github.com/google/wycheproof/) set of ECDSA test vectors (Bitcoin "low-S" variant), a fixed set of test cases designed to trigger various edge cases.
+  - Added tests against [Project Wycheproof's](https://github.com/google/wycheproof/) set of ECDSA test vectors (Bitcoin "low-S" variant), a fixed set of test cases designed to trigger various edge cases.
 
 #### Changed
-
-- Increased minimum required CMake version to 3.13. CMake builds remain experimental.
+ - Increased minimum required CMake version to 3.13. CMake builds remain experimental.
 
 #### ABI Compatibility
-
 The ABI is compatible with version 0.3.0.
 
 ## [0.3.0] - 2023-03-08
 
 #### Added
-
-- Added experimental support for CMake builds. Traditional GNU Autotools builds (`./configure` and `make`) remain fully supported.
-- Usage examples: Added a recommended method for securely clearing sensitive data, e.g., secret keys, from memory.
-- Tests: Added a new test binary `noverify_tests`. This binary runs the tests without some additional checks present in the ordinary `tests` binary and is thereby closer to production binaries. The `noverify_tests` binary is automatically run as part of the `make check` target.
+ - Added experimental support for CMake builds. Traditional GNU Autotools builds (`./configure` and `make`) remain fully supported.
+ - Usage examples: Added a recommended method for securely clearing sensitive data, e.g., secret keys, from memory.
+ - Tests: Added a new test binary `noverify_tests`. This binary runs the tests without some additional checks present in the ordinary `tests` binary and is thereby closer to production binaries. The `noverify_tests` binary is automatically run as part of the `make check` target.
 
 #### Fixed
-
-- Fixed declarations of API variables for MSVC (`__declspec(dllimport)`). This fixes MSVC builds of programs which link against a libsecp256k1 DLL dynamically and use API variables (and not only API functions). Unfortunately, the MSVC linker now will emit warning `LNK4217` when trying to link against libsecp256k1 statically. Pass `/ignore:4217` to the linker to suppress this warning.
+ - Fixed declarations of API variables for MSVC (`__declspec(dllimport)`). This fixes MSVC builds of programs which link against a libsecp256k1 DLL dynamically and use API variables (and not only API functions). Unfortunately, the MSVC linker now will emit warning `LNK4217` when trying to link against libsecp256k1 statically. Pass `/ignore:4217` to the linker to suppress this warning.
 
 #### Changed
-
-- Forbade cloning or destroying `secp256k1_context_static`. Create a new context instead of cloning the static context. (If this change breaks your code, your code is probably wrong.)
-- Forbade randomizing (copies of) `secp256k1_context_static`. Randomizing a copy of `secp256k1_context_static` did not have any effect and did not provide defense-in-depth protection against side-channel attacks. Create a new context if you want to benefit from randomization.
+ - Forbade cloning or destroying `secp256k1_context_static`. Create a new context instead of cloning the static context. (If this change breaks your code, your code is probably wrong.)
+ - Forbade randomizing (copies of) `secp256k1_context_static`. Randomizing a copy of `secp256k1_context_static` did not have any effect and did not provide defense-in-depth protection against side-channel attacks. Create a new context if you want to benefit from randomization.
 
 #### Removed
-
-- Removed the configuration header `src/libsecp256k1-config.h`. We recommend passing flags to `./configure` or `cmake` to set configuration options (see `./configure --help` or `cmake -LH`). If you cannot or do not want to use one of the supported build systems, pass configuration flags such as `-DSECP256K1_ENABLE_MODULE_SCHNORRSIG` manually to the compiler (see the file `configure.ac` for supported flags).
+ - Removed the configuration header `src/libsecp256k1-config.h`. We recommend passing flags to `./configure` or `cmake` to set configuration options (see `./configure --help` or `cmake -LH`). If you cannot or do not want to use one of the supported build systems, pass configuration flags such as `-DSECP256K1_ENABLE_MODULE_SCHNORRSIG` manually to the compiler (see the file `configure.ac` for supported flags).
 
 #### ABI Compatibility
-
-Due to changes in the API regarding `secp256k1_context_static` described above, the ABI is _not_ compatible with previous versions.
+Due to changes in the API regarding `secp256k1_context_static` described above, the ABI is *not* compatible with previous versions.
 
 ## [0.2.0] - 2022-12-12
 
 #### Added
-
-- Added usage examples for common use cases in a new `examples/` directory.
-- Added `secp256k1_selftest`, to be used in conjunction with `secp256k1_context_static`.
-- Added support for 128-bit wide multiplication on MSVC for x86_64 and arm64, giving roughly a 20% speedup on those platforms.
+ - Added usage examples for common use cases in a new `examples/` directory.
+ - Added `secp256k1_selftest`, to be used in conjunction with `secp256k1_context_static`.
+ - Added support for 128-bit wide multiplication on MSVC for x86_64 and arm64, giving roughly a 20% speedup on those platforms.
 
 #### Changed
-
-- Enabled modules `schnorrsig`, `extrakeys` and `ecdh` by default in `./configure`.
-- The `secp256k1_nonce_function_rfc6979` nonce function, used by default by `secp256k1_ecdsa_sign`, now reduces the message hash modulo the group order to match the specification. This only affects improper use of ECDSA signing API.
+ - Enabled modules `schnorrsig`, `extrakeys` and `ecdh` by default in `./configure`.
+ - The `secp256k1_nonce_function_rfc6979` nonce function, used by default by `secp256k1_ecdsa_sign`, now reduces the message hash modulo the group order to match the specification. This only affects improper use of ECDSA signing API.
 
 #### Deprecated
-
-- Deprecated context flags `SECP256K1_CONTEXT_VERIFY` and `SECP256K1_CONTEXT_SIGN`. Use `SECP256K1_CONTEXT_NONE` instead.
-- Renamed `secp256k1_context_no_precomp` to `secp256k1_context_static`.
-- Module `schnorrsig`: renamed `secp256k1_schnorrsig_sign` to `secp256k1_schnorrsig_sign32`.
+ - Deprecated context flags `SECP256K1_CONTEXT_VERIFY` and `SECP256K1_CONTEXT_SIGN`. Use `SECP256K1_CONTEXT_NONE` instead.
+ - Renamed `secp256k1_context_no_precomp` to `secp256k1_context_static`.
+ - Module `schnorrsig`: renamed `secp256k1_schnorrsig_sign` to `secp256k1_schnorrsig_sign32`.
 
 #### ABI Compatibility
-
 Since this is the first release, we do not compare application binary interfaces.
-However, there are earlier unreleased versions of libsecp256k1 that are _not_ ABI compatible with this version.
+However, there are earlier unreleased versions of libsecp256k1 that are *not* ABI compatible with this version.
 
 ## [0.1.0] - 2013-03-05 to 2021-12-25
 

external/secp256k1/CMakePresets.json

@@ -1,9 +1,5 @@
 {
-  "cmakeMinimumRequired": {
-    "major": 3,
-    "minor": 21,
-    "patch": 0
-  },
+  "cmakeMinimumRequired": {"major": 3, "minor": 21, "patch": 0}, 
   "version": 3,
   "configurePresets": [
     {

external/secp256k1/CONTRIBUTING.md

@@ -12,15 +12,15 @@ The libsecp256k1 project welcomes contributions in the form of new functionality
 It is the responsibility of the contributors to convince the maintainers that the proposed functionality is within the project's scope, high-quality and maintainable.
 Contributors are recommended to provide the following in addition to the new code:
 
-- **Specification:**
-  A specification can help significantly in reviewing the new code as it provides documentation and context.
-  It may justify various design decisions, give a motivation and outline security goals.
-  If the specification contains pseudocode, a reference implementation or test vectors, these can be used to compare with the proposed libsecp256k1 code.
-- **Security Arguments:**
-  In addition to a defining the security goals, it should be argued that the new functionality meets these goals.
-  Depending on the nature of the new functionality, a wide range of security arguments are acceptable, ranging from being "obviously secure" to rigorous proofs of security.
-- **Relevance Arguments:**
-  The relevance of the new functionality for the Bitcoin ecosystem should be argued by outlining clear use cases.
+* **Specification:**
+    A specification can help significantly in reviewing the new code as it provides documentation and context.
+    It may justify various design decisions, give a motivation and outline security goals.
+    If the specification contains pseudocode, a reference implementation or test vectors, these can be used to compare with the proposed libsecp256k1 code.
+* **Security Arguments:**
+    In addition to a defining the security goals, it should be argued that the new functionality meets these goals.
+    Depending on the nature of the new functionality, a wide range of security arguments are acceptable, ranging from being "obviously secure" to rigorous proofs of security.
+* **Relevance Arguments:**
+    The relevance of the new functionality for the Bitcoin ecosystem should be argued by outlining clear use cases.
 
 These are not the only factors taken into account when considering to add new functionality.
 The proposed new libsecp256k1 code must be of high quality, including API documentation and tests, as well as featuring a misuse-resistant API design.
@@ -44,36 +44,36 @@ The Contributor Workflow & Peer Review in libsecp256k1 are similar to Bitcoin Co
 
 In addition, libsecp256k1 tries to maintain the following coding conventions:
 
-- No runtime heap allocation (e.g., no `malloc`) unless explicitly requested by the caller (via `secp256k1_context_create` or `secp256k1_scratch_space_create`, for example). Moreover, it should be possible to use the library without any heap allocations.
-- The tests should cover all lines and branches of the library (see [Test coverage](#coverage)).
-- Operations involving secret data should be tested for being constant time with respect to the secrets (see [src/ctime_tests.c](src/ctime_tests.c)).
-- Local variables containing secret data should be cleared explicitly to try to delete secrets from memory.
-- Use `secp256k1_memcmp_var` instead of `memcmp` (see [#823](https://github.com/bitcoin-core/secp256k1/issues/823)).
-- As a rule of thumb, the default values for configuration options should target standard desktop machines and align with Bitcoin Core's defaults, and the tests should mostly exercise the default configuration (see [#1549](https://github.com/bitcoin-core/secp256k1/issues/1549#issuecomment-2200559257)).
+* No runtime heap allocation (e.g., no `malloc`) unless explicitly requested by the caller (via `secp256k1_context_create` or `secp256k1_scratch_space_create`, for example). Moreover, it should be possible to use the library without any heap allocations.
+* The tests should cover all lines and branches of the library (see [Test coverage](#coverage)).
+* Operations involving secret data should be tested for being constant time with respect to the secrets (see [src/ctime_tests.c](src/ctime_tests.c)).
+* Local variables containing secret data should be cleared explicitly to try to delete secrets from memory.
+* Use `secp256k1_memcmp_var` instead of `memcmp` (see [#823](https://github.com/bitcoin-core/secp256k1/issues/823)).
+* As a rule of thumb, the default values for configuration options should target standard desktop machines and align with Bitcoin Core's defaults, and the tests should mostly exercise the default configuration (see [#1549](https://github.com/bitcoin-core/secp256k1/issues/1549#issuecomment-2200559257)).
 
 #### Style conventions
 
-- Commits should be atomic and diffs should be easy to read. For this reason, do not mix any formatting fixes or code moves with actual code changes. Make sure each individual commit is hygienic: that it builds successfully on its own without warnings, errors, regressions, or test failures.
-- New code should adhere to the style of existing, in particular surrounding, code. Other than that, we do not enforce strict rules for code formatting.
-- The code conforms to C89. Most notably, that means that only `/* ... */` comments are allowed (no `//` line comments). Moreover, any declarations in a `{ ... }` block (e.g., a function) must appear at the beginning of the block before any statements. When you would like to declare a variable in the middle of a block, you can open a new block:
-  ```C
-  void secp256k_foo(void) {
-      unsigned int x;              /* declaration */
-      int y = 2*x;                 /* declaration */
-      x = 17;                      /* statement */
-      {
-          int a, b;                /* declaration */
-          a = x + y;               /* statement */
-          secp256k_bar(x, &b);     /* statement */
-      }
-  }
-  ```
-- Use `unsigned int` instead of just `unsigned`.
-- Use `void *ptr` instead of `void* ptr`.
-- Arguments of the publicly-facing API must have a specific order defined in [include/secp256k1.h](include/secp256k1.h).
-- User-facing comment lines in headers should be limited to 80 chars if possible.
-- All identifiers in file scope should start with `secp256k1_`.
-- Avoid trailing whitespace.
+* Commits should be atomic and diffs should be easy to read. For this reason, do not mix any formatting fixes or code moves with actual code changes. Make sure each individual commit is hygienic: that it builds successfully on its own without warnings, errors, regressions, or test failures.
+* New code should adhere to the style of existing, in particular surrounding, code. Other than that, we do not enforce strict rules for code formatting.
+* The code conforms to C89. Most notably, that means that only `/* ... */` comments are allowed (no `//` line comments). Moreover, any declarations in a `{ ... }` block (e.g., a function) must appear at the beginning of the block before any statements. When you would like to declare a variable in the middle of a block, you can open a new block:
+    ```C
+    void secp256k_foo(void) {
+        unsigned int x;              /* declaration */
+        int y = 2*x;                 /* declaration */
+        x = 17;                      /* statement */
+        {
+            int a, b;                /* declaration */
+            a = x + y;               /* statement */
+            secp256k_bar(x, &b);     /* statement */
+        }
+    }
+    ```
+* Use `unsigned int` instead of just `unsigned`.
+* Use `void *ptr` instead of `void* ptr`.
+* Arguments of the publicly-facing API must have a specific order defined in [include/secp256k1.h](include/secp256k1.h).
+* User-facing comment lines in headers should be limited to 80 chars if possible.
+* All identifiers in file scope should start with `secp256k1_`.
+* Avoid trailing whitespace.
 
 ### Tests
 
@@ -101,7 +101,7 @@ To create a HTML report with coloured and annotated source code:
 #### Exhaustive tests
 
 There are tests of several functions in which a small group replaces secp256k1.
-These tests are _exhaustive_ since they provide all elements and scalars of the small group as input arguments (see [src/tests_exhaustive.c](src/tests_exhaustive.c)).
+These tests are *exhaustive* since they provide all elements and scalars of the small group as input arguments (see [src/tests_exhaustive.c](src/tests_exhaustive.c)).
 
 ### Benchmarks
 

external/secp256k1/README.md

@@ -1,4 +1,5 @@
-# libsecp256k1
+libsecp256k1
+============
 
 ![Dependencies: None](https://img.shields.io/badge/dependencies-none-success)
 [![irc.libera.chat #secp256k1](https://img.shields.io/badge/irc.libera.chat-%23secp256k1-success)](https://web.libera.chat/#secp256k1)
@@ -8,59 +9,60 @@ High-performance high-assurance C library for digital signatures and other crypt
 This library is intended to be the highest quality publicly available library for cryptography on the secp256k1 curve. However, the primary focus of its development has been for usage in the Bitcoin system and usage unlike Bitcoin's may be less well tested, verified, or suffer from a less well thought out interface. Correct usage requires some care and consideration that the library is fit for your application's purpose.
 
 Features:
+* secp256k1 ECDSA signing/verification and key generation.
+* Additive and multiplicative tweaking of secret/public keys.
+* Serialization/parsing of secret keys, public keys, signatures.
+* Constant time, constant memory access signing and public key generation.
+* Derandomized ECDSA (via RFC6979 or with a caller provided function.)
+* Very efficient implementation.
+* Suitable for embedded systems.
+* No runtime dependencies.
+* Optional module for public key recovery.
+* Optional module for ECDH key exchange.
+* Optional module for Schnorr signatures according to [BIP-340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki).
+* Optional module for ElligatorSwift key exchange according to [BIP-324](https://github.com/bitcoin/bips/blob/master/bip-0324.mediawiki).
+* Optional module for MuSig2 Schnorr multi-signatures according to [BIP-327](https://github.com/bitcoin/bips/blob/master/bip-0327.mediawiki).
 
-- secp256k1 ECDSA signing/verification and key generation.
-- Additive and multiplicative tweaking of secret/public keys.
-- Serialization/parsing of secret keys, public keys, signatures.
-- Constant time, constant memory access signing and public key generation.
-- Derandomized ECDSA (via RFC6979 or with a caller provided function.)
-- Very efficient implementation.
-- Suitable for embedded systems.
-- No runtime dependencies.
-- Optional module for public key recovery.
-- Optional module for ECDH key exchange.
-- Optional module for Schnorr signatures according to [BIP-340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki).
-- Optional module for ElligatorSwift key exchange according to [BIP-324](https://github.com/bitcoin/bips/blob/master/bip-0324.mediawiki).
-- Optional module for MuSig2 Schnorr multi-signatures according to [BIP-327](https://github.com/bitcoin/bips/blob/master/bip-0327.mediawiki).
+Implementation details
+----------------------
 
-## Implementation details
+* General
+  * No runtime heap allocation.
+  * Extensive testing infrastructure.
+  * Structured to facilitate review and analysis.
+  * Intended to be portable to any system with a C89 compiler and uint64_t support.
+  * No use of floating types.
+  * Expose only higher level interfaces to minimize the API surface and improve application security. ("Be difficult to use insecurely.")
+* Field operations
+  * Optimized implementation of arithmetic modulo the curve's field size (2^256 - 0x1000003D1).
+    * Using 5 52-bit limbs
+    * Using 10 26-bit limbs (including hand-optimized assembly for 32-bit ARM, by Wladimir J. van der Laan).
+      * This is an experimental feature that has not received enough scrutiny to satisfy the standard of quality of this library but is made available for testing and review by the community.
+* Scalar operations
+  * Optimized implementation without data-dependent branches of arithmetic modulo the curve's order.
+    * Using 4 64-bit limbs (relying on __int128 support in the compiler).
+    * Using 8 32-bit limbs.
+* Modular inverses (both field elements and scalars) based on [safegcd](https://gcd.cr.yp.to/index.html) with some modifications, and a variable-time variant (by Peter Dettman).
+* Group operations
+  * Point addition formula specifically simplified for the curve equation (y^2 = x^3 + 7).
+  * Use addition between points in Jacobian and affine coordinates where possible.
+  * Use a unified addition/doubling formula where necessary to avoid data-dependent branches.
+  * Point/x comparison without a field inversion by comparison in the Jacobian coordinate space.
+* Point multiplication for verification (a*P + b*G).
+  * Use wNAF notation for point multiplicands.
+  * Use a much larger window for multiples of G, using precomputed multiples.
+  * Use Shamir's trick to do the multiplication with the public key and the generator simultaneously.
+  * Use secp256k1's efficiently-computable endomorphism to split the P multiplicand into 2 half-sized ones.
+* Point multiplication for signing
+  * Use a precomputed table of multiples of powers of 16 multiplied with the generator, so general multiplication becomes a series of additions.
+  * Intended to be completely free of timing sidechannels for secret-key operations (on reasonable hardware/toolchains)
+    * Access the table with branch-free conditional moves so memory access is uniform.
+    * No data-dependent branches
+  * Optional runtime blinding which attempts to frustrate differential power analysis.
+  * The precomputed tables add and eventually subtract points for which no known scalar (secret key) is known, preventing even an attacker with control over the secret key used to control the data internally.
 
-- General
-  - No runtime heap allocation.
-  - Extensive testing infrastructure.
-  - Structured to facilitate review and analysis.
-  - Intended to be portable to any system with a C89 compiler and uint64_t support.
-  - No use of floating types.
-  - Expose only higher level interfaces to minimize the API surface and improve application security. ("Be difficult to use insecurely.")
-- Field operations
-  - Optimized implementation of arithmetic modulo the curve's field size (2^256 - 0x1000003D1).
-    - Using 5 52-bit limbs
-    - Using 10 26-bit limbs (including hand-optimized assembly for 32-bit ARM, by Wladimir J. van der Laan).
-      - This is an experimental feature that has not received enough scrutiny to satisfy the standard of quality of this library but is made available for testing and review by the community.
-- Scalar operations
-  - Optimized implementation without data-dependent branches of arithmetic modulo the curve's order.
-    - Using 4 64-bit limbs (relying on \_\_int128 support in the compiler).
-    - Using 8 32-bit limbs.
-- Modular inverses (both field elements and scalars) based on [safegcd](https://gcd.cr.yp.to/index.html) with some modifications, and a variable-time variant (by Peter Dettman).
-- Group operations
-  - Point addition formula specifically simplified for the curve equation (y^2 = x^3 + 7).
-  - Use addition between points in Jacobian and affine coordinates where possible.
-  - Use a unified addition/doubling formula where necessary to avoid data-dependent branches.
-  - Point/x comparison without a field inversion by comparison in the Jacobian coordinate space.
-- Point multiplication for verification (a*P + b*G).
-  - Use wNAF notation for point multiplicands.
-  - Use a much larger window for multiples of G, using precomputed multiples.
-  - Use Shamir's trick to do the multiplication with the public key and the generator simultaneously.
-  - Use secp256k1's efficiently-computable endomorphism to split the P multiplicand into 2 half-sized ones.
-- Point multiplication for signing
-  - Use a precomputed table of multiples of powers of 16 multiplied with the generator, so general multiplication becomes a series of additions.
-  - Intended to be completely free of timing sidechannels for secret-key operations (on reasonable hardware/toolchains)
-    - Access the table with branch-free conditional moves so memory access is uniform.
-    - No data-dependent branches
-  - Optional runtime blinding which attempts to frustrate differential power analysis.
-  - The precomputed tables add and eventually subtract points for which no known scalar (secret key) is known, preventing even an attacker with control over the secret key used to control the data internally.
-
-## Building with Autotools
+Building with Autotools
+-----------------------
 
     $ ./autogen.sh
     $ ./configure
@@ -70,7 +72,8 @@ Features:
 
 To compile optional modules (such as Schnorr signatures), you need to run `./configure` with additional flags (such as `--enable-module-schnorrsig`). Run `./configure --help` to see the full list of available flags.
 
-## Building with CMake (experimental)
+Building with CMake (experimental)
+----------------------------------
 
 To maintain a pristine source tree, CMake encourages to perform an out-of-source build by using a separate dedicated build tree.
 
@@ -106,19 +109,18 @@ In "Developer Command Prompt for VS 2022":
     >cmake -G "Visual Studio 17 2022" -A x64 -S . -B build
     >cmake --build build --config RelWithDebInfo
 
-## Usage examples
-
+Usage examples
+-----------
 Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`.
-
-- [ECDSA example](examples/ecdsa.c)
-- [Schnorr signatures example](examples/schnorr.c)
-- [Deriving a shared secret (ECDH) example](examples/ecdh.c)
-- [ElligatorSwift key exchange example](examples/ellswift.c)
+  * [ECDSA example](examples/ecdsa.c)
+  * [Schnorr signatures example](examples/schnorr.c)
+  * [Deriving a shared secret (ECDH) example](examples/ecdh.c)
+  * [ElligatorSwift key exchange example](examples/ellswift.c)
 
 To compile the Schnorr signature and ECDH examples, you also need to configure with `--enable-module-schnorrsig` and `--enable-module-ecdh`.
 
-## Benchmark
-
+Benchmark
+------------
 If configured with `--enable-benchmark` (which is the default), binaries for benchmarking the libsecp256k1 functions will be present in the root directory after the build.
 
 To print the benchmark result to the command line:
@@ -129,10 +131,12 @@ To create a CSV file for the benchmark result :
 
     $ ./bench_name | sed '2d;s/ \{1,\}//g' > bench_name.csv
 
-## Reporting a vulnerability
+Reporting a vulnerability
+------------
 
 See [SECURITY.md](SECURITY.md)
 
-## Contributing to libsecp256k1
+Contributing to libsecp256k1
+------------
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)

external/secp256k1/SECURITY.md

@@ -6,10 +6,10 @@ To report security issues send an email to secp256k1-security@bitcoincore.org (n
 
 The following keys may be used to communicate sensitive information to developers:
 
-| Name          | Fingerprint                                       |
-| ------------- | ------------------------------------------------- |
-| Pieter Wuille | 133E AC17 9436 F14A 5CF1 B794 860F EB80 4E66 9320 |
-| Jonas Nick    | 36C7 1A37 C9D9 88BD E825 08D9 B1A7 0E4F 8DCD 0366 |
-| Tim Ruffing   | 09E0 3F87 1092 E40E 106E 902B 33BC 86AB 80FF 5516 |
+| Name | Fingerprint |
+|------|-------------|
+| Pieter Wuille | 133E AC17 9436 F14A 5CF1  B794 860F EB80 4E66 9320 |
+| Jonas Nick | 36C7 1A37 C9D9 88BD E825  08D9 B1A7 0E4F 8DCD 0366 |
+| Tim Ruffing | 09E0 3F87 1092 E40E 106E  902B 33BC 86AB 80FF 5516 |
 
 You can import a key by running the following command with that individual’s fingerprint: `gpg --keyserver hkps://keys.openpgp.org --recv-keys "<fingerprint>"` Ensure that you put quotes around fingerprints containing spaces.

external/secp256k1/doc/ellswift.md

@@ -5,17 +5,17 @@ construction in the
 ["SwiftEC: Shallue–van de Woestijne Indifferentiable Function To Elliptic Curves"](https://eprint.iacr.org/2022/759)
 paper by Jorge Chávez-Saab, Francisco Rodríguez-Henríquez, and Mehdi Tibouchi.
 
-- [1. Introduction](#1-introduction)
-- [2. The decoding function](#2-the-decoding-function)
-  - [2.1 Decoding for `secp256k1`](#21-decoding-for-secp256k1)
-- [3. The encoding function](#3-the-encoding-function)
-  - [3.1 Switching to _v, w_ coordinates](#31-switching-to-v-w-coordinates)
-  - [3.2 Avoiding computing all inverses](#32-avoiding-computing-all-inverses)
-  - [3.3 Finding the inverse](#33-finding-the-inverse)
-  - [3.4 Dealing with special cases](#34-dealing-with-special-cases)
-  - [3.5 Encoding for `secp256k1`](#35-encoding-for-secp256k1)
-- [4. Encoding and decoding full _(x, y)_ coordinates](#4-encoding-and-decoding-full-x-y-coordinates)
-  - [4.1 Full _(x, y)_ coordinates for `secp256k1`](#41-full-x-y-coordinates-for-secp256k1)
+* [1. Introduction](#1-introduction)
+* [2. The decoding function](#2-the-decoding-function)
+  + [2.1 Decoding for `secp256k1`](#21-decoding-for-secp256k1)
+* [3. The encoding function](#3-the-encoding-function)
+  + [3.1 Switching to *v, w* coordinates](#31-switching-to-v-w-coordinates)
+  + [3.2 Avoiding computing all inverses](#32-avoiding-computing-all-inverses)
+  + [3.3 Finding the inverse](#33-finding-the-inverse)
+  + [3.4 Dealing with special cases](#34-dealing-with-special-cases)
+  + [3.5 Encoding for `secp256k1`](#35-encoding-for-secp256k1)
+* [4. Encoding and decoding full *(x, y)* coordinates](#4-encoding-and-decoding-full-x-y-coordinates)
+  + [4.1 Full *(x, y)* coordinates for `secp256k1`](#41-full-x-y-coordinates-for-secp256k1)
 
 ## 1. Introduction
 
@@ -34,14 +34,13 @@ are taken modulo $p$), and then evaluating $F_u(t)$, which for every $u$ and $t$
 x-coordinate on the curve. The functions $F_u$ will be defined in [Section 2](#2-the-decoding-function).
 
 **Encoding** a given $x$ coordinate is conceptually done as follows:
+* Loop:
+  * Pick a uniformly random field element $u.$
+  * Compute the set $L = F_u^{-1}(x)$ of $t$ values for which $F_u(t) = x$, which may have up to *8* elements.
+  * With probability $1 - \dfrac{\\#L}{8}$, restart the loop.
+  * Select a uniformly random $t \in L$ and return $(u, t).$
 
-- Loop:
-  - Pick a uniformly random field element $u.$
-  - Compute the set $L = F_u^{-1}(x)$ of $t$ values for which $F_u(t) = x$, which may have up to _8_ elements.
-  - With probability $1 - \dfrac{\\#L}{8}$, restart the loop.
-  - Select a uniformly random $t \in L$ and return $(u, t).$
-
-This is the _ElligatorSwift_ algorithm, here given for just x-coordinates. An extension to full
+This is the *ElligatorSwift* algorithm, here given for just x-coordinates. An extension to full
 $(x, y)$ points will be given in [Section 4](#4-encoding-and-decoding-full-x-y-coordinates).
 The algorithm finds a uniformly random $(u, t)$ among (almost all) those
 for which $F_u(t) = x.$ Section 3.2 in the paper proves that the number of such encodings for
@@ -51,40 +50,37 @@ almost all x-coordinates on the curve (all but at most 39) is close to two times
 ## 2. The decoding function
 
 First some definitions:
-
-- $\mathbb{F}$ is the finite field of size $q$, of characteristic 5 or more, and $q \equiv 1 \mod 3.$
-  - For `secp256k1`, $q = 2^{256} - 2^{32} - 977$, which satisfies that requirement.
-- Let $E$ be the elliptic curve of points $(x, y) \in \mathbb{F}^2$ for which $y^2 = x^3 + ax + b$, with $a$ and $b$
+* $\mathbb{F}$ is the finite field of size $q$, of characteristic 5 or more, and $q \equiv 1 \mod 3.$
+  * For `secp256k1`, $q = 2^{256} - 2^{32} - 977$, which satisfies that requirement.
+* Let $E$ be the elliptic curve of points $(x, y) \in \mathbb{F}^2$ for which $y^2 = x^3 + ax + b$, with $a$ and $b$
   public constants, for which $\Delta_E = -16(4a^3 + 27b^2)$ is a square, and at least one of $(-b \pm \sqrt{-3 \Delta_E} / 36)/2$ is a square.
-  This implies that the order of $E$ is either odd, or a multiple of _4_.
+  This implies that the order of $E$ is either odd, or a multiple of *4*.
   If $a=0$, this condition is always fulfilled.
-  - For `secp256k1`, $a=0$ and $b=7.$
-- Let the function $g(x) = x^3 + ax + b$, so the $E$ curve equation is also $y^2 = g(x).$
-- Let the function $h(x) = 3x^3 + 4a.$
-- Define $V$ as the set of solutions $(x_1, x_2, x_3, z)$ to $z^2 = g(x_1)g(x_2)g(x_3).$
-- Define $S_u$ as the set of solutions $(X, Y)$ to $X^2 + h(u)Y^2 = -g(u)$ and $Y \neq 0.$
-- $P_u$ is a function from $\mathbb{F}$ to $S_u$ that will be defined below.
-- $\psi_u$ is a function from $S_u$ to $V$ that will be defined below.
+  * For `secp256k1`, $a=0$ and $b=7.$
+* Let the function $g(x) = x^3 + ax + b$, so the $E$ curve equation is also $y^2 = g(x).$
+* Let the function $h(x) = 3x^3 + 4a.$
+* Define $V$ as the set of solutions $(x_1, x_2, x_3, z)$ to $z^2 = g(x_1)g(x_2)g(x_3).$
+* Define $S_u$ as the set of solutions $(X, Y)$ to $X^2 + h(u)Y^2 = -g(u)$ and $Y \neq 0.$
+* $P_u$ is a function from $\mathbb{F}$ to $S_u$ that will be defined below.
+* $\psi_u$ is a function from $S_u$ to $V$ that will be defined below.
 
 **Note**: In the paper:
-
-- $F_u$ corresponds to $F_{0,u}$ there.
-- $P_u(t)$ is called $P$ there.
-- All $S_u$ sets together correspond to $S$ there.
-- All $\psi_u$ functions together (operating on elements of $S$) correspond to $\psi$ there.
+* $F_u$ corresponds to $F_{0,u}$ there.
+* $P_u(t)$ is called $P$ there.
+* All $S_u$ sets together correspond to $S$ there.
+* All $\psi_u$ functions together (operating on elements of $S$) correspond to $\psi$ there.
 
 Note that for $V$, the left hand side of the equation $z^2$ is square, and thus the right
 hand must also be square. As multiplying non-squares results in a square in $\mathbb{F}$,
 out of the three right-hand side factors an even number must be non-squares.
-This implies that exactly _1_ or exactly _3_ out of
+This implies that exactly *1* or exactly *3* out of
 $\\{g(x_1), g(x_2), g(x_3)\\}$ must be square, and thus that for any $(x_1,x_2,x_3,z) \in V$,
 at least one of $\\{x_1, x_2, x_3\\}$ must be a valid x-coordinate on $E.$ There is one exception
 to this, namely when $z=0$, but even then one of the three values is a valid x-coordinate.
 
 **Define** the decoding function $F_u(t)$ as:
-
-- Let $(x_1, x_2, x_3, z) = \psi_u(P_u(t)).$
-- Return the first element $x$ of $(x_3, x_2, x_1)$ which is a valid x-coordinate on $E$ (i.e., $g(x)$ is square).
+* Let $(x_1, x_2, x_3, z) = \psi_u(P_u(t)).$
+* Return the first element $x$ of $(x_3, x_2, x_1)$ which is a valid x-coordinate on $E$ (i.e., $g(x)$ is square).
 
 $P_u(t) = (X(u, t), Y(u, t))$, where:
 
@@ -102,13 +98,12 @@ Y(u, t) & = & \left\\{\begin{array}{ll}
 $$
 
 $P_u(t)$ is defined:
-
-- For $a=0$, unless:
-  - $u = 0$ or $t = 0$ (division by zero)
-  - $g(u) = -t^2$ (would give $Y=0$).
-- For $a \neq 0$, unless:
-  - $X_0(u) = 0$ or $h(u)t^2 = -1$ (division by zero)
-  - $Y_0(u) (1 - h(u)t^2) = 2X_0(u)t$ (would give $Y=0$).
+* For $a=0$, unless:
+  * $u = 0$ or $t = 0$ (division by zero)
+  * $g(u) = -t^2$ (would give $Y=0$).
+* For $a \neq 0$, unless:
+  * $X_0(u) = 0$ or $h(u)t^2 = -1$ (division by zero)
+  * $Y_0(u) (1 - h(u)t^2) = 2X_0(u)t$ (would give $Y=0$).
 
 The functions $X_0(u)$ and $Y_0(u)$ are defined in Appendix A of the paper, and depend on various properties of $E.$
 
@@ -128,22 +123,20 @@ $$
 Put together and specialized for $a=0$ curves, decoding $(u, t)$ to an x-coordinate is:
 
 **Define** $F_u(t)$ as:
-
-- Let $X = \dfrac{u^3 + b - t^2}{2t}.$
-- Let $Y = \dfrac{X + t}{u\sqrt{-3}}.$
-- Return the first $x$ in $(u + 4Y^2, \dfrac{-X}{2Y} - \dfrac{u}{2}, \dfrac{X}{2Y} - \dfrac{u}{2})$ for which $g(x)$ is square.
+* Let $X = \dfrac{u^3 + b - t^2}{2t}.$
+* Let $Y = \dfrac{X + t}{u\sqrt{-3}}.$
+* Return the first $x$ in $(u + 4Y^2, \dfrac{-X}{2Y} - \dfrac{u}{2}, \dfrac{X}{2Y} - \dfrac{u}{2})$ for which $g(x)$ is square.
 
 To make sure that every input decodes to a valid x-coordinate, we remap the inputs in case
 $P_u$ is not defined (when $u=0$, $t=0$, or $g(u) = -t^2$):
 
 **Define** $F_u(t)$ as:
-
-- Let $u'=u$ if $u \neq 0$; $1$ otherwise (guaranteeing $u' \neq 0$).
-- Let $t'=t$ if $t \neq 0$; $1$ otherwise (guaranteeing $t' \neq 0$).
-- Let $t''=t'$ if $g(u') \neq -t'^2$; $2t'$ otherwise (guaranteeing $t'' \neq 0$ and $g(u') \neq -t''^2$).
-- Let $X = \dfrac{u'^3 + b - t''^2}{2t''}.$
-- Let $Y = \dfrac{X + t''}{u'\sqrt{-3}}.$
-- Return the first $x$ in $(u' + 4Y^2, \dfrac{-X}{2Y} - \dfrac{u'}{2}, \dfrac{X}{2Y} - \dfrac{u'}{2})$ for which $x^3 + b$ is square.
+* Let $u'=u$ if $u \neq 0$; $1$ otherwise (guaranteeing $u' \neq 0$).
+* Let $t'=t$ if $t \neq 0$; $1$ otherwise (guaranteeing $t' \neq 0$).
+* Let $t''=t'$ if $g(u') \neq -t'^2$; $2t'$ otherwise (guaranteeing $t'' \neq 0$ and $g(u') \neq -t''^2$).
+* Let $X = \dfrac{u'^3 + b - t''^2}{2t''}.$
+* Let $Y = \dfrac{X + t''}{u'\sqrt{-3}}.$
+* Return the first $x$ in $(u' + 4Y^2, \dfrac{-X}{2Y} - \dfrac{u'}{2}, \dfrac{X}{2Y} - \dfrac{u'}{2})$ for which $x^3 + b$ is square.
 
 The choices here are not strictly necessary. Just returning a fixed constant in any of the undefined cases would suffice,
 but the approach here is simple enough and gives fairly uniform output even in these cases.
@@ -157,11 +150,10 @@ in `secp256k1_ellswift_xswiftec_var` (which outputs the actual x-coordinate).
 ## 3. The encoding function
 
 To implement $F_u^{-1}(x)$, the function to find the set of inverses $t$ for which $F_u(t) = x$, we have to reverse the process:
-
-- Find all the $(X, Y) \in S_u$ that could have given rise to $x$, through the $x_1$, $x_2$, or $x_3$ formulas in $\psi_u.$
-- Map those $(X, Y)$ solutions to $t$ values using $P_u^{-1}(X, Y).$
-- For each of the found $t$ values, verify that $F_u(t) = x.$
-- Return the remaining $t$ values.
+* Find all the $(X, Y) \in S_u$ that could have given rise to $x$, through the $x_1$, $x_2$, or $x_3$ formulas in $\psi_u.$
+* Map those $(X, Y)$ solutions to $t$ values using $P_u^{-1}(X, Y).$
+* For each of the found $t$ values, verify that $F_u(t) = x.$
+* Return the remaining $t$ values.
 
 The function $P_u^{-1}$, which finds $t$ given $(X, Y) \in S_u$, is significantly simpler than $P_u:$
 
@@ -193,14 +185,13 @@ precedence over both. Because of this, the $g(-u-x)$ being square test for $x_1$
 values round-trip back to the input $x$ correctly. This is the reason for choosing the $(x_3, x_2, x_1)$ precedence order in the decoder;
 any order which does not place $x_3$ first requires more complicated round-trip checks in the encoder.
 
-### 3.1 Switching to _v, w_ coordinates
+### 3.1 Switching to *v, w* coordinates
 
 Before working out the formulas for all this, we switch to different variables for $S_u.$ Let $v = (X/Y - u)/2$, and
 $w = 2Y.$ Or in the other direction, $X = w(u/2 + v)$ and $Y = w/2:$
-
-- $S_u'$ becomes the set of $(v, w)$ for which $w^2 (u^2 + uv + v^2 + a) = -g(u)$ and $w \neq 0.$
-- For $a=0$ curves, $P_u^{-1}$ can be stated for $(v,w)$ as $P_u^{'-1}(v, w) = w\left(\frac{\sqrt{-3}-1}{2}u - v\right).$
-- $\psi_u$ can be stated for $(v, w)$ as $\psi_u'(v, w) = (x_1, x_2, x_3, z)$, where
+* $S_u'$ becomes the set of $(v, w)$ for which $w^2 (u^2 + uv + v^2 + a) = -g(u)$ and $w \neq 0.$
+* For $a=0$ curves, $P_u^{-1}$ can be stated for $(v,w)$ as $P_u^{'-1}(v, w) = w\left(\frac{\sqrt{-3}-1}{2}u - v\right).$
+* $\psi_u$ can be stated for $(v, w)$ as $\psi_u'(v, w) = (x_1, x_2, x_3, z)$, where
 
 $$
 \begin{array}{lcl}
@@ -213,37 +204,34 @@ $$
 
 We can now write the expressions for finding $(v, w)$ given $x$ explicitly, by solving each of the $\\{x_1, x_2, x_3\\}$
 expressions for $v$ or $w$, and using the $S_u'$ equation to find the other variable:
-
-- Assuming $x = x_1$, we find $v = x$ and $w = \pm\sqrt{-g(u)/(u^2 + uv + v^2 + a)}$ (two solutions).
-- Assuming $x = x_2$, we find $v = -u-x$ and $w = \pm\sqrt{-g(u)/(u^2 + uv + v^2 + a)}$ (two solutions).
-- Assuming $x = x_3$, we find $w = \pm\sqrt{x-u}$ and $v = -u/2 \pm \sqrt{-w^2(4g(u) + w^2h(u))}/(2w^2)$ (four solutions).
+* Assuming $x = x_1$, we find $v = x$ and $w = \pm\sqrt{-g(u)/(u^2 + uv + v^2 + a)}$ (two solutions).
+* Assuming $x = x_2$, we find $v = -u-x$ and $w = \pm\sqrt{-g(u)/(u^2 + uv + v^2 + a)}$ (two solutions).
+* Assuming $x = x_3$, we find $w = \pm\sqrt{x-u}$ and $v = -u/2 \pm \sqrt{-w^2(4g(u) + w^2h(u))}/(2w^2)$ (four solutions).
 
 ### 3.2 Avoiding computing all inverses
 
-The _ElligatorSwift_ algorithm as stated in Section 1 requires the computation of $L = F_u^{-1}(x)$ (the
+The *ElligatorSwift* algorithm as stated in Section 1 requires the computation of $L = F_u^{-1}(x)$ (the
 set of all $t$ such that $(u, t)$ decode to $x$) in full. This is unnecessary.
 
 Observe that the procedure of restarting with probability $(1 - \frac{\\#L}{8})$ and otherwise returning a
 uniformly random element from $L$ is actually equivalent to always padding $L$ with $\bot$ values up to length 8,
 picking a uniformly random element from that, restarting whenever $\bot$ is picked:
 
-**Define** _ElligatorSwift(x)_ as:
-
-- Loop:
-  - Pick a uniformly random field element $u.$
-  - Compute the set $L = F_u^{-1}(x).$
-  - Let $T$ be the 8-element vector consisting of the elements of $L$, plus $8 - \\#L$ times $\\{\bot\\}.$
-  - Select a uniformly random $t \in T.$
-  - If $t \neq \bot$, return $(u, t)$; restart loop otherwise.
+**Define** *ElligatorSwift(x)* as:
+* Loop:
+  * Pick a uniformly random field element $u.$
+  * Compute the set $L = F_u^{-1}(x).$
+  * Let $T$ be the 8-element vector consisting of the elements of $L$, plus $8 - \\#L$ times $\\{\bot\\}.$
+  * Select a uniformly random $t \in T.$
+  * If $t \neq \bot$, return $(u, t)$; restart loop otherwise.
 
 Now notice that the order of elements in $T$ does not matter, as all we do is pick a uniformly
 random element in it, so we do not need to have all $\bot$ values at the end.
 As we have 8 distinct formulas for finding $(v, w)$ (taking the variants due to $\pm$ into account),
 we can associate every index in $T$ with exactly one of those formulas, making sure that:
-
-- Formulas that yield no solutions (due to division by zero or non-existing square roots) or invalid solutions are made to return $\bot.$
-- For the $x_1$ and $x_2$ cases, if $g(-u-x)$ is a square, $\bot$ is returned instead (the round-trip check).
-- In case multiple formulas would return the same non- $\bot$ result, all but one of those must be turned into $\bot$ to avoid biasing those.
+* Formulas that yield no solutions (due to division by zero or non-existing square roots) or invalid solutions are made to return $\bot.$
+* For the $x_1$ and $x_2$ cases, if $g(-u-x)$ is a square, $\bot$ is returned instead (the round-trip check).
+* In case multiple formulas would return the same non- $\bot$ result, all but one of those must be turned into $\bot$ to avoid biasing those.
 
 The last condition above only occurs with negligible probability for cryptographically-sized curves, but is interesting
 to take into account as it allows exhaustive testing in small groups. See [Section 3.4](#34-dealing-with-special-cases)
@@ -252,13 +240,12 @@ for an analysis of all the negligible cases.
 If we define $T = (G_{0,u}(x), G_{1,u}(x), \ldots, G_{7,u}(x))$, with each $G_{i,u}$ matching one of the formulas,
 the loop can be simplified to only compute one of the inverses instead of all of them:
 
-**Define** _ElligatorSwift(x)_ as:
-
-- Loop:
-  - Pick a uniformly random field element $u.$
-  - Pick a uniformly random integer $c$ in $[0,8).$
-  - Let $t = G_{c,u}(x).$
-  - If $t \neq \bot$, return $(u, t)$; restart loop otherwise.
+**Define** *ElligatorSwift(x)* as:
+* Loop:
+  * Pick a uniformly random field element $u.$
+  * Pick a uniformly random integer $c$ in $[0,8).$
+  * Let $t = G_{c,u}(x).$
+  * If $t \neq \bot$, return $(u, t)$; restart loop otherwise.
 
 This is implemented in `secp256k1_ellswift_xelligatorswift_var`.
 
@@ -269,19 +256,18 @@ Those are then repeated as $c=4$ through $c=7$ for the other sign of $w$ (noting
 Ignoring the negligible cases, we get:
 
 **Define** $G_{c,u}(x)$ as:
-
-- If $c \in \\{0, 1, 4, 5\\}$ (for $x_1$ and $x_2$ formulas):
-  - If $g(-u-x)$ is square, return $\bot$ (as $x_3$ would be valid and take precedence).
-  - If $c \in \\{0, 4\\}$ (the $x_1$ formula) let $v = x$, otherwise let $v = -u-x$ (the $x_2$ formula)
-  - Let $s = -g(u)/(u^2 + uv + v^2 + a)$ (using $s = w^2$ in what follows).
-- Otherwise, when $c \in \\{2, 3, 6, 7\\}$ (for $x_3$ formulas):
-  - Let $s = x-u.$
-  - Let $r = \sqrt{-s(4g(u) + sh(u))}.$
-  - Let $v = (r/s - u)/2$ if $c \in \\{3, 7\\}$; $(-r/s - u)/2$ otherwise.
-- Let $w = \sqrt{s}.$
-- Depending on $c:$
-  - If $c \in \\{0, 1, 2, 3\\}:$ return $P_u^{'-1}(v, w).$
-  - If $c \in \\{4, 5, 6, 7\\}:$ return $P_u^{'-1}(v, -w).$
+* If $c \in \\{0, 1, 4, 5\\}$ (for $x_1$ and $x_2$ formulas):
+  * If $g(-u-x)$ is square, return $\bot$ (as $x_3$ would be valid and take precedence).
+  * If $c \in \\{0, 4\\}$ (the $x_1$ formula) let $v = x$, otherwise let $v = -u-x$ (the $x_2$ formula)
+  * Let $s = -g(u)/(u^2 + uv + v^2 + a)$ (using $s = w^2$ in what follows).
+* Otherwise, when $c \in \\{2, 3, 6, 7\\}$ (for $x_3$ formulas):
+  * Let $s = x-u.$
+  * Let $r = \sqrt{-s(4g(u) + sh(u))}.$
+  * Let $v = (r/s - u)/2$ if $c \in \\{3, 7\\}$; $(-r/s - u)/2$ otherwise.
+* Let $w = \sqrt{s}.$
+* Depending on $c:$
+  * If $c \in \\{0, 1, 2, 3\\}:$ return $P_u^{'-1}(v, w).$
+  * If $c \in \\{4, 5, 6, 7\\}:$ return $P_u^{'-1}(v, -w).$
 
 Whenever a square root of a non-square is taken, $\bot$ is returned; for both square roots this happens with roughly
 50% on random inputs. Similarly, when a division by 0 would occur, $\bot$ is returned as well; this will only happen
@@ -298,21 +284,20 @@ transformation. Furthermore, that transformation has no effect on $s$ in the fir
 as $u^2 + ux + x^2 + a = u^2 + u(-u-x) + (-u-x)^2 + a.$ Thus we can extract it out and move it down:
 
 **Define** $G_{c,u}(x)$ as:
-
-- If $c \in \\{0, 1, 4, 5\\}:$
-  - If $g(-u-x)$ is square, return $\bot.$
-  - Let $s = -g(u)/(u^2 + ux + x^2 + a).$
-  - Let $v = x.$
-- Otherwise, when $c \in \\{2, 3, 6, 7\\}:$
-  - Let $s = x-u.$
-  - Let $r = \sqrt{-s(4g(u) + sh(u))}.$
-  - Let $v = (r/s - u)/2.$
-- Let $w = \sqrt{s}.$
-- Depending on $c:$
-  - If $c \in \\{0, 2\\}:$ return $P_u^{'-1}(v, w).$
-  - If $c \in \\{1, 3\\}:$ return $P_u^{'-1}(-u-v, w).$
-  - If $c \in \\{4, 6\\}:$ return $P_u^{'-1}(v, -w).$
-  - If $c \in \\{5, 7\\}:$ return $P_u^{'-1}(-u-v, -w).$
+* If $c \in \\{0, 1, 4, 5\\}:$
+  * If $g(-u-x)$ is square, return $\bot.$
+  * Let $s = -g(u)/(u^2 + ux + x^2 + a).$
+  * Let $v = x.$
+* Otherwise, when $c \in \\{2, 3, 6, 7\\}:$
+  * Let $s = x-u.$
+  * Let $r = \sqrt{-s(4g(u) + sh(u))}.$
+  * Let $v = (r/s - u)/2.$
+* Let $w = \sqrt{s}.$
+* Depending on $c:$
+  * If $c \in \\{0, 2\\}:$ return $P_u^{'-1}(v, w).$
+  * If $c \in \\{1, 3\\}:$ return $P_u^{'-1}(-u-v, w).$
+  * If $c \in \\{4, 6\\}:$ return $P_u^{'-1}(v, -w).$
+  * If $c \in \\{5, 7\\}:$ return $P_u^{'-1}(-u-v, -w).$
 
 This shows there will always be exactly 0, 4, or 8 $t$ values for a given $(u, x)$ input.
 There can be 0, 1, or 2 $(v, w)$ pairs before invoking $P_u^{'-1}$, and each results in 4 distinct $t$ values.
@@ -325,60 +310,58 @@ we analyse them here. They generally fall into two categories: cases in which th
 do not decode back to $x$ (or at least cannot guarantee that they do), and cases in which the encoder might produce the same
 $t$ value for multiple $c$ inputs (thereby biasing that encoding):
 
-- In the branch for $x_1$ and $x_2$ (where $c \in \\{0, 1, 4, 5\\}$):
-  - When $g(u) = 0$, we would have $s=w=Y=0$, which is not on $S_u.$ This is only possible on even-ordered curves.
+* In the branch for $x_1$ and $x_2$ (where $c \in \\{0, 1, 4, 5\\}$):
+  * When $g(u) = 0$, we would have $s=w=Y=0$, which is not on $S_u.$ This is only possible on even-ordered curves.
     Excluding this also removes the one condition under which the simplified check for $x_3$ on the curve
     fails (namely when $g(x_1)=g(x_2)=0$ but $g(x_3)$ is not square).
     This does exclude some valid encodings: when both $g(u)=0$ and $u^2+ux+x^2+a=0$ (also implying $g(x)=0$),
     the $S_u'$ equation degenerates to $0 = 0$, and many valid $t$ values may exist. Yet, these cannot be targeted uniformly by the
     encoder anyway as there will generally be more than 8.
-  - When $g(x) = 0$, the same $t$ would be produced as in the $x_3$ branch (where $c \in \\{2, 3, 6, 7\\}$) which we give precedence
+  * When $g(x) = 0$, the same $t$ would be produced as in the $x_3$ branch (where $c \in \\{2, 3, 6, 7\\}$) which we give precedence
     as it can deal with $g(u)=0$.
     This is again only possible on even-ordered curves.
-- In the branch for $x_3$ (where $c \in \\{2, 3, 6, 7\\}$):
-  - When $s=0$, a division by zero would occur.
-  - When $v = -u-v$ and $c \in \\{3, 7\\}$, the same $t$ would be returned as in the $c \in \\{2, 6\\}$ cases.
+* In the branch for $x_3$ (where $c \in \\{2, 3, 6, 7\\}$):
+  * When $s=0$, a division by zero would occur.
+  * When $v = -u-v$ and $c \in \\{3, 7\\}$, the same $t$ would be returned as in the $c \in \\{2, 6\\}$ cases.
     It is equivalent to checking whether $r=0$.
     This cannot occur in the $x_1$ or $x_2$ branches, as it would trigger the $g(-u-x)$ is square condition.
     A similar concern for $w = -w$ does not exist, as $w=0$ is already impossible in both branches: in the first
     it requires $g(u)=0$ which is already outlawed on even-ordered curves and impossible on others; in the second it would trigger division by zero.
-- Curve-specific special cases also exist that need to be rejected, because they result in $(u,t)$ which is invalid to the decoder, or because of division by zero in the encoder:
-  - For $a=0$ curves, when $u=0$ or when $t=0$. The latter can only be reached by the encoder when $g(u)=0$, which requires an even-ordered curve.
-  - For $a \neq 0$ curves, when $X_0(u)=0$, when $h(u)t^2 = -1$, or when $w(u + 2v) = 2X_0(u)$ while also either $w \neq 2Y_0(u)$ or $h(u)=0$.
+* Curve-specific special cases also exist that need to be rejected, because they result in $(u,t)$ which is invalid to the decoder, or because of division by zero in the encoder:
+  * For $a=0$ curves, when $u=0$ or when $t=0$. The latter can only be reached by the encoder when $g(u)=0$, which requires an even-ordered curve.
+  * For $a \neq 0$ curves, when $X_0(u)=0$, when $h(u)t^2 = -1$, or when $w(u + 2v) = 2X_0(u)$ while also either $w \neq 2Y_0(u)$ or $h(u)=0$.
 
 **Define** a version of $G_{c,u}(x)$ which deals with all these cases:
-
-- If $a=0$ and $u=0$, return $\bot.$
-- If $a \neq 0$ and $X_0(u)=0$, return $\bot.$
-- If $c \in \\{0, 1, 4, 5\\}:$
-  - If $g(u) = 0$ or $g(x) = 0$, return $\bot$ (even curves only).
-  - If $g(-u-x)$ is square, return $\bot.$
-  - Let $s = -g(u)/(u^2 + ux + x^2 + a)$ (cannot cause division by zero).
-  - Let $v = x.$
-- Otherwise, when $c \in \\{2, 3, 6, 7\\}:$
-  - Let $s = x-u.$
-  - Let $r = \sqrt{-s(4g(u) + sh(u))}$; return $\bot$ if not square.
-  - If $c \in \\{3, 7\\}$ and $r=0$, return $\bot.$
-  - If $s = 0$, return $\bot.$
-  - Let $v = (r/s - u)/2.$
-- Let $w = \sqrt{s}$; return $\bot$ if not square.
-- If $a \neq 0$ and $w(u+2v) = 2X_0(u)$ and either $w \neq 2Y_0(u)$ or $h(u) = 0$, return $\bot.$
-- Depending on $c:$
-  - If $c \in \\{0, 2\\}$, let $t = P_u^{'-1}(v, w).$
-  - If $c \in \\{1, 3\\}$, let $t = P_u^{'-1}(-u-v, w).$
-  - If $c \in \\{4, 6\\}$, let $t = P_u^{'-1}(v, -w).$
-  - If $c \in \\{5, 7\\}$, let $t = P_u^{'-1}(-u-v, -w).$
-- If $a=0$ and $t=0$, return $\bot$ (even curves only).
-- If $a \neq 0$ and $h(u)t^2 = -1$, return $\bot.$
-- Return $t.$
+* If $a=0$ and $u=0$, return $\bot.$
+* If $a \neq 0$ and $X_0(u)=0$, return $\bot.$
+* If $c \in \\{0, 1, 4, 5\\}:$
+  * If $g(u) = 0$ or $g(x) = 0$, return $\bot$ (even curves only).
+  * If $g(-u-x)$ is square, return $\bot.$
+  * Let $s = -g(u)/(u^2 + ux + x^2 + a)$ (cannot cause division by zero).
+  * Let $v = x.$
+* Otherwise, when $c \in \\{2, 3, 6, 7\\}:$
+  * Let $s = x-u.$
+  * Let $r = \sqrt{-s(4g(u) + sh(u))}$; return $\bot$ if not square.
+  * If $c \in \\{3, 7\\}$ and $r=0$, return $\bot.$
+  * If $s = 0$, return $\bot.$
+  * Let $v = (r/s - u)/2.$
+* Let $w = \sqrt{s}$; return $\bot$ if not square.
+* If $a \neq 0$ and $w(u+2v) = 2X_0(u)$ and either $w \neq 2Y_0(u)$ or $h(u) = 0$, return $\bot.$
+* Depending on $c:$
+  * If $c \in \\{0, 2\\}$, let $t = P_u^{'-1}(v, w).$
+  * If $c \in \\{1, 3\\}$, let $t = P_u^{'-1}(-u-v, w).$
+  * If $c \in \\{4, 6\\}$, let $t = P_u^{'-1}(v, -w).$
+  * If $c \in \\{5, 7\\}$, let $t = P_u^{'-1}(-u-v, -w).$
+* If $a=0$ and $t=0$, return $\bot$ (even curves only).
+* If $a \neq 0$ and $h(u)t^2 = -1$, return $\bot.$
+* Return $t.$
 
 Given any $u$, using this algorithm over all $x$ and $c$ values, every $t$ value will be reached exactly once,
 for an $x$ for which $F_u(t) = x$ holds, except for these cases that will not be reached:
-
-- All cases where $P_u(t)$ is not defined:
-  - For $a=0$ curves, when $u=0$, $t=0$, or $g(u) = -t^2.$
-  - For $a \neq 0$ curves, when $h(u)t^2 = -1$, $X_0(u) = 0$, or $Y_0(u) (1 - h(u) t^2) = 2X_0(u)t.$
-- When $g(u)=0$, the potentially many $t$ values that decode to an $x$ satisfying $g(x)=0$ using the $x_2$ formula. These were excluded by the $g(u)=0$ condition in the $c \in \\{0, 1, 4, 5\\}$ branch.
+* All cases where $P_u(t)$ is not defined:
+  * For $a=0$ curves, when $u=0$, $t=0$, or $g(u) = -t^2.$
+  * For $a \neq 0$ curves, when $h(u)t^2 = -1$, $X_0(u) = 0$, or $Y_0(u) (1 - h(u) t^2) = 2X_0(u)t.$
+* When $g(u)=0$, the potentially many $t$ values that decode to an $x$ satisfying $g(x)=0$ using the $x_2$ formula. These were excluded by the $g(u)=0$ condition in the $c \in \\{0, 1, 4, 5\\}$ branch.
 
 These cases form a negligible subset of all $(u, t)$ for cryptographically sized curves.
 
@@ -387,42 +370,40 @@ These cases form a negligible subset of all $(u, t)$ for cryptographically sized
 Specialized for odd-ordered $a=0$ curves:
 
 **Define** $G_{c,u}(x)$ as:
-
-- If $u=0$, return $\bot.$
-- If $c \in \\{0, 1, 4, 5\\}:$
-  - If $(-u-x)^3 + b$ is square, return $\bot$
-  - Let $s = -(u^3 + b)/(u^2 + ux + x^2)$ (cannot cause division by 0).
-  - Let $v = x.$
-- Otherwise, when $c \in \\{2, 3, 6, 7\\}:$
-  - Let $s = x-u.$
-  - Let $r = \sqrt{-s(4(u^3 + b) + 3su^2)}$; return $\bot$ if not square.
-  - If $c \in \\{3, 7\\}$ and $r=0$, return $\bot.$
-  - If $s = 0$, return $\bot.$
-  - Let $v = (r/s - u)/2.$
-- Let $w = \sqrt{s}$; return $\bot$ if not square.
-- Depending on $c:$
-  - If $c \in \\{0, 2\\}:$ return $w(\frac{\sqrt{-3}-1}{2}u - v).$
-  - If $c \in \\{1, 3\\}:$ return $w(\frac{\sqrt{-3}+1}{2}u + v).$
-  - If $c \in \\{4, 6\\}:$ return $w(\frac{-\sqrt{-3}+1}{2}u + v).$
-  - If $c \in \\{5, 7\\}:$ return $w(\frac{-\sqrt{-3}-1}{2}u - v).$
+* If $u=0$, return $\bot.$
+* If $c \in \\{0, 1, 4, 5\\}:$
+  * If $(-u-x)^3 + b$ is square, return $\bot$
+  * Let $s = -(u^3 + b)/(u^2 + ux + x^2)$ (cannot cause division by 0).
+  * Let $v = x.$
+* Otherwise, when $c \in \\{2, 3, 6, 7\\}:$
+  * Let $s = x-u.$
+  * Let $r = \sqrt{-s(4(u^3 + b) + 3su^2)}$; return $\bot$ if not square.
+  * If $c \in \\{3, 7\\}$ and $r=0$, return $\bot.$
+  * If $s = 0$, return $\bot.$
+  * Let $v = (r/s - u)/2.$
+* Let $w = \sqrt{s}$; return $\bot$ if not square.
+* Depending on $c:$
+  * If $c \in \\{0, 2\\}:$ return $w(\frac{\sqrt{-3}-1}{2}u - v).$
+  * If $c \in \\{1, 3\\}:$ return $w(\frac{\sqrt{-3}+1}{2}u + v).$
+  * If $c \in \\{4, 6\\}:$ return $w(\frac{-\sqrt{-3}+1}{2}u + v).$
+  * If $c \in \\{5, 7\\}:$ return $w(\frac{-\sqrt{-3}-1}{2}u - v).$
 
 This is implemented in `secp256k1_ellswift_xswiftec_inv_var`.
 
 And the x-only ElligatorSwift encoding algorithm is still:
 
-**Define** _ElligatorSwift(x)_ as:
-
-- Loop:
-  - Pick a uniformly random field element $u.$
-  - Pick a uniformly random integer $c$ in $[0,8).$
-  - Let $t = G_{c,u}(x).$
-  - If $t \neq \bot$, return $(u, t)$; restart loop otherwise.
+**Define** *ElligatorSwift(x)* as:
+* Loop:
+  * Pick a uniformly random field element $u.$
+  * Pick a uniformly random integer $c$ in $[0,8).$
+  * Let $t = G_{c,u}(x).$
+  * If $t \neq \bot$, return $(u, t)$; restart loop otherwise.
 
 Note that this logic does not take the remapped $u=0$, $t=0$, and $g(u) = -t^2$ cases into account; it just avoids them.
 While it is not impossible to make the encoder target them, this would increase the maximum number of $t$ values for a given $(u, x)$
 combination beyond 8, and thereby slow down the ElligatorSwift loop proportionally, for a negligible gain in uniformity.
 
-## 4. Encoding and decoding full _(x, y)_ coordinates
+## 4. Encoding and decoding full *(x, y)* coordinates
 
 So far we have only addressed encoding and decoding x-coordinates, but in some cases an encoding
 for full points with $(x, y)$ coordinates is desirable. It is possible to encode this information
@@ -441,32 +422,30 @@ four distinct $P_u^{'-1}$ calls in the definition of $G_{u,c}.$
 
 To encode the sign of $y$ in the sign of $Y:$
 
-**Define** _Decode(u, t)_ for full $(x, y)$ as:
-
-- Let $(X, Y) = P_u(t).$
-- Let $x$ be the first value in $(u + 4Y^2, \frac{-X}{2Y} - \frac{u}{2}, \frac{X}{2Y} - \frac{u}{2})$ for which $g(x)$ is square.
-- Let $y = \sqrt{g(x)}.$
-- If $sign(y) = sign(Y)$, return $(x, y)$; otherwise return $(x, -y).$
+**Define** *Decode(u, t)* for full $(x, y)$ as:
+* Let $(X, Y) = P_u(t).$
+* Let $x$ be the first value in $(u + 4Y^2, \frac{-X}{2Y} - \frac{u}{2}, \frac{X}{2Y} - \frac{u}{2})$ for which $g(x)$ is square.
+* Let $y = \sqrt{g(x)}.$
+* If $sign(y) = sign(Y)$, return $(x, y)$; otherwise return $(x, -y).$
 
 And encoding would be done using a $G_{c,u}(x, y)$ function defined as:
 
 **Define** $G_{c,u}(x, y)$ as:
-
-- If $c \in \\{0, 1\\}:$
-  - If $g(u) = 0$ or $g(x) = 0$, return $\bot$ (even curves only).
-  - If $g(-u-x)$ is square, return $\bot.$
-  - Let $s = -g(u)/(u^2 + ux + x^2 + a)$ (cannot cause division by zero).
-  - Let $v = x.$
-- Otherwise, when $c \in \\{2, 3\\}:$
-  - Let $s = x-u.$
-  - Let $r = \sqrt{-s(4g(u) + sh(u))}$; return $\bot$ if not square.
-  - If $c = 3$ and $r = 0$, return $\bot.$
-  - Let $v = (r/s - u)/2.$
-- Let $w = \sqrt{s}$; return $\bot$ if not square.
-- Let $w' = w$ if $sign(w/2) = sign(y)$; $-w$ otherwise.
-- Depending on $c:$
-  - If $c \in \\{0, 2\\}:$ return $P_u^{'-1}(v, w').$
-  - If $c \in \\{1, 3\\}:$ return $P_u^{'-1}(-u-v, w').$
+* If $c \in \\{0, 1\\}:$
+  * If $g(u) = 0$ or $g(x) = 0$, return $\bot$ (even curves only).
+  * If $g(-u-x)$ is square, return $\bot.$
+  * Let $s = -g(u)/(u^2 + ux + x^2 + a)$ (cannot cause division by zero).
+  * Let $v = x.$
+* Otherwise, when $c \in \\{2, 3\\}:$
+  * Let $s = x-u.$
+  * Let $r = \sqrt{-s(4g(u) + sh(u))}$; return $\bot$ if not square.
+  * If $c = 3$ and $r = 0$, return $\bot.$
+  * Let $v = (r/s - u)/2.$
+* Let $w = \sqrt{s}$; return $\bot$ if not square.
+* Let $w' = w$ if $sign(w/2) = sign(y)$; $-w$ otherwise.
+* Depending on $c:$
+  * If $c \in \\{0, 2\\}:$ return $P_u^{'-1}(v, w').$
+  * If $c \in \\{1, 3\\}:$ return $P_u^{'-1}(-u-v, w').$
 
 Note that $c$ now only ranges $[0,4)$, as the sign of $w'$ is decided based on that of $y$, rather than on $c.$
 This change makes some valid encodings unreachable: when $y = 0$ and $sign(Y) \neq sign(0)$.
@@ -475,23 +454,22 @@ In the above logic, $sign$ can be implemented in several ways, such as parity of
 of the input field element (for prime-sized fields) or the quadratic residuosity (for fields where
 $-1$ is not square). The choice does not matter, as long as it only takes on two possible values, and for $x \neq 0$ it holds that $sign(x) \neq sign(-x)$.
 
-### 4.1 Full _(x, y)_ coordinates for `secp256k1`
+### 4.1 Full *(x, y)* coordinates for `secp256k1`
 
 For $a=0$ curves, there is another option. Note that for those,
 the $P_u(t)$ function translates negations of $t$ to negations of (both) $X$ and $Y.$ Thus, we can use $sign(t)$ to
 encode the y-coordinate directly. Combined with the earlier remapping to guarantee all inputs land on the curve, we get
 as decoder:
 
-**Define** _Decode(u, t)_ as:
-
-- Let $u'=u$ if $u \neq 0$; $1$ otherwise.
-- Let $t'=t$ if $t \neq 0$; $1$ otherwise.
-- Let $t''=t'$ if $u'^3 + b + t'^2 \neq 0$; $2t'$ otherwise.
-- Let $X = \dfrac{u'^3 + b - t''^2}{2t''}.$
-- Let $Y = \dfrac{X + t''}{u'\sqrt{-3}}.$
-- Let $x$ be the first element of $(u' + 4Y^2, \frac{-X}{2Y} - \frac{u'}{2}, \frac{X}{2Y} - \frac{u'}{2})$ for which $g(x)$ is square.
-- Let $y = \sqrt{g(x)}.$
-- Return $(x, y)$ if $sign(y) = sign(t)$; $(x, -y)$ otherwise.
+**Define** *Decode(u, t)* as:
+* Let $u'=u$ if $u \neq 0$; $1$ otherwise.
+* Let $t'=t$ if $t \neq 0$; $1$ otherwise.
+* Let $t''=t'$ if $u'^3 + b + t'^2 \neq 0$; $2t'$ otherwise.
+* Let $X = \dfrac{u'^3 + b - t''^2}{2t''}.$
+* Let $Y = \dfrac{X + t''}{u'\sqrt{-3}}.$
+* Let $x$ be the first element of $(u' + 4Y^2, \frac{-X}{2Y} - \frac{u'}{2}, \frac{X}{2Y} - \frac{u'}{2})$ for which $g(x)$ is square.
+* Let $y = \sqrt{g(x)}.$
+* Return $(x, y)$ if $sign(y) = sign(t)$; $(x, -y)$ otherwise.
 
 This is implemented in `secp256k1_ellswift_swiftec_var`. The used $sign(x)$ function is the parity of $x$ when represented as in integer in $[0,q).$
 

external/secp256k1/doc/musig.md

@@ -1,4 +1,5 @@
-# Notes on the musig module API
+Notes on the musig module API
+===========================
 
 The following sections contain additional notes on the API of the musig module (`include/secp256k1_musig.h`).
 A usage example can be found in `examples/musig.c`.

external/secp256k1/doc/release-process.md

@@ -2,7 +2,7 @@
 
 This document outlines the process for releasing versions of the form `$MAJOR.$MINOR.$PATCH`.
 
-We distinguish between two types of releases: _regular_ and _maintenance_ releases.
+We distinguish between two types of releases: *regular* and *maintenance* releases.
 Regular releases are releases of a new major or minor version as well as patches of the most recent release.
 Maintenance releases, on the other hand, are required for patches of older releases.
 
@@ -15,7 +15,6 @@ This process also assumes that there will be no minor releases for old major rel
 We aim to cut a regular release every 3-4 months, approximately twice as frequent as major Bitcoin Core releases. Every second release should be published one month before the feature freeze of the next major Bitcoin Core release, allowing sufficient time to update the library in Core.
 
 ## Sanity checks
-
 Perform these checks when reviewing the release PR (see below):
 
 1. Ensure `make distcheck` doesn't fail.
@@ -43,15 +42,15 @@ Perform these checks when reviewing the release PR (see below):
 ## Regular release
 
 1. Open a PR to the master branch with a commit (using message `"release: prepare for $MAJOR.$MINOR.$PATCH"`, for example) that
-   - finalizes the release notes in [CHANGELOG.md](../CHANGELOG.md) by
-     - adding a section for the release (make sure that the version number is a link to a diff between the previous and new version),
-     - removing the `[Unreleased]` section header,
-     - ensuring that the release notes are not missing entries (check the `needs-changelog` label on github), and
-     - including an entry for `### ABI Compatibility` if it doesn't exist,
-   - sets `_PKG_VERSION_IS_RELEASE` to `true` in `configure.ac`, and,
-   - if this is not a patch release,
-     - updates `_PKG_VERSION_*` and `_LIB_VERSION_*` in `configure.ac`, and
-     - updates `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_*` in `CMakeLists.txt`.
+   * finalizes the release notes in [CHANGELOG.md](../CHANGELOG.md) by
+       * adding a section for the release (make sure that the version number is a link to a diff between the previous and new version),
+       * removing the `[Unreleased]` section header,
+       * ensuring that the release notes are not missing entries (check the `needs-changelog` label on github), and
+       * including an entry for `### ABI Compatibility` if it doesn't exist,
+   * sets `_PKG_VERSION_IS_RELEASE` to `true` in `configure.ac`, and,
+   * if this is not a patch release,
+       * updates `_PKG_VERSION_*` and `_LIB_VERSION_*`  in `configure.ac`, and
+       * updates `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_*` in `CMakeLists.txt`.
 2. Perform the [sanity checks](#sanity-checks) on the PR branch.
 3. After the PR is merged, tag the commit, and push the tag:
    ```
@@ -60,12 +59,11 @@ Perform these checks when reviewing the release PR (see below):
    git push git@github.com:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
    ```
 4. Open a PR to the master branch with a commit (using message `"release cleanup: bump version after $MAJOR.$MINOR.$PATCH"`, for example) that
-   - sets `_PKG_VERSION_IS_RELEASE` to `false` and increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`,
-   - increments the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`, and
-   - adds an `[Unreleased]` section header to the [CHANGELOG.md](../CHANGELOG.md).
+   * sets `_PKG_VERSION_IS_RELEASE` to `false` and increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`,
+   * increments the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`, and
+   * adds an `[Unreleased]` section header to the [CHANGELOG.md](../CHANGELOG.md).
 
    If other maintainers are not present to approve the PR, it can be merged without ACKs.
-
 5. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
 6. Send an announcement email to the bitcoin-dev mailing list.
 
@@ -79,9 +77,9 @@ Note that bug fixes need to be backported only to releases for which no compatib
    git push git@github.com:bitcoin-core/secp256k1.git $MAJOR.$MINOR
    ```
 2. Open a pull request to the `$MAJOR.$MINOR` branch that
-   - includes the bug fixes,
-   - finalizes the release notes similar to a regular release,
-   - increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`
+   * includes the bug fixes,
+   * finalizes the release notes similar to a regular release,
+   * increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`
      and the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`
      (with commit message `"release: bump versions for $MAJOR.$MINOR.$PATCH"`, for example).
 3. Perform the [sanity checks](#sanity-checks) on the PR branch.
@@ -91,6 +89,6 @@ Note that bug fixes need to be backported only to releases for which no compatib
    git tag -s v$MAJOR.$MINOR.$PATCH -m "libsecp256k1 $MAJOR.$MINOR.$PATCH"
    git push git@github.com:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
    ```
-5. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
-6. Send an announcement email to the bitcoin-dev mailing list.
-7. Open PR to the master branch that includes a commit (with commit message `"release notes: add $MAJOR.$MINOR.$PATCH"`, for example) that adds release notes to [CHANGELOG.md](../CHANGELOG.md).
+6. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
+7. Send an announcement email to the bitcoin-dev mailing list.
+8. Open PR to the master branch that includes a commit (with commit message `"release notes: add $MAJOR.$MINOR.$PATCH"`, for example) that adds release notes to [CHANGELOG.md](../CHANGELOG.md).

external/secp256k1/doc/safegcd_implementation.md

@@ -29,67 +29,65 @@ def gcd(f, g):
     return abs(f)
 ```
 
-It computes the greatest common divisor of an odd integer _f_ and any integer _g_. Its inner loop
-keeps rewriting the variables _f_ and _g_ alongside a state variable _δ_ that starts at _1_, until
-_g=0_ is reached. At that point, _|f|_ gives the GCD. Each of the transitions in the loop is called a
+It computes the greatest common divisor of an odd integer *f* and any integer *g*. Its inner loop
+keeps rewriting the variables *f* and *g* alongside a state variable *δ* that starts at *1*, until
+*g=0* is reached. At that point, *|f|* gives the GCD. Each of the transitions in the loop is called a
 "division step" (referred to as divstep in what follows).
 
-For example, _gcd(21, 14)_ would be computed as:
-
-- Start with _δ=1 f=21 g=14_
-- Take the third branch: _δ=2 f=21 g=7_
-- Take the first branch: _δ=-1 f=7 g=-7_
-- Take the second branch: _δ=0 f=7 g=0_
-- The answer _|f| = 7_.
+For example, *gcd(21, 14)* would be computed as:
+- Start with *δ=1 f=21 g=14*
+- Take the third branch: *δ=2 f=21 g=7*
+- Take the first branch: *δ=-1 f=7 g=-7*
+- Take the second branch: *δ=0 f=7 g=0*
+- The answer *|f| = 7*.
 
 Why it works:
-
 - Divsteps can be decomposed into two steps (see paragraph 8.2 in the paper):
-  - (a) If _g_ is odd, replace _(f,g)_ with _(g,g-f)_ or (f,g+f), resulting in an even _g_.
-  - (b) Replace _(f,g)_ with _(f,g/2)_ (where _g_ is guaranteed to be even).
+  - (a) If *g* is odd, replace *(f,g)* with *(g,g-f)* or (f,g+f), resulting in an even *g*.
+  - (b) Replace *(f,g)* with *(f,g/2)* (where *g* is guaranteed to be even).
 - Neither of those two operations change the GCD:
-  - For (a), assume _gcd(f,g)=c_, then it must be the case that _f=a c_ and _g=b c_ for some integers _a_
-    and _b_. As _(g,g-f)=(b c,(b-a)c)_ and _(f,f+g)=(a c,(a+b)c)_, the result clearly still has
-    common factor _c_. Reasoning in the other direction shows that no common factor can be added by
+  - For (a), assume *gcd(f,g)=c*, then it must be the case that *f=a c* and *g=b c* for some integers *a*
+    and *b*. As *(g,g-f)=(b c,(b-a)c)* and *(f,f+g)=(a c,(a+b)c)*, the result clearly still has
+    common factor *c*. Reasoning in the other direction shows that no common factor can be added by
     doing so either.
-  - For (b), we know that _f_ is odd, so _gcd(f,g)_ clearly has no factor _2_, and we can remove
-    it from _g_.
-- The algorithm will eventually converge to _g=0_. This is proven in the paper (see theorem G.3).
-- It follows that eventually we find a final value _f'_ for which _gcd(f,g) = gcd(f',0)_. As the
-  gcd of _f'_ and _0_ is _|f'|_ by definition, that is our answer.
+  - For (b), we know that *f* is odd, so *gcd(f,g)* clearly has no factor *2*, and we can remove
+    it from *g*.
+- The algorithm will eventually converge to *g=0*. This is proven in the paper (see theorem G.3).
+- It follows that eventually we find a final value *f'* for which *gcd(f,g) = gcd(f',0)*. As the
+  gcd of *f'* and *0* is *|f'|* by definition, that is our answer.
 
 Compared to more [traditional GCD algorithms](https://en.wikipedia.org/wiki/Euclidean_algorithm), this one has the property of only ever looking at
 the low-order bits of the variables to decide the next steps, and being easy to make
-constant-time (in more low-level languages than Python). The _δ_ parameter is necessary to
+constant-time (in more low-level languages than Python). The *δ* parameter is necessary to
 guide the algorithm towards shrinking the numbers' magnitudes without explicitly needing to look
 at high order bits.
 
 Properties that will become important later:
-
-- Performing more divsteps than needed is not a problem, as _f_ does not change anymore after _g=0_.
-- Only even numbers are divided by _2_. This means that when reasoning about it algebraically we
+- Performing more divsteps than needed is not a problem, as *f* does not change anymore after *g=0*.
+- Only even numbers are divided by *2*. This means that when reasoning about it algebraically we
   do not need to worry about rounding.
-- At every point during the algorithm's execution the next _N_ steps only depend on the bottom _N_
-  bits of _f_ and _g_, and on _δ_.
+- At every point during the algorithm's execution the next *N* steps only depend on the bottom *N*
+  bits of *f* and *g*, and on *δ*.
+
 
 ## 2. From GCDs to modular inverses
 
-We want an algorithm to compute the inverse _a_ of _x_ modulo _M_, i.e. the number a such that _a x=1
-mod M_. This inverse only exists if the GCD of _x_ and _M_ is _1_, but that is always the case if _M_ is
-prime and _0 < x < M_. In what follows, assume that the modular inverse exists.
+We want an algorithm to compute the inverse *a* of *x* modulo *M*, i.e. the number a such that *a&thinsp;x=1
+mod M*. This inverse only exists if the GCD of *x* and *M* is *1*, but that is always the case if *M* is
+prime and *0 < x < M*. In what follows, assume that the modular inverse exists.
 It turns out this inverse can be computed as a side effect of computing the GCD by keeping track
 of how the internal variables can be written as linear combinations of the inputs at every step
 (see the [extended Euclidean algorithm](https://en.wikipedia.org/wiki/Extended_Euclidean_algorithm)).
-Since the GCD is _1_, such an algorithm will compute numbers _a_ and _b_ such that a&thinsp;x + b&thinsp;M = 1*.
+Since the GCD is *1*, such an algorithm will compute numbers *a* and *b* such that a&thinsp;x + b&thinsp;M = 1*.
 Taking that expression *mod M* gives *a&thinsp;x mod M = 1*, and we see that *a* is the modular inverse of *x
-mod M\*.
+mod M*.
 
 A similar approach can be used to calculate modular inverses using the divsteps-based GCD
-algorithm shown above, if the modulus _M_ is odd. To do so, compute _gcd(f=M,g=x)_, while keeping
-track of extra variables _d_ and _e_, for which at every step _d = f/x (mod M)_ and _e = g/x (mod M)_.
-_f/x_ here means the number which multiplied with _x_ gives _f mod M_. As _f_ and _g_ are initialized to _M_
-and _x_ respectively, _d_ and _e_ just start off being _0_ (_M/x mod M = 0/x mod M = 0_) and _1_ (_x/x mod M
-= 1_).
+algorithm shown above, if the modulus *M* is odd. To do so, compute *gcd(f=M,g=x)*, while keeping
+track of extra variables *d* and *e*, for which at every step *d = f/x (mod M)* and *e = g/x (mod M)*.
+*f/x* here means the number which multiplied with *x* gives *f mod M*. As *f* and *g* are initialized to *M*
+and *x* respectively, *d* and *e* just start off being *0* (*M/x mod M = 0/x mod M = 0*) and *1* (*x/x mod M
+= 1*).
 
 ```python
 def div2(M, x):
@@ -121,16 +119,17 @@ def modinv(M, x):
     return (d * f) % M
 ```
 
-Also note that this approach to track _d_ and _e_ throughout the computation to determine the inverse
+Also note that this approach to track *d* and *e* throughout the computation to determine the inverse
 is different from the paper. There (see paragraph 12.1 in the paper) a transition matrix for the
 entire computation is determined (see section 3 below) and the inverse is computed from that.
 The approach here avoids the need for 2x2 matrix multiplications of various sizes, and appears to
 be faster at the level of optimization we're able to do in C.
 
+
 ## 3. Batching multiple divsteps
 
-Every divstep can be expressed as a matrix multiplication, applying a transition matrix _(1/2 t)_
-to both vectors _[f, g]_ and _[d, e]_ (see paragraph 8.1 in the paper):
+Every divstep can be expressed as a matrix multiplication, applying a transition matrix *(1/2 t)*
+to both vectors *[f, g]* and *[d, e]* (see paragraph 8.1 in the paper):
 
 ```
   t = [ u,  v ]
@@ -143,15 +142,15 @@ to both vectors _[f, g]_ and _[d, e]_ (see paragraph 8.1 in the paper):
   [ out_e ]               [ in_e ]
 ```
 
-where _(u, v, q, r)_ is _(0, 2, -1, 1)_, _(2, 0, 1, 1)_, or _(2, 0, 0, 1)_, depending on which branch is
-taken. As above, the resulting _f_ and _g_ are always integers.
+where *(u, v, q, r)* is *(0, 2, -1, 1)*, *(2, 0, 1, 1)*, or *(2, 0, 0, 1)*, depending on which branch is
+taken. As above, the resulting *f* and *g* are always integers.
 
 Performing multiple divsteps corresponds to a multiplication with the product of all the
 individual divsteps' transition matrices. As each transition matrix consists of integers
-divided by _2_, the product of these matrices will consist of integers divided by _2<sup>N</sup>_ (see also
-theorem 9.2 in the paper). These divisions are expensive when updating _d_ and _e_, so we delay
-them: we compute the integer coefficients of the combined transition matrix scaled by _2<sup>N</sup>_, and
-do one division by _2<sup>N</sup>_ as a final step:
+divided by *2*, the product of these matrices will consist of integers divided by *2<sup>N</sup>* (see also
+theorem 9.2 in the paper). These divisions are expensive when updating *d* and *e*, so we delay
+them: we compute the integer coefficients of the combined transition matrix scaled by *2<sup>N</sup>*, and
+do one division by *2<sup>N</sup>* as a final step:
 
 ```python
 def divsteps_n_matrix(delta, f, g):
@@ -167,13 +166,13 @@ def divsteps_n_matrix(delta, f, g):
     return delta, (u, v, q, r)
 ```
 
-As the branches in the divsteps are completely determined by the bottom _N_ bits of _f_ and _g_, this
+As the branches in the divsteps are completely determined by the bottom *N* bits of *f* and *g*, this
 function to compute the transition matrix only needs to see those bottom bits. Furthermore all
-intermediate results and outputs fit in _(N+1)_-bit numbers (unsigned for _f_ and _g_; signed for _u_, _v_,
-_q_, and _r_) (see also paragraph 8.3 in the paper). This means that an implementation using 64-bit
-integers could set _N=62_ and compute the full transition matrix for 62 steps at once without any
+intermediate results and outputs fit in *(N+1)*-bit numbers (unsigned for *f* and *g*; signed for *u*, *v*,
+*q*, and *r*) (see also paragraph 8.3 in the paper). This means that an implementation using 64-bit
+integers could set *N=62* and compute the full transition matrix for 62 steps at once without any
 big integer arithmetic at all. This is the reason why this algorithm is efficient: it only needs
-to update the full-size _f_, _g_, _d_, and _e_ numbers once every _N_ steps.
+to update the full-size *f*, *g*, *d*, and *e* numbers once every *N* steps.
 
 We still need functions to compute:
 
@@ -185,8 +184,8 @@ We still need functions to compute:
   [ out_e ]   (        [ q,  r ])   [ in_e ]
 ```
 
-Because the divsteps transformation only ever divides even numbers by two, the result of _t&thinsp;[f,g]_ is always even. When _t_ is a composition of _N_ divsteps, it follows that the resulting _f_
-and _g_ will be multiple of _2<sup>N</sup>_, and division by _2<sup>N</sup>_ is simply shifting them down:
+Because the divsteps transformation only ever divides even numbers by two, the result of *t&thinsp;[f,g]* is always even. When *t* is a composition of *N* divsteps, it follows that the resulting *f*
+and *g* will be multiple of *2<sup>N</sup>*, and division by *2<sup>N</sup>* is simply shifting them down:
 
 ```python
 def update_fg(f, g, t):
@@ -200,8 +199,8 @@ def update_fg(f, g, t):
     return cf >> N, cg >> N
 ```
 
-The same is not true for _d_ and _e_, and we need an equivalent of the `div2` function for division by _2<sup>N</sup> mod M_.
-This is easy if we have precomputed _1/M mod 2<sup>N</sup>_ (which always exists for odd _M_):
+The same is not true for *d* and *e*, and we need an equivalent of the `div2` function for division by *2<sup>N</sup> mod M*.
+This is easy if we have precomputed *1/M mod 2<sup>N</sup>* (which always exists for odd *M*):
 
 ```python
 def div2n(M, Mi, x):
@@ -225,7 +224,7 @@ def update_de(d, e, t, M, Mi):
     return div2n(M, Mi, cd), div2n(M, Mi, ce)
 ```
 
-With all of those, we can write a version of `modinv` that performs _N_ divsteps at once:
+With all of those, we can write a version of `modinv` that performs *N* divsteps at once:
 
 ```python3
 def modinv(M, Mi, x):
@@ -243,19 +242,20 @@ def modinv(M, Mi, x):
     return (d * f) % M
 ```
 
-This means that in practice we'll always perform a multiple of _N_ divsteps. This is not a problem
-because once _g=0_, further divsteps do not affect _f_, _g_, _d_, or _e_ anymore (only _&delta;_ keeps
+This means that in practice we'll always perform a multiple of *N* divsteps. This is not a problem
+because once *g=0*, further divsteps do not affect *f*, *g*, *d*, or *e* anymore (only *&delta;* keeps
 increasing). For variable time code such excess iterations will be mostly optimized away in later
 sections.
 
+
 ## 4. Avoiding modulus operations
 
-So far, there are two places where we compute a remainder of big numbers modulo _M_: at the end of
-`div2n` in every `update_de`, and at the very end of `modinv` after potentially negating _d_ due to the
-sign of _f_. These are relatively expensive operations when done generically.
+So far, there are two places where we compute a remainder of big numbers modulo *M*: at the end of
+`div2n` in every `update_de`, and at the very end of `modinv` after potentially negating *d* due to the
+sign of *f*. These are relatively expensive operations when done generically.
 
-To deal with the modulus operation in `div2n`, we simply stop requiring _d_ and _e_ to be in range
-_[0,M)_ all the time. Let's start by inlining `div2n` into `update_de`, and dropping the modulus
+To deal with the modulus operation in `div2n`, we simply stop requiring *d* and *e* to be in range
+*[0,M)* all the time. Let's start by inlining `div2n` into `update_de`, and dropping the modulus
 operation at the end:
 
 ```python
@@ -272,15 +272,15 @@ def update_de(d, e, t, M, Mi):
     return cd >> N, ce >> N
 ```
 
-Let's look at bounds on the ranges of these numbers. It can be shown that _|u|+|v|_ and _|q|+|r|_
-never exceed _2<sup>N</sup>_ (see paragraph 8.3 in the paper), and thus a multiplication with _t_ will have
-outputs whose absolute values are at most _2<sup>N</sup>_ times the maximum absolute input value. In case the
-inputs _d_ and _e_ are in _(-M,M)_, which is certainly true for the initial values _d=0_ and _e=1_ assuming
-_M > 1_, the multiplication results in numbers in range _(-2<sup>N</sup>M,2<sup>N</sup>M)_. Subtracting less than _2<sup>N</sup>_
-times _M_ to cancel out _N_ bits brings that up to _(-2<sup>N+1</sup>M,2<sup>N</sup>M)_, and
-dividing by _2<sup>N</sup>_ at the end takes it to _(-2M,M)_. Another application of `update_de` would take that
-to _(-3M,2M)_, and so forth. This progressive expansion of the variables' ranges can be
-counteracted by incrementing _d_ and _e_ by _M_ whenever they're negative:
+Let's look at bounds on the ranges of these numbers. It can be shown that *|u|+|v|* and *|q|+|r|*
+never exceed *2<sup>N</sup>* (see paragraph 8.3 in the paper), and thus a multiplication with *t* will have
+outputs whose absolute values are at most *2<sup>N</sup>* times the maximum absolute input value. In case the
+inputs *d* and *e* are in *(-M,M)*, which is certainly true for the initial values *d=0* and *e=1* assuming
+*M > 1*, the multiplication results in numbers in range *(-2<sup>N</sup>M,2<sup>N</sup>M)*. Subtracting less than *2<sup>N</sup>*
+times *M* to cancel out *N* bits brings that up to *(-2<sup>N+1</sup>M,2<sup>N</sup>M)*, and
+dividing by *2<sup>N</sup>* at the end takes it to *(-2M,M)*. Another application of `update_de` would take that
+to *(-3M,2M)*, and so forth. This progressive expansion of the variables' ranges can be
+counteracted by incrementing *d* and *e* by *M* whenever they're negative:
 
 ```python
     ...
@@ -293,12 +293,12 @@ counteracted by incrementing _d_ and _e_ by _M_ whenever they're negative:
     ...
 ```
 
-With inputs in _(-2M,M)_, they will first be shifted into range _(-M,M)_, which means that the
-output will again be in _(-2M,M)_, and this remains the case regardless of how many `update_de`
+With inputs in *(-2M,M)*, they will first be shifted into range *(-M,M)*, which means that the
+output will again be in *(-2M,M)*, and this remains the case regardless of how many `update_de`
 invocations there are. In what follows, we will try to make this more efficient.
 
-Note that increasing _d_ by _M_ is equal to incrementing _cd_ by _u&thinsp;M_ and _ce_ by _q&thinsp;M_. Similarly,
-increasing _e_ by _M_ is equal to incrementing _cd_ by _v&thinsp;M_ and _ce_ by _r&thinsp;M_. So we could instead write:
+Note that increasing *d* by *M* is equal to incrementing *cd* by *u&thinsp;M* and *ce* by *q&thinsp;M*. Similarly,
+increasing *e* by *M* is equal to incrementing *cd* by *v&thinsp;M* and *ce* by *r&thinsp;M*. So we could instead write:
 
 ```python
     ...
@@ -318,10 +318,10 @@ increasing _e_ by _M_ is equal to incrementing _cd_ by _v&thinsp;M_ and _ce_ by
     ...
 ```
 
-Now note that we have two steps of corrections to _cd_ and _ce_ that add multiples of _M_: this
+Now note that we have two steps of corrections to *cd* and *ce* that add multiples of *M*: this
 increment, and the decrement that cancels out bottom bits. The second one depends on the first
-one, but they can still be efficiently combined by only computing the bottom bits of _cd_ and _ce_
-at first, and using that to compute the final _md_, _me_ values:
+one, but they can still be efficiently combined by only computing the bottom bits of *cd* and *ce*
+at first, and using that to compute the final *md*, *me* values:
 
 ```python
 def update_de(d, e, t, M, Mi):
@@ -346,8 +346,8 @@ def update_de(d, e, t, M, Mi):
     return cd >> N, ce >> N
 ```
 
-One last optimization: we can avoid the _md&thinsp;M_ and _me&thinsp;M_ multiplications in the bottom bits of _cd_
-and _ce_ by moving them to the _md_ and _me_ correction:
+One last optimization: we can avoid the *md&thinsp;M* and *me&thinsp;M* multiplications in the bottom bits of *cd*
+and *ce* by moving them to the *md* and *me* correction:
 
 ```python
     ...
@@ -362,10 +362,10 @@ and _ce_ by moving them to the _md_ and _me_ correction:
     ...
 ```
 
-The resulting function takes _d_ and _e_ in range _(-2M,M)_ as inputs, and outputs values in the same
-range. That also means that the _d_ value at the end of `modinv` will be in that range, while we want
-a result in _[0,M)_. To do that, we need a normalization function. It's easy to integrate the
-conditional negation of _d_ (based on the sign of _f_) into it as well:
+The resulting function takes *d* and *e* in range *(-2M,M)* as inputs, and outputs values in the same
+range. That also means that the *d* value at the end of `modinv` will be in that range, while we want
+a result in *[0,M)*. To do that, we need a normalization function. It's easy to integrate the
+conditional negation of *d* (based on the sign of *f*) into it as well:
 
 ```python
 def normalize(sign, v, M):
@@ -391,21 +391,22 @@ And calling it in `modinv` is simply:
    return normalize(f, d, M)
 ```
 
+
 ## 5. Constant-time operation
 
 The primary selling point of the algorithm is fast constant-time operation. What code flow still
 depends on the input data so far?
 
-- the number of iterations of the while _g &ne; 0_ loop in `modinv`
+- the number of iterations of the while *g &ne; 0* loop in `modinv`
 - the branches inside `divsteps_n_matrix`
 - the sign checks in `update_de`
 - the sign checks in `normalize`
 
 To make the while loop in `modinv` constant time it can be replaced with a constant number of
-iterations. The paper proves (Theorem 11.2) that _741_ divsteps are sufficient for any _256_-bit
-inputs, and [safegcd-bounds](https://github.com/sipa/safegcd-bounds) shows that the slightly better bound _724_ is
-sufficient even. Given that every loop iteration performs _N_ divsteps, it will run a total of
-_&lceil;724/N&rceil;_ times.
+iterations. The paper proves (Theorem 11.2) that *741* divsteps are sufficient for any *256*-bit
+inputs, and [safegcd-bounds](https://github.com/sipa/safegcd-bounds) shows that the slightly better bound *724* is
+sufficient even. Given that every loop iteration performs *N* divsteps, it will run a total of
+*&lceil;724/N&rceil;* times.
 
 To deal with the branches in `divsteps_n_matrix` we will replace them with constant-time bitwise
 operations (and hope the C compiler isn't smart enough to turn them back into branches; see
@@ -424,10 +425,10 @@ divstep can be written instead as (compare to the inner loop of `gcd` in section
 ```
 
 To convert the above to bitwise operations, we rely on a trick to negate conditionally: per the
-definition of negative numbers in two's complement, (_-v == ~v + 1_) holds for every number _v_. As
-_-1_ in two's complement is all _1_ bits, bitflipping can be expressed as xor with _-1_. It follows
-that _-v == (v ^ -1) - (-1)_. Thus, if we have a variable _c_ that takes on values _0_ or _-1_, then
-_(v ^ c) - c_ is _v_ if _c=0_ and _-v_ if _c=-1_.
+definition of negative numbers in two's complement, (*-v == ~v + 1*) holds for every number *v*. As
+*-1* in two's complement is all *1* bits, bitflipping can be expressed as xor with *-1*. It follows
+that *-v == (v ^ -1) - (-1)*. Thus, if we have a variable *c* that takes on values *0* or *-1*, then
+*(v ^ c) - c* is *v* if *c=0* and *-v* if *c=-1*.
 
 Using this we can write:
 
@@ -443,13 +444,13 @@ in constant-time form as:
     x = (f ^ c1) - c1
 ```
 
-To use that trick, we need a helper mask variable _c1_ that resolves the condition _&delta;>0_ to _-1_
-(if true) or _0_ (if false). We compute _c1_ using right shifting, which is equivalent to dividing by
-the specified power of _2_ and rounding down (in Python, and also in C under the assumption of a typical two's complement system; see
-`assumptions.h` for tests that this is the case). Right shifting by _63_ thus maps all
-numbers in range _[-2<sup>63</sup>,0)_ to _-1_, and numbers in range _[0,2<sup>63</sup>)_ to _0_.
+To use that trick, we need a helper mask variable *c1* that resolves the condition *&delta;>0* to *-1*
+(if true) or *0* (if false). We compute *c1* using right shifting, which is equivalent to dividing by
+the specified power of *2* and rounding down (in Python, and also in C under the assumption of a typical two's complement system; see
+`assumptions.h` for tests that this is the case). Right shifting by *63* thus maps all
+numbers in range *[-2<sup>63</sup>,0)* to *-1*, and numbers in range *[0,2<sup>63</sup>)* to *0*.
 
-Using the facts that _x&0=0_ and _x&(-1)=x_ (on two's complement systems again), we can write:
+Using the facts that *x&0=0* and *x&(-1)=x* (on two's complement systems again), we can write:
 
 ```python
     if g & 1:
@@ -497,8 +498,8 @@ becomes:
 ```
 
 It turns out that this can be implemented more efficiently by applying the substitution
-_&eta;=-&delta;_. In this representation, negating _&delta;_ corresponds to negating _&eta;_, and incrementing
-_&delta;_ corresponds to decrementing _&eta;_. This allows us to remove the negation in the _c1_
+*&eta;=-&delta;*. In this representation, negating *&delta;* corresponds to negating *&eta;*, and incrementing
+*&delta;* corresponds to decrementing *&eta;*. This allows us to remove the negation in the *c1*
 computation:
 
 ```python
@@ -518,12 +519,12 @@ computation:
     g >>= 1
 ```
 
-A variant of divsteps with better worst-case performance can be used instead: starting _&delta;_ at
-_1/2_ instead of _1_. This reduces the worst case number of iterations to _590_ for _256_-bit inputs
-(which can be shown using convex hull analysis). In this case, the substitution _&zeta;=-(&delta;+1/2)_
-is used instead to keep the variable integral. Incrementing _&delta;_ by _1_ still translates to
-decrementing _&zeta;_ by _1_, but negating _&delta;_ now corresponds to going from _&zeta;_ to _-(&zeta;+1)_, or
-_~&zeta;_. Doing that conditionally based on _c3_ is simply:
+A variant of divsteps with better worst-case performance can be used instead: starting *&delta;* at
+*1/2* instead of *1*. This reduces the worst case number of iterations to *590* for *256*-bit inputs
+(which can be shown using convex hull analysis). In this case, the substitution *&zeta;=-(&delta;+1/2)*
+is used instead to keep the variable integral. Incrementing *&delta;* by *1* still translates to
+decrementing *&zeta;* by *1*, but negating *&delta;* now corresponds to going from *&zeta;* to *-(&zeta;+1)*, or
+*~&zeta;*. Doing that conditionally based on *c3* is simply:
 
 ```python
     ...
@@ -533,12 +534,13 @@ _~&zeta;_. Doing that conditionally based on _c3_ is simply:
 ```
 
 By replacing the loop in `divsteps_n_matrix` with a variant of the divstep code above (extended to
-also apply all _f_ operations to _u_, _v_ and all _g_ operations to _q_, _r_), a constant-time version of
+also apply all *f* operations to *u*, *v* and all *g* operations to *q*, *r*), a constant-time version of
 `divsteps_n_matrix` is obtained. The full code will be in section 7.
 
 These bit fiddling tricks can also be used to make the conditional negations and additions in
 `update_de` and `normalize` constant-time.
 
+
 ## 6. Variable-time optimizations
 
 In section 5, we modified the `divsteps_n_matrix` function (and a few others) to be constant time.
@@ -548,7 +550,7 @@ faster non-constant time `divsteps_n_matrix` function.
 
 To do so, first consider yet another way of writing the inner loop of divstep operations in
 `gcd` from section 1. This decomposition is also explained in the paper in section 8.2. We use
-the original version with initial _&delta;=1_ and _&eta;=-&delta;_ here.
+the original version with initial *&delta;=1* and *&eta;=-&delta;* here.
 
 ```python
 for _ in range(N):
@@ -560,7 +562,7 @@ for _ in range(N):
     g >>= 1
 ```
 
-Whenever _g_ is even, the loop only shifts _g_ down and decreases _&eta;_. When _g_ ends in multiple zero
+Whenever *g* is even, the loop only shifts *g* down and decreases *&eta;*. When *g* ends in multiple zero
 bits, these iterations can be consolidated into one step. This requires counting the bottom zero
 bits efficiently, which is possible on most platforms; it is abstracted here as the function
 `count_trailing_zeros`.
@@ -593,20 +595,20 @@ while True:
     # g is even now, and the eta decrement and g shift will happen in the next loop.
 ```
 
-We can now remove multiple bottom _0_ bits from _g_ at once, but still need a full iteration whenever
-there is a bottom _1_ bit. In what follows, we will get rid of multiple _1_ bits simultaneously as
+We can now remove multiple bottom *0* bits from *g* at once, but still need a full iteration whenever
+there is a bottom *1* bit. In what follows, we will get rid of multiple *1* bits simultaneously as
 well.
 
-Observe that as long as _&eta; &geq; 0_, the loop does not modify _f_. Instead, it cancels out bottom
-bits of _g_ and shifts them out, and decreases _&eta;_ and _i_ accordingly - interrupting only when _&eta;_
-becomes negative, or when _i_ reaches _0_. Combined, this is equivalent to adding a multiple of _f_ to
-_g_ to cancel out multiple bottom bits, and then shifting them out.
+Observe that as long as *&eta; &geq; 0*, the loop does not modify *f*. Instead, it cancels out bottom
+bits of *g* and shifts them out, and decreases *&eta;* and *i* accordingly - interrupting only when *&eta;*
+becomes negative, or when *i* reaches *0*. Combined, this is equivalent to adding a multiple of *f* to
+*g* to cancel out multiple bottom bits, and then shifting them out.
 
-It is easy to find what that multiple is: we want a number _w_ such that _g+w&thinsp;f_ has a few bottom
-zero bits. If that number of bits is _L_, we want _g+w&thinsp;f mod 2<sup>L</sup> = 0_, or _w = -g/f mod 2<sup>L</sup>_. Since _f_
-is odd, such a _w_ exists for any _L_. _L_ cannot be more than _i_ steps (as we'd finish the loop before
-doing more) or more than _&eta;+1_ steps (as we'd run `eta, f, g = -eta, g, -f` at that point), but
-apart from that, we're only limited by the complexity of computing _w_.
+It is easy to find what that multiple is: we want a number *w* such that *g+w&thinsp;f* has a few bottom
+zero bits. If that number of bits is *L*, we want *g+w&thinsp;f mod 2<sup>L</sup> = 0*, or *w = -g/f mod 2<sup>L</sup>*. Since *f*
+is odd, such a *w* exists for any *L*. *L* cannot be more than *i* steps (as we'd finish the loop before
+doing more) or more than *&eta;+1* steps (as we'd run `eta, f, g = -eta, g, -f` at that point), but
+apart from that, we're only limited by the complexity of computing *w*.
 
 This code demonstrates how to cancel up to 4 bits per step:
 
@@ -640,25 +642,26 @@ some can be found in Hacker's Delight second edition by Henry S. Warren, Jr. pag
 Here we need the negated modular inverse, which is a simple transformation of those:
 
 - Instead of a 3-bit table:
-  - _-f_ or _f ^ 6_
+  - *-f* or *f ^ 6*
 - Instead of a 4-bit table:
-  - _1 - f(f + 1)_
-  - _-(f + (((f + 1) & 4) << 1))_
-- For larger tables the following technique can be used: if _w=-1/f mod 2<sup>L</sup>_, then _w(w&thinsp;f+2)_ is
-  _-1/f mod 2<sup>2L</sup>_. This allows extending the previous formulas (or tables). In particular we
+  - *1 - f(f + 1)*
+  - *-(f + (((f + 1) & 4) << 1))*
+- For larger tables the following technique can be used: if *w=-1/f mod 2<sup>L</sup>*, then *w(w&thinsp;f+2)* is
+  *-1/f mod 2<sup>2L</sup>*. This allows extending the previous formulas (or tables). In particular we
   have this 6-bit function (based on the 3-bit function above):
-  - _f(f<sup>2</sup> - 2)_
+  - *f(f<sup>2</sup> - 2)*
 
-This loop, again extended to also handle _u_, _v_, _q_, and _r_ alongside _f_ and _g_, placed in
+This loop, again extended to also handle *u*, *v*, *q*, and *r* alongside *f* and *g*, placed in
 `divsteps_n_matrix`, gives a significantly faster, but non-constant time version.
 
+
 ## 7. Final Python version
 
 All together we need the following functions:
 
 - A way to compute the transition matrix in constant time, using the `divsteps_n_matrix` function
   from section 2, but with its loop replaced by a variant of the constant-time divstep from
-  section 5, extended to handle _u_, _v_, _q_, _r_:
+  section 5, extended to handle *u*, *v*, *q*, *r*:
 
 ```python
 def divsteps_n_matrix(zeta, f, g):
@@ -681,7 +684,7 @@ def divsteps_n_matrix(zeta, f, g):
     return zeta, (u, v, q, r)
 ```
 
-- The functions to update _f_ and _g_, and _d_ and _e_, from section 2 and section 4, with the constant-time
+- The functions to update *f* and *g*, and *d* and *e*, from section 2 and section 4, with the constant-time
   changes to `update_de` from section 5:
 
 ```python
@@ -720,7 +723,7 @@ def normalize(sign, v, M):
     return v
 ```
 
-- And finally the `modinv` function too, adapted to use _&zeta;_ instead of _&delta;_, and using the fixed
+- And finally the `modinv` function too, adapted to use *&zeta;* instead of *&delta;*, and using the fixed
   iteration count from section 5:
 
 ```python
@@ -769,21 +772,20 @@ def modinv_var(M, Mi, x):
 
 ## 8. From GCDs to Jacobi symbol
 
-We can also use a similar approach to calculate Jacobi symbol _(x | M)_ by keeping track of an
-extra variable _j_, for which at every step _(x | M) = j (g | f)_. As we update _f_ and _g_, we
-make corresponding updates to _j_ using
+We can also use a similar approach to calculate Jacobi symbol *(x | M)* by keeping track of an
+extra variable *j*, for which at every step *(x | M) = j (g | f)*. As we update *f* and *g*, we
+make corresponding updates to *j* using
 [properties of the Jacobi symbol](https://en.wikipedia.org/wiki/Jacobi_symbol#Properties):
+* *((g/2) | f)* is either *(g | f)* or *-(g | f)*, depending on the value of *f mod 8* (negating if it's *3* or *5*).
+* *(f | g)* is either *(g | f)* or *-(g | f)*, depending on *f mod 4* and *g mod 4* (negating if both are *3*).
 
-- _((g/2) | f)_ is either _(g | f)_ or _-(g | f)_, depending on the value of _f mod 8_ (negating if it's _3_ or _5_).
-- _(f | g)_ is either _(g | f)_ or _-(g | f)_, depending on _f mod 4_ and _g mod 4_ (negating if both are _3_).
-
-These updates depend only on the values of _f_ and _g_ modulo _4_ or _8_, and can thus be applied
-very quickly, as long as we keep track of a few additional bits of _f_ and _g_. Overall, this
+These updates depend only on the values of *f* and *g* modulo *4* or *8*, and can thus be applied
+very quickly, as long as we keep track of a few additional bits of *f* and *g*. Overall, this
 calculation is slightly simpler than the one for the modular inverse because we no longer need to
-keep track of _d_ and _e_.
+keep track of *d* and *e*.
 
-However, one difficulty of this approach is that the Jacobi symbol _(a | n)_ is only defined for
-positive odd integers _n_, whereas in the original safegcd algorithm, _f, g_ can take negative
+However, one difficulty of this approach is that the Jacobi symbol *(a | n)* is only defined for
+positive odd integers *n*, whereas in the original safegcd algorithm, *f, g* can take negative
 values. We resolve this by using the following modified steps:
 
 ```python
@@ -797,16 +799,15 @@ values. We resolve this by using the following modified steps:
 ```
 
 The algorithm is still correct, since the changed divstep, called a "posdivstep" (see section 8.4
-and E.5 in the paper) preserves _gcd(f, g)_. However, there's no proof that the modified algorithm
+and E.5 in the paper) preserves *gcd(f, g)*. However, there's no proof that the modified algorithm
 will converge. The justification for posdivsteps is completely empirical: in practice, it appears
-that the vast majority of nonzero inputs converge to _f=g=gcd(f<sub>0</sub>, g<sub>0</sub>)_ in a
+that the vast majority of nonzero inputs converge to *f=g=gcd(f<sub>0</sub>, g<sub>0</sub>)* in a
 number of steps proportional to their logarithm.
 
 Note that:
-
-- We require inputs to satisfy _gcd(x, M) = 1_, as otherwise _f=1_ is not reached.
-- We require inputs _x &neq; 0_, because applying posdivstep with _g=0_ has no effect.
-- We need to update the termination condition from _g=0_ to _f=1_.
+- We require inputs to satisfy *gcd(x, M) = 1*, as otherwise *f=1* is not reached.
+- We require inputs *x &neq; 0*, because applying posdivstep with *g=0* has no effect.
+- We need to update the termination condition from *g=0* to *f=1*.
 
 We account for the possibility of nonconvergence by only performing a bounded number of
 posdivsteps, and then falling back to square-root based Jacobi calculation if a solution has not
@@ -814,5 +815,5 @@ yet been found.
 
 The optimizations in sections 3-7 above are described in the context of the original divsteps, but
 in the C implementation we also adapt most of them (not including "avoiding modulus operations",
-since it's not necessary to track _d, e_, and "constant-time operation", since we never calculate
+since it's not necessary to track *d, e*, and "constant-time operation", since we never calculate
 Jacobi symbols for secret data) to the posdivsteps version.

include/xrpl/basics/SHAMapHash.h

@@ -21,6 +21,7 @@
 #define RIPPLE_BASICS_SHAMAP_HASH_H_INCLUDED
 
 #include <xrpl/basics/base_uint.h>
+#include <xrpl/basics/partitioned_unordered_map.h>
 
 #include <ostream>
 

include/xrpl/basics/TaggedCache.h

@@ -90,6 +90,9 @@ public:
     int
     getCacheSize() const;
 
+    int
+    getTrackSize() const;
+
     float
     getHitRate();
 
@@ -167,6 +170,9 @@ public:
     bool
     retrieve(key_type const& key, T& data);
 
+    mutex_type&
+    peekMutex();
+
     std::vector<key_type>
     getKeys() const;
 
@@ -187,14 +193,11 @@ public:
 
 private:
     SharedPointerType
-    initialFetch(key_type const& key);
+    initialFetch(key_type const& key, std::lock_guard<mutex_type> const& l);
 
     void
     collect_metrics();
 
-    Mutex&
-    lockPartition(key_type const& key) const;
-
 private:
     struct Stats
     {
@@ -297,8 +300,8 @@ private:
         [[maybe_unused]] clock_type::time_point const& now,
         typename KeyValueCacheType::map_type& partition,
         SweptPointersVector& stuffToSweep,
-        std::atomic<int>& allRemoval,
-        Mutex& partitionLock);
+        std::atomic<int>& allRemovals,
+        std::lock_guard<std::recursive_mutex> const&);
 
     [[nodiscard]] std::thread
     sweepHelper(
@@ -307,12 +310,14 @@ private:
         typename KeyOnlyCacheType::map_type& partition,
         SweptPointersVector&,
         std::atomic<int>& allRemovals,
-        Mutex& partitionLock);
+        std::lock_guard<std::recursive_mutex> const&);
 
     beast::Journal m_journal;
     clock_type& m_clock;
     Stats m_stats;
 
+    mutex_type mutable m_mutex;
+
     // Used for logging
     std::string m_name;
 
@@ -323,11 +328,10 @@ private:
     clock_type::duration const m_target_age;
 
     // Number of items cached
-    std::atomic<int> m_cache_count;
+    int m_cache_count;
     cache_type m_cache;  // Hold strong reference to recent objects
-    std::atomic<std::uint64_t> m_hits;
-    std::atomic<std::uint64_t> m_misses;
-    mutable std::vector<mutex_type> partitionLocks_;
+    std::uint64_t m_hits;
+    std::uint64_t m_misses;
 };
 
 }  // namespace ripple

include/xrpl/basics/TaggedCache.ipp

@@ -22,7 +22,8 @@
 
 #include <xrpl/basics/IntrusivePointer.ipp>
 #include <xrpl/basics/TaggedCache.h>
-#include <xrpl/beast/core/CurrentThreadName.h>
+
+#include <iostream>
 
 namespace ripple {
 
@@ -61,7 +62,6 @@ inline TaggedCache<
     , m_hits(0)
     , m_misses(0)
 {
-    partitionLocks_ = std::vector<mutex_type>(m_cache.partitions());
 }
 
 template <
@@ -107,13 +107,11 @@ TaggedCache<
     KeyEqual,
     Mutex>::size() const
 {
-    std::size_t totalSize = 0;
-    for (size_t i = 0; i < partitionLocks_.size(); ++i)
-    {
-        std::lock_guard<Mutex> lock(partitionLocks_[i]);
-        totalSize += m_cache.map()[i].size();
-    }
-    return totalSize;
+    std::lock_guard lock(m_mutex);
+    static unsigned long call_count{0};
+    std::cout << "TaggedCache (" << m_name << ") lock stats,"
+              << ", size, call_count = " << ++call_count << std::endl;
+    return m_cache.size();
 }
 
 template <
@@ -136,7 +134,32 @@ TaggedCache<
     KeyEqual,
     Mutex>::getCacheSize() const
 {
-    return m_cache_count.load(std::memory_order_relaxed);
+    std::lock_guard lock(m_mutex);
+    return m_cache_count;
+}
+
+template <
+    class Key,
+    class T,
+    bool IsKeyCache,
+    class SharedWeakUnionPointer,
+    class SharedPointerType,
+    class Hash,
+    class KeyEqual,
+    class Mutex>
+inline int
+TaggedCache<
+    Key,
+    T,
+    IsKeyCache,
+    SharedWeakUnionPointer,
+    SharedPointerType,
+    Hash,
+    KeyEqual,
+    Mutex>::getTrackSize() const
+{
+    std::lock_guard lock(m_mutex);
+    return m_cache.size();
 }
 
 template <
@@ -159,10 +182,9 @@ TaggedCache<
     KeyEqual,
     Mutex>::getHitRate()
 {
-    auto const hits = m_hits.load(std::memory_order_relaxed);
-    auto const misses = m_misses.load(std::memory_order_relaxed);
-    float const total = float(hits + misses);
-    return hits * (100.0f / std::max(1.0f, total));
+    std::lock_guard lock(m_mutex);
+    auto const total = static_cast<float>(m_hits + m_misses);
+    return m_hits * (100.0f / std::max(1.0f, total));
 }
 
 template <
@@ -185,12 +207,9 @@ TaggedCache<
     KeyEqual,
     Mutex>::clear()
 {
-    for (auto& mutex : partitionLocks_)
-        mutex.lock();
+    std::lock_guard lock(m_mutex);
     m_cache.clear();
-    for (auto& mutex : partitionLocks_)
-        mutex.unlock();
-    m_cache_count.store(0, std::memory_order_relaxed);
+    m_cache_count = 0;
 }
 
 template <
@@ -213,9 +232,11 @@ TaggedCache<
     KeyEqual,
     Mutex>::reset()
 {
-    clear();
-    m_hits.store(0, std::memory_order_relaxed);
-    m_misses.store(0, std::memory_order_relaxed);
+    std::lock_guard lock(m_mutex);
+    m_cache.clear();
+    m_cache_count = 0;
+    m_hits = 0;
+    m_misses = 0;
 }
 
 template <
@@ -239,7 +260,12 @@ TaggedCache<
     KeyEqual,
     Mutex>::touch_if_exists(KeyComparable const& key)
 {
-    std::lock_guard<Mutex> lock(lockPartition(key));
+    std::lock_guard lock(m_mutex);
+
+    static unsigned long call_count{0};
+    std::cout << "TaggedCache (" << m_name << ") lock stats,"
+              << "touch_if_exists, call_count = " << ++call_count << std::endl;
+
     auto const iter(m_cache.find(key));
     if (iter == m_cache.end())
     {
@@ -281,6 +307,8 @@ TaggedCache<
 
     auto const start = std::chrono::steady_clock::now();
     {
+        std::lock_guard lock(m_mutex);
+
         if (m_target_size == 0 ||
             (static_cast<int>(m_cache.size()) <= m_target_size))
         {
@@ -312,13 +340,12 @@ TaggedCache<
                 m_cache.map()[p],
                 allStuffToSweep[p],
                 allRemovals,
-                partitionLocks_[p]));
+                lock));
         }
         for (std::thread& worker : workers)
             worker.join();
 
-        int removals = allRemovals.load(std::memory_order_relaxed);
-        m_cache_count.fetch_sub(removals, std::memory_order_relaxed);
+        m_cache_count -= allRemovals;
     }
     // At this point allStuffToSweep will go out of scope outside the lock
     // and decrement the reference count on each strong pointer.
@@ -353,7 +380,11 @@ TaggedCache<
     // Remove from cache, if !valid, remove from map too. Returns true if
     // removed from cache
 
-    std::lock_guard<Mutex> lock(lockPartition(key));
+    std::lock_guard lock(m_mutex);
+
+    static unsigned long call_count{0};
+    std::cout << "TaggedCache (" << m_name << ") lock stats, "
+              << "del, call_count = " << ++call_count << std::endl;
 
     auto cit = m_cache.find(key);
 
@@ -366,7 +397,7 @@ TaggedCache<
 
     if (entry.isCached())
     {
-        m_cache_count.fetch_sub(1, std::memory_order_relaxed);
+        --m_cache_count;
         entry.ptr.convertToWeak();
         ret = true;
     }
@@ -404,16 +435,20 @@ TaggedCache<
 {
     // Return canonical value, store if needed, refresh in cache
     // Return values: true=we had the data already
+    std::lock_guard lock(m_mutex);
 
-    std::lock_guard<Mutex> lock(lockPartition(key));
+    static unsigned long call_count{0};
+    std::cout << "TaggedCache (" << m_name << ") lock stats, "
+              << "canonicalize, call_count = " << ++call_count << std::endl;
     auto cit = m_cache.find(key);
+
     if (cit == m_cache.end())
     {
         m_cache.emplace(
             std::piecewise_construct,
             std::forward_as_tuple(key),
             std::forward_as_tuple(m_clock.now(), data));
-        m_cache_count.fetch_add(1, std::memory_order_relaxed);
+        ++m_cache_count;
         return false;
     }
 
@@ -462,12 +497,12 @@ TaggedCache<
             data = cachedData;
         }
 
-        m_cache_count.fetch_add(1, std::memory_order_relaxed);
+        ++m_cache_count;
         return true;
     }
 
     entry.ptr = data;
-    m_cache_count.fetch_add(1, std::memory_order_relaxed);
+    ++m_cache_count;
 
     return false;
 }
@@ -543,11 +578,15 @@ TaggedCache<
     KeyEqual,
     Mutex>::fetch(key_type const& key)
 {
-    std::lock_guard<Mutex> lock(lockPartition(key));
+    std::lock_guard<mutex_type> l(m_mutex);
 
-    auto ret = initialFetch(key);
+    static unsigned long call_count{0};
+    std::cout << "TaggedCache (" << m_name << ") lock stats, "
+              << "fetch, call_count = " << ++call_count << std::endl;
+
+    auto ret = initialFetch(key, l);
     if (!ret)
-        m_misses.fetch_add(1, std::memory_order_relaxed);
+        ++m_misses;
     return ret;
 }
 
@@ -611,8 +650,13 @@ TaggedCache<
     Mutex>::insert(key_type const& key)
     -> std::enable_if_t<IsKeyCache, ReturnType>
 {
+    std::lock_guard lock(m_mutex);
+
+    static unsigned long call_count{0};
+    std::cout << "TaggedCache (" << m_name << ") lock stats, "
+              << "insert, call_count = " << ++call_count << std::endl;
+
     clock_type::time_point const now(m_clock.now());
-    std::lock_guard<Mutex> lock(lockPartition(key));
     auto [it, inserted] = m_cache.emplace(
         std::piecewise_construct,
         std::forward_as_tuple(key),
@@ -652,6 +696,29 @@ TaggedCache<
     return true;
 }
 
+template <
+    class Key,
+    class T,
+    bool IsKeyCache,
+    class SharedWeakUnionPointer,
+    class SharedPointerType,
+    class Hash,
+    class KeyEqual,
+    class Mutex>
+inline auto
+TaggedCache<
+    Key,
+    T,
+    IsKeyCache,
+    SharedWeakUnionPointer,
+    SharedPointerType,
+    Hash,
+    KeyEqual,
+    Mutex>::peekMutex() -> mutex_type&
+{
+    return m_mutex;
+}
+
 template <
     class Key,
     class T,
@@ -675,13 +742,15 @@ TaggedCache<
     std::vector<key_type> v;
 
     {
+        std::lock_guard lock(m_mutex);
+
+        static unsigned long call_count{0};
+        std::cout << "TaggedCache (" << m_name << ") lock stats, "
+                  << "getKeys, call_count = " << ++call_count << std::endl;
+
         v.reserve(m_cache.size());
-        for (std::size_t i = 0; i < partitionLocks_.size(); ++i)
-        {
-            std::lock_guard<Mutex> lock(partitionLocks_[i]);
-            for (auto const& entry : m_cache.map()[i])
-                v.push_back(entry.first);
-        }
+        for (auto const& _ : m_cache)
+            v.push_back(_.first);
     }
 
     return v;
@@ -707,12 +776,11 @@ TaggedCache<
     KeyEqual,
     Mutex>::rate() const
 {
-    auto const hits = m_hits.load(std::memory_order_relaxed);
-    auto const misses = m_misses.load(std::memory_order_relaxed);
-    auto const tot = hits + misses;
+    std::lock_guard lock(m_mutex);
+    auto const tot = m_hits + m_misses;
     if (tot == 0)
-        return 0.0;
-    return double(hits) / tot;
+        return 0;
+    return double(m_hits) / tot;
 }
 
 template <
@@ -736,16 +804,23 @@ TaggedCache<
     KeyEqual,
     Mutex>::fetch(key_type const& digest, Handler const& h)
 {
-    std::lock_guard<Mutex> lock(lockPartition(digest));
+    {
+        std::lock_guard l(m_mutex);
 
-    if (auto ret = initialFetch(digest))
-        return ret;
+        static unsigned long call_count{0};
+        std::cout << "TaggedCache (" << m_name << ") lock stats, "
+                  << "fetch, call_count = " << ++call_count << std::endl;
+
+        if (auto ret = initialFetch(digest, l))
+            return ret;
+    }
 
     auto sle = h();
     if (!sle)
         return {};
 
-    m_misses.fetch_add(1, std::memory_order_relaxed);
+    std::lock_guard l(m_mutex);
+    ++m_misses;
     auto const [it, inserted] =
         m_cache.emplace(digest, Entry(m_clock.now(), std::move(sle)));
     if (!inserted)
@@ -772,10 +847,9 @@ TaggedCache<
     SharedPointerType,
     Hash,
     KeyEqual,
-    Mutex>::initialFetch(key_type const& key)
+    Mutex>::
+    initialFetch(key_type const& key, std::lock_guard<mutex_type> const& l)
 {
-    std::lock_guard<Mutex> lock(lockPartition(key));
-
     auto cit = m_cache.find(key);
     if (cit == m_cache.end())
         return {};
@@ -783,7 +857,7 @@ TaggedCache<
     Entry& entry = cit->second;
     if (entry.isCached())
     {
-        m_hits.fetch_add(1, std::memory_order_relaxed);
+        ++m_hits;
         entry.touch(m_clock.now());
         return entry.ptr.getStrong();
     }
@@ -791,13 +865,12 @@ TaggedCache<
     if (entry.isCached())
     {
         // independent of cache size, so not counted as a hit
-        m_cache_count.fetch_add(1, std::memory_order_relaxed);
+        ++m_cache_count;
         entry.touch(m_clock.now());
         return entry.ptr.getStrong();
     }
 
     m_cache.erase(cit);
-
     return {};
 }
 
@@ -826,11 +899,10 @@ TaggedCache<
     {
         beast::insight::Gauge::value_type hit_rate(0);
         {
-            auto const hits = m_hits.load(std::memory_order_relaxed);
-            auto const misses = m_misses.load(std::memory_order_relaxed);
-            auto const total = hits + misses;
+            std::lock_guard lock(m_mutex);
+            auto const total(m_hits + m_misses);
             if (total != 0)
-                hit_rate = (hits * 100) / total;
+                hit_rate = (m_hits * 100) / total;
         }
         m_stats.hit_rate.set(hit_rate);
     }
@@ -861,15 +933,16 @@ TaggedCache<
         typename KeyValueCacheType::map_type& partition,
         SweptPointersVector& stuffToSweep,
         std::atomic<int>& allRemovals,
-        Mutex& partitionLock)
+        std::lock_guard<std::recursive_mutex> const&)
 {
     return std::thread([&, this]() {
-        beast::setCurrentThreadName("sweep-KVCache");
-
         int cacheRemovals = 0;
         int mapRemovals = 0;
 
-        std::lock_guard<Mutex> lock(partitionLock);
+        static unsigned long call_count{0};
+        std::cout << "TaggedCache (" << m_name << ") lock stats, "
+                  << "sweep-KVCache, call_count = " << ++call_count
+                  << std::endl;
 
         // Keep references to all the stuff we sweep
         // so that we can destroy them outside the lock.
@@ -954,15 +1027,15 @@ TaggedCache<
         typename KeyOnlyCacheType::map_type& partition,
         SweptPointersVector&,
         std::atomic<int>& allRemovals,
-        Mutex& partitionLock)
+        std::lock_guard<std::recursive_mutex> const&)
 {
     return std::thread([&, this]() {
-        beast::setCurrentThreadName("sweep-KCache");
-
         int cacheRemovals = 0;
         int mapRemovals = 0;
 
-        std::lock_guard<Mutex> lock(partitionLock);
+        static unsigned long call_count{0};
+        std::cout << "TaggedCache (" << m_name << ") lock stats, "
+                  << "sweep-KCache, call_count = " << ++call_count << std::endl;
 
         // Keep references to all the stuff we sweep
         // so that we can destroy them outside the lock.
@@ -998,29 +1071,6 @@ TaggedCache<
     });
 }
 
-template <
-    class Key,
-    class T,
-    bool IsKeyCache,
-    class SharedWeakUnionPointer,
-    class SharedPointerType,
-    class Hash,
-    class KeyEqual,
-    class Mutex>
-inline Mutex&
-TaggedCache<
-    Key,
-    T,
-    IsKeyCache,
-    SharedWeakUnionPointer,
-    SharedPointerType,
-    Hash,
-    KeyEqual,
-    Mutex>::lockPartition(key_type const& key) const
-{
-    return partitionLocks_[m_cache.partition_index(key)];
-}
-
 }  // namespace ripple
 
 #endif

include/xrpl/basics/partitioned_unordered_map.h

@@ -277,12 +277,6 @@ public:
         return map_;
     }
 
-    partition_map_type const&
-    map() const
-    {
-        return map_;
-    }
-
     iterator
     begin()
     {
@@ -327,12 +321,6 @@ public:
         return cend();
     }
 
-    std::size_t
-    partition_index(key_type const& key) const
-    {
-        return partitioner(key);
-    }
-
 private:
     template <class T>
     void

include/xrpl/proto/org/xrpl/rpc/v1/get_ledger.proto

@@ -6,89 +6,81 @@ option java_multiple_files = true;
 
 import "org/xrpl/rpc/v1/ledger.proto";
 
-message GetLedgerRequest
-{
+message GetLedgerRequest {
+  LedgerSpecifier ledger = 1;
 
-    LedgerSpecifier ledger = 1;
+  // If true, include transactions contained in this ledger
+  bool transactions = 2;
 
-    // If true, include transactions contained in this ledger
-    bool transactions = 2;
+  // If true and transactions, include full transactions and metadata
+  // If false and transactions, include only transaction hashes
+  bool expand = 3;
 
-    // If true and transactions, include full transactions and metadata
-    // If false and transactions, include only transaction hashes
-    bool expand = 3;
+  // If true, include state map difference between this ledger and the
+  // previous ledger. This includes all added, modified or deleted ledger
+  // objects
+  bool get_objects = 4;
 
-    // If true, include state map difference between this ledger and the
-    // previous ledger. This includes all added, modified or deleted ledger
-    // objects
-    bool get_objects = 4;
-    
-    // If the request needs to be forwarded from a reporting node to a p2p node,
-    // the reporting node will set this field. Clients should not set this
-    // field.
-    string client_ip = 5;
+  // If the request needs to be forwarded from a reporting node to a p2p node,
+  // the reporting node will set this field. Clients should not set this
+  // field.
+  string client_ip = 5;
 
-    // Identifying string. If user is set, client_ip is not set, and request is
-    // coming from a secure_gateway host, then the client is not subject to
-    // resource controls
-    string user = 6;
+  // Identifying string. If user is set, client_ip is not set, and request is
+  // coming from a secure_gateway host, then the client is not subject to
+  // resource controls
+  string user = 6;
 
-    // For every object in the diff, get the object's predecessor and successor
-    // in the state map. Only used if get_objects is also true.
-    bool get_object_neighbors = 7;
+  // For every object in the diff, get the object's predecessor and successor
+  // in the state map. Only used if get_objects is also true.
+  bool get_object_neighbors = 7;
 }
 
-message GetLedgerResponse
-{
-    bytes ledger_header = 1;
+message GetLedgerResponse {
+  bytes ledger_header = 1;
 
-    oneof transactions
-    {
-        // Just the hashes
-        TransactionHashList hashes_list = 2;
-        
-        // Full transactions and metadata
-        TransactionAndMetadataList transactions_list = 3;
-    }
+  oneof transactions {
+    // Just the hashes
+    TransactionHashList hashes_list = 2;
 
-    // True if the ledger has been validated
-    bool validated = 4;
+    // Full transactions and metadata
+    TransactionAndMetadataList transactions_list = 3;
+  }
 
-    // State map difference between this ledger and the previous ledger
-    RawLedgerObjects ledger_objects = 5;
+  // True if the ledger has been validated
+  bool validated = 4;
 
-    // True if the skiplist object is included in ledger_objects
-    bool skiplist_included = 6;
+  // State map difference between this ledger and the previous ledger
+  RawLedgerObjects ledger_objects = 5;
 
-    // True if request was exempt from resource controls
-    bool is_unlimited = 7;
+  // True if the skiplist object is included in ledger_objects
+  bool skiplist_included = 6;
 
-    // True if the response contains the state map diff
-    bool objects_included = 8;
+  // True if request was exempt from resource controls
+  bool is_unlimited = 7;
 
-    // True if the response contains key of objects adjacent to objects in state
-    // map diff
-    bool object_neighbors_included = 9;
+  // True if the response contains the state map diff
+  bool objects_included = 8;
 
+  // True if the response contains key of objects adjacent to objects in state
+  // map diff
+  bool object_neighbors_included = 9;
 
-    // Successor information for book directories modified as part of this
-    // ledger
-    repeated BookSuccessor book_successors = 10;
+  // Successor information for book directories modified as part of this
+  // ledger
+  repeated BookSuccessor book_successors = 10;
 }
 
-message TransactionHashList
-{
-    repeated bytes hashes = 1;
+message TransactionHashList {
+  repeated bytes hashes = 1;
 }
 
-message TransactionAndMetadata
-{
-    bytes transaction_blob = 1;
+message TransactionAndMetadata {
+  bytes transaction_blob = 1;
 
-    bytes metadata_blob = 2;
+  bytes metadata_blob = 2;
 }
 
-message TransactionAndMetadataList
-{
-    repeated TransactionAndMetadata transactions = 1;
+message TransactionAndMetadataList {
+  repeated TransactionAndMetadata transactions = 1;
 }

include/xrpl/proto/org/xrpl/rpc/v1/get_ledger_data.proto

@@ -8,46 +8,43 @@ import "org/xrpl/rpc/v1/ledger.proto";
 
 // Get ledger objects for a specific ledger. You can iterate through several
 // calls to retrieve the entire contents of a single ledger version.
-message GetLedgerDataRequest
-{
-    // If set, only objects with a key greater than marker are returned.
-    // This can be used to pick up where a previous call left off.
-    // Set marker to the value of marker in the previous response.
-    bytes marker = 1;
+message GetLedgerDataRequest {
+  // If set, only objects with a key greater than marker are returned.
+  // This can be used to pick up where a previous call left off.
+  // Set marker to the value of marker in the previous response.
+  bytes marker = 1;
 
-    LedgerSpecifier ledger = 2;
+  LedgerSpecifier ledger = 2;
 
-    // If set, only objects with a key less than end_marker are returned
-    bytes end_marker = 3;
+  // If set, only objects with a key less than end_marker are returned
+  bytes end_marker = 3;
 
-    // If the request needs to be forwarded from a reporting node to a p2p node,
-    // the reporting node will set this field. Clients should not set this
-    // field.
-    string client_ip = 4;
+  // If the request needs to be forwarded from a reporting node to a p2p node,
+  // the reporting node will set this field. Clients should not set this
+  // field.
+  string client_ip = 4;
 
-    // Identifying string. If user is set, client_ip is not set, and request is
-    // coming from a secure_gateway host, then the client is not subject to
-    // resource controls
-    string user = 6;
+  // Identifying string. If user is set, client_ip is not set, and request is
+  // coming from a secure_gateway host, then the client is not subject to
+  // resource controls
+  string user = 6;
 }
 
-message GetLedgerDataResponse
-{
-    // Sequence of the ledger containing the returned ledger objects
-    uint32 ledger_index = 1;
+message GetLedgerDataResponse {
+  // Sequence of the ledger containing the returned ledger objects
+  uint32 ledger_index = 1;
 
-    // Hash of the ledger containing the returned ledger objects
-    bytes ledger_hash = 2;
-        
-    // Ledger objects
-    RawLedgerObjects ledger_objects = 3;
+  // Hash of the ledger containing the returned ledger objects
+  bytes ledger_hash = 2;
 
-    // Key to be passed into a subsequent call to continue iteration. If not
-    // set, there are no more objects left in the ledger, or no more objects
-    // with key less than end_marker (if end_marker was set in the request)
-    bytes marker = 4;
+  // Ledger objects
+  RawLedgerObjects ledger_objects = 3;
 
-    // True if request was exempt from resource controls
-    bool is_unlimited = 7;
+  // Key to be passed into a subsequent call to continue iteration. If not
+  // set, there are no more objects left in the ledger, or no more objects
+  // with key less than end_marker (if end_marker was set in the request)
+  bytes marker = 4;
+
+  // True if request was exempt from resource controls
+  bool is_unlimited = 7;
 }
-

include/xrpl/proto/org/xrpl/rpc/v1/get_ledger_diff.proto

@@ -6,27 +6,23 @@ option java_multiple_files = true;
 
 import "org/xrpl/rpc/v1/ledger.proto";
 
-
 // Get the state map difference between the two specified ledgers
-message GetLedgerDiffRequest
-{
-    LedgerSpecifier base_ledger = 1;
+message GetLedgerDiffRequest {
+  LedgerSpecifier base_ledger = 1;
 
-    LedgerSpecifier desired_ledger = 2;
+  LedgerSpecifier desired_ledger = 2;
 
-    // If true, include the full ledger object. If false, only keys are included.
-    bool include_blobs = 3;
+  // If true, include the full ledger object. If false, only keys are included.
+  bool include_blobs = 3;
 
-    // If the request needs to be forwarded from a reporting node to a p2p node,
-    // the reporting node will set this field. Clients should not set this
-    // field.
-    string client_ip = 4;
+  // If the request needs to be forwarded from a reporting node to a p2p node,
+  // the reporting node will set this field. Clients should not set this
+  // field.
+  string client_ip = 4;
 }
 
-message GetLedgerDiffResponse
-{
-    // All ledger objects that were added, modified or deleted between
-    // base_ledger and desired_ledger
-    RawLedgerObjects ledger_objects = 1;
+message GetLedgerDiffResponse {
+  // All ledger objects that were added, modified or deleted between
+  // base_ledger and desired_ledger
+  RawLedgerObjects ledger_objects = 1;
 }
-

include/xrpl/proto/org/xrpl/rpc/v1/get_ledger_entry.proto

@@ -7,25 +7,23 @@ option java_multiple_files = true;
 import "org/xrpl/rpc/v1/ledger.proto";
 
 // Get a single ledger object
-message GetLedgerEntryRequest
-{
-    // Key of the desired object
-    bytes key = 1;
+message GetLedgerEntryRequest {
+  // Key of the desired object
+  bytes key = 1;
 
-    // Ledger containing the object
-    LedgerSpecifier ledger = 2;
-    
-    // If the request needs to be forwarded from a reporting node to a p2p node,
-    // the reporting node will set this field. Clients should not set this
-    // field.
-    string client_ip = 3;
+  // Ledger containing the object
+  LedgerSpecifier ledger = 2;
+
+  // If the request needs to be forwarded from a reporting node to a p2p node,
+  // the reporting node will set this field. Clients should not set this
+  // field.
+  string client_ip = 3;
 }
 
-message GetLedgerEntryResponse
-{
-    RawLedgerObject ledger_object = 1;
+message GetLedgerEntryResponse {
+  RawLedgerObject ledger_object = 1;
 
-    // Ledger containing the object. Will match the value specified in the
-    // request.
-    LedgerSpecifier ledger = 2;
+  // Ledger containing the object. Will match the value specified in the
+  // request.
+  LedgerSpecifier ledger = 2;
 }

include/xrpl/proto/org/xrpl/rpc/v1/ledger.proto

@@ -5,71 +5,61 @@ option java_package = "org.xrpl.rpc.v1";
 option java_multiple_files = true;
 
 // Next field: 4
-message LedgerSpecifier
-{
-    // Next field: 4
-    enum Shortcut
-    {
-        SHORTCUT_UNSPECIFIED = 0;
-        SHORTCUT_VALIDATED   = 1;
-        SHORTCUT_CLOSED      = 2;
-        SHORTCUT_CURRENT     = 3;
-    }
+message LedgerSpecifier {
+  // Next field: 4
+  enum Shortcut {
+    SHORTCUT_UNSPECIFIED = 0;
+    SHORTCUT_VALIDATED = 1;
+    SHORTCUT_CLOSED = 2;
+    SHORTCUT_CURRENT = 3;
+  }
 
-    oneof ledger
-    {
-        Shortcut shortcut = 1;
-        uint32 sequence = 2;
-        // 32 bytes
-        bytes hash = 3;
-    }
+  oneof ledger {
+    Shortcut shortcut = 1;
+    uint32 sequence = 2;
+    // 32 bytes
+    bytes hash = 3;
+  }
 }
 
-
 // Next field: 3
-message RawLedgerObject
-{
-    // Raw data of the ledger object. In GetLedgerResponse and
-    // GetLedgerDiffResponse, data will be empty if the object was deleted.
-    bytes data = 1;
+message RawLedgerObject {
+  // Raw data of the ledger object. In GetLedgerResponse and
+  // GetLedgerDiffResponse, data will be empty if the object was deleted.
+  bytes data = 1;
 
-    // Key of the ledger object
-    bytes key = 2;
+  // Key of the ledger object
+  bytes key = 2;
 
-    enum ModificationType
-    {
-        UNSPECIFIED = 0;
-        CREATED = 1;
-        MODIFIED = 2;
-        DELETED = 3;
-    }
+  enum ModificationType {
+    UNSPECIFIED = 0;
+    CREATED = 1;
+    MODIFIED = 2;
+    DELETED = 3;
+  }
 
-    // Whether the object was created, modified or deleted
-    ModificationType mod_type = 3;
+  // Whether the object was created, modified or deleted
+  ModificationType mod_type = 3;
 
-    // Key of the object preceding this object in the desired ledger
-    bytes predecessor = 4;
+  // Key of the object preceding this object in the desired ledger
+  bytes predecessor = 4;
 
-    // Key of the object succeeding this object in the desired ledger
-    bytes successor = 5;
+  // Key of the object succeeding this object in the desired ledger
+  bytes successor = 5;
 }
 
-message RawLedgerObjects
-{
-    repeated RawLedgerObject objects = 1;
+message RawLedgerObjects {
+  repeated RawLedgerObject objects = 1;
 }
 
 // Successor information for book directories. The book base is (usually) not
 // an actual object, yet we need to be able to ask for the successor to the
 // book base.
 message BookSuccessor {
+  // Base of the book in question
+  bytes book_base = 1;
 
-    // Base of the book in question
-    bytes book_base = 1;
-
-    // First book directory in the book. An empty value here means the entire
-    // book is deleted
-    bytes first_book = 2;
-
+  // First book directory in the book. An empty value here means the entire
+  // book is deleted
+  bytes first_book = 2;
 };
-

include/xrpl/proto/org/xrpl/rpc/v1/xrp_ledger.proto

@@ -9,13 +9,11 @@ import "org/xrpl/rpc/v1/get_ledger_entry.proto";
 import "org/xrpl/rpc/v1/get_ledger_data.proto";
 import "org/xrpl/rpc/v1/get_ledger_diff.proto";
 
-
 // These methods are binary only methods for retrieiving arbitrary ledger state
 // via gRPC. These methods are used by clio, but can also be
 // used by any client that wants to extract ledger state in an efficient manner.
 // They do not directly mimic the JSON equivalent methods.
 service XRPLedgerAPIService {
-
   // Get a specific ledger, optionally including transactions and any modified,
   // added or deleted ledger objects
   rpc GetLedger(GetLedgerRequest) returns (GetLedgerResponse);
@@ -29,5 +27,4 @@ service XRPLedgerAPIService {
   // Get all ledger objects that are different between the two specified
   // ledgers. Note, this method has no JSON equivalent.
   rpc GetLedgerDiff(GetLedgerDiffRequest) returns (GetLedgerDiffResponse);
-
 }

include/xrpl/proto/ripple.proto

@@ -4,29 +4,28 @@ package protocol;
 // Unused numbers in the list below may have been used previously. Please don't
 // reassign them for reuse unless you are 100% certain that there won't be a
 // conflict. Even if you're sure, it's probably best to assign a new type.
-enum MessageType
-{
-    mtMANIFESTS                 = 2;
-    mtPING                      = 3;
-    mtCLUSTER                   = 5;
-    mtENDPOINTS                 = 15;
-    mtTRANSACTION               = 30;
-    mtGET_LEDGER                = 31;
-    mtLEDGER_DATA               = 32;
-    mtPROPOSE_LEDGER            = 33;
-    mtSTATUS_CHANGE             = 34;
-    mtHAVE_SET                  = 35;
-    mtVALIDATION                = 41;
-    mtGET_OBJECTS               = 42;
-    mtVALIDATORLIST             = 54;
-    mtSQUELCH                   = 55;
-    mtVALIDATORLISTCOLLECTION   = 56;
-    mtPROOF_PATH_REQ            = 57;
-    mtPROOF_PATH_RESPONSE       = 58;
-    mtREPLAY_DELTA_REQ          = 59;
-    mtREPLAY_DELTA_RESPONSE     = 60;
-    mtHAVE_TRANSACTIONS         = 63;
-    mtTRANSACTIONS              = 64;
+enum MessageType {
+  mtMANIFESTS = 2;
+  mtPING = 3;
+  mtCLUSTER = 5;
+  mtENDPOINTS = 15;
+  mtTRANSACTION = 30;
+  mtGET_LEDGER = 31;
+  mtLEDGER_DATA = 32;
+  mtPROPOSE_LEDGER = 33;
+  mtSTATUS_CHANGE = 34;
+  mtHAVE_SET = 35;
+  mtVALIDATION = 41;
+  mtGET_OBJECTS = 42;
+  mtVALIDATORLIST = 54;
+  mtSQUELCH = 55;
+  mtVALIDATORLISTCOLLECTION = 56;
+  mtPROOF_PATH_REQ = 57;
+  mtPROOF_PATH_RESPONSE = 58;
+  mtREPLAY_DELTA_REQ = 59;
+  mtREPLAY_DELTA_RESPONSE = 60;
+  mtHAVE_TRANSACTIONS = 63;
+  mtTRANSACTIONS = 64;
 }
 
 // token, iterations, target, challenge = issue demand for proof of work
@@ -36,352 +35,309 @@ enum MessageType
 //------------------------------------------------------------------------------
 
 /* Provides the current ephemeral key for a validator. */
-message TMManifest
-{
-    // A Manifest object in the Ripple serialization format.
-    required bytes stobject = 1;
+message TMManifest {
+  // A Manifest object in the Ripple serialization format.
+  required bytes stobject = 1;
 }
 
-message TMManifests
-{
-    repeated TMManifest list = 1;
+message TMManifests {
+  repeated TMManifest list = 1;
 
-    // The manifests sent when a peer first connects to another peer are `history`.
-    optional bool history = 2 [deprecated=true];
+  // The manifests sent when a peer first connects to another peer are `history`.
+  optional bool history = 2 [deprecated = true];
 }
 
 //------------------------------------------------------------------------------
 
 // The status of a node in our cluster
-message TMClusterNode
-{
-    required string          publicKey       = 1;
-    required uint32          reportTime      = 2;
-    required uint32          nodeLoad        = 3;
-    optional string          nodeName        = 4;
-    optional string          address         = 5;
+message TMClusterNode {
+  required string publicKey = 1;
+  required uint32 reportTime = 2;
+  required uint32 nodeLoad = 3;
+  optional string nodeName = 4;
+  optional string address = 5;
 }
 
 // Sources that are placing load on the server
-message TMLoadSource
-{
-    required string          name            = 1;
-    required uint32          cost            = 2;
-    optional uint32          count           = 3; // number of connections
+message TMLoadSource {
+  required string name = 1;
+  required uint32 cost = 2;
+  optional uint32 count = 3;  // number of connections
 }
 
 // The status of all nodes in the cluster
-message TMCluster
-{
-    repeated TMClusterNode   clusterNodes    = 1;
-    repeated TMLoadSource    loadSources     = 2;
+message TMCluster {
+  repeated TMClusterNode clusterNodes = 1;
+  repeated TMLoadSource loadSources = 2;
 }
 
 // Node public key
-message TMLink
-{
-    required bytes nodePubKey       = 1 [deprecated=true]; // node public key
+message TMLink {
+  required bytes nodePubKey = 1 [deprecated = true];  // node public key
 }
 
 // Peer public key
-message TMPublicKey
-{
-    required bytes publicKey = 1;
+message TMPublicKey {
+  required bytes publicKey = 1;
 }
 
 // A transaction can have only one input and one output.
 // If you want to send an amount that is greater than any single address of yours
 // you must first combine coins from one address to another.
 
-enum TransactionStatus
-{
-    tsNEW               = 1;    // origin node did/could not validate
-    tsCURRENT           = 2;    // scheduled to go in this ledger
-    tsCOMMITED          = 3;    // in a closed ledger
-    tsREJECT_CONFLICT   = 4;
-    tsREJECT_INVALID    = 5;
-    tsREJECT_FUNDS      = 6;
-    tsHELD_SEQ          = 7;
-    tsHELD_LEDGER       = 8;    // held for future ledger
+enum TransactionStatus {
+  tsNEW = 1;       // origin node did/could not validate
+  tsCURRENT = 2;   // scheduled to go in this ledger
+  tsCOMMITED = 3;  // in a closed ledger
+  tsREJECT_CONFLICT = 4;
+  tsREJECT_INVALID = 5;
+  tsREJECT_FUNDS = 6;
+  tsHELD_SEQ = 7;
+  tsHELD_LEDGER = 8;  // held for future ledger
 }
 
-message TMTransaction
-{
-    required bytes rawTransaction           = 1;
-    required TransactionStatus status       = 2;
-    optional uint64 receiveTimestamp        = 3;
-    optional bool deferred                  = 4;    // not applied to open ledger
+message TMTransaction {
+  required bytes rawTransaction = 1;
+  required TransactionStatus status = 2;
+  optional uint64 receiveTimestamp = 3;
+  optional bool deferred = 4;  // not applied to open ledger
 }
 
-message TMTransactions
-{
-    repeated TMTransaction transactions = 1;
+message TMTransactions {
+  repeated TMTransaction transactions = 1;
 }
 
-
-enum NodeStatus
-{
-    nsCONNECTING    = 1;        // acquiring connections
-    nsCONNECTED     = 2;        // convinced we are connected to the real network
-    nsMONITORING    = 3;        // we know what the previous ledger is
-    nsVALIDATING    = 4;        // we have the full ledger contents
-    nsSHUTTING      = 5;        // node is shutting down
+enum NodeStatus {
+  nsCONNECTING = 1;  // acquiring connections
+  nsCONNECTED = 2;   // convinced we are connected to the real network
+  nsMONITORING = 3;  // we know what the previous ledger is
+  nsVALIDATING = 4;  // we have the full ledger contents
+  nsSHUTTING = 5;    // node is shutting down
 }
 
-enum NodeEvent
-{
-    neCLOSING_LEDGER    = 1;    // closing a ledger because its close time has come
-    neACCEPTED_LEDGER   = 2;    // accepting a closed ledger, we have finished computing it
-    neSWITCHED_LEDGER   = 3;    // changing due to network consensus
-    neLOST_SYNC         = 4;
+enum NodeEvent {
+  neCLOSING_LEDGER = 1;   // closing a ledger because its close time has come
+  neACCEPTED_LEDGER = 2;  // accepting a closed ledger, we have finished computing it
+  neSWITCHED_LEDGER = 3;  // changing due to network consensus
+  neLOST_SYNC = 4;
 }
 
-message TMStatusChange
-{
-    optional NodeStatus newStatus       = 1;
-    optional NodeEvent newEvent         = 2;
-    optional uint32 ledgerSeq           = 3;
-    optional bytes ledgerHash           = 4;
-    optional bytes ledgerHashPrevious   = 5;
-    optional uint64 networkTime         = 6;
-    optional uint32 firstSeq            = 7;
-    optional uint32 lastSeq             = 8;
+message TMStatusChange {
+  optional NodeStatus newStatus = 1;
+  optional NodeEvent newEvent = 2;
+  optional uint32 ledgerSeq = 3;
+  optional bytes ledgerHash = 4;
+  optional bytes ledgerHashPrevious = 5;
+  optional uint64 networkTime = 6;
+  optional uint32 firstSeq = 7;
+  optional uint32 lastSeq = 8;
 }
 
-
 // Announce to the network our position on a closing ledger
-message TMProposeSet
-{
-    required uint32 proposeSeq          = 1;
-    required bytes currentTxHash        = 2;    // the hash of the ledger we are proposing
-    required bytes nodePubKey           = 3;
-    required uint32 closeTime           = 4;
-    required bytes signature            = 5;    // signature of above fields
-    required bytes previousledger       = 6;
-    repeated bytes addedTransactions    = 10;   // not required if number is large
-    repeated bytes removedTransactions  = 11;   // not required if number is large
+message TMProposeSet {
+  required uint32 proposeSeq = 1;
+  required bytes currentTxHash = 2;  // the hash of the ledger we are proposing
+  required bytes nodePubKey = 3;
+  required uint32 closeTime = 4;
+  required bytes signature = 5;  // signature of above fields
+  required bytes previousledger = 6;
+  repeated bytes addedTransactions = 10;    // not required if number is large
+  repeated bytes removedTransactions = 11;  // not required if number is large
 
-    // node vouches signature is correct
-    optional bool checkedSignature      = 7     [deprecated=true];
+  // node vouches signature is correct
+  optional bool checkedSignature = 7 [deprecated = true];
 
-    // Number of hops traveled
-    optional uint32 hops                = 12    [deprecated=true];
+  // Number of hops traveled
+  optional uint32 hops = 12 [deprecated = true];
 }
 
-enum TxSetStatus
-{
-    tsHAVE      = 1;    // We have this set locally
-    tsCAN_GET   = 2;    // We have a peer with this set
-    tsNEED      = 3;    // We need this set and can't get it
+enum TxSetStatus {
+  tsHAVE = 1;     // We have this set locally
+  tsCAN_GET = 2;  // We have a peer with this set
+  tsNEED = 3;     // We need this set and can't get it
 }
 
-message TMHaveTransactionSet
-{
-    required TxSetStatus status     = 1;
-    required bytes hash             = 2;
+message TMHaveTransactionSet {
+  required TxSetStatus status = 1;
+  required bytes hash = 2;
 }
 
 // Validator list (UNL)
-message TMValidatorList
-{
-    required bytes manifest         = 1;
-    required bytes blob             = 2;
-    required bytes signature        = 3;
-    required uint32 version         = 4;
+message TMValidatorList {
+  required bytes manifest = 1;
+  required bytes blob = 2;
+  required bytes signature = 3;
+  required uint32 version = 4;
 }
 
 // Validator List v2
-message ValidatorBlobInfo
-{
-    optional bytes manifest         = 1;
-    required bytes blob             = 2;
-    required bytes signature        = 3;
+message ValidatorBlobInfo {
+  optional bytes manifest = 1;
+  required bytes blob = 2;
+  required bytes signature = 3;
 }
 
 // Collection of Validator List v2 (UNL)
-message TMValidatorListCollection
-{
-    required uint32 version          = 1;
-    required bytes manifest          = 2;
-    repeated ValidatorBlobInfo blobs = 3;
+message TMValidatorListCollection {
+  required uint32 version = 1;
+  required bytes manifest = 2;
+  repeated ValidatorBlobInfo blobs = 3;
 }
 
 // Used to sign a final closed ledger after reprocessing
-message TMValidation
-{
-    // The serialized validation
-    required bytes validation = 1;
+message TMValidation {
+  // The serialized validation
+  required bytes validation = 1;
 
-    // node vouches signature is correct
-    optional bool checkedSignature = 2 [deprecated = true];
+  // node vouches signature is correct
+  optional bool checkedSignature = 2 [deprecated = true];
 
-    // Number of hops traveled
-    optional uint32 hops = 3           [deprecated = true];
+  // Number of hops traveled
+  optional uint32 hops = 3 [deprecated = true];
 }
 
 // An array of Endpoint messages
-message TMEndpoints
-{
-    // Previously used - don't reuse.
-    reserved 2;
+message TMEndpoints {
+  // Previously used - don't reuse.
+  reserved 2;
 
-    // This field is used to allow the TMEndpoints message format to be
-    // modified as necessary in the future.
-    required uint32         version = 1;
+  // This field is used to allow the TMEndpoints message format to be
+  // modified as necessary in the future.
+  required uint32 version = 1;
 
-    // An update to the Endpoint type that uses a string
-    // to represent endpoints, thus allowing ipv6 or ipv4 addresses
-    message TMEndpointv2
-    {
-        required string endpoint = 1;
-        required uint32 hops     = 2;
-    }
-    repeated TMEndpointv2   endpoints_v2 = 3;
+  // An update to the Endpoint type that uses a string
+  // to represent endpoints, thus allowing ipv6 or ipv4 addresses
+  message TMEndpointv2 {
+    required string endpoint = 1;
+    required uint32 hops = 2;
+  }
+  repeated TMEndpointv2 endpoints_v2 = 3;
 };
 
-message TMIndexedObject
-{
-    optional bytes hash         = 1;
-    optional bytes nodeID       = 2;
-    optional bytes index        = 3;
-    optional bytes data         = 4;
-    optional uint32 ledgerSeq   = 5;
+message TMIndexedObject {
+  optional bytes hash = 1;
+  optional bytes nodeID = 2;
+  optional bytes index = 3;
+  optional bytes data = 4;
+  optional uint32 ledgerSeq = 5;
 }
 
-message TMGetObjectByHash
-{
-    enum ObjectType {
-        otUNKNOWN           = 0;
-        otLEDGER            = 1;
-        otTRANSACTION       = 2;
-        otTRANSACTION_NODE  = 3;
-        otSTATE_NODE        = 4;
-        otCAS_OBJECT        = 5;
-        otFETCH_PACK        = 6;
-        otTRANSACTIONS      = 7;
-    }
+message TMGetObjectByHash {
+  enum ObjectType {
+    otUNKNOWN = 0;
+    otLEDGER = 1;
+    otTRANSACTION = 2;
+    otTRANSACTION_NODE = 3;
+    otSTATE_NODE = 4;
+    otCAS_OBJECT = 5;
+    otFETCH_PACK = 6;
+    otTRANSACTIONS = 7;
+  }
 
-    required ObjectType type            = 1;
-    required bool query                 = 2;    // is this a query or a reply?
-    optional uint32 seq                 = 3;    // used to match replies to queries
-    optional bytes ledgerHash           = 4;    // the hash of the ledger these queries are for
-    optional bool fat                   = 5;    // return related nodes
-    repeated TMIndexedObject objects    = 6;    // the specific objects requested
+  required ObjectType type = 1;
+  required bool query = 2;               // is this a query or a reply?
+  optional uint32 seq = 3;               // used to match replies to queries
+  optional bytes ledgerHash = 4;         // the hash of the ledger these queries are for
+  optional bool fat = 5;                 // return related nodes
+  repeated TMIndexedObject objects = 6;  // the specific objects requested
 }
 
-
-message TMLedgerNode
-{
-    required bytes nodedata         = 1;
-    optional bytes nodeid           = 2;    // missing for ledger base data
+message TMLedgerNode {
+  required bytes nodedata = 1;
+  optional bytes nodeid = 2;  // missing for ledger base data
 }
 
-enum TMLedgerInfoType
-{
-    liBASE          = 0;        // basic ledger info
-    liTX_NODE       = 1;        // transaction node
-    liAS_NODE       = 2;        // account state node
-    liTS_CANDIDATE  = 3;        // candidate transaction set
+enum TMLedgerInfoType {
+  liBASE = 0;          // basic ledger info
+  liTX_NODE = 1;       // transaction node
+  liAS_NODE = 2;       // account state node
+  liTS_CANDIDATE = 3;  // candidate transaction set
 }
 
-enum TMLedgerType
-{
-    ltACCEPTED      = 0;
-    ltCURRENT       = 1;        // no longer supported
-    ltCLOSED        = 2;
+enum TMLedgerType {
+  ltACCEPTED = 0;
+  ltCURRENT = 1;  // no longer supported
+  ltCLOSED = 2;
 }
 
-enum TMQueryType
-{
-    qtINDIRECT      = 0;
+enum TMQueryType {
+  qtINDIRECT = 0;
 }
 
-message TMGetLedger
-{
-    required TMLedgerInfoType itype = 1;
-    optional TMLedgerType ltype     = 2;
-    optional bytes ledgerHash       = 3;    // Can also be the transaction set hash if liTS_CANDIDATE
-    optional uint32 ledgerSeq       = 4;
-    repeated bytes nodeIDs          = 5;
-    optional uint64 requestCookie   = 6;
-    optional TMQueryType queryType  = 7;
-    optional uint32 queryDepth      = 8;    // How deep to go, number of extra levels
+message TMGetLedger {
+  required TMLedgerInfoType itype = 1;
+  optional TMLedgerType ltype = 2;
+  optional bytes ledgerHash = 3;  // Can also be the transaction set hash if liTS_CANDIDATE
+  optional uint32 ledgerSeq = 4;
+  repeated bytes nodeIDs = 5;
+  optional uint64 requestCookie = 6;
+  optional TMQueryType queryType = 7;
+  optional uint32 queryDepth = 8;  // How deep to go, number of extra levels
 }
 
-enum TMReplyError
-{
-    reNO_LEDGER                     = 1;    // We don't have the ledger you are asking about
-    reNO_NODE                       = 2;    // We don't have any of the nodes you are asking for
-    reBAD_REQUEST                   = 3;    // The request is wrong, e.g. wrong format
+enum TMReplyError {
+  reNO_LEDGER = 1;    // We don't have the ledger you are asking about
+  reNO_NODE = 2;      // We don't have any of the nodes you are asking for
+  reBAD_REQUEST = 3;  // The request is wrong, e.g. wrong format
 }
 
-message TMLedgerData
-{
-    required bytes ledgerHash       = 1;
-    required uint32 ledgerSeq       = 2;
-    required TMLedgerInfoType type  = 3;
-    repeated TMLedgerNode nodes     = 4;
-    optional uint32 requestCookie   = 5;
-    optional TMReplyError error     = 6;
+message TMLedgerData {
+  required bytes ledgerHash = 1;
+  required uint32 ledgerSeq = 2;
+  required TMLedgerInfoType type = 3;
+  repeated TMLedgerNode nodes = 4;
+  optional uint32 requestCookie = 5;
+  optional TMReplyError error = 6;
 }
 
-message TMPing
-{
-    enum pingType {
-        ptPING = 0; // we want a reply
-        ptPONG = 1; // this is a reply
-    }
-    required pingType type      = 1;
-    optional uint32 seq         = 2; // detect stale replies, ensure other side is reading
-    optional uint64 pingTime    = 3; // know when we think we sent the ping
-    optional uint64 netTime     = 4;
+message TMPing {
+  enum pingType {
+    ptPING = 0;  // we want a reply
+    ptPONG = 1;  // this is a reply
+  }
+  required pingType type = 1;
+  optional uint32 seq = 2;       // detect stale replies, ensure other side is reading
+  optional uint64 pingTime = 3;  // know when we think we sent the ping
+  optional uint64 netTime = 4;
 }
 
-message TMSquelch
-{
-    required bool squelch           = 1; // squelch if true, otherwise unsquelch
-    required bytes validatorPubKey  = 2; // validator's public key
-    optional uint32 squelchDuration = 3; // squelch duration in seconds
+message TMSquelch {
+  required bool squelch = 1;            // squelch if true, otherwise unsquelch
+  required bytes validatorPubKey = 2;   // validator's public key
+  optional uint32 squelchDuration = 3;  // squelch duration in seconds
 }
 
-enum TMLedgerMapType
-{
-    lmTRANASCTION   = 1;        // transaction map
-    lmACCOUNT_STATE = 2;        // account state map
+enum TMLedgerMapType {
+  lmTRANASCTION = 1;    // transaction map
+  lmACCOUNT_STATE = 2;  // account state map
 }
 
-message TMProofPathRequest
-{
-    required bytes key = 1;
-    required bytes ledgerHash = 2;
-    required TMLedgerMapType type = 3;
+message TMProofPathRequest {
+  required bytes key = 1;
+  required bytes ledgerHash = 2;
+  required TMLedgerMapType type = 3;
 }
 
-message TMProofPathResponse
-{
-    required bytes key = 1;
-    required bytes ledgerHash = 2;
-    required TMLedgerMapType type = 3;
-    optional bytes ledgerHeader = 4;
-    repeated bytes path = 5;
-    optional TMReplyError error = 6;
+message TMProofPathResponse {
+  required bytes key = 1;
+  required bytes ledgerHash = 2;
+  required TMLedgerMapType type = 3;
+  optional bytes ledgerHeader = 4;
+  repeated bytes path = 5;
+  optional TMReplyError error = 6;
 }
 
-message TMReplayDeltaRequest
-{
-    required bytes ledgerHash = 1;
+message TMReplayDeltaRequest {
+  required bytes ledgerHash = 1;
 }
 
-message TMReplayDeltaResponse
-{
-    required bytes ledgerHash = 1;
-    optional bytes ledgerHeader = 2;
-    repeated bytes transaction = 3;
-    optional TMReplyError error = 4;
+message TMReplayDeltaResponse {
+  required bytes ledgerHash = 1;
+  optional bytes ledgerHeader = 2;
+  repeated bytes transaction = 3;
+  optional TMReplyError error = 4;
 }
 
-message TMHaveTransactions
-{
-    repeated bytes hashes = 1;
+message TMHaveTransactions {
+  repeated bytes hashes = 1;
 }
-

include/xrpl/protocol/Batch.h

@@ -34,4 +34,4 @@ serializeBatch(
         msg.addBitString(txid);
 }
 
-}  // namespace ripple
+}  // namespace ripple

include/xrpl/protocol/Protocol.h

@@ -22,6 +22,7 @@
 
 #include <xrpl/basics/ByteUtilities.h>
 #include <xrpl/basics/base_uint.h>
+#include <xrpl/basics/partitioned_unordered_map.h>
 
 #include <cstdint>
 

include/xrpl/protocol/TxFlags.h

@@ -141,7 +141,7 @@ constexpr std::uint32_t const tfTransferable               = 0x00000008;
 constexpr std::uint32_t const tfMutable                    = 0x00000010;
 
 // MPTokenIssuanceCreate flags:
-// NOTE - there is intentionally no flag here for lsfMPTLocked, which this transaction cannot mutate. 
+// NOTE - there is intentionally no flag here for lsfMPTLocked, which this transaction cannot mutate.
 constexpr std::uint32_t const tfMPTCanLock                 = lsfMPTCanLock;
 constexpr std::uint32_t const tfMPTRequireAuth             = lsfMPTRequireAuth;
 constexpr std::uint32_t const tfMPTCanEscrow               = lsfMPTCanEscrow;
@@ -243,7 +243,7 @@ constexpr std::uint32_t tfUntilFailure                 = 0x00040000;
 constexpr std::uint32_t tfIndependent                  = 0x00080000;
 /**
  * @note If nested Batch transactions are supported in the future, the tfInnerBatchTxn flag
- *  will need to be removed from this mask to allow Batch transaction to be inside 
+ *  will need to be removed from this mask to allow Batch transaction to be inside
  *  the sfRawTransactions array.
  */
 constexpr std::uint32_t const tfBatchMask =

include/xrpl/protocol/detail/ledger_entries.macro

@@ -505,4 +505,3 @@ LEDGER_ENTRY(ltVAULT, 0x0084, Vault, vault, ({
 
 #undef EXPAND
 #undef LEDGER_ENTRY_DUPLICATE
-

src/libxrpl/protocol/BuildInfo.cpp

@@ -36,7 +36,7 @@ namespace BuildInfo {
 //  and follow the format described at http://semver.org/
 //------------------------------------------------------------------------------
 // clang-format off
-char const* const versionString = "2.6.0-rc2"
+char const* const versionString = "2.6.0-rc3"
 // clang-format on
 
 #if defined(DEBUG) || defined(SANITIZER)

src/libxrpl/protocol/Permissions.cpp

@@ -145,4 +145,4 @@ Permission::permissionToTxType(uint32_t const& value) const
     return static_cast<TxType>(value - 1);
 }
 
-}  // namespace ripple
+}  // namespace ripple

src/test/app/Delegate_test.cpp

@@ -1499,4 +1499,4 @@ class Delegate_test : public beast::unit_test::suite
 };
 BEAST_DEFINE_TESTSUITE(Delegate, app, ripple);
 }  // namespace test
-}  // namespace ripple
+}  // namespace ripple

src/test/app/NFTokenAuth_test.cpp

@@ -621,4 +621,4 @@ public:
 
 BEAST_DEFINE_TESTSUITE_PRIO(NFTokenAuth, app, ripple, 2);
 
-}  // namespace ripple
+}  // namespace ripple

src/test/basics/TaggedCache_test.cpp

@@ -58,10 +58,10 @@ public:
         // Insert an item, retrieve it, and age it so it gets purged.
         {
             BEAST_EXPECT(c.getCacheSize() == 0);
-            BEAST_EXPECT(c.size() == 0);
+            BEAST_EXPECT(c.getTrackSize() == 0);
             BEAST_EXPECT(!c.insert(1, "one"));
             BEAST_EXPECT(c.getCacheSize() == 1);
-            BEAST_EXPECT(c.size() == 1);
+            BEAST_EXPECT(c.getTrackSize() == 1);
 
             {
                 std::string s;
@@ -72,7 +72,7 @@ public:
             ++clock;
             c.sweep();
             BEAST_EXPECT(c.getCacheSize() == 0);
-            BEAST_EXPECT(c.size() == 0);
+            BEAST_EXPECT(c.getTrackSize() == 0);
         }
 
         // Insert an item, maintain a strong pointer, age it, and
@@ -80,7 +80,7 @@ public:
         {
             BEAST_EXPECT(!c.insert(2, "two"));
             BEAST_EXPECT(c.getCacheSize() == 1);
-            BEAST_EXPECT(c.size() == 1);
+            BEAST_EXPECT(c.getTrackSize() == 1);
 
             {
                 auto p = c.fetch(2);
@@ -88,14 +88,14 @@ public:
                 ++clock;
                 c.sweep();
                 BEAST_EXPECT(c.getCacheSize() == 0);
-                BEAST_EXPECT(c.size() == 1);
+                BEAST_EXPECT(c.getTrackSize() == 1);
             }
 
             // Make sure its gone now that our reference is gone
             ++clock;
             c.sweep();
             BEAST_EXPECT(c.getCacheSize() == 0);
-            BEAST_EXPECT(c.size() == 0);
+            BEAST_EXPECT(c.getTrackSize() == 0);
         }
 
         // Insert the same key/value pair and make sure we get the same result
@@ -111,7 +111,7 @@ public:
             ++clock;
             c.sweep();
             BEAST_EXPECT(c.getCacheSize() == 0);
-            BEAST_EXPECT(c.size() == 0);
+            BEAST_EXPECT(c.getTrackSize() == 0);
         }
 
         // Put an object in but keep a strong pointer to it, advance the clock a
@@ -121,24 +121,24 @@ public:
             // Put an object in
             BEAST_EXPECT(!c.insert(4, "four"));
             BEAST_EXPECT(c.getCacheSize() == 1);
-            BEAST_EXPECT(c.size() == 1);
+            BEAST_EXPECT(c.getTrackSize() == 1);
 
             {
                 // Keep a strong pointer to it
                 auto const p1 = c.fetch(4);
                 BEAST_EXPECT(p1 != nullptr);
                 BEAST_EXPECT(c.getCacheSize() == 1);
-                BEAST_EXPECT(c.size() == 1);
+                BEAST_EXPECT(c.getTrackSize() == 1);
                 // Advance the clock a lot
                 ++clock;
                 c.sweep();
                 BEAST_EXPECT(c.getCacheSize() == 0);
-                BEAST_EXPECT(c.size() == 1);
+                BEAST_EXPECT(c.getTrackSize() == 1);
                 // Canonicalize a new object with the same key
                 auto p2 = std::make_shared<std::string>("four");
                 BEAST_EXPECT(c.canonicalize_replace_client(4, p2));
                 BEAST_EXPECT(c.getCacheSize() == 1);
-                BEAST_EXPECT(c.size() == 1);
+                BEAST_EXPECT(c.getTrackSize() == 1);
                 // Make sure we get the original object
                 BEAST_EXPECT(p1.get() == p2.get());
             }
@@ -146,7 +146,7 @@ public:
             ++clock;
             c.sweep();
             BEAST_EXPECT(c.getCacheSize() == 0);
-            BEAST_EXPECT(c.size() == 0);
+            BEAST_EXPECT(c.getTrackSize() == 0);
         }
     }
 };

src/test/csf/collectors.h

@@ -720,4 +720,4 @@ struct JumpCollector
 }  // namespace test
 }  // namespace ripple
 
-#endif
+#endif

src/test/jtx/delegate.h

@@ -59,4 +59,4 @@ public:
 }  // namespace delegate
 }  // namespace jtx
 }  // namespace test
-}  // namespace ripple
+}  // namespace ripple

src/test/jtx/impl/Env.cpp

@@ -499,7 +499,16 @@ Env::meta()
         close();
     }
     auto const item = closed()->txRead(txid_);
-    return item.second;
+    auto const result = item.second;
+    if (result == nullptr)
+    {
+        test.log << "Env::meta: no metadata for txid: " << txid_ << std::endl;
+        test.log << "This is probably because the transaction failed with a "
+                    "non-tec error."
+                 << std::endl;
+        Throw<std::runtime_error>("Env::meta: no metadata for txid");
+    }
+    return result;
 }
 
 std::shared_ptr<STTx const>

src/test/jtx/impl/delegate.cpp

@@ -64,4 +64,4 @@ entry(jtx::Env& env, jtx::Account const& account, jtx::Account const& authorize)
 }  // namespace delegate
 }  // namespace jtx
 }  // namespace test
-}  // namespace ripple
+}  // namespace ripple

src/xrpld/app/ledger/LedgerHistory.cpp

@@ -25,6 +25,8 @@
 #include <xrpl/basics/contract.h>
 #include <xrpl/json/to_string.h>
 
+#include <iostream>
+
 namespace ripple {
 
 // FIXME: Need to clean up ledgers by index at some point
@@ -63,6 +65,12 @@ LedgerHistory::insert(
         ledger->stateMap().getHash().isNonZero(),
         "ripple::LedgerHistory::insert : nonzero hash");
 
+    std::unique_lock sl(m_ledgers_by_hash.peekMutex());
+
+    static unsigned long call_count{0};
+    std::cout << "LedgerHistory lock stats, "
+              << "insert, call_count = " << ++call_count << std::endl;
+
     bool const alreadyHad = m_ledgers_by_hash.canonicalize_replace_cache(
         ledger->info().hash, ledger);
     if (validated)
@@ -74,6 +82,12 @@ LedgerHistory::insert(
 LedgerHash
 LedgerHistory::getLedgerHash(LedgerIndex index)
 {
+    std::unique_lock sl(m_ledgers_by_hash.peekMutex());
+
+    static unsigned long call_count{0};
+    std::cout << "LedgerHistory lock stats, "
+              << "getLedgerHash, call_count = " << ++call_count << std::endl;
+
     if (auto it = mLedgersByIndex.find(index); it != mLedgersByIndex.end())
         return it->second;
     return {};
@@ -83,11 +97,19 @@ std::shared_ptr<Ledger const>
 LedgerHistory::getLedgerBySeq(LedgerIndex index)
 {
     {
+        std::unique_lock sl(m_ledgers_by_hash.peekMutex());
+
+        static unsigned long call_count{0};
+        std::cout << "LedgerHistory lock stats, "
+                  << "getLedgerBySeq, call_count = " << ++call_count
+                  << std::endl;
+
         auto it = mLedgersByIndex.find(index);
 
         if (it != mLedgersByIndex.end())
         {
             uint256 hash = it->second;
+            sl.unlock();
             return getLedgerByHash(hash);
         }
     }
@@ -103,6 +125,7 @@ LedgerHistory::getLedgerBySeq(LedgerIndex index)
 
     {
         // Add this ledger to the local tracking by index
+        std::unique_lock sl(m_ledgers_by_hash.peekMutex());
 
         XRPL_ASSERT(
             ret->isImmutable(),
@@ -452,6 +475,8 @@ LedgerHistory::builtLedger(
     XRPL_ASSERT(
         !hash.isZero(), "ripple::LedgerHistory::builtLedger : nonzero hash");
 
+    std::unique_lock sl(m_consensus_validated.peekMutex());
+
     auto entry = std::make_shared<cv_entry>();
     m_consensus_validated.canonicalize_replace_client(index, entry);
 
@@ -492,6 +517,8 @@ LedgerHistory::validatedLedger(
         !hash.isZero(),
         "ripple::LedgerHistory::validatedLedger : nonzero hash");
 
+    std::unique_lock sl(m_consensus_validated.peekMutex());
+
     auto entry = std::make_shared<cv_entry>();
     m_consensus_validated.canonicalize_replace_client(index, entry);
 
@@ -525,9 +552,15 @@ LedgerHistory::validatedLedger(
 bool
 LedgerHistory::fixIndex(LedgerIndex ledgerIndex, LedgerHash const& ledgerHash)
 {
-    auto ledger = m_ledgers_by_hash.fetch(ledgerHash);
+    std::unique_lock sl(m_ledgers_by_hash.peekMutex());
+
+    static unsigned long call_count{0};
+    std::cout << "LedgerHistory lock stats, "
+              << "fixIndex, call_count = " << ++call_count << std::endl;
+
     auto it = mLedgersByIndex.find(ledgerIndex);
-    if (ledger && (it != mLedgersByIndex.end()) && (it->second != ledgerHash))
+
+    if ((it != mLedgersByIndex.end()) && (it->second != ledgerHash))
     {
         it->second = ledgerHash;
         return false;

src/xrpld/app/tx/detail/DelegateSet.cpp

@@ -159,4 +159,4 @@ DelegateSet::deleteDelegate(
     return tesSUCCESS;
 }
 
-}  // namespace ripple
+}  // namespace ripple

src/xrpld/app/tx/detail/DelegateSet.h

@@ -53,4 +53,4 @@ public:
 
 }  // namespace ripple
 
-#endif
+#endif

src/xrpld/rpc/handlers/GetCounts.cpp

@@ -114,7 +114,7 @@ getCountsJson(Application& app, int minObjectCount)
     ret[jss::treenode_cache_size] =
         app.getNodeFamily().getTreeNodeCache()->getCacheSize();
     ret[jss::treenode_track_size] =
-        static_cast<int>(app.getNodeFamily().getTreeNodeCache()->size());
+        app.getNodeFamily().getTreeNodeCache()->getTrackSize();
 
     std::string uptime;
     auto s = UptimeClock::now();