Merge branch 'develop' into patch-ctid

.github/actions/build/action.yml

@@ -10,16 +10,12 @@ inputs:
 runs:
  using: composite
  steps:
- - name: dependencies
- uses: ./.github/actions/dependencies
- with:
- configuration: ${{ inputs.configuration }}
  - name: configure
  shell: bash
  run: |
  cd ${build_dir}
  cmake \
- ${{ inputs.generator && format('-G {0}', inputs.generator) || '' }} \
+ ${{ inputs.generator && format('-G "{0}"', inputs.generator) || '' }} \
  -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake \
  -DCMAKE_BUILD_TYPE=${{ inputs.configuration }} \
  ${{ inputs.cmake-args }} \

.github/pull_request_template.md

@@ -33,10 +33,27 @@ Please check [x] relevant options, delete irrelevant ones.
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] Refactor (non-breaking change that only restructures code)
-- [ ] Tests (You added tests for code that already exists, or your new feature included in this PR)
-- [ ] Documentation Updates
+- [ ] Tests (you added tests for code that already exists, or your new feature included in this PR)
+- [ ] Documentation update
+- [ ] Chore (no impact to binary, e.g. `.gitignore`, formatting, dropping support for older tooling)
 - [ ] Release
 
+### API Impact
+
+<!--
+Please check [x] relevant options, delete irrelevant ones.
+
+* If there is any impact to the public API methods (HTTP / WebSocket), please update https:/xrplf/rippled/blob/develop/API-CHANGELOG.md
+ * Update API-CHANGELOG.md and add the change directly in this PR by pushing to your PR branch.
+* libxrpl: See https:/XRPLF/rippled/blob/develop/docs/build/depend.md
+* Peer Protocol: See https://xrpl.org/peer-protocol.html
+-->
+
+- [ ] Public API: New feature (new methods and/or new fields)
+- [ ] Public API: Breaking change (in general, breaking changes should only impact the next api_version)
+- [ ] `libxrpl` change (any change that may affect `libxrpl` or dependents of `libxrpl`)
+- [ ] Peer protocol change (must be backward compatible or bump the peer protocol version)
+
 <!--
 ## Before / After
 If relevant, use this section for an English description of the change at a technical level.

.github/workflows/macos.yml

@@ -37,6 +37,10 @@ jobs:
  run : |
  conan profile get env.CXXFLAGS default || true
  conan profile update 'conf.tools.build:cxxflags+=["-DBOOST_ASIO_DISABLE_CONCEPTS"]' default
+ - name: dependencies
+ uses: ./.github/actions/dependencies
+ with:
+ configuration: ${{ matrix.configuration }}
  - name: build
  uses: ./.github/actions/build
  with:

.github/workflows/nix.yml

@@ -79,7 +79,7 @@ jobs:
  - name: try to authenticate to ripple Conan remote
  id: remote
  run: |
- echo outcome=$(conan user --remote ripple ${{ secrets.CONAN_USERNAME }} --password ${{ secrets.CONAN_TOKEN }} && echo success || echo failure) | tee ${GITHUB_OUTPUT}
+ echo outcome=$(conan user --remote ripple ${{ secrets.CONAN_USERNAME }} --password ${{ secrets.CONAN_TOKEN }} >&2 && echo success || echo failure) | tee ${GITHUB_OUTPUT}
  - name: archive profile
  # Create this archive before dependencies are added to the local cache.
  run: tar -czf conan.tar -C ~/.conan .
@@ -88,7 +88,7 @@ jobs:
  # Print the list of dependencies that would need to be built locally.
  # A non-empty list means we have "failed" to cache binaries remotely.
  run: |
- echo missing=$(conan info . --build missing --json 2>/dev/null | grep '^\[') | tee ${GITHUB_OUTPUT}
+ echo missing=$(conan info . --build missing --settings build_type=${{ matrix.configuration }} --json 2>/dev/null | grep '^\[') | tee ${GITHUB_OUTPUT}
  - name: build dependencies
  if: (steps.binaries.outputs.missing != '[]')
  uses: ./.github/actions/dependencies
