Merge branch 'develop'

.github/workflows/doxygen.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - develop
+      - doxygen
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true

.github/workflows/libxrpl.yml

@@ -0,0 +1,88 @@
+name: Check libXRPL compatibility with Clio
+env:
+  CONAN_URL: http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod
+  CONAN_LOGIN_USERNAME_RIPPLE: ${{ secrets.CONAN_USERNAME }}
+  CONAN_PASSWORD_RIPPLE: ${{ secrets.CONAN_TOKEN }}
+on:
+  pull_request:
+    paths:
+      - 'src/libxrpl/protocol/BuildInfo.cpp'
+      - '.github/workflows/libxrpl.yml'
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  publish:
+    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: rippleci/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 Ripple Conan remote
+        shell: bash
+        run: |
+          conan remote list
+          conan remote remove ripple || true
+          # Do not quote the URL. An empty string will be accepted (with a non-fatal warning), but a missing argument will not.
+          conan remote add ripple ${{ env.CONAN_URL }} --insert 0
+      - 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 Ripple 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 ripple --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 }}"

bin/ci/README.md

@@ -1,3 +1,5 @@
+# Continuous Integration (CI) Scripts
+
 In this directory are two scripts, `build.sh` and `test.sh` used for building
 and testing rippled.
 

cmake/RippledDocs.cmake