@@ -146,6 +146,10 @@ jobs:
  ls ~/.conan
  - name: checkout
  uses: actions/checkout@v3
+ - name: dependencies
+ uses: ./.github/actions/dependencies
+ with:
+ configuration: ${{ matrix.configuration }}
  - name: build
  uses: ./.github/actions/build
  with:

.github/workflows/windows.yml

@@ -1,19 +1,11 @@
 name: windows
-# We have disabled this workflow because it fails in our CI Windows
-# environment, but we cannot replicate the failure in our personal Windows
-# test environments, nor have we gone through the trouble of setting up an
-# interactive CI Windows environment.
-# We welcome contributions to diagnose or debug the problems on Windows. Until
-# then, we leave this tombstone as a reminder that we have tried (but failed)
-# to write a reliable test for Windows.
-# on: [push, pull_request]
-on:
- workflow_dispatch:
- push:
- branches:
- - 'action'
- paths:
- - '.github/workflow/windows.yml'
+
+on: [push, pull_request]
+
+# https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
 
 jobs:
 
@@ -25,6 +17,11 @@ jobs:
  - Visual Studio 16 2019
  configuration:
  - Release
+ # Github hosted runners tend to hang when running Debug unit tests.
+ # Instead of trying to work around it, disable the Debug job until
+ # something beefier (i.e. a heavy self-hosted runner) becomes
+ # available.
+ # - Debug
  runs-on: windows-2019
  env:
  build_dir: .build
@@ -37,11 +34,12 @@ jobs:
  python-version: 3.9
  - name: learn Python cache directory
  id: pip-cache
+ shell: bash
  run: |
- pip install --upgrade pip
- echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+ python -m pip install --upgrade pip
+ echo "dir=$(pip cache dir)" | tee ${GITHUB_OUTPUT}
  - name: restore Python cache directory
- uses: actions/cache@v2
+ uses: actions/cache@v3
  with:
  path: ${{ steps.pip-cache.outputs.dir }}
  key: ${{ runner.os }}-${{ hashFiles('.github/workflows/windows.yml') }}
@@ -55,45 +53,48 @@ jobs:
  cmake --version
  dir env:
  - name: configure Conan
+ shell: bash
+ env:
+ CONAN_URL: http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod
  run: |
  conan profile new default --detect
- conan profile update settings.compiler.cppstd=20 default
- conan profile update settings.compiler.runtime=MT default
- conan profile update settings.compiler.toolset=v141 default
- - name: learn Conan cache directory
- id: conan-cache
- run: |
- echo "dir=$(conan config get storage.path)" >> $GITHUB_OUTPUT
- - name: restore Conan cache directory
- uses: actions/cache@v2
- with:
- path: ${{ steps.conan-cache.outputs.dir }}
- key: ${{ hashFiles('~/.conan/profiles/default', 'conanfile.py', 'external/rocksdb/*', '.github/workflows/windows.yml') }}
- - name: export custom recipes
+ conan profile update settings.compiler.runtime=MT${{ matrix.configuration == 'Debug' && 'd' || '' }} default
+ # 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: try to authenticate to ripple Conan remote
+ shell: bash
+ id: remote
  run: |
- conan export external/snappy snappy/1.1.9@
- conan export external/soci soci/4.0.3@
- - name: install dependencies
+ echo outcome=$(conan user --remote ripple ${{ secrets.CONAN_USERNAME }} \
+ --password ${{ secrets.CONAN_TOKEN }} >&2 && echo success || \
+ echo failure) | tee ${GITHUB_OUTPUT}
+ - name: list missing binaries
+ id: binaries
+ shell: bash
+ # Print the list of dependencies that would need to be built locally.
+ # A non-empty list means we have "failed" to cache binaries remotely.
  run: |
- mkdir $env:build_dir
- cd $env:build_dir
- conan install .. --build missing --settings build_type=${{ matrix.configuration }}
- - name: configure
- run: |
- $env:build_dir
- cd $env:build_dir
- pwd
- ls
- cmake `
- -G "${{ matrix.generator }}" `
- -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake `
- -Dassert=ON `
- -Dreporting=OFF `
- -Dunity=OFF `
- ..
+ echo missing=$(conan info . --build missing --settings build_type=${{ matrix.configuration }} --json 2>/dev/null | grep '^\[') | tee ${GITHUB_OUTPUT}
+ - name: build dependencies
+ uses: ./.github/actions/dependencies
+ with:
+ configuration: ${{ matrix.configuration }}
+ - name: upload dependencies to remote
+ if: (steps.binaries.outputs.missing != '[]') && (steps.remote.outputs.outcome == 'success')
+ run: conan upload --remote ripple '*' --all --parallel --confirm
  - name: build
+ uses: ./.github/actions/build
+ with:
+ generator: '${{ matrix.generator }}'
+ configuration: ${{ matrix.configuration }}
+ # Hard code for now. Move to the matrix if varied options are needed
+ cmake-args: '-Dassert=ON -Dreporting=OFF -Dunity=OFF'
+ - name: test (permitted to silently fail)
+ shell: bash
+ # Github runners are resource limited, which causes unit tests to fail
+ # (e.g. OOM). To allow forward progress until self-hosted runners are
+ # up and running reliably, allow the job to succeed even if tests fail.
+ continue-on-error: true
  run: |
- cmake --build $env:build_dir --target rippled --config ${{ matrix.configuration }} --parallel $env:NUMBER_OF_PROCESSORS
- - name: test
- run: |
- & "$env:build_dir\${{ matrix.configuration }}\rippled.exe" --unittest
+ ${build_dir}/${{ matrix.configuration }}/rippled --unittest --unittest-jobs $(nproc)

API-CHANGELOG.md