@@ -21,15 +21,17 @@ set(doxyfile "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile")
 
 file(GLOB_RECURSE doxygen_input
   docs/*.md
-  src/ripple/*.h
-  src/ripple/*.cpp
-  src/ripple/*.md
-  src/test/*.h
-  src/test/*.md)
+  include/*.h
+  include/*.cpp
+  include/*.md
+  src/*.h
+  src/*.cpp
+  src/*.md
+  Builds/*.md
+  *.md)
 list(APPEND doxygen_input
-  README.md
-  RELEASENOTES.md
-  src/README.md)
+  external/README.md
+  )
 set(dependencies "${doxygen_input}" "${doxyfile}")
 
 function(verbose_find_path variable name)

docs/Doxyfile

@@ -103,18 +103,17 @@ WARN_LOGFILE           =
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
 INPUT                  = \
-    docs \
-    src/ripple \
-    src/test \
-    src/README.md \
-    README.md \
-    RELEASENOTES.md \
+    . \
 
 
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h *.cpp *.md
 RECURSIVE              = YES
-EXCLUDE                =
+EXCLUDE                = \
+    .github \
+    external/ed25519-donna \
+    external/secp256k1 \
+
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
 EXCLUDE_SYMBOLS        =
@@ -130,7 +129,7 @@ INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
 FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE = src/README.md
+USE_MDFILE_AS_MAINPAGE = ./README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

external/README.md

@@ -1,3 +1,5 @@
+# External Conan recipes
+
 The subdirectories in this directory contain either copies or Conan recipes
 of external libraries used by rippled.
 The Conan recipes include patches we have not yet pushed upstream.

include/xrpl/proto/org/xrpl/rpc/v1/README.md

@@ -1,3 +1,5 @@
+# Protocol buffer definitions for gRPC
+
 This folder contains the protocol buffer definitions used by the rippled gRPC API.
 The gRPC API attempts to mimic the JSON/Websocket API as much as possible.
 As of April 2020, the gRPC API supports a subset of the full rippled API:

include/xrpl/protocol/Feature.h

@@ -80,7 +80,7 @@ namespace detail {
 // Feature.cpp. Because it's only used to reserve storage, and determine how
 // large to make the FeatureBitset, it MAY be larger. It MUST NOT be less than
 // the actual number of amendments. A LogicError on startup will verify this.
-static constexpr std::size_t numFeatures = 79;
+static constexpr std::size_t numFeatures = 80;
 
 /** Amendments that this server supports and the default voting behavior.
    Whether they are enabled depends on the Rules defined in the validated
@@ -372,6 +372,7 @@ extern uint256 const fixEnforceNFTokenTrustline;
 extern uint256 const fixInnerObjTemplate2;
 extern uint256 const featureInvariantsV1_1;
 extern uint256 const featureMPTokensV1;
+extern uint256 const fixNFTokenPageLinks;
 
 }  // namespace ripple
 

include/xrpl/protocol/SField.h

@@ -389,6 +389,7 @@ extern SF_UINT16 const sfHookEmitCount;
 extern SF_UINT16 const sfHookExecutionIndex;
 extern SF_UINT16 const sfHookApiVersion;
 extern SF_UINT16 const sfDiscountedFee;
+extern SF_UINT16 const sfLedgerFixType;
 
 // 32-bit integers (common)
 extern SF_UINT32 const sfNetworkID;

include/xrpl/protocol/TER.h

@@ -184,6 +184,7 @@ enum TEFcodes : TERUnderlyingType {
     tefTOO_BIG,
     tefNO_TICKET,
     tefNFTOKEN_IS_NOT_TRANSFERABLE,
+    tefINVALID_LEDGER_FIX_TYPE,
 };
 
 //------------------------------------------------------------------------------

include/xrpl/protocol/TxFormats.h

@@ -190,23 +190,26 @@ enum TxType : std::uint16_t
     /** This transaction type deletes a DID */
     ttDID_DELETE = 50,
 
-
     /** This transaction type creates an Oracle instance */
     ttORACLE_SET = 51,
 
     /** This transaction type deletes an Oracle instance */
     ttORACLE_DELETE = 52,
+
+    /** This transaction type fixes a problem in the ledger state */
+    ttLEDGER_STATE_FIX = 53,
+
 /** This transaction creates a new MPTokenIssuance object. */
-    ttMPTOKEN_ISSUANCE_CREATE = 53,
+    ttMPTOKEN_ISSUANCE_CREATE = 54,
 
     /** This transaction destroys an existing MPTokenIssuance object. */
-    ttMPTOKEN_ISSUANCE_DESTROY = 54,
+    ttMPTOKEN_ISSUANCE_DESTROY = 55,
 
     /** This transaction destroys an existing MPTokenIssuance object. */
-    ttMPTOKEN_AUTHORIZE = 55,
+    ttMPTOKEN_AUTHORIZE = 56,
 
     /** This transaction sets an existing MPTokenIssuance or MPToken object. */
-    ttMPTOKEN_ISSUANCE_SET = 56,
+    ttMPTOKEN_ISSUANCE_SET = 57,
 
     /** This system-generated transaction type is used to update the status of the various amendments.
 

include/xrpl/protocol/jss.h

@@ -111,6 +111,7 @@ JSS(NFTokenAcceptOffer);   // transaction type.
 JSS(NFTokenCancelOffer);   // transaction type.
 JSS(NFTokenCreateOffer);   // transaction type.
 JSS(NFTokenPage);          // ledger type.
+JSS(LedgerStateFix);       // transaction type.
 JSS(LPTokenOut);           // in: AMM Liquidity Provider deposit tokens
 JSS(LPTokenIn);            // in: AMM Liquidity Provider withdraw tokens
 JSS(LPToken);              // out: AMM Liquidity Provider tokens info

src/libxrpl/protocol/Feature.cpp

@@ -497,6 +497,7 @@ REGISTER_FEATURE(NFTokenMintOffer,              Supported::yes, VoteBehavior::De
 REGISTER_FIX    (fixReducedOffersV2,            Supported::yes, VoteBehavior::DefaultNo);
 REGISTER_FIX    (fixEnforceNFTokenTrustline,    Supported::yes, VoteBehavior::DefaultNo);
 REGISTER_FIX    (fixInnerObjTemplate2,          Supported::yes, VoteBehavior::DefaultNo);
+REGISTER_FIX    (fixNFTokenPageLinks,           Supported::yes, VoteBehavior::DefaultNo);
 // InvariantsV1_1 will be changes to Supported::yes when all the
 // invariants expected to be included under it are complete.
 REGISTER_FEATURE(InvariantsV1_1,                Supported::no, VoteBehavior::DefaultNo);

src/libxrpl/protocol/SField.cpp

@@ -114,6 +114,7 @@ CONSTRUCT_TYPED_SFIELD(sfHookStateChangeCount,  "HookStateChangeCount", UINT16,
 CONSTRUCT_TYPED_SFIELD(sfHookEmitCount,         "HookEmitCount",        UINT16,    18);
 CONSTRUCT_TYPED_SFIELD(sfHookExecutionIndex,    "HookExecutionIndex",   UINT16,    19);
 CONSTRUCT_TYPED_SFIELD(sfHookApiVersion,        "HookApiVersion",       UINT16,    20);
+CONSTRUCT_TYPED_SFIELD(sfLedgerFixType,         "LedgerFixType",        UINT16,    21);
 
 // 32-bit integers (common)
 CONSTRUCT_TYPED_SFIELD(sfNetworkID,             "NetworkID",            UINT32,     1);

src/libxrpl/protocol/TER.cpp

@@ -141,6 +141,7 @@ transResults()
         MAKE_ERROR(tefTOO_BIG,                     "Transaction affects too many items."),
         MAKE_ERROR(tefNO_TICKET,                   "Ticket is not in ledger."),
         MAKE_ERROR(tefNFTOKEN_IS_NOT_TRANSFERABLE, "The specified NFToken is not transferable."),
+        MAKE_ERROR(tefINVALID_LEDGER_FIX_TYPE,     "The LedgerFixType field has an invalid value."),
 
         MAKE_ERROR(telLOCAL_ERROR,            "Local failure."),
         MAKE_ERROR(telBAD_DOMAIN,             "Domain too long."),

src/libxrpl/protocol/TxFormats.cpp

@@ -539,6 +539,14 @@ TxFormats::TxFormats()
             {sfMPTokenHolder, soeOPTIONAL},
         },
         commonFields);
+
+    add(jss::LedgerStateFix,
+        ttLEDGER_STATE_FIX,
+        {
+            {sfLedgerFixType, soeREQUIRED},
+            {sfOwner, soeOPTIONAL},
+        },
+        commonFields);
 }
 
 TxFormats const&