@@ -26,6 +26,14 @@ In `api_version: 2`, the `signer_lists` field [will be moved](#modifications-to-
 
 The `network_id` field was added in the `server_info` response in version 1.5.0 (2019), but it was not returned in [reporting mode](https://xrpl.org/rippled-server-modes.html#reporting-mode).
 
+## Unreleased
+
+### Additions
+
+Additions are intended to be non-breaking (because they are purely additive).
+
+- `server_definitions`: A new RPC that generates a `definitions.json`-like output that can be used in XRPL libraries.
+
 ## XRP Ledger version 1.12.0
 
 [Version 1.12.0](https:/XRPLF/rippled/releases/tag/1.12.0) was released on Sep 6, 2023.
@@ -46,27 +54,27 @@ Additions are intended to be non-breaking (because they are purely additive).
  - `Account`: The issuer of the asset being clawed back. Must also be the sender of the transaction.
  - `Amount`: The amount being clawed back, with the `Amount.issuer` being the token holder's address.
 - Adds [AMM](https:/XRPLF/XRPL-Standards/discussions/78) ([#4294](https:/XRPLF/rippled/pull/4294), [#4626](https:/XRPLF/rippled/pull/4626)) feature:
-  - Adds `amm_info` API to retrieve AMM information for a given tokens pair.
-  - Adds `AMMCreate` transaction type to create `AMM` instance.
-  - Adds `AMMDeposit` transaction type to deposit funds into `AMM` instance.
-  - Adds `AMMWithdraw` transaction type to withdraw funds from `AMM` instance.
-  - Adds `AMMVote` transaction type to vote for the trading fee of `AMM` instance.
-  - Adds `AMMBid` transaction type to bid for the Auction Slot of `AMM` instance.
-  - Adds `AMMDelete` transaction type to delete `AMM` instance.
-  - Adds `sfAMMID` to `AccountRoot` to indicate that the account is `AMM`'s account. `AMMID` is used to fetch `ltAMM`.
-  - Adds `lsfAMMNode` `TrustLine` flag to indicate that one side of the `TrustLine` is `AMM` account.
-  - Adds `tfLPToken`, `tfSingleAsset`, `tfTwoAsset`, `tfOneAssetLPToken`, `tfLimitLPToken`, `tfTwoAssetIfEmpty`,
-  `tfWithdrawAll`, `tfOneAssetWithdrawAll` which allow a trader to specify different fields combination 
-  for `AMMDeposit` and `AMMWithdraw` transactions.
-  - Adds new transaction result codes:
-  - tecUNFUNDED_AMM: insufficient balance to fund AMM. The account does not have funds for liquidity provision.
-  -  tecAMM_BALANCE: AMM has invalid balance. Calculated balances greater than the current pool balances.
-  -  tecAMM_FAILED: AMM transaction failed. Fails due to a processing failure.
-  -  tecAMM_INVALID_TOKENS: AMM invalid LP tokens. Invalid input values, format, or calculated values.
-  -  tecAMM_EMPTY: AMM is in empty state. Transaction expects AMM in non-empty state (LP tokens > 0).
-  -  tecAMM_NOT_EMPTY: AMM is not in empty state. Transaction expects AMM in empty state (LP tokens == 0).
-  -  tecAMM_ACCOUNT: AMM account. Clawback of AMM account.
-  -  tecINCOMPLETE: Some work was completed, but more submissions required to finish. AMMDelete partially deletes the trustlines.
+ - Adds `amm_info` API to retrieve AMM information for a given tokens pair.
+ - Adds `AMMCreate` transaction type to create `AMM` instance.
+ - Adds `AMMDeposit` transaction type to deposit funds into `AMM` instance.
+ - Adds `AMMWithdraw` transaction type to withdraw funds from `AMM` instance.
+ - Adds `AMMVote` transaction type to vote for the trading fee of `AMM` instance.
+ - Adds `AMMBid` transaction type to bid for the Auction Slot of `AMM` instance.
+ - Adds `AMMDelete` transaction type to delete `AMM` instance.
+ - Adds `sfAMMID` to `AccountRoot` to indicate that the account is `AMM`'s account. `AMMID` is used to fetch `ltAMM`.
+ - Adds `lsfAMMNode` `TrustLine` flag to indicate that one side of the `TrustLine` is `AMM` account.
+ - Adds `tfLPToken`, `tfSingleAsset`, `tfTwoAsset`, `tfOneAssetLPToken`, `tfLimitLPToken`, `tfTwoAssetIfEmpty`,
+ `tfWithdrawAll`, `tfOneAssetWithdrawAll` which allow a trader to specify different fields combination
+ for `AMMDeposit` and `AMMWithdraw` transactions.
+ - Adds new transaction result codes:
+ - tecUNFUNDED_AMM: insufficient balance to fund AMM. The account does not have funds for liquidity provision.
+ - tecAMM_BALANCE: AMM has invalid balance. Calculated balances greater than the current pool balances.
+ - tecAMM_FAILED: AMM transaction failed. Fails due to a processing failure.
+ - tecAMM_INVALID_TOKENS: AMM invalid LP tokens. Invalid input values, format, or calculated values.
+ - tecAMM_EMPTY: AMM is in empty state. Transaction expects AMM in non-empty state (LP tokens > 0).
+ - tecAMM_NOT_EMPTY: AMM is not in empty state. Transaction expects AMM in empty state (LP tokens == 0).
+ - tecAMM_ACCOUNT: AMM account. Clawback of AMM account.
+ - tecINCOMPLETE: Some work was completed, but more submissions required to finish. AMMDelete partially deletes the trustlines.
 
 ## XRP Ledger version 1.11.0
 
@@ -98,6 +106,17 @@ Additions are intended to be non-breaking (because they are purely additive).
 - Added `NFTokenPages` to the `account_objects` RPC. (https:/XRPLF/rippled/pull/4352)
 - Fixed: `marker` returned from the `account_lines` command would not work on subsequent commands. (https:/XRPLF/rippled/pull/4361)
 
+## XRP Ledger version 1.10.0
+
+[Version 1.10.0](https:/XRPLF/rippled/releases/tag/1.10.0)
+was released on Mar 14, 2023.
+
+### Breaking changes in 1.10
+
+- If the `XRPFees` feature is enabled, the `fee_ref` field will be
+ removed from the [ledger subscription stream](https://xrpl.org/subscribe.html#ledger-stream), because it will no longer
+ have any meaning.
+
 # In development
 
 Changes below this point are in development.
@@ -107,6 +126,7 @@ Changes below this point are in development.
 At the time of writing, this version is expected to be introduced in `rippled` version 2.0.
 
 Currently (prior to the release of 2.0), it is available as a "beta" version, meaning it can be enabled with a config setting in `rippled.cfg`:
+
 ```
 [beta_rpc_api]
 1

Builds/CMake/RippledCore.cmake

@@ -519,6 +519,7 @@ target_sources (rippled PRIVATE
  src/ripple/app/tx/impl/CreateTicket.cpp
  src/ripple/app/tx/impl/DeleteAccount.cpp
  src/ripple/app/tx/impl/DepositPreauth.cpp
+ src/ripple/app/tx/impl/DID.cpp
  src/ripple/app/tx/impl/Escrow.cpp
  src/ripple/app/tx/impl/InvariantCheck.cpp
  src/ripple/app/tx/impl/NFTokenAcceptOffer.cpp
@@ -785,6 +786,7 @@ if (tests)
  src/test/app/DeliverMin_test.cpp
  src/test/app/DepositAuth_test.cpp
  src/test/app/Discrepancy_test.cpp
+ src/test/app/DID_test.cpp
  src/test/app/DNS_test.cpp
  src/test/app/Escrow_test.cpp
  src/test/app/FeeVote_test.cpp
@@ -937,6 +939,7 @@ if (tests)
  src/test/jtx/impl/check.cpp
  src/test/jtx/impl/delivermin.cpp
  src/test/jtx/impl/deposit.cpp
+ src/test/jtx/impl/did.cpp
  src/test/jtx/impl/envconfig.cpp
  src/test/jtx/impl/fee.cpp
  src/test/jtx/impl/flags.cpp

cfg/rippled-example.cfg

@@ -389,6 +389,21 @@
 #
 #
 #
+# [compression]
+#
+# true or false
+#
+# 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 server automatically compresses communications with peer servers
+# that also have link compression enabled.
+# https://xrpl.org/enable-link-compression.html
+#
+#
+#
 # [ips]
 #
 # List of hostnames or ips where the Ripple protocol is served. A default

docs/build/conan.md

@@ -69,7 +69,7 @@ compiler and linker options for all dependencies _and_ this project.
 However, that is very tedious and error-prone, which is why we lean on tools
 like Conan.
 
-We have written a Conan configuration file ([`conanfile.py`](./conanfile.py))
+We have written a Conan configuration file ([`conanfile.py`](../../conanfile.py))
 so that Conan can be used to correctly download, configure, build, and install
 all of the dependencies for this project,
 using a single set of compiler and linker options for all of them.

src/ripple/app/main/Main.cpp

@@ -169,6 +169,7 @@ printHelp(const po::options_description& desc)
  " peer_reservations_list\n"
  " ripple ...\n"
  " ripple_path_find <json> [<ledger>]\n"
+ " server_definitions [<hash>]\n"
  " server_info [counters]\n"
  " server_state [counters]\n"
  " sign <private_key> <tx_json> [offline]\n"

src/ripple/app/paths/PathRequest.cpp

@@ -538,7 +538,6 @@ PathRequest::findPaths(
  continueCallback);
  if (!pathfinder)
  {
- assert(continueCallback && !continueCallback());
  JLOG(m_journal.debug()) << iIdentifier << " No paths found";
  continue;
  }