diff --git a/.clang-format b/.clang-format index ca8edf678f..b6089a2cd4 100644 --- a/.clang-format +++ b/.clang-format @@ -50,20 +50,21 @@ ForEachMacros: [Q_FOREACH, BOOST_FOREACH] IncludeBlocks: Regroup IncludeCategories: - Regex: "^<(test)/" - Priority: 0 - - Regex: "^<(xrpld)/" Priority: 1 - - Regex: "^<(xrpl)/" + - Regex: "^<(xrpld)/" Priority: 2 - - Regex: "^<(boost)/" + - Regex: "^<(xrpl)/" Priority: 3 - - Regex: "^.*/" + - Regex: "^<(boost)/" Priority: 4 - - Regex: '^.*\.h' + - Regex: "^.*/" Priority: 5 - - Regex: ".*" + - Regex: '^.*\.h' Priority: 6 + - Regex: ".*" + Priority: 7 IncludeIsMainRegex: "$" +MainIncludeChar: AngleBracket IndentCaseLabels: true IndentFunctionDeclarationAfterType: false IndentRequiresClause: true diff --git a/.clang-tidy b/.clang-tidy index 36b59f43e3..10aa8c625f 100644 --- a/.clang-tidy +++ b/.clang-tidy @@ -10,26 +10,26 @@ Checks: "-*, bugprone-chained-comparison, bugprone-compare-pointer-to-member-virtual-function, bugprone-copy-constructor-init, - # bugprone-crtp-constructor-accessibility, # has issues + bugprone-crtp-constructor-accessibility, bugprone-dangling-handle, bugprone-dynamic-static-initializers, - # bugprone-empty-catch, # has issues + bugprone-empty-catch, bugprone-fold-init-type, - # bugprone-forward-declaration-namespace, # has issues - # bugprone-inaccurate-erase, - # bugprone-inc-dec-in-conditions, - # bugprone-incorrect-enable-if, - # bugprone-incorrect-roundings, - # bugprone-infinite-loop, - # bugprone-integer-division, + bugprone-forward-declaration-namespace, + bugprone-inaccurate-erase, + bugprone-inc-dec-in-conditions, + bugprone-incorrect-enable-if, + bugprone-incorrect-roundings, + bugprone-infinite-loop, + bugprone-integer-division, bugprone-lambda-function-name, - # bugprone-macro-parentheses, # has issues + bugprone-macro-parentheses, bugprone-macro-repeated-side-effects, bugprone-misplaced-operator-in-strlen-in-alloc, bugprone-misplaced-pointer-arithmetic-in-alloc, bugprone-misplaced-widening-cast, bugprone-move-forwarding-reference, - # bugprone-multi-level-implicit-pointer-conversion, # has issues + bugprone-multi-level-implicit-pointer-conversion, bugprone-multiple-new-in-one-expression, bugprone-multiple-statement-macro, bugprone-no-escape, @@ -39,13 +39,13 @@ Checks: "-*, bugprone-pointer-arithmetic-on-polymorphic-object, bugprone-posix-return, bugprone-redundant-branch-condition, - # bugprone-reserved-identifier, # has issues - # bugprone-return-const-ref-from-parameter, # has issues + bugprone-reserved-identifier, + bugprone-return-const-ref-from-parameter, bugprone-shared-ptr-array-mismatch, bugprone-signal-handler, bugprone-signed-char-misuse, bugprone-sizeof-container, - # bugprone-sizeof-expression, # has issues + bugprone-sizeof-expression, bugprone-spuriously-wake-up-functions, bugprone-standalone-empty, bugprone-string-constructor, @@ -62,7 +62,7 @@ Checks: "-*, bugprone-suspicious-string-compare, bugprone-suspicious-stringview-data-usage, bugprone-swapped-arguments, - # bugprone-switch-missing-default-case, # has issues + bugprone-switch-missing-default-case, bugprone-terminating-continue, bugprone-throw-keyword-missing, bugprone-too-small-loop-variable, @@ -73,30 +73,34 @@ Checks: "-*, bugprone-unhandled-self-assignment, bugprone-unique-ptr-array-mismatch, bugprone-unsafe-functions, - # bugprone-use-after-move, # has issues + bugprone-use-after-move, # has issues bugprone-unused-raii, bugprone-unused-return-value, bugprone-unused-local-non-trivial-variable, bugprone-virtual-near-miss, - # cppcoreguidelines-init-variables, # has issues - # cppcoreguidelines-misleading-capture-default-by-value, # has issues + cppcoreguidelines-init-variables, + cppcoreguidelines-misleading-capture-default-by-value, cppcoreguidelines-no-suspend-with-lock, - # cppcoreguidelines-pro-type-member-init, # has issues + cppcoreguidelines-pro-type-member-init, cppcoreguidelines-pro-type-static-cast-downcast, - # cppcoreguidelines-rvalue-reference-param-not-moved, # has issues - # cppcoreguidelines-use-default-member-init, # has issues - # cppcoreguidelines-virtual-class-destructor, # has issues + cppcoreguidelines-rvalue-reference-param-not-moved, + cppcoreguidelines-use-default-member-init, + cppcoreguidelines-virtual-class-destructor, hicpp-ignored-remove-result, - # misc-definitions-in-headers, # has issues + misc-const-correctness, + misc-definitions-in-headers, misc-header-include-cycle, + misc-include-cleaner, misc-misplaced-const, + misc-redundant-expression, misc-static-assert, - # misc-throw-by-value-catch-by-reference, # has issues + misc-throw-by-value-catch-by-reference, misc-unused-alias-decls, misc-unused-using-decls, modernize-deprecated-headers, modernize-make-shared, modernize-make-unique, + llvm-namespace-comment, performance-faster-string-find, performance-for-range-copy, performance-implicit-conversion-in-loop, @@ -105,40 +109,35 @@ Checks: "-*, performance-move-constructor-init, performance-no-automatic-move, performance-trivially-destructible, - # readability-avoid-nested-conditional-operator, # has issues - # readability-avoid-return-with-void-value, # has issues - # readability-braces-around-statements, # has issues - # readability-const-return-type, # has issues - # readability-container-contains, # has issues - # readability-container-size-empty, # has issues - # readability-convert-member-functions-to-static, # has issues + readability-avoid-nested-conditional-operator, + readability-avoid-return-with-void-value, + readability-braces-around-statements, + readability-const-return-type, + readability-container-contains, + readability-container-size-empty, + readability-convert-member-functions-to-static, readability-duplicate-include, - # readability-else-after-return, # has issues - # readability-enum-initial-value, # has issues - # readability-implicit-bool-conversion, # has issues - # readability-make-member-function-const, # has issues - # readability-math-missing-parentheses, # has issues + readability-else-after-return, + readability-enum-initial-value, + readability-implicit-bool-conversion, + readability-make-member-function-const, + readability-math-missing-parentheses, readability-misleading-indentation, readability-non-const-parameter, - # readability-redundant-casting, # has issues - # readability-redundant-declaration, # has issues - # readability-redundant-inline-specifier, # has issues - # readability-redundant-member-init, # has issues + readability-redundant-casting, + readability-redundant-declaration, + readability-redundant-inline-specifier, + readability-redundant-member-init, readability-redundant-string-init, readability-reference-to-constructed-temporary, - # readability-simplify-boolean-expr, # has issues - # readability-static-definition-in-anonymous-namespace, # has issues - # readability-suspicious-call-argument, # has issues + readability-simplify-boolean-expr, + readability-static-definition-in-anonymous-namespace, + readability-suspicious-call-argument, readability-use-std-min-max " # --- # other checks that have issues that need to be resolved: # -# llvm-namespace-comment, -# misc-const-correctness, -# misc-include-cleaner, -# misc-redundant-expression, -# # readability-inconsistent-declaration-parameter-name, # in this codebase this check will break a lot of arg names # readability-static-accessed-through-instance, # this check is probably unnecessary. it makes the code less readable # readability-identifier-naming, # https://github.com/XRPLF/rippled/pull/6571 @@ -194,7 +193,7 @@ CheckOptions: # readability-identifier-naming.FunctionIgnoredRegexp: ".*tag_invoke.*" bugprone-unsafe-functions.ReportMoreUnsafeFunctions: true bugprone-unused-return-value.CheckedReturnTypes: ::std::error_code;::std::error_condition;::std::errc -# misc-include-cleaner.IgnoreHeaders: '.*/(detail|impl)/.*;.*(expected|unexpected).*;.*ranges_lower_bound\.h;time.h;stdlib.h;__chrono/.*;fmt/chrono.h;boost/uuid/uuid_hash.hpp' + misc-include-cleaner.IgnoreHeaders: ".*/(detail|impl)/.*;.*fwd\\.h(pp)?;time.h;stdlib.h;sqlite3.h;netinet/in\\.h;sys/resource\\.h;sys/sysinfo\\.h;linux/sysinfo\\.h;__chrono/.*;bits/.*;_abort\\.h;boost/uuid/uuid_hash.hpp;boost/beast/core/flat_buffer\\.hpp;boost/beast/http/field\\.hpp;boost/beast/http/dynamic_body\\.hpp;boost/beast/http/message\\.hpp;boost/beast/http/read\\.hpp;boost/beast/http/write\\.hpp;openssl/obj_mac\\.h" # HeaderFilterRegex: '^.*/(test|xrpl|xrpld)/.*\.(h|hpp)$' ExcludeHeaderFilterRegex: '^.*/protocol_autogen/.*\.(h|hpp)$' diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 967b3c1817..05e87d16e0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: Feature Request -about: Suggest a new feature for the rippled project -title: "[Title with short description] (Version: [rippled version])" +about: Suggest a new feature for the xrpld project +title: "[Title with short description] (Version: [xrpld version])" labels: Feature Request assignees: "" --- diff --git a/.github/scripts/check-pr-description.py b/.github/scripts/check-pr-description.py new file mode 100644 index 0000000000..36abb0f5a4 --- /dev/null +++ b/.github/scripts/check-pr-description.py @@ -0,0 +1,85 @@ +#!/usr/bin/env python3 + +""" +Checks that a pull request description has been customized from the +pull_request_template.md. Exits with code 1 if the description is empty +or identical to the template (ignoring HTML comments and whitespace). + +Usage: + python check-pr-description.py --template-file TEMPLATE --pr-body-file BODY +""" + +import argparse +import re +import sys +from pathlib import Path + + +def normalize(text: str) -> str: + """Strip HTML comments, trim lines, and remove blank lines.""" + # Remove HTML comments (possibly multi-line) + text = re.sub(r"", "", text, flags=re.DOTALL) + # Strip each line and drop empties + lines = [line.strip() for line in text.splitlines()] + lines = [line for line in lines if line] + return "\n".join(lines) + + +def main() -> int: + parser = argparse.ArgumentParser( + description="Check that a PR description differs from the template." + ) + parser.add_argument( + "--template-file", + type=Path, + required=True, + help="Path to the pull request template file.", + ) + parser.add_argument( + "--pr-body-file", + type=Path, + required=True, + help="Path to a file containing the PR body text.", + ) + args = parser.parse_args() + + template_path: Path = args.template_file + pr_body_path: Path = args.pr_body_file + + if not template_path.is_file(): + print(f"::error::Template file {template_path} not found") + return 1 + + if not pr_body_path.is_file(): + print(f"::error::PR body file {pr_body_path} not found") + return 1 + + template = template_path.read_text(encoding="utf-8") + pr_body = pr_body_path.read_text(encoding="utf-8") + + # Check if the PR body is empty or whitespace-only + if not pr_body.strip(): + print( + "::error::PR description is empty. " + "Please fill in the pull request template." + ) + return 1 + + norm_template = normalize(template) + norm_pr_body = normalize(pr_body) + + if norm_pr_body == norm_template: + print( + "::error::PR description (ignoring HTML comments) is identical" + " to the template. Please fill in the details of your change." + f"\n\nVisible template content:\n---\n{norm_template}\n---" + f"\n\nVisible PR description content:\n---\n{norm_pr_body}\n---" + ) + return 1 + + print("PR description has been customized from the template.") + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/.github/scripts/levelization/README.md b/.github/scripts/levelization/README.md index 25eb52f079..f657344827 100644 --- a/.github/scripts/levelization/README.md +++ b/.github/scripts/levelization/README.md @@ -1,14 +1,14 @@ # Levelization -Levelization is the term used to describe efforts to prevent rippled from +Levelization is the term used to describe efforts to prevent xrpld from having or creating cyclic dependencies. -rippled code is organized into directories under `src/xrpld`, `src/libxrpl` (and +xrpld code is organized into directories under `src/xrpld`, `src/libxrpl` (and `src/test`) representing modules. The modules are intended to be organized into "tiers" or "levels" such that a module from one level can only include code from lower levels. Additionally, a module in one level should never include code in an `impl` or `detail` folder of any level -other than it's own. +other than its own. The codebase is split into two main areas: @@ -22,7 +22,7 @@ levelization violations they find (by moving files or individual classes). At the very least, don't make things worse. The table below summarizes the _desired_ division of modules, based on the current -state of the rippled code. The levels are numbered from +state of the xrpld code. The levels are numbered from the bottom up with the lower level, lower numbered, more independent modules listed first, and the higher level, higher numbered modules with more dependencies listed later. @@ -72,10 +72,10 @@ that `test` code should _never_ be included in `xrpl` or `xrpld` code.) The [levelization](generate.py) 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. +as long as it is in the expected location in the xrpld repo. It can be run at any time from within a checked out repo, and will do an analysis of all the `#include`s in -the rippled source. The only caveat is that it runs much slower +the xrpld source. The only caveat is that it runs much slower under Windows than in Linux. It hasn't yet been tested under MacOS. It generates many files of [results](results): diff --git a/.github/scripts/levelization/results/loops.txt b/.github/scripts/levelization/results/loops.txt index 7914704f9d..fb449441e3 100644 --- a/.github/scripts/levelization/results/loops.txt +++ b/.github/scripts/levelization/results/loops.txt @@ -2,19 +2,19 @@ Loop: test.jtx test.toplevel test.toplevel > test.jtx Loop: test.jtx test.unit_test - test.unit_test == test.jtx + test.unit_test ~= test.jtx Loop: xrpld.app xrpld.overlay - xrpld.overlay ~= xrpld.app + xrpld.app > xrpld.overlay Loop: xrpld.app xrpld.peerfinder - xrpld.peerfinder == xrpld.app + xrpld.peerfinder ~= xrpld.app Loop: xrpld.app xrpld.rpc xrpld.rpc > xrpld.app Loop: xrpld.app xrpld.shamap - xrpld.shamap ~= xrpld.app + xrpld.shamap > xrpld.app Loop: xrpld.overlay xrpld.rpc xrpld.rpc ~= xrpld.overlay diff --git a/.github/scripts/levelization/results/ordering.txt b/.github/scripts/levelization/results/ordering.txt index 38e77dedf8..02a14a0077 100644 --- a/.github/scripts/levelization/results/ordering.txt +++ b/.github/scripts/levelization/results/ordering.txt @@ -3,13 +3,17 @@ libxrpl.conditions > xrpl.basics libxrpl.conditions > xrpl.conditions libxrpl.core > xrpl.basics libxrpl.core > xrpl.core +libxrpl.core > xrpl.json libxrpl.crypto > xrpl.basics libxrpl.json > xrpl.basics libxrpl.json > xrpl.json libxrpl.ledger > xrpl.basics libxrpl.ledger > xrpl.json libxrpl.ledger > xrpl.ledger +libxrpl.ledger > xrpl.nodestore libxrpl.ledger > xrpl.protocol +libxrpl.ledger > xrpl.server +libxrpl.ledger > xrpl.shamap libxrpl.net > xrpl.basics libxrpl.net > xrpl.net libxrpl.nodestore > xrpl.basics @@ -19,19 +23,22 @@ libxrpl.nodestore > xrpl.protocol libxrpl.protocol > xrpl.basics libxrpl.protocol > xrpl.json libxrpl.protocol > xrpl.protocol -libxrpl.protocol_autogen > xrpl.protocol_autogen libxrpl.rdb > xrpl.basics libxrpl.rdb > xrpl.core libxrpl.rdb > xrpl.rdb libxrpl.resource > xrpl.basics libxrpl.resource > xrpl.json +libxrpl.resource > xrpl.protocol libxrpl.resource > xrpl.resource libxrpl.server > xrpl.basics +libxrpl.server > xrpl.core libxrpl.server > xrpl.json libxrpl.server > xrpl.protocol libxrpl.server > xrpl.rdb +libxrpl.server > xrpl.resource libxrpl.server > xrpl.server libxrpl.shamap > xrpl.basics +libxrpl.shamap > xrpl.nodestore libxrpl.shamap > xrpl.protocol libxrpl.shamap > xrpl.shamap libxrpl.tx > xrpl.basics @@ -43,12 +50,11 @@ libxrpl.tx > xrpl.protocol libxrpl.tx > xrpl.server libxrpl.tx > xrpl.tx test.app > test.jtx -test.app > test.rpc -test.app > test.toplevel test.app > test.unit_test test.app > xrpl.basics test.app > xrpl.core test.app > xrpld.app +test.app > xrpld.consensus test.app > xrpld.core test.app > xrpld.overlay test.app > xrpld.rpc @@ -56,9 +62,9 @@ test.app > xrpl.json test.app > xrpl.ledger test.app > xrpl.nodestore test.app > xrpl.protocol -test.app > xrpl.rdb test.app > xrpl.resource test.app > xrpl.server +test.app > xrpl.shamap test.app > xrpl.tx test.basics > test.jtx test.basics > test.unit_test @@ -71,16 +77,17 @@ test.beast > xrpl.basics test.conditions > xrpl.basics test.conditions > xrpl.conditions test.consensus > test.csf +test.consensus > test.jtx test.consensus > test.toplevel test.consensus > test.unit_test test.consensus > xrpl.basics test.consensus > xrpld.app test.consensus > xrpld.consensus -test.consensus > xrpl.json test.consensus > xrpl.ledger +test.consensus > xrpl.protocol +test.consensus > xrpl.shamap test.consensus > xrpl.tx test.core > test.jtx -test.core > test.toplevel test.core > test.unit_test test.core > xrpl.basics test.core > xrpl.core @@ -108,27 +115,32 @@ test.jtx > xrpl.resource test.jtx > xrpl.server test.jtx > xrpl.tx test.ledger > test.jtx -test.ledger > test.toplevel test.ledger > xrpl.basics +test.ledger > xrpl.core +test.ledger > xrpld.app test.ledger > xrpld.core +test.ledger > xrpl.json test.ledger > xrpl.ledger test.ledger > xrpl.protocol test.nodestore > test.jtx -test.nodestore > test.toplevel test.nodestore > test.unit_test test.nodestore > xrpl.basics +test.nodestore > xrpld.core test.nodestore > xrpl.nodestore +test.nodestore > xrpl.protocol test.nodestore > xrpl.rdb test.overlay > test.jtx -test.overlay > test.toplevel test.overlay > test.unit_test test.overlay > xrpl.basics test.overlay > xrpld.app +test.overlay > xrpld.core test.overlay > xrpld.overlay test.overlay > xrpld.peerfinder -test.overlay > xrpl.ledger +test.overlay > xrpl.json test.overlay > xrpl.nodestore test.overlay > xrpl.protocol +test.overlay > xrpl.resource +test.overlay > xrpl.server test.overlay > xrpl.shamap test.peerfinder > test.beast test.peerfinder > test.unit_test @@ -136,7 +148,7 @@ test.peerfinder > xrpl.basics test.peerfinder > xrpld.core test.peerfinder > xrpld.peerfinder test.peerfinder > xrpl.protocol -test.protocol > test.toplevel +test.protocol > test.jtx test.protocol > test.unit_test test.protocol > xrpl.basics test.protocol > xrpl.json @@ -145,7 +157,6 @@ test.resource > test.unit_test test.resource > xrpl.basics test.resource > xrpl.resource test.rpc > test.jtx -test.rpc > test.toplevel test.rpc > xrpl.basics test.rpc > xrpl.core test.rpc > xrpld.app @@ -159,13 +170,12 @@ test.rpc > xrpl.resource test.rpc > xrpl.server test.rpc > xrpl.tx test.server > test.jtx -test.server > test.toplevel test.server > test.unit_test test.server > xrpl.basics test.server > xrpld.app test.server > xrpld.core -test.server > xrpld.rpc test.server > xrpl.json +test.server > xrpl.protocol test.server > xrpl.server test.shamap > test.unit_test test.shamap > xrpl.basics @@ -239,19 +249,20 @@ xrpld.consensus > xrpl.ledger xrpld.consensus > xrpl.protocol xrpld.core > xrpl.basics xrpld.core > xrpl.core -xrpld.core > xrpl.json xrpld.core > xrpl.net xrpld.core > xrpl.protocol xrpld.core > xrpl.rdb xrpld.overlay > xrpl.basics xrpld.overlay > xrpl.core +xrpld.overlay > xrpld.consensus xrpld.overlay > xrpld.core xrpld.overlay > xrpld.peerfinder xrpld.overlay > xrpl.json +xrpld.overlay > xrpl.ledger xrpld.overlay > xrpl.protocol -xrpld.overlay > xrpl.rdb xrpld.overlay > xrpl.resource xrpld.overlay > xrpl.server +xrpld.overlay > xrpl.shamap xrpld.overlay > xrpl.tx xrpld.peerfinder > xrpl.basics xrpld.peerfinder > xrpld.core @@ -261,6 +272,7 @@ xrpld.perflog > xrpl.basics xrpld.perflog > xrpl.core xrpld.perflog > xrpld.rpc xrpld.perflog > xrpl.json +xrpld.perflog > xrpl.protocol xrpld.rpc > xrpl.basics xrpld.rpc > xrpl.core xrpld.rpc > xrpld.core @@ -272,5 +284,9 @@ xrpld.rpc > xrpl.protocol xrpld.rpc > xrpl.rdb xrpld.rpc > xrpl.resource xrpld.rpc > xrpl.server +xrpld.rpc > xrpl.shamap xrpld.rpc > xrpl.tx +xrpld.shamap > xrpl.basics +xrpld.shamap > xrpld.core +xrpld.shamap > xrpl.protocol xrpld.shamap > xrpl.shamap diff --git a/.github/scripts/rename/README.md b/.github/scripts/rename/README.md index cc004a335f..ab685bb0c3 100644 --- a/.github/scripts/rename/README.md +++ b/.github/scripts/rename/README.md @@ -34,6 +34,8 @@ run from the repository root. 6. `.github/scripts/rename/config.sh`: This script will rename the config from `rippled.cfg` to `xrpld.cfg`, and updating the code accordingly. The old filename will still be accepted. +7. `.github/scripts/rename/docs.sh`: This script will rename any lingering + references of `ripple(d)` to `xrpl(d)` in code, comments, and documentation. You can run all these scripts from the repository root as follows: @@ -44,4 +46,5 @@ You can run all these scripts from the repository root as follows: ./.github/scripts/rename/binary.sh . ./.github/scripts/rename/namespace.sh . ./.github/scripts/rename/config.sh . +./.github/scripts/rename/docs.sh . ``` diff --git a/.github/scripts/rename/binary.sh b/.github/scripts/rename/binary.sh index deb4dd5fb4..81d48ce94b 100755 --- a/.github/scripts/rename/binary.sh +++ b/.github/scripts/rename/binary.sh @@ -29,7 +29,7 @@ if [ ! -d "${DIRECTORY}" ]; then echo "Error: Directory '${DIRECTORY}' does not exist." exit 1 fi -pushd ${DIRECTORY} +pushd "${DIRECTORY}" # Remove the binary name override added by the cmake.sh script. ${SED_COMMAND} -z -i -E 's@\s+# For the time being.+"rippled"\)@@' cmake/XrplCore.cmake @@ -49,6 +49,7 @@ ${SED_COMMAND} -i -E 's@ripple/xrpld@XRPLF/rippled@g' BUILD.md ${SED_COMMAND} -i -E 's@XRPLF/xrpld@XRPLF/rippled@g' BUILD.md ${SED_COMMAND} -i -E 's@xrpld \(`xrpld`\)@xrpld@g' BUILD.md ${SED_COMMAND} -i -E 's@XRPLF/xrpld@XRPLF/rippled@g' CONTRIBUTING.md +${SED_COMMAND} -i -E 's@XRPLF/xrpld@XRPLF/rippled@g' docs/build/install.md popd echo "Processing complete." diff --git a/.github/scripts/rename/cmake.sh b/.github/scripts/rename/cmake.sh index 0f88fa5de2..6c3d30e948 100755 --- a/.github/scripts/rename/cmake.sh +++ b/.github/scripts/rename/cmake.sh @@ -38,7 +38,7 @@ if [ ! -d "${DIRECTORY}" ]; then echo "Error: Directory '${DIRECTORY}' does not exist." exit 1 fi -pushd ${DIRECTORY} +pushd "${DIRECTORY}" # Rename the files. find cmake -type f -name 'Rippled*.cmake' -exec bash -c 'mv "${1}" "${1/Rippled/Xrpl}"' - {} \; diff --git a/.github/scripts/rename/config.sh b/.github/scripts/rename/config.sh index f6e914f502..9a521e8a51 100755 --- a/.github/scripts/rename/config.sh +++ b/.github/scripts/rename/config.sh @@ -28,7 +28,7 @@ if [ ! -d "${DIRECTORY}" ]; then echo "Error: Directory '${DIRECTORY}' does not exist." exit 1 fi -pushd ${DIRECTORY} +pushd "${DIRECTORY}" # Add the xrpld.cfg to the .gitignore. if ! grep -q 'xrpld.cfg' .gitignore; then @@ -52,16 +52,15 @@ for DIRECTORY in "${DIRECTORIES[@]}"; do find "${DIRECTORY}" -type f \( -name "*.h" -o -name "*.hpp" -o -name "*.ipp" -o -name "*.cpp" -o -name "*.cmake" -o -name "*.txt" -o -name "*.cfg" -o -name "*.md" \) | while read -r FILE; do echo "Processing file: ${FILE}" ${SED_COMMAND} -i -E 's/rippled(-example)?[ .]cfg/xrpld\1.cfg/g' "${FILE}" + ${SED_COMMAND} -i 's/rippleConfig/xrpldConfig/g' "${FILE}" done done ${SED_COMMAND} -i 's/rippled/xrpld/g' cfg/xrpld-example.cfg ${SED_COMMAND} -i 's/rippled/xrpld/g' src/test/core/Config_test.cpp ${SED_COMMAND} -i 's/ripplevalidators/xrplvalidators/g' src/test/core/Config_test.cpp # cspell: disable-line -${SED_COMMAND} -i 's/rippleConfig/xrpldConfig/g' src/test/core/Config_test.cpp ${SED_COMMAND} -i 's@ripple/@xrpld/@g' src/test/core/Config_test.cpp ${SED_COMMAND} -i 's/Rippled/File/g' src/test/core/Config_test.cpp - # Restore the old config file name in the code that maintains support for now. ${SED_COMMAND} -i 's/configLegacyName = "xrpld.cfg"/configLegacyName = "rippled.cfg"/g' src/xrpld/core/detail/Config.cpp diff --git a/.github/scripts/rename/copyright.sh b/.github/scripts/rename/copyright.sh index c5a9fb2cd3..f212fe5fc7 100755 --- a/.github/scripts/rename/copyright.sh +++ b/.github/scripts/rename/copyright.sh @@ -31,7 +31,7 @@ if [ ! -d "${DIRECTORY}" ]; then echo "Error: Directory '${DIRECTORY}' does not exist." exit 1 fi -pushd ${DIRECTORY} +pushd "${DIRECTORY}" # Prevent sed and echo from removing newlines and tabs in string literals by # temporarily replacing them with placeholders. This only affects one file. @@ -76,11 +76,11 @@ fi if ! grep -q 'Dev Null' src/test/rpc/ValidatorInfo_test.cpp; then echo -e "// Copyright (c) 2020 Dev Null Productions\n\n$(cat src/test/rpc/ValidatorInfo_test.cpp)" > src/test/rpc/ValidatorInfo_test.cpp fi -if ! grep -q 'Dev Null' src/xrpld/rpc/handlers/DoManifest.cpp; then - echo -e "// Copyright (c) 2019 Dev Null Productions\n\n$(cat src/xrpld/rpc/handlers/DoManifest.cpp)" > src/xrpld/rpc/handlers/DoManifest.cpp +if ! grep -q 'Dev Null' src/xrpld/rpc/handlers/server_info/Manifest.cpp; then + echo -e "// Copyright (c) 2019 Dev Null Productions\n\n$(cat src/xrpld/rpc/handlers/server_info/Manifest.cpp)" > src/xrpld/rpc/handlers/server_info/Manifest.cpp fi -if ! grep -q 'Dev Null' src/xrpld/rpc/handlers/ValidatorInfo.cpp; then - echo -e "// Copyright (c) 2019 Dev Null Productions\n\n$(cat src/xrpld/rpc/handlers/ValidatorInfo.cpp)" > src/xrpld/rpc/handlers/ValidatorInfo.cpp +if ! grep -q 'Dev Null' src/xrpld/rpc/handlers/admin/status/ValidatorInfo.cpp; then + echo -e "// Copyright (c) 2019 Dev Null Productions\n\n$(cat src/xrpld/rpc/handlers/admin/status/ValidatorInfo.cpp)" > src/xrpld/rpc/handlers/admin/status/ValidatorInfo.cpp fi if ! grep -q 'Bougalis' include/xrpl/basics/SlabAllocator.h; then echo -e "// Copyright (c) 2022, Nikolaos D. Bougalis \n\n$(cat include/xrpl/basics/SlabAllocator.h)" > include/xrpl/basics/SlabAllocator.h # cspell: ignore Nikolaos Bougalis nikb diff --git a/.github/scripts/rename/docs.sh b/.github/scripts/rename/docs.sh new file mode 100755 index 0000000000..22d5e242d1 --- /dev/null +++ b/.github/scripts/rename/docs.sh @@ -0,0 +1,96 @@ +#!/bin/bash + +# Exit the script as soon as an error occurs. +set -e + +# On MacOS, ensure that GNU sed is installed and available as `gsed`. +SED_COMMAND=sed +if [[ "${OSTYPE}" == 'darwin'* ]]; then + if ! command -v gsed &> /dev/null; then + echo "Error: gsed is not installed. Please install it using 'brew install gnu-sed'." + exit 1 + fi + SED_COMMAND=gsed +fi + +# This script renames all remaining references to `ripple` and `rippled` to +# `xrpl` and `xrpld`, respectively, in code, comments, and documentation. +# Usage: .github/scripts/rename/docs.sh + +if [ "$#" -ne 1 ]; then + echo "Usage: $0 " + exit 1 +fi + +DIRECTORY=$1 +echo "Processing directory: ${DIRECTORY}" +if [ ! -d "${DIRECTORY}" ]; then + echo "Error: Directory '${DIRECTORY}' does not exist." + exit 1 +fi +pushd "${DIRECTORY}" + +find . -type f \( -name "*.h" -o -name "*.hpp" -o -name "*.ipp" -o -name "*.cpp" -o -name "*.txt" -o -name "*.cfg" -o -name "*.md" -o -name "*.proto" \) -not -path "./.github/scripts/*" | while read -r FILE; do + echo "Processing file: ${FILE}" + ${SED_COMMAND} -i 's/rippleLockEscrowMPT/lockEscrowMPT/g' "${FILE}" + ${SED_COMMAND} -i 's/rippleUnlockEscrowMPT/unlockEscrowMPT/g' "${FILE}" + ${SED_COMMAND} -i 's/rippleCredit/directSendNoFee/g' "${FILE}" + ${SED_COMMAND} -i 's/rippleSend/directSendNoLimit/g' "${FILE}" + ${SED_COMMAND} -i -E 's@([^/+-])rippled@\1xrpld@g' "${FILE}" + ${SED_COMMAND} -i -E 's@([^/+-])Rippled@\1Xrpld@g' "${FILE}" + ${SED_COMMAND} -i -E 's/^rippled/xrpld/g' "${FILE}" + ${SED_COMMAND} -i -E 's/^Rippled/Xrpld/g' "${FILE}" + # cspell: disable + ${SED_COMMAND} -i -E 's/(r|R)ipple (a|A)ddress/XRPL address/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (a|A)ccount/XRPL account/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (a|A)lgorithm/XRPL algorithm/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (c|C)lient/XRPL client/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (c|C)luster/XRPL cluster/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (c|C)onsensus/XRPL consensus/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (d|D)efault/XRPL default/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (e|E)poch/XRPL epoch/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (f|F)eature/XRPL feature/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (n|N)etwork/XRPL network/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (p|P)ayment/XRPL payment/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (p|P)rotocol/XRPL protocol/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (r|R)epository/XRPL repository/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple RPC/XRPL RPC/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (s|S)erialization/XRPL serialization/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (s|S)erver/XRPL server/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (s|S)pecific/XRPL specific/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple Source/XRPL Source/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (t|T)imestamp/XRPL timestamp/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple uses the consensus/XRPL uses the consensus/g' "${FILE}" + ${SED_COMMAND} -i -E 's/(r|R)ipple (v|V)alidator/XRPL validator/g' "${FILE}" + # cspell: enable + ${SED_COMMAND} -i 's/RippleLib/XrplLib/g' "${FILE}" + ${SED_COMMAND} -i 's/ripple-lib/XrplLib/g' "${FILE}" + ${SED_COMMAND} -i 's@opt/ripple/@opt/xrpld/@g' "${FILE}" + ${SED_COMMAND} -i 's@src/ripple/@src/xrpld/@g' "${FILE}" + ${SED_COMMAND} -i 's@ripple/app/@xrpld/app/@g' "${FILE}" + ${SED_COMMAND} -i 's@github.com/ripple/rippled@github.com/XRPLF/rippled@g' "${FILE}" + ${SED_COMMAND} -i 's/\ba xrpl/an xrpl/g' "${FILE}" + ${SED_COMMAND} -i 's/\ba XRPL/an XRPL/g' "${FILE}" +done +${SED_COMMAND} -i 's/ripple_libs/xrpl_libs/' BUILD.md +${SED_COMMAND} -i 's/Ripple integrators/XRPL developers/' README.md +${SED_COMMAND} -i 's/sanitizer-configuration-for-rippled/sanitizer-configuration-for-xrpld/' docs/build/sanitizers.md +${SED_COMMAND} -i 's/rippled/xrpld/g' .github/scripts/levelization/README.md +${SED_COMMAND} -i 's/rippled/xrpld/g' .github/scripts/strategy-matrix/generate.py +${SED_COMMAND} -i 's@/rippled@/xrpld@g' docs/build/install.md +${SED_COMMAND} -i 's@github.com/XRPLF/xrpld@github.com/XRPLF/rippled@g' docs/build/install.md +${SED_COMMAND} -i 's/rippled/xrpld/g' docs/Doxyfile +${SED_COMMAND} -i 's/ripple_basics/basics/' include/xrpl/basics/CountedObject.h +${SED_COMMAND} -i 's/ list: # so that they are easier to identify in the GitHub Actions UI, as long # names get truncated. # Add Address and Thread (both coupled with UB) sanitizers for specific bookworm distros. - # GCC-Asan rippled-embedded tests are failing because of https://github.com/google/sanitizers/issues/856 + # GCC-Asan xrpld-embedded tests are failing because of https://github.com/google/sanitizers/issues/856 if ( os["distro_version"] == "bookworm" and f"{os['compiler_name']}-{os['compiler_version']}" == "clang-20" diff --git a/.github/workflows/check-pr-commits.yml b/.github/workflows/check-pr-commits.yml index 07c62c9ff5..37e15a5648 100644 --- a/.github/workflows/check-pr-commits.yml +++ b/.github/workflows/check-pr-commits.yml @@ -1,7 +1,7 @@ name: Check PR commits on: - pull_request: + pull_request_target: # The action needs to have write permissions to post comments on the PR. permissions: @@ -10,4 +10,4 @@ permissions: jobs: check_commits: - uses: XRPLF/actions/.github/workflows/check-pr-commits.yml@481048b78b94ac3343d1292b4ef125a813879f2b + uses: XRPLF/actions/.github/workflows/check-pr-commits.yml@e2c7f400d1e85ae65dad552fd425169fbacca4a3 diff --git a/.github/workflows/check-pr-description.yml b/.github/workflows/check-pr-description.yml new file mode 100644 index 0000000000..f6eee50291 --- /dev/null +++ b/.github/workflows/check-pr-description.yml @@ -0,0 +1,30 @@ +name: Check PR description + +on: + merge_group: + types: + - checks_requested + pull_request: + types: [opened, edited, reopened, synchronize, ready_for_review] + branches: [develop] + +jobs: + check_description: + if: ${{ github.event.pull_request.draft != true }} + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Write PR body to file + env: + PR_BODY: ${{ github.event.pull_request.body }} + if: ${{ github.event_name == 'pull_request' }} + run: printenv PR_BODY > pr_body.md + + - name: Check PR description differs from template + if: ${{ github.event_name == 'pull_request' }} + run: > + python .github/scripts/check-pr-description.py + --template-file .github/pull_request_template.md + --pr-body-file pr_body.md diff --git a/.github/workflows/check-pr-title.yml b/.github/workflows/check-pr-title.yml index fc03cdf8e1..6d7bdefa08 100644 --- a/.github/workflows/check-pr-title.yml +++ b/.github/workflows/check-pr-title.yml @@ -11,4 +11,4 @@ on: jobs: check_title: if: ${{ github.event.pull_request.draft != true }} - uses: XRPLF/actions/.github/workflows/check-pr-title.yml@e2c7f400d1e85ae65dad552fd425169fbacca4a3 + uses: XRPLF/actions/.github/workflows/check-pr-title.yml@a5d8dd35be543365e90a11358447130c8763871d diff --git a/.github/workflows/on-pr.yml b/.github/workflows/on-pr.yml index 66893d19d3..28299a1264 100644 --- a/.github/workflows/on-pr.yml +++ b/.github/workflows/on-pr.yml @@ -46,7 +46,7 @@ jobs: # that Github considers any skipped jobs to have passed, and in # turn the required checks as well. id: changes - uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5 + uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: files: | # These paths are unique to `on-pr.yml`. diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index 5cc99d1804..89255f0e47 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -14,7 +14,7 @@ on: jobs: # Call the workflow in the XRPLF/actions repo that runs the pre-commit hooks. run-hooks: - uses: XRPLF/actions/.github/workflows/pre-commit.yml@e7896f15cc60d0da1a272c77ee5c4026b424f9c7 + uses: XRPLF/actions/.github/workflows/pre-commit.yml@9307df762265e15c745ddcdb38a581c989f7f349 with: runs_on: ubuntu-latest container: '{ "image": "ghcr.io/xrplf/ci/tools-rippled-pre-commit:sha-41ec7c1" }' diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 7d40ff3363..d619be5543 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -36,7 +36,7 @@ env: BUILD_DIR: build # ubuntu-latest has only 2 CPUs for private repositories # https://docs.github.com/en/actions/reference/runners/github-hosted-runners#standard-github-hosted-runners-for--private-repositories - NPROC_SUBTRACT: ${{ github.event.repository.private && '1' || '2' }} + NPROC_SUBTRACT: ${{ github.event.repository.visibility == 'public' && '2' || '1' }} jobs: build: @@ -47,7 +47,7 @@ jobs: uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Prepare runner - uses: XRPLF/actions/prepare-runner@2bbc2dc1abeec7bfaa886804ab86871ac201764e + uses: XRPLF/actions/prepare-runner@90f11ee655d1687824fb8793db770477d52afbab with: enable_ccache: false @@ -82,12 +82,12 @@ jobs: - name: Create documentation artifact if: ${{ github.event.repository.visibility == 'public' && github.event_name == 'push' }} - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0 + uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 with: path: ${{ env.BUILD_DIR }}/docs/html deploy: - if: ${{ github.event.repository.visibility == 'public' && github.event_name == 'push' }} + if: ${{ github.repository == 'XRPLF/rippled' && github.event_name == 'push' }} needs: build runs-on: ubuntu-latest permissions: diff --git a/.github/workflows/reusable-build-test-config.yml b/.github/workflows/reusable-build-test-config.yml index 27dfa2fd6a..abbec1ceb4 100644 --- a/.github/workflows/reusable-build-test-config.yml +++ b/.github/workflows/reusable-build-test-config.yml @@ -107,7 +107,7 @@ jobs: uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Prepare runner - uses: XRPLF/actions/prepare-runner@2bbc2dc1abeec7bfaa886804ab86871ac201764e + uses: XRPLF/actions/prepare-runner@90f11ee655d1687824fb8793db770477d52afbab with: enable_ccache: ${{ inputs.ccache_enabled }} @@ -153,6 +153,32 @@ jobs: ${CMAKE_ARGS} \ .. + - name: Check protocol autogen files are up-to-date + working-directory: ${{ env.BUILD_DIR }} + env: + MESSAGE: | + + The generated protocol wrapper classes are out of date. + + This typically happens when the macro files or generator scripts + have changed but the generated files were not regenerated. + + To fix this: + 1. Run: cmake --build . --target setup_code_gen + 2. Run: cmake --build . --target code_gen + 3. Commit and push the regenerated files + run: | + set -e + cmake --build . --target setup_code_gen + cmake --build . --target code_gen + DIFF=$(git -C .. status --porcelain -- include/xrpl/protocol_autogen src/tests/libxrpl/protocol_autogen) + if [ -n "${DIFF}" ]; then + echo "::error::Generated protocol files are out of date" + git -C .. diff -- include/xrpl/protocol_autogen src/tests/libxrpl/protocol_autogen + echo "${MESSAGE}" + exit 1 + fi + - name: Build the binary working-directory: ${{ env.BUILD_DIR }} env: @@ -166,29 +192,6 @@ jobs: --parallel "${BUILD_NPROC}" \ --target "${CMAKE_TARGET}" - - name: Check protocol autogen files are up-to-date - env: - MESSAGE: | - - The generated protocol wrapper classes are out of date. - - This typically happens when your branch is behind develop and - the macro files or generator scripts have changed. - - To fix this: - 1. Update your branch from develop (merge or rebase) - 2. Build with code generation enabled (XRPL_NO_CODEGEN=OFF) - 3. Commit and push the regenerated files - run: | - set -e - DIFF=$(git status --porcelain -- include/xrpl/protocol_autogen src/tests/libxrpl/protocol_autogen) - if [ -n "${DIFF}" ]; then - echo "::error::Generated protocol files are out of date" - git diff -- include/xrpl/protocol_autogen src/tests/libxrpl/protocol_autogen - echo "${MESSAGE}" - exit 1 - fi - - name: Show ccache statistics if: ${{ inputs.ccache_enabled }} run: | @@ -200,7 +203,7 @@ jobs: - name: Upload the binary (Linux) if: ${{ github.event.repository.visibility == 'public' && runner.os == 'Linux' }} - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: xrpld-${{ inputs.config_name }} path: ${{ env.BUILD_DIR }}/xrpld diff --git a/.github/workflows/reusable-check-rename.yml b/.github/workflows/reusable-check-rename.yml index 0e335ab9ca..56a1a3e637 100644 --- a/.github/workflows/reusable-check-rename.yml +++ b/.github/workflows/reusable-check-rename.yml @@ -33,6 +33,8 @@ jobs: run: .github/scripts/rename/config.sh . - name: Check include guards run: .github/scripts/rename/include.sh . + - name: Check documentation + run: .github/scripts/rename/docs.sh . - name: Check for differences env: MESSAGE: | diff --git a/.github/workflows/reusable-clang-tidy-files.yml b/.github/workflows/reusable-clang-tidy-files.yml index 2abc9de43b..30b826cb1b 100644 --- a/.github/workflows/reusable-clang-tidy-files.yml +++ b/.github/workflows/reusable-clang-tidy-files.yml @@ -35,7 +35,7 @@ jobs: uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Prepare runner - uses: XRPLF/actions/prepare-runner@2bbc2dc1abeec7bfaa886804ab86871ac201764e + uses: XRPLF/actions/prepare-runner@90f11ee655d1687824fb8793db770477d52afbab with: enable_ccache: false @@ -80,11 +80,11 @@ jobs: env: TARGETS: ${{ inputs.files != '' && inputs.files || 'src tests' }} run: | - run-clang-tidy -j ${{ steps.nproc.outputs.nproc }} -p "${BUILD_DIR}" ${TARGETS} 2>&1 | tee clang-tidy-output.txt + run-clang-tidy -j ${{ steps.nproc.outputs.nproc }} -p "${BUILD_DIR}" -quiet -allow-no-checks ${TARGETS} 2>&1 | tee clang-tidy-output.txt - name: Upload clang-tidy output if: ${{ github.event.repository.visibility == 'public' && steps.run_clang_tidy.outcome != 'success' }} - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: clang-tidy-results path: clang-tidy-output.txt diff --git a/.github/workflows/reusable-clang-tidy.yml b/.github/workflows/reusable-clang-tidy.yml index 4c927dec9f..7a8bf6de57 100644 --- a/.github/workflows/reusable-clang-tidy.yml +++ b/.github/workflows/reusable-clang-tidy.yml @@ -31,7 +31,7 @@ jobs: - name: Get changed C++ files id: changed_files - uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5 + uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: files: | **/*.cpp @@ -41,7 +41,7 @@ jobs: - name: Get changed clang-tidy configuration id: changed_clang_tidy - uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5 + uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: files: | .clang-tidy diff --git a/.github/workflows/upload-conan-deps.yml b/.github/workflows/upload-conan-deps.yml index 832e455453..f14efde05b 100644 --- a/.github/workflows/upload-conan-deps.yml +++ b/.github/workflows/upload-conan-deps.yml @@ -70,7 +70,7 @@ jobs: uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Prepare runner - uses: XRPLF/actions/prepare-runner@2bbc2dc1abeec7bfaa886804ab86871ac201764e + uses: XRPLF/actions/prepare-runner@90f11ee655d1687824fb8793db770477d52afbab with: enable_ccache: false diff --git a/.gitignore b/.gitignore index 7ee6d0c70a..6bd34ece04 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ Debug/ Release/ /.build/ +/.venv/ /build/ /db/ /out.txt diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 59d42ccebc..3a5a85f0ab 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -17,7 +17,6 @@ repos: args: [--maxkb=400, --enforce-all] - id: trailing-whitespace - id: end-of-file-fixer - - id: mixed-line-ending - id: check-merge-conflict args: [--assume-in-merge] @@ -38,6 +37,7 @@ repos: rev: c2bc67fe8f8f549cc489e00ba8b45aa18ee713b1 # frozen: v3.8.1 hooks: - id: prettier + args: [--end-of-line=auto] - repo: https://github.com/psf/black-pre-commit-mirror rev: ea488cebbfd88a5f50b8bd95d5c829d0bb76feb8 # frozen: 26.1.0 diff --git a/API-CHANGELOG.md b/API-CHANGELOG.md index 64b61c2024..d5faaf70af 100644 --- a/API-CHANGELOG.md +++ b/API-CHANGELOG.md @@ -4,23 +4,23 @@ This changelog is intended to list all updates to the [public API methods](https For info about how [API versioning](https://xrpl.org/request-formatting.html#api-versioning) works, including examples, please view the [XLS-22d spec](https://github.com/XRPLF/XRPL-Standards/discussions/54). For details about the implementation of API versioning, view the [implementation PR](https://github.com/XRPLF/rippled/pull/3155). API versioning ensures existing integrations and users continue to receive existing behavior, while those that request a higher API version will experience new behavior. -The API version controls the API behavior you see. This includes what properties you see in responses, what parameters you're permitted to send in requests, and so on. You specify the API version in each of your requests. When a breaking change is introduced to the `rippled` API, a new version is released. To avoid breaking your code, you should set (or increase) your version when you're ready to upgrade. +The API version controls the API behavior you see. This includes what properties you see in responses, what parameters you're permitted to send in requests, and so on. You specify the API version in each of your requests. When a breaking change is introduced to the `xrpld` API, a new version is released. To avoid breaking your code, you should set (or increase) your version when you're ready to upgrade. The [commandline](https://xrpl.org/docs/references/http-websocket-apis/api-conventions/request-formatting/#commandline-format) always uses the latest API version. The command line is intended for ad-hoc usage by humans, not programs or automated scripts. The command line is not meant for use in production code. -For a log of breaking changes, see the **API Version [number]** headings. In general, breaking changes are associated with a particular API Version number. For non-breaking changes, scroll to the **XRP Ledger version [x.y.z]** headings. Non-breaking changes are associated with a particular XRP Ledger (`rippled`) release. +For a log of breaking changes, see the **API Version [number]** headings. In general, breaking changes are associated with a particular API Version number. For non-breaking changes, scroll to the **XRP Ledger version [x.y.z]** headings. Non-breaking changes are associated with a particular XRP Ledger (`xrpld`) release. ## API Version 3 (Beta) -API version 3 is currently a beta API. It requires enabling `[beta_rpc_api]` in the rippled configuration to use. See [API-VERSION-3.md](API-VERSION-3.md) for the full list of changes in API version 3. +API version 3 is currently a beta API. It requires enabling `[beta_rpc_api]` in the xrpld configuration to use. See [API-VERSION-3.md](API-VERSION-3.md) for the full list of changes in API version 3. ## API Version 2 -API version 2 is available in `rippled` version 2.0.0 and later. See [API-VERSION-2.md](API-VERSION-2.md) for the full list of changes in API version 2. +API version 2 is available in `xrpld` version 2.0.0 and later. See [API-VERSION-2.md](API-VERSION-2.md) for the full list of changes in API version 2. ## API Version 1 -This version is supported by all `rippled` versions. For WebSocket and HTTP JSON-RPC requests, it is currently the default API version used when no `api_version` is specified. +This version is supported by all `xrpld` versions. For WebSocket and HTTP JSON-RPC requests, it is currently the default API version used when no `api_version` is specified. ## Unreleased @@ -38,6 +38,8 @@ This section contains changes targeting a future version. ### Bugfixes - Peer Crawler: The `port` field in `overlay.active[]` now consistently returns an integer instead of a string for outbound peers. [#6318](https://github.com/XRPLF/rippled/pull/6318) +- `ping`: The `ip` field is no longer returned as an empty string for proxied connections without a forwarded-for header. It is now omitted, consistent with the behavior for identified connections. [#6730](https://github.com/XRPLF/rippled/pull/6730) +- gRPC `GetLedgerDiff`: Fixed error message that incorrectly said "base ledger not validated" when the desired ledger was not validated. [#6730](https://github.com/XRPLF/rippled/pull/6730) ## XRP Ledger server version 3.1.0 diff --git a/API-VERSION-2.md b/API-VERSION-2.md index 2296795271..eaf626099c 100644 --- a/API-VERSION-2.md +++ b/API-VERSION-2.md @@ -1,6 +1,6 @@ # API Version 2 -API version 2 is available in `rippled` version 2.0.0 and later. To use this API, clients specify `"api_version" : 2` in each request. +API version 2 is available in `xrpld` version 2.0.0 and later. To use this API, clients specify `"api_version" : 2` in each request. For info about how [API versioning](https://xrpl.org/request-formatting.html#api-versioning) works, including examples, please view the [XLS-22d spec](https://github.com/XRPLF/XRPL-Standards/discussions/54). For details about the implementation of API versioning, view the [implementation PR](https://github.com/XRPLF/rippled/pull/3155). API versioning ensures existing integrations and users continue to receive existing behavior, while those that request a higher API version will experience new behavior. diff --git a/API-VERSION-3.md b/API-VERSION-3.md index 46dc3f504d..57d42ce200 100644 --- a/API-VERSION-3.md +++ b/API-VERSION-3.md @@ -1,6 +1,6 @@ # API Version 3 -API version 3 is currently a **beta API**. It requires enabling `[beta_rpc_api]` in the rippled configuration to use. To use this API, clients specify `"api_version" : 3` in each request. +API version 3 is currently a **beta API**. It requires enabling `[beta_rpc_api]` in the xrpld configuration to use. To use this API, clients specify `"api_version" : 3` in each request. For info about how [API versioning](https://xrpl.org/request-formatting.html#api-versioning) works, including examples, please view the [XLS-22d spec](https://github.com/XRPLF/XRPL-Standards/discussions/54). For details about the implementation of API versioning, view the [implementation PR](https://github.com/XRPLF/rippled/pull/3155). API versioning ensures existing integrations and users continue to receive existing behavior, while those that request a higher API version will experience new behavior. diff --git a/BUILD.md b/BUILD.md index 4f709a032b..cf0a685abd 100644 --- a/BUILD.md +++ b/BUILD.md @@ -141,7 +141,7 @@ Alternatively, you can pull our recipes from the repository and export them loca ```bash # Define which recipes to export. -recipes=('abseil' 'ed25519' 'grpc' 'm4' 'mpt-crypto' 'nudb' 'openssl' 'secp256k1' 'snappy' 'soci' 'wasm-xrplf' 'wasmi') +recipes=('abseil' 'ed25519' 'grpc' 'm4' 'mpt-crypto' 'openssl' 'secp256k1' 'snappy' 'soci' 'wasm-xrplf' 'wasmi') # Selectively check out the recipes from our CCI fork. cd external @@ -459,6 +459,21 @@ install ccache --version 4.11.3 --allow-downgrade`. The location of `xrpld` binary in your build directory depends on your CMake generator. Pass `--help` to see the rest of the command line options. +## Code generation + +The protocol wrapper classes in `include/xrpl/protocol_autogen/` are generated +from macro definition files in `include/xrpl/protocol/detail/`. If you modify +the macro files (e.g. `transactions.macro`, `ledger_entries.macro`) or the +generation scripts/templates in `cmake/scripts/codegen/`, you need to regenerate the +files: + +``` +cmake --build . --target setup_code_gen # create venv and install dependencies (once) +cmake --build . --target code_gen # regenerate code +``` + +The regenerated files should be committed alongside your changes. + ## Coverage report The coverage report is intended for developers using compilers GCC @@ -603,8 +618,8 @@ If you want to experiment with a new package, follow these steps: `default_options` property (with syntax `'$package:$option': $value`). 3. Modify [`CMakeLists.txt`](./CMakeLists.txt): - Add a call to `find_package($package REQUIRED)`. - - Link a library from the package to the target `ripple_libs` - (search for the existing call to `target_link_libraries(ripple_libs INTERFACE ...)`). + - Link a library from the package to the target `xrpl_libs` + (search for the existing call to `target_link_libraries(xrpl_libs INTERFACE ...)`). 4. Start coding! Don't forget to include whatever headers you need from the package. [1]: https://github.com/conan-io/conan-center-index/issues/13168 diff --git a/CMakeLists.txt b/CMakeLists.txt index 33f68451c5..80ff8fec13 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -132,6 +132,7 @@ if(coverage) endif() include(XrplCore) +include(XrplProtocolAutogen) include(XrplInstall) include(XrplValidatorKeys) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8670b79db9..0589081055 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -270,14 +270,14 @@ Before running clang-tidy, you must build the project to generate required files Then run clang-tidy on your local changes: ``` -run-clang-tidy -p build src include tests +run-clang-tidy -p build -allow-no-checks src tests ``` This will check all source files in the `src`, `include` and `tests` directories using the compile commands from your `build` directory. If you wish to automatically fix whatever clang-tidy finds _and_ is capable of fixing, add `-fix` to the above command: ``` -run-clang-tidy -p build -fix src include tests +run-clang-tidy -p build -quiet -fix -allow-no-checks src tests ``` ## Contracts and instrumentation @@ -533,7 +533,7 @@ All releases, including release candidates and betas, are handled differently from typical PRs. Most importantly, never use the Github UI to merge a release. -Rippled uses a linear workflow model that can be summarized as: +Xrpld uses a linear workflow model that can be summarized as: 1. In between releases, developers work against the `develop` branch. 2. Periodically, a maintainer will build and tag a beta version from diff --git a/README.md b/README.md index dbc5ab078e..88c7943ebb 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ The [XRP Ledger](https://xrpl.org/) is a decentralized cryptographic ledger powe [XRP](https://xrpl.org/xrp.html) is a public, counterparty-free crypto-asset native to the XRP Ledger, and is designed as a gas token for network services and to bridge different currencies. XRP is traded on the open-market and is available for anyone to access. The XRP Ledger was created in 2012 with a finite supply of 100 billion units of XRP. -## rippled +## xrpld -The server software that powers the XRP Ledger is called `rippled` and is available in this repository under the permissive [ISC open-source license](LICENSE.md). The `rippled` server software is written primarily in C++ and runs on a variety of platforms. The `rippled` server software can run in several modes depending on its [configuration](https://xrpl.org/rippled-server-modes.html). +The server software that powers the XRP Ledger is called `xrpld` and is available in this repository under the permissive [ISC open-source license](LICENSE.md). The `xrpld` server software is written primarily in C++ and runs on a variety of platforms. The `xrpld` server software can run in several modes depending on its [configuration](https://xrpl.org/rippled-server-modes.html). -If you are interested in running an **API Server** (including a **Full History Server**), take a look at [Clio](https://github.com/XRPLF/clio). (rippled Reporting Mode has been replaced by Clio.) +If you are interested in running an **API Server** (including a **Full History Server**), take a look at [Clio](https://github.com/XRPLF/clio). (xrpld Reporting Mode has been replaced by Clio.) ### Build from Source @@ -41,19 +41,19 @@ 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 markdown files in the source tree: `src/xrpld/**/*.md`. - 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 -| Folder | Contents | -| :--------- | :----------------------------------------------- | -| `./bin` | Scripts and data files for Ripple integrators. | -| `./Builds` | Platform-specific guides for building `rippled`. | -| `./docs` | Source documentation files and doxygen config. | -| `./cfg` | Example configuration files. | -| `./src` | Source code. | +| Folder | Contents | +| :--------- | :--------------------------------------------- | +| `./bin` | Scripts and data files for XRPL developers. | +| `./Builds` | Platform-specific guides for building `xrpld`. | +| `./docs` | Source documentation files and doxygen config. | +| `./cfg` | Example configuration files. | +| `./src` | Source code. | Some of the directories under `src` are external repositories included using git-subtree. See those directories' README files for more details. diff --git a/SECURITY.md b/SECURITY.md index 1be412ae2a..2e0c43a134 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ For more details on operating an XRP Ledger server securely, please visit https: ## Supported Versions -Software constantly evolves. In order to focus resources, we only generally only accept vulnerability reports that affect recent and current versions of the software. We always accept reports for issues present in the **master**, **release** or **develop** branches, and with proposed, [open pull requests](https://github.com/ripple/rippled/pulls). +Software constantly evolves. In order to focus resources, we generally only accept vulnerability reports that affect recent and current versions of the software. We always accept reports for issues present in the **master**, **release** or **develop** branches, and with proposed, [open pull requests](https://github.com/XRPLF/rippled/pulls). ## Identifying and Reporting Vulnerabilities @@ -59,11 +59,11 @@ While we commit to responding with 24 hours of your initial report with our tria ## Bug Bounty Program -[Ripple](https://ripple.com) is generously sponsoring a bug bounty program for vulnerabilities in [`rippled`](https://github.com/XRPLF/rippled) (and other related projects, like [`xrpl.js`](https://github.com/XRPLF/xrpl.js), [`xrpl-py`](https://github.com/XRPLF/xrpl-py), [`xrpl4j`](https://github.com/XRPLF/xrpl4j)). +[Ripple](https://ripple.com) is generously sponsoring a bug bounty program for vulnerabilities in [`xrpld`](https://github.com/XRPLF/rippled) (and other related projects, like [`xrpl.js`](https://github.com/XRPLF/xrpl.js), [`xrpl-py`](https://github.com/XRPLF/xrpl-py), [`xrpl4j`](https://github.com/XRPLF/xrpl4j)). This program allows us to recognize and reward individuals or groups that identify and report bugs. In summary, in order to qualify for a bounty, the bug must be: -1. **In scope**. Only bugs in software under the scope of the program qualify. Currently, that means `rippled`, `xrpl.js`, `xrpl-py`, `xrpl4j`. +1. **In scope**. Only bugs in software under the scope of the program qualify. Currently, that means `xrpld`, `xrpl.js`, `xrpl-py`, `xrpl4j`. 2. **Relevant**. A security issue, posing a danger to user funds, privacy, or the operation of the XRP Ledger. 3. **Original and previously unknown**. Bugs that are already known and discussed in public do not qualify. Previously reported bugs, even if publicly unknown, are not eligible. 4. **Specific**. We welcome general security advice or recommendations, but we cannot pay bounties for that. diff --git a/cfg/validators-example.txt b/cfg/validators-example.txt index 6eb49da697..384db924f4 100644 --- a/cfg/validators-example.txt +++ b/cfg/validators-example.txt @@ -28,7 +28,7 @@ # https://vl.ripple.com # https://unl.xrplf.org # http://127.0.0.1:8000 -# file:///etc/opt/ripple/vl.txt +# file:///etc/opt/xrpld/vl.txt # # [validator_list_keys] # @@ -43,11 +43,11 @@ # ED307A760EE34F2D0CAA103377B1969117C38B8AA0AA1E2A24DAC1F32FC97087ED # -# The default validator list publishers that the rippled instance +# The default validator list publishers that the xrpld instance # trusts. # -# WARNING: Changing these values can cause your rippled instance to see a -# validated ledger that contradicts other rippled instances' +# WARNING: Changing these values can cause your xrpld instance to see a +# validated ledger that contradicts other xrpld instances' # validated ledgers (aka a ledger fork) if your validator list(s) # do not sufficiently overlap with the list(s) used by others. # See: https://arxiv.org/pdf/1802.07242.pdf diff --git a/cfg/xrpld-example.cfg b/cfg/xrpld-example.cfg index 995d4e65ff..4b17bf0500 100644 --- a/cfg/xrpld-example.cfg +++ b/cfg/xrpld-example.cfg @@ -9,7 +9,7 @@ # # 2. Peer Protocol # -# 3. Ripple Protocol +# 3. XRPL protocol # # 4. HTTPS Client # @@ -383,7 +383,7 @@ # # These settings control security and access attributes of the Peer to Peer # server section of the xrpld process. Peer Protocol implements the -# Ripple Payment protocol. It is over peer connections that transactions +# XRPL payment protocol. It is over peer connections that transactions # and validations are passed from to machine to machine, to determine the # contents of validated ledgers. # @@ -406,7 +406,7 @@ # # [ips] # -# List of hostnames or ips where the Ripple protocol is served. A default +# List of hostnames or ips where the XRPL protocol is served. A default # starter list is included in the code and used if no other hostnames are # available. # @@ -435,7 +435,7 @@ # List of IP addresses or hostnames to which xrpld should always attempt to # maintain peer connections with. This is useful for manually forming private # networks, for example to configure a validation server that connects to the -# Ripple network through a public-facing server, or for building a set +# XRPL network through a public-facing server, or for building a set # of cluster peers. # # One address or domain names per line is allowed. A port must be specified @@ -748,8 +748,8 @@ # the folder in which the xrpld.cfg file is located. # # Examples: -# /home/ripple/validators.txt -# C:/home/ripple/validators.txt +# /home/username/validators.txt +# C:/home/username/validators.txt # # Example content: # [validators] @@ -840,7 +840,7 @@ # # 0: Disable the ledger replay feature [default] # 1: Enable the ledger replay feature. With this feature enabled, when -# acquiring a ledger from the network, a xrpld node only downloads +# acquiring a ledger from the network, an xrpld node only downloads # the ledger header and the transactions instead of the whole ledger. # And the ledger is built by applying the transactions to the parent # ledger. @@ -853,7 +853,7 @@ # # The xrpld server instance uses HTTPS GET requests in a variety of # circumstances, including but not limited to contacting trusted domains to -# fetch information such as mapping an email address to a Ripple Payment +# fetch information such as mapping an email address to an XRPL payment # Network address. # # [ssl_verify] @@ -1227,7 +1227,7 @@ # #---------- # -# The vote settings configure settings for the entire Ripple network. +# The vote settings configure settings for the entire XRPL network. # While a single instance of xrpld cannot unilaterally enforce network-wide # settings, these choices become part of the instance's vote during the # consensus process for each voting ledger. @@ -1416,6 +1416,12 @@ # in this section to a comma-separated list of the addresses # of your Clio servers, in order to bypass xrpld's rate limiting. # +# TLS/SSL can be enabled for gRPC by specifying ssl_cert and ssl_key. +# Both parameters must be provided together. The ssl_cert_chain parameter +# is optional and provides intermediate CA certificates for the certificate +# chain. The ssl_client_ca parameter is optional and enables mutual TLS +# (client certificate verification). +# # This port is commented out but can be enabled by removing # the '#' from each corresponding line including the entry under [server] # @@ -1465,11 +1471,74 @@ admin = 127.0.0.1 protocol = ws send_queue_limit = 500 +# gRPC TLS/SSL Configuration +# +# The gRPC port supports optional TLS/SSL encryption. When TLS is not +# configured, the gRPC server will accept unencrypted connections. +# +# ssl_cert = +# ssl_key = +# +# To enable TLS for gRPC, both ssl_cert and ssl_key must be specified. +# If only one is provided, xrpld will fail to start. +# +# ssl_cert: Path to the server's SSL certificate file in PEM format. +# ssl_key: Path to the server's SSL private key file in PEM format. +# +# When configured, the gRPC server will only accept TLS-encrypted +# connections. Clients must use TLS (secure) channel credentials rather +# than plaintext / insecure connections. +# +# ssl_cert_chain = +# +# Optional. Path to intermediate CA certificate(s) in PEM format that +# complete the server's certificate chain. +# +# This file should contain the intermediate CA certificate(s) needed +# to build a trust chain from the server certificate (ssl_cert) to a +# root CA that clients trust. Multiple certificates should be +# concatenated in PEM format. +# +# This is needed when your server certificate was signed by an +# intermediate CA rather than directly by a root CA. Without this, +# clients may fail to verify your server certificate. +# +# If not specified, only the server certificate from ssl_cert will be +# presented to clients. +# +# ssl_client_ca = +# +# Optional. Path to a CA certificate file in PEM format for verifying +# client certificates (mutual TLS / mTLS). +# +# When specified, the gRPC server will verify client certificates +# against this CA. This enables mutual authentication where both the +# server and client verify each other's identity. +# +# This is typically NOT needed for public-facing gRPC servers. Only +# use this if you want to restrict access to clients with valid +# certificates signed by the specified CA. +# +# If not specified, the server will use one-way TLS (server +# authentication only) and will accept connections from any client. +# [port_grpc] port = 50051 ip = 127.0.0.1 secure_gateway = 127.0.0.1 +# Optional TLS/SSL configuration for gRPC +# To enable TLS, uncomment and configure both ssl_cert and ssl_key: +#ssl_cert = /etc/ssl/certs/grpc-server.crt +#ssl_key = /etc/ssl/private/grpc-server.key + +# Optional: Include intermediate CA certificates for complete certificate chain +#ssl_cert_chain = /etc/ssl/certs/grpc-intermediate-ca.crt + +# Optional: Enable mutual TLS (client certificate verification) +# Uncomment to require and verify client certificates: +#ssl_client_ca = /etc/ssl/certs/grpc-client-ca.crt + #[port_ws_public] #port = 6005 #ip = 127.0.0.1 diff --git a/cmake/XrplCore.cmake b/cmake/XrplCore.cmake index a50e30f660..9b1dc74049 100644 --- a/cmake/XrplCore.cmake +++ b/cmake/XrplCore.cmake @@ -108,24 +108,12 @@ target_link_libraries( ) # Level 05 -## Set up code generation for protocol_autogen module -include(XrplProtocolAutogen) -# Must call setup_protocol_autogen before add_module so that: -# 1. Stale generated files are cleared before GLOB runs -# 2. Output file list is known for custom commands -setup_protocol_autogen() - add_module(xrpl protocol_autogen) target_link_libraries( xrpl.libxrpl.protocol_autogen PUBLIC xrpl.libxrpl.protocol ) -# Ensure code generation runs before compiling protocol_autogen -if(TARGET protocol_autogen_generate) - add_dependencies(xrpl.libxrpl.protocol_autogen protocol_autogen_generate) -endif() - # Level 06 add_module(xrpl core) target_link_libraries( diff --git a/cmake/XrplProtocolAutogen.cmake b/cmake/XrplProtocolAutogen.cmake index e48d28959d..dd9ef6a9a4 100644 --- a/cmake/XrplProtocolAutogen.cmake +++ b/cmake/XrplProtocolAutogen.cmake @@ -2,308 +2,145 @@ Protocol Autogen - Code generation for protocol wrapper classes #]===================================================================] -# Options for code generation -option( - XRPL_NO_CODEGEN - "Disable code generation (use pre-generated files from repository)" - OFF -) set(CODEGEN_VENV_DIR - "" + "${CMAKE_CURRENT_SOURCE_DIR}/.venv" CACHE PATH - "Path to Python virtual environment for code generation. If provided, automatic venv setup is skipped." + "Path to a Python virtual environment for code generation. A venv will be created here by setup_code_gen and used to run generation scripts." ) -# Function to set up code generation for protocol_autogen module -# This runs at configure time to generate C++ wrapper classes from macro files -function(setup_protocol_autogen) - # Directory paths - set(MACRO_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include/xrpl/protocol/detail") - set(AUTOGEN_HEADER_DIR - "${CMAKE_CURRENT_SOURCE_DIR}/include/xrpl/protocol_autogen" - ) - set(AUTOGEN_TEST_DIR - "${CMAKE_CURRENT_SOURCE_DIR}/src/tests/libxrpl/protocol_autogen" - ) - set(SCRIPTS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/scripts") +# Directory paths +set(MACRO_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include/xrpl/protocol/detail") +set(AUTOGEN_HEADER_DIR + "${CMAKE_CURRENT_SOURCE_DIR}/include/xrpl/protocol_autogen" +) +set(AUTOGEN_TEST_DIR + "${CMAKE_CURRENT_SOURCE_DIR}/src/tests/libxrpl/protocol_autogen" +) +set(SCRIPTS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/cmake/scripts/codegen") - # Input macro files - set(TRANSACTIONS_MACRO "${MACRO_DIR}/transactions.macro") - set(LEDGER_ENTRIES_MACRO "${MACRO_DIR}/ledger_entries.macro") - set(SFIELDS_MACRO "${MACRO_DIR}/sfields.macro") +# Input macro files +set(TRANSACTIONS_MACRO "${MACRO_DIR}/transactions.macro") +set(LEDGER_ENTRIES_MACRO "${MACRO_DIR}/ledger_entries.macro") +set(SFIELDS_MACRO "${MACRO_DIR}/sfields.macro") - # Python scripts and templates - set(GENERATE_TX_SCRIPT "${SCRIPTS_DIR}/generate_tx_classes.py") - set(GENERATE_LEDGER_SCRIPT "${SCRIPTS_DIR}/generate_ledger_classes.py") - set(REQUIREMENTS_FILE "${SCRIPTS_DIR}/requirements.txt") - set(MACRO_PARSER_COMMON "${SCRIPTS_DIR}/macro_parser_common.py") - set(TX_TEMPLATE "${SCRIPTS_DIR}/templates/Transaction.h.mako") - set(TX_TEST_TEMPLATE "${SCRIPTS_DIR}/templates/TransactionTests.cpp.mako") - set(LEDGER_TEMPLATE "${SCRIPTS_DIR}/templates/LedgerEntry.h.mako") - set(LEDGER_TEST_TEMPLATE - "${SCRIPTS_DIR}/templates/LedgerEntryTests.cpp.mako" +# Python scripts and templates +set(GENERATE_TX_SCRIPT "${SCRIPTS_DIR}/generate_tx_classes.py") +set(GENERATE_LEDGER_SCRIPT "${SCRIPTS_DIR}/generate_ledger_classes.py") +set(REQUIREMENTS_FILE "${SCRIPTS_DIR}/requirements.txt") +set(MACRO_PARSER_COMMON "${SCRIPTS_DIR}/macro_parser_common.py") +set(TX_TEMPLATE "${SCRIPTS_DIR}/templates/Transaction.h.mako") +set(TX_TEST_TEMPLATE "${SCRIPTS_DIR}/templates/TransactionTests.cpp.mako") +set(LEDGER_TEMPLATE "${SCRIPTS_DIR}/templates/LedgerEntry.h.mako") +set(LEDGER_TEST_TEMPLATE "${SCRIPTS_DIR}/templates/LedgerEntryTests.cpp.mako") +set(ALL_INPUT_FILES + "${TRANSACTIONS_MACRO}" + "${LEDGER_ENTRIES_MACRO}" + "${SFIELDS_MACRO}" + "${GENERATE_TX_SCRIPT}" + "${GENERATE_LEDGER_SCRIPT}" + "${REQUIREMENTS_FILE}" + "${MACRO_PARSER_COMMON}" + "${TX_TEMPLATE}" + "${TX_TEST_TEMPLATE}" + "${LEDGER_TEMPLATE}" + "${LEDGER_TEST_TEMPLATE}" +) + +# Create output directories +file(MAKE_DIRECTORY "${AUTOGEN_HEADER_DIR}/transactions") +file(MAKE_DIRECTORY "${AUTOGEN_HEADER_DIR}/ledger_entries") +file(MAKE_DIRECTORY "${AUTOGEN_TEST_DIR}/ledger_entries") +file(MAKE_DIRECTORY "${AUTOGEN_TEST_DIR}/transactions") + +# Find Python3 +if(NOT Python3_EXECUTABLE) + find_package(Python3 COMPONENTS Interpreter QUIET) +endif() + +if(NOT Python3_EXECUTABLE) + find_program(Python3_EXECUTABLE NAMES python3 python) +endif() + +if(NOT Python3_EXECUTABLE) + message( + WARNING + "Python3 not found. The 'code_gen' and 'setup_code_gen' targets will not be available." ) + return() +endif() - # Check if code generation is disabled - if(XRPL_NO_CODEGEN) +# Warn if pip is configured with a non-default index (may need VPN). +execute_process( + COMMAND ${Python3_EXECUTABLE} -m pip config get global.index-url + OUTPUT_VARIABLE PIP_INDEX_URL + OUTPUT_STRIP_TRAILING_WHITESPACE + ERROR_QUIET + RESULT_VARIABLE PIP_CONFIG_RESULT +) +if(PIP_CONFIG_RESULT EQUAL 0 AND PIP_INDEX_URL) + if( + NOT PIP_INDEX_URL STREQUAL "https://pypi.org/simple" + AND NOT PIP_INDEX_URL STREQUAL "https://pypi.python.org/simple" + ) message( WARNING - "Protocol autogen: Code generation is disabled (XRPL_NO_CODEGEN=ON). " - "Generated files may be out of date." + "Private pip index URL detected: ${PIP_INDEX_URL}\n" + "You may need to connect to VPN to access this URL." ) - return() endif() +endif() - # Create output directories - file(MAKE_DIRECTORY "${AUTOGEN_HEADER_DIR}/transactions") - file(MAKE_DIRECTORY "${AUTOGEN_HEADER_DIR}/ledger_entries") - file(MAKE_DIRECTORY "${AUTOGEN_TEST_DIR}/ledger_entries") - file(MAKE_DIRECTORY "${AUTOGEN_TEST_DIR}/transactions") - - # Find Python3 - check if already found by Conan or find it ourselves - if(NOT Python3_EXECUTABLE) - find_package(Python3 COMPONENTS Interpreter QUIET) - endif() - - if(NOT Python3_EXECUTABLE) - # Try finding python3 executable directly - find_program(Python3_EXECUTABLE NAMES python3 python) - endif() - - if(NOT Python3_EXECUTABLE) - message( - FATAL_ERROR - "Python3 not found. Code generation cannot proceed.\n" - "Please install Python 3, or set -DXRPL_NO_CODEGEN=ON to use existing generated files." - ) - return() - endif() - - message(STATUS "Using Python3 for code generation: ${Python3_EXECUTABLE}") - - # Set up Python virtual environment for code generation - if(CODEGEN_VENV_DIR) - # User-provided venv - skip automatic setup - set(VENV_DIR "${CODEGEN_VENV_DIR}") - message(STATUS "Using user-provided Python venv: ${VENV_DIR}") - else() - # Use default venv in build directory - set(VENV_DIR "${CMAKE_CURRENT_BINARY_DIR}/codegen_venv") - endif() - - # Determine the Python executable path in the venv +# Determine which Python interpreter to use for code generation. +if(CODEGEN_VENV_DIR) if(WIN32) - set(VENV_PYTHON "${VENV_DIR}/Scripts/python.exe") - set(VENV_PIP "${VENV_DIR}/Scripts/pip.exe") + set(CODEGEN_PYTHON "${CODEGEN_VENV_DIR}/Scripts/python.exe") else() - set(VENV_PYTHON "${VENV_DIR}/bin/python") - set(VENV_PIP "${VENV_DIR}/bin/pip") + set(CODEGEN_PYTHON "${CODEGEN_VENV_DIR}/bin/python") endif() - - # Only auto-setup venv if not user-provided - if(NOT CODEGEN_VENV_DIR) - # Check if venv needs to be created or updated - set(VENV_NEEDS_UPDATE FALSE) - if(NOT EXISTS "${VENV_PYTHON}") - set(VENV_NEEDS_UPDATE TRUE) - message( - STATUS - "Creating Python virtual environment for code generation..." - ) - elseif( - "${REQUIREMENTS_FILE}" - IS_NEWER_THAN - "${VENV_DIR}/.requirements_installed" - ) - set(VENV_NEEDS_UPDATE TRUE) - message( - STATUS - "Updating Python virtual environment (requirements changed)..." - ) - endif() - - # Create/update virtual environment if needed - if(VENV_NEEDS_UPDATE) - message( - STATUS - "Setting up Python virtual environment at ${VENV_DIR}" - ) - execute_process( - COMMAND ${Python3_EXECUTABLE} -m venv "${VENV_DIR}" - RESULT_VARIABLE VENV_RESULT - ERROR_VARIABLE VENV_ERROR - ) - if(NOT VENV_RESULT EQUAL 0) - message( - FATAL_ERROR - "Failed to create virtual environment: ${VENV_ERROR}" - ) - endif() - - # Check pip index URL configuration - execute_process( - COMMAND ${VENV_PIP} config get global.index-url - OUTPUT_VARIABLE PIP_INDEX_URL - OUTPUT_STRIP_TRAILING_WHITESPACE - ERROR_QUIET - ) - - # Default PyPI URL - set(DEFAULT_PIP_INDEX "https://pypi.org/simple") - - # Show warning if using non-default index - if(PIP_INDEX_URL AND NOT PIP_INDEX_URL STREQUAL "") - if(NOT PIP_INDEX_URL STREQUAL DEFAULT_PIP_INDEX) - message( - WARNING - "Private pip index URL detected: ${PIP_INDEX_URL}\n" - "You may need to connect to VPN to access this URL." - ) - endif() - endif() - - message(STATUS "Installing Python dependencies...") - execute_process( - COMMAND ${VENV_PIP} install --upgrade pip - RESULT_VARIABLE PIP_UPGRADE_RESULT - OUTPUT_QUIET - ERROR_VARIABLE PIP_UPGRADE_ERROR - ) - if(NOT PIP_UPGRADE_RESULT EQUAL 0) - message(WARNING "Failed to upgrade pip: ${PIP_UPGRADE_ERROR}") - endif() - - execute_process( - COMMAND ${VENV_PIP} install -r "${REQUIREMENTS_FILE}" - RESULT_VARIABLE PIP_INSTALL_RESULT - ERROR_VARIABLE PIP_INSTALL_ERROR - ) - if(NOT PIP_INSTALL_RESULT EQUAL 0) - message( - FATAL_ERROR - "Failed to install Python dependencies: ${PIP_INSTALL_ERROR}" - ) - endif() - - # Mark requirements as installed - file(TOUCH "${VENV_DIR}/.requirements_installed") - message(STATUS "Python virtual environment ready") - endif() - endif() - - # At configure time - get list of output files for transactions - execute_process( - COMMAND - ${VENV_PYTHON} "${GENERATE_TX_SCRIPT}" "${TRANSACTIONS_MACRO}" - --header-dir "${AUTOGEN_HEADER_DIR}/transactions" --test-dir - "${AUTOGEN_TEST_DIR}/transactions" --list-outputs - OUTPUT_VARIABLE TX_OUTPUT_FILES - OUTPUT_STRIP_TRAILING_WHITESPACE - RESULT_VARIABLE TX_LIST_RESULT - ERROR_VARIABLE TX_LIST_ERROR +else() + set(CODEGEN_PYTHON "${Python3_EXECUTABLE}") + message( + WARNING + "CODEGEN_VENV_DIR is not set. Dependencies will be installed globally.\n" + "If this is not intended, reconfigure with:\n" + " cmake . -UCODEGEN_VENV_DIR" ) - if(NOT TX_LIST_RESULT EQUAL 0) - message( - FATAL_ERROR - "Failed to list transaction output files:\n${TX_LIST_ERROR}" - ) - endif() - # Convert newline-separated list to CMake list - string(REPLACE "\\" "/" TX_OUTPUT_FILES "${TX_OUTPUT_FILES}") - string(REPLACE "\n" ";" TX_OUTPUT_FILES "${TX_OUTPUT_FILES}") +endif() - # At configure time - get list of output files for ledger entries - execute_process( - COMMAND - ${VENV_PYTHON} "${GENERATE_LEDGER_SCRIPT}" "${LEDGER_ENTRIES_MACRO}" - --header-dir "${AUTOGEN_HEADER_DIR}/ledger_entries" --test-dir - "${AUTOGEN_TEST_DIR}/ledger_entries" --list-outputs - OUTPUT_VARIABLE LEDGER_OUTPUT_FILES - OUTPUT_STRIP_TRAILING_WHITESPACE - RESULT_VARIABLE LEDGER_LIST_RESULT - ERROR_VARIABLE LEDGER_LIST_ERROR - ) - if(NOT LEDGER_LIST_RESULT EQUAL 0) - message( - FATAL_ERROR - "Failed to list ledger entry output files:\n${LEDGER_LIST_ERROR}" - ) - endif() - # Convert newline-separated list to CMake list - string(REPLACE "\\" "/" LEDGER_OUTPUT_FILES "${LEDGER_OUTPUT_FILES}") - string(REPLACE "\n" ";" LEDGER_OUTPUT_FILES "${LEDGER_OUTPUT_FILES}") - - # Custom command to generate transaction classes at build time - add_custom_command( - OUTPUT ${TX_OUTPUT_FILES} - COMMAND - ${VENV_PYTHON} "${GENERATE_TX_SCRIPT}" "${TRANSACTIONS_MACRO}" - --header-dir "${AUTOGEN_HEADER_DIR}/transactions" --test-dir - "${AUTOGEN_TEST_DIR}/transactions" --sfields-macro - "${SFIELDS_MACRO}" - WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" - DEPENDS - "${TRANSACTIONS_MACRO}" - "${SFIELDS_MACRO}" - "${GENERATE_TX_SCRIPT}" - "${MACRO_PARSER_COMMON}" - "${TX_TEMPLATE}" - "${TX_TEST_TEMPLATE}" - "${REQUIREMENTS_FILE}" - COMMENT "Generating transaction classes from transactions.macro..." - VERBATIM - ) - - # Custom command to generate ledger entry classes at build time - add_custom_command( - OUTPUT ${LEDGER_OUTPUT_FILES} - COMMAND - ${VENV_PYTHON} "${GENERATE_LEDGER_SCRIPT}" "${LEDGER_ENTRIES_MACRO}" - --header-dir "${AUTOGEN_HEADER_DIR}/ledger_entries" --test-dir - "${AUTOGEN_TEST_DIR}/ledger_entries" --sfields-macro - "${SFIELDS_MACRO}" - WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" - DEPENDS - "${LEDGER_ENTRIES_MACRO}" - "${SFIELDS_MACRO}" - "${GENERATE_LEDGER_SCRIPT}" - "${MACRO_PARSER_COMMON}" - "${LEDGER_TEMPLATE}" - "${LEDGER_TEST_TEMPLATE}" - "${REQUIREMENTS_FILE}" - COMMENT "Generating ledger entry classes from ledger_entries.macro..." - VERBATIM - ) - - # Create a custom target that depends on all generated files +# Custom target to create a venv and install Python dependencies. +# Run manually with: cmake --build . --target setup_code_gen +if(CODEGEN_VENV_DIR) add_custom_target( - protocol_autogen_generate - DEPENDS ${TX_OUTPUT_FILES} ${LEDGER_OUTPUT_FILES} - COMMENT "Protocol autogen code generation" + setup_code_gen + COMMAND ${Python3_EXECUTABLE} -m venv "${CODEGEN_VENV_DIR}" + COMMAND ${CODEGEN_PYTHON} -m pip install -r "${REQUIREMENTS_FILE}" + WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + COMMENT "Creating venv and installing code generation dependencies..." ) +else() + add_custom_target( + setup_code_gen + COMMAND ${Python3_EXECUTABLE} -m pip install -r "${REQUIREMENTS_FILE}" + WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + COMMENT "Installing code generation dependencies..." + ) +endif() - # Extract test files from output lists (files ending in Tests.cpp) - set(PROTOCOL_AUTOGEN_TEST_SOURCES "") - foreach(FILE ${TX_OUTPUT_FILES} ${LEDGER_OUTPUT_FILES}) - if(FILE MATCHES "Tests\\.cpp$") - list(APPEND PROTOCOL_AUTOGEN_TEST_SOURCES "${FILE}") - endif() - endforeach() - # Export test sources to parent scope for use in test CMakeLists.txt - set(PROTOCOL_AUTOGEN_TEST_SOURCES - "${PROTOCOL_AUTOGEN_TEST_SOURCES}" - CACHE INTERNAL - "Generated protocol_autogen test sources" - ) - - # Register dependencies so CMake reconfigures when macro files change - # (to update the list of output files) - set_property( - DIRECTORY - APPEND - PROPERTY - CMAKE_CONFIGURE_DEPENDS - "${TRANSACTIONS_MACRO}" - "${LEDGER_ENTRIES_MACRO}" - ) -endfunction() +# Custom target for code generation, excluded from ALL. +# Run manually with: cmake --build . --target code_gen +add_custom_target( + code_gen + COMMAND + ${CMAKE_COMMAND} -DCODEGEN_PYTHON=${CODEGEN_PYTHON} + -DGENERATE_TX_SCRIPT=${GENERATE_TX_SCRIPT} + -DGENERATE_LEDGER_SCRIPT=${GENERATE_LEDGER_SCRIPT} + -DTRANSACTIONS_MACRO=${TRANSACTIONS_MACRO} + -DLEDGER_ENTRIES_MACRO=${LEDGER_ENTRIES_MACRO} + -DSFIELDS_MACRO=${SFIELDS_MACRO} + -DAUTOGEN_HEADER_DIR=${AUTOGEN_HEADER_DIR} + -DAUTOGEN_TEST_DIR=${AUTOGEN_TEST_DIR} -P + "${CMAKE_CURRENT_SOURCE_DIR}/cmake/XrplProtocolAutogenRun.cmake" + WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + COMMENT "Running protocol code generation..." + SOURCES ${ALL_INPUT_FILES} +) diff --git a/cmake/XrplProtocolAutogenRun.cmake b/cmake/XrplProtocolAutogenRun.cmake new file mode 100644 index 0000000000..8bdb37a8e0 --- /dev/null +++ b/cmake/XrplProtocolAutogenRun.cmake @@ -0,0 +1,39 @@ +#[===================================================================[ + Protocol Autogen - Run script invoked by the 'code_gen' target +#]===================================================================] + +# Generate transaction classes. +execute_process( + COMMAND + ${CODEGEN_PYTHON} "${GENERATE_TX_SCRIPT}" "${TRANSACTIONS_MACRO}" + --header-dir "${AUTOGEN_HEADER_DIR}/transactions" --test-dir + "${AUTOGEN_TEST_DIR}/transactions" --sfields-macro "${SFIELDS_MACRO}" + RESULT_VARIABLE TX_RESULT + OUTPUT_VARIABLE TX_OUTPUT + ERROR_VARIABLE TX_ERROR +) +if(NOT TX_RESULT EQUAL 0) + message( + FATAL_ERROR + "Transaction code generation failed:\n${TX_OUTPUT}\n${TX_ERROR}\n${TX_RESULT}" + ) +endif() + +# Generate ledger entry classes. +execute_process( + COMMAND + ${CODEGEN_PYTHON} "${GENERATE_LEDGER_SCRIPT}" "${LEDGER_ENTRIES_MACRO}" + --header-dir "${AUTOGEN_HEADER_DIR}/ledger_entries" --test-dir + "${AUTOGEN_TEST_DIR}/ledger_entries" --sfields-macro "${SFIELDS_MACRO}" + RESULT_VARIABLE LEDGER_RESULT + OUTPUT_VARIABLE LEDGER_OUTPUT + ERROR_VARIABLE LEDGER_ERROR +) +if(NOT LEDGER_RESULT EQUAL 0) + message( + FATAL_ERROR + "Ledger entry code generation failed:\n${LEDGER_OUTPUT}\n${LEDGER_ERROR}\n${TX_RESULT}" + ) +endif() + +message(STATUS "Protocol autogen: code generation complete") diff --git a/scripts/generate_ledger_classes.py b/cmake/scripts/codegen/generate_ledger_classes.py similarity index 92% rename from scripts/generate_ledger_classes.py rename to cmake/scripts/codegen/generate_ledger_classes.py index ad773ab9af..f5513655de 100644 --- a/scripts/generate_ledger_classes.py +++ b/cmake/scripts/codegen/generate_ledger_classes.py @@ -138,28 +138,12 @@ def main(): "--sfields-macro", help="Path to sfields.macro (default: auto-detect from macro_path)", ) - parser.add_argument( - "--list-outputs", - action="store_true", - help="List output files without generating (one per line)", - ) - + parser.add_argument("--venv-dir", help=argparse.SUPPRESS) args = parser.parse_args() # Parse the macro file to get ledger entry names entries = parse_macro_file(args.macro_path) - # If --list-outputs, just print the output file paths and exit - if args.list_outputs: - header_dir = Path(args.header_dir) - for entry in entries: - print(header_dir / f"{entry['name']}.h") - if args.test_dir: - test_dir = Path(args.test_dir) - for entry in entries: - print(test_dir / f"{entry['name']}Tests.cpp") - return - # Auto-detect sfields.macro path if not provided if args.sfields_macro: sfields_path = Path(args.sfields_macro) diff --git a/scripts/generate_tx_classes.py b/cmake/scripts/codegen/generate_tx_classes.py similarity index 92% rename from scripts/generate_tx_classes.py rename to cmake/scripts/codegen/generate_tx_classes.py index f21b7101df..07baefd8b6 100644 --- a/scripts/generate_tx_classes.py +++ b/cmake/scripts/codegen/generate_tx_classes.py @@ -147,28 +147,12 @@ def main(): "--sfields-macro", help="Path to sfields.macro (default: auto-detect from macro_path)", ) - parser.add_argument( - "--list-outputs", - action="store_true", - help="List output files without generating (one per line)", - ) - + parser.add_argument("--venv-dir", help=argparse.SUPPRESS) args = parser.parse_args() # Parse the macro file to get transaction names transactions = parse_macro_file(args.macro_path) - # If --list-outputs, just print the output file paths and exit - if args.list_outputs: - header_dir = Path(args.header_dir) - for tx in transactions: - print(header_dir / f"{tx['name']}.h") - if args.test_dir: - test_dir = Path(args.test_dir) - for tx in transactions: - print(test_dir / f"{tx['name']}Tests.cpp") - return - # Auto-detect sfields.macro path if not provided if args.sfields_macro: sfields_path = Path(args.sfields_macro) diff --git a/scripts/macro_parser_common.py b/cmake/scripts/codegen/macro_parser_common.py similarity index 100% rename from scripts/macro_parser_common.py rename to cmake/scripts/codegen/macro_parser_common.py diff --git a/scripts/requirements.txt b/cmake/scripts/codegen/requirements.txt similarity index 100% rename from scripts/requirements.txt rename to cmake/scripts/codegen/requirements.txt diff --git a/scripts/templates/LedgerEntry.h.mako b/cmake/scripts/codegen/templates/LedgerEntry.h.mako similarity index 100% rename from scripts/templates/LedgerEntry.h.mako rename to cmake/scripts/codegen/templates/LedgerEntry.h.mako diff --git a/scripts/templates/LedgerEntryTests.cpp.mako b/cmake/scripts/codegen/templates/LedgerEntryTests.cpp.mako similarity index 100% rename from scripts/templates/LedgerEntryTests.cpp.mako rename to cmake/scripts/codegen/templates/LedgerEntryTests.cpp.mako diff --git a/scripts/templates/Transaction.h.mako b/cmake/scripts/codegen/templates/Transaction.h.mako similarity index 100% rename from scripts/templates/Transaction.h.mako rename to cmake/scripts/codegen/templates/Transaction.h.mako diff --git a/scripts/templates/TransactionTests.cpp.mako b/cmake/scripts/codegen/templates/TransactionTests.cpp.mako similarity index 100% rename from scripts/templates/TransactionTests.cpp.mako rename to cmake/scripts/codegen/templates/TransactionTests.cpp.mako diff --git a/conan.lock b/conan.lock index 575be2e071..f1d6ed3fa5 100644 --- a/conan.lock +++ b/conan.lock @@ -3,22 +3,22 @@ "requires": [ "zlib/1.3.1#cac0f6daea041b0ccf42934163defb20%1774439233.809", "xxhash/0.8.3#681d36a0a6111fc56e5e45ea182c19cc%1765850149.987", - "sqlite3/3.51.0#66aa11eabd0e34954c5c1c061ad44abe%1763899256.358", + "sqlite3/3.51.0#66aa11eabd0e34954c5c1c061ad44abe%1774467355.988", "soci/4.0.3#fe32b9ad5eb47e79ab9e45a68f363945%1774450067.231", "snappy/1.1.10#968fef506ff261592ec30c574d4a7809%1765850147.878", "secp256k1/0.7.1#481881709eb0bdd0185a12b912bbe8ad%1770910500.329", "rocksdb/10.5.1#4a197eca381a3e5ae8adf8cffa5aacd0%1765850186.86", "re2/20251105#8579cfd0bda4daf0683f9e3898f964b4%1774398111.888", - "protobuf/6.33.5#d96d52ba5baaaa532f47bda866ad87a5%1773224203.27", + "protobuf/6.33.5#d96d52ba5baaaa532f47bda866ad87a5%1774467363.12", "openssl/3.6.1#e6399de266349245a4542fc5f6c71552%1774458290.139", - "nudb/2.0.9#0432758a24204da08fee953ec9ea03cb%1769436073.32", + "nudb/2.0.9#11149c73f8f2baff9a0198fe25971fc7%1774883011.384", "lz4/1.10.0#59fc63cac7f10fbe8e05c7e62c2f3504%1765850143.914", "libiconv/1.17#1e65319e945f2d31941a9d28cc13c058%1765842973.492", "libbacktrace/cci.20210118#a7691bfccd8caaf66309df196790a5a1%1765842973.03", "libarchive/3.8.1#ffee18995c706e02bf96e7a2f7042e0d%1765850144.736", "jemalloc/5.3.0#e951da9cf599e956cebc117880d2d9f8%1729241615.244", "gtest/1.17.0#5224b3b3ff3b4ce1133cbdd27d53ee7d%1768312129.152", - "grpc/1.78.1#b1a9e74b145cc471bed4dc64dc6eb2c1%1772623605.068", + "grpc/1.78.1#b1a9e74b145cc471bed4dc64dc6eb2c1%1774467387.342", "ed25519/2015.03#ae761bdc52730a843f0809bdf6c1b1f6%1765850143.772", "date/3.0.4#862e11e80030356b53c2c38599ceb32b%1765850143.772", "c-ares/1.34.6#545240bb1c40e2cacd4362d6b8967650%1774439234.681", @@ -29,7 +29,7 @@ "build_requires": [ "zlib/1.3.1#cac0f6daea041b0ccf42934163defb20%1774439233.809", "strawberryperl/5.32.1.1#8d114504d172cfea8ea1662d09b6333e%1774447376.964", - "protobuf/6.33.5#d96d52ba5baaaa532f47bda866ad87a5%1773224203.27", + "protobuf/6.33.5#d96d52ba5baaaa532f47bda866ad87a5%1774467363.12", "nasm/2.16.01#31e26f2ee3c4346ecd347911bd126904%1765850144.707", "msys2/cci.latest#d22fe7b2808f5fd34d0a7923ace9c54f%1770657326.649", "m4/1.4.19#5d7a4994e5875d76faf7acf3ed056036%1774365463.87", @@ -41,16 +41,15 @@ ], "python_requires": [], "overrides": { - "boost/1.90.0#d5e8defe7355494953be18524a7f135b": [ - null, - "boost/1.90.0" - ], "protobuf/[>=5.27.0 <7]": [ "protobuf/6.33.5" ], "lz4/1.9.4": [ "lz4/1.10.0" ], + "boost/[>=1.83.0 <1.91.0]": [ + "boost/1.90.0" + ], "sqlite3/[>=3.44 <4]": [ "sqlite3/3.51.0" ], diff --git a/cspell.config.yaml b/cspell.config.yaml index 63edba587d..028f02191e 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -44,6 +44,10 @@ suggestWords: words: - abempty - AMMID + - AMMMPT + - AMMMPToken + - AMMMPTokens + - AMMXRP - amt - amts - asnode @@ -96,6 +100,7 @@ words: - distro - doxyfile - dxrpl + - enabled - endmacro - exceptioned - Falco @@ -148,6 +153,8 @@ words: - ltype - mcmodel - MEMORYSTATUSEX + - MPTAMM + - MPTDEX - Merkle - Metafuncton - misprediction @@ -157,6 +164,7 @@ words: - mptid - mptissuance - mptissuanceid + - mptissue - mptoken - mptokenid - mptokenissuance diff --git a/docs/0001-negative-unl/README.md b/docs/0001-negative-unl/README.md index c863cab9da..dd5f9af2ae 100644 --- a/docs/0001-negative-unl/README.md +++ b/docs/0001-negative-unl/README.md @@ -558,7 +558,7 @@ network delay. A test case specifies: 1. a UNL with different number of validators for different test cases, 1. a network with zero or more non-validator nodes, 1. a sequence of validator reliability change events (by killing/restarting - nodes, or by running modified rippled that does not send all validation + nodes, or by running modified xrpld that does not send all validation messages), 1. the correct outcomes. @@ -566,7 +566,7 @@ For all the test cases, the correct outcomes are verified by examining logs. We will grep the log to see if the correct negative UNLs are generated, and whether or not the network is making progress when it should be. The ripdtop tool will be helpful for monitoring validators' states and ledger progress. Some of the -timing parameters of rippled will be changed to have faster ledger time. Most if +timing parameters of xrpld will be changed to have faster ledger time. Most if not all test cases do not need client transactions. For example, the test cases for the prototype: @@ -583,7 +583,7 @@ For example, the test cases for the prototype: We considered testing with the current unit test framework, specifically the [Consensus Simulation -Framework](https://github.com/ripple/rippled/blob/develop/src/test/csf/README.md) +Framework](https://github.com/XRPLF/rippled/blob/develop/src/test/csf/README.md) (CSF). However, the CSF currently can only test the generic consensus algorithm as in the paper: [Analysis of the XRP Ledger Consensus Protocol](https://arxiv.org/abs/1802.07242). diff --git a/docs/0001-negative-unl/negativeUNLSqDiagram.puml b/docs/0001-negative-unl/negativeUNLSqDiagram.puml index d86b98c01f..5c8d0c1fb3 100644 --- a/docs/0001-negative-unl/negativeUNLSqDiagram.puml +++ b/docs/0001-negative-unl/negativeUNLSqDiagram.puml @@ -4,7 +4,7 @@ skinparam sequenceArrowThickness 2 skinparam roundcorner 20 skinparam maxmessagesize 160 -actor "Rippled Start" as RS +actor "Xrpld Start" as RS participant "Timer" as T participant "NetworkOPs" as NOP participant "ValidatorList" as VL #lightgreen diff --git a/docs/Docker.md b/docs/Docker.md index 9f67c87ee5..4c712148d6 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -1,5 +1,5 @@ -# `rippled` Docker Image +# `xrpld` Docker Image - Some info relating to Docker containers can be found here: [../Builds/containers](../Builds/containers) -- Images for building and testing rippled can be found here: [thejohnfreeman/rippled-docker](https://github.com/thejohnfreeman/rippled-docker/) - - These images do not have rippled. They have all the tools necessary to build rippled. +- Images for building and testing xrpld can be found here: [thejohnfreeman/rippled-docker](https://github.com/thejohnfreeman/rippled-docker/) + - These images do not have xrpld. They have all the tools necessary to build xrpld. diff --git a/docs/Doxyfile b/docs/Doxyfile index 750ae0fb64..caa1db30e7 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -2,7 +2,7 @@ # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "rippled" +PROJECT_NAME = "xrpld" PROJECT_NUMBER = PROJECT_BRIEF = PROJECT_LOGO = diff --git a/docs/HeapProfiling.md b/docs/HeapProfiling.md index 2871cccaba..6fcc9f9a67 100644 --- a/docs/HeapProfiling.md +++ b/docs/HeapProfiling.md @@ -1,4 +1,4 @@ -## Heap profiling of rippled with jemalloc +## Heap profiling of xrpld with jemalloc The jemalloc library provides a good API for doing heap analysis, including a mechanism to dump a description of the heap from within the @@ -7,26 +7,26 @@ activity in general, as well as how to acquire the software, are available on the jemalloc site: [https://github.com/jemalloc/jemalloc/wiki/Use-Case:-Heap-Profiling](https://github.com/jemalloc/jemalloc/wiki/Use-Case:-Heap-Profiling) -jemalloc is acquired separately from rippled, and is not affiliated +jemalloc is acquired separately from xrpld, and is not affiliated with Ripple Labs. If you compile and install jemalloc from the source release with default options, it will install the library and header under `/usr/local/lib` and `/usr/local/include`, respectively. Heap -profiling has been tested with rippled on a Linux platform. It should -work on platforms on which both rippled and jemalloc are available. +profiling has been tested with xrpld on a Linux platform. It should +work on platforms on which both xrpld and jemalloc are available. -To link rippled with jemalloc, the argument +To link xrpld with jemalloc, the argument `profile-jemalloc=` is provided after the optional target. The `` argument should be the same as that of the `--prefix` parameter passed to the jemalloc configure script when building. ## Examples: -Build rippled with jemalloc library under /usr/local/lib and +Build xrpld with jemalloc library under /usr/local/lib and header under /usr/local/include: $ scons profile-jemalloc=/usr/local -Build rippled using clang with the jemalloc library under /opt/local/lib +Build xrpld using clang with the jemalloc library under /opt/local/lib and header under /opt/local/include: $ scons clang profile-jemalloc=/opt/local diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 35fcbba2d1..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,61 +0,0 @@ -# Building documentation - -## Dependencies - -Install these dependencies: - -- [Doxygen](http://www.doxygen.nl): All major platforms have [official binary - distributions](http://www.doxygen.nl/download.html#srcbin), or you can - build from [source](http://www.doxygen.nl/download.html#srcbin). - - MacOS: We recommend installing via Homebrew: `brew install doxygen`. - The executable will be installed in `/usr/local/bin` which is already - in the default `PATH`. - - If you use the official binary distribution, then you'll need to make - Doxygen available to your command line. You can do this by adding - a symbolic link from `/usr/local/bin` to the `doxygen` executable. For - example, - - ``` - $ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen - ``` - -- [PlantUML](http://plantuml.com): - 1. Install a functioning Java runtime, if you don't already have one. - 2. Download [`plantuml.jar`](http://sourceforge.net/projects/plantuml/files/plantuml.jar/download). - -- [Graphviz](https://www.graphviz.org): - - Linux: Install from your package manager. - - Windows: Use an [official installer](https://graphviz.gitlab.io/_pages/Download/Download_windows.html). - - MacOS: Install via Homebrew: `brew install graphviz`. - -## Docker - -Instead of installing the above dependencies locally, you can use the official -build environment Docker image, which has all of them installed already. - -1. Install [Docker](https://docs.docker.com/engine/installation/) -2. Pull the image: - -``` -sudo docker pull rippleci/rippled-ci-builder:2944b78d22db -``` - -3. Run the image from the project folder: - -``` -sudo docker run -v $PWD:/opt/rippled --rm rippleci/rippled-ci-builder:2944b78d22db -``` - -## Build - -There is a `docs` target in the CMake configuration. - -``` -mkdir build -cd build -cmake -Donly_docs=ON .. -cmake --build . --target docs --parallel -``` - -The output will be in `build/docs/html`. diff --git a/docs/build/depend.md b/docs/build/depend.md index 2fa14378aa..f44519ddf9 100644 --- a/docs/build/depend.md +++ b/docs/build/depend.md @@ -20,7 +20,7 @@ CMakeToolchain ``` # If you want to depend on a version of libxrpl that is not in ConanCenter, -# then you can export the recipe from the rippled project. +# then you can export the recipe from the xrpld project. conan export ``` @@ -49,9 +49,9 @@ cmake --build . --parallel ## CMake subdirectory -The second method adds the [rippled][] project as a CMake +The second method adds the [xrpld][] project as a CMake [subdirectory][add_subdirectory]. -This method works well when you keep the rippled project as a Git +This method works well when you keep the xrpld project as a Git [submodule][]. It's good for when you want to make changes to libxrpl as part of your own project. @@ -90,6 +90,6 @@ cmake --build . --parallel [add_subdirectory]: https://cmake.org/cmake/help/latest/command/add_subdirectory.html [submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules -[rippled]: https://github.com/ripple/rippled +[xrpld]: https://github.com/XRPLF/rippled [Conan]: https://docs.conan.io/ [CMake]: https://cmake.org/cmake/help/latest/ diff --git a/docs/build/environment.md b/docs/build/environment.md index 66bed06c26..fb1ebde8bc 100644 --- a/docs/build/environment.md +++ b/docs/build/environment.md @@ -55,7 +55,7 @@ clang --version ### Install Xcode Specific Version (Optional) If you develop other applications using XCode you might be consistently updating to the newest version of Apple Clang. -This will likely cause issues building rippled. You may want to install a specific version of Xcode: +This will likely cause issues building xrpld. You may want to install a specific version of Xcode: 1. **Download Xcode** - Visit [Apple Developer Downloads](https://developer.apple.com/download/more/) diff --git a/docs/build/install.md b/docs/build/install.md index 7be01ce726..d3ce1e9d87 100644 --- a/docs/build/install.md +++ b/docs/build/install.md @@ -1,4 +1,4 @@ -This document contains instructions for installing rippled. +This document contains instructions for installing xrpld. The APT package manager is common on Debian-based Linux distributions like Ubuntu, while the YUM package manager is common on Red Hat-based Linux distributions @@ -8,7 +8,7 @@ and the only supported option for installing custom builds. ## From source -From a source build, you can install rippled and libxrpl using CMake's +From a source build, you can install xrpld and libxrpl using CMake's `--install` mode: ``` @@ -16,7 +16,7 @@ cmake --install . --prefix /opt/local ``` The default [prefix][1] is typically `/usr/local` on Linux and macOS and -`C:/Program Files/rippled` on Windows. +`C:/Program Files/xrpld` on Windows. [1]: https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html @@ -50,9 +50,9 @@ The default [prefix][1] is typically `/usr/local` on Linux and macOS and In particular, make sure that the fingerprint matches. (In the above example, the fingerprint is on the third line, starting with `C001`.) -5. Add the appropriate Ripple repository for your operating system version: +5. Add the appropriate XRPL repository for your operating system version: - echo "deb [signed-by=/usr/local/share/keyrings/ripple-key.gpg] https://repos.ripple.com/repos/rippled-deb focal stable" | \ + echo "deb [signed-by=/usr/local/share/keyrings/ripple-key.gpg] https://repos.ripple.com/repos/xrpld-deb focal stable" | \ sudo tee -a /etc/apt/sources.list.d/ripple.list The above example is appropriate for **Ubuntu 20.04 Focal Fossa**. For other operating systems, replace the word `focal` with one of the following: @@ -61,33 +61,33 @@ The default [prefix][1] is typically `/usr/local` on Linux and macOS and - `bullseye` for **Debian 11 Bullseye** - `buster` for **Debian 10 Buster** - If you want access to development or pre-release versions of `rippled`, use one of the following instead of `stable`: - - `unstable` - Pre-release builds ([`release` branch](https://github.com/ripple/rippled/tree/release)) - - `nightly` - Experimental/development builds ([`develop` branch](https://github.com/ripple/rippled/tree/develop)) + If you want access to development or pre-release versions of `xrpld`, use one of the following instead of `stable`: + - `unstable` - Pre-release builds ([`release` branch](https://github.com/XRPLF/rippled/tree/release)) + - `nightly` - Experimental/development builds ([`develop` branch](https://github.com/XRPLF/rippled/tree/develop)) **Warning:** Unstable and nightly builds may be broken at any time. Do not use these builds for production servers. -6. Fetch the Ripple repository. +6. Fetch the XRPL repository. sudo apt -y update -7. Install the `rippled` software package: +7. Install the `xrpld` software package: - sudo apt -y install rippled + sudo apt -y install xrpld -8. Check the status of the `rippled` service: +8. Check the status of the `xrpld` service: - systemctl status rippled.service + systemctl status xrpld.service - The `rippled` service should start automatically. If not, you can start it manually: + The `xrpld` service should start automatically. If not, you can start it manually: - sudo systemctl start rippled.service + sudo systemctl start xrpld.service -9. Optional: allow `rippled` to bind to privileged ports. +9. Optional: allow `xrpld` to bind to privileged ports. This allows you to serve incoming API requests on port 80 or 443. (If you want to do so, you must also update the config file's port settings.) - sudo setcap 'cap_net_bind_service=+ep' /opt/ripple/bin/rippled + sudo setcap 'cap_net_bind_service=+ep' /opt/xrpld/bin/xrpld ## With the YUM package manager @@ -106,8 +106,8 @@ The default [prefix][1] is typically `/usr/local` on Linux and macOS and enabled=1 gpgcheck=0 repo_gpgcheck=1 - baseurl=https://repos.ripple.com/repos/rippled-rpm/stable/ - gpgkey=https://repos.ripple.com/repos/rippled-rpm/stable/repodata/repomd.xml.key + baseurl=https://repos.ripple.com/repos/xrpld-rpm/stable/ + gpgkey=https://repos.ripple.com/repos/xrpld-rpm/stable/repodata/repomd.xml.key REPOFILE _Unstable_ @@ -118,8 +118,8 @@ The default [prefix][1] is typically `/usr/local` on Linux and macOS and enabled=1 gpgcheck=0 repo_gpgcheck=1 - baseurl=https://repos.ripple.com/repos/rippled-rpm/unstable/ - gpgkey=https://repos.ripple.com/repos/rippled-rpm/unstable/repodata/repomd.xml.key + baseurl=https://repos.ripple.com/repos/xrpld-rpm/unstable/ + gpgkey=https://repos.ripple.com/repos/xrpld-rpm/unstable/repodata/repomd.xml.key REPOFILE _Nightly_ @@ -130,22 +130,22 @@ The default [prefix][1] is typically `/usr/local` on Linux and macOS and enabled=1 gpgcheck=0 repo_gpgcheck=1 - baseurl=https://repos.ripple.com/repos/rippled-rpm/nightly/ - gpgkey=https://repos.ripple.com/repos/rippled-rpm/nightly/repodata/repomd.xml.key + baseurl=https://repos.ripple.com/repos/xrpld-rpm/nightly/ + gpgkey=https://repos.ripple.com/repos/xrpld-rpm/nightly/repodata/repomd.xml.key REPOFILE 2. Fetch the latest repo updates: sudo yum -y update -3. Install the new `rippled` package: +3. Install the new `xrpld` package: - sudo yum install -y rippled + sudo yum install -y xrpld -4. Configure the `rippled` service to start on boot: +4. Configure the `xrpld` service to start on boot: - sudo systemctl enable rippled.service + sudo systemctl enable xrpld.service -5. Start the `rippled` service: +5. Start the `xrpld` service: - sudo systemctl start rippled.service + sudo systemctl start xrpld.service diff --git a/docs/build/sanitizers.md b/docs/build/sanitizers.md index ac3a0cc865..7677775a3d 100644 --- a/docs/build/sanitizers.md +++ b/docs/build/sanitizers.md @@ -1,9 +1,9 @@ -# Sanitizer Configuration for Rippled +# Sanitizer Configuration for Xrpld This document explains how to properly configure and run sanitizers (AddressSanitizer, undefinedbehaviorSanitizer, ThreadSanitizer) with the xrpld project. Corresponding suppression files are located in the `sanitizers/suppressions` directory. -- [Sanitizer Configuration for Rippled](#sanitizer-configuration-for-rippled) +- [Sanitizer Configuration for Xrpld](#sanitizer-configuration-for-xrpld) - [Building with Sanitizers](#building-with-sanitizers) - [Summary](#summary) - [Build steps:](#build-steps) @@ -100,7 +100,7 @@ export LSAN_OPTIONS="include=sanitizers/suppressions/runtime-lsan-options.txt:su - Boost intrusive containers (used in `aged_unordered_container`) trigger false positives - Boost context switching (used in `Workers.cpp`) confuses ASAN's stack tracking -- Since we usually don't build Boost (because we don't want to instrument Boost and detect issues in Boost code) with ASAN but use Boost containers in ASAN instrumented rippled code, it generates false positives. +- Since we usually don't build Boost (because we don't want to instrument Boost and detect issues in Boost code) with ASAN but use Boost containers in ASAN instrumented xrpld code, it generates false positives. - Building dependencies with ASAN instrumentation reduces false positives. But we don't want to instrument dependencies like Boost with ASAN because it is slow (to compile as well as run tests) and not necessary. - See: https://github.com/google/sanitizers/wiki/AddressSanitizerContainerOverflow - More such flags are detailed [here](https://github.com/google/sanitizers/wiki/AddressSanitizerFlags) diff --git a/docs/consensus.md b/docs/consensus.md index 23e5e7d5be..0da23b708a 100644 --- a/docs/consensus.md +++ b/docs/consensus.md @@ -5,9 +5,9 @@ Consensus is the task of reaching agreement within a distributed system in the presence of faulty or even malicious participants. This document outlines the [XRP Ledger Consensus Algorithm](https://arxiv.org/abs/1802.07242) -as implemented in [rippled](https://github.com/ripple/rippled), but +as implemented in [xrpld](https://github.com/XRPLF/rippled), but focuses on its utility as a generic consensus algorithm independent of the -detailed mechanics of the Ripple Consensus Ledger. Most notably, the algorithm +detailed mechanics of the XRPL consensus Ledger. Most notably, the algorithm does not require fully synchronous communication between all nodes in the network, or even a fixed network topology, but instead achieves consensus via collectively trusted subnetworks. @@ -15,7 +15,7 @@ collectively trusted subnetworks. ## Distributed Agreement A challenge for distributed systems is reaching agreement on changes in shared -state. For the Ripple network, the shared state is the current ledger--account +state. For the XRPL network, the shared state is the current ledger--account information, account balances, order books and other financial data. We will refer to shared distributed state as a /ledger/ throughout the remainder of this document. @@ -23,7 +23,7 @@ document. ![Ledger Chain](images/consensus/ledger_chain.png "Ledger Chain") As shown above, new ledgers are made by applying a set of transactions to the -prior ledger. For the Ripple network, transactions include payments, +prior ledger. For the XRPL network, transactions include payments, modification of account settings, updates to offers and more. In a centralized system, generating the next ledger is trivial since there is a @@ -33,10 +33,10 @@ the set of transactions to include, the order to apply those transactions, and even the resulting ledger after applying the transactions. This is even more difficult when some participants are faulty or malicious. -The Ripple network is a decentralized and **trust-full** network. Anyone is free +The XRPL network is a decentralized and **trust-full** network. Anyone is free to join and participants are free to choose a subset of peers that are collectively trusted to not collude in an attempt to defraud the participant. -Leveraging this network of trust, the Ripple algorithm has two main components. +Leveraging this network of trust, the XRPL algorithm has two main components. - _Consensus_ in which network participants agree on the transactions to apply to a prior ledger, based on the positions of their chosen peers. @@ -54,9 +54,9 @@ and was abandoned. The remainder of this section describes the Consensus and Validation algorithms in more detail and is meant as a companion guide to understanding the generic -implementation in `rippled`. The document **does not** discuss correctness, +implementation in `xrpld`. The document **does not** discuss correctness, fault-tolerance or liveness properties of the algorithms or the full details of -how they integrate within `rippled` to support the Ripple Consensus Ledger. +how they integrate within `xrpld` to support the XRPL consensus Ledger. ## Consensus Overview diff --git a/external/README.md b/external/README.md index f6e9f77d2d..4a4181e59e 100644 --- a/external/README.md +++ b/external/README.md @@ -1,6 +1,6 @@ # External Conan recipes -The subdirectories in this directory contain external libraries used by rippled. +The subdirectories in this directory contain external libraries used by xrpld. | Folder | Upstream | Description | | :--------------- | :------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | diff --git a/external/antithesis-sdk/CMakeLists.txt b/external/antithesis-sdk/CMakeLists.txt index 46c7b4bf7a..645b73c530 100644 --- a/external/antithesis-sdk/CMakeLists.txt +++ b/external/antithesis-sdk/CMakeLists.txt @@ -1,11 +1,11 @@ cmake_minimum_required(VERSION 3.18) -# Note, version set explicitly by rippled project +# Note, version set explicitly by xrpld project project(antithesis-sdk-cpp VERSION 0.4.4 LANGUAGES CXX) add_library(antithesis-sdk-cpp INTERFACE antithesis_sdk.h) -# Note, both sections below created by rippled project +# Note, both sections below created by xrpld project target_include_directories(antithesis-sdk-cpp INTERFACE $ $ diff --git a/include/xrpl/basics/BasicConfig.h b/include/xrpl/basics/BasicConfig.h index f02bf07a83..84fb5335cd 100644 --- a/include/xrpl/basics/BasicConfig.h +++ b/include/xrpl/basics/BasicConfig.h @@ -67,9 +67,13 @@ public: legacy(std::string value) { if (lines_.empty()) + { lines_.emplace_back(std::move(value)); + } else + { lines_[0] = std::move(value); + } } /** @@ -84,8 +88,10 @@ public: if (lines_.empty()) return ""; if (lines_.size() > 1) + { Throw( "A legacy value must have exactly one line. Section: " + name_); + } return lines_[0]; } @@ -296,7 +302,7 @@ set(T& target, std::string const& name, Section const& section) if ((found_and_valid = val.has_value())) target = *val; } - catch (boost::bad_lexical_cast&) + catch (boost::bad_lexical_cast const&) // NOLINT(bugprone-empty-catch) { } return found_and_valid; @@ -311,7 +317,7 @@ template bool set(T& target, T const& defaultValue, std::string const& name, Section const& section) { - bool found_and_valid = set(target, name, section); + bool const found_and_valid = set(target, name, section); if (!found_and_valid) target = defaultValue; return found_and_valid; @@ -330,7 +336,7 @@ get(Section const& section, std::string const& name, T const& defaultValue = T{} { return section.value_or(name, defaultValue); } - catch (boost::bad_lexical_cast&) + catch (boost::bad_lexical_cast const&) // NOLINT(bugprone-empty-catch) { } return defaultValue; @@ -345,7 +351,7 @@ get(Section const& section, std::string const& name, char const* defaultValue) if (val.has_value()) return *val; } - catch (boost::bad_lexical_cast&) + catch (boost::bad_lexical_cast const&) // NOLINT(bugprone-empty-catch) { } return defaultValue; diff --git a/include/xrpl/basics/Buffer.h b/include/xrpl/basics/Buffer.h index 5192daf632..02926e9420 100644 --- a/include/xrpl/basics/Buffer.h +++ b/include/xrpl/basics/Buffer.h @@ -24,7 +24,8 @@ public: Buffer() = default; /** Create an uninitialized buffer with the given size. */ - explicit Buffer(std::size_t size) : p_(size ? new std::uint8_t[size] : nullptr), size_(size) + explicit Buffer(std::size_t size) + : p_((size != 0u) ? new std::uint8_t[size] : nullptr), size_(size) { } @@ -36,7 +37,7 @@ public: */ Buffer(void const* data, std::size_t size) : Buffer(size) { - if (size) + if (size != 0u) std::memcpy(p_.get(), data, size); } @@ -114,7 +115,7 @@ public: operator Slice() const noexcept { - if (!size_) + if (size_ == 0u) return Slice{}; return Slice{p_.get(), size_}; } @@ -155,7 +156,7 @@ public: { if (n != size_) { - p_.reset(n ? new std::uint8_t[n] : nullptr); + p_.reset((n != 0u) ? new std::uint8_t[n] : nullptr); size_ = n; } return p_.get(); @@ -199,7 +200,7 @@ operator==(Buffer const& lhs, Buffer const& rhs) noexcept if (lhs.size() != rhs.size()) return false; - if (lhs.size() == 0) + if (lhs.empty()) return true; return std::memcmp(lhs.data(), rhs.data(), lhs.size()) == 0; diff --git a/include/xrpl/basics/CompressionAlgorithms.h b/include/xrpl/basics/CompressionAlgorithms.h index c549a58b93..31525fa915 100644 --- a/include/xrpl/basics/CompressionAlgorithms.h +++ b/include/xrpl/basics/CompressionAlgorithms.h @@ -68,12 +68,15 @@ lz4Decompress( if (decompressedSize <= 0) Throw("lz4Decompress: integer overflow (output)"); + // NOLINTNEXTLINE(readability-suspicious-call-argument) if (LZ4_decompress_safe( reinterpret_cast(in), reinterpret_cast(decompressed), inSize, decompressedSize) != decompressedSize) + { Throw("lz4Decompress: failed"); + } return decompressedSize; } diff --git a/include/xrpl/basics/CountedObject.h b/include/xrpl/basics/CountedObject.h index 55a895dbb1..675d1b163b 100644 --- a/include/xrpl/basics/CountedObject.h +++ b/include/xrpl/basics/CountedObject.h @@ -34,7 +34,7 @@ public: { // Insert ourselves at the front of the lock-free linked list CountedObjects& instance = CountedObjects::getInstance(); - Counter* head; + Counter* head = nullptr; do { @@ -99,7 +99,7 @@ private: Derived classes have their instances counted automatically. This is used for reporting purposes. - @ingroup ripple_basics + @ingroup basics */ template class CountedObject @@ -112,7 +112,6 @@ private: return c; } -public: CountedObject() noexcept { getCounter().increment(); @@ -126,10 +125,13 @@ public: CountedObject& operator=(CountedObject const&) noexcept = default; +public: ~CountedObject() noexcept { getCounter().decrement(); } + + friend Object; }; } // namespace xrpl diff --git a/include/xrpl/basics/DecayingSample.h b/include/xrpl/basics/DecayingSample.h index a8d6a2360e..d4c7388046 100644 --- a/include/xrpl/basics/DecayingSample.h +++ b/include/xrpl/basics/DecayingSample.h @@ -67,7 +67,7 @@ private: } else { - while (elapsed--) + while ((elapsed--) != 0u) m_value -= (m_value + Window - 1) / Window; } } @@ -93,7 +93,7 @@ class DecayWindow public: using time_point = typename Clock::time_point; - explicit DecayWindow(time_point now) : value_(0), when_(now) + explicit DecayWindow(time_point now) : when_(now) { } @@ -125,7 +125,7 @@ private: when_ = now; } - double value_; + double value_{0}; time_point when_; }; diff --git a/include/xrpl/basics/IntrusivePointer.h b/include/xrpl/basics/IntrusivePointer.h index e6261be340..230dec3ebb 100644 --- a/include/xrpl/basics/IntrusivePointer.h +++ b/include/xrpl/basics/IntrusivePointer.h @@ -59,7 +59,7 @@ concept CAdoptTag = std::is_same_v || still retaining the reference counts. For example, for SHAMapInnerNodes the children may be reset in that function. Note that std::shared_pointer WILL run the destructor when the strong count reaches zero, but may not free the - memory used by the object until the weak count reaches zero. In rippled, we + memory used by the object until the weak count reaches zero. In xrpld, we typically allocate shared pointers with the `make_shared` function. When that is used, the memory is not reclaimed until the weak count reaches zero. */ @@ -84,7 +84,8 @@ public: template requires std::convertible_to - SharedIntrusive(SharedIntrusive&& rhs); + SharedIntrusive( + SharedIntrusive&& rhs); // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) SharedIntrusive& operator=(SharedIntrusive const& rhs); @@ -106,7 +107,8 @@ public: template requires std::convertible_to SharedIntrusive& - operator=(SharedIntrusive&& rhs); + operator=( + SharedIntrusive&& rhs); // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) /** Adopt the raw pointer. The strong reference may or may not be incremented, depending on the TAdoptTag @@ -314,7 +316,8 @@ public: template requires std::convertible_to - SharedWeakUnion(SharedIntrusive&& rhs); + SharedWeakUnion( + SharedIntrusive&& rhs); // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) SharedWeakUnion& operator=(SharedWeakUnion const& rhs); @@ -327,7 +330,8 @@ public: template requires std::convertible_to SharedWeakUnion& - operator=(SharedIntrusive&& rhs); + operator=( + SharedIntrusive&& rhs); // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) ~SharedWeakUnion(); diff --git a/include/xrpl/basics/IntrusivePointer.ipp b/include/xrpl/basics/IntrusivePointer.ipp index de57e61ba6..59caf5a931 100644 --- a/include/xrpl/basics/IntrusivePointer.ipp +++ b/include/xrpl/basics/IntrusivePointer.ipp @@ -68,9 +68,7 @@ SharedIntrusive::operator=(SharedIntrusive const& rhs) template template -// clang-format off -requires std::convertible_to -// clang-format on + requires std::convertible_to SharedIntrusive& SharedIntrusive::operator=(SharedIntrusive const& rhs) { @@ -101,9 +99,7 @@ SharedIntrusive::operator=(SharedIntrusive&& rhs) template template -// clang-format off -requires std::convertible_to -// clang-format on + requires std::convertible_to SharedIntrusive& SharedIntrusive::operator=(SharedIntrusive&& rhs) { @@ -307,9 +303,7 @@ WeakIntrusive::WeakIntrusive(SharedIntrusive const& rhs) : ptr_{rhs.unsafe template template -// clang-format off -requires std::convertible_to -// clang-format on + requires std::convertible_to WeakIntrusive& WeakIntrusive::operator=(SharedIntrusive const& rhs) { @@ -454,9 +448,7 @@ SharedWeakUnion::operator=(SharedWeakUnion const& rhs) template template -// clang-format off -requires std::convertible_to -// clang-format on + requires std::convertible_to SharedWeakUnion& SharedWeakUnion::operator=(SharedIntrusive const& rhs) { @@ -470,9 +462,7 @@ SharedWeakUnion::operator=(SharedIntrusive const& rhs) template template -// clang-format off -requires std::convertible_to -// clang-format on + requires std::convertible_to SharedWeakUnion& SharedWeakUnion::operator=(SharedIntrusive&& rhs) { diff --git a/include/xrpl/basics/IntrusiveRefCounts.h b/include/xrpl/basics/IntrusiveRefCounts.h index 3b2be5c625..ea610a521e 100644 --- a/include/xrpl/basics/IntrusiveRefCounts.h +++ b/include/xrpl/basics/IntrusiveRefCounts.h @@ -33,7 +33,7 @@ enum class ReleaseWeakRefAction { noop, destroy }; /** Implement the strong count, weak count, and bit flags for an intrusive pointer. - A class can satisfy the requirements of a xrpl::IntrusivePointer by + A class can satisfy the requirements of an xrpl::IntrusivePointer by inheriting from this class. */ struct IntrusiveRefCounts @@ -247,7 +247,7 @@ IntrusiveRefCounts::releaseStrongRef() const using enum ReleaseStrongRefAction; auto prevIntVal = refCounts.load(std::memory_order_acquire); - while (1) + while (true) { RefCountPair const prevVal{prevIntVal}; XRPL_ASSERT( @@ -298,7 +298,7 @@ IntrusiveRefCounts::addWeakReleaseStrongRef() const // Note: If this becomes a perf bottleneck, the `partialDestroyStartedMask` // may be able to be set non-atomically. But it is easier to reason about // the code if the flag is set atomically. - while (1) + while (true) { RefCountPair const prevVal{prevIntVal}; // Converted the last strong pointer to a weak pointer. @@ -343,7 +343,7 @@ IntrusiveRefCounts::releaseWeakRef() const RefCountPair prev = prevIntVal; if (prev.weak == 1 && prev.strong == 0) { - if (!prev.partialDestroyStartedBit) + if (prev.partialDestroyStartedBit == 0u) { // This case should only be hit if the partialDestroyStartedBit is // set non-atomically (and even then very rarely). The code is kept @@ -352,7 +352,7 @@ IntrusiveRefCounts::releaseWeakRef() const prevIntVal = refCounts.load(std::memory_order_acquire); prev = RefCountPair{prevIntVal}; } - if (!prev.partialDestroyFinishedBit) + if (prev.partialDestroyFinishedBit == 0u) { // partial destroy MUST finish before running a full destroy (when // using weak pointers) @@ -372,7 +372,7 @@ IntrusiveRefCounts::checkoutStrongRefFromWeak() const noexcept while (!refCounts.compare_exchange_weak(curValue, desiredValue, std::memory_order_acq_rel)) { RefCountPair const prev{curValue}; - if (!prev.strong) + if (prev.strong == 0u) return false; desiredValue = curValue + strongDelta; @@ -448,7 +448,7 @@ inline void partialDestructorFinished(T** o) { T& self = **o; - IntrusiveRefCounts::RefCountPair p = + IntrusiveRefCounts::RefCountPair const p = self.refCounts.fetch_or(IntrusiveRefCounts::partialDestroyFinishedMask); XRPL_ASSERT( (!p.partialDestroyFinishedBit && p.partialDestroyStartedBit && !p.strong), diff --git a/include/xrpl/basics/LocalValue.h b/include/xrpl/basics/LocalValue.h index 4ac76b130d..2e7bb73f6c 100644 --- a/include/xrpl/basics/LocalValue.h +++ b/include/xrpl/basics/LocalValue.h @@ -42,10 +42,10 @@ struct LocalValues // Keys are the address of a LocalValue. std::unordered_map> values; - static inline void + static void cleanup(LocalValues* lvs) { - if (lvs && !lvs->onCoro) + if ((lvs != nullptr) && !lvs->onCoro) delete lvs; } }; @@ -89,7 +89,7 @@ T& LocalValue::operator*() { auto lvs = detail::getLocalValues().get(); - if (!lvs) + if (lvs == nullptr) { lvs = new detail::LocalValues(); lvs->onCoro = false; diff --git a/include/xrpl/basics/Log.h b/include/xrpl/basics/Log.h index 08da3e57b5..500a1f37c1 100644 --- a/include/xrpl/basics/Log.h +++ b/include/xrpl/basics/Log.h @@ -226,7 +226,7 @@ private: // expensive argument lists if the stream is not active. #ifndef JLOG #define JLOG(x) \ - if (!x) \ + if (!(x)) \ { \ } \ else \ @@ -235,7 +235,7 @@ private: #ifndef CLOG #define CLOG(ss) \ - if (!ss) \ + if (!(ss)) \ ; \ else \ *ss diff --git a/include/xrpl/basics/Number.h b/include/xrpl/basics/Number.h index e3da029c03..51ade0b5ea 100644 --- a/include/xrpl/basics/Number.h +++ b/include/xrpl/basics/Number.h @@ -73,12 +73,12 @@ struct MantissaRange enum mantissa_scale { small, large }; explicit constexpr MantissaRange(mantissa_scale scale_) - : min(getMin(scale_)), max(min * 10 - 1), log(logTen(min).value_or(-1)), scale(scale_) + : min(getMin(scale_)), log(logTen(min).value_or(-1)), scale(scale_) { } rep min; - rep max; + rep max{(min * 10) - 1}; int log; mantissa_scale scale; @@ -342,7 +342,9 @@ public: constexpr int signum() const noexcept { - return negative_ ? -1 : (mantissa_ ? 1 : 0); + if (negative_) + return -1; + return (mantissa_ != 0u) ? 1 : 0; } Number @@ -402,19 +404,19 @@ public: static void setMantissaScale(MantissaRange::mantissa_scale scale); - inline static internalrep + static internalrep minMantissa() { return range_.get().min; } - inline static internalrep + static internalrep maxMantissa() { return range_.get().max; } - inline static int + static int mantissaLog() { return range_.get().log; @@ -507,16 +509,12 @@ private: class Guard; }; -inline constexpr Number::Number( - bool negative, - internalrep mantissa, - int exponent, - unchecked) noexcept +constexpr Number::Number(bool negative, internalrep mantissa, int exponent, unchecked) noexcept : negative_(negative), mantissa_{mantissa}, exponent_{exponent} { } -inline constexpr Number::Number(internalrep mantissa, int exponent, unchecked) noexcept +constexpr Number::Number(internalrep mantissa, int exponent, unchecked) noexcept : Number(false, mantissa, exponent, unchecked{}) { } @@ -548,7 +546,7 @@ inline Number::Number(rep mantissa) : Number{mantissa, 0} * Please see the "---- External Interface ----" section of the class * documentation for an explanation of why the internal value may be modified. */ -inline constexpr Number::rep +constexpr Number::rep Number::mantissa() const noexcept { auto m = mantissa_; @@ -569,7 +567,7 @@ Number::mantissa() const noexcept * Please see the "---- External Interface ----" section of the class * documentation for an explanation of why the internal value may be modified. */ -inline constexpr int +constexpr int Number::exponent() const noexcept { auto e = exponent_; @@ -584,13 +582,13 @@ Number::exponent() const noexcept return e; } -inline constexpr Number +constexpr Number Number::operator+() const noexcept { return *this; } -inline constexpr Number +constexpr Number Number::operator-() const noexcept { if (mantissa_ == 0) @@ -705,17 +703,19 @@ Number::normalizeToRange(T minMantissa, T maxMantissa) const int exponent = exponent_; if constexpr (std::is_unsigned_v) + { XRPL_ASSERT_PARTS( !negative, "xrpl::Number::normalizeToRange", "Number is non-negative for unsigned range."); + } Number::normalize(negative, mantissa, exponent, minMantissa, maxMantissa); auto const sign = negative ? -1 : 1; return std::make_pair(static_cast(sign * mantissa), exponent); } -inline constexpr Number +constexpr Number abs(Number x) noexcept { if (x < Number{}) @@ -746,7 +746,7 @@ power(Number const& f, unsigned n, unsigned d); // Return 0 if abs(x) < limit, else returns x -inline constexpr Number +constexpr Number squelch(Number const& x, Number const& limit) noexcept { if (abs(x) < limit) diff --git a/include/xrpl/basics/README.md b/include/xrpl/basics/README.md index f8b19522cd..b20b837ed7 100644 --- a/include/xrpl/basics/README.md +++ b/include/xrpl/basics/README.md @@ -2,9 +2,9 @@ Utility functions and classes. -ripple/basic should contain no dependencies on other modules. +The module xrpl/basics should contain no dependencies on other modules. -# Choosing a rippled container. +# Choosing an xrpld container. - `std::vector` - For ordered containers with most insertions or erases at the end. diff --git a/include/xrpl/basics/RangeSet.h b/include/xrpl/basics/RangeSet.h index f6e03cac79..4e54624056 100644 --- a/include/xrpl/basics/RangeSet.h +++ b/include/xrpl/basics/RangeSet.h @@ -117,22 +117,32 @@ from_string(RangeSet& rs, std::string const& s) case 1: { T front; if (!beast::lexicalCastChecked(front, intervals.front())) + { result = false; + } else + { rs.insert(front); + } break; } case 2: { T front; if (!beast::lexicalCastChecked(front, intervals.front())) + { result = false; + } else { T back; if (!beast::lexicalCastChecked(back, intervals.back())) + { result = false; + } else + { rs.insert(range(front, back)); + } } break; } diff --git a/include/xrpl/basics/SlabAllocator.h b/include/xrpl/basics/SlabAllocator.h index d7ca3a87f1..e3fefa3dfb 100644 --- a/include/xrpl/basics/SlabAllocator.h +++ b/include/xrpl/basics/SlabAllocator.h @@ -60,7 +60,7 @@ class SlabAllocator { // Use memcpy to avoid unaligned UB // (will optimize to equivalent code) - std::memcpy(data, &l_, sizeof(std::uint8_t*)); + std::memcpy(data, static_cast(&l_), sizeof(std::uint8_t*)); l_ = data; data += item; } @@ -91,18 +91,18 @@ class SlabAllocator std::uint8_t* allocate() noexcept { - std::uint8_t* ret; + std::uint8_t* ret = nullptr; // NOLINT(misc-const-correctness) { - std::lock_guard l(m_); + std::lock_guard const l(m_); ret = l_; - if (ret) + if (ret != nullptr) { // Use memcpy to avoid unaligned UB // (will optimize to equivalent code) - std::memcpy(&l_, ret, sizeof(std::uint8_t*)); + std::memcpy(static_cast(&l_), ret, sizeof(std::uint8_t*)); } } @@ -123,11 +123,11 @@ class SlabAllocator { XRPL_ASSERT(own(ptr), "xrpl::SlabAllocator::SlabBlock::deallocate : own input"); - std::lock_guard l(m_); + std::lock_guard const l(m_); // Use memcpy to avoid unaligned UB // (will optimize to equivalent code) - std::memcpy(ptr, &l_, sizeof(std::uint8_t*)); + std::memcpy(ptr, static_cast(&l_), sizeof(std::uint8_t*)); l_ = ptr; } }; @@ -159,7 +159,7 @@ public: std::size_t extra, std::size_t alloc = 0, std::size_t align = 0) - : itemAlignment_(align ? align : alignof(Type)) + : itemAlignment_((align != 0u) ? align : alignof(Type)) , itemSize_(boost::alignment::align_up(sizeof(Type) + extra, itemAlignment_)) , slabSize_(alloc) { @@ -210,16 +210,13 @@ public: // No slab can satisfy our request, so we attempt to allocate a new // one here: - std::size_t size = slabSize_; + std::size_t const size = slabSize_; // We want to allocate the memory at a 2 MiB boundary, to make it // possible to use hugepage mappings on Linux: auto buf = boost::alignment::aligned_alloc(megabytes(std::size_t(2)), size); - - // clang-format off - if (!buf) [[unlikely]] + if (buf == nullptr) [[unlikely]] return nullptr; - // clang-format on #if BOOST_OS_LINUX // When allocating large blocks, attempt to leverage Linux's @@ -238,7 +235,7 @@ public: // This operation is essentially guaranteed not to fail but // let's be careful anyways. - if (!boost::alignment::align(itemAlignment_, itemSize_, slabData, slabSize)) + if (boost::alignment::align(itemAlignment_, itemSize_, slabData, slabSize) == nullptr) { boost::alignment::aligned_free(buf); return nullptr; diff --git a/include/xrpl/basics/Slice.h b/include/xrpl/basics/Slice.h index 6aa5446236..bfcbb460f4 100644 --- a/include/xrpl/basics/Slice.h +++ b/include/xrpl/basics/Slice.h @@ -183,7 +183,7 @@ operator==(Slice const& lhs, Slice const& rhs) noexcept if (lhs.size() != rhs.size()) return false; - if (lhs.size() == 0) + if (lhs.empty()) return true; return std::memcmp(lhs.data(), rhs.data(), lhs.size()) == 0; diff --git a/include/xrpl/basics/StringUtilities.h b/include/xrpl/basics/StringUtilities.h index 9cf6cd315d..592eee6d53 100644 --- a/include/xrpl/basics/StringUtilities.h +++ b/include/xrpl/basics/StringUtilities.h @@ -66,12 +66,12 @@ strUnHex(std::size_t strSize, Iterator begin, Iterator end) while (iter != end) { - int cHigh = digitLookupTable[*iter++]; + int const cHigh = digitLookupTable[*iter++]; if (cHigh < 0) return {}; - int cLow = digitLookupTable[*iter++]; + int const cLow = digitLookupTable[*iter++]; if (cLow < 0) return {}; diff --git a/include/xrpl/basics/TaggedCache.h b/include/xrpl/basics/TaggedCache.h index 6cbe8680c9..1a19c653bc 100644 --- a/include/xrpl/basics/TaggedCache.h +++ b/include/xrpl/basics/TaggedCache.h @@ -182,8 +182,7 @@ private: : hook(collector->make_hook(handler)) , size(collector->make_gauge(prefix, "size")) , hit_rate(collector->make_gauge(prefix, "hit_rate")) - , hits(0) - , misses(0) + { } @@ -191,8 +190,8 @@ private: beast::insight::Gauge size; beast::insight::Gauge hit_rate; - std::size_t hits; - std::size_t misses; + std::size_t hits{0}; + std::size_t misses{0}; }; class KeyOnlyEntry @@ -294,10 +293,10 @@ private: clock_type::duration const m_target_age; // Number of items cached - int m_cache_count; + int m_cache_count{0}; cache_type m_cache; // Hold strong reference to recent objects - std::uint64_t m_hits; - std::uint64_t m_misses; + std::uint64_t m_hits{0}; + std::uint64_t m_misses{0}; }; } // namespace xrpl diff --git a/include/xrpl/basics/TaggedCache.ipp b/include/xrpl/basics/TaggedCache.ipp index 8c0fde5e7d..6879ad435d 100644 --- a/include/xrpl/basics/TaggedCache.ipp +++ b/include/xrpl/basics/TaggedCache.ipp @@ -36,9 +36,7 @@ inline TaggedCache< , m_name(name) , m_target_size(size) , m_target_age(expiration) - , m_cache_count(0) - , m_hits(0) - , m_misses(0) + { } diff --git a/include/xrpl/basics/UptimeClock.h b/include/xrpl/basics/UptimeClock.h index 4edd38d274..3f2e09bbe3 100644 --- a/include/xrpl/basics/UptimeClock.h +++ b/include/xrpl/basics/UptimeClock.h @@ -26,7 +26,7 @@ public: explicit UptimeClock() = default; static time_point - now(); // seconds since rippled program start + now(); // seconds since xrpld program start private: static std::atomic now_; diff --git a/include/xrpl/basics/algorithm.h b/include/xrpl/basics/algorithm.h index b3fdd5453d..9dae731a89 100644 --- a/include/xrpl/basics/algorithm.h +++ b/include/xrpl/basics/algorithm.h @@ -23,8 +23,10 @@ generalized_set_intersection( { while (first1 != last1 && first2 != last2) { - if (comp(*first1, *first2)) // if *first1 < *first2 - ++first1; // then reduce first range + if (comp(*first1, *first2)) + { // if *first1 < *first2 + ++first1; // then reduce first range + } else { if (!comp(*first2, *first1)) // if *first1 == *first2 diff --git a/include/xrpl/basics/base_uint.h b/include/xrpl/basics/base_uint.h index 6d2a0b9939..6fe6bacf89 100644 --- a/include/xrpl/basics/base_uint.h +++ b/include/xrpl/basics/base_uint.h @@ -183,11 +183,17 @@ private: return ParseResult::badChar; if (c >= 'a') + { nibble = static_cast(c - 'a' + 0xA); + } else if (c >= 'A') + { nibble = static_cast(c - 'A' + 0xA); + } else if (c <= '9') + { nibble = static_cast(c - '0'); + } if (nibble > 0xFu) return ParseResult::badChar; @@ -212,7 +218,7 @@ private: while (in != sv.end()) { std::uint32_t accum = {}; - for (std::uint32_t shift : {4u, 0u, 12u, 8u, 20u, 16u, 28u, 24u}) + for (std::uint32_t const shift : {4u, 0u, 12u, 8u, 20u, 16u, 28u, 24u}) { if (auto const result = hexCharToUInt(*in++, shift, accum); result != ParseResult::okay) @@ -308,8 +314,10 @@ public: signum() const { for (int i = 0; i < WIDTH; i++) + { if (data_[i] != 0) return 1; + } return 0; } @@ -335,11 +343,13 @@ public: operator=(std::uint64_t uHost) { *this = beast::zero; + // NOLINTBEGIN(cppcoreguidelines-pro-type-member-init) union { unsigned u[2]; std::uint64_t ul; }; + // NOLINTEND(cppcoreguidelines-pro-type-member-init) // Put in least significant bits. ul = boost::endian::native_to_big(uHost); data_[WIDTH - 2] = u[0]; @@ -388,7 +398,7 @@ public: return *this; } - base_uint const + base_uint operator++(int) { // postfix operator @@ -413,7 +423,7 @@ public: return *this; } - base_uint const + base_uint operator--(int) { // postfix operator @@ -442,9 +452,9 @@ public: { std::uint64_t carry = 0; - for (int i = WIDTH; i--;) + for (int i = WIDTH - 1; i >= 0; i--) { - std::uint64_t n = carry + boost::endian::big_to_native(data_[i]) + + std::uint64_t const n = carry + boost::endian::big_to_native(data_[i]) + boost::endian::big_to_native(b.data_[i]); data_[i] = boost::endian::native_to_big(static_cast(n)); @@ -530,7 +540,7 @@ using uint256 = base_uint<256>; using uint192 = base_uint<192>; template -[[nodiscard]] inline constexpr std::strong_ordering +[[nodiscard]] constexpr std::strong_ordering operator<=>(base_uint const& lhs, base_uint const& rhs) { // This comparison might seem wrong on a casual inspection because it @@ -551,7 +561,7 @@ operator<=>(base_uint const& lhs, base_uint const& rhs) } template -[[nodiscard]] inline constexpr bool +[[nodiscard]] constexpr bool operator==(base_uint const& lhs, base_uint const& rhs) { return (lhs <=> rhs) == 0; @@ -559,7 +569,7 @@ operator==(base_uint const& lhs, base_uint const& rhs) //------------------------------------------------------------------------------ template -inline constexpr bool +constexpr bool operator==(base_uint const& a, std::uint64_t b) { return a == base_uint(b); @@ -567,28 +577,28 @@ operator==(base_uint const& a, std::uint64_t b) //------------------------------------------------------------------------------ template -inline constexpr base_uint +constexpr base_uint operator^(base_uint const& a, base_uint const& b) { return base_uint(a) ^= b; } template -inline constexpr base_uint +constexpr base_uint operator&(base_uint const& a, base_uint const& b) { return base_uint(a) &= b; } template -inline constexpr base_uint +constexpr base_uint operator|(base_uint const& a, base_uint const& b) { return base_uint(a) |= b; } template -inline constexpr base_uint +constexpr base_uint operator+(base_uint const& a, base_uint const& b) { return base_uint(a) += b; @@ -621,7 +631,7 @@ template <> inline std::size_t extract(uint256 const& key) { - std::size_t result; + std::size_t result = 0; // Use memcpy to avoid unaligned UB // (will optimize to equivalent code) std::memcpy(&result, key.data(), sizeof(std::size_t)); diff --git a/include/xrpl/basics/contract.h b/include/xrpl/basics/contract.h index f41c272b61..e2d6dafe55 100644 --- a/include/xrpl/basics/contract.h +++ b/include/xrpl/basics/contract.h @@ -54,7 +54,7 @@ Throw(Args&&... args) E e(std::forward(args)...); LogThrow(std::string("Throwing exception of type " + beast::type_name() + ": ") + e.what()); - throw e; + throw std::move(e); } /** Called when faulty logic causes a broken invariant. */ diff --git a/include/xrpl/basics/hardened_hash.h b/include/xrpl/basics/hardened_hash.h index b05ecda7a6..05e6ab417f 100644 --- a/include/xrpl/basics/hardened_hash.h +++ b/include/xrpl/basics/hardened_hash.h @@ -32,7 +32,7 @@ make_seed_pair() noexcept // state_t& operator=(state_t const&) = delete; }; static state_t state; - std::lock_guard lock(state.mutex); + std::lock_guard const lock(state.mutex); return {state.dist(state.gen), state.dist(state.gen)}; } diff --git a/include/xrpl/basics/partitioned_unordered_map.h b/include/xrpl/basics/partitioned_unordered_map.h index f9e55d71a6..8af9341315 100644 --- a/include/xrpl/basics/partitioned_unordered_map.h +++ b/include/xrpl/basics/partitioned_unordered_map.h @@ -231,7 +231,8 @@ public: { // Set partitions to the number of hardware threads if the parameter // is either empty or set to 0. - partitions_ = partitions && *partitions ? *partitions : std::thread::hardware_concurrency(); + partitions_ = + partitions && (*partitions != 0u) ? *partitions : std::thread::hardware_concurrency(); map_.resize(partitions_); XRPL_ASSERT( partitions_, diff --git a/include/xrpl/basics/random.h b/include/xrpl/basics/random.h index 399439c023..6a09d8161b 100644 --- a/include/xrpl/basics/random.h +++ b/include/xrpl/basics/random.h @@ -14,14 +14,16 @@ namespace xrpl { #ifndef __INTELLISENSE__ static_assert( + // NOLINTNEXTLINE(misc-redundant-expression) std::is_integral::value && std::is_unsigned::value, - "The Ripple default PRNG engine must return an unsigned integral type."); + "The XRPL default PRNG engine must return an unsigned integral type."); static_assert( + // NOLINTNEXTLINE(misc-redundant-expression) std::numeric_limits::max() >= std::numeric_limits::max(), - "The Ripple default PRNG engine return must be at least 64 bits wide."); + "The XRPL default PRNG engine return must be at least 64 bits wide."); #endif namespace detail { @@ -56,9 +58,9 @@ default_prng() // The thread-specific PRNGs: thread_local beast::xor_shift_engine engine = [] { - std::uint64_t seed; + std::uint64_t seed = 0; { - std::lock_guard lk(m); + std::lock_guard const lk(m); std::uniform_int_distribution distribution{1}; seed = distribution(seeder); } diff --git a/include/xrpl/basics/safe_cast.h b/include/xrpl/basics/safe_cast.h index 1e33b9663a..d85278b263 100644 --- a/include/xrpl/basics/safe_cast.h +++ b/include/xrpl/basics/safe_cast.h @@ -17,7 +17,7 @@ concept SafeToCast = (std::is_integral_v && std::is_integral_v) && : sizeof(Dest) >= sizeof(Src)); template -inline constexpr std::enable_if_t && std::is_integral_v, Dest> +constexpr std::enable_if_t && std::is_integral_v, Dest> safe_cast(Src s) noexcept { static_assert( @@ -30,14 +30,14 @@ safe_cast(Src s) noexcept } template -inline constexpr std::enable_if_t && std::is_integral_v, Dest> +constexpr std::enable_if_t && std::is_integral_v, Dest> safe_cast(Src s) noexcept { return static_cast(safe_cast>(s)); } template -inline constexpr std::enable_if_t && std::is_enum_v, Dest> +constexpr std::enable_if_t && std::is_enum_v, Dest> safe_cast(Src s) noexcept { return safe_cast(static_cast>(s)); @@ -48,7 +48,7 @@ safe_cast(Src s) noexcept // underlying types become safe, it can be converted to a safe_cast. template -inline constexpr std::enable_if_t && std::is_integral_v, Dest> +constexpr std::enable_if_t && std::is_integral_v, Dest> unsafe_cast(Src s) noexcept { static_assert( @@ -59,14 +59,14 @@ unsafe_cast(Src s) noexcept } template -inline constexpr std::enable_if_t && std::is_integral_v, Dest> +constexpr std::enable_if_t && std::is_integral_v, Dest> unsafe_cast(Src s) noexcept { return static_cast(unsafe_cast>(s)); } template -inline constexpr std::enable_if_t && std::is_enum_v, Dest> +constexpr std::enable_if_t && std::is_enum_v, Dest> unsafe_cast(Src s) noexcept { return unsafe_cast(static_cast>(s)); diff --git a/include/xrpl/beast/asio/io_latency_probe.h b/include/xrpl/beast/asio/io_latency_probe.h index 81c8bc0dfa..9a8a63de4e 100644 --- a/include/xrpl/beast/asio/io_latency_probe.h +++ b/include/xrpl/beast/asio/io_latency_probe.h @@ -23,15 +23,15 @@ private: std::recursive_mutex m_mutex; std::condition_variable_any m_cond; - std::size_t m_count; + std::size_t m_count{1}; duration const m_period; boost::asio::io_context& m_ios; boost::asio::basic_waitable_timer m_timer; - bool m_cancel; + bool m_cancel{false}; public: io_latency_probe(duration const& period, boost::asio::io_context& ios) - : m_count(1), m_period(period), m_ios(ios), m_timer(m_ios), m_cancel(false) + : m_period(period), m_ios(ios), m_timer(m_ios) { } @@ -83,7 +83,7 @@ public: void sample_one(Handler&& handler) { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); if (m_cancel) throw std::logic_error("io_latency_probe is canceled"); boost::asio::post( @@ -98,7 +98,7 @@ public: void sample(Handler&& handler) { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); if (m_cancel) throw std::logic_error("io_latency_probe is canceled"); boost::asio::post( @@ -122,14 +122,14 @@ private: void addref() { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); ++m_count; } void release() { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); if (--m_count == 0) m_cond.notify_all(); } @@ -184,7 +184,7 @@ private: void operator()() const { - if (!m_probe) + if (m_probe == nullptr) return; typename Clock::time_point const now(Clock::now()); typename Clock::duration const elapsed(now - m_start); @@ -192,7 +192,7 @@ private: m_handler(elapsed); { - std::lock_guard lock(m_probe->m_mutex); + std::lock_guard const lock(m_probe->m_mutex); if (m_probe->m_cancel) return; } @@ -202,7 +202,7 @@ private: // Calculate when we want to sample again, and // adjust for the expected latency. // - typename Clock::time_point const when(now + m_probe->m_period - 2 * elapsed); + typename Clock::time_point const when(now + m_probe->m_period - (2 * elapsed)); if (when <= now) { @@ -224,7 +224,7 @@ private: void operator()(boost::system::error_code const& ec) { - if (!m_probe) + if (m_probe == nullptr) return; typename Clock::time_point const now(Clock::now()); boost::asio::post( diff --git a/include/xrpl/beast/container/aged_map.h b/include/xrpl/beast/container/aged_map.h index e9505f2763..3815f44329 100644 --- a/include/xrpl/beast/container/aged_map.h +++ b/include/xrpl/beast/container/aged_map.h @@ -16,4 +16,4 @@ template < class Allocator = std::allocator>> using aged_map = detail::aged_ordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/aged_multimap.h b/include/xrpl/beast/container/aged_multimap.h index 7625694f66..bb098b63b2 100644 --- a/include/xrpl/beast/container/aged_multimap.h +++ b/include/xrpl/beast/container/aged_multimap.h @@ -16,4 +16,4 @@ template < class Allocator = std::allocator>> using aged_multimap = detail::aged_ordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/aged_multiset.h b/include/xrpl/beast/container/aged_multiset.h index 8d906c694f..60682db0ca 100644 --- a/include/xrpl/beast/container/aged_multiset.h +++ b/include/xrpl/beast/container/aged_multiset.h @@ -15,4 +15,4 @@ template < class Allocator = std::allocator> using aged_multiset = detail::aged_ordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/aged_set.h b/include/xrpl/beast/container/aged_set.h index 2c601f5f41..76ff40b63a 100644 --- a/include/xrpl/beast/container/aged_set.h +++ b/include/xrpl/beast/container/aged_set.h @@ -15,4 +15,4 @@ template < class Allocator = std::allocator> using aged_set = detail::aged_ordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/aged_unordered_map.h b/include/xrpl/beast/container/aged_unordered_map.h index 520ffe5848..ea53320e91 100644 --- a/include/xrpl/beast/container/aged_unordered_map.h +++ b/include/xrpl/beast/container/aged_unordered_map.h @@ -17,4 +17,4 @@ template < class Allocator = std::allocator>> using aged_unordered_map = detail::aged_unordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/aged_unordered_multimap.h b/include/xrpl/beast/container/aged_unordered_multimap.h index dc6338949b..9cb1443cad 100644 --- a/include/xrpl/beast/container/aged_unordered_multimap.h +++ b/include/xrpl/beast/container/aged_unordered_multimap.h @@ -17,4 +17,4 @@ template < class Allocator = std::allocator>> using aged_unordered_multimap = detail::aged_unordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/aged_unordered_multiset.h b/include/xrpl/beast/container/aged_unordered_multiset.h index b251f20077..ced01987aa 100644 --- a/include/xrpl/beast/container/aged_unordered_multiset.h +++ b/include/xrpl/beast/container/aged_unordered_multiset.h @@ -17,4 +17,4 @@ template < using aged_unordered_multiset = detail::aged_unordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/aged_unordered_set.h b/include/xrpl/beast/container/aged_unordered_set.h index a1c032e159..3f4575f6bc 100644 --- a/include/xrpl/beast/container/aged_unordered_set.h +++ b/include/xrpl/beast/container/aged_unordered_set.h @@ -16,4 +16,4 @@ template < class Allocator = std::allocator> using aged_unordered_set = detail::aged_unordered_container; -} +} // namespace beast diff --git a/include/xrpl/beast/container/detail/aged_associative_container.h b/include/xrpl/beast/container/detail/aged_associative_container.h index 34e9560cbb..af6774eb9e 100644 --- a/include/xrpl/beast/container/detail/aged_associative_container.h +++ b/include/xrpl/beast/container/detail/aged_associative_container.h @@ -26,7 +26,7 @@ struct aged_associative_container_extract_t Value const& operator()(Value const& value) const { - return value; + return value; // NOLINT(bugprone-return-const-ref-from-parameter) } }; diff --git a/include/xrpl/beast/container/detail/aged_container_iterator.h b/include/xrpl/beast/container/detail/aged_container_iterator.h index 99aab2a9a9..7a0e60bca8 100644 --- a/include/xrpl/beast/container/detail/aged_container_iterator.h +++ b/include/xrpl/beast/container/detail/aged_container_iterator.h @@ -16,10 +16,10 @@ class aged_container_iterator { public: using iterator_category = typename std::iterator_traits::iterator_category; - using value_type = typename std::conditional< + using value_type = std::conditional_t< is_const, typename Iterator::value_type::stashed::value_type const, - typename Iterator::value_type::stashed::value_type>::type; + typename Iterator::value_type::stashed::value_type>; using difference_type = typename std::iterator_traits::difference_type; using pointer = value_type*; using reference = value_type&; @@ -32,9 +32,9 @@ public: template < bool other_is_const, class OtherIterator, - class = typename std::enable_if< - (other_is_const == false || is_const == true) && - std::is_same::value == false>::type> + class = std::enable_if_t< + (!other_is_const || is_const) && + !static_cast(std::is_same_v)>> explicit aged_container_iterator( aged_container_iterator const& other) : m_iter(other.m_iter) @@ -42,9 +42,7 @@ public: } // Disable constructing a const_iterator from a non-const_iterator. - template < - bool other_is_const, - class = typename std::enable_if::type> + template > aged_container_iterator(aged_container_iterator const& other) : m_iter(other.m_iter) { @@ -53,8 +51,8 @@ public: // Disable assigning a const_iterator to a non-const iterator template auto - operator=(aged_container_iterator const& other) -> typename std:: - enable_if::type + operator=(aged_container_iterator const& other) + -> std::enable_if_t { m_iter = other.m_iter; return *this; diff --git a/include/xrpl/beast/container/detail/aged_ordered_container.h b/include/xrpl/beast/container/detail/aged_ordered_container.h index b482cd33c1..554fed2d58 100644 --- a/include/xrpl/beast/container/detail/aged_ordered_container.h +++ b/include/xrpl/beast/container/detail/aged_ordered_container.h @@ -257,12 +257,15 @@ private: config_t(config_t&& other) : KeyValueCompare(std::move(other.key_compare())) - , beast::detail::empty_base_optimization(std::move(other)) + , beast::detail::empty_base_optimization(std::move( + static_cast&>(other))) , clock(other.clock) { } - config_t(config_t&& other, Allocator const& alloc) + config_t( + config_t&& other, // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) + Allocator const& alloc) : KeyValueCompare(std::move(other.key_compare())) , beast::detail::empty_base_optimization(alloc) , clock(other.clock) @@ -552,7 +555,10 @@ public: aged_ordered_container(aged_ordered_container&& other); - aged_ordered_container(aged_ordered_container&& other, Allocator const& alloc); + aged_ordered_container( + // NOLINTNEXTLINE(cppcoreguidelines-rvalue-reference-param-not-moved) + aged_ordered_container&& other, + Allocator const& alloc); aged_ordered_container(std::initializer_list init, clock_type& clock); @@ -1290,7 +1296,7 @@ aged_ordered_container::aged_ template aged_ordered_container::aged_ordered_container( - aged_ordered_container&& other, + aged_ordered_container&& other, // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) Allocator const& alloc) : m_config(std::move(other.m_config), alloc) #if BOOST_VERSION >= 108000 diff --git a/include/xrpl/beast/container/detail/aged_unordered_container.h b/include/xrpl/beast/container/detail/aged_unordered_container.h index d912f06ce1..dfc853f019 100644 --- a/include/xrpl/beast/container/detail/aged_unordered_container.h +++ b/include/xrpl/beast/container/detail/aged_unordered_container.h @@ -318,7 +318,9 @@ private: { } - config_t(config_t&& other, Allocator const& alloc) + config_t( + config_t&& other, // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) + Allocator const& alloc) : ValueHash(std::move(other.hash_function())) , KeyValueEqual(std::move(other.key_eq())) , beast::detail::empty_base_optimization(alloc) @@ -774,7 +776,10 @@ public: aged_unordered_container(aged_unordered_container&& other); - aged_unordered_container(aged_unordered_container&& other, Allocator const& alloc); + aged_unordered_container( + // NOLINTNEXTLINE(cppcoreguidelines-rvalue-reference-param-not-moved) + aged_unordered_container&& other, + Allocator const& alloc); aged_unordered_container(std::initializer_list init, clock_type& clock); @@ -1838,7 +1843,10 @@ template < class KeyEqual, class Allocator> aged_unordered_container:: - aged_unordered_container(aged_unordered_container&& other, Allocator const& alloc) + aged_unordered_container( + // NOLINTNEXTLINE(cppcoreguidelines-rvalue-reference-param-not-moved) + aged_unordered_container&& other, + Allocator const& alloc) : m_config(std::move(other.m_config), alloc) , m_buck(alloc) , m_cont(m_buck, std::cref(m_config.value_hash()), std::cref(m_config.key_value_equal())) diff --git a/include/xrpl/beast/core/List.h b/include/xrpl/beast/core/List.h index 504dec4c4a..a6ba71680b 100644 --- a/include/xrpl/beast/core/List.h +++ b/include/xrpl/beast/core/List.h @@ -35,9 +35,11 @@ struct CopyConst template class ListNode { -private: + ListNode() = default; + using value_type = T; + friend T; friend class List; template @@ -449,7 +451,7 @@ public: iterator erase(iterator pos) noexcept { - Node* node = &*pos; + Node const* node = &*pos; ++pos; node->m_next->m_prev = node->m_prev; node->m_prev->m_next = node->m_next; diff --git a/include/xrpl/beast/core/LockFreeStack.h b/include/xrpl/beast/core/LockFreeStack.h index fe3baa0564..cf512725fe 100644 --- a/include/xrpl/beast/core/LockFreeStack.h +++ b/include/xrpl/beast/core/LockFreeStack.h @@ -187,7 +187,7 @@ public: bool push_front(Node* node) { - bool first; + bool first = false; Node* old_head = m_head.load(std::memory_order_relaxed); do { @@ -211,7 +211,7 @@ public: pop_front() { Node* node = m_head.load(); - Node* new_head; + Node* new_head = nullptr; do { if (node == &m_end) diff --git a/include/xrpl/beast/core/SemanticVersion.h b/include/xrpl/beast/core/SemanticVersion.h index f839ef8c53..244783234c 100644 --- a/include/xrpl/beast/core/SemanticVersion.h +++ b/include/xrpl/beast/core/SemanticVersion.h @@ -40,12 +40,12 @@ public: std::string print() const; - inline bool + bool isRelease() const noexcept { return preReleaseIdentifiers.empty(); } - inline bool + bool isPreRelease() const noexcept { return !isRelease(); diff --git a/include/xrpl/beast/hash/hash_append.h b/include/xrpl/beast/hash/hash_append.h index d456bb3a73..cfae15e26b 100644 --- a/include/xrpl/beast/hash/hash_append.h +++ b/include/xrpl/beast/hash/hash_append.h @@ -203,7 +203,8 @@ template inline std::enable_if_t::value> hash_append(Hasher& h, T const& t) noexcept { - h(std::addressof(t), sizeof(t)); + // NOLINTNEXTLINE(bugprone-sizeof-expression) + h(static_cast(std::addressof(t)), sizeof(t)); } template diff --git a/include/xrpl/beast/hash/xxhasher.h b/include/xrpl/beast/hash/xxhasher.h index 473907ea89..f89b15314a 100644 --- a/include/xrpl/beast/hash/xxhasher.h +++ b/include/xrpl/beast/hash/xxhasher.h @@ -23,7 +23,7 @@ private: // A 64-byte buffer should to be big enough for us static constexpr std::size_t INTERNAL_BUFFER_SIZE = 64; - alignas(64) std::array buffer_; + alignas(64) std::array buffer_{}; std::span readBuffer_; std::span writeBuffer_; @@ -64,7 +64,7 @@ private: void flushToState(void const* data, std::size_t len) { - if (!state_) + if (state_ == nullptr) { state_ = allocState(); if (seed_.has_value()) @@ -78,7 +78,7 @@ private: } XXH3_64bits_update(state_, readBuffer_.data(), readBuffer_.size()); resetBuffers(); - if (data && len) + if ((data != nullptr) && (len != 0u)) { XXH3_64bits_update(state_, data, len); } @@ -87,22 +87,18 @@ private: result_type retrieveHash() { - if (state_) + if (state_ != nullptr) { flushToState(nullptr, 0); return XXH3_64bits_digest(state_); } - else + + if (seed_.has_value()) { - if (seed_.has_value()) - { - return XXH3_64bits_withSeed(readBuffer_.data(), readBuffer_.size(), *seed_); - } - else - { - return XXH3_64bits(readBuffer_.data(), readBuffer_.size()); - } + return XXH3_64bits_withSeed(readBuffer_.data(), readBuffer_.size(), *seed_); } + + return XXH3_64bits(readBuffer_.data(), readBuffer_.size()); } public: @@ -119,7 +115,7 @@ public: ~xxhasher() noexcept { - if (state_) + if (state_ != nullptr) { XXH3_freeState(state_); } diff --git a/include/xrpl/beast/net/IPAddress.h b/include/xrpl/beast/net/IPAddress.h index 2ac4c3bc43..277a43e5d8 100644 --- a/include/xrpl/beast/net/IPAddress.h +++ b/include/xrpl/beast/net/IPAddress.h @@ -70,9 +70,13 @@ hash_append(Hasher& h, beast::IP::Address const& addr) noexcept { using beast::hash_append; if (addr.is_v4()) + { hash_append(h, addr.to_v4().to_bytes()); + } else if (addr.is_v6()) + { hash_append(h, addr.to_v6().to_bytes()); + } else { // LCOV_EXCL_START diff --git a/include/xrpl/beast/net/IPEndpoint.h b/include/xrpl/beast/net/IPEndpoint.h index 7a0394cbd1..5cb97f7afe 100644 --- a/include/xrpl/beast/net/IPEndpoint.h +++ b/include/xrpl/beast/net/IPEndpoint.h @@ -69,12 +69,12 @@ public: { return m_addr.is_v6(); } - AddressV4 const + AddressV4 to_v4() const { return m_addr.to_v4(); } - AddressV6 const + AddressV6 to_v6() const { return m_addr.to_v6(); diff --git a/include/xrpl/beast/rfc2616.h b/include/xrpl/beast/rfc2616.h index b19c2c511a..08d49eb26c 100644 --- a/include/xrpl/beast/rfc2616.h +++ b/include/xrpl/beast/rfc2616.h @@ -53,8 +53,9 @@ is_white(char c) case '\t': case '\v': return true; + default: + return false; }; - return false; } template @@ -349,8 +350,10 @@ bool token_in_list(boost::string_ref const& value, boost::string_ref const& token) { for (auto const& item : make_list(value)) + { if (ci_equal(item, token)) return true; + } return false; } @@ -359,8 +362,10 @@ bool is_keep_alive(boost::beast::http::message const& m) { if (m.version() <= 10) + { return boost::beast::http::token_list{m[boost::beast::http::field::connection]}.exists( "keep-alive"); + } return !boost::beast::http::token_list{m[boost::beast::http::field::connection]}.exists( "close"); } diff --git a/include/xrpl/beast/test/yield_to.h b/include/xrpl/beast/test/yield_to.h index 6c49c4a89c..07c1ef0799 100644 --- a/include/xrpl/beast/test/yield_to.h +++ b/include/xrpl/beast/test/yield_to.h @@ -44,7 +44,7 @@ public: : work_(boost::asio::make_work_guard(ios_)) { threads_.reserve(concurrency); - while (concurrency--) + while ((concurrency--) != 0u) threads_.emplace_back([&] { ios_.run(); }); } @@ -114,7 +114,7 @@ enable_yield_to::spawn(F0&& f, FN&&... fn) boost::context::fixedsize_stack(2 * 1024 * 1024), [&](yield_context yield) { f(yield); - std::lock_guard lock{m_}; + std::lock_guard const lock{m_}; if (--running_ == 0) cv_.notify_all(); }, diff --git a/include/xrpl/beast/type_name.h b/include/xrpl/beast/type_name.h index 99b90d1757..600f530adc 100644 --- a/include/xrpl/beast/type_name.h +++ b/include/xrpl/beast/type_name.h @@ -32,9 +32,13 @@ type_name() if (std::is_volatile::value) name += " volatile"; if (std::is_lvalue_reference::value) + { name += "&"; + } else if (std::is_rvalue_reference::value) + { name += "&&"; + } return name; } diff --git a/include/xrpl/beast/unit_test/recorder.h b/include/xrpl/beast/unit_test/recorder.h index 8f956fda88..0b3fc34787 100644 --- a/include/xrpl/beast/unit_test/recorder.h +++ b/include/xrpl/beast/unit_test/recorder.h @@ -50,7 +50,7 @@ private: virtual void on_case_end() override { - if (m_case.tests.size() > 0) + if (!m_case.tests.empty()) m_suite.insert(std::move(m_case)); } diff --git a/include/xrpl/beast/unit_test/reporter.h b/include/xrpl/beast/unit_test/reporter.h index 63ad90ff7c..011e2ca3c0 100644 --- a/include/xrpl/beast/unit_test/reporter.h +++ b/include/xrpl/beast/unit_test/reporter.h @@ -118,18 +118,18 @@ private: //------------------------------------------------------------------------------ -template +template void -reporter<_>::suite_results::add(case_results const& r) +reporter::suite_results::add(case_results const& r) { ++cases; total += r.total; failed += r.failed; } -template +template void -reporter<_>::results::add(suite_results const& r) +reporter::results::add(suite_results const& r) { ++suites; total += r.total; @@ -160,13 +160,13 @@ reporter<_>::results::add(suite_results const& r) //------------------------------------------------------------------------------ -template -reporter<_>::reporter(std::ostream& os) : os_(os) +template +reporter::reporter(std::ostream& os) : os_(os) { } -template -reporter<_>::~reporter() +template +reporter::~reporter() { if (results_.top.size() > 0) { @@ -180,9 +180,9 @@ reporter<_>::~reporter() << amount{results_.failed, "failure"} << std::endl; } -template +template std::string -reporter<_>::fmtdur(typename clock_type::duration const& d) +reporter::fmtdur(typename clock_type::duration const& d) { using namespace std::chrono; auto const ms = duration_cast(d); @@ -193,46 +193,46 @@ reporter<_>::fmtdur(typename clock_type::duration const& d) return ss.str(); } -template +template void -reporter<_>::on_suite_begin(suite_info const& info) +reporter::on_suite_begin(suite_info const& info) { suite_results_ = suite_results{info.full_name()}; } -template +template void -reporter<_>::on_suite_end() +reporter::on_suite_end() { results_.add(suite_results_); } -template +template void -reporter<_>::on_case_begin(std::string const& name) +reporter::on_case_begin(std::string const& name) { case_results_ = case_results(name); os_ << suite_results_.name << (case_results_.name.empty() ? "" : (" " + case_results_.name)) << std::endl; } -template +template void -reporter<_>::on_case_end() +reporter::on_case_end() { suite_results_.add(case_results_); } -template +template void -reporter<_>::on_pass() +reporter::on_pass() { ++case_results_.total; } -template +template void -reporter<_>::on_fail(std::string const& reason) +reporter::on_fail(std::string const& reason) { ++case_results_.failed; ++case_results_.total; @@ -240,9 +240,9 @@ reporter<_>::on_fail(std::string const& reason) << std::endl; } -template +template void -reporter<_>::on_log(std::string const& s) +reporter::on_log(std::string const& s) { os_ << s; } diff --git a/include/xrpl/beast/unit_test/results.h b/include/xrpl/beast/unit_test/results.h index cbd0a71057..57327639a5 100644 --- a/include/xrpl/beast/unit_test/results.h +++ b/include/xrpl/beast/unit_test/results.h @@ -35,10 +35,10 @@ private: class tests_t : public detail::const_container> { private: - std::size_t failed_; + std::size_t failed_{0}; public: - tests_t() : failed_(0) + tests_t() { } @@ -145,9 +145,9 @@ public: void insert(case_results&& r) { - cont().emplace_back(std::move(r)); total_ += r.tests.total(); failed_ += r.tests.failed(); + cont().emplace_back(std::move(r)); } void @@ -167,12 +167,12 @@ public: class results : public detail::const_container> { private: - std::size_t m_cases; - std::size_t total_; - std::size_t failed_; + std::size_t m_cases{0}; + std::size_t total_{0}; + std::size_t failed_{0}; public: - results() : m_cases(0), total_(0), failed_(0) + results() { } diff --git a/include/xrpl/beast/unit_test/runner.h b/include/xrpl/beast/unit_test/runner.h index 90d8a2f4b5..7b93d8ad56 100644 --- a/include/xrpl/beast/unit_test/runner.h +++ b/include/xrpl/beast/unit_test/runner.h @@ -198,8 +198,10 @@ runner::run_if(FwdIter first, FwdIter last, Pred pred) { bool failed(false); for (; first != last; ++first) + { if (pred(*first)) failed = run(*first) || failed; + } return failed; } @@ -219,8 +221,10 @@ runner::run_each_if(SequenceContainer const& c, Pred pred) { bool failed(false); for (auto const& s : c) + { if (pred(s)) failed = run(s) || failed; + } return failed; } @@ -228,7 +232,7 @@ template void runner::testcase(std::string const& name) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // Name may not be empty BOOST_ASSERT(default_ || !name.empty()); // Forgot to call pass or fail @@ -244,7 +248,7 @@ template void runner::pass() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (default_) testcase(""); on_pass(); @@ -255,7 +259,7 @@ template void runner::fail(std::string const& reason) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (default_) testcase(""); on_fail(reason); @@ -267,7 +271,7 @@ template void runner::log(std::string const& s) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (default_) testcase(""); on_log(s); diff --git a/include/xrpl/beast/unit_test/suite.h b/include/xrpl/beast/unit_test/suite.h index 9031f9833e..33e9f462d9 100644 --- a/include/xrpl/beast/unit_test/suite.h +++ b/include/xrpl/beast/unit_test/suite.h @@ -36,7 +36,7 @@ make_reason(String const& reason, char const* file, int line) } // namespace detail -class thread; +class Thread; enum abort_t { no_abort_on_fail, abort_on_fail }; @@ -295,12 +295,12 @@ public: } private: - friend class thread; + friend class Thread; static suite** p_this_suite() { - static suite* pts = nullptr; + static suite* pts = nullptr; // NOLINT(misc-const-correctness) return &pts; } @@ -309,7 +309,7 @@ private: run() = 0; void - propagate_abort(); + propagate_abort() const; template void @@ -486,9 +486,13 @@ suite::unexpected(Condition shouldBeFalse, String const& reason) { bool const b = static_cast(shouldBeFalse); if (!b) + { pass(); + } else + { fail(reason); + } return !b; } @@ -522,7 +526,7 @@ suite::fail(String const& reason, char const* file, int line) } inline void -suite::propagate_abort() +suite::propagate_abort() const { if (abort_ && aborted_) BOOST_THROW_EXCEPTION(abort_exception()); @@ -538,7 +542,7 @@ suite::run(runner& r) { run(); } - catch (abort_exception const&) + catch (abort_exception const&) // NOLINT(bugprone-empty-catch) { // ends the suite } diff --git a/include/xrpl/beast/unit_test/thread.h b/include/xrpl/beast/unit_test/thread.h index b49f8ed36e..9267b84ac3 100644 --- a/include/xrpl/beast/unit_test/thread.h +++ b/include/xrpl/beast/unit_test/thread.h @@ -14,7 +14,7 @@ namespace beast { namespace unit_test { /** Replacement for std::thread that handles exceptions in unit tests. */ -class thread +class Thread { private: suite* s_ = nullptr; @@ -24,17 +24,17 @@ public: using id = std::thread::id; using native_handle_type = std::thread::native_handle_type; - thread() = default; - thread(thread const&) = delete; - thread& - operator=(thread const&) = delete; + Thread() = default; + Thread(Thread const&) = delete; + Thread& + operator=(Thread const&) = delete; - thread(thread&& other) : s_(other.s_), t_(std::move(other.t_)) + Thread(Thread&& other) : s_(other.s_), t_(std::move(other.t_)) { } - thread& - operator=(thread&& other) + Thread& + operator=(Thread&& other) { s_ = other.s_; t_ = std::move(other.t_); @@ -42,10 +42,10 @@ public: } template - explicit thread(suite& s, F&& f, Args&&... args) : s_(&s) + explicit Thread(suite& s, F&& f, Args&&... args) : s_(&s) { std::function b = std::bind(std::forward(f), std::forward(args)...); - t_ = std::thread(&thread::run, this, std::move(b)); + t_ = std::thread(&Thread::run, this, std::move(b)); } bool @@ -80,7 +80,7 @@ public: } void - swap(thread& other) + swap(Thread& other) { std::swap(s_, other.s_); std::swap(t_, other.t_); @@ -94,7 +94,7 @@ private: { f(); } - catch (suite::abort_exception const&) + catch (suite::abort_exception const&) // NOLINT(bugprone-empty-catch) { } catch (std::exception const& e) diff --git a/include/xrpl/beast/utility/Journal.h b/include/xrpl/beast/utility/Journal.h index 2ac5050b2d..0d293fc656 100644 --- a/include/xrpl/beast/utility/Journal.h +++ b/include/xrpl/beast/utility/Journal.h @@ -13,13 +13,13 @@ enum Severity { kAll = 0, kTrace = kAll, - kDebug, - kInfo, - kWarning, - kError, - kFatal, + kDebug = 1, + kInfo = 2, + kWarning = 3, + kError = 4, + kFatal = 5, - kDisabled, + kDisabled = 6, kNone = kDisabled }; } // namespace severities @@ -109,12 +109,12 @@ public: }; #ifndef __INTELLISENSE__ - static_assert(std::is_default_constructible::value == false, ""); - static_assert(std::is_copy_constructible::value == false, ""); - static_assert(std::is_move_constructible::value == false, ""); - static_assert(std::is_copy_assignable::value == false, ""); - static_assert(std::is_move_assignable::value == false, ""); - static_assert(std::is_nothrow_destructible::value == true, ""); + static_assert(!std::is_default_constructible_v, ""); + static_assert(!std::is_copy_constructible_v, ""); + static_assert(!std::is_move_constructible_v, ""); + static_assert(!std::is_copy_assignable_v, ""); + static_assert(!std::is_move_assignable_v, ""); + static_assert(std::is_nothrow_destructible_v, ""); #endif /** Returns a Sink which does nothing. */ @@ -165,12 +165,12 @@ public: }; #ifndef __INTELLISENSE__ - static_assert(std::is_default_constructible::value == false, ""); - static_assert(std::is_copy_constructible::value == true, ""); - static_assert(std::is_move_constructible::value == true, ""); - static_assert(std::is_copy_assignable::value == false, ""); - static_assert(std::is_move_assignable::value == false, ""); - static_assert(std::is_nothrow_destructible::value == true, ""); + static_assert(!std::is_default_constructible_v, ""); + static_assert(std::is_copy_constructible_v, ""); + static_assert(std::is_move_constructible_v, ""); + static_assert(!std::is_copy_assignable_v, ""); + static_assert(!std::is_move_assignable_v, ""); + static_assert(std::is_nothrow_destructible_v, ""); #endif //-------------------------------------------------------------------------- @@ -247,12 +247,12 @@ public: }; #ifndef __INTELLISENSE__ - static_assert(std::is_default_constructible::value == true, ""); - static_assert(std::is_copy_constructible::value == true, ""); - static_assert(std::is_move_constructible::value == true, ""); - static_assert(std::is_copy_assignable::value == false, ""); - static_assert(std::is_move_assignable::value == false, ""); - static_assert(std::is_nothrow_destructible::value == true, ""); + static_assert(std::is_default_constructible_v, ""); + static_assert(std::is_copy_constructible_v, ""); + static_assert(std::is_move_constructible_v, ""); + static_assert(!std::is_copy_assignable_v, ""); + static_assert(!std::is_move_assignable_v, ""); + static_assert(std::is_nothrow_destructible_v, ""); #endif //-------------------------------------------------------------------------- @@ -330,12 +330,12 @@ public: }; #ifndef __INTELLISENSE__ -static_assert(std::is_default_constructible::value == false, ""); -static_assert(std::is_copy_constructible::value == true, ""); -static_assert(std::is_move_constructible::value == true, ""); -static_assert(std::is_copy_assignable::value == true, ""); -static_assert(std::is_move_assignable::value == true, ""); -static_assert(std::is_nothrow_destructible::value == true, ""); +static_assert(!std::is_default_constructible_v, ""); +static_assert(std::is_copy_constructible_v, ""); +static_assert(std::is_move_constructible_v, ""); +static_assert(std::is_copy_assignable_v, ""); +static_assert(std::is_move_assignable_v, ""); +static_assert(std::is_nothrow_destructible_v, ""); #endif //------------------------------------------------------------------------------ diff --git a/include/xrpl/beast/utility/PropertyStream.h b/include/xrpl/beast/utility/PropertyStream.h index 3d29138a12..290730c1a2 100644 --- a/include/xrpl/beast/utility/PropertyStream.h +++ b/include/xrpl/beast/utility/PropertyStream.h @@ -311,7 +311,7 @@ private: std::string const m_name; std::recursive_mutex lock_; Item item_; - Source* parent_; + Source* parent_{nullptr}; List children_; public: diff --git a/include/xrpl/beast/utility/Zero.h b/include/xrpl/beast/utility/Zero.h index 00e91a1a47..872a78e97f 100644 --- a/include/xrpl/beast/utility/Zero.h +++ b/include/xrpl/beast/utility/Zero.h @@ -27,8 +27,8 @@ struct Zero }; namespace { -static constexpr Zero zero{}; -} +constexpr Zero zero{}; +} // namespace /** Default implementation of signum calls the method on the class. */ template diff --git a/include/xrpl/beast/xor_shift_engine.h b/include/xrpl/beast/xor_shift_engine.h index d49cb08fc0..85504f51aa 100644 --- a/include/xrpl/beast/xor_shift_engine.h +++ b/include/xrpl/beast/xor_shift_engine.h @@ -37,21 +37,21 @@ public: } private: - result_type s_[2]; + result_type s_[2]{}; static result_type murmurhash3(result_type x); }; -template -xor_shift_engine<_>::xor_shift_engine(result_type val) +template +xor_shift_engine::xor_shift_engine(result_type val) { seed(val); } -template +template void -xor_shift_engine<_>::seed(result_type seed) +xor_shift_engine::seed(result_type seed) { if (seed == 0) throw std::domain_error("invalid seed"); @@ -59,9 +59,9 @@ xor_shift_engine<_>::seed(result_type seed) s_[1] = murmurhash3(s_[0]); } -template +template auto -xor_shift_engine<_>::operator()() -> result_type +xor_shift_engine::operator()() -> result_type { result_type s1 = s_[0]; result_type const s0 = s_[1]; @@ -70,9 +70,9 @@ xor_shift_engine<_>::operator()() -> result_type return (s_[1] = (s1 ^ s0 ^ (s1 >> 17) ^ (s0 >> 26))) + s0; } -template +template auto -xor_shift_engine<_>::murmurhash3(result_type x) -> result_type +xor_shift_engine::murmurhash3(result_type x) -> result_type { x ^= x >> 33; x *= 0xff51afd7ed558ccdULL; diff --git a/include/xrpl/conditions/detail/utils.h b/include/xrpl/conditions/detail/utils.h index 17d93d43b5..2a0ef92ab3 100644 --- a/include/xrpl/conditions/detail/utils.h +++ b/include/xrpl/conditions/detail/utils.h @@ -89,7 +89,7 @@ parsePreamble(Slice& s, std::error_code& ec) p.length = s[0]; s += 1; - if (p.length & 0x80) + if ((p.length & 0x80) != 0u) { // Long form length: std::size_t const cnt = p.length & 0x7F; diff --git a/include/xrpl/core/ClosureCounter.h b/include/xrpl/core/ClosureCounter.h index 6802a03f3d..730cc12dfe 100644 --- a/include/xrpl/core/ClosureCounter.h +++ b/include/xrpl/core/ClosureCounter.h @@ -34,9 +34,9 @@ template class ClosureCounter { private: - std::mutex mutable mutex_{}; - std::condition_variable allClosuresDoneCond_{}; // guard with mutex_ - bool waitForClosures_{false}; // guard with mutex_ + std::mutex mutable mutex_; + std::condition_variable allClosuresDoneCond_; // guard with mutex_ + bool waitForClosures_{false}; // guard with mutex_ std::atomic closureCount_{0}; // Increment the count. @@ -56,7 +56,7 @@ private: // a lock. This removes a small timing window that occurs if the // waiting thread is handling a spurious wakeup when closureCount_ // drops to zero. - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; // Update closureCount_. Notify if stopping and closureCount_ == 0. if ((--closureCount_ == 0) && waitForClosures_) @@ -92,7 +92,9 @@ private: ++counter_; } - Substitute(ClosureCounter& counter, Closure&& closure) + Substitute( + ClosureCounter& counter, + Closure&& closure) // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) : counter_(counter), closure_(std::forward(closure)) { ++counter_; @@ -168,7 +170,7 @@ public: { std::optional> ret; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; if (!waitForClosures_) ret.emplace(*this, std::forward(closure)); @@ -191,7 +193,7 @@ public: bool joined() const { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; return waitForClosures_; } }; diff --git a/include/xrpl/core/Coro.ipp b/include/xrpl/core/Coro.ipp index dca9504679..38d921a658 100644 --- a/include/xrpl/core/Coro.ipp +++ b/include/xrpl/core/Coro.ipp @@ -7,7 +7,6 @@ JobQueue::Coro::Coro(Coro_create_t, JobQueue& jq, JobType type, std::string cons : jq_(jq) , type_(type) , name_(name) - , running_(false) , coro_( // Stack size of 1MB wasn't sufficient for deep calls. ASAN tests flagged the issue. Hence // increasing the size to 1.5MB. diff --git a/include/xrpl/core/JobQueue.h b/include/xrpl/core/JobQueue.h index fdb708ee57..558e55cf31 100644 --- a/include/xrpl/core/JobQueue.h +++ b/include/xrpl/core/JobQueue.h @@ -16,7 +16,7 @@ namespace xrpl { namespace perf { class PerfLog; -} +} // namespace perf class Logs; struct Coro_create_t @@ -45,7 +45,7 @@ public: JobQueue& jq_; JobType type_; std::string name_; - bool running_; + bool running_{false}; std::mutex mutex_; std::mutex mutex_run_; std::condition_variable cv_; @@ -224,7 +224,7 @@ private: beast::Journal m_journal; mutable std::mutex m_mutex; - std::uint64_t m_lastJob; + std::uint64_t m_lastJob{0}; std::set m_jobSet; JobCounter jobCounter_; std::atomic_bool stopping_{false}; @@ -233,7 +233,7 @@ private: JobTypeData m_invalidJobData; // The number of jobs currently in processTask() - int m_processCount; + int m_processCount{0}; // The number of suspended coroutines int nSuspend_ = 0; diff --git a/include/xrpl/core/JobTypeData.h b/include/xrpl/core/JobTypeData.h index 32df3e88cf..c180629af7 100644 --- a/include/xrpl/core/JobTypeData.h +++ b/include/xrpl/core/JobTypeData.h @@ -19,13 +19,13 @@ public: JobTypeInfo const& info; /* The number of jobs waiting */ - int waiting; + int waiting{0}; /* The number presently running */ - int running; + int running{0}; /* And the number we deferred executing because of job limits */ - int deferred; + int deferred{0}; /* Notification callbacks */ beast::insight::Event dequeue; @@ -35,12 +35,8 @@ public: JobTypeInfo const& info_, beast::insight::Collector::ptr const& collector, Logs& logs) noexcept - : m_load(logs.journal("LoadMonitor")) - , m_collector(collector) - , info(info_) - , waiting(0) - , running(0) - , deferred(0) + : m_load(logs.journal("LoadMonitor")), m_collector(collector), info(info_) + { m_load.setTargetLatency(info.getAverageLatency(), info.getPeakLatency()); diff --git a/include/xrpl/core/JobTypes.h b/include/xrpl/core/JobTypes.h index 4dc2fd96cd..98de97a1b4 100644 --- a/include/xrpl/core/JobTypes.h +++ b/include/xrpl/core/JobTypes.h @@ -24,7 +24,7 @@ private: std::chrono::milliseconds{0}) { using namespace std::chrono_literals; - int maxLimit = std::numeric_limits::max(); + int const maxLimit = std::numeric_limits::max(); auto add = [this]( JobType jt, diff --git a/include/xrpl/core/LoadMonitor.h b/include/xrpl/core/LoadMonitor.h index 71fbf75d68..b8777a7056 100644 --- a/include/xrpl/core/LoadMonitor.h +++ b/include/xrpl/core/LoadMonitor.h @@ -36,10 +36,10 @@ public: { Stats(); - std::uint64_t count; + std::uint64_t count{0}; std::chrono::milliseconds latencyAvg; std::chrono::milliseconds latencyPeak; - bool isOverloaded; + bool isOverloaded{false}; }; Stats @@ -54,8 +54,8 @@ private: std::mutex mutex_; - std::uint64_t mCounts; - int mLatencyEvents; + std::uint64_t mCounts{0}; + int mLatencyEvents{0}; std::chrono::milliseconds mLatencyMSAvg; std::chrono::milliseconds mLatencyMSPeak; std::chrono::milliseconds mTargetLatencyAvg; diff --git a/include/xrpl/core/PeerReservationTable.h b/include/xrpl/core/PeerReservationTable.h index ffaef2fa08..3fb85e392f 100644 --- a/include/xrpl/core/PeerReservationTable.h +++ b/include/xrpl/core/PeerReservationTable.h @@ -20,7 +20,7 @@ struct PeerReservation final { public: PublicKey nodeId; - std::string description{}; + std::string description = {}; // NOLINT(readability-redundant-member-init) auto toJson() const -> Json::Value; @@ -67,8 +67,8 @@ public: bool contains(PublicKey const& nodeId) { - std::lock_guard lock(this->mutex_); - return table_.find({nodeId}) != table_.end(); + std::lock_guard const lock(this->mutex_); + return table_.contains({.nodeId = nodeId, .description = {}}); } // Because `ApplicationImp` has two-phase initialization, so must we. @@ -92,7 +92,7 @@ public: private: beast::Journal mutable journal_; std::mutex mutable mutex_; - DatabaseCon* connection_; + DatabaseCon* connection_{}; std::unordered_set, KeyEqual> table_; }; diff --git a/include/xrpl/core/PerfLog.h b/include/xrpl/core/PerfLog.h index 64bdb3b625..8da6a313c8 100644 --- a/include/xrpl/core/PerfLog.h +++ b/include/xrpl/core/PerfLog.h @@ -14,7 +14,7 @@ namespace beast { class Journal; -} +} // namespace beast namespace xrpl { class Application; diff --git a/include/xrpl/core/ServiceRegistry.h b/include/xrpl/core/ServiceRegistry.h index 9f2555dc34..8b7d4b4464 100644 --- a/include/xrpl/core/ServiceRegistry.h +++ b/include/xrpl/core/ServiceRegistry.h @@ -11,13 +11,13 @@ namespace xrpl { // Forward declarations namespace NodeStore { class Database; -} +} // namespace NodeStore namespace Resource { class Manager; -} +} // namespace Resource namespace perf { class PerfLog; -} +} // namespace perf // This is temporary until we migrate all code to use ServiceRegistry. class Application; diff --git a/include/xrpl/core/detail/Workers.h b/include/xrpl/core/detail/Workers.h index 8d898e35c0..dbc93ecf81 100644 --- a/include/xrpl/core/detail/Workers.h +++ b/include/xrpl/core/detail/Workers.h @@ -13,7 +13,7 @@ namespace xrpl { namespace perf { class PerfLog; -} +} // namespace perf /** * `Workers` is effectively a thread pool. The constructor takes a "callback" @@ -183,8 +183,8 @@ private: std::thread thread_; std::mutex mutex_; std::condition_variable wakeup_; - int wakeCount_; // how many times to un-pause - bool shouldExit_; + int wakeCount_{0}; // how many times to un-pause + bool shouldExit_{false}; }; private: @@ -197,9 +197,9 @@ private: std::string m_threadNames; // The name to give each thread std::condition_variable m_cv; // signaled when all threads paused std::mutex m_mut; - bool m_allPaused; + bool m_allPaused{true}; semaphore m_semaphore; // each pending task is 1 resource - int m_numberOfThreads; // how many we want active now + int m_numberOfThreads{0}; // how many we want active now std::atomic m_activeCount; // to know when all are paused std::atomic m_pauseCount; // how many threads need to pause now std::atomic m_runningTaskCount; // how many calls to processTask() active diff --git a/include/xrpl/core/detail/semaphore.h b/include/xrpl/core/detail/semaphore.h index fad3bf5e29..b3bee00588 100644 --- a/include/xrpl/core/detail/semaphore.h +++ b/include/xrpl/core/detail/semaphore.h @@ -55,7 +55,7 @@ public: void notify() { - std::lock_guard lock{m_mutex}; + std::lock_guard const lock{m_mutex}; ++m_count; m_cond.notify_one(); } diff --git a/include/xrpl/json/json_reader.h b/include/xrpl/json/json_reader.h index 09dac80a2f..dd1be76923 100644 --- a/include/xrpl/json/json_reader.h +++ b/include/xrpl/json/json_reader.h @@ -103,9 +103,9 @@ private: public: explicit ErrorInfo() = default; - Token token_; + Token token_{}; std::string message_; - Location extra_; + Location extra_{}; }; using Errors = std::deque; @@ -173,11 +173,11 @@ private: Nodes nodes_; Errors errors_; std::string document_; - Location begin_; - Location end_; - Location current_; - Location lastValueEnd_; - Value* lastValue_; + Location begin_{}; + Location end_{}; + Location current_{}; + Location lastValueEnd_{}; + Value* lastValue_{}; }; template diff --git a/include/xrpl/json/json_value.h b/include/xrpl/json/json_value.h index fc7625d67a..ef1d0fbcb8 100644 --- a/include/xrpl/json/json_value.h +++ b/include/xrpl/json/json_value.h @@ -641,7 +641,7 @@ public: SelfType operator++(int) { - SelfType temp(*this); + SelfType const temp(*this); ++*this; return temp; } @@ -649,7 +649,7 @@ public: SelfType operator--(int) { - SelfType temp(*this); + SelfType const temp(*this); --*this; return temp; } diff --git a/include/xrpl/json/json_writer.h b/include/xrpl/json/json_writer.h index cc3790a7dd..e49abcd81a 100644 --- a/include/xrpl/json/json_writer.h +++ b/include/xrpl/json/json_writer.h @@ -106,8 +106,8 @@ private: ChildValues childValues_; std::string document_; std::string indentString_; - int rightMargin_; - int indentSize_; + int rightMargin_{74}; + int indentSize_{3}; bool addChildValues_{}; }; @@ -171,9 +171,9 @@ private: using ChildValues = std::vector; ChildValues childValues_; - std::ostream* document_; + std::ostream* document_{nullptr}; std::string indentString_; - int rightMargin_; + int rightMargin_{74}; std::string indentation_; bool addChildValues_{}; }; diff --git a/include/xrpl/json/to_string.h b/include/xrpl/json/to_string.h index fb379f5759..c9820e2e55 100644 --- a/include/xrpl/json/to_string.h +++ b/include/xrpl/json/to_string.h @@ -1,12 +1,11 @@ #pragma once -#include +#include + #include namespace Json { -class Value; - /** Writes a Json::Value to an std::string. */ std::string to_string(Value const&); @@ -15,8 +14,4 @@ to_string(Value const&); std::string pretty(Value const&); -/** Output using the StyledStreamWriter. @see Json::operator>>(). */ -std::ostream& -operator<<(std::ostream&, Value const& root); - } // namespace Json diff --git a/include/xrpl/ledger/AmendmentTable.h b/include/xrpl/ledger/AmendmentTable.h index fb90d6e859..7fd8efadf1 100644 --- a/include/xrpl/ledger/AmendmentTable.h +++ b/include/xrpl/ledger/AmendmentTable.h @@ -75,10 +75,12 @@ public: doValidatedLedger(std::shared_ptr const& lastValidatedLedger) { if (needValidatedLedger(lastValidatedLedger->seq())) + { doValidatedLedger( lastValidatedLedger->seq(), getEnabledAmendments(*lastValidatedLedger), getMajorityAmendments(*lastValidatedLedger)); + } } /** Called to determine whether the amendment logic needs to process @@ -143,7 +145,7 @@ public: // Inject appropriate pseudo-transactions for (auto const& it : actions) { - STTx amendTx(ttAMENDMENT, [&it, seq = lastClosedLedger->seq() + 1](auto& obj) { + STTx const amendTx(ttAMENDMENT, [&it, seq = lastClosedLedger->seq() + 1](auto& obj) { obj.setAccountID(sfAccount, AccountID()); obj.setFieldH256(sfAmendment, it.first); obj.setFieldU32(sfLedgerSequence, seq); diff --git a/include/xrpl/ledger/ApplyView.h b/include/xrpl/ledger/ApplyView.h index d5be5c9a1e..73161453db 100644 --- a/include/xrpl/ledger/ApplyView.h +++ b/include/xrpl/ledger/ApplyView.h @@ -213,11 +213,60 @@ public: // Called when a credit is made to an account // This is required to support PaymentSandbox virtual void - creditHook( + creditHookIOU( AccountID const& from, AccountID const& to, STAmount const& amount, STAmount const& preCreditBalance) + { + XRPL_ASSERT(amount.holds(), "creditHookIOU: amount is for Issue"); + } + + virtual void + creditHookMPT( + AccountID const& from, + AccountID const& to, + STAmount const& amount, + std::uint64_t preCreditBalanceHolder, + std::int64_t preCreditBalanceIssuer) + { + XRPL_ASSERT(amount.holds(), "creditHookMPT: amount is for MPTIssue"); + } + + /** Facilitate tracking of MPT sold by an issuer owning MPT sell offer. + * Unlike IOU, MPT doesn't have bi-directional relationship with an issuer, + * where a trustline limits an amount that can be issued to a holder. + * Consequently, the credit step (last MPTEndpointStep or + * BookStep buying MPT) might temporarily overflow OutstandingAmount. + * Limiting of a step's output amount in this case is delegated to + * the next step (in rev order). The next step always redeems when a holder + * account sells MPT (first MPTEndpointStep or BookStep selling MPT). + * In this case the holder account is only limited by the step's output + * and it's available funds since it's transferring the funds from one + * account to another account and doesn't change OutstandingAmount. + * This doesn't apply to an offer owned by an issuer. + * In this case the issuer sells or self debits and is increasing + * OutstandingAmount. Ability to issue is limited by the issuer + * originally available funds less already self sold MPT amounts (MPT sell + * offer). + * Consider an example: + * - GW creates MPT(USD) with 1,000USD MaximumAmount. + * - GW pays 950USD to A1. + * - A1 creates an offer 100XRP(buy)/100USD(sell). + * - GW creates an offer 100XRP(buy)/100USD(sell). + * - A2 pays 200USD to A3 with sendMax of 200XRP. + * Since the payment engine executes payments in reverse, + * OutstandingAmount overflows in MPTEndpointStep: 950 + 200 = 1,150USD. + * BookStep first consumes A1 offer. This reduces OutstandingAmount + * by 100USD: 1,150 - 100 = 1,050USD. GW offer can only be partially + * consumed because the initial available amount is 50USD = 1,000 - 950. + * BookStep limits it's output to 150USD. This in turn limits A3's send + * amount to 150XRP: A1 buys 100XRP and sells 100USD to A3. This doesn't + * change OutstandingAmount. GW buys 50XRP and sells 50USD to A3. This + * changes OutstandingAmount to 1,000USD. + */ + virtual void + issuerSelfDebitHookMPT(MPTIssue const& issue, std::uint64_t amount, std::int64_t origBalance) { } diff --git a/include/xrpl/ledger/CachedSLEs.h b/include/xrpl/ledger/CachedSLEs.h index 2909501b1d..c05aab8856 100644 --- a/include/xrpl/ledger/CachedSLEs.h +++ b/include/xrpl/ledger/CachedSLEs.h @@ -6,4 +6,4 @@ namespace xrpl { using CachedSLEs = TaggedCache; -} +} // namespace xrpl diff --git a/include/xrpl/ledger/CanonicalTXSet.h b/include/xrpl/ledger/CanonicalTXSet.h index 45f58b5701..857b82a734 100644 --- a/include/xrpl/ledger/CanonicalTXSet.h +++ b/include/xrpl/ledger/CanonicalTXSet.h @@ -29,31 +29,31 @@ private: friend bool operator<(Key const& lhs, Key const& rhs); - inline friend bool + friend bool operator>(Key const& lhs, Key const& rhs) { return rhs < lhs; } - inline friend bool + friend bool operator<=(Key const& lhs, Key const& rhs) { return !(lhs > rhs); } - inline friend bool + friend bool operator>=(Key const& lhs, Key const& rhs) { return !(lhs < rhs); } - inline friend bool + friend bool operator==(Key const& lhs, Key const& rhs) { return lhs.txId_ == rhs.txId_; } - inline friend bool + friend bool operator!=(Key const& lhs, Key const& rhs) { return !(lhs == rhs); diff --git a/include/xrpl/ledger/LedgerTiming.h b/include/xrpl/ledger/LedgerTiming.h index 33ccc671e2..8171beed3c 100644 --- a/include/xrpl/ledger/LedgerTiming.h +++ b/include/xrpl/ledger/LedgerTiming.h @@ -34,7 +34,7 @@ auto constexpr decreaseLedgerTimeResolutionEvery = 1; /** Calculates the close time resolution for the specified ledger. - The Ripple protocol uses binning to represent time intervals using only one + The XRPL protocol uses binning to represent time intervals using only one timestamp. This allows servers to derive a common time for the next ledger, without the need for perfectly synchronized clocks. The time resolution (i.e. the size of the intervals) is adjusted dynamically @@ -62,7 +62,7 @@ getNextLedgerTimeResolution( bool previousAgree, Seq ledgerSeq) { - XRPL_ASSERT(ledgerSeq != Seq{0}, "ripple:getNextLedgerTimeResolution : valid ledger sequence"); + XRPL_ASSERT(ledgerSeq != Seq{0}, "xrpl::getNextLedgerTimeResolution : valid ledger sequence"); using namespace std::chrono; // Find the current resolution: @@ -72,7 +72,7 @@ getNextLedgerTimeResolution( previousResolution); XRPL_ASSERT( iter != std::end(ledgerPossibleTimeResolutions), - "ripple:getNextLedgerTimeResolution : found time resolution"); + "xrpl::getNextLedgerTimeResolution : found time resolution"); // This should never happen, but just as a precaution if (iter == std::end(ledgerPossibleTimeResolutions)) diff --git a/include/xrpl/ledger/OrderBookDB.h b/include/xrpl/ledger/OrderBookDB.h index 5bf66eb4ab..a0aee58e2a 100644 --- a/include/xrpl/ledger/OrderBookDB.h +++ b/include/xrpl/ledger/OrderBookDB.h @@ -3,8 +3,8 @@ #include #include #include +#include #include -#include #include #include @@ -53,30 +53,30 @@ public: issue. This is useful for pathfinding to find all possible next hops from a given currency. - @param issue The issue to search for + @param asset The asset to search for @param domain Optional domain restriction for the order book @return Vector of books that want this issue */ virtual std::vector - getBooksByTakerPays(Issue const& issue, std::optional const& domain = std::nullopt) = 0; + getBooksByTakerPays(Asset const& asset, std::optional const& domain = std::nullopt) = 0; /** Get the count of order books that want a specific issue. - @param issue The issue to search for + @param asset The asset to search for @param domain Optional domain restriction for the order book @return Number of books that want this issue */ virtual int - getBookSize(Issue const& issue, std::optional const& domain = std::nullopt) = 0; + getBookSize(Asset const& asset, std::optional const& domain = std::nullopt) = 0; /** Check if an order book to XRP exists for the given issue. - @param issue The issue to check + @param asset The asset to check @param domain Optional domain restriction for the order book @return true if a book from this issue to XRP exists */ virtual bool - isBookToXRP(Issue const& issue, std::optional const& domain = std::nullopt) = 0; + isBookToXRP(Asset const& asset, std::optional const& domain = std::nullopt) = 0; /** * Process a transaction for order book tracking. diff --git a/include/xrpl/ledger/PaymentSandbox.h b/include/xrpl/ledger/PaymentSandbox.h index 891e3ef27b..d6f7820e8a 100644 --- a/include/xrpl/ledger/PaymentSandbox.h +++ b/include/xrpl/ledger/PaymentSandbox.h @@ -15,10 +15,55 @@ namespace detail { // into the PaymentSandbox class itself class DeferredCredits { -public: - struct Adjustment +private: + using KeyIOU = std::tuple; + struct ValueIOU { - Adjustment(STAmount const& d, STAmount const& c, STAmount const& b) + explicit ValueIOU() = default; + + STAmount lowAcctCredits; + STAmount highAcctCredits; + STAmount lowAcctOrigBalance; + }; + + struct HolderValueMPT + { + HolderValueMPT() = default; + // Debit to issuer + std::uint64_t debit = 0; + std::uint64_t origBalance = 0; + }; + + struct IssuerValueMPT + { + IssuerValueMPT() = default; + std::map holders; + // Credit to holder + std::uint64_t credit = 0; + // OutstandingAmount might overflow when MPTs are credited to a holder. + // Consider A1 paying 100MPT to A2 and A1 already having maximum MPTs. + // Since the payment engine executes a payment in revers, A2 is + // credited first and OutstandingAmount is going to be equal + // to MaximumAmount + 100MPT. In the next step A1 redeems 100MPT + // to the issuer and OutstandingAmount balances out. + std::int64_t origBalance = 0; + // Self debit on offer selling MPT. Since the payment engine executes + // a payment in reverse, a crediting/buying step may overflow + // OutstandingAmount. A sell MPT offer owned by a holder can redeem any + // amount up to the offer's amount and holder's available funds, + // balancing out OutstandingAmount. But if the offer's owner is issuer + // then it issues more MPT. In this case the available amount to issue + // is the initial issuer's available amount less all offer sell amounts + // by the issuer. This is self-debit, where the offer's owner, + // issuer in this case, debits to self. + std::uint64_t selfDebit = 0; + }; + using AdjustmentMPT = IssuerValueMPT; + +public: + struct AdjustmentIOU + { + AdjustmentIOU(STAmount const& d, STAmount const& c, STAmount const& b) : debits(d), credits(c), origBalance(b) { } @@ -29,16 +74,30 @@ public: // Get the adjustments for the balance between main and other. // Returns the debits, credits and the original balance - std::optional - adjustments(AccountID const& main, AccountID const& other, Currency const& currency) const; + std::optional + adjustmentsIOU(AccountID const& main, AccountID const& other, Currency const& currency) const; + + std::optional + adjustmentsMPT(MPTID const& mptID) const; void - credit( + creditIOU( AccountID const& sender, AccountID const& receiver, STAmount const& amount, STAmount const& preCreditSenderBalance); + void + creditMPT( + AccountID const& sender, + AccountID const& receiver, + STAmount const& amount, + std::uint64_t preCreditBalanceHolder, + std::int64_t preCreditBalanceIssuer); + + void + issuerSelfDebitMPT(MPTIssue const& issue, std::uint64_t amount, std::int64_t origBalance); + void ownerCount(AccountID const& id, std::uint32_t cur, std::uint32_t next); @@ -52,21 +111,11 @@ public: apply(DeferredCredits& to); private: - // lowAccount, highAccount - using Key = std::tuple; - struct Value - { - explicit Value() = default; + static KeyIOU + makeKeyIOU(AccountID const& a1, AccountID const& a2, Currency const& currency); - STAmount lowAcctCredits; - STAmount highAcctCredits; - STAmount lowAcctOrigBalance; - }; - - static Key - makeKey(AccountID const& a1, AccountID const& a2, Currency const& c); - - std::map credits_; + std::map creditsIOU_; + std::map creditsMPT_; std::map ownerCounts_; }; @@ -131,16 +180,35 @@ public: /** @} */ STAmount - balanceHook(AccountID const& account, AccountID const& issuer, STAmount const& amount) + balanceHookIOU(AccountID const& account, AccountID const& issuer, STAmount const& amount) const override; + STAmount + balanceHookMPT(AccountID const& account, MPTIssue const& issue, std::int64_t amount) + const override; + + STAmount + balanceHookSelfIssueMPT(MPTIssue const& issue, std::int64_t amount) const override; + void - creditHook( + creditHookIOU( AccountID const& from, AccountID const& to, STAmount const& amount, STAmount const& preCreditBalance) override; + void + creditHookMPT( + AccountID const& from, + AccountID const& to, + STAmount const& amount, + std::uint64_t preCreditBalanceHolder, + std::int64_t preCreditBalanceIssuer) override; + + void + issuerSelfDebitHookMPT(MPTIssue const& issue, std::uint64_t amount, std::int64_t origBalance) + override; + void adjustOwnerCountHook(AccountID const& account, std::uint32_t cur, std::uint32_t next) override; diff --git a/include/xrpl/ledger/PendingSaves.h b/include/xrpl/ledger/PendingSaves.h index 76958fc78a..ff70d48bb9 100644 --- a/include/xrpl/ledger/PendingSaves.h +++ b/include/xrpl/ledger/PendingSaves.h @@ -31,7 +31,7 @@ public: bool startWork(LedgerIndex seq) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto it = map_.find(seq); @@ -54,7 +54,7 @@ public: void finishWork(LedgerIndex seq) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); map_.erase(seq); await_.notify_all(); @@ -64,8 +64,8 @@ public: bool pending(LedgerIndex seq) { - std::lock_guard lock(mutex_); - return map_.find(seq) != map_.end(); + std::lock_guard const lock(mutex_); + return map_.contains(seq); } /** Check if a ledger should be dispatched @@ -117,7 +117,7 @@ public: std::map getSnapshot() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return map_; } diff --git a/include/xrpl/ledger/ReadView.h b/include/xrpl/ledger/ReadView.h index e3a5163418..debf01e85f 100644 --- a/include/xrpl/ledger/ReadView.h +++ b/include/xrpl/ledger/ReadView.h @@ -148,15 +148,35 @@ public: // Accounts in a payment are not allowed to use assets acquired during that // payment. The PaymentSandbox tracks the debits, credits, and owner count - // changes that accounts make during a payment. `balanceHook` adjusts + // changes that accounts make during a payment. `balanceHookIOU` adjusts // balances so newly acquired assets are not counted toward the balance. // This is required to support PaymentSandbox. virtual STAmount - balanceHook(AccountID const& account, AccountID const& issuer, STAmount const& amount) const + balanceHookIOU(AccountID const& account, AccountID const& issuer, STAmount const& amount) const { + XRPL_ASSERT(amount.holds(), "balanceHookIOU: amount is for Issue"); + return amount; } + // balanceHookMPT adjusts balances so newly acquired assets are not counted + // toward the balance. + virtual STAmount + balanceHookMPT(AccountID const& account, MPTIssue const& issue, std::int64_t amount) const + { + return STAmount{issue, amount}; + } + + // An offer owned by an issuer and selling MPT is limited by the issuer's + // funds available to issue, which are originally available funds less + // already self sold MPT amounts (MPT sell offer). This hook is used + // by issuerFundsToSelfIssue() function. + virtual STAmount + balanceHookSelfIssueMPT(MPTIssue const& issue, std::int64_t amount) const + { + return STAmount{issue, amount}; + } + // Accounts in a payment are not allowed to use assets acquired during that // payment. The PaymentSandbox tracks the debits, credits, and owner count // changes that accounts make during a payment. `ownerCountHook` adjusts the diff --git a/include/xrpl/ledger/View.h b/include/xrpl/ledger/View.h index 55be01d677..4958a89d8c 100644 --- a/include/xrpl/ledger/View.h +++ b/include/xrpl/ledger/View.h @@ -30,10 +30,10 @@ enum class SkipEntry : bool { No = false, Yes }; /** Determines whether the given expiration time has passed. In the XRP Ledger, expiration times are defined as the number of whole - seconds after the "Ripple Epoch" which, for historical reasons, is set + seconds after the "XRPL epoch" which, for historical reasons, is set to January 1, 2000 (00:00 UTC). - This is like the way the Unix epoch works, except the Ripple Epoch is + This is like the way the Unix epoch works, except the XRPL epoch is precisely 946,684,800 seconds after the Unix Epoch. See https://xrpl.org/basic-data-types.html#specifying-time @@ -63,8 +63,8 @@ isVaultPseudoAccountFrozen( isLPTokenFrozen( ReadView const& view, AccountID const& account, - Issue const& asset, - Issue const& asset2); + Asset const& asset, + Asset const& asset2); // Return the list of enabled amendments [[nodiscard]] std::set diff --git a/include/xrpl/tx/transactors/dex/AMMHelpers.h b/include/xrpl/ledger/helpers/AMMHelpers.h similarity index 83% rename from include/xrpl/tx/transactors/dex/AMMHelpers.h rename to include/xrpl/ledger/helpers/AMMHelpers.h index 6e3957769f..d261f9e018 100644 --- a/include/xrpl/tx/transactors/dex/AMMHelpers.h +++ b/include/xrpl/ledger/helpers/AMMHelpers.h @@ -1,8 +1,13 @@ #pragma once +#include #include #include #include +#include +#include +#include +#include #include #include #include @@ -11,6 +16,7 @@ #include #include #include +#include namespace xrpl { @@ -22,7 +28,7 @@ reduceOffer(auto const& amount) static Number const reducedOfferPct(9999, -4); // Make sure the result is always less than amount or zero. - NumberRoundModeGuard mg(Number::towards_zero); + NumberRoundModeGuard const mg(Number::towards_zero); return amount * reducedOfferPct; } @@ -36,7 +42,7 @@ enum class IsDeposit : bool { No = false, Yes = true }; * @return LP Tokens as IOU */ STAmount -ammLPTokens(STAmount const& asset1, STAmount const& asset2, Issue const& lptIssue); +ammLPTokens(STAmount const& asset1, STAmount const& asset2, Asset const& lptIssue); /** Calculate LP Tokens given asset's deposit amount. * @param asset1Balance current AMM asset1 balance @@ -121,11 +127,11 @@ withinRelativeDistance(Quality const& calcQuality, Quality const& reqQuality, Nu * @param dist requested relative distance * @return true if within dist, false otherwise */ -// clang-format off template requires( std::is_same_v || std::is_same_v || - std::is_same_v || std::is_same_v) + std::is_same_v || std::is_same_v || + std::is_same_v) bool withinRelativeDistance(Amt const& calc, Amt const& req, Number const& dist) { @@ -134,7 +140,6 @@ withinRelativeDistance(Amt const& calc, Amt const& req, Number const& dist) auto const [min, max] = std::minmax(calc, req); return ((max - min) / max) < dist; } -// clang-format on /** Solve quadratic equation to find takerGets or takerPays. Round * to minimize the amount in order to maximize the quality. @@ -175,7 +180,7 @@ getAMMOfferStartWithTakerGets( if (targetQuality.rate() == beast::zero) return std::nullopt; - NumberRoundModeGuard mg(Number::to_nearest); + NumberRoundModeGuard const mg(Number::to_nearest); auto const f = feeMult(tfee); auto const a = 1; auto const b = pool.in * (1 - 1 / f) / targetQuality.rate() - 2 * pool.out; @@ -197,16 +202,16 @@ getAMMOfferStartWithTakerGets( // Round downward to minimize the offer and to maximize the quality. // This has the most impact when takerGets is XRP. auto const takerGets = - toAmount(getIssue(pool.out), nTakerGetsProposed, Number::downward); + toAmount(getAsset(pool.out), nTakerGetsProposed, Number::downward); return TAmounts{swapAssetOut(pool, takerGets, tfee), takerGets}; }; // Try to reduce the offer size to improve the quality. // The quality might still not match the targetQuality for a tiny offer. - if (auto amounts = getAmounts(*nTakerGets); Quality{amounts} < targetQuality) + auto amounts = getAmounts(*nTakerGets); + if (Quality{amounts} < targetQuality) return getAmounts(detail::reduceOffer(amounts.out)); - else - return amounts; + return amounts; } /** Generate AMM offer starting with takerPays when AMM pool @@ -242,7 +247,7 @@ getAMMOfferStartWithTakerPays( if (targetQuality.rate() == beast::zero) return std::nullopt; - NumberRoundModeGuard mg(Number::to_nearest); + NumberRoundModeGuard const mg(Number::to_nearest); auto const f = feeMult(tfee); auto const& a = f; auto const b = pool.in * (1 + f); @@ -264,16 +269,16 @@ getAMMOfferStartWithTakerPays( // Round downward to minimize the offer and to maximize the quality. // This has the most impact when takerPays is XRP. auto const takerPays = - toAmount(getIssue(pool.in), nTakerPaysProposed, Number::downward); + toAmount(getAsset(pool.in), nTakerPaysProposed, Number::downward); return TAmounts{takerPays, swapAssetIn(pool, takerPays, tfee)}; }; // Try to reduce the offer size to improve the quality. // The quality might still not match the targetQuality for a tiny offer. - if (auto amounts = getAmounts(*nTakerPays); Quality{amounts} < targetQuality) + auto amounts = getAmounts(*nTakerPays); + if (Quality{amounts} < targetQuality) return getAmounts(detail::reduceOffer(amounts.in)); - else - return amounts; + return amounts; } /** Generate AMM offer so that either updated Spot Price Quality (SPQ) @@ -313,9 +318,12 @@ changeSpotPriceQuality( auto const& a = f; auto const b = pool.in * (1 + f); Number const c = pool.in * pool.in - pool.in * pool.out * quality.rate(); - if (auto const res = b * b - 4 * a * c; res < 0) + auto const res = b * b - 4 * a * c; + if (res < 0) + { return std::nullopt; // LCOV_EXCL_LINE - else if (auto const nTakerPaysPropose = (-b + root2(res)) / (2 * a); nTakerPaysPropose > 0) + } + if (auto const nTakerPaysPropose = (-b + root2(res)) / (2 * a); nTakerPaysPropose > 0) { auto const nTakerPays = [&]() { // The fee might make the AMM offer quality less than CLOB @@ -333,7 +341,7 @@ changeSpotPriceQuality( << " " << to_string(pool.out) << " " << quality << " " << tfee; return std::nullopt; } - auto const takerPays = toAmount(getIssue(pool.in), nTakerPays, Number::upward); + auto const takerPays = toAmount(getAsset(pool.in), nTakerPays, Number::upward); // should not fail if (auto amounts = TAmounts{takerPays, swapAssetIn(pool, takerPays, tfee)}; Quality{amounts} < quality && @@ -362,7 +370,7 @@ changeSpotPriceQuality( // Generate the offer starting with XRP side. Return seated offer amounts // if the offer can be generated, otherwise nullopt. auto amounts = [&]() { - if (isXRP(getIssue(pool.out))) + if (isXRP(getAsset(pool.out))) return getAMMOfferStartWithTakerGets(pool, quality, tfee); return getAMMOfferStartWithTakerPays(pool, quality, tfee); }(); @@ -437,7 +445,7 @@ swapAssetIn(TAmounts const& pool, TIn const& assetIn, std::uint16_t t // 1-fee // maximize: // fee - saveNumberRoundMode _{Number::getround()}; + saveNumberRoundMode const _{Number::getround()}; Number::setround(Number::upward); auto const numerator = pool.in * pool.out; @@ -447,7 +455,7 @@ swapAssetIn(TAmounts const& pool, TIn const& assetIn, std::uint16_t t auto const denom = pool.in + assetIn * (1 - fee); if (denom.signum() <= 0) - return toAmount(getIssue(pool.out), 0); + return toAmount(getAsset(pool.out), 0); Number::setround(Number::upward); auto const ratio = numerator / denom; @@ -456,17 +464,15 @@ swapAssetIn(TAmounts const& pool, TIn const& assetIn, std::uint16_t t auto const swapOut = pool.out - ratio; if (swapOut.signum() < 0) - return toAmount(getIssue(pool.out), 0); + return toAmount(getAsset(pool.out), 0); - return toAmount(getIssue(pool.out), swapOut, Number::downward); - } - else - { - return toAmount( - getIssue(pool.out), - pool.out - (pool.in * pool.out) / (pool.in + assetIn * feeMult(tfee)), - Number::downward); + return toAmount(getAsset(pool.out), swapOut, Number::downward); } + + return toAmount( + getAsset(pool.out), + pool.out - (pool.in * pool.out) / (pool.in + assetIn * feeMult(tfee)), + Number::downward); } /** Swap assetOut out of the pool and swap in a proportional amount @@ -501,7 +507,7 @@ swapAssetOut(TAmounts const& pool, TOut const& assetOut, std::uint16_ // maximize: // tfee/100000 - saveNumberRoundMode _{Number::getround()}; + saveNumberRoundMode const _{Number::getround()}; Number::setround(Number::upward); auto const numerator = pool.in * pool.out; @@ -510,7 +516,7 @@ swapAssetOut(TAmounts const& pool, TOut const& assetOut, std::uint16_ auto const denom = pool.out - assetOut; if (denom.signum() <= 0) { - return toMaxAmount(getIssue(pool.in)); + return toMaxAmount(getAsset(pool.in)); } Number::setround(Number::upward); @@ -524,17 +530,15 @@ swapAssetOut(TAmounts const& pool, TOut const& assetOut, std::uint16_ Number::setround(Number::upward); auto const swapIn = numerator2 / feeMult; if (swapIn.signum() < 0) - return toAmount(getIssue(pool.in), 0); + return toAmount(getAsset(pool.in), 0); - return toAmount(getIssue(pool.in), swapIn, Number::upward); - } - else - { - return toAmount( - getIssue(pool.in), - ((pool.in * pool.out) / (pool.out - assetOut) - pool.in) / feeMult(tfee), - Number::upward); + return toAmount(getAsset(pool.in), swapIn, Number::upward); } + + return toAmount( + getAsset(pool.in), + ((pool.in * pool.out) / (pool.out - assetOut) - pool.in) / feeMult(tfee), + Number::upward); } /** Return square of n. @@ -618,9 +622,13 @@ getRoundedAsset(Rules const& rules, STAmount const& balance, A const& frac, IsDe if (!rules.enabled(fixAMMv1_3)) { if constexpr (std::is_same_v) - return multiply(balance, frac, balance.issue()); + { + return multiply(balance, frac, balance.asset()); + } else - return toSTAmount(balance.issue(), balance * frac); + { + return toSTAmount(balance.asset(), balance * frac); + } } auto const rm = detail::getAssetRounding(isDeposit); return multiply(balance, frac, rm); @@ -714,4 +722,94 @@ adjustFracByTokens( STAmount const& tokens, Number const& frac); +/** Get AMM pool balances. + */ +std::pair +ammPoolHolds( + ReadView const& view, + AccountID const& ammAccountID, + Asset const& asset1, + Asset const& asset2, + FreezeHandling freezeHandling, + AuthHandling authHandling, + beast::Journal const j); + +/** Get AMM pool and LP token balances. If both optIssue are + * provided then they are used as the AMM token pair issues. + * Otherwise the missing issues are fetched from ammSle. + */ +Expected, TER> +ammHolds( + ReadView const& view, + SLE const& ammSle, + std::optional const& optAsset1, + std::optional const& optAsset2, + FreezeHandling freezeHandling, + AuthHandling authHandling, + beast::Journal const j); + +/** Get the balance of LP tokens. + */ +STAmount +ammLPHolds( + ReadView const& view, + Asset const& asset1, + Asset const& asset2, + AccountID const& ammAccount, + AccountID const& lpAccount, + beast::Journal const j); + +STAmount +ammLPHolds( + ReadView const& view, + SLE const& ammSle, + AccountID const& lpAccount, + beast::Journal const j); + +/** Get AMM trading fee for the given account. The fee is discounted + * if the account is the auction slot owner or one of the slot's authorized + * accounts. + */ +std::uint16_t +getTradingFee(ReadView const& view, SLE const& ammSle, AccountID const& account); + +/** Returns total amount held by AMM for the given token. + */ +STAmount +ammAccountHolds(ReadView const& view, AccountID const& ammAccountID, Asset const& asset); + +/** Delete trustlines to AMM. If all trustlines are deleted then + * AMM object and account are deleted. Otherwise tecINCOMPLETE is returned. + */ +TER +deleteAMMAccount(Sandbox& view, Asset const& asset, Asset const& asset2, beast::Journal j); + +/** Initialize Auction and Voting slots and set the trading/discounted fee. + */ +void +initializeFeeAuctionVote( + ApplyView& view, + std::shared_ptr& ammSle, + AccountID const& account, + Asset const& lptAsset, + std::uint16_t tfee); + +/** Return true if the Liquidity Provider is the only AMM provider, false + * otherwise. Return tecINTERNAL if encountered an unexpected condition, + * for instance Liquidity Provider has more than one LPToken trustline. + */ +Expected +isOnlyLiquidityProvider(ReadView const& view, Issue const& ammIssue, AccountID const& lpAccount); + +/** Due to rounding, the LPTokenBalance of the last LP might + * not match the LP's trustline balance. If it's within the tolerance, + * update LPTokenBalance to match the LP's trustline balance. + */ +Expected +verifyAndAdjustLPTokenBalance( + Sandbox& sb, + STAmount const& lpTokens, + std::shared_ptr& ammSle, + AccountID const& account); + } // namespace xrpl diff --git a/include/xrpl/tx/transactors/delegate/DelegateUtils.h b/include/xrpl/ledger/helpers/DelegateHelpers.h similarity index 100% rename from include/xrpl/tx/transactors/delegate/DelegateUtils.h rename to include/xrpl/ledger/helpers/DelegateHelpers.h diff --git a/include/xrpl/ledger/helpers/DirectoryHelpers.h b/include/xrpl/ledger/helpers/DirectoryHelpers.h index 189dfcd263..2ae188182d 100644 --- a/include/xrpl/ledger/helpers/DirectoryHelpers.h +++ b/include/xrpl/ledger/helpers/DirectoryHelpers.h @@ -189,7 +189,7 @@ forEachItem( AccountID const& id, std::function const&)> const& f) { - return forEachItem(view, keylet::ownerDir(id), f); + forEachItem(view, keylet::ownerDir(id), f); } /** Iterate all items after an item in an owner directory. diff --git a/src/libxrpl/tx/transactors/escrow/EscrowHelpers.h b/include/xrpl/ledger/helpers/EscrowHelpers.h similarity index 77% rename from src/libxrpl/tx/transactors/escrow/EscrowHelpers.h rename to include/xrpl/ledger/helpers/EscrowHelpers.h index 5fdc43c359..b44601594d 100644 --- a/src/libxrpl/tx/transactors/escrow/EscrowHelpers.h +++ b/include/xrpl/ledger/helpers/EscrowHelpers.h @@ -10,7 +10,6 @@ #include #include #include -#include namespace xrpl { @@ -42,7 +41,8 @@ escrowUnlockApplyHelper( bool createAsset, beast::Journal journal) { - Keylet const trustLineKey = keylet::line(receiver, amount.issue()); + Issue const& issue = amount.get(); + Keylet const trustLineKey = keylet::line(receiver, issue); bool const recvLow = issuer > receiver; bool const senderIssuer = issuer == sender; bool const receiverIssuer = issuer == receiver; @@ -65,32 +65,30 @@ escrowUnlockApplyHelper( return tecNO_LINE_INSUF_RESERVE; } - Currency const currency = amount.getCurrency(); - STAmount initialBalance(amount.issue()); - initialBalance.setIssuer(noAccount()); + Currency const currency = issue.currency; + STAmount initialBalance(issue); + initialBalance.get().account = noAccount(); - // clang-format off if (TER const ter = trustCreate( - view, // payment sandbox - recvLow, // is dest low? - issuer, // source - receiver, // destination - trustLineKey.key, // ledger index - sleDest, // Account to add to - false, // authorize account - (sleDest->getFlags() & lsfDefaultRipple) == 0, - false, // freeze trust line - false, // deep freeze trust line - initialBalance, // zero initial balance - Issue(currency, receiver), // limit of zero - 0, // quality in - 0, // quality out - journal); // journal + view, // payment sandbox + recvLow, // is dest low? + issuer, // source + receiver, // destination + trustLineKey.key, // ledger index + sleDest, // Account to add to + false, // authorize account + (sleDest->getFlags() & lsfDefaultRipple) == 0, // + false, // freeze trust line + false, // deep freeze trust line + initialBalance, // zero initial balance + Issue(currency, receiver), // limit of zero + 0, // quality in + 0, // quality out + journal); // journal !isTesSuccess(ter)) { - return ter; // LCOV_EXCL_LINE + return ter; // LCOV_EXCL_LINE } - // clang-format on view.update(sleDest); } @@ -116,7 +114,8 @@ escrowUnlockApplyHelper( if ((!senderIssuer && !receiverIssuer) && lockedRate != parityRate) { // compute transfer fee, if any - auto const xferFee = amount.value() - divideRound(amount, lockedRate, amount.issue(), true); + auto const xferFee = + amount.value() - divideRound(amount, lockedRate, amount.get(), true); // compute balance to transfer finalAmt = amount.value() - xferFee; } @@ -151,7 +150,7 @@ escrowUnlockApplyHelper( // if destination is not the issuer then transfer funds if (!receiverIssuer) { - auto const ter = rippleCredit(view, issuer, receiver, finalAmt, true, journal); + auto const ter = directSendNoFee(view, issuer, receiver, finalAmt, true, journal); if (!isTesSuccess(ter)) return ter; // LCOV_EXCL_LINE } @@ -185,8 +184,7 @@ escrowUnlockApplyHelper( return tecINSUFFICIENT_RESERVE; } - if (auto const ter = MPTokenAuthorize::createMPToken(view, mptID, receiver, 0); - !isTesSuccess(ter)) + if (auto const ter = createMPToken(view, mptID, receiver, 0); !isTesSuccess(ter)) { return ter; // LCOV_EXCL_LINE } @@ -220,7 +218,7 @@ escrowUnlockApplyHelper( // compute balance to transfer finalAmt = amount.value() - xferFee; } - return rippleUnlockEscrowMPT( + return unlockEscrowMPT( view, sender, receiver, diff --git a/include/xrpl/ledger/helpers/MPTokenHelpers.h b/include/xrpl/ledger/helpers/MPTokenHelpers.h index ab487280b9..6544b18dd1 100644 --- a/include/xrpl/ledger/helpers/MPTokenHelpers.h +++ b/include/xrpl/ledger/helpers/MPTokenHelpers.h @@ -80,6 +80,7 @@ authorizeMPToken( * requireAuth check is recursive for MPT shares in a vault, descending to * assets in the vault, up to maxAssetCheckDepth recursion depth. This is * purely defensive, as we currently do not allow such vaults to be created. + * WeakAuth intentionally allows missing MPTokens under MPToken V2. */ [[nodiscard]] TER requireAuth( @@ -114,6 +115,12 @@ canTransfer( AccountID const& from, AccountID const& to); +/** Check if Asset can be traded on DEX. return tecNO_PERMISSION + * if it doesn't and tesSUCCESS otherwise. + */ +[[nodiscard]] TER +canTrade(ReadView const& view, Asset const& asset); + //------------------------------------------------------------------------------ // // Empty holding operations (MPT-specific) @@ -142,14 +149,14 @@ removeEmptyHolding( //------------------------------------------------------------------------------ TER -rippleLockEscrowMPT( +lockEscrowMPT( ApplyView& view, AccountID const& uGrantorID, STAmount const& saAmount, beast::Journal j); TER -rippleUnlockEscrowMPT( +unlockEscrowMPT( ApplyView& view, AccountID const& uGrantorID, AccountID const& uGranteeID, @@ -157,4 +164,80 @@ rippleUnlockEscrowMPT( STAmount const& grossAmount, beast::Journal j); +TER +createMPToken( + ApplyView& view, + MPTID const& mptIssuanceID, + AccountID const& account, + std::uint32_t const flags); + +TER +checkCreateMPT( + xrpl::ApplyView& view, + xrpl::MPTIssue const& mptIssue, + xrpl::AccountID const& holder, + beast::Journal j); + +//------------------------------------------------------------------------------ +// +// MPT Overflow related +// +//------------------------------------------------------------------------------ + +// MaximumAmount doesn't exceed 2**63-1 +std::int64_t +maxMPTAmount(SLE const& sleIssuance); + +// OutstandingAmount may overflow and available amount might be negative. +// But available amount is always <= |MaximumAmount - OutstandingAmount|. +std::int64_t +availableMPTAmount(SLE const& sleIssuance); + +std::int64_t +availableMPTAmount(ReadView const& view, MPTID const& mptID); + +/** Checks for two types of OutstandingAmount overflow during a send operation. + * 1. **Direct directSendNoFee (Overflow: No):** A true overflow check when + * `OutstandingAmount > MaximumAmount`. This threshold is used for direct + * directSendNoFee transactions that bypass the payment engine. + * 2. **accountSend & Payment Engine (Overflow: Yes):** A temporary overflow + * check when `OutstandingAmount > UINT64_MAX`. This higher threshold is used + * for `accountSend` and payments processed via the payment engine. + */ +bool +isMPTOverflow( + std::int64_t sendAmount, + std::uint64_t outstandingAmount, + std::int64_t maximumAmount, + AllowMPTOverflow allowOverflow); + +/** + * Determine funds available for an issuer to sell in an issuer owned offer. + * Issuing step, which could be either MPTEndPointStep last step or BookStep's + * TakerPays may overflow OutstandingAmount. Redeeming step, in BookStep's + * TakerGets redeems the offer's owner funds, essentially balancing out + * the overflow, unless the offer's owner is the issuer. + */ +[[nodiscard]] STAmount +issuerFundsToSelfIssue(ReadView const& view, MPTIssue const& issue); + +/** Facilitate tracking of MPT sold by an issuer owning MPT sell offer. + * See ApplyView::issuerSelfDebitHookMPT(). + */ +void +issuerSelfDebitHookMPT(ApplyView& view, MPTIssue const& issue, std::uint64_t amount); + +//------------------------------------------------------------------------------ +// +// MPT DEX +// +//------------------------------------------------------------------------------ + +/* Return true if a transaction is allowed for the specified MPT/account. The + * function checks MPTokenIssuance and MPToken objects flags to determine if the + * transaction is allowed. + */ +TER +checkMPTTxAllowed(ReadView const& v, TxType tx, Asset const& asset, AccountID const& accountID); + } // namespace xrpl diff --git a/include/xrpl/tx/transactors/nft/NFTokenUtils.h b/include/xrpl/ledger/helpers/NFTokenHelpers.h similarity index 95% rename from include/xrpl/tx/transactors/nft/NFTokenUtils.h rename to include/xrpl/ledger/helpers/NFTokenHelpers.h index 33aab068c6..3af81eff16 100644 --- a/include/xrpl/tx/transactors/nft/NFTokenUtils.h +++ b/include/xrpl/ledger/helpers/NFTokenHelpers.h @@ -1,12 +1,12 @@ #pragma once +#include #include #include #include #include #include #include -#include namespace xrpl { @@ -20,10 +20,6 @@ removeTokenOffersWithLimit( Keylet const& directory, std::size_t maxDeletableOffers); -/** Returns tesSUCCESS if NFToken has few enough offers that it can be burned */ -TER -notTooManyOffers(ReadView const& view, uint256 const& nftokenID); - /** Finds the specified token in the owner's token directory. */ std::optional findToken(ReadView const& view, AccountID const& owner, uint256 const& nftokenID); diff --git a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelHelpers.h b/include/xrpl/ledger/helpers/PaymentChannelHelpers.h similarity index 77% rename from src/libxrpl/tx/transactors/payment_channel/PaymentChannelHelpers.h rename to include/xrpl/ledger/helpers/PaymentChannelHelpers.h index 5d1a4c0aa1..24838f1331 100644 --- a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelHelpers.h +++ b/include/xrpl/ledger/helpers/PaymentChannelHelpers.h @@ -1,6 +1,8 @@ #pragma once +#include #include +#include #include namespace xrpl { diff --git a/include/xrpl/tx/transactors/dex/PermissionedDEXHelpers.h b/include/xrpl/ledger/helpers/PermissionedDEXHelpers.h similarity index 100% rename from include/xrpl/tx/transactors/dex/PermissionedDEXHelpers.h rename to include/xrpl/ledger/helpers/PermissionedDEXHelpers.h diff --git a/include/xrpl/ledger/helpers/RippleStateHelpers.h b/include/xrpl/ledger/helpers/RippleStateHelpers.h index 3feba59d1f..17b0f7673e 100644 --- a/include/xrpl/ledger/helpers/RippleStateHelpers.h +++ b/include/xrpl/ledger/helpers/RippleStateHelpers.h @@ -252,4 +252,14 @@ deleteAMMTrustLine( std::optional const& ammAccountID, beast::Journal j); +/** Delete AMMs MPToken. The passed `sle` must be obtained from a prior + * call to view.peek(). + */ +[[nodiscard]] TER +deleteAMMMPToken( + ApplyView& view, + std::shared_ptr sleMPT, + AccountID const& ammAccountID, + beast::Journal j); + } // namespace xrpl diff --git a/include/xrpl/ledger/helpers/TokenHelpers.h b/include/xrpl/ledger/helpers/TokenHelpers.h index 74d1e4848e..c05308295a 100644 --- a/include/xrpl/ledger/helpers/TokenHelpers.h +++ b/include/xrpl/ledger/helpers/TokenHelpers.h @@ -31,6 +31,9 @@ enum SpendableHandling { shSIMPLE_BALANCE, shFULL_BALANCE }; enum class WaiveTransferFee : bool { No = false, Yes }; +/** Controls whether accountSend is allowed to overflow OutstandingAmount **/ +enum class AllowMPTOverflow : bool { No = false, Yes }; + /* Check if MPToken (for MPT) or trust line (for IOU) exists: * - StrongAuth - before checking if authorization is required * - WeakAuth @@ -176,6 +179,16 @@ accountFunds( FreezeHandling freezeHandling, beast::Journal j); +// Overload with AuthHandling to support IOU and MPT. +[[nodiscard]] STAmount +accountFunds( + ReadView const& view, + AccountID const& id, + STAmount const& saDefault, + FreezeHandling freezeHandling, + AuthHandling authHandling, + beast::Journal j); + /** Returns the transfer fee as Rate based on the type of token * @param view The ledger view * @param amount The amount to transfer @@ -235,11 +248,11 @@ canTransfer(ReadView const& view, Asset const& asset, AccountID const& from, Acc // --> bCheckIssuer : normally require issuer to be involved. // [[nodiscard]] // nodiscard commented out so DirectStep.cpp compiles. -/** Calls static rippleCreditIOU if saAmount represents Issue. - * Calls static rippleCreditMPT if saAmount represents MPTIssue. +/** Calls static directSendNoFeeIOU if saAmount represents Issue. + * Calls static directSendNoFeeMPT if saAmount represents MPTIssue. */ TER -rippleCredit( +directSendNoFee( ApplyView& view, AccountID const& uSenderID, AccountID const& uReceiverID, @@ -257,7 +270,8 @@ accountSend( AccountID const& to, STAmount const& saAmount, beast::Journal j, - WaiveTransferFee waiveFee = WaiveTransferFee::No); + WaiveTransferFee waiveFee = WaiveTransferFee::No, + AllowMPTOverflow allowOverflow = AllowMPTOverflow::No); using MultiplePaymentDestinations = std::vector>; /** Like accountSend, except one account is sending multiple payments (with the diff --git a/include/xrpl/net/AutoSocket.h b/include/xrpl/net/AutoSocket.h index 29cec23998..45e4919b8a 100644 --- a/include/xrpl/net/AutoSocket.h +++ b/include/xrpl/net/AutoSocket.h @@ -44,7 +44,7 @@ public: } bool - isSecure() + isSecure() const { return mSecure; } @@ -126,7 +126,9 @@ public: async_shutdown(ShutdownHandler handler) { if (isSecure()) + { mSocket->async_shutdown(handler); + } else { error_code ec; @@ -134,7 +136,7 @@ public: { lowest_layer().shutdown(plain_socket::shutdown_both); } - catch (boost::system::system_error& e) + catch (boost::system::system_error const& e) { ec = e.code(); } @@ -147,9 +149,13 @@ public: async_read_some(Seq const& buffers, Handler handler) { if (isSecure()) + { mSocket->async_read_some(buffers, handler); + } else + { PlainSocket().async_read_some(buffers, handler); + } } template @@ -157,9 +163,13 @@ public: async_read_until(Seq const& buffers, Condition condition, Handler handler) { if (isSecure()) + { boost::asio::async_read_until(*mSocket, buffers, condition, handler); + } else + { boost::asio::async_read_until(PlainSocket(), buffers, condition, handler); + } } template @@ -170,9 +180,13 @@ public: Handler handler) { if (isSecure()) + { boost::asio::async_read_until(*mSocket, buffers, delim, handler); + } else + { boost::asio::async_read_until(PlainSocket(), buffers, delim, handler); + } } template @@ -183,9 +197,13 @@ public: Handler handler) { if (isSecure()) + { boost::asio::async_read_until(*mSocket, buffers, cond, handler); + } else + { boost::asio::async_read_until(PlainSocket(), buffers, cond, handler); + } } template @@ -193,9 +211,13 @@ public: async_write(Buf const& buffers, Handler handler) { if (isSecure()) + { boost::asio::async_write(*mSocket, buffers, handler); + } else + { boost::asio::async_write(PlainSocket(), buffers, handler); + } } template @@ -203,9 +225,13 @@ public: async_write(boost::asio::basic_streambuf& buffers, Handler handler) { if (isSecure()) + { boost::asio::async_write(*mSocket, buffers, handler); + } else + { boost::asio::async_write(PlainSocket(), buffers, handler); + } } template @@ -213,9 +239,13 @@ public: async_read(Buf const& buffers, Condition cond, Handler handler) { if (isSecure()) + { boost::asio::async_read(*mSocket, buffers, cond, handler); + } else + { boost::asio::async_read(PlainSocket(), buffers, cond, handler); + } } template @@ -223,9 +253,13 @@ public: async_read(boost::asio::basic_streambuf& buffers, Condition cond, Handler handler) { if (isSecure()) + { boost::asio::async_read(*mSocket, buffers, cond, handler); + } else + { boost::asio::async_read(PlainSocket(), buffers, cond, handler); + } } template @@ -233,9 +267,13 @@ public: async_read(Buf const& buffers, Handler handler) { if (isSecure()) + { boost::asio::async_read(*mSocket, buffers, handler); + } else + { boost::asio::async_read(PlainSocket(), buffers, handler); + } } template @@ -243,9 +281,13 @@ public: async_write_some(Seq const& buffers, Handler handler) { if (isSecure()) + { mSocket->async_write_some(buffers, handler); + } else + { PlainSocket().async_write_some(buffers, handler); + } } protected: diff --git a/include/xrpl/net/HTTPClientSSLContext.h b/include/xrpl/net/HTTPClientSSLContext.h index 80e5835f5e..a53ecff849 100644 --- a/include/xrpl/net/HTTPClientSSLContext.h +++ b/include/xrpl/net/HTTPClientSSLContext.h @@ -30,8 +30,10 @@ public: registerSSLCerts(ssl_context_, ec, j_); if (ec && sslVerifyDir.empty()) + { Throw(boost::str( boost::format("Failed to set_default_verify_paths: %s") % ec.message())); + } } else { @@ -43,8 +45,10 @@ public: ssl_context_.add_verify_path(sslVerifyDir, ec); if (ec) + { Throw( boost::str(boost::format("Failed to add verify path: %s") % ec.message())); + } } } diff --git a/include/xrpl/nodestore/README.md b/include/xrpl/nodestore/README.md index 4b228bfc9a..b78c99e27d 100644 --- a/include/xrpl/nodestore/README.md +++ b/include/xrpl/nodestore/README.md @@ -51,7 +51,7 @@ A blob containing the payload. Stored in the following format. --- The `NodeStore` provides an interface that stores, in a persistent database, a -collection of NodeObjects that rippled uses as its primary representation of +collection of NodeObjects that xrpld uses as its primary representation of ledger entries. All ledger entries are stored as NodeObjects and as such, need to be persisted between launches. If a NodeObject is accessed and is not in memory, it will be retrieved from the database. @@ -110,7 +110,7 @@ The `NodeStore.Timing` test is used to execute a set of read/write workloads to compare current available nodestore backends. It can be executed with: ``` -$rippled --unittest=NodeStoreTiming +$xrpld --unittest=NodeStoreTiming ``` It is also possible to use alternate DB config params by passing config strings @@ -143,10 +143,10 @@ Through various executions and profiling some conclusions are presented below. just after ledger close, then that would provide similar, but more predictable guarantees. It would also remove an unneeded thread and unnecessary memory usage. An alternative point of view is that because there will always be many - other rippled instances running there is no need for such guarantees. The nodes + other xrpld instances running there is no need for such guarantees. The nodes will always be available from another peer. -- Lookup in a block was previously using binary search. With rippled's use case +- Lookup in a block was previously using binary search. With xrpld's use case it is highly unlikely that two adjacent key/values will ever be requested one after the other. Therefore hash indexing of blocks makes much more sense. Rocksdb has a number of options for hash indexing both memtables and blocks and diff --git a/include/xrpl/nodestore/Scheduler.h b/include/xrpl/nodestore/Scheduler.h index 6e01533930..dc3e1e3d15 100644 --- a/include/xrpl/nodestore/Scheduler.h +++ b/include/xrpl/nodestore/Scheduler.h @@ -16,7 +16,7 @@ struct FetchReport { } - std::chrono::milliseconds elapsed; + std::chrono::milliseconds elapsed{}; FetchType const fetchType; bool wasFound = false; }; diff --git a/include/xrpl/nodestore/Types.h b/include/xrpl/nodestore/Types.h index 5adbc40f70..f44332a049 100644 --- a/include/xrpl/nodestore/Types.h +++ b/include/xrpl/nodestore/Types.h @@ -22,11 +22,11 @@ enum { /** Return codes from Backend operations. */ enum Status { - ok, - notFound, - dataCorrupt, - unknown, - backendError, + ok = 0, + notFound = 1, + dataCorrupt = 2, + unknown = 3, + backendError = 4, customCode = 100 }; diff --git a/include/xrpl/nodestore/detail/BatchWriter.h b/include/xrpl/nodestore/detail/BatchWriter.h index 1820435133..93993d1c3e 100644 --- a/include/xrpl/nodestore/detail/BatchWriter.h +++ b/include/xrpl/nodestore/detail/BatchWriter.h @@ -71,8 +71,8 @@ private: Scheduler& m_scheduler; LockType mWriteMutex; CondvarType mWriteCondition; - int mWriteLoad; - bool mWritePending; + int mWriteLoad{0}; + bool mWritePending{false}; Batch mWriteSet; }; diff --git a/include/xrpl/nodestore/detail/EncodedBlob.h b/include/xrpl/nodestore/detail/EncodedBlob.h index 78e7153f73..b05583475e 100644 --- a/include/xrpl/nodestore/detail/EncodedBlob.h +++ b/include/xrpl/nodestore/detail/EncodedBlob.h @@ -35,7 +35,7 @@ namespace NodeStore { class EncodedBlob { /** The 32-byte key of the serialized object. */ - std::array key_; + std::array key_{}; /** A pre-allocated buffer for the serialized object. @@ -43,7 +43,8 @@ class EncodedBlob 1024 more bytes. The precise size is calculated automatically at compile time so as to avoid wasting space on padding bytes. */ - std::array payload_; + std::array + payload_{}; /** The size of the serialized data. */ std::uint32_t size_; diff --git a/include/xrpl/nodestore/detail/codec.h b/include/xrpl/nodestore/detail/codec.h index 8a337ca4c3..8096048185 100644 --- a/include/xrpl/nodestore/detail/codec.h +++ b/include/xrpl/nodestore/detail/codec.h @@ -56,7 +56,7 @@ lz4_compress(void const* in, std::size_t in_size, BufferFactory&& bf) using std::runtime_error; using namespace nudb::detail; std::pair result; - std::array::max> vi; + std::array::max> vi{}; auto const n = write_varint(vi.data(), in_size); auto const out_max = LZ4_compressBound(in_size); std::uint8_t* out = reinterpret_cast(bf(n + out_max)); @@ -88,7 +88,7 @@ nodeobject_decompress(void const* in, std::size_t in_size, BufferFactory&& bf) using namespace nudb::detail; std::uint8_t const* p = reinterpret_cast(in); - std::size_t type; + std::size_t type = 0; auto const vn = read_varint(p, in_size, type); if (vn == 0) Throw("nodeobject decompress"); @@ -113,11 +113,13 @@ nodeobject_decompress(void const* in, std::size_t in_size, BufferFactory&& bf) { auto const hs = field::size; // Mask if (in_size < hs + 32) + { Throw( "nodeobject codec v1: short inner node size: " + std::string("in_size = ") + std::to_string(in_size) + " hs = " + std::to_string(hs)); + } istream is(p, in_size); - std::uint16_t mask; + std::uint16_t mask = 0; read(is, mask); // Mask in_size -= hs; result.second = 525; @@ -136,10 +138,12 @@ nodeobject_decompress(void const* in, std::size_t in_size, BufferFactory&& bf) if (mask & bit) { if (in_size < 32) + { Throw( "nodeobject codec v1: short inner node subsize: " + std::string("in_size = ") + std::to_string(in_size) + " i = " + std::to_string(i)); + } std::memcpy(os.data(32), is(32), 32); in_size -= 32; } @@ -149,16 +153,20 @@ nodeobject_decompress(void const* in, std::size_t in_size, BufferFactory&& bf) } } if (in_size > 0) + { Throw( "nodeobject codec v1: long inner node, in_size = " + std::to_string(in_size)); + } break; } case 3: // full v1 inner node { - if (in_size != 16 * 32) // hashes + if (in_size != 16 * 32) + { // hashes Throw( "nodeobject codec v1: short full inner node, in_size = " + std::to_string(in_size)); + } istream is(p, in_size); result.second = 525; void* const out = bf(result.second); @@ -196,10 +204,10 @@ nodeobject_compress(void const* in, std::size_t in_size, BufferFactory&& bf) if (in_size == 525) { istream is(in, in_size); - std::uint32_t index; - std::uint32_t unused; - std::uint8_t kind; - std::uint32_t prefix; + std::uint32_t index = 0; + std::uint32_t unused = 0; + std::uint8_t kind = 0; + std::uint32_t prefix = 0; read(is, index); read(is, unused); read(is, kind); @@ -208,13 +216,13 @@ nodeobject_compress(void const* in, std::size_t in_size, BufferFactory&& bf) { std::size_t n = 0; std::uint16_t mask = 0; - std::array vh; + std::array vh{}; for (unsigned bit = 0x8000; bit; bit >>= 1) { void const* const h = is(32); if (std::memcmp(h, zero32(), 32) == 0) continue; - std::memcpy(vh.data() + 32 * n, h, 32); + std::memcpy(vh.data() + (32 * n), h, 32); mask |= bit; ++n; } @@ -225,7 +233,7 @@ nodeobject_compress(void const* in, std::size_t in_size, BufferFactory&& bf) auto const type = 2U; auto const vs = size_varint(type); result.second = vs + field::size + // mask - n * 32; // hashes + (n * 32); // hashes std::uint8_t* out = reinterpret_cast(bf(result.second)); result.first = out; ostream os(out, result.second); @@ -237,7 +245,7 @@ nodeobject_compress(void const* in, std::size_t in_size, BufferFactory&& bf) // 3 = full v1 inner node auto const type = 3U; auto const vs = size_varint(type); - result.second = vs + n * 32; // hashes + result.second = vs + (n * 32); // hashes std::uint8_t* out = reinterpret_cast(bf(result.second)); result.first = out; ostream os(out, result.second); @@ -247,7 +255,7 @@ nodeobject_compress(void const* in, std::size_t in_size, BufferFactory&& bf) } } - std::array::max> vi; + std::array::max> vi{}; constexpr std::size_t codecType = 1; auto const vn = write_varint(vi.data(), codecType); @@ -257,7 +265,7 @@ nodeobject_compress(void const* in, std::size_t in_size, BufferFactory&& bf) // case 0 was uncompressed data; we always compress now. case 1: // lz4 { - std::uint8_t* p; + std::uint8_t* p = nullptr; auto const lzr = NodeStore::lz4_compress(in, in_size, [&p, &vn, &bf](std::size_t n) { p = reinterpret_cast(bf(vn + n)); return p + vn; @@ -287,10 +295,10 @@ filter_inner(void* in, std::size_t in_size) if (in_size == 525) { istream is(in, in_size); - std::uint32_t index; - std::uint32_t unused; - std::uint8_t kind; - std::uint32_t prefix; + std::uint32_t index = 0; + std::uint32_t unused = 0; + std::uint8_t kind = 0; + std::uint32_t prefix = 0; read(is, index); read(is, unused); read(is, kind); diff --git a/include/xrpl/nodestore/detail/varint.h b/include/xrpl/nodestore/detail/varint.h index 98f8d8ff08..cc7e49fd6f 100644 --- a/include/xrpl/nodestore/detail/varint.h +++ b/include/xrpl/nodestore/detail/varint.h @@ -42,8 +42,10 @@ read_varint(void const* buf, std::size_t buflen, std::size_t& t) std::uint8_t const* p = reinterpret_cast(buf); std::size_t n = 0; while (p[n] & 0x80) + { if (++n >= buflen) return 0; + } if (++n > buflen) return 0; // Special case for 0 @@ -82,6 +84,7 @@ template std::size_t write_varint(void* p0, std::size_t v) { + // NOLINTNEXTLINE(misc-const-correctness) std::uint8_t* p = reinterpret_cast(p0); do { diff --git a/include/xrpl/proto/org/xrpl/rpc/v1/README.md b/include/xrpl/proto/org/xrpl/rpc/v1/README.md index e9b9b55841..e8566ec179 100644 --- a/include/xrpl/proto/org/xrpl/rpc/v1/README.md +++ b/include/xrpl/proto/org/xrpl/rpc/v1/README.md @@ -1,8 +1,8 @@ # Protocol buffer definitions for gRPC -This folder contains the protocol buffer definitions used by the rippled gRPC API. +This folder contains the protocol buffer definitions used by the xrpld 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: +As of April 2020, the gRPC API supports a subset of the full xrpld API: tx, account_tx, account_info, fee and submit. ### Making Changes @@ -63,7 +63,7 @@ templated `CallData` class in GRPCServerImpl::setupListeners(). The template parameters should be the request type and the response type. Finally, define the handler itself in the appropriate file under the -src/ripple/rpc/handlers folder. If the method already has a JSON/Websocket +src/xrpld/rpc/handlers folder. If the method already has a JSON/Websocket equivalent, write the gRPC handler in the same file, and abstract common logic into helper functions (see Tx.cpp or AccountTx.cpp for an example). diff --git a/include/xrpl/proto/xrpl.proto b/include/xrpl/proto/xrpl.proto index 0af7deb35d..cd82ed24e6 100644 --- a/include/xrpl/proto/xrpl.proto +++ b/include/xrpl/proto/xrpl.proto @@ -36,7 +36,7 @@ enum MessageType { /* Provides the current ephemeral key for a validator. */ message TMManifest { - // A Manifest object in the Ripple serialization format. + // A Manifest object in the XRPL serialization format. required bytes stobject = 1; } diff --git a/include/xrpl/protocol/AMMCore.h b/include/xrpl/protocol/AMMCore.h index 1a0252d67a..7a835b44cd 100644 --- a/include/xrpl/protocol/AMMCore.h +++ b/include/xrpl/protocol/AMMCore.h @@ -2,7 +2,7 @@ #include #include -#include +#include #include #include @@ -31,12 +31,12 @@ class Rules; /** Calculate Liquidity Provider Token (LPT) Currency. */ Currency -ammLPTCurrency(Currency const& cur1, Currency const& cur2); +ammLPTCurrency(Asset const& asset1, Asset const& asset2); /** Calculate LPT Issue from AMM asset pair. */ Issue -ammLPTIssue(Currency const& cur1, Currency const& cur2, AccountID const& ammAccountID); +ammLPTIssue(Asset const& asset1, Asset const& asset2, AccountID const& ammAccountID); /** Validate the amount. * If validZero is false and amount is beast::zero then invalid amount. @@ -46,19 +46,19 @@ ammLPTIssue(Currency const& cur1, Currency const& cur2, AccountID const& ammAcco NotTEC invalidAMMAmount( STAmount const& amount, - std::optional> const& pair = std::nullopt, + std::optional> const& pair = std::nullopt, bool validZero = false); NotTEC invalidAMMAsset( - Issue const& issue, - std::optional> const& pair = std::nullopt); + Asset const& asset, + std::optional> const& pair = std::nullopt); NotTEC invalidAMMAssetPair( - Issue const& issue1, - Issue const& issue2, - std::optional> const& pair = std::nullopt); + Asset const& asset1, + Asset const& asset2, + std::optional> const& pair = std::nullopt); /** Get time slot of the auction slot. */ diff --git a/include/xrpl/protocol/AccountID.h b/include/xrpl/protocol/AccountID.h index bc57058d9e..641f2f15c1 100644 --- a/include/xrpl/protocol/AccountID.h +++ b/include/xrpl/protocol/AccountID.h @@ -2,7 +2,7 @@ #include // VFALCO Uncomment when the header issues are resolved -// #include +// #include #include #include #include diff --git a/include/xrpl/protocol/AmountConversions.h b/include/xrpl/protocol/AmountConversions.h index e1a224dac9..9fb45e7bf8 100644 --- a/include/xrpl/protocol/AmountConversions.h +++ b/include/xrpl/protocol/AmountConversions.h @@ -1,6 +1,7 @@ #pragma once #include +#include #include #include @@ -9,11 +10,12 @@ namespace xrpl { inline STAmount -toSTAmount(IOUAmount const& iou, Issue const& iss) +toSTAmount(IOUAmount const& iou, Asset const& asset) { + XRPL_ASSERT(asset.holds(), "xrpl::toSTAmount : is Issue"); bool const isNeg = iou.signum() < 0; std::uint64_t const umant = isNeg ? -iou.mantissa() : iou.mantissa(); - return STAmount(iss, umant, iou.exponent(), isNeg, STAmount::unchecked()); + return STAmount(asset, umant, iou.exponent(), isNeg, STAmount::unchecked()); } inline STAmount @@ -31,12 +33,25 @@ toSTAmount(XRPAmount const& xrp) } inline STAmount -toSTAmount(XRPAmount const& xrp, Issue const& iss) +toSTAmount(XRPAmount const& xrp, Asset const& asset) { - XRPL_ASSERT(isXRP(iss.account) && isXRP(iss.currency), "xrpl::toSTAmount : is XRP"); + XRPL_ASSERT(isXRP(asset), "xrpl::toSTAmount : is XRP"); return toSTAmount(xrp); } +inline STAmount +toSTAmount(MPTAmount const& mpt) +{ + return STAmount(mpt, noMPT()); +} + +inline STAmount +toSTAmount(MPTAmount const& mpt, Asset const& asset) +{ + XRPL_ASSERT(asset.holds(), "xrpl::toSTAmount : is MPT"); + return STAmount(mpt, asset.get()); +} + template T toAmount(STAmount const& amt) = delete; @@ -76,6 +91,21 @@ toAmount(STAmount const& amt) return XRPAmount(sMant); } +template <> +inline MPTAmount +toAmount(STAmount const& amt) +{ + XRPL_ASSERT( + amt.holds() && amt.mantissa() <= maxMPTokenAmount && amt.exponent() == 0, + "xrpl::toAmount : maximum mantissa"); + if (amt.mantissa() > maxMPTokenAmount || amt.exponent() != 0) + Throw("toAmount: invalid mantissa or exponent"); + bool const isNeg = amt.negative(); + std::int64_t const sMant = isNeg ? -std::int64_t(amt.mantissa()) : amt.mantissa(); + + return MPTAmount(sMant); +} + template T toAmount(IOUAmount const& amt) = delete; @@ -98,23 +128,42 @@ toAmount(XRPAmount const& amt) return amt; } +template +T +toAmount(MPTAmount const& amt) = delete; + +template <> +inline MPTAmount +toAmount(MPTAmount const& amt) +{ + return amt; +} + template T -toAmount(Issue const& issue, Number const& n, Number::rounding_mode mode = Number::getround()) +toAmount(Asset const& asset, Number const& n, Number::rounding_mode mode = Number::getround()) { - saveNumberRoundMode rm(Number::getround()); - if (isXRP(issue)) + saveNumberRoundMode const rm(Number::getround()); + if (isXRP(asset)) Number::setround(mode); if constexpr (std::is_same_v) + { return IOUAmount(n); + } else if constexpr (std::is_same_v) + { return XRPAmount(static_cast(n)); + } + else if constexpr (std::is_same_v) + { + return MPTAmount(static_cast(n)); + } else if constexpr (std::is_same_v) { - if (isXRP(issue)) - return STAmount(issue, static_cast(n)); - return STAmount(issue, n); + if (isXRP(asset)) + return STAmount(asset, static_cast(n)); + return STAmount(asset, n); } else { @@ -125,17 +174,29 @@ toAmount(Issue const& issue, Number const& n, Number::rounding_mode mode = Numbe template T -toMaxAmount(Issue const& issue) +toMaxAmount(Asset const& asset) { if constexpr (std::is_same_v) + { return IOUAmount(STAmount::cMaxValue, STAmount::cMaxOffset); + } else if constexpr (std::is_same_v) + { return XRPAmount(static_cast(STAmount::cMaxNativeN)); + } + else if constexpr (std::is_same_v) + { + return MPTAmount(maxMPTokenAmount); + } else if constexpr (std::is_same_v) { - if (isXRP(issue)) - return STAmount(issue, static_cast(STAmount::cMaxNativeN)); - return STAmount(issue, STAmount::cMaxValue, STAmount::cMaxOffset); + return asset.visit( + [](Issue const& issue) { + if (isXRP(issue)) + return STAmount(issue, static_cast(STAmount::cMaxNativeN)); + return STAmount(issue, STAmount::cMaxValue, STAmount::cMaxOffset); + }, + [](MPTIssue const& issue) { return STAmount(issue, maxMPTokenAmount); }); } else { @@ -145,21 +206,31 @@ toMaxAmount(Issue const& issue) } inline STAmount -toSTAmount(Issue const& issue, Number const& n, Number::rounding_mode mode = Number::getround()) +toSTAmount(Asset const& asset, Number const& n, Number::rounding_mode mode = Number::getround()) { - return toAmount(issue, n, mode); + return toAmount(asset, n, mode); } template -Issue -getIssue(T const& amt) +Asset +getAsset(T const& amt) { if constexpr (std::is_same_v) + { return noIssue(); + } else if constexpr (std::is_same_v) + { return xrpIssue(); + } + else if constexpr (std::is_same_v) + { + return noMPT(); + } else if constexpr (std::is_same_v) - return amt.issue(); + { + return amt.asset(); + } else { constexpr bool alwaysFalse = !std::is_same_v; @@ -172,11 +243,21 @@ constexpr T get(STAmount const& a) { if constexpr (std::is_same_v) + { return a.iou(); + } else if constexpr (std::is_same_v) + { return a.xrp(); + } + else if constexpr (std::is_same_v) + { + return a.mpt(); + } else if constexpr (std::is_same_v) + { return a; + } else { constexpr bool alwaysFalse = !std::is_same_v; diff --git a/include/xrpl/protocol/ApiVersion.h b/include/xrpl/protocol/ApiVersion.h index 8772b5a49d..653b4830bf 100644 --- a/include/xrpl/protocol/ApiVersion.h +++ b/include/xrpl/protocol/ApiVersion.h @@ -138,9 +138,11 @@ forApiVersions(Fn const& fn, Args&&... args) { constexpr auto size = maxVer + 1 - minVer; [&](std::index_sequence) { + // NOLINTBEGIN(bugprone-use-after-move) (((void)fn( std::integral_constant{}, std::forward(args)...)), ...); + // NOLINTEND(bugprone-use-after-move) }(std::make_index_sequence{}); } diff --git a/include/xrpl/protocol/Asset.h b/include/xrpl/protocol/Asset.h index d48bc94b50..b1f0338665 100644 --- a/include/xrpl/protocol/Asset.h +++ b/include/xrpl/protocol/Asset.h @@ -2,20 +2,37 @@ #include #include +#include #include #include +#include namespace xrpl { -class Asset; class STAmount; -template -concept ValidIssueType = std::is_same_v || std::is_same_v; +template + requires( + std::is_same_v || std::is_same_v || + std::is_same_v) +struct AmountType +{ + using amount_type = T; +}; -template -concept AssetType = std::is_convertible_v || std::is_convertible_v || - std::is_convertible_v || std::is_convertible_v; +/* Used to check for an asset with either badCurrency() + * or MPT with 0 account. + */ +struct BadAsset +{ +}; + +inline BadAsset const& +badAsset() +{ + static BadAsset const a; + return a; +} /* Asset is an abstraction of three different issue types: XRP, IOU, MPT. * For historical reasons, two issue types XRP and IOU are wrapped in Issue @@ -26,6 +43,9 @@ class Asset { public: using value_type = std::variant; + using token_type = std::variant; + using AmtType = + std::variant, AmountType, AmountType>; private: value_type issue_; @@ -69,36 +89,42 @@ public: constexpr value_type const& value() const; + constexpr token_type + token() const; + void setJson(Json::Value& jv) const; STAmount operator()(Number const&) const; - bool + constexpr AmtType + getAmountType() const; + + // Custom, generic visit implementation + template + constexpr auto + visit(Visitors&&... visitors) const -> decltype(auto) + { + // Simple delegation to the reusable utility, passing the internal + // variant data. + return detail::visit(issue_, std::forward(visitors)...); + } + + constexpr bool native() const { - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - return issue.native(); - if constexpr (std::is_same_v) - return false; - }, - issue_); + return visit( + [&](Issue const& issue) { return issue.native(); }, + [&](MPTIssue const&) { return false; }); } bool integral() const { - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - return issue.native(); - if constexpr (std::is_same_v) - return true; - }, - issue_); + return visit( + [&](Issue const& issue) { return issue.native(); }, + [&](MPTIssue const&) { return true; }); } friend constexpr bool @@ -110,6 +136,10 @@ public: friend constexpr bool operator==(Currency const& lhs, Asset const& rhs); + // rhs is either badCurrency() or MPT issuer is 0 + friend constexpr bool + operator==(BadAsset const& lhs, Asset const& rhs); + /** Return true if both assets refer to the same currency (regardless of * issuer) or MPT issuance. Otherwise return false. */ @@ -117,6 +147,12 @@ public: equalTokens(Asset const& lhs, Asset const& rhs); }; +template +constexpr bool is_issue_v = std::is_same_v; + +template +constexpr bool is_mptissue_v = std::is_same_v; + inline Json::Value to_json(Asset const& asset) { @@ -156,15 +192,42 @@ Asset::value() const return issue_; } +constexpr Asset::token_type +Asset::token() const +{ + return visit( + [&](Issue const& issue) -> Asset::token_type { return issue.currency; }, + [&](MPTIssue const& issue) -> Asset::token_type { return issue.getMptID(); }); +} + +constexpr Asset::AmtType +Asset::getAmountType() const +{ + return visit( + [&](Issue const& issue) -> Asset::AmtType { + constexpr AmountType xrp; + constexpr AmountType iou; + return native() ? AmtType(xrp) : AmtType(iou); + }, + [&](MPTIssue const& issue) -> Asset::AmtType { + constexpr AmountType mpt; + return AmtType(mpt); + }); +} + constexpr bool operator==(Asset const& lhs, Asset const& rhs) { return std::visit( [&](TLhs const& issLhs, TRhs const& issRhs) { if constexpr (std::is_same_v) + { return issLhs == issRhs; + } else + { return false; + } }, lhs.issue_, rhs.issue_); @@ -176,11 +239,17 @@ operator<=>(Asset const& lhs, Asset const& rhs) return std::visit( [](TLhs const& lhs_, TRhs const& rhs_) { if constexpr (std::is_same_v) + { return std::weak_ordering(lhs_ <=> rhs_); - else if constexpr (std::is_same_v && std::is_same_v) + } + else if constexpr (is_issue_v && is_mptissue_v) + { return std::weak_ordering::greater; + } else + { return std::weak_ordering::less; + } }, lhs.issue_, rhs.issue_); @@ -189,7 +258,17 @@ operator<=>(Asset const& lhs, Asset const& rhs) constexpr bool operator==(Currency const& lhs, Asset const& rhs) { - return rhs.holds() && rhs.get().currency == lhs; + return rhs.visit( + [&](Issue const& issue) { return issue.currency == lhs; }, + [](MPTIssue const& issue) { return false; }); +} + +constexpr bool +operator==(BadAsset const&, Asset const& rhs) +{ + return rhs.visit( + [](Issue const& issue) -> bool { return badCurrency() == issue.currency; }, + [](MPTIssue const& issue) -> bool { return issue.getIssuer() == xrpAccount(); }); } constexpr bool @@ -198,11 +277,17 @@ equalTokens(Asset const& lhs, Asset const& rhs) return std::visit( [&](TLhs const& issLhs, TRhs const& issRhs) { if constexpr (std::is_same_v && std::is_same_v) + { return issLhs.currency == issRhs.currency; + } else if constexpr (std::is_same_v && std::is_same_v) + { return issLhs.getMptID() == issRhs.getMptID(); + } else + { return false; + } }, lhs.issue_, rhs.issue_); @@ -223,4 +308,33 @@ validJSONAsset(Json::Value const& jv); Asset assetFromJson(Json::Value const& jv); +inline bool +isConsistent(Asset const& asset) +{ + return asset.visit( + [](Issue const& issue) { return isConsistent(issue); }, + [](MPTIssue const&) { return true; }); +} + +inline bool +validAsset(Asset const& asset) +{ + return asset.visit( + [](Issue const& issue) { return isConsistent(issue) && issue.currency != badCurrency(); }, + [](MPTIssue const& issue) { return issue.getIssuer() != xrpAccount(); }); +} + +template +void +hash_append(Hasher& h, Asset const& r) +{ + using beast::hash_append; + r.visit( + [&](Issue const& issue) { hash_append(h, issue); }, + [&](MPTIssue const& issue) { hash_append(h, issue); }); +} + +std::ostream& +operator<<(std::ostream& os, Asset const& x); + } // namespace xrpl diff --git a/include/xrpl/protocol/Book.h b/include/xrpl/protocol/Book.h index 83965cf701..36bf708f05 100644 --- a/include/xrpl/protocol/Book.h +++ b/include/xrpl/protocol/Book.h @@ -2,7 +2,7 @@ #include #include -#include +#include #include @@ -15,15 +15,15 @@ namespace xrpl { class Book final : public CountedObject { public: - Issue in; - Issue out; + Asset in; + Asset out; std::optional domain; Book() { } - Book(Issue const& in_, Issue const& out_, std::optional const& domain_) + Book(Asset const& in_, Asset const& out_, std::optional const& domain_) : in(in_), out(out_), domain(domain_) { } @@ -53,7 +53,7 @@ reversed(Book const& book); /** Equality comparison. */ /** @{ */ -[[nodiscard]] inline constexpr bool +[[nodiscard]] constexpr bool operator==(Book const& lhs, Book const& rhs) { return (lhs.in == rhs.in) && (lhs.out == rhs.out) && (lhs.domain == rhs.domain); @@ -62,7 +62,7 @@ operator==(Book const& lhs, Book const& rhs) /** Strict weak ordering. */ /** @{ */ -[[nodiscard]] inline constexpr std::weak_ordering +[[nodiscard]] constexpr std::weak_ordering operator<=>(Book const& lhs, Book const& rhs) { if (auto const c{lhs.in <=> rhs.in}; c != 0) @@ -112,16 +112,67 @@ public: } }; +template <> +struct hash : private boost::base_from_member, 0> +{ +private: + using id_hash_type = boost::base_from_member, 0>; + +public: + explicit hash() = default; + + using value_type = std::size_t; + using argument_type = xrpl::MPTIssue; + + value_type + operator()(argument_type const& value) const + { + value_type const result(id_hash_type::member(value.getMptID())); + return result; + } +}; + +template <> +struct hash +{ +private: + using value_type = std::size_t; + using argument_type = xrpl::Asset; + + using issue_hasher = std::hash; + using mptissue_hasher = std::hash; + + issue_hasher m_issue_hasher; + mptissue_hasher m_mptissue_hasher; + +public: + explicit hash() = default; + + value_type + operator()(argument_type const& asset) const + { + return asset.visit( + [&](xrpl::Issue const& issue) { + value_type const result(m_issue_hasher(issue)); + return result; + }, + [&](xrpl::MPTIssue const& issue) { + value_type const result(m_mptissue_hasher(issue)); + return result; + }); + } +}; + //------------------------------------------------------------------------------ template <> struct hash { private: - using issue_hasher = std::hash; + using asset_hasher = std::hash; using uint256_hasher = xrpl::uint256::hasher; - issue_hasher m_issue_hasher; + asset_hasher m_asset_hasher; uint256_hasher m_uint256_hasher; public: @@ -133,8 +184,8 @@ public: value_type operator()(argument_type const& value) const { - value_type result(m_issue_hasher(value.in)); - boost::hash_combine(result, m_issue_hasher(value.out)); + value_type result(m_asset_hasher(value.in)); + boost::hash_combine(result, m_asset_hasher(value.out)); if (value.domain) boost::hash_combine(result, m_uint256_hasher(*value.domain)); @@ -159,6 +210,22 @@ struct hash : std::hash // using Base::Base; // inherit ctors }; +template <> +struct hash : std::hash +{ + explicit hash() = default; + + using Base = std::hash; +}; + +template <> +struct hash : std::hash +{ + explicit hash() = default; + + using Base = std::hash; +}; + template <> struct hash : std::hash { diff --git a/include/xrpl/protocol/BuildInfo.h b/include/xrpl/protocol/BuildInfo.h index cc7633cfe1..522747bc94 100644 --- a/include/xrpl/protocol/BuildInfo.h +++ b/include/xrpl/protocol/BuildInfo.h @@ -33,7 +33,7 @@ getFullVersionString(); X: 16 bits identifying the particular implementation Y: 48 bits of data specific to the implementation - The rippled-specific format (implementation ID is: 0x18 0x3B) is: + The xrpld-specific format (implementation ID is: 0x18 0x3B) is: 00011000-00111011-MMMMMMMM-mmmmmmmm-pppppppp-TTNNNNNN-00000000-00000000 @@ -55,23 +55,23 @@ encodeSoftwareVersion(std::string_view versionStr); std::uint64_t getEncodedVersion(); -/** Check if the encoded software version is a rippled software version. +/** Check if the encoded software version is an xrpld software version. @param version another node's encoded software version - @return true if the version is a rippled software version, false otherwise + @return true if the version is an xrpld software version, false otherwise */ bool -isRippledVersion(std::uint64_t version); +isXrpldVersion(std::uint64_t version); -/** Check if the version is newer than the local node's rippled software +/** Check if the version is newer than the local node's xrpld software version. @param version another node's encoded software version - @return true if the version is newer than the local node's rippled software + @return true if the version is newer than the local node's xrpld software version, false otherwise. @note This function only understands version numbers that are generated by - rippled. Please see the encodeSoftwareVersion() function for detail. + xrpld. Please see the encodeSoftwareVersion() function for detail. */ bool isNewerVersion(std::uint64_t version); diff --git a/include/xrpl/protocol/Concepts.h b/include/xrpl/protocol/Concepts.h new file mode 100644 index 0000000000..5f2eb3c7c8 --- /dev/null +++ b/include/xrpl/protocol/Concepts.h @@ -0,0 +1,86 @@ +#pragma once + +#include + +#include + +namespace xrpl { + +class STAmount; +class Asset; +class Issue; +class MPTIssue; +class IOUAmount; +class XRPAmount; +class MPTAmount; + +template +concept StepAmount = + std::is_same_v || std::is_same_v || std::is_same_v; + +template +concept ValidIssueType = std::is_same_v || std::is_same_v; + +template +concept AssetType = std::is_convertible_v || std::is_convertible_v || + std::is_convertible_v || std::is_convertible_v; + +template +concept ValidPathAsset = (std::is_same_v || std::is_same_v); + +template +concept ValidTaker = + ((std::is_same_v || std::is_same_v || + std::is_same_v) && + (std::is_same_v || std::is_same_v || + std::is_same_v) && + (!std::is_same_v || !std::is_same_v)); + +namespace detail { + +// This template combines multiple callable objects (lambdas) into a single +// object that std::visit can use for overload resolution. +template +struct CombineVisitors : Ts... +{ + // Bring all operator() overloads from base classes into this scope. + // It's the mechanism that makes the CombineVisitors struct function + // as a single callable object with multiple overloads. + using Ts::operator()...; + + // Perfect forwarding constructor to correctly initialize the base class + // lambdas + constexpr CombineVisitors(Ts&&... ts) : Ts(std::forward(ts))... + { + } +}; + +// This function forces function template argument deduction, which is more +// robust than class template argument deduction (CTAD) via the deduction guide. +template +constexpr CombineVisitors...> +make_combine_visitors(Ts&&... ts) +{ + // std::decay_t is used to remove references/constness from the lambda + // types before they are passed as template arguments to the CombineVisitors + // struct. + return CombineVisitors...>{std::forward(ts)...}; +} + +// This function takes ANY variant and ANY number of visitors, and performs the +// visit. It is the reusable core logic. +template +constexpr auto +visit(Variant&& v, Visitors&&... visitors) -> decltype(auto) +{ + // Use the function template helper instead of raw CTAD. + auto visitor_set = make_combine_visitors(std::forward(visitors)...); + + // Delegate to std::visit, perfectly forwarding the variant and the visitor + // set. + return std::visit(visitor_set, std::forward(v)); +} + +} // namespace detail + +} // namespace xrpl diff --git a/include/xrpl/protocol/ErrorCodes.h b/include/xrpl/protocol/ErrorCodes.h index c138d5d39a..2f16415bdf 100644 --- a/include/xrpl/protocol/ErrorCodes.h +++ b/include/xrpl/protocol/ErrorCodes.h @@ -153,7 +153,7 @@ enum warning_code_i { warnRPC_AMENDMENT_BLOCKED = 1002, warnRPC_EXPIRED_VALIDATOR_LIST = 1003, // unused = 1004 - warnRPC_FIELDS_DEPRECATED = 2004, // rippled needs to maintain + warnRPC_FIELDS_DEPRECATED = 2004, // xrpld needs to maintain // compatibility with Clio on this code. }; diff --git a/include/xrpl/protocol/Feature.h b/include/xrpl/protocol/Feature.h index 0ff02fdac2..8f96935ca1 100644 --- a/include/xrpl/protocol/Feature.h +++ b/include/xrpl/protocol/Feature.h @@ -37,10 +37,10 @@ * 5) If a supported feature (`Supported::yes`) was _ever_ in a released * version, it can never be changed back to `Supported::no`, because * it _may_ still become enabled at any time. This would cause newer - * versions of `rippled` to become amendment blocked. + * versions of `xrpld` to become amendment blocked. * Instead, to prevent newer versions from voting on the feature, use * `VoteBehavior::Obsolete`. Obsolete features can not be voted for - * by any versions of `rippled` built with that setting, but will still + * by any versions of `xrpld` built with that setting, but will still * work correctly if they get enabled. If a feature remains obsolete * for long enough that _all_ clients that could vote for it are * amendment blocked, the feature can be removed from the code @@ -107,8 +107,8 @@ validFeatureName(auto fn) -> bool return true; } -enum class VoteBehavior : int { Obsolete = -1, DefaultNo = 0, DefaultYes }; -enum class AmendmentSupport : int { Retired = -1, Supported = 0, Unsupported }; +enum class VoteBehavior : int { Obsolete = -1, DefaultNo = 0, DefaultYes = 1 }; +enum class AmendmentSupport : int { Retired = -1, Supported = 0, Unsupported = 1 }; /** All amendments libxrpl knows about. */ std::map const& @@ -125,10 +125,12 @@ namespace detail { #pragma push_macro("XRPL_RETIRE_FIX") #undef XRPL_RETIRE_FIX +// NOLINTBEGIN(bugprone-macro-parentheses) #define XRPL_FEATURE(name, supported, vote) +1 #define XRPL_FIX(name, supported, vote) +1 #define XRPL_RETIRE_FEATURE(name) +1 #define XRPL_RETIRE_FIX(name) +1 +// NOLINTEND(bugprone-macro-parentheses) // This value SHOULD be equal to the number of amendments registered in // Feature.cpp. Because it's only used to reserve storage, and determine how @@ -373,8 +375,10 @@ void foreachFeature(FeatureBitset bs, F&& f) { for (size_t i = 0; i < bs.size(); ++i) + { if (bs[i]) f(bitsetIndexToFeature(i)); + } } #pragma push_macro("XRPL_FEATURE") diff --git a/include/xrpl/protocol/IOUAmount.h b/include/xrpl/protocol/IOUAmount.h index 2ee453f575..1744345a1b 100644 --- a/include/xrpl/protocol/IOUAmount.h +++ b/include/xrpl/protocol/IOUAmount.h @@ -26,8 +26,8 @@ class IOUAmount : private boost::totally_ordered, private boost::addi private: using mantissa_type = std::int64_t; using exponent_type = int; - mantissa_type mantissa_; - exponent_type exponent_; + mantissa_type mantissa_{}; + exponent_type exponent_{}; /** Adjusts the mantissa and exponent to the proper range. @@ -151,7 +151,9 @@ operator bool() const noexcept inline int IOUAmount::signum() const noexcept { - return (mantissa_ < 0) ? -1 : (mantissa_ ? 1 : 0); + if (mantissa_ < 0) + return -1; + return (mantissa_ != 0) ? 1 : 0; } inline IOUAmount::exponent_type diff --git a/include/xrpl/protocol/Indexes.h b/include/xrpl/protocol/Indexes.h index 7884905d9e..574bbfbde6 100644 --- a/include/xrpl/protocol/Indexes.h +++ b/include/xrpl/protocol/Indexes.h @@ -363,11 +363,12 @@ uint256 getTicketIndex(AccountID const& account, SeqProxy ticketSeq); template +// NOLINTNEXTLINE(cppcoreguidelines-pro-type-member-init) struct keyletDesc { std::function function; Json::StaticString expectedLEName; - bool includeInTests; + bool includeInTests{}; }; // This list should include all of the keylet functions that take a single diff --git a/include/xrpl/protocol/Issue.h b/include/xrpl/protocol/Issue.h index c8e598a540..569b01725d 100644 --- a/include/xrpl/protocol/Issue.h +++ b/include/xrpl/protocol/Issue.h @@ -12,8 +12,8 @@ namespace xrpl { class Issue { public: - Currency currency{}; - AccountID account{}; + Currency currency; + AccountID account; Issue() = default; @@ -68,7 +68,7 @@ hash_append(Hasher& h, Issue const& r) /** Equality comparison. */ /** @{ */ -[[nodiscard]] inline constexpr bool +[[nodiscard]] constexpr bool operator==(Issue const& lhs, Issue const& rhs) { return (lhs.currency == rhs.currency) && (isXRP(lhs.currency) || lhs.account == rhs.account); @@ -96,7 +96,7 @@ operator<=>(Issue const& lhs, Issue const& rhs) inline Issue const& xrpIssue() { - static Issue issue{xrpCurrency(), xrpAccount()}; + static Issue const issue{xrpCurrency(), xrpAccount()}; return issue; } @@ -104,7 +104,7 @@ xrpIssue() inline Issue const& noIssue() { - static Issue issue{noCurrency(), noAccount()}; + static Issue const issue{noCurrency(), noAccount()}; return issue; } diff --git a/include/xrpl/protocol/KnownFormats.h b/include/xrpl/protocol/KnownFormats.h index c454683e19..d965f43b78 100644 --- a/include/xrpl/protocol/KnownFormats.h +++ b/include/xrpl/protocol/KnownFormats.h @@ -74,10 +74,12 @@ public: Derived classes will load the object with all the known formats. */ +private: KnownFormats() : name_(beast::type_name()) { } +public: /** Destroy the known formats object. The defined formats are deleted. @@ -181,6 +183,7 @@ private: boost::container::flat_map names_; boost::container::flat_map types_; + friend Derived; }; } // namespace xrpl diff --git a/include/xrpl/protocol/LedgerFormats.h b/include/xrpl/protocol/LedgerFormats.h index a43f6a7134..009a96533a 100644 --- a/include/xrpl/protocol/LedgerFormats.h +++ b/include/xrpl/protocol/LedgerFormats.h @@ -187,7 +187,8 @@ enum LedgerEntryType : std::uint16_t { \ LEDGER_OBJECT(MPToken, \ LSF_FLAG2(lsfMPTLocked, 0x00000001) \ - LSF_FLAG(lsfMPTAuthorized, 0x00000002)) \ + LSF_FLAG(lsfMPTAuthorized, 0x00000002) \ + LSF_FLAG(lsfMPTAMM, 0x00000004)) \ \ LEDGER_OBJECT(Credential, \ LSF_FLAG(lsfAccepted, 0x00010000)) \ @@ -210,7 +211,7 @@ enum LedgerEntryType : std::uint16_t { // lsfRequireDestTag = 0x00020000, // ... // }; -#define TO_VALUE(name, value) name = value, +#define TO_VALUE(name, value) name = (value), #define NULL_NAME(name, values) values #define NULL_OUTPUT(name, value) enum LedgerSpecificFlags : std::uint32_t { XMACRO(NULL_NAME, TO_VALUE, NULL_OUTPUT) }; diff --git a/include/xrpl/protocol/LedgerHeader.h b/include/xrpl/protocol/LedgerHeader.h index 6e22ad268d..1035e5e892 100644 --- a/include/xrpl/protocol/LedgerHeader.h +++ b/include/xrpl/protocol/LedgerHeader.h @@ -19,7 +19,7 @@ struct LedgerHeader // LedgerIndex seq = 0; - NetClock::time_point parentCloseTime = {}; + NetClock::time_point parentCloseTime; // // For closed ledgers @@ -49,7 +49,7 @@ struct LedgerHeader // closed. For open ledgers, the time the ledger // will close if there's no transactions. // - NetClock::time_point closeTime = {}; + NetClock::time_point closeTime; }; // ledger close flags diff --git a/include/xrpl/protocol/MPTAmount.h b/include/xrpl/protocol/MPTAmount.h index 5c1642ae5c..4a6297cc74 100644 --- a/include/xrpl/protocol/MPTAmount.h +++ b/include/xrpl/protocol/MPTAmount.h @@ -22,11 +22,12 @@ public: using value_type = std::int64_t; protected: - value_type value_; + value_type value_{}; public: MPTAmount() = default; constexpr MPTAmount(MPTAmount const& other) = default; + constexpr MPTAmount(beast::Zero); constexpr MPTAmount& operator=(MPTAmount const& other) = default; @@ -85,6 +86,11 @@ constexpr MPTAmount::MPTAmount(value_type value) : value_(value) { } +constexpr MPTAmount::MPTAmount(beast::Zero) +{ + *this = beast::zero; +} + constexpr MPTAmount& MPTAmount::operator=(beast::Zero) { @@ -103,7 +109,9 @@ operator bool() const noexcept constexpr int MPTAmount::signum() const noexcept { - return (value_ < 0) ? -1 : (value_ ? 1 : 0); + if (value_ < 0) + return -1; + return (value_ != 0) ? 1 : 0; } /** Returns the underlying value. Code SHOULD NOT call this @@ -116,6 +124,14 @@ MPTAmount::value() const return value_; } +// Output MPTAmount as just the value. +template +std::basic_ostream& +operator<<(std::basic_ostream& os, MPTAmount const& q) +{ + return os << q.value(); +} + inline std::string to_string(MPTAmount const& amount) { @@ -127,7 +143,7 @@ mulRatio(MPTAmount const& amt, std::uint32_t num, std::uint32_t den, bool roundU { using namespace boost::multiprecision; - if (!den) + if (den == 0u) Throw("division by zero"); int128_t const amt128(amt.value()); diff --git a/include/xrpl/protocol/MPTIssue.h b/include/xrpl/protocol/MPTIssue.h index d84a610418..727aef9008 100644 --- a/include/xrpl/protocol/MPTIssue.h +++ b/include/xrpl/protocol/MPTIssue.h @@ -17,7 +17,14 @@ private: public: MPTIssue() = default; - explicit MPTIssue(MPTID const& issuanceID); + MPTIssue(MPTID const& issuanceID); + + MPTIssue(std::uint32_t sequence, AccountID const& account); + + operator MPTID const&() const + { + return mptID_; + } AccountID const& getIssuer() const; @@ -40,14 +47,14 @@ public: friend constexpr std::weak_ordering operator<=>(MPTIssue const& lhs, MPTIssue const& rhs); - bool - native() const + static bool + native() { return false; } - bool - integral() const + static bool + integral() { return true; } @@ -73,6 +80,47 @@ isXRP(MPTID const&) return false; } +inline AccountID +getMPTIssuer(MPTID const& mptid) +{ + static_assert(sizeof(MPTID) == (sizeof(std::uint32_t) + sizeof(AccountID))); + // Extract the 20 bytes for the AccountID + std::array bytes{}; + std::copy_n(mptid.data() + sizeof(std::uint32_t), sizeof(AccountID), bytes.begin()); + + // bit_cast is a "magic" compiler intrinsic that is + // usually optimized away to nothing in the final assembly. + return std::bit_cast(bytes); +} + +// Disallow temporary +AccountID const& +getMPTIssuer(MPTID const&&) = delete; +AccountID const& +getMPTIssuer(MPTID&&) = delete; + +inline MPTID +noMPT() +{ + static MPTIssue const mpt{0, noAccount()}; + return mpt.getMptID(); +} + +inline MPTID +badMPT() +{ + static MPTIssue const mpt{0, xrpAccount()}; + return mpt.getMptID(); +} + +template +void +hash_append(Hasher& h, MPTIssue const& r) +{ + using beast::hash_append; + hash_append(h, r.getMptID()); +} + Json::Value to_json(MPTIssue const& mptIssue); @@ -82,4 +130,17 @@ to_string(MPTIssue const& mptIssue); MPTIssue mptIssueFromJson(Json::Value const& jv); +std::ostream& +operator<<(std::ostream& os, MPTIssue const& x); + } // namespace xrpl + +namespace std { + +template <> +struct hash : xrpl::MPTID::hasher +{ + explicit hash() = default; +}; + +} // namespace std diff --git a/include/xrpl/protocol/MultiApiJson.h b/include/xrpl/protocol/MultiApiJson.h index 1ebe72f15e..8d287767a6 100644 --- a/include/xrpl/protocol/MultiApiJson.h +++ b/include/xrpl/protocol/MultiApiJson.h @@ -74,10 +74,14 @@ struct MultiApiJson { int count = 0; for (auto& a : this->val) + { if (a.isMember(key)) count += 1; + } - return (count == 0 ? none : (count < size ? some : all)); + if (count == 0) + return none; + return count < size ? some : all; } static constexpr struct visitor_t final diff --git a/include/xrpl/protocol/PathAsset.h b/include/xrpl/protocol/PathAsset.h new file mode 100644 index 0000000000..662e568bec --- /dev/null +++ b/include/xrpl/protocol/PathAsset.h @@ -0,0 +1,134 @@ +#pragma once + +#include +#include + +namespace xrpl { + +/* Represent STPathElement's asset, which can be Currency or MPTID. + */ +class PathAsset +{ +private: + std::variant easset_; + +public: + PathAsset() = default; + // Enables comparing Asset and PathAsset + PathAsset(Asset const& asset); + PathAsset(Currency const& currency) : easset_(currency) + { + } + PathAsset(MPTID const& mpt) : easset_(mpt) + { + } + + template + constexpr bool + holds() const; + + constexpr bool + isXRP() const; + + template + T const& + get() const; + + constexpr std::variant const& + value() const; + + // Custom, generic visit implementation + template + constexpr auto + visit(Visitors&&... visitors) const -> decltype(auto) + { + // Simple delegation to the reusable utility, passing the internal + // variant data. + return detail::visit(easset_, std::forward(visitors)...); + } + + friend constexpr bool + operator==(PathAsset const& lhs, PathAsset const& rhs); +}; + +template +constexpr bool is_currency_v = std::is_same_v; + +template +constexpr bool is_mptid_v = std::is_same_v; + +inline PathAsset::PathAsset(Asset const& asset) +{ + asset.visit( + [&](Issue const& issue) { easset_ = issue.currency; }, + [&](MPTIssue const& issue) { easset_ = issue.getMptID(); }); +} + +template +constexpr bool +PathAsset::holds() const +{ + return std::holds_alternative(easset_); +} + +template +T const& +PathAsset::get() const +{ + if (!holds()) + Throw("PathAsset doesn't hold requested asset."); + return std::get(easset_); +} + +constexpr std::variant const& +PathAsset::value() const +{ + return easset_; +} + +constexpr bool +PathAsset::isXRP() const +{ + return visit( + [&](Currency const& currency) { return xrpl::isXRP(currency); }, + [](MPTID const&) { return false; }); +} + +constexpr bool +operator==(PathAsset const& lhs, PathAsset const& rhs) +{ + return std::visit( + [](TLhs const& lhs_, TRhs const& rhs_) { + if constexpr (std::is_same_v) + { + return lhs_ == rhs_; + } + else + { + return false; + } + }, + lhs.value(), + rhs.value()); +} + +template +void +hash_append(Hasher& h, PathAsset const& pathAsset) +{ + std::visit([&](T const& e) { hash_append(h, e); }, pathAsset.value()); +} + +inline bool +isXRP(PathAsset const& asset) +{ + return asset.isXRP(); +} + +std::string +to_string(PathAsset const& asset); + +std::ostream& +operator<<(std::ostream& os, PathAsset const& x); + +} // namespace xrpl diff --git a/include/xrpl/protocol/Permissions.h b/include/xrpl/protocol/Permissions.h index 0ec4f04f1a..ea8bd77643 100644 --- a/include/xrpl/protocol/Permissions.h +++ b/include/xrpl/protocol/Permissions.h @@ -20,7 +20,7 @@ enum GranularPermissionType : std::uint32_t { #pragma push_macro("PERMISSION") #undef PERMISSION -#define PERMISSION(type, txType, value) type = value, +#define PERMISSION(type, txType, value) type = (value), #include diff --git a/include/xrpl/protocol/PublicKey.h b/include/xrpl/protocol/PublicKey.h index 67e55ca136..9003175f3d 100644 --- a/include/xrpl/protocol/PublicKey.h +++ b/include/xrpl/protocol/PublicKey.h @@ -21,7 +21,7 @@ namespace xrpl { Public keys are used in the public-key cryptography system used to verify signatures attached to messages. - The format of the public key is Ripple specific, + The format of the public key is XRPL specific, information needed to determine the cryptosystem parameters used is stored inside the key. @@ -69,8 +69,8 @@ public: return buf_; } - std::size_t - size() const noexcept + static std::size_t + size() noexcept { return size_; } diff --git a/include/xrpl/protocol/Quality.h b/include/xrpl/protocol/Quality.h index 09b0f4e7cb..a58b89aaf8 100644 --- a/include/xrpl/protocol/Quality.h +++ b/include/xrpl/protocol/Quality.h @@ -56,8 +56,8 @@ struct TAmounts return *this; } - In in; - Out out; + In in{}; + Out out{}; }; using Amounts = TAmounts; @@ -78,7 +78,7 @@ operator!=(TAmounts const& lhs, TAmounts const& rhs) noexcept //------------------------------------------------------------------------------ -// Ripple specific constant used for parsing qualities and other things +// XRPL specific constant used for parsing qualities and other things #define QUALITY_ONE 1'000'000'000 /** Represents the logical ratio of output currency to input currency. @@ -281,7 +281,7 @@ public: double const minVD = static_cast(minVMantissa); double const maxVD = - expDiff ? maxVMantissa * pow(10, expDiff) : static_cast(maxVMantissa); + (expDiff != 0) ? maxVMantissa * pow(10, expDiff) : static_cast(maxVMantissa); // maxVD and minVD are scaled so they have the same exponents. Dividing // cancels out the exponents, so we only need to deal with the (scaled) @@ -304,8 +304,8 @@ Quality::ceil_TAmounts_helper( // Use the existing STAmount implementation for now, but consider // replacing with code specific to IOUAMount and XRPAmount - Amounts stAmt(toSTAmount(amount.in), toSTAmount(amount.out)); - STAmount stLim(toSTAmount(limit)); + Amounts const stAmt(toSTAmount(amount.in), toSTAmount(amount.out)); + STAmount const stLim(toSTAmount(limit)); Amounts const stRes = ((*this).*ceil_function)(stAmt, stLim, roundUp...); return TAmounts(toAmount(stRes.in), toAmount(stRes.out)); } diff --git a/include/xrpl/protocol/README.md b/include/xrpl/protocol/README.md index a6e8d24982..d679c583d4 100644 --- a/include/xrpl/protocol/README.md +++ b/include/xrpl/protocol/README.md @@ -22,7 +22,7 @@ optional fields easier to read: - The operation `x[~sfFoo]` means "return the value of 'Foo' if it exists, or nothing if it doesn't." This usage of the tilde/bitwise NOT operator is not standard outside of the - `rippled` codebase. + `xrpld` codebase. - As a consequence of this, `x[~sfFoo] = y[~sfFoo]` assigns the value of Foo from y to x, including omitting Foo from x if it doesn't exist in y. @@ -33,7 +33,7 @@ or may not hold a value. For things not guaranteed to exist, you use `x[~sfFoo]` because you want such a container. It avoids having to look something up twice, once just to see if it exists and a second time to get/set its value. -([Real example](https://github.com/ripple/rippled/blob/35f4698aed5dce02f771b34cfbb690495cb5efcc/src/ripple/app/tx/impl/PayChan.cpp#L229-L236)) +([Real example](https://github.com/XRPLF/rippled/blob/35f4698aed5dce02f771b34cfbb690495cb5efcc/src/ripple/app/tx/impl/PayChan.cpp#L229-L236)) The source of this "type magic" is in [SField.h](./SField.h#L296-L302). diff --git a/include/xrpl/protocol/RPCErr.h b/include/xrpl/protocol/RPCErr.h index 34c4bf8f99..e42bf5e637 100644 --- a/include/xrpl/protocol/RPCErr.h +++ b/include/xrpl/protocol/RPCErr.h @@ -1,6 +1,7 @@ #pragma once #include +#include namespace xrpl { diff --git a/include/xrpl/protocol/RippleLedgerHash.h b/include/xrpl/protocol/RippleLedgerHash.h index 2a51298d3d..9dab644663 100644 --- a/include/xrpl/protocol/RippleLedgerHash.h +++ b/include/xrpl/protocol/RippleLedgerHash.h @@ -6,4 +6,4 @@ namespace xrpl { using LedgerHash = uint256; -} +} // namespace xrpl diff --git a/include/xrpl/protocol/SField.h b/include/xrpl/protocol/SField.h index 7a864b1b58..cbc2c12f4e 100644 --- a/include/xrpl/protocol/SField.h +++ b/include/xrpl/protocol/SField.h @@ -84,7 +84,7 @@ class STCurrency; #pragma push_macro("TO_MAP") #undef TO_MAP -#define TO_ENUM(name, value) name = value, +#define TO_ENUM(name, value) name = (value), #define TO_MAP(name, value) {#name, value}, enum SerializedTypeID { XMACRO(TO_ENUM) }; diff --git a/include/xrpl/protocol/STAccount.h b/include/xrpl/protocol/STAccount.h index 76c8f24b7b..b1f112fbb2 100644 --- a/include/xrpl/protocol/STAccount.h +++ b/include/xrpl/protocol/STAccount.h @@ -13,7 +13,7 @@ class STAccount final : public STBase, public CountedObject private: // The original implementation of STAccount kept the value in an STBlob. // But an STAccount is always 160 bits, so we can store it with less - // overhead in a xrpl::uint160. However, so the serialized format of the + // overhead in an xrpl::uint160. However, so the serialized format of the // STAccount stays unchanged, we serialize and deserialize like an STBlob. AccountID value_; bool default_; diff --git a/include/xrpl/protocol/STAmount.h b/include/xrpl/protocol/STAmount.h index dadeec096f..55ffc81098 100644 --- a/include/xrpl/protocol/STAmount.h +++ b/include/xrpl/protocol/STAmount.h @@ -35,9 +35,9 @@ public: private: Asset mAsset; - mantissa_type mValue; + mantissa_type mValue{}; exponent_type mOffset; - bool mIsNegative; + bool mIsNegative{}; public: using value_type = STAmount; @@ -48,7 +48,7 @@ public: // Maximum native value supported by the code constexpr static std::uint64_t cMinValue = 1'000'000'000'000'000ull; static_assert(isPowerOfTen(cMinValue)); - constexpr static std::uint64_t cMaxValue = cMinValue * 10 - 1; + constexpr static std::uint64_t cMaxValue = (cMinValue * 10) - 1; static_assert(cMaxValue == 9'999'999'999'999'999ull); constexpr static std::uint64_t cMaxNative = 9'000'000'000'000'000'000ull; @@ -164,12 +164,9 @@ public: constexpr TIss const& get() const; - Issue const& - issue() const; - - // These three are deprecated - Currency const& - getCurrency() const; + template + TIss& + get(); AccountID const& getIssuer() const; @@ -225,9 +222,6 @@ public: void clear(Asset const& asset); - void - setIssuer(AccountID const& uIssuer); - /** Set the Issue for this amount. */ void setIssue(Asset const& asset); @@ -365,9 +359,13 @@ inline STAmount::STAmount(IOUAmount const& amount, Issue const& issue) : mAsset(issue), mOffset(amount.exponent()), mIsNegative(amount < beast::zero) { if (mIsNegative) + { mValue = unsafe_cast(-amount.mantissa()); + } else + { mValue = unsafe_cast(amount.mantissa()); + } canonicalize(); } @@ -376,9 +374,13 @@ inline STAmount::STAmount(MPTAmount const& amount, MPTIssue const& mptIssue) : mAsset(mptIssue), mOffset(0), mIsNegative(amount < beast::zero) { if (mIsNegative) + { mValue = unsafe_cast(-amount.value()); + } else + { mValue = unsafe_cast(amount.value()); + } canonicalize(); } @@ -407,7 +409,7 @@ amountFromJsonNoThrow(STAmount& result, Json::Value const& jvSource); inline STAmount const& toSTAmount(STAmount const& a) { - return a; + return a; // NOLINT(bugprone-return-const-ref-from-parameter) } //------------------------------------------------------------------------------ @@ -466,16 +468,11 @@ STAmount::get() const return mAsset.get(); } -inline Issue const& -STAmount::issue() const +template +TIss& +STAmount::get() { - return get(); -} - -inline Currency const& -STAmount::getCurrency() const -{ - return mAsset.get().currency; + return mAsset.get(); } inline AccountID const& @@ -487,7 +484,9 @@ STAmount::getIssuer() const inline int STAmount::signum() const noexcept { - return mValue ? (mIsNegative ? -1 : 1) : 0; + if (mValue == 0u) + return 0; + return mIsNegative ? -1 : 1; } inline STAmount @@ -505,11 +504,13 @@ operator bool() const noexcept inline STAmount:: operator Number() const { - if (native()) - return xrp(); - if (mAsset.holds()) - return mpt(); - return iou(); + return asset().visit( + [&](Issue const& issue) -> Number { + if (issue.native()) + return xrp(); + return iou(); + }, + [&](MPTIssue const&) -> Number { return mpt(); }); } inline STAmount& @@ -532,7 +533,7 @@ STAmount::fromNumber(A const& a, Number const& number) { bool const negative = number.mantissa() < 0; Number const working{negative ? -number : number}; - Asset asset{a}; + Asset const asset{a}; if (asset.integral()) { std::uint64_t const intValue = static_cast(working); @@ -568,12 +569,6 @@ STAmount::clear(Asset const& asset) clear(); } -inline void -STAmount::setIssuer(AccountID const& uIssuer) -{ - mAsset.get().account = uIssuer; -} - inline STAmount const& STAmount::value() const noexcept { @@ -716,7 +711,7 @@ roundToAsset( std::int32_t scale, Number::rounding_mode rounding = Number::getround()) { - NumberRoundModeGuard mg(rounding); + NumberRoundModeGuard const mg(rounding); STAmount const ret{asset, value}; if (ret.integral()) return ret; diff --git a/include/xrpl/protocol/STBase.h b/include/xrpl/protocol/STBase.h index 7f06b01ca4..8edeb26424 100644 --- a/include/xrpl/protocol/STBase.h +++ b/include/xrpl/protocol/STBase.h @@ -83,7 +83,7 @@ to_json(T const& t) namespace detail { class STVar; -} +} // namespace detail // VFALCO TODO fix this restriction on copy assignment. // diff --git a/include/xrpl/protocol/STBlob.h b/include/xrpl/protocol/STBlob.h index 71d1a04478..b9dc78ffe4 100644 --- a/include/xrpl/protocol/STBlob.h +++ b/include/xrpl/protocol/STBlob.h @@ -95,7 +95,7 @@ STBlob::size() const inline std::uint8_t const* STBlob::data() const { - return reinterpret_cast(value_.data()); + return value_.data(); } inline STBlob& diff --git a/include/xrpl/protocol/STCurrency.h b/include/xrpl/protocol/STCurrency.h index dc5b079c6d..5fd4c08fbb 100644 --- a/include/xrpl/protocol/STCurrency.h +++ b/include/xrpl/protocol/STCurrency.h @@ -11,7 +11,7 @@ namespace xrpl { class STCurrency final : public STBase { private: - Currency currency_{}; + Currency currency_; public: using value_type = Currency; diff --git a/include/xrpl/protocol/STLedgerEntry.h b/include/xrpl/protocol/STLedgerEntry.h index dde7d49ebd..a28868cd7a 100644 --- a/include/xrpl/protocol/STLedgerEntry.h +++ b/include/xrpl/protocol/STLedgerEntry.h @@ -8,7 +8,7 @@ namespace xrpl { class Rules; namespace test { class Invariants_test; -} +} // namespace test class STLedgerEntry final : public STObject, public CountedObject { @@ -86,7 +86,9 @@ inline STLedgerEntry::STLedgerEntry(LedgerEntryType type, uint256 const& key) { } -inline STLedgerEntry::STLedgerEntry(SerialIter&& sit, uint256 const& index) +inline STLedgerEntry::STLedgerEntry( + SerialIter&& sit, // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) + uint256 const& index) : STLedgerEntry(sit, index) { } diff --git a/include/xrpl/protocol/STObject.h b/include/xrpl/protocol/STObject.h index ecfae0086b..7e996828af 100644 --- a/include/xrpl/protocol/STObject.h +++ b/include/xrpl/protocol/STObject.h @@ -349,6 +349,8 @@ public: void setFieldH128(SField const& field, uint128 const&); void + setFieldH192(SField const& field, uint192 const&); + void setFieldH256(SField const& field, uint256 const&); void setFieldI32(SField const& field, std::int32_t); @@ -671,7 +673,7 @@ public: OptionalProxy& operator=(std::nullopt_t const&); OptionalProxy& - operator=(optional_type&& v); + operator=(optional_type&& v); // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) OptionalProxy& operator=(optional_type const& v); @@ -702,7 +704,7 @@ class STObject::FieldErr : public std::runtime_error template STObject::Proxy::Proxy(STObject* st, TypedField const* f) : st_(st), f_(f) { - if (st_->mType) + if (st_->mType != nullptr) { // STObject has associated template if (!st_->peekAtPField(*f_)) @@ -766,11 +768,15 @@ STObject::Proxy::assign(U&& u) st_->makeFieldAbsent(*f_); return; } - T* t; + T* t = nullptr; if (style_ == soeINVALID) + { t = dynamic_cast(st_->getPField(*f_, true)); + } else + { t = dynamic_cast(st_->makeFieldPresent(*f_)); + } XRPL_ASSERT(t, "xrpl::STObject::Proxy::assign : type cast succeeded"); *t = std::forward(u); } @@ -851,12 +857,18 @@ STObject::OptionalProxy::operator=(std::nullopt_t const&) -> OptionalProxy& template auto -STObject::OptionalProxy::operator=(optional_type&& v) -> OptionalProxy& +STObject::OptionalProxy::operator=( + optional_type&& v) // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) + -> OptionalProxy& { if (v) + { this->assign(std::move(*v)); + } else + { disengage(); + } return *this; } @@ -865,9 +877,13 @@ auto STObject::OptionalProxy::operator=(optional_type const& v) -> OptionalProxy& { if (v) + { this->assign(*v); + } else + { disengage(); + } return *this; } @@ -899,9 +915,13 @@ STObject::OptionalProxy::disengage() if (this->style_ == soeREQUIRED || this->style_ == soeDEFAULT) Throw("Template field error '" + this->f_->getName() + "'"); if (this->style_ == soeINVALID) + { this->st_->delField(*this->f_); + } else + { this->st_->makeFieldAbsent(*this->f_); + } } template @@ -930,6 +950,7 @@ STObject::Transform::operator()(detail::STVar const& e) const //------------------------------------------------------------------------------ +// NOLINTNEXTLINE(cppcoreguidelines-rvalue-reference-param-not-moved) inline STObject::STObject(SerialIter&& sit, SField const& name) : STObject(sit, name) { } @@ -1053,9 +1074,11 @@ STObject::at(TypedField const& f) const { auto const b = peekAtPField(f); if (!b) + { // This is a free object (no constraints) // with no template Throw("Missing field: " + f.getName()); + } if (auto const u = dynamic_cast(b)) return u->value(); @@ -1133,9 +1156,13 @@ STObject::setFieldH160(SField const& field, base_uint<160, Tag> const& v) using Bits = STBitString<160>; if (auto cf = dynamic_cast(rf)) + { cf->setValue(v); + } else + { Throw("Wrong field type"); + } } inline bool @@ -1153,7 +1180,7 @@ STObject::getFieldByValue(SField const& field) const if (!rf) throwFieldNotFound(field); - SerializedTypeID id = rf->getSType(); + SerializedTypeID const id = rf->getSType(); if (id == STI_NOTPRESENT) return V(); // optional field not present @@ -1180,10 +1207,13 @@ STObject::getFieldByConstRef(SField const& field, V const& empty) const if (!rf) throwFieldNotFound(field); - SerializedTypeID id = rf->getSType(); + SerializedTypeID const id = rf->getSType(); if (id == STI_NOTPRESENT) + { + // NOLINTNEXTLINE(bugprone-return-const-ref-from-parameter) return empty; // optional field not present + } T const* cf = dynamic_cast(rf); diff --git a/include/xrpl/protocol/STPathSet.h b/include/xrpl/protocol/STPathSet.h index 2ccbc3d657..1d6fce5c18 100644 --- a/include/xrpl/protocol/STPathSet.h +++ b/include/xrpl/protocol/STPathSet.h @@ -3,6 +3,8 @@ #include #include #include +#include +#include #include #include #include @@ -16,7 +18,7 @@ class STPathElement final : public CountedObject { unsigned int mType; AccountID mAccountID; - Currency mCurrencyID; + PathAsset mAssetID; AccountID mIssuerID; bool is_offer_; @@ -28,8 +30,10 @@ public: typeAccount = 0x01, // Rippling through an account (vs taking an offer). typeCurrency = 0x10, // Currency follows. typeIssuer = 0x20, // Issuer follows. + typeMPT = 0x40, // MPT follows. typeBoundary = 0xFF, // Boundary between alternate paths. - typeAll = typeAccount | typeCurrency | typeIssuer, + typeAsset = typeCurrency | typeMPT, + typeAll = typeAccount | typeCurrency | typeIssuer | typeMPT, // Combination of all types. }; @@ -40,19 +44,19 @@ public: STPathElement( std::optional const& account, - std::optional const& currency, + std::optional const& asset, std::optional const& issuer); STPathElement( AccountID const& account, - Currency const& currency, + PathAsset const& asset, AccountID const& issuer, - bool forceCurrency = false); + bool forceAsset = false); STPathElement( unsigned int uType, AccountID const& account, - Currency const& currency, + PathAsset const& asset, AccountID const& issuer); auto @@ -70,6 +74,12 @@ public: bool hasCurrency() const; + bool + hasMPT() const; + + bool + hasAsset() const; + bool isNone() const; @@ -78,12 +88,21 @@ public: AccountID const& getAccountID() const; + PathAsset const& + getPathAsset() const; + Currency const& getCurrency() const; + MPTID const& + getMPTID() const; + AccountID const& getIssuerID() const; + bool + isType(Type const& pe) const; + bool operator==(STPathElement const& t) const; @@ -118,7 +137,7 @@ public: emplace_back(Args&&... args); bool - hasSeen(AccountID const& account, Currency const& currency, AccountID const& issuer) const; + hasSeen(AccountID const& account, PathAsset const& asset, AccountID const& issuer) const; Json::Value getJson(JsonOptions) const; @@ -221,7 +240,7 @@ inline STPathElement::STPathElement() : mType(typeNone), is_offer_(true) inline STPathElement::STPathElement( std::optional const& account, - std::optional const& currency, + std::optional const& asset, std::optional const& issuer) : mType(typeNone) { @@ -238,10 +257,10 @@ inline STPathElement::STPathElement( mAccountID != noAccount(), "xrpl::STPathElement::STPathElement : account is set"); } - if (currency) + if (asset) { - mCurrencyID = *currency; - mType |= typeCurrency; + mAssetID = *asset; + mType |= mAssetID.holds() ? typeCurrency : typeMPT; } if (issuer) @@ -256,20 +275,20 @@ inline STPathElement::STPathElement( inline STPathElement::STPathElement( AccountID const& account, - Currency const& currency, + PathAsset const& asset, AccountID const& issuer, - bool forceCurrency) + bool forceAsset) : mType(typeNone) , mAccountID(account) - , mCurrencyID(currency) + , mAssetID(asset) , mIssuerID(issuer) , is_offer_(isXRP(mAccountID)) { if (!is_offer_) mType |= typeAccount; - if (forceCurrency || !isXRP(currency)) - mType |= typeCurrency; + if (forceAsset || !isXRP(mAssetID)) + mType |= asset.holds() ? typeCurrency : typeMPT; if (!isXRP(issuer)) mType |= typeIssuer; @@ -280,14 +299,19 @@ inline STPathElement::STPathElement( inline STPathElement::STPathElement( unsigned int uType, AccountID const& account, - Currency const& currency, + PathAsset const& asset, AccountID const& issuer) : mType(uType) , mAccountID(account) - , mCurrencyID(currency) + , mAssetID(asset) , mIssuerID(issuer) , is_offer_(isXRP(mAccountID)) { + // uType could be assetType; i.e. either Currency or MPTID. + // Get the actual type. + mAssetID.visit( + [&](Currency const&) { mType = mType & (~Type::typeMPT); }, + [&](MPTID const&) { mType = mType & (~Type::typeCurrency); }); hash_value_ = get_hash(*this); } @@ -309,16 +333,34 @@ STPathElement::isAccount() const return !isOffer(); } +inline bool +STPathElement::isType(Type const& pe) const +{ + return (mType & pe) != 0u; +} + inline bool STPathElement::hasIssuer() const { - return getNodeType() & STPathElement::typeIssuer; + return isType(STPathElement::typeIssuer); } inline bool STPathElement::hasCurrency() const { - return getNodeType() & STPathElement::typeCurrency; + return isType(STPathElement::typeCurrency); +} + +inline bool +STPathElement::hasMPT() const +{ + return isType(STPathElement::typeMPT); +} + +inline bool +STPathElement::hasAsset() const +{ + return isType(STPathElement::typeAsset); } inline bool @@ -335,10 +377,22 @@ STPathElement::getAccountID() const return mAccountID; } +inline PathAsset const& +STPathElement::getPathAsset() const +{ + return mAssetID; +} + inline Currency const& STPathElement::getCurrency() const { - return mCurrencyID; + return mAssetID.get(); +} + +inline MPTID const& +STPathElement::getMPTID() const +{ + return mAssetID.get(); } inline AccountID const& @@ -351,7 +405,7 @@ inline bool STPathElement::operator==(STPathElement const& t) const { return (mType & typeAccount) == (t.mType & typeAccount) && hash_value_ == t.hash_value_ && - mAccountID == t.mAccountID && mCurrencyID == t.mCurrencyID && mIssuerID == t.mIssuerID; + mAccountID == t.mAccountID && mAssetID == t.mAssetID && mIssuerID == t.mIssuerID; } inline bool diff --git a/include/xrpl/protocol/STTx.h b/include/xrpl/protocol/STTx.h index f200c19eac..b27d9e0637 100644 --- a/include/xrpl/protocol/STTx.h +++ b/include/xrpl/protocol/STTx.h @@ -179,7 +179,8 @@ sterilize(STTx const& stx); bool isPseudoTx(STObject const& tx); -inline STTx::STTx(SerialIter&& sit) : STTx(sit) +inline STTx::STTx(SerialIter&& sit) // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) + : STTx(sit) { } diff --git a/include/xrpl/protocol/STValidation.h b/include/xrpl/protocol/STValidation.h index 861e2152f8..c645336b59 100644 --- a/include/xrpl/protocol/STValidation.h +++ b/include/xrpl/protocol/STValidation.h @@ -36,7 +36,7 @@ class STValidation final : public STObject, public CountedObject // that use manifests this will be derived from the master public key. NodeID const nodeID_; - NetClock::time_point seenTime_ = {}; + NetClock::time_point seenTime_; public: /** Construct a STValidation from a peer from serialized data. diff --git a/include/xrpl/protocol/STVector256.h b/include/xrpl/protocol/STVector256.h index 815224def2..69b06ec1da 100644 --- a/include/xrpl/protocol/STVector256.h +++ b/include/xrpl/protocol/STVector256.h @@ -148,7 +148,7 @@ STVector256::size() const inline void STVector256::resize(std::size_t n) { - return mValue.resize(n); + mValue.resize(n); } inline bool @@ -220,7 +220,7 @@ STVector256::erase(std::vector::iterator position) inline void STVector256::clear() noexcept { - return mValue.clear(); + mValue.clear(); } } // namespace xrpl diff --git a/include/xrpl/protocol/SecretKey.h b/include/xrpl/protocol/SecretKey.h index dd5566915f..c17b3984e9 100644 --- a/include/xrpl/protocol/SecretKey.h +++ b/include/xrpl/protocol/SecretKey.h @@ -85,10 +85,10 @@ public: } }; -inline bool +bool operator==(SecretKey const& lhs, SecretKey const& rhs) = delete; -inline bool +bool operator!=(SecretKey const& lhs, SecretKey const& rhs) = delete; //------------------------------------------------------------------------------ @@ -118,7 +118,7 @@ derivePublicKey(KeyType type, SecretKey const& sk); /** Generate a key pair deterministically. - This algorithm is specific to Ripple: + This algorithm is specific to the XRPL: For secp256k1 key pairs, the seed is converted to a Generator and used to compute the key pair diff --git a/include/xrpl/protocol/Seed.h b/include/xrpl/protocol/Seed.h index 5b490be12e..04e8481c8f 100644 --- a/include/xrpl/protocol/Seed.h +++ b/include/xrpl/protocol/Seed.h @@ -80,7 +80,7 @@ randomSeed(); /** Generate a seed deterministically. - The algorithm is specific to Ripple: + The algorithm is specific to the XRPL: The seed is calculated as the first 128 bits of the SHA512-Half of the string text excluding diff --git a/include/xrpl/protocol/Serializer.h b/include/xrpl/protocol/Serializer.h index 75f5dbdf96..6ce60022e3 100644 --- a/include/xrpl/protocol/Serializer.h +++ b/include/xrpl/protocol/Serializer.h @@ -33,7 +33,7 @@ public: { mData.resize(size); - if (size) + if (size != 0u) { XRPL_ASSERT(data, "xrpl::Serializer::Serializer(void const*) : non-null input"); std::memcpy(mData.data(), data, size); @@ -69,7 +69,7 @@ public: int add32(T i) { - int ret = mData.size(); + int const ret = mData.size(); mData.push_back(static_cast((i >> 24) & 0xff)); mData.push_back(static_cast((i >> 16) & 0xff)); mData.push_back(static_cast((i >> 8) & 0xff)); @@ -85,7 +85,7 @@ public: int add64(T i) { - int ret = mData.size(); + int const ret = mData.size(); mData.push_back(static_cast((i >> 56) & 0xff)); mData.push_back(static_cast((i >> 48) & 0xff)); mData.push_back(static_cast((i >> 40) & 0xff)); @@ -299,7 +299,7 @@ template int Serializer::addVL(Iter begin, Iter end, int len) { - int ret = addEncoded(len); + int const ret = addEncoded(len); for (; begin != end; ++begin) { addRaw(begin->data(), begin->size()); diff --git a/include/xrpl/protocol/TER.h b/include/xrpl/protocol/TER.h index 64201881b0..b0dafecf1c 100644 --- a/include/xrpl/protocol/TER.h +++ b/include/xrpl/protocol/TER.h @@ -121,6 +121,7 @@ enum TEMcodes : TERUnderlyingType { temARRAY_TOO_LARGE, temBAD_TRANSFER_FEE, temINVALID_INNER_BATCH, + temBAD_MPT, }; //------------------------------------------------------------------------------ @@ -208,6 +209,7 @@ enum TERcodes : TERUnderlyingType { terADDRESS_COLLISION, // Failed to allocate AccountID when trying to // create a pseudo-account terNO_DELEGATE_PERMISSION, // Delegate does not have permission + terLOCKED, // MPT is locked }; //------------------------------------------------------------------------------ @@ -342,10 +344,6 @@ enum TECcodes : TERUnderlyingType { tecLIMIT_EXCEEDED = 195, tecPSEUDO_ACCOUNT = 196, tecPRECISION_LOSS = 197, - // DEPRECATED: This error code tecNO_DELEGATE_PERMISSION is reserved for - // backward compatibility with historical data on non-prod networks, can be - // reclaimed after those networks reset. - tecNO_DELEGATE_PERMISSION = 198, }; //------------------------------------------------------------------------------ diff --git a/include/xrpl/protocol/TxFlags.h b/include/xrpl/protocol/TxFlags.h index 7c2085109f..7bbbd12707 100644 --- a/include/xrpl/protocol/TxFlags.h +++ b/include/xrpl/protocol/TxFlags.h @@ -235,7 +235,7 @@ XMACRO(NULL_NAME, TO_VALUE, NULL_OUTPUT, NULL_MASK_ADJ) // The mask adjustment (maskAdj) allows adding flags back to the mask, making them invalid. // For example, Batch uses MASK_ADJ(tfInnerBatchTxn) to reject tfInnerBatchTxn on outer Batch. #define TO_MASK(name, values, maskAdj) \ - inline constexpr FlagValue tf##name##Mask = ~(tfUniversal values) | maskAdj; + inline constexpr FlagValue tf##name##Mask = ~(tfUniversal values) | (maskAdj); #define VALUE_TO_MASK(name, value) | name #define MASK_ADJ_TO_MASK(value) value XMACRO(TO_MASK, VALUE_TO_MASK, VALUE_TO_MASK, MASK_ADJ_TO_MASK) diff --git a/include/xrpl/protocol/TxSearched.h b/include/xrpl/protocol/TxSearched.h index 71bd75005b..c3359ee5ac 100644 --- a/include/xrpl/protocol/TxSearched.h +++ b/include/xrpl/protocol/TxSearched.h @@ -4,4 +4,4 @@ namespace xrpl { enum class TxSearched { All, Some, Unknown }; -} +} // namespace xrpl diff --git a/include/xrpl/protocol/Units.h b/include/xrpl/protocol/Units.h index b377c80e26..b606ca2cdf 100644 --- a/include/xrpl/protocol/Units.h +++ b/include/xrpl/protocol/Units.h @@ -21,7 +21,7 @@ namespace unit { struct dropTag; /** "fee levels" are used by the transaction queue to compare the relative cost of transactions that require different levels of effort to process. - See also: src/ripple/app/misc/FeeEscalation.md#fee-level */ + See also: src/xrpld/app/misc/FeeEscalation.md#fee-level */ struct feelevelTag; /** unitless values are plain scalars wrapped in a ValueUnit. They are used for calculations in this header. */ @@ -267,7 +267,9 @@ public: constexpr int signum() const noexcept { - return (value_ < 0) ? -1 : (value_ ? 1 : 0); + if (value_ < 0) + return -1; + return value_ ? 1 : 0; } /** Returns the number of drops */ diff --git a/include/xrpl/protocol/XRPAmount.h b/include/xrpl/protocol/XRPAmount.h index 6e4133361b..0cb5121ef1 100644 --- a/include/xrpl/protocol/XRPAmount.h +++ b/include/xrpl/protocol/XRPAmount.h @@ -149,7 +149,9 @@ public: constexpr int signum() const noexcept { - return (drops_ < 0) ? -1 : (drops_ ? 1 : 0); + if (drops_ < 0) + return -1; + return (drops_ != 0) ? 1 : 0; } /** Returns the number of drops */ @@ -262,7 +264,7 @@ mulRatio(XRPAmount const& amt, std::uint32_t num, std::uint32_t den, bool roundU { using namespace boost::multiprecision; - if (!den) + if (den == 0u) Throw("division by zero"); int128_t const amt128(amt.drops()); diff --git a/include/xrpl/protocol/detail/STVar.h b/include/xrpl/protocol/detail/STVar.h index bab2c2e024..6984c29525 100644 --- a/include/xrpl/protocol/detail/STVar.h +++ b/include/xrpl/protocol/detail/STVar.h @@ -25,16 +25,10 @@ extern nonPresentObject_t nonPresentObject; // Concept to constrain STVar constructors, which // instantiate ST* types from SerializedTypeID -// clang-format off template concept ValidConstructSTArgs = - (std::is_same_v< - std::tuple...>, - std::tuple> || - std::is_same_v< - std::tuple...>, - std::tuple>); -// clang-format on + (std::is_same_v...>, std::tuple> || + std::is_same_v...>, std::tuple>); // "variant" that can hold any type of serialized object // and includes a small-object allocation optimization. @@ -56,7 +50,7 @@ public: STVar& operator=(STVar&& rhs); - STVar(STBase&& t) + STVar(STBase&& t) // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) { p_ = t.move(max_size, &d_); } @@ -118,9 +112,13 @@ private: construct(Args&&... args) { if constexpr (sizeof(T) > max_size) + { p_ = new T(std::forward(args)...); + } else + { p_ = new (&d_) T(std::forward(args)...); + } } /** Construct requested Serializable Type according to id. diff --git a/include/xrpl/protocol/detail/b58_utils.h b/include/xrpl/protocol/detail/b58_utils.h index adb889ee53..4332d29e5f 100644 --- a/include/xrpl/protocol/detail/b58_utils.h +++ b/include/xrpl/protocol/detail/b58_utils.h @@ -33,7 +33,7 @@ carrying_mul(std::uint64_t a, std::uint64_t b, std::uint64_t carry) { unsigned __int128 const x = a; unsigned __int128 const y = b; - unsigned __int128 const c = x * y + carry; + unsigned __int128 const c = (x * y) + carry; return {c & 0xffff'ffff'ffff'ffff, c >> 64}; } @@ -59,18 +59,18 @@ inplace_bigint_add(std::span a, std::uint64_t b) return TokenCodecErrc::inputTooSmall; } - std::uint64_t carry; + std::uint64_t carry = 0; std::tie(a[0], carry) = carrying_add(a[0], b); for (auto& v : a.subspan(1)) { - if (!carry) + if (carry == 0u) { return TokenCodecErrc::success; } std::tie(v, carry) = carrying_add(v, 1); } - if (carry) + if (carry != 0u) { return TokenCodecErrc::overflowAdd; } @@ -105,7 +105,7 @@ inplace_bigint_mul(std::span a, std::uint64_t b) [[nodiscard]] inline std::uint64_t inplace_bigint_div_rem(std::span numerator, std::uint64_t divisor) { - if (numerator.size() == 0) + if (numerator.empty()) { // should never happen, but if it does then it seems natural to define // the a null set of numbers to be zero, so the remainder is also zero. @@ -162,7 +162,7 @@ b58_10_to_b58_be(std::uint64_t input) int i = 0; while (input > 0) { - std::uint64_t rem; + std::uint64_t rem = 0; std::tie(input, rem) = div_rem(input, 58); result[resultSize - 1 - i] = rem; i += 1; diff --git a/include/xrpl/protocol/detail/features.macro b/include/xrpl/protocol/detail/features.macro index d8d9dc0117..494b3fa6cd 100644 --- a/include/xrpl/protocol/detail/features.macro +++ b/include/xrpl/protocol/detail/features.macro @@ -11,66 +11,66 @@ #error "undefined macro: XRPL_RETIRE_FIX" #endif -// clang-format off // Add new amendments to the top of this list. // Keep it sorted in reverse chronological order. -XRPL_FIX (Security3_1_3, Supported::no, VoteBehavior::DefaultNo) -XRPL_FIX (PermissionedDomainInvariant, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (ExpiredNFTokenOfferRemoval, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (BatchInnerSigs, Supported::no, VoteBehavior::DefaultNo) -XRPL_FEATURE(LendingProtocol, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(PermissionDelegationV1_1, Supported::no, VoteBehavior::DefaultNo) -XRPL_FIX (DirectoryLimit, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (IncludeKeyletFields, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(DynamicMPT, Supported::no, VoteBehavior::DefaultNo) -XRPL_FIX (TokenEscrowV1, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (PriceOracleOrder, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (MPTDeliveredAmount, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (AMMClawbackRounding, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(TokenEscrow, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (EnforceNFTokenTrustlineV2, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (AMMv1_3, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(PermissionedDEX, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(Batch, Supported::no, VoteBehavior::DefaultNo) -XRPL_FEATURE(SingleAssetVault, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (PayChanCancelAfter, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(MPTokensV2, Supported::no, VoteBehavior::DefaultNo) +XRPL_FIX (Security3_1_3, Supported::no, VoteBehavior::DefaultNo) +XRPL_FIX (PermissionedDomainInvariant, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (ExpiredNFTokenOfferRemoval, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (BatchInnerSigs, Supported::no, VoteBehavior::DefaultNo) +XRPL_FEATURE(LendingProtocol, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(PermissionDelegationV1_1, Supported::no, VoteBehavior::DefaultNo) +XRPL_FIX (DirectoryLimit, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (IncludeKeyletFields, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(DynamicMPT, Supported::no, VoteBehavior::DefaultNo) +XRPL_FIX (TokenEscrowV1, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (PriceOracleOrder, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (MPTDeliveredAmount, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (AMMClawbackRounding, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(TokenEscrow, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (EnforceNFTokenTrustlineV2, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (AMMv1_3, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(PermissionedDEX, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(Batch, Supported::no, VoteBehavior::DefaultNo) +XRPL_FEATURE(SingleAssetVault, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (PayChanCancelAfter, Supported::yes, VoteBehavior::DefaultNo) // Check flags in Credential transactions -XRPL_FIX (InvalidTxFlags, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (FrozenLPTokenTransfer, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(DeepFreeze, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(PermissionedDomains, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(DynamicNFT, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(Credentials, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(AMMClawback, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (AMMv1_2, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(MPTokensV1, Supported::yes, VoteBehavior::DefaultNo) -// InvariantsV1_1 will be changes to Supported::yes when all the -// invariants expected to be included under it are complete. -XRPL_FEATURE(InvariantsV1_1, Supported::no, VoteBehavior::DefaultNo) -XRPL_FIX (NFTokenPageLinks, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (InnerObjTemplate2, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (EnforceNFTokenTrustline, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (ReducedOffersV2, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(NFTokenMintOffer, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (AMMv1_1, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (PreviousTxnID, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (XChainRewardRounding, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (EmptyDID, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(PriceOracle, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (AMMOverflowOffer, Supported::yes, VoteBehavior::DefaultYes) -XRPL_FIX (InnerObjTemplate, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (NFTokenReserve, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (FillOrKill, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(DID, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (DisallowIncomingV1, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(XChainBridge, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(AMM, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(Clawback, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (UniversalNumber, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FEATURE(XRPFees, Supported::yes, VoteBehavior::DefaultNo) -XRPL_FIX (RemoveNFTokenAutoTrustLine, Supported::yes, VoteBehavior::DefaultYes) +XRPL_FIX (InvalidTxFlags, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (FrozenLPTokenTransfer, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(DeepFreeze, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(PermissionedDomains, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(DynamicNFT, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(Credentials, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(AMMClawback, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (AMMv1_2, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(MPTokensV1, Supported::yes, VoteBehavior::DefaultNo) +// InvariantsV1_1 will be changed to Supported::yes when all the invariants expected to be included +// under it are complete. +XRPL_FEATURE(InvariantsV1_1, Supported::no, VoteBehavior::DefaultNo) +XRPL_FIX (NFTokenPageLinks, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (InnerObjTemplate2, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (EnforceNFTokenTrustline, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (ReducedOffersV2, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(NFTokenMintOffer, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (AMMv1_1, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (PreviousTxnID, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (XChainRewardRounding, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (EmptyDID, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(PriceOracle, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (AMMOverflowOffer, Supported::yes, VoteBehavior::DefaultYes) +XRPL_FIX (InnerObjTemplate, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (NFTokenReserve, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (FillOrKill, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(DID, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (DisallowIncomingV1, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(XChainBridge, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(AMM, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(Clawback, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (UniversalNumber, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FEATURE(XRPFees, Supported::yes, VoteBehavior::DefaultNo) +XRPL_FIX (RemoveNFTokenAutoTrustLine, Supported::yes, VoteBehavior::DefaultYes) // The following amendments are obsolete, but must remain supported // because they could potentially get enabled. @@ -144,5 +144,3 @@ XRPL_RETIRE_FEATURE(SortedDirectories) XRPL_RETIRE_FEATURE(TicketBatch) XRPL_RETIRE_FEATURE(TickSize) XRPL_RETIRE_FEATURE(TrustSetAuth) - -// clang-format on diff --git a/include/xrpl/protocol/detail/ledger_entries.macro b/include/xrpl/protocol/detail/ledger_entries.macro index 216f404bec..e4182f0cba 100644 --- a/include/xrpl/protocol/detail/ledger_entries.macro +++ b/include/xrpl/protocol/detail/ledger_entries.macro @@ -161,8 +161,10 @@ LEDGER_ENTRY(ltDIR_NODE, 0x0064, DirectoryNode, directory, ({ {sfOwner, soeOPTIONAL}, // for owner directories {sfTakerPaysCurrency, soeOPTIONAL}, // order book directories {sfTakerPaysIssuer, soeOPTIONAL}, // order book directories + {sfTakerPaysMPT, soeOPTIONAL}, // order book directories {sfTakerGetsCurrency, soeOPTIONAL}, // order book directories {sfTakerGetsIssuer, soeOPTIONAL}, // order book directories + {sfTakerGetsMPT, soeOPTIONAL}, // order book directories {sfExchangeRate, soeOPTIONAL}, // order book directories {sfIndexes, soeREQUIRED}, {sfRootIndex, soeREQUIRED}, @@ -578,7 +580,7 @@ LEDGER_ENTRY(ltLOAN, 0x0089, Loan, loan, ({ // The unrounded true total value of the loan. // // - TrueTotalPrincipalOutstanding can be computed using the algorithm - // in the ripple::detail::loanPrincipalFromPeriodicPayment function. + // in the xrpl::detail::loanPrincipalFromPeriodicPayment function. // // - TrueTotalInterestOutstanding = TrueTotalLoanValue - // TrueTotalPrincipalOutstanding diff --git a/include/xrpl/protocol/detail/sfields.macro b/include/xrpl/protocol/detail/sfields.macro index 712cf568af..4f21207831 100644 --- a/include/xrpl/protocol/detail/sfields.macro +++ b/include/xrpl/protocol/detail/sfields.macro @@ -5,7 +5,6 @@ #error "undefined macro: TYPED_SFIELD" #endif -// clang-format off // untyped UNTYPED_SFIELD(sfLedgerEntry, LEDGERENTRY, 257) @@ -160,6 +159,8 @@ TYPED_SFIELD(sfTakerGetsIssuer, UINT160, 4) // 192-bit (common) TYPED_SFIELD(sfMPTokenIssuanceID, UINT192, 1) TYPED_SFIELD(sfShareMPTID, UINT192, 2) +TYPED_SFIELD(sfTakerPaysMPT, UINT192, 3) +TYPED_SFIELD(sfTakerGetsMPT, UINT192, 4) // 256-bit (common) TYPED_SFIELD(sfLedgerHash, UINT256, 1) @@ -421,5 +422,3 @@ UNTYPED_SFIELD(sfAcceptedCredentials, ARRAY, 28) UNTYPED_SFIELD(sfPermissions, ARRAY, 29) UNTYPED_SFIELD(sfRawTransactions, ARRAY, 30) UNTYPED_SFIELD(sfBatchSigners, ARRAY, 31, SField::sMD_Default, SField::notSigning) - -// clang-format on diff --git a/include/xrpl/protocol/detail/token_errors.h b/include/xrpl/protocol/detail/token_errors.h index 686851f508..54b283c41a 100644 --- a/include/xrpl/protocol/detail/token_errors.h +++ b/include/xrpl/protocol/detail/token_errors.h @@ -15,7 +15,7 @@ enum class TokenCodecErrc { overflowAdd, unknown, }; -} +} // namespace xrpl namespace std { template <> @@ -69,7 +69,7 @@ public: inline xrpl::detail::TokenCodecErrcCategory const& TokenCodecErrcCategory() { - static xrpl::detail::TokenCodecErrcCategory c; + static xrpl::detail::TokenCodecErrcCategory const c; return c; } diff --git a/include/xrpl/protocol/detail/transactions.macro b/include/xrpl/protocol/detail/transactions.macro index a2f3c1be43..e52d28ce2a 100644 --- a/include/xrpl/protocol/detail/transactions.macro +++ b/include/xrpl/protocol/detail/transactions.macro @@ -27,7 +27,7 @@ TRANSACTION(ttPAYMENT, 0, Payment, Delegation::delegable, uint256{}, - createAcct, + createAcct | mayCreateMPT, ({ {sfDestination, soeREQUIRED}, {sfAmount, soeREQUIRED, soeMPTSupported}, @@ -129,10 +129,10 @@ TRANSACTION(ttREGULAR_KEY_SET, 5, SetRegularKey, TRANSACTION(ttOFFER_CREATE, 7, OfferCreate, Delegation::delegable, uint256{}, - noPriv, + mayCreateMPT, ({ - {sfTakerPays, soeREQUIRED}, - {sfTakerGets, soeREQUIRED}, + {sfTakerPays, soeREQUIRED, soeMPTSupported}, + {sfTakerGets, soeREQUIRED, soeMPTSupported}, {sfExpiration, soeOPTIONAL}, {sfOfferSequence, soeOPTIONAL}, {sfDomainID, soeOPTIONAL}, @@ -239,7 +239,7 @@ TRANSACTION(ttCHECK_CREATE, 16, CheckCreate, noPriv, ({ {sfDestination, soeREQUIRED}, - {sfSendMax, soeREQUIRED}, + {sfSendMax, soeREQUIRED, soeMPTSupported}, {sfExpiration, soeOPTIONAL}, {sfDestinationTag, soeOPTIONAL}, {sfInvoiceID, soeOPTIONAL}, @@ -252,11 +252,11 @@ TRANSACTION(ttCHECK_CREATE, 16, CheckCreate, TRANSACTION(ttCHECK_CASH, 17, CheckCash, Delegation::delegable, uint256{}, - noPriv, + mayCreateMPT, ({ {sfCheckID, soeREQUIRED}, - {sfAmount, soeOPTIONAL}, - {sfDeliverMin, soeOPTIONAL}, + {sfAmount, soeOPTIONAL, soeMPTSupported}, + {sfDeliverMin, soeOPTIONAL, soeMPTSupported}, })) /** This transaction type cancels an existing check. */ @@ -409,12 +409,12 @@ TRANSACTION(ttCLAWBACK, 30, Clawback, TRANSACTION(ttAMM_CLAWBACK, 31, AMMClawback, Delegation::delegable, featureAMMClawback, - mayDeleteAcct | overrideFreeze, + mayDeleteAcct | overrideFreeze | mayAuthorizeMPT, ({ {sfHolder, soeREQUIRED}, - {sfAsset, soeREQUIRED}, - {sfAsset2, soeREQUIRED}, - {sfAmount, soeOPTIONAL}, + {sfAsset, soeREQUIRED, soeMPTSupported}, + {sfAsset2, soeREQUIRED, soeMPTSupported}, + {sfAmount, soeOPTIONAL, soeMPTSupported}, })) /** This transaction type creates an AMM instance */ @@ -424,10 +424,10 @@ TRANSACTION(ttAMM_CLAWBACK, 31, AMMClawback, TRANSACTION(ttAMM_CREATE, 35, AMMCreate, Delegation::delegable, featureAMM, - createPseudoAcct, + createPseudoAcct | mayCreateMPT, ({ - {sfAmount, soeREQUIRED}, - {sfAmount2, soeREQUIRED}, + {sfAmount, soeREQUIRED, soeMPTSupported}, + {sfAmount2, soeREQUIRED, soeMPTSupported}, {sfTradingFee, soeREQUIRED}, })) @@ -440,10 +440,10 @@ TRANSACTION(ttAMM_DEPOSIT, 36, AMMDeposit, featureAMM, noPriv, ({ - {sfAsset, soeREQUIRED}, - {sfAsset2, soeREQUIRED}, - {sfAmount, soeOPTIONAL}, - {sfAmount2, soeOPTIONAL}, + {sfAsset, soeREQUIRED, soeMPTSupported}, + {sfAsset2, soeREQUIRED, soeMPTSupported}, + {sfAmount, soeOPTIONAL, soeMPTSupported}, + {sfAmount2, soeOPTIONAL, soeMPTSupported}, {sfEPrice, soeOPTIONAL}, {sfLPTokenOut, soeOPTIONAL}, {sfTradingFee, soeOPTIONAL}, @@ -456,12 +456,12 @@ TRANSACTION(ttAMM_DEPOSIT, 36, AMMDeposit, TRANSACTION(ttAMM_WITHDRAW, 37, AMMWithdraw, Delegation::delegable, featureAMM, - mayDeleteAcct, + mayDeleteAcct | mayAuthorizeMPT, ({ - {sfAsset, soeREQUIRED}, - {sfAsset2, soeREQUIRED}, - {sfAmount, soeOPTIONAL}, - {sfAmount2, soeOPTIONAL}, + {sfAsset, soeREQUIRED, soeMPTSupported}, + {sfAsset2, soeREQUIRED, soeMPTSupported}, + {sfAmount, soeOPTIONAL, soeMPTSupported}, + {sfAmount2, soeOPTIONAL, soeMPTSupported}, {sfEPrice, soeOPTIONAL}, {sfLPTokenIn, soeOPTIONAL}, })) @@ -475,8 +475,8 @@ TRANSACTION(ttAMM_VOTE, 38, AMMVote, featureAMM, noPriv, ({ - {sfAsset, soeREQUIRED}, - {sfAsset2, soeREQUIRED}, + {sfAsset, soeREQUIRED, soeMPTSupported}, + {sfAsset2, soeREQUIRED, soeMPTSupported}, {sfTradingFee, soeREQUIRED}, })) @@ -489,8 +489,8 @@ TRANSACTION(ttAMM_BID, 39, AMMBid, featureAMM, noPriv, ({ - {sfAsset, soeREQUIRED}, - {sfAsset2, soeREQUIRED}, + {sfAsset, soeREQUIRED, soeMPTSupported}, + {sfAsset2, soeREQUIRED, soeMPTSupported}, {sfBidMin, soeOPTIONAL}, {sfBidMax, soeOPTIONAL}, {sfAuthAccounts, soeOPTIONAL}, @@ -503,10 +503,10 @@ TRANSACTION(ttAMM_BID, 39, AMMBid, TRANSACTION(ttAMM_DELETE, 40, AMMDelete, Delegation::delegable, featureAMM, - mustDeleteAcct, + mustDeleteAcct | mayDeleteMPT, ({ - {sfAsset, soeREQUIRED}, - {sfAsset2, soeREQUIRED}, + {sfAsset, soeREQUIRED, soeMPTSupported}, + {sfAsset2, soeREQUIRED, soeMPTSupported}, })) /** This transactions creates a crosschain sequence number */ diff --git a/include/xrpl/protocol/digest.h b/include/xrpl/protocol/digest.h index 9e6606f51f..bbb38fa543 100644 --- a/include/xrpl/protocol/digest.h +++ b/include/xrpl/protocol/digest.h @@ -100,7 +100,7 @@ using sha512_hasher = openssl_sha512_hasher; /** Returns the RIPEMD-160 digest of the SHA256 hash of the message. This operation is used to compute the 160-bit identifier - representing a Ripple account, from a message. Typically the + representing an XRPL account, from a message. Typically the message is the public key of the account - which is not stored in the account root. @@ -177,12 +177,12 @@ public: } private: - inline void + void erase(std::false_type) { } - inline void + void erase(std::true_type) { secure_erase(&h_, sizeof(h_)); diff --git a/include/xrpl/protocol/json_get_or_throw.h b/include/xrpl/protocol/json_get_or_throw.h index 336d875450..949fb64cf2 100644 --- a/include/xrpl/protocol/json_get_or_throw.h +++ b/include/xrpl/protocol/json_get_or_throw.h @@ -112,7 +112,7 @@ getOrThrow(Json::Value const& v, xrpl::SField const& field) { auto const s = inner.asString(); // parse as hex - std::uint64_t val; + std::uint64_t val = 0; auto [p, ec] = std::from_chars(s.data(), s.data() + s.size(), val, 16); @@ -146,7 +146,7 @@ getOptional(Json::Value const& v, xrpl::SField const& field) { return getOrThrow(v, field); } - catch (...) + catch (...) // NOLINT(bugprone-empty-catch) { } return {}; diff --git a/include/xrpl/protocol/jss.h b/include/xrpl/protocol/jss.h index 0a877cb96a..a22810ac8a 100644 --- a/include/xrpl/protocol/jss.h +++ b/include/xrpl/protocol/jss.h @@ -21,687 +21,662 @@ namespace jss { error: Common properties of RPC error responses. */ -// clang-format off -JSS(AL_size); // out: GetCounts -JSS(AL_hit_rate); // out: GetCounts -JSS(AcceptedCredentials); // out: AccountObjects -JSS(ACCOUNT_SET_FLAGS); // out: RPC server_definitions -JSS(Account); // in: TransactionSign; field. -JSS(AMMID); // field -JSS(Amount); // in: TransactionSign; field. -JSS(Amount2); // in/out: AMM IOU/XRP pool, deposit, withdraw amount -JSS(Asset); // in: AMM Asset1 -JSS(Asset2); // in: AMM Asset2 -JSS(AssetClass); // in: Oracle -JSS(AssetPrice); // in: Oracle -JSS(AuthAccount); // in: AMM Auction Slot -JSS(AuthAccounts); // in: AMM Auction Slot -JSS(BaseAsset); // in: Oracle -JSS(BidMax); // in: AMM Bid -JSS(BidMin); // in: AMM Bid -JSS(ClearFlag); // field. -JSS(Counterparty); // field. -JSS(CounterpartySignature);// field. -JSS(DeliverMax); // out: alias to Amount -JSS(DeliverMin); // in: TransactionSign -JSS(Destination); // in: TransactionSign; field. -JSS(EPrice); // in: AMM Deposit option -JSS(Fee); // in/out: TransactionSign; field. -JSS(Flags); // in/out: TransactionSign; field. -JSS(Holder); // field. -JSS(Invalid); // -JSS(Issuer); // in: Credential transactions -JSS(IssuingChainDoor); // field. -JSS(IssuingChainIssue); // field. -JSS(LastLedgerSequence); // in: TransactionSign; field -JSS(LastUpdateTime); // field. -JSS(LimitAmount); // field. -JSS(LockingChainDoor); // field. -JSS(LockingChainIssue); // field. -JSS(NetworkID); // field. -JSS(LPTokenOut); // in: AMM Liquidity Provider deposit tokens -JSS(LPTokenIn); // in: AMM Liquidity Provider withdraw tokens -JSS(LPToken); // out: AMM Liquidity Provider tokens info -JSS(OfferSequence); // field. -JSS(OracleDocumentID); // field -JSS(Owner); // field -JSS(Paths); // in/out: TransactionSign -JSS(PriceDataSeries); // field. -JSS(PriceData); // field. -JSS(Provider); // field. -JSS(QuoteAsset); // in: Oracle. -JSS(RawTransaction); // in: Batch -JSS(RawTransactions); // in: Batch -JSS(SLE_hit_rate); // out: GetCounts. -JSS(Scale); // field. -JSS(SettleDelay); // in: TransactionSign -JSS(SendMax); // in: TransactionSign -JSS(Sequence); // in/out: TransactionSign; field. -JSS(SetFlag); // field. -JSS(Signer); // field. -JSS(Signers); // field. -JSS(SigningPubKey); // field. -JSS(Subject); // in: Credential transactions -JSS(TakerGets); // field. -JSS(TakerPays); // field. -JSS(TradingFee); // in/out: AMM trading fee -JSS(TransactionType); // in: TransactionSign. -JSS(TransferRate); // in: TransferRate. -JSS(TxnSignature); // field. -JSS(URI); // field. -JSS(VoteSlots); // out: AMM Vote -JSS(aborted); // out: InboundLedger -JSS(accepted); // out: LedgerToJson, OwnerInfo, SubmitTransaction -JSS(accountState); // out: LedgerToJson -JSS(accountTreeHash); // out: ledger/Ledger.cpp -JSS(account_data); // out: AccountInfo -JSS(account_flags); // out: AccountInfo -JSS(account_hash); // out: LedgerToJson -JSS(account_id); // out: WalletPropose -JSS(account_nfts); // out: AccountNFTs -JSS(account_objects); // out: AccountObjects -JSS(account_root); // in: LedgerEntry -JSS(account_sequence_next); // out: SubmitTransaction +JSS(AL_size); // out: GetCounts +JSS(AL_hit_rate); // out: GetCounts +JSS(AcceptedCredentials); // out: AccountObjects +JSS(ACCOUNT_SET_FLAGS); // out: RPC server_definitions +JSS(Account); // in: TransactionSign; field. +JSS(AMMID); // field +JSS(Amount); // in: TransactionSign; field. +JSS(Amount2); // in/out: AMM IOU/XRP pool, deposit, withdraw amount +JSS(Asset); // in: AMM Asset1 +JSS(Asset2); // in: AMM Asset2 +JSS(AssetClass); // in: Oracle +JSS(AssetPrice); // in: Oracle +JSS(AuthAccount); // in: AMM Auction Slot +JSS(AuthAccounts); // in: AMM Auction Slot +JSS(BaseAsset); // in: Oracle +JSS(BidMax); // in: AMM Bid +JSS(BidMin); // in: AMM Bid +JSS(ClearFlag); // field. +JSS(Counterparty); // field. +JSS(CounterpartySignature); // field. +JSS(DeliverMax); // out: alias to Amount +JSS(DeliverMin); // in: TransactionSign +JSS(Destination); // in: TransactionSign; field. +JSS(EPrice); // in: AMM Deposit option +JSS(Fee); // in/out: TransactionSign; field. +JSS(Flags); // in/out: TransactionSign; field. +JSS(Holder); // field. +JSS(Invalid); // +JSS(Issuer); // in: Credential transactions +JSS(IssuingChainDoor); // field. +JSS(IssuingChainIssue); // field. +JSS(LastLedgerSequence); // in: TransactionSign; field +JSS(LastUpdateTime); // field. +JSS(LimitAmount); // field. +JSS(LockingChainDoor); // field. +JSS(LockingChainIssue); // field. +JSS(NetworkID); // field. +JSS(LPTokenOut); // in: AMM Liquidity Provider deposit tokens +JSS(LPTokenIn); // in: AMM Liquidity Provider withdraw tokens +JSS(LPToken); // out: AMM Liquidity Provider tokens info +JSS(OfferSequence); // field. +JSS(OracleDocumentID); // field +JSS(Owner); // field +JSS(Paths); // in/out: TransactionSign +JSS(PriceDataSeries); // field. +JSS(PriceData); // field. +JSS(Provider); // field. +JSS(QuoteAsset); // in: Oracle. +JSS(RawTransaction); // in: Batch +JSS(RawTransactions); // in: Batch +JSS(SLE_hit_rate); // out: GetCounts. +JSS(Scale); // field. +JSS(SettleDelay); // in: TransactionSign +JSS(SendMax); // in: TransactionSign +JSS(Sequence); // in/out: TransactionSign; field. +JSS(SetFlag); // field. +JSS(Signer); // field. +JSS(Signers); // field. +JSS(SigningPubKey); // field. +JSS(Subject); // in: Credential transactions +JSS(TakerGets); // field. +JSS(TakerPays); // field. +JSS(TradingFee); // in/out: AMM trading fee +JSS(TransactionType); // in: TransactionSign. +JSS(TransferRate); // in: TransferRate. +JSS(TxnSignature); // field. +JSS(URI); // field. +JSS(VoteSlots); // out: AMM Vote +JSS(aborted); // out: InboundLedger +JSS(accepted); // out: LedgerToJson, OwnerInfo, SubmitTransaction +JSS(accountState); // out: LedgerToJson +JSS(accountTreeHash); // out: ledger/Ledger.cpp +JSS(account_data); // out: AccountInfo +JSS(account_flags); // out: AccountInfo +JSS(account_hash); // out: LedgerToJson +JSS(account_id); // out: WalletPropose +JSS(account_nfts); // out: AccountNFTs +JSS(account_objects); // out: AccountObjects +JSS(account_root); // in: LedgerEntry +JSS(account_sequence_next); // out: SubmitTransaction JSS(account_sequence_available); // out: SubmitTransaction JSS(account_history_tx_stream); // in: Subscribe, Unsubscribe JSS(account_history_tx_index); // out: Account txn history subscribe - -JSS(account_history_tx_first); // out: Account txn history subscribe -JSS(account_history_boundary); // out: Account txn history subscribe -JSS(accounts); // in: LedgerEntry, Subscribe, - // handlers/Ledger, Unsubscribe -JSS(accounts_proposed); // in: Subscribe, Unsubscribe -JSS(action); -JSS(active); // out: OverlayImpl -JSS(acquiring); // out: LedgerRequest -JSS(address); // out: PeerImp -JSS(affected); // out: AcceptedLedgerTx -JSS(age); // out: NetworkOPs, Peers -JSS(alternatives); // out: PathRequest, RipplePathFind -JSS(amendment_blocked); // out: NetworkOPs -JSS(amm_account); // in: amm_info -JSS(amount); // out: AccountChannels, amm_info -JSS(amount2); // out: amm_info -JSS(api_version); // in: many, out: Version -JSS(api_version_low); // out: Version -JSS(applied); // out: SubmitTransaction -JSS(asks); // out: Subscribe -JSS(asset); // in: amm_info -JSS(asset2); // in: amm_info -JSS(assets); // out: GatewayBalances -JSS(asset_frozen); // out: amm_info -JSS(asset2_frozen); // out: amm_info -JSS(attestations); -JSS(attestation_reward_account); -JSS(auction_slot); // out: amm_info -JSS(authorized); // out: AccountLines -JSS(authorize); // out: delegate -JSS(authorized_credentials); // in: ledger_entry DepositPreauth -JSS(auth_accounts); // out: amm_info -JSS(auth_change); // out: AccountInfo -JSS(auth_change_queued); // out: AccountInfo -JSS(available); // out: ValidatorList -JSS(avg_bps_recv); // out: Peers -JSS(avg_bps_sent); // out: Peers -JSS(balance); // out: AccountLines -JSS(balances); // out: GatewayBalances -JSS(base); // out: LogLevel -JSS(base_asset); // in: get_aggregate_price -JSS(base_fee); // out: NetworkOPs -JSS(base_fee_xrp); // out: NetworkOPs -JSS(bids); // out: Subscribe -JSS(binary); // in: AccountTX, LedgerEntry, - // AccountTxOld, Tx LedgerData -JSS(blob); // out: ValidatorList -JSS(blobs_v2); // out: ValidatorList - // in: UNL -JSS(books); // in: Subscribe, Unsubscribe -JSS(both); // in: Subscribe, Unsubscribe -JSS(both_sides); // in: Subscribe, Unsubscribe -JSS(branch); // out: server_info -JSS(broadcast); // out: SubmitTransaction -JSS(bridge_account); // in: LedgerEntry -JSS(build_path); // in: TransactionSign -JSS(build_version); // out: NetworkOPs -JSS(cancel_after); // out: AccountChannels -JSS(can_delete); // out: CanDelete -JSS(mpt_amount); // out: mpt_holders -JSS(mpt_issuance_id); // in: Payment, mpt_holders -JSS(mptoken_index); // out: mpt_holders -JSS(changes); // out: BookChanges -JSS(channel_id); // out: AccountChannels -JSS(channels); // out: AccountChannels -JSS(check_nodes); // in: LedgerCleaner -JSS(clear); // in/out: FetchInfo -JSS(close); // out: BookChanges -JSS(close_flags); // out: LedgerToJson -JSS(close_time); // in: Application, out: NetworkOPs, - // RCLCxPeerPos, LedgerToJson -JSS(close_time_iso); // out: Tx, NetworkOPs, TransactionEntry - // AccountTx, LedgerToJson -JSS(close_time_estimated); // in: Application, out: LedgerToJson -JSS(close_time_human); // out: LedgerToJson -JSS(close_time_offset); // out: NetworkOPs -JSS(close_time_resolution); // in: Application; out: LedgerToJson -JSS(closed); // out: NetworkOPs, LedgerToJson, - // handlers/Ledger -JSS(closed_ledger); // out: NetworkOPs -JSS(cluster); // out: PeerImp -JSS(code); // out: errors -JSS(command); // in: RPCHandler -JSS(common); // out: RPC server_definitions -JSS(complete); // out: NetworkOPs, InboundLedger -JSS(complete_ledgers); // out: NetworkOPs, PeerImp -JSS(consensus); // out: NetworkOPs, LedgerConsensus -JSS(converge_time); // out: NetworkOPs -JSS(converge_time_s); // out: NetworkOPs -JSS(cookie); // out: NetworkOPs -JSS(count); // in: AccountTx*, ValidatorList -JSS(counters); // in/out: retrieve counters -JSS(credentials); // in: deposit_authorized -JSS(credential_type); // in: LedgerEntry DepositPreauth -JSS(ctid); // in/out: Tx RPC -JSS(currency_a); // out: BookChanges -JSS(currency_b); // out: BookChanges -JSS(currency); // in: paths/PathRequest, STAmount - // out: STPathSet, STAmount, - // AccountLines -JSS(current); // out: OwnerInfo -JSS(current_activities); -JSS(current_ledger_size); // out: TxQ -JSS(current_queue_size); // out: TxQ -JSS(data); // out: LedgerData -JSS(date); // out: tx/Transaction, NetworkOPs -JSS(dbKBLedger); // out: getCounts -JSS(dbKBTotal); // out: getCounts -JSS(dbKBTransaction); // out: getCounts -JSS(debug_signing); // in: TransactionSign -JSS(deletion_blockers_only); // in: AccountObjects -JSS(delivered_amount); // out: insertDeliveredAmount -JSS(deposit_authorized); // out: deposit_authorized -JSS(deprecated); // out -JSS(descending); // in: AccountTx* -JSS(description); // in/out: Reservations -JSS(destination); // in: nft_buy_offers, nft_sell_offers -JSS(destination_account); // in: PathRequest, RipplePathFind, account_lines - // out: AccountChannels -JSS(destination_amount); // in: PathRequest, RipplePathFind -JSS(destination_currencies); // in: PathRequest, RipplePathFind -JSS(destination_tag); // in: PathRequest - // out: AccountChannels -JSS(details); // out: Manifest, server_info -JSS(dir_entry); // out: DirectoryEntryIterator -JSS(dir_index); // out: DirectoryEntryIterator -JSS(dir_root); // out: DirectoryEntryIterator -JSS(discounted_fee); // out: amm_info -JSS(domain); // out: ValidatorInfo, Manifest -JSS(drops); // out: TxQ -JSS(duration_us); // out: NetworkOPs -JSS(effective); // out: ValidatorList - // in: UNL -JSS(enabled); // out: AmendmentTable -JSS(engine_result); // out: NetworkOPs, TransactionSign, Submit -JSS(engine_result_code); // out: NetworkOPs, TransactionSign, Submit -JSS(engine_result_message); // out: NetworkOPs, TransactionSign, Submit -JSS(entire_set); // out: get_aggregate_price -JSS(ephemeral_key); // out: ValidatorInfo - // in/out: Manifest -JSS(error); // out: error -JSS(errored); -JSS(error_code); // out: error -JSS(error_exception); // out: Submit -JSS(error_message); // out: error -JSS(expand); // in: handler/Ledger -JSS(expected_date); // out: any (warnings) -JSS(expected_date_UTC); // out: any (warnings) -JSS(expected_ledger_size); // out: TxQ -JSS(expiration); // out: AccountOffers, AccountChannels, - // ValidatorList, amm_info -JSS(fail_hard); // in: Sign, Submit -JSS(failed); // out: InboundLedger -JSS(feature); // in: Feature -JSS(features); // out: Feature -JSS(fee_base); // out: NetworkOPs -JSS(fee_div_max); // in: TransactionSign -JSS(fee_level); // out: AccountInfo -JSS(fee_mult_max); // in: TransactionSign -JSS(fee_ref); // out: NetworkOPs, DEPRECATED -JSS(fetch_pack); // out: NetworkOPs -JSS(FIELDS); // out: RPC server_definitions - // matches definitions.json format -JSS(first); // out: rpc/Version -JSS(finished); -JSS(fix_txns); // in: LedgerCleaner -JSS(flags); // out: AccountOffers, - // NetworkOPs -JSS(forward); // in: AccountTx -JSS(freeze); // out: AccountLines -JSS(freeze_peer); // out: AccountLines -JSS(deep_freeze); // out: AccountLines -JSS(deep_freeze_peer); // out: AccountLines -JSS(frozen_balances); // out: GatewayBalances -JSS(full); // in: LedgerClearer, handlers/Ledger -JSS(full_reply); // out: PathFind -JSS(fullbelow_size); // out: GetCounts -JSS(git); // out: server_info -JSS(good); // out: RPCVersion -JSS(hash); // out: NetworkOPs, InboundLedger, - // LedgerToJson, STTx; field -JSS(have_header); // out: InboundLedger -JSS(have_state); // out: InboundLedger -JSS(have_transactions); // out: InboundLedger -JSS(high); // out: BookChanges -JSS(highest_sequence); // out: AccountInfo -JSS(highest_ticket); // out: AccountInfo -JSS(historical_perminute); // historical_perminute. -JSS(holders); // out: MPTHolders -JSS(hostid); // out: NetworkOPs -JSS(hotwallet); // in: GatewayBalances -JSS(id); // websocket. -JSS(ident); // in: AccountCurrencies, AccountInfo, - // OwnerInfo -JSS(ignore_default); // in: AccountLines -JSS(in); // out: OverlayImpl -JSS(inLedger); // out: tx/Transaction -JSS(inbound); // out: PeerImp -JSS(index); // in: LedgerEntry - // out: STLedgerEntry, - // LedgerEntry, TxHistory, LedgerData -JSS(info); // out: ServerInfo, ConsensusInfo, FetchInfo -JSS(initial_sync_duration_us); -JSS(internal_command); // in: Internal -JSS(invalid_API_version); // out: Many, when a request has an invalid - // version -JSS(io_latency_ms); // out: NetworkOPs -JSS(ip); // in: Connect, out: OverlayImpl -JSS(is_burned); // out: nft_info (clio) -JSS(isSerialized); // out: RPC server_definitions - // matches definitions.json format -JSS(isSigningField); // out: RPC server_definitions - // matches definitions.json format -JSS(isVLEncoded); // out: RPC server_definitions - // matches definitions.json format -JSS(issuer); // in: RipplePathFind, Subscribe, - // Unsubscribe, BookOffers - // out: STPathSet, STAmount -JSS(job); -JSS(job_queue); -JSS(jobs); -JSS(jsonrpc); // json version -JSS(jq_trans_overflow); // JobQueue transaction limit overflow. -JSS(kept); // out: SubmitTransaction -JSS(key); // out -JSS(key_type); // in/out: WalletPropose, TransactionSign -JSS(latency); // out: PeerImp -JSS(last); // out: RPCVersion -JSS(last_close); // out: NetworkOPs -JSS(last_refresh_time); // out: ValidatorSite -JSS(last_refresh_status); // out: ValidatorSite -JSS(last_refresh_message); // out: ValidatorSite -JSS(ledger); // in: NetworkOPs, LedgerCleaner, - // RPCHelpers - // out: NetworkOPs, PeerImp -JSS(ledger_current_index); // out: NetworkOPs, RPCHelpers, - // LedgerCurrent, LedgerAccept, - // AccountLines -JSS(ledger_data); // out: LedgerHeader -JSS(ledger_hash); // in: RPCHelpers, LedgerRequest, - // RipplePathFind, TransactionEntry, - // handlers/Ledger - // out: NetworkOPs, RPCHelpers, - // LedgerClosed, LedgerData, - // AccountLines -JSS(ledger_hit_rate); // out: GetCounts -JSS(ledger_index); // in/out: many -JSS(ledger_index_max); // in, out: AccountTx* -JSS(ledger_index_min); // in, out: AccountTx* -JSS(ledger_max); // in, out: AccountTx* -JSS(ledger_min); // in, out: AccountTx* -JSS(ledger_time); // out: NetworkOPs -JSS(LEDGER_ENTRY_TYPES); // out: RPC server_definitions - // matches definitions.json format -JSS(LEDGER_ENTRY_FLAGS); // out: RPC server_definitions -JSS(LEDGER_ENTRY_FORMATS); // out: RPC server_definitions -JSS(levels); // LogLevels -JSS(limit); // in/out: AccountTx*, AccountOffers, - // AccountLines, AccountObjects - // in: LedgerData, BookOffers -JSS(limit_peer); // out: AccountLines -JSS(lines); // out: AccountLines -JSS(list); // out: ValidatorList -JSS(load); // out: NetworkOPs, PeerImp -JSS(load_base); // out: NetworkOPs -JSS(load_factor); // out: NetworkOPs -JSS(load_factor_cluster); // out: NetworkOPs -JSS(load_factor_fee_escalation); // out: NetworkOPs -JSS(load_factor_fee_queue); // out: NetworkOPs -JSS(load_factor_fee_reference); // out: NetworkOPs -JSS(load_factor_local); // out: NetworkOPs -JSS(load_factor_net); // out: NetworkOPs -JSS(load_factor_server); // out: NetworkOPs -JSS(load_fee); // out: LoadFeeTrackImp, NetworkOPs -JSS(loan_broker_id); // in: LedgerEntry -JSS(loan_seq); // in: LedgerEntry -JSS(local); // out: resource/Logic.h -JSS(local_txs); // out: GetCounts -JSS(local_static_keys); // out: ValidatorList -JSS(locked); // out: GatewayBalances -JSS(low); // out: BookChanges -JSS(lowest_sequence); // out: AccountInfo -JSS(lowest_ticket); // out: AccountInfo -JSS(lp_token); // out: amm_info -JSS(majority); // out: RPC feature -JSS(manifest); // out: ValidatorInfo, Manifest -JSS(marker); // in/out: AccountTx, AccountOffers, - // AccountLines, AccountObjects, - // LedgerData - // in: BookOffers -JSS(master_key); // out: WalletPropose, NetworkOPs, - // ValidatorInfo - // in/out: Manifest -JSS(master_seed); // out: WalletPropose -JSS(master_seed_hex); // out: WalletPropose -JSS(master_signature); // out: pubManifest -JSS(max_ledger); // in/out: LedgerCleaner -JSS(max_queue_size); // out: TxQ -JSS(max_spend_drops); // out: AccountInfo -JSS(max_spend_drops_total); // out: AccountInfo -JSS(mean); // out: get_aggregate_price -JSS(median); // out: get_aggregate_price -JSS(median_fee); // out: TxQ -JSS(median_level); // out: TxQ -JSS(message); // error. -JSS(meta); // out: NetworkOPs, AccountTx*, Tx -JSS(meta_blob); // out: NetworkOPs, AccountTx*, Tx -JSS(metaData); -JSS(metadata); // out: TransactionEntry -JSS(method); // RPC -JSS(methods); -JSS(metrics); // out: Peers -JSS(min_count); // in: GetCounts -JSS(min_ledger); // in: LedgerCleaner -JSS(minimum_fee); // out: TxQ -JSS(minimum_level); // out: TxQ -JSS(missingCommand); // error -JSS(name); // out: AmendmentTableImpl, PeerImp -JSS(needed_state_hashes); // out: InboundLedger -JSS(needed_transaction_hashes); // out: InboundLedger -JSS(network_id); // out: NetworkOPs -JSS(network_ledger); // out: NetworkOPs -JSS(next_refresh_time); // out: ValidatorSite -JSS(nft_id); // in: nft_sell_offers, nft_buy_offers -JSS(nft_offer_index); // out nft_buy_offers, nft_sell_offers -JSS(nft_serial); // out: account_nfts -JSS(nft_taxon); // out: nft_info (clio) -JSS(nftoken_id); // out: insertNFTokenID -JSS(nftoken_ids); // out: insertNFTokenID -JSS(no_ripple); // out: AccountLines -JSS(no_ripple_peer); // out: AccountLines -JSS(node); // out: LedgerEntry -JSS(node_binary); // out: LedgerEntry -JSS(node_read_bytes); // out: GetCounts -JSS(node_read_errors); // out: GetCounts -JSS(node_read_retries); // out: GetCounts -JSS(node_reads_hit); // out: GetCounts -JSS(node_reads_total); // out: GetCounts -JSS(node_reads_duration_us); // out: GetCounts -JSS(node_size); // out: server_info -JSS(nodes); // out: VaultInfo -JSS(nodestore); // out: GetCounts -JSS(node_writes); // out: GetCounts -JSS(node_written_bytes); // out: GetCounts -JSS(node_writes_duration_us); // out: GetCounts -JSS(node_write_retries); // out: GetCounts -JSS(node_writes_delayed); // out::GetCounts -JSS(nth); // out: RPC server_definitions -JSS(obligations); // out: GatewayBalances -JSS(offers); // out: NetworkOPs, AccountOffers, Subscribe -JSS(offer_id); // out: insertNFTokenOfferID -JSS(offline); // in: TransactionSign -JSS(offset); // in/out: AccountTxOld -JSS(open); // out: handlers/Ledger -JSS(open_ledger_cost); // out: SubmitTransaction -JSS(open_ledger_fee); // out: TxQ -JSS(open_ledger_level); // out: TxQ -JSS(optionality); // out: server_definitions -JSS(oracles); // in: get_aggregate_price -JSS(oracle_document_id); // in: get_aggregate_price -JSS(out); // out: OverlayImpl -JSS(owner); // in: LedgerEntry, out: NetworkOPs -JSS(owner_funds); // in/out: Ledger, NetworkOPs, AcceptedLedgerTx -JSS(page_index); -JSS(params); // RPC -JSS(parent_close_time); // out: LedgerToJson -JSS(parent_hash); // out: LedgerToJson -JSS(partition); // in: LogLevel -JSS(passphrase); // in: WalletPropose -JSS(password); // in: Subscribe -JSS(paths); // in: RipplePathFind -JSS(paths_canonical); // out: RipplePathFind -JSS(paths_computed); // out: PathRequest, RipplePathFind -JSS(peer); // in: AccountLines -JSS(peer_authorized); // out: AccountLines -JSS(peer_id); // out: RCLCxPeerPos -JSS(peers); // out: InboundLedger, handlers/Peers, Overlay -JSS(peer_disconnects); // Severed peer connection counter. -JSS(peer_disconnects_resources); // Severed peer connections because of - // excess resource consumption. -JSS(port); // in: Connect, out: NetworkOPs -JSS(ports); // out: NetworkOPs -JSS(previous); // out: Reservations -JSS(previous_ledger); // out: LedgerPropose -JSS(price); // out: amm_info, AuctionSlot -JSS(proof); // in: BookOffers -JSS(propose_seq); // out: LedgerPropose -JSS(proposers); // out: NetworkOPs, LedgerConsensus -JSS(protocol); // out: NetworkOPs, PeerImp -JSS(proxied); // out: RPC ping -JSS(pseudo_account); // out: AccountInfo -JSS(pubkey_node); // out: NetworkOPs -JSS(pubkey_publisher); // out: ValidatorList -JSS(pubkey_validator); // out: NetworkOPs, ValidatorList -JSS(public_key); // out: OverlayImpl, PeerImp, WalletPropose, - // ValidatorInfo - // in/out: Manifest -JSS(public_key_hex); // out: WalletPropose -JSS(published_ledger); // out: NetworkOPs -JSS(publisher_lists); // out: ValidatorList -JSS(quality); // out: NetworkOPs -JSS(quality_in); // out: AccountLines -JSS(quality_out); // out: AccountLines -JSS(queue); // in: AccountInfo -JSS(queue_data); // out: AccountInfo -JSS(queued); // out: SubmitTransaction -JSS(queued_duration_us); -JSS(quote_asset); // in: get_aggregate_price -JSS(random); // out: Random -JSS(raw_meta); // out: AcceptedLedgerTx -JSS(receive_currencies); // out: AccountCurrencies -JSS(reference_level); // out: TxQ -JSS(refresh_interval); // in: UNL -JSS(refresh_interval_min); // out: ValidatorSites -JSS(regular_seed); // in/out: LedgerEntry -JSS(remaining); // out: ValidatorList -JSS(remote); // out: Logic.h -JSS(request); // RPC -JSS(requested); // out: Manifest -JSS(reservations); // out: Reservations -JSS(reserve_base); // out: NetworkOPs -JSS(reserve_base_xrp); // out: NetworkOPs -JSS(reserve_inc); // out: NetworkOPs -JSS(reserve_inc_xrp); // out: NetworkOPs -JSS(response); // websocket -JSS(result); // RPC -JSS(ripple_lines); // out: NetworkOPs -JSS(ripple_state); // in: LedgerEntr -JSS(ripplerpc); // ripple RPC version -JSS(role); // out: Ping.cpp -JSS(rpc); -JSS(rt_accounts); // in: Subscribe, Unsubscribe -JSS(running_duration_us); -JSS(search_depth); // in: RipplePathFind -JSS(searched_all); // out: Tx -JSS(secret); // in: TransactionSign, - // ValidationCreate, ValidationSeed, - // channel_authorize -JSS(seed); // -JSS(seed_hex); // in: WalletPropose, TransactionSign -JSS(send_currencies); // out: AccountCurrencies -JSS(send_max); // in: PathRequest, RipplePathFind -JSS(seq); // in: LedgerEntry; - // out: NetworkOPs, RPCSub, AccountOffers, - // ValidatorList, ValidatorInfo, Manifest -JSS(sequence); // in: UNL -JSS(sequence_count); // out: AccountInfo -JSS(server_domain); // out: NetworkOPs -JSS(server_state); // out: NetworkOPs -JSS(server_state_duration_us);// out: NetworkOPs -JSS(server_status); // out: NetworkOPs -JSS(server_version); // out: NetworkOPs -JSS(settle_delay); // out: AccountChannels -JSS(severity); // in: LogLevel -JSS(shares); // out: VaultInfo -JSS(signature); // out: NetworkOPs, ChannelAuthorize -JSS(signature_target); // in: TransactionSign -JSS(signature_verified); // out: ChannelVerify -JSS(signing_key); // out: NetworkOPs -JSS(signing_keys); // out: ValidatorList -JSS(signing_time); // out: NetworkOPs -JSS(signer_lists); // in/out: AccountInfo -JSS(size); // out: get_aggregate_price -JSS(snapshot); // in: Subscribe -JSS(source_account); // in: PathRequest, RipplePathFind -JSS(source_amount); // in: PathRequest, RipplePathFind -JSS(source_currencies); // in: PathRequest, RipplePathFind -JSS(source_tag); // out: AccountChannels -JSS(stand_alone); // out: NetworkOPs -JSS(standard_deviation); // out: get_aggregate_price -JSS(start); // in: TxHistory -JSS(started); -JSS(state_accounting); // out: NetworkOPs -JSS(state_now); // in: Subscribe -JSS(status); // error -JSS(stop); // in: LedgerCleaner -JSS(stop_history_tx_only); // in: Unsubscribe, stop history tx stream -JSS(streams); // in: Subscribe, Unsubscribe -JSS(strict); // in: AccountCurrencies, AccountInfo -JSS(sub_index); // in: LedgerEntry -JSS(subcommand); // in: PathFind -JSS(subject); // in: LedgerEntry Credential -JSS(success); // rpc -JSS(supported); // out: AmendmentTableImpl -JSS(sync_mode); // in: Submit -JSS(system_time_offset); // out: NetworkOPs -JSS(tag); // out: Peers -JSS(taker); // in: Subscribe, BookOffers -JSS(taker_gets); // in: Subscribe, Unsubscribe, BookOffers -JSS(taker_gets_funded); // out: NetworkOPs -JSS(taker_pays); // in: Subscribe, Unsubscribe, BookOffers -JSS(taker_pays_funded); // out: NetworkOPs -JSS(threshold); // in: Blacklist -JSS(ticket_count); // out: AccountInfo -JSS(ticket_seq); // in: LedgerEntry -JSS(time); -JSS(timeouts); // out: InboundLedger -JSS(time_threshold); // in/out: Oracle aggregate -JSS(time_interval); // out: AMM Auction Slot -JSS(track); // out: PeerImp -JSS(traffic); // out: Overlay -JSS(trim); // in: get_aggregate_price -JSS(trimmed_set); // out: get_aggregate_price -JSS(total); // out: counters -JSS(total_bytes_recv); // out: Peers -JSS(total_bytes_sent); // out: Peers -JSS(total_coins); // out: LedgerToJson -JSS(trading_fee); // out: amm_info -JSS(transTreeHash); // out: ledger/Ledger.cpp -JSS(transaction); // in: Tx - // out: NetworkOPs, AcceptedLedgerTx, -JSS(transaction_hash); // out: RCLCxPeerPos, LedgerToJson -JSS(transactions); // out: LedgerToJson, - // in: AccountTx*, Unsubscribe -JSS(TRANSACTION_RESULTS); // out: RPC server_definitions - // matches definitions.json format -JSS(TRANSACTION_TYPES); // out: RPC server_definitions - // matches definitions.json format -JSS(TRANSACTION_FLAGS); // out: RPC server_definitions -JSS(TRANSACTION_FORMATS); // out: RPC server_definitions -JSS(TYPES); // out: RPC server_definitions - // matches definitions.json format -JSS(transfer_rate); // out: nft_info (clio) -JSS(transitions); // out: NetworkOPs -JSS(treenode_cache_size); // out: GetCounts -JSS(treenode_track_size); // out: GetCounts -JSS(trusted); // out: UnlList -JSS(trusted_validator_keys); // out: ValidatorList -JSS(tx); // out: STTx, AccountTx* -JSS(tx_blob); // in/out: Submit, - // in: TransactionSign, AccountTx* -JSS(tx_hash); // in: TransactionEntry -JSS(tx_json); // in/out: TransactionSign - // out: TransactionEntry -JSS(tx_signing_hash); // out: TransactionSign -JSS(tx_unsigned); // out: TransactionSign -JSS(txn_count); // out: NetworkOPs -JSS(txr_tx_cnt); // out: protocol message tx's count -JSS(txr_tx_sz); // out: protocol message tx's size -JSS(txr_have_txs_cnt); // out: protocol message have tx count -JSS(txr_have_txs_sz); // out: protocol message have tx size -JSS(txr_get_ledger_cnt); // out: protocol message get ledger count -JSS(txr_get_ledger_sz); // out: protocol message get ledger size -JSS(txr_ledger_data_cnt); // out: protocol message ledger data count -JSS(txr_ledger_data_sz); // out: protocol message ledger data size -JSS(txr_transactions_cnt); // out: protocol message get object count -JSS(txr_transactions_sz); // out: protocol message get object size -JSS(txr_selected_cnt); // out: selected peers count -JSS(txr_suppressed_cnt); // out: suppressed peers count -JSS(txr_not_enabled_cnt); // out: peers with tx reduce-relay disabled count -JSS(txr_missing_tx_freq); // out: missing tx frequency average -JSS(txs); // out: TxHistory -JSS(type); // in: AccountObjects - // out: NetworkOPs, RPC server_definitions - // OverlayImpl, Logic -JSS(type_hex); // out: STPathSet -JSS(unl); // out: UnlList -JSS(unlimited); // out: Connection.h -JSS(uptime); // out: GetCounts -JSS(uri); // out: ValidatorSites -JSS(url); // in/out: Subscribe, Unsubscribe -JSS(url_password); // in: Subscribe -JSS(url_username); // in: Subscribe -JSS(urlgravatar); // -JSS(username); // in: Subscribe -JSS(validated); // out: NetworkOPs, RPCHelpers, AccountTx* - // Tx -JSS(validator_list_expires); // out: NetworkOps, ValidatorList -JSS(validator_list); // out: NetworkOps, ValidatorList -JSS(validators); -JSS(validated_hash); // out: NetworkOPs -JSS(validated_ledger); // out: NetworkOPs -JSS(validated_ledger_index); // out: SubmitTransaction -JSS(validated_ledgers); // out: NetworkOPs -JSS(validation_key); // out: ValidationCreate, ValidationSeed -JSS(validation_private_key); // out: ValidationCreate -JSS(validation_public_key); // out: ValidationCreate, ValidationSeed -JSS(validation_quorum); // out: NetworkOPs -JSS(validation_seed); // out: ValidationCreate, ValidationSeed -JSS(validations); // out: AmendmentTableImpl -JSS(validator_list_threshold); // out: ValidatorList -JSS(validator_sites); // out: ValidatorSites -JSS(value); // out: STAmount -JSS(vault_id); // in: VaultInfo -JSS(version); // out: RPCVersion -JSS(vetoed); // out: AmendmentTableImpl -JSS(volume_a); // out: BookChanges -JSS(volume_b); // out: BookChanges -JSS(vote); // in: Feature -JSS(vote_slots); // out: amm_info -JSS(vote_weight); // out: amm_info -JSS(warning); // rpc: -JSS(warnings); // out: server_info, server_state -JSS(workers); -JSS(write_load); // out: GetCounts -// clang-format on +JSS(account_history_tx_first); // out: Account txn history subscribe +JSS(account_history_boundary); // out: Account txn history subscribe +JSS(accounts); // in: LedgerEntry, Subscribe, handlers/Ledger, Unsubscribe +JSS(accounts_proposed); // in: Subscribe, Unsubscribe +JSS(action); // +JSS(active); // out: OverlayImpl +JSS(acquiring); // out: LedgerRequest +JSS(address); // out: PeerImp +JSS(affected); // out: AcceptedLedgerTx +JSS(age); // out: NetworkOPs, Peers +JSS(alternatives); // out: PathRequest, RipplePathFind +JSS(amendment_blocked); // out: NetworkOPs +JSS(amm_account); // in: amm_info +JSS(amount); // out: AccountChannels, amm_info +JSS(amount2); // out: amm_info +JSS(api_version); // in: many, out: Version +JSS(api_version_low); // out: Version +JSS(applied); // out: SubmitTransaction +JSS(asks); // out: Subscribe +JSS(asset); // in: amm_info +JSS(asset2); // in: amm_info +JSS(assets); // out: GatewayBalances +JSS(asset_frozen); // out: amm_info +JSS(asset2_frozen); // out: amm_info +JSS(attestations); // +JSS(attestation_reward_account); // +JSS(auction_slot); // out: amm_info +JSS(authorized); // out: AccountLines +JSS(authorize); // out: delegate +JSS(authorized_credentials); // in: ledger_entry DepositPreauth +JSS(auth_accounts); // out: amm_info +JSS(auth_change); // out: AccountInfo +JSS(auth_change_queued); // out: AccountInfo +JSS(available); // out: ValidatorList +JSS(avg_bps_recv); // out: Peers +JSS(avg_bps_sent); // out: Peers +JSS(balance); // out: AccountLines +JSS(balances); // out: GatewayBalances +JSS(base); // out: LogLevel +JSS(base_asset); // in: get_aggregate_price +JSS(base_fee); // out: NetworkOPs +JSS(base_fee_xrp); // out: NetworkOPs +JSS(bids); // out: Subscribe +JSS(binary); // in: AccountTX, LedgerEntry, AccountTxOld, Tx LedgerData +JSS(blob); // out: ValidatorList +JSS(blobs_v2); // out: ValidatorList + // in: UNL +JSS(books); // in: Subscribe, Unsubscribe +JSS(both); // in: Subscribe, Unsubscribe +JSS(both_sides); // in: Subscribe, Unsubscribe +JSS(branch); // out: server_info +JSS(broadcast); // out: SubmitTransaction +JSS(bridge_account); // in: LedgerEntry +JSS(build_path); // in: TransactionSign +JSS(build_version); // out: NetworkOPs +JSS(cancel_after); // out: AccountChannels +JSS(can_delete); // out: CanDelete +JSS(mpt_amount); // out: mpt_holders +JSS(mpt_issuance_id); // in: Payment, mpt_holders +JSS(mptoken_index); // out: mpt_holders +JSS(changes); // out: BookChanges +JSS(channel_id); // out: AccountChannels +JSS(channels); // out: AccountChannels +JSS(check_nodes); // in: LedgerCleaner +JSS(clear); // in/out: FetchInfo +JSS(close); // out: BookChanges +JSS(close_flags); // out: LedgerToJson +JSS(close_time); // in: Application, out: NetworkOPs, RCLCxPeerPos, LedgerToJson +JSS(close_time_iso); // out: Tx, NetworkOPs, TransactionEntry AccountTx, LedgerToJson +JSS(close_time_estimated); // in: Application, out: LedgerToJson +JSS(close_time_human); // out: LedgerToJson +JSS(close_time_offset); // out: NetworkOPs +JSS(close_time_resolution); // in: Application; out: LedgerToJson +JSS(closed); // out: NetworkOPs, LedgerToJson, handlers/Ledger +JSS(closed_ledger); // out: NetworkOPs +JSS(cluster); // out: PeerImp +JSS(code); // out: errors +JSS(command); // in: RPCHandler +JSS(common); // out: RPC server_definitions +JSS(complete); // out: NetworkOPs, InboundLedger +JSS(complete_ledgers); // out: NetworkOPs, PeerImp +JSS(consensus); // out: NetworkOPs, LedgerConsensus +JSS(converge_time); // out: NetworkOPs +JSS(converge_time_s); // out: NetworkOPs +JSS(cookie); // out: NetworkOPs +JSS(count); // in: AccountTx*, ValidatorList +JSS(counters); // in/out: retrieve counters +JSS(credentials); // in: deposit_authorized +JSS(credential_type); // in: LedgerEntry DepositPreauth +JSS(ctid); // in/out: Tx RPC +JSS(currency_a); // out: BookChanges +JSS(currency_b); // out: BookChanges +JSS(currency); // in: paths/PathRequest, STAmount + // out: STPathSet, STAmount, AccountLines +JSS(current); // out: OwnerInfo +JSS(current_activities); // +JSS(current_ledger_size); // out: TxQ +JSS(current_queue_size); // out: TxQ +JSS(data); // out: LedgerData +JSS(date); // out: tx/Transaction, NetworkOPs +JSS(dbKBLedger); // out: getCounts +JSS(dbKBTotal); // out: getCounts +JSS(dbKBTransaction); // out: getCounts +JSS(debug_signing); // in: TransactionSign +JSS(deletion_blockers_only); // in: AccountObjects +JSS(delivered_amount); // out: insertDeliveredAmount +JSS(deposit_authorized); // out: deposit_authorized +JSS(deprecated); // +JSS(descending); // in: AccountTx* +JSS(description); // in/out: Reservations +JSS(destination); // in: nft_buy_offers, nft_sell_offers +JSS(destination_account); // in: PathRequest, RipplePathFind, account_lines + // out: AccountChannels +JSS(destination_amount); // in: PathRequest, RipplePathFind +JSS(destination_currencies); // in: PathRequest, RipplePathFind +JSS(destination_tag); // in: PathRequest + // out: AccountChannels +JSS(details); // out: Manifest, server_info +JSS(dir_entry); // out: DirectoryEntryIterator +JSS(dir_index); // out: DirectoryEntryIterator +JSS(dir_root); // out: DirectoryEntryIterator +JSS(discounted_fee); // out: amm_info +JSS(domain); // out: ValidatorInfo, Manifest +JSS(drops); // out: TxQ +JSS(duration_us); // out: NetworkOPs +JSS(effective); // out: ValidatorList + // in: UNL +JSS(enabled); // out: AmendmentTable +JSS(engine_result); // out: NetworkOPs, TransactionSign, Submit +JSS(engine_result_code); // out: NetworkOPs, TransactionSign, Submit +JSS(engine_result_message); // out: NetworkOPs, TransactionSign, Submit +JSS(entire_set); // out: get_aggregate_price +JSS(ephemeral_key); // out: ValidatorInfo + // in/out: Manifest +JSS(error); // out: error +JSS(errored); // +JSS(error_code); // out: error +JSS(error_exception); // out: Submit +JSS(error_message); // out: error +JSS(expand); // in: handler/Ledger +JSS(expected_date); // out: any (warnings) +JSS(expected_date_UTC); // out: any (warnings) +JSS(expected_ledger_size); // out: TxQ +JSS(expiration); // out: AccountOffers, AccountChannels, ValidatorList, amm_info +JSS(fail_hard); // in: Sign, Submit +JSS(failed); // out: InboundLedger +JSS(feature); // in: Feature +JSS(features); // out: Feature +JSS(fee_base); // out: NetworkOPs +JSS(fee_div_max); // in: TransactionSign +JSS(fee_level); // out: AccountInfo +JSS(fee_mult_max); // in: TransactionSign +JSS(fee_ref); // out: NetworkOPs, DEPRECATED +JSS(fetch_pack); // out: NetworkOPs +JSS(FIELDS); // out: RPC server_definitions + // matches definitions.json format +JSS(first); // out: rpc/Version +JSS(finished); // +JSS(fix_txns); // in: LedgerCleaner +JSS(flags); // out: AccountOffers, NetworkOPs +JSS(forward); // in: AccountTx +JSS(freeze); // out: AccountLines +JSS(freeze_peer); // out: AccountLines +JSS(deep_freeze); // out: AccountLines +JSS(deep_freeze_peer); // out: AccountLines +JSS(frozen_balances); // out: GatewayBalances +JSS(full); // in: LedgerClearer, handlers/Ledger +JSS(full_reply); // out: PathFind +JSS(fullbelow_size); // out: GetCounts +JSS(git); // out: server_info +JSS(good); // out: RPCVersion +JSS(hash); // out: NetworkOPs, InboundLedger, LedgerToJson, STTx; field +JSS(have_header); // out: InboundLedger +JSS(have_state); // out: InboundLedger +JSS(have_transactions); // out: InboundLedger +JSS(high); // out: BookChanges +JSS(highest_sequence); // out: AccountInfo +JSS(highest_ticket); // out: AccountInfo +JSS(historical_perminute); // historical_perminute. +JSS(holders); // out: MPTHolders +JSS(hostid); // out: NetworkOPs +JSS(hotwallet); // in: GatewayBalances +JSS(id); // websocket. +JSS(ident); // in: AccountCurrencies, AccountInfo, OwnerInfo +JSS(ignore_default); // in: AccountLines +JSS(in); // out: OverlayImpl +JSS(inLedger); // out: tx/Transaction +JSS(inbound); // out: PeerImp +JSS(index); // in: LedgerEntry + // out: STLedgerEntry, LedgerEntry, TxHistory, LedgerData +JSS(info); // out: ServerInfo, ConsensusInfo, FetchInfo +JSS(initial_sync_duration_us); // +JSS(internal_command); // in: Internal +JSS(invalid_API_version); // out: Many, when a request has an invalid version +JSS(io_latency_ms); // out: NetworkOPs +JSS(ip); // in: Connect, out: OverlayImpl +JSS(is_burned); // out: nft_info (clio) +JSS(isSerialized); // out: RPC server_definitions + // matches definitions.json format +JSS(isSigningField); // out: RPC server_definitions + // matches definitions.json format +JSS(isVLEncoded); // out: RPC server_definitions + // matches definitions.json format +JSS(issuer); // in: RipplePathFind, Subscribe, Unsubscribe, BookOffers + // out: STPathSet, STAmount +JSS(job); // +JSS(job_queue); // +JSS(jobs); // +JSS(jsonrpc); // json version +JSS(jq_trans_overflow); // JobQueue transaction limit overflow. +JSS(kept); // out: SubmitTransaction +JSS(key); // out +JSS(key_type); // in/out: WalletPropose, TransactionSign +JSS(latency); // out: PeerImp +JSS(last); // out: RPCVersion +JSS(last_close); // out: NetworkOPs +JSS(last_refresh_time); // out: ValidatorSite +JSS(last_refresh_status); // out: ValidatorSite +JSS(last_refresh_message); // out: ValidatorSite +JSS(ledger); // in: NetworkOPs, LedgerCleaner, RPCHelpers + // out: NetworkOPs, PeerImp +JSS(ledger_current_index); // out: NetworkOPs, RPCHelpers, LedgerCurrent, LedgerAccept, + // AccountLines +JSS(ledger_data); // out: LedgerHeader +JSS(ledger_hash); // in: RPCHelpers, LedgerRequest, RipplePathFind, + // TransactionEntry, handlers/Ledger + // out: NetworkOPs, RPCHelpers, LedgerClosed, LedgerData, + // AccountLines +JSS(ledger_hit_rate); // out: GetCounts +JSS(ledger_index); // in/out: many +JSS(ledger_index_max); // in, out: AccountTx* +JSS(ledger_index_min); // in, out: AccountTx* +JSS(ledger_max); // in, out: AccountTx* +JSS(ledger_min); // in, out: AccountTx* +JSS(ledger_time); // out: NetworkOPs +JSS(LEDGER_ENTRY_TYPES); // out: RPC server_definitions + // matches definitions.json format +JSS(LEDGER_ENTRY_FLAGS); // out: RPC server_definitions +JSS(LEDGER_ENTRY_FORMATS); // out: RPC server_definitions +JSS(levels); // LogLevels +JSS(limit); // in/out: AccountTx*, AccountOffers, AccountLines, AccountObjects + // in: LedgerData, BookOffers +JSS(limit_peer); // out: AccountLines +JSS(lines); // out: AccountLines +JSS(list); // out: ValidatorList +JSS(load); // out: NetworkOPs, PeerImp +JSS(load_base); // out: NetworkOPs +JSS(load_factor); // out: NetworkOPs +JSS(load_factor_cluster); // out: NetworkOPs +JSS(load_factor_fee_escalation); // out: NetworkOPs +JSS(load_factor_fee_queue); // out: NetworkOPs +JSS(load_factor_fee_reference); // out: NetworkOPs +JSS(load_factor_local); // out: NetworkOPs +JSS(load_factor_net); // out: NetworkOPs +JSS(load_factor_server); // out: NetworkOPs +JSS(load_fee); // out: LoadFeeTrackImp, NetworkOPs +JSS(loan_broker_id); // in: LedgerEntry +JSS(loan_seq); // in: LedgerEntry +JSS(local); // out: resource/Logic.h +JSS(local_txs); // out: GetCounts +JSS(local_static_keys); // out: ValidatorList +JSS(locked); // out: GatewayBalances +JSS(low); // out: BookChanges +JSS(lowest_sequence); // out: AccountInfo +JSS(lowest_ticket); // out: AccountInfo +JSS(lp_token); // out: amm_info +JSS(majority); // out: RPC feature +JSS(manifest); // out: ValidatorInfo, Manifest +JSS(marker); // in/out: AccountTx, AccountOffers, AccountLines, AccountObjects, + // LedgerData + // in: BookOffers +JSS(master_key); // out: WalletPropose, NetworkOPs, ValidatorInfo + // in/out: Manifest +JSS(master_seed); // out: WalletPropose +JSS(master_seed_hex); // out: WalletPropose +JSS(master_signature); // out: pubManifest +JSS(max_ledger); // in/out: LedgerCleaner +JSS(max_queue_size); // out: TxQ +JSS(max_spend_drops); // out: AccountInfo +JSS(max_spend_drops_total); // out: AccountInfo +JSS(mean); // out: get_aggregate_price +JSS(median); // out: get_aggregate_price +JSS(median_fee); // out: TxQ +JSS(median_level); // out: TxQ +JSS(message); // error. +JSS(meta); // out: NetworkOPs, AccountTx*, Tx +JSS(meta_blob); // out: NetworkOPs, AccountTx*, Tx +JSS(metaData); // +JSS(metadata); // out: TransactionEntry +JSS(method); // RPC +JSS(methods); // +JSS(metrics); // out: Peers +JSS(min_count); // in: GetCounts +JSS(min_ledger); // in: LedgerCleaner +JSS(minimum_fee); // out: TxQ +JSS(minimum_level); // out: TxQ +JSS(missingCommand); // error +JSS(mpt_issuance_id_a); // out: BookChanges +JSS(mpt_issuance_id_b); // out: BookChanges +JSS(name); // out: AmendmentTableImpl, PeerImp +JSS(needed_state_hashes); // out: InboundLedger +JSS(needed_transaction_hashes); // out: InboundLedger +JSS(network_id); // out: NetworkOPs +JSS(network_ledger); // out: NetworkOPs +JSS(next_refresh_time); // out: ValidatorSite +JSS(nft_id); // in: nft_sell_offers, nft_buy_offers +JSS(nft_offer_index); // out nft_buy_offers, nft_sell_offers +JSS(nft_serial); // out: account_nfts +JSS(nft_taxon); // out: nft_info (clio) +JSS(nftoken_id); // out: insertNFTokenID +JSS(nftoken_ids); // out: insertNFTokenID +JSS(no_ripple); // out: AccountLines +JSS(no_ripple_peer); // out: AccountLines +JSS(node); // out: LedgerEntry +JSS(node_binary); // out: LedgerEntry +JSS(node_read_bytes); // out: GetCounts +JSS(node_read_errors); // out: GetCounts +JSS(node_read_retries); // out: GetCounts +JSS(node_reads_hit); // out: GetCounts +JSS(node_reads_total); // out: GetCounts +JSS(node_reads_duration_us); // out: GetCounts +JSS(node_size); // out: server_info +JSS(nodes); // out: VaultInfo +JSS(nodestore); // out: GetCounts +JSS(node_writes); // out: GetCounts +JSS(node_written_bytes); // out: GetCounts +JSS(node_writes_duration_us); // out: GetCounts +JSS(node_write_retries); // out: GetCounts +JSS(node_writes_delayed); // out::GetCounts +JSS(nth); // out: RPC server_definitions +JSS(obligations); // out: GatewayBalances +JSS(offers); // out: NetworkOPs, AccountOffers, Subscribe +JSS(offer_id); // out: insertNFTokenOfferID +JSS(offline); // in: TransactionSign +JSS(offset); // in/out: AccountTxOld +JSS(open); // out: handlers/Ledger +JSS(open_ledger_cost); // out: SubmitTransaction +JSS(open_ledger_fee); // out: TxQ +JSS(open_ledger_level); // out: TxQ +JSS(optionality); // out: server_definitions +JSS(oracles); // in: get_aggregate_price +JSS(oracle_document_id); // in: get_aggregate_price +JSS(out); // out: OverlayImpl +JSS(owner); // in: LedgerEntry, out: NetworkOPs +JSS(owner_funds); // in/out: Ledger, NetworkOPs, AcceptedLedgerTx +JSS(page_index); // +JSS(params); // RPC +JSS(parent_close_time); // out: LedgerToJson +JSS(parent_hash); // out: LedgerToJson +JSS(partition); // in: LogLevel +JSS(passphrase); // in: WalletPropose +JSS(password); // in: Subscribe +JSS(paths); // in: RipplePathFind +JSS(paths_canonical); // out: RipplePathFind +JSS(paths_computed); // out: PathRequest, RipplePathFind +JSS(peer); // in: AccountLines +JSS(peer_authorized); // out: AccountLines +JSS(peer_id); // out: RCLCxPeerPos +JSS(peers); // out: InboundLedger, handlers/Peers, Overlay +JSS(peer_disconnects); // Severed peer connection counter. +JSS(peer_disconnects_resources); // Severed peer connections because of + // excess resource consumption. +JSS(port); // in: Connect, out: NetworkOPs +JSS(ports); // out: NetworkOPs +JSS(previous); // out: Reservations +JSS(previous_ledger); // out: LedgerPropose +JSS(price); // out: amm_info, AuctionSlot +JSS(proof); // in: BookOffers +JSS(propose_seq); // out: LedgerPropose +JSS(proposers); // out: NetworkOPs, LedgerConsensus +JSS(protocol); // out: NetworkOPs, PeerImp +JSS(proxied); // out: RPC ping +JSS(pseudo_account); // out: AccountInfo +JSS(pubkey_node); // out: NetworkOPs +JSS(pubkey_publisher); // out: ValidatorList +JSS(pubkey_validator); // out: NetworkOPs, ValidatorList +JSS(public_key); // out: OverlayImpl, PeerImp, WalletPropose, ValidatorInfo + // in/out: Manifest +JSS(public_key_hex); // out: WalletPropose +JSS(published_ledger); // out: NetworkOPs +JSS(publisher_lists); // out: ValidatorList +JSS(quality); // out: NetworkOPs +JSS(quality_in); // out: AccountLines +JSS(quality_out); // out: AccountLines +JSS(queue); // in: AccountInfo +JSS(queue_data); // out: AccountInfo +JSS(queued); // out: SubmitTransaction +JSS(queued_duration_us); // +JSS(quote_asset); // in: get_aggregate_price +JSS(random); // out: Random +JSS(raw_meta); // out: AcceptedLedgerTx +JSS(receive_currencies); // out: AccountCurrencies +JSS(reference_level); // out: TxQ +JSS(refresh_interval); // in: UNL +JSS(refresh_interval_min); // out: ValidatorSites +JSS(regular_seed); // in/out: LedgerEntry +JSS(remaining); // out: ValidatorList +JSS(remote); // out: Logic.h +JSS(request); // RPC +JSS(requested); // out: Manifest +JSS(reservations); // out: Reservations +JSS(reserve_base); // out: NetworkOPs +JSS(reserve_base_xrp); // out: NetworkOPs +JSS(reserve_inc); // out: NetworkOPs +JSS(reserve_inc_xrp); // out: NetworkOPs +JSS(response); // websocket +JSS(result); // RPC +JSS(ripple_lines); // out: NetworkOPs +JSS(ripple_state); // in: LedgerEntr +JSS(ripplerpc); // XRPL RPC version +JSS(role); // out: Ping.cpp +JSS(rpc); // +JSS(rt_accounts); // in: Subscribe, Unsubscribe +JSS(running_duration_us); // +JSS(search_depth); // in: RipplePathFind +JSS(searched_all); // out: Tx +JSS(secret); // in: TransactionSign, ValidationCreate, ValidationSeed, + // channel_authorize +JSS(seed); // +JSS(seed_hex); // in: WalletPropose, TransactionSign +JSS(send_currencies); // out: AccountCurrencies +JSS(send_max); // in: PathRequest, RipplePathFind +JSS(seq); // in: LedgerEntry + // out: NetworkOPs, RPCSub, AccountOffers, ValidatorList, + // ValidatorInfo, Manifest +JSS(sequence); // in: UNL +JSS(sequence_count); // out: AccountInfo +JSS(server_domain); // out: NetworkOPs +JSS(server_state); // out: NetworkOPs +JSS(server_state_duration_us); // out: NetworkOPs +JSS(server_status); // out: NetworkOPs +JSS(server_version); // out: NetworkOPs +JSS(settle_delay); // out: AccountChannels +JSS(severity); // in: LogLevel +JSS(shares); // out: VaultInfo +JSS(signature); // out: NetworkOPs, ChannelAuthorize +JSS(signature_target); // in: TransactionSign +JSS(signature_verified); // out: ChannelVerify +JSS(signing_key); // out: NetworkOPs +JSS(signing_keys); // out: ValidatorList +JSS(signing_time); // out: NetworkOPs +JSS(signer_lists); // in/out: AccountInfo +JSS(size); // out: get_aggregate_price +JSS(snapshot); // in: Subscribe +JSS(source_account); // in: PathRequest, RipplePathFind +JSS(source_amount); // in: PathRequest, RipplePathFind +JSS(source_currencies); // in: PathRequest, RipplePathFind +JSS(source_tag); // out: AccountChannels +JSS(stand_alone); // out: NetworkOPs +JSS(standard_deviation); // out: get_aggregate_price +JSS(start); // in: TxHistory +JSS(started); // +JSS(state_accounting); // out: NetworkOPs +JSS(state_now); // in: Subscribe +JSS(status); // error +JSS(stop); // in: LedgerCleaner +JSS(stop_history_tx_only); // in: Unsubscribe, stop history tx stream +JSS(streams); // in: Subscribe, Unsubscribe +JSS(strict); // in: AccountCurrencies, AccountInfo +JSS(sub_index); // in: LedgerEntry +JSS(subcommand); // in: PathFind +JSS(subject); // in: LedgerEntry Credential +JSS(success); // rpc +JSS(supported); // out: AmendmentTableImpl +JSS(sync_mode); // in: Submit +JSS(system_time_offset); // out: NetworkOPs +JSS(tag); // out: Peers +JSS(taker); // in: Subscribe, BookOffers +JSS(taker_gets); // in: Subscribe, Unsubscribe, BookOffers +JSS(taker_gets_funded); // out: NetworkOPs +JSS(taker_pays); // in: Subscribe, Unsubscribe, BookOffers +JSS(taker_pays_funded); // out: NetworkOPs +JSS(threshold); // in: Blacklist +JSS(ticket_count); // out: AccountInfo +JSS(ticket_seq); // in: LedgerEntry +JSS(time); // +JSS(timeouts); // out: InboundLedger +JSS(time_threshold); // in/out: Oracle aggregate +JSS(time_interval); // out: AMM Auction Slot +JSS(track); // out: PeerImp +JSS(traffic); // out: Overlay +JSS(trim); // in: get_aggregate_price +JSS(trimmed_set); // out: get_aggregate_price +JSS(total); // out: counters +JSS(total_bytes_recv); // out: Peers +JSS(total_bytes_sent); // out: Peers +JSS(total_coins); // out: LedgerToJson +JSS(trading_fee); // out: amm_info +JSS(transTreeHash); // out: ledger/Ledger.cpp +JSS(transaction); // in: Tx + // out: NetworkOPs, AcceptedLedgerTx, +JSS(transaction_hash); // out: RCLCxPeerPos, LedgerToJson +JSS(transactions); // out: LedgerToJson, + // in: AccountTx*, Unsubscribe +JSS(TRANSACTION_RESULTS); // out: RPC server_definitions + // matches definitions.json format +JSS(TRANSACTION_TYPES); // out: RPC server_definitions + // matches definitions.json format +JSS(TRANSACTION_FLAGS); // out: RPC server_definitions +JSS(TRANSACTION_FORMATS); // out: RPC server_definitions +JSS(TYPES); // out: RPC server_definitions + // matches definitions.json format +JSS(transfer_rate); // out: nft_info (clio) +JSS(transitions); // out: NetworkOPs +JSS(treenode_cache_size); // out: GetCounts +JSS(treenode_track_size); // out: GetCounts +JSS(trusted); // out: UnlList +JSS(trusted_validator_keys); // out: ValidatorList +JSS(tx); // out: STTx, AccountTx* +JSS(tx_blob); // in/out: Submit, + // in: TransactionSign, AccountTx* +JSS(tx_hash); // in: TransactionEntry +JSS(tx_json); // in/out: TransactionSign + // out: TransactionEntry +JSS(tx_signing_hash); // out: TransactionSign +JSS(tx_unsigned); // out: TransactionSign +JSS(txn_count); // out: NetworkOPs +JSS(txr_tx_cnt); // out: protocol message tx's count +JSS(txr_tx_sz); // out: protocol message tx's size +JSS(txr_have_txs_cnt); // out: protocol message have tx count +JSS(txr_have_txs_sz); // out: protocol message have tx size +JSS(txr_get_ledger_cnt); // out: protocol message get ledger count +JSS(txr_get_ledger_sz); // out: protocol message get ledger size +JSS(txr_ledger_data_cnt); // out: protocol message ledger data count +JSS(txr_ledger_data_sz); // out: protocol message ledger data size +JSS(txr_transactions_cnt); // out: protocol message get object count +JSS(txr_transactions_sz); // out: protocol message get object size +JSS(txr_selected_cnt); // out: selected peers count +JSS(txr_suppressed_cnt); // out: suppressed peers count +JSS(txr_not_enabled_cnt); // out: peers with tx reduce-relay disabled count +JSS(txr_missing_tx_freq); // out: missing tx frequency average +JSS(txs); // out: TxHistory +JSS(type); // in: AccountObjects + // out: NetworkOPs, RPC server_definitions OverlayImpl, Logic +JSS(type_hex); // out: STPathSet +JSS(unl); // out: UnlList +JSS(unlimited); // out: Connection.h +JSS(uptime); // out: GetCounts +JSS(uri); // out: ValidatorSites +JSS(url); // in/out: Subscribe, Unsubscribe +JSS(url_password); // in: Subscribe +JSS(url_username); // in: Subscribe +JSS(urlgravatar); // +JSS(username); // in: Subscribe +JSS(validated); // out: NetworkOPs, RPCHelpers, AccountTx*, Tx +JSS(validator_list_expires); // out: NetworkOps, ValidatorList +JSS(validator_list); // out: NetworkOps, ValidatorList +JSS(validators); // +JSS(validated_hash); // out: NetworkOPs +JSS(validated_ledger); // out: NetworkOPs +JSS(validated_ledger_index); // out: SubmitTransaction +JSS(validated_ledgers); // out: NetworkOPs +JSS(validation_key); // out: ValidationCreate, ValidationSeed +JSS(validation_private_key); // out: ValidationCreate +JSS(validation_public_key); // out: ValidationCreate, ValidationSeed +JSS(validation_quorum); // out: NetworkOPs +JSS(validation_seed); // out: ValidationCreate, ValidationSeed +JSS(validations); // out: AmendmentTableImpl +JSS(validator_list_threshold); // out: ValidatorList +JSS(validator_sites); // out: ValidatorSites +JSS(value); // out: STAmount +JSS(vault_id); // in: VaultInfo +JSS(version); // out: RPCVersion +JSS(vetoed); // out: AmendmentTableImpl +JSS(volume_a); // out: BookChanges +JSS(volume_b); // out: BookChanges +JSS(vote); // in: Feature +JSS(vote_slots); // out: amm_info +JSS(vote_weight); // out: amm_info +JSS(warning); // rpc: +JSS(warnings); // out: server_info, server_state +JSS(workers); // +JSS(write_load); // out: GetCounts #pragma push_macro("TRANSACTION") #undef TRANSACTION diff --git a/include/xrpl/protocol/nft.h b/include/xrpl/protocol/nft.h index 4be58c381c..821d146ff7 100644 --- a/include/xrpl/protocol/nft.h +++ b/include/xrpl/protocol/nft.h @@ -39,7 +39,7 @@ constexpr std::uint16_t const flagMutable = 0x0010; inline std::uint16_t getFlags(uint256 const& id) { - std::uint16_t flags; + std::uint16_t flags = 0; memcpy(&flags, id.begin(), 2); return boost::endian::big_to_native(flags); } @@ -47,7 +47,7 @@ getFlags(uint256 const& id) inline std::uint16_t getTransferFee(uint256 const& id) { - std::uint16_t fee; + std::uint16_t fee = 0; memcpy(&fee, id.begin() + 2, 2); return boost::endian::big_to_native(fee); } @@ -55,7 +55,7 @@ getTransferFee(uint256 const& id) inline std::uint32_t getSerial(uint256 const& id) { - std::uint32_t seq; + std::uint32_t seq = 0; memcpy(&seq, id.begin() + 28, 4); return boost::endian::big_to_native(seq); } @@ -87,7 +87,7 @@ cipheredTaxon(std::uint32_t tokenSeq, Taxon taxon) inline Taxon getTaxon(uint256 const& id) { - std::uint32_t taxon; + std::uint32_t taxon = 0; memcpy(&taxon, id.begin() + 24, 4); taxon = boost::endian::big_to_native(taxon); diff --git a/include/xrpl/protocol_autogen/.clang-tidy b/include/xrpl/protocol_autogen/.clang-tidy new file mode 100644 index 0000000000..fbc003598d --- /dev/null +++ b/include/xrpl/protocol_autogen/.clang-tidy @@ -0,0 +1,3 @@ +# This disables all checks for this directory and its subdirectories +Checks: "-*" +InheritParentConfig: false diff --git a/include/xrpl/protocol_autogen/README.md b/include/xrpl/protocol_autogen/README.md index be90788b05..860ed1a242 100644 --- a/include/xrpl/protocol_autogen/README.md +++ b/include/xrpl/protocol_autogen/README.md @@ -4,42 +4,33 @@ This directory contains auto-generated C++ wrapper classes for XRP Ledger protoc ## Generated Files -The files in this directory are automatically generated at **CMake configure time** from macro definition files: +The files in this directory are generated from macro definition files: -- **Transaction classes** (in `transactions/`): Generated from `include/xrpl/protocol/detail/transactions.macro` by `scripts/generate_tx_classes.py` -- **Ledger entry classes** (in `ledger_entries/`): Generated from `include/xrpl/protocol/detail/ledger_entries.macro` by `scripts/generate_ledger_classes.py` +- **Transaction classes** (in `transactions/`): Generated from `include/xrpl/protocol/detail/transactions.macro` by `cmake/scripts/codegen/generate_tx_classes.py` +- **Ledger entry classes** (in `ledger_entries/`): Generated from `include/xrpl/protocol/detail/ledger_entries.macro` by `cmake/scripts/codegen/generate_ledger_classes.py` ## Generation Process -The generation happens automatically when you **configure** the project (not during build). When you run CMake, the system: +Generation requires a one-time setup step to create a virtual environment +and install Python dependencies, followed by running the generation target: -1. Creates a Python virtual environment in the build directory (`codegen_venv`) -2. Installs Python dependencies from `scripts/requirements.txt` into the venv (only if needed) -3. Runs the Python generation scripts using the venv Python interpreter -4. Parses the macro files to extract type definitions -5. Generates type-safe C++ wrapper classes using Mako templates -6. Places the generated headers in this directory +```bash +cmake --build . --target setup_code_gen # create venv and install dependencies (once) +cmake --build . --target code_gen # generate code +``` -### When Regeneration Happens - -The code is regenerated when: - -- You run CMake configure for the first time -- The Python virtual environment doesn't exist -- `scripts/requirements.txt` has been modified - -To force regeneration, delete the build directory and reconfigure. +By default, `CODEGEN_VENV_DIR` points to `.venv` in the project root. The +`setup_code_gen` target creates a venv there and installs the required packages. +The `code_gen` target then uses the venv's Python interpreter to run generation. ### Python Dependencies -The code generation requires the following Python packages (automatically installed): +The code generation requires the following Python packages (installed by `setup_code_gen`): - `pcpp` - C preprocessor for Python - `pyparsing` - Parser combinator library - `Mako` - Template engine -These are isolated in a virtual environment and won't affect your system Python installation. - ## Version Control The generated `.h` files **are checked into version control**. This means: @@ -50,15 +41,15 @@ The generated `.h` files **are checked into version control**. This means: ## Modifying Generated Code -**Do not manually edit generated files.** Any changes will be overwritten the next time CMake configure runs. +**Do not manually edit generated files.** Any changes will be overwritten the next time `code_gen` is run. To modify the generated classes: - Edit the macro files in `include/xrpl/protocol/detail/` -- Edit the Mako templates in `scripts/templates/` -- Edit the generation scripts in `scripts/` -- Update Python dependencies in `scripts/requirements.txt` -- Run CMake configure to regenerate +- Edit the Mako templates in `cmake/scripts/codegen/templates/` +- Edit the generation scripts in `cmake/scripts/codegen/` +- Update Python dependencies in `cmake/scripts/codegen/requirements.txt` +- Run `cmake --build . --target code_gen` to regenerate ## Adding Common Fields @@ -73,7 +64,7 @@ Base classes: Templates (update to pass required common fields to base class constructors): -- `scripts/templates/Transaction.h.mako` -- `scripts/templates/LedgerEntry.h.mako` +- `cmake/scripts/codegen/templates/Transaction.h.mako` +- `cmake/scripts/codegen/templates/LedgerEntry.h.mako` These files are **not auto-generated** and must be updated by hand. diff --git a/include/xrpl/protocol_autogen/ledger_entries/DirectoryNode.h b/include/xrpl/protocol_autogen/ledger_entries/DirectoryNode.h index 545542ec6c..4c06ac5bbb 100644 --- a/include/xrpl/protocol_autogen/ledger_entries/DirectoryNode.h +++ b/include/xrpl/protocol_autogen/ledger_entries/DirectoryNode.h @@ -117,6 +117,30 @@ public: return this->sle_->isFieldPresent(sfTakerPaysIssuer); } + /** + * @brief Get sfTakerPaysMPT (soeOPTIONAL) + * @return The field value, or std::nullopt if not present. + */ + [[nodiscard]] + protocol_autogen::Optional + getTakerPaysMPT() const + { + if (hasTakerPaysMPT()) + return this->sle_->at(sfTakerPaysMPT); + return std::nullopt; + } + + /** + * @brief Check if sfTakerPaysMPT is present. + * @return True if the field is present, false otherwise. + */ + [[nodiscard]] + bool + hasTakerPaysMPT() const + { + return this->sle_->isFieldPresent(sfTakerPaysMPT); + } + /** * @brief Get sfTakerGetsCurrency (soeOPTIONAL) * @return The field value, or std::nullopt if not present. @@ -165,6 +189,30 @@ public: return this->sle_->isFieldPresent(sfTakerGetsIssuer); } + /** + * @brief Get sfTakerGetsMPT (soeOPTIONAL) + * @return The field value, or std::nullopt if not present. + */ + [[nodiscard]] + protocol_autogen::Optional + getTakerGetsMPT() const + { + if (hasTakerGetsMPT()) + return this->sle_->at(sfTakerGetsMPT); + return std::nullopt; + } + + /** + * @brief Check if sfTakerGetsMPT is present. + * @return True if the field is present, false otherwise. + */ + [[nodiscard]] + bool + hasTakerGetsMPT() const + { + return this->sle_->isFieldPresent(sfTakerGetsMPT); + } + /** * @brief Get sfExchangeRate (soeOPTIONAL) * @return The field value, or std::nullopt if not present. @@ -427,6 +475,17 @@ public: return *this; } + /** + * @brief Set sfTakerPaysMPT (soeOPTIONAL) + * @return Reference to this builder for method chaining. + */ + DirectoryNodeBuilder& + setTakerPaysMPT(std::decay_t const& value) + { + object_[sfTakerPaysMPT] = value; + return *this; + } + /** * @brief Set sfTakerGetsCurrency (soeOPTIONAL) * @return Reference to this builder for method chaining. @@ -449,6 +508,17 @@ public: return *this; } + /** + * @brief Set sfTakerGetsMPT (soeOPTIONAL) + * @return Reference to this builder for method chaining. + */ + DirectoryNodeBuilder& + setTakerGetsMPT(std::decay_t const& value) + { + object_[sfTakerGetsMPT] = value; + return *this; + } + /** * @brief Set sfExchangeRate (soeOPTIONAL) * @return Reference to this builder for method chaining. diff --git a/include/xrpl/protocol_autogen/transactions/AMMBid.h b/include/xrpl/protocol_autogen/transactions/AMMBid.h index d3f8cba8f7..4e5c5d1d15 100644 --- a/include/xrpl/protocol_autogen/transactions/AMMBid.h +++ b/include/xrpl/protocol_autogen/transactions/AMMBid.h @@ -49,6 +49,7 @@ public: /** * @brief Get sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -60,6 +61,7 @@ public: /** * @brief Get sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -192,6 +194,7 @@ public: /** * @brief Set sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMBidBuilder& @@ -203,6 +206,7 @@ public: /** * @brief Set sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMBidBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/AMMClawback.h b/include/xrpl/protocol_autogen/transactions/AMMClawback.h index 9603cad6ef..3a968f34d2 100644 --- a/include/xrpl/protocol_autogen/transactions/AMMClawback.h +++ b/include/xrpl/protocol_autogen/transactions/AMMClawback.h @@ -21,7 +21,7 @@ class AMMClawbackBuilder; * Type: ttAMM_CLAWBACK (31) * Delegable: Delegation::delegable * Amendment: featureAMMClawback - * Privileges: mayDeleteAcct | overrideFreeze + * Privileges: mayDeleteAcct | overrideFreeze | mayAuthorizeMPT * * Immutable wrapper around STTx providing type-safe field access. * Use AMMClawbackBuilder to construct new transactions. @@ -60,6 +60,7 @@ public: /** * @brief Get sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -71,6 +72,7 @@ public: /** * @brief Get sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -82,6 +84,7 @@ public: /** * @brief Get sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] @@ -166,6 +169,7 @@ public: /** * @brief Set sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMClawbackBuilder& @@ -177,6 +181,7 @@ public: /** * @brief Set sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMClawbackBuilder& @@ -188,6 +193,7 @@ public: /** * @brief Set sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMClawbackBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/AMMCreate.h b/include/xrpl/protocol_autogen/transactions/AMMCreate.h index 311d19a3c4..ad6a253ffc 100644 --- a/include/xrpl/protocol_autogen/transactions/AMMCreate.h +++ b/include/xrpl/protocol_autogen/transactions/AMMCreate.h @@ -21,7 +21,7 @@ class AMMCreateBuilder; * Type: ttAMM_CREATE (35) * Delegable: Delegation::delegable * Amendment: featureAMM - * Privileges: createPseudoAcct + * Privileges: createPseudoAcct | mayCreateMPT * * Immutable wrapper around STTx providing type-safe field access. * Use AMMCreateBuilder to construct new transactions. @@ -49,6 +49,7 @@ public: /** * @brief Get sfAmount (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -60,6 +61,7 @@ public: /** * @brief Get sfAmount2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -129,6 +131,7 @@ public: /** * @brief Set sfAmount (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMCreateBuilder& @@ -140,6 +143,7 @@ public: /** * @brief Set sfAmount2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMCreateBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/AMMDelete.h b/include/xrpl/protocol_autogen/transactions/AMMDelete.h index bc61434d0b..3325ee63b3 100644 --- a/include/xrpl/protocol_autogen/transactions/AMMDelete.h +++ b/include/xrpl/protocol_autogen/transactions/AMMDelete.h @@ -21,7 +21,7 @@ class AMMDeleteBuilder; * Type: ttAMM_DELETE (40) * Delegable: Delegation::delegable * Amendment: featureAMM - * Privileges: mustDeleteAcct + * Privileges: mustDeleteAcct | mayDeleteMPT * * Immutable wrapper around STTx providing type-safe field access. * Use AMMDeleteBuilder to construct new transactions. @@ -49,6 +49,7 @@ public: /** * @brief Get sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -60,6 +61,7 @@ public: /** * @brief Get sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -116,6 +118,7 @@ public: /** * @brief Set sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMDeleteBuilder& @@ -127,6 +130,7 @@ public: /** * @brief Set sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMDeleteBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/AMMDeposit.h b/include/xrpl/protocol_autogen/transactions/AMMDeposit.h index 8e86339b0a..bb9a36d218 100644 --- a/include/xrpl/protocol_autogen/transactions/AMMDeposit.h +++ b/include/xrpl/protocol_autogen/transactions/AMMDeposit.h @@ -49,6 +49,7 @@ public: /** * @brief Get sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -60,6 +61,7 @@ public: /** * @brief Get sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -71,6 +73,7 @@ public: /** * @brief Get sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] @@ -97,6 +100,7 @@ public: /** * @brief Get sfAmount2 (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] @@ -246,6 +250,7 @@ public: /** * @brief Set sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMDepositBuilder& @@ -257,6 +262,7 @@ public: /** * @brief Set sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMDepositBuilder& @@ -268,6 +274,7 @@ public: /** * @brief Set sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMDepositBuilder& @@ -279,6 +286,7 @@ public: /** * @brief Set sfAmount2 (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMDepositBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/AMMVote.h b/include/xrpl/protocol_autogen/transactions/AMMVote.h index a4e58c9aa4..3baa3f6d41 100644 --- a/include/xrpl/protocol_autogen/transactions/AMMVote.h +++ b/include/xrpl/protocol_autogen/transactions/AMMVote.h @@ -49,6 +49,7 @@ public: /** * @brief Get sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -60,6 +61,7 @@ public: /** * @brief Get sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -129,6 +131,7 @@ public: /** * @brief Set sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMVoteBuilder& @@ -140,6 +143,7 @@ public: /** * @brief Set sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMVoteBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/AMMWithdraw.h b/include/xrpl/protocol_autogen/transactions/AMMWithdraw.h index da19c546ee..99f82b69c8 100644 --- a/include/xrpl/protocol_autogen/transactions/AMMWithdraw.h +++ b/include/xrpl/protocol_autogen/transactions/AMMWithdraw.h @@ -21,7 +21,7 @@ class AMMWithdrawBuilder; * Type: ttAMM_WITHDRAW (37) * Delegable: Delegation::delegable * Amendment: featureAMM - * Privileges: mayDeleteAcct + * Privileges: mayDeleteAcct | mayAuthorizeMPT * * Immutable wrapper around STTx providing type-safe field access. * Use AMMWithdrawBuilder to construct new transactions. @@ -49,6 +49,7 @@ public: /** * @brief Get sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -60,6 +61,7 @@ public: /** * @brief Get sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -71,6 +73,7 @@ public: /** * @brief Get sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] @@ -97,6 +100,7 @@ public: /** * @brief Get sfAmount2 (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] @@ -220,6 +224,7 @@ public: /** * @brief Set sfAsset (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMWithdrawBuilder& @@ -231,6 +236,7 @@ public: /** * @brief Set sfAsset2 (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMWithdrawBuilder& @@ -242,6 +248,7 @@ public: /** * @brief Set sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMWithdrawBuilder& @@ -253,6 +260,7 @@ public: /** * @brief Set sfAmount2 (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ AMMWithdrawBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/CheckCash.h b/include/xrpl/protocol_autogen/transactions/CheckCash.h index 2a2bc9c7af..34dc91c61b 100644 --- a/include/xrpl/protocol_autogen/transactions/CheckCash.h +++ b/include/xrpl/protocol_autogen/transactions/CheckCash.h @@ -21,7 +21,7 @@ class CheckCashBuilder; * Type: ttCHECK_CASH (17) * Delegable: Delegation::delegable * Amendment: uint256{} - * Privileges: noPriv + * Privileges: mayCreateMPT * * Immutable wrapper around STTx providing type-safe field access. * Use CheckCashBuilder to construct new transactions. @@ -60,6 +60,7 @@ public: /** * @brief Get sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] @@ -86,6 +87,7 @@ public: /** * @brief Get sfDeliverMin (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value, or std::nullopt if not present. */ [[nodiscard]] @@ -166,6 +168,7 @@ public: /** * @brief Set sfAmount (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ CheckCashBuilder& @@ -177,6 +180,7 @@ public: /** * @brief Set sfDeliverMin (soeOPTIONAL) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ CheckCashBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/CheckCreate.h b/include/xrpl/protocol_autogen/transactions/CheckCreate.h index ba209a7fc4..f5e2ad23a9 100644 --- a/include/xrpl/protocol_autogen/transactions/CheckCreate.h +++ b/include/xrpl/protocol_autogen/transactions/CheckCreate.h @@ -60,6 +60,7 @@ public: /** * @brief Get sfSendMax (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -205,6 +206,7 @@ public: /** * @brief Set sfSendMax (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ CheckCreateBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/OfferCreate.h b/include/xrpl/protocol_autogen/transactions/OfferCreate.h index a0eff385f6..2735eb85f7 100644 --- a/include/xrpl/protocol_autogen/transactions/OfferCreate.h +++ b/include/xrpl/protocol_autogen/transactions/OfferCreate.h @@ -21,7 +21,7 @@ class OfferCreateBuilder; * Type: ttOFFER_CREATE (7) * Delegable: Delegation::delegable * Amendment: uint256{} - * Privileges: noPriv + * Privileges: mayCreateMPT * * Immutable wrapper around STTx providing type-safe field access. * Use OfferCreateBuilder to construct new transactions. @@ -49,6 +49,7 @@ public: /** * @brief Get sfTakerPays (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -60,6 +61,7 @@ public: /** * @brief Get sfTakerGets (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return The field value. */ [[nodiscard]] @@ -194,6 +196,7 @@ public: /** * @brief Set sfTakerPays (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ OfferCreateBuilder& @@ -205,6 +208,7 @@ public: /** * @brief Set sfTakerGets (soeREQUIRED) + * @note This field supports MPT (Multi-Purpose Token) amounts. * @return Reference to this builder for method chaining. */ OfferCreateBuilder& diff --git a/include/xrpl/protocol_autogen/transactions/Payment.h b/include/xrpl/protocol_autogen/transactions/Payment.h index 877286f90e..edf496dc6d 100644 --- a/include/xrpl/protocol_autogen/transactions/Payment.h +++ b/include/xrpl/protocol_autogen/transactions/Payment.h @@ -21,7 +21,7 @@ class PaymentBuilder; * Type: ttPAYMENT (0) * Delegable: Delegation::delegable * Amendment: uint256{} - * Privileges: createAcct + * Privileges: createAcct | mayCreateMPT * * Immutable wrapper around STTx providing type-safe field access. * Use PaymentBuilder to construct new transactions. diff --git a/include/xrpl/rdb/DatabaseCon.h b/include/xrpl/rdb/DatabaseCon.h index bd7b9ca803..7400593214 100644 --- a/include/xrpl/rdb/DatabaseCon.h +++ b/include/xrpl/rdb/DatabaseCon.h @@ -14,7 +14,7 @@ namespace soci { class session; -} +} // namespace soci namespace xrpl { diff --git a/include/xrpl/rdb/RelationalDatabase.h b/include/xrpl/rdb/RelationalDatabase.h index 56c20e4263..1c28ddec0a 100644 --- a/include/xrpl/rdb/RelationalDatabase.h +++ b/include/xrpl/rdb/RelationalDatabase.h @@ -51,19 +51,19 @@ public: AccountID const& account; /// Ledger sequence range to search. A value of 0 for min or max /// means unbounded in that direction (no constraint applied). - LedgerRange ledgerRange; - std::uint32_t offset; - std::uint32_t limit; - bool bUnlimited; + LedgerRange ledgerRange{}; + std::uint32_t offset = 0; + std::uint32_t limit = 0; + bool bUnlimited{}; }; struct AccountTxPageOptions { AccountID const& account; - LedgerRange ledgerRange; + LedgerRange ledgerRange{}; std::optional marker; - std::uint32_t limit; - bool bAdmin; + std::uint32_t limit = 0; + bool bAdmin = false; }; using AccountTx = std::pair, std::shared_ptr>; @@ -88,8 +88,8 @@ public: struct AccountTxResult { std::variant transactions; - LedgerRange ledgerRange; - uint32_t limit; + LedgerRange ledgerRange{}; + uint32_t limit = 0; std::optional marker; }; diff --git a/include/xrpl/rdb/SociDB.h b/include/xrpl/rdb/SociDB.h index 83758677b9..9c575359c1 100644 --- a/include/xrpl/rdb/SociDB.h +++ b/include/xrpl/rdb/SociDB.h @@ -25,7 +25,7 @@ namespace sqlite_api { struct sqlite3; -} +} // namespace sqlite_api namespace xrpl { diff --git a/include/xrpl/resource/Fees.h b/include/xrpl/resource/Fees.h index 0ba083d4fe..ebda0e98db 100644 --- a/include/xrpl/resource/Fees.h +++ b/include/xrpl/resource/Fees.h @@ -5,38 +5,30 @@ namespace xrpl { namespace Resource { -// clang-format off /** Schedule of fees charged for imposing load on the server. */ /** @{ */ -extern Charge const feeMalformedRequest; // A request that we can immediately - // tell is invalid -extern Charge const feeRequestNoReply; // A request that we cannot satisfy -extern Charge const feeInvalidSignature; // An object whose signature we had - // to check and it failed -extern Charge const feeUselessData; // Data we have no use for -extern Charge const feeInvalidData; // Data we have to verify before - // rejecting +extern Charge const feeMalformedRequest; // A request that we can immediately tell is invalid. +extern Charge const feeRequestNoReply; // A request that we cannot satisfy. +extern Charge const feeInvalidSignature; // An object whose signature we had to check that failed. +extern Charge const feeUselessData; // Data we have no use for. +extern Charge const feeInvalidData; // Data we have to verify before rejecting. // RPC loads -extern Charge const feeMalformedRPC; // An RPC request that we can - // immediately tell is invalid. -extern Charge const feeReferenceRPC; // A default "reference" unspecified - // load -extern Charge const feeExceptionRPC; // RPC load that causes an exception -extern Charge const feeMediumBurdenRPC; // A somewhat burdensome RPC load -extern Charge const feeHeavyBurdenRPC; // A very burdensome RPC load +extern Charge const feeMalformedRPC; // An RPC request that we can immediately tell is invalid. +extern Charge const feeReferenceRPC; // A default "reference" unspecified load. +extern Charge const feeExceptionRPC; // RPC load that causes an exception. +extern Charge const feeMediumBurdenRPC; // A somewhat burdensome RPC load. +extern Charge const feeHeavyBurdenRPC; // A very burdensome RPC load. // Peer loads -extern Charge const feeTrivialPeer; // Requires no reply -extern Charge const feeModerateBurdenPeer; // Requires some work -extern Charge const feeHeavyBurdenPeer; // Extensive work +extern Charge const feeTrivialPeer; // Requires no reply. +extern Charge const feeModerateBurdenPeer; // Requires some work. +extern Charge const feeHeavyBurdenPeer; // Extensive work. // Administrative -extern Charge const feeWarning; // The cost of receiving a warning -extern Charge const feeDrop; // The cost of being dropped for - // excess load +extern Charge const feeWarning; // The cost of receiving a warning. +extern Charge const feeDrop; // The cost of being dropped for excess load. /** @} */ -// clang-format on } // namespace Resource } // namespace xrpl diff --git a/include/xrpl/resource/Gossip.h b/include/xrpl/resource/Gossip.h index e581145149..9a70309cc4 100644 --- a/include/xrpl/resource/Gossip.h +++ b/include/xrpl/resource/Gossip.h @@ -17,7 +17,7 @@ struct Gossip { explicit Item() = default; - int balance; + int balance{}; beast::IP::Endpoint address; }; diff --git a/include/xrpl/resource/README.md b/include/xrpl/resource/README.md index e525ce83e3..545d4e9ca0 100644 --- a/include/xrpl/resource/README.md +++ b/include/xrpl/resource/README.md @@ -17,7 +17,7 @@ performed, or simply disconnecting the endpoint. Currently, consumption endpoints include websocket connections used to service clients, and peer connections used to create the peer to peer -overlay network implementing the Ripple protocol. +overlay network implementing the XRPL protocol. The current "balance" of a Consumer represents resource consumption debt or credit. Debt is accrued when bad loads are imposed. Credit is @@ -72,6 +72,6 @@ drop connections to those IP addresses that occur commonly in the gossip. ## Access -In rippled, the Application holds a unique instance of Resource::Manager, +In xrpld, the Application holds a unique instance of Resource::Manager, which may be retrieved by calling the method `Application::getResourceManager()`. diff --git a/include/xrpl/resource/detail/Entry.h b/include/xrpl/resource/detail/Entry.h index ecff8828af..2e71b7cf17 100644 --- a/include/xrpl/resource/detail/Entry.h +++ b/include/xrpl/resource/detail/Entry.h @@ -22,7 +22,7 @@ struct Entry : public beast::List::Node @param now Construction time of Entry. */ explicit Entry(clock_type::time_point const now) - : refcount(0), local_balance(now), remote_balance(0), lastWarningTime(), whenExpires() + : refcount(0), local_balance(now), remote_balance(0) { } @@ -62,7 +62,7 @@ struct Entry : public beast::List::Node std::optional publicKey; // Back pointer to the map key (bit of a hack here) - Key const* key; + Key const* key{}; // Number of Consumer references int refcount; diff --git a/include/xrpl/resource/detail/Import.h b/include/xrpl/resource/detail/Import.h index 790fc0596a..0377910990 100644 --- a/include/xrpl/resource/detail/Import.h +++ b/include/xrpl/resource/detail/Import.h @@ -13,12 +13,12 @@ struct Import { explicit Item() = default; - int balance; + int balance{}; Consumer consumer; }; // Dummy argument required for zero-copy construction - Import(int = 0) : whenExpires() + Import(int = 0) { } diff --git a/include/xrpl/resource/detail/Logic.h b/include/xrpl/resource/detail/Logic.h index 9a7959f481..0682c4a7e9 100644 --- a/include/xrpl/resource/detail/Logic.h +++ b/include/xrpl/resource/detail/Logic.h @@ -93,7 +93,7 @@ public: Entry* entry(nullptr); { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); auto [resultIt, resultInserted] = table_.emplace( std::piecewise_construct, std::make_tuple(kindInbound, address.at_port(0)), // Key @@ -123,7 +123,7 @@ public: Entry* entry(nullptr); { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); auto [resultIt, resultInserted] = table_.emplace( std::piecewise_construct, std::make_tuple(kindOutbound, address), // Key @@ -156,7 +156,7 @@ public: Entry* entry(nullptr); { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); auto [resultIt, resultInserted] = table_.emplace( std::piecewise_construct, std::make_tuple(kindUnlimited, address.at_port(1)), // Key @@ -191,11 +191,11 @@ public: clock_type::time_point const now(m_clock.now()); Json::Value ret(Json::objectValue); - std::lock_guard _(lock_); + std::lock_guard const _(lock_); for (auto& inboundEntry : inbound_) { - int localBalance = inboundEntry.local_balance.value(now); + int const localBalance = inboundEntry.local_balance.value(now); if ((localBalance + inboundEntry.remote_balance) >= threshold) { Json::Value& entry = (ret[inboundEntry.to_string()] = Json::objectValue); @@ -206,7 +206,7 @@ public: } for (auto& outboundEntry : outbound_) { - int localBalance = outboundEntry.local_balance.value(now); + int const localBalance = outboundEntry.local_balance.value(now); if ((localBalance + outboundEntry.remote_balance) >= threshold) { Json::Value& entry = (ret[outboundEntry.to_string()] = Json::objectValue); @@ -217,7 +217,7 @@ public: } for (auto& adminEntry : admin_) { - int localBalance = adminEntry.local_balance.value(now); + int const localBalance = adminEntry.local_balance.value(now); if ((localBalance + adminEntry.remote_balance) >= threshold) { Json::Value& entry = (ret[adminEntry.to_string()] = Json::objectValue); @@ -236,7 +236,7 @@ public: clock_type::time_point const now(m_clock.now()); Gossip gossip; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); gossip.items.reserve(inbound_.size()); @@ -261,7 +261,7 @@ public: { auto const elapsed = m_clock.now(); { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); auto [resultIt, resultInserted] = importTable_.emplace( std::piecewise_construct, std::make_tuple(origin), // Key @@ -318,7 +318,7 @@ public: void periodicActivity() { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); auto const elapsed = m_clock.now(); @@ -352,7 +352,9 @@ public: iter = importTable_.erase(iter); } else + { ++iter; + } } } @@ -374,7 +376,7 @@ public: void erase(Table::iterator iter) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); Entry& entry(iter->second); XRPL_ASSERT(entry.refcount == 0, "xrpl::Resource::Logic::erase : entry not used"); inactive_.erase(inactive_.iterator_to(entry)); @@ -384,14 +386,14 @@ public: void acquire(Entry& entry) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); ++entry.refcount; } void release(Entry& entry) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); if (--entry.refcount == 0) { JLOG(m_journal.debug()) << "Inactive " << entry; @@ -442,7 +444,7 @@ public: if (!context.empty()) context = " (" + context + ")"; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); clock_type::time_point const now(m_clock.now()); int const balance(entry.add(fee.cost(), now)); JLOG(getStream(fee.cost(), m_journal)) << "Charging " << entry << " for " << fee << context; @@ -455,7 +457,7 @@ public: if (entry.isUnlimited()) return false; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); bool notify(false); auto const elapsed = m_clock.now(); if (entry.balance(m_clock.now()) >= warningThreshold && elapsed != entry.lastWarningTime) @@ -478,7 +480,7 @@ public: if (entry.isUnlimited()) return false; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); bool drop(false); clock_type::time_point const now(m_clock.now()); int const balance(entry.balance(now)); @@ -500,13 +502,13 @@ public: int balance(Entry& entry) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); return entry.balance(m_clock.now()); } //-------------------------------------------------------------------------- - void + static void writeList( clock_type::time_point const now, beast::PropertyStream::Set& items, @@ -529,7 +531,7 @@ public: { clock_type::time_point const now(m_clock.now()); - std::lock_guard _(lock_); + std::lock_guard const _(lock_); { beast::PropertyStream::Set s("inbound", map); diff --git a/include/xrpl/server/LoadFeeTrack.h b/include/xrpl/server/LoadFeeTrack.h index fc031a1833..6b9e96241c 100644 --- a/include/xrpl/server/LoadFeeTrack.h +++ b/include/xrpl/server/LoadFeeTrack.h @@ -26,10 +26,6 @@ class LoadFeeTrack final public: explicit LoadFeeTrack(beast::Journal journal = beast::Journal(beast::Journal::getNullSink())) : j_(journal) - , localTxnLoadFee_(lftNormalFee) - , remoteTxnLoadFee_(lftNormalFee) - , clusterTxnLoadFee_(lftNormalFee) - , raiseCount_(0) { } @@ -39,33 +35,33 @@ public: setRemoteFee(std::uint32_t f) { JLOG(j_.trace()) << "setRemoteFee: " << f; - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); remoteTxnLoadFee_ = f; } std::uint32_t getRemoteFee() const { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); return remoteTxnLoadFee_; } std::uint32_t getLocalFee() const { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); return localTxnLoadFee_; } std::uint32_t getClusterFee() const { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); return clusterTxnLoadFee_; } - std::uint32_t - getLoadBase() const + static std::uint32_t + getLoadBase() { return lftNormalFee; } @@ -73,14 +69,14 @@ public: std::uint32_t getLoadFactor() const { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); return std::max({clusterTxnLoadFee_, localTxnLoadFee_, remoteTxnLoadFee_}); } std::pair getScalingFactors() const { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); return std::make_pair( std::max(localTxnLoadFee_, remoteTxnLoadFee_), @@ -91,7 +87,7 @@ public: setClusterFee(std::uint32_t fee) { JLOG(j_.trace()) << "setClusterFee: " << fee; - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); clusterTxnLoadFee_ = fee; } @@ -103,14 +99,14 @@ public: bool isLoadedLocal() const { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); return (raiseCount_ != 0) || (localTxnLoadFee_ != lftNormalFee); } bool isLoadedCluster() const { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); return (raiseCount_ != 0) || (localTxnLoadFee_ != lftNormalFee) || (clusterTxnLoadFee_ != lftNormalFee); } @@ -124,10 +120,10 @@ private: beast::Journal const j_; std::mutex mutable lock_; - std::uint32_t localTxnLoadFee_; // Scale factor, lftNormalFee = normal fee - std::uint32_t remoteTxnLoadFee_; // Scale factor, lftNormalFee = normal fee - std::uint32_t clusterTxnLoadFee_; // Scale factor, lftNormalFee = normal fee - std::uint32_t raiseCount_; + std::uint32_t localTxnLoadFee_{lftNormalFee}; // Scale factor, lftNormalFee = normal fee + std::uint32_t remoteTxnLoadFee_{lftNormalFee}; // Scale factor, lftNormalFee = normal fee + std::uint32_t clusterTxnLoadFee_{lftNormalFee}; // Scale factor, lftNormalFee = normal fee + std::uint32_t raiseCount_{0}; }; //------------------------------------------------------------------------------ diff --git a/include/xrpl/server/Manifest.h b/include/xrpl/server/Manifest.h index 7f1bba921e..2532a3c5bf 100644 --- a/include/xrpl/server/Manifest.h +++ b/include/xrpl/server/Manifest.h @@ -15,9 +15,9 @@ namespace xrpl { Validator key manifests ----------------------- - Suppose the secret keys installed on a Ripple validator are compromised. Not + Suppose the secret keys installed on an XRPL validator are compromised. Not only do you have to generate and install new key pairs on each validator, - EVERY rippled needs to have its config updated with the new public keys, and + EVERY xrpld needs to have its config updated with the new public keys, and is vulnerable to forged validation signatures until this is done. The solution is a new layer of indirection: A master secret key under restrictive access control is used to sign a "manifest": essentially, a @@ -39,11 +39,11 @@ namespace xrpl { seen for that validator, if any. On startup, the [validator_token] config entry (which contains the manifest for this validator) is decoded and added to the manifest cache. Other manifests are added as "gossip" - received from rippled peers. + received from xrpld peers. When an ephemeral key is compromised, a new signing key pair is created, along with a new manifest vouching for it (with a higher sequence number), - signed by the master key. When a rippled peer receives the new manifest, + signed by the master key. When an xrpld peer receives the new manifest, it verifies it with the master key and (assuming it's valid) discards the old ephemeral key and stores the new one. If the master key itself gets compromised, a manifest with sequence number 0xFFFFFFFF will supersede a @@ -401,7 +401,7 @@ public: void for_each_manifest(Function&& f) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; for (auto const& [_, manifest] : map_) { (void)_; @@ -429,7 +429,7 @@ public: void for_each_manifest(PreFun&& pf, EachFun&& f) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; pf(map_.size()); for (auto const& [_, manifest] : map_) { diff --git a/include/xrpl/server/NetworkOPs.h b/include/xrpl/server/NetworkOPs.h index 75f1e0e1b2..b8f50dcd42 100644 --- a/include/xrpl/server/NetworkOPs.h +++ b/include/xrpl/server/NetworkOPs.h @@ -63,8 +63,8 @@ enum class OperatingMode { needed. A backend application or local client can trust a local instance of - rippled / NetworkOPs. However, client software connecting to non-local - instances of rippled will need to be hardened to protect against hostile + xrpld / NetworkOPs. However, client software connecting to non-local + instances of xrpld will need to be hardened to protect against hostile or unreliable servers. */ class NetworkOPs : public InfoSub::Source @@ -73,7 +73,7 @@ public: using clock_type = beast::abstract_clock; enum class FailHard : unsigned char { no, yes }; - static inline FailHard + static FailHard doFailHard(bool noMeansDont) { return noMeansDont ? FailHard::yes : FailHard::no; diff --git a/include/xrpl/server/Port.h b/include/xrpl/server/Port.h index 1dfa93b0a7..c7acabbc85 100644 --- a/include/xrpl/server/Port.h +++ b/include/xrpl/server/Port.h @@ -19,7 +19,7 @@ namespace boost { namespace asio { namespace ssl { class context; -} +} // namespace ssl } // namespace asio } // namespace boost @@ -54,7 +54,7 @@ struct Port int limit = 0; // Websocket disconnects if send queue exceeds this limit - std::uint16_t ws_queue_limit; + std::uint16_t ws_queue_limit{}; // Returns `true` if any websocket protocols are specified bool @@ -90,7 +90,7 @@ struct ParsedPort std::string ssl_ciphers; boost::beast::websocket::permessage_deflate pmd_options; int limit = 0; - std::uint16_t ws_queue_limit; + std::uint16_t ws_queue_limit{}; std::optional ip; std::optional port; diff --git a/include/xrpl/server/State.h b/include/xrpl/server/State.h index 48e11869f4..c3cc4f609c 100644 --- a/include/xrpl/server/State.h +++ b/include/xrpl/server/State.h @@ -12,7 +12,7 @@ struct SavedState { std::string writableDb; std::string archiveDb; - LedgerIndex lastRotated; + LedgerIndex lastRotated{}; }; /** diff --git a/include/xrpl/server/detail/BaseHTTPPeer.h b/include/xrpl/server/detail/BaseHTTPPeer.h index f900261b84..1e68d5c81c 100644 --- a/include/xrpl/server/detail/BaseHTTPPeer.h +++ b/include/xrpl/server/detail/BaseHTTPPeer.h @@ -48,14 +48,14 @@ protected: struct buffer { - buffer(void const* ptr, std::size_t len) : data(new char[len]), bytes(len), used(0) + buffer(void const* ptr, std::size_t len) : data(new char[len]), bytes(len) { memcpy(data.get(), ptr, len); } std::unique_ptr data; std::size_t bytes; - std::size_t used; + std::size_t used{0}; }; Port const& port_; @@ -219,10 +219,12 @@ void BaseHTTPPeer::close() { if (!strand_.running_in_this_thread()) + { return post( strand_, std::bind( (void (BaseHTTPPeer::*)(void))&BaseHTTPPeer::close, impl().shared_from_this())); + } boost::beast::get_lowest_layer(impl().stream_).close(); } @@ -300,7 +302,7 @@ BaseHTTPPeer::on_write(error_code const& ec, std::size_t bytes_tr return fail(ec, "write"); bytes_out_ += bytes_transferred; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); wq2_.clear(); wq2_.reserve(wq_.size()); std::swap(wq2_, wq_); @@ -392,17 +394,18 @@ BaseHTTPPeer::write(void const* buf, std::size_t bytes) if (bytes == 0) return; if ([&] { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); wq_.emplace_back(buf, bytes); return wq_.size() == 1 && wq2_.size() == 0; }()) { if (!strand_.running_in_this_thread()) + { return post( strand_, std::bind(&BaseHTTPPeer::on_write, impl().shared_from_this(), error_code{}, 0)); - else - return on_write(error_code{}, 0); + } + return on_write(error_code{}, 0); } } @@ -436,14 +439,16 @@ void BaseHTTPPeer::complete() { if (!strand_.running_in_this_thread()) + { return post( strand_, std::bind(&BaseHTTPPeer::complete, impl().shared_from_this())); + } message_ = {}; complete_ = true; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (!wq_.empty() && !wq2_.empty()) return; } @@ -464,19 +469,21 @@ void BaseHTTPPeer::close(bool graceful) { if (!strand_.running_in_this_thread()) + { return post( strand_, std::bind( (void (BaseHTTPPeer::*)(bool))&BaseHTTPPeer::close, impl().shared_from_this(), graceful)); + } complete_ = true; if (graceful) { graceful_ = true; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (!wq_.empty() || !wq2_.empty()) return; } diff --git a/include/xrpl/server/detail/BasePeer.h b/include/xrpl/server/detail/BasePeer.h index afa1ceb993..35c6acb198 100644 --- a/include/xrpl/server/detail/BasePeer.h +++ b/include/xrpl/server/detail/BasePeer.h @@ -34,6 +34,7 @@ protected: boost::asio::strand strand_; public: + // NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility) BasePeer( Port const& port, Handler& handler, diff --git a/include/xrpl/server/detail/BaseWSPeer.h b/include/xrpl/server/detail/BaseWSPeer.h index f415520e59..51e089fde5 100644 --- a/include/xrpl/server/detail/BaseWSPeer.h +++ b/include/xrpl/server/detail/BaseWSPeer.h @@ -285,6 +285,7 @@ BaseWSPeer::on_write(error_code const& ec) return; start_timer(); if (!result.first) + { impl().ws_.async_write_some( static_cast(result.first), result.second, @@ -292,7 +293,9 @@ BaseWSPeer::on_write(error_code const& ec) strand_, std::bind( &BaseWSPeer::on_write, impl().shared_from_this(), std::placeholders::_1))); + } else + { impl().ws_.async_write_some( static_cast(result.first), result.second, @@ -300,6 +303,7 @@ BaseWSPeer::on_write(error_code const& ec) strand_, std::bind( &BaseWSPeer::on_write_fin, impl().shared_from_this(), std::placeholders::_1))); + } } template @@ -319,7 +323,9 @@ BaseWSPeer::on_write_fin(error_code const& ec) &BaseWSPeer::on_close, impl().shared_from_this(), std::placeholders::_1))); } else if (!wq_.empty()) + { on_write({}); + } } template @@ -392,7 +398,7 @@ BaseWSPeer::cancel_timer() { timer_.cancel(); } - catch (boost::system::system_error const&) + catch (boost::system::system_error const&) // NOLINT(bugprone-empty-catch) { // ignored } @@ -418,7 +424,7 @@ BaseWSPeer::on_ping_pong( { if (kind == boost::beast::websocket::frame_type::pong) { - boost::beast::string_view p(payload_.begin()); + boost::beast::string_view const p(payload_.begin()); if (payload == p) { close_on_timer_ = false; diff --git a/include/xrpl/server/detail/Door.h b/include/xrpl/server/detail/Door.h index f977dc6002..6194e62d3c 100644 --- a/include/xrpl/server/detail/Door.h +++ b/include/xrpl/server/detail/Door.h @@ -88,8 +88,12 @@ private: boost::asio::io_context& ioc_; acceptor_type acceptor_; boost::asio::strand strand_; - bool ssl_; - bool plain_; + bool ssl_{ + port_.protocol.count("https") > 0 || port_.protocol.count("wss") > 0 || + port_.protocol.count("wss2") > 0 || port_.protocol.count("peer") > 0}; + bool plain_{ + port_.protocol.count("http") > 0 || port_.protocol.count("ws") > 0 || + (port_.protocol.count("ws2") != 0u)}; static constexpr std::chrono::milliseconds INITIAL_ACCEPT_DELAY{50}; static constexpr std::chrono::milliseconds MAX_ACCEPT_DELAY{2000}; std::chrono::milliseconds accept_delay_{INITIAL_ACCEPT_DELAY}; @@ -274,12 +278,6 @@ Door::Door( , ioc_(io_context) , acceptor_(io_context) , strand_(boost::asio::make_strand(io_context)) - , ssl_( - port_.protocol.count("https") > 0 || port_.protocol.count("wss") > 0 || - port_.protocol.count("wss2") > 0 || port_.protocol.count("peer") > 0) - , plain_( - port_.protocol.count("http") > 0 || port_.protocol.count("ws") > 0 || - port_.protocol.count("ws2")) , backoff_timer_(io_context) { reOpen(); @@ -299,8 +297,10 @@ void Door::close() { if (!strand_.running_in_this_thread()) + { return boost::asio::post( strand_, std::bind(&Door::close, this->shared_from_this())); + } backoff_timer_.cancel(); error_code ec; acceptor_.close(ec); @@ -397,7 +397,7 @@ Door::query_fd_stats() const return std::nullopt; #else FDStats s; - struct rlimit rl; + struct rlimit rl{}; if (getrlimit(RLIMIT_NOFILE, &rl) != 0 || rl.rlim_cur == RLIM_INFINITY) return std::nullopt; s.limit = static_cast(rl.rlim_cur); @@ -434,11 +434,7 @@ Door::should_throttle_for_fds() auto const& s = *stats; auto const free = (s.limit > s.used) ? (s.limit - s.used) : 0ull; double const free_ratio = static_cast(free) / static_cast(s.limit); - if (free_ratio < FREE_FD_THRESHOLD) - { - return true; - } - return false; + return free_ratio < FREE_FD_THRESHOLD; #endif } diff --git a/include/xrpl/server/detail/ServerImpl.h b/include/xrpl/server/detail/ServerImpl.h index 1f91413521..ce1ca13664 100644 --- a/include/xrpl/server/detail/ServerImpl.h +++ b/include/xrpl/server/detail/ServerImpl.h @@ -74,7 +74,7 @@ private: std::vector ports_; std::vector>> list_; int high_ = 0; - std::array hist_; + std::array hist_{}; io_list ios_; @@ -155,7 +155,7 @@ ServerImpl::ports(std::vector const& ports) list_.push_back(sp); auto ep = sp->get_endpoint(); - if (!internalPort.port) + if (internalPort.port == 0u) internalPort.port = ep.port(); eps.emplace(port.name, std::move(ep)); diff --git a/include/xrpl/server/detail/io_list.h b/include/xrpl/server/detail/io_list.h index 5b1a02e039..b36c54a1f4 100644 --- a/include/xrpl/server/detail/io_list.h +++ b/include/xrpl/server/detail/io_list.h @@ -165,7 +165,7 @@ io_list::work::destroy() return; std::function f; { - std::lock_guard lock(ios_->m_); + std::lock_guard const lock(ios_->m_); ios_->map_.erase(this); if (--ios_->n_ == 0 && ios_->closed_) { @@ -195,7 +195,7 @@ io_list::emplace(Args&&... args) auto sp = std::make_shared(std::forward(args)...); decltype(sp) dead; - std::lock_guard lock(m_); + std::lock_guard const lock(m_); if (!closed_) { ++n_; @@ -223,8 +223,10 @@ io_list::close(Finisher&& f) f_ = std::forward(f); lock.unlock(); for (auto const& p : map) + { if (auto sp = p.second.lock()) sp->close(); + } } else { diff --git a/include/xrpl/shamap/README.md b/include/xrpl/shamap/README.md index 419918c0cb..ae37d23ac3 100644 --- a/include/xrpl/shamap/README.md +++ b/include/xrpl/shamap/README.md @@ -112,7 +112,7 @@ When a `SHAMap` decides that it is safe to share a node of its own, it sets the node's sequence number to 0 (a `SHAMap` never has a sequence number of 0). This is done for every node in the trie when `SHAMap::walkSubTree` is executed. -Note that other objects in rippled also have sequence numbers (e.g. ledgers). +Note that other objects in xrpld also have sequence numbers (e.g. ledgers). The `SHAMap` and node sequence numbers should not be confused with these other sequence numbers (no relation). diff --git a/include/xrpl/shamap/SHAMap.h b/include/xrpl/shamap/SHAMap.h index 213e7ce0ce..43b2734d65 100644 --- a/include/xrpl/shamap/SHAMap.h +++ b/include/xrpl/shamap/SHAMap.h @@ -94,10 +94,10 @@ private: public: /** Number of children each non-leaf node has (the 'radix tree' part of the * map) */ - static inline constexpr unsigned int branchFactor = SHAMapInnerNode::branchFactor; + static constexpr unsigned int branchFactor = SHAMapInnerNode::branchFactor; /** The depth of the hash map: data is only present in the leaves */ - static inline constexpr unsigned int leafDepth = 64; + static constexpr unsigned int leafDepth = 64; using DeltaItem = std::pair, boost::intrusive_ptr>; @@ -658,9 +658,13 @@ inline SHAMap::const_iterator& SHAMap::const_iterator::operator++() { if (auto temp = map_->peekNextItem(item_->key(), stack_)) + { item_ = temp->peekItem().get(); + } else + { item_ = nullptr; + } return *this; } diff --git a/include/xrpl/shamap/SHAMapInnerNode.h b/include/xrpl/shamap/SHAMapInnerNode.h index 73d59cc1fe..ebaad0d6f7 100644 --- a/include/xrpl/shamap/SHAMapInnerNode.h +++ b/include/xrpl/shamap/SHAMapInnerNode.h @@ -15,7 +15,7 @@ class SHAMapInnerNode final : public SHAMapTreeNode, public CountedObject(16), "xrpl::make_shamapitem : maximum input size"); + // NOLINTNEXTLINE(misc-const-correctness) std::uint8_t* raw = detail::slabber.allocate(data.size()); // If we can't grab memory from the slab allocators, we fall back to diff --git a/include/xrpl/tx/applySteps.h b/include/xrpl/tx/applySteps.h index 9ce6dfb1e2..ee7faeebd3 100644 --- a/include/xrpl/tx/applySteps.h +++ b/include/xrpl/tx/applySteps.h @@ -27,7 +27,7 @@ struct ApplyResult inline bool isTecClaimHardFail(TER ter, ApplyFlags flags) { - return isTecClaim(ter) && !(flags & tapRETRY); + return isTecClaim(ter) && ((flags & tapRETRY) == 0u); } /** Class describing the consequences to the account diff --git a/include/xrpl/tx/invariants/AMMInvariant.h b/include/xrpl/tx/invariants/AMMInvariant.h index 63ebb804ae..e872c61f76 100644 --- a/include/xrpl/tx/invariants/AMMInvariant.h +++ b/include/xrpl/tx/invariants/AMMInvariant.h @@ -15,12 +15,12 @@ class ValidAMM std::optional ammAccount_; std::optional lptAMMBalanceAfter_; std::optional lptAMMBalanceBefore_; - bool ammPoolChanged_; + bool ammPoolChanged_{false}; public: enum class ZeroAllowed : bool { No = false, Yes = true }; - ValidAMM() : ammPoolChanged_{false} + ValidAMM() { } void diff --git a/include/xrpl/tx/invariants/InvariantCheck.h b/include/xrpl/tx/invariants/InvariantCheck.h index e7ced63785..ad4c5e16c4 100644 --- a/include/xrpl/tx/invariants/InvariantCheck.h +++ b/include/xrpl/tx/invariants/InvariantCheck.h @@ -398,7 +398,8 @@ using InvariantChecks = std::tuple< ValidPseudoAccounts, ValidLoanBroker, ValidLoan, - ValidVault>; + ValidVault, + ValidMPTPayment>; /** * @brief get a tuple of all invariant checks diff --git a/include/xrpl/tx/invariants/InvariantCheckPrivilege.h b/include/xrpl/tx/invariants/InvariantCheckPrivilege.h index 161b3572db..684e40c8cf 100644 --- a/include/xrpl/tx/invariants/InvariantCheckPrivilege.h +++ b/include/xrpl/tx/invariants/InvariantCheckPrivilege.h @@ -44,6 +44,7 @@ enum Privilege { mayDeleteMPT = 0x0400, // The transaction MAY delete an MPT object. May not create. mustModifyVault = 0x0800, // The transaction must modify, delete or create, a vault mayModifyVault = 0x1000, // The transaction MAY modify, delete or create, a vault + mayCreateMPT = 0x2000, // The transaction MAY create an MPT object, except for issuer. }; constexpr Privilege diff --git a/include/xrpl/tx/invariants/MPTInvariant.h b/include/xrpl/tx/invariants/MPTInvariant.h index 68f866d362..dd064af396 100644 --- a/include/xrpl/tx/invariants/MPTInvariant.h +++ b/include/xrpl/tx/invariants/MPTInvariant.h @@ -28,4 +28,32 @@ public: finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const; }; +/** Verify: + * - OutstandingAmount <= MaximumAmount for any MPT + * - OutstandingAmount after = OutstandingAmount before + + * sum (MPT after - MPT before) - this is total MPT credit/debit + */ +class ValidMPTPayment +{ + enum Order { Before = 0, After = 1 }; + struct MPTData + { + std::array outstanding{}; + // sum (MPT after - MPT before) + std::int64_t mptAmount{0}; + }; + + // true if OutstandingAmount > MaximumAmount in after for any MPT + bool overflow_{false}; + // mptid:MPTData + hash_map data_; + +public: + void + visitEntry(bool, std::shared_ptr const&, std::shared_ptr const&); + + bool + finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&); +}; + } // namespace xrpl diff --git a/include/xrpl/tx/invariants/PermissionedDEXInvariant.h b/include/xrpl/tx/invariants/PermissionedDEXInvariant.h index b4e06cd212..da187779b2 100644 --- a/include/xrpl/tx/invariants/PermissionedDEXInvariant.h +++ b/include/xrpl/tx/invariants/PermissionedDEXInvariant.h @@ -11,7 +11,8 @@ namespace xrpl { class ValidPermissionedDEX { bool regularOffers_ = false; - bool badHybrids_ = false; + bool badHybridsOld_ = false; // pre-fixSecurity3_1_3: missing field/domain or size > 1 + bool badHybrids_ = false; // post-fixSecurity3_1_3: also catches size == 0 (size != 1) hash_set domains_; public: diff --git a/include/xrpl/tx/invariants/VaultInvariant.h b/include/xrpl/tx/invariants/VaultInvariant.h index ded9e4618b..9a466b2e33 100644 --- a/include/xrpl/tx/invariants/VaultInvariant.h +++ b/include/xrpl/tx/invariants/VaultInvariant.h @@ -39,9 +39,9 @@ class ValidVault struct Vault final { uint256 key = beast::zero; - Asset asset = {}; - AccountID pseudoId = {}; - AccountID owner = {}; + Asset asset; + AccountID pseudoId; + AccountID owner; uint192 shareMPTID = beast::zero; Number assetsTotal = 0; Number assetsAvailable = 0; @@ -53,18 +53,18 @@ class ValidVault struct Shares final { - MPTIssue share = {}; + MPTIssue share; std::uint64_t sharesTotal = 0; std::uint64_t sharesMaximum = 0; Shares static make(SLE const&); }; - std::vector afterVault_ = {}; - std::vector afterMPTs_ = {}; - std::vector beforeVault_ = {}; - std::vector beforeMPTs_ = {}; - std::unordered_map deltas_ = {}; + std::vector afterVault_; + std::vector afterMPTs_; + std::vector beforeVault_; + std::vector beforeMPTs_; + std::unordered_map deltas_; public: void diff --git a/include/xrpl/tx/paths/AMMLiquidity.h b/include/xrpl/tx/paths/AMMLiquidity.h index 71b8dbb12a..128052f851 100644 --- a/include/xrpl/tx/paths/AMMLiquidity.h +++ b/include/xrpl/tx/paths/AMMLiquidity.h @@ -3,14 +3,14 @@ #include #include #include +#include +#include #include #include -#include -#include namespace xrpl { -template +template class AMMOffer; /** AMMLiquidity class provides AMM offers to BookStep class. @@ -35,8 +35,8 @@ private: AMMContext& ammContext_; AccountID const ammAccountID_; std::uint32_t const tradingFee_; - Issue const issueIn_; - Issue const issueOut_; + Asset const assetIn_; + Asset const assetOut_; // Initial AMM pool balances TAmounts const initialBalances_; beast::Journal const j_; @@ -46,8 +46,8 @@ public: ReadView const& view, AccountID const& ammAccountID, std::uint32_t tradingFee, - Issue const& in, - Issue const& out, + Asset const& in, + Asset const& out, AMMContext& ammContext, beast::Journal j); ~AMMLiquidity() = default; @@ -87,16 +87,16 @@ public: return ammContext_; } - Issue const& - issueIn() const + Asset const& + assetIn() const { - return issueIn_; + return assetIn_; } - Issue const& - issueOut() const + Asset const& + assetOut() const { - return issueOut_; + return assetOut_; } private: diff --git a/include/xrpl/tx/paths/AMMOffer.h b/include/xrpl/tx/paths/AMMOffer.h index aa6132dfce..de583a60d6 100644 --- a/include/xrpl/tx/paths/AMMOffer.h +++ b/include/xrpl/tx/paths/AMMOffer.h @@ -3,6 +3,7 @@ #include #include #include +#include #include #include @@ -16,7 +17,7 @@ class QualityFunction; * methods for use in generic BookStep methods. AMMOffer amounts * are changed indirectly in BookStep limiting steps. */ -template +template class AMMOffer { private: @@ -37,7 +38,7 @@ private: // else the amounts quality Quality const quality_; // AMM offer can be consumed once at a given iteration - bool consumed_; + bool consumed_{false}; public: AMMOffer( @@ -52,8 +53,11 @@ public: return quality_; } - Issue const& - issueIn() const; + Asset const& + assetIn() const; + + Asset const& + assetOut() const; AccountID const& owner() const; @@ -99,7 +103,8 @@ public: static TER send(Args&&... args) { - return accountSend(std::forward(args)..., WaiveTransferFee::Yes); + return accountSend( + std::forward(args)..., WaiveTransferFee::Yes, AllowMPTOverflow::Yes); } bool diff --git a/include/xrpl/tx/paths/BookTip.h b/include/xrpl/tx/paths/BookTip.h index 98036a86eb..6a1805e83a 100644 --- a/include/xrpl/tx/paths/BookTip.h +++ b/include/xrpl/tx/paths/BookTip.h @@ -16,7 +16,7 @@ class BookTip { private: ApplyView& view_; - bool m_valid; + bool m_valid{false}; uint256 m_book; uint256 m_end; uint256 m_dir; diff --git a/include/xrpl/tx/paths/Flow.h b/include/xrpl/tx/paths/Flow.h index 32e8c3611b..f37c9d56c3 100644 --- a/include/xrpl/tx/paths/Flow.h +++ b/include/xrpl/tx/paths/Flow.h @@ -9,7 +9,7 @@ namespace xrpl { namespace path { namespace detail { struct FlowDebugInfo; -} +} // namespace detail } // namespace path /** diff --git a/include/xrpl/tx/paths/Offer.h b/include/xrpl/tx/paths/Offer.h index 4b161c5f2d..0ef2a30052 100644 --- a/include/xrpl/tx/paths/Offer.h +++ b/include/xrpl/tx/paths/Offer.h @@ -3,6 +3,8 @@ #include #include #include +#include +#include #include #include #include @@ -12,30 +14,17 @@ namespace xrpl { -template -class TOfferBase -{ -protected: - Issue issIn_; - Issue issOut_; -}; - -template <> -class TOfferBase -{ -public: - explicit TOfferBase() = default; -}; - -template -class TOffer : private TOfferBase +template +class TOffer { private: SLE::pointer m_entry; - Quality m_quality; + Quality m_quality{}; AccountID m_account; + Asset assetIn_; + Asset assetOut_; - TAmounts m_amounts; + TAmounts m_amounts{}; void setFieldAmounts(); @@ -113,10 +102,10 @@ public: return m_entry->key(); } - Issue const& - issueIn() const; - Issue const& - issueOut() const; + Asset const& + assetIn() const; + Asset const& + assetOut() const; TAmounts limitOut(TAmounts const& offerAmount, TOut const& limit, bool roundUp) const; @@ -131,8 +120,8 @@ public: bool isFunded() const { - // Offer owner is issuer; they have unlimited funds - return m_account == issueOut().account; + // Offer owner is issuer; they have unlimited funds if IOU + return m_account == assetOut_.getIssuer() && assetOut_.holds(); } static std::pair @@ -167,9 +156,7 @@ public: } }; -using Offer = TOffer<>; - -template +template TOffer::TOffer(SLE::pointer const& entry, Quality quality) : m_entry(entry), m_quality(quality), m_account(m_entry->getAccountID(sfAccount)) { @@ -177,33 +164,34 @@ TOffer::TOffer(SLE::pointer const& entry, Quality quality) auto const tg = m_entry->getFieldAmount(sfTakerGets); m_amounts.in = toAmount(tp); m_amounts.out = toAmount(tg); - this->issIn_ = tp.issue(); - this->issOut_ = tg.issue(); + assetIn_ = tp.asset(); + assetOut_ = tg.asset(); } -template <> -inline TOffer::TOffer(SLE::pointer const& entry, Quality quality) - : m_entry(entry) - , m_quality(quality) - , m_account(m_entry->getAccountID(sfAccount)) - , m_amounts(m_entry->getFieldAmount(sfTakerPays), m_entry->getFieldAmount(sfTakerGets)) -{ -} - -template +template void TOffer::setFieldAmounts() { - // LCOV_EXCL_START -#ifdef _MSC_VER - UNREACHABLE("xrpl::TOffer::setFieldAmounts : must be specialized"); -#else - static_assert(sizeof(TOut) == -1, "Must be specialized"); -#endif - // LCOV_EXCL_STOP + if constexpr (std::is_same_v) + { + m_entry->setFieldAmount(sfTakerPays, toSTAmount(m_amounts.in)); + } + else + { + m_entry->setFieldAmount(sfTakerPays, toSTAmount(m_amounts.in, assetIn_)); + } + + if constexpr (std::is_same_v) + { + m_entry->setFieldAmount(sfTakerGets, toSTAmount(m_amounts.out)); + } + else + { + m_entry->setFieldAmount(sfTakerGets, toSTAmount(m_amounts.out, assetOut_)); + } } -template +template TAmounts TOffer::limitOut(TAmounts const& offerAmount, TOut const& limit, bool roundUp) const @@ -213,90 +201,46 @@ TOffer::limitOut(TAmounts const& offerAmount, TOut const& return quality().ceil_out_strict(offerAmount, limit, roundUp); } -template +template TAmounts TOffer::limitIn(TAmounts const& offerAmount, TIn const& limit, bool roundUp) const { if (auto const& rules = getCurrentTransactionRules(); rules && rules->enabled(fixReducedOffersV2)) + { // It turns out that the ceil_in implementation has some slop in // it. ceil_in_strict removes that slop. But removing that slop // affects transaction outcomes, so the change must be made using // an amendment. return quality().ceil_in_strict(offerAmount, limit, roundUp); + } return m_quality.ceil_in(offerAmount, limit); } -template +template template TER TOffer::send(Args&&... args) { - return accountSend(std::forward(args)...); + return accountSend(std::forward(args)..., WaiveTransferFee::No, AllowMPTOverflow::Yes); } -template <> -inline void -TOffer::setFieldAmounts() +template +Asset const& +TOffer::assetIn() const { - m_entry->setFieldAmount(sfTakerPays, m_amounts.in); - m_entry->setFieldAmount(sfTakerGets, m_amounts.out); + return assetIn_; } -template <> -inline void -TOffer::setFieldAmounts() +template +Asset const& +TOffer::assetOut() const { - m_entry->setFieldAmount(sfTakerPays, toSTAmount(m_amounts.in, issIn_)); - m_entry->setFieldAmount(sfTakerGets, toSTAmount(m_amounts.out, issOut_)); + return assetOut_; } -template <> -inline void -TOffer::setFieldAmounts() -{ - m_entry->setFieldAmount(sfTakerPays, toSTAmount(m_amounts.in, issIn_)); - m_entry->setFieldAmount(sfTakerGets, toSTAmount(m_amounts.out)); -} - -template <> -inline void -TOffer::setFieldAmounts() -{ - m_entry->setFieldAmount(sfTakerPays, toSTAmount(m_amounts.in)); - m_entry->setFieldAmount(sfTakerGets, toSTAmount(m_amounts.out, issOut_)); -} - -template -Issue const& -TOffer::issueIn() const -{ - return this->issIn_; -} - -template <> -inline Issue const& -TOffer::issueIn() const -{ - return m_amounts.in.issue(); -} - -template -Issue const& -TOffer::issueOut() const -{ - return this->issOut_; -} - -template <> -inline Issue const& -TOffer::issueOut() const -{ - return m_amounts.out.issue(); -} - -template +template inline std::ostream& operator<<(std::ostream& os, TOffer const& offer) { diff --git a/include/xrpl/tx/paths/OfferStream.h b/include/xrpl/tx/paths/OfferStream.h index df96a1b6da..e40387e3d2 100644 --- a/include/xrpl/tx/paths/OfferStream.h +++ b/include/xrpl/tx/paths/OfferStream.h @@ -4,6 +4,7 @@ #include #include #include +#include #include #include @@ -11,7 +12,7 @@ namespace xrpl { -template +template class TOfferStreamBase { public: @@ -19,11 +20,11 @@ public: { private: std::uint32_t const limit_; - std::uint32_t count_; + std::uint32_t count_{0}; beast::Journal j_; public: - StepCounter(std::uint32_t limit, beast::Journal j) : limit_(limit), count_(0), j_(j) + StepCounter(std::uint32_t limit, beast::Journal j) : limit_(limit), j_(j) { } @@ -64,6 +65,7 @@ protected: permRmOffer(uint256 const& offerIndex) = 0; template + requires ValidTaker bool shouldRmSmallIncreasedQOffer() const; @@ -105,33 +107,6 @@ public: } }; -/** Presents and consumes the offers in an order book. - - Two `ApplyView` objects accumulate changes to the ledger. `view` - is applied when the calling transaction succeeds. If the calling - transaction fails, then `view_cancel` is applied. - - Certain invalid offers are automatically removed: - - Offers with missing ledger entries - - Offers that expired - - Offers found unfunded: - An offer is found unfunded when the corresponding balance is zero - and the caller has not modified the balance. This is accomplished - by also looking up the balance in the cancel view. - - When an offer is removed, it is removed from both views. This grooms the - order book regardless of whether or not the transaction is successful. -*/ -class OfferStream : public TOfferStreamBase -{ -protected: - void - permRmOffer(uint256 const& offerIndex) override; - -public: - using TOfferStreamBase::TOfferStreamBase; -}; - /** Presents and consumes the offers in an order book. The `view_' ` `ApplyView` accumulates changes to the ledger. @@ -149,7 +124,7 @@ public: and the caller has not modified the balance. This is accomplished by also looking up the balance in the cancel view. */ -template +template class FlowOfferStream : public TOfferStreamBase { private: diff --git a/include/xrpl/tx/paths/RippleCalc.h b/include/xrpl/tx/paths/RippleCalc.h index 4fc4c54f2b..55f552a61f 100644 --- a/include/xrpl/tx/paths/RippleCalc.h +++ b/include/xrpl/tx/paths/RippleCalc.h @@ -13,7 +13,7 @@ namespace path { namespace detail { struct FlowDebugInfo; -} +} // namespace detail /** RippleCalc calculates the quality of a payment path. diff --git a/include/xrpl/tx/paths/detail/AmountSpec.h b/include/xrpl/tx/paths/detail/AmountSpec.h index 690e67ae22..e69de29bb2 100644 --- a/include/xrpl/tx/paths/detail/AmountSpec.h +++ b/include/xrpl/tx/paths/detail/AmountSpec.h @@ -1,198 +0,0 @@ -#pragma once - -#include -#include -#include - -#include - -namespace xrpl { - -struct AmountSpec -{ - explicit AmountSpec() = default; - - bool native; - union - { - XRPAmount xrp; - IOUAmount iou = {}; - }; - std::optional issuer; - std::optional currency; - - friend std::ostream& - operator<<(std::ostream& stream, AmountSpec const& amt) - { - if (amt.native) - stream << to_string(amt.xrp); - else - stream << to_string(amt.iou); - if (amt.currency) - stream << "/(" << *amt.currency << ")"; - if (amt.issuer) - stream << "/" << *amt.issuer << ""; - return stream; - } -}; - -struct EitherAmount -{ -#ifndef NDEBUG - bool native = false; -#endif - - union - { - IOUAmount iou = {}; - XRPAmount xrp; - }; - - EitherAmount() = default; - - explicit EitherAmount(IOUAmount const& a) : iou(a) - { - } - -#if defined(__GNUC__) && !defined(__clang__) -#pragma GCC diagnostic push - // ignore warning about half of iou amount being uninitialized -#pragma GCC diagnostic ignored "-Wmaybe-uninitialized" -#endif - explicit EitherAmount(XRPAmount const& a) : xrp(a) - { -#ifndef NDEBUG - native = true; -#endif - } -#if defined(__GNUC__) && !defined(__clang__) -#pragma GCC diagnostic pop -#endif - - explicit EitherAmount(AmountSpec const& a) - { -#ifndef NDEBUG - native = a.native; -#endif - if (a.native) - xrp = a.xrp; - else - iou = a.iou; - } - -#ifndef NDEBUG - friend std::ostream& - operator<<(std::ostream& stream, EitherAmount const& amt) - { - if (amt.native) - stream << to_string(amt.xrp); - else - stream << to_string(amt.iou); - return stream; - } -#endif -}; - -template -T& -get(EitherAmount& amt) -{ - static_assert(sizeof(T) == -1, "Must used specialized function"); - return T(0); -} - -template <> -inline IOUAmount& -get(EitherAmount& amt) -{ - XRPL_ASSERT(!amt.native, "xrpl::get(EitherAmount&) : is not XRP"); - return amt.iou; -} - -template <> -inline XRPAmount& -get(EitherAmount& amt) -{ - XRPL_ASSERT(amt.native, "xrpl::get(EitherAmount&) : is XRP"); - return amt.xrp; -} - -template -T const& -get(EitherAmount const& amt) -{ - static_assert(sizeof(T) == -1, "Must used specialized function"); - return T(0); -} - -template <> -inline IOUAmount const& -get(EitherAmount const& amt) -{ - XRPL_ASSERT(!amt.native, "xrpl::get(EitherAmount const&) : is not XRP"); - return amt.iou; -} - -template <> -inline XRPAmount const& -get(EitherAmount const& amt) -{ - XRPL_ASSERT(amt.native, "xrpl::get(EitherAmount const&) : is XRP"); - return amt.xrp; -} - -inline AmountSpec -toAmountSpec(STAmount const& amt) -{ - XRPL_ASSERT( - amt.mantissa() < std::numeric_limits::max(), - "xrpl::toAmountSpec(STAmount const&) : maximum mantissa"); - bool const isNeg = amt.negative(); - std::int64_t const sMant = isNeg ? -std::int64_t(amt.mantissa()) : amt.mantissa(); - AmountSpec result; - - result.native = isXRP(amt); - if (result.native) - { - result.xrp = XRPAmount(sMant); - } - else - { - result.iou = IOUAmount(sMant, amt.exponent()); - result.issuer = amt.issue().account; - result.currency = amt.issue().currency; - } - - return result; -} - -inline EitherAmount -toEitherAmount(STAmount const& amt) -{ - if (isXRP(amt)) - return EitherAmount{amt.xrp()}; - return EitherAmount{amt.iou()}; -} - -inline AmountSpec -toAmountSpec(EitherAmount const& ea, std::optional const& c) -{ - AmountSpec r; - r.native = (!c || isXRP(*c)); - r.currency = c; - XRPL_ASSERT( - ea.native == r.native, - "xrpl::toAmountSpec(EitherAmount const&&, std::optional) : " - "matching native"); - if (r.native) - { - r.xrp = ea.xrp; - } - else - { - r.iou = ea.iou; - } - return r; -} - -} // namespace xrpl diff --git a/include/xrpl/tx/paths/detail/EitherAmount.h b/include/xrpl/tx/paths/detail/EitherAmount.h new file mode 100644 index 0000000000..ffd90751b8 --- /dev/null +++ b/include/xrpl/tx/paths/detail/EitherAmount.h @@ -0,0 +1,54 @@ +#pragma once + +#include +#include +#include +#include + +namespace xrpl { + +struct EitherAmount +{ + std::variant amount; + + explicit EitherAmount() = default; + + template + explicit EitherAmount(T const& a) : amount(a) + { + } + + template + [[nodiscard]] bool + holds() const + { + return std::holds_alternative(amount); + } + + template + [[nodiscard]] T const& + get() const + { + if (!holds()) + Throw("EitherAmount doesn't hold requested amount"); + return std::get(amount); + } + +#ifndef NDEBUG + friend std::ostream& + operator<<(std::ostream& stream, EitherAmount const& amt) + { + std::visit([&](T const& a) { stream << to_string(a); }, amt.amount); + return stream; + } +#endif +}; + +template +T const& +get(EitherAmount const& amt) +{ + return amt.get(); +} + +} // namespace xrpl diff --git a/include/xrpl/tx/paths/detail/FlowDebugInfo.h b/include/xrpl/tx/paths/detail/FlowDebugInfo.h index d2d9dc8466..ce46d0dcde 100644 --- a/include/xrpl/tx/paths/detail/FlowDebugInfo.h +++ b/include/xrpl/tx/paths/detail/FlowDebugInfo.h @@ -208,18 +208,19 @@ struct FlowDebugInfo auto writeXrpAmtList = [&write_list]( std::vector const& amts, char delim = ';') { auto get_val = [](EitherAmount const& a) -> std::string { - return xrpl::to_string(a.xrp); + return xrpl::to_string(a.get()); }; write_list(amts, get_val, delim); }; auto writeIouAmtList = [&write_list]( std::vector const& amts, char delim = ';') { auto get_val = [](EitherAmount const& a) -> std::string { - return xrpl::to_string(a.iou); + return xrpl::to_string(a.get()); }; write_list(amts, get_val, delim); }; auto writeIntList = [&write_list](std::vector const& vals, char delim = ';') { + // NOLINTNEXTLINE(bugprone-return-const-ref-from-parameter) auto get_val = [](size_t const& v) -> size_t const& { return v; }; write_list(vals, get_val); }; @@ -254,28 +255,44 @@ struct FlowDebugInfo ostr << ", in_pass: "; if (passInfo.nativeIn) + { writeXrpAmtList(passInfo.in); + } else + { writeIouAmtList(passInfo.in); + } ostr << ", out_pass: "; if (passInfo.nativeOut) + { writeXrpAmtList(passInfo.out); + } else + { writeIouAmtList(passInfo.out); + } ostr << ", num_active: "; writeIntList(passInfo.numActive); if (!passInfo.liquiditySrcIn.empty() && !passInfo.liquiditySrcIn.back().empty()) { ostr << ", l_src_in: "; if (passInfo.nativeIn) + { writeNestedXrpAmtList(passInfo.liquiditySrcIn); + } else + { writeNestedIouAmtList(passInfo.liquiditySrcIn); + } ostr << ", l_src_out: "; if (passInfo.nativeOut) + { writeNestedXrpAmtList(passInfo.liquiditySrcOut); + } else + { writeNestedIouAmtList(passInfo.liquiditySrcOut); + } } } diff --git a/include/xrpl/tx/paths/detail/StepChecks.h b/include/xrpl/tx/paths/detail/StepChecks.h index c866705a4c..a1e6490781 100644 --- a/include/xrpl/tx/paths/detail/StepChecks.h +++ b/include/xrpl/tx/paths/detail/StepChecks.h @@ -50,8 +50,7 @@ checkFreeze( if (!sleAmm) return tecINTERNAL; // LCOV_EXCL_LINE - if (isLPTokenFrozen( - view, src, (*sleAmm)[sfAsset].get(), (*sleAmm)[sfAsset2].get())) + if (isLPTokenFrozen(view, src, (*sleAmm)[sfAsset], (*sleAmm)[sfAsset2])) { return terNO_LINE; } @@ -78,8 +77,8 @@ checkNoRipple( if (!sleIn || !sleOut) return terNO_LINE; - if ((*sleIn)[sfFlags] & ((cur > prev) ? lsfHighNoRipple : lsfLowNoRipple) && - (*sleOut)[sfFlags] & ((cur > next) ? lsfHighNoRipple : lsfLowNoRipple)) + if ((((*sleIn)[sfFlags] & ((cur > prev) ? lsfHighNoRipple : lsfLowNoRipple)) != 0u) && + (((*sleOut)[sfFlags] & ((cur > next) ? lsfHighNoRipple : lsfLowNoRipple)) != 0u)) { JLOG(j.info()) << "Path violates noRipple constraint between " << prev << ", " << cur << " and " << next; diff --git a/include/xrpl/tx/paths/detail/Steps.h b/include/xrpl/tx/paths/detail/Steps.h index 53c9294155..c46cebca88 100644 --- a/include/xrpl/tx/paths/detail/Steps.h +++ b/include/xrpl/tx/paths/detail/Steps.h @@ -2,11 +2,11 @@ #include #include +#include #include #include -#include #include -#include +#include #include @@ -44,6 +44,7 @@ issues(DebtDirection dir) BookStepIX is an IOU/XRP offer book BookStepXI is an XRP/IOU offer book XRPEndpointStep is the source or destination account for XRP + MPTEndpointStep is the source or destination account for MPT Amounts may be transformed through a step in either the forward or the reverse direction. In the forward direction, the function `fwd` is used to @@ -147,29 +148,26 @@ public: /** If this step is a DirectStepI, return the quality in of the dst account. - */ + */ virtual std::uint32_t lineQualityIn(ReadView const&) const { return QUALITY_ONE; } - // clang-format off /** Find an upper bound of quality for the step @param v view to query the ledger state from @param prevStepDir Set to DebtDirection::redeems if the previous step redeems. - @return A pair. The first element is the upper bound of quality for the step, or std::nullopt if the - step is dry. The second element will be set to DebtDirection::redeems if this steps redeems, - DebtDirection:issues if this step issues. - @note it is an upper bound because offers on the books may be unfunded. - If there is always a funded offer at the tip of the book, then we could - rename this `theoreticalQuality` rather than `qualityUpperBound`. It - could still differ from the actual quality, but except for "dust" amounts, - it should be a good estimate for the actual quality. - */ - // clang-format on + @return A pair. The first element is the upper bound of quality for the step, or std::nullopt + if the step is dry. The second element will be set to DebtDirection::redeems if this + steps redeems, DebtDirection:issues if this step issues. + @note It is an upper bound because offers on the books may be unfunded. If there is always a + funded offer at the tip of the book, then we could rename this `theoreticalQuality` + rather than `qualityUpperBound`. It could still differ from the actual quality, but + except for "dust" amounts, it should be a good estimate for the actual quality. + */ virtual std::pair, DebtDirection> qualityUpperBound(ReadView const& v, DebtDirection prevStepDir) const = 0; @@ -290,10 +288,10 @@ private: inline std::pair, DebtDirection> Step::getQualityFunc(ReadView const& v, DebtDirection prevStepDir) const { - if (auto const res = qualityUpperBound(v, prevStepDir); res.first) + auto const res = qualityUpperBound(v, prevStepDir); + if (res.first) return {QualityFunction{*res.first, QualityFunction::CLOBLikeTag{}}, res.second}; - else - return {std::nullopt, res.second}; + return {std::nullopt, res.second}; } /// @cond INTERNAL @@ -319,8 +317,10 @@ operator==(Strand const& lhs, Strand const& rhs) if (lhs.size() != rhs.size()) return false; for (size_t i = 0, e = lhs.size(); i != e; ++i) + { if (*lhs[i] != *rhs[i]) return false; + } return true; } /// @endcond @@ -342,8 +342,8 @@ std::pair normalizePath( AccountID const& src, AccountID const& dst, - Issue const& deliver, - std::optional const& sendMaxIssue, + Asset const& deliver, + std::optional const& sendMaxAsset, STPath const& path); /** @@ -358,7 +358,7 @@ normalizePath( optimization. If, during direct offer crossing, the quality of the tip of the book drops below this value, then evaluating the strand can stop. - @param sendMaxIssue Optional asset to send. + @param sendMaxAsset Optional asset to send. @param path Liquidity sources to use for this strand of the payment. The path contains an ordered collection of the offer books to use and accounts to ripple through. @@ -375,9 +375,9 @@ toStrand( ReadView const& sb, AccountID const& src, AccountID const& dst, - Issue const& deliver, + Asset const& deliver, std::optional const& limitQuality, - std::optional const& sendMaxIssue, + std::optional const& sendMaxAsset, STPath const& path, bool ownerPaysTransferFee, OfferCrossing offerCrossing, @@ -416,9 +416,9 @@ toStrands( ReadView const& sb, AccountID const& src, AccountID const& dst, - Issue const& deliver, + Asset const& deliver, std::optional const& limitQuality, - std::optional const& sendMax, + std::optional const& sendMax, STPathSet const& paths, bool addDefaultPath, bool ownerPaysTransferFee, @@ -428,11 +428,13 @@ toStrands( beast::Journal j); /// @cond INTERNAL -template +template struct StepImp : public Step { +private: explicit StepImp() = default; +public: std::pair rev(PaymentSandbox& sb, ApplyView& afView, @@ -472,6 +474,7 @@ struct StepImp : public Step { return get(lhs) == get(rhs); } + friend TDerived; }; /// @endcond @@ -496,8 +499,16 @@ public: // Check equal with tolerance bool checkNear(IOUAmount const& expected, IOUAmount const& actual); -bool -checkNear(XRPAmount const& expected, XRPAmount const& actual); +inline bool +checkNear(MPTAmount const& expected, MPTAmount const& actual) +{ + return expected == actual; +} +inline bool +checkNear(XRPAmount const& expected, XRPAmount const& actual) +{ + return expected == actual; +} /// @endcond /** @@ -508,7 +519,7 @@ struct StrandContext ReadView const& view; ///< Current ReadView AccountID const strandSrc; ///< Strand source account AccountID const strandDst; ///< Strand destination account - Issue const strandDeliver; ///< Issue strand delivers + Asset const strandDeliver; ///< Asset strand delivers std::optional const limitQuality; ///< Worst accepted quality bool const isFirst; ///< true if Step is first in Strand bool const isLast = false; ///< true if Step is last in Strand @@ -525,11 +536,11 @@ struct StrandContext at most twice: once as a src and once as a dst (hence the two element array). The strandSrc and strandDst will only show up once each. */ - std::array, 2>& seenDirectIssues; + std::array, 2>& seenDirectAssets; /** A strand may not include an offer that output the same issue more than once */ - boost::container::flat_set& seenBookOuts; + boost::container::flat_set& seenBookOuts; AMMContext& ammContext; std::optional domainID; // the domain the order book will use beast::Journal const j; @@ -542,15 +553,15 @@ struct StrandContext // replicates the source or destination. AccountID const& strandSrc_, AccountID const& strandDst_, - Issue const& strandDeliver_, + Asset const& strandDeliver_, std::optional const& limitQuality_, bool isLast_, bool ownerPaysTransferFee_, OfferCrossing offerCrossing_, bool isDefaultPath_, - std::array, 2>& - seenDirectIssues_, ///< For detecting currency loops - boost::container::flat_set& seenBookOuts_, ///< For detecting book loops + std::array, 2>& + seenDirectAssets_, ///< For detecting currency loops + boost::container::flat_set& seenBookOuts_, ///< For detecting book loops AMMContext& ammContext_, std::optional const& domainID, beast::Journal j_); ///< Journal for logging @@ -566,6 +577,13 @@ directStepEqual( AccountID const& dst, Currency const& currency); +bool +mptEndpointStepEqual( + Step const& step, + AccountID const& src, + AccountID const& dst, + MPTID const& mptid); + bool xrpEndpointStepEqual(Step const& step, AccountID const& acc); @@ -580,6 +598,13 @@ make_DirectStepI( AccountID const& dst, Currency const& c); +std::pair> +make_MPTEndpointStep( + StrandContext const& ctx, + AccountID const& src, + AccountID const& dst, + MPTID const& a); + std::pair> make_BookStepII(StrandContext const& ctx, Issue const& in, Issue const& out); @@ -592,9 +617,34 @@ make_BookStepXI(StrandContext const& ctx, Issue const& out); std::pair> make_XRPEndpointStep(StrandContext const& ctx, AccountID const& acc); -template +std::pair> +make_BookStepMM(StrandContext const& ctx, MPTIssue const& in, MPTIssue const& out); + +std::pair> +make_BookStepMX(StrandContext const& ctx, MPTIssue const& in); + +std::pair> +make_BookStepXM(StrandContext const& ctx, MPTIssue const& out); + +std::pair> +make_BookStepMI(StrandContext const& ctx, MPTIssue const& in, Issue const& out); + +std::pair> +make_BookStepIM(StrandContext const& ctx, Issue const& in, MPTIssue const& out); + +template bool -isDirectXrpToXrp(Strand const& strand); +isDirectXrpToXrp(Strand const& strand) +{ + if constexpr (std::is_same_v && std::is_same_v) + { + return strand.size() == 2; + } + else + { + return false; + } +} /// @endcond } // namespace xrpl diff --git a/include/xrpl/tx/paths/detail/StrandFlow.h b/include/xrpl/tx/paths/detail/StrandFlow.h index 2a94b9b968..d7250dbdc3 100644 --- a/include/xrpl/tx/paths/detail/StrandFlow.h +++ b/include/xrpl/tx/paths/detail/StrandFlow.h @@ -2,6 +2,7 @@ #include #include +#include #include #include #include @@ -13,7 +14,6 @@ #include #include #include -#include #include @@ -27,7 +27,7 @@ namespace xrpl { template struct StrandResult { - bool success; ///< Strand succeeded + bool success = false; ///< Strand succeeded TInAmt in = beast::zero; ///< Currency amount in TOutAmt out = beast::zero; ///< Currency amount out std::optional sandbox; ///< Resulting Sandbox state @@ -61,7 +61,7 @@ struct StrandResult } StrandResult(Strand const& strand, boost::container::flat_set ofrsToRm_) - : success(false), ofrsToRm(std::move(ofrsToRm_)), ofrsUsed(offersUsed(strand)) + : ofrsToRm(std::move(ofrsToRm_)), ofrsUsed(offersUsed(strand)) { } }; @@ -246,7 +246,7 @@ flow( EitherAmount stepIn(*strand[0]->cachedIn()); for (auto i = 0; i < s; ++i) { - bool valid; + bool valid = false; std::tie(valid, stepIn) = strand[i]->validFwd(checkSB, checkAfView, stepIn); if (!valid) { @@ -327,9 +327,13 @@ qualityUpperBound(ReadView const& v, Strand const& strand) for (auto const& step : strand) { if (std::tie(stepQ, dir) = step->qualityUpperBound(v, dir); stepQ) + { q = composed_quality(q, *stepQ); + } else + { return std::nullopt; + } } return q; }; @@ -360,12 +364,18 @@ limitOut( if (std::tie(stepQualityFunc, dir) = step->getQualityFunc(v, dir); stepQualityFunc) { if (!qf) + { qf = stepQualityFunc; + } else + { qf->combine(*stepQualityFunc); + } } else + { return remainingOut; + } } // QualityFunction is constant @@ -373,14 +383,25 @@ limitOut( return remainingOut; auto const out = [&]() { - if (auto const out = qf->outFromAvgQ(limitQuality); !out) + auto const out = qf->outFromAvgQ(limitQuality); + if (!out) return remainingOut; - else if constexpr (std::is_same_v) + if constexpr (std::is_same_v) + { return XRPAmount{*out}; + } else if constexpr (std::is_same_v) + { return IOUAmount{*out}; + } + else if constexpr (std::is_same_v) + { + return MPTAmount{*out}; + } else - return STAmount{remainingOut.issue(), out->mantissa(), out->exponent()}; + { + return STAmount{remainingOut.asset(), out->mantissa(), out->exponent()}; + } }(); // A tiny difference could be due to the round off if (withinRelativeDistance(out, remainingOut, Number(1, -9))) @@ -430,7 +451,7 @@ public: { for (Strand const* strand : next_) { - if (!strand) + if (strand == nullptr) { // should not happen continue; @@ -534,7 +555,7 @@ public: @return Actual amount in and out from the strands, errors, and payment sandbox */ -template +template FlowResult flow( PaymentSandbox const& baseView, @@ -571,7 +592,7 @@ flow( std::size_t const maxTries = 1000; std::size_t curTry = 0; - std::uint32_t maxOffersToConsider = 1500; + std::uint32_t const maxOffersToConsider = 1500; std::uint32_t offersConsidered = 0; // There is a bug in gcc that incorrectly warns about using uninitialized @@ -625,8 +646,10 @@ flow( // Limit only if one strand and limitQuality auto const limitRemainingOut = [&]() { if (activeStrands.size() == 1 && limitQuality) + { if (auto const strand = activeStrands.get(0)) return limitOut(sb, *strand, remainingOut, *limitQuality); + } return remainingOut; }(); auto const adjustedRemOut = limitRemainingOut != remainingOut; @@ -715,8 +738,10 @@ flow( remainingIn = *sendMax - sum(savedIns); if (flowDebugInfo) + { flowDebugInfo->pushPass( EitherAmount(best->in), EitherAmount(best->out), activeStrands.size()); + } JLOG(j.trace()) << "Best path: in: " << to_string(best->in) << " out: " << to_string(best->out) @@ -771,7 +796,7 @@ flow( { // Rounding in the payment engine is causing this assert to // sometimes fire with "dust" amounts. This is causing issues when - // running debug builds of rippled. While this issue still needs to + // running debug builds of xrpld. While this issue still needs to // be resolved, the assert is causing more harm than good at this // point. // UNREACHABLE("xrpl::flow : rounding error"); diff --git a/include/xrpl/tx/transactors/check/CheckCash.h b/include/xrpl/tx/transactors/check/CheckCash.h index 64be19974c..312c5a983e 100644 --- a/include/xrpl/tx/transactors/check/CheckCash.h +++ b/include/xrpl/tx/transactors/check/CheckCash.h @@ -13,6 +13,9 @@ public: { } + static bool + checkExtraFeatures(PreflightContext const& ctx); + static NotTEC preflight(PreflightContext const& ctx); diff --git a/include/xrpl/tx/transactors/check/CheckCreate.h b/include/xrpl/tx/transactors/check/CheckCreate.h index a71707206a..ff24d36e2c 100644 --- a/include/xrpl/tx/transactors/check/CheckCreate.h +++ b/include/xrpl/tx/transactors/check/CheckCreate.h @@ -13,6 +13,9 @@ public: { } + static bool + checkExtraFeatures(xrpl::PreflightContext const& ctx); + static NotTEC preflight(PreflightContext const& ctx); diff --git a/include/xrpl/tx/transactors/dex/AMMClawback.h b/include/xrpl/tx/transactors/dex/AMMClawback.h index e9ae9e20b2..4f44da60d2 100644 --- a/include/xrpl/tx/transactors/dex/AMMClawback.h +++ b/include/xrpl/tx/transactors/dex/AMMClawback.h @@ -13,6 +13,9 @@ public: { } + static bool + checkExtraFeatures(PreflightContext const& ctx); + static std::uint32_t getFlagsMask(PreflightContext const& ctx); diff --git a/include/xrpl/tx/transactors/dex/AMMDeposit.h b/include/xrpl/tx/transactors/dex/AMMDeposit.h index c74fe5659a..87f2871d27 100644 --- a/include/xrpl/tx/transactors/dex/AMMDeposit.h +++ b/include/xrpl/tx/transactors/dex/AMMDeposit.h @@ -238,7 +238,7 @@ private: AccountID const& ammAccount, STAmount const& amount, STAmount const& amount2, - Issue const& lptIssue, + Asset const& lptIssue, std::uint16_t tfee); }; diff --git a/include/xrpl/tx/transactors/dex/AMMUtils.h b/include/xrpl/tx/transactors/dex/AMMUtils.h deleted file mode 100644 index 77ad18106e..0000000000 --- a/include/xrpl/tx/transactors/dex/AMMUtils.h +++ /dev/null @@ -1,106 +0,0 @@ -#pragma once - -#include -#include -#include -#include -#include -#include -#include - -namespace xrpl { - -class ReadView; -class ApplyView; -class Sandbox; -class NetClock; - -/** Get AMM pool balances. - */ -std::pair -ammPoolHolds( - ReadView const& view, - AccountID const& ammAccountID, - Issue const& issue1, - Issue const& issue2, - FreezeHandling freezeHandling, - beast::Journal const j); - -/** Get AMM pool and LP token balances. If both optIssue are - * provided then they are used as the AMM token pair issues. - * Otherwise the missing issues are fetched from ammSle. - */ -Expected, TER> -ammHolds( - ReadView const& view, - SLE const& ammSle, - std::optional const& optIssue1, - std::optional const& optIssue2, - FreezeHandling freezeHandling, - beast::Journal const j); - -/** Get the balance of LP tokens. - */ -STAmount -ammLPHolds( - ReadView const& view, - Currency const& cur1, - Currency const& cur2, - AccountID const& ammAccount, - AccountID const& lpAccount, - beast::Journal const j); - -STAmount -ammLPHolds( - ReadView const& view, - SLE const& ammSle, - AccountID const& lpAccount, - beast::Journal const j); - -/** Get AMM trading fee for the given account. The fee is discounted - * if the account is the auction slot owner or one of the slot's authorized - * accounts. - */ -std::uint16_t -getTradingFee(ReadView const& view, SLE const& ammSle, AccountID const& account); - -/** Returns total amount held by AMM for the given token. - */ -STAmount -ammAccountHolds(ReadView const& view, AccountID const& ammAccountID, Issue const& issue); - -/** Delete trustlines to AMM. If all trustlines are deleted then - * AMM object and account are deleted. Otherwise tecIMPCOMPLETE is returned. - */ -TER -deleteAMMAccount(Sandbox& view, Issue const& asset, Issue const& asset2, beast::Journal j); - -/** Initialize Auction and Voting slots and set the trading/discounted fee. - */ -void -initializeFeeAuctionVote( - ApplyView& view, - std::shared_ptr& ammSle, - AccountID const& account, - Issue const& lptIssue, - std::uint16_t tfee); - -/** Return true if the Liquidity Provider is the only AMM provider, false - * otherwise. Return tecINTERNAL if encountered an unexpected condition, - * for instance Liquidity Provider has more than one LPToken trustline. - */ -Expected -isOnlyLiquidityProvider(ReadView const& view, Issue const& ammIssue, AccountID const& lpAccount); - -/** Due to rounding, the LPTokenBalance of the last LP might - * not match the LP's trustline balance. If it's within the tolerance, - * update LPTokenBalance to match the LP's trustline balance. - */ -Expected -verifyAndAdjustLPTokenBalance( - Sandbox& sb, - STAmount const& lpTokens, - std::shared_ptr& ammSle, - AccountID const& account); - -} // namespace xrpl diff --git a/include/xrpl/tx/transactors/dex/AMMWithdraw.h b/include/xrpl/tx/transactors/dex/AMMWithdraw.h index e8cd558227..a07cfca693 100644 --- a/include/xrpl/tx/transactors/dex/AMMWithdraw.h +++ b/include/xrpl/tx/transactors/dex/AMMWithdraw.h @@ -112,7 +112,8 @@ public: STAmount const& lpTokens, STAmount const& lpTokensWithdraw, std::uint16_t tfee, - FreezeHandling freezeHanding, + FreezeHandling freezeHandling, + AuthHandling authHandling, WithdrawAll withdrawAll, XRPAmount const& priorBalance, beast::Journal const& journal); @@ -146,6 +147,7 @@ public: STAmount const& lpTokensWithdraw, std::uint16_t tfee, FreezeHandling freezeHandling, + AuthHandling authHandling, WithdrawAll withdrawAll, XRPAmount const& priorBalance, beast::Journal const& journal); @@ -155,8 +157,8 @@ public: Sandbox& sb, std::shared_ptr const ammSle, STAmount const& lpTokenBalance, - Issue const& issue1, - Issue const& issue2, + Asset const& asset1, + Asset const& asset2, beast::Journal const& journal); private: diff --git a/include/xrpl/tx/transactors/dex/OfferCreate.h b/include/xrpl/tx/transactors/dex/OfferCreate.h index bbb9ea8ad9..09c9c0dd6f 100644 --- a/include/xrpl/tx/transactors/dex/OfferCreate.h +++ b/include/xrpl/tx/transactors/dex/OfferCreate.h @@ -65,7 +65,7 @@ private: ApplyFlags const flags, AccountID const id, beast::Journal const j, - Issue const& issue); + Asset const& asset); // Use the payment flow code to perform offer crossing. std::pair diff --git a/include/xrpl/tx/transactors/lending/LendingHelpers.h b/include/xrpl/tx/transactors/lending/LendingHelpers.h index 4057c9c173..897ca3995b 100644 --- a/include/xrpl/tx/transactors/lending/LendingHelpers.h +++ b/include/xrpl/tx/transactors/lending/LendingHelpers.h @@ -143,7 +143,7 @@ struct LoanProperties // - A minimum scale required to represent the periodic payment accurately // All loan state values (principal, interest, fees) are rounded to this // scale. - std::int32_t loanScale; + std::int32_t loanScale{}; // The principal portion of the first payment. Number firstPaymentPrincipal; diff --git a/include/xrpl/tx/transactors/nft/NFTokenMint.h b/include/xrpl/tx/transactors/nft/NFTokenMint.h index da6d9ab445..6dcf8eaf12 100644 --- a/include/xrpl/tx/transactors/nft/NFTokenMint.h +++ b/include/xrpl/tx/transactors/nft/NFTokenMint.h @@ -1,8 +1,8 @@ #pragma once +#include #include #include -#include namespace xrpl { diff --git a/include/xrpl/tx/transactors/token/MPTokenAuthorize.h b/include/xrpl/tx/transactors/token/MPTokenAuthorize.h index 67370bfbd2..0cbc683e91 100644 --- a/include/xrpl/tx/transactors/token/MPTokenAuthorize.h +++ b/include/xrpl/tx/transactors/token/MPTokenAuthorize.h @@ -10,7 +10,7 @@ struct MPTAuthorizeArgs MPTID const& mptIssuanceID; AccountID const& account; std::uint32_t flags{}; - std::optional holderID{}; + std::optional holderID; }; class MPTokenAuthorize : public Transactor @@ -31,13 +31,6 @@ public: static TER preclaim(PreclaimContext const& ctx); - static TER - createMPToken( - ApplyView& view, - MPTID const& mptIssuanceID, - AccountID const& account, - std::uint32_t const flags); - TER doApply() override; diff --git a/include/xrpl/tx/transactors/token/MPTokenIssuanceCreate.h b/include/xrpl/tx/transactors/token/MPTokenIssuanceCreate.h index 8c0fad024c..6718d28e4d 100644 --- a/include/xrpl/tx/transactors/token/MPTokenIssuanceCreate.h +++ b/include/xrpl/tx/transactors/token/MPTokenIssuanceCreate.h @@ -10,14 +10,18 @@ struct MPTCreateArgs { std::optional priorBalance; AccountID const& account; - std::uint32_t sequence; + std::uint32_t sequence = 0; std::uint32_t flags = 0; - std::optional maxAmount{}; - std::optional assetScale{}; - std::optional transferFee{}; + std::optional maxAmount = + std::nullopt; // NOLINT(readability-redundant-member-init) + std::optional assetScale = + std::nullopt; // NOLINT(readability-redundant-member-init) + std::optional transferFee = + std::nullopt; // NOLINT(readability-redundant-member-init) std::optional const& metadata{}; - std::optional domainId{}; - std::optional mutableFlags{}; + std::optional domainId = std::nullopt; // NOLINT(readability-redundant-member-init) + std::optional mutableFlags = + std::nullopt; // NOLINT(readability-redundant-member-init) }; class MPTokenIssuanceCreate : public Transactor diff --git a/sanitizers/suppressions/tsan.supp b/sanitizers/suppressions/tsan.supp index 74f3371e68..702eef1e3d 100644 --- a/sanitizers/suppressions/tsan.supp +++ b/sanitizers/suppressions/tsan.supp @@ -7,7 +7,7 @@ race:boost/context/ race:boost/asio/executor.hpp race:boost::asio -# Suppress tsan related issues in rippled code. +# Suppress tsan related issues in xrpld code. race:src/libxrpl/basics/make_SSLContext.cpp race:src/libxrpl/basics/Number.cpp race:src/libxrpl/json/json_value.cpp @@ -46,7 +46,7 @@ race:xrpl/server/detail/ServerImpl.h race:xrpl/nodestore/detail/DatabaseNodeImp.h race:src/libxrpl/beast/utility/beast_Journal.cpp race:src/test/beast/LexicalCast_test.cpp -race:ripple::ServerHandler +race:ServerHandler # More suppressions in external library code. race:crtstuff.c @@ -65,7 +65,7 @@ deadlock:src/xrpld/app/misc/detail/ValidatorSite.cpp signal:src/libxrpl/beast/utility/beast_Journal.cpp signal:src/xrpld/core/detail/Workers.cpp signal:src/xrpld/core/JobQueue.cpp -signal:ripple::Workers::Worker +signal:Workers::Worker # Aggressive suppressing of deadlock tsan errors deadlock:pthread_create diff --git a/sanitizers/suppressions/ubsan.supp b/sanitizers/suppressions/ubsan.supp index a02cbb17de..1e07065ebd 100644 --- a/sanitizers/suppressions/ubsan.supp +++ b/sanitizers/suppressions/ubsan.supp @@ -74,7 +74,7 @@ vptr:boost # Google protobuf undefined:protobuf -# Suppress UBSan errors in rippled code by source file path +# Suppress UBSan errors in xrpld code by source file path undefined:src/libxrpl/basics/base64.cpp undefined:src/libxrpl/basics/Number.cpp undefined:src/libxrpl/beast/utility/beast_Journal.cpp @@ -165,7 +165,7 @@ unsigned-integer-overflow:xrpl/nodestore/detail/varint.h unsigned-integer-overflow:xrpl/peerfinder/detail/Counts.h unsigned-integer-overflow:xrpl/protocol/nft.h -# Rippled intentional overflows and operations +# Xrpld intentional overflows and operations # STAmount uses intentional negation of INT64_MIN and overflow in arithmetic signed-integer-overflow:src/libxrpl/protocol/STAmount.cpp unsigned-integer-overflow:src/libxrpl/protocol/STAmount.cpp diff --git a/src/libxrpl/basics/Archive.cpp b/src/libxrpl/basics/Archive.cpp index a09d77d794..bba144ed04 100644 --- a/src/libxrpl/basics/Archive.cpp +++ b/src/libxrpl/basics/Archive.cpp @@ -1,4 +1,5 @@ #include + #include #include @@ -20,7 +21,7 @@ extractTarLz4(boost::filesystem::path const& src, boost::filesystem::path const& Throw("Invalid source file"); using archive_ptr = std::unique_ptr; - archive_ptr ar{archive_read_new(), [](struct archive* a) { archive_read_free(a); }}; + archive_ptr const ar{archive_read_new(), [](struct archive* a) { archive_read_free(a); }}; if (!ar) Throw("Failed to allocate archive"); @@ -36,7 +37,8 @@ extractTarLz4(boost::filesystem::path const& src, boost::filesystem::path const& Throw(archive_error_string(ar.get())); } - archive_ptr aw{archive_write_disk_new(), [](struct archive* a) { archive_write_free(a); }}; + archive_ptr const aw{ + archive_write_disk_new(), [](struct archive* a) { archive_write_free(a); }}; if (!aw) Throw("Failed to allocate archive"); diff --git a/src/libxrpl/basics/BasicConfig.cpp b/src/libxrpl/basics/BasicConfig.cpp index edc8bea7d9..12ead7b6b0 100644 --- a/src/libxrpl/basics/BasicConfig.cpp +++ b/src/libxrpl/basics/BasicConfig.cpp @@ -1,9 +1,9 @@ #include + #include #include #include -#include #include #include @@ -126,7 +126,7 @@ BasicConfig::section(std::string const& name) Section const& BasicConfig::section(std::string const& name) const { - static Section none(""); + static Section const none(""); auto const iter = map_.find(name); if (iter == map_.end()) return none; diff --git a/src/libxrpl/basics/FileUtilities.cpp b/src/libxrpl/basics/FileUtilities.cpp index 73f2c2f10d..1a6e604724 100644 --- a/src/libxrpl/basics/FileUtilities.cpp +++ b/src/libxrpl/basics/FileUtilities.cpp @@ -1,6 +1,5 @@ #include -#include #include #include #include @@ -26,7 +25,7 @@ getFileContents( using namespace boost::filesystem; using namespace boost::system::errc; - path fullPath{canonical(sourcePath, ec)}; + path const fullPath{canonical(sourcePath, ec)}; if (ec) return {}; diff --git a/src/libxrpl/basics/Log.cpp b/src/libxrpl/basics/Log.cpp index 9cebd1f04a..d37258776b 100644 --- a/src/libxrpl/basics/Log.cpp +++ b/src/libxrpl/basics/Log.cpp @@ -1,4 +1,5 @@ #include + #include #include #include @@ -119,7 +120,7 @@ Logs::open(boost::filesystem::path const& pathToLogFile) beast::Journal::Sink& Logs::get(std::string const& name) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const result = sinks_.emplace(name, makeSink(name, thresh_)); return *result.first->second; } @@ -145,7 +146,7 @@ Logs::threshold() const void Logs::threshold(beast::severities::Severity thresh) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); thresh_ = thresh; for (auto& sink : sinks_) sink.second->threshold(thresh); @@ -155,7 +156,7 @@ std::vector> Logs::partition_severities() const { std::vector> list; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list.reserve(sinks_.size()); for (auto const& [name, sink] : sinks_) list.emplace_back(name, toString(fromSeverity(sink->threshold()))); @@ -171,7 +172,7 @@ Logs::write( { std::string s; format(s, text, level, partition); - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); file_.writeln(s); if (!silent_) std::cerr << s << '\n'; @@ -183,7 +184,7 @@ Logs::write( std::string Logs::rotate() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); bool const wasOpened = file_.closeAndReopen(); if (wasOpened) return "The log file was closed and reopened."; @@ -411,7 +412,7 @@ public: std::unique_ptr set(std::unique_ptr sink) { - std::lock_guard _(m_); + std::lock_guard const _(m_); using std::swap; swap(holder_, sink); @@ -431,7 +432,7 @@ public: beast::Journal::Sink& get() { - std::lock_guard _(m_); + std::lock_guard const _(m_); return sink_.get(); } }; diff --git a/src/libxrpl/basics/MallocTrim.cpp b/src/libxrpl/basics/MallocTrim.cpp index ed20ac6c94..07b5b9ffc5 100644 --- a/src/libxrpl/basics/MallocTrim.cpp +++ b/src/libxrpl/basics/MallocTrim.cpp @@ -1,13 +1,11 @@ -#include #include +#include +#include + #include -#include -#include -#include -#include -#include +#include #if defined(__GLIBC__) && BOOST_OS_LINUX #include @@ -15,6 +13,14 @@ #include #include +#include +#include +#include +#include +#include +#include +#include + // Require RUSAGE_THREAD for thread-scoped page fault tracking #ifndef RUSAGE_THREAD #error "MallocTrim rusage instrumentation requires RUSAGE_THREAD on Linux/glibc" diff --git a/src/libxrpl/basics/Number.cpp b/src/libxrpl/basics/Number.cpp index f0655cd8a9..73ab8f6307 100644 --- a/src/libxrpl/basics/Number.cpp +++ b/src/libxrpl/basics/Number.cpp @@ -1,11 +1,12 @@ #include -// Keep Number.h first to ensure it can build without hidden dependencies + #include #include #include #include #include +#include #include #include #include @@ -161,7 +162,7 @@ Number::Guard::push(T d) noexcept inline unsigned Number::Guard::pop() noexcept { - unsigned d = (digits_ & 0xF000'0000'0000'0000) >> 60; + unsigned const d = (digits_ & 0xF000'0000'0000'0000) >> 60; digits_ <<= 4; return d; } @@ -325,7 +326,7 @@ Number::externalToInternal(rep mantissa) // int128_t, negate that, and cast it back down to the internalrep // In practice, this is only going to cover the case of // std::numeric_limits::min(). - int128_t temp = mantissa; + int128_t const temp = mantissa; return static_cast(-temp); } @@ -530,7 +531,7 @@ Number::operator+=(Number const& y) uint128_t xm = mantissa_; auto xe = exponent_; - bool yn = y.negative_; + bool const yn = y.negative_; uint128_t ym = y.mantissa_; auto ye = y.exponent_; Guard g; @@ -644,14 +645,14 @@ Number::operator*=(Number const& y) // *m = mantissa // *e = exponent - bool xn = negative_; - int xs = xn ? -1 : 1; + bool const xn = negative_; + int const xs = xn ? -1 : 1; internalrep xm = mantissa_; auto xe = exponent_; - bool yn = y.negative_; - int ys = yn ? -1 : 1; - internalrep ym = y.mantissa_; + bool const yn = y.negative_; + int const ys = yn ? -1 : 1; + internalrep const ym = y.mantissa_; auto ye = y.exponent_; auto zm = uint128_t(xm) * uint128_t(ym); @@ -706,13 +707,13 @@ Number::operator/=(Number const& y) // *m = mantissa // *e = exponent - bool np = negative_; - int ns = (np ? -1 : 1); + bool const np = negative_; + int const ns = (np ? -1 : 1); auto nm = mantissa_; auto ne = exponent_; - bool dp = y.negative_; - int ds = (dp ? -1 : 1); + bool const dp = y.negative_; + int const ds = (dp ? -1 : 1); auto dm = y.mantissa_; auto de = y.exponent_; @@ -728,7 +729,7 @@ Number::operator/=(Number const& y) // f can be up to 10^(38-19) = 10^19 safely static_assert(smallRange.log == 15); static_assert(largeRange.log == 18); - bool small = Number::getMantissaScale() == MantissaRange::small; + bool const small = Number::getMantissaScale() == MantissaRange::small; uint128_t const f = small ? 100'000'000'000'000'000 : 10'000'000'000'000'000'000ULL; XRPL_ASSERT_PARTS(f >= minMantissa * 10, "Number::operator/=", "factor expected size"); @@ -980,8 +981,8 @@ root(Number f, unsigned d) auto const di = static_cast(d); auto ex = [e = e, di = di]() // Euclidean remainder of e/d { - int k = (e >= 0 ? e : e - (di - 1)) / di; - int k2 = e - (k * di); + int const k = (e >= 0 ? e : e - (di - 1)) / di; + int const k2 = e - (k * di); if (k2 == 0) return 0; return di - k2; diff --git a/src/libxrpl/basics/ResolverAsio.cpp b/src/libxrpl/basics/ResolverAsio.cpp index aa1cb1470d..b23ae1272f 100644 --- a/src/libxrpl/basics/ResolverAsio.cpp +++ b/src/libxrpl/basics/ResolverAsio.cpp @@ -1,15 +1,19 @@ +#include + #include #include -#include #include #include #include #include #include +#include #include #include #include +#include +#include #include #include @@ -152,7 +156,7 @@ public: void asyncHandlersComplete() { - std::unique_lock lk{m_mut}; + std::unique_lock const lk{m_mut}; m_asyncHandlersCompleted = true; m_cv.notify_all(); } @@ -172,7 +176,7 @@ public: if (m_stopped.exchange(false)) { { - std::lock_guard lk{m_mut}; + std::lock_guard const lk{m_mut}; m_asyncHandlersCompleted = false; } addReference(); @@ -327,7 +331,7 @@ public: return; std::string const name(m_work.front().names.back()); - HandlerType handler(m_work.front().handler); + HandlerType const handler(m_work.front().handler); m_work.front().names.pop_back(); diff --git a/src/libxrpl/basics/StringUtilities.cpp b/src/libxrpl/basics/StringUtilities.cpp index c47618db82..7bf4c8e743 100644 --- a/src/libxrpl/basics/StringUtilities.cpp +++ b/src/libxrpl/basics/StringUtilities.cpp @@ -1,5 +1,6 @@ -#include #include + +#include #include #include @@ -8,7 +9,6 @@ #include #include #include -#include #include #include @@ -37,7 +37,7 @@ bool parseUrl(parsedURL& pUrl, std::string const& strUrl) { // scheme://username:password@hostname:port/rest - static boost::regex reUrl( + static boost::regex const reUrl( "(?i)\\`\\s*" // required scheme "([[:alpha:]][-+.[:alpha:][:digit:]]*?):" diff --git a/src/libxrpl/basics/UptimeClock.cpp b/src/libxrpl/basics/UptimeClock.cpp index 521a6a1313..3d1664482b 100644 --- a/src/libxrpl/basics/UptimeClock.cpp +++ b/src/libxrpl/basics/UptimeClock.cpp @@ -9,14 +9,14 @@ namespace xrpl { std::atomic UptimeClock::now_{0}; // seconds since start std::atomic UptimeClock::stop_{false}; // stop update thread -// On rippled shutdown, cancel and wait for the update thread +// On xrpld shutdown, cancel and wait for the update thread UptimeClock::update_thread::~update_thread() { if (joinable()) { stop_ = true; // This join() may take up to a 1s, but happens only - // once at rippled shutdown. + // once at xrpld shutdown. join(); } } @@ -40,7 +40,7 @@ UptimeClock::start_clock() }}; } -// This actually measures time since first use, instead of since rippled start. +// This actually measures time since first use, instead of since xrpld start. // However the difference between these two epochs is a small fraction of a // second and unimportant. @@ -50,7 +50,7 @@ UptimeClock::now() // start the update thread on first use static auto const init = start_clock(); - // Return the number of seconds since rippled start + // Return the number of seconds since xrpld start return time_point{duration{now_}}; } diff --git a/src/libxrpl/basics/base64.cpp b/src/libxrpl/basics/base64.cpp index a510fbf6c9..cf6af3db70 100644 --- a/src/libxrpl/basics/base64.cpp +++ b/src/libxrpl/basics/base64.cpp @@ -103,7 +103,7 @@ std::size_t constexpr decoded_size(std::size_t n) std::size_t encode(void* dest, void const* src, std::size_t len) { - char* out = static_cast(dest); + char* out = static_cast(dest); // NOLINT(misc-const-correctness) char const* in = static_cast(src); auto const tab = base64::get_alphabet(); @@ -154,7 +154,7 @@ encode(void* dest, void const* src, std::size_t len) std::pair decode(void* dest, char const* src, std::size_t len) { - char* out = static_cast(dest); + char* out = static_cast(dest); // NOLINT(misc-const-correctness) auto in = reinterpret_cast(src); unsigned char c3[3]{}, c4[4]{}; int i = 0; diff --git a/src/libxrpl/basics/contract.cpp b/src/libxrpl/basics/contract.cpp index 562d3a0944..32628ac3d9 100644 --- a/src/libxrpl/basics/contract.cpp +++ b/src/libxrpl/basics/contract.cpp @@ -1,5 +1,6 @@ -#include #include + +#include #include #include diff --git a/src/libxrpl/basics/make_SSLContext.cpp b/src/libxrpl/basics/make_SSLContext.cpp index de16e8c6cf..4f0487c4c2 100644 --- a/src/libxrpl/basics/make_SSLContext.cpp +++ b/src/libxrpl/basics/make_SSLContext.cpp @@ -1,6 +1,7 @@ -#include #include +#include + #include #include #include @@ -8,8 +9,9 @@ #include #include +#include #include -#include +#include // IWYU pragma: keep #include #include #include @@ -140,7 +142,7 @@ initAnonymous(boost::asio::ssl::context& context) auto const ts = std::time(nullptr) - (25 * 60 * 60); - int ret = std::strftime(buf, sizeof(buf) - 1, "%y%m%d000000Z", std::gmtime(&ts)); + int const ret = std::strftime(buf, sizeof(buf) - 1, "%y%m%d000000Z", std::gmtime(&ts)); buf[ret] = 0; diff --git a/src/libxrpl/basics/mulDiv.cpp b/src/libxrpl/basics/mulDiv.cpp index d8988b474e..4abdcc0f75 100644 --- a/src/libxrpl/basics/mulDiv.cpp +++ b/src/libxrpl/basics/mulDiv.cpp @@ -1,8 +1,6 @@ #include -#include -#include -#include +#include // IWYU pragma: keep #include #include diff --git a/src/libxrpl/beast/clock/basic_seconds_clock.cpp b/src/libxrpl/beast/clock/basic_seconds_clock.cpp index 4727599740..2b7ce57742 100644 --- a/src/libxrpl/beast/clock/basic_seconds_clock.cpp +++ b/src/libxrpl/beast/clock/basic_seconds_clock.cpp @@ -1,4 +1,5 @@ #include + #include #include @@ -41,7 +42,7 @@ seconds_clock_thread::~seconds_clock_thread() XRPL_ASSERT( thread_.joinable(), "beast::seconds_clock_thread::~seconds_clock_thread : thread joinable"); { - std::lock_guard lock(mut_); + std::lock_guard const lock(mut_); stop_ = true; } // publish stop_ asap so if waiting thread times-out, it will see it cv_.notify_one(); diff --git a/src/libxrpl/beast/core/CurrentThreadName.cpp b/src/libxrpl/beast/core/CurrentThreadName.cpp index 8e54a74e4d..ccd3df5f74 100644 --- a/src/libxrpl/beast/core/CurrentThreadName.cpp +++ b/src/libxrpl/beast/core/CurrentThreadName.cpp @@ -1,5 +1,4 @@ #include -#include #include #include @@ -72,7 +71,8 @@ setCurrentThreadNameImpl(std::string_view name) #if BOOST_OS_LINUX #include -#include +#include +#include // IWYU pragma: keep namespace beast::detail { @@ -95,11 +95,6 @@ setCurrentThreadNameImpl(std::string_view name) { std::cerr << "WARNING: Thread name \"" << name << "\" (length " << name.size() << ") exceeds maximum of " << maxThreadNameLength << " characters on Linux.\n"; - - XRPL_ASSERT( - false, - "beast::detail::setCurrentThreadNameImpl : Thread name exceeds " - "maximum length for Linux"); } #endif } diff --git a/src/libxrpl/beast/core/SemanticVersion.cpp b/src/libxrpl/beast/core/SemanticVersion.cpp index 34bb5e3df0..db67791a46 100644 --- a/src/libxrpl/beast/core/SemanticVersion.cpp +++ b/src/libxrpl/beast/core/SemanticVersion.cpp @@ -1,5 +1,6 @@ -#include #include + +#include #include #include @@ -8,6 +9,7 @@ #include #include #include +#include namespace beast { @@ -62,7 +64,7 @@ chopUInt(int& value, int limit, std::string& input) return std::isdigit(c, std::locale::classic()); }); - std::string item(input.begin(), left_iter); + std::string const item(input.begin(), left_iter); // Must not be empty if (item.empty()) @@ -320,7 +322,7 @@ compare(SemanticVersion const& lhs, SemanticVersion const& rhs) { XRPL_ASSERT(!isNumeric(right), "beast::compare : both inputs non-numeric"); - int result = left.compare(right); + int const result = left.compare(right); if (result != 0) return result; diff --git a/src/libxrpl/beast/insight/Collector.cpp b/src/libxrpl/beast/insight/Collector.cpp index 37b199fa7f..d4a528473b 100644 --- a/src/libxrpl/beast/insight/Collector.cpp +++ b/src/libxrpl/beast/insight/Collector.cpp @@ -4,5 +4,5 @@ namespace beast { namespace insight { Collector::~Collector() = default; -} +} // namespace insight } // namespace beast diff --git a/src/libxrpl/beast/insight/Groups.cpp b/src/libxrpl/beast/insight/Groups.cpp index 2b4178a9ca..4d8fff0d07 100644 --- a/src/libxrpl/beast/insight/Groups.cpp +++ b/src/libxrpl/beast/insight/Groups.cpp @@ -1,10 +1,11 @@ +#include + #include #include #include #include #include #include -#include #include #include #include @@ -98,7 +99,7 @@ public: Group::ptr const& get(std::string const& name) override { - std::pair result(m_items.emplace(name, Group::ptr())); + std::pair const result(m_items.emplace(name, Group::ptr())); Group::ptr& group(result.first->second); if (result.second) group = std::make_shared(name, m_collector); diff --git a/src/libxrpl/beast/insight/Hook.cpp b/src/libxrpl/beast/insight/Hook.cpp index d5e0a3439f..82859750cb 100644 --- a/src/libxrpl/beast/insight/Hook.cpp +++ b/src/libxrpl/beast/insight/Hook.cpp @@ -1,9 +1,10 @@ #include + #include namespace beast { namespace insight { HookImpl::~HookImpl() = default; -} +} // namespace insight } // namespace beast diff --git a/src/libxrpl/beast/insight/NullCollector.cpp b/src/libxrpl/beast/insight/NullCollector.cpp index d8ba67a8e7..44e957f5df 100644 --- a/src/libxrpl/beast/insight/NullCollector.cpp +++ b/src/libxrpl/beast/insight/NullCollector.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -9,7 +11,6 @@ #include #include #include -#include #include #include diff --git a/src/libxrpl/beast/insight/StatsDCollector.cpp b/src/libxrpl/beast/insight/StatsDCollector.cpp index 83fc65e92c..817f6a5982 100644 --- a/src/libxrpl/beast/insight/StatsDCollector.cpp +++ b/src/libxrpl/beast/insight/StatsDCollector.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -5,7 +7,6 @@ #include #include #include -#include #include #include #include @@ -13,12 +14,14 @@ #include #include #include +#include #include #include #include #include #include #include +#include #include #include @@ -293,14 +296,14 @@ public: void add(StatsDMetricBase& metric) { - std::lock_guard _(metricsLock_); + std::lock_guard const _(metricsLock_); metrics_.push_back(metric); } void remove(StatsDMetricBase& metric) { - std::lock_guard _(metricsLock_); + std::lock_guard const _(metricsLock_); metrics_.erase(metrics_.iterator_to(metric)); } @@ -444,7 +447,7 @@ public: return; } - std::lock_guard _(metricsLock_); + std::lock_guard const _(metricsLock_); for (auto& m : metrics_) m.do_process(); diff --git a/src/libxrpl/beast/net/IPAddressConversion.cpp b/src/libxrpl/beast/net/IPAddressConversion.cpp index d34a973d8e..6977168f5e 100644 --- a/src/libxrpl/beast/net/IPAddressConversion.cpp +++ b/src/libxrpl/beast/net/IPAddressConversion.cpp @@ -1,4 +1,5 @@ #include + #include #include diff --git a/src/libxrpl/beast/net/IPAddressV6.cpp b/src/libxrpl/beast/net/IPAddressV6.cpp index 30e2eefb96..5523446e09 100644 --- a/src/libxrpl/beast/net/IPAddressV6.cpp +++ b/src/libxrpl/beast/net/IPAddressV6.cpp @@ -1,7 +1,8 @@ -#include #include -#include +#include + +#include namespace beast { namespace IP { diff --git a/src/libxrpl/beast/net/IPEndpoint.cpp b/src/libxrpl/beast/net/IPEndpoint.cpp index 70e7bff2c5..0a1c0305c8 100644 --- a/src/libxrpl/beast/net/IPEndpoint.cpp +++ b/src/libxrpl/beast/net/IPEndpoint.cpp @@ -1,9 +1,9 @@ -#include #include +#include + #include #include -#include #include #include @@ -120,8 +120,7 @@ operator>>(std::istream& is, Endpoint& endpoint) addrStr += i; // don't exceed a reasonable length... - if (addrStr.size() == INET6_ADDRSTRLEN || - ((readTo != 0) && readTo == ':' && addrStr.size() > 15)) + if (addrStr.size() == INET6_ADDRSTRLEN || (readTo == ':' && addrStr.size() > 15)) { is.setstate(std::ios_base::failbit); return is; diff --git a/src/libxrpl/beast/utility/beast_PropertyStream.cpp b/src/libxrpl/beast/utility/beast_PropertyStream.cpp index 454b9d1323..5456faf3eb 100644 --- a/src/libxrpl/beast/utility/beast_PropertyStream.cpp +++ b/src/libxrpl/beast/utility/beast_PropertyStream.cpp @@ -1,3 +1,4 @@ +#include #include #include @@ -15,7 +16,7 @@ namespace beast { // //------------------------------------------------------------------------------ -PropertyStream::Item::Item(Source* source) : ListNode(), m_source(source) +PropertyStream::Item::Item(Source* source) : m_source(source) { } @@ -151,14 +152,13 @@ PropertyStream::Set::stream() const // //------------------------------------------------------------------------------ -PropertyStream::Source::Source(std::string const& name) - : m_name(name), item_(this), parent_(nullptr) +PropertyStream::Source::Source(std::string const& name) : m_name(name), item_(this) { } PropertyStream::Source::~Source() { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); if (parent_ != nullptr) parent_->remove(*this); removeAll(); @@ -174,8 +174,8 @@ void PropertyStream::Source::add(Source& source) { std::lock(lock_, source.lock_); - std::lock_guard lk1(lock_, std::adopt_lock); - std::lock_guard lk2(source.lock_, std::adopt_lock); + std::lock_guard const lk1(lock_, std::adopt_lock); + std::lock_guard const lk2(source.lock_, std::adopt_lock); XRPL_ASSERT( source.parent_ == nullptr, "beast::PropertyStream::Source::add : null source parent"); @@ -187,8 +187,8 @@ void PropertyStream::Source::remove(Source& child) { std::lock(lock_, child.lock_); - std::lock_guard lk1(lock_, std::adopt_lock); - std::lock_guard lk2(child.lock_, std::adopt_lock); + std::lock_guard const lk1(lock_, std::adopt_lock); + std::lock_guard const lk2(child.lock_, std::adopt_lock); XRPL_ASSERT( child.parent_ == this, "beast::PropertyStream::Source::remove : child parent match"); @@ -199,10 +199,10 @@ PropertyStream::Source::remove(Source& child) void PropertyStream::Source::removeAll() { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); for (auto iter = children_.begin(); iter != children_.end();) { - std::lock_guard _cl((*iter)->lock_); + std::lock_guard const _cl((*iter)->lock_); remove(*(*iter)); } } @@ -222,7 +222,7 @@ PropertyStream::Source::write(PropertyStream& stream) Map map(m_name, stream); onWrite(map); - std::lock_guard _(lock_); + std::lock_guard const _(lock_); for (auto& child : children_) child.source().write(stream); @@ -299,9 +299,9 @@ PropertyStream::Source::peel_name(std::string* path) if (path->empty()) return ""; - std::string::const_iterator first = (*path).begin(); - std::string::const_iterator last = (*path).end(); - std::string::const_iterator pos = std::find(first, last, '/'); + std::string::const_iterator const first = (*path).begin(); + std::string::const_iterator const last = (*path).end(); + std::string::const_iterator const pos = std::find(first, last, '/'); std::string s(first, pos); if (pos != last) @@ -320,11 +320,11 @@ PropertyStream::Source::peel_name(std::string* path) PropertyStream::Source* PropertyStream::Source::find_one_deep(std::string const& name) { - Source* found = find_one(name); + Source* found = find_one(name); // NOLINT(misc-const-correctness) if (found != nullptr) return found; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); for (auto& s : children_) { found = s.source().find_one_deep(name); @@ -355,7 +355,7 @@ PropertyStream::Source::find_path(std::string path) PropertyStream::Source* PropertyStream::Source::find_one(std::string const& name) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); for (auto& s : children_) { if (s.source().m_name == name) diff --git a/src/libxrpl/conditions/Condition.cpp b/src/libxrpl/conditions/Condition.cpp index 30beba3402..afd61b9727 100644 --- a/src/libxrpl/conditions/Condition.cpp +++ b/src/libxrpl/conditions/Condition.cpp @@ -1,7 +1,17 @@ #include + +#include +#include #include +#include #include +#include +#include +#include +#include +#include + namespace xrpl { namespace cryptoconditions { diff --git a/src/libxrpl/conditions/Fulfillment.cpp b/src/libxrpl/conditions/Fulfillment.cpp index 11581a8705..898a7304c2 100644 --- a/src/libxrpl/conditions/Fulfillment.cpp +++ b/src/libxrpl/conditions/Fulfillment.cpp @@ -1,9 +1,15 @@ +#include + +#include #include #include -#include #include +#include #include +#include +#include + namespace xrpl { namespace cryptoconditions { diff --git a/src/libxrpl/conditions/error.cpp b/src/libxrpl/conditions/error.cpp index 9c9d4658e4..074dca8b24 100644 --- a/src/libxrpl/conditions/error.cpp +++ b/src/libxrpl/conditions/error.cpp @@ -1,7 +1,10 @@ -#include #include +#include + #include +#include +#include namespace xrpl { namespace cryptoconditions { diff --git a/src/libxrpl/core/HashRouter.cpp b/src/libxrpl/core/HashRouter.cpp index dff1394f77..4175d83340 100644 --- a/src/libxrpl/core/HashRouter.cpp +++ b/src/libxrpl/core/HashRouter.cpp @@ -1,5 +1,17 @@ #include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + namespace xrpl { auto @@ -22,7 +34,7 @@ HashRouter::emplace(uint256 const& key) -> std::pair void HashRouter::addSuppression(uint256 const& key) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); emplace(key); } @@ -36,7 +48,7 @@ HashRouter::addSuppressionPeer(uint256 const& key, PeerShortID peer) std::pair> HashRouter::addSuppressionPeerWithStatus(uint256 const& key, PeerShortID peer) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto result = emplace(key); result.first.addPeer(peer); @@ -46,7 +58,7 @@ HashRouter::addSuppressionPeerWithStatus(uint256 const& key, PeerShortID peer) bool HashRouter::addSuppressionPeer(uint256 const& key, PeerShortID peer, HashRouterFlags& flags) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto [s, created] = emplace(key); s.addPeer(peer); @@ -61,7 +73,7 @@ HashRouter::shouldProcess( HashRouterFlags& flags, std::chrono::seconds tx_interval) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto result = emplace(key); auto& s = result.first; @@ -73,7 +85,7 @@ HashRouter::shouldProcess( HashRouterFlags HashRouter::getFlags(uint256 const& key) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return emplace(key).first.getFlags(); } @@ -83,7 +95,7 @@ HashRouter::setFlags(uint256 const& key, HashRouterFlags flags) { XRPL_ASSERT(static_cast(flags), "xrpl::HashRouter::setFlags : valid input"); - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto& s = emplace(key).first; @@ -97,7 +109,7 @@ HashRouter::setFlags(uint256 const& key, HashRouterFlags flags) auto HashRouter::shouldRelay(uint256 const& key) -> std::optional> { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto& s = emplace(key).first; diff --git a/src/libxrpl/core/detail/Job.cpp b/src/libxrpl/core/detail/Job.cpp index 7e5ca274b3..069cc7f216 100644 --- a/src/libxrpl/core/detail/Job.cpp +++ b/src/libxrpl/core/detail/Job.cpp @@ -1,6 +1,14 @@ -#include #include +#include +#include +#include + +#include +#include +#include +#include + namespace xrpl { Job::Job() : mType(jtINVALID), mJobIndex(0) diff --git a/src/libxrpl/core/detail/JobQueue.cpp b/src/libxrpl/core/detail/JobQueue.cpp index 2fe5a5b0fd..ff7f46dc7d 100644 --- a/src/libxrpl/core/detail/JobQueue.cpp +++ b/src/libxrpl/core/detail/JobQueue.cpp @@ -1,8 +1,23 @@ -#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { @@ -13,9 +28,7 @@ JobQueue::JobQueue( Logs& logs, perf::PerfLog& perfLog) : m_journal(journal) - , m_lastJob(0) , m_invalidJobData(JobTypes::instance().getInvalid(), collector, logs) - , m_processCount(0) , m_workers(*this, &perfLog, "JobQueue", threadCount) , perfLog_(perfLog) , m_collector(collector) @@ -26,7 +39,7 @@ JobQueue::JobQueue( job_count = m_collector->make_gauge("job_count"); { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); for (auto const& x : JobTypes::instance()) { @@ -52,7 +65,7 @@ JobQueue::~JobQueue() void JobQueue::collect() { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); job_count = m_jobSet.size(); } @@ -78,7 +91,7 @@ JobQueue::addRefCountedJob(JobType type, std::string const& name, JobFunction co "requires no threads"); { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); auto result = m_jobSet.emplace(type, name, ++m_lastJob, data.load(), func); auto const& job = *result.first; @@ -106,9 +119,9 @@ JobQueue::addRefCountedJob(JobType type, std::string const& name, JobFunction co int JobQueue::getJobCount(JobType t) const { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); - JobDataMap::const_iterator c = m_jobData.find(t); + JobDataMap::const_iterator const c = m_jobData.find(t); return (c == m_jobData.end()) ? 0 : c->second.waiting; } @@ -116,9 +129,9 @@ JobQueue::getJobCount(JobType t) const int JobQueue::getJobCountTotal(JobType t) const { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); - JobDataMap::const_iterator c = m_jobData.find(t); + JobDataMap::const_iterator const c = m_jobData.find(t); return (c == m_jobData.end()) ? 0 : (c->second.waiting + c->second.running); } @@ -129,7 +142,7 @@ JobQueue::getJobCountGE(JobType t) const // return the number of jobs at this priority level or greater int ret = 0; - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); for (auto const& x : m_jobData) { @@ -143,7 +156,7 @@ JobQueue::getJobCountGE(JobType t) const std::unique_ptr JobQueue::makeLoadEvent(JobType t, std::string const& name) { - JobDataMap::iterator iter(m_jobData.find(t)); + JobDataMap::iterator const iter(m_jobData.find(t)); XRPL_ASSERT(iter != m_jobData.end(), "xrpl::JobQueue::makeLoadEvent : valid job type input"); if (iter == m_jobData.end()) @@ -158,7 +171,7 @@ JobQueue::addLoadEvents(JobType t, int count, std::chrono::milliseconds elapsed) if (isStopped()) LogicError("JobQueue::addLoadEvents() called after JobQueue stopped"); - JobDataMap::iterator iter(m_jobData.find(t)); + JobDataMap::iterator const iter(m_jobData.find(t)); XRPL_ASSERT(iter != m_jobData.end(), "xrpl::JobQueue::addLoadEvents : valid job type input"); iter->second.load().addSamples(count, elapsed); } @@ -181,7 +194,7 @@ JobQueue::getJson(int c) Json::Value priorities = Json::arrayValue; - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); for (auto& x : m_jobData) { @@ -192,10 +205,10 @@ JobQueue::getJson(int c) JobTypeData& data(x.second); - LoadMonitor::Stats stats(data.stats()); + LoadMonitor::Stats const stats(data.stats()); - int waiting(data.waiting); - int running(data.running); + int const waiting(data.waiting); + int const running(data.running); if ((stats.count != 0) || (waiting != 0) || (stats.latencyPeak != 0ms) || (running != 0)) { @@ -238,7 +251,7 @@ JobQueue::rendezvous() JobTypeData& JobQueue::getJobTypeData(JobType type) { - JobDataMap::iterator c(m_jobData.find(type)); + JobDataMap::iterator const c(m_jobData.find(type)); XRPL_ASSERT(c != m_jobData.end(), "xrpl::JobQueue::getJobTypeData : valid job type input"); // NIKB: This is ugly and I hate it. We must remove jtINVALID completely @@ -338,12 +351,12 @@ JobQueue::processTask(int instance) { Job job; { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); getNextJob(job); ++m_processCount; } type = job.getType(); - JobTypeData& data(getJobTypeData(type)); + JobTypeData const& data(getJobTypeData(type)); JLOG(m_journal.trace()) << "Doing " << data.name() << "job"; // The amount of time that the job was in the queue @@ -365,7 +378,7 @@ JobQueue::processTask(int instance) } { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); // Job should be destroyed before stopping // otherwise destructors with side effects can access // parent objects that are already destroyed. diff --git a/src/libxrpl/core/detail/LoadEvent.cpp b/src/libxrpl/core/detail/LoadEvent.cpp index 1370e9089f..429d8f58fb 100644 --- a/src/libxrpl/core/detail/LoadEvent.cpp +++ b/src/libxrpl/core/detail/LoadEvent.cpp @@ -1,7 +1,11 @@ -#include #include + +#include #include +#include +#include + namespace xrpl { LoadEvent::LoadEvent(LoadMonitor& monitor, std::string const& name, bool shouldStart) diff --git a/src/libxrpl/core/detail/LoadMonitor.cpp b/src/libxrpl/core/detail/LoadMonitor.cpp index 9891bdb8b8..2cf4e1f6ea 100644 --- a/src/libxrpl/core/detail/LoadMonitor.cpp +++ b/src/libxrpl/core/detail/LoadMonitor.cpp @@ -1,6 +1,12 @@ +#include + #include #include -#include +#include +#include + +#include +#include namespace xrpl { @@ -15,16 +21,14 @@ TODO //------------------------------------------------------------------------------ -LoadMonitor::Stats::Stats() : count(0), latencyAvg(0), latencyPeak(0), isOverloaded(false) +LoadMonitor::Stats::Stats() : latencyAvg(0), latencyPeak(0) { } //------------------------------------------------------------------------------ LoadMonitor::LoadMonitor(beast::Journal j) - : mCounts(0) - , mLatencyEvents(0) - , mLatencyMSAvg(0) + : mLatencyMSAvg(0) , mLatencyMSPeak(0) , mTargetLatencyAvg(0) , mTargetLatencyPk(0) @@ -104,7 +108,7 @@ LoadMonitor::addLoadSample(LoadEvent const& s) void LoadMonitor::addSamples(int count, std::chrono::milliseconds latency) { - std::lock_guard sl(mutex_); + std::lock_guard const sl(mutex_); update(); mCounts += count; @@ -136,7 +140,7 @@ LoadMonitor::isOverTarget(std::chrono::milliseconds avg, std::chrono::millisecon bool LoadMonitor::isOver() { - std::lock_guard sl(mutex_); + std::lock_guard const sl(mutex_); update(); @@ -153,7 +157,7 @@ LoadMonitor::getStats() using namespace std::chrono_literals; Stats stats; - std::lock_guard sl(mutex_); + std::lock_guard const sl(mutex_); update(); diff --git a/src/libxrpl/core/detail/Workers.cpp b/src/libxrpl/core/detail/Workers.cpp index 21bf75b958..a787fa6a03 100644 --- a/src/libxrpl/core/detail/Workers.cpp +++ b/src/libxrpl/core/detail/Workers.cpp @@ -1,8 +1,12 @@ -#include -#include -#include #include +#include +#include +#include + +#include +#include + namespace xrpl { Workers::Workers( @@ -13,9 +17,7 @@ Workers::Workers( : m_callback(callback) , perfLog_(perfLog) , m_threadNames(threadNames) - , m_allPaused(true) , m_semaphore(0) - , m_numberOfThreads(0) , m_activeCount(0) , m_pauseCount(0) , m_runningTaskCount(0) @@ -96,11 +98,13 @@ Workers::stop() { setNumberOfThreads(0); + // Wait until all workers have paused AND no tasks are actively running. + // Both conditions are needed because m_allPaused (mutex-protected) and + // m_runningTaskCount (atomic) are not synchronized under the same lock, + // so m_allPaused can momentarily be true while a task is still finishing. std::unique_lock lk{m_mut}; - m_cv.wait(lk, [this] { return m_allPaused; }); + m_cv.wait(lk, [this] { return m_allPaused && numberOfCurrentlyRunningTasks() == 0; }); lk.unlock(); - - XRPL_ASSERT(numberOfCurrentlyRunningTasks() == 0, "xrpl::Workers::stop : zero running tasks"); } void @@ -120,7 +124,7 @@ Workers::deleteWorkers(beast::LockFreeStack& stack) { for (;;) { - Worker* const worker = stack.pop_front(); + Worker const* const worker = stack.pop_front(); if (worker != nullptr) { @@ -137,11 +141,8 @@ Workers::deleteWorkers(beast::LockFreeStack& stack) //------------------------------------------------------------------------------ Workers::Worker::Worker(Workers& workers, std::string const& threadName, int const instance) - : m_workers{workers} - , threadName_{threadName} - , instance_{instance} - , wakeCount_{0} - , shouldExit_{false} + : m_workers{workers}, threadName_{threadName}, instance_{instance} + { thread_ = std::thread{&Workers::Worker::run, this}; } @@ -149,7 +150,7 @@ Workers::Worker::Worker(Workers& workers, std::string const& threadName, int con Workers::Worker::~Worker() { { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; ++wakeCount_; shouldExit_ = true; } @@ -161,7 +162,7 @@ Workers::Worker::~Worker() void Workers::Worker::notify() { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; ++wakeCount_; wakeup_.notify_one(); } @@ -177,7 +178,7 @@ Workers::Worker::run() // if (++m_workers.m_activeCount == 1) { - std::lock_guard lk{m_workers.m_mut}; + std::lock_guard const lk{m_workers.m_mut}; m_workers.m_allPaused = false; } @@ -215,7 +216,18 @@ Workers::Worker::run() // ++m_workers.m_runningTaskCount; m_workers.m_callback.processTask(instance_); - --m_workers.m_runningTaskCount; + + // When the running task count drops to zero, wake stop() which + // may be waiting for both m_allPaused and zero running tasks. + // Locking m_mut before notify_all() prevents a lost wakeup: + // it serializes against the predicate check inside stop()'s + // cv.wait(), ensuring the notification is not missed between + // the predicate evaluation and the actual sleep. + if (--m_workers.m_runningTaskCount == 0) + { + std::lock_guard const lk{m_workers.m_mut}; + m_workers.m_cv.notify_all(); + } } // Any worker that goes into the paused list must @@ -229,7 +241,7 @@ Workers::Worker::run() // if (--m_workers.m_activeCount == 0) { - std::lock_guard lk{m_workers.m_mut}; + std::lock_guard const lk{m_workers.m_mut}; m_workers.m_allPaused = true; m_workers.m_cv.notify_all(); } diff --git a/src/libxrpl/crypto/RFC1751.cpp b/src/libxrpl/crypto/RFC1751.cpp index becd0aab8d..8ea4e7007c 100644 --- a/src/libxrpl/crypto/RFC1751.cpp +++ b/src/libxrpl/crypto/RFC1751.cpp @@ -1,6 +1,7 @@ -#include #include +#include + #include #include #include @@ -312,8 +313,8 @@ RFC1751::wsrch(std::string const& strWord, int iMin, int iMax) while (iResult < 0 && iMin != iMax) { // Have a range to search. - int iMid = iMin + ((iMax - iMin) / 2); - int iDir = strWord.compare(s_dictionary[iMid]); + int const iMid = iMin + ((iMax - iMin) / 2); + int const iDir = strWord.compare(s_dictionary[iMid]); if (iDir == 0) { @@ -349,7 +350,7 @@ RFC1751::etob(std::string& strData, std::vector vsHuman) for (auto& strWord : vsHuman) { - int l = strWord.length(); + int const l = strWord.length(); if (l > 4 || l < 1) return -1; diff --git a/src/libxrpl/crypto/csprng.cpp b/src/libxrpl/crypto/csprng.cpp index 25e24c0b08..dc16c9ac64 100644 --- a/src/libxrpl/crypto/csprng.cpp +++ b/src/libxrpl/crypto/csprng.cpp @@ -1,8 +1,9 @@ -#include #include +#include + +#include #include -#include #include #include @@ -42,7 +43,7 @@ csprng_engine::mix_entropy(void* buffer, std::size_t count) e = rd(); } - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // We add data to the pool, but we conservatively assume that // it contributes no actual entropy. diff --git a/src/libxrpl/git/Git.cpp b/src/libxrpl/git/Git.cpp index 2992852632..e13b2ef693 100644 --- a/src/libxrpl/git/Git.cpp +++ b/src/libxrpl/git/Git.cpp @@ -1,4 +1,4 @@ -#include "xrpl/git/Git.h" +#include #include diff --git a/src/libxrpl/json/JsonPropertyStream.cpp b/src/libxrpl/json/JsonPropertyStream.cpp index fb5a7b32a4..ab94223956 100644 --- a/src/libxrpl/json/JsonPropertyStream.cpp +++ b/src/libxrpl/json/JsonPropertyStream.cpp @@ -1,4 +1,5 @@ #include + #include #include diff --git a/src/libxrpl/json/Output.cpp b/src/libxrpl/json/Output.cpp index 626dbeb4b8..e588d21d3c 100644 --- a/src/libxrpl/json/Output.cpp +++ b/src/libxrpl/json/Output.cpp @@ -1,4 +1,5 @@ #include + #include #include diff --git a/src/libxrpl/json/Writer.cpp b/src/libxrpl/json/Writer.cpp index 796ec35dfd..a95ddd756d 100644 --- a/src/libxrpl/json/Writer.cpp +++ b/src/libxrpl/json/Writer.cpp @@ -1,11 +1,12 @@ +#include + #include #include -#include #include #include #include -#include +#include // IWYU pragma: keep #include #include #include @@ -80,7 +81,7 @@ public: void start(CollectionType ct) { - char ch = (ct == array) ? openBracket : openBrace; + char const ch = (ct == array) ? openBracket : openBrace; output({&ch, 1}); stack_.push(Collection()); stack_.top().type = ct; diff --git a/src/libxrpl/json/json_reader.cpp b/src/libxrpl/json/json_reader.cpp index 6475a5b68b..76035a1cfe 100644 --- a/src/libxrpl/json/json_reader.cpp +++ b/src/libxrpl/json/json_reader.cpp @@ -1,5 +1,6 @@ -#include #include + +#include #include #include @@ -93,7 +94,7 @@ Reader::parse(char const* beginDoc, char const* endDoc, Value& root) nodes_.pop(); nodes_.push(&root); - bool successful = readValue(0); + bool const successful = readValue(0); Token token{}; skipCommentTokens(token); @@ -186,7 +187,7 @@ Reader::readToken(Token& token) { skipSpaces(); token.start_ = current_; - Char c = getNextChar(); + Char const c = getNextChar(); bool ok = true; switch (c) @@ -275,7 +276,7 @@ Reader::skipSpaces() { while (current_ != end_) { - Char c = *current_; + Char const c = *current_; if (c == ' ' || c == '\t' || c == '\r' || c == '\n') { @@ -309,7 +310,7 @@ Reader::match(Location pattern, int patternLength) bool Reader::readComment() { - Char c = getNextChar(); + Char const c = getNextChar(); if (c == '*') return readCStyleComment(); @@ -325,7 +326,7 @@ Reader::readCStyleComment() { while (current_ != end_) { - Char c = getNextChar(); + Char const c = getNextChar(); if (c == '*' && *current_ == '/') break; @@ -339,7 +340,7 @@ Reader::readCppStyleComment() { while (current_ != end_) { - Char c = getNextChar(); + Char const c = getNextChar(); if (c == '\r' || c == '\n') break; @@ -444,7 +445,7 @@ Reader::readObject(Token& tokenStart, unsigned depth) Value& value = currentValue()[name]; nodes_.push(&value); - bool ok = readValue(depth + 1); + bool const ok = readValue(depth + 1); nodes_.pop(); if (!ok) // error already set @@ -506,7 +507,8 @@ Reader::readArray(Token& tokenStart, unsigned depth) ok = readToken(token); } - bool badTokenType = (token.type_ != tokenArraySeparator && token.type_ != tokenArrayEnd); + bool const badTokenType = + (token.type_ != tokenArraySeparator && token.type_ != tokenArrayEnd); if (!ok || badTokenType) { @@ -525,7 +527,7 @@ bool Reader::decodeNumber(Token& token) { Location current = token.start_; - bool isNegative = *current == '-'; + bool const isNegative = *current == '-'; if (isNegative) ++current; @@ -546,7 +548,7 @@ Reader::decodeNumber(Token& token) while (current < token.end_ && (value <= Value::maxUInt)) { - Char c = *current++; + Char const c = *current++; if (c < '0' || c > '9') { @@ -606,7 +608,7 @@ Reader::decodeDouble(Token& token) double value = 0; int const bufferSize = 32; int count = 0; - int length = int(token.end_ - token.start_); + int const length = int(token.end_ - token.start_); // Sanity check to avoid buffer overflow exploits. if (length < 0) { @@ -627,7 +629,7 @@ Reader::decodeDouble(Token& token) } else { - std::string buffer(token.start_, token.end_); + std::string const buffer(token.start_, token.end_); count = sscanf(buffer.c_str(), format, &value); } if (count != 1) @@ -657,7 +659,7 @@ Reader::decodeString(Token& token, std::string& decoded) while (current != end) { - Char c = *current++; + Char const c = *current++; if (c == '"') { @@ -668,7 +670,7 @@ Reader::decodeString(Token& token, std::string& decoded) if (current == end) return addError("Empty escape sequence in string", token, current); - Char escape = *current++; + Char const escape = *current++; switch (escape) { @@ -783,7 +785,7 @@ Reader::decodeUnicodeEscapeSequence( for (int index = 0; index < 4; ++index) { - Char c = *current++; + Char const c = *current++; unicode *= 16; if (c >= '0' && c <= '9') @@ -825,7 +827,7 @@ Reader::addError(std::string const& message, Token& token, Location extra) bool Reader::recoverFromError(TokenType skipUntilToken) { - int errorCount = int(errors_.size()); + int const errorCount = int(errors_.size()); Token skip{}; while (true) @@ -872,7 +874,7 @@ Reader::getLocationLineAndColumn(Location location, int& line, int& column) cons while (current < location && current != end_) { - Char c = *current++; + Char const c = *current++; if (c == '\r') { @@ -924,7 +926,7 @@ std::istream& operator>>(std::istream& sin, Value& root) { Json::Reader reader; - bool ok = reader.parse(sin, root); + bool const ok = reader.parse(sin, root); // XRPL_ASSERT(ok, "Json::operator>>() : parse succeeded"); if (!ok) diff --git a/src/libxrpl/json/json_value.cpp b/src/libxrpl/json/json_value.cpp index 988a25a3ff..966be78794 100644 --- a/src/libxrpl/json/json_value.cpp +++ b/src/libxrpl/json/json_value.cpp @@ -1,13 +1,17 @@ +#include + +#include #include #include #include #include -#include #include #include +#include #include #include +#include #include #include @@ -60,6 +64,7 @@ public: static ValueAllocator*& valueAllocator() { + // NOLINTNEXTLINE(misc-const-correctness) static ValueAllocator* valueAllocator = new DefaultValueAllocator; return valueAllocator; } @@ -333,11 +338,11 @@ Value::swap(Value& other) noexcept { std::swap(value_, other.value_); - ValueType temp = type_; + ValueType const temp = type_; type_ = other.type_; other.type_ = temp; - int temp2 = allocated_; + int const temp2 = allocated_; allocated_ = other.allocated_; other.allocated_ = temp2; } @@ -401,7 +406,7 @@ operator<(Value const& x, Value const& y) case arrayValue: case objectValue: { - if (int signum = int(x.value_.map_->size()) - y.value_.map_->size()) + if (int const signum = int(x.value_.map_->size()) - y.value_.map_->size()) return signum < 0; return *x.value_.map_ < *y.value_.map_; @@ -848,13 +853,13 @@ Value::operator[](UInt index) if (type_ == nullValue) *this = Value(arrayValue); - CZString key(index); + CZString const key(index); ObjectValues::iterator it = value_.map_->lower_bound(key); if (it != value_.map_->end() && (*it).first == key) return (*it).second; - ObjectValues::value_type defaultValue(key, null); + ObjectValues::value_type const defaultValue(key, null); it = value_.map_->insert(it, defaultValue); return (*it).second; } @@ -869,8 +874,8 @@ Value::operator[](UInt index) const if (type_ == nullValue) return null; - CZString key(index); - ObjectValues::const_iterator it = value_.map_->find(key); + CZString const key(index); + ObjectValues::const_iterator const it = value_.map_->find(key); if (it == value_.map_->end()) return null; @@ -893,13 +898,13 @@ Value::resolveReference(char const* key, bool isStatic) if (type_ == nullValue) *this = Value(objectValue); - CZString actualKey(key, isStatic ? CZString::noDuplication : CZString::duplicateOnCopy); + CZString const actualKey(key, isStatic ? CZString::noDuplication : CZString::duplicateOnCopy); ObjectValues::iterator it = value_.map_->lower_bound(actualKey); if (it != value_.map_->end() && (*it).first == actualKey) return (*it).second; - ObjectValues::value_type defaultValue(actualKey, null); + ObjectValues::value_type const defaultValue(actualKey, null); it = value_.map_->insert(it, defaultValue); Value& value = (*it).second; return value; @@ -928,8 +933,8 @@ Value::operator[](char const* key) const if (type_ == nullValue) return null; - CZString actualKey(key, CZString::noDuplication); - ObjectValues::const_iterator it = value_.map_->find(actualKey); + CZString const actualKey(key, CZString::noDuplication); + ObjectValues::const_iterator const it = value_.map_->find(actualKey); if (it == value_.map_->end()) return null; @@ -995,8 +1000,8 @@ Value::removeMember(char const* key) if (type_ == nullValue) return null; - CZString actualKey(key, CZString::noDuplication); - ObjectValues::iterator it = value_.map_->find(actualKey); + CZString const actualKey(key, CZString::noDuplication); + ObjectValues::iterator const it = value_.map_->find(actualKey); if (it == value_.map_->end()) return null; @@ -1046,7 +1051,7 @@ Value::getMemberNames() const Members members; members.reserve(value_.map_->size()); ObjectValues::const_iterator it = value_.map_->begin(); - ObjectValues::const_iterator itEnd = value_.map_->end(); + ObjectValues::const_iterator const itEnd = value_.map_->end(); for (; it != itEnd; ++it) members.push_back(std::string((*it).first.c_str())); diff --git a/src/libxrpl/json/json_writer.cpp b/src/libxrpl/json/json_writer.cpp index b51da5bb68..dc551458c3 100644 --- a/src/libxrpl/json/json_writer.cpp +++ b/src/libxrpl/json/json_writer.cpp @@ -1,7 +1,8 @@ +#include + #include #include #include -#include #include #include @@ -47,8 +48,8 @@ std::string valueToString(Int value) { char buffer[32]; - char* current = buffer + sizeof(buffer); - bool isNegative = value < 0; + char* current = buffer + sizeof(buffer); // NOLINT(misc-const-correctness) + bool const isNegative = value < 0; if (isNegative) value = -value; @@ -66,7 +67,7 @@ std::string valueToString(UInt value) { char buffer[32]; - char* current = buffer + sizeof(buffer); + char* current = buffer + sizeof(buffer); // NOLINT(misc-const-correctness) uintToString(value, current); XRPL_ASSERT(current >= buffer, "Json::valueToString(UInt) : buffer check"); return current; @@ -106,7 +107,7 @@ valueToQuotedString(char const* value) // We have to walk value and escape any special characters. // Appending to std::string is not efficient, but this should be rare. // (Note: forward slashes are *not* rare, but I am not escaping them.) - unsigned maxsize = (strlen(value) * 2) + 3; // all-escaped+quotes+NULL + unsigned const maxsize = (strlen(value) * 2) + 3; // all-escaped+quotes+NULL std::string result; result.reserve(maxsize); // to avoid lots of mallocs result += "\""; @@ -213,7 +214,7 @@ FastWriter::writeValue(Value const& value) case arrayValue: { document_ += "["; - int size = value.size(); + int const size = value.size(); for (int index = 0; index < size; ++index) { @@ -252,7 +253,7 @@ FastWriter::writeValue(Value const& value) // Class StyledWriter // ////////////////////////////////////////////////////////////////// -StyledWriter::StyledWriter() : rightMargin_(74), indentSize_(3) +StyledWriter::StyledWriter() { } @@ -338,7 +339,7 @@ StyledWriter::writeValue(Value const& value) void StyledWriter::writeArrayValue(Value const& value) { - unsigned size = value.size(); + unsigned const size = value.size(); if (size == 0) { @@ -346,13 +347,13 @@ StyledWriter::writeArrayValue(Value const& value) } else { - bool isArrayMultiLine = isMultilineArray(value); + bool const isArrayMultiLine = isMultilineArray(value); if (isArrayMultiLine) { writeWithIndent("["); indent(); - bool hasChildValue = !childValues_.empty(); + bool const hasChildValue = !childValues_.empty(); unsigned index = 0; while (true) @@ -401,7 +402,7 @@ StyledWriter::writeArrayValue(Value const& value) bool StyledWriter::isMultilineArray(Value const& value) { - int size = value.size(); + int const size = value.size(); bool isMultiLine = size * 3 >= rightMargin_; childValues_.clear(); @@ -449,7 +450,7 @@ StyledWriter::writeIndent() { if (!document_.empty()) { - char last = document_[document_.length() - 1]; + char const last = document_[document_.length() - 1]; if (last == ' ') // already indented return; @@ -486,8 +487,7 @@ StyledWriter::unindent() // Class StyledStreamWriter // ////////////////////////////////////////////////////////////////// -StyledStreamWriter::StyledStreamWriter(std::string indentation) - : document_(nullptr), rightMargin_(74), indentation_(indentation) +StyledStreamWriter::StyledStreamWriter(std::string indentation) : indentation_(indentation) { } @@ -573,7 +573,7 @@ StyledStreamWriter::writeValue(Value const& value) void StyledStreamWriter::writeArrayValue(Value const& value) { - unsigned size = value.size(); + unsigned const size = value.size(); if (size == 0) { @@ -581,13 +581,13 @@ StyledStreamWriter::writeArrayValue(Value const& value) } else { - bool isArrayMultiLine = isMultilineArray(value); + bool const isArrayMultiLine = isMultilineArray(value); if (isArrayMultiLine) { writeWithIndent("["); indent(); - bool hasChildValue = !childValues_.empty(); + bool const hasChildValue = !childValues_.empty(); unsigned index = 0; while (true) @@ -636,7 +636,7 @@ StyledStreamWriter::writeArrayValue(Value const& value) bool StyledStreamWriter::isMultilineArray(Value const& value) { - int size = value.size(); + int const size = value.size(); bool isMultiLine = size * 3 >= rightMargin_; childValues_.clear(); diff --git a/src/libxrpl/json/to_string.cpp b/src/libxrpl/json/to_string.cpp index d3b35308a0..1d1a609366 100644 --- a/src/libxrpl/json/to_string.cpp +++ b/src/libxrpl/json/to_string.cpp @@ -1,6 +1,7 @@ -#include #include +#include + #include namespace Json { diff --git a/src/libxrpl/ledger/AcceptedLedgerTx.cpp b/src/libxrpl/ledger/AcceptedLedgerTx.cpp index 005d48e6f6..e609f5bdc8 100644 --- a/src/libxrpl/ledger/AcceptedLedgerTx.cpp +++ b/src/libxrpl/ledger/AcceptedLedgerTx.cpp @@ -1,11 +1,24 @@ -#include -#include #include -#include -#include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include + namespace xrpl { AcceptedLedgerTx::AcceptedLedgerTx( @@ -43,13 +56,14 @@ AcceptedLedgerTx::AcceptedLedgerTx( auto const amount = mTxn->getFieldAmount(sfTakerGets); // If the offer create is not self funded then add the owner balance - if (account != amount.issue().account) + if (account != amount.getIssuer()) { auto const ownerFunds = accountFunds( *ledger, account, amount, fhIGNORE_FREEZE, + ahIGNORE_AUTH, beast::Journal{beast::Journal::getNullSink()}); mJson[jss::transaction][jss::owner_funds] = ownerFunds.getText(); } diff --git a/src/libxrpl/ledger/ApplyStateTable.cpp b/src/libxrpl/ledger/ApplyStateTable.cpp index a48c3910e1..b4eb572d12 100644 --- a/src/libxrpl/ledger/ApplyStateTable.cpp +++ b/src/libxrpl/ledger/ApplyStateTable.cpp @@ -1,9 +1,36 @@ -#include -#include -#include #include -#include -#include + +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace detail { @@ -127,8 +154,8 @@ ApplyStateTable::apply( auto curNode = item.second.second; if ((type == &sfModifiedNode) && (*curNode == *origNode)) continue; - std::uint16_t nodeType = curNode ? curNode->getFieldU16(sfLedgerEntryType) - : origNode->getFieldU16(sfLedgerEntryType); + std::uint16_t const nodeType = curNode ? curNode->getFieldU16(sfLedgerEntryType) + : origNode->getFieldU16(sfLedgerEntryType); meta.setAffectedNode(item.first, *type, nodeType); if (type == &sfDeletedNode) { @@ -374,14 +401,14 @@ ApplyStateTable::erase(ReadView const& base, std::shared_ptr const& sle) { auto const iter = items_.find(sle->key()); if (iter == items_.end()) - LogicError("ApplyStateTable::erase: missing key"); + Throw("ApplyStateTable::erase: missing key"); auto& item = iter->second; if (item.second != sle) - LogicError("ApplyStateTable::erase: unknown SLE"); + Throw("ApplyStateTable::erase: unknown SLE"); switch (item.first) { case Action::erase: - LogicError("ApplyStateTable::erase: double erase"); + Throw("ApplyStateTable::erase: double erase"); break; case Action::insert: items_.erase(iter); @@ -405,7 +432,7 @@ ApplyStateTable::rawErase(ReadView const& base, std::shared_ptr const& sle) switch (item.first) { case Action::erase: - LogicError("ApplyStateTable::rawErase: double erase"); + Throw("ApplyStateTable::rawErase: double erase"); break; case Action::insert: items_.erase(result.first); @@ -436,11 +463,11 @@ ApplyStateTable::insert(ReadView const& base, std::shared_ptr const& sle) switch (item.first) { case Action::cache: - LogicError("ApplyStateTable::insert: already cached"); + Throw("ApplyStateTable::insert: already cached"); case Action::insert: - LogicError("ApplyStateTable::insert: already inserted"); + Throw("ApplyStateTable::insert: already inserted"); case Action::modify: - LogicError("ApplyStateTable::insert: already modified"); + Throw("ApplyStateTable::insert: already modified"); case Action::erase: break; } @@ -466,7 +493,7 @@ ApplyStateTable::replace(ReadView const& base, std::shared_ptr const& sle) switch (item.first) { case Action::erase: - LogicError("ApplyStateTable::replace: already erased"); + Throw("ApplyStateTable::replace: already erased"); case Action::cache: item.first = Action::modify; break; @@ -482,14 +509,14 @@ ApplyStateTable::update(ReadView const& base, std::shared_ptr const& sle) { auto const iter = items_.find(sle->key()); if (iter == items_.end()) - LogicError("ApplyStateTable::update: missing key"); + Throw("ApplyStateTable::update: missing key"); auto& item = iter->second; if (item.second != sle) - LogicError("ApplyStateTable::update: unknown SLE"); + Throw("ApplyStateTable::update: unknown SLE"); switch (item.first) { case Action::erase: - LogicError("ApplyStateTable::update: erased"); + Throw("ApplyStateTable::update: erased"); break; case Action::cache: item.first = Action::modify; diff --git a/src/libxrpl/ledger/ApplyView.cpp b/src/libxrpl/ledger/ApplyView.cpp index fe2e046b26..a95005fe64 100644 --- a/src/libxrpl/ledger/ApplyView.cpp +++ b/src/libxrpl/ledger/ApplyView.cpp @@ -1,9 +1,25 @@ +#include + +#include #include #include -#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include namespace xrpl { @@ -32,7 +48,7 @@ createRoot( auto findPreviousPage(ApplyView& view, Keylet const& directory, SLE::ref start) { - std::uint64_t page = start->getFieldU64(sfIndexPrevious); + std::uint64_t const page = start->getFieldU64(sfIndexPrevious); auto node = start; @@ -40,9 +56,9 @@ findPreviousPage(ApplyView& view, Keylet const& directory, SLE::ref start) { node = view.peek(keylet::page(directory, page)); if (!node) - { // LCOV_EXCL_START - LogicError("Directory chain: root back-pointer broken."); - // LCOV_EXCL_STOP + { + Throw( + "Directory chain: root back-pointer broken."); // LCOV_EXCL_LINE } } @@ -62,21 +78,20 @@ insertKey( if (preserveOrder) { if (std::find(indexes.begin(), indexes.end(), key) != indexes.end()) - LogicError("dirInsert: double insertion"); // LCOV_EXCL_LINE + Throw("dirInsert: double insertion"); // LCOV_EXCL_LINE indexes.push_back(key); } else { - // We can't be sure if this page is already sorted because - // it may be a legacy page we haven't yet touched. Take - // the time to sort it. + // We can't be sure if this page is already sorted because it may be a + // legacy page we haven't yet touched. Take the time to sort it. std::sort(indexes.begin(), indexes.end()); auto pos = std::lower_bound(indexes.begin(), indexes.end(), key); if (pos != indexes.end() && key == *pos) - LogicError("dirInsert: double insertion"); // LCOV_EXCL_LINE + Throw("dirInsert: double insertion"); // LCOV_EXCL_LINE indexes.insert(pos, key); } @@ -129,8 +144,7 @@ insertPage( node->setFieldH256(sfRootIndex, directory.key); node->setFieldV256(sfIndexes, indexes); - // Save some space by not specifying the value 0 since - // it's the default. + // Save some space by not specifying the value 0 since it's the default. if (page != 1) node->setFieldU64(sfIndexPrevious, page - 1); XRPL_ASSERT_PARTS(!nextPage, "xrpl::directory::insertPage", "nextPage has default value"); @@ -199,28 +213,24 @@ ApplyView::emptyDirDelete(Keylet const& directory) auto nextPage = node->getFieldU64(sfIndexNext); if (nextPage == rootPage && prevPage != rootPage) - LogicError("Directory chain: fwd link broken"); // LCOV_EXCL_LINE + Throw("Directory chain: fwd link broken"); // LCOV_EXCL_LINE if (prevPage == rootPage && nextPage != rootPage) - LogicError("Directory chain: rev link broken"); // LCOV_EXCL_LINE + Throw("Directory chain: rev link broken"); // LCOV_EXCL_LINE - // Older versions of the code would, in some cases, allow the last - // page to be empty. Remove such pages: + // Older versions of the code would, in some cases, allow the last page to + // be empty. Remove such pages: if (nextPage == prevPage && nextPage != rootPage) { auto last = peek(keylet::page(directory, nextPage)); if (!last) - { // LCOV_EXCL_START - LogicError("Directory chain: fwd link broken."); - // LCOV_EXCL_STOP - } + Throw("Directory chain: fwd link broken."); // LCOV_EXCL_LINE if (!last->getFieldV256(sfIndexes).empty()) return false; - // Update the first page's linked list and - // mark it as updated. + // Update the first page's linked list and mark it as updated. node->setFieldU64(sfIndexNext, rootPage); node->setFieldU64(sfIndexPrevious, rootPage); update(node); @@ -228,8 +238,7 @@ ApplyView::emptyDirDelete(Keylet const& directory) // And erase the empty last page: erase(last); - // Make sure our local values reflect the - // updated information: + // Make sure our local values reflect the updated information: nextPage = rootPage; prevPage = rootPage; } @@ -269,46 +278,33 @@ ApplyView::dirRemove(Keylet const& directory, std::uint64_t page, uint256 const& return true; } - // The current page is now empty; check if it can be - // deleted, and, if so, whether the entire directory - // can now be removed. + // The current page is now empty; check if it can be deleted, and, if so, + // whether the entire directory can now be removed. auto prevPage = node->getFieldU64(sfIndexPrevious); auto nextPage = node->getFieldU64(sfIndexNext); - // The first page is the directory's root node and is - // treated specially: it can never be deleted even if - // it is empty, unless we plan on removing the entire - // directory. + // The first page is the directory's root node and is treated specially: it + // can never be deleted even if it is empty, unless we plan on removing the + // entire directory. if (page == rootPage) { if (nextPage == page && prevPage != page) - { // LCOV_EXCL_START - LogicError("Directory chain: fwd link broken"); - // LCOV_EXCL_STOP - } + Throw("Directory chain: fwd link broken"); // LCOV_EXCL_LINE if (prevPage == page && nextPage != page) - { // LCOV_EXCL_START - LogicError("Directory chain: rev link broken"); - // LCOV_EXCL_STOP - } + Throw("Directory chain: rev link broken"); // LCOV_EXCL_LINE - // Older versions of the code would, in some cases, - // allow the last page to be empty. Remove such - // pages if we stumble on them: + // Older versions of the code would, in some cases, allow the last page + // to be empty. Remove such pages if we stumble on them: if (nextPage == prevPage && nextPage != page) { auto last = peek(keylet::page(directory, nextPage)); if (!last) - { // LCOV_EXCL_START - LogicError("Directory chain: fwd link broken."); - // LCOV_EXCL_STOP - } + Throw("Directory chain: fwd link broken."); // LCOV_EXCL_LINE if (last->getFieldV256(sfIndexes).empty()) { - // Update the first page's linked list and - // mark it as updated. + // Update the first page's linked list and mark it as updated. node->setFieldU64(sfIndexNext, page); node->setFieldU64(sfIndexPrevious, page); update(node); @@ -316,8 +312,7 @@ ApplyView::dirRemove(Keylet const& directory, std::uint64_t page, uint256 const& // And erase the empty last page: erase(last); - // Make sure our local values reflect the - // updated information: + // Make sure our local values reflect the updated information: nextPage = page; prevPage = page; } @@ -335,25 +330,24 @@ ApplyView::dirRemove(Keylet const& directory, std::uint64_t page, uint256 const& // This can never happen for nodes other than the root: if (nextPage == page) - LogicError("Directory chain: fwd link broken"); // LCOV_EXCL_LINE + Throw("Directory chain: fwd link broken"); // LCOV_EXCL_LINE if (prevPage == page) - LogicError("Directory chain: rev link broken"); // LCOV_EXCL_LINE + Throw("Directory chain: rev link broken"); // LCOV_EXCL_LINE - // This node isn't the root, so it can either be in the - // middle of the list, or at the end. Unlink it first - // and then check if that leaves the list with only a - // root: + // This node isn't the root, so it can either be in the middle of the list, + // or at the end. Unlink it first and then check if that leaves the list + // with only a root: auto prev = peek(keylet::page(directory, prevPage)); if (!prev) - LogicError("Directory chain: fwd link broken."); // LCOV_EXCL_LINE + Throw("Directory chain: fwd link broken."); // LCOV_EXCL_LINE // Fix previous to point to its new next. prev->setFieldU64(sfIndexNext, nextPage); update(prev); auto next = peek(keylet::page(directory, nextPage)); if (!next) - LogicError("Directory chain: rev link broken."); // LCOV_EXCL_LINE + Throw("Directory chain: rev link broken."); // LCOV_EXCL_LINE // Fix next to point to its new previous. next->setFieldU64(sfIndexPrevious, prevPage); update(next); @@ -361,13 +355,12 @@ ApplyView::dirRemove(Keylet const& directory, std::uint64_t page, uint256 const& // The page is no longer linked. Delete it. erase(node); - // Check whether the next page is the last page and, if - // so, whether it's empty. If it is, delete it. + // Check whether the next page is the last page and, if so, whether it's + // empty. If it is, delete it. if (nextPage != rootPage && next->getFieldU64(sfIndexNext) == rootPage && next->getFieldV256(sfIndexes).empty()) { - // Since next doesn't point to the root, it - // can't be pointing to prev. + // Since next doesn't point to the root, it can't be pointing to prev. erase(next); // The previous page is now the last page: @@ -377,18 +370,16 @@ ApplyView::dirRemove(Keylet const& directory, std::uint64_t page, uint256 const& // And the root points to the last page: auto root = peek(keylet::page(directory, rootPage)); if (!root) - { // LCOV_EXCL_START - LogicError("Directory chain: root link broken."); - // LCOV_EXCL_STOP - } + Throw("Directory chain: root link broken."); // LCOV_EXCL_LINE + root->setFieldU64(sfIndexPrevious, prevPage); update(root); nextPage = rootPage; } - // If we're not keeping the root, then check to see if - // it's left empty. If so, delete it as well. + // If we're not keeping the root, then check to see if it's left empty. + // If so, delete it as well. if (!keepRoot && nextPage == rootPage && prevPage == rootPage) { if (prev->getFieldV256(sfIndexes).empty()) diff --git a/src/libxrpl/ledger/ApplyViewBase.cpp b/src/libxrpl/ledger/ApplyViewBase.cpp index a5bea68759..5ad8b28f4c 100644 --- a/src/libxrpl/ledger/ApplyViewBase.cpp +++ b/src/libxrpl/ledger/ApplyViewBase.cpp @@ -1,5 +1,18 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + namespace xrpl { namespace detail { diff --git a/src/libxrpl/ledger/ApplyViewImpl.cpp b/src/libxrpl/ledger/ApplyViewImpl.cpp index eca9043db8..9650190a3e 100644 --- a/src/libxrpl/ledger/ApplyViewImpl.cpp +++ b/src/libxrpl/ledger/ApplyViewImpl.cpp @@ -1,5 +1,21 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + namespace xrpl { ApplyViewImpl::ApplyViewImpl(ReadView const* base, ApplyFlags flags) : ApplyViewBase(base, flags) diff --git a/src/libxrpl/ledger/BookDirs.cpp b/src/libxrpl/ledger/BookDirs.cpp index 2bdf6ac9a5..cbe93a159b 100644 --- a/src/libxrpl/ledger/BookDirs.cpp +++ b/src/libxrpl/ledger/BookDirs.cpp @@ -1,8 +1,15 @@ #include -#include + +#include +#include +#include +#include #include +#include #include +#include + namespace xrpl { BookDirs::BookDirs(ReadView const& view, Book const& book) diff --git a/src/libxrpl/ledger/BookListeners.cpp b/src/libxrpl/ledger/BookListeners.cpp index 22b78e46bb..36d02427bc 100644 --- a/src/libxrpl/ledger/BookListeners.cpp +++ b/src/libxrpl/ledger/BookListeners.cpp @@ -1,25 +1,33 @@ #include +#include +#include +#include +#include + +#include +#include + namespace xrpl { void BookListeners::addSubscriber(InfoSub::ref sub) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); mListeners[sub->getSeq()] = sub; } void BookListeners::removeSubscriber(std::uint64_t seq) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); mListeners.erase(seq); } void BookListeners::publish(MultiApiJson const& jvObj, hash_set& havePublished) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); auto it = mListeners.cbegin(); while (it != mListeners.cend()) diff --git a/src/libxrpl/ledger/CachedView.cpp b/src/libxrpl/ledger/CachedView.cpp index 5c15ccdac4..717fd88ae9 100644 --- a/src/libxrpl/ledger/CachedView.cpp +++ b/src/libxrpl/ledger/CachedView.cpp @@ -1,6 +1,16 @@ -#include #include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include + +#include +#include +#include + namespace xrpl { namespace detail { @@ -21,7 +31,7 @@ CachedViewImpl::read(Keylet const& k) const auto const digest = [&]() -> std::optional { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const iter = map_.find(k.key); if (iter != map_.end()) { @@ -57,7 +67,7 @@ CachedViewImpl::read(Keylet const& k) const // Avoid acquiring this lock unless necessary. It is only necessary if // the key was not found in the map_. The lock is needed to add the key // and digest. - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); map_.emplace(k.key, *digest); } if (!sle || !k.check(*sle)) diff --git a/src/libxrpl/ledger/CanonicalTXSet.cpp b/src/libxrpl/ledger/CanonicalTXSet.cpp index 72f45731fb..be5006d33b 100644 --- a/src/libxrpl/ledger/CanonicalTXSet.cpp +++ b/src/libxrpl/ledger/CanonicalTXSet.cpp @@ -1,5 +1,15 @@ #include +#include +#include +#include +#include +#include + +#include +#include +#include + namespace xrpl { bool diff --git a/src/libxrpl/ledger/Dir.cpp b/src/libxrpl/ledger/Dir.cpp index a27171fe12..bf5eaf02fd 100644 --- a/src/libxrpl/ledger/Dir.cpp +++ b/src/libxrpl/ledger/Dir.cpp @@ -1,5 +1,16 @@ #include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + namespace xrpl { using const_iterator = Dir::const_iterator; diff --git a/src/libxrpl/ledger/Ledger.cpp b/src/libxrpl/ledger/Ledger.cpp index 87f6350ce1..62bfed0e85 100644 --- a/src/libxrpl/ledger/Ledger.cpp +++ b/src/libxrpl/ledger/Ledger.cpp @@ -1,17 +1,49 @@ -#include -#include -#include -#include #include + +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include #include #include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include @@ -461,14 +493,14 @@ void Ledger::rawErase(std::shared_ptr const& sle) { if (!stateMap_.delItem(sle->key())) - LogicError("Ledger::rawErase: key not found"); + Throw("Ledger::rawErase: key not found"); } void Ledger::rawErase(uint256 const& key) { if (!stateMap_.delItem(key)) - LogicError("Ledger::rawErase: key not found"); + Throw("Ledger::rawErase: key not found"); } void @@ -478,7 +510,7 @@ Ledger::rawInsert(std::shared_ptr const& sle) sle->add(ss); if (!stateMap_.addGiveItem( SHAMapNodeType::tnACCOUNT_STATE, make_shamapitem(sle->key(), ss.slice()))) - LogicError("Ledger::rawInsert: key already exists"); + Throw("Ledger::rawInsert: key already exists"); } void @@ -488,7 +520,7 @@ Ledger::rawReplace(std::shared_ptr const& sle) sle->add(ss); if (!stateMap_.updateGiveItem( SHAMapNodeType::tnACCOUNT_STATE, make_shamapitem(sle->key(), ss.slice()))) - LogicError("Ledger::rawReplace: key not found"); + Throw("Ledger::rawReplace: key not found"); } void @@ -504,7 +536,7 @@ Ledger::rawTxInsert( s.addVL(txn->peekData()); s.addVL(metaData->peekData()); if (!txMap_.addGiveItem(SHAMapNodeType::tnTRANSACTION_MD, make_shamapitem(key, s.slice()))) - LogicError("duplicate_tx: " + to_string(key)); + Throw("duplicate_tx: " + to_string(key)); } uint256 @@ -522,7 +554,7 @@ Ledger::rawTxInsertWithHash( auto item = make_shamapitem(key, s.slice()); auto hash = sha512Half(HashPrefix::txNode, item->slice(), item->key()); if (!txMap_.addGiveItem(SHAMapNodeType::tnTRANSACTION_MD, std::move(item))) - LogicError("duplicate_tx: " + to_string(key)); + Throw("duplicate_tx: " + to_string(key)); return hash; } @@ -798,7 +830,7 @@ Ledger::updateSkipList() if (header_.seq == 0) // genesis ledger has no previous ledger return; - std::uint32_t prevIndex = header_.seq - 1; + std::uint32_t const prevIndex = header_.seq - 1; // update record of every 256th ledger if ((prevIndex & 0xff) == 0) diff --git a/src/libxrpl/ledger/OpenView.cpp b/src/libxrpl/ledger/OpenView.cpp index b5e358053c..ae530f01ff 100644 --- a/src/libxrpl/ledger/OpenView.cpp +++ b/src/libxrpl/ledger/OpenView.cpp @@ -1,6 +1,27 @@ -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include + namespace xrpl { class OpenView::txs_iter_impl : public txs_type::iter_base @@ -247,7 +268,7 @@ OpenView::rawTxInsert( auto const result = txs_.emplace( std::piecewise_construct, std::forward_as_tuple(key), std::forward_as_tuple(txn, metaData)); if (!result.second) - LogicError("rawTxInsert: duplicate TX id: " + to_string(key)); + Throw("rawTxInsert: duplicate TX id: " + to_string(key)); } } // namespace xrpl diff --git a/src/libxrpl/ledger/PaymentSandbox.cpp b/src/libxrpl/ledger/PaymentSandbox.cpp index a56d730b5a..c017449331 100644 --- a/src/libxrpl/ledger/PaymentSandbox.cpp +++ b/src/libxrpl/ledger/PaymentSandbox.cpp @@ -1,14 +1,32 @@ -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace detail { auto -DeferredCredits::makeKey(AccountID const& a1, AccountID const& a2, Currency const& c) -> Key +DeferredCredits::makeKeyIOU(AccountID const& a1, AccountID const& a2, Currency const& c) -> KeyIOU { if (a1 < a2) { @@ -19,21 +37,23 @@ DeferredCredits::makeKey(AccountID const& a1, AccountID const& a2, Currency cons } void -DeferredCredits::credit( +DeferredCredits::creditIOU( AccountID const& sender, AccountID const& receiver, STAmount const& amount, STAmount const& preCreditSenderBalance) { XRPL_ASSERT( - sender != receiver, "xrpl::detail::DeferredCredits::credit : sender is not receiver"); - XRPL_ASSERT(!amount.negative(), "xrpl::detail::DeferredCredits::credit : positive amount"); + sender != receiver, "xrpl::detail::DeferredCredits::creditIOU : sender is not receiver"); + XRPL_ASSERT(!amount.negative(), "xrpl::detail::DeferredCredits::creditIOU : positive amount"); + XRPL_ASSERT( + amount.holds(), "xrpl::detail::DeferredCredits::creditIOU : amount is for Issue"); - auto const k = makeKey(sender, receiver, amount.getCurrency()); - auto i = credits_.find(k); - if (i == credits_.end()) + auto const k = makeKeyIOU(sender, receiver, amount.get().currency); + auto i = creditsIOU_.find(k); + if (i == creditsIOU_.end()) { - Value v; + ValueIOU v; if (sender < receiver) { @@ -48,7 +68,7 @@ DeferredCredits::credit( v.lowAcctOrigBalance = -preCreditSenderBalance; } - credits_[k] = v; + creditsIOU_[k] = v; } else { @@ -65,6 +85,93 @@ DeferredCredits::credit( } } +void +DeferredCredits::creditMPT( + AccountID const& sender, + AccountID const& receiver, + STAmount const& amount, + std::uint64_t preCreditBalanceHolder, + std::int64_t preCreditBalanceIssuer) +{ + XRPL_ASSERT( + amount.holds(), + "xrpl::detail::DeferredCredits::creditMPT : amount is for MPTIssue"); + XRPL_ASSERT(!amount.negative(), "xrpl::detail::DeferredCredits::creditMPT : positive amount"); + XRPL_ASSERT( + sender != receiver, "xrpl::detail::DeferredCredits::creditMPT : sender is not receiver"); + + auto const mptAmtVal = amount.mpt().value(); + auto const& issuer = amount.getIssuer(); + auto const& mptIssue = amount.get(); + auto const& mptID = mptIssue.getMptID(); + bool const isSenderIssuer = sender == issuer; + + auto i = creditsMPT_.find(mptID); + if (i == creditsMPT_.end()) + { + IssuerValueMPT v; + if (isSenderIssuer) + { + v.credit = mptAmtVal; + v.holders[receiver].origBalance = preCreditBalanceHolder; + } + else + { + v.holders[sender].debit = mptAmtVal; + v.holders[sender].origBalance = preCreditBalanceHolder; + } + v.origBalance = preCreditBalanceIssuer; + creditsMPT_.emplace(mptID, std::move(v)); + } + else + { + // only record the balance the first time, do not record it here + auto& v = i->second; + if (isSenderIssuer) + { + v.credit += mptAmtVal; + if (!v.holders.contains(receiver)) + { + v.holders[receiver].origBalance = preCreditBalanceHolder; + } + } + else + { + if (!v.holders.contains(sender)) + { + v.holders[sender].debit = mptAmtVal; + v.holders[sender].origBalance = preCreditBalanceHolder; + } + else + { + v.holders[sender].debit += mptAmtVal; + } + } + } +} + +void +DeferredCredits::issuerSelfDebitMPT( + MPTIssue const& issue, + std::uint64_t amount, + std::int64_t origBalance) +{ + auto const& mptID = issue.getMptID(); + auto i = creditsMPT_.find(mptID); + + if (i == creditsMPT_.end()) + { + IssuerValueMPT v; + v.origBalance = origBalance; + v.selfDebit = amount; + creditsMPT_.emplace(mptID, std::move(v)); + } + else + { + i->second.selfDebit += amount; + } +} + void DeferredCredits::ownerCount(AccountID const& id, std::uint32_t cur, std::uint32_t next) { @@ -88,16 +195,16 @@ DeferredCredits::ownerCount(AccountID const& id) const // Get the adjustments for the balance between main and other. auto -DeferredCredits::adjustments( +DeferredCredits::adjustmentsIOU( AccountID const& main, AccountID const& other, - Currency const& currency) const -> std::optional + Currency const& currency) const -> std::optional { - std::optional result; + std::optional result; - Key const k = makeKey(main, other, currency); - auto i = credits_.find(k); - if (i == credits_.end()) + KeyIOU const k = makeKeyIOU(main, other, currency); + auto i = creditsIOU_.find(k); + if (i == creditsIOU_.end()) return result; auto const& v = i->second; @@ -112,12 +219,21 @@ DeferredCredits::adjustments( return result; } +auto +DeferredCredits::adjustmentsMPT(xrpl::MPTID const& mptID) const -> std::optional +{ + auto i = creditsMPT_.find(mptID); + if (i == creditsMPT_.end()) + return std::nullopt; + return i->second; +} + void DeferredCredits::apply(DeferredCredits& to) { - for (auto const& i : credits_) + for (auto const& i : creditsIOU_) { - auto r = to.credits_.emplace(i); + auto r = to.creditsIOU_.emplace(i); if (!r.second) { auto& toVal = r.first->second; @@ -128,6 +244,30 @@ DeferredCredits::apply(DeferredCredits& to) } } + for (auto const& i : creditsMPT_) + { + auto r = to.creditsMPT_.emplace(i); + if (!r.second) + { + auto& toVal = r.first->second; + auto const& fromVal = i.second; + toVal.credit += fromVal.credit; + toVal.selfDebit += fromVal.selfDebit; + for (auto& [k, v] : fromVal.holders) + { + if (!toVal.holders.contains(k)) + { + toVal.holders[k] = v; + } + else + { + toVal.holders[k].debit += v.debit; + } + } + // Do not update the orig balance, it's already correct + } + } + for (auto const& i : ownerCounts_) { auto r = to.ownerCounts_.emplace(i); @@ -143,11 +283,13 @@ DeferredCredits::apply(DeferredCredits& to) } // namespace detail STAmount -PaymentSandbox::balanceHook( +PaymentSandbox::balanceHookIOU( AccountID const& account, AccountID const& issuer, STAmount const& amount) const { + XRPL_ASSERT(amount.holds(), "balanceHookIOU: amount is for Issue"); + /* There are two algorithms here. The pre-switchover algorithm takes the current amount and subtracts the recorded credits. The post-switchover @@ -159,14 +301,14 @@ PaymentSandbox::balanceHook( magnitudes, (B+C)-C may not equal B. */ - auto const currency = amount.getCurrency(); + auto const& currency = amount.get().currency; auto delta = amount.zeroed(); auto lastBal = amount; auto minBal = amount; for (auto curSB = this; curSB != nullptr; curSB = curSB->ps_) { - if (auto adj = curSB->tab_.adjustments(account, issuer, currency)) + if (auto adj = curSB->tab_.adjustmentsIOU(account, issuer, currency)) { delta += adj->debits; lastBal = adj->origBalance; @@ -180,13 +322,13 @@ PaymentSandbox::balanceHook( // to compute usable balance just slightly above what the ledger // calculates (but always less than the actual balance). auto adjustedAmt = std::min({amount, lastBal - delta, minBal}); - adjustedAmt.setIssuer(amount.getIssuer()); + adjustedAmt.get().account = amount.getIssuer(); if (isXRP(issuer) && adjustedAmt < beast::zero) { // A calculated negative XRP balance is not an error case. Consider a // payment snippet that credits a large XRP amount and then debits the - // same amount. The credit can't be used but we subtract the debit and + // same amount. The credit can't be used, but we subtract the debit and // calculate a negative value. It's not an error case. adjustedAmt.clear(); } @@ -194,6 +336,64 @@ PaymentSandbox::balanceHook( return adjustedAmt; } +STAmount +PaymentSandbox::balanceHookMPT(AccountID const& account, MPTIssue const& issue, std::int64_t amount) + const +{ + auto const& issuer = issue.getIssuer(); + bool const accountIsHolder = account != issuer; + + std::int64_t delta = 0; + std::int64_t lastBal = amount; + std::int64_t minBal = amount; + for (auto curSB = this; curSB != nullptr; curSB = curSB->ps_) + { + if (auto adj = curSB->tab_.adjustmentsMPT(issue)) + { + if (accountIsHolder) + { + if (auto const i = adj->holders.find(account); i != adj->holders.end()) + { + delta += i->second.debit; + lastBal = i->second.origBalance; + } + } + else + { + delta += adj->credit; + lastBal = adj->origBalance; + } + minBal = std::min(lastBal, minBal); + } + } + + // The adjusted amount should never be larger than the balance. + + auto const adjustedAmt = std::min({amount, lastBal - delta, minBal}); + + return adjustedAmt > 0 ? STAmount{issue, adjustedAmt} : STAmount{issue}; +} + +STAmount +PaymentSandbox::balanceHookSelfIssueMPT(xrpl::MPTIssue const& issue, std::int64_t amount) const +{ + std::int64_t selfDebited = 0; + std::int64_t lastBal = amount; + for (auto curSB = this; curSB != nullptr; curSB = curSB->ps_) + { + if (auto adj = curSB->tab_.adjustmentsMPT(issue)) + { + selfDebited += adj->selfDebit; + lastBal = adj->origBalance; + } + } + + if (lastBal > selfDebited) + return STAmount{issue, lastBal - selfDebited}; + + return STAmount{issue}; +} + std::uint32_t PaymentSandbox::ownerCountHook(AccountID const& account, std::uint32_t count) const { @@ -207,13 +407,39 @@ PaymentSandbox::ownerCountHook(AccountID const& account, std::uint32_t count) co } void -PaymentSandbox::creditHook( +PaymentSandbox::creditHookIOU( AccountID const& from, AccountID const& to, STAmount const& amount, STAmount const& preCreditBalance) { - tab_.credit(from, to, amount, preCreditBalance); + XRPL_ASSERT(amount.holds(), "creditHookIOU: amount is for Issue"); + + tab_.creditIOU(from, to, amount, preCreditBalance); +} + +void +PaymentSandbox::creditHookMPT( + AccountID const& from, + AccountID const& to, + STAmount const& amount, + std::uint64_t preCreditBalanceHolder, + std::int64_t preCreditBalanceIssuer) +{ + XRPL_ASSERT(amount.holds(), "creditHookMPT: amount is for MPTIssue"); + + tab_.creditMPT(from, to, amount, preCreditBalanceHolder, preCreditBalanceIssuer); +} + +void +PaymentSandbox::issuerSelfDebitHookMPT( + MPTIssue const& issue, + std::uint64_t amount, + std::int64_t origBalance) +{ + XRPL_ASSERT(amount > 0, "PaymentSandbox::issuerSelfDebitHookMPT: amount must be > 0"); + + tab_.issuerSelfDebitMPT(issue, amount, origBalance); } void @@ -346,7 +572,7 @@ PaymentSandbox::balanceChanges(ReadView const& view) const } // The following are now set, put them in the map auto delta = newBalance - oldBalance; - auto const cur = newBalance.getCurrency(); + auto const cur = newBalance.get().currency; result[std::make_tuple(lowID, highID, cur)] = delta; auto r = result.emplace(std::make_tuple(lowID, lowID, cur), delta); if (r.second) diff --git a/src/libxrpl/ledger/RawStateTable.cpp b/src/libxrpl/ledger/RawStateTable.cpp index b411a25b00..18bf4eae4f 100644 --- a/src/libxrpl/ledger/RawStateTable.cpp +++ b/src/libxrpl/ledger/RawStateTable.cpp @@ -1,6 +1,20 @@ -#include #include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + namespace xrpl { namespace detail { @@ -241,7 +255,7 @@ RawStateTable::erase(std::shared_ptr const& sle) switch (item.action) { case Action::erase: - LogicError("RawStateTable::erase: already erased"); + Throw("RawStateTable::erase: already erased"); break; case Action::insert: items_.erase(result.first); @@ -270,10 +284,10 @@ RawStateTable::insert(std::shared_ptr const& sle) item.sle = sle; break; case Action::insert: - LogicError("RawStateTable::insert: already inserted"); + Throw("RawStateTable::insert: already inserted"); break; case Action::replace: - LogicError("RawStateTable::insert: already exists"); + Throw("RawStateTable::insert: already exists"); break; } } @@ -291,7 +305,7 @@ RawStateTable::replace(std::shared_ptr const& sle) switch (item.action) { case Action::erase: - LogicError("RawStateTable::replace: was erased"); + Throw("RawStateTable::replace: was erased"); break; case Action::insert: case Action::replace: diff --git a/src/libxrpl/ledger/ReadView.cpp b/src/libxrpl/ledger/ReadView.cpp index e0764d6c81..991dd95251 100644 --- a/src/libxrpl/ledger/ReadView.cpp +++ b/src/libxrpl/ledger/ReadView.cpp @@ -1,5 +1,16 @@ #include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + namespace xrpl { ReadView::sles_type::sles_type(ReadView const& view) : ReadViewFwdRange(view) @@ -58,7 +69,7 @@ makeRulesGivenLedger( std::unordered_set> const& presets) { Keylet const k = keylet::amendments(); - std::optional digest = ledger.digest(k.key); + std::optional const digest = ledger.digest(k.key); if (digest) { auto const sle = ledger.read(k); diff --git a/src/libxrpl/ledger/View.cpp b/src/libxrpl/ledger/View.cpp index 227eafbec8..55735ec0e6 100644 --- a/src/libxrpl/ledger/View.cpp +++ b/src/libxrpl/ledger/View.cpp @@ -1,26 +1,39 @@ -#include -#include -#include -#include -#include #include + +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include #include +#include +#include +#include #include #include +#include +#include #include #include #include -#include +#include +#include +#include +#include #include -#include -#include -#include +#include -#include -#include +#include +#include +#include +#include namespace xrpl { @@ -84,11 +97,10 @@ bool isLPTokenFrozen( ReadView const& view, AccountID const& account, - Issue const& asset, - Issue const& asset2) + Asset const& asset, + Asset const& asset2) { - return isFrozen(view, account, asset.currency, asset.account) || - isFrozen(view, account, asset2.currency, asset2.account); + return isFrozen(view, account, asset) || isFrozen(view, account, asset2); } bool @@ -242,7 +254,7 @@ hashOfSeq(ReadView const& ledger, LedgerIndex seq, beast::Journal journal) if (seq == (ledger.seq() - 1)) return ledger.header().parentHash; - if (int diff = ledger.seq() - seq; diff <= 256) + if (int const diff = ledger.seq() - seq; diff <= 256) { // Within 256... auto const hashIndex = ledger.read(keylet::skip()); @@ -334,22 +346,19 @@ withdrawToDestExceedsLimit( if (from == to || to == issuer || isXRP(issuer)) return tesSUCCESS; - return std::visit( - [&](TIss const& issue) -> TER { - if constexpr (std::is_same_v) + return amount.asset().visit( + [&](Issue const& issue) -> TER { + auto const& currency = issue.currency; + auto const owed = creditBalance(view, to, issuer, currency); + if (owed <= beast::zero) { - auto const& currency = issue.currency; - auto const owed = creditBalance(view, to, issuer, currency); - if (owed <= beast::zero) - { - auto const limit = creditLimit(view, to, issuer, currency); - if (-owed >= limit || amount > (limit + owed)) - return tecNO_LINE; - } + auto const limit = creditLimit(view, to, issuer, currency); + if (-owed >= limit || amount > (limit + owed)) + return tecNO_LINE; } return tesSUCCESS; }, - amount.asset().value()); + [](MPTIssue const&) -> TER { return tesSUCCESS; }); } [[nodiscard]] TER diff --git a/src/libxrpl/ledger/helpers/AMMHelpers.cpp b/src/libxrpl/ledger/helpers/AMMHelpers.cpp new file mode 100644 index 0000000000..94ca2469f7 --- /dev/null +++ b/src/libxrpl/ledger/helpers/AMMHelpers.cpp @@ -0,0 +1,950 @@ +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +namespace xrpl { + +STAmount +ammLPTokens(STAmount const& asset1, STAmount const& asset2, Asset const& lptIssue) +{ + // AMM invariant: sqrt(asset1 * asset2) >= LPTokensBalance + auto const rounding = isFeatureEnabled(fixAMMv1_3) ? Number::downward : Number::getround(); + NumberRoundModeGuard const g(rounding); + auto const tokens = root2(asset1 * asset2); + return toSTAmount(lptIssue, tokens); +} + +/* + * Equation 3: + * t = T * [(b/B - (sqrt(f2**2 - b/(B*f1)) - f2)) / + * (1 + sqrt(f2**2 - b/(B*f1)) - f2)] + * where f1 = 1 - tfee, f2 = (1 - tfee/2)/f1 + */ +STAmount +lpTokensOut( + STAmount const& asset1Balance, + STAmount const& asset1Deposit, + STAmount const& lptAMMBalance, + std::uint16_t tfee) +{ + auto const f1 = feeMult(tfee); + auto const f2 = feeMultHalf(tfee) / f1; + Number const r = asset1Deposit / asset1Balance; + auto const c = root2(f2 * f2 + r / f1) - f2; + if (!isFeatureEnabled(fixAMMv1_3)) + { + auto const t = lptAMMBalance * (r - c) / (1 + c); + return toSTAmount(lptAMMBalance.asset(), t); + } + + // minimize tokens out + auto const frac = (r - c) / (1 + c); + return multiply(lptAMMBalance, frac, Number::downward); +} + +/* Equation 4 solves equation 3 for b: + * Let f1 = 1 - tfee, f2 = (1 - tfee/2)/f1, t1 = t/T, t2 = 1 + t1, R = b/B + * then + * t1 = [R - sqrt(f2**2 + R/f1) + f2] / [1 + sqrt(f2**2 + R/f1] - f2] => + * sqrt(f2**2 + R/f1)*(t1 + 1) = R + f2 + t1*f2 - t1 => + * sqrt(f2**2 + R/f1)*t2 = R + t2*f2 - t1 => + * sqrt(f2**2 + R/f1) = R/t2 + f2 - t1/t2, let d = f2 - t1/t2 => + * sqrt(f2**2 + R/f1) = R/t2 + d => + * f2**2 + R/f1 = (R/t2)**2 +2*d*R/t2 + d**2 => + * (R/t2)**2 + R*(2*d/t2 - 1/f1) + d**2 - f2**2 = 0 + */ +STAmount +ammAssetIn( + STAmount const& asset1Balance, + STAmount const& lptAMMBalance, + STAmount const& lpTokens, + std::uint16_t tfee) +{ + auto const f1 = feeMult(tfee); + auto const f2 = feeMultHalf(tfee) / f1; + auto const t1 = lpTokens / lptAMMBalance; + auto const t2 = 1 + t1; + auto const d = f2 - t1 / t2; + auto const a = 1 / (t2 * t2); + auto const b = 2 * d / t2 - 1 / f1; + auto const c = d * d - f2 * f2; + if (!isFeatureEnabled(fixAMMv1_3)) + { + return toSTAmount(asset1Balance.asset(), asset1Balance * solveQuadraticEq(a, b, c)); + } + + // maximize deposit + auto const frac = solveQuadraticEq(a, b, c); + return multiply(asset1Balance, frac, Number::upward); +} + +/* Equation 7: + * t = T * (c - sqrt(c**2 - 4*R))/2 + * where R = b/B, c = R*fee + 2 - fee + */ +STAmount +lpTokensIn( + STAmount const& asset1Balance, + STAmount const& asset1Withdraw, + STAmount const& lptAMMBalance, + std::uint16_t tfee) +{ + Number const fr = asset1Withdraw / asset1Balance; + auto const f1 = getFee(tfee); + auto const c = fr * f1 + 2 - f1; + if (!isFeatureEnabled(fixAMMv1_3)) + { + auto const t = lptAMMBalance * (c - root2(c * c - 4 * fr)) / 2; + return toSTAmount(lptAMMBalance.asset(), t); + } + + // maximize tokens in + auto const frac = (c - root2(c * c - 4 * fr)) / 2; + return multiply(lptAMMBalance, frac, Number::upward); +} + +/* Equation 8 solves equation 7 for b: + * c - 2*t/T = sqrt(c**2 - 4*R) => + * c**2 - 4*c*t/T + 4*t**2/T**2 = c**2 - 4*R => + * -4*c*t/T + 4*t**2/T**2 = -4*R => + * -c*t/T + t**2/T**2 = -R -=> + * substitute c = R*f + 2 - f => + * -(t/T)*(R*f + 2 - f) + (t/T)**2 = -R, let t1 = t/T => + * -t1*R*f -2*t1 +t1*f +t1**2 = -R => + * R = (t1**2 + t1*(f - 2)) / (t1*f - 1) + */ +STAmount +ammAssetOut( + STAmount const& assetBalance, + STAmount const& lptAMMBalance, + STAmount const& lpTokens, + std::uint16_t tfee) +{ + auto const f = getFee(tfee); + Number const t1 = lpTokens / lptAMMBalance; + if (!isFeatureEnabled(fixAMMv1_3)) + { + auto const b = assetBalance * (t1 * t1 - t1 * (2 - f)) / (t1 * f - 1); + return toSTAmount(assetBalance.asset(), b); + } + + // minimize withdraw + auto const frac = (t1 * t1 - t1 * (2 - f)) / (t1 * f - 1); + return multiply(assetBalance, frac, Number::downward); +} + +Number +square(Number const& n) +{ + return n * n; +} + +STAmount +adjustLPTokens(STAmount const& lptAMMBalance, STAmount const& lpTokens, IsDeposit isDeposit) +{ + // Force rounding downward to ensure adjusted tokens are less or equal + // to requested tokens. + saveNumberRoundMode const rm(Number::setround(Number::rounding_mode::downward)); + if (isDeposit == IsDeposit::Yes) + return (lptAMMBalance + lpTokens) - lptAMMBalance; + return (lpTokens - lptAMMBalance) + lptAMMBalance; +} + +std::tuple, STAmount> +adjustAmountsByLPTokens( + STAmount const& amountBalance, + STAmount const& amount, + std::optional const& amount2, + STAmount const& lptAMMBalance, + STAmount const& lpTokens, + std::uint16_t tfee, + IsDeposit isDeposit) +{ + // AMMv1_3 amendment adjusts tokens and amounts in deposit/withdraw + if (isFeatureEnabled(fixAMMv1_3)) + return std::make_tuple(amount, amount2, lpTokens); + + auto const lpTokensActual = adjustLPTokens(lptAMMBalance, lpTokens, isDeposit); + + if (lpTokensActual == beast::zero) + { + auto const amount2Opt = amount2 ? std::make_optional(STAmount{}) : std::nullopt; + return std::make_tuple(STAmount{}, amount2Opt, lpTokensActual); + } + + if (lpTokensActual < lpTokens) + { + bool const ammRoundingEnabled = [&]() { + if (auto const& rules = getCurrentTransactionRules(); + rules && rules->enabled(fixAMMv1_1)) + return true; + return false; + }(); + + // Equal trade + if (amount2) + { + Number const fr = lpTokensActual / lpTokens; + auto const amountActual = toSTAmount(amount.asset(), fr * amount); + auto const amount2Actual = toSTAmount(amount2->asset(), fr * *amount2); + if (!ammRoundingEnabled) + { + return std::make_tuple( + amountActual < amount ? amountActual : amount, + amount2Actual < amount2 ? amount2Actual : amount2, + lpTokensActual); + } + + return std::make_tuple(amountActual, amount2Actual, lpTokensActual); + } + + // Single trade + auto const amountActual = [&]() { + if (isDeposit == IsDeposit::Yes) + { + return ammAssetIn(amountBalance, lptAMMBalance, lpTokensActual, tfee); + } + if (!ammRoundingEnabled) + { + return ammAssetOut(amountBalance, lptAMMBalance, lpTokens, tfee); + } + + return ammAssetOut(amountBalance, lptAMMBalance, lpTokensActual, tfee); + }(); + if (!ammRoundingEnabled) + { + return amountActual < amount + ? std::make_tuple(amountActual, std::nullopt, lpTokensActual) + : std::make_tuple(amount, std::nullopt, lpTokensActual); + } + + return std::make_tuple(amountActual, std::nullopt, lpTokensActual); + } + + XRPL_ASSERT( + lpTokensActual == lpTokens, "xrpl::adjustAmountsByLPTokens : LP tokens match actual"); + + return {amount, amount2, lpTokensActual}; +} + +Number +solveQuadraticEq(Number const& a, Number const& b, Number const& c) +{ + return (-b + root2(b * b - 4 * a * c)) / (2 * a); +} + +// Minimize takerGets or takerPays +std::optional +solveQuadraticEqSmallest(Number const& a, Number const& b, Number const& c) +{ + auto const d = b * b - 4 * a * c; + if (d < 0) + return std::nullopt; + // use numerically stable citardauq formula for quadratic equation solution + // https://people.csail.mit.edu/bkph/articles/Quadratics.pdf + if (b > 0) + { + return (2 * c) / (-b - root2(d)); + } + + return (2 * c) / (-b + root2(d)); +} + +STAmount +multiply(STAmount const& amount, Number const& frac, Number::rounding_mode rm) +{ + NumberRoundModeGuard const g(rm); + auto const t = amount * frac; + return toSTAmount(amount.asset(), t, rm); +} + +STAmount +getRoundedAsset( + Rules const& rules, + std::function const& noRoundCb, + STAmount const& balance, + std::function const& productCb, + IsDeposit isDeposit) +{ + if (!rules.enabled(fixAMMv1_3)) + return toSTAmount(balance.asset(), noRoundCb()); + + auto const rm = detail::getAssetRounding(isDeposit); + if (isDeposit == IsDeposit::Yes) + return multiply(balance, productCb(), rm); + NumberRoundModeGuard const g(rm); + return toSTAmount(balance.asset(), productCb(), rm); +} + +STAmount +getRoundedLPTokens( + Rules const& rules, + STAmount const& balance, + Number const& frac, + IsDeposit isDeposit) +{ + if (!rules.enabled(fixAMMv1_3)) + return toSTAmount(balance.asset(), balance * frac); + + auto const rm = detail::getLPTokenRounding(isDeposit); + auto const tokens = multiply(balance, frac, rm); + return adjustLPTokens(balance, tokens, isDeposit); +} + +STAmount +getRoundedLPTokens( + Rules const& rules, + std::function const& noRoundCb, + STAmount const& lptAMMBalance, + std::function const& productCb, + IsDeposit isDeposit) +{ + if (!rules.enabled(fixAMMv1_3)) + return toSTAmount(lptAMMBalance.asset(), noRoundCb()); + + auto const tokens = [&] { + auto const rm = detail::getLPTokenRounding(isDeposit); + if (isDeposit == IsDeposit::Yes) + { + NumberRoundModeGuard const g(rm); + return toSTAmount(lptAMMBalance.asset(), productCb(), rm); + } + return multiply(lptAMMBalance, productCb(), rm); + }(); + return adjustLPTokens(lptAMMBalance, tokens, isDeposit); +} + +std::pair +adjustAssetInByTokens( + Rules const& rules, + STAmount const& balance, + STAmount const& amount, + STAmount const& lptAMMBalance, + STAmount const& tokens, + std::uint16_t tfee) +{ + if (!rules.enabled(fixAMMv1_3)) + return {tokens, amount}; + auto assetAdj = ammAssetIn(balance, lptAMMBalance, tokens, tfee); + auto tokensAdj = tokens; + // Rounding didn't work the right way. + // Try to adjust the original deposit amount by difference + // in adjust and original amount. Then adjust tokens and deposit amount. + if (assetAdj > amount) + { + auto const adjAmount = amount - (assetAdj - amount); + auto const t = lpTokensOut(balance, adjAmount, lptAMMBalance, tfee); + tokensAdj = adjustLPTokens(lptAMMBalance, t, IsDeposit::Yes); + assetAdj = ammAssetIn(balance, lptAMMBalance, tokensAdj, tfee); + } + return {tokensAdj, std::min(amount, assetAdj)}; +} + +std::pair +adjustAssetOutByTokens( + Rules const& rules, + STAmount const& balance, + STAmount const& amount, + STAmount const& lptAMMBalance, + STAmount const& tokens, + std::uint16_t tfee) +{ + if (!rules.enabled(fixAMMv1_3)) + return {tokens, amount}; + auto assetAdj = ammAssetOut(balance, lptAMMBalance, tokens, tfee); + auto tokensAdj = tokens; + // Rounding didn't work the right way. + // Try to adjust the original deposit amount by difference + // in adjust and original amount. Then adjust tokens and deposit amount. + if (assetAdj > amount) + { + auto const adjAmount = amount - (assetAdj - amount); + auto const t = lpTokensIn(balance, adjAmount, lptAMMBalance, tfee); + tokensAdj = adjustLPTokens(lptAMMBalance, t, IsDeposit::No); + assetAdj = ammAssetOut(balance, lptAMMBalance, tokensAdj, tfee); + } + return {tokensAdj, std::min(amount, assetAdj)}; +} + +Number +adjustFracByTokens( + Rules const& rules, + STAmount const& lptAMMBalance, + STAmount const& tokens, + Number const& frac) +{ + if (!rules.enabled(fixAMMv1_3)) + return frac; + return tokens / lptAMMBalance; +} + +std::pair +ammPoolHolds( + ReadView const& view, + AccountID const& ammAccountID, + Asset const& asset1, + Asset const& asset2, + FreezeHandling freezeHandling, + AuthHandling authHandling, + beast::Journal const j) +{ + auto const assetInBalance = + accountHolds(view, ammAccountID, asset1, freezeHandling, authHandling, j); + auto const assetOutBalance = + accountHolds(view, ammAccountID, asset2, freezeHandling, authHandling, j); + return std::make_pair(assetInBalance, assetOutBalance); +} + +Expected, TER> +ammHolds( + ReadView const& view, + SLE const& ammSle, + std::optional const& optAsset1, + std::optional const& optAsset2, + FreezeHandling freezeHandling, + AuthHandling authHandling, + beast::Journal const j) +{ + auto const assets = [&]() -> std::optional> { + auto const asset1 = ammSle[sfAsset]; + auto const asset2 = ammSle[sfAsset2]; + if (optAsset1 && optAsset2) + { + if (invalidAMMAssetPair( + *optAsset1, *optAsset2, std::make_optional(std::make_pair(asset1, asset2)))) + { + // This error can only be hit if the AMM is corrupted + // LCOV_EXCL_START + JLOG(j.debug()) << "ammHolds: Invalid optAsset1 or optAsset2 " << *optAsset1 << " " + << *optAsset2; + return std::nullopt; + // LCOV_EXCL_STOP + } + return std::make_optional(std::make_pair(*optAsset1, *optAsset2)); + } + auto const singleAsset = [&asset1, &asset2, &j]( + Asset checkIssue, + char const* label) -> std::optional> { + if (checkIssue == asset1) + { + return std::make_optional(std::make_pair(asset1, asset2)); + } + if (checkIssue == asset2) + { + return std::make_optional(std::make_pair(asset2, asset1)); + } + // Unreachable unless AMM corrupted. + // LCOV_EXCL_START + JLOG(j.debug()) << "ammHolds: Invalid " << label << " " << checkIssue; + return std::nullopt; + // LCOV_EXCL_STOP + }; + if (optAsset1) + { + return singleAsset(*optAsset1, "optAsset1"); + } + if (optAsset2) + { + // Cannot have Amount2 without Amount. + return singleAsset(*optAsset2, "optAsset2"); // LCOV_EXCL_LINE + } + return std::make_optional(std::make_pair(asset1, asset2)); + }(); + if (!assets) + return Unexpected(tecAMM_INVALID_TOKENS); + auto const [amount1, amount2] = ammPoolHolds( + view, + ammSle.getAccountID(sfAccount), + assets->first, + assets->second, + freezeHandling, + authHandling, + j); + return std::make_tuple(amount1, amount2, ammSle[sfLPTokenBalance]); +} + +STAmount +ammLPHolds( + ReadView const& view, + Asset const& asset1, + Asset const& asset2, + AccountID const& ammAccount, + AccountID const& lpAccount, + beast::Journal const j) +{ + // This function looks similar to `accountHolds`. However, it only checks if + // a LPToken holder has enough balance. On the other hand, `accountHolds` + // checks if the underlying assets of LPToken are frozen with the + // fixFrozenLPTokenTransfer amendment + + auto const currency = ammLPTCurrency(asset1, asset2); + STAmount amount; + + auto const sle = view.read(keylet::line(lpAccount, ammAccount, currency)); + if (!sle) + { + amount.clear(Issue{currency, ammAccount}); + JLOG(j.trace()) << "ammLPHolds: no SLE " + << " lpAccount=" << to_string(lpAccount) + << " amount=" << amount.getFullText(); + } + else if (isFrozen(view, lpAccount, currency, ammAccount)) + { + amount.clear(Issue{currency, ammAccount}); + JLOG(j.trace()) << "ammLPHolds: frozen currency " + << " lpAccount=" << to_string(lpAccount) + << " amount=" << amount.getFullText(); + } + else + { + amount = sle->getFieldAmount(sfBalance); + if (lpAccount > ammAccount) + { + // Put balance in account terms. + amount.negate(); + } + amount.get().account = ammAccount; + + JLOG(j.trace()) << "ammLPHolds:" + << " lpAccount=" << to_string(lpAccount) + << " amount=" << amount.getFullText(); + } + + return view.balanceHookIOU(lpAccount, ammAccount, amount); +} + +STAmount +ammLPHolds( + ReadView const& view, + SLE const& ammSle, + AccountID const& lpAccount, + beast::Journal const j) +{ + return ammLPHolds(view, ammSle[sfAsset], ammSle[sfAsset2], ammSle[sfAccount], lpAccount, j); +} + +std::uint16_t +getTradingFee(ReadView const& view, SLE const& ammSle, AccountID const& account) +{ + using namespace std::chrono; + XRPL_ASSERT( + !view.rules().enabled(fixInnerObjTemplate) || ammSle.isFieldPresent(sfAuctionSlot), + "xrpl::getTradingFee : auction present"); + if (ammSle.isFieldPresent(sfAuctionSlot)) + { + auto const& auctionSlot = safe_downcast(ammSle.peekAtField(sfAuctionSlot)); + // Not expired + if (auto const expiration = auctionSlot[~sfExpiration]; + duration_cast(view.header().parentCloseTime.time_since_epoch()).count() < + expiration) + { + if (auctionSlot[~sfAccount] == account) + return auctionSlot[sfDiscountedFee]; + if (auctionSlot.isFieldPresent(sfAuthAccounts)) + { + for (auto const& acct : auctionSlot.getFieldArray(sfAuthAccounts)) + { + if (acct[~sfAccount] == account) + return auctionSlot[sfDiscountedFee]; + } + } + } + } + return ammSle[sfTradingFee]; +} + +STAmount +ammAccountHolds(ReadView const& view, AccountID const& ammAccountID, Asset const& asset) +{ + // Get the actual AMM balance without factoring in the balance hook + return asset.visit( + [&](MPTIssue const& issue) { + if (auto const sle = view.read(keylet::mptoken(issue, ammAccountID)); + sle && !isFrozen(view, ammAccountID, issue)) + return STAmount{issue, (*sle)[sfMPTAmount]}; + return STAmount{asset}; + }, + [&](Issue const& issue) { + if (isXRP(issue)) + { + if (auto const sle = view.read(keylet::account(ammAccountID))) + return (*sle)[sfBalance]; + } + else if ( + auto const sle = + view.read(keylet::line(ammAccountID, issue.account, issue.currency)); + sle && !isFrozen(view, ammAccountID, issue.currency, issue.account)) + { + STAmount amount = (*sle)[sfBalance]; + if (ammAccountID > issue.account) + amount.negate(); + amount.get().account = issue.account; + return amount; + } + return STAmount{asset}; + }); +} + +static TER +deleteAMMTrustLines( + Sandbox& sb, + AccountID const& ammAccountID, + std::uint16_t maxTrustlinesToDelete, + beast::Journal j) +{ + return cleanupOnAccountDelete( + sb, + keylet::ownerDir(ammAccountID), + [&](LedgerEntryType nodeType, + uint256 const&, + std::shared_ptr& sleItem) -> std::pair { + // Skip AMM and MPToken + if (nodeType == ltAMM || nodeType == ltMPTOKEN) + return {tesSUCCESS, SkipEntry::Yes}; + + if (nodeType == ltRIPPLE_STATE) + { + // Trustlines must have zero balance + if (sleItem->getFieldAmount(sfBalance) != beast::zero) + { + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMObjects: deleting trustline with " + "non-zero balance."; + return {tecINTERNAL, SkipEntry::No}; + // LCOV_EXCL_STOP + } + + return {deleteAMMTrustLine(sb, sleItem, ammAccountID, j), SkipEntry::No}; + } + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMObjects: deleting non-trustline or non-MPT " << nodeType; + return {tecINTERNAL, SkipEntry::No}; + // LCOV_EXCL_STOP + }, + j, + maxTrustlinesToDelete); +} + +static TER +deleteAMMMPTokens(Sandbox& sb, AccountID const& ammAccountID, beast::Journal j) +{ + return cleanupOnAccountDelete( + sb, + keylet::ownerDir(ammAccountID), + [&](LedgerEntryType nodeType, + uint256 const&, + std::shared_ptr& sleItem) -> std::pair { + // Skip AMM + if (nodeType == ltAMM) + return {tesSUCCESS, SkipEntry::Yes}; + + if (nodeType == ltMPTOKEN) + { + // MPT must have zero balance + if (sleItem->getFieldU64(sfMPTAmount) != 0 || + (*sleItem)[~sfLockedAmount].value_or(0) != 0) + { + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMObjects: deleting MPT with " + "non-zero balance."; + return {tecINTERNAL, SkipEntry::No}; + // LCOV_EXCL_STOP + } + + return {deleteAMMMPToken(sb, sleItem, ammAccountID, j), SkipEntry::No}; + } + if (nodeType == ltRIPPLE_STATE) + { + // Trustlines should have been deleted + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMObjects: trustlines should have been deleted"; + return {tecINTERNAL, SkipEntry::No}; + // LCOV_EXCL_STOP + } + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMObjects: deleting non-trustline or non-MPT " << nodeType; + return {tecINTERNAL, SkipEntry::No}; + // LCOV_EXCL_STOP + }, + j, + 3); // At most two MPToken plus AMM object +} + +TER +deleteAMMAccount(Sandbox& sb, Asset const& asset, Asset const& asset2, beast::Journal j) +{ + auto ammSle = sb.peek(keylet::amm(asset, asset2)); + if (!ammSle) + { + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMAccount: AMM object does not exist " << asset << " " << asset2; + return tecINTERNAL; + // LCOV_EXCL_STOP + } + + auto const ammAccountID = (*ammSle)[sfAccount]; + auto sleAMMRoot = sb.peek(keylet::account(ammAccountID)); + if (!sleAMMRoot) + { + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMAccount: AMM account does not exist " + << to_string(ammAccountID); + return tecINTERNAL; + // LCOV_EXCL_STOP + } + + if (auto const ter = deleteAMMTrustLines(sb, ammAccountID, maxDeletableAMMTrustLines, j); + !isTesSuccess(ter)) + return ter; + + // Delete AMM's MPTokens only if all trustlines are deleted. If trustlines + // are not deleted then AMM can be re-created with Deposit and + // AMM's MPToken(s) must exist. + if (auto const ter = deleteAMMMPTokens(sb, ammAccountID, j); !isTesSuccess(ter)) + return ter; + + auto const ownerDirKeylet = keylet::ownerDir(ammAccountID); + if (!sb.dirRemove(ownerDirKeylet, (*ammSle)[sfOwnerNode], ammSle->key(), false)) + { + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMAccount: failed to remove dir link"; + return tecINTERNAL; + // LCOV_EXCL_STOP + } + if (sb.exists(ownerDirKeylet) && !sb.emptyDirDelete(ownerDirKeylet)) + { + // LCOV_EXCL_START + JLOG(j.error()) << "deleteAMMAccount: cannot delete root dir node of " + << toBase58(ammAccountID); + return tecINTERNAL; + // LCOV_EXCL_STOP + } + + sb.erase(ammSle); + sb.erase(sleAMMRoot); + + return tesSUCCESS; +} + +void +initializeFeeAuctionVote( + ApplyView& view, + std::shared_ptr& ammSle, + AccountID const& account, + Asset const& lptAsset, + std::uint16_t tfee) +{ + auto const& rules = view.rules(); + // AMM creator gets the voting slot. + STArray voteSlots; + STObject voteEntry = STObject::makeInnerObject(sfVoteEntry); + if (tfee != 0) + voteEntry.setFieldU16(sfTradingFee, tfee); + voteEntry.setFieldU32(sfVoteWeight, VOTE_WEIGHT_SCALE_FACTOR); + voteEntry.setAccountID(sfAccount, account); + voteSlots.push_back(voteEntry); + ammSle->setFieldArray(sfVoteSlots, voteSlots); + // AMM creator gets the auction slot for free. + // AuctionSlot is created on AMMCreate and updated on AMMDeposit + // when AMM is in an empty state + if (rules.enabled(fixInnerObjTemplate) && !ammSle->isFieldPresent(sfAuctionSlot)) + { + STObject auctionSlot = STObject::makeInnerObject(sfAuctionSlot); + ammSle->set(std::move(auctionSlot)); + } + STObject& auctionSlot = ammSle->peekFieldObject(sfAuctionSlot); + auctionSlot.setAccountID(sfAccount, account); + // current + sec in 24h + auto const expiration = std::chrono::duration_cast( + view.header().parentCloseTime.time_since_epoch()) + .count() + + TOTAL_TIME_SLOT_SECS; + auctionSlot.setFieldU32(sfExpiration, expiration); + auctionSlot.setFieldAmount(sfPrice, STAmount{lptAsset, 0}); + // Set the fee + if (tfee != 0) + { + ammSle->setFieldU16(sfTradingFee, tfee); + } + else if (ammSle->isFieldPresent(sfTradingFee)) + { + ammSle->makeFieldAbsent(sfTradingFee); // LCOV_EXCL_LINE + } + if (auto const dfee = tfee / AUCTION_SLOT_DISCOUNTED_FEE_FRACTION) + { + auctionSlot.setFieldU16(sfDiscountedFee, dfee); + } + else if (auctionSlot.isFieldPresent(sfDiscountedFee)) + { + auctionSlot.makeFieldAbsent(sfDiscountedFee); // LCOV_EXCL_LINE + } +} + +Expected +isOnlyLiquidityProvider(ReadView const& view, Issue const& ammIssue, AccountID const& lpAccount) +{ + // Liquidity Provider (LP) must have one LPToken trustline + std::uint8_t nLPTokenTrustLines = 0; + // AMM account has at most two IOU (pool tokens, not LPToken) trustlines. + // One or both trustlines could be to the LP if LP is the issuer, + // or a different account if LP is not an issuer. For instance, + // if AMM has two tokens USD and EUR and LP is not the issuer of the tokens + // then the trustlines are between AMM account and the issuer. + // There is one LPToken trustline for each LP. Only remaining LP has + // exactly one LPToken trustlines and at most two IOU trustline for each + // pool token. One or both tokens could be MPT. + std::uint8_t nIOUTrustLines = 0; + // There are at most two MPT objects, one for each side of the pool. + std::uint8_t nMPT = 0; + // There is only one AMM object + bool hasAMM = false; + // AMM LP has at most three trustlines, at most two MPTs, and only one + // AMM object must exist. If there are more than four objects then + // it's either an error or there are more than one LP. Ten pages should + // be sufficient to include four objects. + std::uint8_t limit = 10; + auto const root = keylet::ownerDir(ammIssue.account); + auto currentIndex = root; + + // Iterate over AMM owner directory objects. + while (limit-- >= 1) + { + auto const ownerDir = view.read(currentIndex); + if (!ownerDir) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + for (auto const& key : ownerDir->getFieldV256(sfIndexes)) + { + auto const sle = view.read(keylet::child(key)); + if (!sle) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + auto const entryType = sle->getFieldU16(sfLedgerEntryType); + // Only one AMM object + if (entryType == ltAMM) + { + if (hasAMM) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + hasAMM = true; + continue; + } + if (entryType == ltMPTOKEN) + { + ++nMPT; + continue; + } + if (entryType != ltRIPPLE_STATE) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + auto const lowLimit = sle->getFieldAmount(sfLowLimit); + auto const highLimit = sle->getFieldAmount(sfHighLimit); + auto const isLPTrustline = + lowLimit.getIssuer() == lpAccount || highLimit.getIssuer() == lpAccount; + auto const isLPTokenTrustline = + lowLimit.asset() == ammIssue || highLimit.asset() == ammIssue; + + // Liquidity Provider trustline + if (isLPTrustline) + { + // LPToken trustline + if (isLPTokenTrustline) + { + // LP has exactly one LPToken trustline + if (++nLPTokenTrustLines > 1) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + } + // AMM account has at most two IOU trustlines + else if (++nIOUTrustLines > 2) + { + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + } + } + // Another Liquidity Provider LPToken trustline + else if (isLPTokenTrustline) + { + return false; + } + // AMM account has at most two IOU trustlines + else if (++nIOUTrustLines > 2) + { + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + } + } + auto const uNodeNext = ownerDir->getFieldU64(sfIndexNext); + if (uNodeNext == 0) + { + if (nLPTokenTrustLines != 1 || (nIOUTrustLines == 0 && nMPT == 0) || + (nIOUTrustLines > 2 || nMPT > 2) || (nIOUTrustLines + nMPT) > 2) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + return true; + } + currentIndex = keylet::page(root, uNodeNext); + } + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE +} + +Expected +verifyAndAdjustLPTokenBalance( + Sandbox& sb, + STAmount const& lpTokens, + std::shared_ptr& ammSle, + AccountID const& account) +{ + auto const res = isOnlyLiquidityProvider(sb, lpTokens.get(), account); + if (!res.has_value()) + { + return Unexpected(res.error()); + } + + if (res.value()) + { + if (withinRelativeDistance( + lpTokens, ammSle->getFieldAmount(sfLPTokenBalance), Number{1, -3})) + { + ammSle->setFieldAmount(sfLPTokenBalance, lpTokens); + sb.update(ammSle); + } + else + { + return Unexpected(tecAMM_INVALID_TOKENS); + } + } + return true; +} + +} // namespace xrpl diff --git a/src/libxrpl/ledger/helpers/AccountRootHelpers.cpp b/src/libxrpl/ledger/helpers/AccountRootHelpers.cpp index 399494bc5f..0663fde1f4 100644 --- a/src/libxrpl/ledger/helpers/AccountRootHelpers.cpp +++ b/src/libxrpl/ledger/helpers/AccountRootHelpers.cpp @@ -1,13 +1,33 @@ #include -// + +#include #include +#include +#include +#include +#include #include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include #include #include +#include #include +#include +#include +#include +#include +#include namespace xrpl { @@ -80,7 +100,7 @@ xrpLiquid(ReadView const& view, AccountID const& id, std::int32_t ownerCountAdj, auto const fullBalance = sle->getFieldAmount(sfBalance); - auto const balance = view.balanceHook(id, xrpAccount(), fullBalance); + auto const balance = view.balanceHookIOU(id, xrpAccount(), fullBalance); STAmount const amount = (balance < reserve) ? STAmount{0} : balance - reserve; @@ -153,7 +173,7 @@ getPseudoAccountFields() if (!ar) { // LCOV_EXCL_START - LogicError( + Throw( "xrpl::getPseudoAccountFields : unable to find account root " "ledger format"); // LCOV_EXCL_STOP diff --git a/src/libxrpl/ledger/helpers/CredentialHelpers.cpp b/src/libxrpl/ledger/helpers/CredentialHelpers.cpp index 32db285f1e..37f7db3677 100644 --- a/src/libxrpl/ledger/helpers/CredentialHelpers.cpp +++ b/src/libxrpl/ledger/helpers/CredentialHelpers.cpp @@ -1,11 +1,32 @@ #include -// -#include + +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include #include +#include +#include namespace xrpl { namespace credentials { diff --git a/src/libxrpl/ledger/helpers/DirectoryHelpers.cpp b/src/libxrpl/ledger/helpers/DirectoryHelpers.cpp index dba71e0acd..8b4eeae7b7 100644 --- a/src/libxrpl/ledger/helpers/DirectoryHelpers.cpp +++ b/src/libxrpl/ledger/helpers/DirectoryHelpers.cpp @@ -1,6 +1,19 @@ #include -// + +#include +#include +#include +#include +#include +#include +#include #include +#include +#include + +#include +#include +#include namespace xrpl { diff --git a/src/libxrpl/ledger/helpers/MPTokenHelpers.cpp b/src/libxrpl/ledger/helpers/MPTokenHelpers.cpp index 31c1d543f5..d47b49e910 100644 --- a/src/libxrpl/ledger/helpers/MPTokenHelpers.cpp +++ b/src/libxrpl/ledger/helpers/MPTokenHelpers.cpp @@ -1,15 +1,40 @@ #include -// + #include +#include +#include +#include +#include +#include +#include #include #include #include #include +#include +#include #include #include +#include #include +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -139,7 +164,9 @@ authorizeMPToken( { auto const mptokenKey = keylet::mptoken(mptIssuanceID, account); auto const sleMpt = view.peek(mptokenKey); - if (!sleMpt || (*sleMpt)[sfMPTAmount] != 0) + if (!sleMpt || (*sleMpt)[sfMPTAmount] != 0 || + (view.rules().enabled(fixSecurity3_1_3) && + (*sleMpt)[~sfLockedAmount].value_or(0) != 0)) return tecINTERNAL; // LCOV_EXCL_LINE if (!view.dirRemove( @@ -252,7 +279,8 @@ removeEmptyHolding( // balance, it can not just be deleted, because that will throw the issuance // accounting out of balance, so fail. Since this should be impossible // anyway, I'm not going to put any effort into it. - if (mptoken->at(sfMPTAmount) != 0) + if (mptoken->at(sfMPTAmount) != 0 || + (view.rules().enabled(fixSecurity3_1_3) && (*mptoken)[~sfLockedAmount].value_or(0) != 0)) return tecHAS_OBLIGATIONS; return authorizeMPToken( @@ -303,18 +331,11 @@ requireAuth( return tefINTERNAL; // LCOV_EXCL_LINE auto const asset = sleVault->at(sfAsset); - if (auto const err = std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - { - return requireAuth(view, issue, account, authType); - } - else - { - return requireAuth(view, issue, account, authType, depth + 1); - } - }, - asset.value()); + if (auto const err = asset.visit( + [&](Issue const& issue) { return requireAuth(view, issue, account, authType); }, + [&](MPTIssue const& issue) { + return requireAuth(view, issue, account, authType, depth + 1); + }); !isTesSuccess(err)) return err; } @@ -485,25 +506,35 @@ canTransfer( } TER -rippleLockEscrowMPT( - ApplyView& view, - AccountID const& sender, - STAmount const& amount, - beast::Journal j) +canTrade(ReadView const& view, Asset const& asset) +{ + return asset.visit( + [&](Issue const&) -> TER { return tesSUCCESS; }, + [&](MPTIssue const& mptIssue) -> TER { + auto const sleIssuance = view.read(keylet::mptIssuance(mptIssue.getMptID())); + if (!sleIssuance) + return tecOBJECT_NOT_FOUND; + if (!sleIssuance->isFlag(lsfMPTCanTrade)) + return tecNO_PERMISSION; + return tesSUCCESS; + }); +} + +TER +lockEscrowMPT(ApplyView& view, AccountID const& sender, STAmount const& amount, beast::Journal j) { auto const mptIssue = amount.get(); auto const mptID = keylet::mptIssuance(mptIssue.getMptID()); auto sleIssuance = view.peek(mptID); if (!sleIssuance) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleLockEscrowMPT: MPT issuance not found for " - << mptIssue.getMptID(); + JLOG(j.error()) << "lockEscrowMPT: MPT issuance not found for " << mptIssue.getMptID(); return tecOBJECT_NOT_FOUND; } // LCOV_EXCL_STOP if (amount.getIssuer() == sender) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleLockEscrowMPT: sender is the issuer, cannot lock MPTs."; + JLOG(j.error()) << "lockEscrowMPT: sender is the issuer, cannot lock MPTs."; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -514,7 +545,7 @@ rippleLockEscrowMPT( auto sle = view.peek(mptokenID); if (!sle) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleLockEscrowMPT: MPToken not found for " << sender; + JLOG(j.error()) << "lockEscrowMPT: MPToken not found for " << sender; return tecOBJECT_NOT_FOUND; } // LCOV_EXCL_STOP @@ -524,8 +555,8 @@ rippleLockEscrowMPT( // Underflow check for subtraction if (!canSubtract(STAmount(mptIssue, amt), STAmount(mptIssue, pay))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleLockEscrowMPT: insufficient MPTAmount for " - << to_string(sender) << ": " << amt << " < " << pay; + JLOG(j.error()) << "lockEscrowMPT: insufficient MPTAmount for " << to_string(sender) + << ": " << amt << " < " << pay; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -536,8 +567,8 @@ rippleLockEscrowMPT( if (!canAdd(STAmount(mptIssue, locked), STAmount(mptIssue, pay))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleLockEscrowMPT: overflow on locked amount for " - << to_string(sender) << ": " << locked << " + " << pay; + JLOG(j.error()) << "lockEscrowMPT: overflow on locked amount for " << to_string(sender) + << ": " << locked << " + " << pay; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -562,7 +593,7 @@ rippleLockEscrowMPT( // Overflow check for addition if (!canAdd(STAmount(mptIssue, issuanceEscrowed), STAmount(mptIssue, pay))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleLockEscrowMPT: overflow on issuance " + JLOG(j.error()) << "lockEscrowMPT: overflow on issuance " "locked amount for " << mptIssue.getMptID() << ": " << issuanceEscrowed << " + " << pay; return tecINTERNAL; @@ -583,7 +614,7 @@ rippleLockEscrowMPT( } TER -rippleUnlockEscrowMPT( +unlockEscrowMPT( ApplyView& view, AccountID const& sender, AccountID const& receiver, @@ -593,8 +624,7 @@ rippleUnlockEscrowMPT( { if (!view.rules().enabled(fixTokenEscrowV1)) { - XRPL_ASSERT( - netAmount == grossAmount, "xrpl::rippleUnlockEscrowMPT : netAmount == grossAmount"); + XRPL_ASSERT(netAmount == grossAmount, "xrpl::unlockEscrowMPT : netAmount == grossAmount"); } auto const& issuer = netAmount.getIssuer(); @@ -603,8 +633,7 @@ rippleUnlockEscrowMPT( auto sleIssuance = view.peek(mptID); if (!sleIssuance) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: MPT issuance not found for " - << mptIssue.getMptID(); + JLOG(j.error()) << "unlockEscrowMPT: MPT issuance not found for " << mptIssue.getMptID(); return tecOBJECT_NOT_FOUND; } // LCOV_EXCL_STOP @@ -612,7 +641,7 @@ rippleUnlockEscrowMPT( { if (!sleIssuance->isFieldPresent(sfLockedAmount)) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: no locked amount in issuance for " + JLOG(j.error()) << "unlockEscrowMPT: no locked amount in issuance for " << mptIssue.getMptID(); return tecINTERNAL; } // LCOV_EXCL_STOP @@ -623,7 +652,7 @@ rippleUnlockEscrowMPT( // Underflow check for subtraction if (!canSubtract(STAmount(mptIssue, locked), STAmount(mptIssue, redeem))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: insufficient locked amount for " + JLOG(j.error()) << "unlockEscrowMPT: insufficient locked amount for " << mptIssue.getMptID() << ": " << locked << " < " << redeem; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -647,7 +676,7 @@ rippleUnlockEscrowMPT( auto sle = view.peek(mptokenID); if (!sle) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: MPToken not found for " << receiver; + JLOG(j.error()) << "unlockEscrowMPT: MPToken not found for " << receiver; return tecOBJECT_NOT_FOUND; } // LCOV_EXCL_STOP @@ -657,8 +686,8 @@ rippleUnlockEscrowMPT( // Overflow check for addition if (!canAdd(STAmount(mptIssue, current), STAmount(mptIssue, delta))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: overflow on MPTAmount for " - << to_string(receiver) << ": " << current << " + " << delta; + JLOG(j.error()) << "unlockEscrowMPT: overflow on MPTAmount for " << to_string(receiver) + << ": " << current << " + " << delta; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -674,7 +703,7 @@ rippleUnlockEscrowMPT( // Underflow check for subtraction if (!canSubtract(STAmount(mptIssue, outstanding), STAmount(mptIssue, redeem))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: insufficient outstanding amount for " + JLOG(j.error()) << "unlockEscrowMPT: insufficient outstanding amount for " << mptIssue.getMptID() << ": " << outstanding << " < " << redeem; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -685,7 +714,7 @@ rippleUnlockEscrowMPT( if (issuer == sender) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: sender is the issuer, " + JLOG(j.error()) << "unlockEscrowMPT: sender is the issuer, " "cannot unlock MPTs."; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -694,14 +723,13 @@ rippleUnlockEscrowMPT( auto sle = view.peek(mptokenID); if (!sle) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: MPToken not found for " << sender; + JLOG(j.error()) << "unlockEscrowMPT: MPToken not found for " << sender; return tecOBJECT_NOT_FOUND; } // LCOV_EXCL_STOP if (!sle->isFieldPresent(sfLockedAmount)) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: no locked amount in MPToken for " - << to_string(sender); + JLOG(j.error()) << "unlockEscrowMPT: no locked amount in MPToken for " << to_string(sender); return tecINTERNAL; } // LCOV_EXCL_STOP @@ -711,8 +739,8 @@ rippleUnlockEscrowMPT( // Underflow check for subtraction if (!canSubtract(STAmount(mptIssue, locked), STAmount(mptIssue, delta))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: insufficient locked amount for " - << to_string(sender) << ": " << locked << " < " << delta; + JLOG(j.error()) << "unlockEscrowMPT: insufficient locked amount for " << to_string(sender) + << ": " << locked << " < " << delta; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -738,7 +766,7 @@ rippleUnlockEscrowMPT( // Underflow check for subtraction if (!canSubtract(STAmount(mptIssue, outstanding), STAmount(mptIssue, diff))) { // LCOV_EXCL_START - JLOG(j.error()) << "rippleUnlockEscrowMPT: insufficient outstanding amount for " + JLOG(j.error()) << "unlockEscrowMPT: insufficient outstanding amount for " << mptIssue.getMptID() << ": " << outstanding << " < " << diff; return tecINTERNAL; } // LCOV_EXCL_STOP @@ -749,4 +777,175 @@ rippleUnlockEscrowMPT( return tesSUCCESS; } +TER +createMPToken( + ApplyView& view, + MPTID const& mptIssuanceID, + AccountID const& account, + std::uint32_t const flags) +{ + auto const mptokenKey = keylet::mptoken(mptIssuanceID, account); + + auto const ownerNode = + view.dirInsert(keylet::ownerDir(account), mptokenKey, describeOwnerDir(account)); + + if (!ownerNode) + return tecDIR_FULL; // LCOV_EXCL_LINE + + auto mptoken = std::make_shared(mptokenKey); + (*mptoken)[sfAccount] = account; + (*mptoken)[sfMPTokenIssuanceID] = mptIssuanceID; + (*mptoken)[sfFlags] = flags; + (*mptoken)[sfOwnerNode] = *ownerNode; + + view.insert(mptoken); + + return tesSUCCESS; +} + +TER +checkCreateMPT( + xrpl::ApplyView& view, + xrpl::MPTIssue const& mptIssue, + xrpl::AccountID const& holder, + beast::Journal j) +{ + if (mptIssue.getIssuer() == holder) + return tesSUCCESS; + + auto const mptIssuanceID = keylet::mptIssuance(mptIssue.getMptID()); + auto const mptokenID = keylet::mptoken(mptIssuanceID.key, holder); + if (!view.exists(mptokenID)) + { + if (auto const err = createMPToken(view, mptIssue.getMptID(), holder, 0); + !isTesSuccess(err)) + { + return err; + } + auto const sleAcct = view.peek(keylet::account(holder)); + if (!sleAcct) + { + return tecINTERNAL; + } + adjustOwnerCount(view, sleAcct, 1, j); + } + return tesSUCCESS; +} + +std::int64_t +maxMPTAmount(SLE const& sleIssuance) +{ + return sleIssuance[~sfMaximumAmount].value_or(maxMPTokenAmount); +} + +std::int64_t +availableMPTAmount(SLE const& sleIssuance) +{ + auto const max = maxMPTAmount(sleIssuance); + auto const outstanding = sleIssuance[sfOutstandingAmount]; + return max - outstanding; +} + +std::int64_t +availableMPTAmount(ReadView const& view, MPTID const& mptID) +{ + auto const sle = view.read(keylet::mptIssuance(mptID)); + if (!sle) + Throw(transHuman(tecINTERNAL)); + return availableMPTAmount(*sle); +} + +bool +isMPTOverflow( + std::int64_t sendAmount, + std::uint64_t outstandingAmount, + std::int64_t maximumAmount, + AllowMPTOverflow allowOverflow) +{ + std::uint64_t const limit = (allowOverflow == AllowMPTOverflow::Yes) + ? std::numeric_limits::max() + : maximumAmount; + return (sendAmount > maximumAmount || outstandingAmount > (limit - sendAmount)); +} + +STAmount +issuerFundsToSelfIssue(ReadView const& view, MPTIssue const& issue) +{ + STAmount amount{issue}; + + auto const sle = view.read(keylet::mptIssuance(issue)); + if (!sle) + return amount; + auto const available = availableMPTAmount(*sle); + return view.balanceHookSelfIssueMPT(issue, available); +} + +void +issuerSelfDebitHookMPT(ApplyView& view, MPTIssue const& issue, std::uint64_t amount) +{ + auto const available = availableMPTAmount(view, issue); + view.issuerSelfDebitHookMPT(issue, amount, available); +} + +static TER +checkMPTAllowed(ReadView const& view, TxType txType, Asset const& asset, AccountID const& accountID) +{ + if (!asset.holds()) + return tesSUCCESS; + + auto const& issuanceID = asset.get().getMptID(); + auto const validTx = txType == ttAMM_CREATE || txType == ttAMM_DEPOSIT || + txType == ttAMM_WITHDRAW || txType == ttOFFER_CREATE || txType == ttCHECK_CREATE || + txType == ttCHECK_CASH || txType == ttPAYMENT; + XRPL_ASSERT(validTx, "xrpl::checkMPTAllowed : all MPT tx or DEX"); + if (!validTx) + return tefINTERNAL; // LCOV_EXCL_LINE + + auto const& issuer = asset.getIssuer(); + if (!view.exists(keylet::account(issuer))) + return tecNO_ISSUER; // LCOV_EXCL_LINE + + auto const issuanceKey = keylet::mptIssuance(issuanceID); + auto const issuanceSle = view.read(issuanceKey); + if (!issuanceSle) + return tecOBJECT_NOT_FOUND; // LCOV_EXCL_LINE + + auto const flags = issuanceSle->getFlags(); + + if ((flags & lsfMPTLocked) != 0u) + return tecLOCKED; // LCOV_EXCL_LINE + // Offer crossing and Payment + if ((flags & lsfMPTCanTrade) == 0) + return tecNO_PERMISSION; + + if (accountID != issuer) + { + if ((flags & lsfMPTCanTransfer) == 0) + return tecNO_PERMISSION; + + auto const mptSle = view.read(keylet::mptoken(issuanceKey.key, accountID)); + // Allow to succeed since some tx create MPToken if it doesn't exist. + // Tx's have their own check for missing MPToken. + if (!mptSle) + return tesSUCCESS; + + if (mptSle->isFlag(lsfMPTLocked)) + return tecLOCKED; + } + + return tesSUCCESS; +} + +TER +checkMPTTxAllowed( + ReadView const& view, + TxType txType, + Asset const& asset, + AccountID const& accountID) +{ + // use isDEXAllowed for payment/offer crossing + XRPL_ASSERT(txType != ttPAYMENT, "xrpl::checkMPTTxAllowed : not payment"); + return checkMPTAllowed(view, txType, asset, accountID); +} + } // namespace xrpl diff --git a/src/libxrpl/tx/transactors/nft/NFTokenUtils.cpp b/src/libxrpl/ledger/helpers/NFTokenHelpers.cpp similarity index 96% rename from src/libxrpl/tx/transactors/nft/NFTokenUtils.cpp rename to src/libxrpl/ledger/helpers/NFTokenHelpers.cpp index 6a8b830bf0..d70607a26b 100644 --- a/src/libxrpl/tx/transactors/nft/NFTokenUtils.cpp +++ b/src/libxrpl/ledger/helpers/NFTokenHelpers.cpp @@ -1,18 +1,42 @@ -#include -#include -#include +#include + +#include +#include +#include +#include +#include +#include +#include #include #include #include #include +#include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include #include -#include +#include +#include +#include #include +#include #include +#include +#include +#include namespace xrpl { @@ -64,7 +88,7 @@ getPageForToken( // A suitable page doesn't exist; we'll have to create one. if (!cp) { - STArray arr; + STArray const arr; cp = std::make_shared(last); cp->setFieldArray(sfNFTokens, arr); view.insert(cp); @@ -245,7 +269,7 @@ insertToken(ApplyView& view, AccountID owner, STObject&& nft) // First, we need to locate the page the NFT belongs to, creating it // if necessary. This operation may fail if it is impossible to insert // the NFT. - std::shared_ptr page = + std::shared_ptr const page = getPageForToken(view, owner, nft[sfNFTokenID], [](ApplyView& view, AccountID const& owner) { adjustOwnerCount( view, @@ -338,7 +362,7 @@ mergePages(ApplyView& view, std::shared_ptr const& p1, std::shared_ptr TER removeToken(ApplyView& view, AccountID const& owner, uint256 const& nftokenID) { - std::shared_ptr page = locatePage(view, owner, nftokenID); + std::shared_ptr const page = locatePage(view, owner, nftokenID); // If the page couldn't be found, the given NFT isn't owned by this account if (!page) @@ -519,7 +543,7 @@ removeToken( std::optional findToken(ReadView const& view, AccountID const& owner, uint256 const& nftokenID) { - std::shared_ptr page = locatePage(view, owner, nftokenID); + std::shared_ptr const page = locatePage(view, owner, nftokenID); // If the page couldn't be found, the given NFT isn't owned by this account if (!page) @@ -606,33 +630,6 @@ removeTokenOffersWithLimit(ApplyView& view, Keylet const& directory, std::size_t return deletedOffersCount; } -TER -notTooManyOffers(ReadView const& view, uint256 const& nftokenID) -{ - std::size_t totalOffers = 0; - - { - Dir buys(view, keylet::nft_buys(nftokenID)); - for (auto iter = buys.begin(); iter != buys.end(); iter.next_page()) - { - totalOffers += iter.page_size(); - if (totalOffers > maxDeletableTokenOfferEntries) - return tefTOO_BIG; - } - } - - { - Dir sells(view, keylet::nft_sells(nftokenID)); - for (auto iter = sells.begin(); iter != sells.end(); iter.next_page()) - { - totalOffers += iter.page_size(); - if (totalOffers > maxDeletableTokenOfferEntries) - return tefTOO_BIG; - } - } - return tesSUCCESS; -} - bool deleteTokenOffer(ApplyView& view, std::shared_ptr const& offer) { @@ -854,15 +851,15 @@ tokenOfferCreatePreclaim( if (view.rules().enabled(featureNFTokenMintOffer)) { if (nftIssuer != amount.getIssuer() && - !view.read(keylet::line(nftIssuer, amount.issue()))) + !view.read(keylet::line(nftIssuer, amount.get()))) return tecNO_LINE; } - else if (!view.exists(keylet::line(nftIssuer, amount.issue()))) + else if (!view.exists(keylet::line(nftIssuer, amount.get()))) { return tecNO_LINE; } - if (isFrozen(view, nftIssuer, amount.getCurrency(), amount.getIssuer())) + if (isFrozen(view, nftIssuer, amount.get().currency, amount.getIssuer())) return tecFROZEN; } @@ -875,7 +872,7 @@ tokenOfferCreatePreclaim( return tefNFTOKEN_IS_NOT_TRANSFERABLE; } - if (isFrozen(view, acctID, amount.getCurrency(), amount.getIssuer())) + if (isFrozen(view, acctID, amount.get().currency, amount.getIssuer())) return tecFROZEN; // If this is an offer to buy the token, the account must have the diff --git a/src/libxrpl/ledger/helpers/OfferHelpers.cpp b/src/libxrpl/ledger/helpers/OfferHelpers.cpp index 9422153b10..d57066cfe2 100644 --- a/src/libxrpl/ledger/helpers/OfferHelpers.cpp +++ b/src/libxrpl/ledger/helpers/OfferHelpers.cpp @@ -1,9 +1,17 @@ #include -// + +#include +#include +#include +#include #include #include -#include -#include +#include +#include // IWYU pragma: keep +#include +#include + +#include namespace xrpl { @@ -16,7 +24,7 @@ offerDelete(ApplyView& view, std::shared_ptr const& sle, beast::Journal j) auto owner = sle->getAccountID(sfAccount); // Detect legacy directories. - uint256 uDirectory = sle->getFieldH256(sfBookDirectory); + uint256 const uDirectory = sle->getFieldH256(sfBookDirectory); if (!view.dirRemove(keylet::ownerDir(owner), sle->getFieldU64(sfOwnerNode), offerIndex, false)) { diff --git a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelHelpers.cpp b/src/libxrpl/ledger/helpers/PaymentChannelHelpers.cpp similarity index 81% rename from src/libxrpl/tx/transactors/payment_channel/PaymentChannelHelpers.cpp rename to src/libxrpl/ledger/helpers/PaymentChannelHelpers.cpp index 176b920e6b..31c206d85b 100644 --- a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelHelpers.cpp +++ b/src/libxrpl/ledger/helpers/PaymentChannelHelpers.cpp @@ -1,9 +1,18 @@ -#include -#include -#include -#include +#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/dex/PermissionedDEXHelpers.cpp b/src/libxrpl/ledger/helpers/PermissionedDEXHelpers.cpp similarity index 57% rename from src/libxrpl/tx/transactors/dex/PermissionedDEXHelpers.cpp rename to src/libxrpl/ledger/helpers/PermissionedDEXHelpers.cpp index d857795e39..2dfdbc29b2 100644 --- a/src/libxrpl/tx/transactors/dex/PermissionedDEXHelpers.cpp +++ b/src/libxrpl/ledger/helpers/PermissionedDEXHelpers.cpp @@ -1,5 +1,18 @@ +#include + +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { namespace permissioned_dex { @@ -49,10 +62,26 @@ offerInDomain( if (sleOffer->getFieldH256(sfDomainID) != domainID) return false; // LCOV_EXCL_LINE - if (sleOffer->isFlag(lsfHybrid) && !sleOffer->isFieldPresent(sfAdditionalBooks)) + if (view.rules().enabled(fixSecurity3_1_3)) { - JLOG(j.error()) << "Hybrid offer " << offerID << " missing AdditionalBooks field"; - return false; // LCOV_EXCL_LINE + // post-fixSecurity3_1_3: also catches empty sfAdditionalBooks (size == 0) + if (sleOffer->isFlag(lsfHybrid) && + (!sleOffer->isFieldPresent(sfAdditionalBooks) || + sleOffer->getFieldArray(sfAdditionalBooks).size() != 1)) + { + JLOG(j.error()) << "Hybrid offer " << offerID + << " missing or malformed AdditionalBooks field"; + return false; // LCOV_EXCL_LINE + } + } + else + { + // pre-fixSecurity3_1_3: only check for missing sfAdditionalBooks + if (sleOffer->isFlag(lsfHybrid) && !sleOffer->isFieldPresent(sfAdditionalBooks)) + { + JLOG(j.error()) << "Hybrid offer " << offerID << " missing AdditionalBooks field"; + return false; // LCOV_EXCL_LINE + } } return accountInDomain(view, sleOffer->getAccountID(sfAccount), domainID); diff --git a/src/libxrpl/ledger/helpers/RippleStateHelpers.cpp b/src/libxrpl/ledger/helpers/RippleStateHelpers.cpp index 22a0967939..f5a5c01060 100644 --- a/src/libxrpl/ledger/helpers/RippleStateHelpers.cpp +++ b/src/libxrpl/ledger/helpers/RippleStateHelpers.cpp @@ -1,15 +1,34 @@ #include -// + #include +#include +#include +#include +#include #include #include #include #include +#include +#include #include #include +#include #include +#include #include #include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include namespace xrpl { @@ -33,11 +52,14 @@ creditLimit( if (sleRippleState) { result = sleRippleState->getFieldAmount(account < issuer ? sfLowLimit : sfHighLimit); - result.setIssuer(account); + result.get().account = account; } XRPL_ASSERT(result.getIssuer() == account, "xrpl::creditLimit : result issuer match"); - XRPL_ASSERT(result.getCurrency() == currency, "xrpl::creditLimit : result currency match"); + XRPL_ASSERT( + result.get().currency == currency, + "xrpl::creditLimit : result currency " + "match"); return result; } @@ -63,11 +85,14 @@ creditBalance( result = sleRippleState->getFieldAmount(sfBalance); if (account < issuer) result.negate(); - result.setIssuer(account); + result.get().account = account; } XRPL_ASSERT(result.getIssuer() == account, "xrpl::creditBalance : result issuer match"); - XRPL_ASSERT(result.getCurrency() == currency, "xrpl::creditBalance : result currency match"); + XRPL_ASSERT( + result.get().currency == currency, + "xrpl::creditBalance : result currency " + "match"); return result; } @@ -222,7 +247,7 @@ trustCreate( sleRippleState->setFieldAmount(bSetHigh ? sfHighLimit : sfLowLimit, saLimit); sleRippleState->setFieldAmount( bSetHigh ? sfLowLimit : sfHighLimit, - STAmount(Issue{saBalance.getCurrency(), bSetDst ? uSrcAccountID : uDstAccountID})); + STAmount(Issue{saBalance.get().currency, bSetDst ? uSrcAccountID : uDstAccountID})); if (uQualityIn != 0u) sleRippleState->setFieldU32(bSetHigh ? sfHighQualityIn : sfLowQualityIn, uQualityIn); @@ -261,7 +286,7 @@ trustCreate( // ONLY: Create ripple balance. sleRippleState->setFieldAmount(sfBalance, bSetHigh ? -saBalance : saBalance); - view.creditHook(uSrcAccountID, uDstAccountID, saBalance, saBalance.zeroed()); + view.creditHookIOU(uSrcAccountID, uDstAccountID, saBalance, saBalance.zeroed()); return tesSUCCESS; } @@ -275,8 +300,8 @@ trustDelete( beast::Journal j) { // Detect legacy dirs. - std::uint64_t uLowNode = sleRippleState->getFieldU64(sfLowNode); - std::uint64_t uHighNode = sleRippleState->getFieldU64(sfHighNode); + std::uint64_t const uLowNode = sleRippleState->getFieldU64(sfLowNode); + std::uint64_t const uHighNode = sleRippleState->getFieldU64(sfHighNode); JLOG(j.trace()) << "trustDelete: Deleting ripple line: low"; @@ -367,14 +392,14 @@ issueIOU( "xrpl::issueIOU : neither account nor issuer is XRP"); // Consistency check - XRPL_ASSERT(issue == amount.issue(), "xrpl::issueIOU : matching issue"); + XRPL_ASSERT(issue == amount.get(), "xrpl::issueIOU : matching issue"); // Can't send to self! XRPL_ASSERT(issue.account != account, "xrpl::issueIOU : not issuer account"); JLOG(j.trace()) << "issueIOU: " << to_string(account) << ": " << amount.getFullText(); - bool bSenderHigh = issue.account > account; + bool const bSenderHigh = issue.account > account; auto const index = keylet::line(issue.account, account, issue.currency); @@ -392,7 +417,7 @@ issueIOU( auto const must_delete = updateTrustLine( view, state, bSenderHigh, issue.account, start_balance, final_balance, j); - view.creditHook(issue.account, account, amount, start_balance); + view.creditHookIOU(issue.account, account, amount, start_balance); if (bSenderHigh) final_balance.negate(); @@ -422,13 +447,13 @@ issueIOU( STAmount const limit(Issue{issue.currency, account}); STAmount final_balance = amount; - final_balance.setIssuer(noAccount()); + final_balance.get().account = noAccount(); auto const receiverAccount = view.peek(keylet::account(account)); if (!receiverAccount) return tefINTERNAL; // LCOV_EXCL_LINE - bool noRipple = (receiverAccount->getFlags() & lsfDefaultRipple) == 0; + bool const noRipple = (receiverAccount->getFlags() & lsfDefaultRipple) == 0; return trustCreate( view, @@ -461,14 +486,14 @@ redeemIOU( "xrpl::redeemIOU : neither account nor issuer is XRP"); // Consistency check - XRPL_ASSERT(issue == amount.issue(), "xrpl::redeemIOU : matching issue"); + XRPL_ASSERT(issue == amount.get(), "xrpl::redeemIOU : matching issue"); // Can't send to self! XRPL_ASSERT(issue.account != account, "xrpl::redeemIOU : not issuer account"); JLOG(j.trace()) << "redeemIOU: " << to_string(account) << ": " << amount.getFullText(); - bool bSenderHigh = account > issue.account; + bool const bSenderHigh = account > issue.account; if (auto state = view.peek(keylet::line(account, issue.account, issue.currency))) { @@ -484,7 +509,7 @@ redeemIOU( auto const must_delete = updateTrustLine(view, state, bSenderHigh, account, start_balance, final_balance, j); - view.creditHook(account, issue.account, amount, start_balance); + view.creditHookIOU(account, issue.account, amount, start_balance); if (bSenderHigh) final_balance.negate(); @@ -757,4 +782,20 @@ deleteAMMTrustLine( return tesSUCCESS; } +TER +deleteAMMMPToken( + ApplyView& view, + std::shared_ptr sleMpt, + AccountID const& ammAccountID, + beast::Journal j) +{ + if (!view.dirRemove( + keylet::ownerDir(ammAccountID), (*sleMpt)[sfOwnerNode], sleMpt->key(), false)) + return tefBAD_LEDGER; // LCOV_EXCL_LINE + + view.erase(sleMpt); + + return tesSUCCESS; +} + } // namespace xrpl diff --git a/src/libxrpl/ledger/helpers/TokenHelpers.cpp b/src/libxrpl/ledger/helpers/TokenHelpers.cpp index 27ee257e64..d5f1d5eb39 100644 --- a/src/libxrpl/ledger/helpers/TokenHelpers.cpp +++ b/src/libxrpl/ledger/helpers/TokenHelpers.cpp @@ -1,19 +1,34 @@ #include -// + #include +#include +#include #include +#include +#include #include #include #include +#include +#include +#include #include #include +#include #include +#include #include -#include +#include +#include +#include +#include #include -#include +#include +#include -#include +#include +#include +#include #include namespace xrpl { @@ -23,8 +38,8 @@ bool isLPTokenFrozen( ReadView const& view, AccountID const& account, - Issue const& asset, - Issue const& asset2); + Asset const& asset, + Asset const& asset2); //------------------------------------------------------------------------------ // @@ -35,18 +50,9 @@ isLPTokenFrozen( bool isGlobalFrozen(ReadView const& view, Asset const& asset) { - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - { - return isGlobalFrozen(view, issue.getIssuer()); - } - else - { - return isGlobalFrozen(view, issue); - } - }, - asset.value()); + return asset.visit( + [&](Issue const& issue) { return isGlobalFrozen(view, issue.getIssuer()); }, + [&](MPTIssue const& issue) { return isGlobalFrozen(view, issue); }); } bool @@ -103,18 +109,9 @@ isAnyFrozen( Asset const& asset, int depth) { - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - { - return isAnyFrozen(view, accounts, issue); - } - else - { - return isAnyFrozen(view, accounts, issue, depth); - } - }, - asset.value()); + return asset.visit( + [&](Issue const& issue) { return isAnyFrozen(view, accounts, issue); }, + [&](MPTIssue const& issue) { return isAnyFrozen(view, accounts, issue, depth); }); } bool @@ -190,11 +187,7 @@ getLineIfUsable( auto const sleAmm = view.read(keylet::amm((*sleIssuer)[sfAMMID])); if (!sleAmm || - isLPTokenFrozen( - view, - account, - (*sleAmm)[sfAsset].get(), - (*sleAmm)[sfAsset2].get())) + isLPTokenFrozen(view, account, (*sleAmm)[sfAsset], (*sleAmm)[sfAsset2])) { return nullptr; } @@ -230,7 +223,7 @@ getTrustLineBalance( { amount += sle->getFieldAmount(oppositeField); } - amount.setIssuer(issuer); + amount.get().account = issuer; } else { @@ -240,7 +233,7 @@ getTrustLineBalance( JLOG(j.trace()) << "getTrustLineBalance:" << " account=" << to_string(account) << " amount=" << amount.getFullText(); - return view.balanceHook(account, issuer, amount); + return view.balanceHookIOU(account, issuer, amount); } STAmount @@ -253,7 +246,7 @@ accountHolds( beast::Journal j, SpendableHandling includeFullBalance) { - STAmount amount; + STAmount const amount; if (isXRP(currency)) { return {xrpLiquid(view, account, 0, j)}; @@ -298,6 +291,9 @@ accountHolds( SpendableHandling includeFullBalance) { bool const returnSpendable = (includeFullBalance == shFULL_BALANCE); + STAmount amount{mptIssue}; + auto const& issuer = mptIssue.getIssuer(); + bool const mptokensV2 = view.rules().enabled(featureMPTokensV2); if (returnSpendable && account == mptIssue.getIssuer()) { @@ -307,16 +303,14 @@ accountHolds( if (!issuance) { - return STAmount{mptIssue}; + return amount; } - return STAmount{ - mptIssue, - issuance->at(~sfMaximumAmount).value_or(maxMPTokenAmount) - - issuance->at(sfOutstandingAmount)}; + auto const available = availableMPTAmount(*issuance); + if (!mptokensV2) + return STAmount{mptIssue, available}; + return view.balanceHookMPT(issuer, mptIssue, available); } - STAmount amount; - auto const sleMpt = view.read(keylet::mptoken(mptIssue.getMptID(), account)); if (!sleMpt) @@ -352,6 +346,8 @@ accountHolds( } } + if (view.rules().enabled(featureMPTokensV2)) + return view.balanceHookMPT(account, mptIssue, amount.mpt().value()); return amount; } @@ -365,19 +361,14 @@ accountHolds( beast::Journal j, SpendableHandling includeFullBalance) { - return std::visit( - [&](TIss const& value) { - if constexpr (std::is_same_v) - { - return accountHolds(view, account, value, zeroIfFrozen, j, includeFullBalance); - } - else if constexpr (std::is_same_v) - { - return accountHolds( - view, account, value, zeroIfFrozen, zeroIfUnauthorized, j, includeFullBalance); - } + return asset.visit( + [&](Issue const& issue) { + return accountHolds(view, account, issue, zeroIfFrozen, j, includeFullBalance); }, - asset.value()); + [&](MPTIssue const& issue) { + return accountHolds( + view, account, issue, zeroIfFrozen, zeroIfUnauthorized, j, includeFullBalance); + }); } STAmount @@ -388,28 +379,38 @@ accountFunds( FreezeHandling freezeHandling, beast::Journal j) { + XRPL_ASSERT(saDefault.holds(), "xrpl::accountFunds: saDefault holds Issue"); + if (!saDefault.native() && saDefault.getIssuer() == id) return saDefault; return accountHolds( - view, id, saDefault.getCurrency(), saDefault.getIssuer(), freezeHandling, j); + view, id, saDefault.get().currency, saDefault.getIssuer(), freezeHandling, j); +} + +STAmount +accountFunds( + ReadView const& view, + AccountID const& id, + STAmount const& saDefault, + FreezeHandling freezeHandling, + AuthHandling authHandling, + beast::Journal j) +{ + return saDefault.asset().visit( + [&](Issue const&) { return accountFunds(view, id, saDefault, freezeHandling, j); }, + [&](MPTIssue const&) { + return accountHolds( + view, id, saDefault.asset(), freezeHandling, authHandling, j, shFULL_BALANCE); + }); } Rate transferRate(ReadView const& view, STAmount const& amount) { - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - { - return transferRate(view, issue.getIssuer()); - } - else - { - return transferRate(view, issue.getMptID()); - } - }, - amount.asset().value()); + return amount.asset().visit( + [&](Issue const& issue) { return transferRate(view, issue.getIssuer()); }, + [&](MPTIssue const& issue) { return transferRate(view, issue.getMptID()); }); } //------------------------------------------------------------------------------ @@ -513,7 +514,7 @@ canTransfer(ReadView const& view, Asset const& asset, AccountID const& from, Acc // - Create trust line if needed. // --> bCheckIssuer : normally require issuer to be involved. static TER -rippleCreditIOU( +directSendNoFeeIOU( ApplyView& view, AccountID const& uSenderID, AccountID const& uReceiverID, @@ -522,25 +523,26 @@ rippleCreditIOU( beast::Journal j) { AccountID const& issuer = saAmount.getIssuer(); - Currency const& currency = saAmount.getCurrency(); + Currency const& currency = saAmount.get().currency; // Make sure issuer is involved. XRPL_ASSERT( !bCheckIssuer || uSenderID == issuer || uReceiverID == issuer, - "xrpl::rippleCreditIOU : matching issuer or don't care"); + "xrpl::directSendNoFeeIOU : matching issuer or don't care"); (void)issuer; // Disallow sending to self. - XRPL_ASSERT(uSenderID != uReceiverID, "xrpl::rippleCreditIOU : sender is not receiver"); + XRPL_ASSERT(uSenderID != uReceiverID, "xrpl::directSendNoFeeIOU : sender is not receiver"); bool const bSenderHigh = uSenderID > uReceiverID; auto const index = keylet::line(uSenderID, uReceiverID, currency); XRPL_ASSERT( - !isXRP(uSenderID) && uSenderID != noAccount(), "xrpl::rippleCreditIOU : sender is not XRP"); + !isXRP(uSenderID) && uSenderID != noAccount(), + "xrpl::directSendNoFeeIOU : sender is not XRP"); XRPL_ASSERT( !isXRP(uReceiverID) && uReceiverID != noAccount(), - "xrpl::rippleCreditIOU : receiver is not XRP"); + "xrpl::directSendNoFeeIOU : receiver is not XRP"); // If the line exists, modify it accordingly. if (auto const sleRippleState = view.peek(index)) @@ -550,13 +552,13 @@ rippleCreditIOU( if (bSenderHigh) saBalance.negate(); // Put balance in sender terms. - view.creditHook(uSenderID, uReceiverID, saAmount, saBalance); + view.creditHookIOU(uSenderID, uReceiverID, saAmount, saBalance); STAmount const saBefore = saBalance; saBalance -= saAmount; - JLOG(j.trace()) << "rippleCreditIOU: " << to_string(uSenderID) << " -> " + JLOG(j.trace()) << "directSendNoFeeIOU: " << to_string(uSenderID) << " -> " << to_string(uReceiverID) << " : before=" << saBefore.getFullText() << " amount=" << saAmount.getFullText() << " after=" << saBalance.getFullText(); @@ -602,7 +604,7 @@ rippleCreditIOU( // Want to reflect balance to zero even if we are deleting line. sleRippleState->setFieldAmount(sfBalance, saBalance); - // ONLY: Adjust ripple balance. + // ONLY: Adjust balance. if (bDelete) { @@ -621,9 +623,9 @@ rippleCreditIOU( STAmount const saReceiverLimit(Issue{currency, uReceiverID}); STAmount saBalance{saAmount}; - saBalance.setIssuer(noAccount()); + saBalance.get().account = noAccount(); - JLOG(j.debug()) << "rippleCreditIOU: " + JLOG(j.debug()) << "directSendNoFeeIOU: " "create line: " << to_string(uSenderID) << " -> " << to_string(uReceiverID) << " : " << saAmount.getFullText(); @@ -656,7 +658,7 @@ rippleCreditIOU( // --> saAmount: Amount/currency/issuer to deliver to receiver. // <-- saActual: Amount actually cost. Sender pays fees. static TER -rippleSendIOU( +directSendNoLimitIOU( ApplyView& view, AccountID const& uSenderID, AccountID const& uReceiverID, @@ -669,13 +671,13 @@ rippleSendIOU( XRPL_ASSERT( !isXRP(uSenderID) && !isXRP(uReceiverID), - "xrpl::rippleSendIOU : neither sender nor receiver is XRP"); - XRPL_ASSERT(uSenderID != uReceiverID, "xrpl::rippleSendIOU : sender is not receiver"); + "xrpl::directSendNoLimitIOU : neither sender nor receiver is XRP"); + XRPL_ASSERT(uSenderID != uReceiverID, "xrpl::directSendNoLimitIOU : sender is not receiver"); if (uSenderID == issuer || uReceiverID == issuer || issuer == noAccount()) { // Direct send: redeeming IOUs and/or sending own IOUs. - auto const ter = rippleCreditIOU(view, uSenderID, uReceiverID, saAmount, false, j); + auto const ter = directSendNoFeeIOU(view, uSenderID, uReceiverID, saAmount, false, j); if (!isTesSuccess(ter)) return ter; saActual = saAmount; @@ -689,14 +691,14 @@ rippleSendIOU( saActual = (waiveFee == WaiveTransferFee::Yes) ? saAmount : multiply(saAmount, transferRate(view, issuer)); - JLOG(j.debug()) << "rippleSendIOU> " << to_string(uSenderID) << " - > " + JLOG(j.debug()) << "directSendNoLimitIOU> " << to_string(uSenderID) << " - > " << to_string(uReceiverID) << " : deliver=" << saAmount.getFullText() << " cost=" << saActual.getFullText(); - TER terResult = rippleCreditIOU(view, issuer, uReceiverID, saAmount, true, j); + TER terResult = directSendNoFeeIOU(view, issuer, uReceiverID, saAmount, true, j); if (tesSUCCESS == terResult) - terResult = rippleCreditIOU(view, uSenderID, issuer, saActual, true, j); + terResult = directSendNoFeeIOU(view, uSenderID, issuer, saActual, true, j); return terResult; } @@ -705,7 +707,7 @@ rippleSendIOU( // --> receivers: Amount/currency/issuer to deliver to receivers. // <-- saActual: Amount actually cost to sender. Sender pays fees. static TER -rippleSendMultiIOU( +directSendNoLimitMultiIOU( ApplyView& view, AccountID const& senderID, Issue const& issue, @@ -716,7 +718,7 @@ rippleSendMultiIOU( { auto const& issuer = issue.getIssuer(); - XRPL_ASSERT(!isXRP(senderID), "xrpl::rippleSendMultiIOU : sender is not XRP"); + XRPL_ASSERT(!isXRP(senderID), "xrpl::directSendNoLimitMultiIOU : sender is not XRP"); // These may diverge STAmount takeFromSender{issue}; @@ -726,7 +728,7 @@ rippleSendMultiIOU( for (auto const& r : receivers) { auto const& receiverID = r.first; - STAmount amount{issue, r.second}; + STAmount const amount{issue, r.second}; /* If we aren't sending anything or if the sender is the same as the * receiver then we don't need to do anything. @@ -734,15 +736,15 @@ rippleSendMultiIOU( if (!amount || (senderID == receiverID)) continue; - XRPL_ASSERT(!isXRP(receiverID), "xrpl::rippleSendMultiIOU : receiver is not XRP"); + XRPL_ASSERT(!isXRP(receiverID), "xrpl::directSendNoLimitMultiIOU : receiver is not XRP"); if (senderID == issuer || receiverID == issuer || issuer == noAccount()) { // Direct send: redeeming IOUs and/or sending own IOUs. - if (auto const ter = rippleCreditIOU(view, senderID, receiverID, amount, false, j)) + if (auto const ter = directSendNoFeeIOU(view, senderID, receiverID, amount, false, j)) return ter; actual += amount; - // Do not add amount to takeFromSender, because rippleCreditIOU took + // Do not add amount to takeFromSender, because directSendNoFeeIOU took // it. continue; @@ -752,23 +754,24 @@ rippleSendMultiIOU( // Calculate the amount to transfer accounting // for any transfer fees if the fee is not waived: - STAmount actualSend = (waiveFee == WaiveTransferFee::Yes) + STAmount const actualSend = (waiveFee == WaiveTransferFee::Yes) ? amount : multiply(amount, transferRate(view, issuer)); actual += actualSend; takeFromSender += actualSend; - JLOG(j.debug()) << "rippleSendMultiIOU> " << to_string(senderID) << " - > " + JLOG(j.debug()) << "directSendNoLimitMultiIOU> " << to_string(senderID) << " - > " << to_string(receiverID) << " : deliver=" << amount.getFullText() << " cost=" << actual.getFullText(); - if (TER const terResult = rippleCreditIOU(view, issuer, receiverID, amount, true, j)) + if (TER const terResult = directSendNoFeeIOU(view, issuer, receiverID, amount, true, j)) return terResult; } if (senderID != issuer && takeFromSender) { - if (TER const terResult = rippleCreditIOU(view, senderID, issuer, takeFromSender, true, j)) + if (TER const terResult = + directSendNoFeeIOU(view, senderID, issuer, takeFromSender, true, j)) return terResult; } @@ -813,7 +816,7 @@ accountSendIOU( JLOG(j.trace()) << "accountSendIOU: " << to_string(uSenderID) << " -> " << to_string(uReceiverID) << " : " << saAmount.getFullText(); - return rippleSendIOU(view, uSenderID, uReceiverID, saAmount, saActual, j, waiveFee); + return directSendNoLimitIOU(view, uSenderID, uReceiverID, saAmount, saActual, j, waiveFee); } /* XRP send which does not check reserve and can do pure adjustment. @@ -823,9 +826,9 @@ accountSendIOU( */ TER terResult(tesSUCCESS); - SLE::pointer sender = + SLE::pointer const sender = uSenderID != beast::zero ? view.peek(keylet::account(uSenderID)) : SLE::pointer(); - SLE::pointer receiver = + SLE::pointer const receiver = uReceiverID != beast::zero ? view.peek(keylet::account(uReceiverID)) : SLE::pointer(); if (auto stream = j.trace()) @@ -857,7 +860,7 @@ accountSendIOU( else { auto const sndBal = sender->getFieldAmount(sfBalance); - view.creditHook(uSenderID, xrpAccount(), saAmount, sndBal); + view.creditHookIOU(uSenderID, xrpAccount(), saAmount, sndBal); // Decrement XRP balance. sender->setFieldAmount(sfBalance, sndBal - saAmount); @@ -870,7 +873,7 @@ accountSendIOU( // Increment XRP balance. auto const rcvBal = receiver->getFieldAmount(sfBalance); receiver->setFieldAmount(sfBalance, rcvBal + saAmount); - view.creditHook(xrpAccount(), uReceiverID, saAmount, -rcvBal); + view.creditHookIOU(xrpAccount(), uReceiverID, saAmount, -rcvBal); view.update(receiver); } @@ -912,7 +915,7 @@ accountSendMultiIOU( JLOG(j.trace()) << "accountSendMultiIOU: " << to_string(senderID) << " sending " << receivers.size() << " IOUs"; - return rippleSendMultiIOU(view, senderID, issue, receivers, actual, j, waiveFee); + return directSendNoLimitMultiIOU(view, senderID, issue, receivers, actual, j, waiveFee); } /* XRP send which does not check reserve and can do pure adjustment. @@ -921,7 +924,7 @@ accountSendMultiIOU( * ensure that transfers are balanced. */ - SLE::pointer sender = + SLE::pointer const sender = senderID != beast::zero ? view.peek(keylet::account(senderID)) : SLE::pointer(); if (auto stream = j.trace()) @@ -940,7 +943,7 @@ accountSendMultiIOU( for (auto const& r : receivers) { auto const& receiverID = r.first; - STAmount amount{issue, r.second}; + STAmount const amount{issue, r.second}; if (amount < beast::zero) { @@ -953,7 +956,7 @@ accountSendMultiIOU( if (!amount || (senderID == receiverID)) continue; - SLE::pointer receiver = + SLE::pointer const receiver = receiverID != beast::zero ? view.peek(keylet::account(receiverID)) : SLE::pointer(); if (auto stream = j.trace()) @@ -973,7 +976,7 @@ accountSendMultiIOU( // Increment XRP balance. auto const rcvBal = receiver->getFieldAmount(sfBalance); receiver->setFieldAmount(sfBalance, rcvBal + amount); - view.creditHook(xrpAccount(), receiverID, amount, -rcvBal); + view.creditHookIOU(xrpAccount(), receiverID, amount, -rcvBal); view.update(receiver); @@ -1001,7 +1004,7 @@ accountSendMultiIOU( return TER{tecFAILED_PROCESSING}; } auto const sndBal = sender->getFieldAmount(sfBalance); - view.creditHook(senderID, xrpAccount(), takeFromSender, sndBal); + view.creditHookIOU(senderID, xrpAccount(), takeFromSender, sndBal); // Decrement XRP balance. sender->setFieldAmount(sfBalance, sndBal - takeFromSender); @@ -1022,7 +1025,7 @@ accountSendMultiIOU( } static TER -rippleCreditMPT( +directSendNoFeeMPT( ApplyView& view, AccountID const& uSenderID, AccountID const& uReceiverID, @@ -1035,9 +1038,20 @@ rippleCreditMPT( auto sleIssuance = view.peek(mptID); if (!sleIssuance) return tecOBJECT_NOT_FOUND; + + auto const maxAmount = maxMPTAmount(*sleIssuance); + auto const outstanding = sleIssuance->getFieldU64(sfOutstandingAmount); + auto const available = availableMPTAmount(*sleIssuance); + auto const amt = saAmount.mpt().value(); + if (uSenderID == issuer) { - (*sleIssuance)[sfOutstandingAmount] += saAmount.mpt().value(); + if (view.rules().enabled(featureMPTokensV2)) + { + if (isMPTOverflow(amt, outstanding, maxAmount, AllowMPTOverflow::Yes)) + return tecPATH_DRY; + } + (*sleIssuance)[sfOutstandingAmount] += amt; view.update(sleIssuance); } else @@ -1045,11 +1059,11 @@ rippleCreditMPT( auto const mptokenID = keylet::mptoken(mptID.key, uSenderID); if (auto sle = view.peek(mptokenID)) { - auto const amt = sle->getFieldU64(sfMPTAmount); - auto const pay = saAmount.mpt().value(); - if (amt < pay) + auto const senderBalance = sle->getFieldU64(sfMPTAmount); + if (senderBalance < amt) return tecINSUFFICIENT_FUNDS; - (*sle)[sfMPTAmount] = amt - pay; + view.creditHookMPT(uSenderID, uReceiverID, saAmount, (*sle)[sfMPTAmount], available); + (*sle)[sfMPTAmount] = senderBalance - amt; view.update(sle); } else @@ -1060,11 +1074,9 @@ rippleCreditMPT( if (uReceiverID == issuer) { - auto const outstanding = sleIssuance->getFieldU64(sfOutstandingAmount); - auto const redeem = saAmount.mpt().value(); - if (outstanding >= redeem) + if (outstanding >= amt) { - sleIssuance->setFieldU64(sfOutstandingAmount, outstanding - redeem); + sleIssuance->setFieldU64(sfOutstandingAmount, outstanding - amt); view.update(sleIssuance); } else @@ -1077,7 +1089,8 @@ rippleCreditMPT( auto const mptokenID = keylet::mptoken(mptID.key, uReceiverID); if (auto sle = view.peek(mptokenID)) { - (*sle)[sfMPTAmount] += saAmount.mpt().value(); + view.creditHookMPT(uSenderID, uReceiverID, saAmount, (*sle)[sfMPTAmount], available); + (*sle)[sfMPTAmount] += amt; view.update(sle); } else @@ -1090,18 +1103,19 @@ rippleCreditMPT( } static TER -rippleSendMPT( +directSendNoLimitMPT( ApplyView& view, AccountID const& uSenderID, AccountID const& uReceiverID, STAmount const& saAmount, STAmount& saActual, beast::Journal j, - WaiveTransferFee waiveFee) + WaiveTransferFee waiveFee, + AllowMPTOverflow allowOverflow) { - XRPL_ASSERT(uSenderID != uReceiverID, "xrpl::rippleSendMPT : sender is not receiver"); + XRPL_ASSERT(uSenderID != uReceiverID, "xrpl::directSendNoLimitMPT : sender is not receiver"); - // Safe to get MPT since rippleSendMPT is only called by accountSendMPT + // Safe to get MPT since directSendNoLimitMPT is only called by accountSendMPT auto const& issuer = saAmount.getIssuer(); auto const sle = view.read(keylet::mptIssuance(saAmount.get().getMptID())); @@ -1115,14 +1129,18 @@ rippleSendMPT( if (uSenderID == issuer) { auto const sendAmount = saAmount.mpt().value(); - auto const maximumAmount = sle->at(~sfMaximumAmount).value_or(maxMPTokenAmount); - if (sendAmount > maximumAmount || - sle->getFieldU64(sfOutstandingAmount) > maximumAmount - sendAmount) + auto const maxAmount = maxMPTAmount(*sle); + auto const outstanding = sle->getFieldU64(sfOutstandingAmount); + auto const mptokensV2 = view.rules().enabled(featureMPTokensV2); + allowOverflow = (allowOverflow == AllowMPTOverflow::Yes && mptokensV2) + ? AllowMPTOverflow::Yes + : AllowMPTOverflow::No; + if (isMPTOverflow(sendAmount, outstanding, maxAmount, allowOverflow)) return tecPATH_DRY; } // Direct send: redeeming MPTs and/or sending own MPTs. - auto const ter = rippleCreditMPT(view, uSenderID, uReceiverID, saAmount, j); + auto const ter = directSendNoFeeMPT(view, uSenderID, uReceiverID, saAmount, j); if (!isTesSuccess(ter)) return ter; saActual = saAmount; @@ -1134,19 +1152,19 @@ rippleSendMPT( ? saAmount : multiply(saAmount, transferRate(view, saAmount.get().getMptID())); - JLOG(j.debug()) << "rippleSendMPT> " << to_string(uSenderID) << " - > " + JLOG(j.debug()) << "directSendNoLimitMPT> " << to_string(uSenderID) << " - > " << to_string(uReceiverID) << " : deliver=" << saAmount.getFullText() << " cost=" << saActual.getFullText(); - if (auto const terResult = rippleCreditMPT(view, issuer, uReceiverID, saAmount, j); + if (auto const terResult = directSendNoFeeMPT(view, issuer, uReceiverID, saAmount, j); !isTesSuccess(terResult)) return terResult; - return rippleCreditMPT(view, uSenderID, issuer, saActual, j); + return directSendNoFeeMPT(view, uSenderID, issuer, saActual, j); } static TER -rippleSendMultiMPT( +directSendNoLimitMultiMPT( ApplyView& view, AccountID const& senderID, MPTIssue const& mptIssue, @@ -1155,79 +1173,111 @@ rippleSendMultiMPT( beast::Journal j, WaiveTransferFee waiveFee) { - // Safe to get MPT since rippleSendMultiMPT is only called by - // accountSendMultiMPT auto const& issuer = mptIssue.getIssuer(); auto const sle = view.read(keylet::mptIssuance(mptIssue.getMptID())); if (!sle) return tecOBJECT_NOT_FOUND; - // These may diverge + // For the issuer-as-sender case, track the running total to validate + // against MaximumAmount. The read-only SLE (view.read) is not updated + // by directSendNoFeeMPT, so a per-iteration SLE read would be stale. + // Use uint64_t, not STAmount, to keep MaximumAmount comparisons in exact + // integer arithmetic. STAmount implicitly converts to Number, whose + // small-scale mantissa (~16 digits) can lose precision for values near + // maxMPTokenAmount (19 digits). + std::uint64_t totalSendAmount{0}; + std::uint64_t const maximumAmount = sle->at(~sfMaximumAmount).value_or(maxMPTokenAmount); + std::uint64_t const outstandingAmount = sle->getFieldU64(sfOutstandingAmount); + + // actual accumulates the total cost to the sender (includes transfer + // fees for third-party transit sends). takeFromSender accumulates only + // the transit portion that is debited to the issuer in bulk after the + // loop. They diverge when there are transfer fees. STAmount takeFromSender{mptIssue}; actual = takeFromSender; - for (auto const& r : receivers) + for (auto const& [receiverID, amt] : receivers) { - auto const& receiverID = r.first; - STAmount amount{mptIssue, r.second}; + STAmount const amount{mptIssue, amt}; if (amount < beast::zero) - { return tecINTERNAL; // LCOV_EXCL_LINE - } - /* If we aren't sending anything or if the sender is the same as the - * receiver then we don't need to do anything. - */ - if (!amount || (senderID == receiverID)) + if (!amount || senderID == receiverID) continue; if (senderID == issuer || receiverID == issuer) { - // if sender is issuer, check that the new OutstandingAmount will - // not exceed MaximumAmount if (senderID == issuer) { XRPL_ASSERT_PARTS( takeFromSender == beast::zero, - "xrpl::rippleSendMultiMPT", + "xrpl::directSendNoLimitMultiMPT", "sender == issuer, takeFromSender == zero"); - auto const sendAmount = amount.mpt().value(); - auto const maximumAmount = sle->at(~sfMaximumAmount).value_or(maxMPTokenAmount); - if (sendAmount > maximumAmount || - sle->getFieldU64(sfOutstandingAmount) > maximumAmount - sendAmount) - return tecPATH_DRY; + + std::uint64_t const sendAmount = amount.mpt().value(); + + if (view.rules().enabled(fixSecurity3_1_3)) + { + // Post-fixSecurity3_1_3: aggregate MaximumAmount + // check. WARNING: the order of conditions is + // critical — each guards the subtraction in the + // next against unsigned underflow. Do not reorder. + bool const exceedsMaximumAmount = + // This send alone exceeds the max cap + sendAmount > maximumAmount || + // The aggregate of all sends exceeds the max cap + totalSendAmount > maximumAmount - sendAmount || + // Outstanding + aggregate exceeds the max cap + outstandingAmount > maximumAmount - sendAmount - totalSendAmount; + + if (exceedsMaximumAmount) + return tecPATH_DRY; + totalSendAmount += sendAmount; + } + else + { + // Pre-fixSecurity3_1_3: per-iteration MaximumAmount + // check. Reads sfOutstandingAmount from a stale + // view.read() snapshot — incorrect for multi-destination + // sends but retained for ledger replay compatibility. + if (sendAmount > maximumAmount || + outstandingAmount > maximumAmount - sendAmount) + return tecPATH_DRY; + } } // Direct send: redeeming MPTs and/or sending own MPTs. - if (auto const ter = rippleCreditMPT(view, senderID, receiverID, amount, j)) + if (auto const ter = directSendNoFeeMPT(view, senderID, receiverID, amount, j); + !isTesSuccess(ter)) return ter; actual += amount; - // Do not add amount to takeFromSender, because rippleCreditMPT took - // it + // Do not add amount to takeFromSender, because directSendNoFeeMPT took it. continue; } // Sending 3rd party MPTs: transit. - STAmount actualSend = (waiveFee == WaiveTransferFee::Yes) + STAmount const actualSend = (waiveFee == WaiveTransferFee::Yes) ? amount : multiply(amount, transferRate(view, amount.get().getMptID())); actual += actualSend; takeFromSender += actualSend; - JLOG(j.debug()) << "rippleSendMultiMPT> " << to_string(senderID) << " - > " + JLOG(j.debug()) << "directSendNoLimitMultiMPT> " << to_string(senderID) << " - > " << to_string(receiverID) << " : deliver=" << amount.getFullText() << " cost=" << actualSend.getFullText(); - if (auto const terResult = rippleCreditMPT(view, issuer, receiverID, amount, j)) - return terResult; + if (auto const ter = directSendNoFeeMPT(view, issuer, receiverID, amount, j); + !isTesSuccess(ter)) + return ter; } if (senderID != issuer && takeFromSender) { - if (TER const terResult = rippleCreditMPT(view, senderID, issuer, takeFromSender, j)) - return terResult; + if (auto const ter = directSendNoFeeMPT(view, senderID, issuer, takeFromSender, j); + !isTesSuccess(ter)) + return ter; } return tesSUCCESS; @@ -1240,7 +1290,8 @@ accountSendMPT( AccountID const& uReceiverID, STAmount const& saAmount, beast::Journal j, - WaiveTransferFee waiveFee) + WaiveTransferFee waiveFee, + AllowMPTOverflow allowOverflow) { XRPL_ASSERT( saAmount >= beast::zero && saAmount.holds(), @@ -1254,7 +1305,8 @@ accountSendMPT( STAmount saActual{saAmount.asset()}; - return rippleSendMPT(view, uSenderID, uReceiverID, saAmount, saActual, j, waiveFee); + return directSendNoLimitMPT( + view, uSenderID, uReceiverID, saAmount, saActual, j, waiveFee, allowOverflow); } static TER @@ -1268,7 +1320,7 @@ accountSendMultiMPT( { STAmount actual; - return rippleSendMultiMPT(view, senderID, mptIssue, receivers, actual, j, waiveFee); + return directSendNoLimitMultiMPT(view, senderID, mptIssue, receivers, actual, j, waiveFee); } //------------------------------------------------------------------------------ @@ -1278,7 +1330,7 @@ accountSendMultiMPT( //------------------------------------------------------------------------------ TER -rippleCredit( +directSendNoFee( ApplyView& view, AccountID const& uSenderID, AccountID const& uReceiverID, @@ -1286,19 +1338,14 @@ rippleCredit( bool bCheckIssuer, beast::Journal j) { - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - { - return rippleCreditIOU(view, uSenderID, uReceiverID, saAmount, bCheckIssuer, j); - } - else - { - XRPL_ASSERT(!bCheckIssuer, "xrpl::rippleCredit : not checking issuer"); - return rippleCreditMPT(view, uSenderID, uReceiverID, saAmount, j); - } + return saAmount.asset().visit( + [&](Issue const&) { + return directSendNoFeeIOU(view, uSenderID, uReceiverID, saAmount, bCheckIssuer, j); }, - saAmount.asset().value()); + [&](MPTIssue const&) { + XRPL_ASSERT(!bCheckIssuer, "xrpl::directSendNoFee : not checking issuer"); + return directSendNoFeeMPT(view, uSenderID, uReceiverID, saAmount, j); + }); } TER @@ -1308,20 +1355,17 @@ accountSend( AccountID const& uReceiverID, STAmount const& saAmount, beast::Journal j, - WaiveTransferFee waiveFee) + WaiveTransferFee waiveFee, + AllowMPTOverflow allowOverflow) { - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - { - return accountSendIOU(view, uSenderID, uReceiverID, saAmount, j, waiveFee); - } - else - { - return accountSendMPT(view, uSenderID, uReceiverID, saAmount, j, waiveFee); - } + return saAmount.asset().visit( + [&](Issue const&) { + return accountSendIOU(view, uSenderID, uReceiverID, saAmount, j, waiveFee); }, - saAmount.asset().value()); + [&](MPTIssue const&) { + return accountSendMPT( + view, uSenderID, uReceiverID, saAmount, j, waiveFee, allowOverflow); + }); } TER @@ -1335,18 +1379,13 @@ accountSendMulti( { XRPL_ASSERT_PARTS( receivers.size() > 1, "xrpl::accountSendMulti", "multiple recipients provided"); - return std::visit( - [&](TIss const& issue) { - if constexpr (std::is_same_v) - { - return accountSendMultiIOU(view, senderID, issue, receivers, j, waiveFee); - } - else - { - return accountSendMultiMPT(view, senderID, issue, receivers, j, waiveFee); - } + return asset.visit( + [&](Issue const& issue) { + return accountSendMultiIOU(view, senderID, issue, receivers, j, waiveFee); }, - asset.value()); + [&](MPTIssue const& issue) { + return accountSendMultiMPT(view, senderID, issue, receivers, j, waiveFee); + }); } TER diff --git a/src/libxrpl/ledger/helpers/VaultHelpers.cpp b/src/libxrpl/ledger/helpers/VaultHelpers.cpp index 83a1b9fc4f..99500b36bf 100644 --- a/src/libxrpl/ledger/helpers/VaultHelpers.cpp +++ b/src/libxrpl/ledger/helpers/VaultHelpers.cpp @@ -1,8 +1,14 @@ #include -// + #include -#include -#include +#include +#include +#include +#include +#include // IWYU pragma: keep + +#include +#include namespace xrpl { diff --git a/src/libxrpl/net/HTTPClient.cpp b/src/libxrpl/net/HTTPClient.cpp index 65205be39c..b39a605313 100644 --- a/src/libxrpl/net/HTTPClient.cpp +++ b/src/libxrpl/net/HTTPClient.cpp @@ -1,16 +1,35 @@ +#include + #include #include +#include #include -#include #include -#include +#include +#include +#include +#include +#include #include #include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { @@ -184,7 +203,7 @@ public: JLOG(j_.trace()) << "Deadline error: " << mDeqSites[0] << ": " << ecResult.message(); // Can't do anything sound. - abort(); + std::abort(); } else { @@ -347,10 +366,10 @@ public: {std::istreambuf_iterator(&mHeader)}, std::istreambuf_iterator()}; JLOG(j_.trace()) << "Header: \"" << strHeader << "\""; - static boost::regex reStatus{"\\`HTTP/1\\S+ (\\d{3}) .*\\'"}; // HTTP/1.1 200 OK - static boost::regex reSize{ + static boost::regex const reStatus{"\\`HTTP/1\\S+ (\\d{3}) .*\\'"}; // HTTP/1.1 200 OK + static boost::regex const reSize{ "\\`.*\\r\\nContent-Length:\\s+([0-9]+).*\\'", boost::regex::icase}; - static boost::regex reBody{"\\`.*\\r\\n\\r\\n(.*)\\'"}; + static boost::regex const reBody{"\\`.*\\r\\n\\r\\n(.*)\\'"}; boost::smatch smMatch; // Match status code. @@ -428,7 +447,7 @@ public: else { mResponse.commit(bytes_transferred); - std::string strBody{ + std::string const strBody{ {std::istreambuf_iterator(&mResponse)}, std::istreambuf_iterator()}; invokeComplete(ecResult, mStatus, mBody + strBody); } @@ -547,7 +566,7 @@ HTTPClient::get( complete, beast::Journal& j) { - std::deque deqSites(1, strSite); + std::deque const deqSites(1, strSite); auto client = std::make_shared(io_context, port, responseMax, j); client->get(bSSL, deqSites, strPath, timeout, complete); @@ -567,7 +586,7 @@ HTTPClient::request( complete, beast::Journal& j) { - std::deque deqSites(1, strSite); + std::deque const deqSites(1, strSite); auto client = std::make_shared(io_context, port, responseMax, j); client->request(bSSL, deqSites, setRequest, timeout, complete); diff --git a/src/libxrpl/net/RegisterSSLCerts.cpp b/src/libxrpl/net/RegisterSSLCerts.cpp index 1f21a76ddb..ff59b5971e 100644 --- a/src/libxrpl/net/RegisterSSLCerts.cpp +++ b/src/libxrpl/net/RegisterSSLCerts.cpp @@ -1,5 +1,10 @@ #include +#include + +#include +#include + #if BOOST_OS_WINDOWS #include #include diff --git a/src/libxrpl/nodestore/BatchWriter.cpp b/src/libxrpl/nodestore/BatchWriter.cpp index 98fe78c489..dd32bd9e00 100644 --- a/src/libxrpl/nodestore/BatchWriter.cpp +++ b/src/libxrpl/nodestore/BatchWriter.cpp @@ -1,10 +1,21 @@ #include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + namespace xrpl { namespace NodeStore { BatchWriter::BatchWriter(Callback& callback, Scheduler& scheduler) - : m_callback(callback), m_scheduler(scheduler), mWriteLoad(0), mWritePending(false) + : m_callback(callback), m_scheduler(scheduler) { mWriteSet.reserve(batchWritePreallocationSize); } @@ -37,7 +48,7 @@ BatchWriter::store(std::shared_ptr const& object) int BatchWriter::getWriteLoad() { - std::lock_guard sl(mWriteMutex); + std::lock_guard const sl(mWriteMutex); return std::max(mWriteLoad, static_cast(mWriteSet.size())); } @@ -58,7 +69,7 @@ BatchWriter::writeBatch() set.reserve(batchWritePreallocationSize); { - std::lock_guard sl(mWriteMutex); + std::lock_guard const sl(mWriteMutex); mWriteSet.swap(set); XRPL_ASSERT( diff --git a/src/libxrpl/nodestore/Database.cpp b/src/libxrpl/nodestore/Database.cpp index 4e0d5be05d..c265c4c63b 100644 --- a/src/libxrpl/nodestore/Database.cpp +++ b/src/libxrpl/nodestore/Database.cpp @@ -1,11 +1,33 @@ -#include -#include -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace NodeStore { @@ -122,7 +144,7 @@ void Database::stop() { { - std::lock_guard lock(readLock_); + std::lock_guard const lock(readLock_); if (!readStopping_.exchange(true, std::memory_order_relaxed)) { @@ -158,7 +180,7 @@ Database::asyncFetch( std::uint32_t ledgerSeq, std::function const&)>&& cb) { - std::lock_guard lock(readLock_); + std::lock_guard const lock(readLock_); if (!isStopping()) { @@ -238,7 +260,7 @@ Database::getCountsJson(Json::Value& obj) XRPL_ASSERT(obj.isObject(), "xrpl::NodeStore::Database::getCountsJson : valid input type"); { - std::unique_lock lock(readLock_); + std::unique_lock const lock(readLock_); obj["read_queue"] = static_cast(read_.size()); } diff --git a/src/libxrpl/nodestore/DatabaseNodeImp.cpp b/src/libxrpl/nodestore/DatabaseNodeImp.cpp index a24379aea9..2e9f4f772e 100644 --- a/src/libxrpl/nodestore/DatabaseNodeImp.cpp +++ b/src/libxrpl/nodestore/DatabaseNodeImp.cpp @@ -1,5 +1,25 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace NodeStore { diff --git a/src/libxrpl/nodestore/DatabaseRotatingImp.cpp b/src/libxrpl/nodestore/DatabaseRotatingImp.cpp index 6cf51fbf31..7162fcfbe5 100644 --- a/src/libxrpl/nodestore/DatabaseRotatingImp.cpp +++ b/src/libxrpl/nodestore/DatabaseRotatingImp.cpp @@ -1,5 +1,26 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace NodeStore { @@ -33,7 +54,7 @@ DatabaseRotatingImp::rotate( // deleted. std::shared_ptr oldArchiveBackend; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); archiveBackend_->setDeletePath(); oldArchiveBackend = std::move(archiveBackend_); @@ -50,14 +71,14 @@ DatabaseRotatingImp::rotate( std::string DatabaseRotatingImp::getName() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return writableBackend_->getName(); } std::int32_t DatabaseRotatingImp::getWriteLoad() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return writableBackend_->getWriteLoad(); } @@ -65,7 +86,7 @@ void DatabaseRotatingImp::importDatabase(Database& source) { auto const backend = [&] { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return writableBackend_; }(); @@ -75,7 +96,7 @@ DatabaseRotatingImp::importDatabase(Database& source) void DatabaseRotatingImp::sync() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); writableBackend_->sync(); } @@ -85,7 +106,7 @@ DatabaseRotatingImp::store(NodeObjectType type, Blob&& data, uint256 const& hash auto nObj = NodeObject::createObject(type, std::move(data), hash); auto const backend = [&] { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return writableBackend_; }(); @@ -133,7 +154,7 @@ DatabaseRotatingImp::fetchNodeObject( std::shared_ptr nodeObject; auto [writable, archive] = [&] { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return std::make_pair(writableBackend_, archiveBackend_); }(); @@ -147,7 +168,7 @@ DatabaseRotatingImp::fetchNodeObject( { { // Refresh the writable backend pointer - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); writable = writableBackend_; } @@ -167,7 +188,7 @@ void DatabaseRotatingImp::for_each(std::function)> f) { auto [writable, archive] = [&] { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return std::make_pair(writableBackend_, archiveBackend_); }(); diff --git a/src/libxrpl/nodestore/DecodedBlob.cpp b/src/libxrpl/nodestore/DecodedBlob.cpp index ad704cb84e..6b708aa66e 100644 --- a/src/libxrpl/nodestore/DecodedBlob.cpp +++ b/src/libxrpl/nodestore/DecodedBlob.cpp @@ -1,8 +1,14 @@ -#include -#include #include +#include +#include +#include +#include +#include + #include +#include +#include namespace xrpl { namespace NodeStore { diff --git a/src/libxrpl/nodestore/DummyScheduler.cpp b/src/libxrpl/nodestore/DummyScheduler.cpp index 21c1b5c92e..26fca36c31 100644 --- a/src/libxrpl/nodestore/DummyScheduler.cpp +++ b/src/libxrpl/nodestore/DummyScheduler.cpp @@ -1,5 +1,8 @@ #include +#include +#include + namespace xrpl { namespace NodeStore { diff --git a/src/libxrpl/nodestore/ManagerImp.cpp b/src/libxrpl/nodestore/ManagerImp.cpp index da9534f68b..2ffeebca77 100644 --- a/src/libxrpl/nodestore/ManagerImp.cpp +++ b/src/libxrpl/nodestore/ManagerImp.cpp @@ -1,8 +1,26 @@ -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace NodeStore { @@ -80,14 +98,14 @@ ManagerImp::make_Database( void ManagerImp::insert(Factory& factory) { - std::lock_guard _(mutex_); + std::lock_guard const _(mutex_); list_.push_back(&factory); } void ManagerImp::erase(Factory& factory) { - std::lock_guard _(mutex_); + std::lock_guard const _(mutex_); auto const iter = std::find_if( list_.begin(), list_.end(), [&factory](Factory* other) { return other == &factory; }); XRPL_ASSERT(iter != list_.end(), "xrpl::NodeStore::ManagerImp::erase : valid input"); @@ -97,7 +115,7 @@ ManagerImp::erase(Factory& factory) Factory* ManagerImp::find(std::string const& name) { - std::lock_guard _(mutex_); + std::lock_guard const _(mutex_); auto const iter = std::find_if(list_.begin(), list_.end(), [&name](Factory* other) { return boost::iequals(name, other->getName()); }); diff --git a/src/libxrpl/nodestore/NodeObject.cpp b/src/libxrpl/nodestore/NodeObject.cpp index 2e40989e7c..b19d5d625a 100644 --- a/src/libxrpl/nodestore/NodeObject.cpp +++ b/src/libxrpl/nodestore/NodeObject.cpp @@ -1,6 +1,10 @@ #include +#include +#include + #include +#include namespace xrpl { diff --git a/src/libxrpl/nodestore/backend/MemoryFactory.cpp b/src/libxrpl/nodestore/backend/MemoryFactory.cpp index 0366fe3573..cf5df38389 100644 --- a/src/libxrpl/nodestore/backend/MemoryFactory.cpp +++ b/src/libxrpl/nodestore/backend/MemoryFactory.cpp @@ -1,13 +1,28 @@ +#include +#include #include +#include +#include +#include #include #include +#include +#include +#include #include #include +#include +#include #include #include #include +#include +#include +#include +#include +#include namespace xrpl { namespace NodeStore { @@ -45,7 +60,7 @@ public: MemoryDB& open(std::string const& path) { - std::lock_guard _(mutex_); + std::lock_guard const _(mutex_); auto const result = map_.emplace(std::piecewise_construct, std::make_tuple(path), std::make_tuple()); MemoryDB& db = result.first->second; @@ -120,9 +135,9 @@ public: { XRPL_ASSERT(db_, "xrpl::NodeStore::MemoryBackend::fetch : non-null database"); - std::lock_guard _(db_->mutex); + std::lock_guard const _(db_->mutex); - Map::iterator iter = db_->table.find(hash); + Map::iterator const iter = db_->table.find(hash); if (iter == db_->table.end()) { pObject->reset(); @@ -140,7 +155,7 @@ public: for (auto const& h : hashes) { std::shared_ptr nObj; - Status status = fetch(h, &nObj); + Status const status = fetch(h, &nObj); if (status != ok) { results.push_back({}); @@ -158,7 +173,7 @@ public: store(std::shared_ptr const& object) override { XRPL_ASSERT(db_, "xrpl::NodeStore::MemoryBackend::store : non-null database"); - std::lock_guard _(db_->mutex); + std::lock_guard const _(db_->mutex); db_->table.emplace(object->getHash(), object); } diff --git a/src/libxrpl/nodestore/backend/NuDBFactory.cpp b/src/libxrpl/nodestore/backend/NuDBFactory.cpp index 2d8cffa85a..ba1068a097 100644 --- a/src/libxrpl/nodestore/backend/NuDBFactory.cpp +++ b/src/libxrpl/nodestore/backend/NuDBFactory.cpp @@ -1,21 +1,48 @@ +#include +#include +#include #include #include +#include #include +#include #include #include +#include +#include +#include #include #include #include -#include +#include +#include +#include -#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include // IWYU pragma: keep +#include +#include #include #include #include #include +#include #include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace NodeStore { @@ -214,7 +241,7 @@ public: for (auto const& h : hashes) { std::shared_ptr nObj; - Status status = fetch(h, &nObj); + Status const status = fetch(h, &nObj); if (status != ok) { results.push_back({}); @@ -231,7 +258,7 @@ public: void do_insert(std::shared_ptr const& no) { - EncodedBlob e(no); + EncodedBlob const e(no); nudb::error_code ec; nudb::detail::buffer bf; auto const result = nodeobject_compress(e.getData(), e.getSize(), bf); @@ -353,7 +380,7 @@ private: auto const kp = (folder / "nudb.key").string(); std::size_t const defaultSize = nudb::block_size(kp); // Default 4K from NuDB - std::size_t blockSize = defaultSize; + std::size_t const blockSize = defaultSize; std::string blockSizeStr; if (!get_if_exists(keyValues, "nudb_block_size", blockSizeStr)) @@ -434,7 +461,7 @@ public: void registerNuDBFactory(Manager& manager) { - static NuDBFactory instance{manager}; + static NuDBFactory const instance{manager}; } } // namespace NodeStore diff --git a/src/libxrpl/nodestore/backend/NullFactory.cpp b/src/libxrpl/nodestore/backend/NullFactory.cpp index ab5b7d0117..4355b29717 100644 --- a/src/libxrpl/nodestore/backend/NullFactory.cpp +++ b/src/libxrpl/nodestore/backend/NullFactory.cpp @@ -1,7 +1,19 @@ +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { namespace NodeStore { @@ -117,7 +129,7 @@ public: void registerNullFactory(Manager& manager) { - static NullFactory instance{manager}; + static NullFactory const instance{manager}; } } // namespace NodeStore diff --git a/src/libxrpl/nodestore/backend/RocksDBFactory.cpp b/src/libxrpl/nodestore/backend/RocksDBFactory.cpp index ac040f178b..6b01ccf7a0 100644 --- a/src/libxrpl/nodestore/backend/RocksDBFactory.cpp +++ b/src/libxrpl/nodestore/backend/RocksDBFactory.cpp @@ -1,4 +1,36 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include #if XRPL_ROCKSDB_AVAILABLE #include @@ -37,18 +69,17 @@ public: static void thread_entry(void* ptr) { - ThreadParams* const p(reinterpret_cast(ptr)); - void (*f)(void*) = p->f; + ThreadParams const* const p(reinterpret_cast(ptr)); + auto const f = p->f; + void* a(p->a); delete p; static std::atomic n; std::size_t const id(++n); - std::stringstream ss; - ss << "rocksdb #" << id; - beast::setCurrentThreadName(ss.str()); + beast::setCurrentThreadName("rocksdb #" + std::to_string(id)); - (*f)(a); + f(a); } void @@ -89,7 +120,7 @@ public: rocksdb::BlockBasedTableOptions table_options; m_options.env = env; - bool hard_set = keyValues.exists("hard_set") && get(keyValues, "hard_set"); + bool const hard_set = keyValues.exists("hard_set") && get(keyValues, "hard_set"); if (keyValues.exists("cache_mb")) { @@ -162,7 +193,7 @@ public: if (keyValues.exists("bbt_options")) { - rocksdb::ConfigOptions config_options; + rocksdb::ConfigOptions const config_options; auto const s = rocksdb::GetBlockBasedTableOptionsFromString( config_options, table_options, get(keyValues, "bbt_options"), &table_options); if (!s.ok()) @@ -212,7 +243,7 @@ public: } rocksdb::DB* db = nullptr; m_options.create_if_missing = createIfMissing; - rocksdb::Status status = rocksdb::DB::Open(m_options, m_name, &db); + rocksdb::Status const status = rocksdb::DB::Open(m_options, m_name, &db); if (!status.ok() || (db == nullptr)) { Throw( @@ -235,7 +266,7 @@ public: m_db.reset(); if (m_deletePath) { - boost::filesystem::path dir = m_name; + boost::filesystem::path const dir = m_name; boost::filesystem::remove_all(dir); } } @@ -262,7 +293,7 @@ public: std::string string; - rocksdb::Status getStatus = m_db->Get(options, slice, &string); + rocksdb::Status const getStatus = m_db->Get(options, slice, &string); if (getStatus.ok()) { @@ -308,7 +339,7 @@ public: for (auto const& h : hashes) { std::shared_ptr nObj; - Status status = fetch(h, &nObj); + Status const status = fetch(h, &nObj); if (status != ok) { results.push_back({}); @@ -339,7 +370,7 @@ public: for (auto const& e : batch) { - EncodedBlob encoded(e); + EncodedBlob const encoded(e); wb.Put( rocksdb::Slice(std::bit_cast(encoded.getKey()), m_keyBytes), @@ -456,7 +487,7 @@ public: void registerRocksDBFactory(Manager& manager) { - static RocksDBFactory instance{manager}; + static RocksDBFactory const instance{manager}; } } // namespace NodeStore diff --git a/src/libxrpl/protocol/AMMCore.cpp b/src/libxrpl/protocol/AMMCore.cpp index 9061d04689..41303e6a22 100644 --- a/src/libxrpl/protocol/AMMCore.cpp +++ b/src/libxrpl/protocol/AMMCore.cpp @@ -1,10 +1,14 @@ +#include + #include #include #include -#include #include +#include +#include #include #include +#include #include #include #include @@ -17,16 +21,28 @@ #include #include #include +#include namespace xrpl { Currency -ammLPTCurrency(Currency const& cur1, Currency const& cur2) +ammLPTCurrency(Asset const& asset1, Asset const& asset2) { // AMM LPToken is 0x03 plus 19 bytes of the hash std::int32_t constexpr AMMCurrencyCode = 0x03; - auto const [minC, maxC] = std::minmax(cur1, cur2); - auto const hash = sha512Half(minC, maxC); + auto const& [minA, maxA] = std::minmax(asset1, asset2); + uint256 const hash = std::visit( + [](auto&& issue1, auto&& issue2) { + auto fromIss = [](T const& issue) { + if constexpr (std::is_same_v) + return issue.currency; + if constexpr (std::is_same_v) + return issue.getMptID(); + }; + return sha512Half(fromIss(issue1), fromIss(issue2)); + }, + minA.value(), + maxA.value()); Currency currency; *currency.begin() = AMMCurrencyCode; std::copy(hash.begin(), hash.begin() + currency.size() - 1, currency.begin() + 1); @@ -34,34 +50,45 @@ ammLPTCurrency(Currency const& cur1, Currency const& cur2) } Issue -ammLPTIssue(Currency const& cur1, Currency const& cur2, AccountID const& ammAccountID) +ammLPTIssue(Asset const& asset1, Asset const& asset2, AccountID const& ammAccountID) { - return Issue(ammLPTCurrency(cur1, cur2), ammAccountID); + return Issue(ammLPTCurrency(asset1, asset2), ammAccountID); } NotTEC -invalidAMMAsset(Issue const& issue, std::optional> const& pair) +invalidAMMAsset(Asset const& asset, std::optional> const& pair) { - if (badCurrency() == issue.currency) - return temBAD_CURRENCY; - if (isXRP(issue) && issue.account.isNonZero()) - return temBAD_ISSUER; - if (pair && issue != pair->first && issue != pair->second) + auto const err = asset.visit( + [](MPTIssue const& issue) -> std::optional { + if (issue.getIssuer() == beast::zero) + return temBAD_MPT; + return std::nullopt; + }, + [](Issue const& issue) -> std::optional { + if (badCurrency() == issue.currency) + return temBAD_CURRENCY; + if (isXRP(issue) && issue.getIssuer().isNonZero()) + return temBAD_ISSUER; + return std::nullopt; + }); + if (err) + return *err; + if (pair && asset != pair->first && asset != pair->second) return temBAD_AMM_TOKENS; return tesSUCCESS; } NotTEC invalidAMMAssetPair( - Issue const& issue1, - Issue const& issue2, - std::optional> const& pair) + Asset const& asset1, + Asset const& asset2, + std::optional> const& pair) { - if (issue1 == issue2) + if (asset1 == asset2) return temBAD_AMM_TOKENS; - if (auto const res = invalidAMMAsset(issue1, pair)) + if (auto const res = invalidAMMAsset(asset1, pair)) return res; - if (auto const res = invalidAMMAsset(issue2, pair)) + if (auto const res = invalidAMMAsset(asset2, pair)) return res; return tesSUCCESS; } @@ -69,10 +96,10 @@ invalidAMMAssetPair( NotTEC invalidAMMAmount( STAmount const& amount, - std::optional> const& pair, + std::optional> const& pair, bool validZero) { - if (auto const res = invalidAMMAsset(amount.issue(), pair)) + if (auto const res = invalidAMMAsset(amount.asset(), pair)) return res; if (amount < beast::zero || (!validZero && amount == beast::zero)) return temBAD_AMOUNT; diff --git a/src/libxrpl/protocol/AccountID.cpp b/src/libxrpl/protocol/AccountID.cpp index 4edbf5c0e7..a89dc8fd11 100644 --- a/src/libxrpl/protocol/AccountID.cpp +++ b/src/libxrpl/protocol/AccountID.cpp @@ -1,8 +1,9 @@ +#include + #include #include #include #include -#include #include #include #include @@ -55,7 +56,7 @@ public: packed_spinlock sl(locks_, index % 64); { - std::lock_guard lock(sl); + std::lock_guard const lock(sl); // The check against the first character of the encoding ensures // that we don't mishandle the case of the all-zero account: @@ -68,7 +69,7 @@ public: XRPL_ASSERT(ret.size() <= 38, "xrpl::detail::AccountIdCache : maximum result size"); { - std::lock_guard lock(sl); + std::lock_guard const lock(sl); cache_[index].id = id; std::strcpy(cache_[index].encoding, ret.c_str()); } diff --git a/src/libxrpl/protocol/Asset.cpp b/src/libxrpl/protocol/Asset.cpp index 0076da6570..3d163c5c6a 100644 --- a/src/libxrpl/protocol/Asset.cpp +++ b/src/libxrpl/protocol/Asset.cpp @@ -1,12 +1,16 @@ +#include + +#include #include #include #include -#include +#include #include #include #include #include +#include #include #include #include @@ -62,4 +66,11 @@ assetFromJson(Json::Value const& v) return mptIssueFromJson(v); } +std::ostream& +operator<<(std::ostream& os, Asset const& x) +{ + std::visit([&](TIss const& issue) { os << issue; }, x.value()); + return os; +} + } // namespace xrpl diff --git a/src/libxrpl/protocol/Book.cpp b/src/libxrpl/protocol/Book.cpp index 59ad739c11..f71800b786 100644 --- a/src/libxrpl/protocol/Book.cpp +++ b/src/libxrpl/protocol/Book.cpp @@ -1,5 +1,6 @@ #include -#include + +#include #include #include diff --git a/src/libxrpl/protocol/BuildInfo.cpp b/src/libxrpl/protocol/BuildInfo.cpp index 0fddb9ff19..ba43e54814 100644 --- a/src/libxrpl/protocol/BuildInfo.cpp +++ b/src/libxrpl/protocol/BuildInfo.cpp @@ -1,11 +1,12 @@ +#include + #include #include #include -#include -#include +#include // IWYU pragma: keep #include -#include +#include // IWYU pragma: keep #include #include @@ -160,7 +161,7 @@ getEncodedVersion() } bool -isRippledVersion(std::uint64_t version) +isXrpldVersion(std::uint64_t version) { return (version & implementationVersionIdentifierMask) == implementationVersionIdentifier; } @@ -168,7 +169,7 @@ isRippledVersion(std::uint64_t version) bool isNewerVersion(std::uint64_t version) { - if (isRippledVersion(version)) + if (isXrpldVersion(version)) return version > getEncodedVersion(); return false; } diff --git a/src/libxrpl/protocol/ErrorCodes.cpp b/src/libxrpl/protocol/ErrorCodes.cpp index 407e1ab3f3..4e928deb75 100644 --- a/src/libxrpl/protocol/ErrorCodes.cpp +++ b/src/libxrpl/protocol/ErrorCodes.cpp @@ -1,6 +1,7 @@ +#include + #include #include -#include #include #include diff --git a/src/libxrpl/protocol/Feature.cpp b/src/libxrpl/protocol/Feature.cpp index 1762d7d22d..8e755e2d0f 100644 --- a/src/libxrpl/protocol/Feature.cpp +++ b/src/libxrpl/protocol/Feature.cpp @@ -1,8 +1,9 @@ +#include + #include #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/IOUAmount.cpp b/src/libxrpl/protocol/IOUAmount.cpp index 338f2c2760..075983d9d8 100644 --- a/src/libxrpl/protocol/IOUAmount.cpp +++ b/src/libxrpl/protocol/IOUAmount.cpp @@ -1,20 +1,18 @@ #include -// Do not remove. Forces IOUAmount.h to stay first, to verify it can compile -// without any hidden dependencies + #include #include #include #include #include -#include - #include #include #include #include #include #include +#include #include namespace xrpl { diff --git a/src/libxrpl/protocol/Indexes.cpp b/src/libxrpl/protocol/Indexes.cpp index 61a64b2a54..4bbf2d6f1f 100644 --- a/src/libxrpl/protocol/Indexes.cpp +++ b/src/libxrpl/protocol/Indexes.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -5,8 +7,10 @@ #include #include #include -#include +#include +#include #include +#include #include #include #include @@ -23,6 +27,7 @@ #include #include #include +#include #include namespace xrpl { @@ -99,19 +104,36 @@ getBookBase(Book const& book) { XRPL_ASSERT(isConsistent(book), "xrpl::getBookBase : input is consistent"); - auto const index = book.domain ? indexHash( - LedgerNameSpace::BOOK_DIR, - book.in.currency, - book.out.currency, - book.in.account, - book.out.account, - *(book.domain)) - : indexHash( - LedgerNameSpace::BOOK_DIR, - book.in.currency, - book.out.currency, - book.in.account, - book.out.account); + auto getIndexHash = [&book](Args... args) { + if (book.domain) + return indexHash(std::forward(args)..., *book.domain); + return indexHash(std::forward(args)...); + }; + + auto const index = std::visit( + [&](TIn const& in, TOut const& out) { + if constexpr (std::is_same_v && std::is_same_v) + { + return getIndexHash( + LedgerNameSpace::BOOK_DIR, in.currency, out.currency, in.account, out.account); + } + else if constexpr (std::is_same_v && std::is_same_v) + { + return getIndexHash( + LedgerNameSpace::BOOK_DIR, in.currency, out.getMptID(), in.account); + } + else if constexpr (std::is_same_v && std::is_same_v) + { + return getIndexHash( + LedgerNameSpace::BOOK_DIR, in.getMptID(), out.currency, out.account); + } + else + { + return getIndexHash(LedgerNameSpace::BOOK_DIR, in.getMptID(), out.getMptID()); + } + }, + book.in.value(), + book.out.value()); // Return with quality 0. auto k = keylet::quality({ltDIR_NODE, index}, 0); @@ -401,11 +423,37 @@ nft_sells(uint256 const& id) noexcept } Keylet -amm(Asset const& issue1, Asset const& issue2) noexcept +amm(Asset const& asset1, Asset const& asset2) noexcept { - auto const& [minI, maxI] = std::minmax(issue1.get(), issue2.get()); - return amm( - indexHash(LedgerNameSpace::AMM, minI.account, minI.currency, maxI.account, maxI.currency)); + auto const& [minA, maxA] = std::minmax(asset1, asset2); + return std::visit( + [](TIss1 const& issue1, TIss2 const& issue2) { + if constexpr (std::is_same_v && std::is_same_v) + { + return amm(indexHash( + LedgerNameSpace::AMM, + issue1.account, + issue1.currency, + issue2.account, + issue2.currency)); + } + else if constexpr (std::is_same_v && std::is_same_v) + { + return amm(indexHash( + LedgerNameSpace::AMM, issue1.account, issue1.currency, issue2.getMptID())); + } + else if constexpr (std::is_same_v && std::is_same_v) + { + return amm(indexHash( + LedgerNameSpace::AMM, issue1.getMptID(), issue2.account, issue2.currency)); + } + else if constexpr (std::is_same_v && std::is_same_v) + { + return amm(indexHash(LedgerNameSpace::AMM, issue1.getMptID(), issue2.getMptID())); + } + }, + minA.value(), + maxA.value()); } Keylet diff --git a/src/libxrpl/protocol/InnerObjectFormats.cpp b/src/libxrpl/protocol/InnerObjectFormats.cpp index bccfe210d1..f4a88ec171 100644 --- a/src/libxrpl/protocol/InnerObjectFormats.cpp +++ b/src/libxrpl/protocol/InnerObjectFormats.cpp @@ -1,4 +1,5 @@ #include + #include #include @@ -164,7 +165,7 @@ InnerObjectFormats::InnerObjectFormats() InnerObjectFormats const& InnerObjectFormats::getInstance() { - static InnerObjectFormats instance; + static InnerObjectFormats const instance; return instance; } diff --git a/src/libxrpl/protocol/Issue.cpp b/src/libxrpl/protocol/Issue.cpp index c73c6c8513..d5896bbd57 100644 --- a/src/libxrpl/protocol/Issue.cpp +++ b/src/libxrpl/protocol/Issue.cpp @@ -1,8 +1,9 @@ +#include + #include #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/Keylet.cpp b/src/libxrpl/protocol/Keylet.cpp index 6f9656c4ea..26bc98c1d6 100644 --- a/src/libxrpl/protocol/Keylet.cpp +++ b/src/libxrpl/protocol/Keylet.cpp @@ -1,5 +1,6 @@ -#include #include + +#include #include #include diff --git a/src/libxrpl/protocol/LedgerFormats.cpp b/src/libxrpl/protocol/LedgerFormats.cpp index 30725f44a9..7826435e51 100644 --- a/src/libxrpl/protocol/LedgerFormats.cpp +++ b/src/libxrpl/protocol/LedgerFormats.cpp @@ -1,7 +1,8 @@ #include + #include #include -#include +#include // IWYU pragma: keep #include @@ -40,7 +41,7 @@ LedgerFormats::LedgerFormats() LedgerFormats const& LedgerFormats::getInstance() { - static LedgerFormats instance; + static LedgerFormats const instance; return instance; } diff --git a/src/libxrpl/protocol/LedgerHeader.cpp b/src/libxrpl/protocol/LedgerHeader.cpp index 38e7a7f6dd..f6a99be28a 100644 --- a/src/libxrpl/protocol/LedgerHeader.cpp +++ b/src/libxrpl/protocol/LedgerHeader.cpp @@ -1,10 +1,13 @@ +#include + #include #include #include -#include #include #include +#include + namespace xrpl { void diff --git a/src/libxrpl/protocol/MPTIssue.cpp b/src/libxrpl/protocol/MPTIssue.cpp index c2f7f1fa50..dac2f4e5fe 100644 --- a/src/libxrpl/protocol/MPTIssue.cpp +++ b/src/libxrpl/protocol/MPTIssue.cpp @@ -1,13 +1,16 @@ +#include + #include #include #include #include #include -#include +#include #include #include #include +#include #include #include @@ -17,6 +20,11 @@ MPTIssue::MPTIssue(MPTID const& issuanceID) : mptID_(issuanceID) { } +MPTIssue::MPTIssue(std::uint32_t sequence, AccountID const& account) + : MPTIssue(xrpl::makeMptID(sequence, account)) +{ +} + AccountID const& MPTIssue::getIssuer() const { @@ -86,4 +94,11 @@ mptIssueFromJson(Json::Value const& v) return MPTIssue{id}; } +std::ostream& +operator<<(std::ostream& os, MPTIssue const& x) +{ + os << to_string(x); + return os; +} + } // namespace xrpl diff --git a/src/libxrpl/protocol/NFTSyntheticSerializer.cpp b/src/libxrpl/protocol/NFTSyntheticSerializer.cpp index e4ce3b7611..e6fb2f2482 100644 --- a/src/libxrpl/protocol/NFTSyntheticSerializer.cpp +++ b/src/libxrpl/protocol/NFTSyntheticSerializer.cpp @@ -1,5 +1,6 @@ -#include #include + +#include #include #include #include diff --git a/src/libxrpl/protocol/NFTokenID.cpp b/src/libxrpl/protocol/NFTokenID.cpp index d867cdb8c9..359a662529 100644 --- a/src/libxrpl/protocol/NFTokenID.cpp +++ b/src/libxrpl/protocol/NFTokenID.cpp @@ -1,7 +1,8 @@ +#include + #include #include #include -#include #include #include #include @@ -70,7 +71,7 @@ getNFTokenIDFromPage(TxMeta const& transactionMeta) // field changing, but no NFTs within that page changing. In this // case, there will be no previous NFTs and we need to skip. // However, there will always be NFTs listed in the final fields, - // as rippled outputs all fields in final fields even if they were + // as xrpld outputs all fields in final fields even if they were // not changed. STObject const& previousFields = node.peekAtField(sfPreviousFields).downcast(); @@ -159,7 +160,7 @@ insertNFTokenID( } else if (type == ttNFTOKEN_CANCEL_OFFER) { - std::vector result = getNFTokenIDFromDeletedOffer(transactionMeta); + std::vector const result = getNFTokenIDFromDeletedOffer(transactionMeta); response[jss::nftoken_ids] = Json::Value(Json::arrayValue); for (auto const& nftID : result) diff --git a/src/libxrpl/protocol/NFTokenOfferID.cpp b/src/libxrpl/protocol/NFTokenOfferID.cpp index 4af589a4e9..c1d426eef0 100644 --- a/src/libxrpl/protocol/NFTokenOfferID.cpp +++ b/src/libxrpl/protocol/NFTokenOfferID.cpp @@ -1,7 +1,8 @@ +#include + #include #include #include -#include #include #include #include diff --git a/src/libxrpl/protocol/PathAsset.cpp b/src/libxrpl/protocol/PathAsset.cpp new file mode 100644 index 0000000000..97011129e5 --- /dev/null +++ b/src/libxrpl/protocol/PathAsset.cpp @@ -0,0 +1,22 @@ +#include + +#include +#include +#include + +namespace xrpl { + +std::string +to_string(PathAsset const& asset) +{ + return std::visit([&](auto const& issue) { return to_string(issue); }, asset.value()); +} + +std::ostream& +operator<<(std::ostream& os, PathAsset const& x) +{ + os << to_string(x); + return os; +} + +} // namespace xrpl diff --git a/src/libxrpl/protocol/Permissions.cpp b/src/libxrpl/protocol/Permissions.cpp index 47fc0d28b6..21efe7a8cf 100644 --- a/src/libxrpl/protocol/Permissions.cpp +++ b/src/libxrpl/protocol/Permissions.cpp @@ -1,7 +1,15 @@ -#include -#include #include -#include + +#include +#include +#include // IWYU pragma: keep +#include +#include + +#include +#include +#include +#include namespace xrpl { @@ -67,6 +75,11 @@ Permission::Permission() #pragma pop_macro("PERMISSION") }; + XRPL_ASSERT( + txFeatureMap_.size() == delegableTx_.size(), + "xrpl::Permission : txFeatureMap_ and delegableTx_ must have same " + "size"); + for ([[maybe_unused]] auto const& permission : granularPermissionMap_) { XRPL_ASSERT( diff --git a/src/libxrpl/protocol/PublicKey.cpp b/src/libxrpl/protocol/PublicKey.cpp index 2e08c49a4e..54430ed5d5 100644 --- a/src/libxrpl/protocol/PublicKey.cpp +++ b/src/libxrpl/protocol/PublicKey.cpp @@ -1,18 +1,19 @@ +#include + #include #include #include #include #include -#include #include #include #include #include -#include #include #include +#include #include #include @@ -130,11 +131,11 @@ ecdsaCanonicality(Slice const& sig) if (!r || !s || !p.empty()) return std::nullopt; - uint264 R(sliceToHex(*r)); + uint264 const R(sliceToHex(*r)); if (R >= G) return std::nullopt; - uint264 S(sliceToHex(*s)); + uint264 const S(sliceToHex(*s)); if (S >= G) return std::nullopt; diff --git a/src/libxrpl/protocol/Quality.cpp b/src/libxrpl/protocol/Quality.cpp index ba9807318a..5f38f2219b 100644 --- a/src/libxrpl/protocol/Quality.cpp +++ b/src/libxrpl/protocol/Quality.cpp @@ -1,11 +1,10 @@ -#include +#include + #include #include -#include #include #include -#include namespace xrpl { diff --git a/src/libxrpl/protocol/QualityFunction.cpp b/src/libxrpl/protocol/QualityFunction.cpp index ebc59dcc83..b460eb212f 100644 --- a/src/libxrpl/protocol/QualityFunction.cpp +++ b/src/libxrpl/protocol/QualityFunction.cpp @@ -1,8 +1,9 @@ +#include + #include #include #include #include -#include #include #include @@ -31,7 +32,7 @@ QualityFunction::outFromAvgQ(Quality const& quality) { if (m_ != 0 && quality.rate() != beast::zero) { - saveNumberRoundMode rm(Number::setround(Number::rounding_mode::upward)); + saveNumberRoundMode const rm(Number::setround(Number::rounding_mode::upward)); auto const out = (1 / quality.rate() - b_) / m_; if (out <= 0) return std::nullopt; diff --git a/src/libxrpl/protocol/RPCErr.cpp b/src/libxrpl/protocol/RPCErr.cpp index e25b5e574b..99836f5e0f 100644 --- a/src/libxrpl/protocol/RPCErr.cpp +++ b/src/libxrpl/protocol/RPCErr.cpp @@ -1,6 +1,7 @@ +#include + #include #include -#include #include namespace xrpl { diff --git a/src/libxrpl/protocol/Rules.cpp b/src/libxrpl/protocol/Rules.cpp index 4ef052d2cc..a09afa96d8 100644 --- a/src/libxrpl/protocol/Rules.cpp +++ b/src/libxrpl/protocol/Rules.cpp @@ -1,6 +1,5 @@ #include -// Do not remove. Forces Rules.h to stay first, to verify it can compile -// without any hidden dependencies + #include #include #include @@ -39,7 +38,7 @@ setCurrentTransactionRules(std::optional r) // Make global changes associated with the rules before the value is moved. // Push the appropriate setting, instead of having the class pull every time // the value is needed. That could get expensive fast. - bool enableLargeNumbers = + bool const enableLargeNumbers = !r || (r->enabled(featureSingleAssetVault) || r->enabled(featureLendingProtocol)); Number::setMantissaScale(enableLargeNumbers ? MantissaRange::large : MantissaRange::small); diff --git a/src/libxrpl/protocol/SField.cpp b/src/libxrpl/protocol/SField.cpp index 8015b34e73..fd6d39bbb0 100644 --- a/src/libxrpl/protocol/SField.cpp +++ b/src/libxrpl/protocol/SField.cpp @@ -1,8 +1,9 @@ -#include #include -#include +#include + #include +#include namespace xrpl { diff --git a/src/libxrpl/protocol/SOTemplate.cpp b/src/libxrpl/protocol/SOTemplate.cpp index b90bff6192..708fd465e2 100644 --- a/src/libxrpl/protocol/SOTemplate.cpp +++ b/src/libxrpl/protocol/SOTemplate.cpp @@ -1,12 +1,14 @@ +#include + #include #include -#include #include #include #include #include #include +#include #include namespace xrpl { diff --git a/src/libxrpl/protocol/STAccount.cpp b/src/libxrpl/protocol/STAccount.cpp index 2dc83cb591..4266b55c98 100644 --- a/src/libxrpl/protocol/STAccount.cpp +++ b/src/libxrpl/protocol/STAccount.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -5,7 +7,6 @@ #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/STAmount.cpp b/src/libxrpl/protocol/STAmount.cpp index 8c0068a275..89992b823c 100644 --- a/src/libxrpl/protocol/STAmount.cpp +++ b/src/libxrpl/protocol/STAmount.cpp @@ -1,16 +1,16 @@ -#include +#include + #include #include -#include #include #include -#include #include #include #include #include #include #include +#include #include #include #include @@ -19,7 +19,6 @@ #include #include #include -#include #include #include #include @@ -31,11 +30,6 @@ #include #include #include -#include -#include -#include -#include -#include #include #include @@ -44,9 +38,11 @@ #include #include #include +#include #include #include #include +#include #include namespace xrpl { @@ -90,11 +86,23 @@ getMPTValue(STAmount const& amount) static bool areComparable(STAmount const& v1, STAmount const& v2) { - if (v1.holds() && v2.holds()) - return v1.native() == v2.native() && v1.get().currency == v2.get().currency; - if (v1.holds() && v2.holds()) - return v1.get() == v2.get(); - return false; + return std::visit( + [&](TIss1 const& issue1, TIss2 const& issue2) { + if constexpr (is_issue_v && is_issue_v) + { + return v1.native() == v2.native() && issue1.currency == issue2.currency; + } + else if constexpr (is_mptissue_v && is_mptissue_v) + { + return issue1 == issue2; + } + else + { + return false; + } + }, + v1.asset().value(), + v2.asset().value()); } static_assert(INITIAL_XRP.drops() == STAmount::cMaxNativeN); @@ -154,7 +162,7 @@ STAmount::STAmount(SerialIter& sit, SField const& name) : STBase(name) if (value != 0u) { - bool isNegative = (offset & 256) == 0; + bool const isNegative = (offset & 256) == 0; offset = (offset & 255) - 97; // center the range if (value < cMinValue || value > cMaxValue || offset < cMinOffset || offset > cMaxOffset) @@ -181,7 +189,7 @@ STAmount::STAmount(SerialIter& sit, SField const& name) : STBase(name) } STAmount::STAmount(SField const& name, std::int64_t mantissa) - : STBase(name), mAsset(xrpIssue()), mValue(0), mOffset(0), mIsNegative(false) + : STBase(name), mAsset(xrpIssue()), mOffset(0) { set(mantissa); } @@ -410,7 +418,7 @@ operator+(STAmount const& v1, STAmount const& v2) // This addition cannot overflow an std::int64_t. It can overflow an // STAmount and the constructor will throw. - std::int64_t fv = vv1 + vv2; + std::int64_t const fv = vv1 + vv2; if ((fv >= -10) && (fv <= 10)) return {v1.getFName(), v1.asset()}; @@ -454,13 +462,13 @@ getRate(STAmount const& offerOut, STAmount const& offerIn) try { - STAmount r = divide(offerIn, offerOut, noIssue()); + STAmount const r = divide(offerIn, offerOut, noIssue()); if (r == beast::zero) // offer is too good return 0; XRPL_ASSERT( (r.exponent() >= -100) && (r.exponent() <= 155), "xrpl::getRate : exponent inside range"); - std::uint64_t ret = r.exponent() + 100; + std::uint64_t const ret = r.exponent() + 100; return (ret << (64 - 8)) | r.mantissa(); } catch (...) @@ -502,8 +510,8 @@ canAdd(STAmount const& a, STAmount const& b) // XRP case (overflow & underflow check) if (isXRP(a) && isXRP(b)) { - XRPAmount A = a.xrp(); - XRPAmount B = b.xrp(); + XRPAmount const A = a.xrp(); + XRPAmount const B = b.xrp(); return !( (B > XRPAmount{0} && @@ -513,26 +521,35 @@ canAdd(STAmount const& a, STAmount const& b) } // IOU case (precision check) - if (a.holds() && b.holds()) - { - static STAmount const one{IOUAmount{1, 0}, noIssue()}; - static STAmount const maxLoss{IOUAmount{1, -4}, noIssue()}; - STAmount lhs = divide((a - b) + b, a, noIssue()) - one; - STAmount rhs = divide((b - a) + a, b, noIssue()) - one; - return ((rhs.negative() ? -rhs : rhs) + (lhs.negative() ? -lhs : lhs)) <= maxLoss; - } + auto const ret = std::visit( + [&]( + TIss1 const&, TIss2 const&) -> std::optional { + if constexpr (is_issue_v && is_issue_v) + { + static STAmount const one{IOUAmount{1, 0}, noIssue()}; + static STAmount const maxLoss{IOUAmount{1, -4}, noIssue()}; + STAmount const lhs = divide((a - b) + b, a, noIssue()) - one; + STAmount const rhs = divide((b - a) + a, b, noIssue()) - one; + return ((rhs.negative() ? -rhs : rhs) + (lhs.negative() ? -lhs : lhs)) <= maxLoss; + } - // MPT (overflow & underflow check) - if (a.holds() && b.holds()) - { - MPTAmount A = a.mpt(); - MPTAmount B = b.mpt(); - return !( - (B > MPTAmount{0} && - A > MPTAmount{std::numeric_limits::max()} - B) || - (B < MPTAmount{0} && - A < MPTAmount{std::numeric_limits::min()} - B)); - } + // MPT (overflow & underflow check) + if constexpr (is_mptissue_v && is_mptissue_v) + { + MPTAmount const A = a.mpt(); + MPTAmount const B = b.mpt(); + return !( + (B > MPTAmount{0} && + A > MPTAmount{std::numeric_limits::max()} - B) || + (B < MPTAmount{0} && + A < MPTAmount{std::numeric_limits::min()} - B)); + } + return std::nullopt; + }, + a.asset().value(), + b.asset().value()); + if (ret) + return *ret; // LCOV_EXCL_START UNREACHABLE("STAmount::canAdd : unexpected STAmount type"); return false; @@ -570,8 +587,8 @@ canSubtract(STAmount const& a, STAmount const& b) // XRP case (underflow & overflow check) if (isXRP(a) && isXRP(b)) { - XRPAmount A = a.xrp(); - XRPAmount B = b.xrp(); + XRPAmount const A = a.xrp(); + XRPAmount const B = b.xrp(); // Check for underflow if (B > XRPAmount{0} && A < B) return false; @@ -585,27 +602,36 @@ canSubtract(STAmount const& a, STAmount const& b) } // IOU case (no underflow) - if (a.holds() && b.holds()) - { - return true; - } + auto const ret = std::visit( + [&]( + TIss1 const&, TIss2 const&) -> std::optional { + if constexpr (is_issue_v && is_issue_v) + { + return true; + } - // MPT case (underflow & overflow check) - if (a.holds() && b.holds()) - { - MPTAmount A = a.mpt(); - MPTAmount B = b.mpt(); + // MPT case (underflow & overflow check) + if constexpr (is_mptissue_v && is_mptissue_v) + { + MPTAmount const A = a.mpt(); + MPTAmount const B = b.mpt(); - // Underflow check - if (B > MPTAmount{0} && A < B) - return false; + // Underflow check + if (B > MPTAmount{0} && A < B) + return false; - // Overflow check - if (B < MPTAmount{0} && - A > MPTAmount{std::numeric_limits::max()} + B) - return false; - return true; - } + // Overflow check + if (B < MPTAmount{0} && + A > MPTAmount{std::numeric_limits::max()} + B) + return false; + return true; + } + return std::nullopt; + }, + a.asset().value(), + b.asset().value()); + if (ret) + return *ret; // LCOV_EXCL_START UNREACHABLE("STAmount::canSubtract : unexpected STAmount type"); return false; @@ -751,45 +777,49 @@ STAmount::getJson(JsonOptions) const void STAmount::add(Serializer& s) const { - if (native()) - { - XRPL_ASSERT(mOffset == 0, "xrpl::STAmount::add : zero offset"); - - if (!mIsNegative) - { - s.add64(mValue | cPositive); - } - else - { + mAsset.visit( + [&](MPTIssue const& issue) { + auto u8 = static_cast(cMPToken >> 56); + if (!mIsNegative) + u8 |= static_cast(cPositive >> 56); + s.add8(u8); s.add64(mValue); - } - } - else if (mAsset.holds()) - { - auto u8 = static_cast(cMPToken >> 56); - if (!mIsNegative) - u8 |= static_cast(cPositive >> 56); - s.add8(u8); - s.add64(mValue); - s.addBitString(mAsset.get().getMptID()); - } - else - { - if (*this == beast::zero) - { - s.add64(cIssuedCurrency); - } - else if (mIsNegative) - { // 512 = not native - s.add64(mValue | (static_cast(mOffset + 512 + 97) << (64 - 10))); - } - else - { // 256 = positive - s.add64(mValue | (static_cast(mOffset + 512 + 256 + 97) << (64 - 10))); - } - s.addBitString(mAsset.get().currency); - s.addBitString(mAsset.get().account); - } + s.addBitString(issue.getMptID()); + }, + [&](Issue const& issue) { + if (native()) + { + XRPL_ASSERT(mOffset == 0, "xrpl::STAmount::add : zero offset"); + + if (!mIsNegative) + { + s.add64(mValue | cPositive); + } + else + { + s.add64(mValue); + } + } + else + { + if (*this == beast::zero) + { + s.add64(cIssuedCurrency); + } + else if (mIsNegative) // 512 = not native + { + s.add64(mValue | (static_cast(mOffset + 512 + 97) << (64 - 10))); + } + else // 256 = positive + { + s.add64( + mValue | + (static_cast(mOffset + 512 + 256 + 97) << (64 - 10))); + } + s.addBitString(issue.currency); + s.addBitString(issue.account); + } + }); } bool @@ -847,7 +877,7 @@ STAmount::canonicalize() if (getSTNumberSwitchover()) { - Number num(mIsNegative, mValue, mOffset, Number::unchecked{}); + Number const num(mIsNegative, mValue, mOffset, Number::unchecked{}); auto set = [&](auto const& val) { auto const value = val.value(); mIsNegative = value < 0; @@ -977,8 +1007,8 @@ amountFromQuality(std::uint64_t rate) if (rate == 0) return STAmount(noIssue()); - std::uint64_t mantissa = rate & ~(255ull << (64 - 8)); - int exponent = static_cast(rate >> (64 - 8)) - 100; + std::uint64_t const mantissa = rate & ~(255ull << (64 - 8)); + int const exponent = static_cast(rate >> (64 - 8)) - 100; return STAmount(noIssue(), mantissa, exponent); } @@ -1065,7 +1095,7 @@ amountFromJson(SField const& name, Json::Value const& v) if (isMPT) { // sequence (32 bits) + account (160 bits) - uint192 u; + MPTID u; if (!u.parseHex(currencyOrMPTID.asString())) Throw("invalid MPTokenIssuanceID"); asset = u; @@ -1255,7 +1285,7 @@ divide(STAmount const& num, STAmount const& den, Asset const& asset) int numOffset = num.exponent(); int denOffset = den.exponent(); - if (num.native() || num.holds()) + if (num.integral()) { while (numVal < STAmount::cMinValue) { @@ -1265,7 +1295,7 @@ divide(STAmount const& num, STAmount const& den, Asset const& asset) } } - if (den.native() || den.holds()) + if (den.integral()) { while (denVal < STAmount::cMinValue) { @@ -1330,7 +1360,7 @@ multiply(STAmount const& v1, STAmount const& v2, Asset const& asset) int offset1 = v1.exponent(); int offset2 = v2.exponent(); - if (v1.native() || v1.holds()) + if (v1.integral()) { while (value1 < STAmount::cMinValue) { @@ -1339,7 +1369,7 @@ multiply(STAmount const& v1, STAmount const& v2, Asset const& asset) } } - if (v2.native() || v2.holds()) + if (v2.integral()) { while (value2 < STAmount::cMinValue) { @@ -1363,7 +1393,7 @@ multiply(STAmount const& v1, STAmount const& v2, Asset const& asset) // for years, so it is deeply embedded in the behavior of cross-currency // transactions. // -// However in 2022 it was noticed that the rounding characteristics were +// However, in 2022 it was noticed that the rounding characteristics were // surprising. When the code converts from IOU-like to XRP-like there may // be a fraction of the IOU-like representation that is too small to be // represented in drops. `canonicalizeRound()` currently does some unusual @@ -1380,9 +1410,9 @@ multiply(STAmount const& v1, STAmount const& v2, Asset const& asset) // So an alternative rounding approach was introduced. You'll see that // alternative below. static void -canonicalizeRound(bool native, std::uint64_t& value, int& offset, bool) +canonicalizeRound(bool integral, std::uint64_t& value, int& offset, bool) { - if (native) + if (integral) { if (offset < 0) { @@ -1419,9 +1449,9 @@ canonicalizeRound(bool native, std::uint64_t& value, int& offset, bool) // rounding decisions. canonicalizeRoundStrict() tracks all of the bits in // the value being rounded. static void -canonicalizeRoundStrict(bool native, std::uint64_t& value, int& offset, bool roundUp) +canonicalizeRoundStrict(bool integral, std::uint64_t& value, int& offset, bool roundUp) { - if (native) + if (integral) { if (offset < 0) { @@ -1474,7 +1504,7 @@ roundToScale(STAmount const& value, std::int32_t scale, Number::rounding_mode ro STAmount const referenceValue{value.asset(), STAmount::cMinValue, scale, value.negative()}; - NumberRoundModeGuard mg(rounding); + NumberRoundModeGuard const mg(rounding); // With an IOU, the the result of addition will be truncated to the // precision of the larger value, which in this case is referenceValue. Then // remove the reference value via subtraction, and we're left with the @@ -1512,12 +1542,10 @@ mulRoundImpl(STAmount const& v1, STAmount const& v2, Asset const& asset, bool ro if (v1 == beast::zero || v2 == beast::zero) return {asset}; - bool const xrp = asset.native(); - - if (v1.native() && v2.native() && xrp) + if (v1.native() && v2.native() && asset.native()) { - std::uint64_t minV = std::min(getSNValue(v1), getSNValue(v2)); - std::uint64_t maxV = std::max(getSNValue(v1), getSNValue(v2)); + std::uint64_t const minV = std::min(getSNValue(v1), getSNValue(v2)); + std::uint64_t const maxV = std::max(getSNValue(v1), getSNValue(v2)); if (minV > 3000000000ull) // sqrt(cMaxNative) Throw("Native value overflow"); @@ -1545,7 +1573,7 @@ mulRoundImpl(STAmount const& v1, STAmount const& v2, Asset const& asset, bool ro std::uint64_t value1 = v1.mantissa(), value2 = v2.mantissa(); int offset1 = v1.exponent(), offset2 = v2.exponent(); - if (v1.native() || v1.holds()) + if (v1.integral()) { while (value1 < STAmount::cMinValue) { @@ -1554,7 +1582,7 @@ mulRoundImpl(STAmount const& v1, STAmount const& v2, Asset const& asset, bool ro } } - if (v2.native() || v2.holds()) + if (v2.integral()) { while (value2 < STAmount::cMinValue) { @@ -1570,7 +1598,7 @@ mulRoundImpl(STAmount const& v1, STAmount const& v2, Asset const& asset, bool ro // range. Dividing their product by 10^14 maintains the // precision, by scaling the result to 10^16 to 10^18. // - // If the we're rounding up, we want to round up away + // If we're rounding up, we want to round up away // from zero, and if we're rounding down, truncation // is implicit. std::uint64_t amount = @@ -1579,7 +1607,7 @@ mulRoundImpl(STAmount const& v1, STAmount const& v2, Asset const& asset, bool ro int offset = offset1 + offset2 + 14; if (resultNegative != roundUp) { - CanonicalizeFunc(xrp, amount, offset, roundUp); + CanonicalizeFunc(asset.integral(), amount, offset, roundUp); } STAmount result = [&]() { // If appropriate, tell Number to round down. This gives the desired @@ -1590,7 +1618,7 @@ mulRoundImpl(STAmount const& v1, STAmount const& v2, Asset const& asset, bool ro if (roundUp && !resultNegative && !result) { - if (xrp) + if (asset.integral()) { // return the smallest value above zero amount = 1; @@ -1634,7 +1662,7 @@ divRoundImpl(STAmount const& num, STAmount const& den, Asset const& asset, bool std::uint64_t numVal = num.mantissa(), denVal = den.mantissa(); int numOffset = num.exponent(), denOffset = den.exponent(); - if (num.native() || num.holds()) + if (num.integral()) { while (numVal < STAmount::cMinValue) { @@ -1643,7 +1671,7 @@ divRoundImpl(STAmount const& num, STAmount const& den, Asset const& asset, bool } } - if (den.native() || den.holds()) + if (den.integral()) { while (denVal < STAmount::cMinValue) { @@ -1668,12 +1696,12 @@ divRoundImpl(STAmount const& num, STAmount const& den, Asset const& asset, bool int offset = numOffset - denOffset - 17; if (resultNegative != roundUp) - canonicalizeRound(asset.native() || asset.holds(), amount, offset, roundUp); + canonicalizeRound(asset.integral(), amount, offset, roundUp); STAmount result = [&]() { // If appropriate, tell Number the rounding mode we are using. // Note that "roundUp == true" actually means "round away from zero". - // Otherwise round toward zero. + // Otherwise, round toward zero. using enum Number::rounding_mode; MightSaveRound const savedRound(roundUp ^ resultNegative ? upward : downward); return STAmount(asset, amount, offset, resultNegative); @@ -1681,7 +1709,7 @@ divRoundImpl(STAmount const& num, STAmount const& den, Asset const& asset, bool if (roundUp && !resultNegative && !result) { - if (asset.native() || asset.holds()) + if (asset.integral()) { // return the smallest value above zero amount = 1; diff --git a/src/libxrpl/protocol/STArray.cpp b/src/libxrpl/protocol/STArray.cpp index 91acc9ddd3..726ac4907b 100644 --- a/src/libxrpl/protocol/STArray.cpp +++ b/src/libxrpl/protocol/STArray.cpp @@ -1,8 +1,9 @@ +#include + #include #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/STBase.cpp b/src/libxrpl/protocol/STBase.cpp index 3c5c34ae4e..b3558e1b08 100644 --- a/src/libxrpl/protocol/STBase.cpp +++ b/src/libxrpl/protocol/STBase.cpp @@ -1,7 +1,8 @@ +#include + #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/STBlob.cpp b/src/libxrpl/protocol/STBlob.cpp index e7d45a698d..3f44c9b529 100644 --- a/src/libxrpl/protocol/STBlob.cpp +++ b/src/libxrpl/protocol/STBlob.cpp @@ -1,8 +1,9 @@ +#include + #include #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/STCurrency.cpp b/src/libxrpl/protocol/STCurrency.cpp index 3ca7b60d6b..dc47624402 100644 --- a/src/libxrpl/protocol/STCurrency.cpp +++ b/src/libxrpl/protocol/STCurrency.cpp @@ -1,8 +1,9 @@ +#include + #include #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/STInteger.cpp b/src/libxrpl/protocol/STInteger.cpp index 1fccee2285..0530a784d9 100644 --- a/src/libxrpl/protocol/STInteger.cpp +++ b/src/libxrpl/protocol/STInteger.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -6,7 +8,6 @@ #include #include #include -#include #include #include #include @@ -15,7 +16,6 @@ #include #include #include -#include namespace xrpl { diff --git a/src/libxrpl/protocol/STIssue.cpp b/src/libxrpl/protocol/STIssue.cpp index bc39ea1b55..10f0ff4c32 100644 --- a/src/libxrpl/protocol/STIssue.cpp +++ b/src/libxrpl/protocol/STIssue.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -6,7 +8,6 @@ #include #include #include -#include #include #include @@ -38,7 +39,7 @@ STIssue::STIssue(SerialIter& sit, SField const& name) : STBase{name} // - 160 bits MPT issuer account // - 160 bits black hole account // - 32 bits sequence - AccountID account = static_cast(sit.get160()); + AccountID const account = static_cast(sit.get160()); // MPT if (noAccount() == account) { @@ -50,7 +51,7 @@ STIssue::STIssue(SerialIter& sit, SField const& name) : STBase{name} mptID.data() + sizeof(sequence), currencyOrAccount.data(), sizeof(currencyOrAccount)); - MPTIssue issue{mptID}; + MPTIssue const issue{mptID}; asset_ = issue; } else @@ -88,22 +89,19 @@ STIssue::getJson(JsonOptions) const void STIssue::add(Serializer& s) const { - if (holds()) - { - auto const& issue = asset_.get(); - s.addBitString(issue.currency); - if (!isXRP(issue.currency)) - s.addBitString(issue.account); - } - else - { - auto const& issue = asset_.get(); - s.addBitString(issue.getIssuer()); - s.addBitString(noAccount()); - std::uint32_t sequence = 0; - memcpy(&sequence, issue.getMptID().data(), sizeof(sequence)); - s.add32(sequence); - } + asset_.visit( + [&](Issue const& issue) { + s.addBitString(issue.currency); + if (!isXRP(issue.currency)) + s.addBitString(issue.account); + }, + [&](MPTIssue const& issue) { + s.addBitString(issue.getIssuer()); + s.addBitString(noAccount()); + std::uint32_t sequence = 0; + memcpy(&sequence, issue.getMptID().data(), sizeof(sequence)); + s.add32(sequence); + }); } bool @@ -116,7 +114,9 @@ STIssue::isEquivalent(STBase const& t) const bool STIssue::isDefault() const { - return holds() && asset_.get() == xrpIssue(); + return asset_.visit( + [](Issue const& issue) { return issue == xrpIssue(); }, + [](MPTIssue const&) { return false; }); } STBase* diff --git a/src/libxrpl/protocol/STLedgerEntry.cpp b/src/libxrpl/protocol/STLedgerEntry.cpp index 02e5ddb451..1f4d9acfd4 100644 --- a/src/libxrpl/protocol/STLedgerEntry.cpp +++ b/src/libxrpl/protocol/STLedgerEntry.cpp @@ -1,9 +1,12 @@ +#include + #include #include #include #include #include -#include +#include +#include // IWYU pragma: keep #include #include #include @@ -11,7 +14,6 @@ #include #include #include -#include #include #include #include @@ -147,7 +149,7 @@ STLedgerEntry::thread( uint256& prevTxID, std::uint32_t& prevLedgerID) { - uint256 oldPrevTxID = getFieldH256(sfPreviousTxnID); + uint256 const oldPrevTxID = getFieldH256(sfPreviousTxnID); JLOG(debugLog().info()) << "Thread Tx:" << txID << " prev:" << oldPrevTxID; diff --git a/src/libxrpl/protocol/STNumber.cpp b/src/libxrpl/protocol/STNumber.cpp index aab4bdc0f5..dfb55064e2 100644 --- a/src/libxrpl/protocol/STNumber.cpp +++ b/src/libxrpl/protocol/STNumber.cpp @@ -1,20 +1,26 @@ #include -// Do not remove. Keep STNumber.h first + #include -#include +#include #include -#include +#include +#include #include #include #include -#include +#include #include #include -#include +#include +#include +#include #include +#include +#include #include +#include #include #include @@ -177,7 +183,7 @@ partsFromString(std::string const& number) // 6 = exponent sign // 7 = exponent number - bool negative = (match[1].matched && (match[1] == "-")); + bool const negative = (match[1].matched && (match[1] == "-")); std::uint64_t mantissa = 0; int exponent = 0; @@ -241,6 +247,7 @@ numberFromJson(SField const& field, Json::Value const& value) // Number mantissas are much bigger than the allowable parsed values, so // it can't be out of range. static_assert( + // NOLINTNEXTLINE(misc-redundant-expression) std::numeric_limits::max() >= std::numeric_limits::max()); } diff --git a/src/libxrpl/protocol/STObject.cpp b/src/libxrpl/protocol/STObject.cpp index 182653d11d..f78ba9671a 100644 --- a/src/libxrpl/protocol/STObject.cpp +++ b/src/libxrpl/protocol/STObject.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -22,7 +24,6 @@ #include #include #include -#include #include #include #include @@ -156,7 +157,7 @@ STObject::applyTemplate(SOTemplate const& type) auto throwFieldErr = [](std::string const& field, char const* description) { std::stringstream ss; ss << "Field '" << field << "' " << description; - std::string text{ss.str()}; + std::string const text{ss.str()}; JLOG(debugLog().error()) << "STObject::applyTemplate failed: " << text; Throw(text); }; @@ -400,7 +401,7 @@ STObject::getFieldIndex(SField const& field) const STBase const& STObject::peekAtField(SField const& field) const { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) throwFieldNotFound(field); @@ -411,7 +412,7 @@ STObject::peekAtField(SField const& field) const STBase& STObject::getField(SField const& field) { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) throwFieldNotFound(field); @@ -428,7 +429,7 @@ STObject::getFieldSType(int index) const STBase const* STObject::peekAtPField(SField const& field) const { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) return nullptr; @@ -439,7 +440,7 @@ STObject::peekAtPField(SField const& field) const STBase* STObject::getPField(SField const& field, bool createOkay) { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) { @@ -455,7 +456,7 @@ STObject::getPField(SField const& field, bool createOkay) bool STObject::isFieldPresent(SField const& field) const { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) return false; @@ -519,7 +520,7 @@ STObject::getFlags(void) const STBase* STObject::makeFieldPresent(SField const& field) { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) { @@ -529,7 +530,7 @@ STObject::makeFieldPresent(SField const& field) return getPIndex(emplace_back(detail::nonPresentObject, field)); } - STBase* f = getPIndex(index); + STBase* f = getPIndex(index); // NOLINT(misc-const-correctness) if (f->getSType() != STI_NOTPRESENT) return f; @@ -541,7 +542,7 @@ STObject::makeFieldPresent(SField const& field) void STObject::makeFieldAbsent(SField const& field) { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) throwFieldNotFound(field); @@ -556,7 +557,7 @@ STObject::makeFieldAbsent(SField const& field) bool STObject::delField(SField const& field) { - int index = getFieldIndex(field); + int const index = getFieldIndex(field); if (index == -1) return false; @@ -640,7 +641,7 @@ STObject::getAccountID(SField const& field) const Blob STObject::getFieldVL(SField const& field) const { - STBlob empty; + STBlob const empty; STBlob const& b = getFieldByConstRef(field, empty); return Blob(b.data(), b.data() + b.size()); } @@ -749,6 +750,12 @@ STObject::setFieldH128(SField const& field, uint128 const& v) setFieldUsingSetValue(field, v); } +void +STObject::setFieldH192(SField const& field, uint192 const& v) +{ + setFieldUsingSetValue(field, v); +} + void STObject::setFieldH256(SField const& field, uint256 const& v) { diff --git a/src/libxrpl/protocol/STParsedJSON.cpp b/src/libxrpl/protocol/STParsedJSON.cpp index 702ad28414..3b2960dac9 100644 --- a/src/libxrpl/protocol/STParsedJSON.cpp +++ b/src/libxrpl/protocol/STParsedJSON.cpp @@ -1,13 +1,18 @@ +#include + #include #include #include #include #include +#include #include #include #include #include #include +#include +#include #include #include #include @@ -19,7 +24,6 @@ #include #include #include -#include #include #include #include @@ -27,6 +31,7 @@ #include #include #include +#include #include #include @@ -736,7 +741,7 @@ parseLeaf( std::string const element_name(json_name + "." + ss.str()); // each element in this path has some combination of - // account, currency, or issuer + // account, asset, or issuer Json::Value pathEl = value[i][j]; @@ -746,14 +751,22 @@ parseLeaf( return ret; } - Json::Value const& account = pathEl["account"]; - Json::Value const& currency = pathEl["currency"]; - Json::Value const& issuer = pathEl["issuer"]; - bool hasCurrency = false; - AccountID uAccount, uIssuer; - Currency uCurrency; + if (pathEl.isMember(jss::currency) && pathEl.isMember(jss::mpt_issuance_id)) + { + error = RPC::make_error(rpcINVALID_PARAMS, "Invalid Asset."); + return ret; + } - if (!account && !currency && !issuer) + bool const isMPT = pathEl.isMember(jss::mpt_issuance_id); + auto const assetName = isMPT ? jss::mpt_issuance_id : jss::currency; + Json::Value const& account = pathEl[jss::account]; + Json::Value const& asset = pathEl[assetName]; + Json::Value const& issuer = pathEl[jss::issuer]; + bool hasAsset = false; + AccountID uAccount, uIssuer; + PathAsset uAsset; + + if (!account && !asset && !issuer) { error = invalid_data(element_name); return ret; @@ -764,7 +777,7 @@ parseLeaf( // human account id if (!account.isString()) { - error = string_expected(element_name, "account"); + error = string_expected(element_name, jss::account.c_str()); return ret; } @@ -775,31 +788,51 @@ parseLeaf( auto const a = parseBase58(account.asString()); if (!a) { - error = invalid_data(element_name, "account"); + error = invalid_data(element_name, jss::account.c_str()); return ret; } uAccount = *a; } } - if (currency) + if (asset) { - // human currency - if (!currency.isString()) + // human asset + if (!asset.isString()) { - error = string_expected(element_name, "currency"); + error = string_expected(element_name, assetName.c_str()); return ret; } - hasCurrency = true; + hasAsset = true; - if (!uCurrency.parseHex(currency.asString())) + if (isMPT) { - if (!to_currency(uCurrency, currency.asString())) + MPTID u; + if (!u.parseHex(asset.asString())) { - error = invalid_data(element_name, "currency"); + error = invalid_data(element_name, assetName.c_str()); return ret; } + if (getMPTIssuer(u) == beast::zero) + { + error = invalid_data(element_name, jss::account.c_str()); + return ret; + } + uAsset = u; + } + else + { + Currency currency; + if (!currency.parseHex(asset.asString())) + { + if (!to_currency(currency, asset.asString())) + { + error = invalid_data(element_name, assetName.c_str()); + return ret; + } + } + uAsset = currency; } } @@ -808,7 +841,7 @@ parseLeaf( // human account id if (!issuer.isString()) { - error = string_expected(element_name, "issuer"); + error = string_expected(element_name, jss::issuer.c_str()); return ret; } @@ -817,14 +850,20 @@ parseLeaf( auto const a = parseBase58(issuer.asString()); if (!a) { - error = invalid_data(element_name, "issuer"); + error = invalid_data(element_name, jss::issuer.c_str()); return ret; } uIssuer = *a; } + + if (isMPT && uIssuer != getMPTIssuer(uAsset.get())) + { + error = invalid_data(element_name, jss::issuer.c_str()); + return ret; + } } - p.emplace_back(uAccount, uCurrency, uIssuer, hasCurrency); + p.emplace_back(uAccount, uAsset, uIssuer, hasAsset); } tail.push_back(p); @@ -1093,7 +1132,7 @@ parseArray( auto ret = parseObject(ss.str(), objectFields, nameField, depth + 1, error); if (!ret) { - std::string errMsg = error["error_message"].asString(); + std::string const errMsg = error["error_message"].asString(); error["error_message"] = "Error at '" + ss.str() + "'. " + errMsg; return std::nullopt; } diff --git a/src/libxrpl/protocol/STPathSet.cpp b/src/libxrpl/protocol/STPathSet.cpp index fde33fb58e..04c8d3c8da 100644 --- a/src/libxrpl/protocol/STPathSet.cpp +++ b/src/libxrpl/protocol/STPathSet.cpp @@ -1,11 +1,14 @@ +#include + #include +#include #include +#include #include #include #include #include #include -#include #include #include #include @@ -31,8 +34,15 @@ STPathElement::get_hash(STPathElement const& element) for (auto const x : element.getAccountID()) hash_account += (hash_account * 257) ^ x; - for (auto const x : element.getCurrency()) - hash_currency += (hash_currency * 509) ^ x; + // Check pathAsset type instead of element's mType + // In some cases mType might be account but the asset + // is still set to either MPT or currency (see Pathfinder::addLink()) + element.getPathAsset().visit( + [&](MPTID const& mpt) { hash_currency += beast::uhash<>{}(mpt); }, + [&](Currency const& currency) { + for (auto const x : currency) + hash_currency += (hash_currency * 509) ^ x; + }); for (auto const x : element.getIssuerID()) hash_issuer += (hash_issuer * 911) ^ x; @@ -45,7 +55,7 @@ STPathSet::STPathSet(SerialIter& sit, SField const& name) : STBase(name) std::vector path; for (;;) { - int iType = sit.get8(); + int const iType = sit.get8(); if (iType == STPathElement::typeNone || iType == STPathElement::typeBoundary) { @@ -68,24 +78,30 @@ STPathSet::STPathSet(SerialIter& sit, SField const& name) : STBase(name) } else { - auto hasAccount = iType & STPathElement::typeAccount; - auto hasCurrency = iType & STPathElement::typeCurrency; - auto hasIssuer = iType & STPathElement::typeIssuer; + auto const hasAccount = (iType & STPathElement::typeAccount) != 0u; + auto const hasCurrency = (iType & STPathElement::typeCurrency) != 0u; + auto const hasIssuer = (iType & STPathElement::typeIssuer) != 0u; + auto const hasMPT = (iType & STPathElement::typeMPT) != 0u; AccountID account; - Currency currency; + PathAsset asset; AccountID issuer; - if (hasAccount != 0) + if (hasAccount) account = sit.get160(); - if (hasCurrency != 0) - currency = sit.get160(); + XRPL_ASSERT( + !(hasCurrency && hasMPT), "xrpl::STPathSet::STPathSet : not has Currency and MPT"); + if (hasCurrency) + asset = static_cast(sit.get160()); - if (hasIssuer != 0) + if (hasMPT) + asset = sit.get192(); + + if (hasIssuer) issuer = sit.get160(); - path.emplace_back(account, currency, issuer, hasCurrency); + path.emplace_back(account, asset, issuer, hasCurrency); } } } @@ -137,11 +153,11 @@ STPathSet::isDefault() const } bool -STPath::hasSeen(AccountID const& account, Currency const& currency, AccountID const& issuer) const +STPath::hasSeen(AccountID const& account, PathAsset const& asset, AccountID const& issuer) const { for (auto& p : mPath) { - if (p.getAccountID() == account && p.getCurrency() == currency && p.getIssuerID() == issuer) + if (p.getAccountID() == account && p.getPathAsset() == asset && p.getIssuerID() == issuer) return true; } @@ -163,9 +179,16 @@ STPath::getJson(JsonOptions) const if ((iType & STPathElement::typeAccount) != 0u) elem[jss::account] = to_string(it.getAccountID()); + XRPL_ASSERT( + ((iType & STPathElement::typeCurrency) == 0u) || + ((iType & STPathElement::typeMPT) == 0u), + "xrpl::STPath::getJson : not type Currency and MPT"); if ((iType & STPathElement::typeCurrency) != 0u) elem[jss::currency] = to_string(it.getCurrency()); + if ((iType & STPathElement::typeMPT) != 0u) + elem[jss::mpt_issuance_id] = to_string(it.getMPTID()); + if ((iType & STPathElement::typeIssuer) != 0u) elem[jss::issuer] = to_string(it.getIssuerID()); @@ -205,17 +228,20 @@ STPathSet::add(Serializer& s) const for (auto const& speElement : spPath) { - int iType = speElement.getNodeType(); + int const iType = speElement.getNodeType(); s.add8(iType); - if ((iType & STPathElement::typeAccount) != 0) + if ((iType & STPathElement::typeAccount) != 0u) s.addBitString(speElement.getAccountID()); - if ((iType & STPathElement::typeCurrency) != 0) + if ((iType & STPathElement::typeMPT) != 0u) + s.addBitString(speElement.getMPTID()); + + if ((iType & STPathElement::typeCurrency) != 0u) s.addBitString(speElement.getCurrency()); - if ((iType & STPathElement::typeIssuer) != 0) + if ((iType & STPathElement::typeIssuer) != 0u) s.addBitString(speElement.getIssuerID()); } diff --git a/src/libxrpl/protocol/STTakesAsset.cpp b/src/libxrpl/protocol/STTakesAsset.cpp index fcf4ad749c..1d37c65fc1 100644 --- a/src/libxrpl/protocol/STTakesAsset.cpp +++ b/src/libxrpl/protocol/STTakesAsset.cpp @@ -1,5 +1,10 @@ #include -// Do not remove. Force STTakesAsset.h first + +#include +#include +#include +#include +#include #include namespace xrpl { diff --git a/src/libxrpl/protocol/STTx.cpp b/src/libxrpl/protocol/STTx.cpp index 7da1919f35..6da0d61b57 100644 --- a/src/libxrpl/protocol/STTx.cpp +++ b/src/libxrpl/protocol/STTx.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -24,18 +26,14 @@ #include #include #include -#include -#include #include #include #include #include -#include #include #include #include -#include #include #include @@ -50,6 +48,7 @@ #include #include #include +#include namespace xrpl { @@ -77,7 +76,7 @@ STTx::STTx(STObject&& object) : STObject(std::move(object)) STTx::STTx(SerialIter& sit) : STObject(sfTransaction) { - int length = sit.getBytesLeft(); + int const length = sit.getBytesLeft(); if ((length < txMinSizeBytes) || (length > txMaxSizeBytes)) Throw("Transaction length invalid"); @@ -329,7 +328,7 @@ STTx::getJson(JsonOptions options, bool binary) const if (binary) { - Serializer s = STObject::getSerializer(); + Serializer const s = STObject::getSerializer(); std::string const dataBin = strHex(s.peekData()); if (V1) @@ -378,7 +377,7 @@ STTx::getMetaSQL( TxnSql status, std::string const& escapedMetaData) const { - static boost::format bfTrans("('%s', '%s', '%s', '%d', '%d', '%c', %s, %s)"); + static boost::format const bfTrans("('%s', '%s', '%s', '%d', '%d', '%c', %s, %s)"); std::string rTxn = sqlBlobLiteral(rawTxn.peekData()); auto format = TxFormats::getInstance().findByType(tx_type_); @@ -656,18 +655,18 @@ isMemoOkay(STObject const& st, std::string& reason) static constexpr std::array const allowedSymbols = []() { std::array a{}; - std::string_view symbols( + std::string_view const symbols( "0123456789" "-._~:/?#[]@!$&'()*+,;=%" "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz"); - for (unsigned char c : symbols) + for (unsigned char const c : symbols) a[c] = 1; return a; }(); - for (unsigned char c : *optData) + for (unsigned char const c : *optData) { if (allowedSymbols[c] == 0) { diff --git a/src/libxrpl/protocol/STValidation.cpp b/src/libxrpl/protocol/STValidation.cpp index ba6e679081..14349d3f85 100644 --- a/src/libxrpl/protocol/STValidation.cpp +++ b/src/libxrpl/protocol/STValidation.cpp @@ -1,16 +1,16 @@ +#include + #include #include #include #include #include #include -#include #include #include #include #include #include -#include #include #include @@ -38,22 +38,22 @@ STValidation::validationFormat() // guarantee the initialization order. // clang-format off static SOTemplate const format{ - {sfFlags, soeREQUIRED}, - {sfLedgerHash, soeREQUIRED}, - {sfLedgerSequence, soeREQUIRED}, - {sfCloseTime, soeOPTIONAL}, - {sfLoadFee, soeOPTIONAL}, - {sfAmendments, soeOPTIONAL}, - {sfBaseFee, soeOPTIONAL}, - {sfReserveBase, soeOPTIONAL}, - {sfReserveIncrement, soeOPTIONAL}, - {sfSigningTime, soeREQUIRED}, - {sfSigningPubKey, soeREQUIRED}, - {sfSignature, soeREQUIRED}, - {sfConsensusHash, soeOPTIONAL}, - {sfCookie, soeDEFAULT}, - {sfValidatedHash, soeOPTIONAL}, - {sfServerVersion, soeOPTIONAL}, + {sfFlags, soeREQUIRED}, + {sfLedgerHash, soeREQUIRED}, + {sfLedgerSequence, soeREQUIRED}, + {sfCloseTime, soeOPTIONAL}, + {sfLoadFee, soeOPTIONAL}, + {sfAmendments, soeOPTIONAL}, + {sfBaseFee, soeOPTIONAL}, + {sfReserveBase, soeOPTIONAL}, + {sfReserveIncrement, soeOPTIONAL}, + {sfSigningTime, soeREQUIRED}, + {sfSigningPubKey, soeREQUIRED}, + {sfSignature, soeREQUIRED}, + {sfConsensusHash, soeOPTIONAL}, + {sfCookie, soeDEFAULT}, + {sfValidatedHash, soeOPTIONAL}, + {sfServerVersion, soeOPTIONAL}, // featureXRPFees {sfBaseFeeDrops, soeOPTIONAL}, {sfReserveBaseDrops, soeOPTIONAL}, diff --git a/src/libxrpl/protocol/STVar.cpp b/src/libxrpl/protocol/STVar.cpp index 8b76d8a322..257cfa522d 100644 --- a/src/libxrpl/protocol/STVar.cpp +++ b/src/libxrpl/protocol/STVar.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -16,7 +18,6 @@ #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/STVector256.cpp b/src/libxrpl/protocol/STVector256.cpp index 2a70dd1e05..038f88c226 100644 --- a/src/libxrpl/protocol/STVector256.cpp +++ b/src/libxrpl/protocol/STVector256.cpp @@ -1,10 +1,11 @@ +#include + #include #include #include #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/STXChainBridge.cpp b/src/libxrpl/protocol/STXChainBridge.cpp index 428e4655ff..a29bf3b6f9 100644 --- a/src/libxrpl/protocol/STXChainBridge.cpp +++ b/src/libxrpl/protocol/STXChainBridge.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -6,7 +8,6 @@ #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/SecretKey.cpp b/src/libxrpl/protocol/SecretKey.cpp index aa398e9fe1..7496edab7f 100644 --- a/src/libxrpl/protocol/SecretKey.cpp +++ b/src/libxrpl/protocol/SecretKey.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -8,7 +10,6 @@ #include #include #include -#include #include #include #include @@ -17,6 +18,7 @@ #include #include +#include #include #include @@ -185,7 +187,7 @@ public: if (secp256k1_ec_seckey_tweak_add(secp256k1Context(), rpk.data(), tweak.data()) == 1) { - SecretKey sk{Slice{rpk.data(), rpk.size()}}; + SecretKey const sk{Slice{rpk.data(), rpk.size()}}; secure_erase(rpk.data(), rpk.size()); return sk; } @@ -270,7 +272,7 @@ randomSecretKey() { std::uint8_t buf[32]; beast::rngfill(buf, sizeof(buf), crypto_prng()); - SecretKey sk(Slice{buf, sizeof(buf)}); + SecretKey const sk(Slice{buf, sizeof(buf)}); secure_erase(buf, sizeof(buf)); return sk; } @@ -281,7 +283,7 @@ generateSecretKey(KeyType type, Seed const& seed) if (type == KeyType::ed25519) { auto key = sha512Half_s(Slice(seed.data(), seed.size())); - SecretKey sk{Slice{key.data(), key.size()}}; + SecretKey const sk{Slice{key.data(), key.size()}}; secure_erase(key.data(), key.size()); return sk; } @@ -289,7 +291,7 @@ generateSecretKey(KeyType type, Seed const& seed) if (type == KeyType::secp256k1) { auto key = detail::deriveDeterministicRootKey(seed); - SecretKey sk{Slice{key.data(), key.size()}}; + SecretKey const sk{Slice{key.data(), key.size()}}; secure_erase(key.data(), key.size()); return sk; } @@ -335,7 +337,7 @@ generateKeyPair(KeyType type, Seed const& seed) switch (type) { case KeyType::secp256k1: { - detail::Generator g(seed); + detail::Generator const g(seed); return g(0); } default: diff --git a/src/libxrpl/protocol/Seed.cpp b/src/libxrpl/protocol/Seed.cpp index 8aa1d8b67d..0fe525a613 100644 --- a/src/libxrpl/protocol/Seed.cpp +++ b/src/libxrpl/protocol/Seed.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -9,7 +11,6 @@ #include #include #include -#include #include #include @@ -48,7 +49,7 @@ randomSeed() { std::array buffer{}; beast::rngfill(buffer.data(), buffer.size(), crypto_prng()); - Seed seed(makeSlice(buffer)); + Seed const seed(makeSlice(buffer)); secure_erase(buffer.data(), buffer.size()); return seed; } diff --git a/src/libxrpl/protocol/Serializer.cpp b/src/libxrpl/protocol/Serializer.cpp index 0e8beae0d9..26d985c4f9 100644 --- a/src/libxrpl/protocol/Serializer.cpp +++ b/src/libxrpl/protocol/Serializer.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -5,7 +7,6 @@ #include #include #include -#include #include #include @@ -23,7 +24,7 @@ namespace xrpl { int Serializer::add16(std::uint16_t i) { - int ret = mData.size(); + int const ret = mData.size(); mData.push_back(static_cast(i >> 8)); mData.push_back(static_cast(i & 0xff)); return ret; @@ -73,7 +74,7 @@ Serializer::addInteger(std::int32_t i) int Serializer::addRaw(Blob const& vector) { - int ret = mData.size(); + int const ret = mData.size(); mData.insert(mData.end(), vector.begin(), vector.end()); return ret; } @@ -81,7 +82,7 @@ Serializer::addRaw(Blob const& vector) int Serializer::addRaw(Slice slice) { - int ret = mData.size(); + int const ret = mData.size(); mData.insert(mData.end(), slice.begin(), slice.end()); return ret; } @@ -89,7 +90,7 @@ Serializer::addRaw(Slice slice) int Serializer::addRaw(Serializer const& s) { - int ret = mData.size(); + int const ret = mData.size(); mData.insert(mData.end(), s.begin(), s.end()); return ret; } @@ -97,7 +98,7 @@ Serializer::addRaw(Serializer const& s) int Serializer::addRaw(void const* ptr, int len) { - int ret = mData.size(); + int const ret = mData.size(); mData.insert(mData.end(), (char const*)ptr, ((char const*)ptr) + len); return ret; } @@ -105,7 +106,7 @@ Serializer::addRaw(void const* ptr, int len) int Serializer::addFieldID(int type, int name) { - int ret = mData.size(); + int const ret = mData.size(); XRPL_ASSERT( (type > 0) && (type < 256) && (name > 0) && (name < 256), "xrpl::Serializer::addFieldID : inputs inside range"); @@ -143,7 +144,7 @@ Serializer::addFieldID(int type, int name) int Serializer::add8(unsigned char byte) { - int ret = mData.size(); + int const ret = mData.size(); mData.push_back(byte); return ret; } @@ -177,7 +178,7 @@ Serializer::getSHA512Half() const int Serializer::addVL(Blob const& vector) { - int ret = addEncoded(vector.size()); + int const ret = addEncoded(vector.size()); addRaw(vector); XRPL_ASSERT( mData.size() == (ret + vector.size() + encodeLengthLength(vector.size())), @@ -188,7 +189,7 @@ Serializer::addVL(Blob const& vector) int Serializer::addVL(Slice const& slice) { - int ret = addEncoded(slice.size()); + int const ret = addEncoded(slice.size()); if (!slice.empty()) addRaw(slice.data(), slice.size()); return ret; @@ -197,7 +198,7 @@ Serializer::addVL(Slice const& slice) int Serializer::addVL(void const* ptr, int len) { - int ret = addEncoded(len); + int const ret = addEncoded(len); if (len != 0) addRaw(ptr, len); @@ -343,7 +344,7 @@ SerialIter::get8() { if (remain_ < 1) Throw("invalid SerialIter get8"); - unsigned char t = *p_; + unsigned char const t = *p_; ++p_; ++used_; --remain_; @@ -469,23 +470,23 @@ SerialIter::getRaw(int size) int SerialIter::getVLDataLength() { - int b1 = get8(); + int const b1 = get8(); int datLen = 0; - int lenLen = Serializer::decodeLengthLength(b1); + int const lenLen = Serializer::decodeLengthLength(b1); if (lenLen == 1) { datLen = Serializer::decodeVLLength(b1); } else if (lenLen == 2) { - int b2 = get8(); + int const b2 = get8(); datLen = Serializer::decodeVLLength(b1, b2); } else { XRPL_ASSERT(lenLen == 3, "xrpl::SerialIter::getVLDataLength : lenLen is 3"); - int b2 = get8(); - int b3 = get8(); + int const b2 = get8(); + int const b3 = get8(); datLen = Serializer::decodeVLLength(b1, b2, b3); } return datLen; @@ -496,7 +497,7 @@ SerialIter::getSlice(std::size_t bytes) { if (bytes > remain_) Throw("invalid SerialIter getSlice"); - Slice s(p_, bytes); + Slice const s(p_, bytes); p_ += bytes; used_ += bytes; remain_ -= bytes; diff --git a/src/libxrpl/protocol/Sign.cpp b/src/libxrpl/protocol/Sign.cpp index 9105be8294..bee034d60e 100644 --- a/src/libxrpl/protocol/Sign.cpp +++ b/src/libxrpl/protocol/Sign.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -7,7 +9,6 @@ #include #include #include -#include namespace xrpl { diff --git a/src/libxrpl/protocol/TER.cpp b/src/libxrpl/protocol/TER.cpp index 5d732a5876..1e3f64cc22 100644 --- a/src/libxrpl/protocol/TER.cpp +++ b/src/libxrpl/protocol/TER.cpp @@ -156,6 +156,7 @@ transResults() MAKE_ERROR(temBAD_FEE, "Invalid fee, negative or not XRP."), MAKE_ERROR(temBAD_ISSUER, "Malformed: Bad issuer."), MAKE_ERROR(temBAD_LIMIT, "Limits must be non-negative."), + MAKE_ERROR(temBAD_MPT, "Malformed: Bad MPT."), MAKE_ERROR(temBAD_OFFER, "Malformed: Bad offer."), MAKE_ERROR(temBAD_PATH, "Malformed: Bad path."), MAKE_ERROR(temBAD_PATH_LOOP, "Malformed: Loop in path."), @@ -214,6 +215,7 @@ transResults() MAKE_ERROR(terNO_AMM, "AMM doesn't exist for the asset pair."), MAKE_ERROR(terADDRESS_COLLISION, "Failed to allocate an unique account address."), MAKE_ERROR(terNO_DELEGATE_PERMISSION, "Delegated account lacks permission to perform this transaction."), + MAKE_ERROR(terLOCKED, "Fund is locked."), MAKE_ERROR(tesSUCCESS, "The transaction was applied. Only final in a validated ledger."), }; diff --git a/src/libxrpl/protocol/TxFormats.cpp b/src/libxrpl/protocol/TxFormats.cpp index 4492ae271b..a2a7c5facf 100644 --- a/src/libxrpl/protocol/TxFormats.cpp +++ b/src/libxrpl/protocol/TxFormats.cpp @@ -1,7 +1,9 @@ +#include + +#include // IWYU pragma: keep #include #include -#include -#include +#include // IWYU pragma: keep #include diff --git a/src/libxrpl/protocol/TxMeta.cpp b/src/libxrpl/protocol/TxMeta.cpp index 19a2755a29..08069ca83d 100644 --- a/src/libxrpl/protocol/TxMeta.cpp +++ b/src/libxrpl/protocol/TxMeta.cpp @@ -1,4 +1,7 @@ +#include + #include +#include #include #include #include @@ -10,13 +13,12 @@ #include #include #include -#include #include #include +#include #include -#include namespace xrpl { @@ -39,7 +41,7 @@ TxMeta::TxMeta(uint256 const& txid, std::uint32_t ledger, Blob const& vec) { SerialIter sit(makeSlice(vec)); - STObject obj(sit, sfMetadata); + STObject const obj(sit, sfMetadata); result_ = obj.getFieldU8(sfTransactionResult); index_ = obj.getFieldU32(sfTransactionIndex); nodes_ = obj.getFieldArray(sfAffectedNodes); @@ -89,7 +91,7 @@ TxMeta::getAffectedAccounts() const // Meta#getAffectedAccounts for (auto const& node : nodes_) { - int index = + int const index = node.getFieldIndex((node.getFName() == sfCreatedNode) ? sfNewFields : sfFinalFields); if (index != -1) @@ -146,7 +148,7 @@ TxMeta::getAffectedAccounts() const STObject& TxMeta::getAffectedNode(SLE::ref node, SField const& type) { - uint256 index = node->key(); + uint256 const index = node->key(); for (auto& n : nodes_) { if (n.getFieldH256(sfLedgerIndex) == index) diff --git a/src/libxrpl/protocol/UintTypes.cpp b/src/libxrpl/protocol/UintTypes.cpp index 5ace6c29d6..0ae41a8c5c 100644 --- a/src/libxrpl/protocol/UintTypes.cpp +++ b/src/libxrpl/protocol/UintTypes.cpp @@ -1,7 +1,8 @@ +#include + #include #include #include -#include #include #include diff --git a/src/libxrpl/protocol/XChainAttestations.cpp b/src/libxrpl/protocol/XChainAttestations.cpp index 314bf9f6d3..ab77aa1758 100644 --- a/src/libxrpl/protocol/XChainAttestations.cpp +++ b/src/libxrpl/protocol/XChainAttestations.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -11,7 +13,6 @@ #include #include #include -#include #include #include @@ -74,7 +75,7 @@ AttestationBase::sameEventHelper(AttestationBase const& lhs, AttestationBase con bool AttestationBase::verify(STXChainBridge const& bridge) const { - std::vector msg = message(bridge); + std::vector const msg = message(bridge); return xrpl::verify(publicKey, makeSlice(msg), signature); } diff --git a/src/libxrpl/protocol/tokens.cpp b/src/libxrpl/protocol/tokens.cpp index bca8919c4e..fc90151309 100644 --- a/src/libxrpl/protocol/tokens.cpp +++ b/src/libxrpl/protocol/tokens.cpp @@ -7,13 +7,14 @@ * file COPYING or http://www.opensource.org/licenses/mit-license.php. */ +#include + #include #include #include #include #include #include -#include #include #include @@ -445,7 +446,7 @@ b256_to_b58_be(std::span input, std::span out) std::array const b58_be = xrpl::b58_fast::detail::b58_10_to_b58_be(base_58_10_coeff[i]); std::size_t to_skip = 0; - std::span b58_be_s{b58_be.data(), b58_be.size()}; + std::span const b58_be_s{b58_be.data(), b58_be.size()}; if (skip_zeros) { to_skip = count_leading_zeros(b58_be_s); @@ -507,7 +508,7 @@ b58_to_b256_be(std::string_view input, std::span out) XRPL_ASSERT( num_b_58_10_coeffs <= b_58_10_coeff.size(), "xrpl::b58_fast::detail::b58_to_b256_be : maximum coeff"); - for (unsigned char c : input.substr(0, partial_coeff_len)) + for (unsigned char const c : input.substr(0, partial_coeff_len)) { auto cur_val = ::xrpl::alphabetReverse[c]; if (cur_val < 0) @@ -521,7 +522,7 @@ b58_to_b256_be(std::string_view input, std::span out) { for (int j = 0; j < num_full_coeffs; ++j) { - unsigned char c = input[partial_coeff_len + (j * 10) + i]; + unsigned char const c = input[partial_coeff_len + (j * 10) + i]; auto cur_val = ::xrpl::alphabetReverse[c]; if (cur_val < 0) { @@ -626,7 +627,7 @@ encodeBase58Token( size_t const checksum_i = input.size() + 1; // buf[checksum_i..checksum_i + 4] = checksum checksum(buf.data() + checksum_i, buf.data(), checksum_i); - std::span b58Span(buf.data(), input.size() + 5); + std::span const b58Span(buf.data(), input.size() + 5); return detail::b256_to_b58_be(b58Span, out); } // Convert from base 58 to base 256, largest coefficients first @@ -680,8 +681,8 @@ encodeBase58Token(TokenType type, void const* token, std::size_t size) // over-allocation, this function uses 128 (again, over-allocation assuming // 2 base 58 char per byte) sr.resize(128); - std::span outSp(reinterpret_cast(sr.data()), sr.size()); - std::span inSp(reinterpret_cast(token), size); + std::span const outSp(reinterpret_cast(sr.data()), sr.size()); + std::span const inSp(reinterpret_cast(token), size); auto r = b58_fast::encodeBase58Token(type, inSp, outSp); if (!r) return {}; @@ -696,7 +697,7 @@ decodeBase58Token(std::string const& s, TokenType type) // The largest object encoded as base58 is 33 bytes; 64 is plenty (and // there's no benefit making it smaller) sr.resize(64); - std::span outSp(reinterpret_cast(sr.data()), sr.size()); + std::span const outSp(reinterpret_cast(sr.data()), sr.size()); auto r = b58_fast::decodeBase58Token(type, s, outSp); if (!r) return {}; diff --git a/src/libxrpl/protocol_autogen/placeholder.cpp b/src/libxrpl/protocol_autogen/placeholder.cpp index b48581e5b8..efc30fd904 100644 --- a/src/libxrpl/protocol_autogen/placeholder.cpp +++ b/src/libxrpl/protocol_autogen/placeholder.cpp @@ -1,5 +1 @@ // This file is a placeholder to ensure the protocol_autogen module can be built. -#include -#include -#include -#include diff --git a/src/libxrpl/rdb/DatabaseCon.cpp b/src/libxrpl/rdb/DatabaseCon.cpp index d064192a14..5f4594b630 100644 --- a/src/libxrpl/rdb/DatabaseCon.cpp +++ b/src/libxrpl/rdb/DatabaseCon.cpp @@ -1,13 +1,18 @@ +#include + #include #include -#include #include -#include -#include - +#include +#include #include +#include +#include +#include +#include #include +#include namespace xrpl { @@ -25,7 +30,7 @@ public: std::shared_ptr fromId(std::uintptr_t id) { - std::lock_guard l{mutex_}; + std::lock_guard const l{mutex_}; auto it = checkpointers_.find(id); if (it != checkpointers_.end()) return it->second; @@ -35,7 +40,7 @@ public: void erase(std::uintptr_t id) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; checkpointers_.erase(id); } @@ -45,7 +50,7 @@ public: JobQueue& jobQueue, ServiceRegistry& registry) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; auto const id = nextId_++; auto const r = makeCheckpointer(id, session, jobQueue, registry); checkpointers_[id] = r; @@ -67,7 +72,7 @@ DatabaseCon::~DatabaseCon() { checkpointers.erase(checkpointer_->id()); - std::weak_ptr wk(checkpointer_); + std::weak_ptr const wk(checkpointer_); checkpointer_.reset(); // The references to our Checkpointer held by 'checkpointer_' and diff --git a/src/libxrpl/rdb/SociDB.cpp b/src/libxrpl/rdb/SociDB.cpp index ac96985407..cbba2800a1 100644 --- a/src/libxrpl/rdb/SociDB.cpp +++ b/src/libxrpl/rdb/SociDB.cpp @@ -1,3 +1,21 @@ +#include +#include +#include +#include +#include + +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include #if defined(__clang__) #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated" @@ -8,9 +26,7 @@ #include #include -#include - -#include +#include // IWYU pragma: keep #include @@ -93,7 +109,7 @@ open(soci::session& s, std::string const& beName, std::string const& connectionS static sqlite_api::sqlite3* getConnection(soci::session& s) { - sqlite_api::sqlite3* result = nullptr; + sqlite_api::sqlite3* result = nullptr; // NOLINT(misc-const-correctness) auto be = s.get_backend(); if (auto b = dynamic_cast(be)) result = b->conn_; @@ -222,7 +238,7 @@ public: schedule() override { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (running_) return; running_ = true; @@ -242,7 +258,7 @@ public: self->checkpoint(); })) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); running_ = false; } } @@ -256,9 +272,10 @@ public: return; int log = 0, ckpt = 0; - int ret = sqlite3_wal_checkpoint_v2(conn, nullptr, SQLITE_CHECKPOINT_PASSIVE, &log, &ckpt); + int const ret = sqlite_api::sqlite3_wal_checkpoint_v2( + conn, nullptr, SQLITE_CHECKPOINT_PASSIVE, &log, &ckpt); - auto fname = sqlite3_db_filename(conn, "main"); + auto fname = sqlite_api::sqlite3_db_filename(conn, "main"); if (ret != SQLITE_OK) { auto jm = (ret == SQLITE_LOCKED) ? j_.trace() : j_.warn(); @@ -269,7 +286,7 @@ public: JLOG(j_.trace()) << "WAL(" << fname << "): frames=" << log << ", written=" << ckpt; } - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); running_ = false; } diff --git a/src/libxrpl/resource/Consumer.cpp b/src/libxrpl/resource/Consumer.cpp index c1cb9d4367..d30408f582 100644 --- a/src/libxrpl/resource/Consumer.cpp +++ b/src/libxrpl/resource/Consumer.cpp @@ -1,8 +1,10 @@ +#include + #include #include #include +#include #include -#include #include #include #include diff --git a/src/libxrpl/resource/Fees.cpp b/src/libxrpl/resource/Fees.cpp index d5999458b7..f2e9c80d42 100644 --- a/src/libxrpl/resource/Fees.cpp +++ b/src/libxrpl/resource/Fees.cpp @@ -1,6 +1,7 @@ -#include #include +#include + namespace xrpl { namespace Resource { diff --git a/src/libxrpl/resource/ResourceManager.cpp b/src/libxrpl/resource/ResourceManager.cpp index 1e7aadfa8d..7d7dee315b 100644 --- a/src/libxrpl/resource/ResourceManager.cpp +++ b/src/libxrpl/resource/ResourceManager.cpp @@ -1,3 +1,5 @@ +#include + #include #include #include @@ -8,7 +10,6 @@ #include #include #include -#include #include #include @@ -50,7 +51,7 @@ public: ~ManagerImp() override { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); stop_ = true; cond_.notify_one(); } diff --git a/src/libxrpl/server/InfoSub.cpp b/src/libxrpl/server/InfoSub.cpp index 5857e4d6ae..30686dfe7e 100644 --- a/src/libxrpl/server/InfoSub.cpp +++ b/src/libxrpl/server/InfoSub.cpp @@ -1,5 +1,13 @@ #include +#include +#include +#include + +#include +#include +#include + namespace xrpl { // This is the primary interface into the "client" portion of the program. @@ -65,7 +73,7 @@ InfoSub::onSendEmpty() void InfoSub::insertSubAccountInfo(AccountID const& account, bool rt) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (rt) { @@ -80,7 +88,7 @@ InfoSub::insertSubAccountInfo(AccountID const& account, bool rt) void InfoSub::deleteSubAccountInfo(AccountID const& account, bool rt) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (rt) { @@ -95,14 +103,14 @@ InfoSub::deleteSubAccountInfo(AccountID const& account, bool rt) bool InfoSub::insertSubAccountHistory(AccountID const& account) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); return accountHistorySubscriptions_.insert(account).second; } void InfoSub::deleteSubAccountHistory(AccountID const& account) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); accountHistorySubscriptions_.erase(account); } diff --git a/src/libxrpl/server/JSONRPCUtil.cpp b/src/libxrpl/server/JSONRPCUtil.cpp index db2ea450a2..280aeeeebc 100644 --- a/src/libxrpl/server/JSONRPCUtil.cpp +++ b/src/libxrpl/server/JSONRPCUtil.cpp @@ -1,9 +1,10 @@ +#include + #include #include #include #include #include -#include #include #include diff --git a/src/libxrpl/server/LoadFeeTrack.cpp b/src/libxrpl/server/LoadFeeTrack.cpp index e206b50863..53fbb8cb84 100644 --- a/src/libxrpl/server/LoadFeeTrack.cpp +++ b/src/libxrpl/server/LoadFeeTrack.cpp @@ -1,18 +1,22 @@ +#include + #include #include #include #include -#include +#include #include #include +#include +#include namespace xrpl { bool LoadFeeTrack::raiseLocalFee() { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); if (++raiseCount_ < 2) return false; @@ -37,7 +41,7 @@ LoadFeeTrack::raiseLocalFee() bool LoadFeeTrack::lowerLocalFee() { - std::lock_guard sl(lock_); + std::lock_guard const sl(lock_); std::uint32_t const origFee = localTxnLoadFee_; raiseCount_ = 0; diff --git a/src/libxrpl/server/Manifest.cpp b/src/libxrpl/server/Manifest.cpp index 4526bf6c16..ca1835a929 100644 --- a/src/libxrpl/server/Manifest.cpp +++ b/src/libxrpl/server/Manifest.cpp @@ -1,17 +1,43 @@ +#include + +#include #include +#include #include #include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include #include +#include #include -#include #include #include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include namespace xrpl { @@ -279,7 +305,7 @@ loadValidatorToken(std::vector const& blob, beast::Journal journal) std::optional ManifestCache::getSigningKey(PublicKey const& pk) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; auto const iter = map_.find(pk); if (iter != map_.end() && !iter->second.revoked()) @@ -291,7 +317,7 @@ ManifestCache::getSigningKey(PublicKey const& pk) const PublicKey ManifestCache::getMasterKey(PublicKey const& pk) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; if (auto const iter = signingToMasterKeys_.find(pk); iter != signingToMasterKeys_.end()) return iter->second; @@ -302,7 +328,7 @@ ManifestCache::getMasterKey(PublicKey const& pk) const std::optional ManifestCache::getSequence(PublicKey const& pk) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; auto const iter = map_.find(pk); if (iter != map_.end() && !iter->second.revoked()) @@ -314,7 +340,7 @@ ManifestCache::getSequence(PublicKey const& pk) const std::optional ManifestCache::getDomain(PublicKey const& pk) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; auto const iter = map_.find(pk); if (iter != map_.end() && !iter->second.revoked()) @@ -326,7 +352,7 @@ ManifestCache::getDomain(PublicKey const& pk) const std::optional ManifestCache::getManifest(PublicKey const& pk) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; auto const iter = map_.find(pk); if (iter != map_.end() && !iter->second.revoked()) @@ -338,7 +364,7 @@ ManifestCache::getManifest(PublicKey const& pk) const bool ManifestCache::revoked(PublicKey const& pk) const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; auto const iter = map_.find(pk); if (iter != map_.end()) @@ -437,12 +463,12 @@ ManifestCache::applyManifest(Manifest m) }; { - std::shared_lock sl{mutex_}; + std::shared_lock const sl{mutex_}; if (auto d = prewriteCheck(map_.find(m.masterKey), /*checkSig*/ true, sl)) return *d; } - std::unique_lock sl{mutex_}; + std::unique_lock const sl{mutex_}; auto const iter = map_.find(m.masterKey); // Since we released the previously held read lock, it's possible that the // collections have been written to. This means we need to run @@ -562,7 +588,7 @@ ManifestCache::save( std::string const& dbTable, std::function const& isTrusted) { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; auto db = dbCon.checkoutDb(); saveManifests(*db, dbTable, isTrusted, map_, j_); diff --git a/src/libxrpl/server/Port.cpp b/src/libxrpl/server/Port.cpp index 2d0b4ec257..99466446d6 100644 --- a/src/libxrpl/server/Port.cpp +++ b/src/libxrpl/server/Port.cpp @@ -1,10 +1,11 @@ +#include + #include #include #include #include #include #include -#include #include #include @@ -17,7 +18,6 @@ #include #include #include -#include #include #include diff --git a/src/libxrpl/server/State.cpp b/src/libxrpl/server/State.cpp index a7c0c0fca2..3d2ed37e98 100644 --- a/src/libxrpl/server/State.cpp +++ b/src/libxrpl/server/State.cpp @@ -1,5 +1,20 @@ #include +#include +#include +#include +#include + +#include + +#include +#include +#include + +#include +#include +#include + namespace xrpl { void diff --git a/src/libxrpl/server/Vacuum.cpp b/src/libxrpl/server/Vacuum.cpp index 89764b777a..d0e430ead9 100644 --- a/src/libxrpl/server/Vacuum.cpp +++ b/src/libxrpl/server/Vacuum.cpp @@ -1,18 +1,29 @@ #include -#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep + +#include + +#include #include +#include namespace xrpl { bool doVacuumDB(DatabaseCon::Setup const& setup, beast::Journal j) { - boost::filesystem::path dbPath = setup.dataDir / TxDBName; + boost::filesystem::path const dbPath = setup.dataDir / TxDBName; uintmax_t const dbSize = file_size(dbPath); - XRPL_ASSERT(dbSize != static_cast(-1), "ripple:doVacuumDB : file_size succeeded"); + XRPL_ASSERT(dbSize != static_cast(-1), "xrpl::doVacuumDB : file_size succeeded"); if (auto available = space(dbPath.parent_path()).available; available < dbSize) { @@ -36,7 +47,7 @@ doVacuumDB(DatabaseCon::Setup const& setup, beast::Journal j) std::cout << "VACUUM beginning. page_size: " << pageSize << std::endl; session << "VACUUM;"; - XRPL_ASSERT(setup.globalPragma, "ripple:doVacuumDB : non-null global pragma"); + XRPL_ASSERT(setup.globalPragma, "xrpl::doVacuumDB : non-null global pragma"); for (auto const& p : *setup.globalPragma) session << p; session << "PRAGMA page_size;", soci::into(pageSize); diff --git a/src/libxrpl/server/Wallet.cpp b/src/libxrpl/server/Wallet.cpp index 95c2e89a20..89aa246dcf 100644 --- a/src/libxrpl/server/Wallet.cpp +++ b/src/libxrpl/server/Wallet.cpp @@ -1,7 +1,37 @@ -#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -199,13 +229,13 @@ bool createFeatureVotes(soci::session& session) { soci::transaction tr(session); - std::string sql = + std::string const sql = "SELECT count(*) FROM sqlite_master " "WHERE type='table' AND name='FeatureVotes'"; // SOCI requires boost::optional (not std::optional) as the parameter. boost::optional featureVotesCount; session << sql, soci::into(featureVotesCount); - bool exists = static_cast(*featureVotesCount); + bool const exists = static_cast(*featureVotesCount); // Create FeatureVotes table in WalletDB if it doesn't exist if (!exists) @@ -232,8 +262,8 @@ readAmendments( return safe_cast(dbVote.value_or(1)); }; - soci::transaction tr(session); - std::string sql = + soci::transaction const tr(session); + std::string const sql = "SELECT AmendmentHash, AmendmentName, Veto FROM " "( SELECT AmendmentHash, AmendmentName, Veto, RANK() OVER " "( PARTITION BY AmendmentHash ORDER BY ROWID DESC ) " diff --git a/src/libxrpl/shamap/SHAMap.cpp b/src/libxrpl/shamap/SHAMap.cpp index 8a853e4d1b..e898a80f80 100644 --- a/src/libxrpl/shamap/SHAMap.cpp +++ b/src/libxrpl/shamap/SHAMap.cpp @@ -1,13 +1,43 @@ -#include +#include + +#include // IWYU pragma: keep +#include // IWYU pragma: keep +#include +#include +#include +#include // IWYU pragma: keep +#include #include #include -#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include #include +#include #include #include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { [[nodiscard]] intr_ptr::SharedPtr @@ -85,11 +115,11 @@ SHAMap::dirtyUp( while (!stack.empty()) { auto node = intr_ptr::dynamic_pointer_cast(stack.top().first); - SHAMapNodeID nodeID = stack.top().second; + SHAMapNodeID const nodeID = stack.top().second; stack.pop(); XRPL_ASSERT(node, "xrpl::SHAMap::dirtyUp : non-null node"); - int branch = selectBranch(nodeID, target); + int const branch = selectBranch(nodeID, target); XRPL_ASSERT(branch >= 0, "xrpl::SHAMap::dirtyUp : valid branch"); node = unshareNode(std::move(node), nodeID); @@ -129,7 +159,7 @@ SHAMap::walkTowardsKey(uint256 const& id, SharedPtrNodeStack* stack) const SHAMapLeafNode* SHAMap::findKey(uint256 const& id) const { - SHAMapLeafNode* leaf = walkTowardsKey(id); + SHAMapLeafNode* leaf = walkTowardsKey(id); // NOLINT(misc-const-correctness) if ((leaf != nullptr) && leaf->peekItem()->key() != id) leaf = nullptr; return leaf; @@ -253,7 +283,7 @@ SHAMap::fetchNode(SHAMapHash const& hash) const SHAMapTreeNode* SHAMap::descendThrow(SHAMapInnerNode* parent, int branch) const { - SHAMapTreeNode* ret = descend(parent, branch); + SHAMapTreeNode* ret = descend(parent, branch); // NOLINT(misc-const-correctness) if ((ret == nullptr) && !parent->isEmptyBranch(branch)) Throw(type_, parent->getChildHash(branch)); @@ -275,7 +305,7 @@ SHAMap::descendThrow(SHAMapInnerNode& parent, int branch) const SHAMapTreeNode* SHAMap::descend(SHAMapInnerNode* parent, int branch) const { - SHAMapTreeNode* ret = parent->getChildPointer(branch); + SHAMapTreeNode* ret = parent->getChildPointer(branch); // NOLINT(misc-const-correctness) if ((ret != nullptr) || !backed_) return ret; @@ -326,7 +356,7 @@ SHAMap::descend( XRPL_ASSERT( !parent->isEmptyBranch(branch), "xrpl::SHAMap::descend : parent branch is non-empty"); - SHAMapTreeNode* child = parent->getChildPointer(branch); + SHAMapTreeNode* child = parent->getChildPointer(branch); // NOLINT(misc-const-correctness) if (child == nullptr) { @@ -353,7 +383,7 @@ SHAMap::descendAsync( { pending = false; - SHAMapTreeNode* ret = parent->getChildPointer(branch); + SHAMapTreeNode* ret = parent->getChildPointer(branch); // NOLINT(misc-const-correctness) if (ret != nullptr) return ret; @@ -513,7 +543,7 @@ SHAMapLeafNode const* SHAMap::peekFirstItem(SharedPtrNodeStack& stack) const { XRPL_ASSERT(stack.empty(), "xrpl::SHAMap::peekFirstItem : empty stack input"); - SHAMapLeafNode* node = firstBelow(root_, stack); + SHAMapLeafNode const* node = firstBelow(root_, stack); if (node == nullptr) { while (!stack.empty()) @@ -555,7 +585,7 @@ SHAMap::peekNextItem(uint256 const& id, SharedPtrNodeStack& stack) const boost::intrusive_ptr const& SHAMap::peekItem(uint256 const& id) const { - SHAMapLeafNode* leaf = findKey(id); + SHAMapLeafNode const* leaf = findKey(id); if (leaf == nullptr) return no_item; @@ -566,7 +596,7 @@ SHAMap::peekItem(uint256 const& id) const boost::intrusive_ptr const& SHAMap::peekItem(uint256 const& id, SHAMapHash& hash) const { - SHAMapLeafNode* leaf = findKey(id); + SHAMapLeafNode const* leaf = findKey(id); if (leaf == nullptr) return no_item; @@ -667,7 +697,7 @@ SHAMap::delItem(uint256 const& id) if (!leaf || (leaf->peekItem()->key() != id)) return false; - SHAMapNodeType type = leaf->getType(); + SHAMapNodeType const type = leaf->getType(); using TreeNodeType = intr_ptr::SharedPtr; @@ -677,7 +707,7 @@ SHAMap::delItem(uint256 const& id) while (!stack.empty()) { auto node = intr_ptr::static_pointer_cast(stack.top().first); - SHAMapNodeID nodeID = stack.top().second; + SHAMapNodeID const nodeID = stack.top().second; stack.pop(); node = unshareNode(std::move(node), nodeID); @@ -741,7 +771,7 @@ SHAMap::addGiveItem(SHAMapNodeType type, boost::intrusive_ptr XRPL_ASSERT(type != SHAMapNodeType::tnINNER, "xrpl::SHAMap::addGiveItem : valid type input"); // add the specified item, does not update - uint256 tag = item->key(); + uint256 const tag = item->key(); SharedPtrNodeStack stack; walkTowardsKey(tag, &stack); @@ -763,7 +793,7 @@ SHAMap::addGiveItem(SHAMapNodeType type, boost::intrusive_ptr { // easy case, we end on an inner node auto inner = intr_ptr::static_pointer_cast(node); - int branch = selectBranch(nodeID, tag); + int const branch = selectBranch(nodeID, tag); XRPL_ASSERT( inner->isEmptyBranch(branch), "xrpl::SHAMap::addGiveItem : inner branch is empty"); inner->setChild(branch, makeTypedLeaf(type, std::move(item), cowid_)); @@ -825,7 +855,7 @@ bool SHAMap::updateGiveItem(SHAMapNodeType type, boost::intrusive_ptr item) { // can't change the tag but can change the hash - uint256 tag = item->key(); + uint256 const tag = item->key(); XRPL_ASSERT(state_ != SHAMapState::Immutable, "xrpl::SHAMap::updateGiveItem : not immutable"); @@ -1007,7 +1037,7 @@ SHAMap::walkSubTree(bool doWrite, NodeObjectType t) { // No need to do I/O. If the node isn't linked, // it can't need to be flushed - int branch = pos; + int const branch = pos; auto child = node->getChild(pos++); if (child && (child->cowid() != 0)) diff --git a/src/libxrpl/shamap/SHAMapDelta.cpp b/src/libxrpl/shamap/SHAMapDelta.cpp index 0b5a09d4a7..4557d004a8 100644 --- a/src/libxrpl/shamap/SHAMapDelta.cpp +++ b/src/libxrpl/shamap/SHAMapDelta.cpp @@ -1,10 +1,23 @@ -#include +#include // IWYU pragma: keep +#include // IWYU pragma: keep +#include #include #include +#include #include +#include +#include +#include +#include + +#include #include +#include +#include #include +#include +#include #include namespace xrpl { @@ -241,14 +254,14 @@ SHAMap::walkMap(std::vector& missingNodes, int maxMissing) co while (!nodeStack.empty()) { - intr_ptr::SharedPtr node = std::move(nodeStack.top()); + intr_ptr::SharedPtr const node = std::move(nodeStack.top()); nodeStack.pop(); for (int i = 0; i < 16; ++i) { if (!node->isEmptyBranch(i)) { - intr_ptr::SharedPtr nextNode = descendNoStore(*node, i); + intr_ptr::SharedPtr const nextNode = descendNoStore(*node, i); if (nextNode) { @@ -310,7 +323,8 @@ SHAMap::walkMapParallel(std::vector& missingNodes, int maxMis { while (!nodeStack.empty()) { - intr_ptr::SharedPtr node = std::move(nodeStack.top()); + intr_ptr::SharedPtr const node = + std::move(nodeStack.top()); XRPL_ASSERT(node, "xrpl::SHAMap::walkMapParallel : non-null node"); nodeStack.pop(); @@ -318,7 +332,7 @@ SHAMap::walkMapParallel(std::vector& missingNodes, int maxMis { if (node->isEmptyBranch(i)) continue; - intr_ptr::SharedPtr nextNode = + intr_ptr::SharedPtr const nextNode = descendNoStore(*node, i); if (nextNode) @@ -332,7 +346,7 @@ SHAMap::walkMapParallel(std::vector& missingNodes, int maxMis } else { - std::lock_guard l{m}; + std::lock_guard const l{m}; missingNodes.emplace_back(type_, node->getChildHash(i)); if (--maxMissing <= 0) return; @@ -342,7 +356,7 @@ SHAMap::walkMapParallel(std::vector& missingNodes, int maxMis } catch (SHAMapMissingNode const& e) { - std::lock_guard l(m); + std::lock_guard const l(m); exceptions.push_back(e); } }, @@ -352,7 +366,7 @@ SHAMap::walkMapParallel(std::vector& missingNodes, int maxMis for (std::thread& worker : workers) worker.join(); - std::lock_guard l(m); + std::lock_guard const l(m); if (exceptions.empty()) return true; std::stringstream ss; diff --git a/src/libxrpl/shamap/SHAMapInnerNode.cpp b/src/libxrpl/shamap/SHAMapInnerNode.cpp index 599d343745..e501561ee4 100644 --- a/src/libxrpl/shamap/SHAMapInnerNode.cpp +++ b/src/libxrpl/shamap/SHAMapInnerNode.cpp @@ -1,13 +1,30 @@ -#include +#include + +#include // IWYU pragma: keep +#include // IWYU pragma: keep +#include #include +#include #include #include +#include #include +#include #include -#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { SHAMapInnerNode::SHAMapInnerNode(std::uint32_t cowid, std::uint8_t numAllocatedChildren) @@ -82,7 +99,7 @@ SHAMapInnerNode::clone(std::uint32_t cowid) const } spinlock sl(lock_); - std::lock_guard lock(sl); + std::lock_guard const lock(sl); if (thisIsSparse) { @@ -313,7 +330,7 @@ SHAMapInnerNode::getChildPointer(int branch) auto const index = *getChildIndex(branch); packed_spinlock sl(lock_, index); - std::lock_guard lock(sl); + std::lock_guard const lock(sl); return hashesAndChildren_.getChildren()[index].get(); } @@ -328,7 +345,7 @@ SHAMapInnerNode::getChild(int branch) auto const index = *getChildIndex(branch); packed_spinlock sl(lock_, index); - std::lock_guard lock(sl); + std::lock_guard const lock(sl); return hashesAndChildren_.getChildren()[index]; } @@ -361,7 +378,7 @@ SHAMapInnerNode::canonicalizeChild(int branch, intr_ptr::SharedPtr +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include + namespace xrpl { SHAMapLeafNode::SHAMapLeafNode(boost::intrusive_ptr item, std::uint32_t cowid) diff --git a/src/libxrpl/shamap/SHAMapNodeID.cpp b/src/libxrpl/shamap/SHAMapNodeID.cpp index 97a8b26a3b..c2d93f20ee 100644 --- a/src/libxrpl/shamap/SHAMapNodeID.cpp +++ b/src/libxrpl/shamap/SHAMapNodeID.cpp @@ -1,8 +1,15 @@ -#include +#include + +#include +#include #include #include #include -#include + +#include +#include +#include +#include namespace xrpl { @@ -87,7 +94,7 @@ deserializeSHAMapNodeID(void const* data, std::size_t size) if (size == 33) { - unsigned int depth = *(static_cast(data) + 32); + unsigned int const depth = *(static_cast(data) + 32); if (depth <= SHAMap::leafDepth) { auto const id = uint256::fromVoid(data); diff --git a/src/libxrpl/shamap/SHAMapSync.cpp b/src/libxrpl/shamap/SHAMapSync.cpp index 14ccdca2eb..f0e364a0f9 100644 --- a/src/libxrpl/shamap/SHAMapSync.cpp +++ b/src/libxrpl/shamap/SHAMapSync.cpp @@ -1,8 +1,33 @@ +#include +#include +#include +#include +#include #include #include +#include +#include #include +#include +#include +#include #include +#include #include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -41,7 +66,7 @@ SHAMap::visitNodes(std::function const& function) const { if (!node->isEmptyBranch(pos)) { - intr_ptr::SharedPtr child = descendNoStore(*node, pos); + intr_ptr::SharedPtr const child = descendNoStore(*node, pos); if (!function(*child)) return; @@ -124,7 +149,7 @@ SHAMap::visitDifferences( if (!node->isEmptyBranch(i)) { auto const& childHash = node->getChildHash(i); - SHAMapNodeID childID = nodeID.getChildNodeID(i); + SHAMapNodeID const childID = nodeID.getChildNodeID(i); auto next = descendThrow(node, i); if (next->isInner()) @@ -160,7 +185,7 @@ SHAMap::gmn_ProcessNodes(MissingNodes& mn, MissingNodes::StackEntry& se) while (currentChild < 16) { - int branch = (firstChild + currentChild++) % 16; + int const branch = (firstChild + currentChild++) % 16; if (node->isEmptyBranch(branch)) continue; @@ -182,7 +207,7 @@ SHAMap::gmn_ProcessNodes(MissingNodes& mn, MissingNodes::StackEntry& se) [node, nodeID, branch, &mn]( intr_ptr::SharedPtr found, SHAMapHash const&) { // a read completed asynchronously - std::unique_lock lock{mn.deferLock_}; + std::unique_lock const lock{mn.deferLock_}; mn.finishedReads_.emplace_back(node, nodeID, branch, std::move(found)); mn.deferCondVar_.notify_one(); }); @@ -327,7 +352,7 @@ SHAMap::getMissingNodes(int max, SHAMapSyncFilter* filter) if ((node == nullptr) && !mn.stack_.empty()) { // Pick up where we left off with this node's parent - bool was = fullBelow; // was full below + bool const was = fullBelow; // was full below pos = mn.stack_.top(); mn.stack_.pop(); @@ -404,7 +429,7 @@ SHAMap::getNodeFat( while ((node != nullptr) && node->isInner() && (nodeID.getDepth() < wanted.getDepth())) { - int branch = selectBranch(nodeID, wanted.getNodeID()); + int const branch = selectBranch(nodeID, wanted.getNodeID()); auto inner = safe_downcast(node); if (inner->isEmptyBranch(branch)) return false; @@ -445,7 +470,7 @@ SHAMap::getNodeFat( // We descend inner nodes with only a single child // without decrementing the depth auto inner = safe_downcast(node); - int bc = inner->getBranchCount(); + int const bc = inner->getBranchCount(); if ((depth > 0) || (bc == 1)) { @@ -709,7 +734,7 @@ SHAMap::hasInnerNode(SHAMapNodeID const& targetNodeID, SHAMapHash const& targetN while (node->isInner() && (nodeID.getDepth() < targetNodeID.getDepth())) { - int branch = selectBranch(nodeID, targetNodeID.getNodeID()); + int const branch = selectBranch(nodeID, targetNodeID.getNodeID()); auto inner = safe_downcast(node); if (inner->isEmptyBranch(branch)) return false; @@ -734,7 +759,7 @@ SHAMap::hasLeafNode(uint256 const& tag, SHAMapHash const& targetNodeHash) const do { - int branch = selectBranch(nodeID, tag); + int const branch = selectBranch(nodeID, tag); auto inner = safe_downcast(node); if (inner->isEmptyBranch(branch)) return false; // Dead end, node must not be here diff --git a/src/libxrpl/shamap/SHAMapTreeNode.cpp b/src/libxrpl/shamap/SHAMapTreeNode.cpp index 9497b4dc54..6fc7bd81e4 100644 --- a/src/libxrpl/shamap/SHAMapTreeNode.cpp +++ b/src/libxrpl/shamap/SHAMapTreeNode.cpp @@ -1,15 +1,28 @@ -#include +#include + +#include // IWYU pragma: keep +#include // IWYU pragma: keep +#include #include +#include #include #include #include +#include #include #include #include -#include +#include +#include #include #include +#include +#include +#include +#include +#include + namespace xrpl { intr_ptr::SharedPtr diff --git a/src/libxrpl/tx/ApplyContext.cpp b/src/libxrpl/tx/ApplyContext.cpp index a73b163ac5..e34103952d 100644 --- a/src/libxrpl/tx/ApplyContext.cpp +++ b/src/libxrpl/tx/ApplyContext.cpp @@ -1,10 +1,28 @@ #include -// + #include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { ApplyContext::ApplyContext( @@ -98,7 +116,7 @@ ApplyContext::checkInvariantsHelper( // short-circuits). While the logic is still correct, the log // message won't be. Every failed invariant should write to the log, // not just the first one. - std::array finalizers{ + std::array const finalizers{ {std::get(checkers).finalize(tx, result, fee, *view_, journal)...}}; // call each check's finalizer to see that it passes diff --git a/src/libxrpl/tx/SignerEntries.cpp b/src/libxrpl/tx/SignerEntries.cpp index 75659a7f04..a1883024d9 100644 --- a/src/libxrpl/tx/SignerEntries.cpp +++ b/src/libxrpl/tx/SignerEntries.cpp @@ -1,11 +1,20 @@ +#include + +#include #include +#include +#include +#include +#include #include #include #include -#include +#include #include #include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/Transactor.cpp b/src/libxrpl/tx/Transactor.cpp index e029c71f4f..8d9d0b6201 100644 --- a/src/libxrpl/tx/Transactor.cpp +++ b/src/libxrpl/tx/Transactor.cpp @@ -1,23 +1,52 @@ +#include + +#include +#include +#include +#include #include +#include +#include #include -#include -#include +#include +#include // IWYU pragma: keep +#include +#include #include #include +#include +#include #include #include +#include #include +#include #include +#include #include +#include +#include +#include +#include +#include #include +#include #include -#include +#include +#include #include +#include #include -#include #include -#include -#include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -34,7 +63,7 @@ preflight0(PreflightContext const& ctx, std::uint32_t flagMask) if (!isPseudoTx(ctx.tx) || ctx.tx.isFieldPresent(sfNetworkID)) { - uint32_t nodeNID = ctx.registry.get().getNetworkIDService().getNetworkID(); + uint32_t const nodeNID = ctx.registry.get().getNetworkIDService().getNetworkID(); std::optional txNID = ctx.tx[~sfNetworkID]; if (nodeNID <= 1024) @@ -363,6 +392,13 @@ Transactor::checkFee(PreclaimContext const& ctx, XRPAmount baseFee) auto const balance = (*sle)[sfBalance].xrp(); + // NOTE: Because preclaim evaluates against a static readview, it + // does not reflect fee deductions from other transactions paid by + // the same account within the current ledger. + // As a result, if an account's balance is over-committed across multiple + // transactions, this check may pass optimistically. + // The fee shortfall will be handled by the Transactor::reset mechanism, + // which caps the fee to the remaining actual balance. if (balance < feePaid) { JLOG(ctx.j.trace()) << "Insufficient balance:" << " balance=" << to_string(balance) @@ -777,7 +813,7 @@ Transactor::checkMultiSign( beast::Journal const j) { // Get id's SignerList and Quorum. - std::shared_ptr sleAccountSigners = view.read(keylet::signers(id)); + std::shared_ptr const sleAccountSigners = view.read(keylet::signers(id)); // If the signer list doesn't exist the account is not multi-signing. if (!sleAccountSigners) { @@ -999,6 +1035,26 @@ removeDeletedTrustLines( } } +static void +removeDeletedMPTs(ApplyView& view, std::vector const& mpts, beast::Journal viewJ) +{ + // There could be at most two MPTs - one for each side of AMM pool + if (mpts.size() > 2) + { + JLOG(viewJ.error()) << "removeDeletedMPTs: deleted mpts exceed 2 " << mpts.size(); + return; + } + + for (auto const& index : mpts) + { + if (auto const sleState = view.peek({ltMPTOKEN, index}); sleState && + deleteAMMMPToken(view, sleState, (*sleState)[sfIssuer], viewJ) != tesSUCCESS) + { + JLOG(viewJ.error()) << "removeDeletedMPTs: failed to delete AMM MPT"; + } + } +} + /** Reset the context, discarding any changes made and adjust the fee. @param fee The transaction fee to be charged. @@ -1125,15 +1181,15 @@ Transactor::operator()() // // raii classes for the current ledger rules. // fixUniversalNumber predate the rulesGuard and should be replaced. - NumberSO stNumberSO{view().rules().enabled(fixUniversalNumber)}; - CurrentTransactionRulesGuard currentTransactionRulesGuard(view().rules()); + NumberSO const stNumberSO{view().rules().enabled(fixUniversalNumber)}; + CurrentTransactionRulesGuard const currentTransactionRulesGuard(view().rules()); #ifdef DEBUG { Serializer ser; ctx_.tx.add(ser); SerialIter sit(ser.slice()); - STTx s2(sit); + STTx const s2(sit); if (!s2.isEquivalent(ctx_.tx)) { @@ -1189,19 +1245,21 @@ Transactor::operator()() // when transactions fail with a `tec` code. std::vector removedOffers; std::vector removedTrustLines; + std::vector removedMPTs; std::vector expiredNFTokenOffers; std::vector expiredCredentials; bool const doOffers = ((result == tecOVERSIZE) || (result == tecKILLED)); - bool const doLines = (result == tecINCOMPLETE); + bool const doLinesOrMPTs = (result == tecINCOMPLETE); bool const doNFTokenOffers = (result == tecEXPIRED); bool const doCredentials = (result == tecEXPIRED); - if (doOffers || doLines || doNFTokenOffers || doCredentials) + if (doOffers || doLinesOrMPTs || doNFTokenOffers || doCredentials) { ctx_.visit([doOffers, &removedOffers, - doLines, + doLinesOrMPTs, &removedTrustLines, + &removedMPTs, doNFTokenOffers, &expiredNFTokenOffers, doCredentials, @@ -1223,10 +1281,17 @@ Transactor::operator()() removedOffers.push_back(index); } - if (doLines && before && after && (before->getType() == ltRIPPLE_STATE)) + if (doLinesOrMPTs && before && after) { // Removal of obsolete AMM trust line - removedTrustLines.push_back(index); + if (before->getType() == ltRIPPLE_STATE) + { + removedTrustLines.push_back(index); + } + else if (before->getType() == ltMPTOKEN) + { + removedMPTs.push_back(index); + } } if (doNFTokenOffers && before && after && @@ -1264,6 +1329,7 @@ Transactor::operator()() { removeDeletedTrustLines( view(), removedTrustLines, ctx_.registry.get().getJournal("View")); + removeDeletedMPTs(view(), removedMPTs, ctx_.registry.get().getJournal("View")); } if (result == tecEXPIRED) diff --git a/src/libxrpl/tx/apply.cpp b/src/libxrpl/tx/apply.cpp index caf716eda6..65c9649035 100644 --- a/src/libxrpl/tx/apply.cpp +++ b/src/libxrpl/tx/apply.cpp @@ -1,11 +1,28 @@ +#include + #include +#include +#include +#include #include #include +#include +#include #include +#include +#include +#include +#include +#include +#include #include -#include +#include #include +#include +#include +#include + namespace xrpl { // These are the same flags defined as HashRouterFlags::PRIVATE1-4 in @@ -116,7 +133,7 @@ template ApplyResult apply(ServiceRegistry& registry, OpenView& view, PreflightChecks&& preflightChecks) { - NumberSO stNumberSO{view.rules().enabled(fixUniversalNumber)}; + NumberSO const stNumberSO{view.rules().enabled(fixUniversalNumber)}; return doApply(preclaim(preflightChecks(), registry, view), registry, view); } diff --git a/src/libxrpl/tx/applySteps.cpp b/src/libxrpl/tx/applySteps.cpp index 67e679a6ec..59377e681a 100644 --- a/src/libxrpl/tx/applySteps.cpp +++ b/src/libxrpl/tx/applySteps.cpp @@ -1,4 +1,26 @@ #include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #pragma push_macro("TRANSACTION") #undef TRANSACTION @@ -17,8 +39,6 @@ #include #include -#include - namespace xrpl { namespace { @@ -95,34 +115,31 @@ with_txn_type(Rules const& rules, TxType txnType, F&& f) // For Transactor::Normal // -// clang-format off -// Current formatter for rippled is based on clang-10, which does not handle `requires` clauses template -requires(T::ConsequencesFactory == Transactor::Normal) + requires(T::ConsequencesFactory == Transactor::Normal) TxConsequences - consequences_helper(PreflightContext const& ctx) +consequences_helper(PreflightContext const& ctx) { return TxConsequences(ctx.tx); }; // For Transactor::Blocker template -requires(T::ConsequencesFactory == Transactor::Blocker) + requires(T::ConsequencesFactory == Transactor::Blocker) TxConsequences - consequences_helper(PreflightContext const& ctx) +consequences_helper(PreflightContext const& ctx) { return TxConsequences(ctx.tx, TxConsequences::blocker); }; // For Transactor::Custom template -requires(T::ConsequencesFactory == Transactor::Custom) + requires(T::ConsequencesFactory == Transactor::Custom) TxConsequences - consequences_helper(PreflightContext const& ctx) +consequences_helper(PreflightContext const& ctx) { return T::makeTxConsequences(ctx); }; -// clang-format on static std::pair invoke_preflight(PreflightContext const& ctx) diff --git a/src/libxrpl/tx/invariants/AMMInvariant.cpp b/src/libxrpl/tx/invariants/AMMInvariant.cpp index 96df97016f..3cc888dea2 100644 --- a/src/libxrpl/tx/invariants/AMMInvariant.cpp +++ b/src/libxrpl/tx/invariants/AMMInvariant.cpp @@ -1,10 +1,26 @@ #include -// + #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include -#include +#include + +#include +#include namespace xrpl { @@ -128,15 +144,16 @@ ValidAMM::finalizeCreate( auto const [amount, amount2] = ammPoolHolds( view, *ammAccount_, - tx[sfAmount].get(), - tx[sfAmount2].get(), + tx[sfAmount].asset(), + tx[sfAmount2].asset(), fhIGNORE_FREEZE, + ahIGNORE_AUTH, j); // Create invariant: // sqrt(amount * amount2) == LPTokens // all balances are greater than zero if (!validBalances(amount, amount2, *lptAMMBalanceAfter_, ZeroAllowed::No) || - ammLPTokens(amount, amount2, lptAMMBalanceAfter_->issue()) != *lptAMMBalanceAfter_) + ammLPTokens(amount, amount2, lptAMMBalanceAfter_->get()) != *lptAMMBalanceAfter_) { JLOG(j.error()) << "AMMCreate invariant failed: " << amount << " " << amount2 << " " << *lptAMMBalanceAfter_; @@ -188,12 +205,7 @@ ValidAMM::generalInvariant( beast::Journal const& j) const { auto const [amount, amount2] = ammPoolHolds( - view, - *ammAccount_, - tx[sfAsset].get(), - tx[sfAsset2].get(), - fhIGNORE_FREEZE, - j); + view, *ammAccount_, tx[sfAsset], tx[sfAsset2], fhIGNORE_FREEZE, ahIGNORE_AUTH, j); // Deposit and Withdrawal invariant: // sqrt(amount * amount2) >= LPTokens // all balances are greater than zero diff --git a/src/libxrpl/tx/invariants/FreezeInvariant.cpp b/src/libxrpl/tx/invariants/FreezeInvariant.cpp index c8723b9bbf..9dcd60d0d6 100644 --- a/src/libxrpl/tx/invariants/FreezeInvariant.cpp +++ b/src/libxrpl/tx/invariants/FreezeInvariant.cpp @@ -1,11 +1,24 @@ #include -// + #include +#include #include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include + namespace xrpl { void @@ -68,7 +81,7 @@ TransfersNotFrozen::finalize( { auto const issuerSle = findIssuer(issue.account, view); // It should be impossible for the issuer to not be found, but check - // just in case so rippled doesn't crash in release. + // just in case so xrpld doesn't crash in release. if (!issuerSle) { // The comment above starting with "assert(enforce)" explains this @@ -127,7 +140,7 @@ TransfersNotFrozen::calculateBalanceChange( bool isDelete) { auto const getBalance = [](auto const& line, auto const& other, bool zero) { - STAmount amt = line ? line->at(sfBalance) : other->at(sfBalance).zeroed(); + STAmount const amt = line ? line->at(sfBalance) : other->at(sfBalance).zeroed(); return zero ? amt.zeroed() : amt; }; @@ -172,7 +185,7 @@ TransfersNotFrozen::recordBalanceChanges( STAmount const& balanceChange) { auto const balanceChangeSign = balanceChange.signum(); - auto const currency = after->at(sfBalance).getCurrency(); + auto const currency = after->at(sfBalance).get().currency; // Change from low account's perspective, which is trust line default recordBalance({currency, after->at(sfHighLimit).getIssuer()}, {after, balanceChangeSign}); diff --git a/src/libxrpl/tx/invariants/InvariantCheck.cpp b/src/libxrpl/tx/invariants/InvariantCheck.cpp index bf0f65f000..f2570d14e8 100644 --- a/src/libxrpl/tx/invariants/InvariantCheck.cpp +++ b/src/libxrpl/tx/invariants/InvariantCheck.cpp @@ -1,22 +1,40 @@ #include -// + #include +#include +#include +#include #include -#include +#include #include -#include +#include +#include #include #include +#include +#include #include +#include +#include #include #include -#include +#include +#include // IWYU pragma: keep +#include #include +#include #include +#include +#include #include +#include #include +#include +#include #include +#include +#include namespace xrpl { @@ -284,25 +302,29 @@ NoZeroEscrow::visitEntry( } else { - // IOU case - if (amount.holds()) - { - if (amount <= beast::zero) - return true; + return amount.asset().visit( + [&](Issue const& issue) { + // IOU case + if (amount <= beast::zero) + return true; - if (badCurrency() == amount.getCurrency()) - return true; - } + if (badCurrency() == issue.currency) + return true; - // MPT case - if (amount.holds()) - { - if (amount <= beast::zero) - return true; + return false; + } - if (amount.mpt() > MPTAmount{maxMPTokenAmount}) - return true; // LCOV_EXCL_LINE - } + // MPT case + , + [&](MPTIssue const&) { + if (amount <= beast::zero) + return true; + + if (amount.mpt() > MPTAmount{maxMPTokenAmount}) + return true; // LCOV_EXCL_LINE + + return false; + }); } return false; }; @@ -600,8 +622,8 @@ NoXRPTrustLines::visitEntry( // checking the issue directly here instead of // relying on .native() just in case native somehow // were systematically incorrect - xrpTrustLine_ = after->getFieldAmount(sfLowLimit).issue() == xrpIssue() || - after->getFieldAmount(sfHighLimit).issue() == xrpIssue(); + xrpTrustLine_ = after->getFieldAmount(sfLowLimit).asset() == xrpIssue() || + after->getFieldAmount(sfHighLimit).asset() == xrpIssue(); } } @@ -774,17 +796,23 @@ ValidClawback::finalize( return false; } - if (trustlinesChanged == 1) + bool const mptV2Enabled = view.rules().enabled(featureMPTokensV2); + if (trustlinesChanged == 1 || (mptV2Enabled && mptokensChanged == 1)) { AccountID const issuer = tx.getAccountID(sfAccount); STAmount const& amount = tx.getFieldAmount(sfAmount); AccountID const& holder = amount.getIssuer(); - STAmount const holderBalance = - accountHolds(view, holder, amount.getCurrency(), issuer, fhIGNORE_FREEZE, j); + STAmount const holderBalance = amount.asset().visit( + [&](Issue const& issue) { + return accountHolds(view, holder, issue.currency, issuer, fhIGNORE_FREEZE, j); + }, + [&](MPTIssue const& issue) { + return accountHolds(view, issuer, issue, fhIGNORE_FREEZE, ahIGNORE_AUTH, j); + }); if (holderBalance.signum() < 0) { - JLOG(j.fatal()) << "Invariant failed: trustline balance is negative"; + JLOG(j.fatal()) << "Invariant failed: trustline or MPT balance is negative"; return false; } } diff --git a/src/libxrpl/tx/invariants/LoanBrokerInvariant.cpp b/src/libxrpl/tx/invariants/LoanBrokerInvariant.cpp index 2bc9e622ad..b72f821f50 100644 --- a/src/libxrpl/tx/invariants/LoanBrokerInvariant.cpp +++ b/src/libxrpl/tx/invariants/LoanBrokerInvariant.cpp @@ -1,13 +1,21 @@ #include -// + #include -#include -#include -#include +#include +#include +#include +#include #include #include -#include +#include +#include +#include // IWYU pragma: keep +#include +#include #include +#include + +#include namespace xrpl { @@ -175,18 +183,32 @@ ValidLoanBroker::finalize( return false; } auto const& vaultAsset = vault->at(sfAsset); - if (after->at(sfCoverAvailable) < accountHolds( - view, - after->at(sfAccount), - vaultAsset, - FreezeHandling::fhIGNORE_FREEZE, - AuthHandling::ahIGNORE_AUTH, - j)) + auto const pseudoBalance = accountHolds( + view, + after->at(sfAccount), + vaultAsset, + FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, + j); + if (after->at(sfCoverAvailable) < pseudoBalance) { JLOG(j.fatal()) << "Invariant failed: Loan Broker cover available " "is less than pseudo-account asset balance"; return false; } + + if (view.rules().enabled(fixSecurity3_1_3)) + { + // Don't check the balance when LoanBroker is deleted, + // sfCoverAvailable is not zeroed + if (tx.getTxnType() != ttLOAN_BROKER_DELETE && + after->at(sfCoverAvailable) > pseudoBalance) + { + JLOG(j.fatal()) << "Invariant failed: Loan Broker cover available is greater " + "than pseudo-account asset balance"; + return false; + } + } } return true; } diff --git a/src/libxrpl/tx/invariants/LoanInvariant.cpp b/src/libxrpl/tx/invariants/LoanInvariant.cpp index 6ce1261612..7aea36296e 100644 --- a/src/libxrpl/tx/invariants/LoanInvariant.cpp +++ b/src/libxrpl/tx/invariants/LoanInvariant.cpp @@ -1,9 +1,18 @@ #include -// + #include -#include +#include +#include +#include #include -#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/invariants/MPTInvariant.cpp b/src/libxrpl/tx/invariants/MPTInvariant.cpp index a3a5bf897d..e010b79b87 100644 --- a/src/libxrpl/tx/invariants/MPTInvariant.cpp +++ b/src/libxrpl/tx/invariants/MPTInvariant.cpp @@ -1,13 +1,26 @@ #include -// + #include +#include #include +#include +#include #include #include +#include #include +#include +#include +#include +#include +#include #include +#include #include +#include +#include + namespace xrpl { void @@ -52,11 +65,12 @@ ValidMPTIssuance::finalize( ReadView const& view, beast::Journal const& j) const { - if (isTesSuccess(result)) + auto const& rules = view.rules(); + bool const mptV2Enabled = rules.enabled(featureMPTokensV2); + if (isTesSuccess(result) || (mptV2Enabled && result == tecINCOMPLETE)) { - auto const& rules = view.rules(); [[maybe_unused]] - bool enforceCreatedByIssuer = + bool const enforceCreatedByIssuer = rules.enabled(featureSingleAssetVault) || rules.enabled(featureLendingProtocol); if (mptCreatedByIssuer_) { @@ -112,12 +126,12 @@ ValidMPTIssuance::finalize( return mptIssuancesCreated_ == 0 && mptIssuancesDeleted_ == 1; } - bool const lendingProtocolEnabled = view.rules().enabled(featureLendingProtocol); + bool const lendingProtocolEnabled = rules.enabled(featureLendingProtocol); // ttESCROW_FINISH may authorize an MPT, but it can't have the // mayAuthorizeMPT privilege, because that may cause // non-amendment-gated side effects. bool const enforceEscrowFinish = (txnType == ttESCROW_FINISH) && - (view.rules().enabled(featureSingleAssetVault) || lendingProtocolEnabled); + (rules.enabled(featureSingleAssetVault) || lendingProtocolEnabled); if (hasPrivilege(tx, mustAuthorizeMPT | mayAuthorizeMPT) || enforceEscrowFinish) { bool const submittedByIssuer = tx.isFieldPresent(sfHolder); @@ -134,19 +148,42 @@ ValidMPTIssuance::finalize( "succeeded but deleted issuances"; return false; } - if (lendingProtocolEnabled && mptokensCreated_ + mptokensDeleted_ > 1) + if (mptV2Enabled && hasPrivilege(tx, mayAuthorizeMPT) && + (txnType == ttAMM_WITHDRAW || txnType == ttAMM_CLAWBACK)) + { + if (submittedByIssuer && txnType == ttAMM_WITHDRAW && mptokensCreated_ > 0) + { + JLOG(j.fatal()) << "Invariant failed: MPT authorize " + "submitted by issuer succeeded " + "but created bad number of mptokens"; + return false; + } + // At most one MPToken may be created on withdraw/clawback since: + // - Liquidity Provider must have at least one token in order + // participate in AMM pool liquidity. + // - At most two MPTokens may be deleted if AMM pool, which has exactly + // two tokens, is empty after withdraw/clawback. + if (mptokensCreated_ > 1 || mptokensDeleted_ > 2) + { + JLOG(j.fatal()) << "Invariant failed: MPT authorize succeeded " + "but created/deleted bad number of mptokens"; + return false; + } + } + else if (lendingProtocolEnabled && (mptokensCreated_ + mptokensDeleted_) > 1) { JLOG(j.fatal()) << "Invariant failed: MPT authorize succeeded " "but created/deleted bad number mptokens"; return false; } - if (submittedByIssuer && (mptokensCreated_ > 0 || mptokensDeleted_ > 0)) + else if (submittedByIssuer && (mptokensCreated_ > 0 || mptokensDeleted_ > 0)) { JLOG(j.fatal()) << "Invariant failed: MPT authorize submitted by issuer " "succeeded but created/deleted mptokens"; return false; } - if (!submittedByIssuer && hasPrivilege(tx, mustAuthorizeMPT) && + else if ( + !submittedByIssuer && hasPrivilege(tx, mustAuthorizeMPT) && (mptokensCreated_ + mptokensDeleted_ != 1)) { // if the holder submitted this tx, then a mptoken must be @@ -158,6 +195,52 @@ ValidMPTIssuance::finalize( return true; } + + if (hasPrivilege(tx, mayCreateMPT)) + { + bool const submittedByIssuer = tx.isFieldPresent(sfHolder); + + if (mptIssuancesCreated_ > 0) + { + JLOG(j.fatal()) << "Invariant failed: MPT authorize " + "succeeded but created MPT issuances"; + return false; + } + if (mptIssuancesDeleted_ > 0) + { + JLOG(j.fatal()) << "Invariant failed: MPT authorize " + "succeeded but deleted issuances"; + return false; + } + if (mptokensDeleted_ > 0) + { + JLOG(j.fatal()) << "Invariant failed: MPT authorize " + "succeeded but deleted MPTokens"; + return false; + } + // AMMCreate may auto-create up to two MPT objects: + // - one per asset side in an MPT/MPT AMM, or one in an IOU/MPT AMM. + // CheckCash may auto-create at most one MPT object for the receiver. + if ((txnType == ttAMM_CREATE && mptokensCreated_ > 2) || + (txnType == ttCHECK_CASH && mptokensCreated_ > 1)) + { + JLOG(j.fatal()) << "Invariant failed: MPT authorize " + "succeeded but created bad number of mptokens"; + return false; + } + if (submittedByIssuer) + { + JLOG(j.fatal()) << "Invariant failed: MPT authorize submitted by issuer " + "succeeded but created mptokens"; + return false; + } + + // Offer crossing or payment may consume multiple offers + // where takerPays is MPT amount. If the offer owner doesn't + // own MPT then MPT is created automatically. + return true; + } + if (txnType == ttESCROW_FINISH) { // ttESCROW_FINISH may authorize an MPT, but it can't have the @@ -168,8 +251,9 @@ ValidMPTIssuance::finalize( return true; } - if (hasPrivilege(tx, mayDeleteMPT) && mptokensDeleted_ == 1 && mptokensCreated_ == 0 && - mptIssuancesCreated_ == 0 && mptIssuancesDeleted_ == 0) + if (hasPrivilege(tx, mayDeleteMPT) && + ((txnType == ttAMM_DELETE && mptokensDeleted_ <= 2) || mptokensDeleted_ == 1) && + mptokensCreated_ == 0 && mptIssuancesCreated_ == 0 && mptIssuancesDeleted_ == 0) return true; } @@ -194,4 +278,107 @@ ValidMPTIssuance::finalize( mptokensDeleted_ == 0; } +void +ValidMPTPayment::visitEntry( + bool, + std::shared_ptr const& before, + std::shared_ptr const& after) +{ + if (overflow_) + return; + + auto makeKey = [](SLE const& sle) { + if (sle.getType() == ltMPTOKEN_ISSUANCE) + return makeMptID(sle[sfSequence], sle[sfIssuer]); + return sle[sfMPTokenIssuanceID]; + }; + + auto update = [&](SLE const& sle, Order order) -> bool { + auto const type = sle.getType(); + if (type == ltMPTOKEN_ISSUANCE) + { + auto const outstanding = sle[sfOutstandingAmount]; + if (outstanding > maxMPTokenAmount) + { + overflow_ = true; + return false; + } + data_[makeKey(sle)].outstanding[order] = outstanding; + } + else if (type == ltMPTOKEN) + { + auto const mptAmt = sle[sfMPTAmount]; + auto const lockedAmt = sle[~sfLockedAmount].value_or(0); + if (mptAmt > maxMPTokenAmount || lockedAmt > maxMPTokenAmount || + lockedAmt > (maxMPTokenAmount - mptAmt)) + { + overflow_ = true; + return false; + } + auto const res = static_cast(mptAmt + lockedAmt); + // subtract before from after + if (order == Before) + { + data_[makeKey(sle)].mptAmount -= res; + } + else + { + data_[makeKey(sle)].mptAmount += res; + } + } + return true; + }; + + if (before && !update(*before, Before)) + return; + + if (after) + { + if (after->getType() == ltMPTOKEN_ISSUANCE) + { + overflow_ = (*after)[sfOutstandingAmount] > maxMPTAmount(*after); + } + if (!update(*after, After)) + return; + } +} + +bool +ValidMPTPayment::finalize( + STTx const& tx, + TER const result, + XRPAmount const, + ReadView const& view, + beast::Journal const& j) +{ + if (isTesSuccess(result)) + { + bool const enforce = view.rules().enabled(featureMPTokensV2); + if (overflow_) + { + JLOG(j.fatal()) << "Invariant failed: OutstandingAmount overflow"; + return !enforce; + } + + auto const signedMax = static_cast(maxMPTokenAmount); + for (auto const& [id, data] : data_) + { + (void)id; + bool const addOverflows = + (data.mptAmount > 0 && data.outstanding[Before] > (signedMax - data.mptAmount)) || + (data.mptAmount < 0 && data.outstanding[Before] < (-signedMax - data.mptAmount)); + if (addOverflows || + data.outstanding[After] != (data.outstanding[Before] + data.mptAmount)) + { + JLOG(j.fatal()) << "Invariant failed: invalid OutstandingAmount balance " + << data.outstanding[Before] << " " << data.outstanding[After] << " " + << data.mptAmount; + return !enforce; + } + } + } + + return true; +} + } // namespace xrpl diff --git a/src/libxrpl/tx/invariants/NFTInvariant.cpp b/src/libxrpl/tx/invariants/NFTInvariant.cpp index cf00dc9290..90511b6d04 100644 --- a/src/libxrpl/tx/invariants/NFTInvariant.cpp +++ b/src/libxrpl/tx/invariants/NFTInvariant.cpp @@ -1,12 +1,27 @@ #include -// + #include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include -#include + +#include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/invariants/PermissionedDEXInvariant.cpp b/src/libxrpl/tx/invariants/PermissionedDEXInvariant.cpp index e932a6ba09..6466812743 100644 --- a/src/libxrpl/tx/invariants/PermissionedDEXInvariant.cpp +++ b/src/libxrpl/tx/invariants/PermissionedDEXInvariant.cpp @@ -1,11 +1,20 @@ #include -// + #include -#include +#include +#include +#include #include #include +#include #include +#include +#include +#include #include +#include + +#include namespace xrpl { @@ -32,11 +41,17 @@ ValidPermissionedDEX::visitEntry( regularOffers_ = true; } - // if a hybrid offer is missing domain or additional book, there's - // something wrong + // pre-fixSecurity3_1_3: hybrid offer missing domain, missing + // sfAdditionalBooks, or sfAdditionalBooks has more than one entry if (after->isFlag(lsfHybrid) && (!after->isFieldPresent(sfDomainID) || !after->isFieldPresent(sfAdditionalBooks) || after->getFieldArray(sfAdditionalBooks).size() > 1)) + badHybridsOld_ = true; + + // post-fixSecurity3_1_3: same as above but also catches size == 0 + if (after->isFlag(lsfHybrid) && + (!after->isFieldPresent(sfDomainID) || !after->isFieldPresent(sfAdditionalBooks) || + after->getFieldArray(sfAdditionalBooks).size() != 1)) badHybrids_ = true; } } @@ -55,7 +70,8 @@ ValidPermissionedDEX::finalize( // For each offercreate transaction, check if // permissioned offers are valid - if (txType == ttOFFER_CREATE && badHybrids_) + bool const isMalformed = view.rules().enabled(fixSecurity3_1_3) ? badHybrids_ : badHybridsOld_; + if (txType == ttOFFER_CREATE && isMalformed) { JLOG(j.fatal()) << "Invariant failed: hybrid offer is malformed"; return false; diff --git a/src/libxrpl/tx/invariants/PermissionedDomainInvariant.cpp b/src/libxrpl/tx/invariants/PermissionedDomainInvariant.cpp index 7365fc7b1a..c2d955d4d1 100644 --- a/src/libxrpl/tx/invariants/PermissionedDomainInvariant.cpp +++ b/src/libxrpl/tx/invariants/PermissionedDomainInvariant.cpp @@ -1,10 +1,22 @@ #include -// -#include + +#include +#include +#include #include #include +#include +#include +#include #include +#include +#include +#include #include +#include + +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/invariants/VaultInvariant.cpp b/src/libxrpl/tx/invariants/VaultInvariant.cpp index c6b3295569..b20176b319 100644 --- a/src/libxrpl/tx/invariants/VaultInvariant.cpp +++ b/src/libxrpl/tx/invariants/VaultInvariant.cpp @@ -1,18 +1,30 @@ #include -// + #include +#include +#include #include -#include +#include #include #include #include +#include #include #include #include -#include +#include +#include // IWYU pragma: keep +#include +#include #include +#include #include +#include +#include +#include +#include + namespace xrpl { ValidVault::Vault diff --git a/src/libxrpl/tx/paths/AMMLiquidity.cpp b/src/libxrpl/tx/paths/AMMLiquidity.cpp index 4d6b67fa68..0a4cfadb69 100644 --- a/src/libxrpl/tx/paths/AMMLiquidity.cpp +++ b/src/libxrpl/tx/paths/AMMLiquidity.cpp @@ -1,5 +1,30 @@ #include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include + +#include +#include +#include +#include namespace xrpl { @@ -8,15 +33,15 @@ AMMLiquidity::AMMLiquidity( ReadView const& view, AccountID const& ammAccountID, std::uint32_t tradingFee, - Issue const& in, - Issue const& out, + Asset const& in, + Asset const& out, AMMContext& ammContext, beast::Journal j) : ammContext_(ammContext) , ammAccountID_(ammAccountID) , tradingFee_(tradingFee) - , issueIn_(in) - , issueOut_(out) + , assetIn_(in) + , assetOut_(out) , initialBalances_{fetchBalances(view)} , j_(j) { @@ -26,13 +51,13 @@ template TAmounts AMMLiquidity::fetchBalances(ReadView const& view) const { - auto const assetIn = ammAccountHolds(view, ammAccountID_, issueIn_); - auto const assetOut = ammAccountHolds(view, ammAccountID_, issueOut_); + auto const amountIn = ammAccountHolds(view, ammAccountID_, assetIn_); + auto const amountOut = ammAccountHolds(view, ammAccountID_, assetOut_); // This should not happen. - if (assetIn < beast::zero || assetOut < beast::zero) + if (amountIn < beast::zero || amountOut < beast::zero) Throw("AMMLiquidity: invalid balances"); - return TAmounts{get(assetIn), get(assetOut)}; + return TAmounts{get(amountIn), get(amountOut)}; } template @@ -42,7 +67,7 @@ AMMLiquidity::generateFibSeqOffer(TAmounts const& balances TAmounts cur{}; cur.in = toAmount( - getIssue(balances.in), + getAsset(balances.in), InitialFibSeqPct * initialBalances_.in, Number::rounding_mode::upward); cur.out = swapAssetIn(initialBalances_, cur.in, tradingFee_); @@ -50,19 +75,17 @@ AMMLiquidity::generateFibSeqOffer(TAmounts const& balances if (ammContext_.curIters() == 0) return cur; - // clang-format off constexpr std::uint32_t fib[AMMContext::MaxIterations] = { - 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610, 987, - 1597, 2584, 4181, 6765, 10946, 17711, 28657, 46368, 75025, 121393, - 196418, 317811, 514229, 832040, 1346269}; - // clang-format on + 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, + 144, 233, 377, 610, 987, 1597, 2584, 4181, 6765, 10946, + 17711, 28657, 46368, 75025, 121393, 196418, 317811, 514229, 832040, 1346269}; XRPL_ASSERT( !ammContext_.maxItersReached(), "xrpl::AMMLiquidity::generateFibSeqOffer : maximum iterations"); cur.out = toAmount( - getIssue(balances.out), + getAsset(balances.out), cur.out * fib[ammContext_.curIters() - 1], Number::rounding_mode::downward); // swapAssetOut() returns negative in this case @@ -91,14 +114,18 @@ maxAmount() { return STAmount(STAmount::cMaxValue / 2, STAmount::cMaxOffset); } + else if constexpr (std::is_same_v) + { + return MPTAmount(maxMPTokenAmount); + } } template T -maxOut(T const& out, Issue const& iss) +maxOut(T const& out, Asset const& asset) { Number const res = out * Number{99, -2}; - return toAmount(iss, res, Number::rounding_mode::downward); + return toAmount(asset, res, Number::rounding_mode::downward); } } // namespace @@ -115,7 +142,7 @@ AMMLiquidity::maxOffer(TAmounts const& balances, Rules con Quality{balances}); } - auto const out = maxOut(balances.out, issueOut()); + auto const out = maxOut(balances.out, assetOut()); if (out <= TOut{0} || out >= balances.out) return std::nullopt; return AMMOffer( @@ -213,8 +240,8 @@ AMMLiquidity::getOffer(ReadView const& view, std::optional c if (offer->amount().in > beast::zero && offer->amount().out > beast::zero) { JLOG(j_.trace()) << "AMMLiquidity::getOffer, created " << to_string(offer->amount().in) - << "/" << issueIn_ << " " << to_string(offer->amount().out) << "/" - << issueOut_; + << "/" << assetIn_ << " " << to_string(offer->amount().out) << "/" + << assetOut_; return offer; } @@ -227,9 +254,13 @@ AMMLiquidity::getOffer(ReadView const& view, std::optional c return std::nullopt; } -template class AMMLiquidity; template class AMMLiquidity; template class AMMLiquidity; template class AMMLiquidity; +template class AMMLiquidity; +template class AMMLiquidity; +template class AMMLiquidity; +template class AMMLiquidity; +template class AMMLiquidity; } // namespace xrpl diff --git a/src/libxrpl/tx/paths/AMMOffer.cpp b/src/libxrpl/tx/paths/AMMOffer.cpp index 2168d80094..0a41411492 100644 --- a/src/libxrpl/tx/paths/AMMOffer.cpp +++ b/src/libxrpl/tx/paths/AMMOffer.cpp @@ -1,45 +1,67 @@ -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + namespace xrpl { -template +template AMMOffer::AMMOffer( AMMLiquidity const& ammLiquidity, TAmounts const& amounts, TAmounts const& balances, Quality const& quality) - : ammLiquidity_(ammLiquidity) - , amounts_(amounts) - , balances_(balances) - , quality_(quality) - , consumed_(false) + : ammLiquidity_(ammLiquidity), amounts_(amounts), balances_(balances), quality_(quality) + { } -template -Issue const& -AMMOffer::issueIn() const +template +Asset const& +AMMOffer::assetIn() const { - return ammLiquidity_.issueIn(); + return ammLiquidity_.assetIn(); } -template +template +Asset const& +AMMOffer::assetOut() const +{ + return ammLiquidity_.assetOut(); +} + +template AccountID const& AMMOffer::owner() const { return ammLiquidity_.ammAccount(); } -template +template TAmounts const& AMMOffer::amount() const { return amounts_; } -template +template void AMMOffer::consume(ApplyView& view, TAmounts const& consumed) { @@ -55,7 +77,7 @@ AMMOffer::consume(ApplyView& view, TAmounts const& consume ammLiquidity_.context().setAMMUsed(); } -template +template TAmounts AMMOffer::limitOut( TAmounts const& offerAmount, @@ -80,7 +102,7 @@ AMMOffer::limitOut( return {swapAssetOut(balances_, limit, ammLiquidity_.tradingFee()), limit}; } -template +template TAmounts AMMOffer::limitIn(TAmounts const& offerAmount, TIn const& limit, bool roundUp) const @@ -97,7 +119,7 @@ AMMOffer::limitIn(TAmounts const& offerAmount, TIn const& return {limit, swapAssetIn(balances_, limit, ammLiquidity_.tradingFee())}; } -template +template QualityFunction AMMOffer::getQualityFunc() const { @@ -106,7 +128,7 @@ AMMOffer::getQualityFunc() const return QualityFunction{balances_, ammLiquidity_.tradingFee(), QualityFunction::AMMTag{}}; } -template +template bool AMMOffer::checkInvariant(TAmounts const& consumed, beast::Journal j) const { @@ -136,9 +158,13 @@ AMMOffer::checkInvariant(TAmounts const& consumed, beast:: return false; } -template class AMMOffer; template class AMMOffer; template class AMMOffer; template class AMMOffer; +template class AMMOffer; +template class AMMOffer; +template class AMMOffer; +template class AMMOffer; +template class AMMOffer; } // namespace xrpl diff --git a/src/libxrpl/tx/paths/BookStep.cpp b/src/libxrpl/tx/paths/BookStep.cpp index 3e492d8a19..f05460df61 100644 --- a/src/libxrpl/tx/paths/BookStep.cpp +++ b/src/libxrpl/tx/paths/BookStep.cpp @@ -1,24 +1,53 @@ #include +#include #include +#include +#include #include +#include #include +#include +#include #include +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include #include #include +#include #include +#include #include #include -#include #include +#include +#include #include +#include #include +#include +#include +#include +#include namespace xrpl { @@ -40,7 +69,7 @@ protected: /** Number of offers consumed or partially consumed the last time the step ran, including expired and unfunded offers. - N.B. This this not the total number offers consumed by this step for the + N.B. This is not the total number offers consumed by this step for the entire payment, it is only the number the last time it ran. Offers may be partially consumed multiple times during a payment. */ @@ -50,6 +79,7 @@ protected: // quality or there is no CLOB offer. std::optional> ammLiquidity_; beast::Journal const j_; + Asset const strandDeliver_; struct Cache { @@ -64,13 +94,14 @@ protected: std::optional cache_; private: - BookStep(StrandContext const& ctx, Issue const& in, Issue const& out) + BookStep(StrandContext const& ctx, Asset const& in, Asset const& out) : book_(in, out, ctx.domainID) , strandSrc_(ctx.strandSrc) , strandDst_(ctx.strandDst) , prevStep_(ctx.prevStep) , ownerPaysTransferFee_(ctx.ownerPaysTransferFee) , j_(ctx.j) + , strandDeliver_(ctx.strandDeliver) { if (auto const ammSle = ctx.view.read(keylet::amm(in, out)); ammSle && ammSle->getFieldAmount(sfLPTokenBalance) != beast::zero) @@ -163,11 +194,14 @@ protected: { std::ostringstream ostr; ostr << name << ": " - << "\ninIss: " << book_.in.account << "\noutIss: " << book_.out.account - << "\ninCur: " << book_.in.currency << "\noutCur: " << book_.out.currency; + << "\ninIss: " << book_.in.getIssuer() << "\noutIss: " << book_.out.getIssuer() + << "\ninCur: " << to_string(book_.in) << "\noutCur: " << to_string(book_.out); return ostr.str(); } + Rate + rate(ReadView const& view, Asset const& asset, AccountID const& dstAccount) const; + private: friend bool operator==(BookStep const& lhs, BookStep const& rhs) @@ -188,7 +222,7 @@ private: // Unfunded offers and bad offers are skipped (and returned). // callback is called with the offer SLE, taker pays, taker gets. // If callback returns false, don't process any more offers. - // Return the unfunded and bad offers and the number of offers consumed. + // Return the unfunded, bad offers and the number of offers consumed. template std::pair, std::uint32_t> forEachOffer( @@ -227,6 +261,11 @@ private: std::optional tipOfferQualityF(ReadView const& view) const; + // Check that takerPays/takerGets can be transferred/traded. + // Applies to MPT assets. + bool + checkMPTDEX(ReadView const& view, AccountID const& owner) const; + friend TDerived; }; @@ -245,7 +284,7 @@ class BookPaymentStep : public BookStep> public: explicit BookPaymentStep() = default; - BookPaymentStep(StrandContext const& ctx, Issue const& in, Issue const& out) + BookPaymentStep(StrandContext const& ctx, Asset const& in, Asset const& out) : BookStep>(ctx, in, out) { } @@ -310,17 +349,12 @@ public: // (the old code does not charge a fee) // Calculate amount that goes to the taker and the amount charged the // offer owner - auto rate = [&](AccountID const& id) { - if (isXRP(id) || id == this->strandDst_) - return parityRate; - return transferRate(v, id); - }; - - auto const trIn = redeems(prevStepDir) ? rate(this->book_.in.account) : parityRate; + auto const trIn = + redeems(prevStepDir) ? this->rate(v, this->book_.in, this->strandDst_) : parityRate; // Always charge the transfer fee, even if the owner is the issuer, // unless the fee is waived auto const trOut = (this->ownerPaysTransferFee_ && waiveFee == WaiveTransferFee::No) - ? rate(this->book_.out.account) + ? this->rate(v, this->book_.out, this->strandDst_) : parityRate; Quality const q1{getRate(STAmount(trOut.value), STAmount(trIn.value))}; @@ -355,7 +389,7 @@ private: } public: - BookOfferCrossingStep(StrandContext const& ctx, Issue const& in, Issue const& out) + BookOfferCrossingStep(StrandContext const& ctx, Asset const& in, Asset const& out) : BookStep>(ctx, in, out) , defaultPath_(ctx.isDefaultPath) , qualityThreshold_(getQuality(ctx.limitQuality)) @@ -454,7 +488,7 @@ public: auto const srcAcct = (prevStep != nullptr) ? prevStep->directStepSrcAcct() : std::nullopt; return owner == srcAcct // If offer crossing && prevStep is DirectI - ? QUALITY_ONE // && src is offer owner + ? QUALITY_ONE // or MPTEndpoint && src is offer owner : trIn; // then rate = QUALITY_ONE } @@ -502,13 +536,8 @@ public: return ofrQ; } - auto rate = [&](AccountID const& id) { - if (isXRP(id) || id == this->strandDst_) - return parityRate; - return transferRate(v, id); - }; - - auto const trIn = redeems(prevStepDir) ? rate(this->book_.in.account) : parityRate; + auto const trIn = + redeems(prevStepDir) ? this->rate(v, this->book_.in, this->strandDst_) : parityRate; // AMM doesn't pay the transfer fee on the out amount auto const trOut = parityRate; @@ -659,15 +688,11 @@ BookStep::forEachOffer( // (the old code does not charge a fee) // Calculate amount that goes to the taker and the amount charged the offer // owner - auto rate = [this, &sb](AccountID const& id) -> std::uint32_t { - if (isXRP(id) || id == this->strandDst_) - return QUALITY_ONE; - return transferRate(sb, id).value; - }; - - std::uint32_t const trIn = redeems(prevStepDir) ? rate(book_.in.account) : QUALITY_ONE; + std::uint32_t const trIn = + redeems(prevStepDir) ? rate(sb, book_.in, this->strandDst_).value : QUALITY_ONE; // Always charge the transfer fee, even if the owner is the issuer - std::uint32_t const trOut = ownerPaysTransferFee_ ? rate(book_.out.account) : QUALITY_ONE; + std::uint32_t const trOut = + ownerPaysTransferFee_ ? rate(sb, book_.out, this->strandDst_).value : QUALITY_ONE; typename FlowOfferStream::StepCounter counter(MaxOffersToConsume, j_); @@ -691,45 +716,49 @@ BookStep::forEachOffer( strandSrc_, strandDst_, offer, ofrQ, offers, offerAttempted)) return true; - // Make sure offer owner has authorization to own IOUs from issuer. - // An account can always own XRP or their own IOUs. - if (!isXRP(offer.issueIn().currency) && offer.owner() != offer.issueIn().account) + Asset const& assetIn = offer.assetIn(); + bool const isAssetInMPT = assetIn.holds(); + auto const& owner = offer.owner(); + + if (isAssetInMPT) { - auto const& issuerID = offer.issueIn().account; - auto const issuer = afView.read(keylet::account(issuerID)); - if (issuer && ((*issuer)[sfFlags] & lsfRequireAuth)) + // Create MPToken for the offer's owner. No need to check + // for the reserve since the offer is removed if it is consumed. + // Therefore, the owner count remains the same. + if (auto const err = checkCreateMPT(sb, assetIn.get(), owner, j_); + !isTesSuccess(err)) { - // Issuer requires authorization. See if offer owner has that. - auto const& ownerID = offer.owner(); - auto const authFlag = issuerID > ownerID ? lsfHighAuth : lsfLowAuth; - - auto const line = - afView.read(keylet::line(ownerID, issuerID, offer.issueIn().currency)); - - if (!line || (((*line)[sfFlags] & authFlag) == 0)) - { - // Offer owner not authorized to hold IOU from issuer. - // Remove this offer even if no crossing occurs. - if (auto const key = offer.key()) - offers.permRmOffer(*key); - if (!offerAttempted) - { - // Change quality only if no previous offers were tried. - ofrQ = std::nullopt; - } - // Returning true causes offers.step() to delete the offer. - return true; - } + return true; } } + // It shouldn't matter from auth point of view whether it's sb + // or afView. Amendment guard this change just in case. + auto& applyView = sb.rules().enabled(featureMPTokensV2) ? sb : afView; + // Make sure offer owner has authorization to own Assets from issuer + // and MPT assets can be traded/transferred. + // An account can always own XRP or their own Assets. + if (!isTesSuccess(requireAuth(applyView, assetIn, owner)) || !checkMPTDEX(sb, owner)) + { + // Offer owner not authorized to hold IOU/MPT from issuer. + // Remove this offer even if no crossing occurs. + if (auto const key = offer.key()) + offers.permRmOffer(*key); + if (!offerAttempted) + { + // Change quality only if no previous offers were tried. + ofrQ = std::nullopt; + } + // Returning true causes offers.step() to delete the offer. + return true; + } + if (!static_cast(this)->checkQualityThreshold(offer.quality())) return false; auto const [ofrInRate, ofrOutRate] = offer.adjustRates( - static_cast(this)->getOfrInRate(prevStep_, offer.owner(), trIn), - static_cast(this)->getOfrOutRate( - prevStep_, offer.owner(), strandDst_, trOut)); + static_cast(this)->getOfrInRate(prevStep_, owner, trIn), + static_cast(this)->getOfrOutRate(prevStep_, owner, strandDst_, trOut)); auto ofrAmt = offer.amount(); TAmounts stpAmt{mulRatio(ofrAmt.in, ofrInRate, QUALITY_ONE, /*roundUp*/ true), ofrAmt.out}; @@ -756,6 +785,26 @@ BookStep::forEachOffer( stpAmt.in = mulRatio(ofrAmt.in, ofrInRate, QUALITY_ONE, /*roundUp*/ true); } + // Limit offer's input if MPT, BookStep is the first step (an issuer + // is making a cross-currency payment), and this offer is not owned + // by the issuer. Otherwise, OutstandingAmount may overflow. + auto const& issuer = assetIn.getIssuer(); + if (isAssetInMPT && !prevStep_ && offer.owner() != issuer) + { + // Funds available to issue + auto const available = toAmount(accountFunds( + sb, + issuer, + assetIn, // STAmount{0}, but the default is not used + FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, + j_)); + if (stpAmt.in > available) + { + limitStepIn(offer, ofrAmt, stpAmt, ownerGives, ofrInRate, ofrOutRate, available); + } + } + offerAttempted = true; return callback(offer, ofrAmt, stpAmt, ownerGives, ofrInRate, ofrOutRate); }; @@ -820,8 +869,8 @@ BookStep::consumeOffer( // The offer owner gets the ofrAmt. The difference between ofrAmt and // stepAmt is a transfer fee that goes to book_.in.account { - auto const dr = - offer.send(sb, book_.in.account, offer.owner(), toSTAmount(ofrAmt.in, book_.in), j_); + auto const dr = offer.send( + sb, book_.in.getIssuer(), offer.owner(), toSTAmount(ofrAmt.in, book_.in), j_); if (!isTesSuccess(dr)) Throw(dr); } @@ -829,10 +878,16 @@ BookStep::consumeOffer( // The offer owner pays `ownerGives`. The difference between ownerGives and // stepAmt is a transfer fee that goes to book_.out.account { + auto const& issuer = book_.out.getIssuer(); auto const cr = - offer.send(sb, offer.owner(), book_.out.account, toSTAmount(ownerGives, book_.out), j_); + offer.send(sb, offer.owner(), issuer, toSTAmount(ownerGives, book_.out), j_); if (!isTesSuccess(cr)) Throw(cr); + if constexpr (std::is_same_v) + { + if (offer.owner() == issuer) + issuerSelfDebitHookMPT(sb, book_.out.get(), ofrAmt.out.value()); + } } offer.consume(sb, ofrAmt); @@ -1009,7 +1064,7 @@ BookStep::revImp( return DebtDirection::issues; }(); auto const r = forEachOffer(sb, afView, prevStepDebtDir, eachOffer); - boost::container::flat_set toRm = std::move(std::get<0>(r)); + boost::container::flat_set const toRm = std::move(std::get<0>(r)); std::uint32_t const offersConsumed = std::get<1>(r); offersUsed_ = offersConsumed; SetUnion(ofrsToRm, toRm); @@ -1171,7 +1226,7 @@ BookStep::fwdImp( return DebtDirection::issues; }(); auto const r = forEachOffer(sb, afView, prevStepDebtDir, eachOffer); - boost::container::flat_set toRm = std::move(std::get<0>(r)); + boost::container::flat_set const toRm = std::move(std::get<0>(r)); std::uint32_t const offersConsumed = std::get<1>(r); offersUsed_ = offersConsumed; SetUnion(ofrsToRm, toRm); @@ -1260,20 +1315,20 @@ BookStep::check(StrandContext const& ctx) const // Do not allow two books to output the same issue. This may cause offers on // one step to unfund offers in another step. if (!ctx.seenBookOuts.insert(book_.out).second || - (ctx.seenDirectIssues[0].count(book_.out) != 0u)) + (ctx.seenDirectAssets[0].count(book_.out) != 0u)) { JLOG(j_.debug()) << "BookStep: loop detected: " << *this; return temBAD_PATH_LOOP; } - if (ctx.seenDirectIssues[1].count(book_.out) != 0u) + if (ctx.seenDirectAssets[1].count(book_.out) != 0u) { JLOG(j_.debug()) << "BookStep: loop detected: " << *this; return temBAD_PATH_LOOP; } - auto issuerExists = [](ReadView const& view, Issue const& iss) -> bool { - return isXRP(iss.account) || view.read(keylet::account(iss.account)); + auto issuerExists = [](ReadView const& view, Asset const& iss) -> bool { + return isXRP(iss.getIssuer()) || view.exists(keylet::account(iss.getIssuer())); }; if (!issuerExists(ctx.view, book_.in) || !issuerExists(ctx.view, book_.out)) @@ -1287,19 +1342,101 @@ BookStep::check(StrandContext const& ctx) const if (auto const prev = ctx.prevStep->directStepSrcAcct()) { auto const& view = ctx.view; - auto const& cur = book_.in.account; + auto const& cur = book_.in.getIssuer(); - auto sle = view.read(keylet::line(*prev, cur, book_.in.currency)); - if (!sle) - return terNO_LINE; - if (((*sle)[sfFlags] & ((cur > *prev) ? lsfHighNoRipple : lsfLowNoRipple)) != 0u) - return terNO_RIPPLE; + auto const err = book_.in.visit( + [&](Issue const& issue) -> std::optional { + auto sle = view.read(keylet::line(*prev, cur, issue.currency)); + if (!sle) + return terNO_LINE; + if (((*sle)[sfFlags] & ((cur > *prev) ? lsfHighNoRipple : lsfLowNoRipple)) != + 0u) + return terNO_RIPPLE; + return std::nullopt; + }, + [&](MPTIssue const& issue) -> std::optional { + // Check if can trade on DEX. + if (auto const ter = canTrade(view, book_.in); !isTesSuccess(ter)) + return ter; + if (auto const ter = canTrade(view, book_.out); !isTesSuccess(ter)) + return ter; + return std::nullopt; + }); + if (err) + return *err; } } return tesSUCCESS; } +template +Rate +BookStep::rate( + ReadView const& view, + Asset const& asset, + AccountID const& dstAccount) const +{ + auto const& issuer = asset.getIssuer(); + if (isXRP(issuer) || issuer == dstAccount) + return parityRate; + return asset.visit( + [&](Issue const&) { return transferRate(view, issuer); }, + [&](MPTIssue const& issue) { return transferRate(view, issue.getMptID()); }); +}; + +template +bool +BookStep::checkMPTDEX(ReadView const& view, AccountID const& owner) const +{ + if (!isTesSuccess(canTrade(view, book_.in)) || !isTesSuccess(canTrade(view, book_.out))) + return false; + + if (book_.in.holds()) + { + auto ret = [&]() { + auto const& asset = book_.in; + // Strand's source is an issuer + if (!prevStep_) + return true; + // Offer's owner is an issuer + if (asset.getIssuer() == owner) + return true; + // The previous step could be MPTEndpointStep with non issuer account or + // BookStep. Fail both if in asset is locked. In the former case it is holder + // to locked holder transfer. In the latter case it is not possible to tell if + // it is issuer to holder or holder to holder transfer. + if (isFrozen(view, owner, book_.in.get())) + return false; + // Previous step is BookStep. BookStep only sends if CanTransfer is + // set and not locked or the offer is owned by an issuer + if (prevStep_->bookStepBook()) + return true; + // Previous step is MPTEndpointStep and offer's owner is not an + // issuer + return isTesSuccess(canTransfer(view, asset, owner, owner)); + }(); + if (!ret) + return false; + } + + if (book_.out.holds()) + { + auto const& asset = book_.out; + // Last step if the strand's destination is an issuer + if (strandDeliver_ == asset && strandDst_ == asset.getIssuer()) + return true; + // Offer's owner is an issuer + if (asset.getIssuer() == owner) + return true; + + // Next step is BookStep and offer's owner is not an issuer. + return isTesSuccess(canTransfer(view, asset, owner, owner)); + } + + return true; +} + //------------------------------------------------------------------------------ namespace test { @@ -1317,22 +1454,25 @@ equalHelper(Step const& step, xrpl::Book const& book) bool bookStepEqual(Step const& step, xrpl::Book const& book) { - bool const inXRP = isXRP(book.in.currency); - bool const outXRP = isXRP(book.out.currency); - if (inXRP && outXRP) - { - // LCOV_EXCL_START - UNREACHABLE("xrpl::test::bookStepEqual : no XRP to XRP book step"); - return false; // no such thing as xrp/xrp book step - // LCOV_EXCL_STOP - } - if (inXRP && !outXRP) - return equalHelper>(step, book); - if (!inXRP && outXRP) - return equalHelper>(step, book); - if (!inXRP && !outXRP) - return equalHelper>(step, book); - return false; + return std::visit( + [&](TIn const&, TOut const&) { + using TIn_ = typename TIn::amount_type; + using TOut_ = typename TOut::amount_type; + + if constexpr (ValidTaker) + { + return equalHelper>(step, book); + } + else + { + // LCOV_EXCL_START + UNREACHABLE("xrpl::bookStepEqual : invalid book step"); + return false; + // LCOV_EXCL_STOP + } + }, + book.in.getAmountType(), + book.out.getAmountType()); } } // namespace test @@ -1340,7 +1480,7 @@ bookStepEqual(Step const& step, xrpl::Book const& book) template static std::pair> -make_BookStepHelper(StrandContext const& ctx, Issue const& in, Issue const& out) +make_BookStepHelper(StrandContext const& ctx, Asset const& in, Asset const& out) { TER ter = tefINTERNAL; std::unique_ptr r; @@ -1380,4 +1520,35 @@ make_BookStepXI(StrandContext const& ctx, Issue const& out) return make_BookStepHelper(ctx, xrpIssue(), out); } +// MPT's +std::pair> +make_BookStepMM(StrandContext const& ctx, MPTIssue const& in, MPTIssue const& out) +{ + return make_BookStepHelper(ctx, in, out); +} + +std::pair> +make_BookStepMI(StrandContext const& ctx, MPTIssue const& in, Issue const& out) +{ + return make_BookStepHelper(ctx, in, out); +} + +std::pair> +make_BookStepIM(StrandContext const& ctx, Issue const& in, MPTIssue const& out) +{ + return make_BookStepHelper(ctx, in, out); +} + +std::pair> +make_BookStepMX(StrandContext const& ctx, MPTIssue const& in) +{ + return make_BookStepHelper(ctx, in, xrpIssue()); +} + +std::pair> +make_BookStepXM(StrandContext const& ctx, MPTIssue const& out) +{ + return make_BookStepHelper(ctx, xrpIssue(), out); +} + } // namespace xrpl diff --git a/src/libxrpl/tx/paths/BookTip.cpp b/src/libxrpl/tx/paths/BookTip.cpp index 5611a081c3..7c6dd85ee3 100644 --- a/src/libxrpl/tx/paths/BookTip.cpp +++ b/src/libxrpl/tx/paths/BookTip.cpp @@ -1,11 +1,19 @@ +#include + +#include +#include #include #include -#include +#include +#include +#include + +#include namespace xrpl { BookTip::BookTip(ApplyView& view, Book const& book) - : view_(view), m_valid(false), m_book(getBookBase(book)), m_end(getQualityNext(m_book)) + : view_(view), m_book(getBookBase(book)), m_end(getQualityNext(m_book)) { } diff --git a/src/libxrpl/tx/paths/DirectStep.cpp b/src/libxrpl/tx/paths/DirectStep.cpp index 9cae103d8f..c4b2c51934 100644 --- a/src/libxrpl/tx/paths/DirectStep.cpp +++ b/src/libxrpl/tx/paths/DirectStep.cpp @@ -1,17 +1,36 @@ #include +#include +#include +#include +#include #include #include #include -#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include #include #include -#include +#include +#include +#include #include +#include +#include namespace xrpl { @@ -519,7 +538,7 @@ DirectStepI::revImp( { IOUAmount const in = mulRatio(srcToDst, srcQOut, QUALITY_ONE, /*roundUp*/ true); cache_.emplace(in, srcToDst, out, srcDebtDir); - rippleCredit( + directSendNoFee( sb, src_, dst_, @@ -536,7 +555,7 @@ DirectStepI::revImp( IOUAmount const in = mulRatio(maxSrcToDst, srcQOut, QUALITY_ONE, /*roundUp*/ true); IOUAmount const actualOut = mulRatio(maxSrcToDst, dstQIn, QUALITY_ONE, /*roundUp*/ false); cache_.emplace(in, maxSrcToDst, actualOut, srcDebtDir); - rippleCredit( + directSendNoFee( sb, src_, dst_, @@ -628,7 +647,7 @@ DirectStepI::fwdImp( { IOUAmount const out = mulRatio(srcToDst, dstQIn, QUALITY_ONE, /*roundUp*/ false); setCacheLimiting(in, srcToDst, out, srcDebtDir); - rippleCredit( + directSendNoFee( sb, src_, dst_, @@ -645,7 +664,7 @@ DirectStepI::fwdImp( IOUAmount const actualIn = mulRatio(maxSrcToDst, srcQOut, QUALITY_ONE, /*roundUp*/ true); IOUAmount const out = mulRatio(maxSrcToDst, dstQIn, QUALITY_ONE, /*roundUp*/ false); setCacheLimiting(actualIn, maxSrcToDst, out, srcDebtDir); - rippleCredit( + directSendNoFee( sb, src_, dst_, @@ -671,7 +690,7 @@ DirectStepI::validFwd(PaymentSandbox& sb, ApplyView& afView, EitherAmo auto const savCache = *cache_; - XRPL_ASSERT(!in.native, "xrpl::DirectStepI::validFwd : input is not XRP"); + XRPL_ASSERT(in.holds(), "xrpl::DirectStepI::validFwd : input is IOU"); auto const [maxSrcToDst, srcDebtDir] = static_cast(this)->maxFlow(sb, cache_->srcToDst); @@ -680,7 +699,7 @@ DirectStepI::validFwd(PaymentSandbox& sb, ApplyView& afView, EitherAmo try { boost::container::flat_set dummy; - fwdImp(sb, afView, dummy, in.iou); // changes cache + fwdImp(sb, afView, dummy, in.get()); // changes cache } catch (FlowException const&) { @@ -857,13 +876,13 @@ DirectStepI::check(StrandContext const& ctx) const // issue if (auto book = ctx.prevStep->bookStepBook()) { - if (book->out != srcIssue) + if (book->out.get() != srcIssue) return temBAD_PATH_LOOP; } } - if (!ctx.seenDirectIssues[0].insert(srcIssue).second || - !ctx.seenDirectIssues[1].insert(dstIssue).second) + if (!ctx.seenDirectAssets[0].insert(srcIssue).second || + !ctx.seenDirectAssets[1].insert(dstIssue).second) { JLOG(j_.debug()) << "DirectStepI: loop detected: Index: " << ctx.strandSize << ' ' << *this; diff --git a/src/libxrpl/tx/paths/Flow.cpp b/src/libxrpl/tx/paths/Flow.cpp index 5a706ea812..413c160c7f 100644 --- a/src/libxrpl/tx/paths/Flow.cpp +++ b/src/libxrpl/tx/paths/Flow.cpp @@ -1,18 +1,28 @@ -#include -#include -#include -#include #include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include #include +#include +#include + namespace xrpl { template static auto -finishFlow(PaymentSandbox& sb, Issue const& srcIssue, Issue const& dstIssue, FlowResult&& f) +finishFlow(PaymentSandbox& sb, Asset const& srcAsset, Asset const& dstAsset, FlowResult&& f) { path::RippleCalc::Output result; if (isTesSuccess(f.ter)) @@ -25,8 +35,8 @@ finishFlow(PaymentSandbox& sb, Issue const& srcIssue, Issue const& dstIssue, Flo } result.setResult(f.ter); - result.actualAmountIn = toSTAmount(f.in, srcIssue); - result.actualAmountOut = toSTAmount(f.out, dstIssue); + result.actualAmountIn = toSTAmount(f.in, srcAsset); + result.actualAmountOut = toSTAmount(f.out, dstAsset); return result; }; @@ -48,19 +58,23 @@ flow( beast::Journal j, path::detail::FlowDebugInfo* flowDebugInfo) { - Issue const srcIssue = [&] { + Asset const srcAsset = [&]() -> Asset { if (sendMax) - return sendMax->issue(); - if (!isXRP(deliver.issue().currency)) - return Issue(deliver.issue().currency, src); - return xrpIssue(); + return sendMax->asset(); + return deliver.asset().visit( + [&](Issue const& issue) -> Asset { + if (isXRP(issue)) + return xrpIssue(); + return Issue(issue.currency, src); + }, + [&](MPTIssue const&) { return deliver.asset(); }); }(); - Issue const dstIssue = deliver.issue(); + Asset const dstAsset = deliver.asset(); - std::optional sendMaxIssue; + std::optional sendMaxAsset; if (sendMax) - sendMaxIssue = sendMax->issue(); + sendMaxAsset = sendMax->asset(); AMMContext ammContext(src, false); @@ -71,9 +85,9 @@ flow( sb, src, dst, - dstIssue, + dstAsset, limitQuality, - sendMaxIssue, + sendMaxAsset, paths, defaultPaths, ownerPaysTransferFee, @@ -93,8 +107,8 @@ flow( if (j.trace()) { - j.trace() << "\nsrc: " << src << "\ndst: " << dst << "\nsrcIssue: " << srcIssue - << "\ndstIssue: " << dstIssue; + j.trace() << "\nsrc: " << src << "\ndst: " << dst << "\nsrcAsset: " << srcAsset + << "\ndstAsset: " << dstAsset; j.trace() << "\nNumStrands: " << strands.size(); for (auto const& curStrand : strands) { @@ -106,87 +120,32 @@ flow( } } - bool const srcIsXRP = isXRP(srcIssue.currency); - bool const dstIsXRP = isXRP(dstIssue.currency); - - auto const asDeliver = toAmountSpec(deliver); - - // The src account may send either xrp or iou. The dst account may receive - // either xrp or iou. Since XRP and IOU amounts are represented by different - // types, use templates to tell `flow` about the amount types. - if (srcIsXRP && dstIsXRP) - { - return finishFlow( - sb, - srcIssue, - dstIssue, - flow( + // The src account may send either xrp,iou,or mpt. The dst account may + // receive either xrp,iou, or mpt. Since XRP, IOU, and MPT amounts are + // represented by different types, use templates to tell `flow` about the + // amount types. + return std::visit( + [&, &strands_ = strands](TIn const&, TOut const&) { + using TIn_ = typename TIn::amount_type; + using TOut_ = typename TOut::amount_type; + return finishFlow( sb, - strands, - asDeliver.xrp, - partialPayment, - offerCrossing, - limitQuality, - sendMax, - j, - ammContext, - flowDebugInfo)); - } - - if (srcIsXRP && !dstIsXRP) - { - return finishFlow( - sb, - srcIssue, - dstIssue, - flow( - sb, - strands, - asDeliver.iou, - partialPayment, - offerCrossing, - limitQuality, - sendMax, - j, - ammContext, - flowDebugInfo)); - } - - if (!srcIsXRP && dstIsXRP) - { - return finishFlow( - sb, - srcIssue, - dstIssue, - flow( - sb, - strands, - asDeliver.xrp, - partialPayment, - offerCrossing, - limitQuality, - sendMax, - j, - ammContext, - flowDebugInfo)); - } - - XRPL_ASSERT(!srcIsXRP && !dstIsXRP, "xrpl::flow : neither is XRP"); - return finishFlow( - sb, - srcIssue, - dstIssue, - flow( - sb, - strands, - asDeliver.iou, - partialPayment, - offerCrossing, - limitQuality, - sendMax, - j, - ammContext, - flowDebugInfo)); + srcAsset, + dstAsset, + flow( + sb, + strands_, + get(deliver), + partialPayment, + offerCrossing, + limitQuality, + sendMax, + j, + ammContext, + flowDebugInfo)); + }, + srcAsset.getAmountType(), + dstAsset.getAmountType()); } } // namespace xrpl diff --git a/src/libxrpl/tx/paths/MPTEndpointStep.cpp b/src/libxrpl/tx/paths/MPTEndpointStep.cpp new file mode 100644 index 0000000000..7b063a39d3 --- /dev/null +++ b/src/libxrpl/tx/paths/MPTEndpointStep.cpp @@ -0,0 +1,937 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include + +namespace xrpl { + +template +class MPTEndpointStep : public StepImp> +{ +protected: + AccountID const src_; + AccountID const dst_; + MPTIssue const mptIssue_; + + // Charge transfer fees when the prev step redeems + Step const* const prevStep_ = nullptr; + bool const isLast_; + // Direct payment between the holders + // Used by maxFlow's last step. + bool const isDirectBetweenHolders_ = false; + beast::Journal const j_; + + struct Cache + { + MPTAmount in; + MPTAmount srcToDst; + MPTAmount out; + DebtDirection srcDebtDir; + + Cache( + MPTAmount const& in_, + MPTAmount const& srcToDst_, + MPTAmount const& out_, + DebtDirection srcDebtDir_) + : in(in_), srcToDst(srcToDst_), out(out_), srcDebtDir(srcDebtDir_) + { + } + }; + + std::optional cache_; + + // Compute the maximum value that can flow from src->dst at + // the best available quality. + // return: first element is max amount that can flow, + // second is the debt direction of the source w.r.t. the dst + std::pair + maxPaymentFlow(ReadView const& sb) const; + + // Compute srcQOut and dstQIn when the source redeems. + std::pair + qualitiesSrcRedeems(ReadView const& sb) const; + + // Compute srcQOut and dstQIn when the source issues. + std::pair + qualitiesSrcIssues(ReadView const& sb, DebtDirection prevStepDebtDirection) const; + + // Returns srcQOut, dstQIn + std::pair + qualities(ReadView const& sb, DebtDirection srcDebtDir, StrandDirection strandDir) const; + + void + resetCache(DebtDirection dir); + +private: + MPTEndpointStep( + StrandContext const& ctx, + AccountID const& src, + AccountID const& dst, + MPTID const& mpt) + : src_(src) + , dst_(dst) + , mptIssue_(mpt) + , prevStep_(ctx.prevStep) + , isLast_(ctx.isLast) + , isDirectBetweenHolders_( + mptIssue_ == ctx.strandDeliver && ctx.strandSrc != mptIssue_.getIssuer() && + ctx.strandDst != mptIssue_.getIssuer() && + (ctx.isFirst || (ctx.prevStep != nullptr && !ctx.prevStep->bookStepBook()))) + , j_(ctx.j) + { + XRPL_ASSERT( + src_ == mptIssue_.getIssuer() || dst_ == mptIssue_.getIssuer(), + "MPTEndpointStep::MPTEndpointStep src or dst must be an issuer"); + } + +public: + AccountID const& + src() const + { + return src_; + } + AccountID const& + dst() const + { + return dst_; + } + MPTID const& + mptID() const + { + return mptIssue_.getMptID(); + } + + std::optional + cachedIn() const override + { + if (!cache_) + return std::nullopt; + return EitherAmount(cache_->in); + } + + std::optional + cachedOut() const override + { + if (!cache_) + return std::nullopt; + return EitherAmount(cache_->out); + } + + std::optional + directStepSrcAcct() const override + { + return src_; + } + + std::optional> + directStepAccts() const override + { + return std::make_pair(src_, dst_); + } + + DebtDirection + debtDirection(ReadView const& sb, StrandDirection dir) const override; + + std::uint32_t + lineQualityIn(ReadView const& v) const override; + + std::pair, DebtDirection> + qualityUpperBound(ReadView const& v, DebtDirection dir) const override; + + std::pair + revImp( + PaymentSandbox& sb, + ApplyView& afView, + boost::container::flat_set& ofrsToRm, + MPTAmount const& out); + + std::pair + fwdImp( + PaymentSandbox& sb, + ApplyView& afView, + boost::container::flat_set& ofrsToRm, + MPTAmount const& in); + + std::pair + validFwd(PaymentSandbox& sb, ApplyView& afView, EitherAmount const& in) override; + + // Check for error, existing liquidity, and violations of auth/frozen + // constraints. + TER + check(StrandContext const& ctx) const; + + void + setCacheLimiting( + MPTAmount const& fwdIn, + MPTAmount const& fwdSrcToDst, + MPTAmount const& fwdOut, + DebtDirection srcDebtDir); + + friend bool + operator==(MPTEndpointStep const& lhs, MPTEndpointStep const& rhs) + { + return lhs.src_ == rhs.src_ && lhs.dst_ == rhs.dst_ && lhs.mptIssue_ == rhs.mptIssue_; + } + + friend bool + operator!=(MPTEndpointStep const& lhs, MPTEndpointStep const& rhs) + { + return !(lhs == rhs); + } + +protected: + std::string + logStringImpl(char const* name) const + { + std::ostringstream ostr; + ostr << name << ": " + << "\nSrc: " << src_ << "\nDst: " << dst_; + return ostr.str(); + } + +private: + bool + equal(Step const& rhs) const override + { + if (auto ds = dynamic_cast(&rhs)) + { + return *this == *ds; + } + return false; + } + + friend TDerived; +}; + +//------------------------------------------------------------------------------ + +// Flow is used in two different circumstances for transferring funds: +// o Payments, and +// o Offer crossing. +// The rules for handling funds in these two cases are almost, but not +// quite, the same. + +// Payment MPTEndpointStep class (not offer crossing). +class MPTEndpointPaymentStep : public MPTEndpointStep +{ +public: + using MPTEndpointStep::MPTEndpointStep; + using MPTEndpointStep::check; + + MPTEndpointPaymentStep( + StrandContext const& ctx, + AccountID const& src, + AccountID const& dst, + MPTID const& mpt) + : MPTEndpointStep(ctx, src, dst, mpt) + { + } + + static bool + verifyPrevStepDebtDirection(DebtDirection) + { + // A payment doesn't care regardless of prevStepRedeems. + return true; + } + + // Verify the consistency of the step. These checks are specific to + // payments and assume that general checks were already performed. + TER + check(StrandContext const& ctx, std::shared_ptr const& sleSrc) const; + + std::string + logString() const override + { + return logStringImpl("MPTEndpointPaymentStep"); + } + + // Not applicable for payment + static TER + checkCreateMPT(ApplyView&, DebtDirection) + { + return tesSUCCESS; + } +}; + +// Offer crossing MPTEndpointStep class (not a payment). +class MPTEndpointOfferCrossingStep : public MPTEndpointStep +{ +public: + using MPTEndpointStep::MPTEndpointStep; + using MPTEndpointStep::check; + + MPTEndpointOfferCrossingStep( + StrandContext const& ctx, + AccountID const& src, + AccountID const& dst, + MPTID const& mpt) + : MPTEndpointStep(ctx, src, dst, mpt) + { + } + + static bool + verifyPrevStepDebtDirection(DebtDirection prevStepDir) + { + // During offer crossing we rely on the fact that prevStepRedeems + // will *always* issue. That's because: + // o If there's a prevStep_, it will always be a BookStep. + // o BookStep::debtDirection() always returns `issues` when offer + // crossing. + // An assert based on this return value will tell us if that + // behavior changes. + return issues(prevStepDir); + } + + // Verify the consistency of the step. These checks are specific to + // offer crossing and assume that general checks were already performed. + static TER + check(StrandContext const& ctx, std::shared_ptr const& sleSrc); + + std::string + logString() const override + { + return logStringImpl("MPTEndpointOfferCrossingStep"); + } + + // Can be created in rev or fwd (if limiting step) direction. + TER + checkCreateMPT(ApplyView& view, DebtDirection srcDebtDir); +}; + +//------------------------------------------------------------------------------ + +TER +MPTEndpointPaymentStep::check(StrandContext const& ctx, std::shared_ptr const& sleSrc) + const +{ + // Since this is a payment, MPToken must be present. Perform all + // MPToken related checks. + + // requireAuth checks if MPTIssuance exist. Note that issuer to issuer + // payment is invalid + auto const& issuer = mptIssue_.getIssuer(); + if (src_ != issuer) + { + if (auto const ter = requireAuth(ctx.view, mptIssue_, src_); !isTesSuccess(ter)) + return ter; + } + + if (dst_ != issuer) + { + if (auto const ter = requireAuth(ctx.view, mptIssue_, dst_); !isTesSuccess(ter)) + return ter; + } + + // Direct MPT payment, no DEX + if (mptIssue_ == ctx.strandDeliver && + (ctx.isFirst || (ctx.prevStep != nullptr && !ctx.prevStep->bookStepBook()))) + { + // Between holders + if (isDirectBetweenHolders_) + { + auto const& holder = ctx.isFirst ? src_ : dst_; + // Payment between the holders + if (isFrozen(ctx.view, holder, mptIssue_)) + return tecLOCKED; + + if (auto const ter = canTransfer(ctx.view, mptIssue_, holder, ctx.strandDst); + !isTesSuccess(ter)) + return ter; + } + // Don't need to check if a payment is between issuer and holder + // in either direction + } + // Cross-token MPT payment via DEX + else + { + if (auto const ter = canTrade(ctx.view, mptIssue_); !isTesSuccess(ter)) + return ter; + } + + // Can't check for creditBalance/Limit unless it's the first step. + // Otherwise, even if OutstandingAmount is equal to MaximumAmount + // a payment can still be successful. For instance, when a balance + // is shifted from one holder to another. + + if (prevStep_ == nullptr) + { + auto const owed = + accountFunds(ctx.view, src_, mptIssue_, fhIGNORE_FREEZE, ahIGNORE_AUTH, j_); + // Already at MaximumAmount + if (owed <= beast::zero) + return tecPATH_DRY; + } + + return tesSUCCESS; +} + +TER +MPTEndpointOfferCrossingStep::check(StrandContext const& ctx, std::shared_ptr const&) +{ + return tesSUCCESS; +} + +TER +MPTEndpointOfferCrossingStep::checkCreateMPT(ApplyView& view, xrpl::DebtDirection srcDebtDir) +{ + // TakerPays is the last step if offer crossing + if (isLast_) + { + // Create MPToken for the offer's owner. No need to check + // for the reserve since the offer doesn't go on the books + // if crossed. Insufficient reserve is allowed if the offer + // crossed. See CreateOffer::applyGuts() for reserve check. + if (auto const err = xrpl::checkCreateMPT(view, mptIssue_, dst_, j_); !isTesSuccess(err)) + { + JLOG(j_.trace()) << "MPTEndpointStep::checkCreateMPT: failed create MPT"; + resetCache(srcDebtDir); + return err; + } + } + return tesSUCCESS; +} + +//------------------------------------------------------------------------------ + +template +std::pair +MPTEndpointStep::maxPaymentFlow(ReadView const& sb) const +{ + auto const maxFlow = accountFunds(sb, src_, mptIssue_, fhIGNORE_FREEZE, ahIGNORE_AUTH, j_); + + // From a holder to an issuer + if (src_ != mptIssue_.getIssuer()) + return {toAmount(maxFlow), DebtDirection::redeems}; + + // From an issuer to a holder + if (auto const sle = sb.read(keylet::mptIssuance(mptIssue_))) + { + // If issuer is the source account, and it is direct payment then + // MPTEndpointStep is the only step. Provide available maxFlow. + if (prevStep_ == nullptr) + return {toAmount(maxFlow), DebtDirection::issues}; + + // MPTEndpointStep is the last step. It's always issuing in + // this case. Can't infer at this point what the maxFlow is, because + // the previous step may issue or redeem. Allow OutstandingAmount + // to temporarily overflow. Let the previous step figure out how + // to limit the flow. + std::int64_t const maxAmount = maxMPTAmount(*sle); + return {MPTAmount{maxAmount}, DebtDirection::issues}; + } + + return {MPTAmount{0}, DebtDirection::issues}; +} + +template +DebtDirection +MPTEndpointStep::debtDirection(ReadView const& sb, StrandDirection dir) const +{ + if (dir == StrandDirection::forward && cache_) + return cache_->srcDebtDir; + + return (src_ == mptIssue_.getIssuer()) ? DebtDirection::issues : DebtDirection::redeems; +} + +template +std::pair +MPTEndpointStep::revImp( + PaymentSandbox& sb, + ApplyView& /*afView*/, + boost::container::flat_set& /*ofrsToRm*/, + MPTAmount const& out) +{ + cache_.reset(); + + auto const [maxSrcToDst, srcDebtDir] = static_cast(this)->maxPaymentFlow(sb); + + auto const [srcQOut, dstQIn] = qualities(sb, srcDebtDir, StrandDirection::reverse); + (void)dstQIn; + + MPTIssue const srcToDstIss(mptIssue_); + + JLOG(j_.trace()) << "MPTEndpointStep::rev" + << " srcRedeems: " << redeems(srcDebtDir) << " outReq: " << to_string(out) + << " maxSrcToDst: " << to_string(maxSrcToDst) << " srcQOut: " << srcQOut + << " dstQIn: " << dstQIn; + + if (maxSrcToDst.signum() <= 0) + { + JLOG(j_.trace()) << "MPTEndpointStep::rev: dry"; + resetCache(srcDebtDir); + return {beast::zero, beast::zero}; + } + + if (auto const err = static_cast(this)->checkCreateMPT(sb, srcDebtDir); + !isTesSuccess(err)) + return {beast::zero, beast::zero}; + + // Don't have to factor in dstQIn since it is always QUALITY_ONE + MPTAmount const srcToDst = out; + + if (srcToDst <= maxSrcToDst) + { + MPTAmount const in = mulRatio(srcToDst, srcQOut, QUALITY_ONE, /*roundUp*/ true); + cache_.emplace(in, srcToDst, srcToDst, srcDebtDir); + auto const ter = directSendNoFee( + sb, + src_, + dst_, + toSTAmount(srcToDst, srcToDstIss), + /*checkIssuer*/ false, + j_); + if (!isTesSuccess(ter)) + { + JLOG(j_.trace()) << "MPTEndpointStep::rev: error " << ter; + resetCache(srcDebtDir); + return {beast::zero, beast::zero}; + } + JLOG(j_.trace()) << "MPTEndpointStep::rev: Non-limiting" + << " srcRedeems: " << redeems(srcDebtDir) << " in: " << to_string(in) + << " srcToDst: " << to_string(srcToDst) << " out: " << to_string(out); + return {in, out}; + } + + // limiting node + MPTAmount const in = mulRatio(maxSrcToDst, srcQOut, QUALITY_ONE, /*roundUp*/ true); + // Don't have to factor in dsqQIn since it's always QUALITY_ONE + MPTAmount const actualOut = maxSrcToDst; + cache_.emplace(in, maxSrcToDst, actualOut, srcDebtDir); + + auto const ter = directSendNoFee( + sb, + src_, + dst_, + toSTAmount(maxSrcToDst, srcToDstIss), + /*checkIssuer*/ false, + j_); + if (!isTesSuccess(ter)) + { + JLOG(j_.trace()) << "MPTEndpointStep::rev: error " << ter; + resetCache(srcDebtDir); + return {beast::zero, beast::zero}; + } + JLOG(j_.trace()) << "MPTEndpointStep::rev: Limiting" + << " srcRedeems: " << redeems(srcDebtDir) << " in: " << to_string(in) + << " srcToDst: " << to_string(maxSrcToDst) << " out: " << to_string(out); + return {in, actualOut}; +} + +// The forward pass should never have more liquidity than the reverse +// pass. But sometimes rounding differences cause the forward pass to +// deliver more liquidity. Use the cached values from the reverse pass +// to prevent this. +template +void +MPTEndpointStep::setCacheLimiting( + MPTAmount const& fwdIn, + MPTAmount const& fwdSrcToDst, + MPTAmount const& fwdOut, + DebtDirection srcDebtDir) +{ + if (cache_->in < fwdIn) + { + MPTAmount const smallDiff(1); + auto const diff = fwdIn - cache_->in; + if (diff > smallDiff) + { + if (!cache_->in.value() || + (Number(fwdIn.value()) / Number(cache_->in.value())) > Number(101, -2)) + { + // Detect large diffs on forward pass so they may be + // investigated + JLOG(j_.warn()) << "MPTEndpointStep::fwd: setCacheLimiting" + << " fwdIn: " << to_string(fwdIn) + << " cacheIn: " << to_string(cache_->in) + << " fwdSrcToDst: " << to_string(fwdSrcToDst) + << " cacheSrcToDst: " << to_string(cache_->srcToDst) + << " fwdOut: " << to_string(fwdOut) + << " cacheOut: " << to_string(cache_->out); + cache_.emplace(fwdIn, fwdSrcToDst, fwdOut, srcDebtDir); + return; + } + } + } + cache_->in = fwdIn; + if (fwdSrcToDst < cache_->srcToDst) + cache_->srcToDst = fwdSrcToDst; + if (fwdOut < cache_->out) + cache_->out = fwdOut; + cache_->srcDebtDir = srcDebtDir; +}; + +template +std::pair +MPTEndpointStep::fwdImp( + PaymentSandbox& sb, + ApplyView& /*afView*/, + boost::container::flat_set& /*ofrsToRm*/, + MPTAmount const& in) +{ + XRPL_ASSERT(cache_, "MPTEndpointStep::fwdImp : valid cache"); + + auto const [maxSrcToDst, srcDebtDir] = static_cast(this)->maxPaymentFlow(sb); + + auto const [srcQOut, dstQIn] = qualities(sb, srcDebtDir, StrandDirection::forward); + (void)dstQIn; + + MPTIssue const srcToDstIss(mptIssue_); + + JLOG(j_.trace()) << "MPTEndpointStep::fwd" + << " srcRedeems: " << redeems(srcDebtDir) << " inReq: " << to_string(in) + << " maxSrcToDst: " << to_string(maxSrcToDst) << " srcQOut: " << srcQOut + << " dstQIn: " << dstQIn; + + if (maxSrcToDst.signum() <= 0) + { + JLOG(j_.trace()) << "MPTEndpointStep::fwd: dry"; + resetCache(srcDebtDir); + return {beast::zero, beast::zero}; + } + + if (auto const err = static_cast(this)->checkCreateMPT(sb, srcDebtDir); + !isTesSuccess(err)) + return {beast::zero, beast::zero}; + + MPTAmount const srcToDst = mulRatio(in, QUALITY_ONE, srcQOut, /*roundUp*/ false); + + if (srcToDst <= maxSrcToDst) + { + // Don't have to factor in dstQIn since it's always QUALITY_ONE + MPTAmount const out = srcToDst; + setCacheLimiting(in, srcToDst, out, srcDebtDir); + auto const ter = directSendNoFee( + sb, + src_, + dst_, + toSTAmount(cache_->srcToDst, srcToDstIss), + /*checkIssuer*/ false, + j_); + if (!isTesSuccess(ter)) + { + JLOG(j_.trace()) << "MPTEndpointStep::fwd: error " << ter; + resetCache(srcDebtDir); + return {beast::zero, beast::zero}; + } + JLOG(j_.trace()) << "MPTEndpointStep::fwd: Non-limiting" + << " srcRedeems: " << redeems(srcDebtDir) << " in: " << to_string(in) + << " srcToDst: " << to_string(srcToDst) << " out: " << to_string(out); + } + else + { + // limiting node + MPTAmount const actualIn = mulRatio(maxSrcToDst, srcQOut, QUALITY_ONE, /*roundUp*/ true); + // Don't have to factor in dstQIn since it's always QUALITY_ONE + MPTAmount const out = maxSrcToDst; + setCacheLimiting(actualIn, maxSrcToDst, out, srcDebtDir); + auto const ter = directSendNoFee( + sb, + src_, + dst_, + toSTAmount(cache_->srcToDst, srcToDstIss), + /*checkIssuer*/ false, + j_); + if (!isTesSuccess(ter)) + { + JLOG(j_.trace()) << "MPTEndpointStep::fwd: error " << ter; + resetCache(srcDebtDir); + return {beast::zero, beast::zero}; + } + JLOG(j_.trace()) << "MPTEndpointStep::fwd: Limiting" + << " srcRedeems: " << redeems(srcDebtDir) << " in: " << to_string(actualIn) + << " srcToDst: " << to_string(srcToDst) << " out: " << to_string(out); + } + return {cache_->in, cache_->out}; +} + +template +std::pair +MPTEndpointStep::validFwd(PaymentSandbox& sb, ApplyView& afView, EitherAmount const& in) +{ + if (!cache_) + { + JLOG(j_.trace()) << "Expected valid cache in validFwd"; + return {false, EitherAmount(MPTAmount(beast::zero))}; + } + + auto const savCache = *cache_; + + XRPL_ASSERT(in.holds(), "MPTEndpoint::validFwd : is MPT"); + + auto const [maxSrcToDst, srcDebtDir] = static_cast(this)->maxPaymentFlow(sb); + (void)srcDebtDir; + + try + { + boost::container::flat_set dummy; + fwdImp(sb, afView, dummy, in.get()); // changes cache + } + catch (FlowException const&) + { + return {false, EitherAmount(MPTAmount(beast::zero))}; + } + + if (maxSrcToDst < cache_->srcToDst) + { + JLOG(j_.warn()) << "MPTEndpointStep: Strand re-execute check failed." + << " Exceeded max src->dst limit" + << " max src->dst: " << to_string(maxSrcToDst) + << " actual src->dst: " << to_string(cache_->srcToDst); + return {false, EitherAmount(cache_->out)}; + } + + if (!(checkNear(savCache.in, cache_->in) && checkNear(savCache.out, cache_->out))) + { + JLOG(j_.warn()) << "MPTEndpointStep: Strand re-execute check failed." + << " ExpectedIn: " << to_string(savCache.in) + << " CachedIn: " << to_string(cache_->in) + << " ExpectedOut: " << to_string(savCache.out) + << " CachedOut: " << to_string(cache_->out); + return {false, EitherAmount(cache_->out)}; + } + return {true, EitherAmount(cache_->out)}; +} + +// Returns srcQOut, dstQIn +template +std::pair +MPTEndpointStep::qualitiesSrcRedeems(ReadView const& sb) const +{ + if (prevStep_ == nullptr) + return {QUALITY_ONE, QUALITY_ONE}; + + auto const prevStepQIn = prevStep_->lineQualityIn(sb); + // Unlike trustline MPT doesn't have line quality field + auto srcQOut = QUALITY_ONE; + + srcQOut = std::max(prevStepQIn, srcQOut); + return {srcQOut, QUALITY_ONE}; +} + +// Returns srcQOut, dstQIn +template +std::pair +MPTEndpointStep::qualitiesSrcIssues( + ReadView const& sb, + DebtDirection prevStepDebtDirection) const +{ + // Charge a transfer rate when issuing and previous step redeems + + XRPL_ASSERT( + static_cast(this)->verifyPrevStepDebtDirection(prevStepDebtDirection), + "MPTEndpointStep::qualitiesSrcIssues : verify prev step debt " + "direction"); + + std::uint32_t const srcQOut = + redeems(prevStepDebtDirection) ? transferRate(sb, mptIssue_.getMptID()).value : QUALITY_ONE; + + // Unlike trustline, MPT doesn't have line quality field + return {srcQOut, QUALITY_ONE}; +} + +// Returns srcQOut, dstQIn +template +std::pair +MPTEndpointStep::qualities( + ReadView const& sb, + DebtDirection srcDebtDir, + StrandDirection strandDir) const +{ + if (redeems(srcDebtDir)) + { + return qualitiesSrcRedeems(sb); + } + + auto const prevStepDebtDirection = [&] { + if (prevStep_ != nullptr) + return prevStep_->debtDirection(sb, strandDir); + return DebtDirection::issues; + }(); + return qualitiesSrcIssues(sb, prevStepDebtDirection); +} + +template +std::uint32_t +MPTEndpointStep::lineQualityIn(ReadView const& v) const +{ + // dst quality in + return QUALITY_ONE; +} + +template +std::pair, DebtDirection> +MPTEndpointStep::qualityUpperBound(ReadView const& v, DebtDirection prevStepDir) const +{ + auto const dir = this->debtDirection(v, StrandDirection::forward); + + auto const [srcQOut, dstQIn] = + redeems(dir) ? qualitiesSrcRedeems(v) : qualitiesSrcIssues(v, prevStepDir); + (void)dstQIn; + + MPTIssue const iss{mptIssue_}; + // Be careful not to switch the parameters to `getRate`. The + // `getRate(offerOut, offerIn)` function is usually used for offers. It + // returns offerIn/offerOut. For a direct step, the rate is srcQOut/dstQIn + // (Input*dstQIn/srcQOut = Output; So rate = srcQOut/dstQIn). Although the + // first parameter is called `offerOut`, it should take the `dstQIn` + // variable. + return {Quality(getRate(STAmount(iss, QUALITY_ONE), STAmount(iss, srcQOut))), dir}; +} + +template +TER +MPTEndpointStep::check(StrandContext const& ctx) const +{ + // The following checks apply for both payments and offer crossing. + if (!src_ || !dst_) + { + JLOG(j_.debug()) << "MPTEndpointStep: specified bad account."; + return temBAD_PATH; + } + + if (src_ == dst_) + { + JLOG(j_.debug()) << "MPTEndpointStep: same src and dst."; + return temBAD_PATH; + } + + auto const sleSrc = ctx.view.read(keylet::account(src_)); + if (!sleSrc) + { + JLOG(j_.warn()) << "MPTEndpointStep: can't receive MPT from non-existent issuer: " << src_; + return terNO_ACCOUNT; + } + + // pure issue/redeem can't be frozen (issuer/holder) + if (!(ctx.isLast && ctx.isFirst)) + { + auto const& account = ctx.isFirst ? src_ : dst_; + if (isFrozen(ctx.view, account, mptIssue_)) + return terLOCKED; + } + + if (ctx.seenBookOuts.count(mptIssue_) > 0) + { + if (ctx.prevStep == nullptr) + { + UNREACHABLE( + "xrpl::MPTEndpointStep::check : prev seen book without a " + "prev step"); + return temBAD_PATH_LOOP; + } + + // This is OK if the previous step is a book step that outputs this + // issue + if (auto book = ctx.prevStep->bookStepBook()) + { + if (book->out.get() != mptIssue_) + return temBAD_PATH_LOOP; + } + } + + if ((ctx.isFirst && !ctx.seenDirectAssets[0].insert(mptIssue_).second) || + (ctx.isLast && !ctx.seenDirectAssets[1].insert(mptIssue_).second)) + { + JLOG(j_.debug()) << "MPTEndpointStep: loop detected: Index: " << ctx.strandSize << ' ' + << *this; + return temBAD_PATH_LOOP; + } + + // MPT can only be an endpoint + if (!ctx.isLast && !ctx.isFirst) + { + JLOG(j_.warn()) << "MPTEndpointStep: MPT can only be an endpoint"; + return temBAD_PATH; + } + + auto const& issuer = mptIssue_.getIssuer(); + if ((src_ != issuer && dst_ != issuer) || (src_ == issuer && dst_ == issuer)) + { + JLOG(j_.warn()) << "MPTEndpointStep: invalid src/dst"; + return temBAD_PATH; + } + + return static_cast(this)->check(ctx, sleSrc); +} + +template +void +MPTEndpointStep::resetCache(xrpl::DebtDirection dir) +{ + cache_.emplace(MPTAmount(beast::zero), MPTAmount(beast::zero), MPTAmount(beast::zero), dir); +} + +//------------------------------------------------------------------------------ + +std::pair> +make_MPTEndpointStep( + StrandContext const& ctx, + AccountID const& src, + AccountID const& dst, + MPTID const& mpt) +{ + TER ter = tefINTERNAL; + std::unique_ptr r; + if (ctx.offerCrossing != OfferCrossing::no) + { + auto offerCrossingStep = std::make_unique(ctx, src, dst, mpt); + ter = offerCrossingStep->check(ctx); + r = std::move(offerCrossingStep); + } + else // payment + { + auto paymentStep = std::make_unique(ctx, src, dst, mpt); + ter = paymentStep->check(ctx); + r = std::move(paymentStep); + } + if (!isTesSuccess(ter)) + return {ter, nullptr}; + + return {tesSUCCESS, std::move(r)}; +} + +namespace test { +// Needed for testing +bool +mptEndpointStepEqual( + Step const& step, + AccountID const& src, + AccountID const& dst, + MPTID const& mptid) +{ + if (auto ds = dynamic_cast const*>(&step)) + { + return ds->src() == src && ds->dst() == dst && ds->mptID() == mptid; + } + return false; +} +} // namespace test + +} // namespace xrpl diff --git a/src/libxrpl/tx/paths/OfferStream.cpp b/src/libxrpl/tx/paths/OfferStream.cpp index b7dc431b23..47910d6861 100644 --- a/src/libxrpl/tx/paths/OfferStream.cpp +++ b/src/libxrpl/tx/paths/OfferStream.cpp @@ -1,11 +1,34 @@ -#include -#include -#include -#include -#include -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include namespace xrpl { @@ -13,14 +36,15 @@ namespace { bool checkIssuers(ReadView const& view, Book const& book) { - auto issuerExists = [](ReadView const& view, Issue const& iss) -> bool { - return isXRP(iss.account) || view.read(keylet::account(iss.account)); + auto issuerExists = [](ReadView const& view, Asset const& asset) -> bool { + auto const& issuer = asset.getIssuer(); + return isXRP(issuer) || view.exists(keylet::account(issuer)); }; return issuerExists(view, book.in) && issuerExists(view, book.out); } } // namespace -template +template TOfferStreamBase::TOfferStreamBase( ApplyView& view, ApplyView& cancelView, @@ -42,7 +66,7 @@ TOfferStreamBase::TOfferStreamBase( // Handle the case where a directory item with no corresponding ledger entry // is found. This shouldn't happen but if it does we clean it up. -template +template void TOfferStreamBase::erase(ApplyView& view) { @@ -75,67 +99,42 @@ TOfferStreamBase::erase(ApplyView& view) << tip_.dir(); } -static STAmount +template +static T accountFundsHelper( ReadView const& view, AccountID const& id, - STAmount const& saDefault, - Issue const&, + T const& amtDefault, + Asset const& asset, FreezeHandling freezeHandling, + AuthHandling authHandling, beast::Journal j) { - return accountFunds(view, id, saDefault, freezeHandling, j); -} - -static IOUAmount -accountFundsHelper( - ReadView const& view, - AccountID const& id, - IOUAmount const& amtDefault, - Issue const& issue, - FreezeHandling freezeHandling, - beast::Journal j) -{ - if (issue.account == id) + if constexpr (std::is_same_v) { - // self funded - return amtDefault; + if (id == asset.getIssuer()) + { + // self funded + return amtDefault; + } + } + else if constexpr (std::is_same_v) + { + if (id == asset.getIssuer()) + { + return toAmount(issuerFundsToSelfIssue(view, asset.get())); + } } - return toAmount( - accountHolds(view, id, issue.currency, issue.account, freezeHandling, j)); + return toAmount(accountHolds(view, id, asset, freezeHandling, authHandling, j)); } -static XRPAmount -accountFundsHelper( - ReadView const& view, - AccountID const& id, - XRPAmount const& amtDefault, - Issue const& issue, - FreezeHandling freezeHandling, - beast::Journal j) -{ - return toAmount( - accountHolds(view, id, issue.currency, issue.account, freezeHandling, j)); -} - -template +template template + requires ValidTaker bool TOfferStreamBase::shouldRmSmallIncreasedQOffer() const { - static_assert( - std::is_same_v || std::is_same_v, - "STAmount is not supported"); - - static_assert( - std::is_same_v || std::is_same_v, - "STAmount is not supported"); - - static_assert( - !std::is_same_v || !std::is_same_v, - "Cannot have XRP/XRP offers"); - // Consider removing the offer if: // o `TakerPays` is XRP (because of XRP drops granularity) or // o `TakerPays` and `TakerGets` are both IOU and `TakerPays`<`TakerGets` @@ -156,14 +155,14 @@ TOfferStreamBase::shouldRmSmallIncreasedQOffer() const if constexpr (!inIsXRP && !outIsXRP) { - if (ofrAmts.in >= ofrAmts.out) + if (Number(ofrAmts.in) >= Number(ofrAmts.out)) return false; } TTakerGets const ownerFunds = toAmount(*ownerFunds_); auto const effectiveAmounts = [&] { - if (offer_.owner() != offer_.issueOut().account && ownerFunds < ofrAmts.out) + if (offer_.owner() != offer_.assetOut().getIssuer() && ownerFunds < ofrAmts.out) { // adjust the amounts by owner funds. // @@ -185,7 +184,7 @@ TOfferStreamBase::shouldRmSmallIncreasedQOffer() const return effectiveQuality < offer_.quality(); } -template +template bool TOfferStreamBase::step() { @@ -203,7 +202,7 @@ TOfferStreamBase::step() if (!tip_.step(j_)) return false; - std::shared_ptr entry = tip_.entry(); + std::shared_ptr const entry = tip_.entry(); // If we exceed the maximum number of allowed steps, we're done. if (!counter_.step()) @@ -240,9 +239,7 @@ TOfferStreamBase::step() continue; } - bool const deepFrozen = isDeepFrozen( - view_, offer_.owner(), offer_.issueIn().currency, offer_.issueIn().account); - if (deepFrozen) + if (isDeepFrozen(view_, offer_.owner(), offer_.assetIn())) { JLOG(j_.trace()) << "Removing deep frozen unfunded offer " << entry->key(); permRmOffer(entry->key()); @@ -262,7 +259,13 @@ TOfferStreamBase::step() // Calculate owner funds ownerFunds_ = accountFundsHelper( - view_, offer_.owner(), amount.out, offer_.issueOut(), fhZERO_IF_FROZEN, j_); + view_, + offer_.owner(), + amount.out, + offer_.assetOut(), + fhZERO_IF_FROZEN, + ahZERO_IF_UNAUTHORIZED, + j_); // Check for unfunded offer if (*ownerFunds_ <= beast::zero) @@ -271,7 +274,13 @@ TOfferStreamBase::step() // we haven't modified the balance and therefore the // offer is "found unfunded" versus "became unfunded" auto const original_funds = accountFundsHelper( - cancelView_, offer_.owner(), amount.out, offer_.issueOut(), fhZERO_IF_FROZEN, j_); + cancelView_, + offer_.owner(), + amount.out, + offer_.assetOut(), + fhZERO_IF_FROZEN, + ahZERO_IF_UNAUTHORIZED, + j_); if (original_funds == *ownerFunds_) { @@ -287,44 +296,16 @@ TOfferStreamBase::step() continue; } - bool const rmSmallIncreasedQOffer = [&] { - bool const inIsXRP = isXRP(offer_.issueIn()); - bool const outIsXRP = isXRP(offer_.issueOut()); - if (inIsXRP && !outIsXRP) - { - // Without the `if constexpr`, the - // `shouldRmSmallIncreasedQOffer` template will be instantiated - // even if it is never used. This can cause compiler errors in - // some cases, hence the `if constexpr` guard. - // Note that TIn can be XRPAmount or STAmount, and TOut can be - // IOUAmount or STAmount. - if constexpr (!(std::is_same_v || std::is_same_v)) - return shouldRmSmallIncreasedQOffer(); - } - if (!inIsXRP && outIsXRP) - { - // See comment above for `if constexpr` rationale - if constexpr (!(std::is_same_v || std::is_same_v)) - return shouldRmSmallIncreasedQOffer(); - } - if (!inIsXRP && !outIsXRP) - { - // See comment above for `if constexpr` rationale - if constexpr (!(std::is_same_v || std::is_same_v)) - return shouldRmSmallIncreasedQOffer(); - } - // LCOV_EXCL_START - UNREACHABLE( - "xrpl::TOfferStreamBase::step::rmSmallIncreasedQOffer : XRP " - "vs XRP offer"); - return false; - // LCOV_EXCL_STOP - }(); - - if (rmSmallIncreasedQOffer) + if (shouldRmSmallIncreasedQOffer()) { auto const original_funds = accountFundsHelper( - cancelView_, offer_.owner(), amount.out, offer_.issueOut(), fhZERO_IF_FROZEN, j_); + cancelView_, + offer_.owner(), + amount.out, + offer_.assetOut(), + fhZERO_IF_FROZEN, + ahZERO_IF_UNAUTHORIZED, + j_); if (original_funds == *ownerFunds_) { @@ -348,26 +329,28 @@ TOfferStreamBase::step() return true; } -void -OfferStream::permRmOffer(uint256 const& offerIndex) -{ - offerDelete(cancelView_, cancelView_.peek(keylet::offer(offerIndex)), j_); -} - -template +template void FlowOfferStream::permRmOffer(uint256 const& offerIndex) { permToRemove_.insert(offerIndex); } -template class FlowOfferStream; template class FlowOfferStream; template class FlowOfferStream; template class FlowOfferStream; +template class FlowOfferStream; +template class FlowOfferStream; +template class FlowOfferStream; +template class FlowOfferStream; +template class FlowOfferStream; -template class TOfferStreamBase; template class TOfferStreamBase; template class TOfferStreamBase; template class TOfferStreamBase; +template class TOfferStreamBase; +template class TOfferStreamBase; +template class TOfferStreamBase; +template class TOfferStreamBase; +template class TOfferStreamBase; } // namespace xrpl diff --git a/src/libxrpl/tx/paths/PaySteps.cpp b/src/libxrpl/tx/paths/PaySteps.cpp index 33b63f7714..b9dc8b2ab4 100644 --- a/src/libxrpl/tx/paths/PaySteps.cpp +++ b/src/libxrpl/tx/paths/PaySteps.cpp @@ -1,11 +1,32 @@ +#include +#include +#include #include +#include +#include #include #include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include #include +#include + #include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -32,12 +53,6 @@ checkNear(IOUAmount const& expected, IOUAmount const& actual) return r <= ratTol; }; -bool -checkNear(XRPAmount const& expected, XRPAmount const& actual) -{ - return expected == actual; -}; - static bool isXRPAccount(STPathElement const& pe) { @@ -51,12 +66,12 @@ toStep( StrandContext const& ctx, STPathElement const* e1, STPathElement const* e2, - Issue const& curIssue) + Asset const& curAsset) { auto& j = ctx.j; if (ctx.isFirst && e1->isAccount() && - ((e1->getNodeType() & STPathElement::typeCurrency) != 0u) && isXRP(e1->getCurrency())) + ((e1->getNodeType() & STPathElement::typeCurrency) != 0u) && e1->getPathAsset().isXRP()) { return make_XRPEndpointStep(ctx, e1->getAccountID()); } @@ -64,9 +79,32 @@ toStep( if (ctx.isLast && isXRPAccount(*e1) && e2->isAccount()) return make_XRPEndpointStep(ctx, e2->getAccountID()); + // MPTEndpointStep is created in following cases: + // 1 Direct payment between an issuer and a holder + // e1 is issuer and e2 is holder or vise versa + // There is only one step in this case: holder->issuer or + // issuer->holder + // 2 Direct payment between the holders + // e1 is issuer and e2 is holder or vise versa + // There are two steps in this case: holder->issuer->holder1 + // 3 Cross-token payment with Amount or SendMax or both MPT + // If destination is an issuer then the last step is BookStep, + // otherwise the last step is MPTEndpointStep where e1 is + // the issuer and e2 is the holder. + // In all cases MPTEndpointStep is always first or last step, + // e1/e2 are always account types, and curAsset is always MPT. + if (e1->isAccount() && e2->isAccount()) { - return make_DirectStepI(ctx, e1->getAccountID(), e2->getAccountID(), curIssue.currency); + return curAsset.visit( + [&](MPTIssue const& issue) { + return make_MPTEndpointStep( + ctx, e1->getAccountID(), e2->getAccountID(), issue.getMptID()); + }, + [&](Issue const& issue) { + return make_DirectStepI( + ctx, e1->getAccountID(), e2->getAccountID(), issue.currency); + }); } if (e1->isOffer() && e2->isAccount()) @@ -80,17 +118,16 @@ toStep( } XRPL_ASSERT( - (e2->getNodeType() & STPathElement::typeCurrency) || + (e2->getNodeType() & STPathElement::typeAsset) || (e2->getNodeType() & STPathElement::typeIssuer), "xrpl::toStep : currency or issuer"); - auto const outCurrency = ((e2->getNodeType() & STPathElement::typeCurrency) != 0u) - ? e2->getCurrency() - : curIssue.currency; + PathAsset const outAsset = + ((e2->getNodeType() & STPathElement::typeAsset) != 0u) ? e2->getPathAsset() : curAsset; auto const outIssuer = ((e2->getNodeType() & STPathElement::typeIssuer) != 0u) ? e2->getIssuerID() - : curIssue.account; + : curAsset.getIssuer(); - if (isXRP(curIssue.currency) && isXRP(outCurrency)) + if (isXRP(curAsset) && outAsset.isXRP()) { JLOG(j.info()) << "Found xrp/xrp offer payment step"; return {temBAD_PATH, std::unique_ptr{}}; @@ -98,13 +135,35 @@ toStep( XRPL_ASSERT(e2->isOffer(), "xrpl::toStep : is offer"); - if (isXRP(outCurrency)) - return make_BookStepIX(ctx, curIssue); + if (outAsset.isXRP()) + { + return curAsset.visit( + [&](MPTIssue const& issue) { return make_BookStepMX(ctx, issue); }, + [&](Issue const& issue) { return make_BookStepIX(ctx, issue); }); + } - if (isXRP(curIssue.currency)) - return make_BookStepXI(ctx, {outCurrency, outIssuer}); + if (isXRP(curAsset)) + { + return outAsset.visit( + [&](MPTID const& mpt) { return make_BookStepXM(ctx, mpt); }, + [&](Currency const& currency) { return make_BookStepXI(ctx, {currency, outIssuer}); }); + } - return make_BookStepII(ctx, curIssue, {outCurrency, outIssuer}); + return curAsset.visit( + [&](MPTIssue const& issue) { + return outAsset.visit( + [&](Currency const& currency) { + return make_BookStepMI(ctx, issue, {currency, outIssuer}); + }, + [&](MPTID const& mpt) { return make_BookStepMM(ctx, issue, mpt); }); + }, + [&](Issue const& issue) { + return outAsset.visit( + [&](MPTID const& mpt) { return make_BookStepIM(ctx, issue, mpt); }, + [&](Currency const& currency) { + return make_BookStepII(ctx, issue, {currency, outIssuer}); + }); + }); } std::pair @@ -112,9 +171,9 @@ toStrand( ReadView const& view, AccountID const& src, AccountID const& dst, - Issue const& deliver, + Asset const& deliver, std::optional const& limitQuality, - std::optional const& sendMaxIssue, + std::optional const& sendMaxAsset, STPath const& path, bool ownerPaysTransferFee, OfferCrossing offerCrossing, @@ -123,15 +182,21 @@ toStrand( beast::Journal j) { if (isXRP(src) || isXRP(dst) || !isConsistent(deliver) || - (sendMaxIssue && !isConsistent(*sendMaxIssue))) + (sendMaxAsset && !isConsistent(*sendMaxAsset))) return {temBAD_PATH, Strand{}}; - if ((sendMaxIssue && sendMaxIssue->account == noAccount()) || (src == noAccount()) || - (dst == noAccount()) || (deliver.account == noAccount())) + if ((sendMaxAsset && sendMaxAsset->getIssuer() == noAccount()) || (src == noAccount()) || + (dst == noAccount()) || (deliver.getIssuer() == noAccount())) return {temBAD_PATH, Strand{}}; - for (auto const& pe : path) + if ((deliver.holds() && deliver.getIssuer() == beast::zero) || + (sendMaxAsset && sendMaxAsset->holds() && + sendMaxAsset->getIssuer() == beast::zero)) + return {temBAD_PATH, Strand{}}; + + for (std::size_t i = 0; i < path.size(); ++i) { + auto const& pe = path[i]; auto const t = pe.getNodeType(); if (((t & ~STPathElement::typeAll) != 0u) || (t == 0u)) @@ -140,6 +205,8 @@ toStrand( bool const hasAccount = (t & STPathElement::typeAccount) != 0u; bool const hasIssuer = (t & STPathElement::typeIssuer) != 0u; bool const hasCurrency = (t & STPathElement::typeCurrency) != 0u; + bool const hasMPT = (t & STPathElement::typeMPT) != 0u; + bool const hasAsset = (t & STPathElement::typeAsset) != 0u; if (hasAccount && (hasIssuer || hasCurrency)) return {temBAD_PATH, Strand{}}; @@ -158,17 +225,33 @@ toStrand( if (hasAccount && (pe.getAccountID() == noAccount())) return {temBAD_PATH, Strand{}}; + + if (hasMPT && (hasCurrency || hasAccount)) + return {temBAD_PATH, Strand{}}; + + if (hasMPT && hasIssuer && (pe.getIssuerID() != getMPTIssuer(pe.getMPTID()))) + return {temBAD_PATH, Strand{}}; + + // No rippling if MPT + if (i > 0 && path[i - 1].hasMPT() && (hasAccount || (hasIssuer && !hasAsset))) + return {temBAD_PATH, Strand{}}; } - Issue curIssue = [&] { - auto const& currency = sendMaxIssue ? sendMaxIssue->currency : deliver.currency; - if (isXRP(currency)) - return xrpIssue(); - return Issue{currency, src}; + Asset curAsset = [&]() -> Asset { + auto const& asset = sendMaxAsset ? *sendMaxAsset : deliver; + return asset.visit( + [&](MPTIssue const& issue) -> Asset { return asset; }, + [&](Issue const& issue) -> Asset { + if (isXRP(asset)) + return xrpIssue(); + // First step ripples from the source to the issuer. + return Issue{issue.currency, src}; + }); }(); - auto hasCurrency = [](STPathElement const pe) { - return pe.getNodeType() & STPathElement::typeCurrency; + // Currency or MPT + auto hasAsset = [](STPathElement const pe) { + return pe.getNodeType() & STPathElement::typeAsset; }; std::vector normPath; @@ -176,13 +259,28 @@ toStrand( // sendmax and deliver. normPath.reserve(4 + path.size()); { - normPath.emplace_back(STPathElement::typeAll, src, curIssue.currency, curIssue.account); + // The first step of a path is always implied to be the sender of the + // transaction, as defined by the transaction's Account field. The Asset + // is either SendMax or Deliver. + auto const t = [&]() { + auto const t = STPathElement::typeAccount | STPathElement::typeIssuer; + return curAsset.visit( + [&](MPTIssue const&) { return t | STPathElement::typeMPT; }, + [&](Issue const&) { return t | STPathElement::typeCurrency; }); + }(); + // If MPT then the issuer is the actual issuer, it is never the source + // account. + normPath.emplace_back(t, src, curAsset, curAsset.getIssuer()); - if (sendMaxIssue && sendMaxIssue->account != src && + // If transaction includes SendMax with the issuer, which is not + // the sender of the transaction, that issuer is implied to be + // the second step of the path. Unless the path starts at an address, + // which is the issuer of SendMax. + if (sendMaxAsset && sendMaxAsset->getIssuer() != src && (path.empty() || !path[0].isAccount() || - path[0].getAccountID() != sendMaxIssue->account)) + path[0].getAccountID() != sendMaxAsset->getIssuer())) { - normPath.emplace_back(sendMaxIssue->account, std::nullopt, std::nullopt); + normPath.emplace_back(sendMaxAsset->getIssuer(), std::nullopt, std::nullopt); } for (auto const& i : path) @@ -190,22 +288,32 @@ toStrand( { // Note that for offer crossing (only) we do use an offer book - // even if all that is changing is the Issue.account. - STPathElement const& lastCurrency = - *std::find_if(normPath.rbegin(), normPath.rend(), hasCurrency); - if ((lastCurrency.getCurrency() != deliver.currency) || - ((offerCrossing != 0u) && lastCurrency.getIssuerID() != deliver.account)) + // even if all that is changing is the Issue.account. Note + // that MPTIssue can't change the account. + STPathElement const& lastAsset = + *std::find_if(normPath.rbegin(), normPath.rend(), hasAsset); + if (lastAsset.getPathAsset() != deliver || + (offerCrossing != OfferCrossing::no && + lastAsset.getIssuerID() != deliver.getIssuer())) { - normPath.emplace_back(std::nullopt, deliver.currency, deliver.account); + normPath.emplace_back(std::nullopt, deliver, deliver.getIssuer()); } } - if (!((normPath.back().isAccount() && normPath.back().getAccountID() == deliver.account) || - (dst == deliver.account))) + // If the Amount field of the transaction includes an issuer that is not + // the same as the Destination of the transaction, that issuer is + // implied to be the second-to-last step of the path. If normPath.back + // is an offer, which sells MPT then the added path element account is + // the MPT's issuer. + if (!((normPath.back().isAccount() && + normPath.back().getAccountID() == deliver.getIssuer()) || + (dst == deliver.getIssuer()))) { - normPath.emplace_back(deliver.account, std::nullopt, std::nullopt); + normPath.emplace_back(deliver.getIssuer(), std::nullopt, std::nullopt); } + // Last step of a path is always implied to be the receiver of a + // transaction, as defined by the transaction's Destination field. if (!normPath.back().isAccount() || normPath.back().getAccountID() != dst) { normPath.emplace_back(dst, std::nullopt, std::nullopt); @@ -227,11 +335,11 @@ toStrand( at most twice: once as a src and once as a dst (hence the two element array). The strandSrc and strandDst will only show up once each. */ - std::array, 2> seenDirectIssues; + std::array, 2> seenDirectAssets; // A strand may not include the same offer book more than once - boost::container::flat_set seenBookOuts; - seenDirectIssues[0].reserve(normPath.size()); - seenDirectIssues[1].reserve(normPath.size()); + boost::container::flat_set seenBookOuts; + seenDirectAssets[0].reserve(normPath.size()); + seenDirectAssets[1].reserve(normPath.size()); seenBookOuts.reserve(normPath.size()); auto ctx = [&](bool isLast = false) { return StrandContext{ @@ -245,7 +353,7 @@ toStrand( ownerPaysTransferFee, offerCrossing, isDefaultPath, - seenDirectIssues, + seenDirectAssets, seenBookOuts, ammContext, domainID, @@ -265,58 +373,96 @@ toStrand( auto cur = &normPath[i]; auto const next = &normPath[i + 1]; - if (cur->isAccount()) + // Switch over from MPT to Currency. In this case curAsset account + // can be different from the issuer. If cur is MPT then curAsset + // is just set to MPTID. + if (curAsset.holds() && cur->hasCurrency()) { - curIssue.account = cur->getAccountID(); - } - else if (cur->hasIssuer()) - { - curIssue.account = cur->getIssuerID(); + curAsset = Issue{}; } + // Can only update the account for Issue since MPTIssue's account + // is immutable as it is part of MPTID. + curAsset.visit( + [&](Issue const&) { + if (cur->isAccount()) + { + curAsset.get().account = cur->getAccountID(); + } + else if (cur->hasIssuer()) + { + curAsset.get().account = cur->getIssuerID(); + } + }, + [](MPTIssue const&) {}); + if (cur->hasCurrency()) { - curIssue.currency = cur->getCurrency(); - if (isXRP(curIssue.currency)) - curIssue.account = xrpAccount(); + curAsset = Issue{cur->getCurrency(), curAsset.getIssuer()}; + if (isXRP(curAsset)) + curAsset.get().account = xrpAccount(); } + else if (cur->hasMPT()) + { + curAsset = cur->getPathAsset().get(); + } + + using ImpliedStepRet = std::pair>; + auto getImpliedStep = [&](AccountID const& src_, + AccountID const& dst_, + Asset const& asset_) -> ImpliedStepRet { + return asset_.visit( + [&](MPTIssue const&) -> ImpliedStepRet { + JLOG(j.error()) << "MPT is invalid with rippling"; + return {temBAD_PATH, nullptr}; + }, + [&](Issue const& issue) -> ImpliedStepRet { + return make_DirectStepI(ctx(), src_, dst_, issue.currency); + }); + }; if (cur->isAccount() && next->isAccount()) { - if (!isXRP(curIssue.currency) && curIssue.account != cur->getAccountID() && - curIssue.account != next->getAccountID()) + // This block doesn't execute + // since curAsset's account is set to cur's account above. + // It should not execute for MPT either because MPT rippling + // is invalid. Should this block be removed/amendment excluded? + if (!isXRP(curAsset) && curAsset.getIssuer() != cur->getAccountID() && + curAsset.getIssuer() != next->getAccountID()) { JLOG(j.trace()) << "Inserting implied account"; - auto msr = make_DirectStepI( - ctx(), cur->getAccountID(), curIssue.account, curIssue.currency); + auto msr = getImpliedStep(cur->getAccountID(), curAsset.getIssuer(), curAsset); if (!isTesSuccess(msr.first)) return {msr.first, Strand{}}; result.push_back(std::move(msr.second)); impliedPE.emplace( - STPathElement::typeAccount, curIssue.account, xrpCurrency(), xrpAccount()); + STPathElement::typeAccount, curAsset.getIssuer(), xrpCurrency(), xrpAccount()); cur = &*impliedPE; } } else if (cur->isAccount() && next->isOffer()) { - if (curIssue.account != cur->getAccountID()) + // Same as above, this block doesn't execute. + if (curAsset.getIssuer() != cur->getAccountID()) { JLOG(j.trace()) << "Inserting implied account before offer"; - auto msr = make_DirectStepI( - ctx(), cur->getAccountID(), curIssue.account, curIssue.currency); + auto msr = getImpliedStep(cur->getAccountID(), curAsset.getIssuer(), curAsset); if (!isTesSuccess(msr.first)) return {msr.first, Strand{}}; result.push_back(std::move(msr.second)); impliedPE.emplace( - STPathElement::typeAccount, curIssue.account, xrpCurrency(), xrpAccount()); + STPathElement::typeAccount, curAsset.getIssuer(), xrpCurrency(), xrpAccount()); cur = &*impliedPE; } } else if (cur->isOffer() && next->isAccount()) { - if (curIssue.account != next->getAccountID() && !isXRP(next->getAccountID())) + // If the offer sells MPT, then next's account is always the issuer. + // See how normPath step is added for second-to-last or last + // step. Therefore, this block never executes if MPT. + if (curAsset.getIssuer() != next->getAccountID() && !isXRP(next->getAccountID())) { - if (isXRP(curIssue)) + if (isXRP(curAsset)) { if (i != normPath.size() - 2) return {temBAD_PATH, Strand{}}; @@ -330,8 +476,7 @@ toStrand( else { JLOG(j.trace()) << "Inserting implied account after offer"; - auto msr = make_DirectStepI( - ctx(), curIssue.account, next->getAccountID(), curIssue.currency); + auto msr = getImpliedStep(curAsset.getIssuer(), next->getAccountID(), curAsset); if (!isTesSuccess(msr.first)) return {msr.first, Strand{}}; result.push_back(std::move(msr.second)); @@ -340,7 +485,7 @@ toStrand( continue; } - if (!next->isOffer() && next->hasCurrency() && next->getCurrency() != curIssue.currency) + if (!next->isOffer() && next->hasAsset() && next->getPathAsset() != curAsset) { // Should never happen // LCOV_EXCL_START @@ -349,7 +494,7 @@ toStrand( // LCOV_EXCL_STOP } - auto s = toStep(ctx(/*isLast*/ i == normPath.size() - 2), cur, next, curIssue); + auto s = toStep(ctx(/*isLast*/ i == normPath.size() - 2), cur, next, curAsset); if (isTesSuccess(s.first)) { result.emplace_back(std::move(s.second)); @@ -366,17 +511,21 @@ toStrand( if (auto r = s.directStepAccts()) return *r; if (auto const r = s.bookStepBook()) - return std::make_pair(r->in.account, r->out.account); + return std::make_pair(r->in.getIssuer(), r->out.getIssuer()); Throw(tefEXCEPTION, "Step should be either a direct or book step"); return std::make_pair(xrpAccount(), xrpAccount()); }; auto curAcc = src; - auto curIss = [&] { - auto& currency = sendMaxIssue ? sendMaxIssue->currency : deliver.currency; - if (isXRP(currency)) - return xrpIssue(); - return Issue{currency, src}; + auto curAsset = [&]() -> Asset { + auto const& asset = sendMaxAsset ? *sendMaxAsset : deliver; + return asset.visit( + [&](MPTIssue const&) -> Asset { return asset; }, + [&](Issue const& issue) -> Asset { + if (isXRP(asset)) + return xrpIssue(); + return Issue{issue.currency, src}; + }); }(); for (auto const& s : result) @@ -387,22 +536,25 @@ toStrand( if (auto const b = s->bookStepBook()) { - if (curIss != b->in) + if (curAsset != b->in) return false; - curIss = b->out; + curAsset = b->out; } - else + else if (curAsset.holds()) { - curIss.account = accts.second; + curAsset.get().account = accts.second; } curAcc = accts.second; } if (curAcc != dst) return false; - if (curIss.currency != deliver.currency) + if (curAsset.holds() != deliver.holds() || + (curAsset.holds() && + curAsset.get().currency != deliver.get().currency) || + (curAsset.holds() && curAsset.get() != deliver.get())) return false; - if (curIss.account != deliver.account && curIss.account != dst) + if (curAsset.getIssuer() != deliver.getIssuer() && curAsset.getIssuer() != dst) return false; return true; }; @@ -424,9 +576,9 @@ toStrands( ReadView const& view, AccountID const& src, AccountID const& dst, - Issue const& deliver, + Asset const& deliver, std::optional const& limitQuality, - std::optional const& sendMax, + std::optional const& sendMax, STPathSet const& paths, bool addDefaultPath, bool ownerPaysTransferFee, @@ -539,14 +691,14 @@ StrandContext::StrandContext( // replicates the source or destination. AccountID const& strandSrc_, AccountID const& strandDst_, - Issue const& strandDeliver_, + Asset const& strandDeliver_, std::optional const& limitQuality_, bool isLast_, bool ownerPaysTransferFee_, OfferCrossing offerCrossing_, bool isDefaultPath_, - std::array, 2>& seenDirectIssues_, - boost::container::flat_set& seenBookOuts_, + std::array, 2>& seenDirectAssets_, + boost::container::flat_set& seenBookOuts_, AMMContext& ammContext_, std::optional const& domainID_, beast::Journal j_) @@ -562,7 +714,7 @@ StrandContext::StrandContext( , isDefaultPath(isDefaultPath_) , strandSize(strand_.size()) , prevStep(!strand_.empty() ? strand_.back().get() : nullptr) - , seenDirectIssues(seenDirectIssues_) + , seenDirectAssets(seenDirectAssets_) , seenBookOuts(seenBookOuts_) , ammContext(ammContext_) , domainID(domainID_) @@ -570,25 +722,4 @@ StrandContext::StrandContext( { } -template -bool -isDirectXrpToXrp(Strand const& strand) -{ - return false; -} - -template <> -bool -isDirectXrpToXrp(Strand const& strand) -{ - return (strand.size() == 2); -} - -template bool -isDirectXrpToXrp(Strand const& strand); -template bool -isDirectXrpToXrp(Strand const& strand); -template bool -isDirectXrpToXrp(Strand const& strand); - } // namespace xrpl diff --git a/src/libxrpl/tx/paths/RippleCalc.cpp b/src/libxrpl/tx/paths/RippleCalc.cpp index c9f0c9e0fb..395a0a3cc7 100644 --- a/src/libxrpl/tx/paths/RippleCalc.cpp +++ b/src/libxrpl/tx/paths/RippleCalc.cpp @@ -1,8 +1,21 @@ -#include -#include -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include namespace xrpl { namespace path { @@ -54,7 +67,7 @@ RippleCalc::rippleCalculate( auto const sendMax = [&]() -> std::optional { if (saMaxAmountReq >= beast::zero || - saMaxAmountReq.getCurrency() != saDstAmountReq.getCurrency() || + !equalTokens(saMaxAmountReq.asset(), saDstAmountReq.asset()) || saMaxAmountReq.getIssuer() != uSrcAccountID) { return saMaxAmountReq; diff --git a/src/libxrpl/tx/paths/XRPEndpointStep.cpp b/src/libxrpl/tx/paths/XRPEndpointStep.cpp index 7452f57ecd..6356eb8ded 100644 --- a/src/libxrpl/tx/paths/XRPEndpointStep.cpp +++ b/src/libxrpl/tx/paths/XRPEndpointStep.cpp @@ -1,18 +1,34 @@ #include +#include +#include +#include +#include #include #include -#include -#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include #include #include +#include #include #include #include +#include +#include +#include #include +#include +#include namespace xrpl { @@ -179,13 +195,25 @@ private: // because the trust line was created after the XRP was removed.) // Return how much the reserve should be reduced. // - // Note that reduced reserve only happens if the trust line does not + // Note that reduced reserve only happens if the trust line or MPT does not // currently exist. static std::int32_t computeReserveReduction(StrandContext const& ctx, AccountID const& acc) { - if (ctx.isFirst && !ctx.view.read(keylet::line(acc, ctx.strandDeliver))) - return -1; + if (ctx.isFirst) + { + return ctx.strandDeliver.visit( + [&](Issue const& issue) { + if (!ctx.view.exists(keylet::line(acc, issue))) + return -1; + return 0; + }, + [&](MPTIssue const& issue) { + if (!ctx.view.exists(keylet::mptoken(issue.getMptID(), acc))) + return -1; + return 0; + }); + } return 0; } @@ -283,9 +311,9 @@ XRPEndpointStep::validFwd(PaymentSandbox& sb, ApplyView& afView, Eithe return {false, EitherAmount(XRPAmount(beast::zero))}; } - XRPL_ASSERT(in.native, "xrpl::XRPEndpointStep::validFwd : input is XRP"); + XRPL_ASSERT(in.holds(), "xrpl::XRPEndpointStep::validFwd : input is XRP"); - auto const& xrpIn = in.xrp; + auto const& xrpIn = in.get(); auto const balance = static_cast(this)->xrpLiquid(sb); if (!isLast_ && balance < xrpIn) @@ -336,7 +364,7 @@ XRPEndpointStep::check(StrandContext const& ctx) const return ter; auto const issuesIndex = isLast_ ? 0 : 1; - if (!ctx.seenDirectIssues[issuesIndex].insert(xrpIssue()).second) + if (!ctx.seenDirectAssets[issuesIndex].insert(xrpIssue()).second) { JLOG(j_.debug()) << "XRPEndpointStep: loop detected: Index: " << ctx.strandSize << ' ' << *this; diff --git a/src/libxrpl/tx/transactors/account/AccountDelete.cpp b/src/libxrpl/tx/transactors/account/AccountDelete.cpp index 8f74a204ad..1a197a6f51 100644 --- a/src/libxrpl/tx/transactors/account/AccountDelete.cpp +++ b/src/libxrpl/tx/transactors/account/AccountDelete.cpp @@ -1,22 +1,38 @@ +#include + #include +#include +#include +#include #include +#include +#include +#include #include #include #include +#include #include +#include #include #include +#include +#include #include -#include -#include -#include +#include +#include +#include +#include #include #include #include -#include #include #include +#include +#include +#include + namespace xrpl { bool @@ -292,7 +308,7 @@ AccountDelete::preclaim(PreclaimContext const& ctx) if (!cdirFirst(ctx.view, ownerDirKeylet.key, sleDirNode, uDirEntry, dirEntry)) return tesSUCCESS; - std::int32_t deletableDirEntryCount{0}; + std::uint32_t deletableDirEntryCount{0}; do { // Make sure any directory node types that we find are the kind diff --git a/src/libxrpl/tx/transactors/account/AccountSet.cpp b/src/libxrpl/tx/transactors/account/AccountSet.cpp index 98f0360410..b113fc62e9 100644 --- a/src/libxrpl/tx/transactors/account/AccountSet.cpp +++ b/src/libxrpl/tx/transactors/account/AccountSet.cpp @@ -1,13 +1,30 @@ +#include + +#include #include -#include +#include +#include +#include +#include +#include #include #include #include +#include +#include +#include #include #include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include namespace xrpl { @@ -63,8 +80,9 @@ AccountSet::preflight(PreflightContext const& ctx) // // RequireAuth // - bool bSetRequireAuth = ((uTxFlags & tfRequireAuth) != 0u) || (uSetFlag == asfRequireAuth); - bool bClearRequireAuth = ((uTxFlags & tfOptionalAuth) != 0u) || (uClearFlag == asfRequireAuth); + bool const bSetRequireAuth = ((uTxFlags & tfRequireAuth) != 0u) || (uSetFlag == asfRequireAuth); + bool const bClearRequireAuth = + ((uTxFlags & tfOptionalAuth) != 0u) || (uClearFlag == asfRequireAuth); if (bSetRequireAuth && bClearRequireAuth) { @@ -75,8 +93,9 @@ AccountSet::preflight(PreflightContext const& ctx) // // RequireDestTag // - bool bSetRequireDest = ((uTxFlags & tfRequireDestTag) != 0u) || (uSetFlag == asfRequireDest); - bool bClearRequireDest = + bool const bSetRequireDest = + ((uTxFlags & tfRequireDestTag) != 0u) || (uSetFlag == asfRequireDest); + bool const bClearRequireDest = ((uTxFlags & tfOptionalDestTag) != 0u) || (uClearFlag == asfRequireDest); if (bSetRequireDest && bClearRequireDest) @@ -88,8 +107,9 @@ AccountSet::preflight(PreflightContext const& ctx) // // DisallowXRP // - bool bSetDisallowXRP = ((uTxFlags & tfDisallowXRP) != 0u) || (uSetFlag == asfDisallowXRP); - bool bClearDisallowXRP = ((uTxFlags & tfAllowXRP) != 0u) || (uClearFlag == asfDisallowXRP); + bool const bSetDisallowXRP = ((uTxFlags & tfDisallowXRP) != 0u) || (uSetFlag == asfDisallowXRP); + bool const bClearDisallowXRP = + ((uTxFlags & tfAllowXRP) != 0u) || (uClearFlag == asfDisallowXRP); if (bSetDisallowXRP && bClearDisallowXRP) { @@ -100,7 +120,7 @@ AccountSet::preflight(PreflightContext const& ctx) // TransferRate if (tx.isFieldPresent(sfTransferRate)) { - std::uint32_t uRate = tx.getFieldU32(sfTransferRate); + std::uint32_t const uRate = tx.getFieldU32(sfTransferRate); if ((uRate != 0u) && (uRate < QUALITY_ONE)) { @@ -217,7 +237,7 @@ AccountSet::preclaim(PreclaimContext const& ctx) std::uint32_t const uSetFlag = ctx.tx.getFieldU32(sfSetFlag); // legacy AccountSet flags - bool bSetRequireAuth = ((uTxFlags & tfRequireAuth) != 0u) || (uSetFlag == asfRequireAuth); + bool const bSetRequireAuth = ((uTxFlags & tfRequireAuth) != 0u) || (uSetFlag == asfRequireAuth); // // RequireAuth @@ -531,7 +551,7 @@ AccountSet::doApply() // if (tx.isFieldPresent(sfTransferRate)) { - std::uint32_t uRate = tx.getFieldU32(sfTransferRate); + std::uint32_t const uRate = tx.getFieldU32(sfTransferRate); if (uRate == 0 || uRate == QUALITY_ONE) { diff --git a/src/libxrpl/tx/transactors/account/SetRegularKey.cpp b/src/libxrpl/tx/transactors/account/SetRegularKey.cpp index 42a6e89fae..f370b56460 100644 --- a/src/libxrpl/tx/transactors/account/SetRegularKey.cpp +++ b/src/libxrpl/tx/transactors/account/SetRegularKey.cpp @@ -1,8 +1,16 @@ -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { XRPAmount diff --git a/src/libxrpl/tx/transactors/account/SignerListSet.cpp b/src/libxrpl/tx/transactors/account/SignerListSet.cpp index cf0d65c06f..fb3cb3b603 100644 --- a/src/libxrpl/tx/transactors/account/SignerListSet.cpp +++ b/src/libxrpl/tx/transactors/account/SignerListSet.cpp @@ -1,16 +1,34 @@ +#include + +#include +#include +#include +#include #include #include #include +#include #include #include +#include +#include +#include #include #include #include +#include #include -#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include namespace xrpl { @@ -167,7 +185,7 @@ removeSignersFromLedger( { // We have to examine the current SignerList so we know how much to // reduce the OwnerCount. - SLE::pointer signers = view.peek(signerListKeylet); + SLE::pointer const signers = view.peek(signerListKeylet); // If the signer list doesn't exist we've already succeeded in deleting it. if (!signers) @@ -299,7 +317,7 @@ SignerListSet::replaceSignerList() std::uint32_t const oldOwnerCount{(*sle)[sfOwnerCount]}; constexpr int addedOwnerCount = 1; - std::uint32_t flags{lsfOneOwnerCount}; + std::uint32_t const flags{lsfOneOwnerCount}; XRPAmount const newReserve{view().fees().accountReserve(oldOwnerCount + addedOwnerCount)}; @@ -339,7 +357,7 @@ SignerListSet::destroySignerList() auto const accountKeylet = keylet::account(account_); // Destroying the signer list is only allowed if either the master key // is enabled or there is a regular key. - SLE::pointer ledgerEntry = view().peek(accountKeylet); + SLE::pointer const ledgerEntry = view().peek(accountKeylet); if (!ledgerEntry) return tefINTERNAL; // LCOV_EXCL_LINE diff --git a/src/libxrpl/tx/transactors/bridge/XChainBridge.cpp b/src/libxrpl/tx/transactors/bridge/XChainBridge.cpp index b94da8ef6d..71592904f5 100644 --- a/src/libxrpl/tx/transactors/bridge/XChainBridge.cpp +++ b/src/libxrpl/tx/transactors/bridge/XChainBridge.cpp @@ -1,31 +1,51 @@ +#include + +#include #include #include -#include #include +#include #include +#include #include #include +#include +#include #include #include #include #include #include +#include +#include +#include +#include #include #include #include #include +#include #include +#include +#include #include #include #include #include +#include #include #include #include -#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include namespace xrpl { @@ -119,7 +139,7 @@ checkAttestationPublicKey( else { // regular key - if (std::optional regularKey = + if (std::optional const regularKey = (*sleAttestationSigningAccount)[~sfRegularKey]; regularKey != accountFromPK) { @@ -326,7 +346,8 @@ onClaim( std::unordered_map const& signersList, beast::Journal j) { - XChainClaimAttestation::MatchFields toMatch{sendingAmount, wasLockingChainSend, std::nullopt}; + XChainClaimAttestation::MatchFields const toMatch{ + sendingAmount, wasLockingChainSend, std::nullopt}; return claimHelper(attestations, view, toMatch, CheckDst::ignore, quorum, signersList, j); } @@ -638,10 +659,10 @@ finalizeClaimHelper( auto const round_mode = innerSb.rules().enabled(fixXChainRewardRounding) ? Number::rounding_mode::downward : Number::getround(); - saveNumberRoundMode _{Number::setround(round_mode)}; + saveNumberRoundMode const _{Number::setround(round_mode)}; STAmount const den{rewardAccounts.size()}; - return divide(rewardPool, den, rewardPool.issue()); + return divide(rewardPool, den, rewardPool.asset()); }(); STAmount distributed = rewardPool.zeroed(); for (auto const& rewardAccount : rewardAccounts) @@ -1166,7 +1187,7 @@ attestationPreflight(PreflightContext const& ctx) if (att->sendingAmount.signum() <= 0) return temXCHAIN_BAD_PROOF; auto const expectedIssue = bridgeSpec.issue(STXChainBridge::srcChain(att->wasLockingChainSend)); - if (att->sendingAmount.issue() != expectedIssue) + if (att->sendingAmount.asset() != expectedIssue) return temXCHAIN_BAD_PROOF; return tesSUCCESS; @@ -1577,8 +1598,8 @@ XChainClaim::preflight(PreflightContext const& ctx) auto const amount = ctx.tx[sfAmount]; if (amount.signum() <= 0 || - (amount.issue() != bridgeSpec.lockingChainIssue() && - amount.issue() != bridgeSpec.issuingChainIssue())) + (amount.asset() != bridgeSpec.lockingChainIssue() && + amount.asset() != bridgeSpec.issuingChainIssue())) { return temBAD_AMOUNT; } @@ -1627,12 +1648,12 @@ XChainClaim::preclaim(PreclaimContext const& ctx) if (isLockingChain) { - if (bridgeSpec.lockingChainIssue() != thisChainAmount.issue()) + if (bridgeSpec.lockingChainIssue() != thisChainAmount.asset()) return tecXCHAIN_BAD_TRANSFER_ISSUE; } else { - if (bridgeSpec.issuingChainIssue() != thisChainAmount.issue()) + if (bridgeSpec.issuingChainIssue() != thisChainAmount.asset()) return tecXCHAIN_BAD_TRANSFER_ISSUE; } } @@ -1819,8 +1840,8 @@ XChainCommit::preflight(PreflightContext const& ctx) if (amount.signum() <= 0 || !isLegalNet(amount)) return temBAD_AMOUNT; - if (amount.issue() != bridgeSpec.lockingChainIssue() && - amount.issue() != bridgeSpec.issuingChainIssue()) + if (amount.asset() != bridgeSpec.lockingChainIssue() && + amount.asset() != bridgeSpec.issuingChainIssue()) return temBAD_ISSUER; return tesSUCCESS; @@ -1865,12 +1886,12 @@ XChainCommit::preclaim(PreclaimContext const& ctx) if (isLockingChain) { - if (bridgeSpec.lockingChainIssue() != ctx.tx[sfAmount].issue()) + if (bridgeSpec.lockingChainIssue() != ctx.tx[sfAmount].asset()) return tecXCHAIN_BAD_TRANSFER_ISSUE; } else { - if (bridgeSpec.issuingChainIssue() != ctx.tx[sfAmount].issue()) + if (bridgeSpec.issuingChainIssue() != ctx.tx[sfAmount].asset()) return tecXCHAIN_BAD_TRANSFER_ISSUE; } @@ -2082,7 +2103,7 @@ XChainCreateAccountCommit::preflight(PreflightContext const& ctx) if (reward.signum() < 0 || !reward.native()) return temBAD_AMOUNT; - if (reward.issue() != amount.issue()) + if (reward.asset() != amount.asset()) return temBAD_AMOUNT; return tesSUCCESS; @@ -2114,7 +2135,7 @@ XChainCreateAccountCommit::preclaim(PreclaimContext const& ctx) if (amount < *minCreateAmount) return tecXCHAIN_INSUFF_CREATE_AMOUNT; - if (minCreateAmount->issue() != amount.issue()) + if (minCreateAmount->asset() != amount.asset()) return tecXCHAIN_BAD_TRANSFER_ISSUE; AccountID const thisDoor = (*sleBridge)[sfAccount]; @@ -2142,7 +2163,7 @@ XChainCreateAccountCommit::preclaim(PreclaimContext const& ctx) } STXChainBridge::ChainType const dstChain = STXChainBridge::otherChain(srcChain); - if (bridgeSpec.issue(srcChain) != ctx.tx[sfAmount].issue()) + if (bridgeSpec.issue(srcChain) != ctx.tx[sfAmount].asset()) return tecXCHAIN_BAD_TRANSFER_ISSUE; if (!isXRP(bridgeSpec.issue(dstChain))) diff --git a/src/libxrpl/tx/transactors/check/CheckCancel.cpp b/src/libxrpl/tx/transactors/check/CheckCancel.cpp index 0b9a9a90af..efbd6fdeb6 100644 --- a/src/libxrpl/tx/transactors/check/CheckCancel.cpp +++ b/src/libxrpl/tx/transactors/check/CheckCancel.cpp @@ -1,11 +1,16 @@ +#include + +#include #include #include #include -#include +#include #include +#include #include -#include -#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/check/CheckCash.cpp b/src/libxrpl/tx/transactors/check/CheckCash.cpp index d4861e524a..f783710354 100644 --- a/src/libxrpl/tx/transactors/check/CheckCash.cpp +++ b/src/libxrpl/tx/transactors/check/CheckCash.cpp @@ -1,18 +1,50 @@ -#include -#include -#include -#include -#include -#include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + #include +#include +#include +#include namespace xrpl { +bool +CheckCash::checkExtraFeatures(xrpl::PreflightContext const& ctx) +{ + auto const optAmount = ctx.tx[~sfAmount]; + auto const optDeliverMin = ctx.tx[~sfDeliverMin]; + + return ctx.rules.enabled(featureMPTokensV2) || + (!(optAmount && optAmount->holds()) && + !(optDeliverMin && optDeliverMin->holds())); +} + NotTEC CheckCash::preflight(PreflightContext const& ctx) { @@ -35,7 +67,7 @@ CheckCash::preflight(PreflightContext const& ctx) return temBAD_AMOUNT; } - if (badCurrency() == value.getCurrency()) + if (badAsset() == value.asset()) { JLOG(ctx.j.warn()) << "Malformed transaction: Bad currency."; return temBAD_CURRENCY; @@ -106,8 +138,7 @@ CheckCash::preclaim(PreclaimContext const& ctx) }(ctx.tx)}; STAmount const sendMax = sleCheck->at(sfSendMax); - Currency const currency{value.getCurrency()}; - if (currency != sendMax.getCurrency()) + if (!equalTokens(value.asset(), sendMax.asset())) { JLOG(ctx.j.warn()) << "Check cash does not match check currency."; return temMALFORMED; @@ -127,8 +158,13 @@ CheckCash::preclaim(PreclaimContext const& ctx) // Make sure the check owner holds at least value. If they have // less than value the check cannot be cashed. { - STAmount availableFunds{ - accountFunds(ctx.view, sleCheck->at(sfAccount), value, fhZERO_IF_FROZEN, ctx.j)}; + STAmount availableFunds{accountFunds( + ctx.view, + sleCheck->at(sfAccount), + value, + fhZERO_IF_FROZEN, + ahZERO_IF_UNAUTHORIZED, + ctx.j)}; // Note that src will have one reserve's worth of additional XRP // once the check is cashed, since the check's reserve will no @@ -147,51 +183,94 @@ CheckCash::preclaim(PreclaimContext const& ctx) // An issuer can always accept their own currency. if (!value.native() && (value.getIssuer() != dstId)) { - auto const sleIssuer = ctx.view.read(keylet::account(issuerId)); - if (!sleIssuer) - { - JLOG(ctx.j.warn()) - << "Can't receive IOUs from non-existent issuer: " << to_string(issuerId); - return tecNO_ISSUER; - } + return value.asset().visit( + [&](Issue const& issue) -> TER { + Currency const currency{issue.currency}; + auto const sleTrustLine = + ctx.view.read(keylet::line(dstId, issuerId, currency)); - if ((sleIssuer->at(sfFlags) & lsfRequireAuth) != 0u) - { - auto const sleTrustLine = ctx.view.read(keylet::line(dstId, issuerId, currency)); + auto const sleIssuer = ctx.view.read(keylet::account(issuerId)); + if (!sleIssuer) + { + JLOG(ctx.j.warn()) << "Can't receive IOUs from " + "non-existent issuer: " + << to_string(issuerId); + return tecNO_ISSUER; + } - if (!sleTrustLine) - { - // We can only create a trust line if the issuer does not - // have lsfRequireAuth set. - return tecNO_AUTH; - } + if ((sleIssuer->at(sfFlags) & lsfRequireAuth) != 0u) + { + if (!sleTrustLine) + { + // We can only create a trust line if the issuer + // does not have lsfRequireAuth set. + return tecNO_AUTH; + } - // Entries have a canonical representation, determined by a - // lexicographical "greater than" comparison employing strict - // weak ordering. Determine which entry we need to access. - bool const canonical_gt(dstId > issuerId); + // Entries have a canonical representation, + // determined by a lexicographical "greater than" + // comparison employing strict weak ordering. + // Determine which entry we need to access. + bool const canonical_gt(dstId > issuerId); - bool const is_authorized( - (sleTrustLine->at(sfFlags) & (canonical_gt ? lsfLowAuth : lsfHighAuth)) != 0u); + bool const is_authorized( + (sleTrustLine->at(sfFlags) & + (canonical_gt ? lsfLowAuth : lsfHighAuth)) != 0u); - if (!is_authorized) - { - JLOG(ctx.j.warn()) << "Can't receive IOUs from issuer without auth."; - return tecNO_AUTH; - } - } + if (!is_authorized) + { + JLOG(ctx.j.warn()) << "Can't receive IOUs from " + "issuer without auth."; + return tecNO_AUTH; + } + } - // The trustline from source to issuer does not need to - // be checked for freezing, since we already verified that the - // source has sufficient non-frozen funds available. + // The trustline from source to issuer does not need to + // be checked for freezing, since we already verified + // that the source has sufficient non-frozen funds + // available. - // However, the trustline from destination to issuer may not - // be frozen. - if (isFrozen(ctx.view, dstId, currency, issuerId)) - { - JLOG(ctx.j.warn()) << "Cashing a check to a frozen trustline."; - return tecFROZEN; - } + // However, the trustline from destination to issuer may + // not be frozen. + if (isFrozen(ctx.view, dstId, currency, issuerId)) + { + JLOG(ctx.j.warn()) << "Cashing a check to a frozen trustline."; + return tecFROZEN; + } + + return tesSUCCESS; + }, + [&](MPTIssue const& issue) -> TER { + auto const sleIssuer = ctx.view.read(keylet::account(issuerId)); + if (!sleIssuer) + { + JLOG(ctx.j.warn()) << "Can't receive MPTs from " + "non-existent issuer: " + << to_string(issuerId); + return tecNO_ISSUER; + } + + if (auto const err = requireAuth(ctx.view, issue, dstId, AuthType::WeakAuth); + !isTesSuccess(err)) + { + JLOG(ctx.j.warn()) << "Cashing a check to a MPT requiring auth."; + return err; + } + + if (isFrozen(ctx.view, dstId, issue)) + { + JLOG(ctx.j.warn()) << "Cashing a check to a frozen MPT."; + return tecLOCKED; + } + + if (auto const err = canTrade(ctx.view, value.asset()); !isTesSuccess(err)) + { + JLOG(ctx.j.warn()) << "MPT DEX is not allowed."; + return err; + } + + return tesSUCCESS; + }); } } return tesSUCCESS; @@ -287,96 +366,152 @@ CheckCash::doApply() // maximum possible currency because there might be a gateway // transfer rate to account for. Since the transfer rate cannot // exceed 200%, we use 1/2 maxValue as our limit. + auto const maxDeliverMin = [&]() { + return optDeliverMin->asset().visit( + [&](Issue const&) { + return STAmount( + optDeliverMin->asset(), STAmount::cMaxValue / 2, STAmount::cMaxOffset); + }, + [&](MPTIssue const&) { + return STAmount(optDeliverMin->asset(), maxMPTokenAmount / 2); + }); + }; STAmount const flowDeliver{ - optDeliverMin - ? STAmount( - optDeliverMin->issue(), STAmount::cMaxValue / 2, STAmount::cMaxOffset) - : ctx_.tx.getFieldAmount(sfAmount)}; + optDeliverMin ? maxDeliverMin() : ctx_.tx.getFieldAmount(sfAmount)}; - // If a trust line does not exist yet create one. - Issue const& trustLineIssue = flowDeliver.issue(); - AccountID const issuer = flowDeliver.getIssuer(); - AccountID const truster = issuer == account_ ? srcId : account_; - Keylet const trustLineKey = keylet::line(truster, trustLineIssue); - bool const destLow = issuer > account_; + // Check reserve. Return destination account SLE if enough reserve, + // otherwise return nullptr. + auto checkReserve = [&]() -> std::shared_ptr { + auto sleDst = psb.peek(keylet::account(account_)); - if (!psb.exists(trustLineKey)) - { - // 1. Can the check casher meet the reserve for the trust line? - // 2. Create trust line between destination (this) account - // and the issuer. - // 3. Apply correct noRipple settings on trust line. Use... - // a. this (destination) account and - // b. issuing account (not sending account). - - auto const sleDst = psb.peek(keylet::account(account_)); - - // Can the account cover the trust line's reserve? + // Can the account cover the trust line's or MPT reserve? if (std::uint32_t const ownerCount = {sleDst->at(sfOwnerCount)}; preFeeBalance_ < psb.fees().accountReserve(ownerCount + 1)) { JLOG(j_.trace()) << "Trust line does not exist. " - "Insufficent reserve to create line."; + "Insufficient reserve to create line."; - return tecNO_LINE_INSUF_RESERVE; + return nullptr; } + return sleDst; + }; - Currency const currency = flowDeliver.getCurrency(); - STAmount initialBalance(flowDeliver.issue()); - initialBalance.setIssuer(noAccount()); + std::optional trustLineKey; + STAmount savedLimit; + bool destLow = false; + AccountID const& deliverIssuer = flowDeliver.getIssuer(); + auto const err = flowDeliver.asset().visit( + [&](Issue const& issue) -> std::optional { + // If a trust line does not exist yet create one. + Issue const& trustLineIssue = issue; + AccountID const truster = deliverIssuer == account_ ? srcId : account_; + trustLineKey = keylet::line(truster, trustLineIssue); + destLow = deliverIssuer > account_; - // clang-format off - if (TER const ter = trustCreate( - psb, // payment sandbox - destLow, // is dest low? - issuer, // source - account_, // destination - trustLineKey.key, // ledger index - sleDst, // Account to add to - false, // authorize account - (sleDst->getFlags() & lsfDefaultRipple) == 0, - false, // freeze trust line - false, // deep freeze trust line - initialBalance, // zero initial balance - Issue(currency, account_), // limit of zero - 0, // quality in - 0, // quality out - viewJ); // journal - !isTesSuccess(ter)) + if (!psb.exists(*trustLineKey)) + { + // 1. Can the check casher meet the reserve for the + // trust line? + // 2. Create trust line between destination (this) + // account + // and the issuer. + // 3. Apply correct noRipple settings on trust line. + // Use... + // a. this (destination) account and + // b. issuing account (not sending account). + + auto const sleDst = checkReserve(); + if (sleDst == nullptr) + return tecNO_LINE_INSUF_RESERVE; + + Currency const& currency = issue.currency; + STAmount initialBalance(flowDeliver.asset()); + initialBalance.get().account = noAccount(); + + if (TER const ter = trustCreate( + psb, // payment sandbox + destLow, // is dest low? + deliverIssuer, // source + account_, // destination + trustLineKey->key, // ledger index + sleDst, // Account to add to + false, // authorize account + (sleDst->getFlags() & lsfDefaultRipple) == 0, // + false, // freeze trust line + false, // deep freeze trust line + initialBalance, // zero initial balance + Issue(currency, account_), // limit of zero + 0, // quality in + 0, // quality out + viewJ); // journal + !isTesSuccess(ter)) + { + return ter; + } + + psb.update(sleDst); + + // Note that we _don't_ need to be careful about + // destroying the trust line if the check cashing + // fails. The transaction machinery will + // automatically clean it up. + } + + // Since the destination is signing the check, they + // clearly want the funds even if their new total funds + // would exceed the limit on their trust line. So we + // tweak the trust line limits before calling flow and + // then restore the trust line limits afterwards. + auto const sleTrustLine = psb.peek(*trustLineKey); + if (!sleTrustLine) + return tecNO_LINE; + + SF_AMOUNT const& tweakedLimit = destLow ? sfLowLimit : sfHighLimit; + savedLimit = sleTrustLine->at(tweakedLimit); + + // Set the trust line limit to the highest possible + // value while flow runs. + STAmount const bigAmount( + trustLineIssue, STAmount::cMaxValue, STAmount::cMaxOffset); + sleTrustLine->at(tweakedLimit) = bigAmount; + + return std::nullopt; + }, + [&](MPTIssue const& issue) -> std::optional { + if (account_ != deliverIssuer) + { + auto const& mptID = issue.getMptID(); + // Create MPT if it doesn't exist + auto const mptokenKey = keylet::mptoken(mptID, account_); + if (!psb.exists(mptokenKey)) + { + auto sleDst = checkReserve(); + if (sleDst == nullptr) + return tecINSUFFICIENT_RESERVE; + + if (auto const err = checkCreateMPT(psb, mptID, account_, j_); + !isTesSuccess(err)) + { + return err; + } + } + } + + return std::nullopt; + }); + if (err) + return *err; + // Make sure the tweaked limits are restored when we leave + // scope. + scope_exit const fixup([&psb, &trustLineKey, destLow, &savedLimit]() { + if (trustLineKey) { - return ter; + SF_AMOUNT const& tweakedLimit = destLow ? sfLowLimit : sfHighLimit; + if (auto const sleTrustLine = psb.peek(*trustLineKey)) + sleTrustLine->at(tweakedLimit) = savedLimit; } - // clang-format on - - psb.update(sleDst); - - // Note that we _don't_ need to be careful about destroying - // the trust line if the check cashing fails. The transaction - // machinery will automatically clean it up. - } - - // Since the destination is signing the check, they clearly want - // the funds even if their new total funds would exceed the limit - // on their trust line. So we tweak the trust line limits before - // calling flow and then restore the trust line limits afterwards. - auto const sleTrustLine = psb.peek(trustLineKey); - if (!sleTrustLine) - return tecNO_LINE; - - SF_AMOUNT const& tweakedLimit = destLow ? sfLowLimit : sfHighLimit; - STAmount const savedLimit = sleTrustLine->at(tweakedLimit); - - // Make sure the tweaked limits are restored when we leave scope. - scope_exit fixup([&psb, &trustLineKey, &tweakedLimit, &savedLimit]() { - if (auto const sleTrustLine = psb.peek(trustLineKey)) - sleTrustLine->at(tweakedLimit) = savedLimit; }); - // Set the trust line limit to the highest possible value - // while flow runs. - STAmount const bigAmount(trustLineIssue, STAmount::cMaxValue, STAmount::cMaxOffset); - sleTrustLine->at(tweakedLimit) = bigAmount; - // Let flow() do the heavy lifting on a check for an IOU. auto const result = flow( psb, @@ -407,6 +542,7 @@ CheckCash::doApply() JLOG(ctx_.journal.warn()) << "flow did not produce DeliverMin."; return tecPATH_PARTIAL; } + ctx_.deliver(result.actualAmountOut); } // Set the delivered amount metadata in all cases, not just diff --git a/src/libxrpl/tx/transactors/check/CheckCreate.cpp b/src/libxrpl/tx/transactors/check/CheckCreate.cpp index 4f962a7fa6..64ab3b9150 100644 --- a/src/libxrpl/tx/transactors/check/CheckCreate.cpp +++ b/src/libxrpl/tx/transactors/check/CheckCreate.cpp @@ -1,15 +1,38 @@ +#include + +#include +#include +#include #include #include #include -#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include #include -#include -#include +#include + +#include +#include +#include namespace xrpl { +bool +CheckCreate::checkExtraFeatures(xrpl::PreflightContext const& ctx) +{ + return ctx.rules.enabled(featureMPTokensV2) || !ctx.tx[sfSendMax].holds(); +} + NotTEC CheckCreate::preflight(PreflightContext const& ctx) { @@ -29,7 +52,7 @@ CheckCreate::preflight(PreflightContext const& ctx) return temBAD_AMOUNT; } - if (badCurrency() == sendMax.getCurrency()) + if (badAsset() == sendMax.asset()) { JLOG(ctx.j.warn()) << "Malformed transaction: Bad currency."; return temBAD_CURRENCY; @@ -52,6 +75,7 @@ TER CheckCreate::preclaim(PreclaimContext const& ctx) { AccountID const dstId{ctx.tx[sfDestination]}; + AccountID const srcId{ctx.tx[sfAccount]}; auto const sleDst = ctx.view.read(keylet::account(dstId)); if (!sleDst) { @@ -86,39 +110,56 @@ CheckCreate::preclaim(PreclaimContext const& ctx) { // The currency may not be globally frozen AccountID const& issuerId{sendMax.getIssuer()}; - if (isGlobalFrozen(ctx.view, issuerId)) + if (isGlobalFrozen(ctx.view, sendMax.asset())) { JLOG(ctx.j.warn()) << "Creating a check for frozen asset"; - return tecFROZEN; - } - // If this account has a trustline for the currency, that - // trustline may not be frozen. - // - // Note that we DO allow create check for a currency that the - // account does not yet have a trustline to. - AccountID const srcId{ctx.tx.getAccountID(sfAccount)}; - if (issuerId != srcId) - { - // Check if the issuer froze the line - auto const sleTrust = - ctx.view.read(keylet::line(srcId, issuerId, sendMax.getCurrency())); - if (sleTrust && sleTrust->isFlag((issuerId > srcId) ? lsfHighFreeze : lsfLowFreeze)) - { - JLOG(ctx.j.warn()) << "Creating a check for frozen trustline."; - return tecFROZEN; - } - } - if (issuerId != dstId) - { - // Check if dst froze the line. - auto const sleTrust = - ctx.view.read(keylet::line(issuerId, dstId, sendMax.getCurrency())); - if (sleTrust && sleTrust->isFlag((dstId > issuerId) ? lsfHighFreeze : lsfLowFreeze)) - { - JLOG(ctx.j.warn()) << "Creating a check for destination frozen trustline."; - return tecFROZEN; - } + return sendMax.asset().holds() ? tecLOCKED : tecFROZEN; } + auto const err = sendMax.asset().visit( + [&](Issue const& issue) -> std::optional { + // If this account has a trustline for the currency, + // that trustline may not be frozen. + // + // Note that we DO allow create check for a currency + // that the account does not yet have a trustline to. + if (issuerId != srcId) + { + // Check if the issuer froze the line + auto const sleTrust = + ctx.view.read(keylet::line(srcId, issuerId, issue.currency)); + if (sleTrust && + sleTrust->isFlag((issuerId > srcId) ? lsfHighFreeze : lsfLowFreeze)) + { + JLOG(ctx.j.warn()) << "Creating a check for frozen trustline."; + return tecFROZEN; + } + } + if (issuerId != dstId) + { + // Check if dst froze the line. + auto const sleTrust = + ctx.view.read(keylet::line(issuerId, dstId, issue.currency)); + if (sleTrust && + sleTrust->isFlag((dstId > issuerId) ? lsfHighFreeze : lsfLowFreeze)) + { + JLOG(ctx.j.warn()) << "Creating a check for " + "destination frozen trustline."; + return tecFROZEN; + } + } + + return std::nullopt; + }, + [&](MPTIssue const& issue) -> std::optional { + if (srcId != issuerId && isFrozen(ctx.view, srcId, issue)) + return tecLOCKED; + if (dstId != issuerId && isFrozen(ctx.view, dstId, issue)) + return tecLOCKED; + + return std::nullopt; + }); + if (err) + return *err; } } if (hasExpired(ctx.view, ctx.tx[~sfExpiration])) @@ -126,7 +167,8 @@ CheckCreate::preclaim(PreclaimContext const& ctx) JLOG(ctx.j.warn()) << "Creating a check that has already expired."; return tecEXPIRED; } - return tesSUCCESS; + + return canTrade(ctx.view, ctx.tx[sfSendMax].asset()); } TER diff --git a/src/libxrpl/tx/transactors/credentials/CredentialAccept.cpp b/src/libxrpl/tx/transactors/credentials/CredentialAccept.cpp index 9b7eb89661..0d33f82f5d 100644 --- a/src/libxrpl/tx/transactors/credentials/CredentialAccept.cpp +++ b/src/libxrpl/tx/transactors/credentials/CredentialAccept.cpp @@ -1,13 +1,22 @@ +#include + #include #include #include #include +#include #include #include +#include +#include +#include +#include +#include +#include #include -#include +#include -#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/credentials/CredentialCreate.cpp b/src/libxrpl/tx/transactors/credentials/CredentialCreate.cpp index 9c0ea0d43d..d56967e322 100644 --- a/src/libxrpl/tx/transactors/credentials/CredentialCreate.cpp +++ b/src/libxrpl/tx/transactors/credentials/CredentialCreate.cpp @@ -1,14 +1,26 @@ +#include + #include +#include +#include #include #include -#include +#include // IWYU pragma: keep #include #include #include +#include +#include +#include +#include +#include +#include #include -#include +#include #include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/credentials/CredentialDelete.cpp b/src/libxrpl/tx/transactors/credentials/CredentialDelete.cpp index e0fa6147aa..d701300da3 100644 --- a/src/libxrpl/tx/transactors/credentials/CredentialDelete.cpp +++ b/src/libxrpl/tx/transactors/credentials/CredentialDelete.cpp @@ -1,13 +1,18 @@ -#include -#include -#include -#include -#include -#include -#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/delegate/DelegateSet.cpp b/src/libxrpl/tx/transactors/delegate/DelegateSet.cpp index ddd5a4c910..a6cc121864 100644 --- a/src/libxrpl/tx/transactors/delegate/DelegateSet.cpp +++ b/src/libxrpl/tx/transactors/delegate/DelegateSet.cpp @@ -1,11 +1,20 @@ +#include + #include -#include +#include #include #include -#include +#include #include -#include -#include +#include +#include +#include +#include +#include + +#include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/delegate/DelegateUtils.cpp b/src/libxrpl/tx/transactors/delegate/DelegateUtils.cpp index d9d74a1212..4d3d97e443 100644 --- a/src/libxrpl/tx/transactors/delegate/DelegateUtils.cpp +++ b/src/libxrpl/tx/transactors/delegate/DelegateUtils.cpp @@ -1,12 +1,21 @@ +#include +#include +#include #include -#include +#include +#include +#include +#include + +#include +#include namespace xrpl { NotTEC checkTxPermission(std::shared_ptr const& delegate, STTx const& tx) { if (!delegate) - return terNO_DELEGATE_PERMISSION; // LCOV_EXCL_LINE + return terNO_DELEGATE_PERMISSION; auto const permissionArray = delegate->getFieldArray(sfPermissions); auto const txPermission = tx.getTxnType() + 1; @@ -28,7 +37,7 @@ loadGranularPermission( std::unordered_set& granularPermissions) { if (!delegate) - return; // LCOV_EXCL_LINE + return; auto const permissionArray = delegate->getFieldArray(sfPermissions); for (auto const& permission : permissionArray) diff --git a/src/libxrpl/tx/transactors/dex/AMMBid.cpp b/src/libxrpl/tx/transactors/dex/AMMBid.cpp index 11cb13be37..b46638de5d 100644 --- a/src/libxrpl/tx/transactors/dex/AMMBid.cpp +++ b/src/libxrpl/tx/transactors/dex/AMMBid.cpp @@ -1,26 +1,52 @@ -#include -#include -#include -#include -#include -#include #include -#include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { bool AMMBid::checkExtraFeatures(PreflightContext const& ctx) { - return ammEnabled(ctx.rules); + if (!ammEnabled(ctx.rules)) + return false; + + if (!ctx.rules.enabled(featureMPTokensV2) && + (ctx.tx[sfAsset].holds() || ctx.tx[sfAsset2].holds())) + return false; + + return true; } NotTEC AMMBid::preflight(PreflightContext const& ctx) { - if (auto const res = - invalidAMMAssetPair(ctx.tx[sfAsset].get(), ctx.tx[sfAsset2].get())) + if (auto const res = invalidAMMAssetPair(ctx.tx[sfAsset], ctx.tx[sfAsset2])) { JLOG(ctx.j.debug()) << "AMM Bid: Invalid asset pair."; return res; @@ -54,7 +80,7 @@ AMMBid::preflight(PreflightContext const& ctx) } if (ctx.rules.enabled(fixAMMv1_3)) { - AccountID account = ctx.tx[sfAccount]; + AccountID const account = ctx.tx[sfAccount]; std::set unique; for (auto const& obj : authAccounts) { @@ -110,7 +136,7 @@ AMMBid::preclaim(PreclaimContext const& ctx) if (bidMin) { - if (bidMin->issue() != lpTokens.issue()) + if (bidMin->asset() != lpTokens.asset()) { JLOG(ctx.j.debug()) << "AMM Bid: Invalid LPToken."; return temBAD_AMM_TOKENS; @@ -125,7 +151,7 @@ AMMBid::preclaim(PreclaimContext const& ctx) auto const bidMax = ctx.tx[~sfBidMax]; if (bidMax) { - if (bidMax->issue() != lpTokens.issue()) + if (bidMax->asset() != lpTokens.asset()) { JLOG(ctx.j.debug()) << "AMM Bid: Invalid LPToken."; return temBAD_AMM_TOKENS; @@ -200,7 +226,7 @@ applyBid(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::Jour { auctionSlot.makeFieldAbsent(sfDiscountedFee); } - auctionSlot.setFieldAmount(sfPrice, toSTAmount(lpTokens.issue(), minPrice)); + auctionSlot.setFieldAmount(sfPrice, toSTAmount(lpTokens.asset(), minPrice)); if (ctx_.tx.isFieldPresent(sfAuthAccounts)) { auctionSlot.setFieldArray(sfAuthAccounts, ctx_.tx.getFieldArray(sfAuthAccounts)); @@ -211,7 +237,7 @@ applyBid(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::Jour } // Burn the remaining bid amount auto const saBurn = - adjustLPTokens(lptAMMBalance, toSTAmount(lptAMMBalance.issue(), burn), IsDeposit::No); + adjustLPTokens(lptAMMBalance, toSTAmount(lptAMMBalance.asset(), burn), IsDeposit::No); if (saBurn >= lptAMMBalance) { // This error case should never occur. @@ -221,7 +247,7 @@ applyBid(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::Jour return tecINTERNAL; // LCOV_EXCL_STOP } - auto res = redeemIOU(sb, account_, saBurn, lpTokens.issue(), ctx_.journal); + auto res = redeemIOU(sb, account_, saBurn, lpTokens.get(), ctx_.journal); if (!isTesSuccess(res)) { JLOG(ctx_.journal.debug()) << "AMM Bid: failed to redeem."; @@ -321,7 +347,7 @@ applyBid(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::Jour sb, account_, auctionSlot[sfAccount], - toSTAmount(lpTokens.issue(), refund), + toSTAmount(lpTokens.asset(), refund), ctx_.journal); if (!isTesSuccess(res)) { diff --git a/src/libxrpl/tx/transactors/dex/AMMClawback.cpp b/src/libxrpl/tx/transactors/dex/AMMClawback.cpp index fa3302cce5..d31b1d793e 100644 --- a/src/libxrpl/tx/transactors/dex/AMMClawback.cpp +++ b/src/libxrpl/tx/transactors/dex/AMMClawback.cpp @@ -1,14 +1,30 @@ -#include -#include -#include -#include -#include -#include #include -#include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include namespace xrpl { @@ -19,6 +35,19 @@ AMMClawback::getFlagsMask(PreflightContext const& ctx) return tfAMMClawbackMask; } +bool +AMMClawback::checkExtraFeatures(xrpl::PreflightContext const& ctx) +{ + if (!ctx.rules.enabled(featureAMMClawback)) + return false; + + std::optional const clawAmount = ctx.tx[~sfAmount]; + + return ctx.rules.enabled(featureMPTokensV2) || + (!(clawAmount && clawAmount->holds()) && !ctx.tx[sfAsset].holds() && + !ctx.tx[sfAsset2].holds()); +} + NotTEC AMMClawback::preflight(PreflightContext const& ctx) { @@ -32,31 +61,31 @@ AMMClawback::preflight(PreflightContext const& ctx) } std::optional const clawAmount = ctx.tx[~sfAmount]; - auto const asset = ctx.tx[sfAsset].get(); - auto const asset2 = ctx.tx[sfAsset2].get(); + auto const asset = ctx.tx[sfAsset]; + auto const asset2 = ctx.tx[sfAsset2]; if (isXRP(asset)) return temMALFORMED; auto const flags = ctx.tx.getFlags(); - if (((flags & tfClawTwoAssets) != 0u) && asset.account != asset2.account) + if (((flags & tfClawTwoAssets) != 0u) && asset.getIssuer() != asset2.getIssuer()) { JLOG(ctx.j.trace()) << "AMMClawback: tfClawTwoAssets can only be enabled when two " "assets in the AMM pool are both issued by the issuer"; return temINVALID_FLAG; } - if (asset.account != issuer) + if (asset.getIssuer() != issuer) { JLOG(ctx.j.trace()) << "AMMClawback: Asset's account does not " "match Account field."; return temMALFORMED; } - if (clawAmount && clawAmount->get() != asset) + if (clawAmount && clawAmount->asset() != asset) { - JLOG(ctx.j.trace()) << "AMMClawback: Amount's issuer/currency subfield " + JLOG(ctx.j.trace()) << "AMMClawback: Amount's asset subfield " "does not match Asset field"; return temBAD_AMOUNT; } @@ -70,8 +99,8 @@ AMMClawback::preflight(PreflightContext const& ctx) TER AMMClawback::preclaim(PreclaimContext const& ctx) { - auto const asset = ctx.tx[sfAsset].get(); - auto const asset2 = ctx.tx[sfAsset2].get(); + auto const asset = ctx.tx[sfAsset]; + auto const asset2 = ctx.tx[sfAsset2]; auto const sleIssuer = ctx.view.read(keylet::account(ctx.tx[sfAccount])); if (!sleIssuer) return terNO_ACCOUNT; // LCOV_EXCL_LINE @@ -87,11 +116,38 @@ AMMClawback::preclaim(PreclaimContext const& ctx) } std::uint32_t const issuerFlagsIn = sleIssuer->getFieldU32(sfFlags); + if (!ctx.view.rules().enabled(featureMPTokensV2)) + { + // If AllowTrustLineClawback is not set or NoFreeze is set, return no + // permission + if (((issuerFlagsIn & lsfAllowTrustLineClawback) == 0u) || + ((issuerFlagsIn & lsfNoFreeze) != 0u)) + { + return tecNO_PERMISSION; + } + } - // If AllowTrustLineClawback is not set or NoFreeze is set, return no - // permission - if (((issuerFlagsIn & lsfAllowTrustLineClawback) == 0u) || - ((issuerFlagsIn & lsfNoFreeze) != 0u)) + auto const checkClawAsset = [&](Asset const asset) -> bool { + return asset.visit( + [&](Issue const& issue) { + if (issue.native()) + return false; // LCOV_EXCL_LINE + + return ((issuerFlagsIn & lsfAllowTrustLineClawback) != 0u) && + ((issuerFlagsIn & lsfNoFreeze) == 0u); + }, + [&](MPTIssue const& issue) { + auto const sleIssuance = ctx.view.read(keylet::mptIssuance(issue.getMptID())); + + return sleIssuance && sleIssuance->isFlag(lsfMPTCanClawback) && + sleIssuance->getAccountID(sfIssuer) == ctx.tx[sfAccount]; + }); + }; + + if (!checkClawAsset(asset)) + return tecNO_PERMISSION; + + if (ctx.tx.isFlag(tfClawTwoAssets) && !checkClawAsset(asset2)) return tecNO_PERMISSION; return tesSUCCESS; @@ -115,8 +171,8 @@ AMMClawback::applyGuts(Sandbox& sb) std::optional const clawAmount = ctx_.tx[~sfAmount]; AccountID const issuer = ctx_.tx[sfAccount]; AccountID const holder = ctx_.tx[sfHolder]; - Issue const asset = ctx_.tx[sfAsset].get(); - Issue const asset2 = ctx_.tx[sfAsset2].get(); + Asset const asset = ctx_.tx[sfAsset]; + Asset const asset2 = ctx_.tx[sfAsset2]; auto ammSle = sb.peek(keylet::amm(asset, asset2)); if (!ammSle) @@ -138,8 +194,15 @@ AMMClawback::applyGuts(Sandbox& sb) !res) return res.error(); // LCOV_EXCL_LINE } - auto const expected = - ammHolds(sb, *ammSle, asset, asset2, FreezeHandling::fhIGNORE_FREEZE, ctx_.journal); + + auto const expected = ammHolds( + sb, + *ammSle, + asset, + asset2, + FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, + ctx_.journal); if (!expected) return expected.error(); // LCOV_EXCL_LINE @@ -173,6 +236,7 @@ AMMClawback::applyGuts(Sandbox& sb) holdLPtokens, 0, FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, WithdrawAll::Yes, preFeeBalance_, ctx_.journal); @@ -204,7 +268,12 @@ AMMClawback::applyGuts(Sandbox& sb) << to_string(newLPTokenBalance.iou()) << " old balance: " << to_string(lptAMMBalance.iou()); - auto const ter = rippleCredit(sb, holder, issuer, amountWithdraw, true, j_); + auto sendAmount = [&](STAmount const& saAmount) -> TER { + bool const checkIssuer = saAmount.holds(); + return directSendNoFee(sb, holder, issuer, saAmount, checkIssuer, j_); + }; + + auto const ter = sendAmount(amountWithdraw); if (!isTesSuccess(ter)) return ter; // LCOV_EXCL_LINE @@ -217,7 +286,7 @@ AMMClawback::applyGuts(Sandbox& sb) auto const flags = ctx_.tx.getFlags(); if ((flags & tfClawTwoAssets) != 0u) - return rippleCredit(sb, holder, issuer, *amount2Withdraw, true, j_); + return sendAmount(*amount2Withdraw); return tesSUCCESS; } @@ -237,8 +306,7 @@ AMMClawback::equalWithdrawMatchingOneAmount( auto frac = Number{amount} / amountBalance; auto amount2Withdraw = amount2Balance * frac; - auto const lpTokensWithdraw = toSTAmount(lptAMMBalance.issue(), lptAMMBalance * frac); - + auto const lpTokensWithdraw = toSTAmount(lptAMMBalance.asset(), lptAMMBalance * frac); if (lpTokensWithdraw > holdLPtokens) { // if lptoken balance less than what the issuer intended to clawback, @@ -256,6 +324,7 @@ AMMClawback::equalWithdrawMatchingOneAmount( holdLPtokens, 0, FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, WithdrawAll::Yes, preFeeBalance_, ctx_.journal); @@ -288,6 +357,7 @@ AMMClawback::equalWithdrawMatchingOneAmount( tokensAdj, 0, FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, WithdrawAll::No, preFeeBalance_, ctx_.journal); @@ -302,11 +372,12 @@ AMMClawback::equalWithdrawMatchingOneAmount( holder, amountBalance, amount, - toSTAmount(amount2Balance.issue(), amount2Withdraw), + toSTAmount(amount2Balance.asset(), amount2Withdraw), lptAMMBalance, - toSTAmount(lptAMMBalance.issue(), lptAMMBalance * frac), + toSTAmount(lptAMMBalance.asset(), lptAMMBalance * frac), 0, FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, WithdrawAll::No, preFeeBalance_, ctx_.journal); diff --git a/src/libxrpl/tx/transactors/dex/AMMCreate.cpp b/src/libxrpl/tx/transactors/dex/AMMCreate.cpp index 1f0c01ea63..3c9adfef34 100644 --- a/src/libxrpl/tx/transactors/dex/AMMCreate.cpp +++ b/src/libxrpl/tx/transactors/dex/AMMCreate.cpp @@ -1,21 +1,54 @@ +#include + +#include +#include +#include #include +#include #include #include +#include #include +#include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include namespace xrpl { bool AMMCreate::checkExtraFeatures(PreflightContext const& ctx) { - return ammEnabled(ctx.rules); + if (!ammEnabled(ctx.rules)) + return false; + + if (!ctx.rules.enabled(featureMPTokensV2) && + (ctx.tx[sfAmount].holds() || ctx.tx[sfAmount2].holds())) + return false; + + return true; } NotTEC @@ -24,9 +57,9 @@ AMMCreate::preflight(PreflightContext const& ctx) auto const amount = ctx.tx[sfAmount]; auto const amount2 = ctx.tx[sfAmount2]; - if (amount.issue() == amount2.issue()) + if (amount.asset() == amount2.asset()) { - JLOG(ctx.j.debug()) << "AMM Instance: tokens can not have the same currency/issuer."; + JLOG(ctx.j.debug()) << "AMM Instance: tokens can not have the same asset."; return temBAD_AMM_TOKENS; } @@ -66,44 +99,44 @@ AMMCreate::preclaim(PreclaimContext const& ctx) auto const amount2 = ctx.tx[sfAmount2]; // Check if AMM already exists for the token pair - if (auto const ammKeylet = keylet::amm(amount.issue(), amount2.issue()); + if (auto const ammKeylet = keylet::amm(amount.asset(), amount2.asset()); ctx.view.read(ammKeylet)) { JLOG(ctx.j.debug()) << "AMM Instance: ltAMM already exists."; return tecDUPLICATE; } - if (auto const ter = requireAuth(ctx.view, amount.issue(), accountID); !isTesSuccess(ter)) + if (auto const ter = requireAuth(ctx.view, amount.asset(), accountID); !isTesSuccess(ter)) { - JLOG(ctx.j.debug()) << "AMM Instance: account is not authorized, " << amount.issue(); + JLOG(ctx.j.debug()) << "AMM Instance: account is not authorized, " << amount.asset(); return ter; } - if (auto const ter = requireAuth(ctx.view, amount2.issue(), accountID); !isTesSuccess(ter)) + if (auto const ter = requireAuth(ctx.view, amount2.asset(), accountID); !isTesSuccess(ter)) { - JLOG(ctx.j.debug()) << "AMM Instance: account is not authorized, " << amount2.issue(); + JLOG(ctx.j.debug()) << "AMM Instance: account is not authorized, " << amount2.asset(); return ter; } // Globally or individually frozen - if (isFrozen(ctx.view, accountID, amount.issue()) || - isFrozen(ctx.view, accountID, amount2.issue())) + if (isFrozen(ctx.view, accountID, amount.asset()) || + isFrozen(ctx.view, accountID, amount2.asset())) { JLOG(ctx.j.debug()) << "AMM Instance: involves frozen asset."; return tecFROZEN; } - auto noDefaultRipple = [](ReadView const& view, Issue const& issue) { - if (isXRP(issue)) + auto noDefaultRipple = [](ReadView const& view, Asset const& asset) { + if (asset.holds() || isXRP(asset)) return false; - if (auto const issuerAccount = view.read(keylet::account(issue.account))) + if (auto const issuerAccount = view.read(keylet::account(asset.getIssuer()))) return (issuerAccount->getFlags() & lsfDefaultRipple) == 0; return false; }; - if (noDefaultRipple(ctx.view, amount.issue()) || noDefaultRipple(ctx.view, amount2.issue())) + if (noDefaultRipple(ctx.view, amount.asset()) || noDefaultRipple(ctx.view, amount2.asset())) { JLOG(ctx.j.debug()) << "AMM Instance: DefaultRipple not set"; return terNO_RIPPLE; @@ -118,13 +151,16 @@ AMMCreate::preclaim(PreclaimContext const& ctx) return tecINSUF_RESERVE_LINE; } - auto insufficientBalance = [&](STAmount const& asset) { - if (isXRP(asset)) - return xrpBalance < asset; - return accountID != asset.issue().account && - accountHolds( - ctx.view, accountID, asset.issue(), FreezeHandling::fhZERO_IF_FROZEN, ctx.j) < - asset; + auto insufficientBalance = [&](STAmount const& amount) { + if (isXRP(amount)) + return xrpBalance < amount; + return accountFunds( + ctx.view, + accountID, + amount, + FreezeHandling::fhZERO_IF_FROZEN, + AuthHandling::ahZERO_IF_UNAUTHORIZED, + ctx.j) < amount; }; if (insufficientBalance(amount) || insufficientBalance(amount2)) @@ -134,7 +170,7 @@ AMMCreate::preclaim(PreclaimContext const& ctx) } auto isLPToken = [&](STAmount const& amount) -> bool { - if (auto const sle = ctx.view.read(keylet::account(amount.issue().account))) + if (auto const sle = ctx.view.read(keylet::account(amount.asset().getIssuer()))) return sle->isFieldPresent(sfAMMID); return false; }; @@ -149,11 +185,18 @@ AMMCreate::preclaim(PreclaimContext const& ctx) if (ctx.view.rules().enabled(featureSingleAssetVault)) { if (auto const accountId = - pseudoAccountAddress(ctx.view, keylet::amm(amount.issue(), amount2.issue()).key); + pseudoAccountAddress(ctx.view, keylet::amm(amount.asset(), amount2.asset()).key); accountId == beast::zero) return terADDRESS_COLLISION; } + if (auto const ter = checkMPTTxAllowed(ctx.view, ttAMM_CREATE, amount.asset(), accountID); + !isTesSuccess(ter)) + return ter; + if (auto const ter = checkMPTTxAllowed(ctx.view, ttAMM_CREATE, amount2.asset(), accountID); + !isTesSuccess(ter)) + return ter; + // If featureAMMClawback is enabled, allow AMMCreate without checking // if the issuer has clawback enabled if (ctx.view.rules().enabled(featureAMMClawback)) @@ -161,20 +204,34 @@ AMMCreate::preclaim(PreclaimContext const& ctx) // Disallow AMM if the issuer has clawback enabled when featureAMMClawback // is not enabled - auto clawbackDisabled = [&](Issue const& issue) -> TER { - if (isXRP(issue)) - return tesSUCCESS; - auto const sle = ctx.view.read(keylet::account(issue.account)); - if (!sle) - return tecINTERNAL; // LCOV_EXCL_LINE - if (sle->getFlags() & lsfAllowTrustLineClawback) - return tecNO_PERMISSION; - return tesSUCCESS; + auto clawbackDisabled = [&](Asset const& asset) -> TER { + return asset.visit( + [&](MPTIssue const& issue) -> TER { + auto const sle = ctx.view.read(keylet::mptIssuance(issue.getMptID())); + if (!sle) + return tecINTERNAL; // LCOV_EXCL_LINE + if (sle->isFlag(lsfMPTCanClawback)) + return tecNO_PERMISSION; + return tesSUCCESS; + }, + [&](Issue const& issue) -> TER { + if (isXRP(issue)) + return tesSUCCESS; + auto const sle = ctx.view.read(keylet::account(issue.account)); + if (!sle) + return tecINTERNAL; // LCOV_EXCL_LINE + if (sle->isFlag(lsfAllowTrustLineClawback)) + return tecNO_PERMISSION; + return tesSUCCESS; + }); }; - if (auto const ter = clawbackDisabled(amount.issue()); !isTesSuccess(ter)) + if (auto const ter = clawbackDisabled(amount.asset()); !isTesSuccess(ter)) return ter; - return clawbackDisabled(amount2.issue()); + if (auto const ter = clawbackDisabled(amount2.asset()); !isTesSuccess(ter)) + return ter; + + return tesSUCCESS; } static std::pair @@ -183,7 +240,7 @@ applyCreate(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::J auto const amount = ctx_.tx[sfAmount]; auto const amount2 = ctx_.tx[sfAmount2]; - auto const ammKeylet = keylet::amm(amount.issue(), amount2.issue()); + auto const ammKeylet = keylet::amm(amount.asset(), amount2.asset()); // Mitigate same account exists possibility auto const maybeAccount = createPseudoAccount(sb, ammKeylet.key, sfAMMID); @@ -197,7 +254,7 @@ applyCreate(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::J auto const accountId = (*account)[sfAccount]; // LP Token already exists. (should not happen) - auto const lptIss = ammLPTIssue(amount.issue().currency, amount2.issue().currency, accountId); + auto const lptIss = ammLPTIssue(amount.asset(), amount2.asset(), accountId); if (sb.read(keylet::line(accountId, lptIss))) { JLOG(j_.error()) << "AMM Instance: LP Token already exists."; @@ -217,9 +274,9 @@ applyCreate(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::J auto ammSle = std::make_shared(ammKeylet); ammSle->setAccountID(sfAccount, accountId); ammSle->setFieldAmount(sfLPTokenBalance, lpTokens); - auto const& [issue1, issue2] = std::minmax(amount.issue(), amount2.issue()); - ammSle->setFieldIssue(sfAsset, STIssue{sfAsset, issue1}); - ammSle->setFieldIssue(sfAsset2, STIssue{sfAsset2, issue2}); + auto const& [asset1, asset2] = std::minmax(amount.asset(), amount2.asset()); + ammSle->setFieldIssue(sfAsset, STIssue{sfAsset, asset1}); + ammSle->setFieldIssue(sfAsset2, STIssue{sfAsset2, asset2}); // AMM creator gets the auction slot and the voting slot. initializeFeeAuctionVote(ctx_.view(), ammSle, account_, lptIss, ctx_.tx[sfTradingFee]); @@ -239,28 +296,59 @@ applyCreate(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::J return {res, false}; } - auto sendAndTrustSet = [&](STAmount const& amount) -> TER { - if (auto const res = - accountSend(sb, account_, accountId, amount, ctx_.journal, WaiveTransferFee::Yes)) - return res; - // Set AMM flag on AMM trustline - if (!isXRP(amount)) - { - SLE::pointer sleRippleState = sb.peek(keylet::line(accountId, amount.issue())); - if (!sleRippleState) - { - return tecINTERNAL; // LCOV_EXCL_LINE - } + auto sendAndInitTrustOrMPT = [&](STAmount const& amount) -> TER { + // Authorize MPT + return amount.asset().visit( + [&](MPTIssue const& issue) -> TER { + // Authorize MPT + auto const& mptIssue = issue; + auto const& mptID = mptIssue.getMptID(); + std::uint32_t flags = lsfMPTAMM; + if (auto const err = + requireAuth(ctx_.view(), mptIssue, accountId, AuthType::WeakAuth); + !isTesSuccess(err)) + { + if (err == tecNO_AUTH) + { + flags |= lsfMPTAuthorized; + } + else + { + return err; + } + } - auto const flags = sleRippleState->getFlags(); - sleRippleState->setFieldU32(sfFlags, flags | lsfAMMNode); - sb.update(sleRippleState); - } - return tesSUCCESS; + if (auto const err = createMPToken(sb, mptID, accountId, flags); !isTesSuccess(err)) + return err; + // Don't adjust AMM owner count. + // It's irrelevant for pseudo-account like AMM. + return accountSend( + sb, account_, accountId, amount, ctx_.journal, WaiveTransferFee::Yes); + }, + // Set AMM flag on AMM trustline + [&](Issue const& issue) -> TER { + if (auto const res = accountSend( + sb, account_, accountId, amount, ctx_.journal, WaiveTransferFee::Yes)) + return res; + // Set AMM flag on AMM trustline + if (!isXRP(amount)) + { + SLE::pointer const sleRippleState = sb.peek(keylet::line(accountId, issue)); + if (!sleRippleState) + { + return tecINTERNAL; // LCOV_EXCL_LINE + } + + auto const flags = sleRippleState->getFlags(); + sleRippleState->setFieldU32(sfFlags, flags | lsfAMMNode); + sb.update(sleRippleState); + } + return tesSUCCESS; + }); }; // Send asset1. - res = sendAndTrustSet(amount); + res = sendAndInitTrustOrMPT(amount); if (!isTesSuccess(res)) { JLOG(j_.debug()) << "AMM Instance: failed to send " << amount; @@ -268,7 +356,7 @@ applyCreate(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::J } // Send asset2. - res = sendAndTrustSet(amount2); + res = sendAndInitTrustOrMPT(amount2); if (!isTesSuccess(res)) { JLOG(j_.debug()) << "AMM Instance: failed to send " << amount2; @@ -277,14 +365,14 @@ applyCreate(ApplyContext& ctx_, Sandbox& sb, AccountID const& account_, beast::J JLOG(j_.debug()) << "AMM Instance: success " << accountId << " " << ammKeylet.key << " " << lpTokens << " " << amount << " " << amount2; - auto addOrderBook = [&](Issue const& issueIn, Issue const& issueOut, std::uint64_t uRate) { - Book const book{issueIn, issueOut, std::nullopt}; + auto addOrderBook = [&](Asset const& assetIn, Asset const& assetOut, std::uint64_t uRate) { + Book const book{assetIn, assetOut, std::nullopt}; auto const dir = keylet::quality(keylet::book(book), uRate); if (auto const bookExisted = static_cast(sb.read(dir)); !bookExisted) ctx_.registry.get().getOrderBookDB().addOrderBook(book); }; - addOrderBook(amount.issue(), amount2.issue(), getRate(amount2, amount)); - addOrderBook(amount2.issue(), amount.issue(), getRate(amount, amount2)); + addOrderBook(amount.asset(), amount2.asset(), getRate(amount2, amount)); + addOrderBook(amount2.asset(), amount.asset(), getRate(amount, amount2)); return {res, isTesSuccess(res)}; } diff --git a/src/libxrpl/tx/transactors/dex/AMMDelete.cpp b/src/libxrpl/tx/transactors/dex/AMMDelete.cpp index c41c3b04c8..3e7d63d6fd 100644 --- a/src/libxrpl/tx/transactors/dex/AMMDelete.cpp +++ b/src/libxrpl/tx/transactors/dex/AMMDelete.cpp @@ -1,16 +1,27 @@ -#include -#include -#include -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { bool AMMDelete::checkExtraFeatures(PreflightContext const& ctx) { - return ammEnabled(ctx.rules); + if (!ammEnabled(ctx.rules)) + return false; + + return ctx.rules.enabled(featureMPTokensV2) || + (!ctx.tx[sfAsset].holds() && !ctx.tx[sfAsset2].holds()); } NotTEC @@ -43,8 +54,7 @@ AMMDelete::doApply() // as we go on processing transactions. Sandbox sb(&ctx_.view()); - auto const ter = - deleteAMMAccount(sb, ctx_.tx[sfAsset].get(), ctx_.tx[sfAsset2].get(), j_); + auto const ter = deleteAMMAccount(sb, ctx_.tx[sfAsset], ctx_.tx[sfAsset2], j_); if (isTesSuccess(ter) || ter == tecINCOMPLETE) sb.apply(ctx_.rawView()); diff --git a/src/libxrpl/tx/transactors/dex/AMMDeposit.cpp b/src/libxrpl/tx/transactors/dex/AMMDeposit.cpp index 9f3c84c898..d097d23e8d 100644 --- a/src/libxrpl/tx/transactors/dex/AMMDeposit.cpp +++ b/src/libxrpl/tx/transactors/dex/AMMDeposit.cpp @@ -1,19 +1,47 @@ -#include -#include -#include -#include -#include -#include #include -#include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include namespace xrpl { bool AMMDeposit::checkExtraFeatures(PreflightContext const& ctx) { - return ammEnabled(ctx.rules); + if (!ammEnabled(ctx.rules)) + return false; + + auto const amount = ctx.tx[~sfAmount]; + auto const amount2 = ctx.tx[~sfAmount2]; + + return ctx.rules.enabled(featureMPTokensV2) || + (!ctx.tx[sfAsset].holds() && !ctx.tx[sfAsset2].holds() && + !(amount && amount->holds()) && !(amount2 && amount2->holds())); } std::uint32_t @@ -26,7 +54,6 @@ NotTEC AMMDeposit::preflight(PreflightContext const& ctx) { auto const flags = ctx.tx.getFlags(); - auto const amount = ctx.tx[~sfAmount]; auto const amount2 = ctx.tx[~sfAmount2]; auto const ePrice = ctx.tx[~sfEPrice]; @@ -78,18 +105,18 @@ AMMDeposit::preflight(PreflightContext const& ctx) return temMALFORMED; } - auto const asset = ctx.tx[sfAsset].get(); - auto const asset2 = ctx.tx[sfAsset2].get(); + auto const asset = ctx.tx[sfAsset]; + auto const asset2 = ctx.tx[sfAsset2]; if (auto const res = invalidAMMAssetPair(asset, asset2)) { JLOG(ctx.j.debug()) << "AMM Deposit: invalid asset pair."; return res; } - if (amount && amount2 && amount->issue() == amount2->issue()) + if (amount && amount2 && amount->asset() == amount2->asset()) { - JLOG(ctx.j.debug()) << "AMM Deposit: invalid tokens, same issue." << amount->issue() << " " - << amount2->issue(); + JLOG(ctx.j.debug()) << "AMM Deposit: invalid tokens, same issue." << amount->asset() << " " + << amount2->asset(); return temBAD_AMM_TOKENS; } @@ -119,11 +146,16 @@ AMMDeposit::preflight(PreflightContext const& ctx) } } - // must be amount issue if (amount && ePrice) { - if (auto const res = invalidAMMAmount( - *ePrice, std::make_optional(std::make_pair(amount->issue(), amount->issue())))) + auto assets = [&]() -> std::optional> { + // don't check ePrice issue + if (ctx.rules.enabled(featureMPTokensV2)) + return std::nullopt; + // must be amount issue + return std::make_optional(std::make_pair(amount->asset(), amount->asset())); + }(); + if (auto const res = invalidAMMAmount(*ePrice, assets)) { JLOG(ctx.j.debug()) << "AMM Deposit: invalid EPrice"; return res; @@ -152,7 +184,13 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) } auto const expected = ammHolds( - ctx.view, *ammSle, std::nullopt, std::nullopt, FreezeHandling::fhIGNORE_FREEZE, ctx.j); + ctx.view, + *ammSle, + std::nullopt, + std::nullopt, + FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, + ctx.j); if (!expected) return expected.error(); // LCOV_EXCL_LINE auto const [amountBalance, amount2Balance, lptAMMBalance] = *expected; @@ -190,7 +228,7 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) auto balance = [&](auto const& deposit) -> TER { if (isXRP(deposit)) { - auto const lpIssue = (*ammSle)[sfLPTokenBalance].issue(); + auto const lpIssue = (*ammSle)[sfLPTokenBalance].get(); // Adjust the reserve if LP doesn't have LPToken trustline auto const sle = ctx.view.read(keylet::line(accountID, lpIssue.account, lpIssue.currency)); @@ -200,10 +238,13 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) return tecUNFUNDED_AMM; return tecINSUF_RESERVE_LINE; } - return (accountID == deposit.issue().account || - accountHolds( - ctx.view, accountID, deposit.issue(), FreezeHandling::fhIGNORE_FREEZE, ctx.j) >= - deposit) + return accountFunds( + ctx.view, + accountID, + deposit, + FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, + ctx.j) >= deposit ? TER(tesSUCCESS) : tecUNFUNDED_AMM; }; @@ -212,8 +253,11 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) { // Check if either of the assets is frozen, AMMDeposit is not allowed // if either asset is frozen - auto checkAsset = [&](Issue const& asset) -> TER { - if (auto const ter = requireAuth(ctx.view, asset, accountID)) + auto checkAsset = [&](Asset const& asset) -> TER { + // WeakAuth - don't need to check if MPT object exists as might be + // depositing into non-MPT pool. It'll fail on send if MPT doesn't + // exist. + if (auto const ter = requireAuth(ctx.view, asset, accountID, AuthType::WeakAuth)) { JLOG(ctx.j.debug()) << "AMM Deposit: account is not authorized, " << asset; return ter; @@ -222,7 +266,7 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) if (isFrozen(ctx.view, accountID, asset)) { JLOG(ctx.j.debug()) << "AMM Deposit: account or currency is frozen, " - << to_string(accountID) << " " << to_string(asset.currency); + << to_string(accountID) << " " << to_string(asset); return tecFROZEN; } @@ -230,10 +274,10 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) return tesSUCCESS; }; - if (auto const ter = checkAsset(ctx.tx[sfAsset].get())) + if (auto const ter = checkAsset(ctx.tx[sfAsset])) return ter; - if (auto const ter = checkAsset(ctx.tx[sfAsset2].get())) + if (auto const ter = checkAsset(ctx.tx[sfAsset2])) return ter; } @@ -246,27 +290,27 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) { // This normally should not happen. // Account is not authorized to hold the assets it's depositing, - // or it doesn't even have a trust line for them - if (auto const ter = requireAuth(ctx.view, amount->issue(), accountID)) + // or it doesn't even have a trust line or MPT for them. + if (auto const ter = requireAuth(ctx.view, amount->asset(), accountID)) { // LCOV_EXCL_START JLOG(ctx.j.debug()) - << "AMM Deposit: account is not authorized, " << amount->issue(); + << "AMM Deposit: account is not authorized, " << amount->asset(); return ter; // LCOV_EXCL_STOP } // AMM account or currency frozen - if (isFrozen(ctx.view, ammAccountID, amount->issue())) + if (isFrozen(ctx.view, ammAccountID, amount->asset())) { JLOG(ctx.j.debug()) << "AMM Deposit: AMM account or currency is frozen, " << to_string(accountID); return tecFROZEN; } // Account frozen - if (isIndividualFrozen(ctx.view, accountID, amount->issue())) + if (isIndividualFrozen(ctx.view, accountID, amount->asset())) { JLOG(ctx.j.debug()) << "AMM Deposit: account is frozen, " << to_string(accountID) - << " " << to_string(amount->issue().currency); + << " " << to_string(amount->asset()); return tecFROZEN; } if (checkBalance) @@ -301,7 +345,7 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) // Equal deposit lp tokens if (auto const lpTokens = ctx.tx[~sfLPTokenOut]; - lpTokens && lpTokens->issue() != lptAMMBalance.issue()) + lpTokens && lpTokens->asset() != lptAMMBalance.asset()) { JLOG(ctx.j.debug()) << "AMM Deposit: invalid LPTokens."; return temBAD_AMM_TOKENS; @@ -320,6 +364,13 @@ AMMDeposit::preclaim(PreclaimContext const& ctx) } } + if (auto const ter = checkMPTTxAllowed(ctx.view, ttAMM_DEPOSIT, ctx.tx[sfAsset], accountID); + !isTesSuccess(ter)) + return ter; + if (auto const ter = checkMPTTxAllowed(ctx.view, ttAMM_DEPOSIT, ctx.tx[sfAsset2], accountID); + !isTesSuccess(ter)) + return ter; + return tesSUCCESS; } @@ -338,9 +389,10 @@ AMMDeposit::applyGuts(Sandbox& sb) auto const expected = ammHolds( sb, *ammSle, - amount ? amount->issue() : std::optional{}, - amount2 ? amount2->issue() : std::optional{}, + amount ? amount->asset() : std::optional{}, + amount2 ? amount2->asset() : std::optional{}, FreezeHandling::fhZERO_IF_FROZEN, + AuthHandling::ahZERO_IF_UNAUTHORIZED, ctx_.journal); if (!expected) return {expected.error(), false}; // LCOV_EXCL_LINE @@ -400,7 +452,7 @@ AMMDeposit::applyGuts(Sandbox& sb) if (subTxType & tfTwoAssetIfEmpty) { return equalDepositInEmptyState( - sb, ammAccountID, *amount, *amount2, lptAMMBalance.issue(), tfee); + sb, ammAccountID, *amount, *amount2, lptAMMBalance.asset(), tfee); } // should not happen. // LCOV_EXCL_START @@ -418,7 +470,7 @@ AMMDeposit::applyGuts(Sandbox& sb) // LP depositing into AMM empty state gets the auction slot // and the voting if (lptAMMBalance == beast::zero) - initializeFeeAuctionVote(sb, ammSle, account_, lptAMMBalance.issue(), tfee); + initializeFeeAuctionVote(sb, ammSle, account_, lptAMMBalance.asset(), tfee); sb.update(ammSle); } @@ -461,19 +513,19 @@ AMMDeposit::deposit( return temBAD_AMOUNT; if (isXRP(depositAmount)) { - auto const& lpIssue = lpTokensDeposit.issue(); + auto const& lpIssue = lpTokensDeposit.get(); // Adjust the reserve if LP doesn't have LPToken trustline auto const sle = view.read(keylet::line(account_, lpIssue.account, lpIssue.currency)); if (xrpLiquid(view, account_, !sle, j_) >= depositAmount) return tesSUCCESS; } else if ( - account_ == depositAmount.issue().account || - accountHolds( + accountFunds( view, account_, - depositAmount.issue(), + depositAmount, FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, ctx_.journal) >= depositAmount) { return tesSUCCESS; @@ -588,7 +640,7 @@ AMMDeposit::equalDepositTokens( auto const tokensAdj = adjustLPTokensOut(view.rules(), lptAMMBalance, lpTokensDeposit); if (view.rules().enabled(fixAMMv1_3) && tokensAdj == beast::zero) return {tecAMM_INVALID_TOKENS, STAmount{}}; - auto const frac = divide(tokensAdj, lptAMMBalance, lptAMMBalance.issue()); + auto const frac = divide(tokensAdj, lptAMMBalance, lptAMMBalance.asset()); // amounts factor in the adjusted tokens auto const amountDeposit = getRoundedAsset(view.rules(), amountBalance, frac, IsDeposit::Yes); @@ -934,7 +986,7 @@ AMMDeposit::equalDepositInEmptyState( AccountID const& ammAccount, STAmount const& amount, STAmount const& amount2, - Issue const& lptIssue, + Asset const& lptIssue, std::uint16_t tfee) { return deposit( diff --git a/src/libxrpl/tx/transactors/dex/AMMHelpers.cpp b/src/libxrpl/tx/transactors/dex/AMMHelpers.cpp deleted file mode 100644 index 20ffab52ca..0000000000 --- a/src/libxrpl/tx/transactors/dex/AMMHelpers.cpp +++ /dev/null @@ -1,379 +0,0 @@ -#include - -namespace xrpl { - -STAmount -ammLPTokens(STAmount const& asset1, STAmount const& asset2, Issue const& lptIssue) -{ - // AMM invariant: sqrt(asset1 * asset2) >= LPTokensBalance - auto const rounding = isFeatureEnabled(fixAMMv1_3) ? Number::downward : Number::getround(); - NumberRoundModeGuard g(rounding); - auto const tokens = root2(asset1 * asset2); - return toSTAmount(lptIssue, tokens); -} - -/* - * Equation 3: - * t = T * [(b/B - (sqrt(f2**2 - b/(B*f1)) - f2)) / - * (1 + sqrt(f2**2 - b/(B*f1)) - f2)] - * where f1 = 1 - tfee, f2 = (1 - tfee/2)/f1 - */ -STAmount -lpTokensOut( - STAmount const& asset1Balance, - STAmount const& asset1Deposit, - STAmount const& lptAMMBalance, - std::uint16_t tfee) -{ - auto const f1 = feeMult(tfee); - auto const f2 = feeMultHalf(tfee) / f1; - Number const r = asset1Deposit / asset1Balance; - auto const c = root2(f2 * f2 + r / f1) - f2; - if (!isFeatureEnabled(fixAMMv1_3)) - { - auto const t = lptAMMBalance * (r - c) / (1 + c); - return toSTAmount(lptAMMBalance.issue(), t); - } - - // minimize tokens out - auto const frac = (r - c) / (1 + c); - return multiply(lptAMMBalance, frac, Number::downward); -} - -/* Equation 4 solves equation 3 for b: - * Let f1 = 1 - tfee, f2 = (1 - tfee/2)/f1, t1 = t/T, t2 = 1 + t1, R = b/B - * then - * t1 = [R - sqrt(f2**2 + R/f1) + f2] / [1 + sqrt(f2**2 + R/f1] - f2] => - * sqrt(f2**2 + R/f1)*(t1 + 1) = R + f2 + t1*f2 - t1 => - * sqrt(f2**2 + R/f1)*t2 = R + t2*f2 - t1 => - * sqrt(f2**2 + R/f1) = R/t2 + f2 - t1/t2, let d = f2 - t1/t2 => - * sqrt(f2**2 + R/f1) = R/t2 + d => - * f2**2 + R/f1 = (R/t2)**2 +2*d*R/t2 + d**2 => - * (R/t2)**2 + R*(2*d/t2 - 1/f1) + d**2 - f2**2 = 0 - */ -STAmount -ammAssetIn( - STAmount const& asset1Balance, - STAmount const& lptAMMBalance, - STAmount const& lpTokens, - std::uint16_t tfee) -{ - auto const f1 = feeMult(tfee); - auto const f2 = feeMultHalf(tfee) / f1; - auto const t1 = lpTokens / lptAMMBalance; - auto const t2 = 1 + t1; - auto const d = f2 - t1 / t2; - auto const a = 1 / (t2 * t2); - auto const b = 2 * d / t2 - 1 / f1; - auto const c = d * d - f2 * f2; - if (!isFeatureEnabled(fixAMMv1_3)) - { - return toSTAmount(asset1Balance.issue(), asset1Balance * solveQuadraticEq(a, b, c)); - } - - // maximize deposit - auto const frac = solveQuadraticEq(a, b, c); - return multiply(asset1Balance, frac, Number::upward); -} - -/* Equation 7: - * t = T * (c - sqrt(c**2 - 4*R))/2 - * where R = b/B, c = R*fee + 2 - fee - */ -STAmount -lpTokensIn( - STAmount const& asset1Balance, - STAmount const& asset1Withdraw, - STAmount const& lptAMMBalance, - std::uint16_t tfee) -{ - Number const fr = asset1Withdraw / asset1Balance; - auto const f1 = getFee(tfee); - auto const c = fr * f1 + 2 - f1; - if (!isFeatureEnabled(fixAMMv1_3)) - { - auto const t = lptAMMBalance * (c - root2(c * c - 4 * fr)) / 2; - return toSTAmount(lptAMMBalance.issue(), t); - } - - // maximize tokens in - auto const frac = (c - root2(c * c - 4 * fr)) / 2; - return multiply(lptAMMBalance, frac, Number::upward); -} - -/* Equation 8 solves equation 7 for b: - * c - 2*t/T = sqrt(c**2 - 4*R) => - * c**2 - 4*c*t/T + 4*t**2/T**2 = c**2 - 4*R => - * -4*c*t/T + 4*t**2/T**2 = -4*R => - * -c*t/T + t**2/T**2 = -R -=> - * substitute c = R*f + 2 - f => - * -(t/T)*(R*f + 2 - f) + (t/T)**2 = -R, let t1 = t/T => - * -t1*R*f -2*t1 +t1*f +t1**2 = -R => - * R = (t1**2 + t1*(f - 2)) / (t1*f - 1) - */ -STAmount -ammAssetOut( - STAmount const& assetBalance, - STAmount const& lptAMMBalance, - STAmount const& lpTokens, - std::uint16_t tfee) -{ - auto const f = getFee(tfee); - Number const t1 = lpTokens / lptAMMBalance; - if (!isFeatureEnabled(fixAMMv1_3)) - { - auto const b = assetBalance * (t1 * t1 - t1 * (2 - f)) / (t1 * f - 1); - return toSTAmount(assetBalance.issue(), b); - } - - // minimize withdraw - auto const frac = (t1 * t1 - t1 * (2 - f)) / (t1 * f - 1); - return multiply(assetBalance, frac, Number::downward); -} - -Number -square(Number const& n) -{ - return n * n; -} - -STAmount -adjustLPTokens(STAmount const& lptAMMBalance, STAmount const& lpTokens, IsDeposit isDeposit) -{ - // Force rounding downward to ensure adjusted tokens are less or equal - // to requested tokens. - saveNumberRoundMode rm(Number::setround(Number::rounding_mode::downward)); - if (isDeposit == IsDeposit::Yes) - return (lptAMMBalance + lpTokens) - lptAMMBalance; - return (lpTokens - lptAMMBalance) + lptAMMBalance; -} - -std::tuple, STAmount> -adjustAmountsByLPTokens( - STAmount const& amountBalance, - STAmount const& amount, - std::optional const& amount2, - STAmount const& lptAMMBalance, - STAmount const& lpTokens, - std::uint16_t tfee, - IsDeposit isDeposit) -{ - // AMMv1_3 amendment adjusts tokens and amounts in deposit/withdraw - if (isFeatureEnabled(fixAMMv1_3)) - return std::make_tuple(amount, amount2, lpTokens); - - auto const lpTokensActual = adjustLPTokens(lptAMMBalance, lpTokens, isDeposit); - - if (lpTokensActual == beast::zero) - { - auto const amount2Opt = amount2 ? std::make_optional(STAmount{}) : std::nullopt; - return std::make_tuple(STAmount{}, amount2Opt, lpTokensActual); - } - - if (lpTokensActual < lpTokens) - { - bool const ammRoundingEnabled = [&]() { - if (auto const& rules = getCurrentTransactionRules(); - rules && rules->enabled(fixAMMv1_1)) - return true; - return false; - }(); - - // Equal trade - if (amount2) - { - Number const fr = lpTokensActual / lpTokens; - auto const amountActual = toSTAmount(amount.issue(), fr * amount); - auto const amount2Actual = toSTAmount(amount2->issue(), fr * *amount2); - if (!ammRoundingEnabled) - { - return std::make_tuple( - amountActual < amount ? amountActual : amount, - amount2Actual < amount2 ? amount2Actual : amount2, - lpTokensActual); - } - - return std::make_tuple(amountActual, amount2Actual, lpTokensActual); - } - - // Single trade - auto const amountActual = [&]() { - if (isDeposit == IsDeposit::Yes) - { - return ammAssetIn(amountBalance, lptAMMBalance, lpTokensActual, tfee); - } - if (!ammRoundingEnabled) - { - return ammAssetOut(amountBalance, lptAMMBalance, lpTokens, tfee); - } - - return ammAssetOut(amountBalance, lptAMMBalance, lpTokensActual, tfee); - }(); - if (!ammRoundingEnabled) - { - return amountActual < amount - ? std::make_tuple(amountActual, std::nullopt, lpTokensActual) - : std::make_tuple(amount, std::nullopt, lpTokensActual); - } - - return std::make_tuple(amountActual, std::nullopt, lpTokensActual); - } - - XRPL_ASSERT( - lpTokensActual == lpTokens, "xrpl::adjustAmountsByLPTokens : LP tokens match actual"); - - return {amount, amount2, lpTokensActual}; -} - -Number -solveQuadraticEq(Number const& a, Number const& b, Number const& c) -{ - return (-b + root2(b * b - 4 * a * c)) / (2 * a); -} - -// Minimize takerGets or takerPays -std::optional -solveQuadraticEqSmallest(Number const& a, Number const& b, Number const& c) -{ - auto const d = b * b - 4 * a * c; - if (d < 0) - return std::nullopt; - // use numerically stable citardauq formula for quadratic equation solution - // https://people.csail.mit.edu/bkph/articles/Quadratics.pdf - if (b > 0) - { - return (2 * c) / (-b - root2(d)); - } - - return (2 * c) / (-b + root2(d)); -} - -STAmount -multiply(STAmount const& amount, Number const& frac, Number::rounding_mode rm) -{ - NumberRoundModeGuard g(rm); - auto const t = amount * frac; - return toSTAmount(amount.issue(), t, rm); -} - -STAmount -getRoundedAsset( - Rules const& rules, - std::function const& noRoundCb, - STAmount const& balance, - std::function const& productCb, - IsDeposit isDeposit) -{ - if (!rules.enabled(fixAMMv1_3)) - return toSTAmount(balance.issue(), noRoundCb()); - - auto const rm = detail::getAssetRounding(isDeposit); - if (isDeposit == IsDeposit::Yes) - return multiply(balance, productCb(), rm); - NumberRoundModeGuard g(rm); - return toSTAmount(balance.issue(), productCb(), rm); -} - -STAmount -getRoundedLPTokens( - Rules const& rules, - STAmount const& balance, - Number const& frac, - IsDeposit isDeposit) -{ - if (!rules.enabled(fixAMMv1_3)) - return toSTAmount(balance.issue(), balance * frac); - - auto const rm = detail::getLPTokenRounding(isDeposit); - auto const tokens = multiply(balance, frac, rm); - return adjustLPTokens(balance, tokens, isDeposit); -} - -STAmount -getRoundedLPTokens( - Rules const& rules, - std::function const& noRoundCb, - STAmount const& lptAMMBalance, - std::function const& productCb, - IsDeposit isDeposit) -{ - if (!rules.enabled(fixAMMv1_3)) - return toSTAmount(lptAMMBalance.issue(), noRoundCb()); - - auto const tokens = [&] { - auto const rm = detail::getLPTokenRounding(isDeposit); - if (isDeposit == IsDeposit::Yes) - { - NumberRoundModeGuard g(rm); - return toSTAmount(lptAMMBalance.issue(), productCb(), rm); - } - return multiply(lptAMMBalance, productCb(), rm); - }(); - return adjustLPTokens(lptAMMBalance, tokens, isDeposit); -} - -std::pair -adjustAssetInByTokens( - Rules const& rules, - STAmount const& balance, - STAmount const& amount, - STAmount const& lptAMMBalance, - STAmount const& tokens, - std::uint16_t tfee) -{ - if (!rules.enabled(fixAMMv1_3)) - return {tokens, amount}; - auto assetAdj = ammAssetIn(balance, lptAMMBalance, tokens, tfee); - auto tokensAdj = tokens; - // Rounding didn't work the right way. - // Try to adjust the original deposit amount by difference - // in adjust and original amount. Then adjust tokens and deposit amount. - if (assetAdj > amount) - { - auto const adjAmount = amount - (assetAdj - amount); - auto const t = lpTokensOut(balance, adjAmount, lptAMMBalance, tfee); - tokensAdj = adjustLPTokens(lptAMMBalance, t, IsDeposit::Yes); - assetAdj = ammAssetIn(balance, lptAMMBalance, tokensAdj, tfee); - } - return {tokensAdj, std::min(amount, assetAdj)}; -} - -std::pair -adjustAssetOutByTokens( - Rules const& rules, - STAmount const& balance, - STAmount const& amount, - STAmount const& lptAMMBalance, - STAmount const& tokens, - std::uint16_t tfee) -{ - if (!rules.enabled(fixAMMv1_3)) - return {tokens, amount}; - auto assetAdj = ammAssetOut(balance, lptAMMBalance, tokens, tfee); - auto tokensAdj = tokens; - // Rounding didn't work the right way. - // Try to adjust the original deposit amount by difference - // in adjust and original amount. Then adjust tokens and deposit amount. - if (assetAdj > amount) - { - auto const adjAmount = amount - (assetAdj - amount); - auto const t = lpTokensIn(balance, adjAmount, lptAMMBalance, tfee); - tokensAdj = adjustLPTokens(lptAMMBalance, t, IsDeposit::No); - assetAdj = ammAssetOut(balance, lptAMMBalance, tokensAdj, tfee); - } - return {tokensAdj, std::min(amount, assetAdj)}; -} - -Number -adjustFracByTokens( - Rules const& rules, - STAmount const& lptAMMBalance, - STAmount const& tokens, - Number const& frac) -{ - if (!rules.enabled(fixAMMv1_3)) - return frac; - return tokens / lptAMMBalance; -} - -} // namespace xrpl diff --git a/src/libxrpl/tx/transactors/dex/AMMUtils.cpp b/src/libxrpl/tx/transactors/dex/AMMUtils.cpp deleted file mode 100644 index 91891ce86f..0000000000 --- a/src/libxrpl/tx/transactors/dex/AMMUtils.cpp +++ /dev/null @@ -1,462 +0,0 @@ -#include -#include -#include -#include -#include -#include -#include - -namespace xrpl { - -std::pair -ammPoolHolds( - ReadView const& view, - AccountID const& ammAccountID, - Issue const& issue1, - Issue const& issue2, - FreezeHandling freezeHandling, - beast::Journal const j) -{ - auto const assetInBalance = accountHolds(view, ammAccountID, issue1, freezeHandling, j); - auto const assetOutBalance = accountHolds(view, ammAccountID, issue2, freezeHandling, j); - return std::make_pair(assetInBalance, assetOutBalance); -} - -Expected, TER> -ammHolds( - ReadView const& view, - SLE const& ammSle, - std::optional const& optIssue1, - std::optional const& optIssue2, - FreezeHandling freezeHandling, - beast::Journal const j) -{ - auto const issues = [&]() -> std::optional> { - auto const issue1 = ammSle[sfAsset].get(); - auto const issue2 = ammSle[sfAsset2].get(); - if (optIssue1 && optIssue2) - { - if (invalidAMMAssetPair( - *optIssue1, *optIssue2, std::make_optional(std::make_pair(issue1, issue2)))) - { - // This error can only be hit if the AMM is corrupted - // LCOV_EXCL_START - JLOG(j.debug()) << "ammHolds: Invalid optIssue1 or optIssue2 " << *optIssue1 << " " - << *optIssue2; - return std::nullopt; - // LCOV_EXCL_STOP - } - return std::make_optional(std::make_pair(*optIssue1, *optIssue2)); - } - auto const singleIssue = [&issue1, &issue2, &j]( - Issue checkIssue, - char const* label) -> std::optional> { - if (checkIssue == issue1) - { - return std::make_optional(std::make_pair(issue1, issue2)); - } - if (checkIssue == issue2) - { - return std::make_optional(std::make_pair(issue2, issue1)); - } - // Unreachable unless AMM corrupted. - // LCOV_EXCL_START - JLOG(j.debug()) << "ammHolds: Invalid " << label << " " << checkIssue; - return std::nullopt; - // LCOV_EXCL_STOP - }; - if (optIssue1) - { - return singleIssue(*optIssue1, "optIssue1"); - } - if (optIssue2) - { - // Cannot have Amount2 without Amount. - return singleIssue(*optIssue2, "optIssue2"); // LCOV_EXCL_LINE - } - return std::make_optional(std::make_pair(issue1, issue2)); - }(); - if (!issues) - return Unexpected(tecAMM_INVALID_TOKENS); - auto const [asset1, asset2] = ammPoolHolds( - view, ammSle.getAccountID(sfAccount), issues->first, issues->second, freezeHandling, j); - return std::make_tuple(asset1, asset2, ammSle[sfLPTokenBalance]); -} - -STAmount -ammLPHolds( - ReadView const& view, - Currency const& cur1, - Currency const& cur2, - AccountID const& ammAccount, - AccountID const& lpAccount, - beast::Journal const j) -{ - // This function looks similar to `accountHolds`. However, it only checks if - // a LPToken holder has enough balance. On the other hand, `accountHolds` - // checks if the underlying assets of LPToken are frozen with the - // fixFrozenLPTokenTransfer amendment - - auto const currency = ammLPTCurrency(cur1, cur2); - STAmount amount; - - auto const sle = view.read(keylet::line(lpAccount, ammAccount, currency)); - if (!sle) - { - amount.clear(Issue{currency, ammAccount}); - JLOG(j.trace()) << "ammLPHolds: no SLE " - << " lpAccount=" << to_string(lpAccount) - << " amount=" << amount.getFullText(); - } - else if (isFrozen(view, lpAccount, currency, ammAccount)) - { - amount.clear(Issue{currency, ammAccount}); - JLOG(j.trace()) << "ammLPHolds: frozen currency " - << " lpAccount=" << to_string(lpAccount) - << " amount=" << amount.getFullText(); - } - else - { - amount = sle->getFieldAmount(sfBalance); - if (lpAccount > ammAccount) - { - // Put balance in account terms. - amount.negate(); - } - amount.setIssuer(ammAccount); - - JLOG(j.trace()) << "ammLPHolds:" - << " lpAccount=" << to_string(lpAccount) - << " amount=" << amount.getFullText(); - } - - return view.balanceHook(lpAccount, ammAccount, amount); -} - -STAmount -ammLPHolds( - ReadView const& view, - SLE const& ammSle, - AccountID const& lpAccount, - beast::Journal const j) -{ - return ammLPHolds( - view, - ammSle[sfAsset].get().currency, - ammSle[sfAsset2].get().currency, - ammSle[sfAccount], - lpAccount, - j); -} - -std::uint16_t -getTradingFee(ReadView const& view, SLE const& ammSle, AccountID const& account) -{ - using namespace std::chrono; - XRPL_ASSERT( - !view.rules().enabled(fixInnerObjTemplate) || ammSle.isFieldPresent(sfAuctionSlot), - "xrpl::getTradingFee : auction present"); - if (ammSle.isFieldPresent(sfAuctionSlot)) - { - auto const& auctionSlot = safe_downcast(ammSle.peekAtField(sfAuctionSlot)); - // Not expired - if (auto const expiration = auctionSlot[~sfExpiration]; - duration_cast(view.header().parentCloseTime.time_since_epoch()).count() < - expiration) - { - if (auctionSlot[~sfAccount] == account) - return auctionSlot[sfDiscountedFee]; - if (auctionSlot.isFieldPresent(sfAuthAccounts)) - { - for (auto const& acct : auctionSlot.getFieldArray(sfAuthAccounts)) - { - if (acct[~sfAccount] == account) - return auctionSlot[sfDiscountedFee]; - } - } - } - } - return ammSle[sfTradingFee]; -} - -STAmount -ammAccountHolds(ReadView const& view, AccountID const& ammAccountID, Issue const& issue) -{ - if (isXRP(issue)) - { - if (auto const sle = view.read(keylet::account(ammAccountID))) - return (*sle)[sfBalance]; - } - else if ( - auto const sle = view.read(keylet::line(ammAccountID, issue.account, issue.currency)); - sle && !isFrozen(view, ammAccountID, issue.currency, issue.account)) - { - auto amount = (*sle)[sfBalance]; - if (ammAccountID > issue.account) - amount.negate(); - amount.setIssuer(issue.account); - return amount; - } - - return STAmount{issue}; -} - -static TER -deleteAMMTrustLines( - Sandbox& sb, - AccountID const& ammAccountID, - std::uint16_t maxTrustlinesToDelete, - beast::Journal j) -{ - return cleanupOnAccountDelete( - sb, - keylet::ownerDir(ammAccountID), - [&](LedgerEntryType nodeType, - uint256 const&, - std::shared_ptr& sleItem) -> std::pair { - // Skip AMM - if (nodeType == LedgerEntryType::ltAMM) - return {tesSUCCESS, SkipEntry::Yes}; - // Should only have the trustlines - if (nodeType != LedgerEntryType::ltRIPPLE_STATE) - { - // LCOV_EXCL_START - JLOG(j.error()) << "deleteAMMTrustLines: deleting non-trustline " << nodeType; - return {tecINTERNAL, SkipEntry::No}; - // LCOV_EXCL_STOP - } - - // Trustlines must have zero balance - if (sleItem->getFieldAmount(sfBalance) != beast::zero) - { - // LCOV_EXCL_START - JLOG(j.error()) << "deleteAMMTrustLines: deleting trustline with " - "non-zero balance."; - return {tecINTERNAL, SkipEntry::No}; - // LCOV_EXCL_STOP - } - - return {deleteAMMTrustLine(sb, sleItem, ammAccountID, j), SkipEntry::No}; - }, - j, - maxTrustlinesToDelete); -} - -TER -deleteAMMAccount(Sandbox& sb, Issue const& asset, Issue const& asset2, beast::Journal j) -{ - auto ammSle = sb.peek(keylet::amm(asset, asset2)); - if (!ammSle) - { - // LCOV_EXCL_START - JLOG(j.error()) << "deleteAMMAccount: AMM object does not exist " << asset << " " << asset2; - return tecINTERNAL; - // LCOV_EXCL_STOP - } - - auto const ammAccountID = (*ammSle)[sfAccount]; - auto sleAMMRoot = sb.peek(keylet::account(ammAccountID)); - if (!sleAMMRoot) - { - // LCOV_EXCL_START - JLOG(j.error()) << "deleteAMMAccount: AMM account does not exist " - << to_string(ammAccountID); - return tecINTERNAL; - // LCOV_EXCL_STOP - } - - if (auto const ter = deleteAMMTrustLines(sb, ammAccountID, maxDeletableAMMTrustLines, j); - !isTesSuccess(ter)) - return ter; - - auto const ownerDirKeylet = keylet::ownerDir(ammAccountID); - if (!sb.dirRemove(ownerDirKeylet, (*ammSle)[sfOwnerNode], ammSle->key(), false)) - { - // LCOV_EXCL_START - JLOG(j.error()) << "deleteAMMAccount: failed to remove dir link"; - return tecINTERNAL; - // LCOV_EXCL_STOP - } - if (sb.exists(ownerDirKeylet) && !sb.emptyDirDelete(ownerDirKeylet)) - { - // LCOV_EXCL_START - JLOG(j.error()) << "deleteAMMAccount: cannot delete root dir node of " - << toBase58(ammAccountID); - return tecINTERNAL; - // LCOV_EXCL_STOP - } - - sb.erase(ammSle); - sb.erase(sleAMMRoot); - - return tesSUCCESS; -} - -void -initializeFeeAuctionVote( - ApplyView& view, - std::shared_ptr& ammSle, - AccountID const& account, - Issue const& lptIssue, - std::uint16_t tfee) -{ - auto const& rules = view.rules(); - // AMM creator gets the voting slot. - STArray voteSlots; - STObject voteEntry = STObject::makeInnerObject(sfVoteEntry); - if (tfee != 0) - voteEntry.setFieldU16(sfTradingFee, tfee); - voteEntry.setFieldU32(sfVoteWeight, VOTE_WEIGHT_SCALE_FACTOR); - voteEntry.setAccountID(sfAccount, account); - voteSlots.push_back(voteEntry); - ammSle->setFieldArray(sfVoteSlots, voteSlots); - // AMM creator gets the auction slot for free. - // AuctionSlot is created on AMMCreate and updated on AMMDeposit - // when AMM is in an empty state - if (rules.enabled(fixInnerObjTemplate) && !ammSle->isFieldPresent(sfAuctionSlot)) - { - STObject auctionSlot = STObject::makeInnerObject(sfAuctionSlot); - ammSle->set(std::move(auctionSlot)); - } - STObject& auctionSlot = ammSle->peekFieldObject(sfAuctionSlot); - auctionSlot.setAccountID(sfAccount, account); - // current + sec in 24h - auto const expiration = std::chrono::duration_cast( - view.header().parentCloseTime.time_since_epoch()) - .count() + - TOTAL_TIME_SLOT_SECS; - auctionSlot.setFieldU32(sfExpiration, expiration); - auctionSlot.setFieldAmount(sfPrice, STAmount{lptIssue, 0}); - // Set the fee - if (tfee != 0) - { - ammSle->setFieldU16(sfTradingFee, tfee); - } - else if (ammSle->isFieldPresent(sfTradingFee)) - { - ammSle->makeFieldAbsent(sfTradingFee); // LCOV_EXCL_LINE - } - if (auto const dfee = tfee / AUCTION_SLOT_DISCOUNTED_FEE_FRACTION) - { - auctionSlot.setFieldU16(sfDiscountedFee, dfee); - } - else if (auctionSlot.isFieldPresent(sfDiscountedFee)) - { - auctionSlot.makeFieldAbsent(sfDiscountedFee); // LCOV_EXCL_LINE - } -} - -Expected -isOnlyLiquidityProvider(ReadView const& view, Issue const& ammIssue, AccountID const& lpAccount) -{ - // Liquidity Provider (LP) must have one LPToken trustline - std::uint8_t nLPTokenTrustLines = 0; - // There are at most two IOU trustlines. One or both could be to the LP - // if LP is the issuer, or a different account if LP is not an issuer. - // For instance, if AMM has two tokens USD and EUR and LP is not the issuer - // of the tokens then the trustlines are between AMM account and the issuer. - std::uint8_t nIOUTrustLines = 0; - // There is only one AMM object - bool hasAMM = false; - // AMM LP has at most three trustlines and only one AMM object must exist. - // If there are more than five objects then it's either an error or - // there are more than one LP. Ten pages should be sufficient to include - // five objects. - std::uint8_t limit = 10; - auto const root = keylet::ownerDir(ammIssue.account); - auto currentIndex = root; - - // Iterate over AMM owner directory objects. - while (limit-- >= 1) - { - auto const ownerDir = view.read(currentIndex); - if (!ownerDir) - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - for (auto const& key : ownerDir->getFieldV256(sfIndexes)) - { - auto const sle = view.read(keylet::child(key)); - if (!sle) - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - // Only one AMM object - if (sle->getFieldU16(sfLedgerEntryType) == ltAMM) - { - if (hasAMM) - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - hasAMM = true; - continue; - } - if (sle->getFieldU16(sfLedgerEntryType) != ltRIPPLE_STATE) - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - auto const lowLimit = sle->getFieldAmount(sfLowLimit); - auto const highLimit = sle->getFieldAmount(sfHighLimit); - auto const isLPTrustline = - lowLimit.getIssuer() == lpAccount || highLimit.getIssuer() == lpAccount; - auto const isLPTokenTrustline = - lowLimit.issue() == ammIssue || highLimit.issue() == ammIssue; - - // Liquidity Provider trustline - if (isLPTrustline) - { - // LPToken trustline - if (isLPTokenTrustline) - { - if (++nLPTokenTrustLines > 1) - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - } - else if (++nIOUTrustLines > 2) - { - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - } - } - // Another Liquidity Provider LPToken trustline - else if (isLPTokenTrustline) - { - return false; - } - else if (++nIOUTrustLines > 2) - { - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - } - } - auto const uNodeNext = ownerDir->getFieldU64(sfIndexNext); - if (uNodeNext == 0) - { - if (nLPTokenTrustLines != 1 || nIOUTrustLines == 0 || nIOUTrustLines > 2) - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - return true; - } - currentIndex = keylet::page(root, uNodeNext); - } - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE -} - -Expected -verifyAndAdjustLPTokenBalance( - Sandbox& sb, - STAmount const& lpTokens, - std::shared_ptr& ammSle, - AccountID const& account) -{ - auto const res = isOnlyLiquidityProvider(sb, lpTokens.issue(), account); - if (!res.has_value()) - { - return Unexpected(res.error()); - } - - if (res.value()) - { - if (withinRelativeDistance( - lpTokens, ammSle->getFieldAmount(sfLPTokenBalance), Number{1, -3})) - { - ammSle->setFieldAmount(sfLPTokenBalance, lpTokens); - sb.update(ammSle); - } - else - { - return Unexpected(tecAMM_INVALID_TOKENS); - } - } - return true; -} - -} // namespace xrpl diff --git a/src/libxrpl/tx/transactors/dex/AMMVote.cpp b/src/libxrpl/tx/transactors/dex/AMMVote.cpp index 6dbea9bb32..fc2dbba0ca 100644 --- a/src/libxrpl/tx/transactors/dex/AMMVote.cpp +++ b/src/libxrpl/tx/transactors/dex/AMMVote.cpp @@ -1,23 +1,43 @@ -#include -#include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + namespace xrpl { bool AMMVote::checkExtraFeatures(PreflightContext const& ctx) { - return ammEnabled(ctx.rules); + if (!ammEnabled(ctx.rules)) + return false; + + return ctx.rules.enabled(featureMPTokensV2) || + (!ctx.tx[sfAsset].holds() && !ctx.tx[sfAsset2].holds()); } NotTEC AMMVote::preflight(PreflightContext const& ctx) { - if (auto const res = - invalidAMMAssetPair(ctx.tx[sfAsset].get(), ctx.tx[sfAsset2].get())) + if (auto const res = invalidAMMAssetPair(ctx.tx[sfAsset], ctx.tx[sfAsset2])) { JLOG(ctx.j.debug()) << "AMM Vote: invalid asset pair."; return res; diff --git a/src/libxrpl/tx/transactors/dex/AMMWithdraw.cpp b/src/libxrpl/tx/transactors/dex/AMMWithdraw.cpp index c48df7836b..f9a357da06 100644 --- a/src/libxrpl/tx/transactors/dex/AMMWithdraw.cpp +++ b/src/libxrpl/tx/transactors/dex/AMMWithdraw.cpp @@ -1,17 +1,56 @@ -#include -#include -#include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { bool AMMWithdraw::checkExtraFeatures(PreflightContext const& ctx) { - return ammEnabled(ctx.rules); + if (!ammEnabled(ctx.rules)) + return false; + + auto const amount = ctx.tx[~sfAmount]; + auto const amount2 = ctx.tx[~sfAmount2]; + + return ctx.rules.enabled(featureMPTokensV2) || + (!ctx.tx[sfAsset].holds() && !ctx.tx[sfAsset2].holds() && + !(amount && amount->holds()) && !(amount2 && amount2->holds())); } std::uint32_t @@ -78,18 +117,18 @@ AMMWithdraw::preflight(PreflightContext const& ctx) return temMALFORMED; } - auto const asset = ctx.tx[sfAsset].get(); - auto const asset2 = ctx.tx[sfAsset2].get(); + auto const asset = ctx.tx[sfAsset]; + auto const asset2 = ctx.tx[sfAsset2]; if (auto const res = invalidAMMAssetPair(asset, asset2)) { JLOG(ctx.j.debug()) << "AMM Withdraw: Invalid asset pair."; return res; } - if (amount && amount2 && amount->issue() == amount2->issue()) + if (amount && amount2 && amount->asset() == amount2->asset()) { - JLOG(ctx.j.debug()) << "AMM Withdraw: invalid tokens, same issue." << amount->issue() << " " - << amount2->issue(); + JLOG(ctx.j.debug()) << "AMM Withdraw: invalid tokens, same issue." << amount->asset() << " " + << amount2->asset(); return temBAD_AMM_TOKENS; } @@ -162,9 +201,10 @@ AMMWithdraw::preclaim(PreclaimContext const& ctx) auto const expected = ammHolds( ctx.view, *ammSle, - amount ? amount->issue() : std::optional{}, - amount2 ? amount2->issue() : std::optional{}, + amount ? amount->asset() : std::optional{}, + amount2 ? amount2->asset() : std::optional{}, FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, ctx.j); if (!expected) return expected.error(); @@ -191,26 +231,33 @@ AMMWithdraw::preclaim(PreclaimContext const& ctx) << "AMM Withdraw: withdrawing more than the balance, " << *amount; return tecAMM_BALANCE; } - if (auto const ter = requireAuth(ctx.view, amount->issue(), accountID)) + // WeakAuth - MPToken is created if it doesn't exist. + if (auto const ter = + requireAuth(ctx.view, amount->asset(), accountID, AuthType::WeakAuth)) { JLOG(ctx.j.debug()) - << "AMM Withdraw: account is not authorized, " << amount->issue(); + << "AMM Withdraw: account is not authorized, " << amount->asset(); return ter; } // AMM account or currency frozen - if (isFrozen(ctx.view, ammAccountID, amount->issue())) + if (isFrozen(ctx.view, ammAccountID, amount->asset())) { JLOG(ctx.j.debug()) << "AMM Withdraw: AMM account or currency is frozen, " << to_string(accountID); return tecFROZEN; } // Account frozen - if (isIndividualFrozen(ctx.view, accountID, amount->issue())) + if (isIndividualFrozen(ctx.view, accountID, amount->asset())) { JLOG(ctx.j.debug()) << "AMM Withdraw: account is frozen, " << to_string(accountID) - << " " << to_string(amount->issue().currency); + << " " << to_string(amount->asset()); return tecFROZEN; } + + if (auto const ter = + checkMPTTxAllowed(ctx.view, ttAMM_WITHDRAW, amount->asset(), accountID); + !isTesSuccess(ter)) + return ter; } return tesSUCCESS; }; @@ -230,7 +277,7 @@ AMMWithdraw::preclaim(PreclaimContext const& ctx) return tecAMM_BALANCE; } - if (lpTokensWithdraw && lpTokensWithdraw->issue() != lpTokens.issue()) + if (lpTokensWithdraw && lpTokensWithdraw->asset() != lpTokens.asset()) { JLOG(ctx.j.debug()) << "AMM Withdraw: invalid LPTokens."; return temBAD_AMM_TOKENS; @@ -242,7 +289,7 @@ AMMWithdraw::preclaim(PreclaimContext const& ctx) return tecAMM_INVALID_TOKENS; } - if (auto const ePrice = ctx.tx[~sfEPrice]; ePrice && ePrice->issue() != lpTokens.issue()) + if (auto const ePrice = ctx.tx[~sfEPrice]; ePrice && ePrice->asset() != lpTokens.asset()) { JLOG(ctx.j.debug()) << "AMM Withdraw: invalid EPrice."; return temBAD_AMM_TOKENS; @@ -289,9 +336,10 @@ AMMWithdraw::applyGuts(Sandbox& sb) auto const expected = ammHolds( sb, *ammSle, - amount ? amount->issue() : std::optional{}, - amount2 ? amount2->issue() : std::optional{}, + amount ? amount->asset() : std::optional{}, + amount2 ? amount2->asset() : std::optional{}, FreezeHandling::fhZERO_IF_FROZEN, + AuthHandling::ahZERO_IF_UNAUTHORIZED, ctx_.journal); if (!expected) return {expected.error(), false}; @@ -363,12 +411,7 @@ AMMWithdraw::applyGuts(Sandbox& sb) return {result, false}; auto const res = deleteAMMAccountIfEmpty( - sb, - ammSle, - newLPTokenBalance, - ctx_.tx[sfAsset].get(), - ctx_.tx[sfAsset2].get(), - j_); + sb, ammSle, newLPTokenBalance, ctx_.tx[sfAsset], ctx_.tx[sfAsset2], j_); // LCOV_EXCL_START if (!res.second) return {res.first, false}; @@ -421,6 +464,7 @@ AMMWithdraw::withdraw( lpTokensWithdraw, tfee, FreezeHandling::fhZERO_IF_FROZEN, + AuthHandling::ahZERO_IF_UNAUTHORIZED, isWithdrawAll(ctx_.tx), preFeeBalance_, j_); @@ -440,13 +484,14 @@ AMMWithdraw::withdraw( STAmount const& lpTokensWithdraw, std::uint16_t tfee, FreezeHandling freezeHandling, + AuthHandling authHandling, WithdrawAll withdrawAll, XRPAmount const& priorBalance, beast::Journal const& journal) { auto const lpTokens = ammLPHolds(view, ammSle, account, journal); - auto const expected = - ammHolds(view, ammSle, amountWithdraw.issue(), std::nullopt, freezeHandling, journal); + auto const expected = ammHolds( + view, ammSle, amountWithdraw.asset(), std::nullopt, freezeHandling, authHandling, journal); // LCOV_EXCL_START if (!expected) return {expected.error(), STAmount{}, STAmount{}, STAmount{}}; @@ -525,33 +570,102 @@ AMMWithdraw::withdraw( return {tecAMM_BALANCE, STAmount{}, STAmount{}, STAmount{}}; } - // Check the reserve in case a trustline has to be created - bool const enabledFixAMMv1_2 = view.rules().enabled(fixAMMv1_2); - auto sufficientReserve = [&](Issue const& issue) -> TER { - if (!enabledFixAMMv1_2 || isXRP(issue)) - return tesSUCCESS; - if (!view.exists(keylet::line(account, issue))) + // Updated pool state must be valid - either all balances are zero + // or all balances are non-zero. + if (view.rules().enabled(featureMPTokensV2)) + { + bool const newBalanceZero = (curBalance - amountWithdrawActual) == beast::zero; + bool const newBalance2Zero = + (curBalance2 - amount2WithdrawActual.value_or(curBalance2.asset())) == beast::zero; + bool const newLPTokensZero = (lpTokensAMMBalance - lpTokensWithdrawActual) == beast::zero; + // newBalance2Zero can be zero if that side of the pool is frozen. + // ignore newBalance2Zero if one-sided withdrawal. + bool const valid = [&]() { + if (!amount2WithdrawActual) + return newBalanceZero == newLPTokensZero; + return newBalanceZero == newBalance2Zero && newBalance2Zero == newLPTokensZero; + }(); + if (!valid) { - auto const sleAccount = view.read(keylet::account(account)); + JLOG(journal.debug()) << "AMM Withdraw: some balances are zero" + << " curBalance: " << curBalance << " " << amountWithdrawActual + << " curBalance2: " << curBalance2 << " " + << (amount2WithdrawActual ? *amount2WithdrawActual : STAmount{}) + << " lpTokensBalance: " << lpTokensWithdraw << " lptBalance " + << lpTokensAMMBalance; + return {tecAMM_BALANCE, STAmount{}, STAmount{}, STAmount{}}; + } + } + + // Check the reserve in case a trustline or MPT has to be created + bool const enabledFixAMMv1_2 = view.rules().enabled(fixAMMv1_2); + // If seated after a call to sufficientReserve() then MPToken must be + // authorized + std::optional mptokenKey; + auto sufficientReserve = [&](Asset const& asset) -> TER { + mptokenKey = std::nullopt; + if (!enabledFixAMMv1_2 || isXRP(asset)) + return tesSUCCESS; + bool const isIssue = asset.holds(); + bool const assetNotExists = [&] { + if (isIssue) + return !view.exists(keylet::line(account, asset.get())); + auto const issuanceKey = keylet::mptIssuance(asset.get()); + mptokenKey = keylet::mptoken(issuanceKey.key, account); + if (!view.exists(*mptokenKey)) + return true; + mptokenKey = std::nullopt; + return false; + }(); + if (assetNotExists) + { + auto sleAccount = view.peek(keylet::account(account)); if (!sleAccount) return tecINTERNAL; // LCOV_EXCL_LINE - auto const balance = (*sleAccount)[sfBalance].xrp(); + STAmount const balance = (*sleAccount)[sfBalance]; std::uint32_t const ownerCount = sleAccount->at(sfOwnerCount); - // See also TrustSet::doApply() + // See also TrustSet::doApply() and MPTokenAuthorize::authorize() XRPAmount const reserve( (ownerCount < 2) ? XRPAmount(beast::zero) : view.fees().accountReserve(ownerCount + 1)); - if (std::max(priorBalance, balance) < reserve) + auto const balance_ = isIssue ? std::max(priorBalance, balance.xrp()) : priorBalance; + if (balance_ < reserve) return tecINSUFFICIENT_RESERVE; + + // Update owner count. + if (!isIssue) + adjustOwnerCount(view, sleAccount, 1, journal); } return tesSUCCESS; }; - if (auto const err = sufficientReserve(amountWithdrawActual.issue())) + // Create MPToken if it doesn't exist + auto createMPToken = [&](Asset const& asset) -> TER { + // If mptoken is seated then must authorize + if (mptokenKey && account != asset.getIssuer()) + { + auto const& mptIssue = asset.get(); + if (auto const err = requireAuth(view, mptIssue, account, AuthType::WeakAuth); + !isTesSuccess(err)) + return err; + + if (auto const err = checkCreateMPT(view, mptIssue, account, journal); + !isTesSuccess(err)) + { + return err; + } + } + return tesSUCCESS; + }; + + if (auto const err = sufficientReserve(amountWithdrawActual.asset())) return {err, STAmount{}, STAmount{}, STAmount{}}; + if (auto const res = createMPToken(amountWithdrawActual.asset()); !isTesSuccess(res)) + return {res, STAmount{}, STAmount{}, STAmount{}}; + // Withdraw amountWithdraw auto res = accountSend( view, ammAccount, account, amountWithdrawActual, journal, WaiveTransferFee::Yes); @@ -566,9 +680,12 @@ AMMWithdraw::withdraw( // Withdraw amount2Withdraw if (amount2WithdrawActual) { - if (auto const err = sufficientReserve(amount2WithdrawActual->issue()); !isTesSuccess(err)) + if (auto const err = sufficientReserve(amount2WithdrawActual->asset()); !isTesSuccess(err)) return {err, STAmount{}, STAmount{}, STAmount{}}; + if (auto const res = createMPToken(amount2WithdrawActual->asset()); !isTesSuccess(res)) + return {res, STAmount{}, STAmount{}, STAmount{}}; + res = accountSend( view, ammAccount, account, *amount2WithdrawActual, journal, WaiveTransferFee::Yes); if (!isTesSuccess(res)) @@ -581,7 +698,8 @@ AMMWithdraw::withdraw( } // Withdraw LP tokens - res = redeemIOU(view, account, lpTokensWithdrawActual, lpTokensWithdrawActual.issue(), journal); + res = redeemIOU( + view, account, lpTokensWithdrawActual, lpTokensWithdrawActual.get(), journal); if (!isTesSuccess(res)) { // LCOV_EXCL_START @@ -637,6 +755,7 @@ AMMWithdraw::equalWithdrawTokens( lpTokensWithdraw, tfee, FreezeHandling::fhZERO_IF_FROZEN, + AuthHandling::ahZERO_IF_UNAUTHORIZED, isWithdrawAll(ctx_.tx), preFeeBalance_, ctx_.journal); @@ -648,15 +767,15 @@ AMMWithdraw::deleteAMMAccountIfEmpty( Sandbox& sb, std::shared_ptr const ammSle, STAmount const& lpTokenBalance, - Issue const& issue1, - Issue const& issue2, + Asset const& asset1, + Asset const& asset2, beast::Journal const& journal) { TER ter; bool updateBalance = true; if (lpTokenBalance == beast::zero) { - ter = deleteAMMAccount(sb, issue1, issue2, journal); + ter = deleteAMMAccount(sb, asset1, asset2, journal); if (!isTesSuccess(ter) && ter != tecINCOMPLETE) return {ter, false}; // LCOV_EXCL_LINE @@ -687,6 +806,7 @@ AMMWithdraw::equalWithdrawTokens( STAmount const& lpTokensWithdraw, std::uint16_t tfee, FreezeHandling freezeHandling, + AuthHandling authHandling, WithdrawAll withdrawAll, XRPAmount const& priorBalance, beast::Journal const& journal) @@ -708,6 +828,7 @@ AMMWithdraw::equalWithdrawTokens( lpTokensWithdraw, tfee, freezeHandling, + authHandling, WithdrawAll::Yes, priorBalance, journal); @@ -742,6 +863,7 @@ AMMWithdraw::equalWithdrawTokens( tokensAdj, tfee, freezeHandling, + authHandling, withdrawAll, priorBalance, journal); @@ -793,13 +915,12 @@ AMMWithdraw::equalWithdrawLimit( std::uint16_t tfee) { auto frac = Number{amount} / amountBalance; - auto amount2Withdraw = getRoundedAsset(view.rules(), amount2Balance, frac, IsDeposit::No); auto tokensAdj = getRoundedLPTokens(view.rules(), lptAMMBalance, frac, IsDeposit::No); if (view.rules().enabled(fixAMMv1_3) && tokensAdj == beast::zero) return {tecAMM_INVALID_TOKENS, STAmount{}}; // factor in the adjusted tokens frac = adjustFracByTokens(view.rules(), lptAMMBalance, tokensAdj, frac); - amount2Withdraw = getRoundedAsset(view.rules(), amount2Balance, frac, IsDeposit::No); + auto const amount2Withdraw = getRoundedAsset(view.rules(), amount2Balance, frac, IsDeposit::No); if (amount2Withdraw <= amount2) { return withdraw( diff --git a/src/libxrpl/tx/transactors/dex/OfferCancel.cpp b/src/libxrpl/tx/transactors/dex/OfferCancel.cpp index 3c5149dd7d..82a3b0783b 100644 --- a/src/libxrpl/tx/transactors/dex/OfferCancel.cpp +++ b/src/libxrpl/tx/transactors/dex/OfferCancel.cpp @@ -1,8 +1,12 @@ -#include -#include -#include #include +#include +#include +#include +#include +#include +#include + namespace xrpl { NotTEC diff --git a/src/libxrpl/tx/transactors/dex/OfferCreate.cpp b/src/libxrpl/tx/transactors/dex/OfferCreate.cpp index af100bc141..2d21cebbe3 100644 --- a/src/libxrpl/tx/transactors/dex/OfferCreate.cpp +++ b/src/libxrpl/tx/transactors/dex/OfferCreate.cpp @@ -1,19 +1,55 @@ +#include + +#include #include -#include +#include +#include +#include +#include #include #include +#include #include #include +#include #include -#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include #include -#include +#include +#include +#include +#include #include -#include -#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { TxConsequences @@ -30,7 +66,11 @@ OfferCreate::makeTxConsequences(PreflightContext const& ctx) bool OfferCreate::checkExtraFeatures(PreflightContext const& ctx) { - return !ctx.tx.isFieldPresent(sfDomainID) || ctx.rules.enabled(featurePermissionedDEX); + if (ctx.tx.isFieldPresent(sfDomainID) && !ctx.rules.enabled(featurePermissionedDEX)) + return false; + + return ctx.rules.enabled(featureMPTokensV2) || + (!ctx.tx[sfTakerPays].holds() && !ctx.tx[sfTakerGets].holds()); } std::uint32_t @@ -79,8 +119,8 @@ OfferCreate::preflight(PreflightContext const& ctx) return temBAD_SEQUENCE; } - STAmount saTakerPays = tx[sfTakerPays]; - STAmount saTakerGets = tx[sfTakerGets]; + STAmount const saTakerPays = tx[sfTakerPays]; + STAmount const saTakerGets = tx[sfTakerGets]; if (!isLegalNet(saTakerPays) || !isLegalNet(saTakerGets)) return temBAD_AMOUNT; @@ -97,18 +137,18 @@ OfferCreate::preflight(PreflightContext const& ctx) } auto const& uPaysIssuerID = saTakerPays.getIssuer(); - auto const& uPaysCurrency = saTakerPays.getCurrency(); + auto const& uPaysAsset = saTakerPays.asset(); auto const& uGetsIssuerID = saTakerGets.getIssuer(); - auto const& uGetsCurrency = saTakerGets.getCurrency(); + auto const& uGetsAsset = saTakerGets.asset(); - if (uPaysCurrency == uGetsCurrency && uPaysIssuerID == uGetsIssuerID) + if (uPaysAsset == uGetsAsset) { JLOG(j.debug()) << "Malformed offer: redundant (IOU for IOU)"; return temREDUNDANT; } // We don't allow a non-native currency to use the currency code XRP. - if (badCurrency() == uPaysCurrency || badCurrency() == uGetsCurrency) + if (badAsset() == uPaysAsset || badAsset() == uGetsAsset) { JLOG(j.debug()) << "Malformed offer: bad currency"; return temBAD_CURRENCY; @@ -131,10 +171,7 @@ OfferCreate::preclaim(PreclaimContext const& ctx) auto saTakerPays = ctx.tx[sfTakerPays]; auto saTakerGets = ctx.tx[sfTakerGets]; - auto const& uPaysIssuerID = saTakerPays.getIssuer(); - auto const& uPaysCurrency = saTakerPays.getCurrency(); - - auto const& uGetsIssuerID = saTakerGets.getIssuer(); + auto const& uPaysAsset = saTakerPays.asset(); auto const cancelSequence = ctx.tx[~sfOfferSequence]; @@ -146,13 +183,17 @@ OfferCreate::preclaim(PreclaimContext const& ctx) auto viewJ = ctx.registry.get().getJournal("View"); - if (isGlobalFrozen(ctx.view, uPaysIssuerID) || isGlobalFrozen(ctx.view, uGetsIssuerID)) + if (isGlobalFrozen(ctx.view, saTakerPays.asset()) || + isGlobalFrozen(ctx.view, saTakerGets.asset())) { JLOG(ctx.j.debug()) << "Offer involves frozen asset"; return tecFROZEN; } - if (accountFunds(ctx.view, id, saTakerGets, fhZERO_IF_FROZEN, viewJ) <= beast::zero) + // Allow unfunded MPT for issuer (OutstandingAmount >= MaximumAmount) + if ((!saTakerGets.holds() || saTakerGets.getIssuer() != id) && + accountFunds(ctx.view, id, saTakerGets, fhZERO_IF_FROZEN, ahZERO_IF_UNAUTHORIZED, viewJ) <= + beast::zero) { JLOG(ctx.j.debug()) << "delay: Offers must be at least partially funded."; return tecUNFUNDED_OFFER; @@ -177,8 +218,7 @@ OfferCreate::preclaim(PreclaimContext const& ctx) // Make sure that we are authorized to hold what the taker will pay us. if (!saTakerPays.native()) { - auto result = - checkAcceptAsset(ctx.view, ctx.flags, id, ctx.j, Issue(uPaysCurrency, uPaysIssuerID)); + auto result = checkAcceptAsset(ctx.view, ctx.flags, id, ctx.j, uPaysAsset); if (!isTesSuccess(result)) return result; } @@ -191,6 +231,11 @@ OfferCreate::preclaim(PreclaimContext const& ctx) return tecNO_PERMISSION; } + if (auto const ter = canTrade(ctx.view, saTakerPays.asset()); !isTesSuccess(ter)) + return ter; + if (auto const ter = canTrade(ctx.view, saTakerGets.asset()); !isTesSuccess(ter)) + return ter; + return tesSUCCESS; } @@ -200,17 +245,17 @@ OfferCreate::checkAcceptAsset( ApplyFlags const flags, AccountID const id, beast::Journal const j, - Issue const& issue) + Asset const& asset) { // Only valid for custom currencies - XRPL_ASSERT(!isXRP(issue.currency), "xrpl::OfferCreate::checkAcceptAsset : input is not XRP"); + XRPL_ASSERT(!isXRP(asset), "xrpl::OfferCreate::checkAcceptAsset : input is not XRP"); - auto const issuerAccount = view.read(keylet::account(issue.account)); + auto const issuerAccount = view.read(keylet::account(asset.getIssuer())); if (!issuerAccount) { JLOG(j.debug()) << "delay: can't receive IOUs from non-existent issuer: " - << to_string(issue.account); + << to_string(asset.getIssuer()); return ((flags & tapRETRY) != 0u) ? TER{terNO_ACCOUNT} : TER{tecNO_ISSUER}; } @@ -218,51 +263,63 @@ OfferCreate::checkAcceptAsset( // An account cannot create a trustline to itself, so no line can exist // to be frozen. Additionally, an issuer can always accept its own // issuance. - if (issue.account == id) + if (asset.getIssuer() == id) return tesSUCCESS; - if (((*issuerAccount)[sfFlags] & lsfRequireAuth) != 0u) - { - auto const trustLine = view.read(keylet::line(id, issue.account, issue.currency)); + return asset.visit( + [&](Issue const& issue) -> TER { + auto const& issuer = issue.getIssuer(); + if (((*issuerAccount)[sfFlags] & lsfRequireAuth) != 0u) + { + auto const trustLine = view.read(keylet::line(id, issuer, issue.currency)); - if (!trustLine) - { - return ((flags & tapRETRY) != 0u) ? TER{terNO_LINE} : TER{tecNO_LINE}; - } + if (!trustLine) + { + return ((flags & tapRETRY) != 0u) ? TER{terNO_LINE} : TER{tecNO_LINE}; + } - // Entries have a canonical representation, determined by a - // lexicographical "greater than" comparison employing strict weak - // ordering. Determine which entry we need to access. - bool const canonical_gt(id > issue.account); + // Entries have a canonical representation, determined by a + // lexicographical "greater than" comparison employing + // strict weak ordering. Determine which entry we need to + // access. + bool const canonical_gt(id > issuer); - bool const is_authorized( - ((*trustLine)[sfFlags] & (canonical_gt ? lsfLowAuth : lsfHighAuth)) != 0u); + bool const is_authorized( + ((*trustLine)[sfFlags] & (canonical_gt ? lsfLowAuth : lsfHighAuth)) != 0u); - if (!is_authorized) - { - JLOG(j.debug()) << "delay: can't receive IOUs from issuer without auth."; + if (!is_authorized) + { + JLOG(j.debug()) << "delay: can't receive IOUs from " + "issuer without auth."; - return ((flags & tapRETRY) != 0u) ? TER{terNO_AUTH} : TER{tecNO_AUTH}; - } - } + return ((flags & tapRETRY) != 0u) ? TER{terNO_AUTH} : TER{tecNO_AUTH}; + } + } - auto const trustLine = view.read(keylet::line(id, issue.account, issue.currency)); + auto const trustLine = view.read(keylet::line(id, issue.account, issue.currency)); - if (!trustLine) - { - return tesSUCCESS; - } + if (!trustLine) + { + return tesSUCCESS; + } - // There's no difference which side enacted deep freeze, accepting - // tokens shouldn't be possible. - bool const deepFrozen = ((*trustLine)[sfFlags] & (lsfLowDeepFreeze | lsfHighDeepFreeze)) != 0u; + // There's no difference which side enacted deep freeze, accepting + // tokens shouldn't be possible. + bool const deepFrozen = + ((*trustLine)[sfFlags] & (lsfLowDeepFreeze | lsfHighDeepFreeze)) != 0u; - if (deepFrozen) - { - return tecFROZEN; - } + if (deepFrozen) + { + return tecFROZEN; + } - return tesSUCCESS; + return tesSUCCESS; + }, + [&](MPTIssue const& issue) -> TER { + // WeakAuth - don't check if MPToken exists since it's created + // if needed. + return requireAuth(view, issue, id, AuthType::WeakAuth); + }); } std::pair @@ -280,9 +337,12 @@ OfferCreate::flowCross( // We check this in preclaim, but when selling XRP charged fees can // cause a user's available balance to go to 0 (by causing it to dip // below the reserve) so we check this case again. - STAmount const inStartBalance = - accountFunds(psb, account_, takerAmount.in, fhZERO_IF_FROZEN, j_); - if (inStartBalance <= beast::zero) + STAmount const inStartBalance = accountFunds( + psb, account_, takerAmount.in, fhZERO_IF_FROZEN, ahZERO_IF_UNAUTHORIZED, j_); + // Allow unfunded MPT issuer + auto const disallowUnfunded = + !inStartBalance.holds() || inStartBalance.getIssuer() != account_; + if (disallowUnfunded && inStartBalance <= beast::zero) { // The account balance can't cover even part of the offer. JLOG(j_.debug()) << "Not crossing: taker is unfunded."; @@ -296,11 +356,11 @@ OfferCreate::flowCross( STAmount sendMax = takerAmount.in; if (!sendMax.native() && (account_ != sendMax.getIssuer())) { - gatewayXferRate = transferRate(psb, sendMax.getIssuer()); + gatewayXferRate = transferRate(psb, sendMax); if (gatewayXferRate.value != QUALITY_ONE) { sendMax = - multiplyRound(takerAmount.in, gatewayXferRate, takerAmount.in.issue(), true); + multiplyRound(takerAmount.in, gatewayXferRate, takerAmount.in.asset(), true); } } @@ -331,6 +391,7 @@ OfferCreate::flowCross( } // Special handling for the tfSell flag. STAmount deliver = takerAmount.out; + auto const& deliverAsset = deliver.asset(); OfferCrossing offerCrossing = OfferCrossing::yes; if ((txFlags & tfSell) != 0u) { @@ -338,19 +399,23 @@ OfferCreate::flowCross( // We are selling, so we will accept *more* than the offer // specified. Since we don't know how much they might offer, // we allow delivery of the largest possible amount. - if (deliver.native()) - { - deliver = STAmount{STAmount::cMaxNative}; - } - else - { - // We can't use the maximum possible currency here because - // there might be a gateway transfer rate to account for. - // Since the transfer rate cannot exceed 200%, we use 1/2 - // maxValue for our limit. - deliver = STAmount{ - takerAmount.out.issue(), STAmount::cMaxValue / 2, STAmount::cMaxOffset}; - } + deliver.asset().visit( + [&](Issue const& issue) { + if (issue.native()) + { + deliver = STAmount{STAmount::cMaxNative}; + } + // We can't use the maximum possible currency here because + // there might be a gateway transfer rate to account for. + // Since the transfer rate cannot exceed 200%, we use 1/2 + // maxValue for our limit. + else + { + deliver = + STAmount{deliverAsset, STAmount::cMaxValue / 2, STAmount::cMaxOffset}; + } + }, + [&](MPTIssue const&) { deliver = STAmount{deliverAsset, maxMPTokenAmount / 2}; }); } // Call the payment engine's flow() to do the actual work. @@ -382,10 +447,10 @@ OfferCreate::flowCross( auto afterCross = takerAmount; // If !tesSUCCESS offer unchanged if (isTesSuccess(result.result())) { - STAmount const takerInBalance = - accountFunds(psb, account_, takerAmount.in, fhZERO_IF_FROZEN, j_); + STAmount const takerInBalance = accountFunds( + psb, account_, takerAmount.in, fhZERO_IF_FROZEN, ahZERO_IF_UNAUTHORIZED, j_); - if (takerInBalance <= beast::zero) + if (disallowUnfunded && takerInBalance <= beast::zero) { // If offer crossing exhausted the account's funds don't // create the offer. @@ -410,7 +475,7 @@ OfferCreate::flowCross( if (gatewayXferRate.value != QUALITY_ONE) { nonGatewayAmountIn = divideRound( - result.actualAmountIn, gatewayXferRate, takerAmount.in.issue(), true); + result.actualAmountIn, gatewayXferRate, takerAmount.in.asset(), true); } afterCross.in -= nonGatewayAmountIn; @@ -425,7 +490,7 @@ OfferCreate::flowCross( } afterCross.out = - divRoundStrict(afterCross.in, rate, takerAmount.out.issue(), false); + divRoundStrict(afterCross.in, rate, takerAmount.out.asset(), false); } else { @@ -438,7 +503,7 @@ OfferCreate::flowCross( "xrpl::OfferCreate::flowCross : minimum offer"); if (afterCross.out < beast::zero) afterCross.out.clear(); - afterCross.in = mulRound(afterCross.out, rate, takerAmount.in.issue(), true); + afterCross.in = mulRound(afterCross.out, rate, takerAmount.in.asset(), true); } } } @@ -458,7 +523,9 @@ OfferCreate::format_amount(STAmount const& amount) { std::string txt = amount.getText(); txt += "/"; - txt += to_string(amount.issue().currency); + amount.asset().visit( + [&](Issue const& issue) { txt += to_string(issue.currency); }, + [&](MPTIssue const& issue) { txt += to_string(issue); }); return txt; } @@ -478,7 +545,7 @@ OfferCreate::applyHybrid( sleOffer->setFlag(lsfHybrid); // if offer is hybrid, need to also place into open offer dir - Book const book{saTakerPays.issue(), saTakerGets.issue(), std::nullopt}; + Book const book{saTakerPays.asset(), saTakerGets.asset(), std::nullopt}; auto dir = keylet::quality(keylet::book(book), getRate(saTakerGets, saTakerPays)); bool const bookExists = sb.exists(dir); @@ -527,7 +594,7 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) auto const cancelSequence = ctx_.tx[~sfOfferSequence]; - // Note that we we use the value from the sequence or ticket as the + // Note that we use the value from the sequence or ticket as the // offer sequence. For more explanation see comments in SeqProxy.h. auto const offerSequence = ctx_.tx.getSeqValue(); @@ -574,13 +641,15 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) auto const& uGetsIssuerID = saTakerGets.getIssuer(); std::uint8_t uTickSize = Quality::maxTickSize; - if (!isXRP(uPaysIssuerID)) + // Not XRP or MPT + if (!saTakerPays.integral()) { auto const sle = sb.read(keylet::account(uPaysIssuerID)); if (sle && sle->isFieldPresent(sfTickSize)) uTickSize = std::min(uTickSize, (*sle)[sfTickSize]); } - if (!isXRP(uGetsIssuerID)) + // Not XRP or MPT + if (!saTakerGets.integral()) { auto const sle = sb.read(keylet::account(uGetsIssuerID)); if (sle && sle->isFieldPresent(sfTickSize)) @@ -596,12 +665,13 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) if (bSell) { // this is a sell, round taker pays - saTakerPays = multiply(saTakerGets, rate, saTakerPays.issue()); + if (!saTakerPays.holds()) + saTakerPays = multiply(saTakerGets, rate, saTakerPays.asset()); } - else + else if (!saTakerGets.holds()) { // this is a buy, round taker gets - saTakerGets = divide(saTakerPays, rate, saTakerGets.issue()); + saTakerGets = divide(saTakerPays, rate, saTakerGets.asset()); } if (!saTakerGets || !saTakerPays) { @@ -615,8 +685,8 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) // We reverse pays and gets because during crossing we are taking. Amounts const takerAmount(saTakerGets, saTakerPays); - JLOG(j_.debug()) << "Attempting cross: " << to_string(takerAmount.in.issue()) << " -> " - << to_string(takerAmount.out.issue()); + JLOG(j_.debug()) << "Attempting cross: " << to_string(takerAmount.in.asset()) << " -> " + << to_string(takerAmount.out.asset()); if (auto stream = j_.trace()) { @@ -660,10 +730,10 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) } XRPL_ASSERT( - saTakerGets.issue() == place_offer.in.issue(), + saTakerGets.asset() == place_offer.in.asset(), "xrpl::OfferCreate::applyGuts : taker gets issue match"); XRPL_ASSERT( - saTakerPays.issue() == place_offer.out.issue(), + saTakerPays.asset() == place_offer.out.asset(), "xrpl::OfferCreate::applyGuts : taker pays issue match"); if (takerAmount != place_offer) @@ -726,7 +796,7 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) { // Any ImmediateOrCancel offer that transfers absolutely no funds // returns tecKILLED rather than tesSUCCESS. Motivation for the - // change is here: https://github.com/ripple/rippled/issues/4115 + // change is here: https://github.com/XRPLF/rippled/issues/4115 return {tecKILLED, false}; } return {tesSUCCESS, true}; @@ -737,7 +807,8 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) return {tefINTERNAL, false}; { - XRPAmount reserve = sb.fees().accountReserve(sleCreator->getFieldU32(sfOwnerCount) + 1); + XRPAmount const reserve = + sb.fees().accountReserve(sleCreator->getFieldU32(sfOwnerCount) + 1); if (preFeeBalance_ < reserve) { @@ -774,11 +845,11 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) // Update owner count. adjustOwnerCount(sb, sleCreator, 1, viewJ); - JLOG(j_.trace()) << "adding to book: " << to_string(saTakerPays.issue()) << " : " - << to_string(saTakerGets.issue()) + JLOG(j_.trace()) << "adding to book: " << to_string(saTakerPays.asset()) << " : " + << to_string(saTakerGets.asset()) << (domainID ? (" : " + to_string(*domainID)) : ""); - Book const book{saTakerPays.issue(), saTakerGets.issue(), domainID}; + Book const book{saTakerPays.asset(), saTakerGets.asset(), domainID}; // Add offer to order book, using the original rate // before any crossing occurred. @@ -795,10 +866,18 @@ OfferCreate::applyGuts(Sandbox& sb, Sandbox& sbCancel) bool const bookExisted = static_cast(sb.peek(dir)); auto setBookDir = [&](SLE::ref sle, std::optional const& maybeDomain) { - sle->setFieldH160(sfTakerPaysCurrency, saTakerPays.issue().currency); - sle->setFieldH160(sfTakerPaysIssuer, saTakerPays.issue().account); - sle->setFieldH160(sfTakerGetsCurrency, saTakerGets.issue().currency); - sle->setFieldH160(sfTakerGetsIssuer, saTakerGets.issue().account); + saTakerPays.asset().visit( + [&](Issue const& issue) { + sle->setFieldH160(sfTakerPaysCurrency, issue.currency); + sle->setFieldH160(sfTakerPaysIssuer, issue.account); + }, + [&](MPTIssue const& issue) { sle->setFieldH192(sfTakerPaysMPT, issue.getMptID()); }); + saTakerGets.asset().visit( + [&](Issue const& issue) { + sle->setFieldH160(sfTakerGetsCurrency, issue.currency); + sle->setFieldH160(sfTakerGetsIssuer, issue.account); + }, + [&](MPTIssue const& issue) { sle->setFieldH192(sfTakerGetsMPT, issue.getMptID()); }); sle->setFieldU64(sfExchangeRate, uRate); if (maybeDomain) sle->setFieldH256(sfDomainID, *maybeDomain); diff --git a/src/libxrpl/tx/transactors/did/DIDDelete.cpp b/src/libxrpl/tx/transactors/did/DIDDelete.cpp index e90cb502d1..528e2f31b5 100644 --- a/src/libxrpl/tx/transactors/did/DIDDelete.cpp +++ b/src/libxrpl/tx/transactors/did/DIDDelete.cpp @@ -1,8 +1,18 @@ +#include + #include +#include #include #include +#include #include -#include +#include +#include +#include +#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/did/DIDSet.cpp b/src/libxrpl/tx/transactors/did/DIDSet.cpp index 9d307f0662..e09c6a1fe3 100644 --- a/src/libxrpl/tx/transactors/did/DIDSet.cpp +++ b/src/libxrpl/tx/transactors/did/DIDSet.cpp @@ -1,11 +1,21 @@ -#include +#include + +#include #include #include #include +#include #include #include -#include -#include +#include +#include +#include +#include +#include +#include + +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/escrow/Escrow.cpp b/src/libxrpl/tx/transactors/escrow/Escrow.cpp new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/libxrpl/tx/transactors/escrow/EscrowCancel.cpp b/src/libxrpl/tx/transactors/escrow/EscrowCancel.cpp index 11a4cfdbaa..d976927a9e 100644 --- a/src/libxrpl/tx/transactors/escrow/EscrowCancel.cpp +++ b/src/libxrpl/tx/transactors/escrow/EscrowCancel.cpp @@ -1,15 +1,26 @@ +#include + #include #include #include #include +#include #include #include +#include +#include +#include #include #include +#include +#include #include -#include +#include +#include +#include +#include -#include +#include namespace xrpl { @@ -33,13 +44,13 @@ escrowCancelPreclaimHelper( AccountID const& account, STAmount const& amount) { - AccountID issuer = amount.getIssuer(); + AccountID const& issuer = amount.getIssuer(); // If the issuer is the same as the account, return tecINTERNAL if (issuer == account) return tecINTERNAL; // LCOV_EXCL_LINE // If the issuer has requireAuth set, check if the account is authorized - if (auto const ter = requireAuth(ctx.view, amount.issue(), account); !isTesSuccess(ter)) + if (auto const ter = requireAuth(ctx.view, amount.get(), account); !isTesSuccess(ter)) return ter; return tesSUCCESS; @@ -52,7 +63,7 @@ escrowCancelPreclaimHelper( AccountID const& account, STAmount const& amount) { - AccountID issuer = amount.getIssuer(); + AccountID const issuer = amount.getIssuer(); // If the issuer is the same as the account, return tecINTERNAL if (issuer == account) return tecINTERNAL; // LCOV_EXCL_LINE diff --git a/src/libxrpl/tx/transactors/escrow/EscrowCreate.cpp b/src/libxrpl/tx/transactors/escrow/EscrowCreate.cpp index a27f25071f..554cc539e0 100644 --- a/src/libxrpl/tx/transactors/escrow/EscrowCreate.cpp +++ b/src/libxrpl/tx/transactors/escrow/EscrowCreate.cpp @@ -1,19 +1,38 @@ +#include + #include #include +#include #include +#include #include #include #include #include #include #include +#include +#include +#include #include #include +#include +#include #include +#include +#include #include -#include +#include +#include +#include +#include #include -#include +#include +#include + +#include +#include +#include namespace xrpl { @@ -72,7 +91,7 @@ escrowCreatePreflightHelper(PreflightContext const& ctx) if (amount.native() || amount <= beast::zero) return temBAD_AMOUNT; - if (badCurrency() == amount.getCurrency()) + if (badCurrency() == amount.get().currency) return temBAD_CURRENCY; return tesSUCCESS; @@ -163,7 +182,8 @@ escrowCreatePreclaimHelper( AccountID const& dest, STAmount const& amount) { - AccountID issuer = amount.getIssuer(); + Issue const& issue = amount.get(); + AccountID const& issuer = amount.getIssuer(); // If the issuer is the same as the account, return tecNO_PERMISSION if (issuer == account) return tecNO_PERMISSION; @@ -176,7 +196,7 @@ escrowCreatePreclaimHelper( return tecNO_PERMISSION; // If the account does not have a trustline to the issuer, return tecNO_LINE - auto const sleRippleState = ctx.view.read(keylet::line(account, issuer, amount.getCurrency())); + auto const sleRippleState = ctx.view.read(keylet::line(account, issuer, issue.currency)); if (!sleRippleState) return tecNO_LINE; @@ -191,23 +211,23 @@ escrowCreatePreclaimHelper( return tecNO_PERMISSION; // LCOV_EXCL_LINE // If the issuer has requireAuth set, check if the account is authorized - if (auto const ter = requireAuth(ctx.view, amount.issue(), account); !isTesSuccess(ter)) + if (auto const ter = requireAuth(ctx.view, issue, account); !isTesSuccess(ter)) return ter; // If the issuer has requireAuth set, check if the destination is authorized - if (auto const ter = requireAuth(ctx.view, amount.issue(), dest); !isTesSuccess(ter)) + if (auto const ter = requireAuth(ctx.view, issue, dest); !isTesSuccess(ter)) return ter; // If the issuer has frozen the account, return tecFROZEN - if (isFrozen(ctx.view, account, amount.issue())) + if (isFrozen(ctx.view, account, issue)) return tecFROZEN; // If the issuer has frozen the destination, return tecFROZEN - if (isFrozen(ctx.view, dest, amount.issue())) + if (isFrozen(ctx.view, dest, issue)) return tecFROZEN; STAmount const spendableAmount = - accountHolds(ctx.view, account, amount.getCurrency(), issuer, fhIGNORE_FREEZE, ctx.j); + accountHolds(ctx.view, account, issue.currency, issuer, fhIGNORE_FREEZE, ctx.j); // If the balance is less than or equal to 0, return tecINSUFFICIENT_FUNDS if (spendableAmount <= beast::zero) @@ -233,7 +253,7 @@ escrowCreatePreclaimHelper( AccountID const& dest, STAmount const& amount) { - AccountID issuer = amount.getIssuer(); + AccountID const issuer = amount.getIssuer(); // If the issuer is the same as the account, return tecNO_PERMISSION if (issuer == account) return tecNO_PERMISSION; @@ -353,7 +373,8 @@ escrowLockApplyHelper( if (issuer == sender) return tecINTERNAL; // LCOV_EXCL_LINE - auto const ter = rippleCredit(view, sender, issuer, amount, !amount.holds(), journal); + auto const ter = + directSendNoFee(view, sender, issuer, amount, !amount.holds(), journal); if (!isTesSuccess(ter)) return ter; // LCOV_EXCL_LINE return tesSUCCESS; @@ -372,7 +393,7 @@ escrowLockApplyHelper( if (issuer == sender) return tecINTERNAL; // LCOV_EXCL_LINE - auto const ter = rippleLockEscrowMPT(view, sender, amount, journal); + auto const ter = lockEscrowMPT(view, sender, amount, journal); if (!isTesSuccess(ter)) return ter; // LCOV_EXCL_LINE return tesSUCCESS; @@ -418,7 +439,7 @@ EscrowCreate::doApply() return tecDST_TAG_NEEDED; } - // Create escrow in ledger. Note that we we use the value from the + // Create escrow in ledger. Note that we use the value from the // sequence or ticket. For more explanation see comments in SeqProxy.h. Keylet const escrowKeylet = keylet::escrow(account_, ctx_.tx.getSeqValue()); auto const slep = std::make_shared(escrowKeylet); diff --git a/src/libxrpl/tx/transactors/escrow/EscrowFinish.cpp b/src/libxrpl/tx/transactors/escrow/EscrowFinish.cpp index d6b37f530e..867d3d6eea 100644 --- a/src/libxrpl/tx/transactors/escrow/EscrowFinish.cpp +++ b/src/libxrpl/tx/transactors/escrow/EscrowFinish.cpp @@ -1,21 +1,35 @@ +#include + #include +#include #include #include #include #include #include +#include #include +#include #include +#include #include #include +#include +#include +#include #include #include +#include +#include #include -#include +#include +#include +#include #include -#include +#include -#include +#include +#include namespace xrpl { @@ -127,17 +141,17 @@ escrowFinishPreclaimHelper( AccountID const& dest, STAmount const& amount) { - AccountID issuer = amount.getIssuer(); + AccountID const& issuer = amount.getIssuer(); // If the issuer is the same as the account, return tesSUCCESS if (issuer == dest) return tesSUCCESS; // If the issuer has requireAuth set, check if the destination is authorized - if (auto const ter = requireAuth(ctx.view, amount.issue(), dest); !isTesSuccess(ter)) + if (auto const ter = requireAuth(ctx.view, amount.get(), dest); !isTesSuccess(ter)) return ter; // If the issuer has deep frozen the destination, return tecFROZEN - if (isDeepFrozen(ctx.view, dest, amount.getCurrency(), amount.getIssuer())) + if (isDeepFrozen(ctx.view, dest, amount.get().currency, amount.getIssuer())) return tecFROZEN; return tesSUCCESS; @@ -150,7 +164,7 @@ escrowFinishPreclaimHelper( AccountID const& dest, STAmount const& amount) { - AccountID issuer = amount.getIssuer(); + AccountID const& issuer = amount.getIssuer(); // If the issuer is the same as the dest, return tesSUCCESS if (issuer == dest) return tesSUCCESS; diff --git a/src/libxrpl/tx/transactors/lending/LendingHelpers.cpp b/src/libxrpl/tx/transactors/lending/LendingHelpers.cpp index ad4cd8440d..dea8dbbd34 100644 --- a/src/libxrpl/tx/transactors/lending/LendingHelpers.cpp +++ b/src/libxrpl/tx/transactors/lending/LendingHelpers.cpp @@ -1,7 +1,30 @@ #include -// DO NOT REMOVE forces header file include to sort first + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include + namespace xrpl { bool @@ -1253,7 +1276,7 @@ checkLoanGuards( // loan can't be amortized in the specified number of payments, raise an // error { - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); if (std::int64_t const computedPayments{ properties.loanState.valueOutstanding / roundedPayment}; @@ -1486,7 +1509,7 @@ computeLoanProperties( auto const [totalValueOutstanding, loanScale] = [&]() { // only round up if there should be interest - NumberRoundModeGuard mg(periodicRate == 0 ? Number::to_nearest : Number::upward); + NumberRoundModeGuard const mg(periodicRate == 0 ? Number::to_nearest : Number::upward); // Use STAmount's internal rounding instead of roundToAsset, because // we're going to use this result to determine the scale for all the // other rounding. diff --git a/src/libxrpl/tx/transactors/lending/LoanBrokerCoverClawback.cpp b/src/libxrpl/tx/transactors/lending/LoanBrokerCoverClawback.cpp index fd2a145516..a40d75caab 100644 --- a/src/libxrpl/tx/transactors/lending/LoanBrokerCoverClawback.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanBrokerCoverClawback.cpp @@ -1,9 +1,33 @@ #include -// + +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include + namespace xrpl { bool @@ -123,7 +147,7 @@ determineAsset( { // We want the asset to match the vault asset, so use the account as the // issuer - return Issue{amount.getCurrency(), account}; + return Issue{amount.get().currency, account}; } return Unexpected(tecWRONG_ASSET); @@ -137,11 +161,11 @@ determineClawAmount( { auto const maxClawAmount = [&]() { // Always round the minimum required up - NumberRoundModeGuard mg1(Number::upward); + NumberRoundModeGuard const mg1(Number::upward); auto const minRequiredCover = tenthBipsOfValue(sleBroker[sfDebtTotal], TenthBips32(sleBroker[sfCoverRateMinimum])); // The subtraction probably won't round, but round down if it does. - NumberRoundModeGuard mg2(Number::downward); + NumberRoundModeGuard const mg2(Number::downward); return sleBroker[sfCoverAvailable] - minRequiredCover; }(); if (maxClawAmount <= beast::zero) diff --git a/src/libxrpl/tx/transactors/lending/LoanBrokerCoverDeposit.cpp b/src/libxrpl/tx/transactors/lending/LoanBrokerCoverDeposit.cpp index 7de5ab235f..322de22434 100644 --- a/src/libxrpl/tx/transactors/lending/LoanBrokerCoverDeposit.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanBrokerCoverDeposit.cpp @@ -1,7 +1,14 @@ #include -// + +#include +#include #include +#include +#include +#include #include +#include +#include #include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/lending/LoanBrokerCoverWithdraw.cpp b/src/libxrpl/tx/transactors/lending/LoanBrokerCoverWithdraw.cpp index ed42547a2b..1b2795cd31 100644 --- a/src/libxrpl/tx/transactors/lending/LoanBrokerCoverWithdraw.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanBrokerCoverWithdraw.cpp @@ -1,11 +1,20 @@ #include -// + +#include +#include +#include +#include #include -#include #include +#include +#include +#include +#include #include +#include +#include +#include #include -#include namespace xrpl { @@ -119,7 +128,7 @@ LoanBrokerCoverWithdraw::preclaim(PreclaimContext const& ctx) auto const minimumCover = [&]() { // Always round the minimum required up. // Applies to `tenthBipsOfValue` as well as `roundToAsset`. - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); return roundToAsset( vaultAsset, tenthBipsOfValue(currentDebtTotal, TenthBips32(sleBroker->at(sfCoverRateMinimum))), diff --git a/src/libxrpl/tx/transactors/lending/LoanBrokerDelete.cpp b/src/libxrpl/tx/transactors/lending/LoanBrokerDelete.cpp index b6cf7efb58..8aafe98343 100644 --- a/src/libxrpl/tx/transactors/lending/LoanBrokerDelete.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanBrokerDelete.cpp @@ -1,8 +1,17 @@ #include -// + +#include +#include +#include #include #include +#include +#include +#include +#include #include +#include +#include #include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/lending/LoanBrokerSet.cpp b/src/libxrpl/tx/transactors/lending/LoanBrokerSet.cpp index 5a0a6f8d46..8130af38b0 100644 --- a/src/libxrpl/tx/transactors/lending/LoanBrokerSet.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanBrokerSet.cpp @@ -1,10 +1,25 @@ #include -// + +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include + namespace xrpl { bool diff --git a/src/libxrpl/tx/transactors/lending/LoanDelete.cpp b/src/libxrpl/tx/transactors/lending/LoanDelete.cpp index 3c9dae8790..83bd2d6a6a 100644 --- a/src/libxrpl/tx/transactors/lending/LoanDelete.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanDelete.cpp @@ -1,7 +1,14 @@ #include -// + +#include +#include +#include #include +#include +#include #include +#include +#include #include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/lending/LoanManage.cpp b/src/libxrpl/tx/transactors/lending/LoanManage.cpp index 8c79171d0e..4890b54601 100644 --- a/src/libxrpl/tx/transactors/lending/LoanManage.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanManage.cpp @@ -1,10 +1,29 @@ #include -// + +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include #include +#include +#include + namespace xrpl { bool @@ -144,7 +163,7 @@ LoanManage::defaultLoan( TenthBips32 const coverRateLiquidation{brokerSle->at(sfCoverRateLiquidation)}; auto const defaultCovered = [&]() { // Always round the minimum required up. - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); auto const minimumCover = tenthBipsOfValue(brokerDebtTotalProxy.value(), coverRateMinimum); // Round the liquidation amount up, too auto const covered = roundToAsset( @@ -386,21 +405,29 @@ LoanManage::doApply() return tefBAD_LEDGER; // LCOV_EXCL_LINE auto const vaultAsset = vaultSle->at(sfAsset); - // Valid flag combinations are checked in preflight. No flags is valid - - // just a noop. - if (tx.isFlag(tfLoanDefault)) - return defaultLoan(view, loanSle, brokerSle, vaultSle, vaultAsset, j_); - if (tx.isFlag(tfLoanImpair)) - return impairLoan(view, loanSle, vaultSle, vaultAsset, j_); - if (tx.isFlag(tfLoanUnimpair)) - return unimpairLoan(view, loanSle, vaultSle, vaultAsset, j_); - // Noop, as described above. + auto const result = [&]() -> TER { + // Valid flag combinations are checked in preflight. No flags is valid - + // just a noop. + if (tx.isFlag(tfLoanDefault)) + return defaultLoan(view, loanSle, brokerSle, vaultSle, vaultAsset, j_); + if (tx.isFlag(tfLoanImpair)) + return impairLoan(view, loanSle, vaultSle, vaultAsset, j_); + if (tx.isFlag(tfLoanUnimpair)) + return unimpairLoan(view, loanSle, vaultSle, vaultAsset, j_); + // Noop, as described above. + return tesSUCCESS; + }(); - associateAsset(*loanSle, vaultAsset); - associateAsset(*brokerSle, vaultAsset); - associateAsset(*vaultSle, vaultAsset); + // Pre-amendment, associateAsset was only called on the noop (no flags) + // path. Post-amendment, we call associateAsset on all successful paths. + if (view.rules().enabled(fixSecurity3_1_3) && isTesSuccess(result)) + { + associateAsset(*loanSle, vaultAsset); + associateAsset(*brokerSle, vaultAsset); + associateAsset(*vaultSle, vaultAsset); + } - return tesSUCCESS; + return result; } void diff --git a/src/libxrpl/tx/transactors/lending/LoanPay.cpp b/src/libxrpl/tx/transactors/lending/LoanPay.cpp index c7e680addd..79ce989886 100644 --- a/src/libxrpl/tx/transactors/lending/LoanPay.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanPay.cpp @@ -1,14 +1,32 @@ #include -// + +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include #include +#include +#include #include +#include #include +#include +#include +#include #include #include +#include #include +#include namespace xrpl { @@ -117,7 +135,7 @@ LoanPay::calculateBaseFee(ReadView const& view, STTx const& tx) // If making an overpayment, count it as a full payment because it will do // about the same amount of work, if not more. - NumberRoundModeGuard mg(tx.isFlag(tfLoanOverpayment) ? Number::upward : Number::downward); + NumberRoundModeGuard const mg(tx.isFlag(tfLoanOverpayment) ? Number::upward : Number::downward); // Estimate how many payments will be made Number const numPaymentEstimate = static_cast(amount / regularPayment); @@ -155,7 +173,7 @@ LoanPay::preclaim(PreclaimContext const& ctx) if (tx.isFlag(tfLoanOverpayment) && !loanSle->isFlag(lsfLoanOverpayment)) { JLOG(ctx.j.warn()) << "Requested overpayment on a loan that doesn't allow it"; - return temINVALID_FLAG; + return ctx.view.rules().enabled(fixSecurity3_1_3) ? TER{tecNO_PERMISSION} : temINVALID_FLAG; } auto const principalOutstanding = loanSle->at(sfPrincipalOutstanding); @@ -277,7 +295,7 @@ LoanPay::doApply() // Round the minimum required cover up to be conservative. This ensures // CoverAvailable never drops below the theoretical minimum, protecting // the broker's solvency. - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); return coverAvailableProxy >= roundToAsset( asset, tenthBipsOfValue(debtTotalProxy.value(), coverRateMinimum), loanScale) && diff --git a/src/libxrpl/tx/transactors/lending/LoanSet.cpp b/src/libxrpl/tx/transactors/lending/LoanSet.cpp index b424e0763c..c13196a5da 100644 --- a/src/libxrpl/tx/transactors/lending/LoanSet.cpp +++ b/src/libxrpl/tx/transactors/lending/LoanSet.cpp @@ -1,11 +1,38 @@ #include -// + +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { bool @@ -466,7 +493,7 @@ LoanSet::doApply() // Round the minimum required cover up to be conservative. This ensures // CoverAvailable never drops below the theoretical minimum, protecting // the broker's solvency. - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); if (brokerSle->at(sfCoverAvailable) < tenthBipsOfValue(newDebtTotal, coverRateMinimum)) { JLOG(j_.warn()) << "Insufficient first-loss capital to cover the loan."; diff --git a/src/libxrpl/tx/transactors/nft/NFTokenAcceptOffer.cpp b/src/libxrpl/tx/transactors/nft/NFTokenAcceptOffer.cpp index 05a924cdbc..fcf3fc85ff 100644 --- a/src/libxrpl/tx/transactors/nft/NFTokenAcceptOffer.cpp +++ b/src/libxrpl/tx/transactors/nft/NFTokenAcceptOffer.cpp @@ -1,10 +1,26 @@ +#include + +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include #include -#include -#include -#include +#include +#include +#include +#include + +#include +#include +#include +#include namespace xrpl { @@ -83,7 +99,7 @@ NFTokenAcceptOffer::preclaim(PreclaimContext const& ctx) return tecNFTOKEN_BUY_SELL_MISMATCH; // The two offers being brokered must be for the same asset: - if ((*bo)[sfAmount].issue() != (*so)[sfAmount].issue()) + if ((*bo)[sfAmount].asset() != (*so)[sfAmount].asset()) return tecNFTOKEN_BUY_SELL_MISMATCH; // The two offers may not form a loop. A broker may not sell the @@ -116,7 +132,7 @@ NFTokenAcceptOffer::preclaim(PreclaimContext const& ctx) // cut, if any). if (auto const brokerFee = ctx.tx[~sfNFTokenBrokerFee]) { - if (brokerFee->issue() != (*bo)[sfAmount].issue()) + if (brokerFee->asset() != (*bo)[sfAmount].asset()) return tecNFTOKEN_BUY_SELL_MISMATCH; if (brokerFee >= (*bo)[sfAmount]) @@ -289,7 +305,7 @@ NFTokenAcceptOffer::preclaim(PreclaimContext const& ctx) if (ctx.view.rules().enabled(fixEnforceNFTokenTrustline) && (nft::getFlags(tokenID) & nft::flagCreateTrustLines) == 0 && nftMinter != amount.getIssuer() && - !ctx.view.read(keylet::line(nftMinter, amount.issue()))) + !ctx.view.read(keylet::line(nftMinter, amount.get()))) return tecNO_LINE; // Check that the issuer is allowed to receive IOUs. diff --git a/src/libxrpl/tx/transactors/nft/NFTokenBurn.cpp b/src/libxrpl/tx/transactors/nft/NFTokenBurn.cpp index 37c06adae9..1528a8e6f0 100644 --- a/src/libxrpl/tx/transactors/nft/NFTokenBurn.cpp +++ b/src/libxrpl/tx/transactors/nft/NFTokenBurn.cpp @@ -1,8 +1,14 @@ -#include -#include -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/nft/NFTokenCancelOffer.cpp b/src/libxrpl/tx/transactors/nft/NFTokenCancelOffer.cpp index c78d914b2d..c0dd5ad3af 100644 --- a/src/libxrpl/tx/transactors/nft/NFTokenCancelOffer.cpp +++ b/src/libxrpl/tx/transactors/nft/NFTokenCancelOffer.cpp @@ -1,10 +1,18 @@ -#include -#include -#include #include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/nft/NFTokenCreateOffer.cpp b/src/libxrpl/tx/transactors/nft/NFTokenCreateOffer.cpp index 48a98490c7..17844da523 100644 --- a/src/libxrpl/tx/transactors/nft/NFTokenCreateOffer.cpp +++ b/src/libxrpl/tx/transactors/nft/NFTokenCreateOffer.cpp @@ -1,8 +1,15 @@ -#include -#include -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/nft/NFTokenMint.cpp b/src/libxrpl/tx/transactors/nft/NFTokenMint.cpp index 399a882008..11343d78a7 100644 --- a/src/libxrpl/tx/transactors/nft/NFTokenMint.cpp +++ b/src/libxrpl/tx/transactors/nft/NFTokenMint.cpp @@ -1,14 +1,28 @@ -#include -#include -#include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + #include #include +#include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/nft/NFTokenModify.cpp b/src/libxrpl/tx/transactors/nft/NFTokenModify.cpp index b4819e250e..73304deb4d 100644 --- a/src/libxrpl/tx/transactors/nft/NFTokenModify.cpp +++ b/src/libxrpl/tx/transactors/nft/NFTokenModify.cpp @@ -1,7 +1,14 @@ -#include -#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/oracle/OracleDelete.cpp b/src/libxrpl/tx/transactors/oracle/OracleDelete.cpp index b7ace79d8e..be6b6152be 100644 --- a/src/libxrpl/tx/transactors/oracle/OracleDelete.cpp +++ b/src/libxrpl/tx/transactors/oracle/OracleDelete.cpp @@ -1,10 +1,17 @@ -#include -#include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + namespace xrpl { NotTEC diff --git a/src/libxrpl/tx/transactors/oracle/OracleSet.cpp b/src/libxrpl/tx/transactors/oracle/OracleSet.cpp index 94cbe32195..04d040ad59 100644 --- a/src/libxrpl/tx/transactors/oracle/OracleSet.cpp +++ b/src/libxrpl/tx/transactors/oracle/OracleSet.cpp @@ -1,12 +1,28 @@ -#include -#include +#include + +#include +#include #include #include #include +#include #include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/payment/DepositPreauth.cpp b/src/libxrpl/tx/transactors/payment/DepositPreauth.cpp index 60c0aa586c..e715fb980d 100644 --- a/src/libxrpl/tx/transactors/payment/DepositPreauth.cpp +++ b/src/libxrpl/tx/transactors/payment/DepositPreauth.cpp @@ -1,14 +1,28 @@ +#include + #include -#include +#include +#include +#include #include #include #include +#include #include #include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/payment/Payment.cpp b/src/libxrpl/tx/transactors/payment/Payment.cpp index 7e97fadfe2..26a78d7e0d 100644 --- a/src/libxrpl/tx/transactors/payment/Payment.cpp +++ b/src/libxrpl/tx/transactors/payment/Payment.cpp @@ -1,17 +1,46 @@ -#include +#include + +#include +#include +#include +#include +#include +#include #include #include +#include #include +#include #include +#include +#include #include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include #include -#include -#include -#include + +#include +#include +#include +#include +#include namespace xrpl { @@ -39,16 +68,17 @@ getMaxSourceAmount( { return *sendMax; } - if (dstAmount.native() || dstAmount.holds()) - { - return dstAmount; - } - - return STAmount( - Issue{dstAmount.get().currency, account}, - dstAmount.mantissa(), - dstAmount.exponent(), - dstAmount < beast::zero); + return dstAmount.asset().visit( + [&](MPTIssue const& issue) { return dstAmount; }, + [&](Issue const& issue) { + if (issue.native()) + return dstAmount; + return STAmount( + Issue{issue.currency, account}, + dstAmount.mantissa(), + dstAmount.exponent(), + dstAmount < beast::zero); + }); } bool @@ -68,9 +98,14 @@ Payment::getFlagsMask(PreflightContext const& ctx) auto& tx = ctx.tx; STAmount const dstAmount(tx.getFieldAmount(sfAmount)); - bool const mptDirect = dstAmount.holds(); + bool const isDstMPT = dstAmount.holds(); + bool const MPTokensV2 = ctx.rules.enabled(featureMPTokensV2); - return mptDirect ? tfMPTPaymentMask : tfPaymentMask; + constexpr std::uint32_t tfMPTPaymentMaskV1 = ~(tfUniversal | tfPartialPayment); + std::uint32_t const paymentMask = + (isDstMPT && !MPTokensV2) ? tfMPTPaymentMaskV1 : tfPaymentMask; + + return paymentMask; } NotTEC @@ -80,14 +115,15 @@ Payment::preflight(PreflightContext const& ctx) auto& j = ctx.j; STAmount const dstAmount(tx.getFieldAmount(sfAmount)); - bool const mptDirect = dstAmount.holds(); + bool const isDstMPT = dstAmount.holds(); + bool const MPTokensV2 = ctx.rules.enabled(featureMPTokensV2); - if (mptDirect && !ctx.rules.enabled(featureMPTokensV1)) + if (!ctx.rules.enabled(featureMPTokensV1) && isDstMPT) return temDISABLED; std::uint32_t const txFlags = tx.getFlags(); - if (mptDirect && ctx.tx.isFieldPresent(sfPaths)) + if (!MPTokensV2 && isDstMPT && ctx.tx.isFieldPresent(sfPaths)) return temMALFORMED; bool const partialPaymentAllowed = (txFlags & tfPartialPayment) != 0u; @@ -101,8 +137,9 @@ Payment::preflight(PreflightContext const& ctx) auto const account = tx.getAccountID(sfAccount); STAmount const maxSourceAmount = getMaxSourceAmount(account, dstAmount, tx[~sfSendMax]); - if ((mptDirect && dstAmount.asset() != maxSourceAmount.asset()) || - (!mptDirect && maxSourceAmount.holds())) + if (!MPTokensV2 && + ((isDstMPT && dstAmount.asset() != maxSourceAmount.asset()) || + (!isDstMPT && maxSourceAmount.holds()))) { JLOG(j.trace()) << "Malformed transaction: inconsistent issues: " << dstAmount.getFullText() << " " << maxSourceAmount.getFullText() << " " @@ -137,7 +174,12 @@ Payment::preflight(PreflightContext const& ctx) JLOG(j.trace()) << "Malformed transaction: bad dst amount: " << dstAmount.getFullText(); return temBAD_AMOUNT; } - if (badCurrency() == srcAsset || badCurrency() == dstAsset) + auto bad = [&](auto const& asset) { + if (ctx.rules.enabled(featureMPTokensV2)) + return badAsset() == asset; + return badCurrency() == asset; + }; + if (bad(srcAsset) || bad(dstAsset)) { JLOG(j.trace()) << "Malformed transaction: Bad currency."; return temBAD_CURRENCY; @@ -158,7 +200,7 @@ Payment::preflight(PreflightContext const& ctx) << "SendMax specified for XRP to XRP."; return temBAD_SEND_XRP_MAX; } - if ((xrpDirect || mptDirect) && hasPaths) + if ((xrpDirect || (!MPTokensV2 && isDstMPT)) && hasPaths) { // XRP is sent without paths. JLOG(j.trace()) << "Malformed transaction: " @@ -172,14 +214,14 @@ Payment::preflight(PreflightContext const& ctx) << "Partial payment specified for XRP to XRP."; return temBAD_SEND_XRP_PARTIAL; } - if ((xrpDirect || mptDirect) && limitQuality) + if ((xrpDirect || (!MPTokensV2 && isDstMPT)) && limitQuality) { // Consistent but redundant transaction. JLOG(j.trace()) << "Malformed transaction: " << "Limit quality specified for XRP to XRP or MPT to MPT."; return temBAD_SEND_XRP_LIMIT; } - if ((xrpDirect || mptDirect) && !defaultPathsAllowed) + if ((xrpDirect || (!MPTokensV2 && isDstMPT)) && !defaultPathsAllowed) { // Consistent but redundant transaction. JLOG(j.trace()) << "Malformed transaction: " @@ -252,6 +294,7 @@ Payment::checkPermission(ReadView const& view, STTx const& tx) tx.isFieldPresent(sfPaths)) return terNO_DELEGATE_PERMISSION; + // PaymentMint and PaymentBurn apply to both IOU and MPT direct payments. if (granularPermissions.contains(PaymentMint) && !isXRP(amountAsset) && amountAsset.getIssuer() == tx[sfAccount]) return tesSUCCESS; @@ -372,7 +415,7 @@ Payment::doApply() AccountID const dstAccountID(ctx_.tx.getAccountID(sfDestination)); STAmount const dstAmount(ctx_.tx.getFieldAmount(sfAmount)); - bool const mptDirect = dstAmount.holds(); + bool const isDstMPT = dstAmount.holds(); STAmount const maxSourceAmount = getMaxSourceAmount(account_, dstAmount, sendMax); JLOG(j_.trace()) << "maxSourceAmount=" << maxSourceAmount.getFullText() @@ -399,11 +442,14 @@ Payment::doApply() view().update(sleDst); } - bool const ripple = (hasPaths || sendMax || !dstAmount.native()) && !mptDirect; + bool const MPTokensV2 = view().rules().enabled(featureMPTokensV2); + + // Direct MPT payment is handled by payment engine if MPTokensV2 is enabled + bool const ripple = (hasPaths || sendMax || !dstAmount.native()) && (!isDstMPT || MPTokensV2); if (ripple) { - // Ripple payment with at least one intermediate step and uses + // XRPL payment with at least one intermediate step and uses // transitive balances. // An account that requires authorization has two ways to get an @@ -466,7 +512,7 @@ Payment::doApply() terResult = tecPATH_DRY; return terResult; } - if (mptDirect) + if (isDstMPT) { JLOG(j_.trace()) << " dstAmount=" << dstAmount.getFullText(); auto const& mptIssue = dstAmount.get(); @@ -559,18 +605,23 @@ Payment::doApply() // This is the total reserve in drops. auto const reserve = view().fees().accountReserve(ownerCount); - // preFeeBalance_ is the balance on the sending account BEFORE the - // fees were charged. We want to make sure we have enough reserve - // to send. Allow final spend to use reserve for fee. - auto const mmm = std::max(reserve, ctx_.tx.getFieldAmount(sfFee).xrp()); + // In a delegated payment, the fee payer is the delegated account, + // not the source account (account_). + bool const accountIsPayer = (ctx_.tx.getFeePayer() == account_); - if (preFeeBalance_ < dstAmount.xrp() + mmm) + // preFeeBalance_ is the balance on the source account (account_) BEFORE the fees + // were charged. If source account is the fee payer, it must also cover the fee. + // The final spend may use the reserve to cover fees. + auto const minRequiredFunds = + accountIsPayer ? std::max(reserve, ctx_.tx.getFieldAmount(sfFee).xrp()) : reserve; + + if (preFeeBalance_ < dstAmount.xrp() + minRequiredFunds) { // Vote no. However the transaction might succeed, if applied in // a different order. JLOG(j_.trace()) << "Delay transaction: Insufficient funds: " << to_string(preFeeBalance_) - << " / " << to_string(dstAmount.xrp() + mmm) << " (" << to_string(reserve) - << ")"; + << " / " << to_string(dstAmount.xrp() + minRequiredFunds) << " (" + << to_string(reserve) << ")"; return tecUNFUNDED_PAYMENT; } diff --git a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelClaim.cpp b/src/libxrpl/tx/transactors/payment_channel/PaymentChannelClaim.cpp index d22c907126..0af46ba043 100644 --- a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelClaim.cpp +++ b/src/libxrpl/tx/transactors/payment_channel/PaymentChannelClaim.cpp @@ -1,14 +1,26 @@ -#include -#include -#include -#include -#include -#include -#include -#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelCreate.cpp b/src/libxrpl/tx/transactors/payment_channel/PaymentChannelCreate.cpp index fec4dcd9f4..06d4aefecf 100644 --- a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelCreate.cpp +++ b/src/libxrpl/tx/transactors/payment_channel/PaymentChannelCreate.cpp @@ -1,13 +1,24 @@ +#include + #include +#include +#include #include #include #include #include #include #include +#include +#include #include -#include -#include +#include +#include +#include +#include +#include + +#include namespace xrpl { @@ -123,7 +134,7 @@ PaymentChannelCreate::doApply() // Create PayChan in ledger. // - // Note that we we use the value from the sequence or ticket as the + // Note that we use the value from the sequence or ticket as the // payChan sequence. For more explanation see comments in SeqProxy.h. Keylet const payChanKeylet = keylet::payChan(account, dst, ctx_.tx.getSeqValue()); auto const slep = std::make_shared(payChanKeylet); diff --git a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelFund.cpp b/src/libxrpl/tx/transactors/payment_channel/PaymentChannelFund.cpp index fc3330cde5..2cbfc9946e 100644 --- a/src/libxrpl/tx/transactors/payment_channel/PaymentChannelFund.cpp +++ b/src/libxrpl/tx/transactors/payment_channel/PaymentChannelFund.cpp @@ -1,9 +1,17 @@ -#include -#include -#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainDelete.cpp b/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainDelete.cpp index 50d800663c..3e4dca4b81 100644 --- a/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainDelete.cpp +++ b/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainDelete.cpp @@ -1,8 +1,14 @@ -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { NotTEC diff --git a/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainSet.cpp b/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainSet.cpp index 8af2d2c73b..d3a94b1fe6 100644 --- a/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainSet.cpp +++ b/src/libxrpl/tx/transactors/permissioned_domain/PermissionedDomainSet.cpp @@ -1,11 +1,21 @@ #include -// -#include + +#include +#include #include #include #include +#include +#include +#include +#include +#include #include -#include +#include +#include + +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/system/Batch.cpp b/src/libxrpl/tx/transactors/system/Batch.cpp index cac323f637..622c0b9130 100644 --- a/src/libxrpl/tx/transactors/system/Batch.cpp +++ b/src/libxrpl/tx/transactors/system/Batch.cpp @@ -1,13 +1,30 @@ +#include + #include -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include -#include -#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -123,7 +140,7 @@ Batch::calculateBaseFee(ReadView const& view, STTx const& tx) } // LCOV_EXCL_STOP - XRPAmount signerFees = signerCount * view.fees().base; + XRPAmount const signerFees = signerCount * view.fees().base; // LCOV_EXCL_START if (signerFees > maxAmount - txnFees) diff --git a/src/libxrpl/tx/transactors/system/Change.cpp b/src/libxrpl/tx/transactors/system/Change.cpp index c45dbcb951..6e94839a8d 100644 --- a/src/libxrpl/tx/transactors/system/Change.cpp +++ b/src/libxrpl/tx/transactors/system/Change.cpp @@ -1,13 +1,28 @@ -#include -#include -#include -#include -#include -#include -#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include namespace xrpl { @@ -142,7 +157,7 @@ Change::preCompute() TER Change::applyAmendment() { - uint256 amendment(ctx_.tx.getFieldH256(sfAmendment)); + uint256 const amendment(ctx_.tx.getFieldH256(sfAmendment)); auto const k = keylet::amendments(); diff --git a/src/libxrpl/tx/transactors/system/LedgerStateFix.cpp b/src/libxrpl/tx/transactors/system/LedgerStateFix.cpp index ebab113d3e..69bf8f250f 100644 --- a/src/libxrpl/tx/transactors/system/LedgerStateFix.cpp +++ b/src/libxrpl/tx/transactors/system/LedgerStateFix.cpp @@ -1,10 +1,14 @@ -#include -#include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { NotTEC diff --git a/src/libxrpl/tx/transactors/system/TicketCreate.cpp b/src/libxrpl/tx/transactors/system/TicketCreate.cpp index f3b5b1d537..6aa44442d5 100644 --- a/src/libxrpl/tx/transactors/system/TicketCreate.cpp +++ b/src/libxrpl/tx/transactors/system/TicketCreate.cpp @@ -1,10 +1,21 @@ -#include +#include + +#include +#include +#include +#include #include #include -#include #include -#include -#include +#include +#include +#include +#include +#include +#include + +#include +#include namespace xrpl { @@ -70,7 +81,7 @@ TicketCreate::doApply() return tecINSUFFICIENT_RESERVE; } - beast::Journal viewJ{ctx_.registry.get().getJournal("View")}; + beast::Journal const viewJ{ctx_.registry.get().getJournal("View")}; // The starting ticket sequence is the same as the current account // root sequence. Before we got here to doApply(), the transaction @@ -88,7 +99,7 @@ TicketCreate::doApply() { std::uint32_t const curTicketSeq = firstTicketSeq + i; Keylet const ticketKeylet = keylet::ticket(account_, curTicketSeq); - SLE::pointer sleTicket = std::make_shared(ticketKeylet); + SLE::pointer const sleTicket = std::make_shared(ticketKeylet); sleTicket->setAccountID(sfAccount, account_); sleTicket->setFieldU32(sfTicketSequence, curTicketSeq); diff --git a/src/libxrpl/tx/transactors/token/Clawback.cpp b/src/libxrpl/tx/transactors/token/Clawback.cpp index f1f22f51dd..60b0af4eae 100644 --- a/src/libxrpl/tx/transactors/token/Clawback.cpp +++ b/src/libxrpl/tx/transactors/token/Clawback.cpp @@ -1,12 +1,27 @@ -#include +#include + +#include +#include #include #include +#include +#include #include #include +#include +#include #include +#include #include -#include -#include +#include +#include +#include +#include +#include + +#include +#include +#include namespace xrpl { @@ -95,7 +110,7 @@ preclaimHelper( return tecNO_PERMISSION; auto const sleRippleState = - ctx.view.read(keylet::line(holder, issuer, clawAmount.getCurrency())); + ctx.view.read(keylet::line(holder, issuer, clawAmount.get().currency)); if (!sleRippleState) return tecNO_LINE; @@ -118,7 +133,8 @@ preclaimHelper( // We can't directly check the balance of trustline because // the available balance of a trustline is prone to new changes (eg. // XLS-34). So we must use `accountHolds`. - if (accountHolds(ctx.view, holder, clawAmount.getCurrency(), issuer, fhIGNORE_FREEZE, ctx.j) <= + if (accountHolds( + ctx.view, holder, clawAmount.get().currency, issuer, fhIGNORE_FREEZE, ctx.j) <= beast::zero) return tecINSUFFICIENT_FUNDS; @@ -199,7 +215,7 @@ applyHelper(ApplyContext& ctx) AccountID const holder = clawAmount.getIssuer(); // cannot be reference // Replace the `issuer` field with issuer's account - clawAmount.setIssuer(issuer); + clawAmount.get().account = issuer; if (holder == issuer) return tecINTERNAL; // LCOV_EXCL_LINE @@ -207,12 +223,12 @@ applyHelper(ApplyContext& ctx) STAmount const spendableAmount = accountHolds( ctx.view(), holder, - clawAmount.getCurrency(), + clawAmount.get().currency, clawAmount.getIssuer(), fhIGNORE_FREEZE, ctx.journal); - return rippleCredit( + return directSendNoFee( ctx.view(), holder, issuer, std::min(spendableAmount, clawAmount), true, ctx.journal); } @@ -233,7 +249,7 @@ applyHelper(ApplyContext& ctx) ahIGNORE_AUTH, ctx.journal); - return rippleCredit( + return directSendNoFee( ctx.view(), holder, issuer, diff --git a/src/libxrpl/tx/transactors/token/MPTokenAuthorize.cpp b/src/libxrpl/tx/transactors/token/MPTokenAuthorize.cpp index 2897278497..28d1d17f64 100644 --- a/src/libxrpl/tx/transactors/token/MPTokenAuthorize.cpp +++ b/src/libxrpl/tx/transactors/token/MPTokenAuthorize.cpp @@ -1,11 +1,18 @@ -#include +#include + +#include #include -#include #include #include +#include +#include +#include +#include #include -#include -#include +#include + +#include +#include namespace xrpl { @@ -38,7 +45,7 @@ MPTokenAuthorize::preclaim(PreclaimContext const& ctx) // `holderID` is NOT used if (!holderID) { - std::shared_ptr sleMpt = + std::shared_ptr const sleMpt = ctx.view.read(keylet::mptoken(ctx.tx[sfMPTokenIssuanceID], accountID)); // There is an edge case where all holders have zero balance, issuance @@ -132,32 +139,6 @@ MPTokenAuthorize::preclaim(PreclaimContext const& ctx) return tesSUCCESS; } -TER -MPTokenAuthorize::createMPToken( - ApplyView& view, - MPTID const& mptIssuanceID, - AccountID const& account, - std::uint32_t const flags) -{ - auto const mptokenKey = keylet::mptoken(mptIssuanceID, account); - - auto const ownerNode = - view.dirInsert(keylet::ownerDir(account), mptokenKey, describeOwnerDir(account)); - - if (!ownerNode) - return tecDIR_FULL; // LCOV_EXCL_LINE - - auto mptoken = std::make_shared(mptokenKey); - (*mptoken)[sfAccount] = account; - (*mptoken)[sfMPTokenIssuanceID] = mptIssuanceID; - (*mptoken)[sfFlags] = flags; - (*mptoken)[sfOwnerNode] = *ownerNode; - - view.insert(mptoken); - - return tesSUCCESS; -} - TER MPTokenAuthorize::doApply() { diff --git a/src/libxrpl/tx/transactors/token/MPTokenIssuanceCreate.cpp b/src/libxrpl/tx/transactors/token/MPTokenIssuanceCreate.cpp index 1e6add4f7a..9754d1867a 100644 --- a/src/libxrpl/tx/transactors/token/MPTokenIssuanceCreate.cpp +++ b/src/libxrpl/tx/transactors/token/MPTokenIssuanceCreate.cpp @@ -1,9 +1,23 @@ -#include +#include + +#include +#include +#include +#include +#include #include #include #include +#include +#include +#include +#include #include -#include +#include +#include + +#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/token/MPTokenIssuanceDestroy.cpp b/src/libxrpl/tx/transactors/token/MPTokenIssuanceDestroy.cpp index 0869cafda2..b851dc51a1 100644 --- a/src/libxrpl/tx/transactors/token/MPTokenIssuanceDestroy.cpp +++ b/src/libxrpl/tx/transactors/token/MPTokenIssuanceDestroy.cpp @@ -1,9 +1,11 @@ -#include -#include -#include -#include #include +#include +#include +#include +#include +#include + namespace xrpl { NotTEC diff --git a/src/libxrpl/tx/transactors/token/MPTokenIssuanceSet.cpp b/src/libxrpl/tx/transactors/token/MPTokenIssuanceSet.cpp index dbb7e24f68..667bb874f9 100644 --- a/src/libxrpl/tx/transactors/token/MPTokenIssuanceSet.cpp +++ b/src/libxrpl/tx/transactors/token/MPTokenIssuanceSet.cpp @@ -1,9 +1,27 @@ -#include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + namespace xrpl { bool @@ -213,6 +231,12 @@ MPTokenIssuanceSet::preclaim(PreclaimContext const& ctx) ((*mutableFlags & (f.setFlag | f.clearFlag))); })) return tecNO_PERMISSION; + + // Clearing lsfMPTRequireAuth is invalid when the issuance already has + // a DomainID set, because a DomainID requires RequireAuth to be active. + if ((*mutableFlags & tmfMPTClearRequireAuth) != 0u && + sleMptIssuance->isFieldPresent(sfDomainID)) + return tecNO_PERMISSION; } if (!isMutableFlag(lsmfMPTCanMutateMetadata) && ctx.tx.isFieldPresent(sfMPTokenMetadata)) diff --git a/src/libxrpl/tx/transactors/token/TrustSet.cpp b/src/libxrpl/tx/transactors/token/TrustSet.cpp index 44be34604c..da3d9b92c5 100644 --- a/src/libxrpl/tx/transactors/token/TrustSet.cpp +++ b/src/libxrpl/tx/transactors/token/TrustSet.cpp @@ -1,14 +1,31 @@ -#include +#include + +#include +#include +#include +#include +#include #include +#include #include #include +#include #include #include +#include +#include #include #include +#include #include -#include -#include +#include +#include +#include +#include +#include + +#include +#include namespace { @@ -82,7 +99,7 @@ TrustSet::preflight(PreflightContext const& ctx) return temBAD_LIMIT; } - if (badCurrency() == saLimitAmount.getCurrency()) + if (badCurrency() == saLimitAmount.get().currency) { JLOG(j.trace()) << "Malformed transaction: specifies XRP as IOU"; return temBAD_CURRENCY; @@ -135,7 +152,8 @@ TrustSet::checkPermission(ReadView const& view, STTx const& tx) auto const saLimitAmount = tx.getFieldAmount(sfLimitAmount); auto const sleRippleState = view.read( - keylet::line(tx[sfAccount], saLimitAmount.getIssuer(), saLimitAmount.getCurrency())); + keylet::line( + tx[sfAccount], saLimitAmount.getIssuer(), saLimitAmount.get().currency)); // if the trustline does not exist, granular permissions are // not allowed to create trustline @@ -159,7 +177,7 @@ TrustSet::checkPermission(ReadView const& view, STTx const& tx) : sleRippleState->getFieldAmount(sfLowLimit); STAmount saLimitAllow = saLimitAmount; - saLimitAllow.setIssuer(tx[sfAccount]); + saLimitAllow.get().account = tx[sfAccount]; if (curLimit != saLimitAllow) return terNO_DELEGATE_PERMISSION; @@ -188,7 +206,7 @@ TrustSet::preclaim(PreclaimContext const& ctx) auto const saLimitAmount = ctx.tx[sfLimitAmount]; - auto const currency = saLimitAmount.getCurrency(); + auto const currency = saLimitAmount.get().currency; auto const uDstAccountID = saLimitAmount.getIssuer(); if (id == uDstAccountID) @@ -241,7 +259,7 @@ TrustSet::preclaim(PreclaimContext const& ctx) { return tecAMM_EMPTY; } - if (lpTokens.getCurrency() != saLimitAmount.getCurrency()) + if (lpTokens.get().currency != saLimitAmount.get().currency) { return tecNO_PERMISSION; } @@ -317,8 +335,8 @@ TrustSet::doApply() bool const bQualityIn(ctx_.tx.isFieldPresent(sfQualityIn)); bool const bQualityOut(ctx_.tx.isFieldPresent(sfQualityOut)); - Currency const currency(saLimitAmount.getCurrency()); - AccountID uDstAccountID(saLimitAmount.getIssuer()); + Currency const currency(saLimitAmount.get().currency); + AccountID const uDstAccountID(saLimitAmount.getIssuer()); // true, if current is high account. bool const bHigh = account_ > uDstAccountID; @@ -336,7 +354,7 @@ TrustSet::doApply() // items. // // We do this because being able to exchange currencies, - // which needs trust lines, is a powerful Ripple feature. + // which needs trust lines, is a powerful XRPL feature. // So we want to make it easy for a gateway to fund the // accounts of its users without fear of being tricked. // @@ -350,7 +368,7 @@ TrustSet::doApply() XRPAmount const reserveCreate( (uOwnerCount < 2) ? XRPAmount(beast::zero) : view().fees().accountReserve(uOwnerCount + 1)); - std::uint32_t uQualityIn(bQualityIn ? ctx_.tx.getFieldU32(sfQualityIn) : 0); + std::uint32_t const uQualityIn(bQualityIn ? ctx_.tx.getFieldU32(sfQualityIn) : 0); std::uint32_t uQualityOut(bQualityOut ? ctx_.tx.getFieldU32(sfQualityOut) : 0); if (bQualityOut && QUALITY_ONE == uQualityOut) @@ -368,7 +386,7 @@ TrustSet::doApply() auto viewJ = ctx_.registry.get().getJournal("View"); - SLE::pointer sleDst = view().peek(keylet::account(uDstAccountID)); + SLE::pointer const sleDst = view().peek(keylet::account(uDstAccountID)); if (!sleDst) { @@ -377,9 +395,10 @@ TrustSet::doApply() } STAmount saLimitAllow = saLimitAmount; - saLimitAllow.setIssuer(account_); + saLimitAllow.get().account = account_; - SLE::pointer sleRippleState = view().peek(keylet::line(account_, uDstAccountID, currency)); + SLE::pointer const sleRippleState = + view().peek(keylet::line(account_, uDstAccountID, currency)); if (sleRippleState) { @@ -625,7 +644,7 @@ TrustSet::doApply() else { // Zero balance in currency. - STAmount saBalance(Issue{currency, noAccount()}); + STAmount const saBalance(Issue{currency, noAccount()}); auto const k = keylet::line(account_, uDstAccountID, currency); diff --git a/src/libxrpl/tx/transactors/vault/VaultClawback.cpp b/src/libxrpl/tx/transactors/vault/VaultClawback.cpp index 8251cfc566..04f7f248ff 100644 --- a/src/libxrpl/tx/transactors/vault/VaultClawback.cpp +++ b/src/libxrpl/tx/transactors/vault/VaultClawback.cpp @@ -1,18 +1,33 @@ +#include + +#include +#include +#include +#include +#include #include -#include +#include #include #include #include +#include +#include +#include +#include +#include #include #include #include -#include +#include // IWYU pragma: keep #include #include -#include -#include +#include +#include +#include #include +#include +#include namespace xrpl { NotTEC @@ -162,44 +177,43 @@ VaultClawback::preclaim(PreclaimContext const& ctx) return tecNO_PERMISSION; } - return std::visit( - [&](TIss const& issue) -> TER { - if constexpr (std::is_same_v) - { - auto const mptIssue = ctx.view.read(keylet::mptIssuance(issue.getMptID())); - if (mptIssue == nullptr) - return tecOBJECT_NOT_FOUND; + return vaultAsset.visit( + [&](MPTIssue const& issue) -> TER { + auto const mptIssue = ctx.view.read(keylet::mptIssuance(issue.getMptID())); + if (mptIssue == nullptr) + return tecOBJECT_NOT_FOUND; - std::uint32_t const issueFlags = mptIssue->getFieldU32(sfFlags); - if (!(issueFlags & lsfMPTCanClawback)) - { - JLOG(ctx.j.debug()) << "VaultClawback: cannot clawback " - "MPT vault asset."; - return tecNO_PERMISSION; - } - } - else if constexpr (std::is_same_v) + std::uint32_t const issueFlags = mptIssue->getFieldU32(sfFlags); + if ((issueFlags & lsfMPTCanClawback) == 0u) { - auto const issuerSle = ctx.view.read(keylet::account(account)); - if (!issuerSle) - { - // LCOV_EXCL_START - JLOG(ctx.j.error()) << "VaultClawback: missing submitter account."; - return tefINTERNAL; - // LCOV_EXCL_STOP - } - - std::uint32_t const issuerFlags = issuerSle->getFieldU32(sfFlags); - if (!(issuerFlags & lsfAllowTrustLineClawback) || (issuerFlags & lsfNoFreeze)) - { - JLOG(ctx.j.debug()) << "VaultClawback: cannot clawback " - "IOU vault asset."; - return tecNO_PERMISSION; - } + JLOG(ctx.j.debug()) << "VaultClawback: cannot clawback " + "MPT vault asset."; + return tecNO_PERMISSION; } + return tesSUCCESS; }, - vaultAsset.value()); + [&](Issue const&) -> TER { + auto const issuerSle = ctx.view.read(keylet::account(account)); + if (!issuerSle) + { + // LCOV_EXCL_START + JLOG(ctx.j.error()) << "VaultClawback: missing submitter account."; + return tefINTERNAL; + // LCOV_EXCL_STOP + } + + std::uint32_t const issuerFlags = issuerSle->getFieldU32(sfFlags); + if (((issuerFlags & lsfAllowTrustLineClawback) == 0u) || + ((issuerFlags & lsfNoFreeze) != 0u)) + { + JLOG(ctx.j.debug()) << "VaultClawback: cannot clawback " + "IOU vault asset."; + return tecNO_PERMISSION; + } + + return tesSUCCESS; + }); } // Invalid asset @@ -226,7 +240,11 @@ VaultClawback::assetsToClawback( auto const mptIssuanceID = *vault->at(sfShareMPTID); MPTIssue const share{mptIssuanceID}; - if (clawbackAmount == beast::zero) + // Pre-fixSecurity3_1_3: zero-amount clawback returned early without + // clamping to assetsAvailable, allowing more assets to be recovered + // than available when there was an outstanding loan. Retained for + // ledger replay compatibility. + if (!ctx_.view().rules().enabled(fixSecurity3_1_3) && clawbackAmount == beast::zero) { auto const sharesDestroyed = accountHolds( view(), @@ -243,22 +261,40 @@ VaultClawback::assetsToClawback( } STAmount sharesDestroyed; - STAmount assetsRecovered = clawbackAmount; + STAmount assetsRecovered; + try { + if (clawbackAmount == beast::zero) + { + sharesDestroyed = accountHolds( + view(), + holder, + share, + FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, + j_); + auto const maybeAssets = + sharesToAssetsWithdraw(vault, sleShareIssuance, sharesDestroyed); + if (!maybeAssets) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + + assetsRecovered = *maybeAssets; + } + else { auto const maybeShares = - assetsToSharesWithdraw(vault, sleShareIssuance, assetsRecovered); + assetsToSharesWithdraw(vault, sleShareIssuance, clawbackAmount); if (!maybeShares) return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE sharesDestroyed = *maybeShares; + + auto const maybeAssets = + sharesToAssetsWithdraw(vault, sleShareIssuance, sharesDestroyed); + if (!maybeAssets) + return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE + assetsRecovered = *maybeAssets; } - - auto const maybeAssets = sharesToAssetsWithdraw(vault, sleShareIssuance, sharesDestroyed); - if (!maybeAssets) - return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE - assetsRecovered = *maybeAssets; - // Clamp to maximum. if (assetsRecovered > *assetsAvailable) { @@ -334,7 +370,7 @@ VaultClawback::doApply() lossUnrealized <= (assetsTotal - assetsAvailable), "xrpl::VaultClawback::doApply : loss and assets do balance"); - AccountID holder = tx[sfHolder]; + AccountID const holder = tx[sfHolder]; STAmount sharesDestroyed = {share}; STAmount assetsRecovered = {vault->at(sfAsset)}; diff --git a/src/libxrpl/tx/transactors/vault/VaultCreate.cpp b/src/libxrpl/tx/transactors/vault/VaultCreate.cpp index 669a1e0f6d..f85043d17b 100644 --- a/src/libxrpl/tx/transactors/vault/VaultCreate.cpp +++ b/src/libxrpl/tx/transactors/vault/VaultCreate.cpp @@ -1,3 +1,8 @@ +#include + +#include +#include +#include #include #include #include @@ -6,16 +11,20 @@ #include #include #include +#include #include #include #include -#include +#include // IWYU pragma: keep #include #include #include -#include +#include #include -#include + +#include +#include +#include namespace xrpl { @@ -181,8 +190,10 @@ VaultCreate::doApply() .sequence = 1, .flags = mptFlags, .assetScale = scale, + .transferFee = std::nullopt, .metadata = tx[~sfMPTokenMetadata], .domainId = tx[~sfDomainID], + .mutableFlags = std::nullopt, }); if (!maybeShare) return maybeShare.error(); // LCOV_EXCL_LINE diff --git a/src/libxrpl/tx/transactors/vault/VaultDelete.cpp b/src/libxrpl/tx/transactors/vault/VaultDelete.cpp index 232a11d129..6adc3446ca 100644 --- a/src/libxrpl/tx/transactors/vault/VaultDelete.cpp +++ b/src/libxrpl/tx/transactors/vault/VaultDelete.cpp @@ -1,14 +1,18 @@ -#include +#include + +#include +#include +#include #include #include #include -#include +#include +#include #include -#include -#include +#include +#include // IWYU pragma: keep #include -#include -#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/vault/VaultDeposit.cpp b/src/libxrpl/tx/transactors/vault/VaultDeposit.cpp index c4d4ba361f..081c1c23d3 100644 --- a/src/libxrpl/tx/transactors/vault/VaultDeposit.cpp +++ b/src/libxrpl/tx/transactors/vault/VaultDeposit.cpp @@ -1,19 +1,23 @@ -#include +#include + +#include +#include +#include #include #include #include #include -#include #include +#include #include #include #include -#include +#include // IWYU pragma: keep #include #include -#include -#include -#include +#include + +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/vault/VaultSet.cpp b/src/libxrpl/tx/transactors/vault/VaultSet.cpp index 056792a1f4..52d7202ec2 100644 --- a/src/libxrpl/tx/transactors/vault/VaultSet.cpp +++ b/src/libxrpl/tx/transactors/vault/VaultSet.cpp @@ -1,13 +1,16 @@ -#include -#include +#include + +#include +#include #include #include +#include +#include #include -#include +#include // IWYU pragma: keep #include #include -#include -#include +#include namespace xrpl { diff --git a/src/libxrpl/tx/transactors/vault/VaultWithdraw.cpp b/src/libxrpl/tx/transactors/vault/VaultWithdraw.cpp index 932c5b29b9..eb8ffea1a7 100644 --- a/src/libxrpl/tx/transactors/vault/VaultWithdraw.cpp +++ b/src/libxrpl/tx/transactors/vault/VaultWithdraw.cpp @@ -1,15 +1,24 @@ +#include + +#include +#include +#include +#include #include -#include #include #include #include #include +#include +#include +#include #include -#include +#include // IWYU pragma: keep #include #include -#include -#include +#include + +#include namespace xrpl { @@ -43,10 +52,10 @@ VaultWithdraw::preclaim(PreclaimContext const& ctx) if (!vault) return tecNO_ENTRY; - auto const assets = ctx.tx[sfAmount]; + auto const amount = ctx.tx[sfAmount]; auto const vaultAsset = vault->at(sfAsset); auto const vaultShare = vault->at(sfShareMPTID); - if (assets.asset() != vaultAsset && assets.asset() != vaultShare) + if (amount.asset() != vaultAsset && amount.asset() != vaultShare) return tecWRONG_ASSET; auto const& vaultAccount = vault->at(sfAccount); @@ -67,8 +76,53 @@ VaultWithdraw::preclaim(PreclaimContext const& ctx) // LCOV_EXCL_STOP } - if (auto const ret = canWithdraw(ctx.view, ctx.tx)) - return ret; + if (ctx.view.rules().enabled(fixSecurity3_1_3) && amount.asset() == vaultShare) + { + // Post-fixSecurity3_1_3: if the user specified shares, convert + // to the equivalent asset amount before checking withdrawal + // limits. Pre-amendment the limit check was skipped for + // share-denominated withdrawals. + auto const sleIssuance = ctx.view.read(keylet::mptIssuance(vaultShare)); + if (!sleIssuance) + { + // LCOV_EXCL_START + JLOG(ctx.j.error()) << "VaultWithdraw: missing issuance of vault shares."; + return tefINTERNAL; + // LCOV_EXCL_STOP + } + + try + { + auto const maybeAssets = sharesToAssetsWithdraw(vault, sleIssuance, amount); + if (!maybeAssets) + return tefINTERNAL; // LCOV_EXCL_LINE + + if (auto const ret = canWithdraw( + ctx.view, + account, + dstAcct, + *maybeAssets, + ctx.tx.isFieldPresent(sfDestinationTag))) + return ret; + } + catch (std::overflow_error const&) + { + // It's easy to hit this exception from Number with large enough Scale + // so we avoid spamming the log and only use debug here. + JLOG(ctx.j.debug()) // + << "VaultWithdraw: overflow error with" + << " scale=" << (int)vault->at(sfScale) // + << ", assetsTotal=" << vault->at(sfAssetsTotal) + << ", sharesTotal=" << sleIssuance->at(sfOutstandingAmount) + << ", amount=" << amount.value(); + return tecPATH_DRY; + } + } + else + { + if (auto const ret = canWithdraw(ctx.view, ctx.tx)) + return ret; + } // If sending to Account (i.e. not a transfer), we will also create (only // if authorized) a trust line or MPToken as needed, in doApply(). @@ -83,7 +137,7 @@ VaultWithdraw::preclaim(PreclaimContext const& ctx) // Cannot return shares to the vault, if the underlying asset was frozen for // the submitter - if (auto const ret = checkFrozen(ctx.view, account, vaultShare)) + if (auto const ret = checkFrozen(ctx.view, account, Asset{vaultShare})) return ret; return tesSUCCESS; diff --git a/src/test/README.md b/src/test/README.md index b012607f58..179d75941b 100644 --- a/src/test/README.md +++ b/src/test/README.md @@ -2,10 +2,10 @@ ## Running Tests -Unit tests are bundled in the `rippled` executable and can be executed using the +Unit tests are bundled in the `xrpld` executable and can be executed using the `--unittest` parameter. Without any arguments to this option, all non-manual unit tests will be executed. If you want to run one or more manual tests, you -must specify it by suite or full-name (e.g. `ripple.app.NoRippleCheckLimits` or +must specify it by suite or full-name (e.g. `xrpl.app.NoRippleCheckLimits` or just `NoRippleCheckLimits`). More than one suite or group of suites can be specified as a comma separated diff --git a/src/test/app/AMMCalc_test.cpp b/src/test/app/AMMCalc_test.cpp index b4043f239b..6df1e0d62d 100644 --- a/src/test/app/AMMCalc_test.cpp +++ b/src/test/app/AMMCalc_test.cpp @@ -1,9 +1,33 @@ -#include +#include +#include +#include + +#include +#include +#include +#include +#include #include -#include +#include +#include +#include -#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -37,7 +61,7 @@ class AMMCalc_test : public beast::unit_test::suite str = boost::regex_replace(str, boost::regex("^(A|O)[(]"), ""); boost::smatch match; // XXX(val))? - boost::regex rx("^([^(]+)[(]([^)]+)[)]([)])?$"); + boost::regex const rx("^([^(]+)[(]([^)]+)[)]([)])?$"); if (boost::regex_search(str, match, rx)) { if (delimited != nullptr) @@ -65,12 +89,12 @@ class AMMCalc_test : public beast::unit_test::suite str = boost::regex_replace(str, boost::regex("^T[(]"), ""); // XXX(rate))? boost::smatch match; - boost::regex rx("^([^(]+)[(]([^)]+)[)]([)])?$"); + boost::regex const rx("^([^(]+)[(]([^)]+)[)]([)])?$"); if (boost::regex_search(str, match, rx)) { std::string const currency = match[1]; // input is rate * 100, no fraction - std::uint32_t rate = 10'000'000 * std::stoi(match[2].str()); + std::uint32_t const rate = 10'000'000 * std::stoi(match[2].str()); // true if delimited - ) return {{currency, rate, match[3] != ""}}; } @@ -164,9 +188,7 @@ class AMMCalc_test : public beast::unit_test::suite static std::string toString(STAmount const& a) { - std::stringstream str; - str << a.getText() << "/" << to_string(a.issue().currency); - return str.str(); + return (boost::format("%s/%s") % a.getText() % to_string(a.get().currency)).str(); } static STAmount @@ -175,8 +197,8 @@ class AMMCalc_test : public beast::unit_test::suite if (a == b) return amt; if (amt.native()) - return toSTAmount(mulRatio(amt.xrp(), a, b, round), amt.issue()); - return toSTAmount(mulRatio(amt.iou(), a, b, round), amt.issue()); + return toSTAmount(mulRatio(amt.xrp(), a, b, round), amt.asset()); + return toSTAmount(mulRatio(amt.iou(), a, b, round), amt.asset()); } static void @@ -191,9 +213,9 @@ class AMMCalc_test : public beast::unit_test::suite STAmount sin{}; int limitingStep = vp.size(); STAmount limitStepOut{}; - auto transferRate = [&](auto const& amt) { - auto const currency = to_string(amt.issue().currency); - return rates.find(currency) != rates.end() ? rates.at(currency) : QUALITY_ONE; + auto transferRate = [&](STAmount const& amt) { + auto const currency = to_string(amt.get().currency); + return rates.contains(currency) ? rates.at(currency) : QUALITY_ONE; }; // swap out reverse sin = sout; @@ -254,9 +276,9 @@ class AMMCalc_test : public beast::unit_test::suite STAmount sout{}; int limitingStep = 0; STAmount limitStepIn{}; - auto transferRate = [&](auto const& amt) { - auto const currency = to_string(amt.issue().currency); - return rates.find(currency) != rates.end() ? rates.at(currency) : QUALITY_ONE; + auto transferRate = [&](STAmount const& amt) { + auto const currency = to_string(amt.get().currency); + return rates.contains(currency) ? rates.at(currency) : QUALITY_ONE; }; // Swap in forward for (auto it = vp.begin(); it != vp.end(); ++it) @@ -310,7 +332,7 @@ class AMMCalc_test : public beast::unit_test::suite { using namespace jtx; auto const a = arg(); - boost::regex re(","); + boost::regex const re(","); token_iter p(a.begin(), a.end(), re, -1); // Token is denoted as CUR(xxx), where CUR is the currency code // and xxx is the amount, for instance: XRP(100) or USD(11.5) @@ -391,7 +413,7 @@ class AMMCalc_test : public beast::unit_test::suite // 10 is AMM trading fee else if (*p == "changespq") { - Env env(*this); + Env const env(*this); if (auto const pool = getAmounts(++p)) { if (auto const offer = getAmounts(p)) diff --git a/src/test/app/AMMClawbackMPT_test.cpp b/src/test/app/AMMClawbackMPT_test.cpp new file mode 100644 index 0000000000..1a344b40b6 --- /dev/null +++ b/src/test/app/AMMClawbackMPT_test.cpp @@ -0,0 +1,1842 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +namespace xrpl { +namespace test { +class AMMClawbackMPT_test : public beast::unit_test::suite +{ + void + testInvalidRequest(FeatureBitset features) + { + testcase("test invalid request"); + using namespace jtx; + + for (auto const& feature : {features, features - featureSingleAssetVault}) + { + Env env(*this, feature); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + auto const USD = gw["USD"]; + env.trust(USD(10000), alice); + env(pay(gw, alice, USD(100))); + env.close(); + + AMM amm(env, gw, BTC(100), USD(100)); + + // holder does not exist + env(amm::ammClawback(gw, Account("unknown"), USD, BTC, std::nullopt), + ter(terNO_ACCOUNT)); + + // can not clawback from self. + env(amm::ammClawback(gw, gw, USD, BTC, std::nullopt), ter(temMALFORMED)); + + // provided Asset does not match issuer gw + { + env(amm::ammClawback( + gw, alice, Issue{gw["USD"].currency, alice.id()}, BTC, std::nullopt), + ter(temMALFORMED)); + env(amm::ammClawback(gw, alice, MPTIssue{makeMptID(1, alice)}, USD, std::nullopt), + ter(temMALFORMED)); + } + + // Amount does not match asset + { + env(amm::ammClawback( + gw, alice, USD, BTC, STAmount{Issue{gw["USD"].currency, alice.id()}, 1}), + ter(temBAD_AMOUNT)); + env(amm::ammClawback( + gw, alice, BTC, USD, STAmount{MPTIssue{makeMptID(1, alice)}, 10}), + ter(temBAD_AMOUNT)); + } + + // Amount is not greater than 0 + { + env(amm::ammClawback(gw, alice, BTC, USD, BTC(-1)), ter(temBAD_AMOUNT)); + env(amm::ammClawback(gw, alice, BTC, USD, BTC(0)), ter(temBAD_AMOUNT)); + } + + // clawback from account not holding lptoken + env(amm::ammClawback(gw, bob, BTC, USD, BTC(1000)), ter(tecAMM_BALANCE)); + + // can not perform regular claw from amm pool + { + Issue const usd(USD.currency, amm.ammAccount()); + auto amount = amountFromString(usd, "10"); + auto const err = + feature[featureSingleAssetVault] ? tecPSEUDO_ACCOUNT : tecAMM_ACCOUNT; + env(claw(gw, amount), ter(err)); + } + + // AMM does not exist + { + // withdraw all tokens will delete the AMM + amm.withdrawAll(gw); + BEAST_EXPECT(!amm.ammExists()); + env.close(); + env(amm::ammClawback(gw, alice, USD, BTC, std::nullopt), ter(terNO_AMM)); + } + } + + // tfMPTCanClawback is not enabled + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(100000), gw, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 40'000}); + + auto const USD = gw["USD"]; + env.trust(USD(10000), alice); + env(pay(gw, alice, USD(10000))); + env.close(); + + AMM amm(env, gw, BTC(100), USD(100)); + env.close(); + amm.deposit(alice, 1'000); + env.close(); + + // can not clawback when tfMPTCanClawback is not enabled + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt), ter(tecNO_PERMISSION)); + } + + // can not claw with tfClawTwoAssets if the assets are not issued by the + // same issuer + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + env.fund(XRP(100000), gw, gw2, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(10000), alice); + env(pay(gw, alice, USD(10000))); + env.close(); + + // todo: check tfMPTCanTransfer in xrpl.org + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM const amm(env, alice, BTC(100), USD(100)); + env.close(); + + { + // Return temINVALID_FLAG because the issuer set + // tfClawTwoAssets, but the issuer only issues USD in the pool. + // The issuer is not allowed to set tfClawTwoAssets flag if he + // did not issue both assets in the pool. + env(amm::ammClawback(gw, alice, USD, BTC, std::nullopt), + txflags(tfClawTwoAssets), + ter(temINVALID_FLAG)); + } + } + + // Test if the issuer did not set asfAllowTrustLineClawback, but the MPT + // is set tfMPTCanClawback, the issuer can claw MPT. + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(10000), gw, alice); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM const amm(env, alice, BTC(100), XRP(100)); + env.close(); + + // If asfAllowTrustLineClawback is not set, the issuer can + // still claw MPT because the MPT's tfMPTCanClawback is set. + env(amm::ammClawback(gw, alice, BTC, XRP, std::nullopt)); + } + } + + void + testFeatureDisabled(FeatureBitset features) + { + testcase("test feature disabled."); + using namespace jtx; + Env env{*this, features}; + Account const gw("gateway"), alice("alice"); + env.fund(XRP(30'000), gw, alice); + env.close(); + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 10'000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM const amm(env, alice, XRP(1'000), BTC(1'000)); + + // disable featureAMMClawback + env.disableFeature(featureAMMClawback); + env(amm::ammClawback(gw, alice, BTC, XRP, std::nullopt), ter(temDISABLED)); + + // enable featureAMMClawback and disable featureMPTokensV2 + env.enableFeature(featureAMMClawback); + env.disableFeature(featureMPTokensV2); + env(amm::ammClawback(gw, alice, BTC, XRP, BTC(100)), ter(temDISABLED)); + + // enable featureMPTokensV2 + env.enableFeature(featureMPTokensV2); + env(amm::ammClawback(gw, alice, BTC, XRP, BTC(200))); + } + + void + testAMMClawbackAmount(FeatureBitset features) + { + testcase("test AMMClawback specific amount"); + using namespace jtx; + + // AMMClawback from MPT/IOU issued by different issuers + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + env.fund(XRP(100000), gw, gw2, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env(fset(gw2, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(50000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {alice}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM const amm(env, alice, BTC(1000000000), USD(2000)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(1'000'000000), USD(2000), IOUAmount{1414'213'562373095, -9})); + + // can not set tfClawTwoAssets because the assets are not issued by + // the same issuer. + env(amm::ammClawback(gw2, alice, BTC, USD, BTC(1000)), + txflags(tfClawTwoAssets), + ter(temINVALID_FLAG)); + + auto aliceUSD = env.balance(alice, USD); + auto aliceBTC = env.balance(alice, BTC); + // gw clawback 1000 USD from alice + env(amm::ammClawback(gw, alice, USD, BTC, USD(1000))); + env.close(); + + BEAST_EXPECT( + amm.expectBalances(BTC(500'000000), USD(1000), IOUAmount{707'106'7811865475, -10})); + // USD is clawed back, + env.require(balance(alice, aliceUSD)); + // a proportional amount of BTC is returned to alice + env.require(balance(alice, aliceBTC + BTC(500'000000))); + aliceBTC = env.balance(alice, BTC); + + // gw2 clawback 250'000000 BTC from alice + env(amm::ammClawback(gw2, alice, BTC, USD, BTC(250'000000))); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(250'000000), USD(500), IOUAmount{353'553'3905932737, -10})); + env.require(balance(alice, aliceUSD + USD(500))); + env.require(balance(alice, aliceBTC)); + aliceUSD = env.balance(alice, USD); + + // gw2 clawback 500'000000 BTC which exceeds the balance, + // this will clawback all and the amm will be deleted. + env(amm::ammClawback(gw2, alice, BTC, USD, BTC(500'000000))); + env.close(); + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceUSD + USD(500))); + env.require(balance(alice, aliceBTC)); + } + + // AMMClawback from MPT/XRP pool + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(1000000000), XRP(2000)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(1'000'000000), XRP(2000), IOUAmount{1'414'213'562'373095, -6})); + + amm.deposit(bob, BTC(2'000'000000), XRP(4000)); + BEAST_EXPECT(amm.expectBalances( + BTC(3'000'000000), XRP(6000), IOUAmount{4'242'640'687'119285, -6})); + + auto aliceXRP = env.balance(alice, XRP); + auto aliceBTC = env.balance(alice, BTC); + auto bobXRP = env.balance(bob, XRP); + auto bobBTC = env.balance(bob, BTC); + + // can not claw XRP + env(amm::ammClawback(gw, alice, XRP, BTC, XRP(1000)), ter(temMALFORMED)); + // can not set tfClawTwoAssets + env(amm::ammClawback(gw, alice, BTC, XRP, BTC(1000)), + txflags(tfClawTwoAssets), + ter(temINVALID_FLAG)); + + // gw clawback 500 BTC from alice + env(amm::ammClawback(gw, alice, BTC, XRP, BTC(500))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(2'999'999501), + STAmount{XRP, UINT64_C(5'999'999001)}, + IOUAmount{4'242'639'980'012504, -6})); + env.require(balance(alice, aliceXRP + drops(999))); + env.require(balance(alice, aliceBTC)); + env.require(balance(bob, bobXRP)); + env.require(balance(bob, bobBTC)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1'414'212'855'266314, -6})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{2'828'427'124'74619, -5})); + aliceXRP = env.balance(alice, XRP); + + // gw clawback 1000'000000 BTC from bob + env(amm::ammClawback(gw, bob, BTC, XRP, BTC(1'000'000000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(1'999'999501), + STAmount{XRP, UINT64_C(3'999'999002)}, + IOUAmount{2828426418'110813, -6})); + env.require(balance(alice, aliceXRP)); + env.require(balance(alice, aliceBTC)); + env.require(balance(bob, bobXRP + XRPAmount(1999999999))); + env.require(balance(bob, bobBTC)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1'414'212'855'266314, -6})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1'414'213'562'844499, -6})); + bobXRP = env.balance(bob, XRP); + + // gw clawback 1000'000000 BTC from alice, which exceeds her balance + // will clawback all her balance + env(amm::ammClawback(gw, alice, BTC, XRP, BTC(1'000'000000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(1'000'000001), XRPAmount(2'000'000002), IOUAmount{1'414'213'562'844499, -6})); + env.require(balance(alice, aliceXRP + STAmount{XRP, UINT64_C(1'999'999000)})); + env.require(balance(alice, aliceBTC)); + env.require(balance(bob, bobXRP)); + env.require(balance(bob, bobBTC)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0))); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1'414'213'562'844499, -6})); + aliceXRP = env.balance(alice, XRP); + + // gw clawback from bob, which exceeds his balance + env(amm::ammClawback(gw, bob, BTC, XRP, BTC(2'000'000000))); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceXRP)); + env.require(balance(alice, aliceBTC)); + env.require(balance(bob, bobXRP + XRPAmount(2000000002))); + env.require(balance(bob, bobBTC)); + } + + // AMMClawback from MPT/MPT pool, different issuers + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, gw2, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env(fset(gw2, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + MPT const ETH = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {alice, bob}, + .pay = 30'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(2'000'000000), ETH(3'000'000000)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(2'000'000000), ETH(3'000'000000), IOUAmount{2'449'489'742'783178, -6})); + + amm.deposit(bob, BTC(4'000'000000), ETH(6'000'000000)); + BEAST_EXPECT(amm.expectBalances( + BTC(6'000'000000), ETH(9'000'000000), IOUAmount{7'348'469'228'349534, -6})); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceETH = env.balance(alice, ETH); + auto bobBTC = env.balance(bob, BTC); + auto bobETH = env.balance(bob, ETH); + + // gw clawback BTC from alice + env(amm::ammClawback(gw, alice, BTC, ETH, BTC(1'000'000000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(5'000'000000), ETH(7'500'000000), IOUAmount{6'123'724'356'957944, -6})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH + ETH(1'500'000000))); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1'224'744'871'391588, -6})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{4'898'979'485'566356, -6})); + aliceETH = env.balance(alice, ETH); + + // gw2 clawback ETH from bob + env(amm::ammClawback(gw2, bob, ETH, BTC, ETH(3'000'000000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(3'000'000000), ETH(4'500'000000), IOUAmount{3'674'234'614'174766, -6})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC + BTC(2'000'000000))); + env.require(balance(bob, bobETH)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1'224'744'871'391588, -6})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{2'449'489'742'783178, -6})); + bobBTC = env.balance(bob, BTC); + + // gw2 clawback ETH from alice, which exceeds her balance + env(amm::ammClawback(gw2, alice, ETH, BTC, ETH(4'000'000000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(2'000'000001), ETH(3'000'000001), IOUAmount{2'449'489'742'783178, -6})); + env.require(balance(alice, aliceBTC + BTC(999'999999))); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH)); + aliceBTC = env.balance(alice, BTC); + + // gw clawback BTC from bob, which exceeds his balance + env(amm::ammClawback(gw, bob, BTC, ETH, BTC(3'000'000000))); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH + ETH(3'000'000001))); + } + } + + void + testAMMClawbackAll(FeatureBitset features) + { + testcase("test AMMClawback all"); + using namespace jtx; + + // AMMClawback all from MPT/IOU issued by different issuers + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, gw2, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env(fset(gw2, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(50000))); + env.trust(USD(200000), bob); + env(pay(gw, bob, USD(60000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(2000000000), USD(2000)); + env.close(); + BEAST_EXPECT(amm.expectBalances(BTC(2'000'000000), USD(2000), IOUAmount(2000000))); + + // gw clawback all BTC from alice + amm.deposit(bob, BTC(1'000'000000), USD(2000)); + env.close(); + BEAST_EXPECT(amm.expectBalances(BTC(3'000'000000), USD(3000), IOUAmount(3000000))); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceUSD = env.balance(alice, USD); + auto bobBTC = env.balance(bob, BTC); + auto bobUSD = env.balance(bob, USD); + + // gw2 clawback all BTC from alice + env(amm::ammClawback(gw2, alice, BTC, USD, std::nullopt)); + env.close(); + BEAST_EXPECT(amm.expectBalances(BTC(1'000'000000), USD(1000), IOUAmount(1000000))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + USD(2000))); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobUSD)); + aliceUSD = env.balance(alice, USD); + + // gw clawback all USD from bob + env(amm::ammClawback(gw, bob, USD, BTC, std::nullopt)); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + env.require(balance(bob, bobBTC + BTC(1'000'000000))); + env.require(balance(bob, bobUSD)); + } + + // AMMClawback all from MPT/XRP pool + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(5000), XRP(10'000)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(5'000), XRP(10'000), IOUAmount{7'071'067'811865475, -9})); + + amm.deposit(bob, BTC(10'000), XRP(20'000)); + BEAST_EXPECT( + amm.expectBalances(BTC(15'000), XRP(30'000), IOUAmount{21'213'203'43559642, -8})); + + auto aliceXRP = env.balance(alice, XRP); + auto aliceBTC = env.balance(alice, BTC); + auto bobXRP = env.balance(bob, XRP); + auto bobBTC = env.balance(bob, BTC); + + // gw clawback all BTC from alice + env(amm::ammClawback(gw, alice, BTC, XRP, std::nullopt)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(10'000), XRP(20'000), IOUAmount{14'142'135'62373094, -8})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceXRP + XRP(10'000))); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobXRP)); + aliceXRP = env.balance(alice, XRP); + + // gw clawback all BTC from bob + env(amm::ammClawback(gw, bob, BTC, XRP, std::nullopt)); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceXRP)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobXRP + XRP(20'000))); + } + + // AMMClawback all from MPT/MPT pool, different issuers + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, gw2, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env(fset(gw2, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + MPT const ETH = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {alice, bob}, + .pay = 30'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(20'000), ETH(50'000)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(20'000), ETH(50'000), IOUAmount{31'622'77660168379, -11})); + + amm.deposit(bob, BTC(40'000), ETH(100'000)); + BEAST_EXPECT( + amm.expectBalances(BTC(60'000), ETH(150'000), IOUAmount{94'868'32980505137, -11})); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceETH = env.balance(alice, ETH); + auto bobBTC = env.balance(bob, BTC); + auto bobETH = env.balance(bob, ETH); + + // gw clawback all BTC from bob + env(amm::ammClawback(gw, bob, BTC, ETH, std::nullopt)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(20'000), ETH(50'000), IOUAmount{31'622'77660168379, -11})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH + ETH(100'000))); + bobETH = env.balance(bob, ETH); + + // gw2 clawback all ETH from alice + env(amm::ammClawback(gw2, alice, ETH, BTC, std::nullopt)); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceBTC + BTC(20'000))); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH)); + } + } + + void + testAMMClawbackAmountSameIssuer(FeatureBitset features) + { + testcase("test AMMClawback specific amount, assets have the same issuer"); + using namespace jtx; + + // AMMClawback from MPT/IOU issued by the same issuer + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(50000))); + env.trust(USD(100000), bob); + env(pay(gw, bob, USD(40000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(1'000'000000), USD(2000)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(1'000'000000), USD(2000), IOUAmount{1414'213'562373095, -9})); + + amm.deposit(bob, BTC(500'000000), USD(1000)); + BEAST_EXPECT(amm.expectBalances( + BTC(1'500'000000), + STAmount{USD, UINT64_C(2'999'999999999999), -12}, + IOUAmount{2'121'320'343559642, -9})); + + auto aliceUSD = env.balance(alice, USD); + auto aliceBTC = env.balance(alice, BTC); + auto bobUSD = env.balance(bob, USD); + auto bobBTC = env.balance(bob, BTC); + + // gw clawback 500 USD from alice. + env(amm::ammClawback(gw, alice, USD, BTC, USD(500))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(1250'000001), USD(2500), IOUAmount{1'767'766'952966369, -9})); + env.require(balance(alice, aliceUSD)); + env.require(balance(alice, aliceBTC + BTC(249'999999))); + env.require(balance(bob, bobUSD)); + env.require(balance(bob, bobBTC)); + aliceBTC = env.balance(alice, BTC); + // gw clawback 250'000000 BTC and 500 USD from bob + // with tfClawTwoAssets + env(amm::ammClawback(gw, bob, BTC, USD, BTC(250'000000)), txflags(tfClawTwoAssets)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(1'000'000002), + STAmount{USD, UINT64_C(2000'0000004), -7}, + IOUAmount{1'414'213'562655938, -9})); + env.require(balance(alice, aliceUSD)); + env.require(balance(alice, aliceBTC)); + env.require(balance(bob, bobUSD)); + env.require(balance(bob, bobBTC)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1'060'660'171779822, -9})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{353'553'390876116, -9})); + + // gw clawback USD from alice exceeding her balance + env(amm::ammClawback(gw, alice, USD, BTC, USD(5'000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(250'000001), + STAmount{USD, UINT64_C(500'0000004), -7}, + IOUAmount{353'553'390876116, -9})); + env.require(balance(alice, aliceUSD)); + env.require(balance(alice, aliceBTC + BTC(750'000001))); + env.require(balance(bob, bobUSD)); + env.require(balance(bob, bobBTC)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0))); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{353'553'390876116, -9})); + aliceBTC = env.balance(alice, BTC); + + // gw clawback BTC from bob which exceeds his balance with + // tfClawTwoAssets + env(amm::ammClawback(gw, bob, BTC, USD, BTC(300'000000)), txflags(tfClawTwoAssets)); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceUSD)); + env.require(balance(alice, aliceBTC)); + // USD is also clawed back from bob because of tfClawTwoAssets, + // bob's USD balance will not change + env.require(balance(bob, bobUSD)); + env.require(balance(bob, bobBTC)); + } + + // AMMClawback from MPT/MPT issued by the same issuer + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + MPT const ETH = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 30'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(2'000'000000), ETH(3'000'000000)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(2'000'000000), ETH(3'000'000000), IOUAmount{2'449'489'742'783178, -6})); + + amm.deposit(bob, BTC(4'000'000000), ETH(6'000'000000)); + BEAST_EXPECT(amm.expectBalances( + BTC(6'000'000000), ETH(9'000'000000), IOUAmount{7'348'469'228'349534, -6})); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceETH = env.balance(alice, ETH); + auto bobBTC = env.balance(bob, BTC); + auto bobETH = env.balance(bob, ETH); + + // gw clawback BTC from alice + env(amm::ammClawback(gw, alice, BTC, ETH, BTC(1'000'000000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(5'000'000000), ETH(7'500'000000), IOUAmount{6'123'724'356'957944, -6})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH + ETH(1'500'000000))); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1'224'744'871'391588, -6})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{4'898'979'485'566356, -6})); + aliceETH = env.balance(alice, ETH); + + // gw clawback ETH and BTC from bob with tfClawTwoAssets + env(amm::ammClawback(gw, bob, ETH, BTC, ETH(3'000'000000)), txflags(tfClawTwoAssets)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(3'000'000000), ETH(4'500'000000), IOUAmount{3'674'234'614'174766, -6})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1'224'744'871'391588, -6})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{2'449'489'742'783178, -6})); + + // gw clawback BTC from alice, which exceeds her balance with + // tfClawTwoAssets + env(amm::ammClawback(gw, alice, BTC, ETH, BTC(3'000'000000)), txflags(tfClawTwoAssets)); + env.close(); + BEAST_EXPECT(amm.expectBalances( + BTC(2'000'000001), ETH(3'000'000001), IOUAmount{2'449'489'742'783178, -6})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0))); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{2'449'489'742'783178, -6})); + + // gw clawback ETH from bob, which is the same as his balance + env(amm::ammClawback(gw, bob, ETH, BTC, ETH(3'000'000001))); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC + BTC(2'000'000001))); + env.require(balance(bob, bobETH)); + } + } + + void + testAMMClawbackAllSameIssuer(FeatureBitset features) + { + testcase("test AMMClawback all, assets have the same issuer"); + using namespace jtx; + + // AMMClawback all from MPT/IOU issued by the same issuer + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(50000))); + env.trust(USD(200000), bob); + env(pay(gw, bob, USD(60000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(2'000'000000), USD(8'000)); + env.close(); + BEAST_EXPECT(amm.expectBalances(BTC(2'000'000000), USD(8'000), IOUAmount(4'000'000))); + + amm.deposit(bob, BTC(1'000'000000), USD(4'000)); + env.close(); + BEAST_EXPECT(amm.expectBalances(BTC(3'000'000000), USD(12'000), IOUAmount(6'000'000))); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceUSD = env.balance(alice, USD); + auto bobBTC = env.balance(bob, BTC); + auto bobUSD = env.balance(bob, USD); + + // gw clawback all BTC and USD from alice + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt), txflags(tfClawTwoAssets)); + env.close(); + + BEAST_EXPECT(amm.expectBalances(BTC(1'000'000000), USD(4'000), IOUAmount(2'000'000))); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(2'000'000))); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobUSD)); + + // gw clawback all USD from bob + env(amm::ammClawback(gw, bob, USD, BTC, std::nullopt)); + env.close(); + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + env.require(balance(bob, bobBTC + BTC(1'000'000000))); + env.require(balance(bob, bobUSD)); + } + + // AMMClawback all from MPT/MPT issued by the same issuer + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + MPT const ETH = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 30'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, BTC(20'000), ETH(10'000)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(20'000), ETH(10'000), IOUAmount{14'142'13562373095, -11})); + + amm.deposit(bob, BTC(40'000), ETH(20'000)); + BEAST_EXPECT( + amm.expectBalances(BTC(60'000), ETH(30'000), IOUAmount{42'426'40687119285, -11})); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceETH = env.balance(alice, ETH); + auto bobBTC = env.balance(bob, BTC); + auto bobETH = env.balance(bob, ETH); + + // gw clawback all ETH from bob + env(amm::ammClawback(gw, bob, ETH, BTC, std::nullopt)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(20'000), ETH(10'000), IOUAmount{14'142'13562373095, -11})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC + BTC(40'000))); + env.require(balance(bob, bobETH)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{14'142'13562373095, -11})); + BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(0))); + bobBTC = env.balance(bob, BTC); + + // gw clawback all ETH and BTC from alice with tfClawTwoAssets + env(amm::ammClawback(gw, alice, ETH, BTC, std::nullopt), txflags(tfClawTwoAssets)); + env.close(); + + // amm is empty and deleted + BEAST_EXPECT(!amm.ammExists()); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(bob, bobBTC)); + env.require(balance(bob, bobETH)); + } + } + + void + testAMMClawbackIssuesEachOther(FeatureBitset features) + { + testcase("test AMMClawback when issuing token for each other"); + using namespace jtx; + + // AMMClawback from MPT/IOU issued by each other + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + env.fund(XRP(1000000), gw, gw2, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env(fset(gw2, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), gw2); + env(pay(gw, gw2, USD(5000))); + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(5000))); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {alice, gw}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, gw, USD(1000), BTC(2000)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(USD(1000), BTC(2000), IOUAmount{1414'213562373095, -12})); + + amm.deposit(gw2, USD(2000), BTC(4000)); + BEAST_EXPECT( + amm.expectBalances(USD(3000), BTC(6000), IOUAmount{4242'640687119285, -12})); + + amm.deposit(alice, USD(3000), BTC(6000)); + BEAST_EXPECT( + amm.expectBalances(USD(6000), BTC(12000), IOUAmount{8485'281374238570, -12})); + + BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{1414'213562373095, -12})); + BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{2828'427124746190, -12})); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4242'640687119285, -12})); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceUSD = env.balance(alice, USD); + auto gwBTC = env.balance(gw, BTC); + auto gw2USD = env.balance(gw2, USD); + + // gw claws back 1000 USD from gw2. + env(amm::ammClawback(gw, gw2, USD, BTC, USD(1000))); + env.close(); + BEAST_EXPECT( + amm.expectBalances(USD(5000), BTC(10000), IOUAmount{7071'067811865474, -12})); + BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{1414'213562373095, -12})); + BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414'213562373094, -12})); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4242'640687119285, -12})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + env.require(balance(gw, gwBTC)); + env.require(balance(gw2, gw2USD)); + + // gw2 claws back 1000 BTC from gw. + env(amm::ammClawback(gw2, gw, BTC, USD, BTC(1000)), ter(tesSUCCESS)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(USD(4500), BTC(9001), IOUAmount{6363'961030678927, -12})); + + BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{707'1067811865480, -13})); + BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414'213562373094, -12})); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4242'640687119285, -12})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + env.require(balance(gw, gwBTC)); + env.require(balance(gw2, gw2USD)); + + // gw2 claws back 4000 BTC from alice + env(amm::ammClawback(gw2, alice, BTC, USD, BTC(4000))); + env.close(); + BEAST_EXPECT(amm.expectBalances( + STAmount{USD, UINT64_C(2500'222197533607), -12}, + BTC(5001), + IOUAmount{3535'84814069829, -11})); + + BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{707'1067811865480, -13})); + BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414'213562373094, -12})); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1414'527797138648, -12})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + STAmount{USD, UINT64_C(1999'777802466393), -12})); + env.require(balance(gw, gwBTC)); + env.require(balance(gw2, gw2USD)); + } + + // AMMClawback from MPT/MPT issued by each other + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + env.fund(XRP(100000), gw, gw2, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env(fset(gw2, asfAllowTrustLineClawback)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {gw2, alice}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + MPT const ETH = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {gw, alice}, + .pay = 30'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, gw, BTC(10'000), ETH(50'000)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(10'000), ETH(50'000), IOUAmount{22'360'67977499789, -11})); + + amm.deposit(gw2, BTC(20'000), ETH(100'000)); + BEAST_EXPECT( + amm.expectBalances(BTC(30'000), ETH(150'000), IOUAmount{67'082'03932499367, -11})); + + amm.deposit(alice, BTC(40'000), ETH(200'000)); + BEAST_EXPECT( + amm.expectBalances(BTC(70'000), ETH(350'000), IOUAmount{156'524'7584249852, -10})); + + auto aliceBTC = env.balance(alice, BTC); + auto aliceETH = env.balance(alice, ETH); + auto gw2BTC = env.balance(gw2, BTC); + auto gwETH = env.balance(gw, ETH); + + // gw claws back 1000 BTC from gw2. + env(amm::ammClawback(gw, gw2, BTC, ETH, BTC(1000))); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(69'001), ETH(345'001), IOUAmount{154'288'6904474855, -10})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(gw, gwETH)); + env.require(balance(gw2, gw2BTC)); + + // gw2 claws back all ETH from gw + env(amm::ammClawback(gw2, gw, ETH, BTC, std::nullopt)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(59'001), ETH(295'001), IOUAmount{131'928'0106724876, -10})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH)); + env.require(balance(gw, gwETH)); + env.require(balance(gw2, gw2BTC)); + + // gw claws back all BTC from alice + env(amm::ammClawback(gw, alice, BTC, ETH, std::nullopt)); + env.close(); + BEAST_EXPECT( + amm.expectBalances(BTC(19'001), ETH(95'001), IOUAmount{42'485'29157249607, -11})); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceETH + ETH(200'000))); + env.require(balance(gw, gwETH)); + env.require(balance(gw2, gw2BTC)); + } + } + + void + testAssetFrozenOrLocked(FeatureBitset features) + { + testcase("test AMMClawback when asset is frozen or locked"); + using namespace jtx; + + // test AMMClawback when MPT globally locked or IOU globally frozen + { + Env env{*this, features}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(1'000'000), gw, alice); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + auto const USD = gw["USD"]; + env.trust(USD(1'000'000), alice); + env(pay(gw, alice, USD(500'000))); + + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanClawback | tfMPTCanLock | MPTDEXFlags}); + AMM const ammAlice(env, alice, USD(10'000), BTC(10'000)); + BEAST_EXPECT(ammAlice.expectBalances(USD(10'000), BTC(10'000), IOUAmount(10'000))); + env.close(); + + auto aliceBTC = env.balance(alice, MPT(BTC)); + auto aliceUSD = env.balance(alice, USD); + + // globally locked and claw back 1000 BTC. + // this should be successful + BTC.set({.flags = tfMPTLock}); + env(amm::ammClawback(gw, alice, MPT(BTC), USD, BTC(1'000))); + BEAST_EXPECT(ammAlice.expectBalances(USD(9'000), BTC(9'000), IOUAmount(9'000))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + USD(1'000))); + aliceUSD = env.balance(alice, USD); + + // unlock and claw back 2000 BTC + BTC.set({.flags = tfMPTUnlock}); + env(amm::ammClawback(gw, alice, MPT(BTC), USD, BTC(2'000))); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount(USD, UINT64_C(7'000'000000000001), -12), BTC(7'001), IOUAmount(7'000))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + USD(2'000))); + aliceUSD = env.balance(alice, USD); + + // globally freeze trustline and claw back 1000 USD. + // this should be successful + env(trust(gw, alice["USD"](0), tfSetFreeze)); + env.close(); + env(amm::ammClawback(gw, alice, USD, MPT(BTC), USD(1'000))); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount(USD, UINT64_C(6000'000000000002), -12), + BTC(6'001), + IOUAmount(6'000'000000000001, -12))); + env.require(balance(alice, aliceBTC + BTC(1'000))); + env.require(balance(alice, aliceUSD)); + aliceBTC = env.balance(alice, MPT(BTC)); + + // globally unfreeze trustline and claw back 2000 USD + // and 2000 BTC with tfClawTwoAssets + env(fset(gw, asfGlobalFreeze)); + env.close(); + env(amm::ammClawback(gw, alice, USD, MPT(BTC), USD(2'000)), txflags(tfClawTwoAssets)); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount(USD, UINT64_C(4'000'000000000002), -12), + BTC(4'001), + IOUAmount(4'000'000000000001, -12))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + } + + // test AMMClawback when MPT individually locked or IOU individually + // frozen + { + Env env{*this, features}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(1'000'000), gw, alice); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + auto const USD = gw["USD"]; + env.trust(USD(1'000'000), alice); + env(pay(gw, alice, USD(500'000))); + + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanClawback | tfMPTCanLock | MPTDEXFlags}); + AMM const ammAlice(env, alice, USD(10'000), BTC(10'000)); + BEAST_EXPECT(ammAlice.expectBalances(USD(10'000), BTC(10'000), IOUAmount(10'000))); + env.close(); + + auto aliceBTC = env.balance(alice, MPT(BTC)); + auto aliceUSD = env.balance(alice, USD); + + // individually locked and claw back 2000 BTC from alice + BTC.set({.holder = alice, .flags = tfMPTLock}); + env(amm::ammClawback(gw, alice, MPT(BTC), USD, BTC(2'000))); + BEAST_EXPECT(ammAlice.expectBalances(USD(8'000), BTC(8'000), IOUAmount(8'000))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + USD(2'000))); + aliceUSD = env.balance(alice, USD); + + // individually freeze trustline and claw back 1000 USD from alice + env(trust(gw, alice["USD"](0), tfSetFreeze)); + env.close(); + env(amm::ammClawback(gw, alice, USD, MPT(BTC), USD(1'000))); + BEAST_EXPECT(ammAlice.expectBalances(USD(7'000), BTC(7'000), IOUAmount(7'000))); + env.require(balance(alice, aliceBTC + BTC(1'000))); + env.require(balance(alice, aliceUSD)); + aliceBTC = env.balance(alice, MPT(BTC)); + + // unlock MPT and claw back 3000 BTC from alice + BTC.set({.holder = alice, .flags = tfMPTUnlock}); + env(amm::ammClawback(gw, alice, MPT(BTC), USD, BTC(3'000))); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(4000'000000000001), -12}, BTC(4'001), IOUAmount(4'000))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + USD(3'000))); + aliceUSD = env.balance(alice, USD); + + // unlock trustline and claw back 1000 USD from alice + env(trust(gw, alice["USD"](0), tfClearFreeze)); + env.close(); + env(amm::ammClawback(gw, alice, USD, MPT(BTC), USD(1'000))); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount(USD, UINT64_C(3'000'000000000002), -12), + BTC(3'001), + IOUAmount(3000'000000000001, -12))); + env.require(balance(alice, aliceBTC + BTC(1'000))); + env.require(balance(alice, aliceUSD)); + } + } + + void + testSingleDepositAndClawback(FeatureBitset features) + { + testcase("test single depoit and clawback"); + using namespace jtx; + + // MPT/XRP + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(1000000000), gw, alice); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + // gw creates AMM pool of BTC/XRP. + AMM amm(env, gw, XRP(100), BTC(400), ter(tesSUCCESS)); + env.close(); + BEAST_EXPECT(amm.expectBalances(XRP(100), BTC(400), IOUAmount(200000))); + amm.deposit(alice, BTC(400)); + env.close(); + BEAST_EXPECT(amm.expectBalances(XRP(100), BTC(800), IOUAmount{282842'712474619, -9})); + + auto aliceBTC = env.balance(alice, MPT(BTC)); + auto aliceXRP = env.balance(alice, XRP); + + // gw clawback 100 BTC from alice + env(amm::ammClawback(gw, alice, MPT(BTC), XRP, BTC(100))); + BEAST_EXPECT(amm.expectBalances( + XRPAmount(87500001), BTC(701), IOUAmount{247'487'3734152917, -10})); + + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceXRP + XRPAmount(12'499999))); + } + + // MPT/IOU + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(1000000000), gw, alice); + env.close(); + + // gw sets asfAllowTrustLineClawback. + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + env.require(flags(gw, asfAllowTrustLineClawback)); + + // gw issues 1000 USD to Alice. + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(1000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + // gw creates AMM pool of BTC/USD. + AMM amm(env, gw, USD(100), BTC(400), ter(tesSUCCESS)); + env.close(); + BEAST_EXPECT(amm.expectBalances(USD(100), BTC(400), IOUAmount(200))); + amm.deposit(alice, BTC(400)); + env.close(); + BEAST_EXPECT(amm.expectBalances(USD(100), BTC(800), IOUAmount{282'842712474619, -12})); + + auto aliceBTC = env.balance(alice, MPT(BTC)); + auto aliceUSD = env.balance(alice, USD); + + // gw clawback 100 BTC from alice + env(amm::ammClawback(gw, alice, MPT(BTC), USD, BTC(100))); + BEAST_EXPECT(amm.expectBalances( + STAmount{USD, UINT64_C(87'50000000000003), -14}, + BTC(701), + IOUAmount{247'4873734152917, -13})); + + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + USD(12.5))); + aliceUSD = env.balance(alice, USD); + + // gw clawback 30 USD from alice with tfClawTwoAssets, which exceeds + // her balance + env(amm::ammClawback(gw, alice, USD, MPT(BTC), USD(30)), txflags(tfClawTwoAssets)); + BEAST_EXPECT(amm.expectBalances( + STAmount{USD, UINT64_C(70'71067811865476), -14}, BTC(567), IOUAmount(200))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0))); + BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount(200))); + } + + // MPT/MPT + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(1000000000), gw, alice); + env.close(); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + // gw creates AMM pool of BTC/USD. + AMM amm(env, gw, USD(100), BTC(400), ter(tesSUCCESS)); + env.close(); + BEAST_EXPECT(amm.expectBalances(USD(100), BTC(400), IOUAmount(200))); + amm.deposit(alice, BTC(400)); + env.close(); + BEAST_EXPECT(amm.expectBalances(USD(100), BTC(800), IOUAmount{282'842712474619, -12})); + + auto aliceBTC = env.balance(alice, MPT(BTC)); + auto aliceUSD = env.balance(alice, USD); + + // gw clawback 100 BTC from alice + env(amm::ammClawback(gw, alice, MPT(BTC), USD, BTC(100))); + BEAST_EXPECT(amm.expectBalances(USD(88), BTC(701), IOUAmount{247'4873734152917, -13})); + + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD + USD(12))); + aliceUSD = env.balance(alice, USD); + + // gw clawback 30 USD from alice with tfClawTwoAssets, which exceeds + // her balance + env(amm::ammClawback(gw, alice, USD, MPT(BTC), USD(30)), txflags(tfClawTwoAssets)); + BEAST_EXPECT(amm.expectBalances(USD(72), BTC(567), IOUAmount(200))); + env.require(balance(alice, aliceBTC)); + env.require(balance(alice, aliceUSD)); + BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0))); + BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount(200))); + } + } + + void + testLastHolderLPTokenBalance(FeatureBitset features) + { + testcase( + "test last holder's lptoken balance not equal to AMM's lptoken " + "balance before clawback"); + using namespace jtx; + std::string logs; + + // MPT/IOU + { + Env env(*this, features, std::make_unique(&logs)); + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(50000))); + env.trust(USD(100000), bob); + env(pay(gw, bob, USD(40000))); + env.close(); + + MPT const EUR = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, USD(2), EUR(1)); + amm.deposit(alice, IOUAmount{1'576123487565916, -15}); + amm.deposit(bob, IOUAmount{1'000}); + amm.withdraw(alice, IOUAmount{1'576123487565916, -15}); + amm.withdrawAll(bob); + + auto const lpToken = + getAccountLines(env, alice, amm.lptIssue())[jss::lines][0u][jss::balance] + .asString(); + auto const lpTokenBalance = + amm.ammRpcInfo()[jss::amm][jss::lp_token][jss::value].asString(); + if (features[featureSingleAssetVault] || features[featureLendingProtocol]) + { + BEAST_EXPECT(lpToken == "1.414213562374011" && lpTokenBalance == "1.4142135623741"); + } + else + { + BEAST_EXPECT(lpToken == "1.414213562374011" && lpTokenBalance == "1.414213562374"); + } + + auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice); + BEAST_EXPECT(res && res.value()); + + if (features[fixAMMv1_3] && features[fixAMMClawbackRounding]) + { + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt)); + BEAST_EXPECT(!amm.ammExists()); + } + else if ( + features[fixAMMv1_3] && + (features[featureSingleAssetVault] || features[featureLendingProtocol])) + { + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt)); + // Without the Rounding feature and with new Number a dust pool + // amount remains + BEAST_EXPECT(amm.ammExists()); + } + else if (!features[featureSingleAssetVault] && !features[featureLendingProtocol]) + { + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt), ter(tecINTERNAL)); + BEAST_EXPECT(amm.ammExists()); + } + else + { + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt), ter(tecAMM_BALANCE)); + BEAST_EXPECT(amm.ammExists()); + } + } + + // MPT/MPT + { + Env env(*this, features, std::make_unique(&logs)); + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + MPT const EUR = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM amm(env, alice, USD(2), EUR(1)); + amm.deposit(alice, IOUAmount{1'576123487565916, -15}); + amm.deposit(bob, IOUAmount{1'000}); + amm.withdraw(alice, IOUAmount{1'576123487565916, -15}); + amm.withdrawAll(bob); + + auto const lpToken = + getAccountLines(env, alice, amm.lptIssue())[jss::lines][0u][jss::balance] + .asString(); + auto const lpTokenBalance = + amm.ammRpcInfo()[jss::amm][jss::lp_token][jss::value].asString(); + if (!features[featureSingleAssetVault] && !features[featureLendingProtocol]) + { + BEAST_EXPECT(lpToken == "1.414213562374011" && lpTokenBalance == "1.414213562374"); + } + else + { + BEAST_EXPECT(lpToken == "1.414213562374011" && lpTokenBalance == "1.4142135623741"); + } + + auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice); + BEAST_EXPECT(res && res.value()); + + if (features[fixAMMv1_3] && features[fixAMMClawbackRounding]) + { + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt)); + BEAST_EXPECT(!amm.ammExists()); + } + else if ( + features[fixAMMv1_3] && + (features[featureSingleAssetVault] || features[featureLendingProtocol])) + { + // Without the Rounding feature and with new Number a dust pool + // amount remains + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt)); + BEAST_EXPECT(amm.ammExists()); + } + else if (!features[featureSingleAssetVault] && !features[featureLendingProtocol]) + { + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt), ter(tecINTERNAL)); + BEAST_EXPECT(amm.ammExists()); + } + else if (features[featureMPTokensV2]) + { + env(amm::ammClawback(gw, alice, USD, EUR, std::nullopt), ter(tecAMM_BALANCE)); + BEAST_EXPECT(amm.ammExists()); + } + } + } + + void + testClawAssetCheck(FeatureBitset features) + { + testcase("claw asset check for MPT and IOU"); + using namespace jtx; + + // IOU/MPT, MPT not clawable + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(100000), gw, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(1000))); + env.close(); + + MPT const BTC = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 40'000}); + + AMM const amm(env, alice, USD(200), BTC(100)); + // Asset BTC is not clawable without tfMPTCanClawback. + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt), ter(tecNO_PERMISSION)); + + // Although USD is clawable with asfAllowTrustLineClawback. + // When tfClawTwoAssets is set, we will claw Asser2 as well. + // But Asset2 is not clawable. tfMPTCanClawback was not set for BTC. + env(amm::ammClawback(gw, alice, USD, BTC, std::nullopt), + txflags(tfClawTwoAssets), + ter(tecNO_PERMISSION)); + + // Can only claw the other asset + env(amm::ammClawback(gw, alice, USD, BTC, std::nullopt)); + } + + // IOU/MPT, IOU not clawable + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; + env.fund(XRP(100000), gw, alice); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(1000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + // Asset USD is not clawable without asfAllowTrustLineClawback. + AMM const amm(env, alice, USD(200), BTC(100)); + env(amm::ammClawback(gw, alice, USD, BTC, std::nullopt), ter(tecNO_PERMISSION)); + + // Although BTC is clawable with tfMPTCanClawback. + // When tfClawTwoAssets is set, we will claw Asset2 as well. + // But Asset2 is not clawable. asfAllowTrustLineClawback was not set + // by the issuer. + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt), + txflags(tfClawTwoAssets), + ter(tecNO_PERMISSION)); + + // Can only claw the other asset + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt)); + } + + // IOU/MPT both clawable + { + Env env(*this, features); + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + env.fund(XRP(100000), gw, gw2, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(1000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw2, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + + AMM const amm(env, alice, USD(200), BTC(100)); + + // the account trying to claw MPT is not its issuer + // will return temMALFORMED in preflight. + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt), ter(temMALFORMED)); + } + + // only issuer can claw. IOU/MPT mix + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + Account const gw("gateway"), alice("alice"), bob("bob"); + env.fund(XRP(30'000), alice, bob, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = bob, + .holders = {alice}, + .limit = 1'000'000}); + env(pay(gw, alice, USD(50000))); + env(pay(bob, alice, BTC(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10100)); + // BTC's issuer is bob, alice can not clawback + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt), ter(temMALFORMED)); + }; + testHelper2TokensMix(test); + } + + // set tfClawTwoAssets, but the two assets are from different issuer. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + Account const gw("gateway"), alice("alice"), bob("bob"); + env.fund(XRP(30'000), alice, bob, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = bob, + .holders = {alice}, + .limit = 1'000'000}); + env(pay(gw, alice, USD(50000))); + env(pay(bob, alice, BTC(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10100)); + // BTC's issuer is bob. But with tfClawTwoAssets, we will claw + // both. It will fail because the other asset USD's issuer is + // gw. + env(amm::ammClawback(bob, alice, BTC, USD, std::nullopt), + txflags(tfClawTwoAssets), + ter(temINVALID_FLAG)); + }; + testHelper2TokensMix(test); + } + } + + void + run() override + { + FeatureBitset const all{jtx::testable_amendments() | fixAMMClawbackRounding}; + + testInvalidRequest(all); + testFeatureDisabled(all); + testAMMClawbackAmount(all); + testAMMClawbackAll(all); + testAMMClawbackAmountSameIssuer(all); + testAMMClawbackAllSameIssuer(all); + testAMMClawbackIssuesEachOther(all); + testAssetFrozenOrLocked(all); + testSingleDepositAndClawback(all); + testLastHolderLPTokenBalance(all); + testLastHolderLPTokenBalance(all - fixAMMv1_3 - fixAMMClawbackRounding); + testLastHolderLPTokenBalance( + all - fixAMMv1_3 - fixAMMClawbackRounding - featureSingleAssetVault - + featureLendingProtocol); + testLastHolderLPTokenBalance(all - fixAMMClawbackRounding); + testClawAssetCheck(all); + } +}; + +BEAST_DEFINE_TESTSUITE(AMMClawbackMPT, app, xrpl); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/AMMClawback_test.cpp b/src/test/app/AMMClawback_test.cpp index 9033fe2bdd..662417ffc3 100644 --- a/src/test/app/AMMClawback_test.cpp +++ b/src/test/app/AMMClawback_test.cpp @@ -1,25 +1,44 @@ -#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include + +#include +#include +#include +#include namespace xrpl { namespace test { class AMMClawback_test : public beast::unit_test::suite { void - testInvalidRequest() + testInvalidRequest(FeatureBitset features) { testcase("test invalid request"); using namespace jtx; // Test if holder does not exist. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(100000), gw, alice); env.close(); @@ -32,7 +51,7 @@ class AMMClawback_test : public beast::unit_test::suite env.trust(USD(10000), alice); env(pay(gw, alice, USD(100))); - AMM amm(env, alice, XRP(100), USD(100)); + AMM const amm(env, alice, XRP(100), USD(100)); env.close(); env(amm::ammClawback(gw, Account("unknown"), USD, XRP, std::nullopt), @@ -42,9 +61,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test if asset pair provided does not exist. This should // return terNO_AMM error. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(100000), gw, alice); env.close(); @@ -74,9 +93,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test if the issuer field and holder field is the same. This should // return temMALFORMED error. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(10000), gw, alice); env.close(); @@ -91,7 +110,7 @@ class AMMClawback_test : public beast::unit_test::suite env(pay(gw, alice, USD(100))); env.close(); - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); // Issuer can not clawback from himself. env(amm::ammClawback(gw, gw, USD, XRP, std::nullopt), ter(temMALFORMED)); @@ -102,9 +121,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test if the Asset field matches the Account field. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(10000), gw, alice); env.close(); @@ -119,7 +138,7 @@ class AMMClawback_test : public beast::unit_test::suite env(pay(gw, alice, USD(100))); env.close(); - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); // The Asset's issuer field is alice, while the Account field is gw. // This should return temMALFORMED because they do not match. @@ -130,9 +149,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test if the Amount field matches the Asset field. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(10000), gw, alice); env.close(); @@ -147,7 +166,7 @@ class AMMClawback_test : public beast::unit_test::suite env(pay(gw, alice, USD(100))); env.close(); - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); // The Asset's issuer subfield is gw account and Amount's issuer // subfield is alice account. Return temBAD_AMOUNT because @@ -159,9 +178,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test if the Amount is invalid, which is less than zero. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(10000), gw, alice); env.close(); @@ -176,7 +195,7 @@ class AMMClawback_test : public beast::unit_test::suite env(pay(gw, alice, USD(100))); env.close(); - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); // Return temBAD_AMOUNT if the Amount value is less than 0. env(amm::ammClawback( @@ -192,9 +211,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test if the issuer did not set asfAllowTrustLineClawback, AMMClawback // transaction is prohibited. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(10000), gw, alice); env.close(); @@ -207,7 +226,7 @@ class AMMClawback_test : public beast::unit_test::suite env.require(balance(gw, alice["USD"](-100))); // gw creates AMM pool of XRP/USD. - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); // If asfAllowTrustLineClawback is not set, the issuer is not // allowed to send the AMMClawback transaction. @@ -216,9 +235,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test invalid flag. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(10000), gw, alice); env.close(); @@ -233,7 +252,7 @@ class AMMClawback_test : public beast::unit_test::suite env(pay(gw, alice, USD(100))); env.close(); - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); // Return temINVALID_FLAG when providing invalid flag. env(amm::ammClawback(gw, alice, USD, XRP, std::nullopt), @@ -244,9 +263,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test if tfClawTwoAssets is set when the two assets in the AMM pool // are not issued by the same issuer. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(10000), gw, alice); env.close(); @@ -262,7 +281,7 @@ class AMMClawback_test : public beast::unit_test::suite env.close(); // gw creates AMM pool of XRP/USD. - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); // Return temINVALID_FLAG because the issuer set tfClawTwoAssets, // but the issuer only issues USD in the pool. The issuer is not @@ -275,9 +294,9 @@ class AMMClawback_test : public beast::unit_test::suite // Test clawing back XRP is being prohibited. { - Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Env env(*this, features); + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, alice); env.close(); @@ -293,7 +312,7 @@ class AMMClawback_test : public beast::unit_test::suite env.close(); // Alice creates AMM pool of XRP/USD. - AMM amm(env, alice, XRP(1000), USD(2000), ter(tesSUCCESS)); + AMM const amm(env, alice, XRP(1000), USD(2000), ter(tesSUCCESS)); env.close(); // Clawback XRP is prohibited. @@ -309,8 +328,8 @@ class AMMClawback_test : public beast::unit_test::suite if (!features[featureAMMClawback]) { Env env(*this, features); - Account gw{"gateway"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, alice); env.close(); @@ -342,9 +361,9 @@ class AMMClawback_test : public beast::unit_test::suite // issuer. Claw back USD, and EUR goes back to the holder. { Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, gw2, alice); env.close(); @@ -370,7 +389,7 @@ class AMMClawback_test : public beast::unit_test::suite env.require(balance(alice, EUR(3000))); // Alice creates AMM pool of EUR/USD. - AMM amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); + AMM const amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); env.close(); BEAST_EXPECT( @@ -422,8 +441,8 @@ class AMMClawback_test : public beast::unit_test::suite // to the holder. { Env env(*this, features); - Account gw{"gateway"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, alice); env.close(); @@ -441,7 +460,7 @@ class AMMClawback_test : public beast::unit_test::suite env.require(balance(alice, USD(3000))); // Alice creates AMM pool of XRP/USD. - AMM amm(env, alice, XRP(1000), USD(2000), ter(tesSUCCESS)); + AMM const amm(env, alice, XRP(1000), USD(2000), ter(tesSUCCESS)); env.close(); BEAST_EXPECT(amm.expectBalances(USD(2000), XRP(1000), IOUAmount{1414213562373095, -9})); @@ -501,9 +520,9 @@ class AMMClawback_test : public beast::unit_test::suite // balance in AMM pool. { Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, gw2, alice); env.close(); @@ -527,7 +546,7 @@ class AMMClawback_test : public beast::unit_test::suite env.require(balance(alice, EUR(6000))); // Alice creates AMM pool of EUR/USD - AMM amm(env, alice, EUR(5000), USD(4000), ter(tesSUCCESS)); + AMM const amm(env, alice, EUR(5000), USD(4000), ter(tesSUCCESS)); env.close(); if (!features[fixAMMv1_3]) @@ -672,10 +691,10 @@ class AMMClawback_test : public beast::unit_test::suite // creates the AMM pool EUR/XRP. { Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000000), gw, gw2, alice, bob); env.close(); @@ -1082,11 +1101,11 @@ class AMMClawback_test : public beast::unit_test::suite // issuer. Claw back all the USD for different users. { Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(1000000), gw, gw2, alice, bob, carol); env.close(); @@ -1288,9 +1307,9 @@ class AMMClawback_test : public beast::unit_test::suite // different users. { Env env(*this, features); - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000000), gw, alice, bob); env.close(); @@ -1400,10 +1419,10 @@ class AMMClawback_test : public beast::unit_test::suite // Test AMMClawback for USD/EUR pool. The assets are issued by different // issuer. Claw back all the USD for different users. Env env(*this, features); - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(1000000), gw, alice, bob, carol); env.close(); @@ -1534,10 +1553,10 @@ class AMMClawback_test : public beast::unit_test::suite // Test AMMClawback for USD/EUR pool. The assets are issued by different // issuer. Claw back all the USD for different users. Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000000), gw, gw2, alice, bob); env.close(); @@ -1629,9 +1648,9 @@ class AMMClawback_test : public beast::unit_test::suite // gw and gw2 issues token for each other. Test AMMClawback from // each other. Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, gw2, alice); env.close(); @@ -1815,8 +1834,8 @@ class AMMClawback_test : public beast::unit_test::suite using namespace jtx; Env env(*this, features); - Account gw{"gateway"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, alice); env.close(); @@ -1829,7 +1848,7 @@ class AMMClawback_test : public beast::unit_test::suite env.trust(USD(100000), alice); env(pay(gw, alice, USD(5000))); - AMM amm(env, gw, USD(1000), XRP(2000), ter(tesSUCCESS)); + AMM const amm(env, gw, USD(1000), XRP(2000), ter(tesSUCCESS)); env.close(); // Alice did not deposit in the amm pool. So AMMClawback from Alice @@ -1846,9 +1865,9 @@ class AMMClawback_test : public beast::unit_test::suite // test individually frozen trustline. { Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, gw2, alice); env.close(); @@ -1872,7 +1891,7 @@ class AMMClawback_test : public beast::unit_test::suite env.require(balance(alice, EUR(3000))); // Alice creates AMM pool of EUR/USD. - AMM amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); + AMM const amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); env.close(); BEAST_EXPECT( @@ -1910,9 +1929,9 @@ class AMMClawback_test : public beast::unit_test::suite // test individually frozen trustline of both USD and EUR currency. { Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, gw2, alice); env.close(); @@ -1936,7 +1955,7 @@ class AMMClawback_test : public beast::unit_test::suite env.require(balance(alice, EUR(3000))); // Alice creates AMM pool of EUR/USD. - AMM amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); + AMM const amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); env.close(); BEAST_EXPECT( @@ -1960,9 +1979,9 @@ class AMMClawback_test : public beast::unit_test::suite // test gw global freeze. { Env env(*this, features); - Account gw{"gateway"}; - Account gw2{"gateway2"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; + Account const alice{"alice"}; env.fund(XRP(1000000), gw, gw2, alice); env.close(); @@ -1986,7 +2005,7 @@ class AMMClawback_test : public beast::unit_test::suite env.require(balance(alice, EUR(3000))); // Alice creates AMM pool of EUR/USD. - AMM amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); + AMM const amm(env, alice, EUR(1000), USD(2000), ter(tesSUCCESS)); env.close(); BEAST_EXPECT( @@ -2010,10 +2029,10 @@ class AMMClawback_test : public beast::unit_test::suite // global freeze. { Env env(*this, features); - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(1000000), gw, alice, bob, carol); env.close(); @@ -2149,8 +2168,8 @@ class AMMClawback_test : public beast::unit_test::suite // Test AMMClawback for USD/XRP pool. Claw back USD, and XRP goes back // to the holder. Env env(*this, features, std::make_unique(&logs)); - Account gw{"gateway"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(1000000000), gw, alice); env.close(); @@ -2212,21 +2231,22 @@ class AMMClawback_test : public beast::unit_test::suite using namespace jtx; std::string logs; - auto setupAccounts = [&](Env& env, Account& gw, Account& alice, Account& bob) { - env.fund(XRP(100000), gw, alice, bob); - env.close(); - env(fset(gw, asfAllowTrustLineClawback)); - env.close(); + auto setupAccounts = + [&](Env& env, Account const& gw, Account const& alice, Account const& bob) { + env.fund(XRP(100000), gw, alice, bob); + env.close(); + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); - auto const USD = gw["USD"]; - env.trust(USD(100000), alice); - env(pay(gw, alice, USD(50000))); - env.trust(USD(100000), bob); - env(pay(gw, bob, USD(40000))); - env.close(); + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(50000))); + env.trust(USD(100000), bob); + env(pay(gw, bob, USD(40000))); + env.close(); - return USD; - }; + return USD; + }; auto getLPTokenBalances = [&](auto& env, auto const& amm, @@ -2242,7 +2262,7 @@ class AMMClawback_test : public beast::unit_test::suite // IOU/XRP pool. AMMClawback almost last holder's USD balance { Env env(*this, features, std::make_unique(&logs)); - Account gw{"gateway"}, alice{"alice"}, bob{"bob"}; + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; auto const USD = setupAccounts(env, gw, alice, bob); AMM amm(env, alice, XRP(2), USD(1)); @@ -2275,7 +2295,7 @@ class AMMClawback_test : public beast::unit_test::suite // IOU/XRP pool. AMMClawback part of last holder's USD balance { Env env(*this, features, std::make_unique(&logs)); - Account gw{"gateway"}, alice{"alice"}, bob{"bob"}; + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; auto const USD = setupAccounts(env, gw, alice, bob); AMM amm(env, alice, XRP(2), USD(1)); @@ -2317,7 +2337,7 @@ class AMMClawback_test : public beast::unit_test::suite // IOU/XRP pool. AMMClawback all of last holder's USD balance { Env env(*this, features, std::make_unique(&logs)); - Account gw{"gateway"}, alice{"alice"}, bob{"bob"}; + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; auto const USD = setupAccounts(env, gw, alice, bob); AMM amm(env, alice, XRP(2), USD(1)); @@ -2354,10 +2374,10 @@ class AMMClawback_test : public beast::unit_test::suite // IOU/IOU pool, different issuers { Env env(*this, features, std::make_unique(&logs)); - Account gw{"gateway"}, alice{"alice"}, bob{"bob"}; + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; auto const USD = setupAccounts(env, gw, alice, bob); - Account gw2{"gateway2"}; + Account const gw2{"gateway2"}; env.fund(XRP(100000), gw2); env.close(); auto const EUR = gw2["EUR"]; @@ -2394,7 +2414,7 @@ class AMMClawback_test : public beast::unit_test::suite // IOU/IOU pool, same issuer { Env env(*this, features, std::make_unique(&logs)); - Account gw{"gateway"}, alice{"alice"}, bob{"bob"}; + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; auto const USD = setupAccounts(env, gw, alice, bob); auto const EUR = gw["EUR"]; @@ -2433,7 +2453,7 @@ class AMMClawback_test : public beast::unit_test::suite // IOU/IOU pool, larger asset ratio { Env env(*this, features, std::make_unique(&logs)); - Account gw{"gateway"}, alice{"alice"}, bob{"bob"}; + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; auto const USD = setupAccounts(env, gw, alice, bob); auto const EUR = gw["EUR"]; @@ -2490,10 +2510,14 @@ class AMMClawback_test : public beast::unit_test::suite FeatureBitset const all = jtx::testable_amendments() - featureSingleAssetVault - featureLendingProtocol; - testInvalidRequest(); + testInvalidRequest(all); + testInvalidRequest(all - featureMPTokensV2); testFeatureDisabled(all - featureAMMClawback); for (auto const& features : - {all - fixAMMv1_3 - fixAMMClawbackRounding, all - fixAMMClawbackRounding, all}) + {all - fixAMMv1_3 - fixAMMClawbackRounding - featureMPTokensV2, + all - fixAMMClawbackRounding - featureMPTokensV2, + all - featureMPTokensV2, + all}) { testAMMClawbackSpecificAmount(features); testAMMClawbackExceedBalance(features); diff --git a/src/test/app/AMMExtendedMPT_test.cpp b/src/test/app/AMMExtendedMPT_test.cpp new file mode 100644 index 0000000000..25fd8153b6 --- /dev/null +++ b/src/test/app/AMMExtendedMPT_test.cpp @@ -0,0 +1,3663 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +namespace xrpl { +namespace test { + +/** + * Tests of AMM MPT that use offers. + */ +struct AMMExtendedMPT_test : public jtx::AMMTest +{ +private: + void + testRmFundedOffer(FeatureBitset features) + { + testcase("Incorrect Removal of Funded Offers"); + + // We need at least two paths. One at good quality and one at bad + // quality. The bad quality path needs two offer books in a row. + // Each offer book should have two offers at the same quality, the + // offers should be completely consumed, and the payment should + // require both offers to be satisfied. The first offer must + // be "taker gets" XRP. Ensure that the payment engine does not remove + // the first "taker gets" xrp offer, because the offer is still + // funded and not used for the payment. + + using namespace jtx; + Env env{*this, features}; + + fund(env, gw, {alice, bob, carol}, XRP(10'000)); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 200'000'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 2'000'000'000'000'000, + .flags = MPTDEXFlags}); + + // Must be two offers at the same quality + // "taker gets" must be XRP + // (Different amounts so I can distinguish the offers) + env(offer(carol, BTC(49'000'000'000'000), XRP(49))); + env(offer(carol, BTC(51'000'000'000'000), XRP(51))); + + // Offers for the poor quality path + // Must be two offers at the same quality + env(offer(carol, XRP(50), ETH(50'000'000'000'000))); + env(offer(carol, XRP(50), ETH(50'000'000'000'000))); + + // Good quality path + AMM const ammCarol(env, carol, BTC(1'000'000'000'000'000), ETH(100'100'000'000'000'000)); + + PathSet const paths(Path(XRP, MPT(ETH)), Path(MPT(ETH))); + + env(pay(alice, bob, ETH(100'000'000'000'000)), + json(paths.json()), + sendmax(BTC(1'000'000'000'000'000)), + txflags(tfPartialPayment)); + + BEAST_EXPECT(ammCarol.expectBalances( + BTC(1'001'000'000'374'816), ETH(100'000'000'000'000'000), ammCarol.tokens())); + + env.require(balance(bob, ETH(200'100'000'000'000'000))); + BEAST_EXPECT(isOffer(env, carol, BTC(49'000'000'000'000), XRP(49))); + } + + void + testFillModes(FeatureBitset features) + { + testcase("Fill Modes"); + using namespace jtx; + + auto const startBalance = XRP(1'000'000); + + // Fill or Kill - unless we fully cross, just charge a fee and don't + // place the offer on the books. But also clean up expired offers + // that are discovered along the way. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const& BTC = MPT(ammAlice[1]); + auto const baseFee = env.current()->fees().base; + auto carolBTC = env.balance(carol, BTC); + auto carolXRP = env.balance(carol, XRP); + // Order that can't be filled + env(offer(carol, BTC(100), XRP(100)), txflags(tfFillOrKill), ter(tecKILLED)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'100), BTC(10'000), ammAlice.tokens())); + // fee = AMM + env.require(balance(carol, carolXRP - baseFee)); + env.require(balance(carol, carolBTC)); + + BEAST_EXPECT(expectOffers(env, carol, 0)); + carolXRP = env.balance(carol, XRP); + + // Order that can be filled + env(offer(carol, XRP(100), BTC(100)), txflags(tfFillOrKill), ter(tesSUCCESS)); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(10'100), ammAlice.tokens())); + env.require(balance(carol, carolXRP + XRP(100) - baseFee)); + env.require(balance(carol, carolBTC - BTC(100))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + }, + {{XRP(10'100), AMMMPT(10'000)}}, + 0, + std::nullopt, + {features}); + + // Immediate or Cancel - cross as much as possible + // and add nothing on the books. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const& BTC = MPT(ammAlice[1]); + auto const baseFee = env.current()->fees().base; + auto carolBTC = env.balance(carol, BTC); + auto carolXRP = env.balance(carol, XRP); + env(offer(carol, XRP(200), BTC(200)), + txflags(tfImmediateOrCancel), + ter(tesSUCCESS)); + + // AMM generates a synthetic offer of 100BTC/100XRP + // to match the CLOB offer quality. + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(10'100), ammAlice.tokens())); + // +AMM - offer * fee + env.require(balance(carol, carolXRP + XRP(100) - baseFee)); + env.require(balance(carol, carolBTC - BTC(100))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + }, + {{XRP(10'100), AMMMPT(10'000)}}, + 0, + std::nullopt, + {features}); + + // tfPassive -- place the offer without crossing it. + testAMM( + [&](AMM& ammAlice, Env& env) { + // Carol creates a passive offer that could cross AMM. + // Carol's offer should stay in the ledger. + auto const& BTC = MPT(ammAlice[1]); + env(offer(carol, XRP(100), BTC(100), tfPassive)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'100), BTC(10'000), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 1, {{{XRP(100), BTC(100)}}})); + }, + {{XRP(10'100), AMMMPT(10'000)}}, + 0, + std::nullopt, + {features}); + + // tfPassive -- cross only offers of better quality. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const& BTC = MPT(ammAlice[1]); + env(offer(alice, BTC(110), XRP(100))); + env.close(); + + // Carol creates a passive offer. That offer should cross + // AMM and leave Alice's offer untouched. + env(offer(carol, XRP(100), BTC(100), tfPassive)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'900), BTC(9083), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, alice, 1)); + }, + {{XRP(11'000), AMMMPT(9'000)}}, + 0, + std::nullopt, + {features}); + } + + void + testOfferCrossWithXRP(FeatureBitset features) + { + testcase("Offer Crossing with XRP, Normal order"); + + using namespace jtx; + + Env env{*this, features}; + + fund(env, gw, {bob, alice}, XRP(300'000)); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 100'000'000, + .flags = MPTDEXFlags}); + + AMM const ammAlice(env, alice, XRP(150'000), BTC(50'000'000)); + + // Existing offer pays better than this wants. + // Partially consume existing offer. + // Pay 1'000'000 BTC, get 3061224490 Drops. + auto const xrpTransferred = XRPAmount{3'061'224'490}; + env(offer(bob, BTC(1'000'000), XRP(4'000))); + + BEAST_EXPECT(ammAlice.expectBalances( + XRP(150'000) + xrpTransferred, BTC(49'000'000), IOUAmount{273'861'278752583, -5})); + + env.require(balance(bob, BTC(101'000'000))); + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(300'000) - xrpTransferred - 2 * txfee(env, 1))); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + + void + testOfferCrossWithLimitOverride(FeatureBitset features) + { + testcase("Offer Crossing with Limit Override"); + + using namespace jtx; + + Env env{*this, features}; + + env.fund(XRP(200'000), gw, alice, bob); + env.close(); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob}, .flags = MPTDEXFlags}); + env(pay(gw, alice, BTC(500'000'000))); + + AMM const ammAlice(env, alice, XRP(150'000), BTC(51'000'000)); + env(offer(bob, BTC(1'000'000), XRP(3'000))); + + BEAST_EXPECT(ammAlice.expectBalances(XRP(153'000), BTC(50'000'000), ammAlice.tokens())); + + env.require(balance(bob, BTC(1'000'000))); + env.require(balance(bob, XRP(200'000) - XRP(3'000) - env.current()->fees().base * 2)); + } + + void + testCurrencyConversionEntire(FeatureBitset features) + { + testcase("Currency Conversion: Entire Offer"); + + using namespace jtx; + + Env env{*this, features}; + + fund(env, gw, {alice, bob}, XRP(10'000)); + env.require(owners(bob, 0)); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob}, .flags = MPTDEXFlags}); + env(pay(gw, bob, BTC(1'000'000'000))); + + env.require(owners(alice, 1), owners(bob, 1)); + + env(pay(gw, alice, BTC(100'000'000))); + AMM const ammBob(env, bob, BTC(200'000'000), XRP(1'500)); + + env(pay(alice, alice, XRP(500)), sendmax(BTC(100'000'000))); + + BEAST_EXPECT(ammBob.expectBalances(BTC(300'000'000), XRP(1'000), ammBob.tokens())); + env.require(balance(alice, BTC(0))); + + auto jrr = ledgerEntryRoot(env, alice); + env.require(balance(alice, XRP(10'000) + XRP(500) - env.current()->fees().base * 2)); + } + + void + testCurrencyConversionInParts(FeatureBitset features) + { + testcase("Currency Conversion: In Parts"); + + using namespace jtx; + + Env env{*this, features}; + env.fund(XRP(30'000), gw, bob); + env.fund(XRP(40'000), alice); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 30'000'000'000, + .flags = MPTDEXFlags}); + env(pay(gw, alice, BTC(10'000'000'000))); + + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000'000'000)); + env.close(); + + // Alice converts BTC to XRP which should fail + // due to PartialPayment. + env(pay(alice, alice, XRP(100)), sendmax(BTC(100'000'000)), ter(tecPATH_PARTIAL)); + + // Alice converts BTC to XRP, should succeed because + // we permit partial payment + env(pay(alice, alice, XRP(100)), sendmax(BTC(100'000'000)), txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount{9'900'990'100}, BTC(10'100'000'000), ammAlice.tokens())); + // initial 40,000'000'000 - 10,000'000'000AMM - 100'000'000pay + env.require(balance(alice, BTC(29'900'000'000))); + // initial 40,000 - 10,0000AMM + 99.009900pay - fee*3 + BEAST_EXPECT(expectLedgerEntryRoot( + env, + alice, + XRP(40'000) - XRP(10'000) + XRPAmount{99'009'900} - ammCrtFee(env) - txfee(env, 3))); + } + + void + testCrossCurrencyStartXRP(FeatureBitset features) + { + testcase("Cross Currency Payment: Start with XRP"); + + using namespace jtx; + + Env env{*this, features}; + env.fund(XRP(30'000), gw); + env.fund(XRP(40'000), alice); + env.fund(XRP(1'000), bob); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob}, .flags = MPTDEXFlags}); + env(pay(gw, alice, BTC(10'100'000'000))); + + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'100'000'000)); + env.close(); + + env(pay(alice, bob, BTC(100'000'000)), sendmax(XRP(100))); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'100), BTC(10'000'000'000), ammAlice.tokens())); + env.require(balance(bob, BTC(100'000'000))); + } + + void + testCrossCurrencyEndXRP(FeatureBitset features) + { + testcase("Cross Currency Payment: End with XRP"); + + using namespace jtx; + + Env env{*this, features}; + env.fund(XRP(30'000), gw); + env.fund(XRP(40'100), alice); + env.fund(XRP(1'000), bob); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob}, .flags = MPTDEXFlags}); + env(pay(gw, alice, BTC(40'000'000'000))); + + AMM const ammAlice(env, alice, XRP(10'100), BTC(10'000'000'000)); + env.close(); + + env(pay(alice, bob, XRP(100)), sendmax(BTC(100'000'000))); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(10'100'000'000), ammAlice.tokens())); + BEAST_EXPECT(expectLedgerEntryRoot(env, bob, XRP(1'000) + XRP(100) - txfee(env, 1))); + } + + void + testCrossCurrencyBridged(FeatureBitset features) + { + testcase("Cross Currency Payment: Bridged"); + + using namespace jtx; + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + auto const dan = Account{"dan"}; + env.fund(XRP(60'000), alice, bob, carol, gw, dan); + env.close(); + auto const ETH = issue1( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob, carol, dan}, + .limit = 10'000'000'000'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol, dan}, + .limit = 10'000'000'000'000'000}); + env(pay(gw, alice, BTC(500'000'000'000'000))); + env(pay(gw, carol, BTC(6'000'000'000'000'000))); + env(pay(gw, dan, ETH(400'000'000'000'000))); + env.close(); + env.close(); + AMM const ammCarol(env, carol, BTC(5'000'000'000'000'000), XRP(50'000)); + + env(offer(dan, XRP(500), ETH(50'000'000'000'000))); + env.close(); + + Json::Value jtp{Json::arrayValue}; + jtp[0u][0u][jss::currency] = "XRP"; + env(pay(alice, bob, ETH(30'000'000'000'000)), + json(jss::Paths, jtp), + sendmax(BTC(333'000'000'000'000))); + env.close(); + BEAST_EXPECT(ammCarol.expectBalances( + XRP(49'700), BTC(5'030'181'086'519'115), ammCarol.tokens())); + BEAST_EXPECT(expectOffers(env, dan, 1, {{Amounts{XRP(200), ETH(20'000'000'000'000)}}})); + env.require(balance(bob, ETH(30'000'000'000'000))); + }; + testHelper2TokensMix(test); + } + + void + testOfferFeesConsumeFunds(FeatureBitset features) + { + testcase("Offer Fees Consume Funds"); + + using namespace jtx; + + Env env{*this, features}; + + // Provide micro amounts to compensate for fees to make results round + // nice. + auto const starting_xrp = + XRP(100) + env.current()->fees().accountReserve(2) + env.current()->fees().base * 3; + + env.fund(starting_xrp, gw, alice); + env.fund(XRP(2'000), bob); + env.close(); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob}, .flags = MPTDEXFlags}); + + // Created only to increase one reserve count for alice + MPTTester const ETH({.env = env, .issuer = gw, .holders = {alice}, .flags = MPTDEXFlags}); + + env(pay(gw, bob, BTC(1'200'000'000'000'000))); + + AMM const ammBob(env, bob, XRP(1'000), BTC(1'200'000'000'000'000)); + // Alice has 400 - (2 reserve of 50 = 300 reserve) = 100 available. + // Ask for more than available to prove reserve works. + env(offer(alice, BTC(200'000'000'000'000), XRP(200))); + + // The pool gets only 100XRP for ~109.09e12BTC, even though + // it can exchange more. + BEAST_EXPECT( + ammBob.expectBalances(XRP(1'100), BTC(1'090'909'090'909'091), ammBob.tokens())); + + env.require(balance(alice, BTC(109'090'909'090'909))); + env.require(balance(alice, XRP(300))); + } + + void + testOfferCreateThenCross(FeatureBitset features) + { + testcase("Offer Create, then Cross"); + + using namespace jtx; + + Env env{*this, features}; + + fund(env, gw, {alice, bob}, XRP(200'000)); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .transferFee = 500, + .flags = MPTDEXFlags}); + + env(pay(gw, bob, BTC(1'000'000'000'000))); + env(pay(gw, alice, BTC(200'000'000'000'000))); + + AMM const ammAlice(env, alice, BTC(150'000'000'000'000), XRP(150'100)); + env(offer(bob, XRP(100), BTC(100'000'000'000))); + + BEAST_EXPECT( + ammAlice.expectBalances(BTC(150'100'000'000'000), XRP(150'000), ammAlice.tokens())); + + // Bob pays 0.005 transfer fee. + env.require(balance(bob, BTC(899'500'000'000))); + } + + void + testSellFlagBasic(FeatureBitset features) + { + testcase("Offer tfSell: Basic Sell"); + + using namespace jtx; + + Env env{*this, features}; + env.fund(XRP(30'000), gw, bob, carol); + env.fund(XRP(39'900), alice); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 30'000, + .flags = MPTDEXFlags}); + env(pay(gw, alice, BTC(10'100))); + + AMM const ammAlice(env, alice, XRP(9'900), BTC(10'100)); + + env(offer(carol, BTC(100), XRP(100)), json(jss::Flags, tfSell)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(9'999), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 0)); + env.require(balance(carol, BTC(30'101))); + BEAST_EXPECT(expectLedgerEntryRoot(env, carol, XRP(30'000) - XRP(100) - 2 * txfee(env, 1))); + } + + void + testSellFlagExceedLimit(FeatureBitset features) + { + testcase("Offer tfSell: 2x Sell Exceed Limit"); + + using namespace jtx; + + Env env{*this, features}; + + auto const starting_xrp = XRP(100) + reserve(env, 1) + env.current()->fees().base * 2; + + env.fund(starting_xrp, gw, alice); + env.fund(XRP(2'000), bob); + env.close(); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob}, .flags = MPTDEXFlags}); + env(pay(gw, bob, BTC(2'200'000'000))); + + AMM const ammBob(env, bob, XRP(1'000), BTC(2'200'000'000)); + // Alice has 350 fees - a reserve of 50 = 250 reserve = 100 available. + // Ask for more than available to prove reserve works. + // Taker pays 100'000'000 BTC for 100 XRP. + // Selling XRP. + // Will sell all 100 XRP and get more BTC than asked for. + env(offer(alice, BTC(100'000'000), XRP(200)), json(jss::Flags, tfSell)); + BEAST_EXPECT(ammBob.expectBalances(XRP(1'100), BTC(2'000'000'000), ammBob.tokens())); + env.require(balance(alice, BTC(200'000'000))); + BEAST_EXPECT(expectLedgerEntryRoot(env, alice, XRP(250))); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + + void + testGatewayCrossCurrency(FeatureBitset features) + { + testcase("Client Issue: Gateway Cross Currency"); + + using namespace jtx; + + Env env{*this, features}; + + auto const starting_xrp = XRP(100.1) + reserve(env, 1) + env.current()->fees().base * 2; + env.fund(starting_xrp, gw, alice, bob); + + MPTTester const XTS( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const XXX( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const ammAlice(env, alice, XTS(1'000'000'000'000'000), XXX(1'000'000'000'000'000)); + + Json::Value payment; + payment[jss::secret] = toBase58(generateSeed("bob")); + payment[jss::id] = env.seq(bob); + payment[jss::build_path] = true; + payment[jss::tx_json] = pay(bob, bob, XXX(10'000'000'000'000)); + payment[jss::tx_json][jss::Sequence] = + env.current()->read(keylet::account(bob.id()))->getFieldU32(sfSequence); + payment[jss::tx_json][jss::Fee] = to_string(env.current()->fees().base); + payment[jss::tx_json][jss::SendMax] = + XTS(15'000'000'000'000).value().getJson(JsonOptions::none); + payment[jss::tx_json][jss::Flags] = tfPartialPayment; + auto const jrr = env.rpc("json", "submit", to_string(payment)); + BEAST_EXPECT(jrr[jss::result][jss::status] == "success"); + BEAST_EXPECT(jrr[jss::result][jss::engine_result] == "tesSUCCESS"); + + BEAST_EXPECT(ammAlice.expectBalances( + XTS(1'010'101'010'101'011), XXX(990'000'000'000'000), ammAlice.tokens())); + env.require(balance(bob, XTS(989'898'989'898'989))); + env.require(balance(bob, XXX(1'010'000'000'000'000))); + } + + void + testBridgedCross(FeatureBitset features) + { + testcase("Bridged Crossing"); + + using namespace jtx; + + { + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 15'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 15'000'000'000, + .flags = MPTDEXFlags}); + + // The scenario: + // o BTC/XRP AMM is created. + // o ETH/XRP AMM is created. + // o carol has ETH but wants BTC. + // Note that carol's offer must come last. If carol's offer is + // placed before AMM is created, then autobridging will not occur. + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'100'000'000)); + AMM const ammBob(env, bob, ETH(10'000'000'000), XRP(10'100)); + + // Carol makes an offer that consumes AMM liquidity and + // fully consumes Carol's offer. + env(offer(carol, BTC(100'000'000), ETH(100'000'000))); + env.close(); + + BEAST_EXPECT( + ammAlice.expectBalances(XRP(10'100), BTC(10'000'000'000), ammAlice.tokens())); + BEAST_EXPECT(ammBob.expectBalances(XRP(10'000), ETH(10'100'000'000), ammBob.tokens())); + env.require(balance(carol, BTC(15'100'000'000))); + env.require(balance(carol, ETH(14'900'000'000))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + { + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 15'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 15'000'000'000, + .flags = MPTDEXFlags}); + + // The scenario: + // o BTC/XRP AMM is created. + // o ETH/XRP offer is created. + // o carol has ETH but wants BTC. + // Note that carol's offer must come last. If carol's offer is + // placed before AMM and bob's offer are created, then autobridging + // will not occur. + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'100'000'000)); + env(offer(bob, ETH(100'000'000), XRP(100))); + env.close(); + + // Carol makes an offer that consumes AMM liquidity and + // fully consumes Carol's offer. + env(offer(carol, BTC(100'000'000), ETH(100'000'000))); + env.close(); + + BEAST_EXPECT( + ammAlice.expectBalances(XRP(10'100), BTC(10'000'000'000), ammAlice.tokens())); + env.require(balance(carol, BTC(15'100'000'000))); + env.require(balance(carol, ETH(14'900'000'000))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + + { + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 15'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 15'000'000'000, + .flags = MPTDEXFlags}); + + // The scenario: + // o BTC/XRP offer is created. + // o ETH/XRP AMM is created. + // o carol has ETH but wants BTC. + // Note that carol's offer must come last. If carol's offer is + // placed before AMM and alice's offer are created, then + // autobridging will not occur. + env(offer(alice, XRP(100), BTC(100'000'000))); + env.close(); + AMM const ammBob(env, bob, ETH(10'000'000'000), XRP(10'100)); + + // Carol makes an offer that consumes AMM liquidity and + // fully consumes Carol's offer. + env(offer(carol, BTC(100'000'000), ETH(100'000'000))); + env.close(); + + BEAST_EXPECT(ammBob.expectBalances(XRP(10'000), ETH(10'100'000'000), ammBob.tokens())); + env.require(balance(carol, BTC(15'100'000'000))); + env.require(balance(carol, ETH(14'900'000'000))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + } + + void + testSellWithFillOrKill(FeatureBitset features) + { + // Test a number of different corner cases regarding offer crossing + // when both the tfSell flag and tfFillOrKill flags are set. + testcase("Combine tfSell with tfFillOrKill"); + + using namespace jtx; + + { + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 20'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammBob(env, bob, XRP(20'000), BTC(200'000'000)); + // alice submits a tfSell | tfFillOrKill offer that does not cross. + env(offer(alice, BTC(2'100'000), XRP(210), tfSell | tfFillOrKill), ter(tecKILLED)); + + BEAST_EXPECT(ammBob.expectBalances(XRP(20'000), BTC(200'000'000), ammBob.tokens())); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + { + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammBob(env, bob, XRP(20'000), BTC(200'000'000'000'000)); + // alice submits a tfSell | tfFillOrKill offer that crosses. + // Even though tfSell is present it doesn't matter this time. + env(offer(alice, BTC(2'000'000'000'000), XRP(220), tfSell | tfFillOrKill)); + env.close(); + BEAST_EXPECT( + ammBob.expectBalances(XRP(20'220), BTC(197'823'936'696'341), ammBob.tokens())); + env.require(balance(alice, BTC(1'002'176'063'303'659))); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + { + // alice submits a tfSell | tfFillOrKill offer that crosses and + // returns more than was asked for (because of the tfSell flag). + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammBob(env, bob, XRP(20'000), BTC(200'000'000'000'000)); + + env(offer(alice, BTC(10'000'000'000'000), XRP(1'500), tfSell | tfFillOrKill)); + env.close(); + + BEAST_EXPECT( + ammBob.expectBalances(XRP(21'500), BTC(186'046'511'627'907), ammBob.tokens())); + env.require(balance(alice, BTC(1'013'953'488'372'093))); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + { + // alice submits a tfSell | tfFillOrKill offer that doesn't cross. + // This would have succeeded with a regular tfSell, but the + // fillOrKill prevents the transaction from crossing since not + // all of the offer is consumed because AMM generated offer, + // which matches alice's offer quality is ~ 10XRP/0.01996e3BTC. + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 10'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammBob(env, bob, XRP(5000), BTC(10'000'000)); + + env(offer(alice, BTC(1'000'000), XRP(501), tfSell | tfFillOrKill), ter(tecKILLED)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + } + + void + testTransferRateOffer(FeatureBitset features) + { + testcase("Transfer Rate Offer"); + + using namespace jtx; + + // AMM XRP/BTC. Alice places BTC/XRP offer. + { + Env env(*this, features); + env.fund(XRP(30'000), gw, bob, carol); + env.fund(XRP(40'000), alice); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 30'000'000, + .flags = MPTDEXFlags}); + env(pay(gw, alice, BTC(10'100'000))); + + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'100'000)); + env.close(); + + env(offer(carol, BTC(100'000), XRP(100))); + env.close(); + + // AMM doesn't pay the transfer fee + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'100), BTC(10'000'000), ammAlice.tokens())); + env.require(balance(carol, BTC(30'100'000))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + { + Env env(*this, features); + env.fund(XRP(30'000), gw, bob, carol); + env.fund(XRP(40'100), alice); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 30'000'000, + .flags = MPTDEXFlags}); + env(pay(gw, alice, BTC(10'000'000))); + + AMM const ammAlice(env, alice, XRP(10'100), BTC(10'000'000)); + env.close(); + + env(offer(carol, XRP(100), BTC(100'000))); + env.close(); + + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(10'100'000), ammAlice.tokens())); + // Carol pays 25% transfer fee + env.require(balance(carol, BTC(29'875'000))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + { + // Bridged crossing. + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 15'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 15'000'000, + .flags = MPTDEXFlags}); + + // The scenario: + // o BTC/XRP AMM is created. + // o ETH/XRP Offer is created. + // o carol has ETH but wants BTC. + // Note that Carol's offer must come last. If Carol's offer is + // placed before AMM is created, then autobridging will not occur. + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'100'000)); + env(offer(bob, ETH(100'000), XRP(100))); + env.close(); + + // Carol makes an offer that consumes AMM liquidity and + // fully consumes Bob's offer. + env(offer(carol, BTC(100'000), ETH(100'000))); + env.close(); + + // AMM doesn't pay the transfer fee + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'100), BTC(10'000'000), ammAlice.tokens())); + env.require(balance(carol, BTC(15'100'000))); + // Carol pays 25% transfer fee. + env.require(balance(carol, ETH(14'875'000))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + + { + // Bridged crossing. The transfer fee is paid on the step not + // involving AMM as src/dst. + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 15'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 15'000'000, + .flags = MPTDEXFlags}); + + // The scenario: + // o BTC/XRP AMM is created. + // o ETH/XRP Offer is created. + // o carol has ETH but wants BTC. + // Note that Carol's offer must come last. If Carol's offer is + // placed before AMM is created, then autobridging will not occur. + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'050'000)); + env(offer(bob, ETH(100'000), XRP(100))); + env.close(); + + // Carol makes an offer that consumes AMM liquidity and + // partially consumes Bob's offer. + env(offer(carol, BTC(50'000), ETH(50'000))); + env.close(); + // This test verifies that the amount removed from an offer + // accounts for the transfer fee that is removed from the + // account but not from the remaining offer. + + // AMM doesn't pay the transfer fee + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'050), BTC(10'000'000), ammAlice.tokens())); + env.require(balance(carol, BTC(15'050'000))); + // Carol pays 25% transfer fee. + env.require(balance(carol, ETH(14'937'500))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, bob, 1, {{Amounts{ETH(50'000), XRP(50)}}})); + } + } + + void + testSelfIssueOffer(FeatureBitset features) + { + // This test is not the same as corresponding testSelfIssueOffer() + // in the Offer_test. It simply tests AMM with self issue and + // offer crossing. + using namespace jtx; + + Env env{*this, features}; + + auto const f = env.current()->fees().base; + + env.fund(XRP(30'000) + f, alice, bob); + env.close(); + + MPTTester const BTC({.env = env, .issuer = bob, .holders = {alice}, .flags = MPTDEXFlags}); + + AMM const ammBob(env, bob, XRP(10'000), BTC(10'100)); + + env(offer(alice, BTC(100), XRP(100))); + env.close(); + + BEAST_EXPECT(ammBob.expectBalances(XRP(10'100), BTC(10'000), ammBob.tokens())); + BEAST_EXPECT(expectOffers(env, alice, 0)); + env.require(balance(alice, BTC(100))); + } + + void + testDirectToDirectPath(FeatureBitset features) + { + // The offer crossing code expects that a DirectStep is always + // preceded by a BookStep. In one instance the default path + // was not matching that assumption. Here we recreate that case + // so we can prove the bug stays fixed. + testcase("Direct to Direct path"); + + using namespace jtx; + + Env env{*this, features}; + + auto const ann = Account("ann"); + auto const bob = Account("bob"); + auto const cam = Account("cam"); + auto const carol = Account("carol"); + + auto const fee = env.current()->fees().base; + env.fund(XRP(1'000), carol); + env.fund(reserve(env, 4) + (fee * 5), ann, bob, cam); + env.close(); + + MPTTester const A_BUX( + {.env = env, .issuer = ann, .holders = {bob, cam, carol}, .flags = MPTDEXFlags}); + + MPTTester const B_BUX( + {.env = env, .issuer = bob, .holders = {ann, cam, carol}, .flags = MPTDEXFlags}); + + env(pay(ann, cam, A_BUX(350'000'000'000'000))); + env(pay(bob, cam, B_BUX(350'000'000'000'000))); + env(pay(bob, carol, B_BUX(4'000'000'000'000'000))); + env(pay(ann, carol, A_BUX(4'000'000'000'000'000))); + + AMM const ammCarol(env, carol, A_BUX(3'000'000'000'000'000), B_BUX(3'300'000'000'000'000)); + + // cam puts an offer on the books that her upcoming offer could cross. + // But this offer should be deleted, not crossed, by her upcoming + // offer. + env(offer(cam, A_BUX(290'000'000'000'000), B_BUX(300'000'000'000'000), tfPassive)); + env.close(); + env.require(balance(cam, A_BUX(350'000'000'000'000))); + env.require(balance(cam, B_BUX(350'000'000'000'000))); + env.require(offers(cam, 1)); + + // This offer caused the assert. + env(offer(cam, B_BUX(300'000'000'000'000), A_BUX(300'000'000'000'000))); + + // AMM is consumed up to the first cam Offer quality + BEAST_EXPECT(ammCarol.expectBalances( + A_BUX(3'093'541'659'651'604), B_BUX(3'200'215'509'984'418), ammCarol.tokens())); + BEAST_EXPECT(expectOffers( + env, cam, 1, {{Amounts{B_BUX(200'215'509'984'418), A_BUX(200'215'509'984'419)}}})); + } + + void + testRequireAuth(FeatureBitset features) + { + testcase("RequireAuth"); + + using namespace jtx; + + Env env{*this, features}; + env.fund(XRP(400'000), gw, alice, bob); + + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .flags = tfMPTRequireAuth | MPTDEXFlags}); + + // Authorize bob and alice + BTC.authorize({.holder = alice}); + BTC.authorize({.holder = bob}); + + env(pay(gw, alice, BTC(1'000))); + env.close(); + + // Alice is able to create AMM since the GW has authorized her + AMM const ammAlice(env, alice, BTC(1'000), XRP(1'050)); + + env(pay(gw, bob, BTC(50))); + env.close(); + + env.require(balance(bob, BTC(50))); + + // Bob's offer should cross Alice's AMM + env(offer(bob, XRP(50), BTC(50))); + env.close(); + + BEAST_EXPECT(ammAlice.expectBalances(BTC(1'050), XRP(1'000), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, bob, 0)); + env.require(balance(bob, BTC(0))); + } + + void + testMissingAuth(FeatureBitset features) + { + testcase("Missing Auth"); + + using namespace jtx; + + Env env{*this, features}; + + env.fund(XRP(400'000), gw, alice, bob); + env.close(); + + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .flags = tfMPTRequireAuth | MPTDEXFlags}); + + // Alice doesn't have the funds + { + AMM const ammAlice(env, alice, BTC(1'000), XRP(1'000), ter(tecNO_AUTH)); + } + + BTC.authorize({.holder = bob}); + env(pay(gw, bob, BTC(50))); + env.close(); + env.require(balance(bob, BTC(50))); + + // Alice should not be able to create AMM without authorization. + { + AMM const ammAlice(env, alice, BTC(1'000), XRP(1'000), ter(tecNO_AUTH)); + } + + // Finally, authorize alice. Now alice's AMM create should succeed. + BTC.authorize({.holder = alice}); + env(pay(gw, alice, BTC(1'000))); + env.close(); + + AMM const ammAlice(env, alice, BTC(1'000), XRP(1'050)); + + // Authorize AMM. + // BTC.authorize({.account = ammAlice.ammAccount()}); + // env.close(); + + // Now bob creates his offer again, which crosses with alice's AMM. + env(offer(bob, XRP(50), BTC(50))); + env.close(); + + BEAST_EXPECT(ammAlice.expectBalances(BTC(1'050), XRP(1'000), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, bob, 0)); + env.require(balance(bob, BTC(0))); + } + + void + testOffers() + { + using namespace jtx; + FeatureBitset const all{testable_amendments()}; + testRmFundedOffer(all); + testFillModes(all); + testOfferCrossWithXRP(all); + testOfferCrossWithLimitOverride(all); + testCurrencyConversionEntire(all); + testCurrencyConversionInParts(all); + testCrossCurrencyStartXRP(all); + testCrossCurrencyEndXRP(all); + testCrossCurrencyBridged(all); + testOfferFeesConsumeFunds(all); + testOfferCreateThenCross(all); + testSellFlagExceedLimit(all); + testGatewayCrossCurrency(all); + testBridgedCross(all); + testSellWithFillOrKill(all); + testTransferRateOffer(all); + testSelfIssueOffer(all); + testSellFlagBasic(all); + testDirectToDirectPath(all); + testRequireAuth(all); + testMissingAuth(all); + } + + void + path_find_consume_all() + { + testcase("path find consume all"); + using namespace jtx; + + Env env = pathTestEnv(); + env.fund(XRP(100'000'260), alice); + env.fund(XRP(30'000), gw, bob, carol); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 100'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const ammCarol(env, carol, XRP(100), ETH(100'000'000'000'000)); + + STPathSet st; + STAmount sa; + STAmount da; + std::tie(st, sa, da) = + find_paths(env, alice, bob, bob["AUD"](-1), std::optional(XRP(100'000'000))); + BEAST_EXPECT(st.empty()); + std::tie(st, sa, da) = + find_paths(env, alice, bob, ETH(-1), std::optional(XRP(100'000'000))); + // Alice sends all requested 100,000,000XRP + BEAST_EXPECT(sa == XRP(100'000'000)); + // Bob gets ~99.99e12ETH. This is the amount Bob + // can get out of AMM for 100,000,000XRP. + BEAST_EXPECT(equal(da, ETH(99'999'900'000'100))); + } + + // carol holds ETH, sells ETH for XRP + // bob will hold ETH + // alice pays bob ETH using XRP + void + via_offers_via_gateway() + { + testcase("via gateway"); + using namespace jtx; + + Env env = pathTestEnv(); + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 10'000, + .flags = MPTDEXFlags}); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 10'000, + .flags = MPTDEXFlags}); + + env(pay(gw, carol, ETH(51))); + env.close(); + AMM const ammCarol(env, carol, XRP(40), ETH(51)); + env(pay(alice, bob, ETH(10)), sendmax(XRP(100)), paths(XRP)); + env.close(); + // AMM offer is 51.282052XRP/11ETH, 11ETH/1.1 = 10ETH to bob + BEAST_EXPECT(ammCarol.expectBalances(XRP(51), ETH(40), ammCarol.tokens())); + env.require(balance(bob, ETH(10))); + + auto const result = find_paths(env, alice, bob, BTC(25)); + BEAST_EXPECT(std::get<0>(result).empty()); + } + + void + receive_max() + { + testcase("Receive max"); + using namespace jtx; + auto const charlie = Account("charlie"); + { + // XRP -> MPT receive max + Env env = pathTestEnv(); + env.fund(XRP(30'000), alice, bob, charlie, gw); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, charlie}, + .pay = 11'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const ammCharlie(env, charlie, XRP(10), ETH(11'000'000'000'000)); + auto [st, sa, da] = find_paths(env, alice, bob, ETH(-1), XRP(1).value()); + BEAST_EXPECT(sa == XRP(1)); + BEAST_EXPECT(equal(da, ETH(1'000'000'000'000))); + if (BEAST_EXPECT(st.size() == 1 && st[0].size() == 1)) + { + auto const& pathElem = st[0][0]; + BEAST_EXPECT( + pathElem.isOffer() && pathElem.getIssuerID() == gw.id() && + pathElem.getMPTID() == ETH.issuanceID()); + } + } + { + // MPT -> XRP receive max + Env env = pathTestEnv(); + env.fund(XRP(30'000), alice, bob, charlie, gw); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, charlie}, + .pay = 11'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const ammCharlie(env, charlie, XRP(11), ETH(10'000'000'000'000)); + env.close(); + auto [st, sa, da] = + find_paths(env, alice, bob, drops(-1), ETH(1'000'000'000'000).value()); + BEAST_EXPECT(sa == ETH(1'000'000'000'000)); + BEAST_EXPECT(equal(da, XRP(1))); + if (BEAST_EXPECT(st.size() == 1 && st[0].size() == 1)) + { + auto const& pathElem = st[0][0]; + BEAST_EXPECT( + pathElem.isOffer() && pathElem.getIssuerID() == xrpAccount() && + pathElem.getCurrency() == xrpCurrency()); + } + } + } + + void + path_find_01() + { + testcase("Path Find: XRP -> XRP and XRP -> MPT"); + using namespace jtx; + Env env = pathTestEnv(); + Account A1{"A1"}; + Account A2{"A2"}; + Account A3{"A3"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account G3{"G3"}; + Account M1{"M1"}; + + env.fund(XRP(100'000), A1); + env.fund(XRP(10'000), A2); + env.fund(XRP(1'000), A3, G1, G2, G3); + env.fund(XRP(20'000), M1); + env.close(); + + MPTTester const XYZ_G1( + {.env = env, .issuer = G1, .holders = {A1, M1, A2}, .flags = MPTDEXFlags}); + + MPTTester const XYZ_G2( + {.env = env, .issuer = G2, .holders = {A2, M1, A1}, .flags = MPTDEXFlags}); + + MPTTester const ABC_G3( + {.env = env, .issuer = G3, .holders = {A1, A2, M1, A3}, .flags = MPTDEXFlags}); + + MPTTester const ABC_A2( + {.env = env, .issuer = A2, .holders = {G3, A1}, .flags = MPTDEXFlags}); + + env(pay(G1, A1, XYZ_G1(3'500'000'000))); + env(pay(G3, A1, ABC_G3(1'200'000'000))); + env(pay(G1, M1, XYZ_G1(25'000'000'000))); + env(pay(G2, M1, XYZ_G2(25'000'000'000))); + env(pay(G3, M1, ABC_G3(25'000'000'000))); + env(pay(A2, G3, ABC_A2(101'000'000))); + env.close(); + + AMM const ammM1_XYZ_G1_XYZ_G2(env, M1, XYZ_G1(1'000'000'000), XYZ_G2(1'000'000'000)); + AMM const ammM1_XRP_ABC_G3(env, M1, XRP(10'000), ABC_G3(1'000'000'000)); + AMM const ammG3_ABC_G3_ABC_A2(env, G3, ABC_G3(100'000'000), ABC_A2(101'000'000)); + env.close(); + + STPathSet st; + STAmount sa, da; + + { + auto const& send_amt = XRP(10); + std::tie(st, sa, da) = find_paths(env, A1, A2, send_amt, std::nullopt, xrpCurrency()); + BEAST_EXPECT(equal(da, send_amt)); + BEAST_EXPECT(st.empty()); + } + + { + // no path should exist for this since dest account + // does not exist. + auto const& send_amt = XRP(200); + std::tie(st, sa, da) = + find_paths(env, A1, Account{"A0"}, send_amt, std::nullopt, xrpCurrency()); + BEAST_EXPECT(equal(da, send_amt)); + BEAST_EXPECT(st.empty()); + } + + { + auto const& send_amt = ABC_G3(10'000'000); + std::tie(st, sa, da) = find_paths(env, A2, G3, send_amt, std::nullopt, xrpCurrency()); + BEAST_EXPECT(equal(da, send_amt)); + BEAST_EXPECT(equal(sa, XRPAmount{101'010'102})); + BEAST_EXPECT(same(st, stpath(IPE(MPT(ABC_G3))))); + } + + { + auto const& send_amt = ABC_A2(1'000'000); + std::tie(st, sa, da) = find_paths(env, A1, A2, send_amt, std::nullopt, xrpCurrency()); + BEAST_EXPECT(equal(da, send_amt)); + BEAST_EXPECT(equal(sa, XRPAmount{10'010'011})); + BEAST_EXPECT(same(st, stpath(IPE(MPT(ABC_G3)), IPE(MPT(ABC_A2))))); + } + } + + void + path_find_02() + { + testcase("Path Find: non-XRP -> XRP"); + using namespace jtx; + Env env = pathTestEnv(); + Account A1{"A1"}; + Account A2{"A2"}; + Account const G3{"G3"}; + Account M1{"M1"}; + + env.fund(XRP(1'000), A1, A2, G3); + env.fund(XRP(11'000), M1); + env.close(); + + MPTTester const ETH( + {.env = env, + .issuer = G3, + .holders = {A1, A2, M1}, + .pay = 1'000'000'000, + .flags = MPTDEXFlags}); + + AMM const ammM1(env, M1, ETH(1'000'000'000), XRP(10'010)); + + STPathSet st; + STAmount sa, da; + + auto const& send_amt = XRP(10); + + std::tie(st, sa, da) = + find_paths_by_element(env, A1, A2, send_amt, std::nullopt, IPE(MPT(ETH))); + BEAST_EXPECT(equal(da, send_amt)); + BEAST_EXPECT(equal(sa, ETH(1'000'000))); + BEAST_EXPECT(same(st, stpath(IPE(xrpIssue())))); + } + + void + path_find_06() + { + testcase("Path Find: non-XRP -> non-XRP, same issuanceID"); + using namespace jtx; + { + Env env = pathTestEnv(); + Account A1{"A1"}; + Account A2{"A2"}; + Account const A3{"A3"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account M1{"M1"}; + + env.fund(XRP(11'000), M1); + env.fund(XRP(1'000), A1, A2, A3, G1, G2); + env.close(); + + MPTTester const HKD_G1( + {.env = env, + .issuer = G1, + .holders = {A1, M1}, + .pay = 5'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const HKD_G2( + {.env = env, + .issuer = G2, + .holders = {A2, M1}, + .pay = 5'000'000'000, + .flags = MPTDEXFlags}); + + AMM const ammM1(env, M1, HKD_G1(1'000'000'000), HKD_G2(1'010'000'000)); + + auto const& send_amt = HKD_G2(10'000'000); + STPathSet st; + STAmount sa, da; + std::tie(st, sa, da) = jtx::find_paths( + env, + G1, + A2, + send_amt, + std::nullopt, + HKD_G1.issuanceID(), + std::nullopt, + std::nullopt); + BEAST_EXPECT(equal(da, send_amt)); + BEAST_EXPECT(equal(sa, HKD_G1(10'000'000))); + BEAST_EXPECT(same(st, stpath(IPE(MPT(HKD_G2))))); + } + } + + void + testFalseDry(FeatureBitset features) + { + testcase("falseDryChanges"); + + using namespace jtx; + + Env env(*this, features); + env.memoize(bob); + + env.fund(XRP(10'000), alice, gw); + fund(env, gw, {carol}, XRP(10'000), {}, Fund::Acct); + auto const AMMXRPPool = env.current()->fees().increment * 2; + env.fund(reserve(env, 5) + ammCrtFee(env) + AMMXRPPool, bob); + env.close(); + + MPTTester const ETH( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + env(pay(gw, alice, ETH(50'000))); + env(pay(gw, bob, BTC(150'000))); + + // Bob has _just_ slightly less than 50 xrp available + // If his owner count changes, he will have more liquidity. + // This is one error case to test (when Flow is used). + // Computing the incoming xrp to the XRP/BTC offer will require two + // recursive calls to the ETH/XRP offer. The second call will return + // tecPATH_DRY, but the entire path should not be marked as dry. + // This is the second error case to test (when flowV1 is used). + env(offer(bob, ETH(50'000), XRP(50))); + AMM const ammBob(env, bob, AMMXRPPool, BTC(150'000)); + + env(pay(alice, carol, BTC(1'000'000'000)), + path(~XRP, ~MPT(BTC)), + sendmax(ETH(500'000)), + txflags(tfNoRippleDirect | tfPartialPayment)); + + auto const carolBTC = env.balance(carol, MPT(BTC)); + BEAST_EXPECT(carolBTC > BTC(0) && carolBTC < BTC(50'000)); + } + + void + testBookStep(FeatureBitset features) + { + testcase("Book Step"); + + using namespace jtx; + + // simple MPT/IOU mix offer + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + auto const ETH = issue1( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000'000}); + env(pay(gw, alice, BTC(500000))); + env(pay(gw, bob, BTC(500000))); + env(pay(gw, carol, BTC(500000))); + env(pay(gw, alice, ETH(500000))); + env(pay(gw, bob, ETH(500000))); + env(pay(gw, carol, ETH(500000))); + env.close(); + AMM const ammBob(env, bob, BTC(100'000), ETH(150'000)); + + env(pay(alice, carol, ETH(50'000)), path(~ETH), sendmax(BTC(50'000))); + + env.require(balance(alice, BTC(450'000))); + env.require(balance(bob, BTC(400'000))); + env.require(balance(bob, ETH(350'000))); + env.require(balance(carol, ETH(550'000))); + BEAST_EXPECT(ammBob.expectBalances(BTC(150'000), ETH(100'000), ammBob.tokens())); + }; + testHelper2TokensMix(test); + } + + { + // simple MPT/XRP XRP/MPT offer + Env env(*this, features); + env.fund(XRP(10'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 100'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 150'000, + .flags = MPTDEXFlags}); + + AMM const ammBobBTC_XRP(env, bob, BTC(100'000), XRP(150)); + AMM const ammBobXRP_ETH(env, bob, XRP(100), ETH(150'000)); + + env(pay(alice, carol, ETH(50'000)), path(~XRP, ~MPT(ETH)), sendmax(BTC(50'000))); + + env.require(balance(alice, BTC(50'000))); + env.require(balance(bob, BTC(0))); + env.require(balance(bob, ETH(0))); + env.require(balance(carol, ETH(200'000))); + BEAST_EXPECT( + ammBobBTC_XRP.expectBalances(BTC(150'000), XRP(100), ammBobBTC_XRP.tokens())); + BEAST_EXPECT( + ammBobXRP_ETH.expectBalances(XRP(150), ETH(100'000), ammBobXRP_ETH.tokens())); + } + { + // simple XRP -> MPT through offer and sendmax + Env env(*this, features); + XRPAmount const baseFee{env.current()->fees().base}; + env.fund(XRP(10'000), gw, alice, bob, carol); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 150'000, + .flags = MPTDEXFlags}); + + AMM const ammBob(env, bob, XRP(100), ETH(150'000)); + + env(pay(alice, carol, ETH(50'000)), path(~MPT(ETH)), sendmax(XRP(50))); + BEAST_EXPECT(expectLedgerEntryRoot(env, alice, XRP(10'000) - XRP(50) - 2 * baseFee)); + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(10'000) - XRP(100) - ammCrtFee(env) - baseFee)); + env.require(balance(bob, ETH(0))); + env.require(balance(carol, ETH(200'000))); + BEAST_EXPECT(ammBob.expectBalances(XRP(150), ETH(100'000), ammBob.tokens())); + } + { + // simple MPT -> XRP through offer and sendmax + Env env(*this, features); + XRPAmount const baseFee{env.current()->fees().base}; + env.fund(XRP(10'000), gw, alice, bob, carol); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 100'000, + .flags = MPTDEXFlags}); + + AMM const ammBob(env, bob, ETH(100'000), XRP(150)); + + env(pay(alice, carol, XRP(50)), path(~XRP), sendmax(ETH(50'000))); + + env.require(balance(alice, ETH(50'000))); + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(10'000) - XRP(150) - ammCrtFee(env) - baseFee)); + env.require(balance(bob, ETH(0))); + BEAST_EXPECT(expectLedgerEntryRoot(env, carol, XRP(10'000 + 50) - baseFee)); + BEAST_EXPECT(ammBob.expectBalances(ETH(150'000), XRP(100), ammBob.tokens())); + } + + // test unfunded offers are removed when payment succeeds + { + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env(*this, features); + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + auto const BTC = issue1( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1000'000000}); + auto const ETH = issue2( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1000'000000}); + auto const GBP = issue3( + {.env = env, + .token = "GBP", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1000'000000}); + + env(pay(gw, alice, BTC(60'000))); + env(pay(gw, bob, ETH(200'000))); + env(pay(gw, bob, GBP(150'000))); + env(offer(bob, BTC(50'000), ETH(50'000))); + env(offer(bob, BTC(40'000), GBP(50'000))); + env.close(); + AMM const ammBob(env, bob, GBP(100'000), ETH(150'000)); + + // unfund offer + env(pay(bob, gw, GBP(50'000))); + BEAST_EXPECT(isOffer(env, bob, BTC(50'000), ETH(50'000))); + BEAST_EXPECT(isOffer(env, bob, BTC(40'000), GBP(50'000))); + env(pay(alice, carol, ETH(50'000)), + path(~ETH), + path(~GBP, ~ETH), + sendmax(BTC(60'000))); + env.require(balance(alice, BTC(10'000))); + env.require(balance(bob, BTC(50'000))); + env.require(balance(bob, ETH(0))); + env.require(balance(bob, GBP(0))); + env.require(balance(carol, ETH(50'000))); + // used in the payment + BEAST_EXPECT(!isOffer(env, bob, BTC(50'000), ETH(50'000))); + // found unfunded + BEAST_EXPECT(!isOffer(env, bob, BTC(40'000), GBP(50'000))); + // unchanged + BEAST_EXPECT(ammBob.expectBalances(GBP(100'000), ETH(150'000), ammBob.tokens())); + }; + testHelper3TokensMix(test); + } + + { + // test unfunded offers are removed when the payment fails. + // bob makes two offers: a funded 50'000'000 ETH for 50'000'000 BTC + // and an unfunded 50'000'000 GBP for 60'000'000 BTC. alice pays + // carol 61'000'000 ETH with 61'000'000 BTC. alice only has + // 60'000'000 BTC, so the payment will fail. The payment uses two + // paths: one through bob's funded offer and one through his + // unfunded offer. When the payment fails `flow` should return the + // unfunded offer. This test is intentionally similar to the one + // that removes unfunded offers when the payment succeeds. + Env env(*this, features); + + env.fund(XRP(10'000), bob, carol, gw); + env.close(); + // Sets rippling on, this is different from + // the original test + fund(env, gw, {alice}, XRP(10'000), {}, Fund::Acct); + + MPTTester BTC( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + MPTTester ETH( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + MPTTester GBP( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + env(pay(gw, alice, BTC(60'000'000))); + env(pay(gw, bob, BTC(100'000'000))); + env(pay(gw, bob, ETH(100'000'000))); + env(pay(gw, bob, GBP(50'000'000))); + env(pay(gw, carol, GBP(1'000'000))); + env.close(); + + // This is multiplath, which generates limited # of offers + AMM const ammBobBTC_ETH(env, bob, BTC(50'000'000), ETH(50'000'000)); + env(offer(bob, BTC(60'000'000), GBP(50'000'000))); + env(offer(carol, BTC(1'000'000'000), GBP(1'000'000))); + env(offer(bob, GBP(50'000'000), ETH(50'000'000))); + + // unfund offer + env(pay(bob, gw, GBP(50'000'000))); + BEAST_EXPECT(ammBobBTC_ETH.expectBalances( + BTC(50'000'000), ETH(50'000'000), ammBobBTC_ETH.tokens())); + BEAST_EXPECT(isOffer(env, bob, BTC(60'000'000), GBP(50'000'000))); + BEAST_EXPECT(isOffer(env, carol, BTC(1'000'000'000), GBP(1'000'000))); + BEAST_EXPECT(isOffer(env, bob, GBP(50'000'000), ETH(50'000'000))); + + auto flowJournal = env.app().getLogs().journal("Flow"); + auto const flowResult = [&] { + STAmount const deliver(ETH(51'000'000)); + STAmount smax(BTC(61'000'000)); + PaymentSandbox sb(env.current().get(), tapNONE); + STPathSet paths; + auto IPE = [](MPTTester const& iss) { + return STPathElement( + STPathElement::typeMPT | STPathElement::typeIssuer, + xrpAccount(), + PathAsset{iss.issuanceID()}, + iss.issuer()); + }; + { + // BTC -> ETH + STPath const p1({IPE(ETH)}); + paths.push_back(p1); + // BTC -> GBP -> ETH + STPath const p2({IPE(GBP), IPE(ETH)}); + paths.push_back(p2); + } + + return flow( + sb, + deliver, + alice, + carol, + paths, + false, + false, + true, + OfferCrossing::no, + std::nullopt, + smax, + std::nullopt, + flowJournal); + }(); + + BEAST_EXPECT(flowResult.removableOffers.size() == 1); + env.app().getOpenLedger().modify([&](OpenView& view, beast::Journal j) { + if (flowResult.removableOffers.empty()) + return false; + Sandbox sb(&view, tapNONE); + for (auto const& o : flowResult.removableOffers) + { + if (auto ok = sb.peek(keylet::offer(o))) + { + offerDelete(sb, ok, flowJournal); + } + } + sb.apply(view); + return true; + }); + + // used in payment, but since payment failed should be untouched + BEAST_EXPECT(ammBobBTC_ETH.expectBalances( + BTC(50'000'000), ETH(50'000'000), ammBobBTC_ETH.tokens())); + BEAST_EXPECT(isOffer(env, carol, BTC(1'000'000'000), GBP(1'000'000))); + // found unfunded + BEAST_EXPECT(!isOffer(env, bob, BTC(60'000'000), GBP(50'000'000))); + } + { + // Do not produce more in the forward pass than the reverse pass + // This test uses a path that whose reverse pass will compute a + // 500 ETH input required for a 1'000 BTC output. It sets a sendmax + // of 400 ETH, so the payment engine will need to do a forward + // pass. Without limits, the 400 ETH would produce 1'000 BTC in + // the forward pass. This test checks that the payment produces + // 1'000 BTC, as expected. + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + auto const ETH = issue1( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 10'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 10'000'000}); + + env(pay(gw, alice, ETH(1'000'000))); + env(pay(gw, bob, BTC(1'000'000))); + env(pay(gw, bob, ETH(1'000'000))); + env.close(); + + AMM const ammBob(env, bob, ETH(8'000), XRPAmount{21}); + env(offer(bob, drops(1), BTC(1'000'000)), txflags(tfPassive)); + + env(pay(alice, carol, BTC(1'000)), + path(~XRP, ~BTC), + sendmax(ETH(400)), + txflags(tfNoRippleDirect | tfPartialPayment)); + + env.require(balance(carol, BTC(1'000))); + BEAST_EXPECT(ammBob.expectBalances(ETH(8400), XRPAmount{20}, ammBob.tokens())); + }; + testHelper2TokensMix(test); + } + } + + void + testTransferRateNoOwnerFee(FeatureBitset features) + { + testcase("No Owner Fee"); + using namespace jtx; + + { + // payment via AMM + Env env(*this, features); + env.fund(XRP(1'000), gw, alice, bob, carol); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const amm(env, bob, GBP(1'000'000'000'000'000), BTC(1'000'000'000'000'000)); + + env(pay(alice, carol, BTC(100'000'000'000'000)), + path(~MPT(BTC)), + sendmax(GBP(150'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment)); + env.close(); + + // alice buys 107.1428e12BTC with 120e12GBP and pays 25% tr fee on + // 120e12GBP 1,000e12 - 120e12*1.25 = 850e12GBP + env.require(balance(alice, GBP(850'000'000'000'000))); + + BEAST_EXPECT(amm.expectBalances( + GBP(1'120'000'000'000'000), BTC(892'857'142'857'143), amm.tokens())); + + // 25% of 85.7142e12BTC is paid in tr fee + // 85.7142e12*1.25 = 107.1428e12BTC + env.require(balance(carol, BTC(1'085'714'285'714'285))); + } + { + // Payment via offer and AMM + Env env(*this, features); + Account const ed("ed"); + + env.fund(XRP(1'000), gw, alice, bob, carol, ed); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + env(offer(ed, GBP(1'000'000'000'000'000), ETH(1'000'000'000'000'000)), + txflags(tfPassive)); + env.close(); + + AMM const amm(env, bob, ETH(1'000'000'000'000'000), BTC(1'000'000'000'000'000)); + + env(pay(alice, carol, BTC(100'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(GBP(150'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment)); + env.close(); + + // alice buys 120e12ETH with 120e12GBP via the offer + // and pays 25% tr fee on 120e12GBP + // 1,000e12 - 120e12*1.25 = 850e12GBP + env.require(balance(alice, GBP(850'000'000'000'000))); + // consumed offer is 120e12GBP/120e12ETH + // ed doesn't pay tr fee + env.require(balance(ed, ETH(880'000'000'000'000))); + env.require(balance(ed, GBP(1'120'000'000'000'000))); + BEAST_EXPECT(expectOffers( + env, ed, 1, {Amounts{GBP(880'000'000'000'000), ETH(880'000'000'000'000)}})); + // 25% on 96e12ETH is paid in tr fee 96e12*1.25 = 120e12ETH + // 96e12ETH is swapped in for 87.5912e12BTC + BEAST_EXPECT(amm.expectBalances( + ETH(1'096'000'000'000'000), BTC(912'408'759'124'088), amm.tokens())); + // 25% on 70.0729e12BTC is paid in tr fee 70.0729e12*1.25 + // = 87.5912e12BTC + env.require(balance(carol, BTC(1'070'072'992'700'729))); + } + { + // Payment via AMM, AMM + Env env(*this, features); + Account const ed("ed"); + + env.fund(XRP(1'000), gw, alice, bob, carol, ed); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const amm1(env, bob, GBP(1'000'000'000'000'000), ETH(1'000'000'000'000'000)); + AMM const amm2(env, ed, ETH(1'000'000'000'000'000), BTC(1'000'000'000'000'000)); + + env(pay(alice, carol, BTC(100'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(GBP(150'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment)); + env.close(); + + env.require(balance(alice, GBP(850'000'000'000'000))); + + // alice buys 107.1428e12ETH with 120e12GBP and pays 25% tr fee on + // 120e12GBP 1,000e12 - 120e12*1.25 = 850e12GBP 120e12GBP is swapped + // in for 107.1428e12ETH + BEAST_EXPECT(amm1.expectBalances( + GBP(1'120'000'000'000'000), ETH(892'857'142'857'143), amm1.tokens())); + // 25% on 85.7142e12ETH is paid in tr fee 85.7142e12*1.25 = + // 107.1428e12ETH 85.7142e12ETH is swapped in for 78.9473e12BTC + BEAST_EXPECT(amm2.expectBalances( + ETH(1'085'714'285'714'285), BTC(921'052'631'578'948), amm2.tokens())); + + // 25% on 63.1578e12BTC is paid in tr fee 63.1578e12*1.25 + // = 78.9473e12BTC + env.require(balance(carol, BTC(1'063'157'894'736'841))); + } + { + // AMM offer crossing + Env env(*this, features); + + env.fund(XRP(1'000), gw, alice, bob); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .transferFee = 25'000, + .pay = 1'100'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .transferFee = 25'000, + .pay = 1'100'000, + .flags = MPTDEXFlags}); + + AMM const amm(env, bob, BTC(1'000'000), ETH(1'100'000)); + env(offer(alice, ETH(100'000), BTC(100'000))); + env.close(); + + // 100e3BTC is swapped in for 100e3ETH + BEAST_EXPECT(amm.expectBalances(BTC(1'100'000), ETH(1'000'000), amm.tokens())); + // alice pays 25% tr fee on 100e3BTC 1100e3-100e3*1.25 = 975e3BTC + env.require(balance(alice, BTC(975'000))); + env.require(balance(alice, ETH(1'200'000))); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + { + // Payment via AMM with limit quality + Env env(*this, features); + + env.fund(XRP(1'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'000'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const amm(env, bob, GBP(1'000'000'000'000'000), BTC(1'000'000'000'000'000)); + + // requested quality limit is 100e12BTC/178.58e12GBP = 0.55997 + // trade quality is 100e12BTC/178.5714 = 0.55999e12 + env(pay(alice, carol, BTC(100'000'000'000'000)), + path(~MPT(BTC)), + sendmax(GBP(178'580'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + + // alice buys 125e12BTC with 142.8571e12GBP and pays 25% tr fee + // on 142.8571e12GBP + // 1,000e12 - 142.8571e12*1.25 = 821.4285e12GBP + env.require(balance(alice, GBP(821'428'571'428'571))); + // 142.8571e12GBP is swapped in for 125e12BTC + BEAST_EXPECT(amm.expectBalances( + GBP(1'142'857'142'857'143), BTC(875'000'000'000'000), amm.tokens())); + // 25% on 100e12BTC is paid in tr fee + // 100e12*1.25 = 125e12BTC + env.require(balance(carol, BTC(1'100'000'000'000'000))); + } + { + // Payment via AMM with limit quality, deliver less + // than requested + Env env(*this, features); + + env.fund(XRP(1'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'200'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'200'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const amm(env, bob, GBP(1'000'000'000'000'000), BTC(1'200'000'000'000'000)); + + // requested quality limit is 90e12BTC/120e12GBP = 0.75 + // trade quality is 22.5e12BTC/30e12GBP = 0.75 + env(pay(alice, carol, BTC(90'000'000'000'000)), + path(~MPT(BTC)), + sendmax(GBP(120'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + + // alice buys 28.125e12BTC with 24e12GBP and pays 25% tr fee + // on 24e12GBP + // 1,200e12 - 24e12*1.25 =~ 1,170e12GBP + env.require(balance(alice, GBP(1'170'000'000'000'000))); + // 24e12GBP is swapped in for 28.125e12BTC + BEAST_EXPECT(amm.expectBalances( + GBP(1'024'000'000'000'000), BTC(1'171'875'000'000'000), amm.tokens())); + + // 25% on 22.5e12BTC is paid in tr fee + // 22.5*1.25 = 28.125e12BTC + env.require(balance(carol, BTC(1'222'500'000'000'000))); + } + { + // Payment via offer and AMM with limit quality, deliver less + // than requested + Env env(*this, features); + Account const ed("ed"); + + env.fund(XRP(1'000), gw, alice, bob, carol, ed); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + env(offer(ed, GBP(1'000'000'000'000'000), ETH(1'000'000'000'000'000)), + txflags(tfPassive)); + env.close(); + + AMM const amm(env, bob, ETH(1'000'000'000'000'000), BTC(1'400'000'000'000'000)); + + // requested quality limit is 95e12BTC/140e12GBP = 0.6785 + // trade quality is 59.7321e12BTC/88.0262e12GBP = 0.6785 + env(pay(alice, carol, BTC(95'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(GBP(140'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + + // alice buys 70.4210e12ETH with 70.4210e12GBP via the offer + // and pays 25% tr fee on 70.4210e12GBP + // 1,400e12 - 70.4210e12*1.25 = 1400e12 - 88.0262e12 = + // 1311.9736e12GBP + env.require(balance(alice, GBP(1'311'973'684'210'525))); + // ed doesn't pay tr fee, the balances reflect consumed offer + // 70.4210e12GBP/70.4210e12ETH + env.require(balance(ed, ETH(1'329'578'947'368'420))); + env.require(balance(ed, GBP(1'470'421'052'631'580))); + BEAST_EXPECT(expectOffers( + env, ed, 1, {Amounts{GBP(929'578'947'368'420), ETH(929'578'947'368'420)}})); + // 25% on 56.3368e12ETH is paid in tr fee 56.3368e12*1.25 + // = 70.4210e12ETH 56.3368e12ETH is swapped in for 74.6651e12BTC + BEAST_EXPECT(amm.expectBalances( + ETH(1'056'336'842'105'264), BTC(1'325'334'821'428'571), amm.tokens())); + + // 25% on 59.7321e12BTC is paid in tr fee 59.7321e12*1.25 + // = 74.6651e12BTC + env.require(balance(carol, BTC(1'459'732'142'857'143))); + } + { + // Payment via AMM and offer with limit quality, deliver less + // than requested + Env env(*this, features); + Account const ed("ed"); + + env.fund(XRP(1'000), gw, alice, bob, carol, ed); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const amm(env, bob, GBP(1'000'000'000'000'000), ETH(1'000'000'000'000'000)); + + env(offer(ed, ETH(1'000'000'000'000'000), BTC(1'400'000'000'000'000)), + txflags(tfPassive)); + env.close(); + + // requested quality limit is 95e12BTC/140e12GBP = 0.6785 + // trade quality is 47.7857e12BTC/70.4210e12GBP = 0.6785 + env(pay(alice, carol, BTC(95'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(GBP(140'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + + // alice buys 53.3322e12ETH with 56.3368e12GBP via the amm + // and pays 25% tr fee on 56.3368e12GBP + // 1,400e12 - 56.3368e12*1.25 = 1400e12 - 70.4210e12 = + // 1329.5789e12GBP + env.require(balance(alice, GBP(1'329'578'947'368'420))); + //// 25% on 56.3368e12ETH is paid in tr fee 56.3368e12*1.25 + ///= 70.4210e12ETH + // 56.3368e12GBP is swapped in for 53.3322e12ETH + BEAST_EXPECT(amm.expectBalances( + GBP(1'056'336'842'105'264), ETH(946'667'729'591'836), amm.tokens())); + + // 25% on 42.6658e12ETH is paid in tr fee 42.6658e12*1.25 + // = 53.3322e12ETH 42.6658e12ETH/59.7321e12BTC + env.require(balance(ed, BTC(1'340'267'857'142'857))); + env.require(balance(ed, ETH(1'442'665'816'326'531))); + BEAST_EXPECT(expectOffers( + env, ed, 1, {Amounts{ETH(957'334'183'673'469), BTC(1'340'267'857'142'857)}})); + // 25% on 47.7857e12BTC is paid in tr fee 47.7857e12*1.25 + // = 59.7321e12BTC + env.require(balance(carol, BTC(1'447'785714285714))); + } + { + // Payment via AMM, AMM with limit quality, deliver less + // than requested + Env env(*this, features); + Account const ed("ed"); + + env.fund(XRP(1'000), gw, alice, bob, carol, ed); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const amm1(env, bob, GBP(1'000'000'000'000'000), ETH(1'000'000'000'000'000)); + AMM const amm2(env, ed, ETH(1'000'000'000'000'000), BTC(1'400'000'000'000'000)); + + // requested quality limit is 90e12BTC/145e12GBP = 0.6206 + // trade quality is 66.7432e12BTC/107.5308e12GBP = 0.6206 + env(pay(alice, carol, BTC(90'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(GBP(145'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + + // alice buys 53.3322e12ETH with 107.5308e12GBP + // 25% on 86.0246e12GBP is paid in tr fee + // 1,400e12 - 86.0246e12*1.25 = 1400e12 - 107.5308e12 = + // 1229.4691e12GBP + env.require(balance(alice, GBP(1'292'469'135'802'465))); + // 86.0246e12GBP is swapped in for 79.2106e12ETH + BEAST_EXPECT(amm1.expectBalances( + GBP(1'086'024'691'358'028), ETH(920'789'377'955'618), amm1.tokens())); + // 25% on 63.3684e12ETH is paid in tr fee 63.3684e12*1.25 + // = 79.2106e12ETH 63.3684e12ETH is swapped in for 83.4291e12BTC + BEAST_EXPECT(amm2.expectBalances( + ETH(1'063'368'497'635'505), BTC(1'316'570'881'226'053), amm2.tokens())); + + // 25% on 66.7432e12BTC is paid in tr fee 66.7432e12*1.25 + // = 83.4291e12BTC + env.require(balance(carol, BTC(1'466'743'295'019'157))); + } + { + // Payment by the issuer via AMM, AMM with limit quality, + // deliver less than requested + Env env(*this, features); + + env.fund(XRP(1'000), gw, alice, bob, carol); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 1'400'000'000'000'000, + .flags = MPTDEXFlags}); + + AMM const amm1(env, alice, GBP(1'000'000'000'000'000), ETH(1'000'000'000'000'000)); + AMM const amm2(env, bob, ETH(1'000'000'000'000'000), BTC(1'400'000'000'000'000)); + + // requested quality limit is 90e12BTC/120e12GBP = 0.75 + // trade quality is 81.1111e12BTC/108.1481e12GBP = 0.75 + env(pay(gw, carol, BTC(90'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(GBP(120'000'000'000'000)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + + // 108.1481e12GBP is swapped in for 97.5935e12ETH + BEAST_EXPECT(amm1.expectBalances( + GBP(1'108'148'148'148'150), ETH(902'406'417'112'298), amm1.tokens())); + // 25% on 78.0748e12ETH is paid in tr fee 78.0748e12*1.25 + // = 97.5935e12ETH 78.0748e12ETH is swapped in for 101.3888e12BTC + BEAST_EXPECT(amm2.expectBalances( + ETH(1'078'074'866'310'161), BTC(1'298'611'111'111'111), amm2.tokens())); + + // 25% on 81.1111e12BTC is paid in tr fee 81.1111e12*1.25 = + // 101.3888e12BTC + env.require(balance(carol, BTC(1'481'111'111'111'111))); + } + } + + void + testLimitQuality() + { + // Single path with amm, offer, and limit quality. The quality limit + // is such that the first offer should be taken but the second + // should not. The total amount delivered should be the sum of the + // two offers and sendMax should be more than the first offer. + testcase("limitQuality"); + using namespace jtx; + + { + Env env(*this); + env.fund(XRP(10'000), gw, alice, bob, carol); + + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 2'000'000, + .flags = MPTDEXFlags}); + + AMM const ammBob(env, bob, XRP(1'000), ETH(1'050'000)); + env(offer(bob, XRP(100), ETH(50'000))); + + env(pay(alice, carol, ETH(100'000)), + path(~MPT(ETH)), + sendmax(XRP(100)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + + BEAST_EXPECT(ammBob.expectBalances(XRP(1'050), ETH(1'000'000), ammBob.tokens())); + env.require(balance(carol, ETH(2'050'000))); + BEAST_EXPECT(expectOffers(env, bob, 1, {{{XRP(100), ETH(50'000)}}})); + } + } + + void + testXRPPathLoop() + { + testcase("Circular XRP"); + + using namespace jtx; + + // Payment path starting with XRP + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, gw); + env.close(); + auto const ETH = issue1( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob}, + .limit = 2000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob}, + .limit = 2000'000}); + + env(pay(gw, alice, BTC(200'000))); + env(pay(gw, bob, BTC(200'000))); + env(pay(gw, alice, ETH(200'000))); + env(pay(gw, bob, ETH(200'000))); + env.close(); + + AMM const ammAliceXRP_BTC(env, alice, XRP(100), BTC(101'000)); + AMM const ammAliceXRP_ETH(env, alice, XRP(100), ETH(101'000)); + env(pay(alice, bob, ETH(1'000)), + path(~BTC, ~XRP, ~ETH), + sendmax(XRP(1)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper2TokensMix(test); + } + + // Payment path ending with XRP + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, gw); + env.close(); + auto const ETH = issue1( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob}, + .limit = 2000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob}, + .limit = 2000'000}); + + env(pay(gw, alice, BTC(200'000))); + env(pay(gw, bob, BTC(200'000))); + env(pay(gw, alice, ETH(200'000))); + env(pay(gw, bob, ETH(200'000))); + env.close(); + + AMM const ammAliceXRP_BTC(env, alice, XRP(100), BTC(100'000)); + AMM const ammAliceXRP_ETH(env, alice, XRP(100), ETH(100'000)); + // ETH -> //XRP -> //BTC ->XRP + env(pay(alice, bob, XRP(1)), + path(~XRP, ~BTC, ~XRP), + sendmax(ETH(1'000)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper2TokensMix(test); + } + + // Payment where loop is formed in the middle of the path, not + // on an endpoint + { + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env(*this); + env.fund(XRP(10'000), gw, alice, bob); + env.close(); + auto const ETH = issue1( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob}, + .limit = 2000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob}, + .limit = 2000'000}); + auto const JPY = issue2( + {.env = env, + .token = "JPY", + .issuer = gw, + .holders = {alice, bob}, + .limit = 2000'000}); + + env(pay(gw, alice, BTC(200'000))); + env(pay(gw, bob, BTC(200'000))); + env(pay(gw, alice, ETH(200'000))); + env(pay(gw, bob, ETH(200'000))); + env(pay(gw, alice, JPY(200'000))); + env(pay(gw, bob, JPY(200'000))); + env.close(); + + AMM const ammAliceXRP_BTC(env, alice, XRP(100), BTC(100'000)); + AMM const ammAliceXRP_ETH(env, alice, XRP(100), ETH(100'000)); + AMM const ammAliceXRP_JPY(env, alice, XRP(100), JPY(100'000)); + + env(pay(alice, bob, JPY(1'000)), + path(~XRP, ~ETH, ~XRP, ~JPY), + sendmax(BTC(1'000)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper3TokensMix(test); + } + } + + void + testStepLimit(FeatureBitset features) + { + testcase("Step Limit"); + + using namespace jtx; + { + Env env(*this, features); + auto const dan = Account("dan"); + auto const ed = Account("ed"); + + env.fund(XRP(100'000'000), gw, alice, bob, carol, dan, ed); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {bob, dan, ed}, .flags = MPTDEXFlags}); + + env(pay(gw, ed, BTC(11'000'000'000'000))); + env(pay(gw, bob, BTC(1'000'000'000'000))); + env(pay(gw, dan, BTC(1'000'000'000'000))); + + n_offers(env, 2'000, bob, XRP(1), BTC(1'000'000'000'000)); + n_offers(env, 1, dan, XRP(1), BTC(1'000'000'000'000)); + AMM const ammEd(env, ed, XRP(9), BTC(11'000'000'000'000)); + + // Alice offers to buy 1000 XRP for 1000e12 BTC. She takes Bob's + // first offer, removes 999 more as unfunded, then hits the step + // limit. + env(offer(alice, BTC(1'000'000'000'000'000), XRP(1'000))); + env.require(balance(alice, BTC(2'050'125'257'867))); + env.require(owners(alice, 2)); + env.require(balance(bob, BTC(0))); + env.require(owners(bob, 1'001)); + env.require(balance(dan, BTC(1'000'000'000'000))); + env.require(owners(dan, 2)); + + // Carol offers to buy 1000 XRP for 1000e12 BTC. She removes Bob's + // next 1000 offers as unfunded and hits the step limit. + env(offer(carol, BTC(1'000'000'000'000'000), XRP(1'000))); + env.require(balance(carol, MPT(BTC)(none))); + env.require(owners(carol, 1)); + env.require(balance(bob, BTC(0))); + env.require(owners(bob, 1)); + env.require(balance(dan, BTC(1'000'000'000'000))); + env.require(owners(dan, 2)); + } + + // MPT/IOU, similar to the case above + { + Env env(*this, features); + auto const dan = Account("dan"); + auto const ed = Account("ed"); + + env.fund(XRP(100'000), gw, alice, bob, carol, dan, ed); + env.close(); + + MPTTester const USD( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, ed}, + .pay = 10000'000'000, + .flags = MPTDEXFlags}); + + env.trust(BTC(11'000'000'000'000), ed); + env(pay(gw, ed, BTC(11'000'000'000'000))); + env.trust(BTC(1'000'000'000'000), bob); + env(pay(gw, bob, BTC(1'000'000'000'000))); + env.trust(BTC(1'000'000'000'000), dan); + env(pay(gw, dan, BTC(1'000'000'000'000))); + env.close(); + + n_offers(env, 2'000, bob, USD(1000000), BTC(1'000'000'000'000)); + n_offers(env, 1, dan, USD(1000000), BTC(1'000'000'000'000)); + AMM const ammEd(env, ed, USD(9000000), BTC(11'000'000'000'000)); + env(offer(alice, BTC(1'000'000'000'000'000), USD(1'000000000))); + + env.require(balance(alice, STAmount{BTC, UINT64_C(2050125257867'587), -3})); + env.require(owners(alice, 3)); + env.require(balance(bob, BTC(0))); + env.require(owners(bob, 1'002)); + env.require(balance(dan, BTC(1000000000000))); + env.require(owners(dan, 3)); + } + + // IOU/MPT, similar to the case above + { + Env env(*this, features); + auto const dan = Account("dan"); + auto const ed = Account("ed"); + + env.fund(XRP(100'000), gw, alice, bob, carol, dan, ed); + env.close(); + + env.trust(USD(10000'000'000), alice); + env(pay(gw, alice, USD(10000'000'000))); + env.trust(USD(10000'000'000), bob); + env(pay(gw, bob, USD(10000'000'000))); + env.trust(USD(10000'000'000), carol); + env(pay(gw, carol, USD(10000'000'000))); + env.trust(USD(10000'000'000), dan); + env(pay(gw, dan, USD(10000'000'000))); + env.trust(USD(10000'000'000), ed); + env(pay(gw, ed, USD(10000'000'000))); + env.close(); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {bob, dan, ed}, .flags = MPTDEXFlags}); + + env(pay(gw, ed, BTC(11'000'000'000'000))); + env(pay(gw, bob, BTC(1'000'000'000'000))); + env(pay(gw, dan, BTC(1'000'000'000'000))); + env.close(); + + n_offers(env, 2'000, bob, USD(1000000), BTC(1'000'000'000'000)); + n_offers(env, 1, dan, USD(1000000), BTC(1'000'000'000'000)); + AMM const ammEd(env, ed, USD(9000000), BTC(11'000'000'000'000)); + env(offer(alice, BTC(1'000'000'000'000'000), USD(1'000000000))); + + env.require(balance(alice, BTC(2050125628933))); + env.require(owners(alice, 3)); + env.require(balance(bob, BTC(0))); + env.require(owners(bob, 1'002)); + env.require(balance(dan, BTC(1000000000000))); + env.require(owners(dan, 3)); + } + + // MPT/MPT, similar to the case above + { + Env env(*this, features); + auto const dan = Account("dan"); + auto const ed = Account("ed"); + + env.fund(XRP(100'000), gw, alice, bob, carol, dan, ed); + env.close(); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {bob, dan, ed}, .flags = MPTDEXFlags}); + MPTTester const USD( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, ed}, + .pay = 10000'000'000, + .flags = MPTDEXFlags}); + + env(pay(gw, ed, BTC(11'000'000'000'000))); + env(pay(gw, bob, BTC(1'000'000'000'000))); + env(pay(gw, dan, BTC(1'000'000'000'000))); + env.close(); + + n_offers(env, 2'000, bob, USD(1000000), BTC(1'000'000'000'000)); + n_offers(env, 1, dan, USD(1000000), BTC(1'000'000'000'000)); + AMM const ammEd(env, ed, USD(9000000), BTC(11'000'000'000'000)); + env(offer(alice, BTC(1'000'000'000'000'000), USD(1'000000000))); + + env.require(balance(alice, BTC(2050125257867))); + env.require(owners(alice, 3)); + env.require(balance(bob, BTC(0))); + env.require(owners(bob, 1'002)); + env.require(balance(dan, BTC(1000000000000))); + env.require(owners(dan, 3)); + } + } + + void + test_convert_all_of_an_asset(FeatureBitset features) + { + testcase("Convert all of an asset using DeliverMin"); + + using namespace jtx; + + { + Env env(*this, features); + fund(env, gw, {alice, bob, carol}, XRP(10'000)); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + env(pay(alice, bob, BTC(10'000)), deliver_min(BTC(10'000)), ter(temBAD_AMOUNT)); + env(pay(alice, bob, BTC(10'000)), + deliver_min(BTC(-5'000)), + txflags(tfPartialPayment), + ter(temBAD_AMOUNT)); + env(pay(alice, bob, BTC(10'000)), + deliver_min(XRP(5)), + txflags(tfPartialPayment), + ter(temBAD_AMOUNT)); + env(pay(alice, bob, BTC(10'000)), + deliver_min(BTC(5'000)), + txflags(tfPartialPayment), + ter(tecPATH_DRY)); + env(pay(alice, bob, BTC(10'000)), + deliver_min(BTC(15'000)), + txflags(tfPartialPayment), + ter(temBAD_AMOUNT)); + env(pay(gw, carol, BTC(50'000))); + AMM const ammCarol(env, carol, XRP(10), BTC(15'000)); + env(pay(alice, bob, BTC(10'000)), + paths(XRP), + deliver_min(BTC(7'000)), + txflags(tfPartialPayment), + sendmax(XRP(5)), + ter(tecPATH_PARTIAL)); + env.require( + balance(alice, drops(10'000'000'000 - (3 * env.current()->fees().base.drops())))); + env.require(balance(bob, drops(10'000'000'000 - env.current()->fees().base.drops()))); + } + + { + Env env(*this, features); + fund(env, gw, {alice, bob}, XRP(10'000)); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob}, .flags = MPTDEXFlags}); + + env(pay(gw, bob, BTC(1'100'000))); + AMM const ammBob(env, bob, XRP(1'000), BTC(1'100'000)); + env(pay(alice, alice, BTC(10'000'000)), + paths(XRP), + deliver_min(BTC(100'000)), + txflags(tfPartialPayment), + sendmax(XRP(100))); + env.require(balance(alice, BTC(100'000))); + } + + // IOU/MPT mix, similar to the above case + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 3000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + + env(pay(gw, alice, USD(10'000))); + env(pay(gw, bob, USD(10'000))); + env(pay(gw, bob, BTC(1'200))); + env.close(); + + AMM const ammBob(env, bob, USD(1'000), BTC(1'100)); + env(pay(alice, alice, BTC(10'000)), + paths(USD), + deliver_min(BTC(100)), + txflags(tfPartialPayment), + sendmax(USD(100))); + env.require(balance(alice, BTC(100))); + }; + testHelper2TokensMix(test); + } + + { + Env env(*this, features); + fund(env, gw, {alice, bob, carol}, XRP(10'000)); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {bob, carol}, .flags = MPTDEXFlags}); + + env(pay(gw, bob, BTC(1'200'000))); + AMM const ammBob(env, bob, XRP(5'500), BTC(1'200'000)); + env(pay(alice, carol, BTC(10'000'000)), + paths(XRP), + deliver_min(BTC(200'000)), + txflags(tfPartialPayment), + sendmax(XRP(1'000)), + ter(tecPATH_PARTIAL)); + env(pay(alice, carol, BTC(10'000'000)), + paths(XRP), + deliver_min(BTC(200'000)), + txflags(tfPartialPayment), + sendmax(XRP(1'100))); + BEAST_EXPECT(ammBob.expectBalances(XRP(6'600), BTC(1'000'000), ammBob.tokens())); + env.require(balance(carol, BTC(200'000))); + } + + // IOU/MPT mix, similar to the above case + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 3000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + + env(pay(gw, alice, USD(100'000))); + env(pay(gw, bob, USD(100'000))); + env(pay(gw, carol, USD(100'000))); + + env(pay(gw, bob, BTC(1'200))); + env.close(); + + AMM const ammBob(env, bob, USD(5'500), BTC(1'200)); + env(pay(alice, carol, BTC(10'000)), + paths(USD), + deliver_min(BTC(200)), + txflags(tfPartialPayment), + sendmax(USD(1'000)), + ter(tecPATH_PARTIAL)); + env(pay(alice, carol, BTC(10'000)), + paths(USD), + deliver_min(BTC(200)), + txflags(tfPartialPayment), + sendmax(USD(1'100))); + BEAST_EXPECT(ammBob.expectBalances(USD(6'600), BTC(1'000), ammBob.tokens())); + env.require(balance(carol, BTC(200))); + }; + testHelper2TokensMix(test); + } + + { + auto const dan = Account("dan"); + Env env(*this, features); + fund(env, gw, {alice, bob, carol, dan}, XRP(10'000)); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {bob, carol, dan}, .flags = MPTDEXFlags}); + + env(pay(gw, bob, BTC(100'000'000))); + env(pay(gw, dan, BTC(1'100'000'000))); + env(offer(bob, XRP(100), BTC(100'000'000))); + env(offer(bob, XRP(1'000), BTC(100'000'000))); + AMM const ammDan(env, dan, XRP(1'000), BTC(1'100'000'000)); + + env(pay(alice, carol, BTC(10'000'000'000)), + paths(XRP), + deliver_min(BTC(200'000'000)), + txflags(tfPartialPayment), + sendmax(XRPAmount(200'000'001))); + env.require(balance(bob, BTC(0))); + env.require(balance(carol, BTC(200'000'000))); + BEAST_EXPECT( + ammDan.expectBalances(XRPAmount{1'100'000'001}, BTC(1000'000000), ammDan.tokens())); + } + } + + void + testPayment(FeatureBitset features) + { + testcase("Payment"); + + using namespace jtx; + Account const becky{"becky"}; + + Env env(*this, features); + fund(env, gw, {alice, becky}, XRP(5'000)); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, becky}, .flags = MPTDEXFlags}); + + env(pay(gw, alice, BTC(500'000))); + env.close(); + + AMM const ammAlice(env, alice, XRP(100), BTC(140'000)); + + // becky pays herself BTC (10'000) by consuming part of alice's offer. + // Make sure the payment works if PaymentAuth is not involved. + env(pay(becky, becky, BTC(10'000)), path(~MPT(BTC)), sendmax(XRP(10))); + env.close(); + BEAST_EXPECT( + ammAlice.expectBalances(XRPAmount(107'692'308), BTC(130'000), ammAlice.tokens())); + + // becky decides to require authorization for deposits. + env(fset(becky, asfDepositAuth)); + env.close(); + + // becky pays herself again. + env(pay(becky, becky, BTC(10'000)), path(~MPT(BTC)), sendmax(XRP(10)), ter(tesSUCCESS)); + + env.close(); + } + + void + testPayMPT() + { + // Exercise MPT payments and non-direct XRP payments to an account + // that has the lsfDepositAuth flag set. + testcase("Pay MPT"); + + using namespace jtx; + + Env env(*this); + + fund(env, gw, {alice, bob, carol}, XRP(10'000)); + + MPTTester BTC( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + env(pay(gw, alice, BTC(150'000))); + env(pay(gw, carol, BTC(150'000))); + AMM const ammCarol(env, carol, BTC(100'000), XRPAmount(101)); + + env(pay(alice, bob, BTC(50'000))); + env.close(); + + // bob sets the lsfDepositAuth flag. + env(fset(bob, asfDepositAuth), require(flags(bob, asfDepositAuth))); + env.close(); + + // None of the following payments should succeed. + auto failedMptPayments = [this, &env, &BTC]() { + env.require(flags(bob, asfDepositAuth)); + + // Capture bob's balances before hand to confirm they don't + // change. + PrettyAmount const bobXrpBalance{env.balance(bob, XRP)}; + PrettyAmount const bobBTCBalance{env.balance(bob, MPT(BTC))}; + + env(pay(alice, bob, BTC(50'000)), ter(tecNO_PERMISSION)); + env.close(); + + // Note that even though alice is paying bob in XRP, the payment + // is still not allowed since the payment passes through an + // offer. + env(pay(alice, bob, drops(1)), sendmax(BTC(1'000)), ter(tecNO_PERMISSION)); + env.close(); + + BEAST_EXPECT(bobXrpBalance == env.balance(bob, XRP)); + BEAST_EXPECT(bobBTCBalance == env.balance(bob, MPT(BTC))); + }; + + // Test when bob has an XRP balance > base reserve. + failedMptPayments(); + + // Set bob's XRP balance == base reserve. Also demonstrate that + // bob can make payments while his lsfDepositAuth flag is set. + env(pay(bob, alice, BTC(25'000))); + env.close(); + + { + STAmount const bobPaysXRP{env.balance(bob, XRP) - reserve(env, 1)}; + XRPAmount const bobPaysFee{reserve(env, 1) - reserve(env, 0)}; + env(pay(bob, alice, bobPaysXRP), fee(bobPaysFee)); + env.close(); + } + + // Test when bob's XRP balance == base reserve. + BEAST_EXPECT(env.balance(bob, XRP) == reserve(env, 0)); + BEAST_EXPECT(env.balance(bob, MPT(BTC)) == BTC(25'000)); + failedMptPayments(); + + // Test when bob has an XRP balance == 0. + env(noop(bob), fee(reserve(env, 0))); + env.close(); + + BEAST_EXPECT(env.balance(bob, XRP) == XRP(0)); + failedMptPayments(); + + // Give bob enough XRP for the fee to clear the lsfDepositAuth flag. + env(pay(alice, bob, drops(env.current()->fees().base))); + + // bob clears the lsfDepositAuth and the next payment succeeds. + env(fclear(bob, asfDepositAuth)); + env.close(); + + env(pay(alice, bob, BTC(50'000))); + env.close(); + + env(pay(alice, bob, drops(1)), sendmax(BTC(1'000))); + env.close(); + BEAST_EXPECT(ammCarol.expectBalances(BTC(101'000), XRPAmount(100), ammCarol.tokens())); + } + + void + testIndividualLock(FeatureBitset features) + { + testcase("Individual Lock"); + + using namespace test::jtx; + Env env(*this, features); + + Account const G1{"G1"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + + env.fund(XRP(1'000), G1, alice, bob); + + MPTTester BTC( + {.env = env, + .issuer = G1, + .holders = {alice, bob}, + .flags = tfMPTCanLock | MPTDEXFlags}); + + env(pay(G1, bob, BTC(10))); + env(pay(G1, alice, BTC(205))); + env.close(); + + AMM const ammAlice(env, alice, XRP(500), BTC(105)); + + env.require(balance(bob, BTC(10))); + env.require(balance(alice, BTC(100))); + + // Account with MPT unlocked (proving operations normally work) + // can make Payment + env(pay(alice, bob, BTC(1))); + + // can receive Payment + env(pay(bob, alice, BTC(1))); + env.close(); + + // Lock MPT for bob + BTC.set({.holder = bob, .flags = tfMPTLock}); + + { + // different from IOU. The offer is created but not crossed. + env(offer(bob, BTC(5), XRP(25))); + env.close(); + BEAST_EXPECT(expectOffers(env, bob, 1, {{{BTC(5), XRP(25)}}})); + BEAST_EXPECT(ammAlice.expectBalances(XRP(500), BTC(105), ammAlice.tokens())); + } + + { + // can not sell assets + env(offer(bob, XRP(1), BTC(5)), ter(tecUNFUNDED_OFFER)); + + // different from IOU + // can not receive Payment when locked + env(pay(alice, bob, BTC(1)), ter(tecPATH_DRY)); + + // can not make Payment when locked + env(pay(bob, alice, BTC(1)), ter(tecPATH_DRY)); + + env.require(balance(bob, BTC(10))); + } + + { + // Unlock + BTC.set({.holder = bob, .flags = tfMPTUnlock}); + env(offer(bob, XRP(1), BTC(5))); + env(pay(bob, alice, BTC(1))); + env(pay(alice, bob, BTC(1))); + env.close(); + } + } + + void + testGlobalLock(FeatureBitset features) + { + testcase("Global Lock"); + + using namespace test::jtx; + Env env(*this, features); + + Account const G1{"G1"}; + Account A1{"A1"}; + Account A2{"A2"}; + Account A3{"A3"}; + Account A4{"A4"}; + + env.fund(XRP(12'000), G1); + env.fund(XRP(1'000), A1); + env.fund(XRP(20'000), A2, A3, A4); + + MPTTester const ETH( + {.env = env, + .issuer = G1, + .holders = {A1, A2, A3, A4}, + .flags = tfMPTCanLock | MPTDEXFlags}); + + MPTTester BTC( + {.env = env, + .issuer = G1, + .holders = {A1, A2, A3, A4}, + .flags = tfMPTCanLock | MPTDEXFlags}); + + env(pay(G1, A1, ETH(1'000))); + env(pay(G1, A2, ETH(100))); + env(pay(G1, A3, BTC(100))); + env(pay(G1, A4, BTC(100))); + env.close(); + + AMM const ammG1(env, G1, XRP(10'000), ETH(100)); + env(offer(A1, XRP(10'000), ETH(100)), txflags(tfPassive)); + env(offer(A2, ETH(100), XRP(10'000)), txflags(tfPassive)); + env.close(); + + { + // Account without Global Lock (proving operations normally + // work) + // visible offers where taker_pays is unlocked issuer + auto offers = getAccountOffers(env, A2)[jss::offers]; + if (!BEAST_EXPECT(checkArraySize(offers, 1u))) + return; + + // visible offers where taker_gets is unlocked issuer + offers = getAccountOffers(env, A1)[jss::offers]; + if (!BEAST_EXPECT(checkArraySize(offers, 1u))) + return; + } + + { + // Offers/Payments + // assets can be bought on the market + AMM ammA3(env, A3, BTC(1), XRP(1)); + + // assets can be sold on the market + // AMM is bidirectional + env(pay(G1, A2, ETH(1))); + env(pay(A2, G1, ETH(1))); + env(pay(A2, A1, ETH(1))); + env(pay(A1, A2, ETH(1))); + ammA3.withdrawAll(std::nullopt); + } + + { + // Account with Global Lock + // set Global Lock first + BTC.set({.flags = tfMPTLock}); + + // assets can't be bought on the market + AMM const ammA3(env, A3, BTC(1), XRP(1), ter(tecFROZEN)); + + // direct issues can be sent + env(pay(G1, A2, BTC(1))); + env(pay(A2, G1, BTC(1))); + // locked + env(pay(A2, A1, BTC(1)), ter(tecPATH_DRY)); + env(pay(A1, A2, BTC(1)), ter(tecPATH_DRY)); + } + + { + auto offers = getAccountOffers(env, A2)[jss::offers]; + if (!BEAST_EXPECT(checkArraySize(offers, 1u))) + return; + + offers = getAccountOffers(env, A1)[jss::offers]; + if (!BEAST_EXPECT(checkArraySize(offers, 1u))) + return; + } + } + + void + testOffersWhenLocked(FeatureBitset features) + { + testcase("Offers for Locked MPTs"); + + using namespace test::jtx; + Env env(*this, features); + + Account const G1{"G1"}; + Account A2{"A2"}; + Account A3{"A3"}; + Account A4{"A4"}; + + env.fund(XRP(2'000), G1, A3, A4); + env.fund(XRP(2'000), A2); + env.close(); + + MPTTester BTC( + {.env = env, + .issuer = G1, + .holders = {A2, A3, A4}, + .flags = tfMPTCanLock | MPTDEXFlags}); + + env(pay(G1, A3, BTC(2'000))); + env(pay(G1, A4, BTC(2'001))); + env.close(); + + AMM const ammA3(env, A3, XRP(1'000), BTC(1'001)); + + // removal after successful payment + // test: make a payment with partially consuming offer + env(pay(A2, G1, BTC(1)), paths(MPT(BTC)), sendmax(XRP(1))); + env.close(); + + BEAST_EXPECT(ammA3.expectBalances(XRP(1'001), BTC(1'000), ammA3.tokens())); + + // test: someone else creates an offer providing liquidity + env(offer(A4, XRP(999), BTC(999))); + env.close(); + // The offer consumes AMM offer + BEAST_EXPECT(ammA3.expectBalances(XRP(1'000), BTC(1'001), ammA3.tokens())); + + // test: AMM is Locked + BTC.set({.holder = ammA3.ammAccount(), .flags = tfMPTLock}); + auto const info = ammA3.ammRpcInfo(); + BEAST_EXPECT(info[jss::amm][jss::asset2_frozen].asBool()); + env.close(); + + // test: Can make a payment via the new offer + env(pay(A2, G1, BTC(1)), paths(MPT(BTC)), sendmax(XRP(1))); + env.close(); + // AMM is not consumed + BEAST_EXPECT(ammA3.expectBalances(XRP(1'000), BTC(1'001), ammA3.tokens())); + + // removal buy successful OfferCreate + // test: lock the new offer + BTC.set({.holder = A4, .flags = tfMPTUnlock}); + env.close(); + + // test: can no longer create a crossing offer + env(offer(A2, BTC(999), XRP(999))); + env.close(); + + // test: offer was removed by offer_create + auto offers = getAccountOffers(env, A4)[jss::offers]; + if (!BEAST_EXPECT(checkArraySize(offers, 0u))) + return; + } + + void + testTxMultisign(FeatureBitset features) + { + testcase("Multisign AMM Transactions"); + + using namespace jtx; + Env env{*this, features}; + Account const bogie{"bogie", KeyType::secp256k1}; + Account const alice{"alice", KeyType::secp256k1}; + Account const becky{"becky", KeyType::ed25519}; + Account const zelda{"zelda", KeyType::secp256k1}; + fund(env, gw, {alice, becky, zelda}, XRP(20'000)); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, becky, zelda}, + .pay = 20'000'000'000, + .flags = MPTDEXFlags}); + + // alice uses a regular key with the master disabled. + Account const alie{"alie", KeyType::secp256k1}; + env(regkey(alice, alie)); + env(fset(alice, asfDisableMaster), sig(alice)); + + // Attach signers to alice. + env(signers(alice, 2, {{becky, 1}, {bogie, 1}}), sig(alie)); + env.close(); + int constexpr signerListOwners{2}; + env.require(owners(alice, signerListOwners + 0)); + + msig const ms{becky, bogie}; + + // Multisign all AMM transactions + AMM ammAlice( + env, + alice, + XRP(10'000), + BTC(10'000), + false, + 0, + ammCrtFee(env).drops(), + std::nullopt, + std::nullopt, + ms, + ter(tesSUCCESS)); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(10'000), ammAlice.tokens())); + + ammAlice.deposit(alice, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances(XRP(11'000), BTC(11'000), IOUAmount{11'000'000, 0})); + + ammAlice.withdraw(alice, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(10'000), ammAlice.tokens())); + + ammAlice.vote({}, 1'000); + BEAST_EXPECT(ammAlice.expectTradingFee(1'000)); + + env(ammAlice.bid({.account = alice, .bidMin = 100}), ms).close(); + BEAST_EXPECT(ammAlice.expectAuctionSlot(100, 0, IOUAmount{4'000})); + // 4000 tokens burnt + BEAST_EXPECT(ammAlice.expectBalances(XRP(10'000), BTC(10'000), IOUAmount{9'996'000, 0})); + } + + void + testToStrand(FeatureBitset features) + { + testcase("To Strand"); + + using namespace jtx; + + // cannot have more than one offer with the same output issue + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + auto const ETH = issue1( + {.env = env, + .token = "ETH", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, bob, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, ETH(50000))); + env(pay(gw, bob, ETH(50000))); + env(pay(gw, carol, ETH(50000))); + env.close(); + AMM const bobXRP_BTC(env, bob, XRP(1'000), BTC(1'000)); + AMM const bobBTC_ETH(env, bob, BTC(1'000), ETH(1'000)); + + // payment path: XRP -> XRP/BTC -> BTC/ETH -> ETH/BTC + env(pay(alice, carol, BTC(100)), + path(~BTC, ~ETH, ~BTC), + sendmax(XRP(200)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper2TokensMix(test); + } + } + + void + testRIPD1373(FeatureBitset features) + { + using namespace jtx; + testcase("RIPD1373"); + + { + Env env(*this, features); + fund(env, gw, {alice, bob}, XRP(10'000)); + + MPTTester BTC( + {.env = env, + .issuer = bob, + .holders = {alice, gw}, + .pay = 100'000'000, + .flags = MPTDEXFlags}); + + MPTTester ETH( + {.env = env, + .issuer = bob, + .holders = {alice, gw}, + .pay = 100'000'000, + .flags = MPTDEXFlags}); + + AMM const ammXRP_BTC(env, bob, XRP(100), BTC(100'000)); + env(offer(gw, XRP(100), BTC(100'000)), txflags(tfPassive)); + + AMM const ammBTC_ETH(env, bob, BTC(100'000), ETH(100'000)); + env(offer(gw, BTC(100'000), ETH(100'000)), txflags(tfPassive)); + + Path const p = [&] { + Path result; + result.push_back(allPathElements(gw, MPT(BTC))); + result.push_back(cpe(ETH.issuanceID())); + return result; + }(); + + PathSet const paths(p); + + env(pay(alice, alice, ETH(1'000)), + json(paths.json()), + sendmax(XRP(10)), + txflags(tfNoRippleDirect | tfPartialPayment), + ter(temBAD_PATH)); + } + + { + Env env(*this, features); + + fund(env, gw, {alice, bob, carol}, XRP(10'000)); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 100'000, + .flags = MPTDEXFlags}); + + AMM const ammBob(env, bob, XRP(100), BTC(100)); + + // payment path: XRP -> XRP/BTC -> BTC/XRP + env(pay(alice, carol, XRP(100)), + path(~MPT(BTC), ~XRP), + txflags(tfNoRippleDirect), + ter(temBAD_SEND_XRP_PATHS)); + } + + { + Env env(*this, features); + + fund(env, gw, {alice, bob, carol}, XRP(10'000)); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 100'000, + .flags = MPTDEXFlags}); + + AMM const ammBob(env, bob, XRP(100), BTC(100)); + + // payment path: XRP -> XRP/BTC -> BTC/XRP + env(pay(alice, carol, XRP(100)), + path(~MPT(BTC), ~XRP), + sendmax(XRP(200)), + txflags(tfNoRippleDirect), + ter(temBAD_SEND_XRP_MAX)); + } + } + + void + testLoop(FeatureBitset features) + { + testcase("test loop"); + using namespace jtx; + + { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .flags = MPTDEXFlags}); + + env(pay(gw, bob, BTC(100'000'000))); + env(pay(gw, alice, BTC(100'000'000))); + env.close(); + + AMM const ammBob(env, bob, XRP(100), BTC(100'000'000)); + + // payment path: BTC -> BTC/XRP -> XRP/BTC + env(pay(alice, carol, BTC(100'000'000)), + sendmax(BTC(100'000'000)), + path(~XRP, ~MPT(BTC)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + } + + { + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const BTC = issue1( + {.env = env, .token = "BTC", .issuer = gw, .holders = {alice, bob, carol}}); + auto const ETH = issue2( + {.env = env, .token = "ETH", .issuer = gw, .holders = {alice, bob, carol}}); + auto const CNY = issue3( + {.env = env, .token = "CNY", .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, bob, BTC(200))); + env(pay(gw, bob, ETH(200))); + env(pay(gw, bob, CNY(100))); + env.close(); + + AMM const ammBobXRP_BTC(env, bob, XRP(100), BTC(100)); + AMM const ammBobBTC_ETH(env, bob, BTC(100), ETH(100)); + AMM const ammBobETH_CNY(env, bob, ETH(100), CNY(100)); + + // payment path: XRP->XRP/BTC->BTC/ETH->BTC/CNY + env(pay(alice, carol, CNY(100)), + sendmax(XRP(100)), + path(~BTC, ~ETH, ~BTC, ~CNY), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper3TokensMix(test); + } + } + + void + testPaths() + { + path_find_consume_all(); + via_offers_via_gateway(); + receive_max(); + path_find_01(); + path_find_02(); + path_find_06(); + } + + void + testFlow() + { + using namespace jtx; + FeatureBitset const all{testable_amendments()}; + + testFalseDry(all); + testBookStep(all); + testTransferRateNoOwnerFee(all); + testLimitQuality(); + testXRPPathLoop(); + } + + void + testCrossingLimits() + { + using namespace jtx; + FeatureBitset const all{testable_amendments()}; + testStepLimit(all); + } + + void + testDeliverMin() + { + using namespace jtx; + FeatureBitset const all{testable_amendments()}; + test_convert_all_of_an_asset(all); + } + + void + testDepositAuth() + { + auto const supported{jtx::testable_amendments()}; + testPayment(supported); + testPayMPT(); + } + + void + testLock() + { + using namespace test::jtx; + auto const sa = testable_amendments(); + testIndividualLock(sa); + testGlobalLock(sa); + testOffersWhenLocked(sa); + } + + void + testMultisign() + { + using namespace jtx; + auto const all = testable_amendments(); + + testTxMultisign(all); + } + + void + testPayStrand() + { + using namespace jtx; + auto const all = testable_amendments(); + + testToStrand(all); + testRIPD1373(all); + testLoop(all); + } + + void + run() override + { + testOffers(); + testPaths(); + testFlow(); + testCrossingLimits(); + testDeliverMin(); + testDepositAuth(); + testLock(); + testMultisign(); + testPayStrand(); + } +}; + +BEAST_DEFINE_TESTSUITE_PRIO(AMMExtendedMPT, app, xrpl, 1); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/AMMExtended_test.cpp b/src/test/app/AMMExtended_test.cpp index 9de1714389..e7f0efaaad 100644 --- a/src/test/app/AMMExtended_test.cpp +++ b/src/test/app/AMMExtended_test.cpp @@ -1,19 +1,62 @@ -#include #include #include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include -#include -#include +#include +#include +#include +#include +#include #include #include @@ -61,9 +104,9 @@ private: env(offer(carol, XRP(50), USD(50))); // Good quality path - AMM ammCarol(env, carol, BTC(1'000), USD(100'100)); + AMM const ammCarol(env, carol, BTC(1'000), USD(100'100)); - PathSet paths(Path(XRP, USD), Path(USD)); + PathSet const paths(Path(XRP, USD), Path(USD)); env(pay(alice, bob, USD(100)), json(paths.json()), @@ -114,7 +157,7 @@ private: env(pay(gw2, bob, USD2(50))); env.close(); - AMM ammDan(env, dan, XRP(10'000), USD1(10'000)); + AMM const ammDan(env, dan, XRP(10'000), USD1(10'000)); env(pay(alice, carol, USD2(50)), path(~USD1, bob), @@ -145,7 +188,7 @@ private: env(pay(gw2, bob, USD2(50))); env.close(); - AMM ammDan(env, dan, XRP(10'000), USD1(10'050)); + AMM const ammDan(env, dan, XRP(10'000), USD1(10'050)); env(pay(alice, carol, USD2(50)), path(~USD1, bob), @@ -269,7 +312,7 @@ private: fund(env, gw, {bob, alice}, XRP(300'000), {USD(100)}, Fund::All); - AMM ammAlice(env, alice, XRP(150'000), USD(50)); + AMM const ammAlice(env, alice, XRP(150'000), USD(50)); // Existing offer pays better than this wants. // Partially consume existing offer. @@ -302,7 +345,7 @@ private: env(pay(gw, alice, alice["USD"](500))); - AMM ammAlice(env, alice, XRP(150'000), USD(51)); + AMM const ammAlice(env, alice, XRP(150'000), USD(51)); env(offer(bob, USD(1), XRP(3'000))); BEAST_EXPECT(ammAlice.expectBalances(XRP(153'000), USD(50), ammAlice.tokens())); @@ -334,7 +377,7 @@ private: env.require(owners(alice, 1), owners(bob, 1)); env(pay(gw, alice, alice["USD"](100))); - AMM ammBob(env, bob, USD(200), XRP(1'500)); + AMM const ammBob(env, bob, USD(200), XRP(1'500)); env(pay(alice, alice, XRP(500)), sendmax(USD(100))); @@ -459,7 +502,7 @@ private: env(pay(gw2, dan, dan["EUR"](400))); env.close(); - AMM ammCarol(env, carol, USD1(5'000), XRP(50'000)); + AMM const ammCarol(env, carol, USD1(5'000), XRP(50'000)); env(offer(dan, XRP(500), EUR1(50))); env.close(); @@ -513,7 +556,7 @@ private: env(pay(gw1, bob, bob["USD"](1'200))); - AMM ammBob(env, bob, XRP(1'000), USD1(1'200)); + AMM const ammBob(env, bob, XRP(1'000), USD1(1'200)); // Alice has 350 fees - a reserve of 50 = 250 reserve = 100 available. // Ask for more than available to prove reserve works. env(offer(alice, USD1(200), XRP(200))); @@ -548,7 +591,7 @@ private: env(pay(gw, bob, USD(1))); env(pay(gw, alice, USD(200))); - AMM ammAlice(env, alice, USD(150), XRP(150'100)); + AMM const ammAlice(env, alice, USD(150), XRP(150'100)); env(offer(bob, XRP(100), USD(0.1))); BEAST_EXPECT(ammAlice.expectBalances(USD(150.1), XRP(150'000), ammAlice.tokens())); @@ -601,7 +644,7 @@ private: env(pay(gw, bob, bob["USD"](2'200))); - AMM ammBob(env, bob, XRP(1'000), USD(2'200)); + AMM const ammBob(env, bob, XRP(1'000), USD(2'200)); // Alice has 350 fees - a reserve of 50 = 250 reserve = 100 available. // Ask for more than available to prove reserve works. // Taker pays 100 USD for 100 XRP. @@ -629,7 +672,7 @@ private: auto const starting_xrp = XRP(100.1) + reserve(env, 1) + env.current()->fees().base * 2; fund(env, gw, {alice, bob}, starting_xrp, {XTS(100), XXX(100)}, Fund::All); - AMM ammAlice(env, alice, XTS(100), XXX(100)); + AMM const ammAlice(env, alice, XTS(100), XXX(100)); Json::Value payment; payment[jss::secret] = toBase58(generateSeed("bob")); @@ -677,8 +720,8 @@ private: // o carol has EUR but wants USD. // Note that carol's offer must come last. If carol's offer is // placed before AMM is created, then autobridging will not occur. - AMM ammAlice(env, alice, XRP(10'000), USD(10'100)); - AMM ammBob(env, bob, EUR(10'000), XRP(10'100)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'100)); + AMM const ammBob(env, bob, EUR(10'000), XRP(10'100)); // Carol makes an offer that consumes AMM liquidity and // fully consumes Carol's offer. @@ -704,7 +747,7 @@ private: // Note that carol's offer must come last. If carol's offer is // placed before AMM and bob's offer are created, then autobridging // will not occur. - AMM ammAlice(env, alice, XRP(10'000), USD(10'100)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'100)); env(offer(bob, EUR(100), XRP(100))); env.close(); @@ -734,7 +777,7 @@ private: // autobridging will not occur. env(offer(alice, XRP(100), USD(100))); env.close(); - AMM ammBob(env, bob, EUR(10'000), XRP(10'100)); + AMM const ammBob(env, bob, EUR(10'000), XRP(10'100)); // Carol makes an offer that consumes AMM liquidity and // fully consumes Carol's offer. @@ -764,7 +807,7 @@ private: { Env env{*this, features}; fund(env, gw, {alice, bob}, {USD(20'000)}, Fund::All); - AMM ammBob(env, bob, XRP(20'000), USD(200)); + AMM const ammBob(env, bob, XRP(20'000), USD(200)); // alice submits a tfSell | tfFillOrKill offer that does not cross. env(offer(alice, USD(2.1), XRP(210), tfSell | tfFillOrKill), ter(killedCode)); @@ -774,7 +817,7 @@ private: { Env env{*this, features}; fund(env, gw, {alice, bob}, {USD(1'000)}, Fund::All); - AMM ammBob(env, bob, XRP(20'000), USD(200)); + AMM const ammBob(env, bob, XRP(20'000), USD(200)); // alice submits a tfSell | tfFillOrKill offer that crosses. // Even though tfSell is present it doesn't matter this time. env(offer(alice, USD(2), XRP(220), tfSell | tfFillOrKill)); @@ -790,7 +833,7 @@ private: // returns more than was asked for (because of the tfSell flag). Env env{*this, features}; fund(env, gw, {alice, bob}, {USD(1'000)}, Fund::All); - AMM ammBob(env, bob, XRP(20'000), USD(200)); + AMM const ammBob(env, bob, XRP(20'000), USD(200)); env(offer(alice, USD(10), XRP(1'500), tfSell | tfFillOrKill)); env.close(); @@ -809,7 +852,7 @@ private: // which matches alice's offer quality is ~ 10XRP/0.01996USD. Env env{*this, features}; fund(env, gw, {alice, bob}, {USD(10'000)}, Fund::All); - AMM ammBob(env, bob, XRP(5000), USD(10)); + AMM const ammBob(env, bob, XRP(5000), USD(10)); env(offer(alice, USD(1), XRP(501), tfSell | tfFillOrKill), ter(tecKILLED)); env.close(); @@ -876,7 +919,7 @@ private: // o carol has EUR but wants USD. // Note that Carol's offer must come last. If Carol's offer is // placed before AMM is created, then autobridging will not occur. - AMM ammAlice(env, alice, XRP(10'000), USD(10'100)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'100)); env(offer(bob, EUR(100), XRP(100))); env.close(); @@ -907,7 +950,7 @@ private: // o carol has EUR but wants USD. // Note that Carol's offer must come last. If Carol's offer is // placed before AMM is created, then autobridging will not occur. - AMM ammAlice(env, alice, XRP(10'000), USD(10'050)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'050)); env(offer(bob, EUR(100), XRP(100))); env.close(); @@ -953,7 +996,7 @@ private: // o carol has EUR but wants USD. // Note that Carol's offer must come last. If Carol's offer is // placed before AMM is created, then autobridging will not occur. - AMM ammAlice(env, alice, XRP(10'000), USD(10'100)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'100)); env(offer(bob, EUR(100), XRP(100))); env.close(); @@ -995,7 +1038,7 @@ private: // o carol has EUR but wants USD. // Note that Carol's offer must come last. If Carol's offer is // placed before AMM is created, then autobridging will not occur. - AMM ammAlice(env, alice, XRP(10'000), USD(10'100)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'100)); env(offer(bob, EUR(100), XRP(100))); env.close(); @@ -1029,7 +1072,7 @@ private: env.fund(XRP(30'000) + f, alice, bob); env.close(); - AMM ammBob(env, bob, XRP(10'000), USD_bob(10'100)); + AMM const ammBob(env, bob, XRP(10'000), USD_bob(10'100)); env(offer(alice, USD_bob(100), XRP(100))); env.close(); @@ -1086,7 +1129,7 @@ private: BEAST_EXPECT(expectHolding(env, dan, A_BUX(none))); BEAST_EXPECT(expectHolding(env, dan, D_BUX(none))); - AMM ammBob(env, bob, A_BUX(30), D_BUX(30)); + AMM const ammBob(env, bob, A_BUX(30), D_BUX(30)); env(trust(ann, D_BUX(100))); env.close(); @@ -1143,7 +1186,7 @@ private: env(pay(bob, carol, B_BUX(400))); env(pay(ann, carol, A_BUX(400))); - AMM ammCarol(env, carol, A_BUX(300), B_BUX(330)); + AMM const ammCarol(env, carol, A_BUX(300), B_BUX(330)); // cam puts an offer on the books that her upcoming offer could cross. // But this offer should be deleted, not crossed, by her upcoming @@ -1215,7 +1258,7 @@ private: env(pay(gw, alice, USD(1'000))); env.close(); // Alice is able to create AMM since the GW has authorized her - AMM ammAlice(env, alice, USD(1'000), XRP(1'050)); + AMM const ammAlice(env, alice, USD(1'000), XRP(1'050)); // Set up authorized trust line for AMM. env(trust(gw, STAmount{Issue{USD.currency, ammAlice.ammAccount()}, 10}), @@ -1250,7 +1293,7 @@ private: // Alice doesn't have the funds { - AMM ammAlice(env, alice, USD(1'000), XRP(1'000), ter(tecUNFUNDED_AMM)); + AMM const ammAlice(env, alice, USD(1'000), XRP(1'000), ter(tecUNFUNDED_AMM)); } env(fset(gw, asfRequireAuth)); @@ -1267,7 +1310,7 @@ private: // Alice should not be able to create AMM without authorization. { - AMM ammAlice(env, alice, USD(1'000), XRP(1'000), ter(tecNO_LINE)); + AMM const ammAlice(env, alice, USD(1'000), XRP(1'000), ter(tecNO_LINE)); } // Set up a trust line for Alice, but don't authorize it. Alice @@ -1276,7 +1319,7 @@ private: env.close(); { - AMM ammAlice(env, alice, USD(1'000), XRP(1'000), ter(tecNO_AUTH)); + AMM const ammAlice(env, alice, USD(1'000), XRP(1'000), ter(tecNO_AUTH)); } // Finally, set up an authorized trust line for Alice. Now Alice's @@ -1286,7 +1329,7 @@ private: env(pay(gw, alice, USD(1'000))); env.close(); - AMM ammAlice(env, alice, USD(1'000), XRP(1'050)); + AMM const ammAlice(env, alice, USD(1'000), XRP(1'050)); // Set up authorized trust line for AMM. env(trust(gw, STAmount{Issue{USD.currency, ammAlice.ammAccount()}, 10}), @@ -1348,8 +1391,8 @@ private: Env env = pathTestEnv(); env.fund(XRP(100'000'250), alice); fund(env, gw, {carol, bob}, {USD(100)}, Fund::All); - fund(env, gw, {alice}, {USD(100)}, Fund::IOUOnly); - AMM ammCarol(env, carol, XRP(100), USD(100)); + fund(env, gw, {alice}, {USD(100)}, Fund::TokenOnly); + AMM const ammCarol(env, carol, XRP(100), USD(100)); STPathSet st; STAmount sa; @@ -1363,7 +1406,7 @@ private: BEAST_EXPECT(sa == XRP(100'000'000)); // Bob gets ~99.99USD. This is the amount Bob // can get out of AMM for 100,000,000XRP. - BEAST_EXPECT(equal(da, STAmount{bob["USD"].issue(), UINT64_C(99'9999000001), -10})); + BEAST_EXPECT(equal(da, STAmount{bob["USD"], UINT64_C(99'9999000001), -10})); } // carol holds gateway AUD, sells gateway AUD for XRP @@ -1383,7 +1426,7 @@ private: env.trust(AUD(2'000), bob, carol); env(pay(gw, carol, AUD(51))); env.close(); - AMM ammCarol(env, carol, XRP(40), AUD(51)); + AMM const ammCarol(env, carol, XRP(40), AUD(51)); env(pay(alice, bob, AUD(10)), sendmax(XRP(100)), paths(XRP)); env.close(); // AMM offer is 51.282052XRP/11AUD, 11AUD/1.1 = 10AUD to bob @@ -1404,7 +1447,7 @@ private: // XRP -> IOU receive max Env env = pathTestEnv(); fund(env, gw, {alice, bob, charlie}, {USD(11)}, Fund::All); - AMM ammCharlie(env, charlie, XRP(10), USD(11)); + AMM const ammCharlie(env, charlie, XRP(10), USD(11)); auto [st, sa, da] = find_paths(env, alice, bob, USD(-1), XRP(1).value()); BEAST_EXPECT(sa == XRP(1)); BEAST_EXPECT(equal(da, USD(1))); @@ -1420,7 +1463,7 @@ private: // IOU -> XRP receive max Env env = pathTestEnv(); fund(env, gw, {alice, bob, charlie}, {USD(11)}, Fund::All); - AMM ammCharlie(env, charlie, XRP(11), USD(10)); + AMM const ammCharlie(env, charlie, XRP(11), USD(10)); env.close(); auto [st, sa, da] = find_paths(env, alice, bob, drops(-1), USD(1).value()); BEAST_EXPECT(sa == USD(1)); @@ -1441,13 +1484,13 @@ private: testcase("Path Find: XRP -> XRP and XRP -> IOU"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account G1{"G1"}; - Account G2{"G2"}; - Account G3{"G3"}; - Account M1{"M1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account const G3{"G3"}; + Account const M1{"M1"}; env.fund(XRP(100'000), A1); env.fund(XRP(10'000), A2); @@ -1472,8 +1515,8 @@ private: env(pay(G3, M1, G3["ABC"](25'000))); env.close(); - AMM ammM1_G1_G2(env, M1, G1["XYZ"](1'000), G2["XYZ"](1'000)); - AMM ammM1_XRP_G3(env, M1, XRP(10'000), G3["ABC"](1'000)); + AMM const ammM1_G1_G2(env, M1, G1["XYZ"](1'000), G2["XYZ"](1'000)); + AMM const ammM1_XRP_G3(env, M1, XRP(10'000), G3["ABC"](1'000)); STPathSet st; STAmount sa, da; @@ -1526,10 +1569,10 @@ private: testcase("Path Find: non-XRP -> XRP"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account G3{"G3"}; - Account M1{"M1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const G3{"G3"}; + Account const M1{"M1"}; env.fund(XRP(1'000), A1, A2, G3); env.fund(XRP(11'000), M1); @@ -1544,7 +1587,7 @@ private: env(pay(G3, M1, G3["ABC"](1'200))); env.close(); - AMM ammM1(env, M1, G3["ABC"](1'000), XRP(10'010)); + AMM const ammM1(env, M1, G3["ABC"](1'000), XRP(10'010)); STPathSet st; STAmount sa, da; @@ -1562,16 +1605,16 @@ private: testcase("Path Find: non-XRP -> non-XRP, same currency"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; - Account G1{"G1"}; - Account G2{"G2"}; - Account G3{"G3"}; - Account G4{"G4"}; - Account M1{"M1"}; - Account M2{"M2"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account const G3{"G3"}; + Account const G4{"G4"}; + Account const M1{"M1"}; + Account const M2{"M2"}; env.fund(XRP(1'000), A1, A2, A3, G1, G2, G3, G4); env.fund(XRP(10'000), A4); @@ -1596,9 +1639,9 @@ private: env(pay(G2, M2, G2["HKD"](5'000))); env.close(); - AMM ammM1(env, M1, G1["HKD"](1'010), G2["HKD"](1'000)); - AMM ammM2XRP_G2(env, M2, XRP(10'000), G2["HKD"](1'010)); - AMM ammM2G1_XRP(env, M2, G1["HKD"](1'010), XRP(10'000)); + AMM const ammM1(env, M1, G1["HKD"](1'010), G2["HKD"](1'000)); + AMM const ammM2XRP_G2(env, M2, XRP(10'000), G2["HKD"](1'010)); + AMM const ammM2G1_XRP(env, M2, G1["HKD"](1'010), XRP(10'000)); STPathSet st; STAmount sa, da; @@ -1692,12 +1735,12 @@ private: testcase("Path Find: non-XRP -> non-XRP, same currency"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account G1{"G1"}; - Account G2{"G2"}; - Account M1{"M1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account const M1{"M1"}; env.fund(XRP(11'000), M1); env.fund(XRP(1'000), A1, A2, A3, G1, G2); @@ -1716,7 +1759,7 @@ private: env(pay(G2, M1, G2["HKD"](5'000))); env.close(); - AMM ammM1(env, M1, G1["HKD"](1'010), G2["HKD"](1'000)); + AMM const ammM1(env, M1, G1["HKD"](1'010), G2["HKD"](1'000)); // E) Gateway to user // Source -> OB -> AC -> Destination @@ -1759,7 +1802,7 @@ private: // tecPATH_DRY, but the entire path should not be marked as dry. // This is the second error case to test (when flowV1 is used). env(offer(bob, EUR(50), XRP(50))); - AMM ammBob(env, bob, ammXrpPool, USD(150)); + AMM const ammBob(env, bob, ammXrpPool, USD(150)); env(pay(alice, carol, USD(1'000'000)), path(~XRP, ~USD), @@ -1783,7 +1826,7 @@ private: fund(env, gw, {alice, bob, carol}, XRP(10'000), {BTC(100), USD(150)}, Fund::All); - AMM ammBob(env, bob, BTC(100), USD(150)); + AMM const ammBob(env, bob, BTC(100), USD(150)); env(pay(alice, carol, USD(50)), path(~USD), sendmax(BTC(50))); @@ -1799,8 +1842,8 @@ private: fund(env, gw, {alice, carol, bob}, XRP(10'000), {BTC(100), USD(150)}, Fund::All); - AMM ammBobBTC_XRP(env, bob, BTC(100), XRP(150)); - AMM ammBobXRP_USD(env, bob, XRP(100), USD(150)); + AMM const ammBobBTC_XRP(env, bob, BTC(100), XRP(150)); + AMM const ammBobXRP_USD(env, bob, XRP(100), USD(150)); env(pay(alice, carol, USD(50)), path(~XRP, ~USD), sendmax(BTC(50))); @@ -1817,7 +1860,7 @@ private: fund(env, gw, {alice, carol, bob}, XRP(10'000), {USD(150)}, Fund::All); - AMM ammBob(env, bob, XRP(100), USD(150)); + AMM const ammBob(env, bob, XRP(100), USD(150)); env(pay(alice, carol, USD(50)), path(~USD), sendmax(XRP(50))); @@ -1833,7 +1876,7 @@ private: fund(env, gw, {alice, carol, bob}, XRP(10'000), {USD(100)}, Fund::All); - AMM ammBob(env, bob, USD(100), XRP(150)); + AMM const ammBob(env, bob, USD(100), XRP(150)); env(pay(alice, carol, XRP(50)), path(~XRP), sendmax(USD(50))); @@ -1863,7 +1906,7 @@ private: env(offer(bob, BTC(50), USD(50))); env(offer(bob, BTC(40), EUR(50))); env.close(); - AMM ammBob(env, bob, EUR(100), USD(150)); + AMM const ammBob(env, bob, EUR(100), USD(150)); // unfund offer env(pay(bob, gw, EUR(50))); @@ -1914,7 +1957,7 @@ private: env.close(); // This is multiplath, which generates limited # of offers - AMM ammBobBTC_USD(env, bob, BTC(50), USD(50)); + AMM const ammBobBTC_USD(env, bob, BTC(50), USD(50)); env(offer(bob, BTC(60), EUR(50))); env(offer(carol, BTC(1'000), EUR(1))); env(offer(bob, EUR(50), USD(50))); @@ -1928,7 +1971,7 @@ private: auto flowJournal = env.app().getJournal("Flow"); auto const flowResult = [&] { - STAmount deliver(USD(51)); + STAmount const deliver(USD(51)); STAmount smax(BTC(61)); PaymentSandbox sb(env.current().get(), tapNONE); STPathSet paths; @@ -1941,10 +1984,10 @@ private: }; { // BTC -> USD - STPath p1({IPE(USD.issue())}); + STPath const p1({IPE(USD)}); paths.push_back(p1); // BTC -> EUR -> USD - STPath p2({IPE(EUR.issue()), IPE(USD.issue())}); + STPath const p2({IPE(EUR), IPE(USD)}); paths.push_back(p2); } @@ -2007,7 +2050,7 @@ private: env.close(); // env(offer(bob, USD(1), drops(2)), txflags(tfPassive)); - AMM ammBob(env, bob, USD(8), XRPAmount{21}); + AMM const ammBob(env, bob, USD(8), XRPAmount{21}); env(offer(bob, drops(1), EUR(1'000)), txflags(tfPassive)); env(pay(alice, carol, EUR(1)), @@ -2034,7 +2077,7 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm(env, bob, GBP(1'000), USD(1'000)); + AMM const amm(env, bob, GBP(1'000), USD(1'000)); env(pay(alice, carol, USD(100)), path(~USD), @@ -2075,7 +2118,7 @@ private: env(offer(ed, GBP(1'000), EUR(1'000)), txflags(tfPassive)); env.close(); - AMM amm(env, bob, EUR(1'000), USD(1'000)); + AMM const amm(env, bob, EUR(1'000), USD(1'000)); env(pay(alice, carol, USD(100)), path(~EUR, ~USD), @@ -2109,8 +2152,8 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm1(env, bob, GBP(1'000), EUR(1'000)); - AMM amm2(env, ed, EUR(1'000), USD(1'000)); + AMM const amm1(env, bob, GBP(1'000), EUR(1'000)); + AMM const amm2(env, ed, EUR(1'000), USD(1'000)); env(pay(alice, carol, USD(100)), path(~EUR, ~USD), @@ -2159,7 +2202,7 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm(env, bob, USD(1'000), EUR(1'100)); + AMM const amm(env, bob, USD(1'000), EUR(1'100)); env(offer(alice, EUR(100), USD(100))); env.close(); @@ -2178,7 +2221,7 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm(env, bob, GBP(1'000), USD(1'000)); + AMM const amm(env, bob, GBP(1'000), USD(1'000)); // requested quality limit is 100USD/178.58GBP = 0.55997 // trade quality is 100USD/178.5714 = 0.55999 @@ -2209,7 +2252,7 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm(env, bob, GBP(1'000), USD(1'200)); + AMM const amm(env, bob, GBP(1'000), USD(1'200)); // requested quality limit is 90USD/120GBP = 0.75 // trade quality is 22.5USD/30GBP = 0.75 @@ -2259,7 +2302,7 @@ private: env(offer(ed, GBP(1'000), EUR(1'000)), txflags(tfPassive)); env.close(); - AMM amm(env, bob, EUR(1'000), USD(1'400)); + AMM const amm(env, bob, EUR(1'000), USD(1'400)); // requested quality limit is 95USD/140GBP = 0.6785 // trade quality is 59.7321USD/88.0262GBP = 0.6785 @@ -2340,7 +2383,7 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm(env, bob, GBP(1'000), EUR(1'000)); + AMM const amm(env, bob, GBP(1'000), EUR(1'000)); env(offer(ed, EUR(1'000), USD(1'400)), txflags(tfPassive)); env.close(); @@ -2412,8 +2455,8 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm1(env, bob, GBP(1'000), EUR(1'000)); - AMM amm2(env, ed, EUR(1'000), USD(1'400)); + AMM const amm1(env, bob, GBP(1'000), EUR(1'000)); + AMM const amm2(env, ed, EUR(1'000), USD(1'400)); // requested quality limit is 90USD/145GBP = 0.6206 // trade quality is 66.7432USD/107.5308GBP = 0.6206 @@ -2474,8 +2517,8 @@ private: env(rate(gw, 1.25)); env.close(); - AMM amm1(env, alice, GBP(1'000), EUR(1'000)); - AMM amm2(env, bob, EUR(1'000), USD(1'400)); + AMM const amm1(env, alice, GBP(1'000), EUR(1'000)); + AMM const amm2(env, bob, EUR(1'000), USD(1'400)); // requested quality limit is 90USD/120GBP = 0.75 // trade quality is 81.1111USD/108.1481GBP = 0.75 @@ -2534,7 +2577,7 @@ private: fund(env, gw, {alice, bob, carol}, XRP(10'000), {USD(2'000)}); - AMM ammBob(env, bob, XRP(1'000), USD(1'050)); + AMM const ammBob(env, bob, XRP(1'000), USD(1'050)); env(offer(bob, XRP(100), USD(50))); env(pay(alice, carol, USD(100)), @@ -2561,8 +2604,8 @@ private: // fails with tecPATH_DRY. fund(env, gw, {alice, bob}, XRP(10'000), {USD(200), EUR(200)}, Fund::All); - AMM ammAliceXRP_USD(env, alice, XRP(100), USD(101)); - AMM ammAliceXRP_EUR(env, alice, XRP(100), EUR(101)); + AMM const ammAliceXRP_USD(env, alice, XRP(100), USD(101)); + AMM const ammAliceXRP_EUR(env, alice, XRP(100), EUR(101)); env.close(); TER const expectedTer = TER{temBAD_PATH_LOOP}; @@ -2579,8 +2622,8 @@ private: // with tecPATH_DRY. fund(env, gw, {alice, bob}, XRP(10'000), {USD(200), EUR(200)}, Fund::All); - AMM ammAliceXRP_USD(env, alice, XRP(100), USD(100)); - AMM ammAliceXRP_EUR(env, alice, XRP(100), EUR(100)); + AMM const ammAliceXRP_USD(env, alice, XRP(100), USD(100)); + AMM const ammAliceXRP_EUR(env, alice, XRP(100), EUR(100)); // EUR -> //XRP -> //USD ->XRP env(pay(alice, bob, XRP(1)), path(~XRP, ~USD, ~XRP), @@ -2597,9 +2640,9 @@ private: // with tecPATH_DRY. fund(env, gw, {alice, bob}, XRP(10'000), {USD(200), EUR(200), JPY(200)}, Fund::All); - AMM ammAliceXRP_USD(env, alice, XRP(100), USD(100)); - AMM ammAliceXRP_EUR(env, alice, XRP(100), EUR(100)); - AMM ammAliceXRP_JPY(env, alice, XRP(100), JPY(100)); + AMM const ammAliceXRP_USD(env, alice, XRP(100), USD(100)); + AMM const ammAliceXRP_EUR(env, alice, XRP(100), EUR(100)); + AMM const ammAliceXRP_JPY(env, alice, XRP(100), JPY(100)); env(pay(alice, bob, JPY(1)), path(~XRP, ~EUR, ~XRP, ~JPY), @@ -2628,7 +2671,7 @@ private: env(pay(gw, dan, USD(1))); n_offers(env, 2'000, bob, XRP(1), USD(1)); n_offers(env, 1, dan, XRP(1), USD(1)); - AMM ammEd(env, ed, XRP(9), USD(11)); + AMM const ammEd(env, ed, XRP(9), USD(11)); // Alice offers to buy 1000 XRP for 1000 USD. She takes Bob's first // offer, removes 999 more as unfunded, then hits the step limit. @@ -2687,7 +2730,7 @@ private: txflags(tfPartialPayment), ter(temBAD_AMOUNT)); env(pay(gw, carol, USD(50))); - AMM ammCarol(env, carol, XRP(10), USD(15)); + AMM const ammCarol(env, carol, XRP(10), USD(15)); env(pay(alice, bob, USD(10)), paths(XRP), deliver_min(USD(7)), @@ -2703,7 +2746,7 @@ private: fund(env, gw, {alice, bob}, XRP(10'000)); env.trust(USD(1'100), alice, bob); env(pay(gw, bob, USD(1'100))); - AMM ammBob(env, bob, XRP(1'000), USD(1'100)); + AMM const ammBob(env, bob, XRP(1'000), USD(1'100)); env(pay(alice, alice, USD(10'000)), paths(XRP), deliver_min(USD(100)), @@ -2717,7 +2760,7 @@ private: fund(env, gw, {alice, bob, carol}, XRP(10'000)); env.trust(USD(1'200), bob, carol); env(pay(gw, bob, USD(1'200))); - AMM ammBob(env, bob, XRP(5'500), USD(1'200)); + AMM const ammBob(env, bob, XRP(5'500), USD(1'200)); env(pay(alice, carol, USD(10'000)), paths(XRP), deliver_min(USD(200)), @@ -2743,7 +2786,7 @@ private: env(pay(gw, dan, USD(1'100))); env(offer(bob, XRP(100), USD(100))); env(offer(bob, XRP(1'000), USD(100))); - AMM ammDan(env, dan, XRP(1'000), USD(1'100)); + AMM const ammDan(env, dan, XRP(1'000), USD(1'100)); if (!features[fixAMMv1_1]) { env(pay(alice, carol, USD(10'000)), @@ -2794,7 +2837,7 @@ private: env(pay(gw, alice, USD(500))); env.close(); - AMM ammAlice(env, alice, XRP(100), USD(140)); + AMM const ammAlice(env, alice, XRP(100), USD(140)); // becky pays herself USD (10) by consuming part of alice's offer. // Make sure the payment works if PaymentAuth is not involved. @@ -2829,7 +2872,7 @@ private: env(pay(gw, alice, USD(150))); env(pay(gw, carol, USD(150))); - AMM ammCarol(env, carol, USD(100), XRPAmount(101)); + AMM const ammCarol(env, carol, USD(100), XRPAmount(101)); // Make sure bob's trust line is all set up so he can receive USD. env(pay(alice, bob, USD(50))); @@ -2926,7 +2969,7 @@ private: env(pay(G1, alice, G1["USD"](205))); env.close(); - AMM ammAlice(env, alice, XRP(500), G1["USD"](105)); + AMM const ammAlice(env, alice, XRP(500), G1["USD"](105)); { auto lines = getAccountLines(env, bob); @@ -3040,11 +3083,11 @@ private: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; env.fund(XRP(12'000), G1); env.fund(XRP(1'000), A1); @@ -3063,7 +3106,7 @@ private: env(pay(G1, A4, G1["BTC"](100))); env.close(); - AMM ammG1(env, G1, XRP(10'000), G1["USD"](100)); + AMM const ammG1(env, G1, XRP(10'000), G1["USD"](100)); env(offer(A1, XRP(10'000), G1["USD"](100)), txflags(tfPassive)); env(offer(A2, G1["USD"](100), XRP(10'000)), txflags(tfPassive)); env.close(); @@ -3129,7 +3172,7 @@ private: env.require(nflags(G1, asfNoFreeze)); // test: assets can't be bought on the market - AMM ammA3(env, A3, G1["BTC"](1), XRP(1), ter(tecFROZEN)); + AMM const ammA3(env, A3, G1["BTC"](1), XRP(1), ter(tecFROZEN)); // test: assets can't be sold on the market // AMM is bidirectional @@ -3170,10 +3213,10 @@ private: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; + Account const G1{"G1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; env.fund(XRP(2'000), G1, A3, A4); env.fund(XRP(2'000), A2); @@ -3188,7 +3231,7 @@ private: env(pay(G1, A4, G1["USD"](2'001))); env.close(); - AMM ammA3(env, A3, XRP(1'000), G1["USD"](1'001)); + AMM const ammA3(env, A3, XRP(1'000), G1["USD"](1'001)); // removal after successful payment // test: make a payment with partially consuming offer @@ -3299,8 +3342,8 @@ private: fund(env, gw, {alice, bob, carol}, XRP(10'000), {USD(2'000), EUR(1'000)}); - AMM bobXRP_USD(env, bob, XRP(1'000), USD(1'000)); - AMM bobUSD_EUR(env, bob, USD(1'000), EUR(1'000)); + AMM const bobXRP_USD(env, bob, XRP(1'000), USD(1'000)); + AMM const bobUSD_EUR(env, bob, USD(1'000), EUR(1'000)); // payment path: XRP -> XRP/USD -> USD/EUR -> EUR/USD env(pay(alice, carol, USD(100)), @@ -3324,13 +3367,12 @@ private: env.trust(USD(1'000), alice, bob); env.trust(EUR(1'000), alice, bob); env.close(); - fund(env, bob, {alice, gw}, {BobUSD(100), BobEUR(100)}, Fund::IOUOnly); - env.close(); + fund(env, bob, {alice, gw}, {BobUSD(100), BobEUR(100)}, Fund::TokenOnly); - AMM ammBobXRP_USD(env, bob, XRP(100), BobUSD(100)); + AMM const ammBobXRP_USD(env, bob, XRP(100), BobUSD(100)); env(offer(gw, XRP(100), USD(100)), txflags(tfPassive)); - AMM ammBobUSD_EUR(env, bob, BobUSD(100), BobEUR(100)); + AMM const ammBobUSD_EUR(env, bob, BobUSD(100), BobEUR(100)); env(offer(gw, USD(100), EUR(100)), txflags(tfPassive)); Path const p = [&] { @@ -3340,7 +3382,7 @@ private: return result; }(); - PathSet paths(p); + PathSet const paths(p); env(pay(alice, alice, EUR(1)), json(paths.json()), @@ -3354,7 +3396,7 @@ private: fund(env, gw, {alice, bob, carol}, XRP(10'000), {USD(100)}); - AMM ammBob(env, bob, XRP(100), USD(100)); + AMM const ammBob(env, bob, XRP(100), USD(100)); // payment path: XRP -> XRP/USD -> USD/XRP env(pay(alice, carol, XRP(100)), @@ -3368,7 +3410,7 @@ private: fund(env, gw, {alice, bob, carol}, XRP(10'000), {USD(100)}); - AMM ammBob(env, bob, XRP(100), USD(100)); + AMM const ammBob(env, bob, XRP(100), USD(100)); // payment path: XRP -> XRP/USD -> USD/XRP env(pay(alice, carol, XRP(100)), @@ -3398,7 +3440,7 @@ private: env(pay(gw, alice, USD(100))); env.close(); - AMM ammBob(env, bob, XRP(100), USD(100)); + AMM const ammBob(env, bob, XRP(100), USD(100)); // payment path: USD -> USD/XRP -> XRP/USD env(pay(alice, carol, USD(100)), @@ -3421,9 +3463,9 @@ private: env(pay(gw, bob, EUR(200))); env(pay(gw, bob, CNY(100))); - AMM ammBobXRP_USD(env, bob, XRP(100), USD(100)); - AMM ammBobUSD_EUR(env, bob, USD(100), EUR(100)); - AMM ammBobEUR_CNY(env, bob, EUR(100), CNY(100)); + AMM const ammBobXRP_USD(env, bob, XRP(100), USD(100)); + AMM const ammBobUSD_EUR(env, bob, USD(100), EUR(100)); + AMM const ammBobEUR_CNY(env, bob, EUR(100), CNY(100)); // payment path: XRP->XRP/USD->USD/EUR->USD/CNY env(pay(alice, carol, CNY(100)), diff --git a/src/test/app/AMMMPT_test.cpp b/src/test/app/AMMMPT_test.cpp new file mode 100644 index 0000000000..35c1522e68 --- /dev/null +++ b/src/test/app/AMMMPT_test.cpp @@ -0,0 +1,7088 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace xrpl { +namespace test { + +/** + * Basic tests of AMM functionality involving MPT assets, excluding those that + * use offers. Tests incorporating offers are in `AMMExtended_test`. + */ +struct AMMMPT_test : public jtx::AMMTest +{ +private: + void + testInstanceCreate() + { + testcase("Instance Create"); + + using namespace jtx; + + // XRP to MPT + testAMM( + [&](AMM& ammAlice, Env&) { + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'000), IOUAmount{10'000'000})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // IOU to MPT + testAMM( + [&](AMM& ammAlice, Env&) { + BEAST_EXPECT(ammAlice.expectBalances( + USD(20'000), MPT(ammAlice[1])(20'000), IOUAmount{20'000})); + }, + {{USD(20'000), AMMMPT(20'000)}}); + + // MPT to MPT + testAMM( + [&](AMM& ammAlice, Env&) { + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(20'000), MPT(ammAlice[1])(20'000), IOUAmount{20'000})); + }, + {{AMMMPT(20'000), AMMMPT(20'000)}}); + + // IOU to MPT + transfer fee + { + Env env{*this}; + fund(env, gw, {alice}, {USD(20'000)}, Fund::All); + env(rate(gw, 1.25)); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .transferFee = 1'500, + .pay = 30'000}); + // no transfer fee on create + AMM const ammAlice(env, alice, USD(20'000), BTC(20'000)); + BEAST_EXPECT(ammAlice.expectBalances(USD(20'000), BTC(20'000), IOUAmount{20'000, 0})); + BEAST_EXPECT(expectHolding(env, alice, USD(0))); + // alice initially had 30'000 + BEAST_EXPECT(expectMPT(env, alice, BTC(10'000))); + } + + // Require authorization is set, account is authorized + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + env.close(); + env(fset(gw, asfRequireAuth)); + env(trust(alice, gw["USD"](30'000), 0)); + env(trust(gw, alice["USD"](0), tfSetfAuth)); + env(pay(gw, alice, USD(10'000))); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTRequireAuth | MPTDEXFlags, + .authHolder = true}); + AMM const ammAlice(env, alice, USD(10'000), BTC(10'000)); + } + + // Cleared global freeze + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + MPTTester USD( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + USD.set({.flags = tfMPTLock}); + AMM const ammAliceFail(env, alice, XRP(10'000), USD(10'000), ter(tecFROZEN)); + USD.set({.flags = tfMPTUnlock}); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'000)); + } + } + + void + testInvalidInstance() + { + testcase("Invalid Instance"); + + using namespace jtx; + + // Can't have both tokens the same MPT + { + Env env{*this}; + env.fund(XRP(30'000), alice, gw); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .transferFee = 1'500, + .pay = 40'000}); + AMM const ammAlice(env, alice, BTC(20'000), BTC(10'000), ter(temBAD_AMM_TOKENS)); + } + + // MPTCanTrade is not set and AMM creator is not the issuer of MPT + { + Env env{*this}; + env.fund(XRP(30'000), alice, gw); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanLock}); + AMM const ammAlice(env, alice, BTC(20'000), XRP(10'000), ter(tecNO_PERMISSION)); + } + + // MPTokenIssuance doesn't exist + { + Env env{*this}; + env.fund(XRP(30'000), alice, gw); + env.close(); + AMM const ammAlice( + env, alice, MPT(gw, 1'000)(20'000), XRP(10'000), ter(tecOBJECT_NOT_FOUND)); + } + + // MPToken doesn't exist and amm creator is not the issuer + { + Env env{*this}; + env.fund(XRP(30'000), alice, gw); + env.close(); + MPT const BTC = MPTTester({ + .env = env, + .issuer = gw, + }); + AMM const ammAlice(env, alice, BTC(20'000), XRP(10'000), ter(tecNO_AUTH)); + } + + // Can't have zero or negative amounts + { + Env env{*this}; + fund(env, gw, {alice}, {USD(20'000)}, Fund::All); + env(rate(gw, 1.25)); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .transferFee = 1'500, + .pay = 30'000}); + + AMM const ammAlice(env, alice, XRP(0), BTC(10'000), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice.ammExists()); + AMM const ammAlice1(env, alice, XRP(10'000), BTC(0), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice1.ammExists()); + AMM const ammAlice2(env, alice, USD(0), BTC(10'000), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice2.ammExists()); + AMM const ammAlice3(env, alice, USD(10'000), BTC(0), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice3.ammExists()); + AMM const ammAlice4(env, alice, XRP(-10'0000), BTC(10'000), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice4.ammExists()); + AMM const ammAlice5(env, alice, XRP(10'000), BTC(-10'000), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice5.ammExists()); + AMM const ammAlice6(env, alice, USD(-10'000), BTC(10'000), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice6.ammExists()); + AMM const ammAlice7(env, alice, USD(10'000), BTC(-10'000), ter(temBAD_AMOUNT)); + BEAST_EXPECT(!ammAlice7.ammExists()); + } + + // Bad MPT + { + Env env{*this}; + fund(env, gw, {alice}, {USD(20'000)}, Fund::All); + + AMM const ammAlice(env, alice, XRP(10'000), MPT(badMPT())(100), ter(temBAD_MPT)); + + BEAST_EXPECT(!ammAlice.ammExists()); + } + + // Insufficient MPT balance + { + Env env{*this}; + fund(env, gw, {alice}, {USD(30'000)}, Fund::All); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .transferFee = 1'500, + .pay = 30'000}); + AMM const ammAlice(env, alice, XRP(10'000), BTC(40'000), ter(tecUNFUNDED_AMM)); + BEAST_EXPECT(!ammAlice.ammExists()); + } + + // Invalid trading fee + { + Env env{*this}; + fund(env, gw, {alice}, {USD(20'000)}, Fund::All); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .transferFee = 1'500, + .pay = 30'000}); + AMM const ammAlice( + env, + alice, + USD(10'000), + BTC(10'000), + false, + 65'001, + 10, + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_FEE)); + BEAST_EXPECT(!ammAlice.ammExists()); + } + + // AMM already exists XRP/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + // Account bob1("bob1"); + env.fund(XRP(30'000), bob); + env.close(); + AMM const ammBob(env, bob, XRP(1'000), MPT(ammAlice[1])(1'000), ter(tecDUPLICATE)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // AMM already exists IOU/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + env.fund(XRP(30'000), bob); + env.close(); + env.trust(USD(10000), bob); + env(pay(gw, bob, USD(100))); + + AMM const ammBob(env, bob, USD(1'000), MPT(ammAlice[1])(1'000), ter(tecDUPLICATE)); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // AMM already exists MPT/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + AMM const ammCarol( + env, + carol, + MPT(ammAlice[0])(1'000), + MPT(ammAlice[1])(2'000), + ter(tecDUPLICATE)); + }, + {{AMMMPT(20'000), AMMMPT(10'000)}}); + + // MPTRequireAuth flag is set and AMM creator is not authorized + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + env.close(); + env(fset(gw, asfRequireAuth)); + env(trust(alice, gw["USD"](30'000), 0)); + env(trust(gw, alice["USD"](0), tfSetfAuth)); + env.close(); + env(pay(gw, alice, USD(10'000))); + env.close(); + MPT const BTC = MPTTester( + {.env = env, .issuer = gw, .holders = {alice}, .flags = tfMPTRequireAuth}); + AMM const ammAlice(env, alice, USD(10'000), BTC(10'000), ter(tecNO_AUTH)); + BEAST_EXPECT(!ammAlice.ammExists()); + } + + // MPTLocked flag is set + { + Env env{*this}; + fund(env, gw, {alice}, {USD(20'000)}, Fund::All); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + BTC.set({.flags = tfMPTLock}); + AMM const ammAlice(env, alice, USD(10'000), BTC(10'000), ter(tecFROZEN)); + BEAST_EXPECT(!ammAlice.ammExists()); + } + + // MPT individually locked + { + Env env{*this}; + fund(env, gw, {alice, bob}, {USD(20'000)}, Fund::All); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + BTC.set({.holder = alice, .flags = tfMPTLock}); + + // alice's token is locked + AMM const ammAlice(env, alice, USD(10'000), BTC(10'000), ter(tecFROZEN)); + BEAST_EXPECT(!ammAlice.ammExists()); + + // bob can create + AMM const ammBob(env, bob, USD(10'000), BTC(10'000)); + BEAST_EXPECT(ammBob.ammExists()); + } + + // OutstandingAmount > MaximumAmount + { + Env env{*this}; + env.fund(XRP(1'000), gw, alice); + + MPTTester const BTC({.env = env, .issuer = gw, .holders = {alice}, .maxAmt = 100}); + + // OutstandingAmount is 0, issuer issues 10 over MaximumAmount + AMM const amm(env, gw, XRP(100), BTC(110), ter(tecUNFUNDED_AMM)); + + env(pay(gw, alice, BTC(100))); + + // OutstandingAmount is 100, issuer issues 100 over MaximumAmount + AMM const amm1(env, gw, XRP(100), BTC(100), ter(tecUNFUNDED_AMM)); + // This is fine - alice transfers 100 to AMM. OutstandingAmount + // is 100. + AMM const ammAlice(env, alice, XRP(100), BTC(100)); + } + } + + void + testInvalidDeposit(FeatureBitset features) + { + testcase("Invalid Deposit"); + + using namespace jtx; + + testAMM( + [&](AMM& ammAlice, Env& env) { + // LPTokenOut can not be zero + ammAlice.deposit(alice, 0, std::nullopt, std::nullopt, ter(temBAD_AMM_TOKENS)); + + // LPTokenOut can not be negative + ammAlice.deposit( + alice, IOUAmount{-1}, std::nullopt, std::nullopt, ter(temBAD_AMM_TOKENS)); + + // LPTokenOut can not be MPT + { + Json::Value jv = Json::objectValue; + jv[jss::Account] = alice.human(); + jv[jss::TransactionType] = jss::AMMDeposit; + jv[jss::Asset] = STIssue(sfAsset, XRP).getJson(JsonOptions::none); + jv[jss::Asset2] = STIssue(sfAsset, MPT(ammAlice[1])).getJson(JsonOptions::none); + jv[jss::LPTokenOut] = MPT(ammAlice[1])(100).value().getJson(JsonOptions::none); + jv[jss::Flags] = tfLPToken; + env(jv, ter(telENV_RPC_FAILED)); + } + + // Provided LPTokenOut does not match AMM pool's LPToken + // asset + { + Json::Value jv = Json::objectValue; + jv[jss::Account] = alice.human(); + jv[jss::TransactionType] = jss::AMMDeposit; + jv[jss::Asset] = STIssue(sfAsset, XRP).getJson(JsonOptions::none); + jv[jss::Asset2] = STIssue(sfAsset, MPT(ammAlice[1])).getJson(JsonOptions::none); + jv[jss::LPTokenOut] = USD(100).value().getJson(JsonOptions::none); + jv[jss::Flags] = tfLPToken; + env(jv, ter(temBAD_AMM_TOKENS)); + } + + // Invalid trading fee + ammAlice.deposit( + carol, + std::nullopt, + XRP(200), + MPT(ammAlice[1])(200), + std::nullopt, + tfTwoAssetIfEmpty, + std::nullopt, + std::nullopt, + 10'000, + ter(temBAD_FEE)); + + // Invalid tokens + { + auto const mpt1 = MPTIssue{MPTID(0xabc)}; + auto const mpt2 = MPTIssue{MPTID(0xdef)}; + ammAlice.deposit( + alice, + 1'000, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + {{mpt1, mpt2}}, + std::nullopt, + std::nullopt, + ter(terNO_AMM)); + } + + // invalid MPT + ammAlice.deposit( + alice, badMPT(), std::nullopt, std::nullopt, std::nullopt, ter(temBAD_MPT)); + ammAlice.deposit( + alice, XRP(100), badMPT(), std::nullopt, std::nullopt, ter(temBAD_MPT)); + + // MPTokenIssuance object doesn't exist + ammAlice.deposit( + alice, + XRP(100), + MPT(gw, 1'000)(100), + std::nullopt, + tfTwoAsset, + ter(temBAD_AMM_TOKENS)); + + // MPToken object doesn't exist + env.fund(XRP(1'000), bob); + ammAlice.deposit( + bob, + XRP(100), + MPT(ammAlice[1])(200), + std::nullopt, + tfTwoAsset, + ter(tecNO_AUTH)); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .flags = tfMPTCanLock | MPTDEXFlags, + .authHolder = true}); + + // Depositing mismatched token, invalid Asset1In.issue + ammAlice.deposit( + alice, + BTC(100), + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_AMM_TOKENS)); + + // Depositing mismatched token, invalid Asset2In.issue + ammAlice.deposit( + alice, XRP(100), BTC(100), std::nullopt, std::nullopt, ter(temBAD_AMM_TOKENS)); + + // Assets can not be the same + ammAlice.deposit( + alice, + MPT(ammAlice[1])(100), + MPT(ammAlice[1])(200), + std::nullopt, + tfTwoAsset, + ter(temBAD_AMM_TOKENS)); + + // Invalid amount value + ammAlice.deposit( + alice, + MPT(ammAlice[1])(0), + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_AMOUNT)); + ammAlice.deposit( + alice, + MPT(ammAlice[1])(-1'000), + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_AMOUNT)); + + // Invalid Account + { + Account bad("bad"); + env.memoize(bad); + ammAlice.deposit( + bad, + std::nullopt, + MPT(ammAlice[1])(1'000), + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + seq(1), + std::nullopt, + ter(terNO_ACCOUNT)); + } + + // Invalid AMM + ammAlice.deposit( + alice, + 1'000, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + {{MPT(BTC), MPT(ammAlice[1])}}, + std::nullopt, + std::nullopt, + ter(terNO_AMM)); + + // Single deposit: 100000 tokens worth of MPT + // Amount to deposit exceeds Max + ammAlice.deposit( + carol, + 100'000, + MPT(ammAlice[1])(200), + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecAMM_FAILED)); + + // Single deposit: 100000 tokens worth of XRP + // Amount to deposit exceeds Max + ammAlice.deposit( + carol, + 100'000, + XRP(200), + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecAMM_FAILED)); + + // Deposit amount is invalid + ammAlice.deposit( + alice, + MPT(ammAlice[1])(0), + std::nullopt, + STAmount{ammAlice.lptIssue(), 1, -1}, + std::nullopt, + ter(tecUNFUNDED_AMM)); + // Calculated amount is 0 + ammAlice.deposit( + alice, + MPT(ammAlice[1])(0), + std::nullopt, + STAmount{ammAlice.lptIssue(), 2'000, -6}, + std::nullopt, + ter(tecAMM_FAILED)); + + // Tiny deposit + ammAlice.deposit( + carol, + IOUAmount{1, -10}, + std::nullopt, + std::nullopt, + ter(tecAMM_INVALID_TOKENS)); + + // Deposit non-empty AMM + ammAlice.deposit( + carol, + XRP(100), + MPT(ammAlice[1])(100), + std::nullopt, + tfTwoAssetIfEmpty, + ter(tecAMM_NOT_EMPTY)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Tiny deposit + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const enabledV1_3 = env.current()->rules().enabled(fixAMMv1_3); + auto const err = !enabledV1_3 ? ter(temBAD_AMOUNT) : ter(tesSUCCESS); + // Pre-amendment XRP deposit side is rounded to 0 + // and deposit fails. + ammAlice.deposit(carol, IOUAmount{1, -1}, std::nullopt, std::nullopt, err); + }, + {{XRP(10'000), AMMMPT(10'000)}}, + 0, + std::nullopt, + {features, features - fixAMMv1_3}); + + // Invalid AMM + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.withdrawAll(alice); + ammAlice.deposit(alice, 10'000, std::nullopt, std::nullopt, ter(terNO_AMM)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit MPT with eprice + // the calculated amount to deposit is negative. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + STAmount{ammAlice.lptIssue(), 1, -1}, + tfLimitLPToken, + ter(tecAMM_FAILED)); + + // although we should use lptoken unit for eprice, + // we don't check the currency any more, we just use + // the value + ammAlice.deposit( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + STAmount{USD, 1, -1}, + tfLimitLPToken, + ter(tecAMM_FAILED)); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Globally locked MPT + { + Env env{*this}; + fund(env, gw, {alice, carol}, {USD(20'000)}, Fund::All); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM ammAlice(env, alice, USD(10'000), BTC(10'000)); + BTC.set({.flags = tfMPTLock}); + + ammAlice.deposit( + carol, BTC(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + ammAlice.deposit( + carol, USD(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + + ammAlice.deposit(carol, USD(100), BTC(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + } + + // Individually lock MPT or freeze IOU (AMM) with IOU/MPT AMM + { + Env env{*this, features}; + fund(env, gw, {alice, carol}, {USD(20'000)}, Fund::All); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM ammAlice(env, alice, USD(10'000), BTC(10'000)); + + // Carol's mpt is locked + BTC.set({.holder = carol, .flags = tfMPTLock}); + + // Carol can not deposit locked mpt + ammAlice.deposit( + carol, BTC(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + + if (!features[featureAMMClawback]) + { + ammAlice.deposit( + carol, USD(100), std::nullopt, std::nullopt, std::nullopt, ter(tecLOCKED)); + } + else + { + // Carol can not deposit non-forzen token either + ammAlice.deposit( + carol, USD(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + } + + // Alice can deposit because she's not individually locked + ammAlice.deposit(alice, BTC(100), std::nullopt, std::nullopt, std::nullopt); + ammAlice.deposit(alice, 1'000, std::nullopt, std::nullopt); + ammAlice.deposit(alice, USD(100), std::nullopt, std::nullopt, std::nullopt); + + // Unlock + BTC.set({.holder = carol, .flags = tfMPTUnlock}); + // Carol can deposit after unlock + ammAlice.deposit(carol, BTC(100), std::nullopt, std::nullopt, std::nullopt); + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt); + + // Individually frozen AMM + env(trust( + gw, STAmount{Issue{gw["USD"].currency, ammAlice.ammAccount()}, 0}, tfSetFreeze)); + env.close(); + + // Can deposit non-frozen token + ammAlice.deposit(carol, BTC(100), std::nullopt, std::nullopt, std::nullopt); + + // Cannot deposit frozen token + ammAlice.deposit(carol, 1'000'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.deposit( + carol, USD(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + // unfreeze IOU + env(trust( + gw, STAmount{Issue{gw["USD"].currency, ammAlice.ammAccount()}, 0}, tfClearFreeze)); + env.close(); + // Can deposit + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt); + + // Individually lock AMM + BTC.set({.holder = ammAlice.ammAccount(), .flags = tfMPTLock}); + + // Can deposit non-frozen token + ammAlice.deposit(carol, USD(100), std::nullopt, std::nullopt, std::nullopt); + + // Can not deposit locked token + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.deposit( + carol, BTC(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + // Unlock AMM MPT + BTC.set({.holder = ammAlice.ammAccount(), .flags = tfMPTUnlock}); + // can deposit + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt); + ammAlice.deposit(carol, BTC(100), std::nullopt, std::nullopt, std::nullopt); + } + + // Individually lock MPT (AMM) account with MPT/MPT AMM + { + Env env{*this}; + env.fund(XRP(10'000), gw, alice, carol); + env.close(); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + MPTTester USD( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 40'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM ammAlice(env, alice, USD(10'000), BTC(10'000)); + + // Carol's BTC is locked + BTC.set({.holder = carol, .flags = tfMPTLock}); + ammAlice.deposit( + carol, USD(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + ammAlice.deposit( + carol, BTC(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + // Unlock carol's BTC + BTC.set({.holder = carol, .flags = tfMPTUnlock}); + + // Can deposit + ammAlice.deposit(carol, USD(100), std::nullopt, std::nullopt, std::nullopt); + ammAlice.deposit(carol, BTC(100), std::nullopt, std::nullopt, std::nullopt); + + // Individually lock MPT BTC (AMM) account + BTC.set({.holder = ammAlice.ammAccount(), .flags = tfMPTLock}); + + // Can deposit non-locked token USD + ammAlice.deposit(carol, USD(100), std::nullopt, std::nullopt, std::nullopt); + + // Can not deposit locked token BTC + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.deposit( + carol, BTC(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + // Unlock AMM MPT BTC + BTC.set({.holder = ammAlice.ammAccount(), .flags = tfMPTUnlock}); + // Can deposit BTC + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt); + ammAlice.deposit(carol, BTC(100), std::nullopt, std::nullopt, std::nullopt); + + // Individually Lock MPT USD (AMM) account + USD.set({.holder = ammAlice.ammAccount(), .flags = tfMPTLock}); + + // Can deposit non-locked token BTC + ammAlice.deposit(carol, BTC(100), std::nullopt, std::nullopt, std::nullopt); + + // Can not deposit locked token USD + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.deposit( + carol, USD(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); + + // Unlock AMM MPT USD + USD.set({.holder = ammAlice.ammAccount(), .flags = tfMPTUnlock}); + // Can deposit USD + ammAlice.deposit(carol, 1'000, std::nullopt, std::nullopt); + ammAlice.deposit(carol, USD(100), std::nullopt, std::nullopt, std::nullopt); + } + + // Deposit unauthorized token + { + Env env{*this, features}; + Account const gw("gateway"), alice{"alice"}, carol{"carol"}; + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + + MPTTester BTC(env, gw, {.holders = {alice, carol}, .fund = false}); + BTC.create( + {.maxAmt = 1'000'000, + .authorize = {{alice}}, + .pay = {{{alice}, 10'000}}, + .flags = tfMPTRequireAuth | MPTDEXFlags, + .authHolder = true}); + + AMM amm(env, alice, XRP(10'000), BTC(10'000)); + env.close(); + + if (!features[featureAMMClawback]) + { + amm.deposit(carol, XRP(10), std::nullopt, std::nullopt, std::nullopt); + } + else + { + amm.deposit( + carol, XRP(10), std::nullopt, std::nullopt, std::nullopt, ter(tecNO_AUTH)); + } + } + + // MPTCanTransfer is not set and the account is not the issuer of MPT + { + Env env{*this, features}; + Account const gw("gateway"), alice{"alice"}, carol{"carol"}; + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 1'000, + .flags = tfMPTCanTrade}); + + AMM amm(env, gw, XRP(10'000), BTC(10'000)); + + amm.deposit({.account = alice, .asset1In = BTC(10), .err = ter(tecNO_PERMISSION)}); + } + + // Insufficient XRP balance + testAMM( + [&](AMM& ammAlice, Env& env) { + env.fund(XRP(1'000), bob); + env.close(); + ammAlice.deposit(bob, XRP(10)); + ammAlice.deposit( + bob, + XRP(1'000), + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecUNFUNDED_AMM)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Insufficient MPT balance + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + MPT(ammAlice[1])(450'000), + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecUNFUNDED_AMM)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Insufficient IOU balance + testAMM( + [&](AMM& ammAlice, Env& env) { + fund(env, gw, {bob}, {USD(1'000)}, Fund::Acct); + ammAlice.deposit( + bob, + USD(1'001), + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecUNFUNDED_AMM)); + }, + {{USD(1000), AMMMPT(1000)}}); + + // Insufficient MPT balance by tokens + { + Env env{*this}; + env.fund(XRP(30'000), alice, bob, gw); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .transferFee = 1'500, + .pay = 1000}); + AMM ammAlice(env, alice, XRP(20'000), BTC(1000)); + ammAlice.deposit( + bob, + 10'000'000, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecUNFUNDED_AMM)); + } + + // Insufficient reserve, XRP/MPT + { + Env env(*this); + auto const starting_xrp = reserve(env, 4) + env.current()->fees().base * 4; + env.fund(XRP(10'000), gw); + env.fund(XRP(10'000), alice); + env.fund(starting_xrp, carol); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 1'500, + .pay = 40'000}); + + env(offer(carol, XRP(100), BTC(101))); + AMM ammAlice(env, alice, XRP(1000), BTC(1000)); + ammAlice.deposit( + carol, + XRP(100), + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecINSUF_RESERVE_LINE)); + + env(offer(carol, XRP(100), BTC(102))); + ammAlice.deposit( + carol, + BTC(100), + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecINSUF_RESERVE_LINE)); + } + + // Invalid min + testAMM( + [&](AMM& ammAlice, Env& env) { + // min tokens can't be <= zero + ammAlice.deposit(carol, 0, XRP(100), tfSingleAsset, ter(temBAD_AMM_TOKENS)); + ammAlice.deposit(carol, -1, XRP(100), tfSingleAsset, ter(temBAD_AMM_TOKENS)); + ammAlice.deposit( + carol, + 0, + XRP(100), + MPT(ammAlice[1])(100), + std::nullopt, + tfTwoAsset, + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_AMM_TOKENS)); + + // min amounts can't be <= zero + ammAlice.deposit( + carol, + 1'000, + XRP(0), + MPT(ammAlice[1])(100), + std::nullopt, + tfTwoAsset, + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_AMOUNT)); + ammAlice.deposit( + carol, + 1'000, + XRP(100), + MPT(ammAlice[1])(-1), + std::nullopt, + tfTwoAsset, + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_AMOUNT)); + ammAlice.deposit( + carol, + 1'000, + XRP(100), + badMPT(), + std::nullopt, + tfTwoAsset, + std::nullopt, + std::nullopt, + std::nullopt, + ter(temBAD_MPT)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Min deposit + testAMM( + [&](AMM& ammAlice, Env& env) { + // Equal deposit by tokens + ammAlice.deposit( + carol, + 1'000'000, + XRP(1'000), + MPT(ammAlice[1])(1'001), + std::nullopt, + tfLPToken, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecAMM_FAILED)); + ammAlice.deposit( + carol, + 1'000'000, + XRP(1'001), + MPT(ammAlice[1])(1'000), + std::nullopt, + tfLPToken, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecAMM_FAILED)); + // Equal deposit by asset + ammAlice.deposit( + carol, + 100'001, + XRP(100), + MPT(ammAlice[1])(100), + std::nullopt, + tfTwoAsset, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecAMM_FAILED)); + // Single deposit by asset + ammAlice.deposit( + carol, + 488'090, + XRP(1'000), + std::nullopt, + std::nullopt, + tfSingleAsset, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecAMM_FAILED)); + }, + {{XRP(1000), AMMMPT(1000)}}); + + // OutstandingAmount > MaximumAmount + { + Env env{*this}; + env.fund(XRP(1'000), gw, alice); + + MPTTester const BTC({.env = env, .issuer = gw, .holders = {alice}, .maxAmt = 100}); + + AMM amm(env, gw, XRP(100), BTC(90)); + // OutstandingAmount is 90, issuer issues 1 over MaximumAmount + amm.deposit( + DepositArg{.account = gw, .asset1In = BTC(11), .err = ter(tecUNFUNDED_AMM)}); + + env(pay(gw, alice, BTC(10))); + + // OutstandingAmount is 100, issuer issues 10 over MaximumAmount + amm.deposit( + DepositArg{.account = gw, .asset1In = BTC(10), .err = ter(tecUNFUNDED_AMM)}); + // This is fine - alice transfers 10 to AMM. OutstandingAmount + // is 100. + amm.deposit(DepositArg{.account = alice, .asset1In = BTC(10)}); + } + } + + void + testDeposit() + { + testcase("Deposit"); + + using namespace jtx; + + // Equal deposit: 1000000 tokens. XRP/MPT AMM. + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{11'000'000, 0})); + + // carol deposited 1000 XRP and pays the transaction fee + env.require(balance(carol, carolXRP - XRP(1000) - drops(baseFee))); + // carol deposited 1000 MPT + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(1000))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // single deposit MPT with eprice + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + STAmount{ammAlice.lptIssue(), 1, -1}, + tfLimitLPToken); + + // although we should use lptoken unit for eprice, + // we don't check the currency any more, we just use + // the value + ammAlice.deposit( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + STAmount{USD, 1, -1}, + tfLimitLPToken); + }, + {{USD(10'000'000), AMMMPT(10'000)}}); + + // Equal deposit: 1000000 tokens. IOU/MPT combination + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto carolBTC = env.balance(carol, BTC); + auto carolUSD = env.balance(carol, USD); + + ammAlice.deposit(carol, 1'000); + BEAST_EXPECT(ammAlice.expectBalances(BTC(11'000), USD(11'000), IOUAmount(11'000))); + + env.require(balance(carol, carolBTC - BTC(1000))); + env.require(balance(carol, carolUSD - USD(1000))); + }; + testHelper2TokensMix(test); + } + + // Deposit 100MPT/100XRP. XRP/MPT AMM. + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, MPT(ammAlice[1])(100), XRP(100)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'100), MPT(ammAlice[1])(10'100), IOUAmount{10'100'000, 0})); + + env.require(balance(carol, carolXRP - XRP(100) - drops(baseFee))); + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(100))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Deposit MPT/IOU combination + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto carolBTC = env.balance(carol, BTC); + auto carolUSD = env.balance(carol, USD); + ammAlice.deposit(carol, BTC(100), USD(100)); + + BEAST_EXPECT(ammAlice.expectBalances(BTC(10'100), USD(10'100), IOUAmount(10'100))); + + env.require(balance(carol, carolBTC - BTC(100))); + env.require(balance(carol, carolUSD - USD(100))); + }; + testHelper2TokensMix(test); + } + + // Equal limit deposit. + // Try to deposit 200MPT/100XRP. Is truncated to 100MPT/100XRP. + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, MPT(ammAlice[1])(200), XRP(100)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'100), MPT(ammAlice[1])(10'100), IOUAmount{10'100'000, 0})); + + env.require(balance(carol, carolXRP - XRP(100) - drops(baseFee))); + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(100))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal limit deposit. MPT/IOU combination. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto carolBTC = env.balance(carol, BTC); + auto carolUSD = env.balance(carol, USD); + ammAlice.deposit(carol, BTC(200), USD(100)); + BEAST_EXPECT(ammAlice.expectBalances(BTC(10'100), USD(10'100), IOUAmount(10'100))); + + env.require(balance(carol, carolBTC - BTC(100))); + env.require(balance(carol, carolUSD - USD(100))); + }; + testHelper2TokensMix(test); + } + + // Single deposit: 1000 MPT into MPT/XRP + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, MPT(ammAlice[1])(1000)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(11'000), IOUAmount{10'488'088'48170151, -8})); + + env.require(balance(carol, carolXRP - drops(baseFee))); + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(1000))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit: 1000 XRP into MPT/XRP + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, XRP(1000)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(10'000), IOUAmount{10'488'088'48170151, -8})); + + env.require(balance(carol, carolXRP - XRP(1000) - drops(baseFee))); + env.require(balance(carol, carolMPT)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit: 1000 MPT0 into MPT/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + auto carolMPT0 = env.balance(carol, MPT(ammAlice[0])); + auto carolMPT1 = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, MPT(ammAlice[0])(1000)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(11'000), + MPT(ammAlice[1])(10'000), + IOUAmount{10'488'08848170151, -11})); + + env.require(balance(carol, carolMPT0 - MPT(ammAlice[0])(1000))); + env.require(balance(carol, carolMPT1)); + }, + {{AMMMPT(10'000), AMMMPT(10'000)}}); + + // Single deposit: 1000 MPT into MPT/IOU + testAMM( + [&](AMM& ammAlice, Env& env) { + auto carolMPT = env.balance(carol, MPT(ammAlice[0])); + auto carolUSD = env.balance(carol, USD); + + ammAlice.deposit(carol, MPT(ammAlice[0])(1000)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(11'000), USD(10'000), IOUAmount{10'488'08848170151, -11})); + + env.require(balance(carol, carolMPT - MPT(ammAlice[0])(1000))); + env.require(balance(carol, carolUSD)); + }, + {{AMMMPT(10'000), USD(10'000)}}); + + // Single deposit: 1000 IOU into MPT/IOU + testAMM( + [&](AMM& ammAlice, Env& env) { + auto carolMPT = env.balance(carol, MPT(ammAlice[0])); + auto carolUSD = env.balance(carol, USD); + + ammAlice.deposit(carol, USD(1000)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000), + STAmount{USD, UINT64_C(10999'99999999999), -11}, + IOUAmount{10'488'08848170151, -11})); + + env.require(balance(carol, carolMPT)); + env.require( + balance(carol, carolUSD - STAmount{USD, UINT64_C(999'99999999999), -11})); + }, + {{AMMMPT(10'000), USD(10'000)}}); + + // Single deposit: 100000 tokens worth of MPT into XRP/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, 100'000, MPT(ammAlice[1])(205)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'201), IOUAmount{10'100'000, 0})); + + env.require(balance(carol, carolXRP - drops(baseFee))); + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(201))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit: 100000 tokens worth of XRP into XRP/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit(carol, 100'000, XRP(205)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'201), MPT(ammAlice[1])(10'000), IOUAmount{10'100'000, 0})); + + env.require(balance(carol, carolXRP - XRP(201) - drops(baseFee))); + env.require(balance(carol, carolMPT)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit: 100 tokens worth of MPT/IOU into pool of MPT/IOU + // combination + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto carolBTC = env.balance(carol, BTC); + auto carolUSD = env.balance(carol, USD); + + ammAlice.deposit(carol, 100, USD(205)); + auto deltaUSD = [&]() { + if constexpr (std::is_same_v>) + return USD(202); + return USD(201); + }(); + BEAST_EXPECT(ammAlice.expectBalances( + BTC(10'000), USD(10'000) + deltaUSD, IOUAmount{10'100, 0})); + + env.require(balance(carol, carolBTC)); + env.require(balance(carol, carolUSD - deltaUSD)); + }; + testHelper2TokensMix(test); + } + + // Single deposit with EP not exceeding specified: + // 100 MPT with EP not to exceed 0.1 (AssetIn/TokensOut) + // for XRP/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + STAmount{ammAlice.lptIssue(), 1, -1}); + + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10100), IOUAmount{10'049'875'62112089, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit with EP not exceeding specified: + // 100 MPT with EP not to exceed 0.002004 (AssetIn/TokensOut) + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + STAmount{ammAlice.lptIssue(), 2004, -6}); + + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'081), IOUAmount{10'039'920'31840891, -8})); + + env.require(balance(carol, carolXRP - drops(baseFee))); + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(81))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit with EP not exceeding specified: + // 0 MPT with EP not to exceed 0.002004 (AssetIn/TokensOut) + testAMM( + [&](AMM& ammAlice, Env& env) { + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + ammAlice.deposit( + carol, + MPT(ammAlice[1])(0), + std::nullopt, + STAmount{ammAlice.lptIssue(), 2004, -6}); + + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'081), IOUAmount{10'039'920'31840891, -8})); + + env.require(balance(carol, carolXRP - drops(baseFee))); + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(81))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit with EP not exceeding specified: + // 100 MPT with EP not to exceed 0.1 (AssetIn/TokensOut) + // for IOU/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + STAmount{ammAlice.lptIssue(), 1, -1}); + + BEAST_EXPECT(ammAlice.expectBalances( + USD(10'000'000'000), + MPT(ammAlice[1])(10100), + IOUAmount{10'049'875'62112089, -8})); + }, + {{USD(10'000'000'000), AMMMPT(10'000)}}); + + // Single deposit with EP not exceeding specified: + // 100 IOU with EP not to exceed 0.1 (AssetIn/TokensOut) + // for IOU/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, USD(100), std::nullopt, STAmount{USD, 1, -1}); + + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[1])(10'000'000'000), + USD(10100), + IOUAmount{10'049'875'62112089, -8})); + }, + {{USD(10'000), AMMMPT(10'000'000'000)}}); + + // Single deposit with EP not exceeding specified: + // 100 IOU with EP not to exceed 0.1 (AssetIn/TokensOut) + // for MPT/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + MPT(ammAlice[0])(100), + std::nullopt, + STAmount{ammAlice.lptIssue(), 1, -1}); + + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[1])(10'000'000'000), + MPT(ammAlice[0])(10100), + IOUAmount{10'049'875'62112089, -8})); + }, + {{AMMMPT(10'000), AMMMPT(10'000'000'000)}}); + + // MPT/MPT with transfer fee + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 25'000, + .pay = 400'000}); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 25'000, + .pay = 400'000}); + + AMM ammAlice(env, alice, USD(200'000), BTC(5)); + BEAST_EXPECT(ammAlice.expectBalances(USD(200'000), BTC(5), IOUAmount{1000, 0})); + + ammAlice.deposit(carol, 100, std::nullopt, std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances(USD(220'000), BTC(6), IOUAmount{1100, 0})); + } + + // IOU/MPT with transfer fee + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, bob, carol); + env.close(); + + env(rate(gw, 1.25)); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 400'000}); + + auto const USD = gw["USD"]; + env.trust(USD(1000000), alice); + env(pay(gw, alice, USD(1000000))); + env.trust(USD(1000000), bob); + env(pay(gw, bob, USD(1000000))); + env.trust(USD(1000000), carol); + env(pay(gw, carol, USD(1000000))); + env.close(); + + // IOU/MPT + AMM ammAlice(env, alice, USD(200'000), BTC(5)); + BEAST_EXPECT(ammAlice.expectBalances(USD(200'000), BTC(5), IOUAmount{1000, 0})); + ammAlice.deposit(carol, 100, std::nullopt, std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances(USD(220'000), BTC(6), IOUAmount{1100, 0})); + + MPT const ETH = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 400'000}); + + // MPT/IOU + AMM ammBob(env, bob, ETH(20'000), USD(0.5)); + BEAST_EXPECT(ammBob.expectBalances(ETH(20'000), USD(0.5), IOUAmount{100, 0})); + ammBob.deposit(carol, 10); + BEAST_EXPECT(ammBob.expectBalances(ETH(22'000), USD(0.55), IOUAmount{110, 0})); + } + + // Tiny deposits for IOU/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + // tiny amount causes MPT to deposit rounded to 0 + ammAlice.deposit(carol, IOUAmount{1, -3}, std::nullopt, std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(10'000'001), -3}, + MPT(ammAlice[1])(10'001), + IOUAmount{10'000'001, -3})); + + ammAlice.deposit(carol, IOUAmount{1}); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(10'001'001), -3}, + MPT(ammAlice[1])(10'003), + IOUAmount{10'001'001, -3})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, STAmount{USD, 1, -10}); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(10'000'00000000008), -11}, + MPT(ammAlice[1])(10'000), + IOUAmount{1'000'000'000000004, -11})); + + ammAlice.deposit(carol, MPT(ammAlice[1])(1)); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(10'000'00000000008), -11}, + MPT(ammAlice[1])(10'001), + IOUAmount{10'000'49998750066, -11})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Tiny deposits for XRP/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, XRPAmount{1}); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount{10'000'000'001}, + MPT(ammAlice[1])(10'000), + IOUAmount{1'000'000'000049999, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, MPT(ammAlice[1])(1)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'001), IOUAmount{10'000'499'98750062, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Tiny deposits for MPT/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, MPT(ammAlice[1])(1)); + + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000), + MPT(ammAlice[1])(10'001), + IOUAmount{1'000'049'998750062, -11})); + }, + {{AMMMPT(10'000), AMMMPT(10'000)}}); + + // MPT Issuer create/deposit + { + Env env(*this); + env.fund(XRP(30'000), gw); + env.close(); + + MPT const BTC = MPTTester({.env = env, .issuer = gw, .holders = {}}); + + AMM ammGw(env, gw, XRP(10'000), BTC(10'000'000'000)); + BEAST_EXPECT( + ammGw.expectBalances(XRP(10'000), BTC(10'000'000'000), IOUAmount{10'000'000'000})); + + ammGw.deposit(gw, 1'000'000); + BEAST_EXPECT( + ammGw.expectBalances(XRP(10'001), BTC(10'001000000), IOUAmount{10'001000000})); + + ammGw.deposit(gw, BTC(1'000000000)); + BEAST_EXPECT(ammGw.expectBalances( + XRP(10'001), BTC(11'001000000), IOUAmount{1048'908'961731188, -5})); + } + + // Issuer deposit in MPT/MPT pool + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(gw, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(1'010'000), + MPT(ammAlice[1])(1'010'000), + IOUAmount{1'010'000})); + + ammAlice.deposit(gw, MPT(ammAlice[0])(1000)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(1'010'999), + MPT(ammAlice[1])(1'010'000), + IOUAmount{1'010'499'376546071, -9})); + }, + {{AMMMPT(10'000), AMMMPT(10'000)}}); + + // Issuer deposit in MPT/XRP pool + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(gw, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{11'000'000})); + ammAlice.deposit(gw, MPT(ammAlice[1])(1'000)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(12'000), IOUAmount{11'489'125'29307605, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal deposit by tokens MPT/XRP + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + 1'000'000, + XRP(1'000), + MPT(ammAlice[1])(1'000), + std::nullopt, + tfLPToken, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{11'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal deposit by tokens MPT/IOU combination + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto carolBTC = env.balance(carol, BTC); + auto carolUSD = env.balance(carol, USD); + + ammAlice.deposit( + carol, + 1'000, + USD(1'000), + BTC(1'000), + std::nullopt, + tfLPToken, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances(USD(11'000), BTC(11'000), IOUAmount{11'000})); + + env.require(balance(carol, carolBTC - BTC(1000))); + env.require(balance(carol, carolUSD - USD(1000))); + }; + testHelper2TokensMix(test); + } + + // Equal deposit by asset XRP/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + 1'000'000, + XRP(1'000), + MPT(ammAlice[1])(1'000), + std::nullopt, + tfTwoAsset, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{11'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal deposit by asset IOU/MPT combination + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto carolBTC = env.balance(carol, BTC); + auto carolUSD = env.balance(carol, USD); + + ammAlice.deposit( + carol, + 1'000, + USD(1'000), + BTC(1'000), + std::nullopt, + tfTwoAsset, + std::nullopt, + std::nullopt); + BEAST_EXPECT( + ammAlice.expectBalances(USD(11'000), BTC(11'000), IOUAmount{11'000, 0})); + + env.require(balance(carol, carolBTC - BTC(1000))); + env.require(balance(carol, carolUSD - USD(1000))); + }; + testHelper2TokensMix(test); + } + + // Single deposit XRP by asset MPT/XRP + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + 488'088, + XRP(1'000), + std::nullopt, + std::nullopt, + tfSingleAsset, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(10'000), IOUAmount{10'488'088'48170151, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit MPT by asset MPT/XRP + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + 488'088, + MPT(ammAlice[1])(1'000), + std::nullopt, + std::nullopt, + tfSingleAsset, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(11'000), IOUAmount{10'488'088'48170151, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit IOU by asset MPT/IOU + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + 488, + USD(1'000), + std::nullopt, + std::nullopt, + tfSingleAsset, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(10'999'99999999999), -11}, + MPT(ammAlice[1])(10'000), + IOUAmount{10'488'08848170151, -11})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Single deposit MPT by asset MPT/IOU + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + 488, + MPT(ammAlice[1])(1'000), + std::nullopt, + std::nullopt, + tfSingleAsset, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + USD(10'000), MPT(ammAlice[1])(11'000), IOUAmount{10'488'088'48170151, -11})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Single deposit MPT by asset MPT/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit( + carol, + 488, + MPT(ammAlice[1])(1'000), + std::nullopt, + std::nullopt, + tfSingleAsset, + std::nullopt, + std::nullopt); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000), + MPT(ammAlice[1])(11'000), + IOUAmount{10'488'088'48170151, -11})); + }, + {{AMMMPT(10'000), AMMMPT(10'000)}}); + } + + void + testInvalidWithdraw() + { + testcase("Invalid AMMWithdraw"); + + using namespace jtx; + auto const all = testable_amendments(); + + testAMM( + [&](AMM& ammAlice, Env& env) { + WithdrawArg const args{ + .asset1Out = XRP(100), + .err = ter(tecAMM_BALANCE), + }; + ammAlice.withdraw(args); + }, + {{XRP(99), AMMMPT(99)}}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + WithdrawArg const args{ + .asset1Out = MPT(ammAlice[1])(100), + .err = ter(tecAMM_BALANCE), + }; + ammAlice.withdraw(args); + }, + {{XRP(99), AMMMPT(99)}}); + + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice, bob); + env.close(); + // alice is authorized to hold gw MPT, bob is not authorized + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTRequireAuth | MPTDEXFlags, + .authHolder = true}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + WithdrawArg const args{ + .account = bob, + .asset1Out = BTC(100), + .err = ter(tecNO_AUTH), + }; + ammAlice.withdraw(args); + } + + testAMM( + [&](AMM& ammAlice, Env& env) { + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 2'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + // Invalid tokens + ammAlice.withdraw(alice, 0, std::nullopt, std::nullopt, ter(temBAD_AMM_TOKENS)); + ammAlice.withdraw( + alice, IOUAmount{-1}, std::nullopt, std::nullopt, ter(temBAD_AMM_TOKENS)); + + // Mismatched token, invalid Asset1Out issue + ammAlice.withdraw( + alice, BTC(100), std::nullopt, std::nullopt, ter(temBAD_AMM_TOKENS)); + ammAlice.withdraw( + alice, MPT(badMPT())(100), std::nullopt, std::nullopt, ter(temBAD_MPT)); + + // Mismatched token, invalid Asset2Out issue + ammAlice.withdraw(alice, XRP(100), BTC(100), std::nullopt, ter(temBAD_AMM_TOKENS)); + + // Mismatched token, Asset1Out.issue == Asset2Out.issue + ammAlice.withdraw( + alice, + MPT(ammAlice[1])(100), + MPT(ammAlice[1])(100), + std::nullopt, + ter(temBAD_AMM_TOKENS)); + + // Invalid amount value + ammAlice.withdraw( + alice, MPT(ammAlice[1])(0), std::nullopt, std::nullopt, ter(temBAD_AMOUNT)); + ammAlice.withdraw( + alice, MPT(ammAlice[1])(-100), std::nullopt, std::nullopt, ter(temBAD_AMOUNT)); + ammAlice.withdraw( + alice, MPT(ammAlice[1])(10), std::nullopt, IOUAmount{-1}, ter(temBAD_AMOUNT)); + + // Invalid amount/token value, withdraw all tokens from one side + // of the pool. + ammAlice.withdraw( + alice, + MPT(ammAlice[1])(10'000), + std::nullopt, + std::nullopt, + ter(tecAMM_BALANCE)); + ammAlice.withdraw( + alice, XRP(10'000), std::nullopt, std::nullopt, ter(tecAMM_BALANCE)); + ammAlice.withdraw( + alice, + std::nullopt, + MPT(ammAlice[1])(0), + std::nullopt, + std::nullopt, + tfOneAssetWithdrawAll, + std::nullopt, + std::nullopt, + ter(tecAMM_BALANCE)); + + // Bad MPT + ammAlice.withdraw( + alice, XRP(100), MPT(badMPT())(100), std::nullopt, ter(temBAD_MPT)); + + // Specified MPToken doesn't match the pool assets + ammAlice.withdraw( + alice, XRP(100), MPT(noMPT())(100), std::nullopt, ter(temBAD_AMM_TOKENS)); + + // Invalid Account + Account bad("bad"); + env.memoize(bad); + ammAlice.withdraw( + bad, + 1'000'000, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + seq(1), + ter(terNO_ACCOUNT)); + + // Invalid AMM + ammAlice.withdraw( + alice, + 1'000, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + {{MPT(ammAlice[1]), GBP}}, + std::nullopt, + ter(terNO_AMM)); + + // Carol is not a Liquidity Provider + ammAlice.withdraw(carol, 10'000, std::nullopt, std::nullopt, ter(tecAMM_BALANCE)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + // Withdraw entire one side of the pool. + // Pre-fixAMMv1_3: + // Equal withdraw but due to MPT precision limit, + // this results in full withdraw of MPT pool only, + // while leaving a tiny amount in USD pool. + // Post-fixAMMv1_3: + // Most of the pool is withdrawn with remaining tiny amounts + auto err = env.enabled(fixAMMv1_3) ? ter(tesSUCCESS) : ter(tecAMM_BALANCE); + ammAlice.withdraw( + alice, IOUAmount{9'999'999'9999, -4}, std::nullopt, std::nullopt, err); + if (env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(1), STAmount{USD, 1, -7}, IOUAmount{1, -4})); + } + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}, + 0, + std::nullopt, + {all, all - fixAMMv1_3}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + // Similar to above with even smaller remaining amount + // Pre-fixAMMv1_3: results in full withdraw of MPT pool only, + // returning tecAMM_BALANCE. Post-fixAMMv1_3: most of the pool + // is withdrawn with remaining tiny amounts + auto err = env.enabled(fixAMMv1_3) ? ter(tesSUCCESS) : ter(tecAMM_BALANCE); + ammAlice.withdraw( + alice, IOUAmount{9'999'999'999999999, -9}, std::nullopt, std::nullopt, err); + if (env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(1), STAmount{USD, 1, -11}, IOUAmount{1, -8})); + } + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}, + 0, + std::nullopt, + {all, all - fixAMMv1_3}); + + // Invalid AMM + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.withdrawAll(alice); + ammAlice.withdraw(alice, 10'000, std::nullopt, std::nullopt, ter(terNO_AMM)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // MPTokenIssuance object doesn't exist + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + env.close(); + MPT const BTC = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 30'000}); + + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + + ammAlice.withdraw( + WithdrawArg{ + .account = alice, + .asset1Out = MPT(gw, 1'000)(10), + .assets = {{XRP, MPT(gw, 1'000)}}, + .err = ter(terNO_AMM)}); + } + + // MPTRequireAuth flag is set and the account is not authorized + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + env.close(); + auto BTCM = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTRequireAuth | MPTDEXFlags, + .authHolder = true}); + MPT const BTC = BTCM; + + AMM amm(env, alice, XRP(10'000), BTC(10'000)); + + BTCM.authorize({.account = gw, .holder = alice, .flags = tfMPTUnauthorize}); + + amm.withdraw( + WithdrawArg{ + .account = alice, + .asset1Out = BTC(100), + .assets = {{XRP, BTC}}, + .err = ter(tecNO_AUTH)}); + } + + // MPTCanTransfer is not set and the account is not the issuer of MPT + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + env.close(); + auto BTCM = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanTrade, + .authHolder = true}); + MPT const BTC = BTCM; + + AMM amm(env, gw, XRP(10'000), BTC(10'000)); + + amm.withdraw( + WithdrawArg{ + .account = alice, + .asset1Out = BTC(100), + .assets = {{XRP, BTC}}, + .err = ter(tecNO_PERMISSION)}); + } + + // Globally locked MPT + // MPTLocked flag is set and the account is not the issuer of MPT + { + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + env.close(); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags, + .authHolder = true}); + + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + BTC.set({.flags = tfMPTLock}); + + ammAlice.withdraw( + alice, MPT(ammAlice[1])(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + + // can single withdraw the other asset + ammAlice.withdraw({.account = alice, .asset1Out = XRP(100)}); + } + + // Individually frozen (AMM) account with MPT/MPT AMM + { + Env env{*this}; + env.fund(XRP(10'000), gw, alice); + env.close(); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + MPTTester const USD( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM ammAlice(env, alice, USD(10'000), BTC(10'000)); + + // Alice's BTC is locked + BTC.set({.holder = alice, .flags = tfMPTLock}); + ammAlice.withdraw(alice, 1000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.withdraw(alice, BTC(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + + // can withdraw the other asset + ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt); + + // Unlock and then alice can withdraw + BTC.set({.holder = alice, .flags = tfMPTUnlock}); + ammAlice.withdraw(alice, 1000, std::nullopt, std::nullopt); + ammAlice.withdraw(alice, BTC(100), std::nullopt, std::nullopt); + ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt); + } + + // Individually lock MPT or freeze IOU (AMM) + { + Env env{*this}; + fund(env, gw, {alice}, {USD(20'000)}, Fund::All); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM ammAlice(env, alice, USD(10'000), BTC(10'000)); + + // Alice's BTC is locked + BTC.set({.holder = alice, .flags = tfMPTLock}); + + ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.withdraw(alice, BTC(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + // can still single withdraw the unlocked other asset + ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt); + + // Unlock alice's BTC + BTC.set({.holder = alice, .flags = tfMPTUnlock}); + + // Now alice can withdraw + ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt); + ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt); + ammAlice.withdraw(alice, BTC(100), std::nullopt, std::nullopt); + + // Individually lock MPT BTC (AMM) account + BTC.set({.holder = ammAlice.ammAccount(), .flags = tfMPTLock}); + + // Can withdraw non-frozen token USD + ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt); + + // Can not withdraw locked token BTC + ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.withdraw(alice, BTC(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + + // Unlock AMM MPT + BTC.set({.holder = ammAlice.ammAccount(), .flags = tfMPTUnlock}); + // Can withdraw + ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt); + ammAlice.withdraw(alice, BTC(100), std::nullopt, std::nullopt); + + // Individually frozen AMM + env(trust( + gw, STAmount{Issue{gw["USD"].currency, ammAlice.ammAccount()}, 0}, tfSetFreeze)); + env.close(); + + // Can withdraw non-locked token BTC + ammAlice.withdraw(alice, BTC(100), std::nullopt, std::nullopt); + + // Can not withdraw frozen token USD + ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + + // Unfreeze + env(trust( + gw, STAmount{Issue{gw["USD"].currency, ammAlice.ammAccount()}, 0}, tfClearFreeze)); + env.close(); + + // Can withdraw + ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt); + ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt); + } + + // Carol withdraws more than she owns + testAMM( + [&](AMM& ammAlice, Env&) { + // Single deposit of 100000 worth of tokens + // which is 10% of the pool. Carol is LP now. + ammAlice.deposit(carol, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{11'000'000, 0})); + + ammAlice.withdraw( + carol, 2'000'000, std::nullopt, std::nullopt, ter(tecAMM_INVALID_TOKENS)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{11'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Withdraw with EPrice limit. Fails to withdraw, calculated tokens + // to withdraw are 0. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000); + auto const err = + env.enabled(fixAMMv1_3) ? ter(tecAMM_INVALID_TOKENS) : ter(tecAMM_FAILED); + ammAlice.withdraw( + carol, MPT(ammAlice[1])(100), std::nullopt, IOUAmount{500, 0}, err); + }, + {{XRP(10'000), AMMMPT(10'000)}}, + 0, + std::nullopt, + {all, all - fixAMMv1_3}); + + // Withdraw with EPrice limit. Fails to withdraw, calculated tokens + // to withdraw are greater than the LP shares. + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, 1'000'000); + ammAlice.withdraw( + carol, + MPT(ammAlice[1])(100), + std::nullopt, + IOUAmount{600, 0}, + ter(tecAMM_INVALID_TOKENS)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Withdraw with EPrice limit. Fails to withdraw, amount1 + // to withdraw is less than 1700 MPT. + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, 1'000'000); + ammAlice.withdraw( + carol, + MPT(ammAlice[1])(1'700), + std::nullopt, + IOUAmount{520, 0}, + ter(tecAMM_FAILED)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Deposit/Withdraw the same amount with the trading fee + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + ammAlice.withdraw( + carol, + MPT(ammAlice[1])(1'000), + std::nullopt, + std::nullopt, + ter(tecAMM_INVALID_TOKENS)); + }, + {{XRP(10'000), AMMMPT(10'000)}}, + 1'000); + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, XRP(1'000)); + ammAlice.withdraw( + carol, XRP(1'000), std::nullopt, std::nullopt, ter(tecAMM_INVALID_TOKENS)); + }, + {{XRP(10'000), AMMMPT(10'000)}}, + 1'000); + + // Deposit/Withdraw the same amount fails due to the tokens adjustment + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, STAmount{USD, 1, -6}); + ammAlice.withdraw( + carol, + STAmount{USD, 1, -6}, + std::nullopt, + std::nullopt, + ter(tecAMM_INVALID_TOKENS)); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + + // Withdraw close to one side of the pool. Account's LP tokens + // are rounded to all LP tokens. + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw( + alice, + STAmount{MPT(ammAlice[1]), UINT64_C(9'999'999999999999), -12}, + std::nullopt, + std::nullopt, + ter(tecAMM_BALANCE)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Tiny withdraw + testAMM( + [&](AMM& ammAlice, Env&) { + // XRP amount to withdraw is 0 + ammAlice.withdraw( + alice, IOUAmount{1, -5}, std::nullopt, std::nullopt, ter(tecAMM_FAILED)); + // Calculated tokens to withdraw are 0 + ammAlice.withdraw( + alice, + std::nullopt, + STAmount{USD, 1, -11}, + std::nullopt, + ter(tecAMM_INVALID_TOKENS)); + ammAlice.deposit(carol, STAmount{USD, 1, -10}); + ammAlice.withdraw( + carol, + std::nullopt, + STAmount{USD, 1, -9}, + std::nullopt, + ter(tecAMM_INVALID_TOKENS)); + ammAlice.withdraw( + carol, + std::nullopt, + MPT(ammAlice[0])(1), + std::nullopt, + ter(tecAMM_INVALID_TOKENS)); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + } + + void + testWithdraw() + { + testcase("Withdraw"); + + using namespace jtx; + + // Equal withdrawal by Carol: 1'000'000 of tokens, 10% of the current + // pool + testAMM( + [&](AMM& ammAlice, Env& env) { + // XRP/MPT + XRPAmount const baseFee{env.current()->fees().base}; + auto carolXRP = env.balance(carol, XRP); + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + + // Single deposit of 1'000'000 worth of tokens, + // which is 10% of the pool. Carol is LP now. + ammAlice.deposit(carol, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{11'000'000, 0})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{1'000'000, 0})); + env.require(balance(carol, carolMPT - MPT(ammAlice[1])(1'000))); + env.require(balance(carol, carolXRP - XRP(1'000) - drops(baseFee))); + + // Carol withdraws all tokens + ammAlice.withdraw(carol, 1'000'000); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount(beast::Zero()))); + env.require(balance(carol, carolMPT)); + env.require(balance(carol, carolXRP - drops(2 * baseFee))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal withdrawal by tokens 1000000, 10% + // of the current pool, XRP/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + // XRP/MPT + ammAlice.withdraw(alice, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(9'000), MPT(ammAlice[1])(9'000), IOUAmount{9'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal withdrawal by tokens, 10% of the current pool, IOU/MPT + // combination + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env.close(); + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto aliceBTC = env.balance(alice, BTC); + auto aliceUSD = env.balance(alice, USD); + ammAlice.withdraw(alice, 1'000); + BEAST_EXPECT(ammAlice.expectBalances(BTC(9'000), USD(9'000), IOUAmount(9'000))); + env.require(balance(alice, aliceBTC + BTC(1000))); + env.require(balance(alice, aliceUSD + USD(1000))); + }; + testHelper2TokensMix(test); + } + + // Equal withdrawal with a limit. Withdraw XRP200. + // If proportional withdraw of MPT is less than 100 + // then withdraw that amount, otherwise withdraw MPT100 + // and proportionally withdraw XRP. It's the latter + // in this case - XRP100/MPT100. + testAMM( + [&](AMM& ammAlice, Env&) { + // XRP/MPT + ammAlice.withdraw(alice, XRP(200), MPT(ammAlice[1])(100)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(9'900), MPT(ammAlice[1])(9'900), IOUAmount{9'900'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal withdrawal with a limit. XRP100/MPT200 truncated to + // XRP100/MPT100 + testAMM( + [&](AMM& ammAlice, Env&) { + // XRP/MPT + ammAlice.withdraw(alice, XRP(100), MPT(ammAlice[1])(200)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(9'900), MPT(ammAlice[1])(9'900), IOUAmount{9'900'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal withdrawal with a limit. IOU/MPT combination. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env.close(); + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto aliceBTC = env.balance(alice, BTC); + auto aliceUSD = env.balance(alice, USD); + ammAlice.withdraw(alice, BTC(200), USD(100)); + BEAST_EXPECT(ammAlice.expectBalances(BTC(9'900), USD(9'900), IOUAmount(9'900))); + env.require(balance(alice, aliceBTC + BTC(100))); + env.require(balance(alice, aliceUSD + USD(100))); + }; + testHelper2TokensMix(test); + } + + // Single withdrawal by amount + testAMM( + [&](AMM& ammAlice, Env&) { + // single withdraw XRP from XRP/MPT + ammAlice.withdraw(alice, XRP(1'000)); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount(9000'000001), + MPT(ammAlice[1])(10'000), + IOUAmount{9'486'832'98050514, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + // single withdraw MPT from XRP/MPT + ammAlice.withdraw(alice, MPT(ammAlice[1])(1'000)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10000), MPT(ammAlice[1])(9001), IOUAmount{9'486'832'98050514, -8})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + // single withdraw IOU from IOU/MPT + ammAlice.withdraw(alice, USD(1'000)); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(9000'000000000004), -12}, + MPT(ammAlice[1])(10'000), + IOUAmount{9486'83298050514, -11})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + // single withdraw MPT from IOU/MPT + ammAlice.withdraw(alice, MPT(ammAlice[1])(1'000)); + BEAST_EXPECT(ammAlice.expectBalances( + USD(10'000), MPT(ammAlice[1])(9001), IOUAmount{9486'83298050514, -11})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + // single withdraw MPT from MPT/MPT + ammAlice.withdraw(alice, MPT(ammAlice[0])(1'000)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(9001), + MPT(ammAlice[1])(10'000), + IOUAmount{9486'83298050514, -11})); + }, + {{AMMMPT(10'000), AMMMPT(10'000)}}); + + // Single withdrawal MPT by tokens 10000. XRP/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, 10'000, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(9981), IOUAmount{9'990'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single withdrawal XRP by tokens 10000. XRP/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, 10'000, XRP(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount(9980010000), MPT(ammAlice[1])(10'000), IOUAmount{9'990'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single withdrawal by tokens 10000. MPT/IOU combination. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env.close(); + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto aliceBTC = env.balance(alice, BTC); + auto aliceUSD = env.balance(alice, USD); + ammAlice.withdraw(alice, 1000, BTC(0)); + BEAST_EXPECT(ammAlice.expectBalances(USD(10'000), BTC(8100), IOUAmount{9000, 0})); + env.require(balance(alice, aliceBTC + BTC(1900))); + env.require(balance(alice, aliceUSD)); + }; + testHelper2TokensMix(test); + } + + // Withdraw all tokens. + testAMM( + [&](AMM& ammAlice, Env& env) { + env(trust(carol, STAmount{ammAlice.lptIssue(), 10'000})); + // Can SetTrust only for AMM LP tokens + env(trust(carol, STAmount{Issue{EUR.currency, ammAlice.ammAccount()}, 10'000}), + ter(tecNO_PERMISSION)); + env.close(); + ammAlice.withdrawAll(alice); + BEAST_EXPECT(!ammAlice.ammExists()); + + BEAST_EXPECT(!env.le(keylet::ownerDir(ammAlice.ammAccount()))); + + // Can create AMM for the XRP/MPT pair + AMM const ammCarol(env, carol, XRP(10'000), MPT(ammAlice[1])(10'000)); + BEAST_EXPECT(ammCarol.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'000), IOUAmount{10'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000MPT, withdraw all tokens in MPT from XRP/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'001), IOUAmount{10'000'000, 0})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount(beast::Zero()))); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000MPT, withdraw all tokens in XRP from XRP/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + ammAlice.withdrawAll(carol, XRP(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount(9'090'909'091), MPT(ammAlice[1])(11000), IOUAmount{10'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000MPT, withdraw all tokens in MPT from USD/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + // USD/MPT + ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + USD(10'000), MPT(ammAlice[1])(10'001), IOUAmount{10'000, 0})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount(beast::Zero()))); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000USD, withdraw all tokens in USD from USD/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + // USD/MPT + ammAlice.deposit(carol, USD(1'000)); + ammAlice.withdrawAll(carol, USD(0)); + BEAST_EXPECT(ammAlice.expectBalances( + USD(10'000), MPT(ammAlice[1])(10'000), IOUAmount{10'000, 0})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount(beast::Zero()))); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000MPT, withdraw all tokens in MPT from MPT/MPT + testAMM( + [&](AMM& ammAlice, Env& env) { + // MPT/MPT + ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000), MPT(ammAlice[1])(10'001), IOUAmount{10'000, 0})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount(beast::Zero()))); + }, + {{AMMMPT(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000MPT, withdraw all tokens in MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10001), IOUAmount{10'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000MPT, withdraw all tokens in USD + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + ammAlice.withdrawAll(carol, USD(0)); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(9'090'9090909091), -10}, + MPT(ammAlice[1])(11000), + IOUAmount{10'000, 0})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Single deposit 1000USD, withdraw all tokens in MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, USD(1'000)); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(10'999'99999999999), -11}, + MPT(ammAlice[1])(9091), + IOUAmount{10'000, 0})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + + // Single deposit/withdraw by the same account + testAMM( + [&](AMM& ammAlice, Env&) { + auto lpTokens = ammAlice.deposit(carol, USD(1'000)); + ammAlice.withdraw(carol, lpTokens, USD(0)); + lpTokens = ammAlice.deposit(carol, STAmount(USD, 1, -6)); + ammAlice.withdraw(carol, lpTokens, USD(0)); + lpTokens = ammAlice.deposit(carol, MPT(ammAlice[0])(1)); + ammAlice.withdraw(carol, lpTokens, MPT(ammAlice[0])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000'000'001), USD(10'000), ammAlice.tokens())); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + auto const& BTC = MPT(ammAlice[1]); + auto lpTokens = ammAlice.deposit(carol, BTC(1'000)); + ammAlice.withdraw(carol, lpTokens, BTC(0)); + lpTokens = ammAlice.deposit(carol, BTC(1)); + ammAlice.withdraw(carol, lpTokens, BTC(0)); + lpTokens = ammAlice.deposit(carol, BTC(1)); + ammAlice.withdraw(carol, lpTokens, BTC(0)); + BEAST_EXPECT(ammAlice.expectBalances(BTC(10'003), XRP(10'000), ammAlice.tokens())); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Single deposit by different accounts and then withdraw + // in reverse. + testAMM( + [&](AMM& ammAlice, Env&) { + auto const carolTokens = ammAlice.deposit(carol, MPT(ammAlice[1])(1'000)); + auto const aliceTokens = ammAlice.deposit(alice, MPT(ammAlice[1])(1'000)); + ammAlice.withdraw(alice, aliceTokens, MPT(ammAlice[1])(0)); + ammAlice.withdraw(carol, carolTokens, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'001), ammAlice.tokens())); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0})); + BEAST_EXPECT(ammAlice.expectLPTokens(alice, ammAlice.tokens())); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal deposit 10%, withdraw all tokens. XRP/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, 1'000'000); + ammAlice.withdrawAll(carol); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'000), IOUAmount{10'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + // Equal deposit 10%, withdraw all tokens. IOU/MPT combination. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, carol}, + .limit = 1'000'000}); + env(pay(gw, alice, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + auto carolBTC = env.balance(carol, BTC); + auto carolUSD = env.balance(carol, USD); + ammAlice.deposit(carol, 1'000); + ammAlice.withdrawAll(carol); + BEAST_EXPECT( + ammAlice.expectBalances(USD(10'000), BTC(10'000), IOUAmount{10'000, 0})); + env.require(balance(carol, carolBTC)); + env.require(balance(carol, carolUSD)); + }; + testHelper2TokensMix(test); + } + + // Equal deposit 10%, withdraw all tokens in MPT from XRP/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, 1'000'000); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), + STAmount{MPT(ammAlice[1]), UINT64_C(9'090'909090909092), -12}, + IOUAmount{10'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal deposit 10%, withdraw all tokens in XRP from XRP/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, 1'000'000); + ammAlice.withdrawAll(carol, XRP(0)); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount(9'090'909'091), MPT(ammAlice[1])(11'000), IOUAmount{10'000'000, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Equal deposit 10%, withdraw all tokens in USD from USD/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, 1'000); + ammAlice.withdrawAll(carol, USD(0)); + BEAST_EXPECT(ammAlice.expectBalances( + STAmount{USD, UINT64_C(9'090'909090909092), -12}, + MPT(ammAlice[1])(11'000), + IOUAmount{10'000})); + }, + {{USD(10'000), AMMMPT(10'000)}}); + // Equal deposit 10%, withdraw all tokens in MPT from MPT/MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.deposit(carol, 1'000); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(11'000), MPT(ammAlice[1])(9'091), IOUAmount{10'000})); + }, + {{AMMMPT(10'000), AMMMPT(10'000)}}); + + auto const all = testable_amendments(); + + // Withdraw with EPrice limit. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000'000'000); + ammAlice.withdraw( + carol, MPT(ammAlice[1])(100'000000), std::nullopt, IOUAmount{520, 0}); + if (!env.enabled(fixAMMv1_1) && !env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT( + ammAlice.expectBalances( + XRP(11'000'000000), + MPT(ammAlice[1])(9372781065), + IOUAmount{10'153'846'15384616, -2}) && + ammAlice.expectLPTokens(carol, IOUAmount{153'846'15384616, -2})); + } + else if (env.enabled(fixAMMv1_1) && !env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT( + ammAlice.expectBalances( + XRP(11'000'000000), + MPT(ammAlice[1])(9372781065), + IOUAmount{10'153'846'15384616, -2}) && + ammAlice.expectLPTokens(carol, IOUAmount{153'846'15384616, -2})); + } + else if (env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT( + ammAlice.expectBalances( + XRP(11'000'000000), + MPT(ammAlice[1])(9372781066), + IOUAmount{10'153'846'15384616, -2}) && + ammAlice.expectLPTokens(carol, IOUAmount{153'846'15384616, -2})); + } + ammAlice.withdrawAll(carol); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0})); + }, + {{XRP(10'000'000'000), AMMMPT(10'000'000'000)}}, + 0, + std::nullopt, + {all, all - fixAMMv1_3, all - fixAMMv1_1 - fixAMMv1_3}); + + // Withdraw with EPrice limit. AssetOut is 0. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000'000'000); + ammAlice.withdraw(carol, MPT(ammAlice[1])(0), std::nullopt, IOUAmount{520, 0}); + if (!env.enabled(fixAMMv1_1) && !env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT( + ammAlice.expectBalances( + XRP(11'000'000000), + MPT(ammAlice[1])(9372781065), + IOUAmount{10'153'846'15384616, -2}) && + ammAlice.expectLPTokens(carol, IOUAmount{153'846'15384616, -2})); + } + else if (env.enabled(fixAMMv1_1) && !env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT( + ammAlice.expectBalances( + XRP(11'000'000000), + MPT(ammAlice[1])(9372781065), + IOUAmount{10'153'846'15384616, -2}) && + ammAlice.expectLPTokens(carol, IOUAmount{153'846'15384616, -2})); + } + else if (env.enabled(fixAMMv1_3)) + { + BEAST_EXPECT( + ammAlice.expectBalances( + XRP(11'000'000000), + MPT(ammAlice[1])(9372781066), + IOUAmount{10'153'846'15384616, -2}) && + ammAlice.expectLPTokens(carol, IOUAmount{153'846'15384616, -2})); + } + ammAlice.withdrawAll(carol); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0})); + }, + {{XRP(10'000'000'000), AMMMPT(10'000'000'000)}}, + 0, + std::nullopt, + {all, all - fixAMMv1_3, all - fixAMMv1_1 - fixAMMv1_3}); + + // IOU/MPT combination + transfer fee + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000, + .transferFee = 25'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000, + .transferFee = 25'000}); + env(pay(gw, alice, BTC(10000))); + env(pay(gw, bob, BTC(10000))); + env(pay(gw, carol, BTC(10000))); + env(pay(gw, alice, USD(10000))); + env(pay(gw, bob, USD(10000))); + env(pay(gw, carol, USD(10000))); + env.close(); + // no transfer fee on create + AMM ammAlice(env, alice, BTC(2'000), USD(5)); + BEAST_EXPECT(ammAlice.expectBalances(BTC(2'000), USD(5), IOUAmount{100, 0})); + env.require(balance(alice, BTC(8000))); + env.require(balance(alice, USD(9995))); + + // no transfer fee on deposit + ammAlice.deposit(carol, 100); + BEAST_EXPECT(ammAlice.expectBalances(BTC(4000), USD(10), IOUAmount{200, 0})); + env.require(balance(carol, BTC(8000))); + env.require(balance(carol, USD(9995))); + + // no transfer fee on withdraw + ammAlice.withdraw(carol, 100); + BEAST_EXPECT(ammAlice.expectBalances(BTC(2'000), USD(5), IOUAmount{100, 0})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0, 0})); + env.require(balance(carol, BTC(10000))); + env.require(balance(carol, USD(10000))); + }; + testHelper2TokensMix(test); + } + + // Tiny withdraw + testAMM( + [&](AMM& ammAlice, Env&) { + // By tokens + ammAlice.withdraw(alice, IOUAmount{1, -3}); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(9'999'999'999), + STAmount{USD, UINT64_C(9'999'999999), -6}, + IOUAmount{9'999'999'999, -3})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + // Single withdraw MPT from MPT/IOU + ammAlice.withdraw(alice, std::nullopt, MPT(ammAlice[0])(1)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10000'000000), USD(10'000), IOUAmount{9'999'999'9995, -4})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + // Single withdraw IOU from MPT/IOU + ammAlice.withdraw(alice, std::nullopt, STAmount{USD, 1, -10}); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000'000'000), + STAmount{USD, UINT64_C(9'999'9999999999), -10}, + IOUAmount{9'999'999'99999995, -8})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + // Single withdraw XRP from MPT/XRP + ammAlice.withdraw(alice, std::nullopt, XRPAmount(1)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[1])(10'000), XRP(10'000), IOUAmount{9999999'9995, -4})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Withdraw close to entire pool + // Equal by tokens + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, IOUAmount{9'999'999'999, -3}); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(1), STAmount{USD, 1, -6}, IOUAmount{1, -3})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + // USD by tokens + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, IOUAmount{9'999'999}, USD(0)); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000'000'000), STAmount{USD, 1, -10}, IOUAmount{1})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + // MPT by tokens + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, IOUAmount{9'999'900}, MPT(ammAlice[0])(0)); + BEAST_EXPECT( + ammAlice.expectBalances(MPT(ammAlice[0])(1), USD(10'000), IOUAmount{100})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + // XRP by tokens + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, IOUAmount{9'999'900}, XRP(0)); + BEAST_EXPECT( + ammAlice.expectBalances(MPT(ammAlice[1])(10000), XRPAmount(1), IOUAmount{100})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + // USD + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, STAmount{USD, UINT64_C(9'999'99999999999), -11}); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000'000'000), + STAmount{USD, 1, -11}, + IOUAmount{316227765, -9})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + // XRP + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, XRPAmount{9'999'999'999}); + BEAST_EXPECT( + ammAlice.expectBalances(MPT(ammAlice[1])(10000), XRPAmount(1), IOUAmount{100})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + // MPT + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, MPT(ammAlice[0])(9'999'999'999)); + BEAST_EXPECT( + ammAlice.expectBalances(MPT(ammAlice[0])(1), USD(10'000), IOUAmount{100})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + testAMM( + [&](AMM& ammAlice, Env&) { + ammAlice.withdraw(alice, MPT(ammAlice[1])(9'999)); + BEAST_EXPECT( + ammAlice.expectBalances(MPT(ammAlice[1])(1), XRP(10'000), IOUAmount{100000})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + } + + void + testInvalidFeeVote() + { + testcase("Invalid Fee Vote"); + using namespace jtx; + + testAMM( + [&](AMM& ammAlice, Env& env) { + // Invalid Account + Account bad("bad"); + env.memoize(bad); + ammAlice.vote(bad, 1'000, std::nullopt, seq(1), std::nullopt, ter(terNO_ACCOUNT)); + + // Invalid AMM + ammAlice.vote( + alice, + 1'000, + std::nullopt, + std::nullopt, + {{MPT(ammAlice[1]), GBP}}, + ter(terNO_AMM)); + + // Account is not LP + ammAlice.vote( + carol, + 1'000, + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecAMM_INVALID_TOKENS)); + + // Invalid asset pair + ammAlice.vote( + alice, + 1'000, + std::nullopt, + std::nullopt, + {{MPT(ammAlice[1]), MPT(ammAlice[1])}}, + ter(temBAD_AMM_TOKENS)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Invalid AMM + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.withdrawAll(alice); + ammAlice.vote( + alice, 1'000, std::nullopt, std::nullopt, std::nullopt, ter(terNO_AMM)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // MPTokenInstance object doesn't exist + { + Env env(*this); + env.fund(XRP(1'000), alice); + env(AMM::voteJv({.account = alice, .tfee = 1'000, .assets = {{XRP, MPT(alice, 0)}}}), + ter(terNO_AMM)); + } + } + + void + testFeeVote() + { + testcase("Fee Vote"); + using namespace jtx; + + // One vote sets fee to 1%. + testAMM( + [&](AMM& ammAlice, Env& env) { + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{0})); + ammAlice.vote({}, 1'000); + BEAST_EXPECT(ammAlice.expectTradingFee(1'000)); + // Discounted fee is 1/10 of trading fee. + BEAST_EXPECT(ammAlice.expectAuctionSlot(100, 0, IOUAmount{0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + auto vote = [&](AMM& ammAlice, + Env& env, + int i, + std::uint32_t tokens = 10'000'000, + std::vector* accounts = nullptr) { + Account a(std::to_string(i)); + ammAlice.deposit(a, tokens); + ammAlice.vote(a, 50 * (i + 1)); + if (accounts) + accounts->push_back(std::move(a)); + }; + + { + // Eight votes fill all voting slots, set fee 0.175%. + // New vote, same account, sets fee 0.225% + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + std::vector holders = {alice}; + for (int i = 0; i <= 7; ++i) + { + Account const a(std::to_string(i)); + holders.push_back(a); + env.fund(XRP(30'000), a); + } + env.close(); + // create MPT and pay 30'000 to all the accounts + MPTTester const BTC({.env = env, .issuer = gw, .holders = holders, .pay = 30'000}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + for (int i = 0; i < 7; ++i) + vote(ammAlice, env, i); + BEAST_EXPECT(ammAlice.expectTradingFee(175)); + Account const a("0"); + ammAlice.vote(a, 450); + BEAST_EXPECT(ammAlice.expectTradingFee(225)); + } + + { + // Eight votes fill all voting slots, set fee 0.175%. + // New vote, new account, higher vote weight, set higher fee 0.244% + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + std::vector holders = {alice}; + for (int i = 0; i < 8; ++i) + { + Account const a(std::to_string(i)); + holders.push_back(a); + env.fund(XRP(30'000), a); + } + env.close(); + MPTTester const BTC({.env = env, .issuer = gw, .holders = holders, .pay = 30'000}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + for (int i = 0; i < 7; ++i) + vote(ammAlice, env, i); + BEAST_EXPECT(ammAlice.expectTradingFee(175)); + vote(ammAlice, env, 7, 20'000'000); + BEAST_EXPECT(ammAlice.expectTradingFee(244)); + } + + { + // Eight votes fill all voting slots, set fee 0.219%. + // New vote, new account, higher vote weight, set smaller fee 0.206% + Env env{*this}; + env.fund(XRP(30'000), gw, alice); + std::vector holders = {alice}; + for (int i = 0; i < 8; ++i) + { + Account const a(std::to_string(i)); + holders.push_back(a); + env.fund(XRP(30'000), a); + } + env.close(); + MPTTester const BTC({.env = env, .issuer = gw, .holders = holders, .pay = 30'000}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + for (int i = 7; i > 0; --i) + vote(ammAlice, env, i); + BEAST_EXPECT(ammAlice.expectTradingFee(219)); + vote(ammAlice, env, 0, 20'000'000); + BEAST_EXPECT(ammAlice.expectTradingFee(206)); + } + + { + // Eight votes fill all voting slots. The accounts then withdraw all + // tokens. An account sets a new fee and the previous slots are + // deleted. + Env env{*this}; + env.fund(XRP(30'000), gw, alice, carol); + std::vector holders = {alice, carol}; + for (int i = 0; i < 7; ++i) + { + Account const a(std::to_string(i)); + holders.push_back(a); + env.fund(XRP(30'000), a); + } + env.close(); + MPTTester const BTC({.env = env, .issuer = gw, .holders = holders, .pay = 30'000}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + std::vector accounts; + for (int i = 0; i < 7; ++i) + vote(ammAlice, env, i, 10'000'000, &accounts); + BEAST_EXPECT(ammAlice.expectTradingFee(175)); + for (int i = 0; i < 7; ++i) + ammAlice.withdrawAll(accounts[i]); + ammAlice.deposit(carol, 10'000'000); + ammAlice.vote(carol, 1'000); + // The initial LP set the fee to 1000. Carol gets 50% voting + // power, and the new fee is 500. + BEAST_EXPECT(ammAlice.expectTradingFee(500)); + } + { + // Eight votes fill all voting slots. The accounts then withdraw + // some tokens. The new vote doesn't get the voting power but the + // slots are refreshed and the fee is updated. + Env env{*this}; + env.fund(XRP(30'000), gw, alice, carol); + std::vector holders = {alice, carol}; + for (int i = 0; i < 7; ++i) + { + Account const a(std::to_string(i)); + holders.push_back(a); + env.fund(XRP(30'000), a); + } + env.close(); + MPTTester const BTC({.env = env, .issuer = gw, .holders = holders, .pay = 30'000}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + std::vector accounts; + for (int i = 0; i < 7; ++i) + vote(ammAlice, env, i, 10'000'000, &accounts); + BEAST_EXPECT(ammAlice.expectTradingFee(175)); + for (int i = 0; i < 7; ++i) + ammAlice.withdraw(accounts[i], 9'000'000); + ammAlice.deposit(carol, 1'000); + // The vote is not added to the slots + ammAlice.vote(carol, 1'000); + auto const info = ammAlice.ammRpcInfo()[jss::amm][jss::vote_slots]; + for (auto i = 0; i < info.size(); ++i) + BEAST_EXPECT(info[i][jss::account] != carol.human()); + // But the slots are refreshed and the fee is changed + BEAST_EXPECT(ammAlice.expectTradingFee(82)); + } + } + + void + testInvalidBid() + { + testcase("Invalid Bid"); + using namespace jtx; + using namespace std::chrono; + + // burn all the LPTokens through a AMMBid transaction + { + Env env(*this); + env.fund(XRP(2'000), gw, alice); + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice}, .pay = 2'000, .flags = MPTDEXFlags}); + AMM amm(env, gw, XRP(1'000), BTC(1'000), false, 1'000); + + // auction slot is owned by the creator of the AMM i.e. gw + BEAST_EXPECT(amm.expectAuctionSlot(100, 0, IOUAmount{0})); + + // gw attempts to burn all her LPTokens through a bid transaction + // this transaction fails because AMMBid transaction can not burn + // all the outstanding LPTokens + env(amm.bid({ + .account = gw, + .bidMin = 1'000'000, + }), + ter(tecAMM_INVALID_TOKENS)); + } + + // burn all the LPTokens through a AMMBid transaction + { + Env env(*this); + env.fund(XRP(2'000), gw, alice); + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice}, .pay = 2'000, .flags = MPTDEXFlags}); + AMM amm(env, gw, XRP(1'000), BTC(1'000), false, 1'000); + + // auction slot is owned by the creator of the AMM i.e. gw + BEAST_EXPECT(amm.expectAuctionSlot(100, 0, IOUAmount{0})); + + // gw burns all but one of its LPTokens through a bid transaction + // this transaction succeeds because the bid price is less than + // the total outstanding LPToken balance + env(amm.bid({ + .account = gw, + .bidMin = STAmount{amm.lptIssue(), UINT64_C(999'999)}, + }), + ter(tesSUCCESS)) + .close(); + + // gw must own the auction slot + BEAST_EXPECT(amm.expectAuctionSlot(100, 0, IOUAmount{999'999})); + + // 999'999 tokens are burned, only 1 LPToken is owned by gw + BEAST_EXPECT(amm.expectBalances(XRP(1'000), BTC(1'000), IOUAmount{1})); + + // gw owns only 1 LPToken in its balance + BEAST_EXPECT(Number{amm.getLPTokensBalance(gw)} == 1); + + // gw attempts to burn the last of its LPTokens in an AMMBid + // transaction. This transaction fails because it would burn all + // the remaining LPTokens + env(amm.bid({ + .account = gw, + .bidMin = 1, + }), + ter(tecAMM_INVALID_TOKENS)); + } + + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000); + // Invlaid Min/Max combination + env(ammAlice.bid({ + .account = carol, + .bidMin = 200, + .bidMax = 100, + }), + ter(tecAMM_INVALID_TOKENS)); + + // Invalid Account + Account bad("bad"); + env.memoize(bad); + env(ammAlice.bid({ + .account = bad, + .bidMax = 100, + }), + seq(1), + ter(terNO_ACCOUNT)); + + // Account is not LP + Account const dan("dan"); + env.fund(XRP(1'000), dan); + env(ammAlice.bid({ + .account = dan, + .bidMin = 100, + }), + ter(tecAMM_INVALID_TOKENS)); + env(ammAlice.bid({ + .account = dan, + }), + ter(tecAMM_INVALID_TOKENS)); + + // Auth account is invalid. + env(ammAlice.bid({ + .account = carol, + .bidMin = 100, + .authAccounts = {bob}, + }), + ter(terNO_ACCOUNT)); + + // Invalid Assets + env(ammAlice.bid({ + .account = alice, + .bidMax = 100, + .assets = {{MPT(ammAlice[1]), GBP}}, + }), + ter(terNO_AMM)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Invalid AMM + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.withdrawAll(alice); + env(ammAlice.bid({ + .account = alice, + .bidMax = 100, + }), + ter(terNO_AMM)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Bid price exceeds LP owned tokens + { + Env env(*this); + fund(env, gw, {alice, bob, carol}, XRP(1'000), {USD(30'000)}, Fund::All); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 30'000'000'000, + .flags = MPTDEXFlags}); + + AMM ammAlice(env, alice, BTC(10'000'000'000), USD(10'000)); + ammAlice.deposit(carol, 1'000'000); + ammAlice.deposit(bob, 10); + env(ammAlice.bid({ + .account = carol, + .bidMin = 1'000'001, + }), + ter(tecAMM_INVALID_TOKENS)); + env(ammAlice.bid({ + .account = carol, + .bidMax = 1'000'001, + }), + ter(tecAMM_INVALID_TOKENS)); + env(ammAlice.bid({ + .account = carol, + .bidMin = 1'000, + })); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{1'000})); + // Slot purchase price is more than 1000 but bob only has 10 tokens + env(ammAlice.bid({ + .account = bob, + }), + ter(tecAMM_INVALID_TOKENS)); + } + + // Bid all tokens, still own the slot + { + Env env(*this); + env.fund(XRP(1'000), gw, alice, bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 1'000, + .flags = MPTDEXFlags}); + AMM amm(env, gw, XRP(10), BTC(1'000)); + auto const lpIssue = amm.lptIssue(); + env.trust(STAmount{lpIssue, 100}, alice); + env.trust(STAmount{lpIssue, 50}, bob); + env(pay(gw, alice, STAmount{lpIssue, 100})); + env(pay(gw, bob, STAmount{lpIssue, 50})); + env(amm.bid({.account = alice, .bidMin = 100})); + // Alice doesn't have any more tokens, but + // she still owns the slot. + env(amm.bid({ + .account = bob, + .bidMax = 50, + }), + ter(tecAMM_FAILED)); + } + } + + void + testBid(FeatureBitset features) + { + testcase("Bid"); + using namespace jtx; + using namespace std::chrono; + + // Auction slot initially is owned by AMM creator, who pays 0 price. + + // Bid 110 tokens. Pay bidMin. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000); + env(ammAlice.bid({.account = carol, .bidMin = 110})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{110})); + // 110 tokens are burned. + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{10'999'890, 0})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Bid with min/max when the pay price is less than min. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000); + // Bid exactly 110. Pay 110 because the pay price is < 110. + env(ammAlice.bid({.account = carol, .bidMin = 110, .bidMax = 110})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{110})); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{10'999'890})); + // Bid exactly 180-200. Pay 180 because the pay price is < 180. + env(ammAlice.bid({.account = alice, .bidMin = 180, .bidMax = 200})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{180})); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(11'000), MPT(ammAlice[1])(11'000), IOUAmount{10'999'814'5, -1})); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Start bid at bidMin 110. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol, bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 30'000, + .flags = MPTDEXFlags}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + + ammAlice.deposit(carol, 1'000'000); + // Bid, pay bidMin. + env(ammAlice.bid({.account = carol, .bidMin = 110})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{110})); + + ammAlice.deposit(bob, 1'000'000); + // Bid, pay the computed price. + env(ammAlice.bid({.account = bob})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount(1155, -1))); + + // Bid bidMax fails because the computed price is higher. + env(ammAlice.bid({ + .account = carol, + .bidMax = 120, + }), + ter(tecAMM_FAILED)); + // Bid MaxSlotPrice succeeds - pay computed price + env(ammAlice.bid({.account = carol, .bidMax = 600})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{121'275, -3})); + + // Bid Min/MaxSlotPrice fails because the computed price is not + // in range + env(ammAlice.bid({ + .account = carol, + .bidMin = 10, + .bidMax = 100, + }), + ter(tecAMM_FAILED)); + // Bid Min/MaxSlotPrice succeeds - pay computed price + env(ammAlice.bid({.account = carol, .bidMin = 100, .bidMax = 600})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{127'33875, -5})); + } + + // Slot states. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol, bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 30'000, + .flags = MPTDEXFlags}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'000)); + + ammAlice.deposit(carol, 1'000'000); + ammAlice.deposit(bob, 1'000'000); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount(12'000'000001), BTC(12'001), IOUAmount{12'000'000, 0})); + + // Initial state. Pay bidMin. + env(ammAlice.bid({.account = carol, .bidMin = 110})).close(); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{110})); + + // 1st Interval after close, price for 0th interval. + env(ammAlice.bid({.account = bob})); + env.close(seconds(AUCTION_SLOT_INTERVAL_DURATION + 1)); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 1, IOUAmount{1'155, -1})); + + // 10th Interval after close, price for 1st interval. + env(ammAlice.bid({.account = carol})); + env.close(seconds((10 * AUCTION_SLOT_INTERVAL_DURATION) + 1)); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 10, IOUAmount{121'275, -3})); + + // 20th Interval (expired) after close, price for 10th interval. + env(ammAlice.bid({.account = bob})); + env.close(seconds((AUCTION_SLOT_TIME_INTERVALS * AUCTION_SLOT_INTERVAL_DURATION) + 1)); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, std::nullopt, IOUAmount{127'33875, -5})); + + // 0 Interval. + env(ammAlice.bid({.account = carol, .bidMin = 110})).close(); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, std::nullopt, IOUAmount{110})); + // ~321.09 tokens burnt on bidding fees. + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount(12'000'000001), BTC(12'001), IOUAmount{11'999'678'91000001, -8})); + } + + // Pool's fee 1%. Bid bidMin. + // Auction slot owner and auth account trade at discounted fee - + // 1/10 of the trading fee. + // Other accounts trade at 1% fee. + { + Env env(*this); + Account const dan("dan"); + Account const ed("ed"); + env.fund(XRP(2'000), gw, alice, bob, carol, dan, ed); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, ed}, + .pay = 30'000'000'000}); + fund(env, gw, {alice, carol}, {USD(30'000)}, Fund::TokenOnly); + fund(env, gw, {bob, dan, ed}, {USD(20'000)}, Fund::TokenOnly); + + AMM ammAlice(env, alice, BTC(10'000'000'000), USD(10'000), CreateArg{.tfee = 1'000}); + ammAlice.deposit(bob, 1'000'000); + ammAlice.deposit(ed, 1'000'000); + ammAlice.deposit(carol, 500'000); + ammAlice.deposit(dan, 500'000); + auto ammTokens = ammAlice.getLPTokensBalance(); + env(ammAlice.bid({ + .account = carol, + .bidMin = 120, + .authAccounts = {bob, ed}, + })); + auto const slotPrice = IOUAmount{5'200}; + ammTokens -= slotPrice; + BEAST_EXPECT(ammAlice.expectAuctionSlot(100, 0, slotPrice)); + BEAST_EXPECT(ammAlice.expectBalances(BTC(13'000'000'003), USD(13'000), ammTokens)); + // Discounted trade + for (int i = 0; i < 10; ++i) + { + auto tokens = ammAlice.deposit(carol, USD(100)); + ammAlice.withdraw(carol, tokens, USD(0)); + tokens = ammAlice.deposit(bob, USD(100)); + ammAlice.withdraw(bob, tokens, USD(0)); + tokens = ammAlice.deposit(ed, USD(100)); + ammAlice.withdraw(ed, tokens, USD(0)); + } + // carol, bob, and ed pay ~0.99USD in fees. + BEAST_EXPECT( + env.balance(carol, USD) == STAmount(USD, UINT64_C(29'499'00572620545), -11)); + BEAST_EXPECT(env.balance(bob, USD) == STAmount(USD, UINT64_C(18'999'00572616195), -11)); + BEAST_EXPECT(env.balance(ed, USD) == STAmount(USD, UINT64_C(18'999'00572611841), -11)); + // USD pool is slightly higher because of the fees. + BEAST_EXPECT(ammAlice.expectBalances( + BTC(13'000'000'003), STAmount(USD, UINT64_C(13'002'98282151419), -11), ammTokens)); + + ammTokens = ammAlice.getLPTokensBalance(); + // Trade with the fee + for (int i = 0; i < 10; ++i) + { + auto const tokens = ammAlice.deposit(dan, USD(100)); + ammAlice.withdraw(dan, tokens, USD(0)); + } + // dan pays ~9.94USD, which is ~10 times more in fees than + // carol, bob, ed. the discounted fee is 10 times less + // than the trading fee. + + BEAST_EXPECT(env.balance(dan, USD) == STAmount(USD, UINT64_C(19'490'05672274398), -11)); + // USD pool gains more in dan's fees. + BEAST_EXPECT(ammAlice.expectBalances( + BTC(13'000'000'003), STAmount{USD, UINT64_C(13'012'92609877021), -11}, ammTokens)); + // Discounted fee payment + ammAlice.deposit(carol, USD(100)); + ammTokens = ammAlice.getLPTokensBalance(); + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(13'000'000'003), + STAmount{USD, UINT64_C(13'112'92609877019), -11}, + ammTokens)); + env(pay(carol, bob, USD(100)), path(~USD), sendmax(BTC(110'000'000))); + env.close(); + // carol pays 100000 drops in fees + // 99900668MPT swapped in for 100USD + BEAST_EXPECT(ammAlice.expectBalances( + BTC(13'100'000'671), STAmount{USD, UINT64_C(13'012'92609877019), -11}, ammTokens)); + + // Payment with the trading fee + env(pay(alice, carol, BTC(100'000'000)), path(~MPT(ammAlice[0])), sendmax(USD(110))); + env.close(); + // alice pays ~1.011USD in fees, which is ~10 times more + // than carol's fee + // 100.099431529USD swapped in for 100MPT + + BEAST_EXPECT(ammAlice.expectBalances( + BTC(13'000'000'671), STAmount{USD, UINT64_C(13'114'03663044931), -11}, ammTokens)); + + // Auction slot expired, no discounted fee + env.close(seconds(TOTAL_TIME_SLOT_SECS + 1)); + // clock is parent's based + env.close(); + + BEAST_EXPECT( + env.balance(carol, USD) == STAmount(USD, UINT64_C(29'399'00572620547), -11)); + ammTokens = ammAlice.getLPTokensBalance(); + for (int i = 0; i < 10; ++i) + { + auto const tokens = ammAlice.deposit(carol, USD(100)); + ammAlice.withdraw(carol, tokens, USD(0)); + } + // carol pays ~9.94USD in fees, which is ~10 times more in + // trading fees vs discounted fee. + + BEAST_EXPECT( + env.balance(carol, USD) == STAmount(USD, UINT64_C(29'389'06197177122), -11)); + BEAST_EXPECT(ammAlice.expectBalances( + BTC(13'000'000'671), STAmount{USD, UINT64_C(13'123'98038488356), -11}, ammTokens)); + + env(pay(carol, bob, USD(100)), path(~USD), sendmax(BTC(110'000'000))); + env.close(); + // carol pays ~1.008MPT in trading fee, which is + // ~10 times more than the discounted fee. + // 99.815876MPT is swapped in for 100USD + BEAST_EXPECT(ammAlice.expectBalances( + BTC(13'100'824'793), STAmount{USD, UINT64_C(13'023'98038488356), -11}, ammTokens)); + } + + // Bid tiny amount + testAMM( + [&](AMM& ammAlice, Env& env) { + // Bid a tiny amount + auto const tiny = Number{STAmount::cMinValue, STAmount::cMinOffset}; + env(ammAlice.bid({.account = alice, .bidMin = IOUAmount{tiny}})); + // Auction slot purchase price is equal to the tiny amount + // since the minSlotPrice is 0 with no trading fee. + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{tiny})); + // The purchase price is too small to affect the total tokens + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000'000'000), USD(10'000), ammAlice.tokens())); + // Bid the tiny amount + env(ammAlice.bid({ + .account = alice, + .bidMin = IOUAmount{STAmount::cMinValue, STAmount::cMinOffset}, + })); + // Pay slightly higher price + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{tiny * Number{105, -2}})); + // The purchase price is still too small to affect the total + // tokens + BEAST_EXPECT(ammAlice.expectBalances( + MPT(ammAlice[0])(10'000'000'000), USD(10'000), ammAlice.tokens())); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + + // Reset auth account + testAMM( + [&](AMM& ammAlice, Env& env) { + env(ammAlice.bid({ + .account = alice, + .bidMin = IOUAmount{100}, + .authAccounts = {carol}, + })); + BEAST_EXPECT(ammAlice.expectAuctionSlot({carol})); + env(ammAlice.bid({.account = alice, .bidMin = IOUAmount{100}})); + BEAST_EXPECT(ammAlice.expectAuctionSlot({})); + Account bob("bob"); + Account dan("dan"); + fund(env, {bob, dan}, XRP(1'000)); + env(ammAlice.bid({ + .account = alice, + .bidMin = IOUAmount{100}, + .authAccounts = {bob, dan}, + })); + BEAST_EXPECT(ammAlice.expectAuctionSlot({bob, dan})); + }, + {{AMMMPT(10'000'000'000), USD(10'000)}}); + + // Bid all tokens, still own the slot and trade at a discount + { + Env env(*this); + env.fund(XRP(2'000), gw, alice, bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 2'000'000'000, + .flags = MPTDEXFlags}); + fund(env, gw, {alice, bob}, {USD(2'000)}, Fund::TokenOnly); + AMM amm(env, gw, BTC(1'000'000'000), USD(1'010), false, 1'000); + auto const lpIssue = amm.lptIssue(); + env.trust(STAmount{lpIssue, 500}, alice); + env.trust(STAmount{lpIssue, 50}, bob); + env(pay(gw, alice, STAmount{lpIssue, 500})); + env(pay(gw, bob, STAmount{lpIssue, 50})); + // Alice doesn't have anymore lp tokens + env(amm.bid({.account = alice, .bidMin = 500})); + BEAST_EXPECT(amm.expectAuctionSlot(100, 0, IOUAmount{500})); + BEAST_EXPECT(expectHolding(env, alice, STAmount{lpIssue, 0})); + // But trades with the discounted fee since she still owns the slot. + // Alice pays ~10011 MPT in fees + env(pay(alice, bob, USD(10)), path(~USD), sendmax(BTC(11'000'000))); + BEAST_EXPECT(amm.expectBalances( + BTC(1'010'010'011), USD(1'000), IOUAmount{1'004'487'562112089, -9})); + + // Bob pays the full fee ~0.1USD + env(pay(bob, alice, BTC(10'000'000)), path(~MPT(BTC)), sendmax(USD(11))); + + BEAST_EXPECT(amm.expectBalances( + BTC(1'000'010'011), + STAmount{USD, UINT64_C(1'010'10090898081), -11}, + IOUAmount{1'004'487'562112089, -9})); + } + + // preflight tests + { + Env env(*this, features); + env.fund(XRP(2'000), gw, alice, bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 2'000, + .flags = MPTDEXFlags}); + AMM amm(env, gw, XRP(1'000), BTC(1'010), false, 1'000); + Json::Value const tx = amm.bid({.account = alice, .bidMin = 500}); + + { + auto jtx = env.jt(tx, seq(1), fee(10)); + env.app().config().features.erase(featureMPTokensV2); + PreflightContext const pfctx( + env.app(), *jtx.stx, env.current()->rules(), tapNONE, env.journal); + auto pf = AMMBid::checkExtraFeatures(pfctx); + BEAST_EXPECT(pf == false); + env.app().config().features.insert(featureMPTokensV2); + } + + { + auto jtx = env.jt(tx, seq(1), fee(10)); + jtx.jv["Asset2"]["currency"] = "XRP"; + jtx.jv["Asset2"].removeMember("mpt_issuance_id"); + jtx.stx = env.ust(jtx); + PreflightContext const pfctx( + env.app(), *jtx.stx, env.current()->rules(), tapNONE, env.journal); + auto pf = AMMBid::preflight(pfctx); + BEAST_EXPECT(pf == temBAD_AMM_TOKENS); + } + } + } + + void + testClawback() + { + testcase("Clawback"); + using namespace jtx; + + Env env(*this); + env.fund(XRP(2'000), gw, alice); + MPT const BTC = MPTTester( + {.env = env, .issuer = gw, .holders = {alice}, .transferFee = 1'500, .pay = 40'000}); + + // alice creates AMM + AMM const amm(env, alice, XRP(1'000), BTC(1'000)); + + // gw owns MPTIssuance, not allowed to set asfAllowTrustLineClawback + env(fset(gw, asfAllowTrustLineClawback), ter(tecOWNERS)); + } + + void + testClawbackFromAMMAccount(FeatureBitset features) + { + testcase("test clawback from AMM account"); + using namespace jtx; + + Env env(*this, features); + env.fund(XRP(1'000), gw); + env(fset(gw, asfAllowTrustLineClawback)); + fund(env, gw, {alice}, XRP(1'000), {USD(1'000)}, Fund::Acct); + + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + // to clawback from AMM account, must use AMMClawback instead of + // Clawback + auto const err = features[featureSingleAssetVault] ? tecPSEUDO_ACCOUNT : tecAMM_ACCOUNT; + AMM const amm(env, gw, XRP(100), BTC(100)); + auto amount = amountFromString(amm.lptIssue(), "10"); + env(claw(gw, amount), ter(err)); + + AMM const amm1(env, alice, USD(100), BTC(200)); + auto amount1 = amountFromString(amm1.lptIssue(), "10"); + env(claw(gw, amount1), ter(err)); + } + + void + testInvalidAMMPayment() + { + testcase("Invalid AMM Payment"); + using namespace jtx; + using namespace jtx::paychan; + using namespace std::chrono; + using namespace std::literals::chrono_literals; + + // Can't pay into AMM account. + // Can't pay out since there is no keys + for (auto const& acct : {gw, alice}) + { + { + Env env(*this); + fund(env, gw, {alice, carol}, XRP(1'000)); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 100, + .flags = MPTDEXFlags}); + // XRP balance is below reserve + AMM const ammAlice(env, acct, XRP(10), BTC(10)); + // Pay below reserve + env(pay(carol, ammAlice.ammAccount(), XRP(10)), ter(tecNO_PERMISSION)); + // Pay above reserve + env(pay(carol, ammAlice.ammAccount(), XRP(300)), ter(tecNO_PERMISSION)); + // Pay MPT + env(pay(carol, ammAlice.ammAccount(), BTC(10)), ter(tecNO_PERMISSION)); + } + + { + Env env(*this); + fund(env, gw, {alice, carol}, XRP(10'000'000)); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 20'000, + .flags = MPTDEXFlags}); + // XRP balance is above reserve + AMM const ammAlice(env, acct, XRP(1'000'000), BTC(10'000)); + // Pay below reserve + env(pay(carol, ammAlice.ammAccount(), XRP(10)), ter(tecNO_PERMISSION)); + // Pay above reserve + env(pay(carol, ammAlice.ammAccount(), XRP(1'000'000)), ter(tecNO_PERMISSION)); + // Pay MPT + env(pay(carol, ammAlice.ammAccount(), BTC(1'000)), ter(tecNO_PERMISSION)); + } + } + + // Can't pay into AMM with escrow. + testAMM( + [&](AMM& ammAlice, Env& env) { + env(escrow::create(carol, ammAlice.ammAccount(), MPT(ammAlice[1])(1)), + escrow::condition(escrow::cb1), + escrow::finish_time(env.now() + 1s), + escrow::cancel_time(env.now() + 2s), + fee(1'500), + ter(tecNO_PERMISSION)); + + env(escrow::create(carol, ammAlice.ammAccount(), XRP(1)), + escrow::condition(escrow::cb1), + escrow::finish_time(env.now() + 1s), + escrow::cancel_time(env.now() + 2s), + fee(1'500), + ter(tecNO_PERMISSION)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Can't pay into AMM with paychan. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const pk = carol.pk(); + auto const settleDelay = 10s; + NetClock::time_point const cancelAfter = + env.current()->header().parentCloseTime + 20s; + env(create( + carol, + ammAlice.ammAccount(), + MPT(ammAlice[1])(1'000), + settleDelay, + pk, + cancelAfter), + ter(telENV_RPC_FAILED)); + + env(create(carol, ammAlice.ammAccount(), XRP(1'000), settleDelay, pk, cancelAfter), + ter(tecNO_PERMISSION)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Can't pay into AMM with checks. + testAMM( + [&](AMM& ammAlice, Env& env) { + env(check::create(env.master.id(), ammAlice.ammAccount(), XRP(100)), + ter(tecNO_PERMISSION)); + + env(check::create(env.master.id(), ammAlice.ammAccount(), MPT(ammAlice[1])(100)), + ter(tecNO_PERMISSION)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + // Pay amounts close to one side of the pool + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const& BTC = MPT(ammAlice[1]); + // Can't consume whole pool + env(pay(alice, carol, USD(100)), + path(~USD), + sendmax(BTC(1'000'000'000)), + ter(tecPATH_PARTIAL)); + env(pay(alice, carol, BTC(100'000'000)), + path(~BTC), + sendmax(USD(1'000'000'000)), + ter(tecPATH_PARTIAL)); + // Overflow + env(pay(alice, carol, STAmount{USD, UINT64_C(99'999999999), -9}), + path(~USD), + sendmax(BTC(1'000'000'000)), + ter(tecPATH_PARTIAL)); + env(pay(alice, carol, STAmount{USD, UINT64_C(999'99999999), -8}), + path(~USD), + sendmax(BTC(1'000'000'000)), + ter(tecPATH_PARTIAL)); + env(pay(alice, carol, BTC(99'999'999)), + path(~BTC), + sendmax(USD(1'000'000'000)), + ter(tecPATH_PARTIAL)); + // Sender doesn't have enough funds + env(pay(alice, carol, USD(99.99)), + path(~USD), + sendmax(BTC(1'000'000'000)), + ter(tecPATH_PARTIAL)); + env(pay(alice, carol, BTC(99'990'000)), + path(~BTC), + sendmax(USD(1'000'000'000)), + ter(tecPATH_PARTIAL)); + }, + {{USD(100), AMMMPT(100'000'000)}}); + + // Globally locked MPT. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000)); + BTC.set({.flags = tfMPTLock}); + + env(pay(alice, carol, BTC(1)), + path(~static_cast(BTC)), + txflags(tfPartialPayment | tfNoRippleDirect), + sendmax(XRP(10)), + ter(tecPATH_DRY)); + env(pay(alice, carol, XRP(1)), + path(~XRP), + txflags(tfPartialPayment | tfNoRippleDirect), + sendmax(BTC(10)), + ter(tecPATH_DRY)); + } + + // Individually locked MPT destination account. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000)); + BTC.set({.holder = carol, .flags = tfMPTLock}); + + env(pay(alice, carol, BTC(1)), + path(~static_cast(BTC)), + txflags(tfPartialPayment | tfNoRippleDirect), + sendmax(XRP(10)), + ter(tecPATH_DRY)); + } + + // Individually locked MPT source account + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000)); + BTC.set({.holder = alice, .flags = tfMPTLock}); + + env(pay(alice, carol, XRP(1)), + path(~XRP), + txflags(tfPartialPayment | tfNoRippleDirect), + sendmax(BTC(10)), + ter(tecPATH_DRY)); + } + + // lock on both sides + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + MPTTester ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM const ammAlice(env, alice, ETH(10'000), BTC(10'000)); + BTC.set({.holder = carol, .flags = tfMPTLock}); + BTC.set({.holder = alice, .flags = tfMPTLock}); + ETH.set({.holder = carol, .flags = tfMPTLock}); + ETH.set({.holder = alice, .flags = tfMPTLock}); + + env(pay(alice, carol, ETH(1)), + path(~MPT(ETH)), + txflags(tfPartialPayment | tfNoRippleDirect), + sendmax(BTC(10)), + ter(tecPATH_DRY)); + + env(pay(alice, carol, BTC(1)), + path(~MPT(BTC)), + txflags(tfPartialPayment | tfNoRippleDirect), + sendmax(ETH(10)), + ter(tecPATH_DRY)); + } + + // Individually locked AMM MPT + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000)); + BTC.set({.holder = ammAlice.ammAccount(), .flags = tfMPTLock}); + + env(pay(alice, carol, XRP(1)), + path(~XRP), + txflags(tfPartialPayment | tfNoRippleDirect), + sendmax(BTC(10)), + ter(tecPATH_DRY)); + } + } + + void + testBasicPaymentEngine() + { + testcase("Basic Payment"); + using namespace jtx; + + // Payment 100MPT for 100XRP. + // Force one path with tfNoRippleDirect. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + env.fund(XRP(30'000), bob); + env.close(); + env(pay(bob, carol, MPT(ammAlice[1])(100)), + path(~MPT(ammAlice[1])), + sendmax(XRP(100)), + txflags(tfNoRippleDirect)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'100), MPT(ammAlice[1])(10'000), ammAlice.tokens())); + // Initial balance + 100 + env.require(balance(carol, carolMPT + MPT(ammAlice[1])(100))); + // Initial balance 30,000 - 100(sendmax) - 10(tx fee) + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(30'000) - XRP(100) - txfee(env, 1))); + }, + {{XRP(10'000), AMMMPT(10'100)}}); + + // Payment 100IOU/MPT for 100IOU/MPT. Test IOU/MPT mix. + // Force one path with tfNoRippleDirect. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + + env(pay(gw, alice, BTC(50000))); + env(pay(gw, bob, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, bob, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10100)); + auto carolBTC = env.balance(carol, BTC); + auto bobUSD = env.balance(bob, USD); + env(pay(bob, carol, BTC(100)), + path(~BTC), + sendmax(USD(100)), + txflags(tfNoRippleDirect | tfPartialPayment)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(USD(10'100), BTC(10'000), ammAlice.tokens())); + env.require(balance(carol, carolBTC + BTC(100))); + env.require(balance(bob, bobUSD - USD(100))); + }; + testHelper2TokensMix(test); + } + + // Payment 100MPT for 100XRP, use default path. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + env.fund(XRP(30'000), bob); + env.close(); + env(pay(bob, carol, MPT(ammAlice[1])(100)), sendmax(XRP(100))); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'100), MPT(ammAlice[1])(10'000), ammAlice.tokens())); + // Initial balance + 100 + env.require(balance(carol, carolMPT + MPT(ammAlice[1])(100))); + // Initial balance 30,000 - 100(sendmax) - 10(tx fee) + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(30'000) - XRP(100) - txfee(env, 1))); + }, + {{XRP(10'000), AMMMPT(10'100)}}); + + // Payment 100IOU/MPT for 100IOU/MPT using default path. + // Test IOU/MPT mix. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + + env(pay(gw, alice, BTC(50000))); + env(pay(gw, bob, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, bob, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10100)); + auto carolBTC = env.balance(carol, BTC); + auto bobUSD = env.balance(bob, USD); + env(pay(bob, carol, BTC(100)), sendmax(USD(100))); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(USD(10'100), BTC(10'000), ammAlice.tokens())); + env.require(balance(carol, carolBTC + BTC(100))); + env.require(balance(bob, bobUSD - USD(100))); + }; + testHelper2TokensMix(test); + } + + // This payment is identical to above. While it has + // both default path and path, activeStrands has one path. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + env.fund(XRP(30'000), bob); + env.close(); + env(pay(bob, carol, MPT(ammAlice[1])(100)), + path(~MPT(ammAlice[1])), + sendmax(XRP(100))); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'100), MPT(ammAlice[1])(10'000), ammAlice.tokens())); + // Initial balance + 100 + env.require(balance(carol, carolMPT + MPT(ammAlice[1])(100))); + // Initial balance 30,000 - 100(sendmax) - 10(tx fee) + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(30'000) - XRP(100) - txfee(env, 1))); + }, + {{XRP(10'000), AMMMPT(10'100)}}); + + // Test MPT/IOU combination for the case above. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + + env(pay(gw, alice, BTC(50000))); + env(pay(gw, bob, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, bob, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10100)); + auto carolBTC = env.balance(carol, BTC); + auto bobUSD = env.balance(bob, USD); + env(pay(bob, carol, BTC(100)), path(~BTC), sendmax(USD(100))); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(USD(10'100), BTC(10'000), ammAlice.tokens())); + env.require(balance(carol, carolBTC + BTC(100))); + env.require(balance(bob, bobUSD - USD(100))); + }; + testHelper2TokensMix(test); + } + + // Payment with limitQuality set. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto carolMPT = env.balance(carol, MPT(ammAlice[1])); + env.fund(jtx::XRP(30'000), bob); + env.close(); + // Pays 10MPT for 10XRP. A larger payment of ~99.11MPT/100XRP + // would have been sent has it not been for limitQuality. + env(pay(bob, carol, MPT(ammAlice[1])(100)), + path(~MPT(ammAlice[1])), + sendmax(XRP(100)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'010), MPT(ammAlice[1])(10'000), ammAlice.tokens())); + // Initial balance + 10(limited by limitQuality) + env.require(balance(carol, carolMPT + MPT(ammAlice[1])(10))); + // Initial balance 30,000 - 10(limited by limitQuality) - 10(tx + // fee) + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(30'000) - XRP(10) - txfee(env, 1))); + + // Fails because of limitQuality. Would have sent + // ~98.91MPT/110XRP has it not been for limitQuality. + env(pay(bob, carol, MPT(ammAlice[1])(100)), + path(~MPT(ammAlice[1])), + sendmax(XRP(100)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality), + ter(tecPATH_DRY)); + env.close(); + }, + {{XRP(10'000), AMMMPT(10'010)}}); + + // Payment with limitQuality set. MPT/IOU combination. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + + env(pay(gw, alice, BTC(50000))); + env(pay(gw, bob, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, bob, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10010)); + auto carolBTC = env.balance(carol, BTC); + auto bobUSD = env.balance(bob, USD); + env(pay(bob, carol, BTC(100)), + path(~BTC), + sendmax(USD(100)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(USD(10'010), BTC(10'000), ammAlice.tokens())); + env.require(balance(carol, carolBTC + BTC(10))); + env.require(balance(bob, bobUSD - USD(10))); + + env(pay(bob, carol, BTC(100)), + path(~BTC), + sendmax(USD(100)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality), + ter(tecPATH_DRY)); + env.close(); + }; + testHelper2TokensMix(test); + } + + // Payment with limitQuality and transfer fee set. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, bob, carol); + env.close(); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 10'000, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + auto ammAlice = AMM(env, alice, XRP(10'000), BTC(10'010'000'000'000'000)); + env.close(); + auto carolMPT = env.balance(carol, MPT(BTC)); + // Pays 10'000'000'000'000MPT for 10XRP. A larger payment of + // ~99'110'000'000'000MPT/100XRP would have been sent has it not + // been for limitQuality and the transfer fee. + env(pay(bob, carol, BTC(100'000'000'000'000)), + path(~MPT(BTC)), + sendmax(XRP(110)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'010), BTC(10'000'000'000'000'000), ammAlice.tokens())); + // 10'000'000'000'000MPT - 10% transfer fee + env.require(balance(carol, carolMPT + BTC(9'090'909'090'909))); + BEAST_EXPECT(expectLedgerEntryRoot(env, bob, XRP(30'000) - XRP(10) - txfee(env, 1))); + } + + // Payment with limitQuality and transfer fee set. MPT/IOU combination. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1({ + .env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000 + //.transferFee = 10'000 + }); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 300'000'000'000'000'000, + .transferFee = 10'000}); + + env(pay(gw, alice, BTC(30'000'000'000'000'000))); + env(pay(gw, bob, BTC(30'000'000'000'000'000))); + env(pay(gw, carol, BTC(30'000'000'000'000'000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, bob, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10'000), BTC(10'010'000'000'000'000)); + auto carolBTC = env.balance(carol, BTC); + auto bobUSD = env.balance(bob, USD); + env(pay(bob, carol, BTC(100'000'000'000'000)), + path(~BTC), + sendmax(USD(110)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + USD(10'010), BTC(10'000'000'000'000'000), ammAlice.tokens())); + env.require(balance(carol, carolBTC + BTC(9'090'909'090'909))); + env.require(balance(bob, bobUSD - USD(10))); + }; + testHelper2TokensMix(test); + } + + // Fail when partial payment is not set. + testAMM( + [&](AMM& ammAlice, Env& env) { + env.fund(jtx::XRP(30'000), bob); + env.close(); + env(pay(bob, carol, MPT(ammAlice[1])(100)), + path(~MPT(ammAlice[1])), + sendmax(XRP(100)), + txflags(tfNoRippleDirect), + ter(tecPATH_PARTIAL)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + // Fail when partial payment is not set. MPT/IOU combination. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(30'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000'000}); + + env(pay(gw, alice, BTC(50000))); + env(pay(gw, bob, BTC(50000))); + env(pay(gw, carol, BTC(50000))); + env(pay(gw, alice, USD(50000))); + env(pay(gw, bob, USD(50000))); + env(pay(gw, carol, USD(50000))); + env.close(); + + auto ammAlice = AMM(env, alice, USD(10000), BTC(10000)); + env(pay(bob, carol, BTC(100)), + path(~BTC), + sendmax(USD(100)), + txflags(tfNoRippleDirect), + ter(tecPATH_PARTIAL)); + }; + testHelper2TokensMix(test); + } + + // Non-default path (with AMM) has a better quality than default path. + // The max possible liquidity is taken out of non-default + // path ~29.9e14XRP/29.9e14ETH, ~29.9e14ETH/~29.99e14btc. The rest + // is taken from the offer. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 3'000'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 3'000'000'000'000'000'000, + .flags = MPTDEXFlags}); + env.fund(XRP(1'000), bob); + env.close(); + auto ammETH_XRP = AMM(env, alice, XRP(10'000), ETH(1'000'000'000'000'000'000)); + auto ammBTC_ETH = + AMM(env, alice, ETH(1'000'000'000'000'000'000), BTC(1'000'000'000'000'000'000)); + env(offer(alice, XRP(101), BTC(10'000'000'000'000'000)), txflags(tfPassive)); + env.close(); + env(pay(bob, carol, BTC(10'000'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(XRP(102)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(ammETH_XRP.expectBalances( + XRPAmount(10'030'082'730), ETH(9'970'00749812546872), ammETH_XRP.tokens())); + + BEAST_EXPECT(ammBTC_ETH.expectBalances( + BTC(9'970'09727766213961), ETH(10'029'99250187453128), ammBTC_ETH.tokens())); + + Amounts const expectedAmounts = Amounts{XRPAmount(30'201'749), BTC(29'90272233786039)}; + + BEAST_EXPECT(expectOffers(env, alice, 1, {{expectedAmounts}})); + + // Initial (30,000 + 100)e14 + env.require(balance(carol, BTC(3'010'000'000'000'000'000))); + // Initial 1,000 - 30082730(AMM pool) - 70798251(offer) - 10(tx fee) + BEAST_EXPECT(expectLedgerEntryRoot( + env, + bob, + XRP(1'000) - XRPAmount{30'082'730} - XRPAmount{70'798'251} - txfee(env, 1))); + } + + // Default path (with AMM) has a better quality than a + // non-default path. + // The max possible liquidity is taken out of default + // path ~49XRP/49e14BTC. The rest is taken from the offer. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 3'000'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 1'000'000'000'000'000'000, + .flags = MPTDEXFlags}); + auto ammAlice = AMM(env, alice, XRP(10'000), BTC(1'000'000'000'000'000'000)); + env.fund(XRP(1'000), bob); + env.close(); + env(offer(alice, XRP(101), ETH(10'000'000'000'000'000)), txflags(tfPassive)); + env.close(); + env(offer(alice, ETH(10'000'000'000'000'000), BTC(10'000'000'000'000'000)), + txflags(tfPassive)); + env.close(); + env(pay(bob, carol, BTC(10'000'000'000'000'000)), + path(~MPT(ETH), ~MPT(BTC)), + sendmax(XRP(102)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount(10'050'238'637), BTC(9'950'01249687578120), ammAlice.tokens())); + BEAST_EXPECT(expectOffers( + env, + alice, + 2, + {{Amounts{XRPAmount(50'487'378), ETH(49'98750312421880)}, + Amounts{ETH(49'98750312421880), BTC(49'98750312421880)}}})); + // Initial (30,000 + 100)e14 + env.require(balance(carol, BTC(30'100'00000000000000))); + // Initial 1,000 - 50238637(AMM pool) - 50512622(offer) - 10(tx + // fee) + BEAST_EXPECT(expectLedgerEntryRoot( + env, + bob, + XRP(1'000) - XRPAmount{50'238'637} - XRPAmount{50'512'622} - txfee(env, 1))); + } + + // Default path with AMM and Order Book offer. AMM is consumed first, + // remaining amount is consumed by the offer. + { + Env env(*this); + fund(env, gw, {alice, bob, carol}, XRP(30'000)); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'100'000'000'000'000)); + env(offer(bob, XRP(100), MPT(ammAlice[1])(100'000'000'000'000)), txflags(tfPassive)); + env.close(); + env(pay(alice, carol, MPT(ammAlice[1])(200'000'000'000'000)), + sendmax(XRP(200)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'100), MPT(ammAlice[1])(10'000'000000000001), ammAlice.tokens())); + env.require(balance(carol, MPT(ammAlice[1])(30'199'999999999999))); + + // Initial 30,000 - 10000(AMM pool LP) - 100(AMMoffer) - + // - 100(offer) - 10(tx fee) - 10(tx fee of MPTTester init as + // holder) - one reserve + BEAST_EXPECT(expectLedgerEntryRoot( + env, + alice, + XRP(30'000) - XRP(10'000) - XRP(100) - XRP(100) - ammCrtFee(env) - + 2 * txfee(env, 1))); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + + // Default path with AMM and Order Book offer. + // Order Book offer is consumed first. + // Remaining amount is consumed by AMM. + { + Env env(*this); + fund(env, gw, {alice, bob, carol}, XRP(20'000)); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 2'000, + .flags = MPTDEXFlags}); + env(offer(bob, XRP(50), BTC(150)), txflags(tfPassive)); + env.close(); + AMM const ammAlice(env, alice, XRP(1'000), BTC(1'050)); + env(pay(alice, carol, BTC(200)), sendmax(XRP(200)), txflags(tfPartialPayment)); + BEAST_EXPECT(ammAlice.expectBalances(XRP(1'050), BTC(1'000), ammAlice.tokens())); + env.require(balance(carol, BTC(2'200))); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + + // Offer crossing XRP/MPT + { + Env env(*this); + fund(env, gw, {alice, bob, carol}, XRP(30'000)); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 30'000, + .flags = MPTDEXFlags}); + AMM ammAlice(env, alice, XRP(10'000), BTC(10'100)); + env(offer(bob, MPT(ammAlice[1])(100), XRP(100))); + env.close(); + BEAST_EXPECT( + ammAlice.expectBalances(XRP(10'100), MPT(ammAlice[1])(10'000), ammAlice.tokens())); + // Initial 30,000 + 100 + env.require(balance(bob, MPT(ammAlice[1])(30'100))); + // Initial 30,000 - 100(offer) - 10(tx fee) - 1(tx fee for MPTTester + // holder) + BEAST_EXPECT( + expectLedgerEntryRoot(env, bob, XRP(30'000) - XRP(100) - 2 * txfee(env, 1))); + BEAST_EXPECT(expectOffers(env, bob, 0)); + } + + // Offer crossing MPT/MPT and transfer rate + // Single path AMM offer + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 25'000, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 25'000, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammAlice(env, alice, BTC(1'000'000'000'000'000), ETH(1'100'000'000'000'000)); + // This offer succeeds to cross pre- and post-amendment + // because the strand's out amount is small enough to match + // limitQuality value and limitOut() function in StrandFlow + // doesn't require an adjustment to out value. + env(offer(carol, ETH(100'000'000'000'000), BTC(100'000'000'000'000))); + env.close(); + // No transfer fee + BEAST_EXPECT(ammAlice.expectBalances( + BTC(1'100'000'000'000'000), ETH(1'000'000'000'000'000), ammAlice.tokens())); + // Initial 30,000'000'000'000'000 - 100'000'000'000'000(offer)-25 % + // transfer fee + env.require(balance(carol, BTC(29'875'000'000'000'000))); + // Initial 30,000'000'000'000'000 + 100'000'000'000'000(offer) + env.require(balance(carol, ETH(30'100'000'000'000'000))); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + // Single-path AMM offer + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, bob, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 100, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const amm(env, alice, XRP(1'000), BTC(500'000'000'000'000)); + env(offer(carol, XRP(100), BTC(55'000'000'000'000))); + env.close(); + + BEAST_EXPECT( + amm.expectBalances(XRPAmount(909'090'909), BTC(550'000000055001), amm.tokens())); + // Offer ~91XRP/49.99e12BTC + BEAST_EXPECT(expectOffers( + env, carol, 1, {{Amounts{XRPAmount{9'090'909}, BTC(4'999999950000)}}})); + // Carol pays 0.1% fee on 50'000000055000BTC = 50'000000055BTC + env.require(balance(carol, BTC(29'949'949'999'944'943))); + } + + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .transferFee = 100, + .pay = 3'000'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const amm(env, alice, XRP(1'000), BTC(50'000'000'000'000'000)); + env(offer(carol, XRP(10), BTC(5'500'000'000'000'000))); + env.close(); + + BEAST_EXPECT(amm.expectBalances(XRP(990), BTC(505'05050505050506), amm.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + // Multi-path AMM offer + { + Env env(*this); + Account const ed("ed"); + env.fund(XRP(30'000), gw, alice, bob, carol, ed); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 20'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = 25'000, + .pay = 20'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammAlice( + env, alice, BTC(10'000'000'000'000'000), ETH(11'000'000'000'000'000)); + + env(offer(bob, BTC(100'000'000'000'000), XRP(10)), txflags(tfPassive)); + env(offer(ed, XRP(10), ETH(100'000'000'000'000)), txflags(tfPassive)); + env.close(); + env(offer(carol, ETH(1'000'000'000'000'000), BTC(1'000'000'000'000'000))); + env.close(); + + BEAST_EXPECT(ammAlice.expectBalances( + BTC(1'060'6848287928033), ETH(1'037'0658372213574), ammAlice.tokens())); + // Consumed offer ~72.93e13ETH/72.93e13BTC + BEAST_EXPECT(expectOffers( + env, carol, 1, {Amounts{ETH(27'0658372213574), BTC(27'0658372213575)}})); + BEAST_EXPECT(expectOffers(env, bob, 0)); + BEAST_EXPECT(expectOffers(env, ed, 0)); + + env.require(balance(carol, BTC(19'116'439'640'089'955))); + env.require(balance(carol, ETH(20'729'341'627'786'426))); + env.require(balance(bob, BTC(20'100'000'000'000'000))); + env.require(balance(ed, ETH(19'875'000'000'000'000))); + } + + // Payment and transfer fee + // Scenario: + // Bob sends 125BTC to pay 80EUR to Carol + // Payment execution: + // bob's 125BTC/1.25 = 100BTC + // 100BTC/100EUR AMM offer + // 100EUR/1.25 = 80EUR paid to carol + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, bob, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 30'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .pay = 30'000, + .flags = MPTDEXFlags}); + AMM const ammAlice(env, alice, BTC(1'000), ETH(1'100)); + env(rate(gw, 1.25)); + env.close(); + env(pay(bob, carol, ETH(100)), + path(~MPT(ETH)), + sendmax(BTC(125)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(ammAlice.expectBalances(BTC(1'100), ETH(1'000), ammAlice.tokens())); + env.require(balance(bob, BTC(29'875))); + env.require(balance(carol, ETH(30'080))); + } + + // Payment and transfer fee, multiple steps + // Scenario: + // Dan's offer 200CAN/200GBP + // AMM 1000GBP/10125ETH + // Ed's offer 200ETH/BTC + // Bob sends 195.3125CAN to pay 100BTC to Carol + // Payment execution: + // bob's 195.3125CAN/1.25 = 156.25CAN -> dan's offer + // 156.25CAN/156.25GBP 156.25GBP/1.25 = 125GBP -> AMM's offer + // 125GBP/125ETH 125ETH/1.25 = 100ETH -> ed's offer + // 100ETH/100BTC 100BTC/1.25 = 80BTC paid to carol + { + Env env(*this); + Account const dan("dan"); + Account const ed("ed"); + env.fund(XRP(30'000), gw, alice, bob, carol, dan, ed); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, ed}, + .transferFee = 25'000, + .pay = 30'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, ed}, + .transferFee = 25'000, + .pay = 30'000, + .flags = MPTDEXFlags}); + MPTTester const CAN( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, ed}, + .transferFee = 25'000, + .pay = 2'000'000, + .flags = MPTDEXFlags}); + MPTTester const GBP( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, ed}, + .transferFee = 25'000, + .pay = 3'000'000, + .flags = MPTDEXFlags}); + AMM const ammAlice(env, alice, GBP(1'000'000), ETH(10'125)); + env(pay(gw, bob, CAN(1'953'125))); + env.close(); + env(offer(dan, CAN(2'000'000), GBP(20'000))); + env(offer(ed, ETH(200), BTC(200))); + env.close(); + env(pay(bob, carol, BTC(100)), + path(~MPT(GBP), ~MPT(ETH), ~MPT(BTC)), + sendmax(CAN(1'953'125)), + txflags(tfPartialPayment)); + env.close(); + env.require(balance(bob, CAN(2'000'000))); + env.require(balance(dan, CAN(3'562'500))); + env.require(balance(dan, GBP(2'984'375))); + + BEAST_EXPECT(ammAlice.expectBalances(GBP(1'012'500), ETH(10'000), ammAlice.tokens())); + env.require(balance(ed, ETH(30'100))); + env.require(balance(ed, BTC(29'900))); + env.require(balance(carol, BTC(30'080))); + } + + // Pay amounts close to one side of the pool + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const& BTC = MPT(ammAlice[1]); + env(pay(alice, carol, BTC(9999)), + path(~BTC), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(tesSUCCESS)); + env(pay(alice, carol, BTC(10'000)), + path(~BTC), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(tesSUCCESS)); + env(pay(alice, carol, XRP(100)), + path(~XRP), + sendmax(BTC(100)), + txflags(tfPartialPayment), + ter(tesSUCCESS)); + env(pay(alice, carol, STAmount{xrpIssue(), 99'999'900}), + path(~XRP), + sendmax(BTC(100)), + txflags(tfPartialPayment), + ter(tesSUCCESS)); + }, + {{XRP(100), AMMMPT(10'000)}}); + + // Multiple paths/steps + { + Env env(*this); + env.fund(XRP(100'000), gw, alice); + env.fund(XRP(1'000), bob, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 500'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 500'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const USD( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 500'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const EUR( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 500'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const xrp_eur(env, alice, XRP(10'100), EUR(100'000'000'000'000'000)); + AMM const eur_btc( + env, alice, EUR(100'000'000'000'000'000), BTC(102'000'000'000'000'000)); + AMM const btc_usd( + env, alice, BTC(101'000'000'000'000'000), USD(100'000'000'000'000'000)); + AMM const xrp_usd(env, alice, XRP(10'150), USD(102'000'000'000'000'000)); + AMM const xrp_eth(env, alice, XRP(10'000), ETH(101'000'000'000'000'000)); + AMM const eth_eur( + env, alice, ETH(109'000'000'000'000'000), EUR(110'000'000'000'000'000)); + AMM const eur_usd( + env, alice, EUR(101'000'000'000'000'000), USD(100'000'000'000'000'000)); + env(pay(bob, carol, USD(1'000'000'000'000'000)), + path(~MPT(EUR), ~MPT(BTC), ~MPT(USD)), + path(~MPT(USD)), + path(~MPT(ETH), ~MPT(EUR), ~MPT(USD)), + sendmax(XRP(200))); + + BEAST_EXPECT(xrp_eth.expectBalances( + XRPAmount(10'026'208'900), ETH(10'073'6577924447994), xrp_eth.tokens())); + BEAST_EXPECT(eth_eur.expectBalances( + ETH(10'926'3422075552006), EUR(10'973'5423207873690), eth_eur.tokens())); + BEAST_EXPECT(eur_usd.expectBalances( + EUR(10'126'4576792126310), USD(9'973'9315171207179), eur_usd.tokens())); + // XRP-USD path + // This path provides ~73.9e12USD/74.1XRP + BEAST_EXPECT(xrp_usd.expectBalances( + XRPAmount(10'224'106'246), USD(10'126'0684828792821), xrp_usd.tokens())); + + // XRP-EUR-BTC-USD + // This path doesn't provide any liquidity due to how + // offers are generated in multi-path. + // Analytical solution shows a different distribution: + // XRP-EUR-BTC-USD 11.6e12USD/11.64XRP, + // XRP-USD 60.7e12USD/60.8XRP, + // XRP-ETH-EUR-USD 27.6e12USD/27.6XRP + BEAST_EXPECT(xrp_eur.expectBalances( + XRP(10'100), EUR(100'000'000'000'000'000), xrp_eur.tokens())); + BEAST_EXPECT(eur_btc.expectBalances( + EUR(100'000'000'000'000'000), BTC(102'000'000'000'000'000), eur_btc.tokens())); + BEAST_EXPECT(btc_usd.expectBalances( + BTC(101'000'000'000'000'000), USD(100'000'000'000'000'000), btc_usd.tokens())); + env.require(balance(carol, USD(501'000'000'000'000'000))); + } + + // Dependent AMM + { + Env env(*this); + env.fund(XRP(40'000), gw, alice); + env.fund(XRP(1'000), bob, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 50'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 50'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const USD( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 50'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const EUR( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 50'000'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const xrp_eur(env, alice, XRP(10'100), EUR(10'000'000'000'000'000)); + AMM const eur_btc(env, alice, EUR(10'000'000'000'000'000), BTC(10'200'000'000'000'000)); + AMM const btc_usd(env, alice, BTC(10'100'000'000'000'000), USD(10'000'000'000'000'000)); + AMM const xrp_eth(env, alice, XRP(10'000), ETH(10'100'000'000'000'000)); + AMM const eth_eur(env, alice, ETH(10'900'000'000'000'000), EUR(11'000'000'000'000'000)); + env(pay(bob, carol, USD(100'000'000'000'000)), + path(~MPT(EUR), ~MPT(BTC), ~MPT(USD)), + path(~MPT(ETH), ~MPT(EUR), ~MPT(BTC), ~MPT(USD)), + sendmax(XRP(200))); + + BEAST_EXPECT(xrp_eur.expectBalances( + XRPAmount(10'118'738'472), EUR(9'981'544436337981), xrp_eur.tokens())); + BEAST_EXPECT(eur_btc.expectBalances( + EUR(10'101'160967851758), BTC(10'097'914269680647), eur_btc.tokens())); + BEAST_EXPECT(btc_usd.expectBalances( + BTC(10'202'085730319353), USD(9'900'000'000'000'000), btc_usd.tokens())); + BEAST_EXPECT(xrp_eth.expectBalances( + XRPAmount(10'082'446'397), ETH(10'017'410727780081), xrp_eth.tokens())); + BEAST_EXPECT(eth_eur.expectBalances( + ETH(10'982'589272219919), EUR(10'917'294595810261), eth_eur.tokens())); + env.require(balance(carol, USD(50'100'000'000'000'000))); + } + + // AMM offers limit + // Consuming 30 CLOB offers, results in hitting 30 AMM offers limit. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + env.fund(XRP(1'000), bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 400'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000'000'000'000'000)); + + for (int i = 0; i < 30; ++i) + env(offer(alice, ETH(1'000'000'000'000 + (10'000'000'000 * i)), XRP(1))); + // This is worse quality offer than 30 offers above. + // It will not be consumed because of AMM offers limit. + env(offer(alice, ETH(140'000'000'000'000), XRP(100))); + env(pay(bob, carol, BTC(100'000'000'000'000)), + path(~XRP, ~MPT(BTC)), + sendmax(ETH(400'000'000'000'000)), + txflags(tfPartialPayment | tfNoRippleDirect)); + + BEAST_EXPECT( + ammAlice.expectBalances(XRP(10'030), BTC(9'970'089730807592), ammAlice.tokens())); + + env.require(balance(carol, BTC(30'029'910269192408))); + BEAST_EXPECT(expectOffers(env, alice, 1, {{{ETH(140'000'000'000'000), XRP(100)}}})); + } + + // This payment is fulfilled + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + env.fund(XRP(1'000), bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 400'000'000'000'000, + .flags = MPTDEXFlags}); + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000'000'000'000'000)); + + for (int i = 0; i < 29; ++i) + env(offer(alice, ETH(1'000'000'000'000 + (10'000'000'000 * i)), XRP(1))); + // This is worse quality offer than 30 offers above. + // It will not be consumed because of AMM offers limit. + env(offer(alice, ETH(140'000'000'000'000), XRP(100))); + env(pay(bob, carol, BTC(100'000'000'000'000)), + path(~XRP, ~MPT(BTC)), + sendmax(ETH(400'000'000'000'000)), + txflags(tfPartialPayment | tfNoRippleDirect)); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount{10'101'010'102}, BTC(9'900'000'000'000'000), ammAlice.tokens())); + + env.require(balance(carol, BTC(30'100'000'000'000'000))); + BEAST_EXPECT( + expectOffers(env, alice, 1, {{{ETH(39'185857200000), XRPAmount{27'989'898}}}})); + } + + // Offer crossing with AMM and another offer. + // AMM has a better quality and is consumed first. + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + env.fund(XRP(1'000), bob); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 30'000'000'000'000'000, + .flags = MPTDEXFlags}); + + env(offer(bob, XRP(100), BTC(100'001'000'000'000))); + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'100'000'000'000'000)); + env(offer(carol, BTC(100'000'000'000'000), XRP(100))); + + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount{10'049'825'372}, BTC(10'049'925870493027), ammAlice.tokens())); + BEAST_EXPECT( + expectOffers(env, bob, 1, {{{XRPAmount{50'074'628}, BTC(50'075129506973)}}})); + + env.require(balance(carol, BTC(30'100'000'000'000'000))); + } + + // Individually locked MPT destination account + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000)); + + BTC.set({.holder = carol, .flags = tfMPTLock}); + + env(pay(alice, carol, XRP(1)), + path(~XRP), + sendmax(BTC(10)), + txflags(tfNoRippleDirect | tfPartialPayment), + ter(tesSUCCESS)); + } + + // Individually locked MPT source account + { + Env env(*this); + env.fund(XRP(30'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + AMM const ammAlice(env, alice, XRP(10'000), BTC(10'000)); + + BTC.set({.holder = alice, .flags = tfMPTLock}); + + env(pay(alice, carol, BTC(1)), + path(~MPT(BTC)), + sendmax(XRP(10)), + txflags(tfNoRippleDirect | tfPartialPayment), + ter(tesSUCCESS)); + } + } + + void + testAMMTokens() + { + testcase("AMM Tokens"); + using namespace jtx; + + // Offer crossing with AMM LPTokens and XRP. + // AMM LPTokens come from MPT/XRP pool. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const token1 = ammAlice.lptIssue(); + auto priceXRP = ammAssetOut( + STAmount{XRPAmount{10'000'000'000}}, + STAmount{token1, 10'000'000}, + STAmount{token1, 5'000'000}, + 0); + // Carol places an order to buy LPTokens + env(offer(carol, STAmount{token1, 5'000'000}, priceXRP)); + // Alice places an order to sell LPTokens + env(offer(alice, priceXRP, STAmount{token1, 5'000'000})); + // Pool's LPTokens balance doesn't change + BEAST_EXPECT(ammAlice.expectBalances( + XRP(10'000), MPT(ammAlice[1])(10'000), IOUAmount{10'000'000})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{5'000'000})); + BEAST_EXPECT(ammAlice.expectLPTokens(alice, IOUAmount{5'000'000})); + // Carol votes + ammAlice.vote(carol, 1'000); + BEAST_EXPECT(ammAlice.expectTradingFee(500)); + ammAlice.vote(carol, 0); + BEAST_EXPECT(ammAlice.expectTradingFee(0)); + // Carol bids + auto const baseFee = env.current()->fees().base; + auto const carolXRP = env.balance(carol); + env(ammAlice.bid({.account = carol, .bidMin = 100})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{4'999'900})); + BEAST_EXPECT(ammAlice.expectAuctionSlot(0, 0, IOUAmount{100})); + BEAST_EXPECT(env.balance(carol) == (carolXRP - baseFee)); + priceXRP = ammAssetOut( + STAmount{XRPAmount{10'000'000'000}}, + STAmount{token1, 9'999'900}, + STAmount{token1, 4'999'900}, + 0); + // Carol withdraws + ammAlice.withdrawAll(carol, XRP(0)); + BEAST_EXPECT(env.balance(carol) == (carolXRP - baseFee * 2 + priceXRP)); + BEAST_EXPECT(ammAlice.expectBalances( + XRPAmount{10'000'000'000} - priceXRP, + MPT(ammAlice[1])(10'000), + IOUAmount{5'000'000})); + BEAST_EXPECT(ammAlice.expectLPTokens(alice, IOUAmount{5'000'000})); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0})); + }, + {{XRP(10000), AMMMPT(10000)}}); + + // Offer crossing with two AMM LPTokens. + // token1 comes from MPT/XRP pool. + // token2 comes from XRP/IOU pool. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000); + fund(env, gw, {alice, carol}, {EUR(10'000)}, Fund::TokenOnly); + AMM ammAlice1(env, alice, XRP(10'000), EUR(10'000)); + ammAlice1.deposit(carol, 1'000'000); + auto const token1 = ammAlice.lptIssue(); + auto const token2 = ammAlice1.lptIssue(); + env(offer(alice, STAmount{token1, 100}, STAmount{token2, 100}), txflags(tfPassive)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1)); + env(offer(carol, STAmount{token2, 100}, STAmount{token1, 100})); + env.close(); + BEAST_EXPECT( + expectHolding(env, alice, STAmount{token1, 10'000'100}) && + expectHolding(env, alice, STAmount{token2, 9'999'900})); + BEAST_EXPECT( + expectHolding(env, carol, STAmount{token2, 1'000'100}) && + expectHolding(env, carol, STAmount{token1, 999'900})); + BEAST_EXPECT(expectOffers(env, alice, 0) && expectOffers(env, carol, 0)); + }, + {{XRP(10000), AMMMPT(10000)}}); + + // LPs pay LPTokens directly. Must trust set because the trust line + // is checked for the limit, which is 0 in the AMM auto-created + // trust line. + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const token1 = ammAlice.lptIssue(); + env.trust(STAmount{token1, 2'000'000}, carol); + env.close(); + ammAlice.deposit(carol, 1'000'000); + BEAST_EXPECT( + ammAlice.expectLPTokens(alice, IOUAmount{10'000'000, 0}) && + ammAlice.expectLPTokens(carol, IOUAmount{1'000'000, 0})); + // Pool balance doesn't change, only tokens moved from + // one line to another. + env(pay(alice, carol, STAmount{token1, 100})); + env.close(); + BEAST_EXPECT( + // Alice initial token1 10,000,000 - 100 + ammAlice.expectLPTokens(alice, IOUAmount{9'999'900, 0}) && + // Carol initial token1 1,000,000 + 100 + ammAlice.expectLPTokens(carol, IOUAmount{1'000'100, 0})); + + env.trust(STAmount{token1, 20'000'000}, alice); + env.close(); + env(pay(carol, alice, STAmount{token1, 100})); + env.close(); + // Back to the original balance + BEAST_EXPECT( + ammAlice.expectLPTokens(alice, IOUAmount{10'000'000, 0}) && + ammAlice.expectLPTokens(carol, IOUAmount{1'000'000, 0})); + }, + {{XRP(10000), AMMMPT(10000)}}); + } + + void + testAmendment() + { + testcase("Amendment"); + using namespace jtx; + FeatureBitset const feature{testable_amendments() - featureMPTokensV2}; + Env env{*this, feature}; + + env.fund(XRP(30'000), gw, alice); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 10'000, + .flags = tfMPTCanClawback | tfMPTCanTransfer}); + + AMM amm(env, alice, XRP(1'000), BTC(1'000), ter(temDISABLED)); + + env(amm.bid({.bidMax = 1000}), ter(temMALFORMED)); + env(amm.bid({}), ter(temDISABLED)); + amm.vote(VoteArg{.tfee = 100, .err = ter(temDISABLED)}); + amm.withdraw(WithdrawArg{.tokens = 100, .err = ter(temMALFORMED)}); + amm.withdraw(WithdrawArg{.err = ter(temDISABLED)}); + amm.deposit(DepositArg{.asset1In = USD(100), .err = ter(temDISABLED)}); + amm.ammDelete(alice, ter(temDISABLED)); + } + + void + testAMMAndCLOB(FeatureBitset features) + { + testcase("AMMAndCLOB, offer quality change"); + using namespace jtx; + auto const gw = Account("gw"); + auto const LP1 = Account("LP1"); + auto const LP2 = Account("LP2"); + + auto prep = [&](auto const& offerCb, auto const& expectCb) { + Env env(*this, features); + env.fund(XRP(30'000'000'000), gw); + env.fund(XRP(10'000), LP1); + env.fund(XRP(10'000), LP2); + MPTTester const TST( + {.env = env, .issuer = gw, .holders = {LP1, LP2}, .flags = MPTDEXFlags}); + + env(offer(gw, XRP(11'500'000'000), TST(1'000'000'000'000'000))); + + env(offer(LP1, TST(25'000'000), XRPAmount(287'500'000))); + + // Either AMM or CLOB offer + offerCb(env, TST); + + env(offer(LP2, TST(25'000'000), XRPAmount(287'500'000))); + + expectCb(env, TST); + }; + + // If we replace AMM with an equivalent CLOB offer, which AMM generates + // when it is consumed, then the result must be equivalent, too. + STAmount lp2TSTBalance; + std::string lp2TakerGets; + std::string lp2TakerPays; + // Execute with AMM first + prep( + [&](Env& env, MPTTester TST) { AMM const amm(env, LP1, TST(25'000'000), XRP(250)); }, + [&](Env& env, MPTTester TST) { + lp2TSTBalance = env.balance(LP2, MPT(TST)); + auto const offer = getAccountOffers(env, LP2)["offers"][0u]; + lp2TakerGets = offer["taker_gets"].asString(); + lp2TakerPays = offer["taker_pays"]["value"].asString(); + }); + // Execute with CLOB offer + prep( + [&](Env& env, MPTTester TST) { + env(offer(LP1, XRPAmount{18'095'131}, TST(1'687'379)), txflags(tfPassive)); + }, + [&](Env& env, MPTTester TST) { + BEAST_EXPECT(lp2TSTBalance == env.balance(LP2, MPT(TST))); + auto const offer = getAccountOffers(env, LP2)["offers"][0u]; + BEAST_EXPECT(lp2TakerGets == offer["taker_gets"].asString()); + BEAST_EXPECT(lp2TakerPays == offer["taker_pays"]["value"].asString()); + }); + } + + void + testTradingFee(FeatureBitset features) + { + testcase("Trading Fee"); + using namespace jtx; + + // Single Deposit, 1% fee + testAMM( + [&](AMM& ammAlice, Env& env) { + // No fee + ammAlice.deposit(carol, MPT(ammAlice[1])(3'000)); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{1'000})); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(3'000)); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{0})); + env.require(balance(carol, MPT(ammAlice[1])(30'000))); + // Set fee to 1% + ammAlice.vote(alice, 1'000); + BEAST_EXPECT(ammAlice.expectTradingFee(1'000)); + + // Carol gets fewer LPToken ~994, because of the single deposit + // fee + ammAlice.deposit(carol, MPT(ammAlice[1])(3'000)); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{994'981155689671, -12})); + env.require(balance(carol, MPT(ammAlice[1])(27'000))); + + // Set fee to 0 + ammAlice.vote(alice, 0); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + + // Carol gets back less than the original deposit + if (!features[fixAMMv1_3]) + { + env.require(balance(carol, MPT(ammAlice[1])(29'995))); + } + else + { + env.require(balance(carol, MPT(ammAlice[1])(29'994))); + } + }, + {{USD(1000), AMMMPT(1000)}}, + 0, + std::nullopt, + {features}); + + // Single deposit with EP not exceeding specified: + // 100MPT with EP not to exceed 0.1 (AssetIn/TokensOut). 1% fee. + testAMM( + [&](AMM& ammAlice, Env& env) { + BEAST_EXPECT(ammAlice.expectTradingFee(1'000)); + auto const balance = env.balance(carol, MPT(ammAlice[1])); + auto const tokensFee = ammAlice.deposit( + carol, + MPT(ammAlice[1])(1000), + std::nullopt, + STAmount{ammAlice.lptIssue(), 1, -1}); + auto const deposit = balance - env.balance(carol, MPT(ammAlice[1])); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + ammAlice.vote(alice, 0); + BEAST_EXPECT(ammAlice.expectTradingFee(0)); + auto const tokensNoFee = ammAlice.deposit(carol, deposit); + BEAST_EXPECT(tokensFee == IOUAmount(485636'0611129, -7)); + if (!features[fixAMMv1_3]) + { + BEAST_EXPECT(tokensNoFee == IOUAmount(487659'8005807, -7)); + } + else + { + BEAST_EXPECT(tokensNoFee == IOUAmount(487612'21584827, -8)); + } + }, + {{XRP(10'000), AMMMPT(10'000)}}, + 1'000, + std::nullopt, + {features}); + + // Single deposit with EP not exceeding specified: + // 200MPT with EP not to exceed 0.002020 (AssetIn/TokensOut). 1% fee + testAMM( + [&](AMM& ammAlice, Env& env) { + BEAST_EXPECT(ammAlice.expectTradingFee(1'000)); + auto const balance = env.balance(carol, MPT(ammAlice[1])); + auto const tokensFee = ammAlice.deposit( + carol, + MPT(ammAlice[1])(200), + std::nullopt, + STAmount{ammAlice.lptIssue(), 2020, -6}); + auto const deposit = balance - env.balance(carol, MPT(ammAlice[1])); + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + ammAlice.vote(alice, 0); + BEAST_EXPECT(ammAlice.expectTradingFee(0)); + auto const tokensNoFee = ammAlice.deposit(carol, deposit); + if (!features[fixAMMv1_3]) + { + BEAST_EXPECT(tokensFee == IOUAmount(98'019'80198019, -8)); + BEAST_EXPECT(tokensNoFee == IOUAmount(98'495'13933556, -8)); + } + else + { + BEAST_EXPECT(tokensFee == IOUAmount(97527'05893345, -8)); + BEAST_EXPECT(tokensNoFee == IOUAmount(98000'10293049, -8)); + } + }, + {{XRP(10'000), AMMMPT(10'000)}}, + 1'000, + std::nullopt, + {features}); + + // Single Withdrawal, 1% fee + testAMM( + [&](AMM& ammAlice, Env& env) { + // No fee + ammAlice.deposit(carol, MPT(ammAlice[1])(3'000)); + BEAST_EXPECT(ammAlice.expectLPTokens(carol, IOUAmount{1'000})); + env.require(balance(carol, MPT(ammAlice[1])(27'000))); + // Set fee to 1% + ammAlice.vote(alice, 1'000); + BEAST_EXPECT(ammAlice.expectTradingFee(1'000)); + // Single withdrawal. Carol gets ~5USD less than deposited. + ammAlice.withdrawAll(carol, MPT(ammAlice[1])(0)); + if (!features[fixAMMv1_3]) + { + env.require(balance(carol, MPT(ammAlice[1])(29'995))); + } + else + { + env.require(balance(carol, MPT(ammAlice[1])(29'994))); + } + }, + {{USD(1000), AMMMPT(1000)}}, + 0, + std::nullopt, + {features}); + + // Withdraw with EPrice limit, 1% fee. + testAMM( + [&](AMM& ammAlice, Env& env) { + ammAlice.deposit(carol, 1'000'000); + auto const tokensFee = ammAlice.withdraw( + carol, MPT(ammAlice[1])(100), std::nullopt, IOUAmount{520, 0}); + env.require(balance(carol, MPT(ammAlice[1])(30443))); + + // Set to original pool size + auto const deposit = + env.balance(carol, MPT(ammAlice[1])) - MPT(ammAlice[1])(29'000); + ammAlice.deposit(carol, deposit); + // fee 0% + ammAlice.vote(alice, 0); + BEAST_EXPECT(ammAlice.expectTradingFee(0)); + auto const tokensNoFee = ammAlice.withdraw(carol, deposit); + if (!features[fixAMMv1_3]) + { + env.require(balance(carol, MPT(ammAlice[1])(30443))); + } + else + { + env.require(balance(carol, MPT(ammAlice[1])(30442))); + } + BEAST_EXPECT(tokensNoFee == IOUAmount(746'327'46496649, -8)); + BEAST_EXPECT(tokensFee == IOUAmount(750'588'23529411, -8)); + }, + {{XRP(10'000), AMMMPT(10'000)}}, + 1'000, + std::nullopt, + {features}); + + // Payment, 1% fee + { + Env env{*this, features}; + env.fund(XRP(30'000), gw, alice, bob, carol); + env.close(); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .pay = 30'000, + .flags = MPTDEXFlags}); + + auto const USD = gw["USD"]; + env.trust(USD(30'000), alice); + env(pay(gw, alice, USD(30'000))); + env.trust(USD(30'000), bob); + env(pay(gw, bob, USD(1'000))); + env.trust(USD(30'000), carol); + env(pay(gw, carol, USD(30'000))); + env.close(); + + AMM amm(env, alice, BTC(1000), USD(1010)); + + env.require(balance(alice, BTC(29'000))); + env.require(balance(alice, USD(28'990))); + env.require(balance(carol, BTC(30'000))); + + // Carol pays to Alice with no fee + env(pay(carol, alice, USD(10)), + path(~USD), + sendmax(BTC(10)), + txflags(tfNoRippleDirect)); + env.close(); + + // Alice has 10USD more and Carol has 10BTC less + env.require(balance(alice, BTC(29'000))); + env.require(balance(alice, USD(29'000))); + env.require(balance(carol, BTC(29'990))); + + // Set fee to 1% + amm.vote(alice, 1'000); + BEAST_EXPECT(amm.expectTradingFee(1'000)); + // Bob pays to Carol with 1% fee + env(pay(bob, carol, BTC(10)), path(~BTC), sendmax(USD(15)), txflags(tfNoRippleDirect)); + env.close(); + // Bob sends 10.1~USD to pay 10BTC + env.require(balance(bob, STAmount{USD, UINT64_C(989'8989898989899), -13})); + // Carol got 10BTC + env.require(balance(carol, BTC(30'000))); + BEAST_EXPECT(amm.expectBalances( + BTC(1'000), STAmount{USD, UINT64_C(1'010'10101010101), -11}, amm.tokens())); + } + + // Offer crossing, 0.05% fee MPT/XRP + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const BTC = MPT(ammAlice[1]); + auto const carolXRP = env.balance(carol); + auto const baseFee = env.current()->fees().base; + env(offer(carol, BTC(10), XRP(10))); + env.close(); + env.require(balance(carol, BTC(30'010))); + env.require(balance(carol, carolXRP - baseFee - XRP(10))); + + // Change pool composition back + env(offer(carol, XRP(10), BTC(10))); + env.close(); + env.require(balance(carol, BTC(30'000))); + env.require(balance(carol, carolXRP - baseFee * 2)); + + // set fee to 0.05% + ammAlice.vote(alice, 50); + BEAST_EXPECT(ammAlice.expectTradingFee(50)); + env(offer(carol, BTC(10), XRP(10))); + env.close(); + env.require(balance(carol, BTC(30'009))); + env.require(balance(carol, carolXRP - baseFee * 3 - XRPAmount(8'995'507))); + BEAST_EXPECT(expectOffers(env, carol, 1, {{Amounts{BTC(1), XRP(1)}}})); + }, + {{XRP(1000), AMMMPT(1010)}}, + 0, + std::nullopt, + {features}); + + // Offer crossing, 0.5% fee MPT/IOU + testAMM( + [&](AMM& ammAlice, Env& env) { + auto const BTC = MPT(ammAlice[1]); + env(offer(carol, BTC(10'000'000), USD(10))); + env.close(); + env.require(balance(carol, BTC(1'020'001'000))); + env.require(balance(carol, USD(29'990))); + + // Change pool composition back + env(offer(carol, USD(10), BTC(10'000'000))); + env.close(); + env.require(balance(carol, BTC(1'010'001'000))); + env.require(balance(carol, USD(30'000))); + + // set fee to 0.5% + ammAlice.vote(alice, 500); + BEAST_EXPECT(ammAlice.expectTradingFee(500)); + env(offer(carol, BTC(10'000'000), USD(10))); + env.close(); + env.require(balance(carol, BTC(1'014'975'874))); + env.require(balance(carol, STAmount{USD, UINT64_C(29'995'02512600184), -11})); + BEAST_EXPECT(expectOffers( + env, + carol, + 1, + {{Amounts{BTC(5'025126), STAmount{USD, UINT64_C(5'025126), -6}}}})); + }, + {{USD(1000), AMMMPT(1010000000)}}, + 0, + std::nullopt, + {features}); + + // Payment with AMM and CLOB offer, 0 fee + // AMM liquidity is consumed first up to CLOB offer quality + // CLOB offer is fully consumed next + // Remaining amount is consumed via AMM liquidity + { + Env env{*this, features}; + Account const ed("ed"); + fund(env, gw, {alice, bob, carol, ed}, XRP(30'000), {USD(2'000)}); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .pay = 30'000'000000, + .flags = MPTDEXFlags}); + + env(offer(carol, BTC(5'000000), USD(5))); + AMM const ammAlice(env, alice, USD(1'005), BTC(1'000'000000)); + env(pay(bob, ed, USD(10)), + path(~USD), + sendmax(BTC(15'000000)), + txflags(tfNoRippleDirect)); + + env.require(balance(ed, USD(2'010))); + env.require(balance(bob, BTC(29'989'999999))); + BEAST_EXPECT(ammAlice.expectBalances( + BTC(1'005'000001), + STAmount{USD, UINT64_C(999'9999999999999), -13}, + ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + // Payment with AMM and CLOB offer. Same as above but with 0.25% + // fee. + { + Env env{*this, features}; + Account const ed("ed"); + fund(env, gw, {alice, bob, carol, ed}, XRP(30'000), {USD(2'000)}); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .pay = 30'000'000000, + .flags = MPTDEXFlags}); + + env(offer(carol, BTC(5'000000), USD(5))); + // Set 0.25% fee + AMM const ammAlice(env, alice, USD(1'005), BTC(1'000'000000), false, 250); + env(pay(bob, ed, USD(10)), + path(~USD), + sendmax(BTC(15'000000)), + txflags(tfNoRippleDirect)); + env.require(balance(ed, USD(2'010))); + env.require(balance(bob, BTC(29'989'987453))); + BEAST_EXPECT(ammAlice.expectBalances(BTC(1'005'012547), USD(1'000), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + // Payment with AMM and CLOB offer. AMM has a better + // spot price quality, but 1% fee offsets that. As the result + // the entire trade is executed via LOB. + { + Env env{*this, features}; + Account const ed("ed"); + fund(env, gw, {alice, bob, carol, ed}, XRP(30'000), {USD(2'000)}); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .pay = 30'000'000000, + .flags = MPTDEXFlags}); + + env(offer(carol, BTC(10'000000), USD(10))); + // Set 1% fee + AMM const ammAlice(env, alice, USD(1'005), BTC(1'000'000000), false, 1'000); + env(pay(bob, ed, USD(10)), + path(~USD), + sendmax(BTC(15'000000)), + txflags(tfNoRippleDirect)); + env.require(balance(ed, USD(2'010))); + env.require(balance(bob, BTC(29'990'000000))); + BEAST_EXPECT(ammAlice.expectBalances(BTC(1'000'000000), USD(1'005), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + + // Payment with AMM and CLOB offer. AMM has a better + // spot price quality, but 1% fee offsets that. + // The CLOB offer is consumed first and the remaining + // amount is consumed via AMM liquidity. + { + Env env{*this, features}; + Account const ed("ed"); + fund(env, gw, {alice, bob, carol, ed}, XRP(30'000), {USD(2'000)}); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .pay = 30'000'000000, + .flags = MPTDEXFlags}); + + env(offer(carol, BTC(9'000000), USD(9))); + // Set 1% fee + AMM const ammAlice(env, alice, USD(1'005), BTC(1'000'000000), false, 1'000); + env(pay(bob, ed, USD(10)), + path(~USD), + sendmax(BTC(15'000000)), + txflags(tfNoRippleDirect)); + env.require(balance(ed, USD(2'010))); + env.require(balance(bob, BTC(29'989'993923))); + BEAST_EXPECT(ammAlice.expectBalances(BTC(1'001'006077), USD(1'004), ammAlice.tokens())); + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + } + + void + testAdjustedTokens(FeatureBitset features) + { + testcase("Adjusted Deposit/Withdraw Tokens"); + using namespace jtx; + + // Deposit/Withdraw USD from USD/MPT pool + { + Env env(*this); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob("bob"); + Account const carol("carol"); + Account const ed("ed"); + Account const paul("paul"); + Account const dan("dan"); + Account const chris("chris"); + Account const simon("simon"); + Account const ben("ben"); + Account const natalie("natalie"); + std::vector const holders{ + alice, bob, carol, ed, paul, dan, chris, simon, ben, natalie}; + env.fund(XRP(100000), gw, alice, bob, carol, ed, paul, dan, chris, simon, ben, natalie); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = holders, + .pay = 40'000'000000, + .flags = MPTDEXFlags}); + + auto const USD = gw["USD"]; + for (auto const& holder : holders) + { + env.trust(USD(1'500'000), holder); + env(pay(gw, holder, USD(1'500'000))); + } + env.close(); + + auto aliceUSD = env.balance(alice, USD); + auto bobUSD = env.balance(bob, USD); + auto carolUSD = env.balance(carol, USD); + auto edUSD = env.balance(ed, USD); + auto paulUSD = env.balance(paul, USD); + auto danUSD = env.balance(dan, USD); + auto chrisUSD = env.balance(chris, USD); + auto simonUSD = env.balance(simon, USD); + auto benUSD = env.balance(ben, USD); + auto natalieUSD = env.balance(natalie, USD); + + AMM ammAlice(env, alice, BTC(10'000'000000), USD(10000)); + BEAST_EXPECT( + ammAlice.expectBalances(BTC(10'000'000000), USD(10'000), IOUAmount{10'000'000})); + + for (int i = 0; i < 10; ++i) + { + ammAlice.deposit(ben, STAmount{USD, 1, -10}); + ammAlice.withdrawAll(ben, USD(0)); + ammAlice.deposit(simon, USD(0.1)); + ammAlice.withdrawAll(simon, USD(0)); + ammAlice.deposit(chris, USD(1)); + ammAlice.withdrawAll(chris, USD(0)); + ammAlice.deposit(dan, USD(10)); + ammAlice.withdrawAll(dan, USD(0)); + ammAlice.deposit(bob, USD(100)); + ammAlice.withdrawAll(bob, USD(0)); + ammAlice.deposit(carol, USD(1'000)); + ammAlice.withdrawAll(carol, USD(0)); + ammAlice.deposit(ed, USD(10'000)); + ammAlice.withdrawAll(ed, USD(0)); + ammAlice.deposit(paul, USD(100'000)); + ammAlice.withdrawAll(paul, USD(0)); + ammAlice.deposit(natalie, USD(1'000'000)); + ammAlice.withdrawAll(natalie, USD(0)); + } + + BEAST_EXPECT(ammAlice.expectBalances( + BTC(10'000'000000), + STAmount{USD, UINT64_C(10000'0000000001), -10}, + IOUAmount{10'000'000})); + + env.require(balance(bob, bobUSD)); + env.require(balance(carol, carolUSD)); + env.require(balance(ed, edUSD)); + env.require(balance(paul, paulUSD)); + env.require(balance(dan, danUSD)); + env.require(balance(chris, chrisUSD)); + env.require(balance(simon, simonUSD)); + env.require(balance(ben, benUSD)); + env.require(balance(natalie, natalieUSD)); + + ammAlice.withdrawAll(alice); + BEAST_EXPECT(!ammAlice.ammExists()); + env.require(balance(alice, aliceUSD)); + } + + // Same as above but deposit/withdraw MPT from USD/MPT pool + { + Env env(*this); + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob("bob"); + Account const carol("carol"); + Account const ed("ed"); + Account const paul("paul"); + Account const dan("dan"); + Account const chris("chris"); + Account const simon("simon"); + Account const ben("ben"); + Account const natalie("natalie"); + std::vector const holders{ + alice, bob, carol, ed, paul, dan, chris, simon, ben, natalie}; + env.fund(XRP(100000), gw, alice, bob, carol, ed, paul, dan, chris, simon, ben, natalie); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = holders, + .pay = 40'000'000000, + .flags = MPTDEXFlags}); + + auto const USD = gw["USD"]; + for (auto const& holder : holders) + { + env.trust(USD(1'500'000), holder); + env(pay(gw, holder, USD(1'500'000))); + } + env.close(); + + auto aliceBTC = env.balance(alice, BTC); + auto bobBTC = env.balance(bob, BTC); + auto carolBTC = env.balance(carol, BTC); + auto edBTC = env.balance(ed, BTC); + auto paulBTC = env.balance(paul, BTC); + auto danBTC = env.balance(dan, BTC); + auto chrisBTC = env.balance(chris, BTC); + auto simonBTC = env.balance(simon, BTC); + auto benBTC = env.balance(ben, BTC); + auto natalieBTC = env.balance(natalie, BTC); + + AMM ammAlice(env, alice, BTC(10'000'000000), USD(10000)); + BEAST_EXPECT( + ammAlice.expectBalances(BTC(10'000'000000), USD(10'000), IOUAmount{10'000'000})); + + for (int i = 0; i < 10; ++i) + { + ammAlice.deposit(ben, BTC(1)); + ammAlice.withdrawAll(ben, BTC(0)); + ammAlice.deposit(simon, BTC(1'000)); + ammAlice.withdrawAll(simon, BTC(0)); + ammAlice.deposit(chris, BTC(1)); + ammAlice.withdrawAll(chris, BTC(0)); + ammAlice.deposit(dan, BTC(10)); + ammAlice.withdrawAll(dan, BTC(0)); + ammAlice.deposit(bob, BTC(100)); + ammAlice.withdrawAll(bob, BTC(0)); + ammAlice.deposit(carol, BTC(1'000)); + ammAlice.withdrawAll(carol, BTC(0)); + ammAlice.deposit(ed, BTC(10'000)); + ammAlice.withdrawAll(ed, BTC(0)); + ammAlice.deposit(paul, BTC(100'000)); + ammAlice.withdrawAll(paul, BTC(0)); + ammAlice.deposit(natalie, BTC(1'000'000)); + ammAlice.withdrawAll(natalie, BTC(0)); + } + + BEAST_EXPECT( + ammAlice.expectBalances(BTC(10'000'000090), USD(10'000), IOUAmount{10'000'000})); + + env.require(balance(bob, bobBTC - BTC(10))); + env.require(balance(carol, carolBTC - BTC(10))); + env.require(balance(ed, edBTC - BTC(10))); + env.require(balance(paul, paulBTC - BTC(10))); + env.require(balance(dan, danBTC - BTC(10))); + env.require(balance(chris, chrisBTC - BTC(10))); + env.require(balance(simon, simonBTC - BTC(10))); + env.require(balance(ben, benBTC - BTC(10))); + env.require(balance(natalie, natalieBTC - BTC(10))); + + ammAlice.withdrawAll(alice); + BEAST_EXPECT(!ammAlice.ammExists()); + env.require(balance(alice, aliceBTC + BTC(90))); + } + } + + void + testAMMID() + { + testcase("AMMID"); + using namespace jtx; + + // MPT/XRP + testAMM( + [&](AMM& amm, Env& env) { + amm.setClose(false); + auto const info = env.rpc( + "json", + "account_info", + std::string("{\"account\": \"" + to_string(amm.ammAccount()) + "\"}")); + try + { + BEAST_EXPECT( + info[jss::result][jss::account_data][jss::AMMID].asString() == + to_string(amm.ammID())); + } + catch (...) + { + fail(); + } + + amm.deposit(carol, 1'000); + + auto affected = env.meta()->getJson(JsonOptions::none)[sfAffectedNodes.fieldName]; + try + { + bool found = false; + for (auto const& node : affected) + { + if (node.isMember(sfModifiedNode.fieldName) && + node[sfModifiedNode.fieldName][sfLedgerEntryType.fieldName] + .asString() == "AccountRoot" && + node[sfModifiedNode.fieldName][sfFinalFields.fieldName][jss::Account] + .asString() == to_string(amm.ammAccount())) + { + found = + node[sfModifiedNode.fieldName][sfFinalFields.fieldName][jss::AMMID] + .asString() == to_string(amm.ammID()); + break; + } + } + BEAST_EXPECT(found); + } + catch (...) + { + fail(); + } + }, + {{XRP(1000), AMMMPT(1000'000)}}); + } + + void + testSelection(FeatureBitset features) + { + testcase("Offer/Strand Selection"); + using namespace jtx; + Account const ed("ed"); + Account const gw1("gw1"); + + // These tests are expected to fail if the OwnerPaysFee feature + // is ever supported. Updates will need to be made to AMM handling + // in the payment engine, and these tests will need to be updated. + + struct MPTList + { + MPTTester const USD; + MPTTester const ETH; + MPTTester const CAN; + }; + + auto prep = [&](Env& env, uint16_t gwTransferFee, uint16_t gw1TransferFee) -> MPTList { + env.fund(XRP(2'000), gw, gw1, alice, bob, carol, ed); + MPTTester USD( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, ed}, + .transferFee = gwTransferFee, + .pay = 2'000'000'000, + .flags = MPTDEXFlags}); + MPTTester ETH( + {.env = env, + .issuer = gw1, + .holders = {alice, bob, carol, ed}, + .transferFee = gw1TransferFee, + .pay = 2'000'000'000, + .flags = MPTDEXFlags}); + MPTTester CAN( + {.env = env, + .issuer = gw1, + .holders = {alice, bob, carol, ed}, + .transferFee = gw1TransferFee, + .pay = 2'000'000'000, + .flags = MPTDEXFlags}); + env.close(); + + return MPTList{ + .USD = std::move(USD), + .ETH = std::move(ETH), + .CAN = std::move(CAN), + }; + }; + + std::uint32_t constexpr lowRate = 10'000; + std::uint32_t constexpr highRate = 50'000; + for (auto const& rates : + {std::make_pair(lowRate, highRate), std::make_pair(highRate, lowRate)}) + { + // Offer Selection + + // Cross-currency payment: AMM has the same spot price quality + // as CLOB's offer and can't generate a better quality offer. + // The transfer fee in this case doesn't change the CLOB quality + // because trIn is ignored on adjustment and trOut on payment is + // also ignored because ownerPaysTransferFee is false in this + // case. Run test for 0) offer, 1) AMM, 2) offer and AMM to + // verify that the quality is better in the first case, and CLOB + // is selected in the second case. + { + std::array q{}; + for (auto i = 0; i < 3; ++i) + { + Env env(*this, features); + auto mpts = prep(env, rates.first, rates.second); + auto USD = mpts.USD; + auto ETH = mpts.ETH; + auto CAN = mpts.CAN; + std::optional amm; + + if (i == 0 || i == 2) + { + env(offer(ed, ETH(400'000'000), USD(400'000'000)), txflags(tfPassive)); + env.close(); + } + if (i > 0) + amm.emplace(env, ed, USD(1'000'000'000), ETH(1'000'000'000)); + env(pay(carol, bob, USD(100'000'000)), + path(~MPT(USD)), + sendmax(ETH(500'000'000))); + env.close(); + // CLOB and AMM, AMM is not selected + if (i == 2) + { + BEAST_EXPECT(amm->expectBalances( + USD(1'000'000'000), ETH(1'000'000'000), amm->tokens())); + } + env.require(balance(bob, USD(2'100'000'000))); + q[i] = Quality( + Amounts{ + ETH(2'000'000'000) - env.balance(carol, MPT(ETH)), + env.balance(bob, MPT(USD)) - USD(2'000'000'000)}); + } + // CLOB is better quality than AMM + BEAST_EXPECT(q[0] > q[1]); + // AMM is not selected with CLOB + BEAST_EXPECT(q[0] == q[2]); + } + // Offer crossing: AMM has the same spot price quality + // as CLOB's offer and can't generate a better quality offer. + // The transfer fee in this case doesn't change the CLOB quality + // because the quality adjustment is ignored for the offer + // crossing. + for (auto i = 0; i < 3; ++i) + { + Env env(*this, features); + auto mpts = prep(env, rates.first, rates.second); + auto USD = mpts.USD; + auto ETH = mpts.ETH; + auto CAN = mpts.CAN; + std::optional amm; + if (i == 0 || i == 2) + { + env(offer(ed, ETH(400'000'000), USD(400'000'000)), txflags(tfPassive)); + env.close(); + } + if (i > 0) + amm.emplace(env, ed, USD(1'000'000'000), ETH(1'000'000'000)); + env(offer(alice, USD(400'000'000), ETH(400'000'000))); + env.close(); + // AMM is not selected + if (i > 0) + { + BEAST_EXPECT( + amm->expectBalances(USD(1'000'000'000), ETH(1'000'000'000), amm->tokens())); + } + if (i == 0 || i == 2) + { + // Fully crosses + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + // Fails to cross because AMM is not selected + else + { + BEAST_EXPECT( + expectOffers(env, alice, 1, {Amounts{USD(400'000'000), ETH(400'000'000)}})); + } + BEAST_EXPECT(expectOffers(env, ed, 0)); + } + + // Show that the CLOB quality reduction + // results in AMM offer selection. + + // Same as the payment but reduced offer quality + { + std::array q{}; + for (auto i = 0; i < 3; ++i) + { + Env env(*this, features); + auto mpts = prep(env, rates.first, rates.second); + auto USD = mpts.USD; + auto ETH = mpts.ETH; + auto CAN = mpts.CAN; + std::optional amm; + if (i == 0 || i == 2) + { + env(offer(ed, ETH(400'000'000), USD(330'000'000)), txflags(tfPassive)); + env.close(); + } + if (i > 0) + amm.emplace(env, ed, USD(1'000'000'000), ETH(1'000'000'000)); + env(pay(carol, bob, USD(100'000'000)), + path(~MPT(USD)), + sendmax(ETH(500'000'000))); + env.close(); + // AMM and CLOB are selected + if (i > 0) + { + BEAST_EXPECT(!amm->expectBalances( + USD(1'000'000'000), ETH(1'000'000'000), amm->tokens())); + } + + if (i == 2) + { + if (rates.first == lowRate) + { + BEAST_EXPECT(expectOffers( + env, + ed, + 1, + {{Amounts{ + ETH(377'824'111), + USD(311'704'892), + }}})); + } + else + { + BEAST_EXPECT(expectOffers( + env, + ed, + 1, + {{Amounts{ + ETH(329'339'263), + USD(271'704'892), + }}})); + } + } + env.require(balance(bob, USD(2'100'000'000))); + q[i] = Quality( + Amounts{ + ETH(2'000'000'000) - env.balance(carol, MPT(ETH)), + env.balance(bob, MPT(USD)) - USD(2'000'000'000)}); + } + // AMM is better quality + BEAST_EXPECT(q[1] > q[0]); + // AMM and CLOB produce better quality + BEAST_EXPECT(q[2] > q[1]); + } + + // Same as the offer-crossing but reduced offer quality + for (auto i = 0; i < 3; ++i) + { + Env env(*this, features); + auto mpts = prep(env, rates.first, rates.second); + auto USD = mpts.USD; + auto ETH = mpts.ETH; + auto CAN = mpts.CAN; + std::optional amm; + if (i == 0 || i == 2) + { + env(offer(ed, ETH(400'000'000), USD(325'000'002)), txflags(tfPassive)); + env.close(); + } + if (i > 0) + amm.emplace(env, ed, USD(1'000'000'000), ETH(1'000'000'000)); + env(offer(alice, USD(325'000'000), ETH(400'000'000))); + env.close(); + // AMM is selected in both cases + if (i > 0) + { + BEAST_EXPECT(!amm->expectBalances( + USD(1'000'000'000), ETH(1'000'000'000), amm->tokens())); + } + // Partially crosses, AMM is selected, CLOB fails + // limitQuality + if (i == 2) + { + if (rates.first == lowRate) + { + // Ed offer is partially crossed. + // The updated rounding makes limitQuality + // work if both amendments are enabled + BEAST_EXPECT(expectOffers( + env, + ed, + 1, + {{Amounts{ + ETH(121'368'836), + USD(98'612'180), + }}})); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + else + { + // Ed offer is partially crossed. + BEAST_EXPECT(expectOffers( + env, + ed, + 1, + {{Amounts{ + ETH(121'368'836), + USD(98'612'180), + }}})); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + } + } + + // Strand selection + + // Two book steps strand quality is 1. + // AMM strand's best quality is equal to AMM's spot price + // quality, which is 1. Both strands (steps) are adjusted + // for the transfer fee in qualityUpperBound. In case + // of two strands, AMM offers have better quality and are + // consumed first, remaining liquidity is generated by CLOB + // offers. Liquidity from two strands is better in this case + // than in case of one strand with two book steps. Liquidity + // from one strand with AMM has better quality than either one + // strand with two book steps or two strands. It may appear + // unintuitive, but one strand with AMM is optimized and + // generates one AMM offer, while in case of two strands, + // multiple AMM offers are generated, which results in slightly + // worse overall quality. + { + std::array q{}; + for (auto i = 0; i < 3; ++i) + { + Env env(*this, features); + auto mpts = prep(env, rates.first, rates.second); + auto USD = mpts.USD; + auto ETH = mpts.ETH; + auto CAN = mpts.CAN; + std::optional amm; + + if (i == 0 || i == 2) + { + env(offer(ed, ETH(400'000'000), CAN(375'000'000)), txflags(tfPassive)); + env(offer(ed, CAN(375'000'000), USD(338'000'000))), txflags(tfPassive); + } + + if (i > 0) + amm.emplace(env, ed, ETH(1'000'000'000), USD(1'000'000'000)); + + env(pay(carol, bob, USD(100'000'000)), + path(~MPT(USD)), + path(~MPT(CAN), ~MPT(USD)), + sendmax(ETH(600'000'000))); + env.close(); + + env.require(balance(bob, USD(2'100'000'000))); + + if (i == 2) + { + if (rates.first == lowRate) + { + // Liquidity is consumed from AMM strand only + BEAST_EXPECT(amm->expectBalances( + ETH(1'124'584'936), USD(889'999'993), amm->tokens())); + } + else + { + BEAST_EXPECT(amm->expectBalances( + ETH(1'103'723'909), USD(906'023'688), amm->tokens())); + BEAST_EXPECT(expectOffers( + env, + ed, + 2, + {{Amounts{ + ETH(327'069'745), + CAN(306'627'886), + }, + Amounts{ + CAN(312'843'533), + USD(281'976'305), + }}})); + } + } + q[i] = Quality( + Amounts{ + ETH(2'000'000'000) - env.balance(carol, MPT(ETH)), + env.balance(bob, MPT(USD)) - USD(2'000'000'000)}); + } + BEAST_EXPECT(q[1] > q[0]); + BEAST_EXPECT(q[2] > q[0] && q[2] < q[1]); + } + } + } + + void + testMalformed() + { + testcase("Malformed"); + using namespace jtx; + + testAMM( + [&](AMM& ammAlice, Env& env) { + WithdrawArg const args{ + .flags = tfSingleAsset, + .err = ter(temMALFORMED), + }; + ammAlice.withdraw(args); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + WithdrawArg const args{ + .flags = tfOneAssetLPToken, + .err = ter(temMALFORMED), + }; + ammAlice.withdraw(args); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + WithdrawArg const args{ + .flags = tfLimitLPToken, + .err = ter(temMALFORMED), + }; + ammAlice.withdraw(args); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + WithdrawArg const args{ + .asset1Out = MPT(ammAlice[1])(100), + .asset2Out = MPT(ammAlice[1])(100), + .err = ter(temBAD_AMM_TOKENS), + }; + ammAlice.withdraw(args); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 2'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + WithdrawArg const args{ + .asset1Out = XRP(100), + .asset2Out = BTC(100), + .err = ter(temBAD_AMM_TOKENS), + }; + ammAlice.withdraw(args); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + + testAMM( + [&](AMM& ammAlice, Env& env) { + Json::Value jv; + jv[jss::TransactionType] = jss::AMMWithdraw; + jv[jss::Flags] = tfLimitLPToken; + jv[jss::Account] = alice.human(); + ammAlice.setTokens(jv); + XRP(100).value().setJson(jv[jss::Amount]); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 2'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + BTC(100).value().setJson(jv[jss::EPrice]); + env(jv, ter(telENV_RPC_FAILED)); + }, + {{XRP(10'000), AMMMPT(10'000)}}); + } + + void + testFixAMMOfferBlockedByLOB(FeatureBitset features) + { + testcase("AMM Offer Blocked By LOB"); + using namespace jtx; + + // Low quality LOB offer blocks AMM liquidity + + // USD/MPT crosses AMM despite of low quality LOB + { + Env env(*this, features); + + fund(env, gw, {alice, carol}, XRP(1'000'000), {USD(1'000'000)}); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 40'000'000000, + .flags = MPTDEXFlags}); + + env(offer(alice, BTC(1), USD(0.01))); + env.close(); + AMM const amm(env, gw, BTC(200'000), USD(100'000)); + env(offer(carol, USD(0.49), BTC(1))); + env.close(); + + if (!features[fixAMMv1_1] && !features[fixAMMv1_3]) + { + BEAST_EXPECT(amm.expectBalances(BTC(200'000), USD(100'000), amm.tokens())); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{BTC(1), USD(0.01)}}})); + BEAST_EXPECT(expectOffers(env, carol, 1, {{Amounts{USD(0.49), BTC(1)}}})); + } + + if (features[fixAMMv1_1] && features[fixAMMv1_3]) + { + BEAST_EXPECT(amm.expectBalances(BTC(200'001), USD(99'999.51), amm.tokens())); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{BTC(1), USD(0.01)}}})); + // Carol's offer crosses AMM + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + } + + // XRP/MPT crosses AMM despite of low quality LOB + { + Env env(*this, features); + + fund(env, gw, {alice, carol}, XRP(1'000'000), {USD(1'000'000)}); + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 40'000'000000, + .flags = MPTDEXFlags}); + + env(offer(alice, BTC(1), XRP(0.01))); + env.close(); + AMM const amm(env, gw, BTC(200'000), XRP(100'000)); + env(offer(carol, XRP(0.49), BTC(1))); + env.close(); + + if (!features[fixAMMv1_1] && !features[fixAMMv1_3]) + { + BEAST_EXPECT(amm.expectBalances(BTC(200'000), XRP(100'000), amm.tokens())); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{BTC(1), XRP(0.01)}}})); + BEAST_EXPECT(expectOffers(env, carol, 1, {{Amounts{XRP(0.49), BTC(1)}}})); + } + + if (features[fixAMMv1_1] && features[fixAMMv1_3]) + { + BEAST_EXPECT(amm.expectBalances(BTC(200'001), XRP(99'999.51), amm.tokens())); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{BTC(1), XRP(0.01)}}})); + // Carol's offer crosses AMM + BEAST_EXPECT(expectOffers(env, carol, 0)); + } + } + } + + void + testLPTokenBalance(FeatureBitset features) + { + testcase("LPToken Balance"); + using namespace jtx; + + Env env(*this, features); + Account const gw{"gateway"}, alice{"alice"}, bob{"bob"}; + env.fund(XRP(100000), gw, alice, bob); + env.close(); + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto const USD = gw["USD"]; + env.trust(USD(100000), alice); + env(pay(gw, alice, USD(50000))); + env.trust(USD(100000), bob); + env(pay(gw, bob, USD(40000))); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .pay = 40'000'000000, + .flags = tfMPTCanClawback | tfMPTCanLock | MPTDEXFlags}); + + AMM amm(env, alice, BTC(2), USD(1)); + amm.deposit(alice, IOUAmount{1'876123487565916, -15}); + amm.deposit(bob, IOUAmount{1'000}); + amm.withdraw(alice, IOUAmount{1'876123487565916, -15}); + amm.withdrawAll(bob); + + auto const lpToken = + getAccountLines(env, alice, amm.lptIssue())[jss::lines][0u][jss::balance].asString(); + auto const lpTokenBalance = + amm.ammRpcInfo()[jss::amm][jss::lp_token][jss::value].asString(); + + BEAST_EXPECT(lpToken == "1.414213562374011" && lpTokenBalance == "1.4142135623741"); + + auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice); + BEAST_EXPECT(res && res.value()); + + amm.withdrawAll(alice); + BEAST_EXPECT(!amm.ammExists()); + } + + void + testAMMDepositWithFrozenAssets() + { + testcase("test AMMDeposit with frozen assets"); + using namespace jtx; + + // This lambda function is used to create trustline, MPT. + // and create an AMM account. + // And also test the callback function. + auto testAMMDeposit = [&](Env& env, std::function cb) { + env.fund(XRP(1'000), gw, alice); + env.close(); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 30'000, + .flags = tfMPTCanLock | MPTDEXFlags}); + + AMM amm(env, alice, BTC(100), XRP(100)); + env.close(); + BTC.set({.holder = alice, .flags = tfMPTLock}); + cb(amm, BTC); + }; + + // Deposit two assets, one of which is frozen, + // then we should get tecFROZEN error. + { + Env env(*this); + testAMMDeposit(env, [&](AMM& amm, MPTTester& BTC) { + amm.deposit(alice, BTC(100), XRP(100), std::nullopt, tfTwoAsset, ter(tecFROZEN)); + }); + } + + // Deposit one asset, which is the frozen token, + // then we should get tecFROZEN error. + { + Env env(*this); + testAMMDeposit(env, [&](AMM& amm, MPTTester& BTC) { + amm.deposit( + alice, BTC(100), std::nullopt, std::nullopt, tfSingleAsset, ter(tecFROZEN)); + }); + } + + // Deposit one asset which is not the frozen token, + // but the other asset is frozen. We should get tecFROZEN error + // when feature AMMClawback is enabled. + { + Env env(*this); + testAMMDeposit(env, [&](AMM& amm, MPTTester& BTC) { + amm.deposit( + alice, XRP(100), std::nullopt, std::nullopt, tfSingleAsset, ter(tecFROZEN)); + }); + } + } + + void + testAutoDelete() + { + testcase("Auto Delete"); + + using namespace jtx; + FeatureBitset const all{testable_amendments()}; + + { + Env env( + *this, + envconfig([](std::unique_ptr cfg) { + cfg->FEES.reference_fee = XRPAmount(1); + return cfg; + }), + all); + env.fund(XRP(1'000), gw, alice); + MPTTester const USD({.env = env, .issuer = gw, .holders = {alice}, .pay = 20'000}); + MPTTester const BTC({.env = env, .issuer = gw, .holders = {alice}, .pay = 20'000}); + AMM amm(env, gw, USD(10'000), BTC(10'000)); + for (auto i = 0; i < maxDeletableAMMTrustLines + 10; ++i) + { + Account const a{std::to_string(i)}; + env.fund(XRP(1'000), a); + env(trust(a, STAmount{amm.lptIssue(), 10'000})); + env.close(); + } + // The trustlines are partially deleted, + // AMM is set to an empty state. + amm.withdrawAll(gw); + BEAST_EXPECT(amm.ammExists()); + + // Bid,Vote,Deposit,Withdraw,SetTrust failing with + // tecAMM_EMPTY. Deposit succeeds with tfTwoAssetIfEmpty option. + env(amm.bid({ + .account = alice, + .bidMin = 1000, + }), + ter(tecAMM_EMPTY)); + amm.vote({.account = alice, .tfee = 100, .err = ter(tecAMM_EMPTY)}); + amm.withdraw({.account = alice, .tokens = 100, .err = ter(tecAMM_EMPTY)}); + amm.deposit({.account = alice, .asset1In = USD(100), .err = ter(tecAMM_EMPTY)}); + env(trust(alice, STAmount{amm.lptIssue(), 10'000}), ter(tecAMM_EMPTY)); + + // Can deposit with tfTwoAssetIfEmpty option + amm.deposit( + {.account = alice, + .asset1In = USD(1'000), + .asset2In = BTC(1'000), + .flags = tfTwoAssetIfEmpty, + .tfee = 1'000}); + BEAST_EXPECT(amm.expectBalances(USD(1'000), BTC(1'000), IOUAmount{1'000})); + BEAST_EXPECT(amm.expectTradingFee(1'000)); + BEAST_EXPECT(amm.expectAuctionSlot(100, 0, IOUAmount{0})); + + // Withdrawing all tokens deletes AMM since the number + // of remaining trustlines is less than max + amm.withdrawAll(alice); + BEAST_EXPECT(!amm.ammExists()); + BEAST_EXPECT(!env.le(keylet::ownerDir(amm.ammAccount()))); + } + + { + Env env( + *this, + envconfig([](std::unique_ptr cfg) { + cfg->FEES.reference_fee = XRPAmount(1); + return cfg; + }), + all); + env.fund(XRP(1'000), gw, alice); + MPTTester const USD({.env = env, .issuer = gw, .holders = {alice}, .pay = 20'000}); + MPTTester const BTC({.env = env, .issuer = gw, .holders = {alice}, .pay = 20'000}); + AMM amm(env, gw, USD(10'000), BTC(10'000)); + for (auto i = 0; i < (maxDeletableAMMTrustLines * 2) + 10; ++i) + { + Account const a{std::to_string(i)}; + env.fund(XRP(1'000), a); + env(trust(a, STAmount{amm.lptIssue(), 10'000})); + env.close(); + } + // The trustlines are partially deleted. + amm.withdrawAll(gw); + BEAST_EXPECT(amm.ammExists()); + + // AMMDelete has to be called twice to delete AMM. + amm.ammDelete(alice, ter(tecINCOMPLETE)); + BEAST_EXPECT(amm.ammExists()); + // Deletes remaining trustlines and deletes AMM. + amm.ammDelete(alice); + BEAST_EXPECT(!amm.ammExists()); + BEAST_EXPECT(!env.le(keylet::ownerDir(amm.ammAccount()))); + + // Try redundant delete + amm.ammDelete(alice, ter(terNO_AMM)); + } + + { + Env env( + *this, + envconfig([](std::unique_ptr cfg) { + cfg->FEES.reference_fee = XRPAmount(1); + return cfg; + }), + all); + env.fund(XRP(1'000), gw, alice, carol); + MPTTester const USD( + {.env = env, .issuer = gw, .holders = {alice, carol}, .pay = 20'000}); + MPTTester const BTC( + {.env = env, .issuer = gw, .holders = {alice, carol}, .pay = 20'000}); + AMM amm(env, gw, USD(10'000), BTC(10'000)); + amm.deposit({.account = alice, .tokens = 1'000}); + amm.deposit({.account = carol, .tokens = 1'000}); + amm.withdrawAll(alice); + amm.withdrawAll(carol); + amm.withdrawAll(gw); + BEAST_EXPECT(!amm.ammExists()); + } + + // This test validates both invariant changes work together for + // the specific case of MPT/MPT pools with > maxDeletableAMMTrustLines. + { + Env env( + *this, + envconfig([](std::unique_ptr cfg) { + cfg->FEES.reference_fee = XRPAmount(1); + return cfg; + }), + all); + + env.fund(XRP(1'000), gw, alice); + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 20'000}); + MPT const BTC = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 20'000}); + + // MPT/MPT pool with MANY trustlines + AMM amm(env, gw, USD(10'000), BTC(10'000)); + for (auto i = 0; i < (maxDeletableAMMTrustLines * 2) + 10; ++i) + { + Account const a{std::to_string(i)}; + env.fund(XRP(1'000), a); + env(trust(a, STAmount{amm.lptIssue(), 10'000})); + env.close(); + } + + amm.withdrawAll(gw); + // AMM is in empty state, but can't be auto-deleted because of the LPTokens trustlines. + BEAST_EXPECT(amm.expectBalances(USD(0), BTC(0), IOUAmount(0))); + BEAST_EXPECT(amm.ammExists()); + + // Critical: MPT/MPT pool + tecINCOMPLETE + amm.ammDelete(alice, ter(tecINCOMPLETE)); + BEAST_EXPECT(amm.ammExists()); + + amm.ammDelete(alice); + BEAST_EXPECT(!amm.ammExists()); + } + } + + void + run() override + { + FeatureBitset const all{jtx::testable_amendments()}; + testInstanceCreate(); + testInvalidInstance(); + testInvalidDeposit(all); + testInvalidDeposit(all - featureAMMClawback); + testDeposit(); + testInvalidWithdraw(); + testWithdraw(); + testInvalidFeeVote(); + testFeeVote(); + testInvalidBid(); + testBid(all); + testClawback(); + testClawbackFromAMMAccount(all); + testClawbackFromAMMAccount(all - featureSingleAssetVault); + testInvalidAMMPayment(); + testBasicPaymentEngine(); + testAMMTokens(); + testAmendment(); + testAMMAndCLOB(all); + testTradingFee(all); + testTradingFee(all - fixAMMv1_3); + testAdjustedTokens(all); + testAMMID(); + testSelection(all); + testMalformed(); + testFixAMMOfferBlockedByLOB(all - fixAMMv1_1 - fixAMMv1_3); + testFixAMMOfferBlockedByLOB(all); + testLPTokenBalance(all); + testLPTokenBalance(all - fixAMMv1_3); + testAMMDepositWithFrozenAssets(); + testAutoDelete(); + } +}; + +BEAST_DEFINE_TESTSUITE_PRIO(AMMMPT, app, xrpl, 1); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/AMM_test.cpp b/src/test/app/AMM_test.cpp index 704ced2b86..2379a8ca24 100644 --- a/src/test/app/AMM_test.cpp +++ b/src/test/app/AMM_test.cpp @@ -1,23 +1,66 @@ -#include #include #include #include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include @@ -87,7 +130,7 @@ private: env(rate(gw, 1.25)); env.close(); // no transfer fee on create - AMM ammAlice(env, alice, USD(20'000), BTC(0.5)); + AMM const ammAlice(env, alice, USD(20'000), BTC(0.5)); BEAST_EXPECT(ammAlice.expectBalances(USD(20'000), BTC(0.5), IOUAmount{100, 0})); BEAST_EXPECT(expectHolding(env, alice, USD(0))); BEAST_EXPECT(expectHolding(env, alice, BTC(0))); @@ -104,7 +147,7 @@ private: env.close(); env(pay(gw, alice, USD(10'000))); env.close(); - AMM ammAlice(env, alice, XRP(10'000), USD(10'000)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'000)); } // Cleared global freeze @@ -118,10 +161,10 @@ private: env.close(); env(fset(gw, asfGlobalFreeze)); env.close(); - AMM ammAliceFail(env, alice, XRP(10'000), USD(10'000), ter(tecFROZEN)); + AMM const ammAliceFail(env, alice, XRP(10'000), USD(10'000), ter(tecFROZEN)); env(fclear(gw, asfGlobalFreeze)); env.close(); - AMM ammAlice(env, alice, XRP(10'000), USD(10'000)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'000)); } // Trading fee @@ -135,11 +178,11 @@ private: // Make sure asset comparison works. BEAST_EXPECT( - STIssue(sfAsset, STAmount(XRP(2'000)).issue()) == - STIssue(sfAsset, STAmount(XRP(2'000)).issue())); + STIssue(sfAsset, STAmount(XRP(2'000)).asset()) == + STIssue(sfAsset, STAmount(XRP(2'000)).asset())); BEAST_EXPECT( - STIssue(sfAsset, STAmount(XRP(2'000)).issue()) != - STIssue(sfAsset, STAmount(USD(2'000)).issue())); + STIssue(sfAsset, STAmount(XRP(2'000)).asset()) != + STIssue(sfAsset, STAmount(USD(2'000)).asset())); } void @@ -153,7 +196,7 @@ private: { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice(env, alice, XRP(10'000), XRP(10'000), ter(temBAD_AMM_TOKENS)); + AMM const ammAlice(env, alice, XRP(10'000), XRP(10'000), ter(temBAD_AMM_TOKENS)); BEAST_EXPECT(!ammAlice.ammExists()); } @@ -161,7 +204,7 @@ private: { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice(env, alice, USD(10'000), USD(10'000), ter(temBAD_AMM_TOKENS)); + AMM const ammAlice(env, alice, USD(10'000), USD(10'000), ter(temBAD_AMM_TOKENS)); BEAST_EXPECT(!ammAlice.ammExists()); } @@ -169,13 +212,13 @@ private: { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice(env, alice, XRP(0), USD(10'000), ter(temBAD_AMOUNT)); + AMM const ammAlice(env, alice, XRP(0), USD(10'000), ter(temBAD_AMOUNT)); BEAST_EXPECT(!ammAlice.ammExists()); - AMM ammAlice1(env, alice, XRP(10'000), USD(0), ter(temBAD_AMOUNT)); + AMM const ammAlice1(env, alice, XRP(10'000), USD(0), ter(temBAD_AMOUNT)); BEAST_EXPECT(!ammAlice1.ammExists()); - AMM ammAlice2(env, alice, XRP(10'000), USD(-10'000), ter(temBAD_AMOUNT)); + AMM const ammAlice2(env, alice, XRP(10'000), USD(-10'000), ter(temBAD_AMOUNT)); BEAST_EXPECT(!ammAlice2.ammExists()); - AMM ammAlice3(env, alice, XRP(-10'000), USD(10'000), ter(temBAD_AMOUNT)); + AMM const ammAlice3(env, alice, XRP(-10'000), USD(10'000), ter(temBAD_AMOUNT)); BEAST_EXPECT(!ammAlice3.ammExists()); } @@ -183,7 +226,7 @@ private: { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice(env, alice, XRP(10'000), BAD(10'000), ter(temBAD_CURRENCY)); + AMM const ammAlice(env, alice, XRP(10'000), BAD(10'000), ter(temBAD_CURRENCY)); BEAST_EXPECT(!ammAlice.ammExists()); } @@ -191,7 +234,7 @@ private: { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice(env, alice, XRP(10'000), USD(40'000), ter(tecUNFUNDED_AMM)); + AMM const ammAlice(env, alice, XRP(10'000), USD(40'000), ter(tecUNFUNDED_AMM)); BEAST_EXPECT(!ammAlice.ammExists()); } @@ -199,7 +242,7 @@ private: { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice(env, alice, XRP(40'000), USD(10'000), ter(tecUNFUNDED_AMM)); + AMM const ammAlice(env, alice, XRP(40'000), USD(10'000), ter(tecUNFUNDED_AMM)); BEAST_EXPECT(!ammAlice.ammExists()); } @@ -207,7 +250,7 @@ private: { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice( + AMM const ammAlice( env, alice, XRP(10'000), @@ -224,14 +267,14 @@ private: // AMM already exists testAMM([&](AMM& ammAlice, Env& env) { - AMM ammCarol(env, carol, XRP(10'000), USD(10'000), ter(tecDUPLICATE)); + AMM const ammCarol(env, carol, XRP(10'000), USD(10'000), ter(tecDUPLICATE)); }); // Invalid flags { Env env{*this}; fund(env, gw, {alice}, {USD(30'000)}, Fund::All); - AMM ammAlice( + AMM const ammAlice( env, alice, XRP(10'000), @@ -249,9 +292,9 @@ private: // Invalid Account { Env env{*this}; - Account bad("bad"); + Account const bad("bad"); env.memoize(bad); - AMM ammAlice( + AMM const ammAlice( env, bad, XRP(10'000), @@ -275,7 +318,7 @@ private: env.close(); env(trust(gw, alice["USD"](30'000))); env.close(); - AMM ammAlice(env, alice, XRP(10'000), USD(10'000), ter(tecNO_AUTH)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'000), ter(tecNO_AUTH)); BEAST_EXPECT(!ammAlice.ammExists()); } @@ -288,8 +331,11 @@ private: env.close(); env(trust(gw, alice["USD"](30'000))); env.close(); - AMM ammAlice(env, alice, XRP(10'000), USD(10'000), ter(tecFROZEN)); - BEAST_EXPECT(!ammAlice.ammExists()); + for (auto const& account : {alice, gw}) + { + AMM const amm(env, account, XRP(10'000), USD(10'000), ter(tecFROZEN)); + BEAST_EXPECT(!amm.ammExists()); + } } // Individually frozen @@ -301,8 +347,10 @@ private: env.close(); env(trust(gw, alice["USD"](0), tfSetFreeze)); env.close(); - AMM ammAlice(env, alice, XRP(10'000), USD(10'000), ter(tecFROZEN)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'000), ter(tecFROZEN)); BEAST_EXPECT(!ammAlice.ammExists()); + // issuer can create + AMM const amm(env, gw, XRP(10'000), USD(10'000)); } // Insufficient reserve, XRP/IOU @@ -317,7 +365,7 @@ private: env.close(); env(offer(alice, XRP(101), USD(100))); env(offer(alice, XRP(102), USD(100))); - AMM ammAlice(env, alice, XRP(1'000), USD(1'000), ter(tecUNFUNDED_AMM)); + AMM const ammAlice(env, alice, XRP(1'000), USD(1'000), ter(tecUNFUNDED_AMM)); } // Insufficient reserve, IOU/IOU @@ -334,14 +382,14 @@ private: env.close(); env(offer(alice, EUR(101), USD(100))); env(offer(alice, EUR(102), USD(100))); - AMM ammAlice(env, alice, EUR(1'000), USD(1'000), ter(tecINSUF_RESERVE_LINE)); + AMM const ammAlice(env, alice, EUR(1'000), USD(1'000), ter(tecINSUF_RESERVE_LINE)); } // Insufficient fee { Env env(*this); fund(env, gw, {alice}, XRP(2'000), {USD(2'000), EUR(2'000)}); - AMM ammAlice( + AMM const ammAlice( env, alice, EUR(1'000), @@ -359,14 +407,14 @@ private: // AMM with one LPToken from another AMM. testAMM([&](AMM& ammAlice, Env& env) { - fund(env, gw, {alice}, {EUR(10'000)}, Fund::IOUOnly); - AMM ammAMMToken( + fund(env, gw, {alice}, {EUR(10'000)}, Fund::TokenOnly); + AMM const ammAMMToken( env, alice, EUR(10'000), STAmount{ammAlice.lptIssue(), 1'000'000}, ter(tecAMM_INVALID_TOKENS)); - AMM ammAMMToken1( + AMM const ammAMMToken1( env, alice, STAmount{ammAlice.lptIssue(), 1'000'000}, @@ -376,11 +424,11 @@ private: // AMM with two LPTokens from other AMMs. testAMM([&](AMM& ammAlice, Env& env) { - fund(env, gw, {alice}, {EUR(10'000)}, Fund::IOUOnly); - AMM ammAlice1(env, alice, XRP(10'000), EUR(10'000)); + fund(env, gw, {alice}, {EUR(10'000)}, Fund::TokenOnly); + AMM const ammAlice1(env, alice, XRP(10'000), EUR(10'000)); auto const token1 = ammAlice.lptIssue(); auto const token2 = ammAlice1.lptIssue(); - AMM ammAMMTokens( + AMM const ammAMMTokens( env, alice, STAmount{token1, 1'000'000}, @@ -393,21 +441,21 @@ private: Env env(*this); env.fund(XRP(30'000), gw); env(fclear(gw, asfDefaultRipple)); - AMM ammGw(env, gw, XRP(10'000), USD(10'000), ter(terNO_RIPPLE)); + AMM const ammGw(env, gw, XRP(10'000), USD(10'000), ter(terNO_RIPPLE)); env.fund(XRP(30'000), alice); env.trust(USD(30'000), alice); env(pay(gw, alice, USD(30'000))); - AMM ammAlice(env, alice, XRP(10'000), USD(10'000), ter(terNO_RIPPLE)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'000), ter(terNO_RIPPLE)); Account const gw1("gw1"); env.fund(XRP(30'000), gw1); env(fclear(gw1, asfDefaultRipple)); env.trust(USD(30'000), gw1); env(pay(gw, gw1, USD(30'000))); auto const USD1 = gw1["USD"]; - AMM ammGwGw1(env, gw, USD(10'000), USD1(10'000), ter(terNO_RIPPLE)); + AMM const ammGwGw1(env, gw, USD(10'000), USD1(10'000), ter(terNO_RIPPLE)); env.trust(USD1(30'000), alice); env(pay(gw1, alice, USD1(30'000))); - AMM ammAlice1(env, alice, USD(10'000), USD1(10'000), ter(terNO_RIPPLE)); + AMM const ammAlice1(env, alice, USD(10'000), USD1(10'000), ter(terNO_RIPPLE)); } } @@ -429,106 +477,65 @@ private: std::optional, std::optional, std::optional, - std::optional>> - invalidOptions = { - // flags, tokens, asset1In, asset2in, EPrice, tfee - {tfLPToken, 1'000, std::nullopt, USD(100), std::nullopt, std::nullopt}, - {tfLPToken, 1'000, XRP(100), std::nullopt, std::nullopt, std::nullopt}, - {tfLPToken, - 1'000, - std::nullopt, - std::nullopt, - STAmount{USD, 1, -1}, - std::nullopt}, - {tfLPToken, - std::nullopt, - USD(100), - std::nullopt, - STAmount{USD, 1, -1}, - std::nullopt}, - {tfLPToken, 1'000, XRP(100), std::nullopt, STAmount{USD, 1, -1}, std::nullopt}, - {tfLPToken, 1'000, std::nullopt, std::nullopt, std::nullopt, 1'000}, - {tfSingleAsset, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, - {tfSingleAsset, - std::nullopt, - std::nullopt, - USD(100), - std::nullopt, - std::nullopt}, - {tfSingleAsset, - std::nullopt, - std::nullopt, - std::nullopt, - STAmount{USD, 1, -1}, - std::nullopt}, - {tfSingleAsset, std::nullopt, USD(100), std::nullopt, std::nullopt, 1'000}, - {tfTwoAsset, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, - {tfTwoAsset, - std::nullopt, - XRP(100), - USD(100), - STAmount{USD, 1, -1}, - std::nullopt}, - {tfTwoAsset, std::nullopt, XRP(100), std::nullopt, std::nullopt, std::nullopt}, - {tfTwoAsset, std::nullopt, XRP(100), USD(100), std::nullopt, 1'000}, - {tfTwoAsset, - std::nullopt, - std::nullopt, - USD(100), - STAmount{USD, 1, -1}, - std::nullopt}, - {tfOneAssetLPToken, - 1'000, - std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt}, - {tfOneAssetLPToken, - std::nullopt, - XRP(100), - USD(100), - std::nullopt, - std::nullopt}, - {tfOneAssetLPToken, - std::nullopt, - XRP(100), - std::nullopt, - STAmount{USD, 1, -1}, - std::nullopt}, - {tfOneAssetLPToken, 1'000, XRP(100), std::nullopt, std::nullopt, 1'000}, - {tfLimitLPToken, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, - {tfLimitLPToken, 1'000, USD(100), std::nullopt, std::nullopt, std::nullopt}, - {tfLimitLPToken, std::nullopt, USD(100), XRP(100), std::nullopt, std::nullopt}, - {tfLimitLPToken, - std::nullopt, - XRP(100), - std::nullopt, - STAmount{USD, 1, -1}, - 1'000}, - {tfTwoAssetIfEmpty, - std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt, - 1'000}, - {tfTwoAssetIfEmpty, - 1'000, - std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt}, - {tfTwoAssetIfEmpty, - std::nullopt, - XRP(100), - USD(100), - STAmount{USD, 1, -1}, - std::nullopt}, - {tfTwoAssetIfEmpty | tfLPToken, - std::nullopt, - XRP(100), - USD(100), - STAmount{USD, 1, -1}, - std::nullopt}}; + std::optional>> const invalidOptions = { + // flags, tokens, asset1In, asset2in, EPrice, tfee + {tfLPToken, 1'000, std::nullopt, USD(100), std::nullopt, std::nullopt}, + {tfLPToken, 1'000, XRP(100), std::nullopt, std::nullopt, std::nullopt}, + {tfLPToken, 1'000, std::nullopt, std::nullopt, STAmount{USD, 1, -1}, std::nullopt}, + {tfLPToken, + std::nullopt, + USD(100), + std::nullopt, + STAmount{USD, 1, -1}, + std::nullopt}, + {tfLPToken, 1'000, XRP(100), std::nullopt, STAmount{USD, 1, -1}, std::nullopt}, + {tfLPToken, 1'000, std::nullopt, std::nullopt, std::nullopt, 1'000}, + {tfSingleAsset, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, + {tfSingleAsset, std::nullopt, std::nullopt, USD(100), std::nullopt, std::nullopt}, + {tfSingleAsset, + std::nullopt, + std::nullopt, + std::nullopt, + STAmount{USD, 1, -1}, + std::nullopt}, + {tfSingleAsset, std::nullopt, USD(100), std::nullopt, std::nullopt, 1'000}, + {tfTwoAsset, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, + {tfTwoAsset, std::nullopt, XRP(100), USD(100), STAmount{USD, 1, -1}, std::nullopt}, + {tfTwoAsset, std::nullopt, XRP(100), std::nullopt, std::nullopt, std::nullopt}, + {tfTwoAsset, std::nullopt, XRP(100), USD(100), std::nullopt, 1'000}, + {tfTwoAsset, + std::nullopt, + std::nullopt, + USD(100), + STAmount{USD, 1, -1}, + std::nullopt}, + {tfOneAssetLPToken, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, + {tfOneAssetLPToken, std::nullopt, XRP(100), USD(100), std::nullopt, std::nullopt}, + {tfOneAssetLPToken, + std::nullopt, + XRP(100), + std::nullopt, + STAmount{USD, 1, -1}, + std::nullopt}, + {tfOneAssetLPToken, 1'000, XRP(100), std::nullopt, std::nullopt, 1'000}, + {tfLimitLPToken, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, + {tfLimitLPToken, 1'000, USD(100), std::nullopt, std::nullopt, std::nullopt}, + {tfLimitLPToken, std::nullopt, USD(100), XRP(100), std::nullopt, std::nullopt}, + {tfLimitLPToken, std::nullopt, XRP(100), std::nullopt, STAmount{USD, 1, -1}, 1'000}, + {tfTwoAssetIfEmpty, std::nullopt, std::nullopt, std::nullopt, std::nullopt, 1'000}, + {tfTwoAssetIfEmpty, 1'000, std::nullopt, std::nullopt, std::nullopt, std::nullopt}, + {tfTwoAssetIfEmpty, + std::nullopt, + XRP(100), + USD(100), + STAmount{USD, 1, -1}, + std::nullopt}, + {tfTwoAssetIfEmpty | tfLPToken, + std::nullopt, + XRP(100), + USD(100), + STAmount{USD, 1, -1}, + std::nullopt}}; for (auto const& it : invalidOptions) { ammAlice.deposit( @@ -626,7 +633,7 @@ private: alice, BAD(100), std::nullopt, std::nullopt, std::nullopt, ter(temBAD_CURRENCY)); // Invalid Account - Account bad("bad"); + Account const bad("bad"); env.memoize(bad); ammAlice.deposit( bad, @@ -754,11 +761,20 @@ private: ammAlice.deposit( carol, XRP(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); } - ammAlice.deposit( - carol, USD(100), std::nullopt, std::nullopt, std::nullopt, ter(tecFROZEN)); - ammAlice.deposit(carol, 1'000'000, std::nullopt, std::nullopt, ter(tecFROZEN)); - ammAlice.deposit( - carol, XRP(100), USD(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + for (auto const& account : {carol, gw}) + { + ammAlice.deposit( + account, + USD(100), + std::nullopt, + std::nullopt, + std::nullopt, + ter(tecFROZEN)); + ammAlice.deposit( + account, 1'000'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.deposit( + account, XRP(100), USD(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + } }, std::nullopt, 0, @@ -1445,7 +1461,7 @@ private: testAMM( [&](AMM& ammAlice, Env& env) { - WithdrawArg args{ + WithdrawArg const args{ .asset1Out = XRP(100), .err = ter(tecAMM_BALANCE), }; @@ -1455,7 +1471,7 @@ private: testAMM( [&](AMM& ammAlice, Env& env) { - WithdrawArg args{ + WithdrawArg const args{ .asset1Out = USD(100), .err = ter(tecAMM_BALANCE), }; @@ -1478,7 +1494,7 @@ private: env(pay(gw, alice, USD(10'000))); env.close(); AMM ammAlice(env, alice, XRP(10'000), USD(10'000)); - WithdrawArg args{ + WithdrawArg const args{ .account = bob, .asset1Out = USD(100), .err = ter(tecNO_AUTH), @@ -1516,79 +1532,58 @@ private: std::optional, std::optional, std::optional, - NotTEC>> - invalidOptions = { - // tokens, asset1Out, asset2Out, EPrice, flags, ter - {std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt, - temMALFORMED}, - {std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt, - tfSingleAsset | tfTwoAsset, - temMALFORMED}, - {1'000, std::nullopt, std::nullopt, std::nullopt, tfWithdrawAll, temMALFORMED}, - {std::nullopt, - USD(0), - XRP(100), - std::nullopt, - tfWithdrawAll | tfLPToken, - temMALFORMED}, - {std::nullopt, - std::nullopt, - USD(100), - std::nullopt, - tfWithdrawAll, - temMALFORMED}, - {std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt, - tfWithdrawAll | tfOneAssetWithdrawAll, - temMALFORMED}, - {std::nullopt, - USD(100), - std::nullopt, - std::nullopt, - tfWithdrawAll, - temMALFORMED}, - {std::nullopt, - std::nullopt, - std::nullopt, - std::nullopt, - tfOneAssetWithdrawAll, - temMALFORMED}, - {1'000, std::nullopt, USD(100), std::nullopt, std::nullopt, temMALFORMED}, - {std::nullopt, - std::nullopt, - std::nullopt, - IOUAmount{250, 0}, - tfWithdrawAll, - temMALFORMED}, - {1'000, - std::nullopt, - std::nullopt, - IOUAmount{250, 0}, - std::nullopt, - temMALFORMED}, - {std::nullopt, - std::nullopt, - USD(100), - IOUAmount{250, 0}, - std::nullopt, - temMALFORMED}, - {std::nullopt, - XRP(100), - USD(100), - IOUAmount{250, 0}, - std::nullopt, - temMALFORMED}, - {1'000, XRP(100), USD(100), std::nullopt, std::nullopt, temMALFORMED}, - {std::nullopt, XRP(100), USD(100), std::nullopt, tfWithdrawAll, temMALFORMED}}; + NotTEC>> const invalidOptions = { + // tokens, asset1Out, asset2Out, EPrice, flags, ter + {std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + temMALFORMED}, + {std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + tfSingleAsset | tfTwoAsset, + temMALFORMED}, + {1'000, std::nullopt, std::nullopt, std::nullopt, tfWithdrawAll, temMALFORMED}, + {std::nullopt, + USD(0), + XRP(100), + std::nullopt, + tfWithdrawAll | tfLPToken, + temMALFORMED}, + {std::nullopt, std::nullopt, USD(100), std::nullopt, tfWithdrawAll, temMALFORMED}, + {std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + tfWithdrawAll | tfOneAssetWithdrawAll, + temMALFORMED}, + {std::nullopt, USD(100), std::nullopt, std::nullopt, tfWithdrawAll, temMALFORMED}, + {std::nullopt, + std::nullopt, + std::nullopt, + std::nullopt, + tfOneAssetWithdrawAll, + temMALFORMED}, + {1'000, std::nullopt, USD(100), std::nullopt, std::nullopt, temMALFORMED}, + {std::nullopt, + std::nullopt, + std::nullopt, + IOUAmount{250, 0}, + tfWithdrawAll, + temMALFORMED}, + {1'000, std::nullopt, std::nullopt, IOUAmount{250, 0}, std::nullopt, temMALFORMED}, + {std::nullopt, + std::nullopt, + USD(100), + IOUAmount{250, 0}, + std::nullopt, + temMALFORMED}, + {std::nullopt, XRP(100), USD(100), IOUAmount{250, 0}, std::nullopt, temMALFORMED}, + {1'000, XRP(100), USD(100), std::nullopt, std::nullopt, temMALFORMED}, + {std::nullopt, XRP(100), USD(100), std::nullopt, tfWithdrawAll, temMALFORMED}}; for (auto const& it : invalidOptions) { ammAlice.withdraw( @@ -1641,7 +1636,7 @@ private: ammAlice.withdraw(alice, BAD(100), std::nullopt, std::nullopt, ter(temBAD_CURRENCY)); // Invalid Account - Account bad("bad"); + Account const bad("bad"); env.memoize(bad); ammAlice.withdraw( bad, @@ -1740,12 +1735,16 @@ private: // Globally frozen asset testAMM([&](AMM& ammAlice, Env& env) { + ammAlice.deposit({.account = gw, .asset1In = USD(1'000), .asset2In = XRP(1'000)}); env(fset(gw, asfGlobalFreeze)); env.close(); // Can withdraw non-frozen token - ammAlice.withdraw(alice, XRP(100)); - ammAlice.withdraw(alice, USD(100), std::nullopt, std::nullopt, ter(tecFROZEN)); - ammAlice.withdraw(alice, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + for (auto const& account : {alice, gw}) + { + ammAlice.withdraw(account, XRP(100)); + ammAlice.withdraw(account, USD(100), std::nullopt, std::nullopt, ter(tecFROZEN)); + ammAlice.withdraw(account, 1'000, std::nullopt, std::nullopt, ter(tecFROZEN)); + } }); // Individually frozen (AMM) account @@ -1984,7 +1983,7 @@ private: BEAST_EXPECT(!env.le(keylet::ownerDir(ammAlice.ammAccount()))); // Can create AMM for the XRP/USD pair - AMM ammCarol(env, carol, XRP(10'000), USD(10'000)); + AMM const ammCarol(env, carol, XRP(10'000), USD(10'000)); BEAST_EXPECT( ammCarol.expectBalances(XRP(10'000), USD(10'000), IOUAmount{10'000'000, 0})); }); @@ -2254,7 +2253,7 @@ private: BEAST_EXPECT(ammAlice.expectTradingFee(0)); // Invalid Account - Account bad("bad"); + Account const bad("bad"); env.memoize(bad); ammAlice.vote(bad, 1'000, std::nullopt, seq(1), std::nullopt, ter(terNO_ACCOUNT)); @@ -2488,7 +2487,7 @@ private: ter(tecAMM_INVALID_TOKENS)); // Invalid Account - Account bad("bad"); + Account const bad("bad"); env.memoize(bad); env(ammAlice.bid({ .account = bad, @@ -2551,10 +2550,10 @@ private: // More than four Auth accounts. testAMM([&](AMM& ammAlice, Env& env) { - Account ed("ed"); - Account bill("bill"); - Account scott("scott"); - Account james("james"); + Account const ed("ed"); + Account const bill("bill"); + Account const scott("scott"); + Account const james("james"); env.fund(XRP(1'000), bob, ed, bill, scott, james); env.close(); ammAlice.deposit(carol, 1'000'000); @@ -3088,8 +3087,8 @@ private: BEAST_EXPECT(ammAlice.expectAuctionSlot({carol})); env(ammAlice.bid({.account = alice, .bidMin = IOUAmount{100}})); BEAST_EXPECT(ammAlice.expectAuctionSlot({})); - Account bob("bob"); - Account dan("dan"); + Account const bob("bob"); + Account const dan("dan"); fund(env, {bob, dan}, XRP(1'000)); env(ammAlice.bid({ .account = alice, @@ -3147,12 +3146,12 @@ private: fund(env, gw, {alice, bob}, XRP(2'000), {USD(2'000)}); AMM amm(env, gw, XRP(1'000), USD(1'010), false, 1'000); - Json::Value tx = amm.bid({.account = alice, .bidMin = 500}); + Json::Value const tx = amm.bid({.account = alice, .bidMin = 500}); { auto jtx = env.jt(tx, seq(1), fee(baseFee)); env.app().config().features.erase(featureAMM); - PreflightContext pfCtx( + PreflightContext const pfCtx( env.app(), *jtx.stx, env.current()->rules(), tapNONE, env.journal); auto pf = Transactor::invokePreflight(pfCtx); BEAST_EXPECT(pf == temDISABLED); @@ -3163,7 +3162,7 @@ private: auto jtx = env.jt(tx, seq(1), fee(baseFee)); jtx.jv["TxnSignature"] = "deadbeef"; jtx.stx = env.ust(jtx); - PreflightContext pfCtx( + PreflightContext const pfCtx( env.app(), *jtx.stx, env.current()->rules(), tapNONE, env.journal); auto pf = Transactor::invokePreflight(pfCtx); BEAST_EXPECT(!isTesSuccess(pf)); @@ -3174,7 +3173,7 @@ private: jtx.jv["Asset2"]["currency"] = "XRP"; jtx.jv["Asset2"].removeMember("issuer"); jtx.stx = env.ust(jtx); - PreflightContext pfCtx( + PreflightContext const pfCtx( env.app(), *jtx.stx, env.current()->rules(), tapNONE, env.journal); auto pf = Transactor::invokePreflight(pfCtx); BEAST_EXPECT(pf == temBAD_AMM_TOKENS); @@ -3198,7 +3197,7 @@ private: Env env(*this); fund(env, gw, {alice, carol}, XRP(1'000), {USD(100)}); // XRP balance is below reserve - AMM ammAlice(env, acct, XRP(10), USD(10)); + AMM const ammAlice(env, acct, XRP(10), USD(10)); // Pay below reserve env(pay(carol, ammAlice.ammAccount(), XRP(10)), ter(tecNO_PERMISSION)); // Pay above reserve @@ -3210,7 +3209,7 @@ private: Env env(*this); fund(env, gw, {alice, carol}, XRP(10'000'000), {USD(10'000)}); // XRP balance is above reserve - AMM ammAlice(env, acct, XRP(1'000'000), USD(100)); + AMM const ammAlice(env, acct, XRP(1'000'000), USD(100)); // Pay below reserve env(pay(carol, ammAlice.ammAccount(), XRP(10)), ter(tecNO_PERMISSION)); // Pay above reserve @@ -3635,7 +3634,7 @@ private: env.close(); env(offer(bob, XRP(50), USD(150)), txflags(tfPassive)); env.close(); - AMM ammAlice(env, alice, XRP(1'000), USD(1'050)); + AMM const ammAlice(env, alice, XRP(1'000), USD(1'050)); env(pay(alice, carol, USD(200)), sendmax(XRP(200)), txflags(tfPartialPayment)); env.close(); BEAST_EXPECT(ammAlice.expectBalances(XRP(1'050), USD(1'000), ammAlice.tokens())); @@ -3962,13 +3961,13 @@ private: XRP(100'000), {EUR(50'000), BTC(50'000), ETH(50'000), USD(50'000)}); fund(env, gw, {carol, bob}, XRP(1'000), {USD(200)}, Fund::Acct); - AMM xrp_eur(env, alice, XRP(10'100), EUR(10'000)); - AMM eur_btc(env, alice, EUR(10'000), BTC(10'200)); - AMM btc_usd(env, alice, BTC(10'100), USD(10'000)); - AMM xrp_usd(env, alice, XRP(10'150), USD(10'200)); - AMM xrp_eth(env, alice, XRP(10'000), ETH(10'100)); - AMM eth_eur(env, alice, ETH(10'900), EUR(11'000)); - AMM eur_usd(env, alice, EUR(10'100), USD(10'000)); + AMM const xrp_eur(env, alice, XRP(10'100), EUR(10'000)); + AMM const eur_btc(env, alice, EUR(10'000), BTC(10'200)); + AMM const btc_usd(env, alice, BTC(10'100), USD(10'000)); + AMM const xrp_usd(env, alice, XRP(10'150), USD(10'200)); + AMM const xrp_eth(env, alice, XRP(10'000), ETH(10'100)); + AMM const eth_eur(env, alice, ETH(10'900), EUR(11'000)); + AMM const eur_usd(env, alice, EUR(10'100), USD(10'000)); env(pay(bob, carol, USD(100)), path(~EUR, ~BTC, ~USD), path(~USD), @@ -4043,11 +4042,11 @@ private: XRP(40'000), {EUR(50'000), BTC(50'000), ETH(50'000), USD(50'000)}); fund(env, gw, {carol, bob}, XRP(1000), {USD(200)}, Fund::Acct); - AMM xrp_eur(env, alice, XRP(10'100), EUR(10'000)); - AMM eur_btc(env, alice, EUR(10'000), BTC(10'200)); - AMM btc_usd(env, alice, BTC(10'100), USD(10'000)); - AMM xrp_eth(env, alice, XRP(10'000), ETH(10'100)); - AMM eth_eur(env, alice, ETH(10'900), EUR(11'000)); + AMM const xrp_eur(env, alice, XRP(10'100), EUR(10'000)); + AMM const eur_btc(env, alice, EUR(10'000), BTC(10'200)); + AMM const btc_usd(env, alice, BTC(10'100), USD(10'000)); + AMM const xrp_eth(env, alice, XRP(10'000), ETH(10'100)); + AMM const eth_eur(env, alice, ETH(10'900), EUR(11'000)); env(pay(bob, carol, USD(100)), path(~EUR, ~BTC, ~USD), path(~ETH, ~EUR, ~BTC, ~USD), @@ -4108,7 +4107,7 @@ private: testAMM( [&](AMM& ammAlice, Env& env) { env.fund(XRP(1'000), bob); - fund(env, gw, {bob}, {EUR(400)}, Fund::IOUOnly); + fund(env, gw, {bob}, {EUR(400)}, Fund::TokenOnly); env(trust(alice, EUR(200))); for (int i = 0; i < 30; ++i) env(offer(alice, EUR(1.0 + (0.01 * i)), XRP(1))); @@ -4148,7 +4147,7 @@ private: testAMM( [&](AMM& ammAlice, Env& env) { env.fund(XRP(1'000), bob); - fund(env, gw, {bob}, {EUR(400)}, Fund::IOUOnly); + fund(env, gw, {bob}, {EUR(400)}, Fund::TokenOnly); env(trust(alice, EUR(200))); for (int i = 0; i < 29; ++i) env(offer(alice, EUR(1.0 + (0.01 * i)), XRP(1))); @@ -4188,7 +4187,7 @@ private: Env env(*this, features); fund(env, gw, {alice, carol, bob}, XRP(30'000), {USD(30'000)}); env(offer(bob, XRP(100), USD(100.001))); - AMM ammAlice(env, alice, XRP(10'000), USD(10'100)); + AMM const ammAlice(env, alice, XRP(10'000), USD(10'100)); env(offer(carol, USD(100), XRP(100))); if (!features[fixAMMv1_1]) { @@ -4286,7 +4285,7 @@ private: // Offer crossing with two AMM LPTokens. testAMM([&](AMM& ammAlice, Env& env) { ammAlice.deposit(carol, 1'000'000); - fund(env, gw, {alice, carol}, {EUR(10'000)}, Fund::IOUOnly); + fund(env, gw, {alice, carol}, {EUR(10'000)}, Fund::TokenOnly); AMM ammAlice1(env, alice, XRP(10'000), EUR(10'000)); ammAlice1.deposit(carol, 1'000'000); auto const token1 = ammAlice.lptIssue(); @@ -4413,7 +4412,7 @@ private: env.trust(TSTB(10'000), C); env(pay(A, C, TSTA(10'000))); env(pay(B, C, TSTB(10'000))); - AMM amm(env, C, TSTA(5'000), TSTB(5'000)); + AMM const amm(env, C, TSTA(5'000), TSTB(5'000)); auto const ammIss = Issue(TSTA.currency, amm.ammAccount()); // Can TrustSet only for AMM LP tokens @@ -4463,7 +4462,7 @@ private: std::string lp2TakerPays; // Execute with AMM first prep( - [&](Env& env) { AMM amm(env, LP1, TST(25), XRP(250)); }, + [&](Env& env) { AMM const amm(env, LP1, TST(25), XRP(250)); }, [&](Env& env) { lp2TSTBalance = getAccountLines(env, LP2, TST)["lines"][0u]["balance"].asString(); auto const offer = getAccountOffers(env, LP2)["offers"][0u]; @@ -4767,7 +4766,7 @@ private: Account const ed("ed"); fund(env, gw, {alice, bob, carol, ed}, XRP(1'000), {USD(2'000), EUR(2'000)}); env(offer(carol, EUR(5), USD(5))); - AMM ammAlice(env, alice, USD(1'005), EUR(1'000)); + AMM const ammAlice(env, alice, USD(1'005), EUR(1'000)); env(pay(bob, ed, USD(10)), path(~USD), sendmax(EUR(15)), txflags(tfNoRippleDirect)); BEAST_EXPECT(expectHolding(env, ed, USD(2'010))); if (!features[fixAMMv1_1]) @@ -4795,7 +4794,7 @@ private: fund(env, gw, {alice, bob, carol, ed}, XRP(1'000), {USD(2'000), EUR(2'000)}); env(offer(carol, EUR(5), USD(5))); // Set 0.25% fee - AMM ammAlice(env, alice, USD(1'005), EUR(1'000), false, 250); + AMM const ammAlice(env, alice, USD(1'005), EUR(1'000), false, 250); env(pay(bob, ed, USD(10)), path(~USD), sendmax(EUR(15)), txflags(tfNoRippleDirect)); BEAST_EXPECT(expectHolding(env, ed, USD(2'010))); if (!features[fixAMMv1_1]) @@ -4828,7 +4827,7 @@ private: fund(env, gw, {alice, bob, carol, ed}, XRP(1'000), {USD(2'000), EUR(2'000)}); env(offer(carol, EUR(10), USD(10))); // Set 1% fee - AMM ammAlice(env, alice, USD(1'005), EUR(1'000), false, 1'000); + AMM const ammAlice(env, alice, USD(1'005), EUR(1'000), false, 1'000); env(pay(bob, ed, USD(10)), path(~USD), sendmax(EUR(15)), txflags(tfNoRippleDirect)); BEAST_EXPECT(expectHolding(env, ed, USD(2'010))); BEAST_EXPECT(expectHolding(env, bob, EUR(1'990))); @@ -4846,7 +4845,7 @@ private: fund(env, gw, {alice, bob, carol, ed}, XRP(1'000), {USD(2'000), EUR(2'000)}); env(offer(carol, EUR(9), USD(9))); // Set 1% fee - AMM ammAlice(env, alice, USD(1'005), EUR(1'000), false, 1'000); + AMM const ammAlice(env, alice, USD(1'005), EUR(1'000), false, 1'000); env(pay(bob, ed, USD(10)), path(~USD), sendmax(EUR(15)), txflags(tfNoRippleDirect)); BEAST_EXPECT(expectHolding(env, ed, USD(2'010))); BEAST_EXPECT(expectHolding(env, bob, STAmount{EUR, UINT64_C(1'989'993923296712), -12})); @@ -5187,7 +5186,7 @@ private: Env env(*this); env.fund(XRP(2'000), gw); env.fund(XRP(2'000), alice); - AMM amm(env, gw, XRP(1'000), USD(1'000)); + AMM const amm(env, gw, XRP(1'000), USD(1'000)); env(fset(gw, asfAllowTrustLineClawback), ter(tecOWNERS)); } @@ -5256,7 +5255,7 @@ private: auto prep = [&](Env& env, auto gwRate, auto gw1Rate) { fund(env, gw, {alice, carol, bob, ed}, XRP(2'000), {USD(2'000)}); env.fund(XRP(2'000), gw1); - fund(env, gw1, {alice, carol, bob, ed}, {ETH(2'000), CAN(2'000)}, Fund::IOUOnly); + fund(env, gw1, {alice, carol, bob, ed}, {ETH(2'000), CAN(2'000)}, Fund::TokenOnly); env(rate(gw, gwRate)); env(rate(gw1, gw1Rate)); env.close(); @@ -5737,7 +5736,7 @@ private: auto const xrpIouAmounts10_100 = TAmounts{XRPAmount{10}, IOUAmount{100}}; auto const iouXrpAmounts10_100 = TAmounts{IOUAmount{10}, XRPAmount{100}}; // clang-format off - std::vector> tests = { + std::vector> const tests = { //Pool In , Pool Out, Quality , Fee, Status {"0.001519763260828713", "1558701", Quality{5414253689393440221}, 1000, FailShouldSucceed}, {"0.01099814367603737", "1892611", Quality{5482264816516900274}, 1000, FailShouldSucceed}, @@ -5797,14 +5796,14 @@ private: }; // clang-format on - boost::regex rx("^\\d+$"); + boost::regex const rx("^\\d+$"); boost::smatch match; // tests that succeed should have the same amounts pre-fix and post-fix - std::vector> successAmounts; - Env env(*this, features, std::make_unique(&logs)); + std::vector> const successAmounts; + Env const env(*this, features, std::make_unique(&logs)); auto rules = env.current()->rules(); - CurrentTransactionRulesGuard rg(rules); - NumberMantissaScaleGuard sg(MantissaRange::small); + CurrentTransactionRulesGuard const rg(rules); + NumberMantissaScaleGuard const sg(MantissaRange::small); for (auto const& t : tests) { @@ -5886,7 +5885,7 @@ private: takerGets}; } auto const takerPays = - toAmount(getIssue(poolIn), Number{1, -10} * poolIn); + toAmount(getAsset(poolIn), Number{1, -10} * poolIn); return Amounts{ takerPays, swapAssetIn(Amounts{poolIn, poolOut}, takerPays, tfee)}; }(); @@ -5923,7 +5922,7 @@ private: using namespace jtx; testAMM([&](AMM& ammAlice, Env& env) { - WithdrawArg args{ + WithdrawArg const args{ .flags = tfSingleAsset, .err = ter(temMALFORMED), }; @@ -5931,7 +5930,7 @@ private: }); testAMM([&](AMM& ammAlice, Env& env) { - WithdrawArg args{ + WithdrawArg const args{ .flags = tfOneAssetLPToken, .err = ter(temMALFORMED), }; @@ -5939,7 +5938,7 @@ private: }); testAMM([&](AMM& ammAlice, Env& env) { - WithdrawArg args{ + WithdrawArg const args{ .flags = tfLimitLPToken, .err = ter(temMALFORMED), }; @@ -5947,7 +5946,7 @@ private: }); testAMM([&](AMM& ammAlice, Env& env) { - WithdrawArg args{ + WithdrawArg const args{ .asset1Out = XRP(100), .asset2Out = XRP(100), .err = ter(temBAD_AMM_TOKENS), @@ -5956,7 +5955,7 @@ private: }); testAMM([&](AMM& ammAlice, Env& env) { - WithdrawArg args{ + WithdrawArg const args{ .asset1Out = XRP(100), .asset2Out = BAD(100), .err = ter(temBAD_CURRENCY), @@ -5977,6 +5976,7 @@ private: } void + // NOLINTNEXTLINE(readability-convert-member-functions-to-static) testFixOverflowOffer(FeatureBitset featuresInitial) { using namespace jtx; @@ -6234,7 +6234,7 @@ private: env(pay(bitstamp, trader, usdBIT(100'000))); env.close(); - AMM amm{env, trader, usdGH(input.poolUsdGH), usdBIT(input.poolUsdBIT)}; + AMM const amm{env, trader, usdGH(input.poolUsdGH), usdBIT(input.poolUsdBIT)}; env.close(); IOUAmount const preSwapLPTokenBalance = amm.getLPTokensBalance(); @@ -6343,7 +6343,7 @@ private: env(offer(alice, XRP(1), USD(0.01))); env.close(); - AMM amm(env, gw, XRP(200'000), USD(100'000)); + AMM const amm(env, gw, XRP(200'000), USD(100'000)); // The offer doesn't cross AMM in pre-amendment code // It crosses AMM in post-amendment code @@ -6376,7 +6376,7 @@ private: // There is no blocking offer // env(offer(alice, XRP(1), USD(0.01))); - AMM amm(env, gw, XRP(200'000), USD(100'000)); + AMM const amm(env, gw, XRP(200'000), USD(100'000)); // The offer crosses AMM env(offer(carol, USD(0.49), XRP(1))); @@ -6398,7 +6398,7 @@ private: // It crosses AMM in post-amendment code env(offer(bob, USD(1), XRPAmount(500))); env.close(); - AMM amm(env, alice, XRP(1'000), USD(500)); + AMM const amm(env, alice, XRP(1'000), USD(500)); env(offer(carol, XRP(100), USD(55))); env.close(); if (!features[fixAMMv1_1]) @@ -6428,7 +6428,7 @@ private: Env env(*this, features); fund(env, gw, {alice, carol, bob}, XRP(10'000), {USD(1'000)}); - AMM amm(env, alice, XRP(1'000), USD(500)); + AMM const amm(env, alice, XRP(1'000), USD(500)); env(offer(carol, XRP(100), USD(55))); env.close(); BEAST_EXPECT(amm.expectBalances( @@ -6534,7 +6534,7 @@ private: Account const gw1("gw1"); auto const YAN = gw1["YAN"]; fund(env, gw, {gw1}, XRP(1'000), {USD(1'000)}); - fund(env, gw1, {gw}, XRP(1'000), {YAN(1'000)}, Fund::IOUOnly); + fund(env, gw1, {gw}, XRP(1'000), {YAN(1'000)}, Fund::TokenOnly); AMM amm(env, gw1, YAN(10), USD(10)); amm.deposit(gw, 1'000); auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), gw); @@ -6561,12 +6561,12 @@ private: // clawback-enabled issuer if (!features[featureAMMClawback]) { - AMM amm(env, gw, XRP(100), USD(100), ter(tecNO_PERMISSION)); - AMM amm1(env, alice, USD(100), XRP(100), ter(tecNO_PERMISSION)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tecNO_PERMISSION)); + AMM const amm1(env, alice, USD(100), XRP(100), ter(tecNO_PERMISSION)); env(fclear(gw, asfAllowTrustLineClawback)); env.close(); // Can't be cleared - AMM amm2(env, gw, XRP(100), USD(100), ter(tecNO_PERMISSION)); + AMM const amm2(env, gw, XRP(100), USD(100), ter(tecNO_PERMISSION)); } // If featureAMMClawback is enabled, AMMCreate is allowed for // clawback-enabled issuer. Clawback from the AMM Account is not @@ -6575,8 +6575,8 @@ private: // AMMClawback transaction to claw back from AMM Account. else { - AMM amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); - AMM amm1(env, alice, USD(100), XRP(200), ter(tecDUPLICATE)); + AMM const amm(env, gw, XRP(100), USD(100), ter(tesSUCCESS)); + AMM const amm1(env, alice, USD(100), XRP(200), ter(tecDUPLICATE)); // Construct the amount being clawed back using AMM account. // By doing this, we make the clawback transaction's Amount field's @@ -6588,7 +6588,7 @@ private: // is confusing. auto const error = features[featureSingleAssetVault] ? ter{tecPSEUDO_ACCOUNT} : ter{tecAMM_ACCOUNT}; - Issue usd(USD.issue().currency, amm.ammAccount()); + Issue const usd(USD.issue().currency, amm.ammAccount()); auto amount = amountFromString(usd, "10"); env(claw(gw, amount), error); } @@ -6712,9 +6712,9 @@ private: env(pay(gw, alice, USD(10'000))); env.close(); - STAmount amount = XRP(10'000); - STAmount amount2 = USD(10'000); - auto const keylet = keylet::amm(amount.issue(), amount2.issue()); + STAmount const amount = XRP(10'000); + STAmount const amount2 = USD(10'000); + auto const keylet = keylet::amm(amount.asset(), amount2.asset()); for (int i = 0; i < 256; ++i) { AccountID const accountId = xrpl::pseudoAccountAddress(*env.current(), keylet.key); @@ -6725,7 +6725,7 @@ private: sig(autofill)); } - AMM ammAlice( + AMM const ammAlice( env, alice, amount, @@ -6747,7 +6747,7 @@ private: STAmount xrpBalance{XRPAmount(692'614'492'126)}; STAmount xpmBalance{XPM, UINT64_C(18'610'359'80246901), -8}; STAmount amount{XPM, UINT64_C(6'566'496939465400), -12}; - std::uint16_t tfee = 941; + std::uint16_t const tfee = 941; auto test = [&](auto&& cb, std::uint16_t tfee_) { Env env(*this, features); @@ -6758,7 +6758,7 @@ private: AMM amm(env, gw, xrpBalance, xpmBalance, CreateArg{.tfee = tfee_}); // AMM LPToken balance required to replicate single deposit failure - STAmount lptAMMBalance{amm.lptIssue(), UINT64_C(3'234'987'266'485968), -6}; + STAmount const lptAMMBalance{amm.lptIssue(), UINT64_C(3'234'987'266'485968), -6}; auto const burn = IOUAmount{amm.getLPTokensBalance() - lptAMMBalance}; // burn tokens to get to the required AMM state env(amm.bid(BidArg{.account = gw, .bidMin = burn, .bidMax = burn})); @@ -6793,8 +6793,8 @@ private: { auto const [amount, amount2, lptBalance] = amm.balances(GBP, EUR); - NumberMantissaScaleGuard sg(MantissaRange::small); - NumberRoundModeGuard g(env.enabled(fixAMMv1_3) ? Number::upward : Number::getround()); + NumberMantissaScaleGuard const sg(MantissaRange::small); + NumberRoundModeGuard const g(env.enabled(fixAMMv1_3) ? Number::upward : Number::getround()); auto const res = root2(amount * amount2); if (shouldFail) @@ -6992,7 +6992,7 @@ private: // tfSingleAsset withdraw mode // Note: This test fails with 0 trading fees, but doesn't fail if // trading fees is set to 1'000 -- I suspect the compound operations - // in AMMHelpers.cpp:withdrawByTokens compensate for the rounding + // in AMMHelpers.cpp:ammAssetOut compensate for the rounding // errors testAMM( [&](AMM& ammAlice, Env& env) { diff --git a/src/test/app/AccountDelete_test.cpp b/src/test/app/AccountDelete_test.cpp index 91780800e9..66c4451ec9 100644 --- a/src/test/app/AccountDelete_test.cpp +++ b/src/test/app/AccountDelete_test.cpp @@ -1,8 +1,49 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -452,7 +493,7 @@ public: // Verify the existence of the expected ledger entries. Keylet const aliceOwnerDirKey{keylet::ownerDir(alice.id())}; { - std::shared_ptr closed{env.closed()}; + std::shared_ptr const closed{env.closed()}; BEAST_EXPECT(closed->exists(keylet::account(alice.id()))); BEAST_EXPECT(closed->exists(aliceOwnerDirKey)); @@ -486,7 +527,7 @@ public: // Verify that alice's account root is gone as well as her directory // nodes and all of her offers. { - std::shared_ptr closed{env.closed()}; + std::shared_ptr const closed{env.closed()}; BEAST_EXPECT(!closed->exists(keylet::account(alice.id()))); BEAST_EXPECT(!closed->exists(aliceOwnerDirKey)); @@ -539,7 +580,7 @@ public: env(acctdelete(gw, alice), fee(acctDelFee), ter(tecHAS_OBLIGATIONS)); env.close(); { - std::shared_ptr closed{env.closed()}; + std::shared_ptr const closed{env.closed()}; BEAST_EXPECT(closed->exists(keylet::account(alice.id()))); BEAST_EXPECT(closed->exists(keylet::account(gw.id()))); } @@ -590,7 +631,7 @@ public: env(acctdelete(alice, env.master), fee(XRP(1)), ter(telINSUF_FEE_P)); env.close(); { - std::shared_ptr closed{env.closed()}; + std::shared_ptr const closed{env.closed()}; BEAST_EXPECT(closed->exists(keylet::account(alice.id()))); BEAST_EXPECT(env.balance(env.master) == masterBalance); } @@ -617,7 +658,7 @@ public: env.require(owners(bob, 250)); { - std::shared_ptr closed{env.closed()}; + std::shared_ptr const closed{env.closed()}; BEAST_EXPECT(closed->exists(keylet::account(bob.id()))); for (std::uint32_t i = 0; i < 250; ++i) { @@ -636,7 +677,7 @@ public: verifyDeliveredAmount(env, bobOldBalance - acctDelFee); env.close(); { - std::shared_ptr closed{env.closed()}; + std::shared_ptr const closed{env.closed()}; BEAST_EXPECT(!closed->exists(keylet::account(bob.id()))); for (std::uint32_t i = 0; i < 250; ++i) { diff --git a/src/test/app/AccountSet_test.cpp b/src/test/app/AccountSet_test.cpp index 748f276433..6ce81e04ff 100644 --- a/src/test/app/AccountSet_test.cpp +++ b/src/test/app/AccountSet_test.cpp @@ -1,13 +1,54 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include +#include +#include #include #include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { class AccountSet_test : public beast::unit_test::suite @@ -195,7 +236,7 @@ public: std::size_t const maxLength = 256; for (std::size_t len = maxLength - 1; len <= maxLength + 1; ++len) { - std::string domain2 = std::string(len - domain.length() - 1, 'a') + "." + domain; + std::string const domain2 = std::string(len - domain.length() - 1, 'a') + "." + domain; BEAST_EXPECT(domain2.length() == len); @@ -373,7 +414,7 @@ public: // // Two out-of-bound values are currently in the ledger (March 2020) // They are 4.0 and 4.294967295. So those are the values we test. - for (double transferRate : {4.0, 4.294967295}) + for (double const transferRate : {4.0, 4.294967295}) { Env env(*this); env.fund(XRP(10000), gw, alice, bob); diff --git a/src/test/app/AccountTxPaging_test.cpp b/src/test/app/AccountTxPaging_test.cpp index 09b517c37c..d5c299b782 100644 --- a/src/test/app/AccountTxPaging_test.cpp +++ b/src/test/app/AccountTxPaging_test.cpp @@ -1,7 +1,13 @@ -#include -#include -#include +#include +#include +#include +#include +#include + +#include +#include +#include #include #include @@ -47,9 +53,9 @@ class AccountTxPaging_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; env.fund(XRP(10000), A1, A2, A3); env.close(); diff --git a/src/test/app/AmendmentTable_test.cpp b/src/test/app/AmendmentTable_test.cpp index 39e516304b..4e3ef42242 100644 --- a/src/test/app/AmendmentTable_test.cpp +++ b/src/test/app/AmendmentTable_test.cpp @@ -1,21 +1,44 @@ #include +#include #include +#include +#include #include #include -#include +#include +#include #include -#include +#include +#include +#include #include +#include #include +#include #include +#include +#include #include #include #include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { class AmendmentTable_test final : public beast::unit_test::suite @@ -1067,7 +1090,7 @@ public: // Since the local validator vote record expires after 24 hours, // with 23 hour flapping the amendment will go live. But with 25 // hour flapping the amendment will not go live. - for (int flapRateHours : {23, 25}) + for (int const flapRateHours : {23, 25}) { test::jtx::Env env{*this, feat}; auto const testAmendment = amendmentId("validatorFlapping"); diff --git a/src/test/app/Batch_test.cpp b/src/test/app/Batch_test.cpp index a548eb6b49..7fd4c28403 100644 --- a/src/test/app/Batch_test.cpp +++ b/src/test/app/Batch_test.cpp @@ -1,20 +1,77 @@ -#include +#include +#include #include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include #include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -960,7 +1017,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -969,7 +1026,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } @@ -1002,7 +1059,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -1011,7 +1068,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } @@ -1044,7 +1101,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -1053,7 +1110,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } @@ -1086,7 +1143,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -1095,7 +1152,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } @@ -1128,7 +1185,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -1137,7 +1194,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } @@ -1463,7 +1520,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -1495,7 +1552,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(9999)), seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -1524,7 +1581,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(trust(alice, USD(1000), tfSetfAuth), seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -1553,7 +1610,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(trust(alice, USD(1000), tfSetfAuth), 0, seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -1605,7 +1662,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(9999)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tecUNFUNDED_PAYMENT", txIDs[0], batchID}, {2, "Payment", "tecUNFUNDED_PAYMENT", txIDs[1], batchID}, @@ -1638,7 +1695,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tecUNFUNDED_PAYMENT", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -1670,7 +1727,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, }; @@ -1701,7 +1758,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[1], batchID}, }; @@ -1732,7 +1789,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[1], batchID}, }; @@ -1769,7 +1826,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, dave, XRP(100)), seq + 6)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "OfferCreate", "tecKILLED", txIDs[0], batchID}, {2, "OfferCreate", "tecKILLED", txIDs[1], batchID}, @@ -1821,7 +1878,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tecUNFUNDED_PAYMENT", txIDs[0], batchID}, }; @@ -1852,7 +1909,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(4)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -1887,7 +1944,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -1921,7 +1978,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -1954,7 +2011,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -1987,7 +2044,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, dave, XRP(100)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -2038,7 +2095,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tecUNFUNDED_PAYMENT", txIDs[1], batchID}, @@ -2073,7 +2130,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 4)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -2108,7 +2165,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -2142,7 +2199,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(3)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -2175,7 +2232,7 @@ class Batch_test : public beast::unit_test::suite offer(alice, alice["USD"](100), XRP(100), tfImmediateOrCancel), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -2339,7 +2396,7 @@ class Batch_test : public beast::unit_test::suite // - has no `Signers` field // + has `tfInnerBatchTxn` flag { - STTx amendTx(ttAMENDMENT, [seq = env.closed()->header().seq + 1](auto& obj) { + STTx const amendTx(ttAMENDMENT, [seq = env.closed()->header().seq + 1](auto& obj) { obj.setAccountID(sfAccount, AccountID()); obj.setFieldH256(sfAmendment, fixBatchInnerSigs); obj.setFieldU32(sfLedgerSequence, seq); @@ -2397,7 +2454,7 @@ class Batch_test : public beast::unit_test::suite batch::sig(bob)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "AccountSet", "tesSUCCESS", txIDs[1], batchID}, @@ -2446,7 +2503,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(1)), seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "AccountSet", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -2501,7 +2558,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "AccountDelete", "tesSUCCESS", txIDs[1], batchID}, @@ -2544,7 +2601,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "AccountDelete", "tecHAS_OBLIGATIONS", txIDs[1], batchID}, @@ -2585,7 +2642,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 3)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -2626,7 +2683,7 @@ class Batch_test : public beast::unit_test::suite // Just use an XRP asset PrettyAsset const asset{xrpIssue(), 1'000'000}; - Vault vault{env}; + Vault const vault{env}; auto const deposit = asset(50'000); auto const debtMaximumValue = asset(25'000).value(); @@ -2821,7 +2878,7 @@ class Batch_test : public beast::unit_test::suite batch::sig(bob)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "CheckCreate", "tesSUCCESS", txIDs[0], batchID}, {2, "CheckCash", "tesSUCCESS", txIDs[1], batchID}, @@ -2867,7 +2924,7 @@ class Batch_test : public beast::unit_test::suite batch::sig(bob)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "CheckCreate", "tecDST_TAG_NEEDED", txIDs[0], batchID}, {2, "CheckCash", "tecNO_ENTRY", txIDs[1], batchID}, @@ -2932,7 +2989,7 @@ class Batch_test : public beast::unit_test::suite batch::sig(bob)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "TicketCreate", "tesSUCCESS", txIDs[0], batchID}, {2, "CheckCreate", "tesSUCCESS", txIDs[1], batchID}, @@ -2992,7 +3049,7 @@ class Batch_test : public beast::unit_test::suite batch::sig(alice, bob)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "CheckCreate", "tesSUCCESS", txIDs[0], batchID}, {2, "CheckCash", "tesSUCCESS", txIDs[1], batchID}, @@ -3026,7 +3083,7 @@ class Batch_test : public beast::unit_test::suite env.fund(XRP(10000), alice, bob); env.close(); - std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + std::uint32_t const aliceTicketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 10)); env.close(); @@ -3044,7 +3101,7 @@ class Batch_test : public beast::unit_test::suite ticket::use(aliceTicketSeq)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3092,7 +3149,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), 0, aliceTicketSeq + 1)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3123,7 +3180,7 @@ class Batch_test : public beast::unit_test::suite env.fund(XRP(10000), alice, bob); env.close(); - std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + std::uint32_t const aliceTicketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 10)); env.close(); @@ -3141,7 +3198,7 @@ class Batch_test : public beast::unit_test::suite ticket::use(aliceTicketSeq)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3202,7 +3259,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3213,7 +3270,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger contains noop txn - std::vector testCases = { + std::vector const testCases = { {0, "AccountSet", "tesSUCCESS", noopTxnID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -3246,7 +3303,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3257,7 +3314,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } } @@ -3285,7 +3342,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3296,7 +3353,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } } @@ -3327,7 +3384,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "AccountSet", "tesSUCCESS", noopTxnID, std::nullopt}, {1, "Batch", "tesSUCCESS", batchID, std::nullopt}, {2, "Payment", "tesSUCCESS", txIDs[0], batchID}, @@ -3339,7 +3396,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger contains no transactions - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } } @@ -3365,7 +3422,7 @@ class Batch_test : public beast::unit_test::suite env.fund(XRP(10000), alice, bob); env.close(); - std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + std::uint32_t const aliceTicketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 10)); env.close(); @@ -3387,7 +3444,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3398,7 +3455,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } } @@ -3412,7 +3469,7 @@ class Batch_test : public beast::unit_test::suite env.fund(XRP(10000), alice, bob); env.close(); - std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + std::uint32_t const aliceTicketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 10)); env.close(); @@ -3434,7 +3491,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3445,7 +3502,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } } @@ -3473,7 +3530,7 @@ class Batch_test : public beast::unit_test::suite env.fund(XRP(10000), alice, bob); env.close(); - std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + std::uint32_t const aliceTicketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 10)); env.close(); @@ -3497,7 +3554,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "CheckCreate", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3509,7 +3566,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger is empty - std::vector testCases = {}; + std::vector const testCases = {}; validateClosedLedger(env, testCases); } } @@ -3520,7 +3577,7 @@ class Batch_test : public beast::unit_test::suite env.fund(XRP(10000), alice, bob); env.close(); - std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + std::uint32_t const aliceTicketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 10)); env.close(); @@ -3546,7 +3603,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "CheckCreate", "tesSUCCESS", objTxnID, std::nullopt}, {1, "Batch", "tesSUCCESS", batchID, std::nullopt}, {2, "CheckCash", "tesSUCCESS", txIDs[0], batchID}, @@ -3567,7 +3624,7 @@ class Batch_test : public beast::unit_test::suite env.fund(XRP(10000), alice, bob); env.close(); - std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + std::uint32_t const aliceTicketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 10)); env.close(); @@ -3591,7 +3648,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "CheckCreate", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3687,7 +3744,7 @@ class Batch_test : public beast::unit_test::suite env(payTxn2, ter(terPRE_SEQ)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Payment", "tesSUCCESS", payTxn1ID, std::nullopt}, {1, "Batch", "tesSUCCESS", batchID, std::nullopt}, {2, "Payment", "tesSUCCESS", txIDs[0], batchID}, @@ -3698,7 +3755,7 @@ class Batch_test : public beast::unit_test::suite env.close(); { // next ledger includes the payment txn - std::vector testCases = { + std::vector const testCases = { {0, "Payment", "tesSUCCESS", payTxn2ID, std::nullopt}, }; validateClosedLedger(env, testCases); @@ -3910,7 +3967,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -3959,7 +4016,7 @@ class Batch_test : public beast::unit_test::suite batch::sig(bob)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "Payment", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -4009,7 +4066,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(pay(alice, bob, XRP(2)), seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "AccountSet", "tesSUCCESS", txIDs[0], batchID}, {2, "Payment", "tesSUCCESS", txIDs[1], batchID}, @@ -4029,8 +4086,8 @@ class Batch_test : public beast::unit_test::suite // MPTokenIssuanceSet with granular permission { test::jtx::Env env{*this, features}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(100000), alice, bob); env.close(); @@ -4071,7 +4128,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(jv2, seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "MPTokenIssuanceSet", "tesSUCCESS", txIDs[0], batchID}, {2, "MPTokenIssuanceSet", "tesSUCCESS", txIDs[1], batchID}, @@ -4084,9 +4141,9 @@ class Batch_test : public beast::unit_test::suite // with granular permission { test::jtx::Env env{*this, features}; - Account gw{"gw"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env(fset(gw, asfRequireAuth)); env.close(); @@ -4112,7 +4169,7 @@ class Batch_test : public beast::unit_test::suite batch::inner(jv2, seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "TrustSet", "tesSUCCESS", txIDs[0], batchID}, {2, "TrustSet", "tesSUCCESS", txIDs[1], batchID}, @@ -4123,9 +4180,9 @@ class Batch_test : public beast::unit_test::suite // inner transaction not authorized by the delegating account. { test::jtx::Env env{*this, features}; - Account gw{"gw"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env(fset(gw, asfRequireAuth)); env.close(); @@ -4152,11 +4209,15 @@ class Batch_test : public beast::unit_test::suite batch::inner(jv2, seq + 2)); env.close(); - std::vector testCases = { + std::vector const testCases = { {0, "Batch", "tesSUCCESS", batchID, std::nullopt}, {1, "TrustSet", "tesSUCCESS", txIDs[0], batchID}, + // jv2 fails with terNO_DELEGATE_PERMISSION. }; validateClosedLedger(env, testCases); + + // verify jv2 is not present in the closed ledger. + BEAST_EXPECT(env.rpc("tx", txIDs[1])[jss::result][jss::error] == "txnNotFound"); } } diff --git a/src/test/app/CheckMPT_test.cpp b/src/test/app/CheckMPT_test.cpp new file mode 100644 index 0000000000..cea5da5ed3 --- /dev/null +++ b/src/test/app/CheckMPT_test.cpp @@ -0,0 +1,2200 @@ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +namespace xrpl { + +class CheckMPT_test : public beast::unit_test::suite +{ + // Helper function that returns the Checks on an account. + static std::vector> + checksOnAccount(test::jtx::Env& env, test::jtx::Account account) + { + std::vector> result; + forEachItem(*env.current(), account, [&result](std::shared_ptr const& sle) { + if (sle && sle->getType() == ltCHECK) + result.push_back(sle); + }); + return result; + } + + // Helper function that verifies the expected DeliveredAmount is present. + // + // NOTE: the function _infers_ the transaction to operate on by calling + // env.tx(), which returns the result from the most recent transaction. + void + verifyDeliveredAmount(test::jtx::Env& env, STAmount const& amount) + { + // Get the hash for the most recent transaction. + std::string const txHash{env.tx()->getJson(JsonOptions::none)[jss::hash].asString()}; + + // Verify DeliveredAmount and delivered_amount metadata are correct. + env.close(); + Json::Value const meta = env.rpc("tx", txHash)[jss::result][jss::meta]; + + // Expect there to be a DeliveredAmount field. + if (!BEAST_EXPECT(meta.isMember(sfDeliveredAmount.jsonName))) + return; + + // DeliveredAmount and delivered_amount should both be present and + // equal amount. + BEAST_EXPECT(meta[sfDeliveredAmount.jsonName] == amount.getJson(JsonOptions::none)); + BEAST_EXPECT(meta[jss::delivered_amount] == amount.getJson(JsonOptions::none)); + } + + void + testCreateValid(FeatureBitset features) + { + // Explore many of the valid ways to create a check. + testcase("Create valid"); + + using namespace test::jtx; + + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + + Env env{*this, features}; + + STAmount const startBalance{XRP(1'000).value()}; + env.fund(startBalance, gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw}); + + // Note that no MPToken has been set up for alice, but alice can + // still write a check for USD. You don't have to have the funds + // necessary to cover a check in order to write a check. + auto writeTwoChecks = [&env, &USD, this](Account const& from, Account const& to) { + std::uint32_t const fromOwnerCount{ownerCount(env, from)}; + std::uint32_t const toOwnerCount{ownerCount(env, to)}; + + std::size_t const fromCkCount{checksOnAccount(env, from).size()}; + std::size_t const toCkCount{checksOnAccount(env, to).size()}; + + env(check::create(from, to, XRP(2000))); + env.close(); + + env(check::create(from, to, USD(50))); + env.close(); + + BEAST_EXPECT(checksOnAccount(env, from).size() == fromCkCount + 2); + BEAST_EXPECT(checksOnAccount(env, to).size() == toCkCount + 2); + + env.require(owners(from, fromOwnerCount + 2)); + env.require(owners(to, to == from ? fromOwnerCount + 2 : toOwnerCount)); + }; + // from to + writeTwoChecks(alice, bob); + writeTwoChecks(gw, alice); + writeTwoChecks(alice, gw); + + // Now try adding the various optional fields. There's no + // expected interaction between these optional fields; other than + // the expiration, they are just plopped into the ledger. So I'm + // not looking at interactions. + using namespace std::chrono_literals; + std::size_t const aliceCount{checksOnAccount(env, alice).size()}; + std::size_t const bobCount{checksOnAccount(env, bob).size()}; + env(check::create(alice, bob, USD(50)), expiration(env.now() + 1s)); + env.close(); + + env(check::create(alice, bob, USD(50)), source_tag(2)); + env.close(); + env(check::create(alice, bob, USD(50)), dest_tag(3)); + env.close(); + env(check::create(alice, bob, USD(50)), invoice_id(uint256{4})); + env.close(); + env(check::create(alice, bob, USD(50)), + expiration(env.now() + 1s), + source_tag(12), + dest_tag(13), + invoice_id(uint256{4})); + env.close(); + + BEAST_EXPECT(checksOnAccount(env, alice).size() == aliceCount + 5); + BEAST_EXPECT(checksOnAccount(env, bob).size() == bobCount + 5); + + // Use a regular key and also multisign to create a check. + Account const alie{"alie", KeyType::ed25519}; + env(regkey(alice, alie)); + env.close(); + + Account const bogie{"bogie", KeyType::secp256k1}; + Account const demon{"demon", KeyType::ed25519}; + env(signers(alice, 2, {{bogie, 1}, {demon, 1}}), sig(alie)); + env.close(); + + // alice uses her regular key to create a check. + env(check::create(alice, bob, USD(50)), sig(alie)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == aliceCount + 6); + BEAST_EXPECT(checksOnAccount(env, bob).size() == bobCount + 6); + + // alice uses multisigning to create a check. + XRPAmount const baseFeeDrops{env.current()->fees().base}; + env(check::create(alice, bob, USD(50)), msig(bogie, demon), fee(3 * baseFeeDrops)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == aliceCount + 7); + BEAST_EXPECT(checksOnAccount(env, bob).size() == bobCount + 7); + } + + void + testCreateDisallowIncoming(FeatureBitset features) + { + testcase("Create valid with disallow incoming"); + + using namespace test::jtx; + + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + + Env env{*this, features}; + + STAmount const startBalance{XRP(1'000).value()}; + env.fund(startBalance, gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw}); + + /* + * Attempt to create two checks from `from` to `to` and + * require they both result in error/success code `expected` + */ + auto writeTwoChecksDI = [&env, &USD, this]( + Account const& from, Account const& to, TER expected) { + std::uint32_t const fromOwnerCount{ownerCount(env, from)}; + std::uint32_t const toOwnerCount{ownerCount(env, to)}; + + std::size_t const fromCkCount{checksOnAccount(env, from).size()}; + std::size_t const toCkCount{checksOnAccount(env, to).size()}; + + env(check::create(from, to, XRP(2000)), ter(expected)); + env.close(); + + env(check::create(from, to, USD(50)), ter(expected)); + env.close(); + + if (expected == tesSUCCESS) + { + BEAST_EXPECT(checksOnAccount(env, from).size() == fromCkCount + 2); + BEAST_EXPECT(checksOnAccount(env, to).size() == toCkCount + 2); + + env.require(owners(from, fromOwnerCount + 2)); + env.require(owners(to, to == from ? fromOwnerCount + 2 : toOwnerCount)); + return; + } + + BEAST_EXPECT(checksOnAccount(env, from).size() == fromCkCount); + BEAST_EXPECT(checksOnAccount(env, to).size() == toCkCount); + + env.require(owners(from, fromOwnerCount)); + env.require(owners(to, to == from ? fromOwnerCount : toOwnerCount)); + }; + + // enable the DisallowIncoming flag on both bob and alice + env(fset(bob, asfDisallowIncomingCheck)); + env(fset(alice, asfDisallowIncomingCheck)); + env.close(); + + // both alice and bob can't receive checks + writeTwoChecksDI(alice, bob, tecNO_PERMISSION); + writeTwoChecksDI(gw, alice, tecNO_PERMISSION); + + // remove the flag from alice but not from bob + env(fclear(alice, asfDisallowIncomingCheck)); + env.close(); + + // now bob can send alice a cheque but not visa-versa + writeTwoChecksDI(bob, alice, tesSUCCESS); + writeTwoChecksDI(alice, bob, tecNO_PERMISSION); + + // remove bob's flag too + env(fclear(bob, asfDisallowIncomingCheck)); + env.close(); + + // now they can send checks freely + writeTwoChecksDI(bob, alice, tesSUCCESS); + writeTwoChecksDI(alice, bob, tesSUCCESS); + } + + void + testCreateInvalid(FeatureBitset features) + { + // Explore many of the invalid ways to create a check. + testcase("Create invalid"); + + using namespace test::jtx; + + Account const gw1{"gateway1"}; + Account const gwF{"gatewayFrozen"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + + Env env{*this, features}; + + STAmount const startBalance{XRP(1'000).value()}; + env.fund(startBalance, gw1, gwF, alice, bob); + + auto USDM = MPTTester({.env = env, .issuer = gw1, .flags = MPTDEXFlags | tfMPTCanLock}); + MPT const USD = USDM; + + // Bad fee. + env(check::create(alice, bob, USD(50)), fee(drops(-10)), ter(temBAD_FEE)); + env.close(); + + // Bad flags. + env(check::create(alice, bob, USD(50)), txflags(tfImmediateOrCancel), ter(temINVALID_FLAG)); + env.close(); + + // Check to self. + env(check::create(alice, alice, XRP(10)), ter(temREDUNDANT)); + env.close(); + + // Bad amount. + env(check::create(alice, bob, drops(-1)), ter(temBAD_AMOUNT)); + env.close(); + + env(check::create(alice, bob, drops(0)), ter(temBAD_AMOUNT)); + env.close(); + + env(check::create(alice, bob, drops(1))); + env.close(); + + env(check::create(alice, bob, USD(-1)), ter(temBAD_AMOUNT)); + env.close(); + + env(check::create(alice, bob, USD(0)), ter(temBAD_AMOUNT)); + env.close(); + + env(check::create(alice, bob, USD(1))); + env.close(); + { + MPT const BAD(makeMptID(0, xrpAccount())); + env(check::create(alice, bob, BAD(2)), ter(temBAD_CURRENCY)); + env.close(); + } + + // Bad expiration. + env(check::create(alice, bob, USD(50)), + expiration(NetClock::time_point{}), + ter(temBAD_EXPIRATION)); + env.close(); + + // Destination does not exist. + Account const bogie{"bogie"}; + env(check::create(alice, bogie, USD(50)), ter(tecNO_DST)); + env.close(); + + // Require destination tag. + env(fset(bob, asfRequireDest)); + env.close(); + + env(check::create(alice, bob, USD(50)), ter(tecDST_TAG_NEEDED)); + env.close(); + + env(check::create(alice, bob, USD(50)), dest_tag(11)); + env.close(); + + env(fclear(bob, asfRequireDest)); + env.close(); + { + // Globally frozen asset. + env.close(); + auto USFM = MPTTester({.env = env, .issuer = gwF, .flags = MPTDEXFlags | tfMPTCanLock}); + MPT const USF = USFM; + USFM.set({.flags = tfMPTLock}); + + env(check::create(alice, bob, USF(50)), ter(tecLOCKED)); + env.close(); + + USFM.set({.flags = tfMPTUnlock}); + + env(check::create(alice, bob, USF(50))); + env.close(); + } + { + // Frozen MPT. Check creation should be similar to payment + // behavior in the face of locked MPT. + USDM.authorizeHolders({alice, bob}); + env(pay(gw1, alice, USD(25))); + env(pay(gw1, bob, USD(25))); + env.close(); + + USDM.set({.holder = alice, .flags = tfMPTLock}); + // Setting MPT locked prevents alice from + // creating a check for USD ore receiving a check. This is different + // from IOU where alice can receive checks from bob or gw. + env.close(); + env(check::create(alice, bob, USD(50)), ter(tecLOCKED)); + env.close(); + // Note that IOU returns tecPATH_DRY in this case. + // IOU's internal error is terNO_LINE, which is + // considered ter re-triable and changed to tecPATH_DRY. + env(pay(alice, bob, USD(1)), ter(tecPATH_DRY)); + env.close(); + env(check::create(bob, alice, USD(50)), ter(tecLOCKED)); + env.close(); + env(pay(bob, alice, USD(1)), ter(tecPATH_DRY)); + env.close(); + env(check::create(gw1, alice, USD(50)), ter(tecLOCKED)); + env.close(); + env(pay(gw1, alice, USD(1))); + env.close(); + + // Clear that lock. Now check creation works. + USDM.set({.holder = alice, .flags = tfMPTUnlock}); + env(check::create(alice, bob, USD(50))); + env.close(); + env(check::create(bob, alice, USD(50))); + env.close(); + env(check::create(gw1, alice, USD(50))); + env.close(); + } + + // Expired expiration. + env(check::create(alice, bob, USD(50)), expiration(env.now()), ter(tecEXPIRED)); + env.close(); + + using namespace std::chrono_literals; + env(check::create(alice, bob, USD(50)), expiration(env.now() + 1s)); + env.close(); + + // Insufficient reserve. + Account const cheri{"cheri"}; + env.fund(env.current()->fees().accountReserve(1) - drops(1), cheri); + + env(check::create(cheri, bob, USD(50)), + fee(drops(env.current()->fees().base)), + ter(tecINSUFFICIENT_RESERVE)); + env.close(); + + env(pay(bob, cheri, drops(env.current()->fees().base + 1))); + env.close(); + + env(check::create(cheri, bob, USD(50))); + env.close(); + } + + void + testCashMPT(FeatureBitset features) + { + // Explore many of the valid ways to cash a check for an MPT. + testcase("Cash MPT"); + + using namespace test::jtx; + + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + { + // Simple MPT check cashed with Amount (with failures). + Env env{*this, features}; + + env.fund(XRP(1'000), gw, alice, bob); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .maxAmt = 105}); + + // alice writes the check before she gets the funds. + uint256 const chkId1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(100))); + env.close(); + + // bob attempts to cash the check. Should fail. + env(check::cash(bob, chkId1, USD(100)), ter(tecPATH_PARTIAL)); + env.close(); + + // alice gets almost enough funds. bob tries and fails again. + env(pay(gw, alice, USD(95))); + env.close(); + env(check::cash(bob, chkId1, USD(100)), ter(tecPATH_PARTIAL)); + env.close(); + + // alice gets the last of the necessary funds. + env(pay(gw, alice, USD(5))); + env.close(); + + // bob for more than the check's SendMax. + env.close(); + env(check::cash(bob, chkId1, USD(105)), ter(tecPATH_PARTIAL)); + env.close(); + + // bob asks for exactly the check amount and the check clears. + // MPT is authorized automatically + env(check::cash(bob, chkId1, USD(100))); + env.close(); + env.require(balance(alice, USD(0))); + env.require(balance(bob, USD(100))); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(checksOnAccount(env, bob).empty()); + BEAST_EXPECT(ownerCount(env, alice) == 1); + BEAST_EXPECT(ownerCount(env, bob) == 1); + + // bob tries to cash the same check again, which fails. + env(check::cash(bob, chkId1, USD(100)), ter(tecNO_ENTRY)); + env.close(); + + // bob pays alice USD(70) so he can try another case. + env(pay(bob, alice, USD(70))); + env.close(); + + uint256 const chkId2{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(70))); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 1); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 1); + + // bob cashes the check for less than the face amount. That works, + // consumes the check, and bob receives as much as he asked for. + env(check::cash(bob, chkId2, USD(50))); + env.close(); + env.require(balance(alice, USD(20))); + env.require(balance(bob, USD(80))); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(checksOnAccount(env, bob).empty()); + BEAST_EXPECT(ownerCount(env, alice) == 1); + BEAST_EXPECT(ownerCount(env, bob) == 1); + + // alice writes two checks for USD(20), although she only has + // USD(20). + uint256 const chkId3{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(20))); + env.close(); + uint256 const chkId4{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(20))); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 2); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 2); + + // bob cashes the second check for the face amount. + env(check::cash(bob, chkId4, USD(20))); + env.close(); + env.require(balance(alice, USD(0))); + env.require(balance(bob, USD(100))); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 1); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 1); + BEAST_EXPECT(ownerCount(env, alice) == 2); + BEAST_EXPECT(ownerCount(env, bob) == 1); + + // bob is not allowed to cash the last check for USD(0), he must + // use check::cancel instead. + env(check::cash(bob, chkId3, USD(0)), ter(temBAD_AMOUNT)); + env.close(); + env.require(balance(alice, USD(0))); + env.require(balance(bob, USD(100))); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 1); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 1); + BEAST_EXPECT(ownerCount(env, alice) == 2); + BEAST_EXPECT(ownerCount(env, bob) == 1); + + { + // Unlike IOU, cashing a check exceeding the MPT limit doesn't + // work. Show that at work. + // + // MPT limit is USD(105). Show that + // neither a payment to bob or caching can exceed that limit. + + // Payment of 200 USD fails. + env(pay(gw, bob, USD(200)), ter(tecPATH_PARTIAL)); + env.close(); + + uint256 const chkId20{getCheckIndex(gw, env.seq(gw))}; + env(check::create(gw, bob, USD(200))); + env.close(); + + // Cashing a check for 200 USD fails. + env(check::cash(bob, chkId20, USD(200)), ter(tecPATH_PARTIAL)); + env.close(); + env.require(balance(bob, USD(100))); + + // Clean up this most recent experiment so the rest of the + // tests work. + env(pay(bob, gw, USD(100))); + env(check::cancel(bob, chkId20)); + } + + // ... so bob cancels alice's remaining check. + env(check::cancel(bob, chkId3)); + env.close(); + env.require(balance(alice, USD(0))); + env.require(balance(bob, USD(0))); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(checksOnAccount(env, bob).empty()); + BEAST_EXPECT(ownerCount(env, alice) == 1); + BEAST_EXPECT(ownerCount(env, bob) == 1); + } + { + // Simple MPT check cashed with DeliverMin (with failures). + Env env{*this, features}; + + env.fund(XRP(1'000), gw, alice, bob); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 20}); + + env(pay(gw, alice, USD(8))); + env.close(); + + // alice creates several checks ahead of time. + uint256 const chkId9{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(9))); + env.close(); + uint256 const chkId8{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(8))); + env.close(); + uint256 const chkId7{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(7))); + env.close(); + uint256 const chkId6{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(6))); + env.close(); + + // bob attempts to cash a check for the amount on the check. + // Should fail, since alice doesn't have the funds. + env(check::cash(bob, chkId9, check::DeliverMin(USD(9))), ter(tecPATH_PARTIAL)); + env.close(); + + // bob sets a DeliverMin of 7 and gets all that alice has. + env(check::cash(bob, chkId9, check::DeliverMin(USD(7)))); + verifyDeliveredAmount(env, USD(8)); + env.require(balance(alice, USD(0))); + env.require(balance(bob, USD(8))); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 3); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 3); + BEAST_EXPECT(ownerCount(env, alice) == 4); + BEAST_EXPECT(ownerCount(env, bob) == 1); + + // bob pays alice USD(7) so he can use another check. + env(pay(bob, alice, USD(7))); + env.close(); + + // Using DeliverMin for the SendMax value of the check (and no + // transfer fees) should work just like setting Amount. + env(check::cash(bob, chkId7, check::DeliverMin(USD(7)))); + verifyDeliveredAmount(env, USD(7)); + env.require(balance(alice, USD(0))); + env.require(balance(bob, USD(8))); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 2); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 2); + BEAST_EXPECT(ownerCount(env, alice) == 3); + BEAST_EXPECT(ownerCount(env, bob) == 1); + + // bob pays alice USD(8) so he can use the last two checks. + env(pay(bob, alice, USD(8))); + env.close(); + + // alice has USD(8). If bob uses the check for USD(6) and uses a + // DeliverMin of 4, he should get the SendMax value of the check. + env(check::cash(bob, chkId6, check::DeliverMin(USD(4)))); + verifyDeliveredAmount(env, USD(6)); + env.require(balance(alice, USD(2))); + env.require(balance(bob, USD(6))); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 1); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 1); + BEAST_EXPECT(ownerCount(env, alice) == 2); + BEAST_EXPECT(ownerCount(env, bob) == 1); + + // bob cashes the last remaining check setting a DeliverMin. + // of exactly alice's remaining USD. + env(check::cash(bob, chkId8, check::DeliverMin(USD(2)))); + verifyDeliveredAmount(env, USD(2)); + env.require(balance(alice, USD(0))); + env.require(balance(bob, USD(8))); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(checksOnAccount(env, bob).empty()); + BEAST_EXPECT(ownerCount(env, alice) == 1); + BEAST_EXPECT(ownerCount(env, bob) == 1); + } + { + // Examine the effects of the asfRequireAuth flag. + Env env(*this, features); + + env.fund(XRP(1000), gw, alice, bob); + auto USDM = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .flags = MPTDEXFlags | tfMPTRequireAuth, + .maxAmt = 20}); + MPT const USD = USDM; + USDM.authorize({.holder = alice}); + env.close(); + env(pay(gw, alice, USD(8))); + env.close(); + + // alice writes a check to bob for USD. bob can't cash it + // because he is not authorized to hold gw["USD"]. + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(7))); + env.close(); + + env(check::cash(bob, chkId, USD(7)), ter(tecNO_AUTH)); + env.close(); + + // Now give bob MPT for USD. bob still can't cash the + // check because he is not authorized. + USDM.authorize({.account = bob}); + env.close(); + + env(check::cash(bob, chkId, USD(7)), ter(tecNO_AUTH)); + env.close(); + + // bob gets authorization to hold USD. + USDM.authorize({.holder = bob}); + env.close(); + + env(check::cash(bob, chkId, check::DeliverMin(USD(4)))); + STAmount const bobGot = USD(7); + verifyDeliveredAmount(env, bobGot); + env.require(balance(alice, USD(8) - bobGot)); + env.require(balance(bob, bobGot)); + + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(checksOnAccount(env, bob).empty()); + BEAST_EXPECT(ownerCount(env, alice) == 1); + BEAST_EXPECT(ownerCount(env, bob) == 1); + } + + { + Env env{*this, features}; + + env.fund(XRP(1'000), gw, alice, bob); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 20}); + + // alice creates her checks ahead of time. + uint256 const chkId1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(1))); + env.close(); + + uint256 const chkId2{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(2))); + env.close(); + + env(pay(gw, alice, USD(8))); + env.close(); + + // Give bob a regular key and signers + Account const bobby{"bobby", KeyType::secp256k1}; + env(regkey(bob, bobby)); + env.close(); + + Account const bogie{"bogie", KeyType::secp256k1}; + Account const demon{"demon", KeyType::ed25519}; + env(signers(bob, 2, {{bogie, 1}, {demon, 1}}), sig(bobby)); + env.close(); + + int const signersCount = 1; + BEAST_EXPECT(ownerCount(env, bob) == signersCount + 1); + + // bob uses his regular key to cash a check. + env(check::cash(bob, chkId1, (USD(1))), sig(bobby)); + env.close(); + env.require(balance(alice, USD(7))); + env.require(balance(bob, USD(1))); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 1); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 1); + BEAST_EXPECT(ownerCount(env, alice) == 2); + BEAST_EXPECT(ownerCount(env, bob) == signersCount + 1); + + // bob uses multisigning to cash a check. + XRPAmount const baseFeeDrops{env.current()->fees().base}; + env(check::cash(bob, chkId2, (USD(2))), msig(bogie, demon), fee(3 * baseFeeDrops)); + env.close(); + env.require(balance(alice, USD(5))); + env.require(balance(bob, USD(3))); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(checksOnAccount(env, bob).empty()); + BEAST_EXPECT(ownerCount(env, alice) == 1); + BEAST_EXPECT(ownerCount(env, bob) == signersCount + 1); + } + } + + void + testCashXferFee(FeatureBitset features) + { + // Look at behavior when the issuer charges a transfer fee. + testcase("Cash with transfer fee"); + + using namespace test::jtx; + + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + + Env env{*this, features}; + + env.fund(XRP(1'000), gw, alice, bob); + + // Set gw's transfer rate and see the consequences when cashing a check. + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .transferFee = 25'000, + .maxAmt = 1'000}); + + env.close(); + env(pay(gw, alice, USD(1'000))); + env.close(); + + // alice writes a check with a SendMax of USD(125). The most bob + // can get is USD(100) because of the transfer rate. + uint256 const chkId125{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(125))); + env.close(); + + // alice writes another check that won't get cashed until the transfer + // rate changes so we can see the rate applies when the check is + // cashed, not when it is created. +#if 0 + uint256 const chkId120{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(120))); + env.close(); +#endif + + // bob attempts to cash the check for face value. Should fail. + env(check::cash(bob, chkId125, USD(125)), ter(tecPATH_PARTIAL)); + env.close(); + env(check::cash(bob, chkId125, check::DeliverMin(USD(101))), ter(tecPATH_PARTIAL)); + env.close(); + + // bob decides that he'll accept anything USD(75) or up. + // He gets USD(100). + env(check::cash(bob, chkId125, check::DeliverMin(USD(75)))); + verifyDeliveredAmount(env, USD(100)); + env.require(balance(alice, USD(1'000 - 125))); + env.require(balance(bob, USD(0 + 100))); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(checksOnAccount(env, bob).empty()); + +#if 0 + // Adjust gw's rate... + env(rate(gw, 1.2)); + env.close(); + + // bob cashes the second check for less than the face value. The new + // rate applies to the actual value transferred. + env(check::cash(bob, chkId120, USD(50))); + env.close(); + env.require(balance(alice, USD(1000 - 125 - 60))); + env.require(balance(bob, USD(0 + 100 + 50))); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 0); + BEAST_EXPECT(checksOnAccount(env, bob).size() == 0); +#endif + } + + void + testCashInvalid(FeatureBitset features) + { + // Explore many of the ways to fail at cashing a check. + testcase("Cash invalid"); + + using namespace test::jtx; + + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const zoe{"zoe"}; + std::int64_t maxAmt{20}; + + Env env(*this, features); + + env.fund(XRP(1000), gw, alice, bob, zoe); + + auto USDM = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .flags = MPTDEXFlags | tfMPTCanLock, + .maxAmt = maxAmt}); + MPT const USD = USDM; + + env(pay(gw, alice, USD(20))); + env.close(); + + USDM.authorize({.account = bob}); + + // bob tries to cash a non-existent check from alice. + { + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::cash(bob, chkId, USD(20)), ter(tecNO_ENTRY)); + env.close(); + } + + // alice creates her checks ahead of time. + uint256 const chkIdU{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(20))); + env.close(); + + uint256 const chkIdX{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, XRP(10))); + env.close(); + + using namespace std::chrono_literals; + uint256 const chkIdExp{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, XRP(10)), expiration(env.now() + 1s)); + env.close(); + + uint256 const chkIdFroz1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(1))); + env.close(); + + uint256 const chkIdFroz2{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(2))); + env.close(); + + uint256 const chkIdFroz3{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(3))); + env.close(); + + uint256 const chkIdNoDest1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(1))); + env.close(); + + uint256 const chkIdHasDest2{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(2)), dest_tag(7)); + env.close(); + + // Same set of failing cases for both MPT and XRP check cashing. + auto failingCases = [&env, &gw, &alice, &bob]( + uint256 const& chkId, STAmount const& amount) { + // Bad fee. + env(check::cash(bob, chkId, amount), fee(drops(-10)), ter(temBAD_FEE)); + env.close(); + + // Bad flags. + env(check::cash(bob, chkId, amount), + txflags(tfImmediateOrCancel), + ter(temINVALID_FLAG)); + env.close(); + + // Missing both Amount and DeliverMin. + { + Json::Value tx{check::cash(bob, chkId, amount)}; + tx.removeMember(sfAmount.jsonName); + env(tx, ter(temMALFORMED)); + env.close(); + } + // Both Amount and DeliverMin present. + { + Json::Value tx{check::cash(bob, chkId, amount)}; + tx[sfDeliverMin.jsonName] = amount.getJson(JsonOptions::none); + env(tx, ter(temMALFORMED)); + env.close(); + } + + // Negative or zero amount. + { + STAmount neg{amount}; + neg.negate(); + env(check::cash(bob, chkId, neg), ter(temBAD_AMOUNT)); + env.close(); + env(check::cash(bob, chkId, amount.zeroed()), ter(temBAD_AMOUNT)); + env.close(); + } + + // Bad currency. + if (!amount.native()) + { + Issue const badIssue{badCurrency(), amount.getIssuer()}; + STAmount badAmount{amount}; + badAmount.setIssue(Issue{badCurrency(), amount.getIssuer()}); + env(check::cash(bob, chkId, badAmount), ter(temBAD_CURRENCY)); + env.close(); + } + + // Not destination cashing check. + env(check::cash(alice, chkId, amount), ter(tecNO_PERMISSION)); + env.close(); + env(check::cash(gw, chkId, amount), ter(tecNO_PERMISSION)); + env.close(); + + // Currency mismatch. + { + MPT const EUR = MPTTester({.env = env, .issuer = gw}); + STAmount const badAmount{EUR, amount}; + env(check::cash(bob, chkId, badAmount), ter(temMALFORMED)); + env.close(); + } + + // Issuer mismatch. + // Every MPT is unique. There is no USD MPT with different issuers. + + // Amount bigger than SendMax. + env(check::cash(bob, chkId, amount + amount), ter(tecPATH_PARTIAL)); + env.close(); + + // DeliverMin bigger than SendMax. + env(check::cash(bob, chkId, check::DeliverMin(amount + amount)), ter(tecPATH_PARTIAL)); + env.close(); + }; + + failingCases(chkIdX, XRP(10)); + failingCases(chkIdU, USD(20)); + + // Verify that those two checks really were cashable. + env(check::cash(bob, chkIdU, USD(20))); + env.close(); + env(check::cash(bob, chkIdX, check::DeliverMin(XRP(10)))); + verifyDeliveredAmount(env, XRP(10)); + + // Try to cash an expired check. + env(check::cash(bob, chkIdExp, XRP(10)), ter(tecEXPIRED)); + env.close(); + + // Cancel the expired check. Anyone can cancel an expired check. + env(check::cancel(zoe, chkIdExp)); + env.close(); + + // Can we cash a check with frozen MPT? + { + env(pay(bob, alice, USD(20))); + env.close(); + env.require(balance(alice, USD(20))); + env.require(balance(bob, USD(0))); + + // Global freeze + USDM.set({.flags = tfMPTLock}); + + // MPTLocked flag is set and the account is not the issuer of MPT + env(check::cash(bob, chkIdFroz1, USD(1)), ter(tecPATH_PARTIAL)); + env.close(); + env(check::cash(bob, chkIdFroz1, check::DeliverMin(USD(1))), ter(tecPATH_PARTIAL)); + env.close(); + + USDM.set({.flags = tfMPTUnlock}); + + // No longer frozen. Success. + env(check::cash(bob, chkIdFroz1, USD(1))); + env.close(); + env.require(balance(alice, USD(19))); + env.require(balance(bob, USD(1))); + + // Freeze individual MPT. + USDM.set({.holder = alice, .flags = tfMPTLock}); + env(check::cash(bob, chkIdFroz2, USD(2)), ter(tecPATH_PARTIAL)); + env.close(); + env(check::cash(bob, chkIdFroz2, check::DeliverMin(USD(1))), ter(tecPATH_PARTIAL)); + env.close(); + + // Clear that freeze. Now check cashing works. + USDM.set({.holder = alice, .flags = tfMPTUnlock}); + env(check::cash(bob, chkIdFroz2, USD(2))); + env.close(); + env.require(balance(alice, USD(17))); + env.require(balance(bob, USD(3))); + + // Freeze bob's MPT. bob can't cash the check. + USDM.set({.holder = bob, .flags = tfMPTLock}); + env(check::cash(bob, chkIdFroz3, USD(3)), ter(tecLOCKED)); + env.close(); + env(check::cash(bob, chkIdFroz3, check::DeliverMin(USD(1))), ter(tecLOCKED)); + env.close(); + + // Clear that freeze. Now check cashing works again. + USDM.set({.holder = bob, .flags = tfMPTUnlock}); + env.close(); + env(check::cash(bob, chkIdFroz3, check::DeliverMin(USD(1)))); + verifyDeliveredAmount(env, USD(3)); + env.require(balance(alice, USD(14))); + env.require(balance(bob, USD(6))); + } + { + // Set the RequireDest flag on bob's account (after the check + // was created) then cash a check without a destination tag. + env(fset(bob, asfRequireDest)); + env.close(); + env(check::cash(bob, chkIdNoDest1, USD(1)), ter(tecDST_TAG_NEEDED)); + env.close(); + env(check::cash(bob, chkIdNoDest1, check::DeliverMin(USD(1))), ter(tecDST_TAG_NEEDED)); + env.close(); + + // bob can cash a check with a destination tag. + env(check::cash(bob, chkIdHasDest2, USD(2))); + env.close(); + + env.require(balance(alice, USD(12))); + env.require(balance(bob, USD(8))); + + // Clear the RequireDest flag on bob's account so he can + // cash the check with no DestinationTag. + env(fclear(bob, asfRequireDest)); + env.close(); + env(check::cash(bob, chkIdNoDest1, USD(1))); + env.close(); + env.require(balance(alice, USD(11))); + env.require(balance(bob, USD(9))); + } + + // OutstandingAmount exceeds MaximumAmount + { + // Already at maximum + BEAST_EXPECT(env.balance(gw, USDM) == USDM(-maxAmt)); + + uint256 const chkId{getCheckIndex(gw, env.seq(gw))}; + env(check::create(gw, bob, USDM(10))); + env.close(); + + // Exceeds MaximumAmount (20 + 10) = 30 > 20 + env(check::cash(bob, chkId, USDM(10)), ter(tecPATH_PARTIAL)); + env.close(); + + // Redeem some tokens (20 - 9) = 11 + env(pay(alice, gw, USDM(9))); + env.close(); + + // Still exceeds MaximumAmount (11 + 10) = 21 > 20 + env(check::cash(bob, chkId, USDM(10)), ter(tecPATH_PARTIAL)); + env.close(); + } + } + + void + testCancelValid(FeatureBitset features) + { + // Explore many of the ways to cancel a check. + testcase("Cancel valid"); + + using namespace test::jtx; + + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const zoe{"zoe"}; + + { + Env env{*this, features}; + + env.fund(XRP(1'000), gw, alice, bob, zoe); + + MPT const USD = MPTTester({.env = env, .issuer = gw}); + + // alice creates her checks ahead of time. + // Three ordinary checks with no expiration. + uint256 const chkId1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(10))); + env.close(); + + uint256 const chkId2{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, XRP(10))); + env.close(); + + uint256 const chkId3{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(10))); + env.close(); + + // Three checks that expire in 10 minutes. + using namespace std::chrono_literals; + uint256 const chkIdNotExp1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, XRP(10)), expiration(env.now() + 600s)); + env.close(); + + uint256 const chkIdNotExp2{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(10)), expiration(env.now() + 600s)); + env.close(); + + uint256 const chkIdNotExp3{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, XRP(10)), expiration(env.now() + 600s)); + env.close(); + + // Three checks that expire in one second. + uint256 const chkIdExp1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(10)), expiration(env.now() + 1s)); + env.close(); + + uint256 const chkIdExp2{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, XRP(10)), expiration(env.now() + 1s)); + env.close(); + + uint256 const chkIdExp3{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(10)), expiration(env.now() + 1s)); + env.close(); + + // Two checks to cancel using a regular key and using multisigning. + uint256 const chkIdReg{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, USD(10))); + env.close(); + + uint256 const chkIdMSig{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, XRP(10))); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 11); + BEAST_EXPECT(ownerCount(env, alice) == 11); + + // Creator, destination, and an outsider cancel the checks. + env(check::cancel(alice, chkId1)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 10); + BEAST_EXPECT(ownerCount(env, alice) == 10); + + env(check::cancel(bob, chkId2)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 9); + BEAST_EXPECT(ownerCount(env, alice) == 9); + + env(check::cancel(zoe, chkId3), ter(tecNO_PERMISSION)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 9); + BEAST_EXPECT(ownerCount(env, alice) == 9); + + // Creator, destination, and an outsider cancel unexpired checks. + env(check::cancel(alice, chkIdNotExp1)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 8); + BEAST_EXPECT(ownerCount(env, alice) == 8); + + env(check::cancel(bob, chkIdNotExp2)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 7); + BEAST_EXPECT(ownerCount(env, alice) == 7); + + env(check::cancel(zoe, chkIdNotExp3), ter(tecNO_PERMISSION)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 7); + BEAST_EXPECT(ownerCount(env, alice) == 7); + + // Creator, destination, and an outsider cancel expired checks. + env(check::cancel(alice, chkIdExp1)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 6); + BEAST_EXPECT(ownerCount(env, alice) == 6); + + env(check::cancel(bob, chkIdExp2)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 5); + BEAST_EXPECT(ownerCount(env, alice) == 5); + + env(check::cancel(zoe, chkIdExp3)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 4); + BEAST_EXPECT(ownerCount(env, alice) == 4); + + // Use a regular key and also multisign to cancel checks. + Account const alie{"alie", KeyType::ed25519}; + env(regkey(alice, alie)); + env.close(); + + Account const bogie{"bogie", KeyType::secp256k1}; + Account const demon{"demon", KeyType::ed25519}; + env(signers(alice, 2, {{bogie, 1}, {demon, 1}}), sig(alie)); + env.close(); + + int const signersCount{1}; + + // alice uses her regular key to cancel a check. + env(check::cancel(alice, chkIdReg), sig(alie)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 3); + BEAST_EXPECT(ownerCount(env, alice) == signersCount + 3); + + // alice uses multisigning to cancel a check. + XRPAmount const baseFeeDrops{env.current()->fees().base}; + env(check::cancel(alice, chkIdMSig), msig(bogie, demon), fee(3 * baseFeeDrops)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 2); + BEAST_EXPECT(ownerCount(env, alice) == signersCount + 2); + + // Creator and destination cancel the remaining unexpired checks. + env(check::cancel(alice, chkId3), sig(alice)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 1); + BEAST_EXPECT(ownerCount(env, alice) == signersCount + 1); + + env(check::cancel(bob, chkIdNotExp3)); + env.close(); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(ownerCount(env, alice) == signersCount + 0); + } + } + + void + testWithTickets(FeatureBitset features) + { + testcase("With Tickets"); + + using namespace test::jtx; + + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, bob); + env.close(); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 1'000}); + + // alice and bob grab enough tickets for all the following + // transactions. Note that once the tickets are acquired alice's + // and bob's account sequence numbers should not advance. + std::uint32_t aliceTicketSeq{env.seq(alice) + 1}; + env(ticket::create(alice, 10)); + std::uint32_t const aliceSeq{env.seq(alice)}; + + std::uint32_t bobTicketSeq{env.seq(bob) + 1}; + env(ticket::create(bob, 10)); + std::uint32_t const bobSeq{env.seq(bob)}; + + env.close(); + // MPT + 10 tickets + env.require(owners(alice, 11)); + env.require(owners(bob, 11)); + + env.require(tickets(alice, env.seq(alice) - aliceTicketSeq)); + BEAST_EXPECT(env.seq(alice) == aliceSeq); + + env.require(tickets(bob, env.seq(bob) - bobTicketSeq)); + BEAST_EXPECT(env.seq(bob) == bobSeq); + + env(pay(gw, alice, USD(900))); + env.close(); + + // alice creates four checks; two XRP, two MPT. Bob will cash + // one of each and cancel one of each. + uint256 const chkIdXrp1{getCheckIndex(alice, aliceTicketSeq)}; + env(check::create(alice, bob, XRP(200)), ticket::use(aliceTicketSeq++)); + + uint256 const chkIdXrp2{getCheckIndex(alice, aliceTicketSeq)}; + env(check::create(alice, bob, XRP(300)), ticket::use(aliceTicketSeq++)); + + uint256 const chkIdUsd1{getCheckIndex(alice, aliceTicketSeq)}; + env(check::create(alice, bob, USD(200)), ticket::use(aliceTicketSeq++)); + + uint256 const chkIdUsd2{getCheckIndex(alice, aliceTicketSeq)}; + env(check::create(alice, bob, USD(300)), ticket::use(aliceTicketSeq++)); + + env.close(); + // Alice used four tickets but created four checks. + env.require(owners(alice, 11)); + env.require(tickets(alice, env.seq(alice) - aliceTicketSeq)); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 4); + BEAST_EXPECT(env.seq(alice) == aliceSeq); + + env.require(owners(bob, 11)); + BEAST_EXPECT(env.seq(bob) == bobSeq); + + // Bob cancels two of alice's checks. + env(check::cancel(bob, chkIdXrp1), ticket::use(bobTicketSeq++)); + env(check::cancel(bob, chkIdUsd2), ticket::use(bobTicketSeq++)); + env.close(); + + env.require(owners(alice, 9)); + env.require(tickets(alice, env.seq(alice) - aliceTicketSeq)); + BEAST_EXPECT(checksOnAccount(env, alice).size() == 2); + BEAST_EXPECT(env.seq(alice) == aliceSeq); + + env.require(owners(bob, 9)); + BEAST_EXPECT(env.seq(bob) == bobSeq); + + // Bob cashes alice's two remaining checks. + env(check::cash(bob, chkIdXrp2, XRP(300)), ticket::use(bobTicketSeq++)); + env(check::cash(bob, chkIdUsd1, USD(200)), ticket::use(bobTicketSeq++)); + env.close(); + + auto const baseFee = env.current()->fees().base; + env.require(owners(alice, 7)); + env.require(tickets(alice, env.seq(alice) - aliceTicketSeq)); + BEAST_EXPECT(checksOnAccount(env, alice).empty()); + BEAST_EXPECT(env.seq(alice) == aliceSeq); + env.require(balance(alice, USD(700))); + env.require(balance(alice, XRP(700) - 6 * baseFee)); + env.require(owners(bob, 7)); + BEAST_EXPECT(env.seq(bob) == bobSeq); + env.require(balance(bob, USD(200))); + env.require(balance(bob, XRP(1'300) - 6 * baseFee)); + } + + void + testMPTCreation(FeatureBitset features) + { + // Explore automatic MPT creation when a check is cashed. + + testcase("MPT Creation"); + + using namespace test::jtx; + + Env env{*this, features}; + + // An account that independently tracks its owner count. + struct AccountOwns + { + using iterator = hash_map::iterator; + beast::unit_test::suite& suite; + Env& env; + Account const acct; + std::size_t owners{0}; + hash_map mpts; + bool const isIssuer; + bool const requireAuth; + + AccountOwns( + beast::unit_test::suite& s, + Env& e, + Account const& a, + bool isIssuer_, + bool requireAuth_ = false) + : suite(s), env(e), acct(a), isIssuer(isIssuer_), requireAuth(requireAuth_) + { + } + + void + verifyOwners(std::uint32_t line, bool print = false) const + { + if (print) + { + std::cout << acct.name() << " " << ownerCount(env, acct) << " " << owners + << std::endl; + } + suite.expect( + ownerCount(env, acct) == owners, "Owner count mismatch", __FILE__, line); + } + + // Operators to make using the class more convenient. + operator Account() const + { + return acct; + } + + operator xrpl::AccountID() const + { + return acct.id(); + } + + /** Create MPTTester if it doesn't exist for the given MPT. + * Increment owners if created since it creates MPTokenIssuance + */ + MPT + operator[](std::string const& s) + { + if (!isIssuer) + Throw("AccountOwns: must be issuer"); + if (auto const& it = mpts.find(s); it != mpts.end()) + return it->second[s]; + auto flags = MPTDEXFlags | tfMPTCanLock; + if (requireAuth) + flags |= tfMPTRequireAuth; + auto [it, _] = + mpts.emplace(s, MPTTester({.env = env, .issuer = acct, .flags = flags})); + (void)_; + ++owners; + + return it->second[s]; + } + + iterator + getIt(MPT const& mpt) + { + if (!isIssuer) + Throw("AccountOwns::set must be issuer"); + auto it = mpts.find(mpt.name); + if (it == mpts.end()) + Throw("AccountOwns::set mpt doesn't exist"); + return it; + } + + void + set(MPT const& mpt, std::uint32_t flag) + { + auto it = getIt(mpt); + it->second.set({.flags = flag}); + } + + void + authorize(MPT const& mpt, AccountOwns& id) + { + auto it = getIt(mpt); + it->second.authorize({.account = id}); + ++id.owners; + } + + void + cleanup(MPT const& mpt, AccountOwns& id) + { + auto it = getIt(mpt); + // redeem to the issuer + if (auto const redeem = it->second.getBalance(id)) + pay(it, id, acct, redeem); + // delete mptoken + it->second.authorize({.account = id, .flags = tfMPTUnauthorize}); + --id.owners; + } + + void + pay(iterator& it, Account const& src, Account const& dst, std::uint64_t amount) + { + if (env.le(keylet::account(dst))->isFlag(lsfDepositAuth)) + { + env(fclear(dst, asfDepositAuth)); + it->second.pay(src, dst, amount); + env(fset(dst, asfDepositAuth)); + } + else + { + it->second.pay(src, dst, amount); + } + } + + void + pay(Account const& src, Account const& dst, PrettyAmount amount) + { + auto it = getIt(amount.name()); + pay(it, src, dst, amount.value().mpt().value()); + } + }; + + AccountOwns alice{*this, env, "alice", false}; + AccountOwns bob{*this, env, "bob", false}; + AccountOwns gw1{*this, env, "gw1", true}; + + // Fund with noripple so the accounts do not have any flags set. + env.fund(XRP(5000), noripple(alice, bob)); + env.close(); + + // Automatic MPT creation should fail if the check destination + // can't afford the reserve for the trust line. + { + // Fund gw1 with noripple (even though that's atypical for a + // gateway) so it does not have any flags set. We'll set flags + // on gw1 later. + env.fund(XRP(5'000), noripple(gw1)); + env.close(); + + MPT const CK8 = gw1["CK8"]; + gw1.verifyOwners(__LINE__); + + Account const yui{"yui"}; + + // Note the reserve in unit tests is 200 XRP, not 20. So here + // we're just barely giving yui enough XRP to meet the + // account reserve. + env.fund(XRP(200), yui); + env.close(); + + uint256 const chkId{getCheckIndex(gw1, env.seq(gw1))}; + env(check::create(gw1, yui, CK8(99))); + env.close(); + + env(check::cash(yui, chkId, CK8(99)), ter(tecINSUFFICIENT_RESERVE)); + env.close(); + alice.verifyOwners(__LINE__); + + // Give yui enough XRP to meet the trust line's reserve. Cashing + // the check succeeds and creates the trust line. + env(pay(env.master, yui, XRP(51))); + env.close(); + env(check::cash(yui, chkId, CK8(99))); + verifyDeliveredAmount(env, CK8(99)); + env.close(); + BEAST_EXPECT(ownerCount(env, yui) == 1); + + // The automatic trust line does not take a reserve from gw1. + // Since gw1's check was consumed it has no owners. + gw1.verifyOwners(__LINE__); + } + + // We'll be looking at the effects of various account root flags and + // MPT flags. + + // Automatically create MPT using + // o Offers and + // o Check cashing + + //----------- No account root flags, check written by issuer ----------- + { + // No account root flags on any participant. + // Automatic trust line from issuer to destination. + + BEAST_EXPECT((*env.le(gw1))[sfFlags] == 0); + BEAST_EXPECT((*env.le(alice))[sfFlags] == 0); + BEAST_EXPECT((*env.le(bob))[sfFlags] == 0); + + // Use offers to automatically create MPT + MPT const OF1 = gw1["OF1"]; + env(offer(gw1, XRP(98), OF1(98))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF1.issuanceID, alice)) == nullptr); + env(offer(alice, OF1(98), XRP(98))); + ++alice.owners; + env.close(); + + // Both offers should be consumed. + // Since gw1's offer was consumed and the trust line was not + // created by gw1, gw1's owner count should be 0. + gw1.verifyOwners(__LINE__); + + // alice's automatically created MPT bumps her owner count. + alice.verifyOwners(__LINE__); + + // Use check cashing to automatically create the trust line. + MPT const CK1 = gw1["CK1"]; + uint256 const chkId{getCheckIndex(gw1, env.seq(gw1))}; + env(check::create(gw1, alice, CK1(98))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK1.issuanceID, alice)) == nullptr); + env(check::cash(alice, chkId, CK1(98))); + ++alice.owners; + verifyDeliveredAmount(env, CK1(98)); + env.close(); + + // gw1's check should be consumed. + // Since gw1's check was consumed and the trust line was not + // created by gw1, gw1's owner count should be 0. + gw1.verifyOwners(__LINE__); + + // alice's automatically created trust line bumps her owner count. + alice.verifyOwners(__LINE__); + + // cmpTrustLines(gw1, alice, OF1, CK1); + } + //--------- No account root flags, check written by non-issuer --------- + { + // No account root flags on any participant. + + // Use offers to automatically create MPT. + // Transfer of assets using offers does not require rippling. + // So bob's offer is successfully crossed which creates MPT. + MPT const OF1 = gw1["OF1"]; + env(offer(alice, XRP(97), OF1(97))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF1, bob)) == nullptr); + env(offer(bob, OF1(97), XRP(97))); + ++bob.owners; + env.close(); + + // Both offers should be consumed. + env.require(balance(alice, OF1(1))); + env.require(balance(bob, OF1(97))); + + // bob now has an owner count of 1 due to new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + // + // Unlike IOU where cashing a check (unlike crossing offers) + // requires rippling through the currency's issuer, rippling doesn't + // impact MPT. Even though gw1 does not have rippling enabled, the + // check cash succeeds for MPT and MPT is created. + MPT const CK1 = gw1["CK1"]; + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, CK1(97))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK1, bob)) == nullptr); + env(check::cash(bob, chkId, CK1(97))); + ++bob.owners; + env.close(); + + BEAST_EXPECT(env.le(keylet::mptoken(OF1, bob)) != nullptr); + + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + } + + //------------- lsfDefaultRipple, check written by issuer -------------- + { + // gw1 enables rippling. + // This doesn't impact automatic MPT creation. + env(fset(gw1, asfDefaultRipple)); + env.close(); + + // Use offers to automatically create the trust line. + MPT const OF2 = gw1["OF2"]; + env(offer(gw1, XRP(96), OF2(96))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF2, alice)) == nullptr); + env(offer(alice, OF2(96), XRP(96))); + ++alice.owners; + env.close(); + + // Both offers should be consumed. + // Since gw1's offer was consumed, gw1 owner count doesn't change. + gw1.verifyOwners(__LINE__); + + // alice's automatically created MPT bumps her owner count. + alice.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + MPT const CK2 = gw1["CK2"]; + uint256 const chkId{getCheckIndex(gw1, env.seq(gw1))}; + env(check::create(gw1, alice, CK2(96))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK2, alice)) == nullptr); + env(check::cash(alice, chkId, CK2(96))); + ++alice.owners; + verifyDeliveredAmount(env, CK2(96)); + env.close(); + + // gw1's check should be consumed. + // Since gw1's check was consumed and MPT was not + // created by gw1, gw1's owner count doesn't change. + gw1.verifyOwners(__LINE__); + + // alice's automatically created trust line bumps her owner count. + alice.verifyOwners(__LINE__); + } + + //----------- lsfDefaultRipple, check written by non-issuer ------------ + { + // gw1 enabled rippling doesn't impact MPT, so automatic MPT from + // non-issuer to non-issuer should work. + + // Use offers to automatically create MPT. + MPT const OF2 = gw1["OF2"]; + env(offer(alice, XRP(95), OF2(95))); + env.close(); + // alice already has OF2 MPT + BEAST_EXPECT(env.le(keylet::mptoken(OF2, alice)) != nullptr); + env(offer(bob, OF2(95), XRP(95))); + ++bob.owners; + env.close(); + + // bob's owner count should increase due to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + MPT const CK2 = gw1["CK2"]; + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, CK2(95))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK2, bob)) == nullptr); + env(check::cash(bob, chkId, CK2(95))); + ++bob.owners; + verifyDeliveredAmount(env, CK2(95)); + env.close(); + + // bob's owner count should increase due to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + } + + //-------------- lsfDepositAuth, check written by issuer --------------- + { + // Both offers and checks ignore the lsfDepositAuth flag, since + // the destination signs the transaction that delivers their funds. + // So setting lsfDepositAuth on all the participants should not + // change any outcomes. + // + // Automatic MPT from issuer to non-issuer should still work. + env(fset(gw1, asfDepositAuth)); + env(fset(alice, asfDepositAuth)); + env(fset(bob, asfDepositAuth)); + env.close(); + + // Use offers to automatically create MPT. + MPT const OF3 = gw1["OF3"]; + env(offer(gw1, XRP(94), OF3(94))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF3, alice)) == nullptr); + env(offer(alice, OF3(94), XRP(94))); + ++alice.owners; + env.close(); + + // Both offers should be consumed. + // Since gw1's offer was consumed and MPT was not + // created by gw1, gw1's owner count doesn't change. + gw1.verifyOwners(__LINE__); + + // alice's automatically created MPT bumps her owner count. + alice.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + MPT const CK3 = gw1["CK3"]; + uint256 const chkId{getCheckIndex(gw1, env.seq(gw1))}; + env(check::create(gw1, alice, CK3(94))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK3, alice)) == nullptr); + env(check::cash(alice, chkId, CK3(94))); + ++alice.owners; + verifyDeliveredAmount(env, CK3(94)); + env.close(); + + // gw1's check should be consumed. + // Since gw1's check was consumed and MPT was not + // created by gw1, gw1's owner count doesn't change. + gw1.verifyOwners(__LINE__); + + // alice's automatically created trust line bumps her owner count. + alice.verifyOwners(__LINE__); + } + + //------------ lsfDepositAuth, check written by non-issuer ------------- + { + // The presence of the lsfDepositAuth flag should not affect + // automatic MPT creation. + + // Use offers to automatically create MPT. + MPT const OF3 = gw1["OF3"]; + env(offer(alice, XRP(93), OF3(93))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF3, alice)) != nullptr); + env(offer(bob, OF3(93), XRP(93))); + ++bob.owners; + env.close(); + + // bob's owner count should increase due to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + MPT const CK3 = gw1["CK3"]; + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, CK3(93))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK3, bob)) == nullptr); + env(check::cash(bob, chkId, CK3(93))); + ++bob.owners; + verifyDeliveredAmount(env, CK3(93)); + env.close(); + + // bob's owner count should increase due to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + } + + //-------------- lsfGlobalFreeze, check written by issuer -------------- + { + // Set lsfGlobalFreeze on gw1. That should not stop any automatic + // MPT from being created. + env(fset(gw1, asfGlobalFreeze)); + env.close(); + + // Use offers to automatically create MPT. + MPT const OF4 = gw1["OF4"]; + env(offer(gw1, XRP(92), OF4(92))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF4, alice)) == nullptr); + env(offer(alice, OF4(92), XRP(92))); + ++alice.owners; + env.close(); + + // alice's owner count should increase do to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + MPT const CK4 = gw1["CK4"]; + uint256 const chkId{getCheckIndex(gw1, env.seq(gw1))}; + env(check::create(gw1, bob, CK4(92))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK4, bob)) == nullptr); + env(check::cash(bob, chkId, CK4(92))); + verifyDeliveredAmount(env, CK4(92)); + ++bob.owners; + env.close(); + + // bob's owner count should increase due to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // clean up + gw1.cleanup(OF4, alice); + gw1.cleanup(CK4, bob); + } + + //-------------- lsfMPTLock, check written by issuer -------------- + { + // Set lsfMPTLock on gw1. That should stop any automatic + // MPT from being created. + + // Use offers to automatically create MPT. + MPT const OF4 = gw1["OF4"]; + gw1.set(OF4, tfMPTLock); + env(offer(gw1, XRP(92), OF4(92)), ter(tecFROZEN)); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF4, alice)) == nullptr); + env(offer(alice, OF4(92), XRP(92)), ter(tecFROZEN)); + env.close(); + + // No one's owner count should have changed. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + MPT const CK4 = gw1["CK4"]; + gw1.set(CK4, tfMPTLock); + uint256 const chkId{getCheckIndex(gw1, env.seq(gw1))}; + env(check::create(gw1, alice, CK4(92)), ter(tecLOCKED)); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK4, alice)) == nullptr); + env(check::cash(alice, chkId, CK4(92)), ter(tecNO_ENTRY)); + env.close(); + + // No one's owner count should have changed. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Because gw1 has set tfMPTLock, neither MPT + // is created. + BEAST_EXPECT(env.le(keylet::mptoken(OF4, alice)) == nullptr); + BEAST_EXPECT(env.le(keylet::mptoken(CK4, alice)) == nullptr); + + // clear global freeze + gw1.set(OF4, tfMPTUnlock); + gw1.set(CK4, tfMPTUnlock); + } + + //------------ lsfGlobalFreeze, check written by non-issuer ------------ + { + // lsfGlobalFreeze flag set on gw1 should not stop + // automatic MPT creation between non-issuers. + + // Use offers to automatically create MPT. + MPT const OF4 = gw1["OF4"]; + gw1.authorize(OF4, alice); + gw1.pay(gw1, alice, OF4(91)); + env(offer(alice, XRP(91), OF4(91))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF4, alice)) != nullptr); + env(offer(bob, OF4(91), XRP(91))); + ++bob.owners; + env.close(); + + // alice's owner count should increase since it created MPT. + // bob's owner count should increase due to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create the trust line. + MPT const CK4 = gw1["CK4"]; + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, CK4(91))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK4, bob)) == nullptr); + gw1.authorize(CK4, alice); + gw1.pay(gw1, alice, CK4(91)); + env(check::cash(bob, chkId, CK4(91))); + ++bob.owners; + env.close(); + + // alice's owner count should increase since it created MPT. + // bob's owner count should increase due to the new MPT. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // cleanup + gw1.cleanup(OF4, alice); + gw1.cleanup(CK4, alice); + gw1.cleanup(OF4, bob); + gw1.cleanup(CK4, bob); + } + + //------------ lsfMPTLock, check written by non-issuer ------------ + { + // Since gw1 has the lsfMPTLock flag set, there should be + // no automatic MPT creation between non-issuers. + + // Use offers to automatically create MPT. + MPT const OF4 = gw1["OF4"]; + gw1.set(OF4, tfMPTLock); + env(offer(alice, XRP(91), OF4(91)), ter(tecFROZEN)); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF4, alice)) == nullptr); + env(offer(bob, OF4(91), XRP(91)), ter(tecFROZEN)); + env.close(); + + // No one's owner count should have changed. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create the trust line. + MPT const CK4 = gw1["CK4"]; + gw1.set(CK4, tfMPTLock); + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, CK4(91)), ter(tecLOCKED)); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK4, bob)) == nullptr); + env(check::cash(bob, chkId, CK4(91)), ter(tecNO_ENTRY)); + env.close(); + + // No one's owner count should have changed. + gw1.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Because gw1 has set lsfGlobalFreeze, neither trust line + // is created. + BEAST_EXPECT(env.le(keylet::mptoken(OF4, bob)) == nullptr); + BEAST_EXPECT(env.le(keylet::mptoken(CK4, bob)) == nullptr); + + gw1.set(OF4, tfMPTUnlock); + gw1.set(CK4, tfMPTUnlock); + } + + //-------------- lsfRequireAuth, check written by issuer --------------- + + // We want to test the lsfRequireAuth flag, but we can't set that + // flag on an account that already has MPT. So we'll fund + // a new gateway and use that. + AccountOwns gw2{*this, env, "gw2", true}; + { + env.fund(XRP(5'000), gw2); + env.close(); + + // Set lsfRequireAuth on gw2. That should not stop any automatic + // MPT from being created. + env(fset(gw2, asfRequireAuth)); + env.close(); + + // Use offers to automatically create MPT. + MPT const OF5 = gw2["OF5"]; + env(offer(gw2, XRP(92), OF5(92))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF5, alice)) == nullptr); + env(offer(alice, OF5(92), XRP(92))); + ++alice.owners; + env.close(); + + // alice's owner count should increase due to the new MPT. + gw2.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create MPT. + MPT const CK5 = gw2["CK5"]; + uint256 const chkId{getCheckIndex(gw2, env.seq(gw2))}; + env(check::create(gw2, alice, CK5(92))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK5, alice)) == nullptr); + env(check::cash(alice, chkId, CK5(92))); + verifyDeliveredAmount(env, CK5(92)); + ++alice.owners; + env.close(); + + // alice's owner count should increase due to the new MPT. + gw2.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // cleanup + gw2.cleanup(OF5, alice); + gw2.cleanup(CK5, alice); + } + + // Fund new gw to test since gw2 has MPTokenIssuance already created. + // Set RequireAuth flag. + AccountOwns gw3{*this, env, "gw3", true, true}; + { + env.fund(XRP(5'000), gw3); + env.close(); + // Use offers to automatically create the trust line. + MPT const OF5 = gw3["OF5"]; + std::uint32_t const gw3OfferSeq = {env.seq(gw3)}; + env(offer(gw3, XRP(92), OF5(92))); + ++gw3.owners; + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(OF5, alice)) == nullptr); + env(offer(alice, OF5(92), XRP(92)), ter(tecNO_AUTH)); + env.close(); + + // gw3 should still own the offer, but no one else's owner + // count should have changed. + gw3.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Since we don't need it anymore, remove gw3's offer. + env(offer_cancel(gw3, gw3OfferSeq)); + --gw3.owners; + env.close(); + gw3.verifyOwners(__LINE__); + + // Use check cashing to automatically create the trust line. + MPT const CK5 = gw3["CK5"]; + uint256 const chkId{getCheckIndex(gw3, env.seq(gw3))}; + env(check::create(gw3, alice, CK5(92))); + ++gw3.owners; + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK5, alice)) == nullptr); + env(check::cash(alice, chkId, CK5(92)), ter(tecNO_AUTH)); + env.close(); + + // gw3 should still own the check, but no one else's owner + // count should have changed. + gw3.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Because gw3 has set lsfRequireAuth, neither trust line + // is created. + BEAST_EXPECT(env.le(keylet::mptoken(OF5, alice)) == nullptr); + BEAST_EXPECT(env.le(keylet::mptoken(CK5, alice)) == nullptr); + + // Since we don't need it anymore, remove gw3's check. + env(check::cancel(gw3, chkId)); + --gw3.owners; + env.close(); + gw3.verifyOwners(__LINE__); + } + + //------------ lsfRequireAuth, check written by non-issuer ------------- + { + // gw2 lsfRequireAuth flag set should not affect + // automatic MPT creation between non-issuers. + + // Use offers to automatically create MPT. + MPT const OF5 = gw2["OF5"]; + gw2.authorize(OF5, alice); + gw2.pay(gw2, alice, OF5(91)); + env(offer(alice, XRP(91), OF5(91))); + env.close(); + env(offer(bob, OF5(91), XRP(91))); + ++bob.owners; + env.close(); + + // bob's owner count should increase due to the new MPT. + gw2.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create the trust line. + MPT const CK5 = gw2["CK5"]; + gw2.authorize(CK5, alice); + gw2.pay(gw2, alice, CK5(91)); + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, CK5(91))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK5, bob)) == nullptr); + env(check::cash(bob, chkId, CK5(91))); + ++bob.owners; + env.close(); + + // bob's owner count should increase due to the new MPT. + gw2.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + } + + //------------ lsfMPTRequireAuth, check written by non-issuer + //------------- + { + // Since gw3 has the lsfMPTRequireAuth flag set, there should be + // no automatic MPT creation between non-issuers. + + // Use offers to automatically create the trust line. + MPT const OF5 = gw3["OF5"]; + env(offer(alice, XRP(91), OF5(91)), ter(tecUNFUNDED_OFFER)); + env.close(); + env(offer(bob, OF5(91), XRP(91)), ter(tecNO_AUTH)); + BEAST_EXPECT(env.le(keylet::mptoken(OF5, bob)) == nullptr); + env.close(); + + gw3.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Use check cashing to automatically create the trust line. + MPT const CK5 = gw3["CK5"]; + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, bob, CK5(91))); + env.close(); + BEAST_EXPECT(env.le(keylet::mptoken(CK5, bob)) == nullptr); + env(check::cash(bob, chkId, CK5(91)), ter(tecPATH_PARTIAL)); + env.close(); + + // Delete alice's check since it is no longer needed. + env(check::cancel(alice, chkId)); + env.close(); + + // No one's owner count should have changed. + gw3.verifyOwners(__LINE__); + alice.verifyOwners(__LINE__); + bob.verifyOwners(__LINE__); + + // Because gw3 has set lsfRequireAuth, neither trust line + // is created. + BEAST_EXPECT(env.le(keylet::mptoken(OF5, bob)) == nullptr); + BEAST_EXPECT(env.le(keylet::mptoken(CK5, bob)) == nullptr); + } + } + + void + testWithFeats(FeatureBitset features) + { + testCreateValid(features); + testCreateDisallowIncoming(features); + testCreateInvalid(features); + testCashMPT(features); + testCashXferFee(features); + testCashInvalid(features); + testCancelValid(features); + testWithTickets(features); + } + +public: + void + run() override + { + using namespace test::jtx; + auto const sa = testable_amendments(); + testWithFeats(sa); + + testMPTCreation(sa); + } +}; + +BEAST_DEFINE_TESTSUITE(CheckMPT, tx, xrpl); + +} // namespace xrpl diff --git a/src/test/app/Check_test.cpp b/src/test/app/Check_test.cpp index 671f8aab1a..685e998f51 100644 --- a/src/test/app/Check_test.cpp +++ b/src/test/app/Check_test.cpp @@ -1,70 +1,53 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include + namespace xrpl { -namespace test { -namespace jtx { - -/** Set Expiration on a JTx. */ -class expiration -{ -private: - std::uint32_t const expiry_; - -public: - explicit expiration(NetClock::time_point const& expiry) - : expiry_{expiry.time_since_epoch().count()} - { - } - - void - operator()(Env&, JTx& jt) const - { - jt[sfExpiration.jsonName] = expiry_; - } -}; - -/** Set SourceTag on a JTx. */ -class source_tag -{ -private: - std::uint32_t const tag_; - -public: - explicit source_tag(std::uint32_t tag) : tag_{tag} - { - } - - void - operator()(Env&, JTx& jt) const - { - jt[sfSourceTag.jsonName] = tag_; - } -}; - -/** Set DestinationTag on a JTx. */ -class dest_tag -{ -private: - std::uint32_t const tag_; - -public: - explicit dest_tag(std::uint32_t tag) : tag_{tag} - { - } - - void - operator()(Env&, JTx& jt) const - { - jt[sfDestinationTag.jsonName] = tag_; - } -}; - -} // namespace jtx -} // namespace test class Check_test : public beast::unit_test::suite { @@ -404,11 +387,17 @@ class Check_test : public beast::unit_test::suite env(check::create(alice, bob, USF(50)), ter(tecFROZEN)); env.close(); + env(check::create(gwF, bob, USF(50)), ter(tecFROZEN)); + env.close(); + env(fclear(gwF, asfGlobalFreeze)); env.close(); env(check::create(alice, bob, USF(50))); env.close(); + + env(check::create(gwF, bob, USF(50))); + env.close(); } { // Frozen trust line. Check creation should be similar to payment @@ -1064,8 +1053,8 @@ class Check_test : public beast::unit_test::suite double pct, double amount) { // Capture bob's and alice's balances so we can test at the end. - STAmount const aliceStart{env.balance(alice, USD.issue()).value()}; - STAmount const bobStart{env.balance(bob, USD.issue()).value()}; + STAmount const aliceStart{env.balance(alice, USD).value()}; + STAmount const bobStart{env.balance(bob, USD).value()}; // Set the modified quality. env(trust(truster, iou(1000)), inOrOut(pct)); @@ -1089,8 +1078,8 @@ class Check_test : public beast::unit_test::suite double pct, double amount) { // Capture bob's and alice's balances so we can test at the end. - STAmount const aliceStart{env.balance(alice, USD.issue()).value()}; - STAmount const bobStart{env.balance(bob, USD.issue()).value()}; + STAmount const aliceStart{env.balance(alice, USD).value()}; + STAmount const bobStart{env.balance(bob, USD).value()}; // Set the modified quality. env(trust(truster, iou(1000)), inOrOut(pct)); @@ -1153,7 +1142,7 @@ class Check_test : public beast::unit_test::suite double max2) { // Capture alice's balance so we can test at the end. It doesn't // make any sense to look at the balance of a gateway. - STAmount const aliceStart{env.balance(alice, USD.issue()).value()}; + STAmount const aliceStart{env.balance(alice, USD).value()}; // Set the modified quality. env(trust(truster, iou(1000)), inOrOut(pct)); @@ -1186,7 +1175,7 @@ class Check_test : public beast::unit_test::suite double max2) { // Capture alice's balance so we can test at the end. It doesn't // make any sense to look at the balance of the issuer. - STAmount const aliceStart{env.balance(alice, USD.issue()).value()}; + STAmount const aliceStart{env.balance(alice, USD).value()}; // Set the modified quality. env(trust(truster, iou(1000)), inOrOut(pct)); @@ -1297,6 +1286,14 @@ class Check_test : public beast::unit_test::suite env(check::create(alice, bob, USD(4))); env.close(); + uint256 const chkIdFroz4ToIssuer{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, gw, USD(4))); + env.close(); + + uint256 const chkIdFroz4Issuer{getCheckIndex(gw, env.seq(gw))}; + env(check::create(gw, alice, USD(4))); + env.close(); + uint256 const chkIdNoDest1{getCheckIndex(alice, env.seq(alice))}; env(check::create(alice, bob, USD(1))); env.close(); @@ -1363,7 +1360,7 @@ class Check_test : public beast::unit_test::suite { IOU const wrongCurrency{gw["EUR"]}; STAmount badAmount{amount}; - badAmount.setIssue(wrongCurrency.issue()); + badAmount.setIssue(wrongCurrency); env(check::cash(bob, chkId, badAmount), ter(temMALFORMED)); env.close(); } @@ -1372,7 +1369,7 @@ class Check_test : public beast::unit_test::suite { IOU const wrongIssuer{alice["USD"]}; STAmount badAmount{amount}; - badAmount.setIssue(wrongIssuer.issue()); + badAmount.setIssue(wrongIssuer); env(check::cash(bob, chkId, badAmount), ter(temMALFORMED)); env.close(); } @@ -1419,6 +1416,17 @@ class Check_test : public beast::unit_test::suite env(check::cash(bob, chkIdFroz1, check::DeliverMin(USD(0.5))), ter(tecPATH_PARTIAL)); env.close(); + env(check::cash(gw, chkIdFroz4ToIssuer, USD(1)), ter(tecPATH_PARTIAL)); + env.close(); + env(check::cash(gw, chkIdFroz4ToIssuer, check::DeliverMin(USD(0.5))), + ter(tecPATH_PARTIAL)); + env.close(); + + env(check::cash(alice, chkIdFroz4Issuer, USD(1)), ter(tecFROZEN)); + env.close(); + env(check::cash(alice, chkIdFroz4Issuer, check::DeliverMin(USD(0.5))), ter(tecFROZEN)); + env.close(); + env(fclear(gw, asfGlobalFreeze)); env.close(); @@ -1428,6 +1436,9 @@ class Check_test : public beast::unit_test::suite env.require(balance(alice, USD(19))); env.require(balance(bob, USD(1))); + env(check::cash(gw, chkIdFroz4ToIssuer, USD(1))); + env.close(); + // Freeze individual trustlines. env(trust(gw, alice["USD"](0), tfSetFreeze)); env.close(); @@ -1441,7 +1452,7 @@ class Check_test : public beast::unit_test::suite env.close(); env(check::cash(bob, chkIdFroz2, USD(2))); env.close(); - env.require(balance(alice, USD(17))); + env.require(balance(alice, USD(16))); env.require(balance(bob, USD(3))); // Freeze bob's trustline. bob can't cash the check. @@ -1457,7 +1468,7 @@ class Check_test : public beast::unit_test::suite env.close(); env(check::cash(bob, chkIdFroz3, check::DeliverMin(USD(1)))); verifyDeliveredAmount(env, USD(3)); - env.require(balance(alice, USD(14))); + env.require(balance(alice, USD(13))); env.require(balance(bob, USD(6))); // Set bob's freeze bit in the other direction. Check @@ -1474,7 +1485,7 @@ class Check_test : public beast::unit_test::suite env.close(); env(check::cash(bob, chkIdFroz4, USD(4))); env.close(); - env.require(balance(alice, USD(10))); + env.require(balance(alice, USD(9))); env.require(balance(bob, USD(10))); } { @@ -1491,7 +1502,7 @@ class Check_test : public beast::unit_test::suite // bob can cash a check with a destination tag. env(check::cash(bob, chkIdHasDest2, USD(2))); env.close(); - env.require(balance(alice, USD(8))); + env.require(balance(alice, USD(7))); env.require(balance(bob, USD(12))); // Clear the RequireDest flag on bob's account so he can @@ -1500,7 +1511,7 @@ class Check_test : public beast::unit_test::suite env.close(); env(check::cash(bob, chkIdNoDest1, USD(1))); env.close(); - env.require(balance(alice, USD(7))); + env.require(balance(alice, USD(6))); env.require(balance(bob, USD(13))); } } @@ -1880,7 +1891,7 @@ class Check_test : public beast::unit_test::suite // Automatic trust line creation should fail if the check destination // can't afford the reserve for the trust line. { - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; // Fund gw1 with noripple (even though that's atypical for a // gateway) so it does not have any flags set. We'll set flags @@ -1960,7 +1971,7 @@ class Check_test : public beast::unit_test::suite if (!BEAST_EXPECT(!offerAmount.native() && !checkAmount.native())) return; - BEAST_EXPECT(offerAmount.issue().account == checkAmount.issue().account); + BEAST_EXPECT(offerAmount.getIssuer() == checkAmount.getIssuer()); BEAST_EXPECT(offerAmount.negative() == checkAmount.negative()); BEAST_EXPECT(offerAmount.mantissa() == checkAmount.mantissa()); BEAST_EXPECT(offerAmount.exponent() == checkAmount.exponent()); @@ -2000,7 +2011,7 @@ class Check_test : public beast::unit_test::suite { // No account root flags on any participant. // Automatic trust line from issuer to destination. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; BEAST_EXPECT((*env.le(gw1))[sfFlags] == 0); BEAST_EXPECT((*env.le(alice))[sfFlags] == 0); @@ -2053,7 +2064,7 @@ class Check_test : public beast::unit_test::suite // Transfer of assets using offers does not require rippling. // So bob's offer is successfully crossed which creates the // trust line. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; IOU const OF1 = gw1["OF1"]; env(offer(alice, XRP(97), OF1(97))); env.close(); @@ -2102,7 +2113,7 @@ class Check_test : public beast::unit_test::suite { // gw1 enables rippling. // Automatic trust line from issuer to non-issuer should still work. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; env(fset(gw1, asfDefaultRipple)); env.close(); @@ -2150,7 +2161,7 @@ class Check_test : public beast::unit_test::suite // to non-issuer should work. // Use offers to automatically create the trust line. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; IOU const OF2 = gw1["OF2"]; env(offer(alice, XRP(95), OF2(95))); env.close(); @@ -2191,7 +2202,7 @@ class Check_test : public beast::unit_test::suite // change any outcomes. // // Automatic trust line from issuer to non-issuer should still work. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; env(fset(gw1, asfDepositAuth)); env(fset(alice, asfDepositAuth)); env(fset(bob, asfDepositAuth)); @@ -2241,7 +2252,7 @@ class Check_test : public beast::unit_test::suite // automatic trust line creation. // Use offers to automatically create the trust line. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; IOU const OF3 = gw1["OF3"]; env(offer(alice, XRP(93), OF3(93))); env.close(); @@ -2278,7 +2289,7 @@ class Check_test : public beast::unit_test::suite { // Set lsfGlobalFreeze on gw1. That should stop any automatic // trust lines from being created. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; env(fset(gw1, asfGlobalFreeze)); env.close(); @@ -2320,7 +2331,7 @@ class Check_test : public beast::unit_test::suite // no automatic trust line creation between non-issuers. // Use offers to automatically create the trust line. - AccountOwns gw1{*this, env, "gw1", 0}; + AccountOwns const gw1{*this, env, "gw1", 0}; IOU const OF4 = gw1["OF4"]; env(offer(alice, XRP(91), OF4(91)), ter(tecFROZEN)); env.close(); @@ -2370,7 +2381,7 @@ class Check_test : public beast::unit_test::suite // Use offers to automatically create the trust line. IOU const OF5 = gw2["OF5"]; - std::uint32_t gw2OfferSeq = {env.seq(gw2)}; + std::uint32_t const gw2OfferSeq = {env.seq(gw2)}; env(offer(gw2, XRP(92), OF5(92))); ++gw2.owners; env.close(); @@ -2423,7 +2434,7 @@ class Check_test : public beast::unit_test::suite // no automatic trust line creation between non-issuers. // Use offers to automatically create the trust line. - AccountOwns gw2{*this, env, "gw2", 0}; + AccountOwns const gw2{*this, env, "gw2", 0}; IOU const OF5 = gw2["OF5"]; env(offer(alice, XRP(91), OF5(91)), ter(tecUNFUNDED_OFFER)); env.close(); diff --git a/src/test/app/Clawback_test.cpp b/src/test/app/Clawback_test.cpp index d169e9e165..8efcece295 100644 --- a/src/test/app/Clawback_test.cpp +++ b/src/test/app/Clawback_test.cpp @@ -1,7 +1,28 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include + +#include +#include +#include namespace xrpl { @@ -52,7 +73,7 @@ class Clawback_test : public beast::unit_test::suite // Also, asfAllowTrustLineClawback cannot be cleared. { Env env(*this, features); - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(1000), alice); env.close(); @@ -77,7 +98,7 @@ class Clawback_test : public beast::unit_test::suite // asfNoFreeze has been set { Env env(*this, features); - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(1000), alice); env.close(); @@ -103,8 +124,8 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -146,7 +167,7 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features - featureClawback); - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(1000), alice); env.close(); @@ -183,8 +204,8 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features - featureClawback); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -228,8 +249,8 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -310,8 +331,8 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; // bob's account is not funded and does not exist env.fund(XRP(1000), alice); @@ -332,9 +353,9 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; - Account cindy{"cindy"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const cindy{"cindy"}; env.fund(XRP(1000), alice, bob, cindy); env.close(); @@ -375,8 +396,8 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -445,8 +466,8 @@ class Clawback_test : public beast::unit_test::suite // Test that alice is able to successfully clawback tokens from bob Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -496,9 +517,9 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; - Account cindy{"cindy"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const cindy{"cindy"}; env.fund(XRP(1000), alice, bob, cindy); env.close(); @@ -554,9 +575,9 @@ class Clawback_test : public beast::unit_test::suite { Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; - Account cindy{"cindy"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const cindy{"cindy"}; env.fund(XRP(1000), alice, bob, cindy); env.close(); @@ -624,8 +645,8 @@ class Clawback_test : public beast::unit_test::suite // perspective is allowed to clawback Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -711,8 +732,8 @@ class Clawback_test : public beast::unit_test::suite // If clawback results the trustline to be default, // trustline should be automatically deleted Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -761,8 +782,8 @@ class Clawback_test : public beast::unit_test::suite // Claws back from frozen trustline // and the trustline should remain frozen Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -807,8 +828,8 @@ class Clawback_test : public beast::unit_test::suite // When alice tries to claw back an amount that is greater // than what bob holds, only the max available balance is clawed Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); @@ -859,8 +880,8 @@ class Clawback_test : public beast::unit_test::suite // Tests clawback with tickets Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), alice, bob); env.close(); diff --git a/src/test/app/Credentials_test.cpp b/src/test/app/Credentials_test.cpp index db09bfc0ca..d4e8b03f0a 100644 --- a/src/test/app/Credentials_test.cpp +++ b/src/test/app/Credentials_test.cpp @@ -1,14 +1,35 @@ -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include #include +#include #include #include +#include #include +#include +#include #include #include +#include +#include #include namespace xrpl { @@ -471,7 +492,7 @@ struct Credentials_test : public beast::unit_test::suite { testcase("Credentials fail, expiration in the past."); auto jv = credentials::create(subject, issuer, credType); - // current time in ripple epoch - 1s + // current time in XRPL epoch - 1s uint32_t const t = env.current()->header().parentCloseTime.time_since_epoch().count() - 1; jv[sfExpiration.jsonName] = t; @@ -812,7 +833,7 @@ struct Credentials_test : public beast::unit_test::suite testcase("CredentialsDelete fail, time not expired yet."); auto jv = credentials::create(subject, issuer, credType); - // current time in ripple epoch + 1000s + // current time in XRPL epoch + 1000s uint32_t const t = env.current()->header().parentCloseTime.time_since_epoch().count() + 1000; jv[sfExpiration.jsonName] = t; diff --git a/src/test/app/CrossingLimitsMPT_test.cpp b/src/test/app/CrossingLimitsMPT_test.cpp new file mode 100644 index 0000000000..d42f0aace2 --- /dev/null +++ b/src/test/app/CrossingLimitsMPT_test.cpp @@ -0,0 +1,444 @@ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +namespace xrpl { +namespace test { + +class CrossingLimitsMPT_test : public beast::unit_test::suite +{ +public: + void + testStepLimit(FeatureBitset features) + { + testcase("Step Limit"); + + using namespace jtx; + Env env(*this, features); + + auto const gw = Account("gateway"); + + env.fund(XRP(100'000'000), gw, "alice", "bob", "carol", "dan"); + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {"bob", "dan"}, .maxAmt = 2}); + env(pay(gw, "bob", USD(1))); + env(pay(gw, "dan", USD(1))); + n_offers(env, 2'000, "bob", XRP(1), USD(1)); + n_offers(env, 1, "dan", XRP(1), USD(1)); + + // Alice offers to buy 1000 XRP for 1000 USD. She takes Bob's first + // offer, removes 999 more as unfunded, then hits the step limit. + env(offer("alice", USD(1'000), XRP(1'000))); + env.require(balance("alice", USD(1))); + env.require(owners("alice", 2)); + env.require(balance("bob", USD(0))); + env.require(owners("bob", 1'001)); + env.require(balance("dan", USD(1))); + env.require(owners("dan", 2)); + + // Carol offers to buy 1000 XRP for 1000 USD. She removes Bob's next + // 1000 offers as unfunded and hits the step limit. + env(offer("carol", USD(1'000), XRP(1'000))); + env.require(balance("carol", USD(none))); + env.require(owners("carol", 1)); + env.require(balance("bob", USD(0))); + env.require(owners("bob", 1)); + env.require(balance("dan", USD(1))); + env.require(owners("dan", 2)); + } + + void + testCrossingLimit(FeatureBitset features) + { + testcase("Crossing Limit"); + + using namespace jtx; + Env env(*this, features); + + auto const gw = Account("gateway"); + + int const maxConsumed = 1'000; + + env.fund(XRP(100'000'000), gw, "alice", "bob", "carol"); + int const bobsOfferCount = maxConsumed + 150; + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {"bob"}, .maxAmt = bobsOfferCount}); + env(pay(gw, "bob", USD(bobsOfferCount))); + env.close(); + n_offers(env, bobsOfferCount, "bob", XRP(1), USD(1)); + + // Alice offers to buy Bob's offers. However, she hits the offer + // crossing limit, so she can't buy them all at once. + env(offer("alice", USD(bobsOfferCount), XRP(bobsOfferCount))); + env.close(); + env.require(balance("alice", USD(maxConsumed))); + env.require(balance("bob", USD(150))); + env.require(owners("bob", 150 + 1)); + + // Carol offers to buy 1000 XRP for 1000 USD. She takes Bob's + // remaining 150 offers without hitting a limit. + env(offer("carol", USD(1'000), XRP(1'000))); + env.close(); + env.require(balance("carol", USD(150))); + env.require(balance("bob", USD(0))); + env.require(owners("bob", 1)); + } + + void + testStepAndCrossingLimit(FeatureBitset features) + { + testcase("Step And Crossing Limit"); + + using namespace jtx; + Env env(*this, features); + + auto const gw = Account("gateway"); + + env.fund(XRP(100'000'000), gw, "alice", "bob", "carol", "dan", "evita"); + + int const maxConsumed = 1'000; + int const evitaOfferCount{maxConsumed + 49}; + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {"bob", "alice", "carol", "evita"}, + .maxAmt = 2'000 + evitaOfferCount + 1}); + + env(pay(gw, "alice", USD(1000))); + env(pay(gw, "carol", USD(1))); + env(pay(gw, "evita", USD(evitaOfferCount + 1))); + + // Give carol an extra 150 (unfunded) offers when we're using Taker + // to accommodate that difference. + int const carolOfferCount{700}; + n_offers(env, 400, "alice", XRP(1), USD(1)); + n_offers(env, carolOfferCount, "carol", XRP(1), USD(1)); + n_offers(env, evitaOfferCount, "evita", XRP(1), USD(1)); + + // Bob offers to buy 1000 XRP for 1000 USD. He takes all 400 USD from + // Alice's offers, 1 USD from Carol's and then removes 599 of Carol's + // offers as unfunded, before hitting the step limit. + env(offer("bob", USD(1000), XRP(1000))); + env.require(balance("bob", USD(401))); + env.require(balance("alice", USD(600))); + env.require(owners("alice", 1)); + env.require(balance("carol", USD(0))); + env.require(owners("carol", carolOfferCount - 599)); + env.require(balance("evita", USD(evitaOfferCount + 1))); + env.require(owners("evita", evitaOfferCount + 1)); + + // Dan offers to buy maxConsumed + 50 XRP USD. He removes all of + // Carol's remaining offers as unfunded, then takes + // (maxConsumed - 100) USD from Evita's, hitting the crossing limit. + env(offer("dan", USD(maxConsumed + 50), XRP(maxConsumed + 50))); + env.require(balance("dan", USD(maxConsumed - 100))); + env.require(owners("dan", 2)); + env.require(balance("alice", USD(600))); + env.require(owners("alice", 1)); + env.require(balance("carol", USD(0))); + env.require(owners("carol", 1)); + env.require(balance("evita", USD(150))); + env.require(owners("evita", 150)); + } + + void + testAutoBridgedLimits(FeatureBitset features) + { + testcase("Auto Bridged Limits"); + + // Extracts as much as possible in one book at one Quality + // before proceeding to the other book. This reduces the number of + // times we change books. + + // If any book step in a payment strand consumes 1000 offers, the + // liquidity from the offers is used, but that strand will be marked as + // dry for the remainder of the transaction. + + using namespace jtx; + + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const carol = Account("carol"); + + // There are two almost identical tests. There is a strand with a large + // number of unfunded offers that will cause the strand to be marked dry + // even though there will still be liquidity available on that strand. + // In the first test, the strand has the best initial quality. In the + // second test the strand does not have the best quality (the + // implementation has to handle this case correct and not mark the + // strand dry until the liquidity is actually used) + + // The implementation allows any single step to consume at most 1000 + // offers. With the `FlowSortStrands` feature enabled, if the total + // number of offers consumed by all the steps combined exceeds 1500, the + // payment stops. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(100'000'000), gw, alice, bob, carol); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = maxMPTokenAmount}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {bob}, + .limit = maxMPTokenAmount}); + + env(pay(gw, alice, USD(4'000))); + env(pay(gw, carol, USD(3))); + + // Notice the strand with the 800 unfunded offers has the + // initial best quality + n_offers(env, 2'000, alice, EUR(2), XRP(1)); + n_offers(env, 100, alice, XRP(1), USD(4)); + n_offers(env, 801, carol, XRP(1), + USD(3)); // only one offer is funded + n_offers(env, 1'000, alice, XRP(1), USD(3)); + + n_offers(env, 1, alice, EUR(500), USD(500)); + + // Bob offers to buy 2000 USD for 2000 EUR; He starts with 2000 + // EUR + // 1. The best quality is the autobridged offers that take 2 + // EUR and give 4 USD. + // Bob spends 200 EUR and receives 400 USD. + // 100 EUR->XRP offers consumed. + // 100 XRP->USD offers consumed. + // 200 total offers consumed. + // + // 2. The best quality is the autobridged offers that take 2 + // EUR and give 3 USD. + // a. One of Carol's offers is taken. This leaves her other + // offers unfunded. + // b. Carol's remaining 800 offers are consumed as unfunded. + // c. 199 of alice's XRP(1) to USD(3) offers are consumed. + // A book step is allowed to consume a maximum of 1000 + // offers at a given quality, and that limit is now + // reached. + // d. Now the strand is dry, even though there are still + // funded XRP(1) to USD(3) offers available. + // Bob has spent 400 EUR and received 600 USD in this + // step. 200 EUR->XRP offers consumed 800 unfunded + // XRP->USD offers consumed 200 funded XRP->USD offers + // consumed (1 carol, 199 alice) 1400 total offers + // consumed so far (100 left before the limit) + // 3. The best is the non-autobridged offers that takes 500 EUR + // and gives 500 USD. + // Bob started with 2000 EUR + // Bob spent 500 EUR (100+400) + // Bob has 1500 EUR left + // In this step: + // Bob spends 500 EUR and receives 500 USD. + // In total: + // Bob spent 1100 EUR (200 + 400 + 500) + // Bob has 900 EUR remaining (2000 - 1100) + // Bob received 1500 USD (400 + 600 + 500) + // Alice spent 1497 USD (100*4 + 199*3 + 500) + // Alice has 2503 remaining (4000 - 1497) + // Alice received 1100 EUR (200 + 400 + 500) + env(pay(gw, bob, EUR(2'000))); + env.close(); + env(offer(bob, USD(4'000), EUR(4'000))); + env.close(); + + env.require(balance(bob, USD(1'500))); + env.require(balance(bob, EUR(900))); + env.require(offers(bob, 1)); + env.require(owners(bob, 3)); + + env.require(balance(alice, USD(2'503))); + env.require(balance(alice, EUR(1'100))); + auto const numAOffers = 2'000 + 100 + 1'000 + 1 - (2 * 100 + 2 * 199 + 1 + 1); + env.require(offers(alice, numAOffers)); + env.require(owners(alice, numAOffers + 2)); + + env.require(offers(carol, 0)); + }; + testHelper2TokensMix(test); + } + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(100'000'000), gw, alice, bob, carol); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = maxMPTokenAmount}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {bob}, + .limit = maxMPTokenAmount}); + + env(pay(gw, alice, USD(4'000))); + env(pay(gw, carol, USD(3))); + + // Notice the strand with the 800 unfunded offers does not have + // the initial best quality + n_offers(env, 1, alice, EUR(1), USD(10)); + n_offers(env, 2'000, alice, EUR(2), XRP(1)); + n_offers(env, 100, alice, XRP(1), USD(4)); + n_offers(env, 801, carol, XRP(1), + USD(3)); // only one offer is funded + n_offers(env, 1'000, alice, XRP(1), USD(3)); + + n_offers(env, 1, alice, EUR(499), USD(499)); + + // Bob offers to buy 2000 USD for 2000 EUR; He starts with 2000 + // EUR + // 1. The best quality is the offer that takes 1 EUR and gives + // 10 USD + // Bob spends 1 EUR and receives 10 USD. + // + // 2. The best quality is the autobridged offers that takes 2 + // EUR and gives 4 USD. + // Bob spends 200 EUR and receives 400 USD. + // + // 3. The best quality is the autobridged offers that takes 2 + // EUR and gives 3 USD. + // a. One of Carol's offers is taken. This leaves her other + // offers unfunded. + // b. Carol's remaining 800 offers are consumed as unfunded. + // c. 199 of alice's XRP(1) to USD(3) offers are consumed. + // A book step is allowed to consume a maximum of 1000 + // offers at a given quality, and that limit is now + // reached. + // d. Now the strand is dry, even though there are still + // funded XRP(1) to USD(3) offers available. Bob has spent + // 400 EUR and received 600 USD in this step. (200 funded + // offers consumed 800 unfunded offers) + // 4. The best is the non-autobridged offers that takes 499 EUR + // and gives 499 USD. + // Bob has 2000 EUR, and has spent 1+200+400=601 EUR. He has + // 1399 left. Bob spent 499 EUR and receives 499 USD. + // In total: Bob spent EUR(1 + 200 + 400 + 499) = EUR(1100). He + // started with 2000 so has 900 remaining + // Bob received USD(10 + 400 + 600 + 499) = USD(1509). + // Alice spent 10 + 100*4 + 199*3 + 499 = 1506 USD. + // She started with 4000 so has 2494 USD remaining. + // Alice received 200 + 400 + 500 = 1100 EUR + env.close(); + env(pay(gw, bob, EUR(2'000))); + env.close(); + env(offer(bob, USD(4'000), EUR(4'000))); + env.close(); + + env.require(balance(bob, USD(1'509))); + env.require(balance(bob, EUR(900))); + env.require(offers(bob, 1)); + env.require(owners(bob, 3)); + + env.require(balance(alice, USD(2'494))); + env.require(balance(alice, EUR(1'100))); + auto const numAOffers = + 1 + 2'000 + 100 + 1'000 + 1 - (1 + 2 * 100 + 2 * 199 + 1 + 1); + env.require(offers(alice, numAOffers)); + env.require(owners(alice, numAOffers + 2)); + + env.require(offers(carol, 0)); + }; + testHelper2TokensMix(test); + } + } + + void + testOfferOverflow(FeatureBitset features) + { + testcase("Offer Overflow"); + + using namespace jtx; + + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + Env env(*this, features); + + env.fund(XRP(100'000'000), gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + env(pay(gw, alice, USD(8'000))); + env.close(); + + // The new flow cross handles consuming excessive offers differently + // than the old offer crossing code. In the old code, the total number + // of consumed offers is tracked, and the crossings will stop after this + // limit is hit. In the new code, the number of offers is tracked per + // offerbook and per quality. This test shows how they can differ. Set + // up a book with many offers. At each quality keep the number of offers + // below the limit. However, if all the offers are consumed it would + // create a tecOVERSIZE error. + + // The featureFlowSortStrands introduces a way of tracking the total + // number of consumed offers; with this feature the transaction no + // longer fails with a tecOVERSIZE error. + // The implementation allows any single step to consume at most 1000 + // offers. With the `FlowSortStrands` feature enabled, if the total + // number of offers consumed by all the steps combined exceeds 1500, the + // payment stops. Since the first set of offers consumes 998 offers, the + // second set will consume 998, which is not over the limit and the + // payment stops. So 2*998, or 1996 is the expected value when + // `FlowSortStrands` is enabled. + n_offers(env, 998, alice, XRP(1.00), USD(1)); + n_offers(env, 998, alice, XRP(0.99), USD(1)); + n_offers(env, 998, alice, XRP(0.98), USD(1)); + n_offers(env, 998, alice, XRP(0.97), USD(1)); + n_offers(env, 998, alice, XRP(0.96), USD(1)); + n_offers(env, 998, alice, XRP(0.95), USD(1)); + + auto const expectedTER = tesSUCCESS; + + env(offer(bob, USD(8'000), XRP(8'000)), ter(expectedTER)); + env.close(); + + auto const expectedUSD = USD(1'996); + + env.require(balance(bob, expectedUSD)); + } + + void + run() override + { + using namespace jtx; + auto const features = testable_amendments(); + testStepLimit(features); + testCrossingLimit(features); + testStepAndCrossingLimit(features); + testAutoBridgedLimits(features); + testOfferOverflow(features); + } +}; + +BEAST_DEFINE_TESTSUITE_MANUAL_PRIO(CrossingLimitsMPT, tx, xrpl, 10); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/CrossingLimits_test.cpp b/src/test/app/CrossingLimits_test.cpp index 0451822492..bc9186bb29 100644 --- a/src/test/app/CrossingLimits_test.cpp +++ b/src/test/app/CrossingLimits_test.cpp @@ -1,7 +1,18 @@ -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include #include +#include namespace xrpl { namespace test { @@ -143,107 +154,15 @@ public: env.require(owners("evita", 150)); } - void - testAutoBridgedLimitsTaker(FeatureBitset features) - { - testcase("Auto Bridged Limits Taker"); - - using namespace jtx; - Env env(*this, features); - - auto const gw = Account("gateway"); - auto const USD = gw["USD"]; - auto const EUR = gw["EUR"]; - - env.fund(XRP(100000000), gw, "alice", "bob", "carol", "dan", "evita"); - - env.trust(USD(2000), "alice"); - env(pay(gw, "alice", USD(2000))); - env.trust(USD(1000), "carol"); - env(pay(gw, "carol", USD(3))); - env.trust(USD(1000), "evita"); - env(pay(gw, "evita", USD(1000))); - - n_offers(env, 302, "alice", EUR(2), XRP(1)); - n_offers(env, 300, "alice", XRP(1), USD(4)); - n_offers(env, 497, "carol", XRP(1), USD(3)); - n_offers(env, 1001, "evita", EUR(1), USD(1)); - - // Bob offers to buy 2000 USD for 2000 EUR, even though he only has - // 1000 EUR. - // 1. He spends 600 EUR taking Alice's auto-bridged offers and - // gets 1200 USD for that. - // 2. He spends another 2 EUR taking one of Alice's EUR->XRP and - // one of Carol's XRP-USD offers. He gets 3 USD for that. - // 3. The remainder of Carol's offers are now unfunded. We've - // consumed 602 offers so far. We now chew through 398 more - // of Carol's unfunded offers until we hit the 1000 offer limit. - // This sets have_bridge to false -- we will handle no more - // bridged offers. - // 4. However, have_direct is still true. So we go around one more - // time and take one of Evita's offers. - // 5. After taking one of Evita's offers we notice (again) that our - // offer count was exceeded. So we completely stop after taking - // one of Evita's offers. - env.trust(EUR(10000), "bob"); - env.close(); - env(pay(gw, "bob", EUR(1000))); - env.close(); - env(offer("bob", USD(2000), EUR(2000))); - env.require(balance("bob", USD(1204))); - env.require(balance("bob", EUR(397))); - - env.require(balance("alice", USD(800))); - env.require(balance("alice", EUR(602))); - env.require(offers("alice", 1)); - env.require(owners("alice", 3)); - - env.require(balance("carol", USD(0))); - env.require(balance("carol", EUR(none))); - env.require(offers("carol", 100)); - env.require(owners("carol", 101)); - - env.require(balance("evita", USD(999))); - env.require(balance("evita", EUR(1))); - env.require(offers("evita", 1000)); - env.require(owners("evita", 1002)); - - // Dan offers to buy 900 EUR for 900 USD. - // 1. He removes all 100 of Carol's remaining unfunded offers. - // 2. Then takes 850 USD from Evita's offers. - // 3. Consuming 850 of Evita's funded offers hits the crossing - // limit. So Dan's offer crossing stops even though he would - // be willing to take another 50 of Evita's offers. - env.trust(EUR(10000), "dan"); - env.close(); - env(pay(gw, "dan", EUR(1000))); - env.close(); - - env(offer("dan", USD(900), EUR(900))); - env.require(balance("dan", USD(850))); - env.require(balance("dan", EUR(150))); - - env.require(balance("alice", USD(800))); - env.require(balance("alice", EUR(602))); - env.require(offers("alice", 1)); - env.require(owners("alice", 3)); - - env.require(balance("carol", USD(0))); - env.require(balance("carol", EUR(none))); - env.require(offers("carol", 0)); - env.require(owners("carol", 1)); - - env.require(balance("evita", USD(149))); - env.require(balance("evita", EUR(851))); - env.require(offers("evita", 150)); - env.require(owners("evita", 152)); - } - void testAutoBridgedLimits(FeatureBitset features) { testcase("Auto Bridged Limits"); + // Extracts as much as possible in one book at one Quality + // before proceeding to the other book. This reduces the number of + // times we change books. + // If any book step in a payment strand consumes 1000 offers, the // liquidity from the offers is used, but that strand will be marked as // dry for the remainder of the transaction. diff --git a/src/test/app/DID_test.cpp b/src/test/app/DID_test.cpp index 20c367d64f..baa36ec7ea 100644 --- a/src/test/app/DID_test.cpp +++ b/src/test/app/DID_test.cpp @@ -1,9 +1,19 @@ -#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include + +#include #include #include - -#include +#include +#include namespace xrpl { namespace test { diff --git a/src/test/app/DNS_test.cpp b/src/test/app/DNS_test.cpp index 9b75e66b85..224c7278c1 100644 --- a/src/test/app/DNS_test.cpp +++ b/src/test/app/DNS_test.cpp @@ -1,11 +1,20 @@ -#include +#include + +#include #include #include +#include + +#include +#include #include +#include #include +#include +#include namespace xrpl { namespace test { @@ -62,7 +71,7 @@ public: { using boost::asio::ip::tcp; tcp::resolver resolver(env_.app().getIOContext()); - std::string port = pUrl_.port ? std::to_string(*pUrl_.port) : "443"; + std::string const port = pUrl_.port ? std::to_string(*pUrl_.port) : "443"; auto results = resolver.resolve(pUrl_.domain, port); auto it = results.begin(); auto end = results.end(); diff --git a/src/test/app/Delegate_test.cpp b/src/test/app/Delegate_test.cpp index 2618a95d0d..0ec4c3c917 100644 --- a/src/test/app/Delegate_test.cpp +++ b/src/test/app/Delegate_test.cpp @@ -1,9 +1,54 @@ -#include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -16,9 +61,9 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env{*this, features}; - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000000), gw, alice, bob); env.close(); @@ -39,8 +84,8 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account gw{"gateway"}; - Account alice{"alice"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; env.fund(XRP(100000), gw, alice); env.close(); @@ -112,9 +157,9 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this, features); - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(100000), gw, alice, bob); env.close(); @@ -203,8 +248,8 @@ class Delegate_test : public beast::unit_test::suite // reserve requirement not met { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; auto const txFee = env.current()->fees().base; env.fund(env.current()->fees().accountReserve(0) + txFee, alice); @@ -218,9 +263,9 @@ class Delegate_test : public beast::unit_test::suite // reserve recovered after deleting delegation object { Env env(*this); - Account bob{"bob"}; - Account alice{"alice"}; - Account carol{"carol"}; + Account const bob{"bob"}; + Account const alice{"alice"}; + Account const carol{"carol"}; auto const txFee = env.current()->fees().base; @@ -247,8 +292,8 @@ class Delegate_test : public beast::unit_test::suite // test reserve when sending transaction on behalf of other account { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(drops(env.current()->fees().accountReserve(1)), alice); env.fund(drops(env.current()->fees().accountReserve(2)), bob); @@ -274,37 +319,42 @@ class Delegate_test : public beast::unit_test::suite testcase("test fee"); using namespace jtx; - Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; - env.fund(XRP(10000), alice, carol); - env.fund(XRP(1000), bob); - env.close(); + // Common setup: fund alice, bob, carol with 1000 XRP. + auto setup = [&](Env& env) { + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; + env.fund(XRP(1000), alice, bob, carol); + env.close(); + return std::make_tuple(alice, bob, carol); + }; + // No fee deduction for terNO_DELEGATE_PERMISSION. { - auto aliceBalance = env.balance(alice); - auto bobBalance = env.balance(bob); - auto carolBalance = env.balance(carol); + Env env(*this); + auto [alice, bob, carol] = setup(env); - env(pay(alice, carol, XRP(100)), - fee(XRP(2000)), - delegate::as(bob), - ter(terNO_DELEGATE_PERMISSION)); + auto const aliceBalance = env.balance(alice); + auto const bobBalance = env.balance(bob); + auto const carolBalance = env.balance(carol); + + env(pay(alice, carol, XRP(100)), delegate::as(bob), ter(terNO_DELEGATE_PERMISSION)); env.close(); BEAST_EXPECT(env.balance(alice) == aliceBalance); BEAST_EXPECT(env.balance(bob) == bobBalance); BEAST_EXPECT(env.balance(carol) == carolBalance); } - env(delegate::set(alice, bob, {"Payment"})); - env.close(); - + // Delegate pays the fee successfully. { - // Delegate pays the fee - auto aliceBalance = env.balance(alice); - auto bobBalance = env.balance(bob); - auto carolBalance = env.balance(carol); + Env env(*this); + auto [alice, bob, carol] = setup(env); + env(delegate::set(alice, bob, {"Payment"})); + env.close(); + + auto const aliceBalance = env.balance(alice); + auto const bobBalance = env.balance(bob); + auto const carolBalance = env.balance(carol); auto const sendAmt = XRP(100); auto const feeAmt = XRP(10); @@ -315,11 +365,16 @@ class Delegate_test : public beast::unit_test::suite BEAST_EXPECT(env.balance(carol) == carolBalance + sendAmt); } + // Bob has insufficient balance to pay the fee, will get terINSUF_FEE_B. { - // insufficient balance to pay fee - auto aliceBalance = env.balance(alice); - auto bobBalance = env.balance(bob); - auto carolBalance = env.balance(carol); + Env env(*this); + auto [alice, bob, carol] = setup(env); + env(delegate::set(alice, bob, {"Payment"})); + env.close(); + + auto const aliceBalance = env.balance(alice); + auto const bobBalance = env.balance(bob); + auto const carolBalance = env.balance(carol); env(pay(alice, carol, XRP(100)), fee(XRP(2000)), @@ -331,22 +386,143 @@ class Delegate_test : public beast::unit_test::suite BEAST_EXPECT(env.balance(carol) == carolBalance); } + // The delegated account has enough balance to pay and delegator has enough reserve { - // fee is paid by Delegate - // on context reset (tec error) - auto aliceBalance = env.balance(alice); - auto bobBalance = env.balance(bob); - auto carolBalance = env.balance(carol); - auto const feeAmt = XRP(10); + // Common setup: fund accounts and grant Bob permission to pay on Alice's behalf. + // Alice is funded with exactly (paymentAmount + reserve + baseFee): baseFee covers + // the DelegateSet tx cost, leaving Alice with exactly (paymentAmount + reserve). + // highFee = reserve + baseFee, strictly greater than reserve, so that + // max(reserve, highFee) = highFee — making the direct payment check fail. + auto setup = [&](Env& env) { + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; - env(pay(alice, carol, XRP(20000)), - fee(feeAmt), - delegate::as(bob), - ter(tecUNFUNDED_PAYMENT)); + auto const baseFee = env.current()->fees().base; + auto const reserve = env.current()->fees().accountReserve(1); + auto const paymentAmount = XRP(1); + auto const highFee = reserve + baseFee; + BEAST_EXPECT(highFee > reserve); + + env.fund(paymentAmount + reserve + baseFee, alice); + env.fund(XRP(1000), bob); + env.fund(XRP(1000), carol); + env.close(); + + env(delegate::set(alice, bob, {"Payment"})); + env.close(); + + env.require(balance(alice, paymentAmount + reserve)); + + return std::make_tuple(alice, bob, carol, paymentAmount, highFee, reserve); + }; + + // Alice's balance (paymentAmount + reserve) is insufficient to cover both + // the payment and highFee directly. Even though fees are allowed to dip + // below reserve, when Alice pays the fee herself the required funds = + // paymentAmount + max(reserve, highFee) = paymentAmount + highFee + // (since highFee > reserve), which still exceeds her balance. + // tec: highFee is consumed from Alice's balance. + { + Env env(*this); + auto [alice, bob, carol, paymentAmount, highFee, reserve] = setup(env); + auto const aliceBalance = env.balance(alice); + auto const bobBalance = env.balance(bob); + auto const carolBalance = env.balance(carol); + + env(pay(alice, carol, paymentAmount), fee(highFee), ter(tecUNFUNDED_PAYMENT)); + + // tec consumes the fee from Alice; carol and bob are unaffected. + BEAST_EXPECT(env.balance(alice) == aliceBalance - highFee); + BEAST_EXPECT(env.balance(bob) == bobBalance); + BEAST_EXPECT(env.balance(carol) == carolBalance); + } + + // The payment succeeds because the delegated account pays the fee. + // Alice only needs (paymentAmount + reserve). + { + Env env(*this); + auto [alice, bob, carol, paymentAmount, highFee, reserve] = setup(env); + + auto const alicePrePay = env.balance(alice, XRP); + auto const bobPrePay = env.balance(bob, XRP); + auto const carolPrePay = env.balance(carol, XRP); + + env(pay(alice, carol, paymentAmount), delegate::as(bob), fee(highFee)); + env.close(); + + env.require(balance(alice, alicePrePay - paymentAmount)); + env.require(balance(bob, bobPrePay - highFee)); + env.require(balance(carol, carolPrePay + paymentAmount)); + } + } + + // Delegated account can pay the fee even if it dips below reserve. + { + Env env(*this); + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; + + auto const baseFee = env.current()->fees().base; + auto const baseReserve = env.current()->fees().accountReserve(0); + + env.fund(env.current()->fees().accountReserve(1) + baseFee + XRP(1), alice); + env.fund(baseReserve, bob); + env.fund(XRP(1000), carol); env.close(); - BEAST_EXPECT(env.balance(alice) == aliceBalance); - BEAST_EXPECT(env.balance(bob) == bobBalance - feeAmt); - BEAST_EXPECT(env.balance(carol) == carolBalance); + + env(delegate::set(alice, bob, {"Payment"})); + env.close(); + + auto const alicePreTx = env.balance(alice, XRP); + auto const bobPreTx = env.balance(bob, XRP); + + // After paying for this transaction, bob's balance will + // dip below the base reserve + env(pay(alice, carol, XRP(1)), delegate::as(bob)); + env.close(); + + // Bob's balance is now less than the base reserve. + BEAST_EXPECT(env.balance(bob, XRP) < baseReserve); + env.require(balance(bob, bobPreTx - drops(baseFee))); + + // Alice's balance only decreased by the 1.0 XRP she sent. + env.require(balance(alice, alicePreTx - XRP(1))); + } + + // The delegated account has enough balance for the fee, but delegator + // runs into tecUNFUNDED_PAYMENT. + { + Env env(*this); + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; + + auto const baseFee = env.current()->fees().base; + auto const reserve = env.current()->fees().accountReserve(1); + + // Alice is funded with (reserve + baseFee): after DelegateSet she has + // exactly 'reserve', which is insufficient to send XRP(10) while keeping + // reserve. Bob has plenty to pay the fee. + env.fund(reserve + baseFee, alice); + env.fund(XRP(1000), bob); + env.fund(XRP(1000), carol); + env.close(); + + env(delegate::set(alice, bob, {"Payment"})); + env.close(); + + auto const alicePrePay = env.balance(alice, XRP); + auto const bobPrePay = env.balance(bob, XRP); + auto const carolPrePay = env.balance(carol, XRP); + + // Bob pays the fee, but Alice has insufficient balance to send XRP(10). + env(pay(alice, carol, XRP(10)), delegate::as(bob), ter(tecUNFUNDED_PAYMENT)); + + env.require(balance(alice, alicePrePay)); + env.require(balance(bob, bobPrePay - drops(baseFee))); + env.require(balance(carol, carolPrePay)); } } @@ -357,9 +533,9 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(10000), alice, bob, carol); env.close(); @@ -410,8 +586,8 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(100000), alice, bob); env.close(); @@ -444,9 +620,9 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; XRPAmount const baseFee{env.current()->fees().base}; @@ -510,10 +686,10 @@ class Delegate_test : public beast::unit_test::suite // test PaymentMint and PaymentBurn { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account gw{"gateway"}; - Account gw2{"gateway2"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const gw{"gateway"}; + Account const gw2{"gateway2"}; auto const USD = gw["USD"]; auto const EUR = gw2["EUR"]; @@ -615,9 +791,9 @@ class Delegate_test : public beast::unit_test::suite // test PaymentMint won't affect Payment transaction level delegation. { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const gw{"gateway"}; auto const USD = gw["USD"]; env.fund(XRP(10000), alice); @@ -805,9 +981,9 @@ class Delegate_test : public beast::unit_test::suite // test TrustlineUnfreeze, TrustlineFreeze and TrustlineAuthorize { Env env(*this); - Account gw{"gw"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env(fset(gw, asfRequireAuth)); env.close(); @@ -917,9 +1093,9 @@ class Delegate_test : public beast::unit_test::suite // test mix of transaction level delegation and granular delegation { Env env(*this); - Account gw{"gw"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env(fset(gw, asfRequireAuth)); env.close(); @@ -962,9 +1138,9 @@ class Delegate_test : public beast::unit_test::suite // tfFullyCanonicalSig won't block delegated transaction { Env env(*this); - Account gw{"gw"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env(fset(gw, asfRequireAuth)); env.close(); @@ -1210,8 +1386,8 @@ class Delegate_test : public beast::unit_test::suite // tfFullyCanonicalSig won't block delegated transaction { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), alice, bob); env.close(); @@ -1238,8 +1414,8 @@ class Delegate_test : public beast::unit_test::suite // test MPTokenIssuanceUnlock and MPTokenIssuanceLock permissions { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(100000), alice, bob); env.close(); @@ -1285,8 +1461,8 @@ class Delegate_test : public beast::unit_test::suite // test mix of granular and transaction level permission { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(100000), alice, bob); env.close(); @@ -1332,8 +1508,8 @@ class Delegate_test : public beast::unit_test::suite // tfFullyCanonicalSig won't block delegated transaction { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(100000), alice, bob); env.close(); @@ -1356,9 +1532,9 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(100000), alice, bob, carol); env.close(); @@ -1384,9 +1560,9 @@ class Delegate_test : public beast::unit_test::suite { Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(100000), alice, bob, carol); env.close(); @@ -1410,7 +1586,9 @@ class Delegate_test : public beast::unit_test::suite { Env env(*this); - Account alice{"alice"}, bob{"bob"}, carol{"carol"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(100000), alice, bob, carol); env.close(); @@ -1444,7 +1622,9 @@ class Delegate_test : public beast::unit_test::suite { Env env(*this); - Account alice{"alice"}, bob{"bob"}, carol{"carol"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(100000), alice, bob, carol); env.close(); @@ -1481,11 +1661,11 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; - Account daria{"daria"}; - Account edward{"edward"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; + Account const daria{"daria"}; + Account const edward{"edward"}; env.fund(XRP(100000), alice, bob, carol, daria, edward); env.close(); @@ -1517,12 +1697,12 @@ class Delegate_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; - Account daria = Account{"daria"}; - Account edward = Account{"edward"}; - Account fred = Account{"fred"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; + Account const daria{"daria"}; + Account const edward{"edward"}; + Account const fred{"fred"}; env.fund(XRP(100000), alice, bob, carol, daria, edward, fred); env.close(); @@ -1559,8 +1739,8 @@ class Delegate_test : public beast::unit_test::suite Env env(*this, features); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(100000), alice, bob); env.close(); @@ -1721,6 +1901,21 @@ class Delegate_test : public beast::unit_test::suite "\n Action: Verify security requirements to interact with Delegation feature"); } + void + testDelegateUtilsNullptrCheck() + { + testcase("DelegateUtils nullptr check"); + + // checkTxPermission nullptr check + STTx const tx{ttPAYMENT, [](STObject&) {}}; + BEAST_EXPECT(checkTxPermission(nullptr, tx) == terNO_DELEGATE_PERMISSION); + + // loadGranularPermission nullptr check + std::unordered_set granularPermissions; + loadGranularPermission(nullptr, ttPAYMENT, granularPermissions); + BEAST_EXPECT(granularPermissions.empty()); + } + void run() override { @@ -1746,6 +1941,7 @@ class Delegate_test : public beast::unit_test::suite testPermissionValue(all); testTxRequireFeatures(all); testTxDelegableCount(); + testDelegateUtilsNullptrCheck(); } }; BEAST_DEFINE_TESTSUITE(Delegate, app, xrpl); diff --git a/src/test/app/DeliverMin_test.cpp b/src/test/app/DeliverMin_test.cpp index fe044353b7..12870f6224 100644 --- a/src/test/app/DeliverMin_test.cpp +++ b/src/test/app/DeliverMin_test.cpp @@ -1,7 +1,20 @@ -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include #include +#include +#include namespace xrpl { namespace test { diff --git a/src/test/app/DepositAuth_test.cpp b/src/test/app/DepositAuth_test.cpp index 7a8404aad8..6e865455c5 100644 --- a/src/test/app/DepositAuth_test.cpp +++ b/src/test/app/DepositAuth_test.cpp @@ -1,8 +1,48 @@ -#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -1045,7 +1085,7 @@ struct DepositPreauth_test : public beast::unit_test::suite // Create credentials auto jv = credentials::create(alice, issuer, credType); - // Current time in ripple epoch. + // Current time in XRPL epoch. // Every time ledger close, unittest timer increase by 10s uint32_t const t = env.current()->header().parentCloseTime.time_since_epoch().count() + 60; diff --git a/src/test/app/Discrepancy_test.cpp b/src/test/app/Discrepancy_test.cpp index 3f808b37d8..b01b11aa11 100644 --- a/src/test/app/Discrepancy_test.cpp +++ b/src/test/app/Discrepancy_test.cpp @@ -1,13 +1,25 @@ -#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include #include #include +#include #include +#include + namespace xrpl { class Discrepancy_test : public beast::unit_test::suite @@ -24,13 +36,13 @@ class Discrepancy_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this, features}; - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; - Account A5{"A5"}; - Account A6{"A6"}; - Account A7{"A7"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; + Account const A5{"A5"}; + Account const A6{"A6"}; + Account const A7{"A7"}; env.fund(XRP(2000), A1); env.fund(XRP(1000), A2, A6, A7); @@ -68,7 +80,7 @@ class Discrepancy_test : public beast::unit_test::suite env(offer(A7, XRP(1233), A6["CNY"](25))); env.close(); - test::PathSet payPaths{ + test::PathSet const payPaths{ test::Path{A2["JPY"], A2}, test::Path{XRP, A2["JPY"], A2}, test::Path{A6, XRP, A2["JPY"], A2}}; @@ -84,7 +96,7 @@ class Discrepancy_test : public beast::unit_test::suite jrq2[jss::transaction] = env.tx()->getJson(JsonOptions::none)[jss::hash]; jrq2[jss::id] = 3; auto jrr = env.rpc("json", "tx", to_string(jrq2))[jss::result]; - uint64_t fee{jrr[jss::Fee].asUInt()}; + uint64_t const fee{jrr[jss::Fee].asUInt()}; auto meta = jrr[jss::meta]; uint64_t sumPrev{0}; uint64_t sumFinal{0}; diff --git a/src/test/app/EscrowToken_test.cpp b/src/test/app/EscrowToken_test.cpp index 619b584ddb..22f11c5c93 100644 --- a/src/test/app/EscrowToken_test.cpp +++ b/src/test/app/EscrowToken_test.cpp @@ -1,16 +1,45 @@ -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include #include +#include #include +#include #include #include +#include +#include +#include +#include #include +#include #include +#include #include -#include #include +#include +#include #include +#include namespace xrpl { namespace test { @@ -983,13 +1012,13 @@ struct EscrowToken_test : public beast::unit_test::suite auto const aa = env.le(keylet::escrow(alice.id(), aseq)); BEAST_EXPECT(aa); { - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 2); BEAST_EXPECT(std::find(aod.begin(), aod.end(), aa) != aod.end()); } { - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 4); BEAST_EXPECT(std::find(iod.begin(), iod.end(), aa) != iod.end()); } @@ -1004,13 +1033,13 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(bb); { - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 2); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) != bod.end()); } { - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 5); BEAST_EXPECT(std::find(iod.begin(), iod.end(), bb) != iod.end()); } @@ -1022,15 +1051,15 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT( (*env.meta())[sfTransactionResult] == static_cast(tesSUCCESS)); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), aa) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 2); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) != bod.end()); - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 4); BEAST_EXPECT(std::find(iod.begin(), iod.end(), bb) != iod.end()); } @@ -1042,11 +1071,11 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT( (*env.meta())[sfTransactionResult] == static_cast(tesSUCCESS)); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 1); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) == bod.end()); - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 3); BEAST_EXPECT(std::find(iod.begin(), iod.end(), bb) == iod.end()); } @@ -1085,20 +1114,20 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(bc); { - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 2); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) != aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 3); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) != bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) != bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 2); BEAST_EXPECT(std::find(cod.begin(), cod.end(), bc) != cod.end()); - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 5); BEAST_EXPECT(std::find(iod.begin(), iod.end(), ab) != iod.end()); BEAST_EXPECT(std::find(iod.begin(), iod.end(), bc) != iod.end()); @@ -1110,19 +1139,19 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(!env.le(keylet::escrow(alice.id(), aseq))); BEAST_EXPECT(env.le(keylet::escrow(bob.id(), bseq))); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 2); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) == bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) != bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 2); - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 4); BEAST_EXPECT(std::find(iod.begin(), iod.end(), ab) == iod.end()); BEAST_EXPECT(std::find(iod.begin(), iod.end(), bc) != iod.end()); @@ -1134,19 +1163,19 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(!env.le(keylet::escrow(alice.id(), aseq))); BEAST_EXPECT(!env.le(keylet::escrow(bob.id(), bseq))); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 1); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) == bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) == bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 1); - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 3); BEAST_EXPECT(std::find(iod.begin(), iod.end(), ab) == iod.end()); BEAST_EXPECT(std::find(iod.begin(), iod.end(), bc) == iod.end()); @@ -1182,14 +1211,14 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(ag); { - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 2); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ag) != aod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 1); - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 3); BEAST_EXPECT(std::find(iod.begin(), iod.end(), ag) != iod.end()); } @@ -1199,14 +1228,14 @@ struct EscrowToken_test : public beast::unit_test::suite { BEAST_EXPECT(!env.le(keylet::escrow(alice.id(), aseq))); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ag) == aod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 1); - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 2); BEAST_EXPECT(std::find(iod.begin(), iod.end(), ag) == iod.end()); } @@ -1229,7 +1258,7 @@ struct EscrowToken_test : public beast::unit_test::suite bool negative; }; - std::array tests = {{ + std::array const tests = {{ // src > dst && src > issuer && dst no trustline {Account("alice2"), Account("bob0"), Account{"gw0"}, false, true}, // src < dst && src < issuer && dst no trustline @@ -1335,7 +1364,7 @@ struct EscrowToken_test : public beast::unit_test::suite env.close(); } - std::array gwDstTests = {{ + std::array const gwDstTests = {{ // src > dst && src > issuer && dst has trustline {Account("alice2"), Account{"gw0"}, true}, // src < dst && src < issuer && dst has trustline @@ -2522,7 +2551,7 @@ struct EscrowToken_test : public beast::unit_test::suite Sandbox sb(&view, tapNONE); auto sleNew = std::make_shared(keylet::escrow(alice, seq1)); MPTIssue const mpt{MPTIssue{makeMptID(1, AccountID(0x4985601))}}; - STAmount amt(mpt, 10); + STAmount const amt(mpt, 10); sleNew->setAccountID(sfDestination, bob); sleNew->setFieldAmount(sfAmount, amt); sb.insert(sleNew); @@ -2749,7 +2778,7 @@ struct EscrowToken_test : public beast::unit_test::suite Sandbox sb(&view, tapNONE); auto sleNew = std::make_shared(keylet::escrow(alice, seq1)); MPTIssue const mpt{MPTIssue{makeMptID(1, AccountID(0x4985601))}}; - STAmount amt(mpt, 10); + STAmount const amt(mpt, 10); sleNew->setAccountID(sfDestination, bob); sleNew->setFieldAmount(sfAmount, amt); sb.insert(sleNew); @@ -3100,13 +3129,13 @@ struct EscrowToken_test : public beast::unit_test::suite auto const aa = env.le(keylet::escrow(alice.id(), aseq)); BEAST_EXPECT(aa); { - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 2); BEAST_EXPECT(std::find(aod.begin(), aod.end(), aa) != aod.end()); } { - xrpl::Dir iod(*env.current(), keylet::ownerDir(gw.id())); + xrpl::Dir const iod(*env.current(), keylet::ownerDir(gw.id())); BEAST_EXPECT(std::distance(iod.begin(), iod.end()) == 1); BEAST_EXPECT(std::find(iod.begin(), iod.end(), aa) == iod.end()); } @@ -3121,7 +3150,7 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(bb); { - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 2); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) != bod.end()); } @@ -3133,11 +3162,11 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT( (*env.meta())[sfTransactionResult] == static_cast(tesSUCCESS)); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), aa) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 2); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) != bod.end()); } @@ -3149,7 +3178,7 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT( (*env.meta())[sfTransactionResult] == static_cast(tesSUCCESS)); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 1); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) == bod.end()); } @@ -3191,16 +3220,16 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(bc); { - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 2); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) != aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 3); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) != bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) != bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 2); BEAST_EXPECT(std::find(cod.begin(), cod.end(), bc) != cod.end()); } @@ -3211,16 +3240,16 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(!env.le(keylet::escrow(alice.id(), aseq))); BEAST_EXPECT(env.le(keylet::escrow(bob.id(), bseq))); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 2); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) == bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) != bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 2); } @@ -3230,16 +3259,16 @@ struct EscrowToken_test : public beast::unit_test::suite BEAST_EXPECT(!env.le(keylet::escrow(alice.id(), aseq))); BEAST_EXPECT(!env.le(keylet::escrow(bob.id(), bseq))); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bob.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bob.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 1); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) == bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) == bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 1); } } diff --git a/src/test/app/Escrow_test.cpp b/src/test/app/Escrow_test.cpp index 2e6ef718d6..fa20c8f38d 100644 --- a/src/test/app/Escrow_test.cpp +++ b/src/test/app/Escrow_test.cpp @@ -1,14 +1,36 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include #include #include #include +#include +#include #include #include #include #include +#include +#include +#include #include +#include namespace xrpl { namespace test { @@ -1057,7 +1079,7 @@ struct Escrow_test : public beast::unit_test::suite Env env(*this, features); env.fund(XRP(5000), "alice", "bob"); - std::array cb = { + std::array const cb = { {0xA2, 0x2B, 0x80, 0x20, 0x42, 0x4A, 0x70, 0x49, 0x49, 0x52, 0x92, 0x67, 0xB6, 0x21, 0xB3, 0xD7, 0x91, 0x19, 0xD7, 0x29, 0xB2, 0x38, 0x2C, 0xED, 0x8B, 0x29, 0x6C, 0x3C, 0x02, 0x8F, 0xA9, 0x7D, 0x35, 0x0F, 0x6D, 0x07, @@ -1100,7 +1122,7 @@ struct Escrow_test : public beast::unit_test::suite BEAST_EXPECT(aa); { - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), aa) != aod.end()); } @@ -1115,7 +1137,7 @@ struct Escrow_test : public beast::unit_test::suite BEAST_EXPECT(bb); { - xrpl::Dir bod(*env.current(), keylet::ownerDir(bruce.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bruce.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 1); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) != bod.end()); } @@ -1127,11 +1149,11 @@ struct Escrow_test : public beast::unit_test::suite BEAST_EXPECT( (*env.meta())[sfTransactionResult] == static_cast(tesSUCCESS)); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 0); BEAST_EXPECT(std::find(aod.begin(), aod.end(), aa) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bruce.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bruce.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 1); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) != bod.end()); } @@ -1143,7 +1165,7 @@ struct Escrow_test : public beast::unit_test::suite BEAST_EXPECT( (*env.meta())[sfTransactionResult] == static_cast(tesSUCCESS)); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bruce.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bruce.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 0); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bb) == bod.end()); } @@ -1174,16 +1196,16 @@ struct Escrow_test : public beast::unit_test::suite BEAST_EXPECT(bc); { - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 1); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) != aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bruce.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bruce.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 2); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) != bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) != bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 1); BEAST_EXPECT(std::find(cod.begin(), cod.end(), bc) != cod.end()); } @@ -1194,16 +1216,16 @@ struct Escrow_test : public beast::unit_test::suite BEAST_EXPECT(!env.le(keylet::escrow(alice.id(), aseq))); BEAST_EXPECT(env.le(keylet::escrow(bruce.id(), bseq))); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 0); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bruce.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bruce.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 1); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) == bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) != bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 1); } @@ -1213,16 +1235,16 @@ struct Escrow_test : public beast::unit_test::suite BEAST_EXPECT(!env.le(keylet::escrow(alice.id(), aseq))); BEAST_EXPECT(!env.le(keylet::escrow(bruce.id(), bseq))); - xrpl::Dir aod(*env.current(), keylet::ownerDir(alice.id())); + xrpl::Dir const aod(*env.current(), keylet::ownerDir(alice.id())); BEAST_EXPECT(std::distance(aod.begin(), aod.end()) == 0); BEAST_EXPECT(std::find(aod.begin(), aod.end(), ab) == aod.end()); - xrpl::Dir bod(*env.current(), keylet::ownerDir(bruce.id())); + xrpl::Dir const bod(*env.current(), keylet::ownerDir(bruce.id())); BEAST_EXPECT(std::distance(bod.begin(), bod.end()) == 0); BEAST_EXPECT(std::find(bod.begin(), bod.end(), ab) == bod.end()); BEAST_EXPECT(std::find(bod.begin(), bod.end(), bc) == bod.end()); - xrpl::Dir cod(*env.current(), keylet::ownerDir(carol.id())); + xrpl::Dir const cod(*env.current(), keylet::ownerDir(carol.id())); BEAST_EXPECT(std::distance(cod.begin(), cod.end()) == 0); } } diff --git a/src/test/app/FeeVote_test.cpp b/src/test/app/FeeVote_test.cpp index 3c84f9e007..4c4f041b87 100644 --- a/src/test/app/FeeVote_test.cpp +++ b/src/test/app/FeeVote_test.cpp @@ -1,16 +1,39 @@ -#include + +#include #include +#include #include +#include +#include +#include +#include #include #include #include +#include #include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -189,7 +212,7 @@ class FeeVote_test : public beast::unit_test::suite FeeSetup const defaultSetup; { // defaults - Section config; + Section const config; auto setup = setup_FeeVote(config); BEAST_EXPECT(setup.reference_fee == defaultSetup.reference_fee); BEAST_EXPECT(setup.account_reserve == defaultSetup.account_reserve); @@ -260,7 +283,7 @@ class FeeVote_test : public beast::unit_test::suite // Test successful fee transaction with legacy fields - FeeSettingsFields fields{ + FeeSettingsFields const fields{ .baseFee = 10, .reserveBase = 200000, .reserveIncrement = 50000, @@ -288,7 +311,7 @@ class FeeVote_test : public beast::unit_test::suite // Create the next ledger to apply transaction to ledger = std::make_shared(*ledger, env.app().getTimeKeeper().closeTime()); - FeeSettingsFields fields{ + FeeSettingsFields const fields{ .baseFeeDrops = XRPAmount{10}, .reserveBaseDrops = XRPAmount{200000}, .reserveIncrementDrops = XRPAmount{50000}}; @@ -408,7 +431,7 @@ class FeeVote_test : public beast::unit_test::suite ledger = std::make_shared(*ledger, env.app().getTimeKeeper().closeTime()); - FeeSettingsFields fields1{ + FeeSettingsFields const fields1{ .baseFeeDrops = XRPAmount{10}, .reserveBaseDrops = XRPAmount{200000}, .reserveIncrementDrops = XRPAmount{50000}}; @@ -425,7 +448,7 @@ class FeeVote_test : public beast::unit_test::suite // Apply second fee transaction with different values ledger = std::make_shared(*ledger, env.app().getTimeKeeper().closeTime()); - FeeSettingsFields fields2{ + FeeSettingsFields const fields2{ .baseFeeDrops = XRPAmount{20}, .reserveBaseDrops = XRPAmount{300000}, .reserveIncrementDrops = XRPAmount{75000}}; @@ -487,7 +510,7 @@ class FeeVote_test : public beast::unit_test::suite ledger = std::make_shared(*ledger, env.app().getTimeKeeper().closeTime()); - FeeSettingsFields fields1{ + FeeSettingsFields const fields1{ .baseFeeDrops = XRPAmount{10}, .reserveBaseDrops = XRPAmount{200000}, .reserveIncrementDrops = XRPAmount{50000}}; @@ -504,7 +527,7 @@ class FeeVote_test : public beast::unit_test::suite ledger = std::make_shared(*ledger, env.app().getTimeKeeper().closeTime()); // Apply partial update (only some fields) - FeeSettingsFields fields2{ + FeeSettingsFields const fields2{ .baseFeeDrops = XRPAmount{20}, .reserveBaseDrops = XRPAmount{200000}}; auto feeTx2 = createFeeTx(ledger->rules(), ledger->seq(), fields2); diff --git a/src/test/app/FixNFTokenPageLinks_test.cpp b/src/test/app/FixNFTokenPageLinks_test.cpp index 25366534cd..4a630cba74 100644 --- a/src/test/app/FixNFTokenPageLinks_test.cpp +++ b/src/test/app/FixNFTokenPageLinks_test.cpp @@ -1,9 +1,32 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include -#include -#include +#include + +#include +#include +#include namespace xrpl { diff --git a/src/test/app/FlowMPT_test.cpp b/src/test/app/FlowMPT_test.cpp new file mode 100644 index 0000000000..bd818f85d7 --- /dev/null +++ b/src/test/app/FlowMPT_test.cpp @@ -0,0 +1,2144 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +namespace xrpl { +namespace test { + +struct FlowMPT_test : public beast::unit_test::suite +{ + using Accounts = std::vector; + + void + testDirectStep(FeatureBitset features) + { + testcase("Direct Step"); + + using namespace jtx; + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const carol = Account("carol"); + auto const gw = Account("gw"); + { + // Pay USD, trivial path + Env env(*this, features); + + env.fund(XRP(10000), alice, bob, gw); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + env(pay(gw, alice, USD(100))); + env(pay(alice, bob, USD(10)), paths(USD)); + env.require(balance(bob, USD(10))); + } + { + // Partial payments + Env env(*this, features); + + env.fund(XRP(10000), alice, bob, gw); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + env(pay(gw, alice, USD(100))); + env(pay(alice, bob, USD(110)), paths(USD), ter(tecPATH_PARTIAL)); + env.require(balance(bob, USD(0))); + env(pay(alice, bob, USD(110)), paths(USD), txflags(tfPartialPayment)); + env.require(balance(bob, USD(100))); + } + + { + // Limit quality + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(10'000), gw, alice, bob, carol); + env.close(); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice, carol}}); + auto const EUR = + issue2({.env = env, .token = "EUR", .issuer = gw, .holders = {bob}}); + + env(pay(gw, alice, USD(100))); + env(pay(gw, bob, EUR(100))); + + env(offer(alice, EUR(4), USD(4))); + env.close(); + + env(pay(bob, carol, USD(5)), + sendmax(EUR(4)), + txflags(tfLimitQuality | tfPartialPayment), + ter(tecPATH_DRY)); + env.require(balance(carol, USD(0))); + + env(pay(bob, carol, USD(5)), sendmax(EUR(4)), txflags(tfPartialPayment)); + env.require(balance(carol, USD(4))); + }; + testHelper2TokensMix(test); + } + } + + void + testBookStep(FeatureBitset features) + { + testcase("Book Step"); + + using namespace jtx; + + auto const gw = Account("gateway"); + Account const alice("alice"); + Account const bob("bob"); + Account const carol("carol"); + + { + // simple [MPT|IOU]/[IOU|MPT] offer + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob, carol}}); + auto const BTC = issue2( + {.env = env, .token = "BTC", .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, alice, BTC(50))); + env(pay(gw, bob, USD(50))); + + env(offer(bob, BTC(50), USD(50))); + + env(pay(alice, carol, USD(50)), path(~USD), sendmax(BTC(50))); + + env.require(balance(alice, BTC(0))); + env.require(balance(bob, BTC(50))); + env.require(balance(bob, USD(0))); + env.require(balance(carol, USD(50))); + BEAST_EXPECT(!isOffer(env, bob, BTC(50), USD(50))); + }; + testHelper2TokensMix(test); + } + { + // simple [MPT|IOU]/XRP XRP/[IOU|MPT] offer + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob, carol}}); + auto const BTC = issue2( + {.env = env, .token = "BTC", .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, alice, BTC(50))); + env(pay(gw, bob, USD(50))); + + env(offer(bob, BTC(50), XRP(50))); + env(offer(bob, XRP(50), USD(50))); + + env(pay(alice, carol, USD(50)), path(~XRP, ~USD), sendmax(BTC(50))); + + env.require(balance(alice, BTC(0))); + env.require(balance(bob, BTC(50))); + env.require(balance(bob, USD(0))); + env.require(balance(carol, USD(50))); + BEAST_EXPECT(!isOffer(env, bob, XRP(50), USD(50))); + BEAST_EXPECT(!isOffer(env, bob, BTC(50), XRP(50))); + }; + testHelper2TokensMix(test); + } + { + // simple XRP -> USD through offer and sendmax + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, carol}}); + MPT const BTC = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, bob, USD(50))); + + env(offer(bob, XRP(50), USD(50))); + + env(pay(alice, carol, USD(50)), path(~USD), sendmax(XRP(50))); + + // fee: MPTokenAuthorize * 2(EUR, USD) + pay + env.require(balance(alice, XRP(10'000 - 50) - txfee(env, 3))); + // fee: MPTokenAuthorize * 2(EUR, USD) + offer + env.require(balance(bob, XRP(10'000 + 50) - txfee(env, 3))); + env.require(balance(bob, USD(0))); + env.require(balance(carol, USD(50))); + BEAST_EXPECT(!isOffer(env, bob, XRP(50), USD(50))); + } + { + // simple USD -> XRP through offer and sendmax + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, carol}}); + MPT const BTC = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, alice, USD(50))); + + env(offer(bob, USD(50), XRP(50))); + + env(pay(alice, carol, XRP(50)), path(~XRP), sendmax(USD(50))); + + env.require(balance(alice, USD(0))); + env.require(balance(bob, XRP(10'000 - 50) - txfee(env, 3))); + env.require(balance(bob, USD(50))); + env.require(balance(carol, XRP(10'000 + 50) - txfee(env, 2))); + BEAST_EXPECT(!isOffer(env, bob, USD(50), XRP(50))); + } + { + // test unfunded offers are removed when payment succeeds + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob, carol}}); + auto const BTC = issue2( + {.env = env, .token = "BTC", .issuer = gw, .holders = {alice, bob, carol}}); + auto const EUR = issue3( + {.env = env, .token = "EUR", .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, alice, BTC(60))); + env(pay(gw, bob, USD(50))); + env(pay(gw, bob, EUR(50))); + + env(offer(bob, BTC(50), USD(50))); + env(offer(bob, BTC(40), EUR(50))); + env(offer(bob, EUR(50), USD(50))); + + // unfund offer + env(pay(bob, gw, EUR(50))); + env.require(balance(bob, EUR(0))); + BEAST_EXPECT(isOffer(env, bob, BTC(50), USD(50))); + BEAST_EXPECT(isOffer(env, bob, BTC(40), EUR(50))); + BEAST_EXPECT(isOffer(env, bob, EUR(50), USD(50))); + + env(pay(alice, carol, USD(50)), path(~USD), path(~EUR, ~USD), sendmax(BTC(60))); + + env.require(balance(alice, BTC(10))); + env.require(balance(bob, BTC(50))); + env.require(balance(bob, USD(0))); + env.require(balance(bob, EUR(0))); + env.require(balance(carol, USD(50))); + // used in the payment + BEAST_EXPECT(!isOffer(env, bob, BTC(50), USD(50))); + // found unfunded + BEAST_EXPECT(!isOffer(env, bob, BTC(40), EUR(50))); + // unfunded, but should not yet be found unfunded + BEAST_EXPECT(isOffer(env, bob, EUR(50), USD(50))); + }; + testHelper3TokensMix(test); + } + { + // test unfunded offers are returned when the payment fails. + // bob makes two offers: a funded 5000 USD for 50 BTC and an + // unfunded 5000 EUR for 60 BTC. alice pays carol 6100 USD with 61 + // BTC. alice only has 60 BTC, so the payment will fail. The payment + // uses two paths: one through bob's funded offer and one through + // his unfunded offer. When the payment fails `flow` should return + // the unfunded offer. This test is intentionally similar to the one + // that removes unfunded offers when the payment succeeds. + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000}); + auto const EUR = issue3( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000}); + + env(pay(gw, alice, BTC(60))); + env(pay(gw, bob, USD(6'000))); + env(pay(gw, bob, EUR(5'000))); + env(pay(gw, carol, EUR(100))); + + env(offer(bob, BTC(50), USD(5'000))); + env(offer(bob, BTC(60), EUR(5'000))); + env(offer(carol, BTC(1'000), EUR(100))); + env(offer(bob, EUR(5'000), USD(5'000))); + + // unfund offer + env(pay(bob, gw, EUR(5'000))); + BEAST_EXPECT(isOffer(env, bob, BTC(50), USD(5'000))); + BEAST_EXPECT(isOffer(env, bob, BTC(60), EUR(5'000))); + BEAST_EXPECT(isOffer(env, carol, BTC(1'000), EUR(100))); + + auto flowJournal = env.app().getLogs().journal("Flow"); + auto const flowResult = [&] { + STAmount const deliver(USD(5'100)); + STAmount smax(BTC(61)); + PaymentSandbox sb(env.current().get(), tapNONE); + STPathSet paths; + auto IPE = [](Asset const& asset) { + return STPathElement( + STPathElement::typeAsset | STPathElement::typeIssuer, + xrpAccount(), + asset, + asset.getIssuer()); + }; + { + // BTC -> USD + STPath const p1({IPE(USD)}); + paths.push_back(p1); + // BTC -> EUR -> USD + STPath const p2({IPE(EUR), IPE(USD)}); + paths.push_back(p2); + } + + return flow( + sb, + deliver, + alice, + carol, + paths, + false, + false, + true, + OfferCrossing::no, + std::nullopt, + smax, + std::nullopt, + flowJournal); + }(); + + BEAST_EXPECT(flowResult.removableOffers.size() == 1); + env.app().getOpenLedger().modify([&](OpenView& view, beast::Journal j) { + if (flowResult.removableOffers.empty()) + return false; + Sandbox sb(&view, tapNONE); + for (auto const& o : flowResult.removableOffers) + { + if (auto ok = sb.peek(keylet::offer(o))) + offerDelete(sb, ok, flowJournal); + } + sb.apply(view); + return true; + }); + + // used in payment, but since payment failed should + // be untouched + BEAST_EXPECT(isOffer(env, bob, BTC(50), USD(5'000))); + BEAST_EXPECT(isOffer(env, carol, BTC(1'000), EUR(100))); + // found unfunded + BEAST_EXPECT(!isOffer(env, bob, BTC(60), EUR(5'000))); + }; + testHelper3TokensMix(test); + } + { + // Do not produce more in the forward pass than the + // reverse pass. This test uses a path whose reverse + // pass will compute a 0.5 USD input required for a 1 + // EUR output. It sets a sendmax of 0.4 USD, so the + // payment engine will need to do a forward pass. + // Without limits, the 0.4 USD would produce 1000 EUR in + // the forward pass. This test checks that the payment + // produces 1 EUR, as expected. + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + env.fund(XRP(10'000), alice, bob, carol, gw); + + auto const USD = issue1( + {.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob, carol}}); + auto const EUR = issue1( + {.env = env, .token = "EUR", .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, alice, USD(1'000))); + env(pay(gw, bob, EUR(1'000))); + + Keylet const bobUsdOffer = keylet::offer(bob, env.seq(bob)); + env(offer(bob, USD(10), drops(2)), txflags(tfPassive)); + env(offer(bob, drops(1), EUR(1'000)), txflags(tfPassive)); + + bool const reducedOffersV2 = features[fixReducedOffersV2]; + + // With reducedOffersV2, it is not allowed to accept + // less than USD(0.5) of bob's USD offer. If we + // provide 1 drop for less than USD(0.5), then the + // remaining fractional offer would block the order + // book. + TER const expectedTER = reducedOffersV2 ? TER(tecPATH_DRY) : TER(tesSUCCESS); + env(pay(alice, carol, EUR(1)), + path(~XRP, ~EUR), + sendmax(USD(4)), + txflags(tfNoRippleDirect | tfPartialPayment), + ter(expectedTER)); + + if (!reducedOffersV2) + { + env.require(balance(carol, EUR(1))); + env.require(balance(bob, USD(4))); + env.require(balance(bob, EUR(999))); + + // Show that bob's USD offer is now a blocker. + std::shared_ptr const usdOffer = env.le(bobUsdOffer); + if (BEAST_EXPECT(usdOffer)) + { + std::uint64_t const bookRate = [&usdOffer]() { + // Extract the least significant 64 + // bits from the book page. That's + // where the quality is stored. + std::string bookDirStr = to_string(usdOffer->at(sfBookDirectory)); + bookDirStr.erase(0, 48); + return std::stoull(bookDirStr, nullptr, 16); + }(); + std::uint64_t const actualRate = + getRate(usdOffer->at(sfTakerGets), usdOffer->at(sfTakerPays)); + + // We expect the actual rate of the offer to + // be worse (larger) than the rate of the + // book page holding the offer. This is a + // defect which is corrected by + // fixReducedOffersV2. + BEAST_EXPECT(actualRate > bookRate); + } + } + }; + testHelper2TokensMix(test); + } + } + + void + testTransferRate(FeatureBitset features) + { + testcase("Transfer Rate"); + + using namespace jtx; + + auto const gw = Account("gateway"); + Account const alice("alice"); + Account const bob("bob"); + Account const carol("carol"); + + { + // Simple payment through a gateway with a + // transfer rate + Env env(*this, features); + + env.fund(XRP(10000), alice, bob, carol, gw); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .maxAmt = 1'000}); + + env(pay(gw, alice, USD(50))); + env.require(balance(alice, USD(50))); + env(pay(alice, bob, USD(40)), sendmax(USD(50))); + env.require(balance(bob, USD(40)), balance(alice, USD(0))); + } + { + // transfer rate is not charged when issuer is src or + // dst + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .maxAmt = 1'000}); + + env(pay(gw, alice, USD(50))); + env.require(balance(alice, USD(50))); + env(pay(alice, gw, USD(40)), sendmax(USD(40))); + env.require(balance(alice, USD(10))); + } + { + // transfer fee on an offer + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol}, + .transferFee = 25'000, + .maxAmt = 10'000}); + + // scale by 1 + env(pay(gw, bob, USD(650))); + + env(offer(bob, XRP(50), USD(500))); + + env(pay(alice, carol, USD(500)), + path(~USD), + sendmax(XRP(50)), + txflags(tfPartialPayment)); + + // bob pays 25% on 500USD -> 100USD; 400USD goes to carol + env.require( + balance(alice, XRP(10'000 - 50) - txfee(env, 2)), + balance(bob, USD(150)), + balance(carol, USD(400))); + } + { + // Transfer fee two consecutive offers + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000, + .transferFee = 25'000}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 1'000, + .transferFee = 25'000}); + + env(pay(gw, bob, USD(50))); + env(pay(gw, bob, EUR(50))); + + env(offer(bob, XRP(50), USD(50))); + env(offer(bob, USD(50), EUR(50))); + + env(pay(alice, carol, EUR(40)), + path(~USD, ~EUR), + sendmax(XRP(40)), + txflags(tfPartialPayment)); + // +1 for fset in helperIssueIOU + using tEUR = std::decay_t; + auto const fee = txfee(env, 3); + // bob pays 25% on 40USD (40 since sendmax is 40XRP) + // 8USD goes to gw and 32USD goes back to bob -> + // bob's USD balance is 42USD. USD/EUR offer is 32USD/32EUR. + // bob pays 25% on 32EUR -> 7EUR if MPT, 6.4EUR if IOU, + // therefore carl gets 25EUR if MPT, 25.6EUR if IOU. + auto const carolEUR = [&]() { + if constexpr (std::is_same_v) + { + return EUR(25.6); + } + else + { + return EUR(25); + } + }(); + env.require( + balance(alice, XRP(10'000 - 40) - fee), + balance(bob, USD(42)), + balance(bob, EUR(18)), + balance(carol, carolEUR)); + }; + testHelper2TokensMix(test); + } + { + // Offer where the owner is also the issuer, sender pays + // fee + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, gw); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .transferFee = 25'000, + .maxAmt = 1'000}); + + env(offer(gw, XRP(100), USD(100))); + env(pay(alice, bob, USD(100)), sendmax(XRP(100)), txflags(tfPartialPayment)); + env.require(balance(alice, XRP(10'000 - 100) - txfee(env, 2)), balance(bob, USD(80))); + } + { + // Offer where the owner is also the issuer, sender pays + // fee + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, gw); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .transferFee = 25'000, + .maxAmt = 1'000}); + + env(offer(gw, XRP(125), USD(125))); + env(pay(alice, bob, USD(100)), sendmax(XRP(200))); + env.require(balance(alice, XRP(10'000 - 125) - txfee(env, 2)), balance(bob, USD(100))); + } + } + + void + testFalseDry(FeatureBitset features) + { + testcase("falseDryChanges"); + + using namespace jtx; + + auto const gw = Account("gateway"); + Account const alice("alice"); + Account const bob("bob"); + Account const carol("carol"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, carol, gw); + env.fund(reserve(env, 5), bob); + env.close(); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice, carol, bob}}); + auto const EUR = + issue2({.env = env, .token = "EUR", .issuer = gw, .holders = {alice, carol, bob}}); + + env(pay(gw, alice, EUR(50))); + env(pay(gw, bob, USD(50))); + + // Bob has _just_ slightly less than 50 xrp available + // If his owner count changes, he will have more liquidity. + // This is one error case to test (when Flow is used). + // Computing the incoming xrp to the XRP/USD offer will + // require two recursive calls to the EUR/XRP offer. The + // second call will return tecPATH_DRY, but the entire path + // should not be marked as dry. This is the second error + // case to test (when flowV1 is used). + env(offer(bob, EUR(50), XRP(50))); + env(offer(bob, XRP(50), USD(50))); + + env(pay(alice, carol, USD(1'000'000)), + path(~XRP, ~USD), + sendmax(EUR(500)), + txflags(tfNoRippleDirect | tfPartialPayment)); + + auto const carolUSD = env.balance(carol, USD).value(); + BEAST_EXPECT(carolUSD > USD(0) && carolUSD < USD(50)); + }; + testHelper2TokensMix(test); + } + + void + testLimitQuality() + { + // Single path with two offers and limit quality. The + // quality limit is such that the first offer should be + // taken but the second should not. The total amount + // delivered should be the sum of the two offers and sendMax + // should be more than the first offer. + testcase("limitQuality"); + using namespace jtx; + + auto const gw = Account("gateway"); + Account const alice("alice"); + Account const bob("bob"); + Account const carol("carol"); + + { + Env env(*this); + + env.fund(XRP(10'000), alice, bob, carol, gw); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, bob, USD(100))); + env(offer(bob, XRP(50), USD(50))); + env(offer(bob, XRP(100), USD(50))); + + env(pay(alice, carol, USD(100)), + path(~USD), + sendmax(XRP(100)), + txflags(tfNoRippleDirect | tfPartialPayment | tfLimitQuality)); + + env.require(balance(carol, USD(50))); + } + } + + // Helper function that returns the reserve on an account based on + // the passed in number of owners. + static XRPAmount + reserve(jtx::Env& env, std::uint32_t count) + { + return env.current()->fees().accountReserve(count); + } + + // Helper function that returns the Offers on an account. + static std::vector> + offersOnAccount(jtx::Env& env, jtx::Account account) + { + std::vector> result; + forEachItem(*env.current(), account, [&result](std::shared_ptr const& sle) { + if (sle->getType() == ltOFFER) + result.push_back(sle); + }); + return result; + } + + void + testSelfPayment1(FeatureBitset features) + { + testcase("Self-payment 1"); + + // In this test case the new flow code mis-computes the + // amount of money to move. Fortunately the new code's + // re-execute check catches the problem and throws out the + // transaction. + // + // The old payment code handles the payment correctly. + using namespace jtx; + + auto test = [&](auto&& issue1, auto&& issue2) { + auto const gw1 = Account("gw1"); + auto const gw2 = Account("gw2"); + auto const alice = Account("alice"); + + Env env(*this, features); + + env.fund(XRP(1'000'000), gw1, gw2); + env.close(); + + // The fee that's charged for transactions. + auto const f = env.current()->fees().base; + + env.fund(reserve(env, 3) + f * 4, alice); + env.close(); + + auto const USD = issue1( + {.env = env, .token = "USD", .issuer = gw1, .holders = {alice}, .limit = 20'000}); + auto const EUR = issue2( + {.env = env, .token = "EUR", .issuer = gw2, .holders = {alice}, .limit = 20'000}); + + env(pay(gw1, alice, USD(10))); + env(pay(gw2, alice, EUR(10'000))); + env.close(); + + env(offer(alice, USD(5'000), EUR(6'000))); + env.close(); + + env.require(owners(alice, 3)); + env.require(balance(alice, USD(10))); + env.require(balance(alice, EUR(10'000))); + + auto aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + for (auto const& offerPtr : aliceOffers) + { + auto const offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == EUR(6'000)); + BEAST_EXPECT(offer[sfTakerPays] == USD(5'000)); + } + + env(pay(alice, alice, EUR(6'000)), sendmax(USD(5'000)), txflags(tfPartialPayment)); + env.close(); + + env.require(owners(alice, 3)); + env.require(balance(alice, USD(10))); + env.require(balance(alice, EUR(10'000))); + aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + for (auto const& offerPtr : aliceOffers) + { + auto const offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + if constexpr (std::is_same_v, IOU>) + { + BEAST_EXPECT(offer[sfTakerGets] == EUR(5'988)); + } + else + { + BEAST_EXPECT(offer[sfTakerGets] == EUR(5'989)); + } + BEAST_EXPECT(offer[sfTakerPays] == USD(4'990)); + } + }; + testHelper2TokensMix(test); + } + + template + struct TokenData + { + TGets gets; + TPays pays; + jtx::PrettyAmount remTakerGets; + jtx::PrettyAmount remTakerPays; + }; + + void + testSelfPayment2(FeatureBitset features) + { + testcase("Self-payment 2"); + + using namespace jtx; + + // This test shows a difference between IOU and MPT + // self-payment result depending on IOU trustline limit. + + auto const gw1 = Account("gw1"); + auto const gw2 = Account("gw2"); + auto const alice = Account("alice"); + + auto initMPT = [&](Env& env) { + MPT const USD = + MPTTester({.env = env, .issuer = gw1, .holders = {alice}, .maxAmt = 506}); + MPT const EUR = + MPTTester({.env = env, .issuer = gw2, .holders = {alice}, .maxAmt = 606}); + // Payment's engine last step overflows + // OutstandingAmount since it doesn't know if the + // BookStep redeems or not. The BookStep then has 600EUR + // available. Consequently, the entire offer is crossed. + // Note remaining takerGets is 541 rather than 540 due to integral + // rounding. XRP has a similar result. + return TokenData{EUR, USD, EUR(541), USD(450)}; + }; + + auto initXRP = [&](Env& env) { + MPT const USD = + MPTTester({.env = env, .issuer = gw1, .holders = {alice}, .maxAmt = 1'000}); + // Payment's engine last step overflows + // OutstandingAmount since it doesn't know if the + // BookStep redeems or not. The BookStep then has 600EUR + // available. Consequently, the entire offer is crossed. + // Note remaining takerGets is 540.000001 rather than 540 due to + // integral rounding. + return TokenData{XRP, USD, XRP(540.000001), USD(450)}; + }; + + auto initIOU = [&](Env& env) { + auto const USD = gw1["USD"]; + auto const EUR = gw2["EUR"]; + env(trust(alice, USD(506))); + env(trust(alice, EUR(606))); + env.close(); + // Payment's engine last step is limited by alice's + // trustline - 606. Therefore, only 6EUR is delivered + // and the offer is partially crossed. + return TokenData{EUR, USD, EUR(594), USD(495)}; + }; + + auto initIOU1 = [&](Env& env) { + auto const USD = gw1["USD"]; + auto const EUR = gw2["EUR"]; + env(trust(alice, USD(1'000))); + env(trust(alice, EUR(1'000))); + env.close(); + // Payment's engine last step is not limited by alice's + // trustline. Therefore, the entire offer is crossed. + // This the same result as with MPT. + return TokenData{EUR, USD, EUR(540), USD(450)}; + }; + + auto test = [&](auto&& initToken) { + Env env(*this, features); + + env.fund(XRP(2'000), gw1, gw2, alice); + env.close(); + + auto const f = env.current()->fees().base; + + auto const tok = initToken(env); + + auto const& TOK1 = tok.pays; + auto const& TOK2 = tok.gets; + bool const isTakerGetsXRP = isXRP(Asset{TOK2}); + std::uint32_t const ownerCnt = isTakerGetsXRP ? 2 : 3; + + env(pay(gw1, alice, TOK1(500))); + if (!isTakerGetsXRP) + env(pay(gw2, alice, TOK2(600))); + env.close(); + + env(offer(alice, TOK1(500), TOK2(600))); + env.close(); + + env.require(owners(alice, ownerCnt)); + env.require(balance(alice, TOK1(500))); + if (isTakerGetsXRP) + { + env.require(balance(alice, TOK2(2'000) - 2 * f)); + } + else + { + env.require(balance(alice, TOK2(600))); + } + + auto aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + for (auto const& offerPtr : aliceOffers) + { + auto const offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == TOK2(600)); + BEAST_EXPECT(offer[sfTakerPays] == TOK1(500)); + } + + env(pay(alice, alice, TOK2(60)), sendmax(TOK1(50)), txflags(tfPartialPayment)); + env.close(); + + env.require(owners(alice, ownerCnt)); + env.require(balance(alice, TOK1(500))); + if (isTakerGetsXRP) + { + env.require(balance(alice, TOK2(2'000) - 3 * f)); + } + else + { + env.require(balance(alice, TOK2(600))); + } + aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + for (auto const& offerPtr : aliceOffers) + { + auto const offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == tok.remTakerGets); + BEAST_EXPECT(offer[sfTakerPays] == tok.remTakerPays); + } + }; + + test(initXRP); + test(initMPT); + test(initIOU); + test(initIOU1); + } + + void + testSelfFundedXRPEndpoint(bool consumeOffer, FeatureBitset features) + { + // Test that the deferred credit table is not bypassed for + // XRPEndpointSteps. If the account in the first step is + // sending XRP and that account also owns an offer that + // receives XRP, it should not be possible for that step to + // use the XRP received in the offer as part of the payment. + testcase("Self funded XRPEndpoint"); + + using namespace jtx; + + Env env(*this, features); + + auto const alice = Account("alice"); + auto const gw = Account("gw"); + + env.fund(XRP(10'000), alice, gw); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}, .maxAmt = 20}); + + env(pay(gw, alice, USD(10))); + env(offer(alice, XRP(50'000), USD(10))); + + // Consuming the offer changes the owner count, which could + // also cause liquidity to decrease in the forward pass + auto const toSend = consumeOffer ? USD(10) : USD(9); + env(pay(alice, alice, toSend), + path(~USD), + sendmax(XRP(20'000)), + txflags(tfPartialPayment | tfNoRippleDirect)); + } + + void + testUnfundedOffer(FeatureBitset features) + { + testcase("Unfunded Offer"); + + using namespace jtx; + { + // Test reverse + Env env(*this, features); + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const gw = Account("gw"); + + env.fund(XRP(100'000), alice, bob, gw); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 20E+17}); + + // scale by 17 + STAmount const tinyAmt1{USD, 9'000'000'000'000'000ll, 0, false, STAmount::unchecked{}}; + STAmount const tinyAmt3{USD, 9'000'000'000'000'003ll, 0, false, STAmount::unchecked{}}; + + env(offer(gw, drops(9'000'000'000), tinyAmt3)); + + env(pay(alice, bob, tinyAmt1), + path(~USD), + sendmax(drops(9'000'000'000)), + txflags(tfNoRippleDirect)); + + BEAST_EXPECT(!isOffer(env, gw, XRP(0), USD(0))); + } + { + // Test forward + Env env(*this, features); + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const gw = Account("gw"); + + env.fund(XRP(100'000), alice, bob, gw); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 20E+17}); + + // scale by 17 + STAmount const tinyAmt1{USD, 9'000'000'000'000'000ll, 0, false, STAmount::unchecked{}}; + STAmount const tinyAmt3{USD, 9'000'000'000'000'003ll, 0, false, STAmount::unchecked{}}; + + env(pay(gw, alice, tinyAmt1)); + + env(offer(gw, tinyAmt3, drops(9'000'000'000))); + env(pay(alice, bob, drops(9'000'000'000)), + path(~XRP), + sendmax(USD(static_cast(1E+17))), + txflags(tfNoRippleDirect)); + + BEAST_EXPECT(!isOffer(env, gw, USD(0), XRP(0))); + } + } + + void + testReExecuteDirectStep(FeatureBitset features) + { + testcase("ReexecuteDirectStep"); + + using namespace jtx; + Env env(*this, features); + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const gw = Account("gw"); + + env.fund(XRP(10'000), alice, bob, gw); + + // scale by 16 + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 100E+16}); + + env( + pay(gw, + alice, + // 12.55.... + STAmount{USD, std::uint64_t(1255555555555555ull), 2, false})); + + env(offer( + gw, + // 5.0... + STAmount{USD, std::uint64_t(5000000000000000ull), 1, false}, + XRP(1000))); + + env(offer( + gw, + // .555... + STAmount{USD, std::uint64_t(5555555555555555ull), 0, false}, + XRP(10))); + + env(offer( + gw, + // 4.44.... + STAmount{USD, std::uint64_t(4444444444444444ull), 1, false}, + XRP(.1))); + + env(offer( + alice, + // 17 + STAmount{USD, std::uint64_t(1700000000000000ull), 0, false}, + XRP(.001))); + + env(pay(alice, bob, XRP(10'000)), + path(~XRP), + sendmax(USD(static_cast(100E+16))), + txflags(tfPartialPayment | tfNoRippleDirect)); + } + + void + testSelfPayLowQualityOffer(FeatureBitset features) + { + // The new payment code used to assert if an offer was made + // for more XRP than the offering account held. This unit + // test reproduces that failing case. + testcase("Self crossing low quality offer"); + + using namespace jtx; + + Env env(*this, features); + + auto const ann = Account("ann"); + auto const gw = Account("gateway"); + + auto const fee = env.current()->fees().base; + env.fund(reserve(env, 2) + drops(9999640) + fee, ann); + env.fund(reserve(env, 2) + fee * 4, gw); + + // scale by 5 + MPT const CTB = MPTTester( + {.env = env, + .issuer = gw, + .holders = {ann}, + .transferFee = 2'000, // 2% + .maxAmt = 1'000'000}); + + env(pay(gw, ann, CTB(285'600))); + env.close(); + + env(offer(ann, drops(365'611'702'030), CTB(571'300))); + env.close(); + + // This payment caused assert. + env(pay(ann, ann, CTB(68'700)), sendmax(drops(20'000'000'000)), txflags(tfPartialPayment)); + } + + void + testEmptyStrand(FeatureBitset features) + { + testcase("Empty Strand"); + using namespace jtx; + + auto const alice = Account("alice"); + + Env env(*this, features); + + env.fund(XRP(10000), alice); + + MPT const USD; + + env(pay(alice, alice, USD(100)), path(~USD), ter(temBAD_PATH)); + } + + void + testXRPPathLoop() + { + testcase("Circular XRP"); + + using namespace jtx; + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const gw = Account("gw"); + + { + // Payment path starting with XRP + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(10'000), alice, bob, gw); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob}}); + auto const EUR = + issue2({.env = env, .token = "EUR", .issuer = gw, .holders = {alice, bob}}); + env(pay(gw, alice, USD(100))); + env(pay(gw, alice, EUR(100))); + env.close(); + + env(offer(alice, XRP(100), USD(100)), txflags(tfPassive)); + env(offer(alice, USD(100), XRP(100)), txflags(tfPassive)); + env(offer(alice, XRP(100), EUR(100)), txflags(tfPassive)); + env.close(); + + TER const expectedTer = TER{temBAD_PATH_LOOP}; + env(pay(alice, bob, EUR(1)), + path(~USD, ~XRP, ~EUR), + sendmax(XRP(1)), + txflags(tfNoRippleDirect), + ter(expectedTer)); + }; + testHelper2TokensMix(test); + } + { + // Payment path ending with XRP + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + env.fund(XRP(10'000), alice, bob, gw); + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob}}); + auto const EUR = + issue2({.env = env, .token = "EUR", .issuer = gw, .holders = {alice, bob}}); + env(pay(gw, alice, USD(100))); + env(pay(gw, alice, EUR(100))); + env.close(); + + env(offer(alice, XRP(100), USD(100)), txflags(tfPassive)); + env(offer(alice, EUR(100), XRP(100)), txflags(tfPassive)); + env.close(); + // EUR -> //XRP -> //USD ->XRP + env(pay(alice, bob, XRP(1)), + path(~XRP, ~USD, ~XRP), + sendmax(EUR(1)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper2TokensMix(test); + } + { + // Payment where loop is formed in the middle of the + // path, not on an endpoint + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env(*this); + env.fund(XRP(10'000), alice, bob, gw); + env.close(); + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob}}); + auto const EUR = + issue2({.env = env, .token = "EUR", .issuer = gw, .holders = {alice, bob}}); + auto const JPY = + issue3({.env = env, .token = "JPY", .issuer = gw, .holders = {alice, bob}}); + env(pay(gw, alice, USD(100))); + env(pay(gw, alice, EUR(100))); + env(pay(gw, alice, JPY(100))); + env.close(); + + env(offer(alice, USD(100), XRP(100)), txflags(tfPassive)); + env(offer(alice, XRP(100), EUR(100)), txflags(tfPassive)); + env(offer(alice, EUR(100), XRP(100)), txflags(tfPassive)); + env(offer(alice, XRP(100), JPY(100)), txflags(tfPassive)); + env.close(); + + env(pay(alice, bob, JPY(1)), + path(~XRP, ~EUR, ~XRP, ~JPY), + sendmax(USD(1)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper3TokensMix(test); + } + } + + void + testMaxAndSelfPaymentEdgeCases(FeatureBitset features) + { + testcase("Max Flow/Self Payment Edge Cases"); + using namespace jtx; + Account const gw("gw"); + Account const alice("alice"); + Account const carol("carol"); + Account const bob("bob"); + + // Direct payment between holders. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}, .maxAmt = 100}); + + env(pay(gw, alice, USD(100))); + + env(pay(alice, carol, USD(100))); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-100)); + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + BEAST_EXPECT(env.balance(alice, USD) == USD(0)); + } + + // Direct payment between holders. Partial payment limited + // by holder funds. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}, .maxAmt = 100}); + + env(pay(gw, alice, USD(80))); + + env(pay(alice, carol, USD(100)), txflags(tfPartialPayment)); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-80)); + BEAST_EXPECT(env.balance(alice, USD) == USD(0)); + BEAST_EXPECT(env.balance(carol, USD) == USD(80)); + } + + // Direct payment between holders. Partial payment limited + // by holder funds. OutstandingAmount is already at max + // before the payment. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol, bob); + + MPT const USD = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, carol, bob}, .maxAmt = 100}); + + env(pay(gw, bob, USD(20))); + env(pay(gw, alice, USD(80))); + + env(pay(alice, carol, USD(100)), txflags(tfPartialPayment)); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-100)); + BEAST_EXPECT(env.balance(alice, USD) == USD(0)); + BEAST_EXPECT(env.balance(carol, USD) == USD(80)); + } + + // Cross-currency payment holder to holder. Holder owns an + // offer. OutstandingAmount is already at max before the + // payment. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol, bob); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}, .maxAmt = 100}); + + env(pay(gw, alice, USD(100))); + + env(offer(alice, XRP(100), USD(100))); + + env(pay(bob, carol, USD(100)), sendmax(XRP(100)), path(~USD)); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-100)); + BEAST_EXPECT(env.balance(alice, USD) == USD(0)); + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + } + + // Cross-currency payment holder to holder. Issuer owns an + // offer. OutstandingAmount is already at max before the + // payment. Since an issuer owns the offer, it issues more + // tokens to another holder, and the payment fails. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {carol}, .maxAmt = 100}); + + env(pay(gw, carol, USD(100))); + + env(offer(gw, XRP(100), USD(100))); + + env(pay(alice, carol, USD(100)), + sendmax(XRP(100)), + path(~USD), + txflags(tfPartialPayment), + ter(tecPATH_DRY)); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-100)); + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + } + + // Cross-currency payment holder to holder. Issuer owns an + // offer. OutstandingAmount is at 80USD before the payment. + // Consequently, the issuer can issue 20USD more. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {carol}, .maxAmt = 100}); + + env(pay(gw, carol, USD(80))); + + env(offer(gw, XRP(100), USD(100))); + + env(pay(alice, carol, USD(100)), + sendmax(XRP(100)), + path(~USD), + txflags(tfPartialPayment)); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-100)); + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + } + + // Cross-currency payment holder to holder. Holder owns an + // offer. The offer buys more MPT's. The payment fails since + // OutstandingAmount is already at max. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .maxAmt = 100}); + + env(pay(gw, alice, USD(100))); + + env(offer(alice, USD(100), XRP(100))); + + env(pay(gw, alice, XRP(100)), sendmax(USD(100)), path(~XRP), ter(tecPATH_PARTIAL)); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-100)); + BEAST_EXPECT(env.balance(alice, USD) == USD(100)); + } + + // Cross-currency payment issuer to holder. Holder owns an + // offer. The offer buys EUR, OutstandingAmount goes to max, + // no overflow. The offer redeems USD to the issuer. While + // OutstandingAmount is already at max, the payment succeeds + // since USD is redeemed. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol}, + .limit = 100}); + using tUSD = std::decay_t; + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, carol}, + .limit = 100}); + + env(pay(gw, alice, USD(100))); + + env(offer(alice, EUR(100), USD(100))); + + env(pay(gw, carol, USD(100)), sendmax(EUR(100)), path(~USD)); + + if constexpr (std::is_same_v) + BEAST_EXPECT(env.balance(gw, USD) == USD(-100)); + BEAST_EXPECT(env.balance(alice, USD) == USD(0)); + BEAST_EXPECT(env.balance(alice, EUR) == EUR(100)); + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + }; + testHelper2TokensMix(test); + } + + // Cross-currency payment holder to holder. Offer is owned + // by destination account. OutstandingAmount is not at max. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {carol}, .maxAmt = 120}); + + env(pay(gw, carol, USD(100))); + + env(offer(carol, XRP(100), USD(100))); + + env(pay(alice, carol, USD(100)), + path(~USD), + sendmax(XRP(100)), + txflags(tfPartialPayment)); + + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + } + + // Cross-currency payment holder to holder. Offer is owned + // by destination account. OutstandingAmount is already at + // max. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {carol}, .maxAmt = 100}); + + env(pay(gw, carol, USD(100))); + + env(offer(carol, XRP(100), USD(100))); + + env(pay(alice, carol, USD(100)), + path(~USD), + sendmax(XRP(100)), + txflags(tfPartialPayment)); + + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + } + + // Cross-currency payment holder to holder. Multiple offers + // with different owners - some holders, some issuer. + { + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol, bob); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, carol, bob}, + .limit = 1'000}); + using tUSD = std::decay_t; + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, carol, bob}, + .limit = 1'000}); + using tEUR = std::decay_t; + + env(pay(gw, alice, USD(600))); + env(pay(gw, carol, EUR(700))); + + env(offer(alice, EUR(100), USD(105))); + env(offer(gw, EUR(100), USD(104))); + env(offer(gw, EUR(100), USD(103))); + env(offer(gw, EUR(100), USD(102))); + env(offer(gw, EUR(100), USD(101))); + env(offer(gw, EUR(100), USD(100))); + + env(pay(carol, bob, USD(2'000)), + sendmax(EUR(2'000)), + path(~USD), + txflags(tfPartialPayment)); + + if constexpr (std::is_same_v) + { + BEAST_EXPECT(env.balance(gw, USD) == USD(-1'000)); + BEAST_EXPECT(env.balance(alice, USD) == USD(495)); + BEAST_EXPECT(env.balance(bob, USD) == USD(505)); + } + else + { + BEAST_EXPECT(env.balance(gw, USD) == USD(0)); + BEAST_EXPECT(env.balance(alice, USD) == USD(495)); + // all offers are consumed since the limit is different + // for the holders + BEAST_EXPECT(env.balance(bob, USD) == USD(615)); + } + if constexpr (std::is_same_v) + { + if constexpr (std::is_same_v) + { + BEAST_EXPECT(env.balance(carol, EUR) == EUR(210)); + } + else + { + // carol sells 600USD since all offers are consumed + BEAST_EXPECT(env.balance(carol, EUR) == EUR(100)); + } + } + else + { + BEAST_EXPECT( + env.balance(carol, EUR) == STAmount(EUR, UINT64_C(209'9009900990099), -13)); + } + // 100/101 is partially crossed (90/91) and 100/100 is + // unfunded when MPT. All offers are consumed if IOU. + env.require(offers(gw, 0)); + // alice's offer is consumed. + env.require(offers(alice, 0)); + }; + testHelper2TokensMix(test); + } + + // Cross-currency payment holder to holder. Multiple offers + // with different owners - some holders, some issuer. Source + // and destination account is the same. + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}, .maxAmt = 2'000}); + + env(pay(gw, carol, USD(1'000))); + env(pay(gw, alice, USD(600))); + + env(offer(gw, XRP(5), USD(11))); + env(offer(gw, XRP(6), USD(13))); + env(offer(carol, XRP(7), USD(15))); + env(offer(carol, XRP(17), USD(35))); + env(offer(carol, XRP(23), USD(47))); + env(offer(alice, XRP(10), USD(19))); + env(offer(alice, XRP(15), USD(28))); + env(offer(alice, XRP(25), USD(46))); + + env(pay(carol, carol, USD(200)), sendmax(XRP(100)), txflags(tfPartialPayment)); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-1'624)); + BEAST_EXPECT(env.balance(carol, USD) == USD(1'102)); + env.require(offers(carol, 0)); + env.require(offers(gw, 0)); + // 100 XRP's = 5+6+7+17+23+10+15+17(25-8) + BEAST_EXPECT(isOffer(env, alice, XRP(8), USD(15))); + } + + // Cross-currency payment holder to holder. Multiple offers + // with different owners - some holders, some issuer. + { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol, bob); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, carol, bob}, .maxAmt = 30}); + + env(pay(gw, alice, USD(12))); // 12, 15, 20 + env(pay(gw, bob, USD(5))); // 5, 5, 10 + + env(offer(alice, XRP(10), USD(12))); + env(offer(gw, XRP(10), USD(11))); + env(offer(bob, XRP(10), USD(10))); + + env(pay(carol, bob, USD(30)), sendmax(XRP(30)), txflags(tfPartialPayment), path(~USD)); + BEAST_EXPECT(env.balance(gw, USD) == USD(-28)); + BEAST_EXPECT(env.balance(alice, USD) == USD(0)); + // 12+11+5 + BEAST_EXPECT(env.balance(bob, USD) == USD(28)); + } + + // Cross-currency payment two steps. Second book step + // issues, first book step redeems. + { + Account const dan{"dan"}; + Account const john{"john"}; + Account const ed{"ed"}; + Account const sam{"sam"}; + Account const bill{"bill"}; + + struct TestData + { + int maxAmt; + int sendMax; + int dstTrustLimit; + int dstExpectEUR; + int outstandingUSD; + int expEdBuyUSD; + int expDanBuyUSD; + int expBobSellUSD; + int expGwXRP; // whole XRP excluding the fees + std::uint8_t expOffersGw; + bool lastGwBuyUSD; + std::uint8_t + expOffersBob() const + { + return expBobSellUSD == 0 ? 1 : 0; + } + std::uint8_t + expOffersEd() const + { + // partially crossed if < 100 + return expEdBuyUSD < 100 ? 1 : 0; + } + std::uint8_t + expOffersDan() const + { + return expDanBuyUSD == 0 ? 1 : 0; + } + }; + + auto test = [&](TestData const& d) { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol, bob, dan, john, ed, sam, bill); + env.close(); + + MPT const USD = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, carol, bob}, .maxAmt = d.maxAmt}); + auto const EUR = gw["EUR"]; + + env(pay(gw, alice, USD(100))); + env(pay(gw, carol, USD(100))); + env(pay(gw, bob, USD(100))); + + BEAST_EXPECT(env.balance(gw, USD) == USD(-300)); + + env(trust(john, EUR(100))); + env(trust(dan, EUR(100))); + env(trust(ed, EUR(100))); + env(trust(bill, EUR(d.dstTrustLimit))); + + env(pay(gw, john, EUR(100))); + env(pay(gw, dan, EUR(100))); + env(pay(gw, ed, EUR(100))); + env.close(); + + // Sell USD + env(offer(alice, XRP(100), USD(100))); + env.close(); // close after each create to ensure + // the order + env(offer(carol, XRP(100), USD(100))); + env.close(); + if (!d.lastGwBuyUSD) + { + env(offer(gw, XRP(100), USD(100))); + env.close(); + } + env(offer(bob, XRP(100), USD(100))); + env.close(); + if (d.lastGwBuyUSD) + { + env(offer(gw, XRP(100), USD(100))); + env.close(); + } + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(expectOffers(env, carol, 1)); + BEAST_EXPECT(expectOffers(env, gw, 1)); + BEAST_EXPECT(expectOffers(env, bob, 1)); + + // Buy USD + env(offer(john, USD(100), EUR(100))); + env.close(); + env(offer(gw, USD(100), EUR(100))); + env.close(); + env(offer(dan, USD(100), EUR(100))); + env.close(); + env(offer(ed, USD(100), EUR(100))); + env.close(); + BEAST_EXPECT(expectOffers(env, john, 1)); + BEAST_EXPECT(expectOffers(env, gw, 2)); + BEAST_EXPECT(expectOffers(env, dan, 1)); + BEAST_EXPECT(expectOffers(env, ed, 1)); + + env(pay(sam, bill, EUR(400)), + sendmax(XRP(d.sendMax)), + path(~USD, ~EUR), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + auto const baseFee = env.current()->fees().base.drops(); + BEAST_EXPECT(env.balance(bill, EUR) == EUR(d.dstExpectEUR)); + BEAST_EXPECT(env.balance(john, USD) == USD(100)); + BEAST_EXPECT(env.balance(dan, USD) == USD(d.expDanBuyUSD)); + BEAST_EXPECT(env.balance(ed, USD) == USD(d.expEdBuyUSD)); + BEAST_EXPECT(env.balance(gw, USD) == USD(-d.outstandingUSD)); + BEAST_EXPECT(env.balance(alice, USD) == USD(0)); + BEAST_EXPECT(env.balance(carol, USD) == USD(0)); + BEAST_EXPECT(env.balance(bob, USD) == USD(100 - d.expBobSellUSD)); + BEAST_EXPECT( + env.balance(gw) == XRPAmount{d.expGwXRP * DROPS_PER_XRP - baseFee * 9}); + BEAST_EXPECT(expectOffers(env, john, 0)); + BEAST_EXPECT(expectOffers(env, gw, d.expOffersGw)); + BEAST_EXPECT(expectOffers(env, dan, d.expOffersDan())); + BEAST_EXPECT(expectOffers(env, ed, d.expOffersEd())); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, bob, d.expOffersBob())); + }; + + // clang-format off + std::vector const tests = { + // Sell USD: alice, carol, bob, gw are consumed. + // Buy USD: john, gw, dan, ed are consumed. + // gw's sell USD is consumed because there is sufficient available balance (100USD). + // but OutstandingAmount is 300USD because gw's sell offer is balanced out by + // gw's buy offer. + //*maxAmt sendMax limitEUR expectEUR outstandingUSD edBuy danBuy bobSell gwXRP offersGw lastGw + { 400, 400, 400, 400, 300, 100, 100, 100, 1100, 0, false}, + // Sell USD: alice, carol, bob, gw are consumed. + // Buy USD: john, gw, dan, ed (partially) are consumed. + // gw's sell USD is partially consumed because there is available balance (50USD). + // OutstandingAmount is 250USD because gw's sell offer is partially balanced by + // gw's buy offer. ed's offer is on the books because it's partially crossed. + // gw's offer is removed from the order book because it's partially consumed and + // the remaining offer is unfunded. + //*maxAmt sendMax limitEUR expectEUR outstandingUSD edBuy danBuy bobSell gwXRP offersGw lastGw + { 350, 400, 400, 350, 250, 50, 100, 100, 1050, 0, false}, + // Sell USD: alice, carol, bob are consumed; gw's is unfunded + // since OutstandingAmount is initially at MaximumAmount. + // Buy USD: john, gw, dan are consumed; ed's remains on the order + // book since 300USD is the sell limit. + //*maxAmt sendMax limitEUR expectEUR outstandingUSD edBuy danBuy bobSell gwXRP offersGw lastGw + { 300, 400, 400, 300, 200, 0, 100, 100, 1000, 0, false}, + // Same as above. bill's trustline limit sets the output to 300USD. + //*maxAmt sendMax limitEUR expectEUR outstandingUSD edBuy danBuy bobSell gwXRP offersGw lastGw + { 300, 400, 300, 300, 200, 0, 100, 100, 1000, 0, false}, + // Sell USD: alice, carol, bob are consumed; gw's removed from + // the order book since it's unfunded. + // Buy USD: john, gw, dan are consumed; ed's remains on the order + // book since 300USD is the limit. + //*maxAmt sendMax limitEUR expectEUR outstandingUSD edBuy danBuy bobSell gwXRP offersGw lastGw + { 300, 400, 300, 300, 200, 0, 100, 100, 1000, 0, true}, + // Sell USD: alice, carol are consumed; gw's removed from + // the order book in rev pass since it's unfunded; bob's + // remains on the order book. + // Buy USD: john, gw; ed's, dan's remains on the order + // book since 300USD is the limit. + //*maxAmt sendMax limitEUR expectEUR outstandingUSD edBuy danBuy bobSell gwXRP offersGw lastGw + { 300, 200, 300, 200, 200, 0, 0, 0, 1000, 0, false}, + // Same as three tests above since limited by buy 300USD (gw offer is unfunded) + //*maxAmt sendMax limitEUR expectEUR outstandingUSD edBuy danBuy bobSell gwXRP offersGw lastGw + { 300, 380, 400, 300, 200, 0, 100, 100, 1000, 0, false}, + }; + // clang-format on + for (auto const& t : tests) + test(t); + } + + // Cross-currency payment. BookStep issues, the first step + // redeems. + { + Account const ed{"ed"}; + + struct TestData + { + int maxAmt; + int sendMax; + int gwOffer; // quality == 1 + int dstExpectXRP; + int outstandingUSD; + int expBobBuyUSD; + int expGwXRP; // whole XRP excluding the fees + std::uint8_t expOffersGw; + bool lastGwBuyUSD; + std::uint8_t + expOffersBob() const + { + // partially crossed if < 100 + return expBobBuyUSD < 100 ? 1 : 0; + } + }; + + auto test = [&](TestData const& d) { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol, bob, ed); + env.close(); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .maxAmt = d.maxAmt}); + + env(pay(gw, alice, USD(300))); + env.close(); + + env(offer(carol, USD(100), XRP(100))); + env.close(); + if (!d.lastGwBuyUSD) + { + env(offer(gw, USD(d.gwOffer), XRP(d.gwOffer))); + env.close(); + } + env(offer(bob, USD(100), XRP(100))); + env.close(); + if (d.lastGwBuyUSD) + { + env(offer(gw, USD(d.gwOffer), XRP(d.gwOffer))); + env.close(); + } + + BEAST_EXPECT(expectOffers(env, carol, 1)); + BEAST_EXPECT(expectOffers(env, bob, 1)); + BEAST_EXPECT(expectOffers(env, gw, 1)); + BEAST_EXPECT(env.balance(gw, USD) == USD(-300)); + + env(pay(alice, ed, XRP(300)), + sendmax(USD(d.sendMax)), + path(~XRP), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + auto const baseFee = env.current()->fees().base.drops(); + BEAST_EXPECT(env.balance(alice, USD) == USD(300 - d.sendMax)); + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + BEAST_EXPECT(env.balance(bob, USD) == USD(d.expBobBuyUSD)); + BEAST_EXPECT(env.balance(ed) == XRP(d.dstExpectXRP)); + BEAST_EXPECT(env.balance(gw, USD) == USD(-d.outstandingUSD)); + BEAST_EXPECT( + env.balance(gw) == XRPAmount{d.expGwXRP * DROPS_PER_XRP - baseFee * 3}); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, bob, d.expOffersBob())); + BEAST_EXPECT(expectOffers(env, gw, d.expOffersGw)); + }; + + // clang-format off + std::vector const tests = { + // Buy USD: carol, gw, bob are consumed. + // Gw gets 300USD from alice; carol and bob buy 200USD, + // therefore OutstandingAmount is 200. + //*maxAmt sendMax gwOffer dstXRP outstandingUSD bobBuy gwXRP offersGw lastGw + { 300, 300, 100, 1300, 200, 100, 900, 0, false}, + // Same as above. Gw offer location in the order book doesn't matter + //*maxAmt sendMax gwOffer dstXRP outstandingUSD bobBuy gwXRP offersGw lastGw + { 300, 300, 100, 1300, 200, 100, 900, 0, true}, + // Buy USD: carol, gw are consumed. bob's offer remains on the order book. + // Gw gets 300USD from alice; carol buys 100USD, + // therefore OutstandingAmount is 100. + //*maxAmt sendMax gwOffer dstXRP outstandingUSD bobBuy gwXRP offersGw lastGw + { 300, 300, 200, 1300, 100, 0, 800, 0, false}, + // Buy USD: carol, bob are consumed; gw's is partially consumed (100/100) since it's last. + // Gw gets 300USD from alice; carol and bob buy 200USD, + // therefore OutstandingAmount is 200. + //*maxAmt sendMax gwOffer dstXRP outstandingUSD bobBuy gwXRP offersGw lastGw + { 300, 300, 200, 1300, 200, 100, 900, 1, true}, + // Buy USD: carol, bob are consumed; gw's is partially consumed (50/50) since it's last + // and sendMax limits the output. + // Gw gets 250USD from alice; carol and bob buy 200USD, alice has 50USD left, + // therefore OutstandingAmount is 200. + //*maxAmt sendMax gwOffer dstXRP outstandingUSD bobBuy gwXRP offersGw lastGw + { 300, 250, 200, 1250, 250, 100, 950, 1, true}, + }; + // clang-format on + for (auto const& t : tests) + test(t); + } + + // Cross-currency payment. BookStep redeems, the last step + // issues. + { + Account const ed{"ed"}; + + struct TestData + { + int maxAmt; + int sendMax; + int initDst; + int gwOffer; // quality == 1 + int dstExpectUSD; + int outstandingUSD; + int expAliceXRP; // whole XRP excluding the fees + int expBobSellUSD; + int expGwXRP; + std::uint8_t expOffersGw; + bool lastGwBuyUSD; + std::uint8_t + expOffersBob() const + { + return expBobSellUSD > 0 && expBobSellUSD < 100 ? 1 : 0; + } + }; + + auto test = [&](TestData const& d) { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol, bob, ed); + env.close(); + + MPT const USD = MPTTester( + {.env = env, .issuer = gw, .holders = {carol, bob, ed}, .maxAmt = d.maxAmt}); + + if (d.initDst != 0) + env(pay(gw, ed, USD(d.initDst))); + env(pay(gw, carol, USD(100))); + env(pay(gw, bob, USD(100))); + env.close(); + + env(offer(carol, XRP(100), USD(100))); + env.close(); + if (!d.lastGwBuyUSD) + { + env(offer(gw, XRP(d.gwOffer), USD(d.gwOffer))); + env.close(); + } + env(offer(bob, XRP(100), USD(100))); + env.close(); + if (d.lastGwBuyUSD) + { + env(offer(gw, XRP(d.gwOffer), USD(d.gwOffer))); + env.close(); + } + + BEAST_EXPECT(expectOffers(env, carol, 1)); + BEAST_EXPECT(expectOffers(env, bob, 1)); + BEAST_EXPECT(expectOffers(env, gw, 1)); + BEAST_EXPECT(env.balance(gw, USD) == USD(-200 - d.initDst)); + + env(pay(alice, ed, USD(300)), + sendmax(XRP(d.sendMax)), + path(~USD), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + auto const baseFee = env.current()->fees().base.drops(); + BEAST_EXPECT( + env.balance(alice) == XRPAmount{d.expAliceXRP * DROPS_PER_XRP - baseFee}); + BEAST_EXPECT(env.balance(carol, USD) == USD(0)); + BEAST_EXPECT(env.balance(bob, USD) == USD(100 - d.expBobSellUSD)); + BEAST_EXPECT(env.balance(ed, USD) == USD(d.dstExpectUSD)); + BEAST_EXPECT(env.balance(gw, USD) == USD(-d.outstandingUSD)); + BEAST_EXPECT( + env.balance(gw) == + XRPAmount{ + d.expGwXRP * DROPS_PER_XRP - baseFee * (4 + (d.initDst != 0 ? 1 : 0))}); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, bob, d.expOffersBob())); + BEAST_EXPECT(expectOffers(env, gw, d.expOffersGw)); + }; + + // clang-format off + std::vector const tests = { + // Sell USD: carol, gw, bob are consumed. + // ed buys 300USD from carol, gw, bob therefore OutstandingAmount is 300. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 300, 0, 100, 300, 300, 700, 100, 1100, 0, false}, + // Same as above. Gw offer location in the order book doesn't matter + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 300, 0, 100, 300, 300, 700, 100, 1100, 0, true}, + // Sell USD: carol, bob are consumed, gw is partially consumed. + // ed buys 200 from carol and bob and 50 from gw because gw can only issue 50 + // (300(max) - 200(carol+bob) - 50(ed)). ed buys 250 from carol, gw, bob and has 50 initially, + // therefore OutstandingAmount is 300. + // gw's offer is removed from the order book because it's partially consumed and the remaining + // offer is unfunded. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 300, 50, 100, 300, 300, 750, 100, 1050, 0, false}, + // Same as above. Gw offer location in the order book doesn't matter. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 300, 50, 100, 300, 300, 750, 100, 1050, 0, true}, + // Same as above. Gw offer size doesn't matter. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 300, 50, 200, 300, 300, 750, 100, 1050, 0, true}, + // Sell USD: carol, gw are consumed, bob is partially consumed. + // ed buys 200 from carol and gw and 50 form bob because of sendMax limit. bob keeps 50, + // therefore OutstandingAmount is 300. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 250, 0, 100, 250, 300, 750, 50, 1100, 0, false}, + // Sell USD: carol, bob are consumed, gw is partially consumed because of sendMax limit. + // ed buys 200 from carol and bob and 50 from gw. Therefore, OutstandingAmount is 250. + // gw's offer remains on the order book because it's partially consumed and has more funds. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 250, 0, 100, 250, 250, 750, 100, 1050, 1, true}, + // Sell USD: carol, bob are consumed, gw is partially consumed because of sendMax limit, also + // there is only 50 available to issue. ed buys 200 from carol and bob and 50 from gw, plus + // he has initially 50, therefore OutstandingAmount is 300. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 250, 50, 100, 300, 300, 750, 100, 1050, 0, true}, + // Sell USD: carol, bob are consumed, gw is not consumed because there is not available funds + // to issue. ed buys 200 from carol and bob and, plus he has initially 100, + // therefore OutstandingAmount is 300. gw offer is removed because it's unfunded. + //*maxAmt sendMax initDst gwOffer dstUSD outstandingUSD aliceXRP bobSell gwXRP offersGw lastGw + { 300, 250, 100, 100, 300, 300, 800, 100, 1000, 0, true}, + }; + // clang-format on + for (auto const& t : tests) + test(t); + } + + // Cross-currency payment with BookStep as the first step. + // BookStep limits the buy amount. + { + auto test = [&](int sendMax, std::uint16_t dstXRP, std::uint8_t expGwOffers) { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .maxAmt = 300}); + + env(offer(carol, USD(400), XRP(400))); + env(offer(gw, USD(100), XRP(100))); + BEAST_EXPECT(expectOffers(env, carol, 1)); + BEAST_EXPECT(expectOffers(env, gw, 1)); + + env(pay(gw, alice, XRP(500)), + sendmax(USD(sendMax)), + path(~XRP), + txflags(tfPartialPayment | tfNoRippleDirect)); + + BEAST_EXPECT(env.balance(alice) == XRP(dstXRP)); + BEAST_EXPECT(env.balance(gw, USD) == USD(-300)); + BEAST_EXPECT(env.balance(carol, USD) == USD(300)); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(expectOffers(env, gw, expGwOffers)); + }; + // carol's offer is partially consumed - 300USD/300XRP + // because available amount to issue is 300USD. gw's + // offer is fully consumed because it doesn't change + // OutstandingAmount. Both offers are removed from the + // order book - carol's offer is unfunded and gw's offer + // is fully consumed. + test(500, 1'400, 0); + // carol's offer is partially consumed - 300USD/300XRP + // because available amount to issue is 300USD. gw's + // offer is partially consumed because of sendMax limit. + // carol's offer is removed from the order book because + // it's unfunded. gw's offer remains on the order book + // because it's partially consumed and gw has more + // funds. + test(350, 1'350, 1); + } + } + + void + testWithFeats(FeatureBitset features) + { + using namespace jtx; + + testMaxAndSelfPaymentEdgeCases(features); + testFalseDry(features); + testDirectStep(features); + testBookStep(features); + testTransferRate(features); + testSelfPayment1(features); + testSelfPayment2(features); + testSelfFundedXRPEndpoint(false, features); + testSelfFundedXRPEndpoint(true, features); + testUnfundedOffer(features); + testReExecuteDirectStep(features); + testSelfPayLowQualityOffer(features); + } + + void + run() override + { + using namespace jtx; + auto const sa = testable_amendments(); + testLimitQuality(); + testXRPPathLoop(); + testWithFeats(sa); + testEmptyStrand(sa); + } +}; + +BEAST_DEFINE_TESTSUITE_PRIO(FlowMPT, app, xrpl, 2); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/Flow_test.cpp b/src/test/app/Flow_test.cpp index 25bcb4ee64..c9b3810831 100644 --- a/src/test/app/Flow_test.cpp +++ b/src/test/app/Flow_test.cpp @@ -1,16 +1,54 @@ -#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include -#include - +#include #include +#include +#include +#include +#include #include #include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -437,7 +475,7 @@ struct Flow_test : public beast::unit_test::suite auto flowJournal = env.app().getJournal("Flow"); auto const flowResult = [&] { - STAmount deliver(USD(51)); + STAmount const deliver(USD(51)); STAmount smax(BTC(61)); PaymentSandbox sb(env.current().get(), tapNONE); STPathSet paths; @@ -450,10 +488,10 @@ struct Flow_test : public beast::unit_test::suite }; { // BTC -> USD - STPath p1({IPE(USD.issue())}); + STPath const p1({IPE(USD)}); paths.push_back(p1); // BTC -> EUR -> USD - STPath p2({IPE(EUR.issue()), IPE(USD.issue())}); + STPath const p2({IPE(EUR), IPE(USD)}); paths.push_back(p2); } @@ -876,8 +914,8 @@ struct Flow_test : public beast::unit_test::suite env.close(); env(trust(bob, USD(20))); - STAmount tinyAmt1{USD.issue(), 9000000000000000ll, -17, false, STAmount::unchecked{}}; - STAmount tinyAmt3{USD.issue(), 9000000000000003ll, -17, false, STAmount::unchecked{}}; + STAmount const tinyAmt1{USD, 9000000000000000ll, -17, false, STAmount::unchecked{}}; + STAmount const tinyAmt3{USD, 9000000000000003ll, -17, false, STAmount::unchecked{}}; env(offer(gw, drops(9000000000), tinyAmt3)); env(pay(alice, bob, tinyAmt1), @@ -900,8 +938,8 @@ struct Flow_test : public beast::unit_test::suite env.close(); env(trust(alice, USD(20))); - STAmount tinyAmt1{USD.issue(), 9000000000000000ll, -17, false, STAmount::unchecked{}}; - STAmount tinyAmt3{USD.issue(), 9000000000000003ll, -17, false, STAmount::unchecked{}}; + STAmount const tinyAmt1{USD, 9000000000000000ll, -17, false, STAmount::unchecked{}}; + STAmount const tinyAmt3{USD, 9000000000000003ll, -17, false, STAmount::unchecked{}}; env(pay(gw, alice, tinyAmt1)); @@ -940,30 +978,30 @@ struct Flow_test : public beast::unit_test::suite pay(gw, alice, // 12.55.... - STAmount{USD.issue(), std::uint64_t(1255555555555555ull), -14, false})); + STAmount{USD, std::uint64_t(1255555555555555ull), -14, false})); env(offer( gw, // 5.0... - STAmount{USD.issue(), std::uint64_t(5000000000000000ull), -15, false}, + STAmount{USD, std::uint64_t(5000000000000000ull), -15, false}, XRP(1000))); env(offer( gw, // .555... - STAmount{USD.issue(), std::uint64_t(5555555555555555ull), -16, false}, + STAmount{USD, std::uint64_t(5555555555555555ull), -16, false}, XRP(10))); env(offer( gw, // 4.44.... - STAmount{USD.issue(), std::uint64_t(4444444444444444ull), -15, false}, + STAmount{USD, std::uint64_t(4444444444444444ull), -15, false}, XRP(.1))); env(offer( alice, // 17 - STAmount{USD.issue(), std::uint64_t(1700000000000000ull), -14, false}, + STAmount{USD, std::uint64_t(1700000000000000ull), -14, false}, XRP(.001))); env(pay(alice, bob, XRP(10000)), diff --git a/src/test/app/Freeze_test.cpp b/src/test/app/Freeze_test.cpp index 1dd0de578b..29127ec8e1 100644 --- a/src/test/app/Freeze_test.cpp +++ b/src/test/app/Freeze_test.cpp @@ -1,12 +1,38 @@ -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include #include +#include #include +#include #include +#include +#include +#include +#include + namespace xrpl { class Freeze_test : public beast::unit_test::suite @@ -19,9 +45,9 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const G1{"G1"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(1000), G1, alice, bob); env.close(); @@ -168,8 +194,8 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; + Account const G1{"G1"}; + Account const A1{"A1"}; env.fund(XRP(10000), G1, A1); env.close(); @@ -259,8 +285,8 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; + Account const G1{"G1"}; + Account const A1{"A1"}; env.fund(XRP(10000), G1, A1); env.close(); @@ -308,8 +334,8 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; + Account const G1{"G1"}; + Account const A1{"A1"}; env.fund(XRP(10000), G1, A1); env.close(); @@ -347,11 +373,11 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; env.fund(XRP(12000), G1); env.fund(XRP(1000), A1); @@ -497,10 +523,10 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account frozenAcc{"A2"}; - Account deepFrozenAcc{"A3"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const frozenAcc{"A2"}; + Account const deepFrozenAcc{"A3"}; env.fund(XRP(12000), G1); env.fund(XRP(1000), A1); @@ -608,10 +634,10 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; + Account const G1{"G1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; env.fund(XRP(1000), G1, A3, A4); env.fund(XRP(2000), A2); @@ -705,10 +731,10 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2, A3); @@ -935,9 +961,9 @@ class Freeze_test : public beast::unit_test::suite using path = test::jtx::path; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -1161,9 +1187,9 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -1283,9 +1309,9 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -1578,9 +1604,9 @@ class Freeze_test : public beast::unit_test::suite using path = test::jtx::path; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -1593,7 +1619,7 @@ class Freeze_test : public beast::unit_test::suite env(pay(G1, A2, USD(1000))); env.close(); - AMM ammG1(env, G1, XRP(1'000), USD(1'000)); + AMM const ammG1(env, G1, XRP(1'000), USD(1'000)); env.close(); // Testing basic payment using AMM when freezing one of the trust lines. @@ -1668,9 +1694,9 @@ class Freeze_test : public beast::unit_test::suite using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -1829,7 +1855,7 @@ class Freeze_test : public beast::unit_test::suite // Testing brokered offer acceptance if (features[featureDeepFreeze] && features[fixEnforceNFTokenTrustlineV2]) { - Account broker{"broker"}; + Account const broker{"broker"}; env.fund(XRP(10000), broker); env.close(); env(trust(G1, broker["USD"](1000), tfSetFreeze | tfSetDeepFreeze)); @@ -1855,7 +1881,7 @@ class Freeze_test : public beast::unit_test::suite // Testing transfer fee if (features[featureDeepFreeze] && features[fixEnforceNFTokenTrustlineV2]) { - Account minter{"minter"}; + Account const minter{"minter"}; env.fund(XRP(10000), minter); env.close(); env(trust(G1, minter["USD"](1000))); diff --git a/src/test/app/GRPCServerTLS_test.cpp b/src/test/app/GRPCServerTLS_test.cpp new file mode 100644 index 0000000000..041dcc4c53 --- /dev/null +++ b/src/test/app/GRPCServerTLS_test.cpp @@ -0,0 +1,851 @@ +#include +#include + +#include + +#include +#include +#include + +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace { + +constexpr std::string_view kCA_CERT_CONTENT = + "-----BEGIN CERTIFICATE-----\n" + "MIIFhjCCA26gAwIBAgIJAL9P70zX30oiMA0GCSqGSIb3DQEBCwUAMFcxCzAJBgNV\n" + "BAYTAlVTMQ0wCwYDVQQIDARUZXN0MQ0wCwYDVQQHDARUZXN0MRgwFgYDVQQKDA9S\n" + "aXBwbGVkIFRlc3QgQ0ExEDAOBgNVBAMMB1Rlc3QgQ0EwIBcNMjYwNDA5MTMyNTA2\n" + "WhgPMjEyNjAzMTYxMzI1MDZaMFcxCzAJBgNVBAYTAlVTMQ0wCwYDVQQIDARUZXN0\n" + "MQ0wCwYDVQQHDARUZXN0MRgwFgYDVQQKDA9SaXBwbGVkIFRlc3QgQ0ExEDAOBgNV\n" + "BAMMB1Rlc3QgQ0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCzOJ5s\n" + "dy1O0GN/kmbeWf5DmFbQBSS9FRKxh6/o9V9BqRBQfECrVK9T5Y4FYrGGtmUW3YEV\n" + "uMDZ5q6rvBT2zrrzPXnWA5Pb4I4mKqC/yk5L7Mm8A9xQsNoRzgTyl/NuHiXKn+yQ\n" + "FuidA6U36qwIAcDR7gLqrJ1ud/ng9f9Q4k6+IItY/XGhcz4nKlQq9jpzmfdSlBkU\n" + "hXsIsdNtC+UGlQMCMX2jwysIFfjjCOMlH7KFQ3dKodhsW+Ym6AsPwyRGCgNXO/zd\n" + "Fqt1MIMs1F7r40DtfVO3R7w4/2SblcceZlsDrYQUbJnH+sEPWO0SGGo6Y7Ohs09+\n" + "aJSOAGGQVgTSLuAcFtR4BXD0GLn39+10PDvHGOsMJKL1de1f96s8kPlifQ5AGWuc\n" + "xy6XsupGSa0F8LozwQmKD7hVkyladUTWFPknz5tsPEVApTO0U8Vuknuhyovo6+mx\n" + "qBoSD32NwHveFz3jWqfj0CGX9BwL9AOpMabDhROVQfyM5GrLeLOOdgOnsBXJYYdW\n" + "MeJwz6BH30q9yvEd9Ti26jSk3fM8WPuEkZzNNp8STEMyDrfhaKOe5fGPWLnqMQAf\n" + "yMCDLwB1WqIN1Q6gOELb3rxyYDVH/5x6/JXosdUe1qx/tzvRoSWxxssRRd2Em+e+\n" + "MUFLXz+9D6kZ9XCuP/mLyRGW6LEiwwQkGKMnzwIDAQABo1MwUTAPBgNVHRMBAf8E\n" + "BTADAQH/MB0GA1UdDgQWBBQPK5hXxLdTj3QqfVzGpfTga6IF3zAfBgNVHSMEGDAW\n" + "gBQPK5hXxLdTj3QqfVzGpfTga6IF3zANBgkqhkiG9w0BAQsFAAOCAgEAa06whkqv\n" + "KmdT1HVhkV7AkWEAeHMWPLLaaFbcwble7a1Vizh6GjCyNpLtoN+mtwqwiOdsIlRE\n" + "42pWILc6CuuX0ae0nHSrcQS5mq8ZKSMr1xTo9RSfBq7CDfdyquxzG83HhpdApViZ\n" + "87Bjy3WoRuomM+YiONfUVdCbC5ZmXW/z+xrXJ+JqIXrtv66sZxpQIR0+ShnWT0DE\n" + "w9jB5fxjydPFwEudYi4z9XjEZaZJ1f8VNWDuUvi3yTJtTlNaWnKveudtDZBw/fA+\n" + "MBFd9ccYVhGQPxOs6S0Ev6q5IjcnzGeEBNZOjgjQk9aFrAs2Iiy018AbYQj5XD64\n" + "hHyiNgyPjl/VgXJE1Xl3lXGpiiJlXctgnCd3UGMfKznhBIpDT13i2CmHFyR3uk7o\n" + "UOZUXCnbnmgthejmFxB35Wf5TmGaYubtRMfCPHGNbQD+7Kg2+8eel3J3JSuG6RQ8\n" + "hwNyHHQnaPVUSANItJ4cMe5DutM0vUCMkJbajL+fjC5SdsTcGfR2VmAFqulNDXjH\n" + "sGWBiWVNsgddax63m6kL9UOeE+8pu8yStKZ4mVn2EjE9eJk4vyZt4BaI6sDUMlke\n" + "S9OjcI5iYlxXNgbRQBtwK70+c3D3JoRPREkTRPPwC4NiAFed7UwXSMh5nWbpt/dq\n" + "fAbAYqu0rfMFHUYjzIVnu8WRCC56qYHO5tU=\n" + "-----END CERTIFICATE-----\n"; + +constexpr std::string_view kSERVER_CERT_CONTENT = + "-----BEGIN CERTIFICATE-----\n" + "MIIFizCCA3OgAwIBAgIJAIErcpMflkrRMA0GCSqGSIb3DQEBCwUAMFcxCzAJBgNV\n" + "BAYTAlVTMQ0wCwYDVQQIDARUZXN0MQ0wCwYDVQQHDARUZXN0MRgwFgYDVQQKDA9S\n" + "aXBwbGVkIFRlc3QgQ0ExEDAOBgNVBAMMB1Rlc3QgQ0EwIBcNMjYwNDA5MTMyNTA3\n" + "WhgPMjEyNjAzMTYxMzI1MDdaMFExCzAJBgNVBAYTAlVTMQ0wCwYDVQQIDARUZXN0\n" + "MQ0wCwYDVQQHDARUZXN0MRAwDgYDVQQKDAdSaXBwbGVkMRIwEAYDVQQDDAlsb2Nh\n" + "bGhvc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCv+Lj9LJfPuSOE\n" + "yZqTn2gmG5tJt02ywnuIQet7N5tduxnNs50yXQ00Jeb40dth0HwI5I+AsEVNPIG3\n" + "7tJ9RtCwwTyltaZ4bXuL9ujEVr6TAKY6rlU9bL+Zmr62Lm8B0SLouxfPtyzKhBv6\n" + "7bGUrdIX7o9DbTQ3/2mQTc7KjPCJTEutmpVyD3dABN1qDM9Qzac0NtK1nixvYGd4\n" + "SpbK95BRXby3X9um0dVXoUMbc2gDV9uUZw1xLSjuKDJtQ/rleqe0mmS6JSoagwbb\n" + "DmPX/GbIf21IWUsg3m7AyIwYf9FtIJArB/j3iVBsY9lTB0mXSLxiyN6KM822+QjH\n" + "/VeHKDUWdQB6N3smmi1OLQasukRpSUTmTsoucn30dUqS6qdTtkHzvqGEN+CXBWgG\n" + "i1AS2CacOjYSVHRppC10r/3kEChYY/9rqYBz7GedFRJ6VzQzrwFYZleLJvX6GWfe\n" + "4gNvgwLfo/q2Af1HkCY2aHO+19eAghVsy1MRUDnm/GbZAhHSrX10iEfRjs+GhfxY\n" + "v0xMrvGBCm/2CiJ8RAvdRPpNkM/3u9fjOmqdKvE9NTqDOX1HUBoqa/UguIzi6o/k\n" + "BlBtohfaeL6ZeYXl6MefIIs2pipR7S1VQ1RY9OSdnN5nIJidyn1l85P9vLn49QVw\n" + "2OAT+TcEZnxyaiHCKU6nWtusuMt3wQIDAQABo14wXDAaBgNVHREEEzARgglsb2Nh\n" + "bGhvc3SHBH8AAAEwHQYDVR0OBBYEFO9bPc31jmMlMVNhOd+eXgZPD/+pMB8GA1Ud\n" + "IwQYMBaAFA8rmFfEt1OPdCp9XMal9OBrogXfMA0GCSqGSIb3DQEBCwUAA4ICAQCm\n" + "+hnvRdr9N9a260yOD53b/Gs0c4viAOU3WmxAa89upLHnpPEi7/GlKlw+ed6SwYoX\n" + "CSopDw8AG2Ub/oHM3uIrONjfdHBwUl/SUS8wNhiELuQjKm0qGjkh/n/FHY903flc\n" + "0VP2ciLnqhSS2NY+KH0O8uny3yR4FVH7Byqtk648Z7LfIhe02TjTIjhXDrGwn5dS\n" + "tuTKEAGaxxPJuINCR1BZlwfk+10ipJK59rSpCW//P1YJVr16sdnyh3YJXoAJ5qxP\n" + "P8QWHiRIl2ZGs7KB5SU9fX1dVEU5gwrl/KF3oP+iS01wfNZGvnR+eHMPJsl/IwoC\n" + "SOZAMjgkTZh06cprfEXne8bcidiHvETbF9szMAofA91PbXi0lcwMqpkHG2AElOXI\n" + "by4ejjs9RZJF2Ef38qZPb8RuT+gLORFH5SuPQUwXKlszjpzpxkQ6IKYjFJY+j8CS\n" + "XlXhdkzK5h18cf7J2i5SQdIzE1btQqdcaMb9DzX+drCqqD8JZd1Vczua7Q5tbZ/g\n" + "Bq19Zzo1KQL0xXPdomWv+sP6eUMiW+3J5oFN2hJpilKuFSCAhDmgcmLooFy5t6rR\n" + "kW0n1P3iTWvgQHNzB/3msanvC4/hHyrHHOVGQtAjhxuoRioBJ+hg4RKDptSUcHJX\n" + "YSyd81wvumIpP+I7BDkQLgTb+NzMmoBIjRg3aVvXSg==\n" + "-----END CERTIFICATE-----\n"; + +constexpr std::string_view kSERVER_KEY_CONTENT = + "-----BEGIN PRIVATE KEY-----\n" + "MIIJQgIBADANBgkqhkiG9w0BAQEFAASCCSwwggkoAgEAAoICAQCv+Lj9LJfPuSOE\n" + "yZqTn2gmG5tJt02ywnuIQet7N5tduxnNs50yXQ00Jeb40dth0HwI5I+AsEVNPIG3\n" + "7tJ9RtCwwTyltaZ4bXuL9ujEVr6TAKY6rlU9bL+Zmr62Lm8B0SLouxfPtyzKhBv6\n" + "7bGUrdIX7o9DbTQ3/2mQTc7KjPCJTEutmpVyD3dABN1qDM9Qzac0NtK1nixvYGd4\n" + "SpbK95BRXby3X9um0dVXoUMbc2gDV9uUZw1xLSjuKDJtQ/rleqe0mmS6JSoagwbb\n" + "DmPX/GbIf21IWUsg3m7AyIwYf9FtIJArB/j3iVBsY9lTB0mXSLxiyN6KM822+QjH\n" + "/VeHKDUWdQB6N3smmi1OLQasukRpSUTmTsoucn30dUqS6qdTtkHzvqGEN+CXBWgG\n" + "i1AS2CacOjYSVHRppC10r/3kEChYY/9rqYBz7GedFRJ6VzQzrwFYZleLJvX6GWfe\n" + "4gNvgwLfo/q2Af1HkCY2aHO+19eAghVsy1MRUDnm/GbZAhHSrX10iEfRjs+GhfxY\n" + "v0xMrvGBCm/2CiJ8RAvdRPpNkM/3u9fjOmqdKvE9NTqDOX1HUBoqa/UguIzi6o/k\n" + "BlBtohfaeL6ZeYXl6MefIIs2pipR7S1VQ1RY9OSdnN5nIJidyn1l85P9vLn49QVw\n" + "2OAT+TcEZnxyaiHCKU6nWtusuMt3wQIDAQABAoICAQCZilzm0uT3Y2RBdaMBUaKP\n" + "NaFONbl+00D0SAhOr9tJcnp2SFVN33Eo4jVhP8K62y2OmNc5gxRE6xmIQsK4enSW\n" + "9VSUhiXliCm3m03IGqQYIgXox7oqaVvYi/QBhAxpunBKPwzsubhET/cWABXlU7Ew\n" + "HoA0ZfGdNqeGOM3JYCZ0tfSGWo4xQptbaaND6D9wErDk1z0NKSE+YRCHHhXqrQ3o\n" + "YPDL08EVEpui5VtndU/5Msyt9Sj+alf/TWWKfzlIx7fS1rAy10Cgd1khA7JMf7ez\n" + "E7Rn3zm1ST+7yICs08IJBNOmKEOswMxCdvDmCELG1LlDPF8omUDSeQKXdU7M6GFA\n" + "b5PQ11Ik6xZVw1NUESf4d9g0VhEJRXSdGwA3KepAkwRejkB5jI56C8z9dB0LWdWH\n" + "2r3dX2ZpbJv0XVNxAELRgKwyfqWxYrF3caGLrxxWAiyPFvD9FgZJB1ftBU3D+HZZ\n" + "bltdfHJBgZe3pwoCr3X2JPhcA6ecITsset14dvsXHSi9IAXTHbeXxjrHCRcXs6xV\n" + "v4ZSL5r43dv6qk7XiFONCmV8diIwJOxcaSvoBgeeCykX4RKGSk/6Atlo4C9hXb47\n" + "BAuXu3Y+SkS98EljsdeNKCr013Tvt0p4H2QfeoDTKuzC+j3hu9fCkEP3oak2nWFl\n" + "bOkrYMJCc6yxu20G58vzrQKCAQEA1y93gNuNa7Z+VrZCSEcJX2BZl1mTyhLEa9mN\n" + "QOmKlW10VrfCsJxLu+dTGWccy0c6Q8wk6uGjgYJHsdyFPIdSroPR2ysJKSP/5Vzu\n" + "xNymgbeLPnWoivC9TctovWY/15fdboYNUO54jOpFheCC1wq9ZP6CyJmw5O96Y7tJ\n" + "1l5Dq7Fe4iQbIQHPt54wVVHsm7G1ZNywgSbt0HXHeP43YN3mRawJ51++MaEksCXv\n" + "rW+vOxPdiW8djE0tqcK0tqFMhI6p+WcUu8128aRHd0iHlKsVsFU4OLLZr10zwy9i\n" + "COHoF4Fh53pGp05jv+5eMtuEiem87ZUmpJn7whHZt8sKSE71AwKCAQEA0Vkwr4KA\n" + "kRRCUPvor5mdNil05N1mLrYgr/4UAHg3tbeTGxOjSX65KnJWi5dsDmZUdGTL4StD\n" + "8H6uLzzjX88gQkpKvtRYPYKBFtTRsI+ItOvIIo8czK/Kv8dwC2WXZbZBjsCAhrCm\n" + "0fKL2jx7rgdjaqvQeqSRtcHiyiYJG/jC7Iqwm4CyPr+nkVUWKZUWXopw0QXZXHWp\n" + "Glz9TXreEI7Xb/R+RXYU21exBqg0SfHq9pA//aNTQWxWGlNVwqO/KUao9HZupKHb\n" + "mA73oxFJTKhVNNNdC5cC91pxDeDTUzpIEjCGeLI3Aa35CD0WFqEbELJphr5HGkGo\n" + "VkYod6P79+Ta6wKCAQAadFpzvAop2Ni1XljNu/X6BMVe5wNVT3NYcvl7pnqEHl20\n" + "H4lO3xgsdKbxs4yFrS8LkLhlK/JHBLY9toemxlgy3j/ZevP4W9Wk5ATyrNHHlsIG\n" + "nr5mvmv3eW9aAY0Nuzzczpwqe/bUFCUR7WUIfOiF1whLEyH9MzfPtQHB2frly7uH\n" + "f7raFvfrcgYtJxI4neNYEA2fAyMvgptQU6iJPx6FKD5bdJjUTyRMh41svBNF5w5Q\n" + "TBnM2twnR6mh3jii/0sEP1j8MalS0ch7cK5CZ7oV4JQ13D8I4SNw9o1N3EAFS8G2\n" + "jIDNJsT6npp0FCq6LcMtTi3fBJM/66PhhZOxCgvzAoIBAH1LnE/vE3PBZE+D9afj\n" + "kKwx87xmphme98FdmCsPyIgB7xFtl3UNW1WESTgS0KFtrW5cRYnmkysFJssu7gcR\n" + "uIT0YfgErythSFGZ3kaGIZPm6kmEzf/T1s0hWHX5v7soceQ2YrY6VB2jxQBA4uUt\n" + "ltrpKkW86ViXSl0ilqEfKcrY1wq64/OaUXgyLKmGiXTb9tmjXoxv/12/+fq9ZtsS\n" + "Iu7mrgx0t9bvjQwm7+Sx3abkfugXMGUfqgjnh5SO3IKfv89QcrgmB3/itWPrnKs8\n" + "tIKBXlbpcuUIRFHCFbjiUPBSCqmCQFnI/htoNCgnFEPSBEaY64VTdqTsKJwykUO0\n" + "vTECggEAEAB8vyHHk7fpU+IOwD8TP7MCMHwoJzoHQp35So7TlhmO7oDranNhg3nl\n" + "jhTOeISLG2dmPkT49vhsO30tal4CgSXVZo1bPbOK83UvgeLH5Rhji44Dmah+ohKy\n" + "wCuVLuF6YSSp5rD7VIrahhegBFXEYdW5+ZBFbDpE5EXp0WeHc7IRPwWvm+ixr1m8\n" + "VqLeeh1xkMG5WdTTwGjgKWIFXZQ3bOIdVK7uya8wFDAtftkswXiBxAlb9L6Id+Dp\n" + "bKfMAHNouU1TQn5duFgPnCbSU1Js74HkkC0NEEIjQX8k2UCPrhV0VfLfViPuPFax\n" + "S/RYUSUkZ4VvqFUfo7wT8x18urb87w==\n" + "-----END PRIVATE KEY-----\n"; + +constexpr std::string_view kCLIENT_CERT_CONTENT = + "-----BEGIN CERTIFICATE-----\n" + "MIIFeDCCA2CgAwIBAgIJAIErcpMflkrSMA0GCSqGSIb3DQEBCwUAMFcxCzAJBgNV\n" + "BAYTAlVTMQ0wCwYDVQQIDARUZXN0MQ0wCwYDVQQHDARUZXN0MRgwFgYDVQQKDA9S\n" + "aXBwbGVkIFRlc3QgQ0ExEDAOBgNVBAMMB1Rlc3QgQ0EwIBcNMjYwNDA5MTMyNTA3\n" + "WhgPMjEyNjAzMTYxMzI1MDdaMFoxCzAJBgNVBAYTAlVTMQ0wCwYDVQQIDARUZXN0\n" + "MQ0wCwYDVQQHDARUZXN0MRcwFQYDVQQKDA5SaXBwbGVkIENsaWVudDEUMBIGA1UE\n" + "AwwLdGVzdC1jbGllbnQwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDP\n" + "QHttw3TLjOqYS3VkLF3KMRaP2ZtO6A1mXfTbqbKvD41Fazf/cM/v9lPMAlRd2SEY\n" + "3MeE8KVddKJwsbF0kNgDkKB5D5V42WrTw5biFNMOeHAZMR/oWChIvZbbGbDxIdIO\n" + "2+W3X0kjpa2eKcK9qBk8xoyIeilyXtleGWuWvHxiZP9iGHxaTWB+wIKUIK6vrEOb\n" + "iO3P/9XPpHzsBt0HdTDh4V7fwnr2UndVeQyBwUwLn6pd73sTKBfA26YppRwDjPIj\n" + "6NYtF3I28lRCUo+47TAVZM97gjN9oEwyHIVtOc7fnZPwtN26M5v5083SGXU1k/PN\n" + "3xGAlDUiCF3RSMbBRylGgUVtsAD57i8tI2SqCr+ZG233VFiOdwTRKKVNTyMC9TCJ\n" + "dCFFEDFDHTTSimKRQKy0Cm2qoL6JBkziAIiu/0Zzv9YjAAnRoJ2cweMXQ/9z1oWe\n" + "EUZBLRsggYQ8FbM13FOkOs8IlzacSuhwrYKOq8LsMX4cH2mnn783FtXXqrL/xfL7\n" + "11KhzGpZNrz187ilJ+ZsmP9D6vCBP/tR7V52dgtB6I291o8zxdH8GheIGenEFaZa\n" + "oAwyN2FuJgXZqx9319I9gYerZ/BbUzA2MuOxFd0ywtdcTPqKiyAQ9rxQVCVQyYWj\n" + "kfBEYRzWxjfj3XhNprxdm3cauz01NAoTDiz52dZhGQIDAQABo0IwQDAdBgNVHQ4E\n" + "FgQUXVKwiGRrXC1sjK2D86jsjMVV0XgwHwYDVR0jBBgwFoAUDyuYV8S3U490Kn1c\n" + "xqX04GuiBd8wDQYJKoZIhvcNAQELBQADggIBACpHTm9GZMZ7OPhqVo4VltVOW9a9\n" + "LLDsVYmvpAF9+yjZGims6+p3f7eY+o+TRdUE4HEBCmH0UiFVODXCZSoqXo6y9xq7\n" + "TS1dmXll1Sajbfi7YXsM8CAUb+cSsHtmT57JtbGicDiVXAqIOlT65yXkuujdcEa0\n" + "OAw45vJDkWk/6nneFJKdTs7aT3fvIGTlMAxgMJngVsA8BRsX8TWoo05Lum8ClNgi\n" + "s6mtl+nUvjOaM0omFL/K9kqLy7OJAbmE5xuhkC9q6Kn0pHBL4u0YSWaWTpyrvAX7\n" + "BuOE0G1JezcCAcqJvXbKFvhnOSHTvzdlMgXhteGW8Uwgf8cGKtVLSwh6YTjI1XaL\n" + "DkNZfJabAyH7BsGGbAd9Jts4h+4auPqHgcpEz16280oCgZdcfLSP0UKrfwYuXOar\n" + "8KWlVRFl2NBpEJwRf2KjZFQUqYoX1MmfX0gyy+kk0ZP12L7oGNqAxkaWySfb4PSv\n" + "Hsnb8iD6sIJQjZvZ/2wLV8xwFTbFjvGbmSx+XLnMUVV8cVAMUpZz5X2R9pBvpVi4\n" + "KfUccTvIVA0p1wFSdWYQ0+QNxHxZGX1rin6KVUdV1z8K6J3FgGlRqzfz4bruGpXs\n" + "6vX5vqF9KTFpwLTOxDU+kAoIfHowHeu/LQX1l+rk1ww2UZQ1zvgKb6fxWMtviq3F\n" + "cTe8jkzRqYdUfAoV\n" + "-----END CERTIFICATE-----\n"; + +constexpr std::string_view kCLIENT_KEY_CONTENT = + "-----BEGIN PRIVATE KEY-----\n" + "MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQDPQHttw3TLjOqY\n" + "S3VkLF3KMRaP2ZtO6A1mXfTbqbKvD41Fazf/cM/v9lPMAlRd2SEY3MeE8KVddKJw\n" + "sbF0kNgDkKB5D5V42WrTw5biFNMOeHAZMR/oWChIvZbbGbDxIdIO2+W3X0kjpa2e\n" + "KcK9qBk8xoyIeilyXtleGWuWvHxiZP9iGHxaTWB+wIKUIK6vrEObiO3P/9XPpHzs\n" + "Bt0HdTDh4V7fwnr2UndVeQyBwUwLn6pd73sTKBfA26YppRwDjPIj6NYtF3I28lRC\n" + "Uo+47TAVZM97gjN9oEwyHIVtOc7fnZPwtN26M5v5083SGXU1k/PN3xGAlDUiCF3R\n" + "SMbBRylGgUVtsAD57i8tI2SqCr+ZG233VFiOdwTRKKVNTyMC9TCJdCFFEDFDHTTS\n" + "imKRQKy0Cm2qoL6JBkziAIiu/0Zzv9YjAAnRoJ2cweMXQ/9z1oWeEUZBLRsggYQ8\n" + "FbM13FOkOs8IlzacSuhwrYKOq8LsMX4cH2mnn783FtXXqrL/xfL711KhzGpZNrz1\n" + "87ilJ+ZsmP9D6vCBP/tR7V52dgtB6I291o8zxdH8GheIGenEFaZaoAwyN2FuJgXZ\n" + "qx9319I9gYerZ/BbUzA2MuOxFd0ywtdcTPqKiyAQ9rxQVCVQyYWjkfBEYRzWxjfj\n" + "3XhNprxdm3cauz01NAoTDiz52dZhGQIDAQABAoICADTppZmUeVEunQZc3Y/BtABX\n" + "IAeB6yDuJd2ox0b9wFzpf4vln9pblvsQzLwdLCT5tnV+iIHsXovJp19WPpQgFsZy\n" + "OkYuMF82Qwvlt7Po1Smwng4QeLD9MOvBW658lKw7kkGw6qkybp3nQrhKuSlqrWbS\n" + "2jZN2h8VEDHyE4HchXUpi/ojfjwf3S7/P1dKMM8xD+G5x91+17u3px0rc2rgBKbm\n" + "vy4pnPMegtETopnOG/grv3dUGPv/FHFsorOnL8vIRFnerC+++K4GmHSGV6NDCy+r\n" + "GT3TNAoyzsFMftQwGh0FQiwGQUW0v3G9HaMyVLZlG63H8dP+AsK5mBpCllvqKyMb\n" + "TQcS8mTBYAvBgiKqZBy6cwbnLaN5hYftDTg4zS62LVZzNlaMeTFGGYINDrth2S6X\n" + "+qH2GcXAUqd8aYIz/BLimCGhZMFQ0hAFCcq72Lh8UJsvvf9ng8Di/6oiZFJeN4nf\n" + "/LHUjlOyBqj8prTh0UCBjM0hdzzs96K+e3eBGjFHdVrdK5QytKZh1KTBSu0t64b2\n" + "0MSW5+2vFbdaQT5jed2lyh9YMmtGJV07T+5LKjWQGcJcc53DLA6uQ8lQuckQReE4\n" + "VzTWoG0eKEvk8ahltbl+0Gk7+fQlsMD5VizbET7EDOoiFPT3SpA/5dybXglNSuH4\n" + "9T65s7Xj2/zD8khLb3CxAoIBAQDwV3OQ66kqIC554Emz7F9ZNInMx4Vjuatd4wxe\n" + "WMT1Vlyg0ZeNSgdfggPmfntDW56NZ/h7q9F9feGfF3OogfZXVv2NzsynAOS4DR1c\n" + "0JR8/y7NG8vxHmDkNVJ3YkHfNYqK3x+sMCoXF0jDdaILXaP0nzAdcnLrRLyU9F3r\n" + "RVJpyaMWt9mtnRzlf1PTlc9WQ99MYuMfqxFj/zBFddnNFiI0FaG3/3Xdg6EH9x42\n" + "/2GXT/TlSUQo4e6Dh9mGhupUYzJt+AqjCnFA2n+D68QIdVq8ykOqGvnpwmfF94qt\n" + "8xfrKhI4zskj4N0X/xwByfEBOkU8nI8zP8PdVqKCbCRG1Z93AoIBAQDcwSRpPD5J\n" + "dmfXY2MGHvGQiJme/3YGPhcA15fQVRzWuZtn1PHULlI2V62NintzTUhjmv6SkGyX\n" + "6ze4RSCxrRFJumJwev5HtohQ7DH/nDtg+Y9Ewn32ehSEotycz1HUskOtgtLOQjwY\n" + "m66gTx6OzG4T6G2YRHcK8hFk9eLR0t2fIqPtu6APfRuo5OowiuYVzRKOplzh2J05\n" + "Q1TCJ4QL6geJQ/MzxVx33yopXWfRxZekG7ri4OJTIv8zj1Ocrytgz4hxAc8xJEf5\n" + "Z50k4JaWGBy+O/mKZ9sOGsolNv/FMUauE2EjSeNWNgvCFFvh4hDUciIakPzEeslp\n" + "hZdZCG9IV8fvAoIBAQDoDbfSbAc4Wjwlhq4C362sJrMKGnarNADGtMsjaRg6PTlQ\n" + "OS3XyGtYBuOXL/X5skNjCsj7N4kcXmdywST1xQ3BhIdp3QryEEXFgzwfenB0Q7q/\n" + "ZSBDXW51yRonlKI/TqXGseoVyadKBjxGJJTh3nbIYM8HD5Lvn71pIIxx9cu9wmcK\n" + "L1cobvMQjyCzwQigpQW77hqXYAd5glHsLv6tKrq5iU1Mp4X46/eWBj6RIYDrpNKy\n" + "c0wxIPu22XrojelAs0pkrUIv64wv7weBqyjqdcy3TZ+JZWR5FDA4D2tByt4EO+m+\n" + "GcJRNvKiEbnL7FwbMFTbUdpdxCpr0hM0VA+uqOG/AoIBAB24JuXABYawWSSHLdKq\n" + "Ic1ahowASmxmuYQUgky62KoTzNc6tN/i6JCGV0gh56LLOb6nJDSpGuWM9jBpphAl\n" + "g5lQbWZFOKyA53M1iTmnV9sjXeVc5cZkAxUkM90skBC5eyEF5sl740lQ1D6iyDNj\n" + "VEJ73R1NwlUH582WyNWEtO9yo20jAFZ1el7PirPET1uKA0CPJxwEpI4MAYIt/bn4\n" + "5NDXBAvpOxysP6nX+F0mY9blINDgg7e7k23mktQaRRXAetbz7mfoQYRTLbXEQqGs\n" + "V1pJCrxWZQhOFP7Tm7V5f9F5rG8qyF9X4VdclE4huDBRuUOoV09AVJNPN+P1nb24\n" + "i6MCggEBAIHUb8G0QKM4LPfdUmv575YmbnYY+Y3O982+jjRg4uAkYHnEkNfL6FKE\n" + "6ot7vcwDTN2Ccw6UKZU8GvyAQOGotmj6Nkgny2wFnEfoTzJaENjhPlnCHD9LDCps\n" + "w/tuoCHOUyyEb/Ygc+4xTsc0W3y2dbaYcg1qvLeIFuVZBNvY1XNlVf40/sVoiyet\n" + "Abh2yPwqOgOu8FpK4gcM8iSwL/xhEJJgT2wE+1MyHOd8KKklFHR7dF2WX1dF0Sif\n" + "cerPwqKXCvWh7og0RIJXe24fymMxtIsURBer9a3bPzUPVQoOXki4/u/kdEGH66GH\n" + "+6f4hsbp29hg+BUZ+UPdk7QyCKpZD1A=\n" + "-----END PRIVATE KEY-----\n"; + +/** + * RAII helper for managing temporary TLS certificates in tests. + * + * Creates a temporary directory and writes test certificates to it. + * Automatically cleans up the directory when destroyed. + */ +class TemporaryTLSCertificates +{ +public: + static constexpr std::string_view kCA_CERT_FILENAME = "ca.pem"; + static constexpr std::string_view kSERVER_CERT_FILENAME = "server_cert.pem"; + static constexpr std::string_view kSERVER_KEY_FILENAME = "server_key.pem"; + static constexpr std::string_view kCLIENT_CERT_FILENAME = "client_cert.pem"; + static constexpr std::string_view kCLIENT_KEY_FILENAME = "client_key.pem"; + static constexpr std::string_view kCERTS_DIR_PREFIX = "grpc_tls_test_"; + + TemporaryTLSCertificates() + { + auto tmpDir = std::filesystem::temp_directory_path(); + auto uniqueDirName = + boost::filesystem::unique_path(std::string(kCERTS_DIR_PREFIX) + "%%%%%%%%"); + tempDir_ = tmpDir / uniqueDirName.string(); + std::filesystem::create_directories(tempDir_); + + writeFile(tempDir_ / kCA_CERT_FILENAME, kCA_CERT_CONTENT); + writeFile(tempDir_ / kSERVER_CERT_FILENAME, kSERVER_CERT_CONTENT); + writeFile(tempDir_ / kSERVER_KEY_FILENAME, kSERVER_KEY_CONTENT); + writeFile(tempDir_ / kCLIENT_CERT_FILENAME, kCLIENT_CERT_CONTENT); + writeFile(tempDir_ / kCLIENT_KEY_FILENAME, kCLIENT_KEY_CONTENT); + } + + virtual ~TemporaryTLSCertificates() + { + std::error_code ec; + std::filesystem::remove_all(tempDir_, ec); + } + + TemporaryTLSCertificates(TemporaryTLSCertificates const&) = delete; + TemporaryTLSCertificates& + operator=(TemporaryTLSCertificates const&) = delete; + TemporaryTLSCertificates(TemporaryTLSCertificates&&) = delete; + TemporaryTLSCertificates& + operator=(TemporaryTLSCertificates&&) = delete; + + [[nodiscard]] std::filesystem::path + getCACertPath() const + { + return tempDir_ / kCA_CERT_FILENAME; + } + + [[nodiscard]] std::filesystem::path + getServerCertPath() const + { + return tempDir_ / kSERVER_CERT_FILENAME; + } + + [[nodiscard]] std::filesystem::path + getServerKeyPath() const + { + return tempDir_ / kSERVER_KEY_FILENAME; + } + + [[nodiscard]] std::filesystem::path + getClientCertPath() const + { + return tempDir_ / kCLIENT_CERT_FILENAME; + } + + [[nodiscard]] std::filesystem::path + getClientKeyPath() const + { + return tempDir_ / kCLIENT_KEY_FILENAME; + } + + [[nodiscard]] std::filesystem::path + getTempDir() const + { + return tempDir_; + } + +private: + static void + writeFile(std::filesystem::path const& path, std::string_view content) + { + std::ofstream file(path); + if (!file) + throw std::runtime_error("Failed to create file: " + path.string()); + file << content; + if (!file) + throw std::runtime_error("Failed to write file: " + path.string()); + } + + std::filesystem::path tempDir_; +}; + +} // namespace + +namespace xrpl { +namespace test { +/** + * Helper function to make a simple gRPC call to test connectivity. + * Returns true if the call succeeded, false otherwise. + */ +bool +makeTestGRPCCall(std::unique_ptr const& stub) +{ + grpc::ClientContext context; + org::xrpl::rpc::v1::GetLedgerRequest const request; + org::xrpl::rpc::v1::GetLedgerResponse response; + + // Set a short deadline to avoid hanging on failed connections + context.set_deadline(std::chrono::system_clock::now() + std::chrono::seconds(2)); + + grpc::Status const status = stub->GetLedger(&context, request, &response); + return status.ok(); +} + +class GRPCServerTLS_test : public beast::unit_test::suite, public TemporaryTLSCertificates +{ +public: + void + testWithoutTLS() + { + testcase("GRPCServer without TLS"); + + using namespace jtx; + + // Create config without TLS settings + auto cfg = envconfig(addGrpcConfig); + Env env(*this, std::move(cfg)); + + // Verify the server actually started by checking the port + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort > 0); + + // Test 1: Plaintext client should connect successfully + std::string const serverAddress = "localhost:" + std::to_string(*grpcPort); + auto plaintextStub = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::InsecureChannelCredentials())); + BEAST_EXPECT(makeTestGRPCCall(plaintextStub)); + } + + void + testWithValidTLS() + { + testcase("GRPCServer with valid TLS configuration (no mutual TLS)"); + + using namespace jtx; + + // Test with just server cert and key (no client verification) + auto cfg = envconfig( + addGrpcConfigWithTLS, getServerCertPath().string(), getServerKeyPath().string()); + Env env(*this, std::move(cfg)); + + // Verify the server actually started by checking the port + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort > 0); + + std::string const serverAddress = "localhost:" + std::to_string(*grpcPort); + + // Test 1: Plaintext client should FAIL against TLS server + auto plaintextStub = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::InsecureChannelCredentials())); + BEAST_EXPECT(!makeTestGRPCCall(plaintextStub)); + + // Test 2: TLS client with server CA should succeed + grpc::SslCredentialsOptions sslOpts; + sslOpts.pem_root_certs = std::string(kCA_CERT_CONTENT); + auto tlsStub = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::SslCredentials(sslOpts))); + BEAST_EXPECT(makeTestGRPCCall(tlsStub)); + } + + void + testWithMutualTLS() + { + testcase("GRPCServer with mutual TLS (client verification enabled)"); + + using namespace jtx; + + // Test with server cert, key, and CA for client verification + auto cfg = envconfig( + addGrpcConfigWithTLSAndClientCA, + getServerCertPath().string(), + getServerKeyPath().string(), + getCACertPath().string()); + Env env(*this, std::move(cfg)); + + // Verify the server actually started by checking the port + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort > 0); + + auto const serverAddress = "localhost:" + std::to_string(*grpcPort); + + // Test 1: TLS client WITHOUT client certificate should FAIL (mTLS requires client cert) + grpc::SslCredentialsOptions sslOptsNoClient; + sslOptsNoClient.pem_root_certs = std::string(kCA_CERT_CONTENT); + auto tlsStubNoClient = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::SslCredentials(sslOptsNoClient))); + BEAST_EXPECT(!makeTestGRPCCall(tlsStubNoClient)); + + // Test 2: TLS client WITH client certificate should succeed + grpc::SslCredentialsOptions sslOptsWithClient; + sslOptsWithClient.pem_root_certs = std::string(kCA_CERT_CONTENT); + sslOptsWithClient.pem_cert_chain = std::string(kCLIENT_CERT_CONTENT); + sslOptsWithClient.pem_private_key = std::string(kCLIENT_KEY_CONTENT); + auto tlsStubWithClient = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::SslCredentials(sslOptsWithClient))); + BEAST_EXPECT(makeTestGRPCCall(tlsStubWithClient)); + } + + void + testWithMissingKey() + { + testcase("GRPCServer with cert but no key"); + + using namespace jtx; + + // Create config with only cert (missing key) + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + // Intentionally omit ssl_key + + try + { + Env const env(*this, std::move(cfg)); + fail("Should have thrown exception for incomplete TLS config"); + } + catch (std::runtime_error const& e) + { + BEAST_EXPECT( + std::string(e.what()).find("Incomplete TLS configuration") != std::string::npos); + } + } + + void + testWithMissingCert() + { + testcase("GRPCServer with key but no cert"); + + using namespace jtx; + + // Create config with only key (missing cert) + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", getServerKeyPath().string()); + // Intentionally omit ssl_cert + + try + { + Env const env(*this, std::move(cfg)); + fail("Should have thrown exception for incomplete TLS config"); + } + catch (std::runtime_error const& e) + { + BEAST_EXPECT( + std::string(e.what()).find("Incomplete TLS configuration") != std::string::npos); + } + } + + void + testWithClientCAButNoTLS() + { + testcase("GRPCServer with ssl_client_ca but without both ssl_cert and ssl_key"); + + using namespace jtx; + + // Test 1: ssl_client_ca specified without any TLS config + { + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_client_ca", getCACertPath().string()); + // Intentionally omit both ssl_cert and ssl_key + + try + { + Env const env(*this, std::move(cfg)); + fail("Should have thrown exception for ssl_client_ca without TLS config"); + } + catch (std::runtime_error const& e) + { + BEAST_EXPECT( + std::string(e.what()).find( + "ssl_client_ca requires both ssl_cert and ssl_key") != std::string::npos); + } + } + + // Test 2: ssl_client_ca with only ssl_cert (missing ssl_key) + { + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_client_ca", getCACertPath().string()); + // Intentionally omit ssl_key + + try + { + Env const env(*this, std::move(cfg)); + fail("Should have thrown exception for ssl_client_ca with only ssl_cert"); + } + catch (std::runtime_error const& e) + { + // This should fail with "Incomplete TLS configuration" first + // because ssl_cert is specified without ssl_key + BEAST_EXPECT( + std::string(e.what()).find("Incomplete TLS configuration") != + std::string::npos); + } + } + + // Test 3: ssl_client_ca with only ssl_key (missing ssl_cert) + { + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", getServerKeyPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_client_ca", getCACertPath().string()); + // Intentionally omit ssl_cert + + try + { + Env const env(*this, std::move(cfg)); + fail("Should have thrown exception for ssl_client_ca with only ssl_key"); + } + catch (std::runtime_error const& e) + { + // This should fail with "Incomplete TLS configuration" first + // because ssl_key is specified without ssl_cert + BEAST_EXPECT( + std::string(e.what()).find("Incomplete TLS configuration") != + std::string::npos); + } + } + } + + void + testWithCertChainButNoTLS() + { + testcase("GRPCServer with ssl_cert_chain but without both ssl_cert and ssl_key"); + + using namespace jtx; + + // Test 1: ssl_cert_chain specified without any TLS config + { + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert_chain", getCACertPath().string()); + // Intentionally omit both ssl_cert and ssl_key + + try + { + Env const env(*this, std::move(cfg)); + fail("Should have thrown exception for ssl_cert_chain without TLS config"); + } + catch (std::runtime_error const& e) + { + BEAST_EXPECT( + std::string(e.what()).find( + "ssl_cert_chain requires both ssl_cert and ssl_key") != std::string::npos); + } + } + + // Test 2: ssl_cert_chain with only ssl_cert (missing ssl_key) + { + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert_chain", getCACertPath().string()); + // Intentionally omit ssl_key + + try + { + Env const env(*this, std::move(cfg)); + fail("Should have thrown exception for ssl_cert_chain with only ssl_cert"); + } + catch (std::runtime_error const& e) + { + // This should fail with "Incomplete TLS configuration" first + // because ssl_cert is specified without ssl_key + BEAST_EXPECT( + std::string(e.what()).find("Incomplete TLS configuration") != + std::string::npos); + } + } + } + + void + testWithCertChain() + { + testcase("GRPCServer with ssl_cert_chain for intermediate CA certificates"); + + using namespace jtx; + + // Test with server cert, key, and cert chain (intermediate CA) + // In this test, we use the CA cert as a stand-in for an intermediate CA cert + auto cfg = envconfig( + addGrpcConfigWithTLSAndCertChain, + getServerCertPath().string(), + getServerKeyPath().string(), + getCACertPath().string()); + Env env(*this, std::move(cfg)); + + // Verify the server actually started by checking the port + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort > 0); + + auto const serverAddress = "localhost:" + std::to_string(*grpcPort); + + // Test: TLS client should be able to connect (no client cert required) + grpc::SslCredentialsOptions sslOpts; + sslOpts.pem_root_certs = std::string(kCA_CERT_CONTENT); + auto tlsStub = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::SslCredentials(sslOpts))); + BEAST_EXPECT(makeTestGRPCCall(tlsStub)); + + // Insecure client should fail + auto insecureStub = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::InsecureChannelCredentials())); + BEAST_EXPECT(!makeTestGRPCCall(insecureStub)); + } + + void + testWithInvalidCertFile() + { + testcase("GRPCServer with invalid/non-existent certificate file"); + + using namespace jtx; + + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", "/nonexistent/path/to/cert.pem"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", getServerKeyPath().string()); + + Env env(*this, std::move(cfg)); + + // Server should fail to start - verify port is 0 + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort == 0); // Server should not have started + } + + void + testWithInvalidKeyFile() + { + testcase("GRPCServer with invalid/non-existent key file"); + + using namespace jtx; + + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", "/nonexistent/path/to/key.pem"); + + Env env(*this, std::move(cfg)); + + // Server should fail to start - verify port is 0 + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort == 0); // Server should not have started + } + + void + testWithInvalidCertChainFile() + { + testcase("GRPCServer with invalid/non-existent cert chain file"); + + using namespace jtx; + + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", getServerKeyPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert_chain", "/nonexistent/path/to/chain.pem"); + + Env env(*this, std::move(cfg)); + + // Server should fail to start - verify port is 0 + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort == 0); // Server should not have started + } + + void + testWithInvalidClientCAFile() + { + testcase("GRPCServer with invalid/non-existent client CA file"); + + using namespace jtx; + + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", getServerKeyPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_client_ca", "/nonexistent/path/to/ca.pem"); + + Env env(*this, std::move(cfg)); + + // Server should fail to start - verify port is 0 + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort == 0); // Server should not have started + } + + void + testWithEmptyClientCAFile() + { + testcase("GRPCServer with empty client CA file"); + + using namespace jtx; + + // Create an empty file for client CA + auto emptyCAPath = getTempDir() / "empty_ca.pem"; + std::ofstream emptyFile(emptyCAPath); + emptyFile.close(); + + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", "127.0.0.1"); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", getServerKeyPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_client_ca", emptyCAPath.string()); + + Env env(*this, std::move(cfg)); + + // Server should fail to start due to empty CA file + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort == 0); // Server should not have started + } + + void + testWithBothCertChainAndClientCA() + { + testcase("GRPCServer with both cert chain and client CA (full mTLS with intermediates)"); + + using namespace jtx; + + // Test with all TLS features enabled: cert, key, cert_chain, and client_ca + auto cfg = envconfig(); + (*cfg)[SECTION_PORT_GRPC].set("ip", getEnvLocalhostAddr()); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", getServerCertPath().string()); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", getServerKeyPath().string()); + (*cfg)[SECTION_PORT_GRPC].set( + "ssl_cert_chain", getCACertPath().string()); // Using CA as intermediate + (*cfg)[SECTION_PORT_GRPC].set("ssl_client_ca", getCACertPath().string()); + + Env env(*this, std::move(cfg)); + + // Verify the server started successfully + auto const grpcPort = env.app().config()[SECTION_PORT_GRPC].get("port"); + BEAST_EXPECT(grpcPort.has_value()); + BEAST_EXPECT(*grpcPort > 0); + + auto const serverAddress = "localhost:" + std::to_string(*grpcPort); + + // Test 1: TLS client WITHOUT client certificate should FAIL (mTLS requires client cert) + grpc::SslCredentialsOptions sslOptsNoClient; + sslOptsNoClient.pem_root_certs = std::string(kCA_CERT_CONTENT); + auto tlsStubNoClient = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::SslCredentials(sslOptsNoClient))); + BEAST_EXPECT(!makeTestGRPCCall(tlsStubNoClient)); + + // Test 2: TLS client WITH client certificate should succeed + grpc::SslCredentialsOptions sslOptsWithClient; + sslOptsWithClient.pem_root_certs = std::string(kCA_CERT_CONTENT); + sslOptsWithClient.pem_cert_chain = std::string(kCLIENT_CERT_CONTENT); + sslOptsWithClient.pem_private_key = std::string(kCLIENT_KEY_CONTENT); + auto tlsStubWithClient = org::xrpl::rpc::v1::XRPLedgerAPIService::NewStub( + grpc::CreateChannel(serverAddress, grpc::SslCredentials(sslOptsWithClient))); + BEAST_EXPECT(makeTestGRPCCall(tlsStubWithClient)); + } + + void + run() override + { + testWithoutTLS(); + testWithValidTLS(); + testWithMutualTLS(); + testWithMissingKey(); + testWithMissingCert(); + testWithClientCAButNoTLS(); + testWithCertChainButNoTLS(); + testWithCertChain(); + testWithInvalidCertFile(); + testWithInvalidKeyFile(); + testWithInvalidCertChainFile(); + testWithInvalidClientCAFile(); + testWithEmptyClientCAFile(); + testWithBothCertChainAndClientCA(); + } +}; + +BEAST_DEFINE_TESTSUITE(GRPCServerTLS, app, xrpl); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/HashRouter_test.cpp b/src/test/app/HashRouter_test.cpp index a1601914cf..70bf0a1a39 100644 --- a/src/test/app/HashRouter_test.cpp +++ b/src/test/app/HashRouter_test.cpp @@ -2,9 +2,16 @@ #include #include -#include +#include #include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -27,9 +34,9 @@ class HashRouter_test : public beast::unit_test::suite TestStopwatch stopwatch; HashRouter router(getSetup(2s, 1s), stopwatch); - HashRouterFlags key1(HashRouterFlags::PRIVATE1); - HashRouterFlags key2(HashRouterFlags::PRIVATE2); - HashRouterFlags key3(HashRouterFlags::PRIVATE3); + HashRouterFlags const key1(HashRouterFlags::PRIVATE1); + HashRouterFlags const key2(HashRouterFlags::PRIVATE2); + HashRouterFlags const key3(HashRouterFlags::PRIVATE3); auto const ukey1 = uint256{static_cast(key1)}; auto const ukey2 = uint256{static_cast(key2)}; @@ -69,10 +76,10 @@ class HashRouter_test : public beast::unit_test::suite TestStopwatch stopwatch; HashRouter router(getSetup(2s, 1s), stopwatch); - HashRouterFlags key1(HashRouterFlags::PRIVATE1); - HashRouterFlags key2(HashRouterFlags::PRIVATE2); - HashRouterFlags key3(HashRouterFlags::PRIVATE3); - HashRouterFlags key4(HashRouterFlags::PRIVATE4); + HashRouterFlags const key1(HashRouterFlags::PRIVATE1); + HashRouterFlags const key2(HashRouterFlags::PRIVATE2); + HashRouterFlags const key3(HashRouterFlags::PRIVATE3); + HashRouterFlags const key4(HashRouterFlags::PRIVATE4); auto const ukey1 = uint256{static_cast(key1)}; auto const ukey2 = uint256{static_cast(key2)}; @@ -242,7 +249,7 @@ class HashRouter_test : public beast::unit_test::suite TestStopwatch stopwatch; HashRouter router(getSetup(5s, 1s), stopwatch); uint256 const key(1); - HashRouter::PeerShortID peer = 1; + HashRouter::PeerShortID const peer = 1; HashRouterFlags flags = HashRouterFlags::UNDEFINED; BEAST_EXPECT(router.shouldProcess(key, peer, flags, 1s)); @@ -259,7 +266,7 @@ class HashRouter_test : public beast::unit_test::suite using namespace std::chrono_literals; { - Config cfg; + Config const cfg; // default auto const setup = setup_HashRouter(cfg); BEAST_EXPECT(setup.holdTime == 300s); @@ -298,7 +305,7 @@ class HashRouter_test : public beast::unit_test::suite } catch (std::exception const& e) { - std::string expected = + std::string const expected = "HashRouter relay time must be less than or equal to hold " "time"; BEAST_EXPECT(e.what() == expected); @@ -317,7 +324,7 @@ class HashRouter_test : public beast::unit_test::suite } catch (std::exception const& e) { - std::string expected = + std::string const expected = "HashRouter hold time must be at least 12 seconds (the " "approximate validation time for three " "ledgers)."; @@ -337,7 +344,7 @@ class HashRouter_test : public beast::unit_test::suite } catch (std::exception const& e) { - std::string expected = + std::string const expected = "HashRouter relay time must be at least 8 seconds (the " "approximate validation time for two ledgers)."; BEAST_EXPECT(e.what() == expected); @@ -365,9 +372,9 @@ class HashRouter_test : public beast::unit_test::suite using HF = HashRouterFlags; using UHF = std::underlying_type_t; - HF f1 = HF::BAD; - HF f2 = HF::SAVED; - HF combined = f1 | f2; + HF const f1 = HF::BAD; + HF const f2 = HF::SAVED; + HF const combined = f1 | f2; BEAST_EXPECT(static_cast(combined) == (static_cast(f1) | static_cast(f2))); @@ -375,7 +382,7 @@ class HashRouter_test : public beast::unit_test::suite temp |= f2; BEAST_EXPECT(temp == combined); - HF intersect = combined & f1; + HF const intersect = combined & f1; BEAST_EXPECT(intersect == f1); HF temp2 = combined; diff --git a/src/test/app/Invariants_test.cpp b/src/test/app/Invariants_test.cpp index c1d8003038..27a1a69d2b 100644 --- a/src/test/app/Invariants_test.cpp +++ b/src/test/app/Invariants_test.cpp @@ -1,28 +1,66 @@ -#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include #include #include #include #include +#include #include #include +#include +#include +#include #include +#include #include +#include +#include #include -#include +#include +#include +#include #include +#include #include +#include #include +#include #include #include #include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -136,7 +174,7 @@ class Invariants_test : public beast::unit_test::suite OpenView ov{*env.current()}; test::StreamSink sink{beast::severities::kWarning}; - beast::Journal jlog{sink}; + beast::Journal const jlog{sink}; ApplyContext ac{env.app(), ov, tx, tesSUCCESS, env.current()->fees().base, tapNONE, jlog}; BEAST_EXPECT(precheck(A1, A2, ac)); @@ -601,7 +639,7 @@ class Invariants_test : public beast::unit_test::suite using namespace test::jtx; testcase << "transfers when frozen"; - Account G1{"G1"}; + Account const G1{"G1"}; // Helper function to establish the trustlines auto const createTrustlines = [&](Account const& A1, Account const& A2, Env& env) { // Preclose callback to establish trust lines with gateway @@ -859,7 +897,7 @@ class Invariants_test : public beast::unit_test::suite auto sleNew = std::make_shared(keylet::escrow(A1, (*sle)[sfSequence] + 2)); Issue const usd{Currency(0x5553440000000000), AccountID(0x4985601)}; - STAmount amt(usd, -1); + STAmount const amt(usd, -1); sleNew->setFieldAmount(sfAmount, amt); ac.view().insert(sleNew); return true; @@ -876,7 +914,7 @@ class Invariants_test : public beast::unit_test::suite auto sleNew = std::make_shared(keylet::escrow(A1, (*sle)[sfSequence] + 2)); Issue const bad{badCurrency(), AccountID(0x4985601)}; - STAmount amt(bad, 1); + STAmount const amt(bad, 1); sleNew->setFieldAmount(sfAmount, amt); ac.view().insert(sleNew); return true; @@ -893,7 +931,7 @@ class Invariants_test : public beast::unit_test::suite auto sleNew = std::make_shared(keylet::escrow(A1, (*sle)[sfSequence] + 2)); MPTIssue const mpt{MPTIssue{makeMptID(1, AccountID(0x4985601))}}; - STAmount amt(mpt, -1); + STAmount const amt(mpt, -1); sleNew->setFieldAmount(sfAmount, amt); ac.view().insert(sleNew); return true; @@ -1040,8 +1078,7 @@ class Invariants_test : public beast::unit_test::suite auto const sleNew = std::make_shared(acctKeylet); sleNew->setFieldU32(sfSequence, 0); sleNew->setFieldH256(sfAMMID, uint256(1)); - sleNew->setFieldU32( - sfFlags, lsfDisableMaster | lsfDefaultRipple | lsfDefaultRipple); + sleNew->setFieldU32(sfFlags, lsfDisableMaster | lsfDefaultRipple); ac.view().insert(sleNew); return true; }, @@ -1267,8 +1304,8 @@ class Invariants_test : public beast::unit_test::suite using namespace test::jtx; bool const fixPDEnabled = features[fixPermissionedDomainInvariant]; - std::initializer_list badTers = {tecINVARIANT_FAILED, tecINVARIANT_FAILED}; - std::initializer_list failTers = {tecINVARIANT_FAILED, tefINVARIANT_FAILED}; + std::initializer_list const badTers = {tecINVARIANT_FAILED, tecINVARIANT_FAILED}; + std::initializer_list const failTers = {tecINVARIANT_FAILED, tefINVARIANT_FAILED}; testcase << "PermissionedDomain" + std::string(fixPDEnabled ? " fix" : ""); @@ -1352,7 +1389,7 @@ class Invariants_test : public beast::unit_test::suite // update PD with empty rules { - STArray credentials(sfAcceptedCredentials, 2); + STArray const credentials(sfAcceptedCredentials, 2); slePd->setFieldArray(sfAcceptedCredentials, credentials); ac.view().update(slePd); } @@ -1452,15 +1489,16 @@ class Invariants_test : public beast::unit_test::suite STTx{ttPERMISSIONED_DOMAIN_SET, [](STObject&) {}}, fixPDEnabled ? failTers : badTers); - std::initializer_list goodTers = {tesSUCCESS, tesSUCCESS}; + std::initializer_list const goodTers = {tesSUCCESS, tesSUCCESS}; - std::vector badMoreThan1{ + std::vector const badMoreThan1{ {"transaction affected more than 1 permissioned domain entry."}}; - std::vector emptyV; - std::vector badNoDomains{{"no domain objects affected by"}}; - std::vector badNotDeleted{{"domain object modified, but not deleted by "}}; - std::vector badDeleted{{"domain object deleted by"}}; - std::vector badTx{ + std::vector const emptyV; + std::vector const badNoDomains{{"no domain objects affected by"}}; + std::vector const badNotDeleted{ + {"domain object modified, but not deleted by "}}; + std::vector const badDeleted{{"domain object deleted by"}}; + std::vector const badTx{ {"domain object(s) affected by an unauthorized transaction."}}; { @@ -1610,11 +1648,11 @@ class Invariants_test : public beast::unit_test::suite using namespace jtx; AccountID pseudoAccountID; - Preclose createPseudo = [&, this](Account const& a, Account const& b, Env& env) { + Preclose const createPseudo = [&, this](Account const& a, Account const& b, Env& env) { PrettyAsset const xrpAsset{xrpIssue(), 1'000'000}; // Create vault - Vault vault{env}; + Vault const vault{env}; auto [tx, vKeylet] = vault.create({.owner = a, .asset = xrpAsset}); env(tx); env.close(); @@ -1738,7 +1776,7 @@ class Invariants_test : public beast::unit_test::suite std::uint32_t const seq = env.seq(A1); env(pdomain::setTx(A1, credentials)); - uint256 key = pdomain::getNewDomain(env.meta()); + uint256 const key = pdomain::getNewDomain(env.meta()); // std::cout << "PD, acc: " << A1.id() << ", seq: " << seq << ", k: " << // key << std::endl; @@ -1751,8 +1789,10 @@ class Invariants_test : public beast::unit_test::suite using namespace test::jtx; bool const fixPDEnabled = features[fixPermissionedDomainInvariant]; + bool const fixS313Enabled = features[fixSecurity3_1_3]; - testcase << "PermissionedDEX" + std::string(fixPDEnabled ? " fix" : ""); + testcase << "PermissionedDEX" + std::string(fixPDEnabled ? " fixPD" : "") + + std::string(fixS313Enabled ? " fixS313" : ""); doInvariantCheck( Env(*this, features), @@ -1840,6 +1880,45 @@ class Invariants_test : public beast::unit_test::suite {tecINVARIANT_FAILED, tecINVARIANT_FAILED}); } + // empty sfAdditionalBooks (size 0) + { + Env env1(*this, features); + + Account const A1{"A1"}; + Account const A2{"A2"}; + env1.fund(XRP(1000), A1, A2); + env1.close(); + + [[maybe_unused]] auto [seq1, pd1] = createPermissionedDomainEnv(env1, A1, A2); + env1.close(); + + doInvariantCheck( + std::move(env1), + A1, + A2, + fixS313Enabled ? std::vector{{"hybrid offer is malformed"}} + : std::vector{}, + [&pd1](Account const& A1, Account const& A2, ApplyContext& ac) { + Keylet const offerKey = keylet::offer(A2.id(), 10); + auto sleOffer = std::make_shared(offerKey); + sleOffer->setAccountID(sfAccount, A2); + sleOffer->setFieldAmount(sfTakerPays, A1["USD"](10)); + sleOffer->setFieldAmount(sfTakerGets, XRP(1)); + sleOffer->setFlag(lsfHybrid); + sleOffer->setFieldH256(sfDomainID, pd1); + + STArray const bookArr; // empty array, size 0 + sleOffer->setFieldArray(sfAdditionalBooks, bookArr); + ac.view().insert(sleOffer); + return true; + }, + XRPAmount{}, + STTx{ttOFFER_CREATE, [&](STObject&) {}}, + fixS313Enabled + ? std::initializer_list{tecINVARIANT_FAILED, tecINVARIANT_FAILED} + : std::initializer_list{tesSUCCESS, tesSUCCESS}); + } + // hybrid offer missing sfAdditionalBooks { Env env1(*this, features); @@ -1956,7 +2035,7 @@ class Invariants_test : public beast::unit_test::suite // Create vault uint256 vaultID; - Vault vault{env}; + Vault const vault{env}; auto [tx, vKeylet] = vault.create({.owner = a, .asset = asset}); env(tx); BEAST_EXPECT(env.le(vKeylet)); @@ -1981,7 +2060,7 @@ class Invariants_test : public beast::unit_test::suite // Initialize with a placeholder value because there's no default ctor Keylet loanBrokerKeylet = keylet::amendments(); - Preclose createLoanBroker = [&, this](Account const& a, Account const& b, Env& env) { + Preclose const createLoanBroker = [&, this](Account const& a, Account const& b, Env& env) { PrettyAsset const xrpAsset{xrpIssue(), 1'000'000}; loanBrokerKeylet = this->createLoanBroker(a, env, xrpAsset); @@ -2060,40 +2139,40 @@ class Invariants_test : public beast::unit_test::suite { // Initialize with a placeholder value because there's no default // ctor - Keylet loanBrokerKeylet = keylet::amendments(); - Preclose createLoanBroker = [&, this]( - Account const& alice, Account const& issuer, Env& env) { - PrettyAsset const asset = [&]() { - switch (assetType) - { - case Asset::IOU: { - PrettyAsset const iouAsset = issuer["IOU"]; - env(trust(alice, iouAsset(1000))); - env(pay(issuer, alice, iouAsset(1000))); - env.close(); - return iouAsset; - } - - case Asset::MPT: { - MPTTester mptt{env, issuer, mptInitNoFund}; - mptt.create( - {.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock}); - PrettyAsset const mptAsset = mptt.issuanceID(); - mptt.authorize({.account = alice}); - env(pay(issuer, alice, mptAsset(1000))); - env.close(); - return mptAsset; - } - - case Asset::XRP: - default: - return PrettyAsset{xrpIssue(), 1'000'000}; + auto const setupAsset = + [&](Account const& alice, Account const& issuer, Env& env) -> PrettyAsset { + switch (assetType) + { + case Asset::IOU: { + PrettyAsset const iouAsset = issuer["IOU"]; + env(trust(alice, iouAsset(1000))); + env(pay(issuer, alice, iouAsset(1000))); + env.close(); + return iouAsset; } - }(); - loanBrokerKeylet = this->createLoanBroker(alice, env, asset); - return BEAST_EXPECT(env.le(loanBrokerKeylet)); + case Asset::MPT: { + MPTTester mptt{env, issuer, mptInitNoFund}; + mptt.create({.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock}); + PrettyAsset const mptAsset = mptt.issuanceID(); + mptt.authorize({.account = alice}); + env(pay(issuer, alice, mptAsset(1000))); + env.close(); + return mptAsset; + } + case Asset::XRP: + default: + return PrettyAsset{xrpIssue(), 1'000'000}; + } }; + Keylet loanBrokerKeylet = keylet::amendments(); + Preclose const createLoanBroker = + [&, this](Account const& alice, Account const& issuer, Env& env) { + auto const asset = setupAsset(alice, issuer, env); + loanBrokerKeylet = this->createLoanBroker(alice, env, asset); + return BEAST_EXPECT(env.le(loanBrokerKeylet)); + }; + // Ensure the test scenarios are set up completely. The test cases // will need to recompute any of these values it needs for itself // rather than trying to return a bunch of items @@ -2263,6 +2342,56 @@ class Invariants_test : public beast::unit_test::suite STTx{ttLOAN_BROKER_SET, [](STObject& tx) {}}, {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, createLoanBroker); + + // Test: cover available less than pseudo-account asset balance + { + Keylet brokerKeylet = keylet::amendments(); + Preclose const createBrokerWithCover = + [&, this](Account const& alice, Account const& issuer, Env& env) { + auto const asset = setupAsset(alice, issuer, env); + brokerKeylet = this->createLoanBroker(alice, env, asset); + if (!BEAST_EXPECT(env.le(brokerKeylet))) + return false; + env(loanBroker::coverDeposit(alice, brokerKeylet.key, asset(10))); + env.close(); + return BEAST_EXPECT(env.le(brokerKeylet)); + }; + + doInvariantCheck( + {{"Loan Broker cover available is less than pseudo-account asset balance"}}, + [&](Account const&, Account const&, ApplyContext& ac) { + auto sle = ac.view().peek(brokerKeylet); + if (!BEAST_EXPECT(sle)) + return false; + // Pseudo-account holds 10 units, set cover to 5 + sle->at(sfCoverAvailable) = Number(5); + ac.view().update(sle); + return true; + }, + XRPAmount{}, + STTx{ttLOAN_BROKER_SET, [](STObject& tx) {}}, + {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, + createBrokerWithCover); + } + + // Test: cover available greater than pseudo-account asset balance + // (requires fixSecurity3_1_3) + doInvariantCheck( + {{"Loan Broker cover available is greater than pseudo-account asset balance"}}, + [&](Account const&, Account const&, ApplyContext& ac) { + auto sle = ac.view().peek(loanBrokerKeylet); + if (!BEAST_EXPECT(sle)) + return false; + // Pseudo-account has no cover deposited; set cover + // higher than any incidental balance + sle->at(sfCoverAvailable) = Number(1'000'000); + ac.view().update(sle); + return true; + }, + XRPAmount{}, + STTx{ttLOAN_BROKER_SET, [](STObject& tx) {}}, + {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, + createLoanBroker); } } @@ -2403,11 +2532,11 @@ class Invariants_test : public beast::unit_test::suite return sample; }; - Account A3{"A3"}; - Account A4{"A4"}; + Account const A3{"A3"}; + Account const A4{"A4"}; auto const precloseXrp = [&](Account const& A1, Account const& A2, Env& env) -> bool { env.fund(XRP(1000), A3, A4); - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); env(vault.deposit({.depositor = A1, .id = keylet.key, .amount = XRP(10)})); @@ -2431,7 +2560,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_DELETE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2451,7 +2580,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttPAYMENT, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2471,7 +2600,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttPAYMENT, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2507,7 +2636,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_SET, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2536,7 +2665,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_DELETE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; { auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); @@ -2582,7 +2711,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_DELETE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2608,7 +2737,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_DELETE, [](STObject&) {}}, {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); env(vault.deposit({.depositor = A1, .id = keylet.key, .amount = XRP(10)})); @@ -2644,7 +2773,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CREATE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2657,7 +2786,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_DEPOSIT, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2670,7 +2799,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_WITHDRAW, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2683,7 +2812,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CLAWBACK, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2696,7 +2825,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_DELETE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2722,7 +2851,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_SET, [](STObject&) {}}, {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, _] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -2744,7 +2873,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_WITHDRAW, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); env(vault.deposit({.depositor = A1, .id = keylet.key, .amount = XRP(10)})); @@ -2984,7 +3113,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CREATE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -3010,7 +3139,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CREATE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -3037,7 +3166,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CREATE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -3065,7 +3194,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CREATE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -3089,7 +3218,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CREATE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -3117,7 +3246,7 @@ class Invariants_test : public beast::unit_test::suite STTx{ttVAULT_CREATE, [](STObject&) {}}, {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, [&](Account const& A1, Account const& A2, Env& env) { - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = xrpIssue()}); env(tx); return true; @@ -3672,7 +3801,7 @@ class Invariants_test : public beast::unit_test::suite } auto const mptID = makeMptID(env.seq(A3) - 1, A3); - Asset asset = MPTIssue(mptID); + Asset const asset = MPTIssue(mptID); // Authorize A1 A2 A4 { Json::Value jv; @@ -3695,7 +3824,7 @@ class Invariants_test : public beast::unit_test::suite env.close(); } - Vault vault{env}; + Vault const vault{env}; auto [tx, keylet] = vault.create({.owner = A1, .asset = asset}); env(tx); env(vault.deposit({.depositor = A1, .id = keylet.key, .amount = asset(10)})); @@ -3819,6 +3948,154 @@ class Invariants_test : public beast::unit_test::suite precloseMpt); } + void + testMPT() + { + using namespace test::jtx; + testcase << "MPT"; + + // MPT OutstandingAmount > MaximumAmount + doInvariantCheck( + {{"OutstandingAmount overflow"}}, + [](Account const& A1, Account const&, ApplyContext& ac) { + // mptissuance outstanding is negative + auto const sle = ac.view().peek(keylet::account(A1.id())); + if (!sle) + return false; + + MPTIssue const mpt{MPTIssue{makeMptID(sle->getFieldU32(sfSequence), A1)}}; + auto sleNew = std::make_shared(keylet::mptIssuance(mpt.getMptID())); + sleNew->setFieldU64(sfOutstandingAmount, 110); + sleNew->setFieldU64(sfMaximumAmount, 100); + ac.view().insert(sleNew); + return true; + }); + + // MPTToken amount doesn't add up to OutstandingAmount + doInvariantCheck( + {{"invalid OutstandingAmount balance"}}, + [](Account const& A1, Account const& A2, ApplyContext& ac) { + // mptissuance outstanding is negative + auto const sle = ac.view().peek(keylet::account(A1.id())); + if (!sle) + return false; + + MPTIssue const mpt{MPTIssue{makeMptID(sle->getFieldU32(sfSequence), A1)}}; + auto sleNew = std::make_shared(keylet::mptIssuance(mpt.getMptID())); + sleNew->setFieldU64(sfOutstandingAmount, 100); + sleNew->setFieldU64(sfMaximumAmount, 100); + ac.view().insert(sleNew); + + sleNew = std::make_shared(keylet::mptoken(mpt.getMptID(), A2)); + sleNew->setFieldU64(sfMPTAmount, 90); + ac.view().insert(sleNew); + + return true; + }); + + // Overflow/Invalid balance on payment + auto testPayment = [&](std::string const& log, auto&& update) { + MPTID id; + doInvariantCheck( + {{log}}, + [&](Account const& A1, Account const& A2, ApplyContext& ac) { + return update(id, ac, A1); + }, + XRPAmount{}, + STTx{ttPAYMENT, [](STObject& tx) {}}, + {tecINVARIANT_FAILED, tecINVARIANT_FAILED}, + [&](Account const& A1, Account const& A2, Env& env) { + Account const gw("gw"); + env.fund(XRP(1'000), gw); + MPTTester const mpt( + {.env = env, .issuer = gw, .holders = {A1}, .pay = 100, .maxAmt = 100}); + id = mpt.issuanceID(); + return true; + }); + }; + testPayment( + "invalid OutstandingAmount balance", + [&](MPTID const& id, ApplyContext& ac, Account const& A1) { + auto sle = ac.view().peek(keylet::mptoken(id, A1)); + if (!sle) + return false; + sle->setFieldU64(sfMPTAmount, 101); + ac.view().update(sle); + return true; + }); + testPayment( + "OutstandingAmount overflow", [&](MPTID const& id, ApplyContext& ac, Account const&) { + auto sle = ac.view().peek(keylet::mptIssuance(id)); + if (!sle) + return false; + sle->setFieldU64(sfOutstandingAmount, 101); + ac.view().update(sle); + return true; + }); + + // More MPTokens created than expected + std::array, 4> const tests = { + std::make_pair(ttAMM_WITHDRAW, 2), + std::make_pair(ttAMM_CLAWBACK, 2), + std::make_pair(ttAMM_CREATE, 3), + std::make_pair(ttCHECK_CASH, 2)}; + for (auto const& [tx, nTokens] : tests) + { + doInvariantCheck( + {{std::string("MPToken created for the MPT issuer")}}, + [&](Account const& A1, Account const& A2, ApplyContext& ac) { + auto const sle = ac.view().peek(keylet::account(A1.id())); + if (!sle) + return false; + + auto seq = sle->getFieldU32(sfSequence); + for (int i = 0; i < nTokens; ++i) + { + MPTIssue const mpt{MPTIssue{makeMptID(seq + i, A1)}}; + auto sleNew = std::make_shared(keylet::mptIssuance(mpt.getMptID())); + ac.view().insert(sleNew); + + sleNew = std::make_shared(keylet::mptoken(mpt.getMptID(), A2)); + ac.view().insert(sleNew); + } + + return true; + }, + XRPAmount{}, + STTx{tx, [](STObject& tx) {}}, + {tecINVARIANT_FAILED, tefINVARIANT_FAILED}); + } + + // More MPTokens deleted than expected + for (auto const& tx : {ttAMM_WITHDRAW, ttAMM_CLAWBACK}) + { + MPTID id; + Account const A3("A3"); + doInvariantCheck( + {{"MPT authorize succeeded but created/deleted bad number of mptokens"}}, + [&](Account const& A1, Account const& A2, ApplyContext& ac) { + for (auto const& a : {A1, A2, A3}) + { + auto sle = ac.view().peek(keylet::mptoken(id, a)); + if (!sle) + return false; + ac.view().erase(sle); + } + return true; + }, + XRPAmount{}, + STTx{tx, [](STObject& tx) {}}, + {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, + [&](Account const& A1, Account const& A2, Env& env) { + Account const gw("gw"); + env.fund(XRP(1'000), gw, A3); + MPTTester const mpt({.env = env, .issuer = gw, .holders = {A1, A2, A3}}); + id = mpt.issuanceID(); + return true; + }); + } + } + public: void run() override @@ -3840,10 +4117,15 @@ public: testPermissionedDomainInvariants(defaultAmendments() - fixPermissionedDomainInvariant); testPermissionedDEX(defaultAmendments() | fixPermissionedDomainInvariant); testPermissionedDEX(defaultAmendments() - fixPermissionedDomainInvariant); + testPermissionedDEX( + (defaultAmendments() | fixPermissionedDomainInvariant) - fixSecurity3_1_3); + testPermissionedDEX( + defaultAmendments() - fixPermissionedDomainInvariant - fixSecurity3_1_3); testNoModifiedUnmodifiableFields(); testValidPseudoAccounts(); testValidLoanBroker(); testVault(); + testMPT(); } }; diff --git a/src/test/app/LPTokenTransfer_test.cpp b/src/test/app/LPTokenTransfer_test.cpp index 265ff7d2ef..c73504186a 100644 --- a/src/test/app/LPTokenTransfer_test.cpp +++ b/src/test/app/LPTokenTransfer_test.cpp @@ -1,6 +1,24 @@ -#include #include #include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -224,7 +242,7 @@ class LPTokenTransfer_test : public jtx::AMMTest AMM ammAlice1(env, alice, XRP(10'000), USD(10'000)); ammAlice1.deposit(carol, 10'000'000); - fund(env, gw, {alice, carol}, {EUR(10'000)}, Fund::IOUOnly); + fund(env, gw, {alice, carol}, {EUR(10'000)}, Fund::TokenOnly); AMM ammAlice2(env, alice, XRP(10'000), EUR(10'000)); ammAlice2.deposit(carol, 10'000'000); auto const token1 = ammAlice1.lptIssue(); diff --git a/src/test/app/LedgerHistory_test.cpp b/src/test/app/LedgerHistory_test.cpp index dbc20fe8f2..16be0e2da8 100644 --- a/src/test/app/LedgerHistory_test.cpp +++ b/src/test/app/LedgerHistory_test.cpp @@ -1,16 +1,28 @@ -#include +#include #include +#include +#include +#include +#include +#include #include #include +#include +#include #include -#include +#include +#include +#include #include +#include +#include #include -#include -#include +#include +#include +#include namespace xrpl { namespace test { @@ -138,17 +150,17 @@ public: Env env{*this, envconfig(), std::make_unique(msg, &found)}; LedgerHistory lh{beast::insight::NullCollector::New(), env.app()}; - Account alice{"A1"}; - Account bob{"A2"}; + Account const alice{"A1"}; + Account const bob{"A2"}; env.fund(XRP(1000), alice, bob); env.close(); auto const ledgerBase = env.app().getLedgerMaster().getClosedLedger(); - JTx txAlice = env.jt(noop(alice)); + JTx const txAlice = env.jt(noop(alice)); auto const ledgerA = makeLedger(ledgerBase, env, lh, 4s, txAlice.stx); - JTx txBob = env.jt(noop(bob)); + JTx const txBob = env.jt(noop(bob)); auto const ledgerB = makeLedger(ledgerBase, env, lh, 4s, txBob.stx); lh.builtLedger(ledgerA, txAlice.stx->getTransactionID(), {}); diff --git a/src/test/app/LedgerLoad_test.cpp b/src/test/app/LedgerLoad_test.cpp index 2fa1193921..a97b492921 100644 --- a/src/test/app/LedgerLoad_test.cpp +++ b/src/test/app/LedgerLoad_test.cpp @@ -1,17 +1,33 @@ -#include +#include #include +#include +#include +#include +#include -#include +#include + +#include #include #include #include +#include +#include +#include #include #include -#include -#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include namespace xrpl { @@ -57,7 +73,7 @@ class LedgerLoad_test : public beast::unit_test::suite for (auto i = 0; i < 20; ++i) { - Account acct{"A" + std::to_string(i)}; + Account const acct{"A" + std::to_string(i)}; env.fund(XRP(10000), acct); env.close(); if (i > 0 && BEAST_EXPECT(prev.has_value())) @@ -68,7 +84,7 @@ class LedgerLoad_test : public beast::unit_test::suite } env(offer(acct, XRP(100), acct["USD"](1))); env.close(); - prev.emplace(std::move(acct)); + prev.emplace(acct); } retval.ledger = env.rpc("ledger", "current", "full")[jss::result]; @@ -127,7 +143,7 @@ class LedgerLoad_test : public beast::unit_test::suite // empty path except([&] { - Env env( + Env const env( *this, envconfig(ledgerConfig, sd.dbPath, "", StartUpType::LoadFile, std::nullopt), nullptr, @@ -136,7 +152,7 @@ class LedgerLoad_test : public beast::unit_test::suite // file does not exist except([&] { - Env env( + Env const env( *this, envconfig( ledgerConfig, sd.dbPath, "badfile.json", StartUpType::LoadFile, std::nullopt), @@ -158,7 +174,7 @@ class LedgerLoad_test : public beast::unit_test::suite return; except([&] { - Env env( + Env const env( *this, envconfig( ledgerConfig, @@ -257,7 +273,7 @@ class LedgerLoad_test : public beast::unit_test::suite { // will throw an exception, because we cannot load a ledger for // replay when trapTxHash is set to an invalid transaction - Env env( + Env const env( *this, envconfig(ledgerConfig, sd.dbPath, ledgerHash, StartUpType::Replay, ~sd.trapTxHash), nullptr, @@ -314,7 +330,7 @@ public: void run() override { - beast::temp_dir td; + beast::temp_dir const td; auto sd = setupLedger(td); // test cases diff --git a/src/test/app/LedgerMaster_test.cpp b/src/test/app/LedgerMaster_test.cpp index 3ea16b63eb..5f9a756157 100644 --- a/src/test/app/LedgerMaster_test.cpp +++ b/src/test/app/LedgerMaster_test.cpp @@ -1,7 +1,22 @@ -#include +#include #include +#include +#include +#include #include +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include namespace xrpl { namespace test { @@ -51,14 +66,14 @@ class LedgerMaster_test : public beast::unit_test::suite // test invalid range { - std::uint32_t ledgerSeq = -1; - std::uint32_t txnIndex = 0; + std::uint32_t const ledgerSeq = -1; + std::uint32_t const txnIndex = 0; auto result = env.app().getLedgerMaster().txnIdFromIndex(ledgerSeq, txnIndex); BEAST_EXPECT(!result); } // test not in ledger { - uint32_t txnIndex = metas[0]->getFieldU32(sfTransactionIndex); + uint32_t const txnIndex = metas[0]->getFieldU32(sfTransactionIndex); auto result = env.app().getLedgerMaster().txnIdFromIndex(0, txnIndex); BEAST_EXPECT(!result); } @@ -69,13 +84,13 @@ class LedgerMaster_test : public beast::unit_test::suite } // ended without result { - uint32_t txnIndex = metas[0]->getFieldU32(sfTransactionIndex); + uint32_t const txnIndex = metas[0]->getFieldU32(sfTransactionIndex); auto result = env.app().getLedgerMaster().txnIdFromIndex(endLegSeq + 1, txnIndex); BEAST_EXPECT(!result); } // success (first tx) { - uint32_t txnIndex = metas[0]->getFieldU32(sfTransactionIndex); + uint32_t const txnIndex = metas[0]->getFieldU32(sfTransactionIndex); auto result = env.app().getLedgerMaster().txnIdFromIndex(startLegSeq, txnIndex); BEAST_EXPECT( // NOLINTNEXTLINE(bugprone-unchecked-optional-access) @@ -86,7 +101,7 @@ class LedgerMaster_test : public beast::unit_test::suite } // success (second tx) { - uint32_t txnIndex = metas[1]->getFieldU32(sfTransactionIndex); + uint32_t const txnIndex = metas[1]->getFieldU32(sfTransactionIndex); auto result = env.app().getLedgerMaster().txnIdFromIndex(startLegSeq + 1, txnIndex); BEAST_EXPECT( // NOLINTNEXTLINE(bugprone-unchecked-optional-access) diff --git a/src/test/app/LedgerReplay_test.cpp b/src/test/app/LedgerReplay_test.cpp index 93811d33b0..9205b38ce5 100644 --- a/src/test/app/LedgerReplay_test.cpp +++ b/src/test/app/LedgerReplay_test.cpp @@ -1,7 +1,15 @@ -#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include #include #include #include @@ -9,13 +17,51 @@ #include #include #include +#include +#include +#include #include -#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include + +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { namespace test { @@ -246,7 +292,7 @@ public: uint256 const& getClosedLedgerHash() const override { - static uint256 hash{}; + static uint256 const hash{}; return hash; } bool @@ -398,7 +444,7 @@ struct TestPeerSet : public PeerSet std::set const& getPeerIds() const override { - static std::set emptyPeers; + static std::set const emptyPeers; return emptyPeers; } @@ -605,7 +651,7 @@ public: bool waitForLedgers(uint256 const& finishLedgerHash, int totalReplay) { - int totalRound = 100; + int const totalRound = 100; for (int i = 0; i < totalRound; ++i) { if (haveLedgers(finishLedgerHash, totalReplay)) @@ -619,12 +665,12 @@ public: bool waitForDone() { - int totalRound = 100; + int const totalRound = 100; for (int i = 0; i < totalRound; ++i) { bool allDone = true; { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); for (auto const& t : replayer.tasks_) { if (!t->finished()) @@ -645,14 +691,14 @@ public: std::vector> getTasks() { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); return replayer.tasks_; } std::shared_ptr findTask(uint256 const& hash, int totalReplay) { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); auto i = std::find_if(replayer.tasks_.begin(), replayer.tasks_.end(), [&](auto const& t) { return t->parameter_.finishHash_ == hash && t->parameter_.totalLedgers_ == totalReplay; }); @@ -664,21 +710,21 @@ public: std::size_t countDeltas() { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); return replayer.deltas_.size(); } std::size_t countSkipLists() { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); return replayer.skipLists_.size(); } bool countsAsExpected(std::size_t tasks, std::size_t skipLists, std::size_t deltas) { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); return replayer.tasks_.size() == tasks && replayer.skipLists_.size() == skipLists && replayer.deltas_.size() == deltas; } @@ -686,7 +732,7 @@ public: std::shared_ptr findSkipListAcquire(uint256 const& hash) { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); auto i = replayer.skipLists_.find(hash); if (i == replayer.skipLists_.end()) return {}; @@ -696,7 +742,7 @@ public: std::shared_ptr findLedgerDeltaAcquire(uint256 const& hash) { - std::unique_lock lock(replayer.mtx_); + std::unique_lock const lock(replayer.mtx_); auto i = replayer.deltas_.find(hash); if (i == replayer.deltas_.end()) return {}; @@ -1017,26 +1063,26 @@ struct LedgerReplayer_test : public beast::unit_test::suite { testcase("config test"); { - Config c; + Config const c; BEAST_EXPECT(c.LEDGER_REPLAY == false); } { Config c; - std::string toLoad(R"rippleConfig( + std::string const toLoad(R"xrpldConfig( [ledger_replay] 1 -)rippleConfig"); +)xrpldConfig"); c.loadFromString(toLoad); BEAST_EXPECT(c.LEDGER_REPLAY == true); } { Config c; - std::string toLoad = (R"rippleConfig( + std::string const toLoad = (R"xrpldConfig( [ledger_replay] 0 -)rippleConfig"); +)xrpldConfig"); c.loadFromString(toLoad); BEAST_EXPECT(c.LEDGER_REPLAY == false); } @@ -1051,11 +1097,12 @@ struct LedgerReplayer_test : public beast::unit_test::suite http_request_type http_request; http_request.version(request.version()); http_request.base() = request.base(); - bool serverResult = peerFeatureEnabled(http_request, FEATURE_LEDGER_REPLAY, server); + bool const serverResult = + peerFeatureEnabled(http_request, FEATURE_LEDGER_REPLAY, server); if (serverResult != expecting) return false; - beast::IP::Address addr = boost::asio::ip::make_address("172.1.1.100"); + beast::IP::Address const addr = boost::asio::ip::make_address("172.1.1.100"); jtx::Env serverEnv(*this); serverEnv.app().config().LEDGER_REPLAY = server; auto http_resp = xrpl::makeResponse( @@ -1081,7 +1128,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite NetworkOfTwo net(*this, {totalReplay + 1}, psBhvr, ilBhvr, peerFeature); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; for (int i = 0; i < totalReplay; ++i) { BEAST_EXPECT(l); @@ -1098,7 +1145,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); - std::vector deltaStatuses(totalReplay - 1, TaskStatus::Completed); + std::vector const deltaStatuses(totalReplay - 1, TaskStatus::Completed); BEAST_EXPECT(net.client.waitAndCheckStatus( finalHash, totalReplay, TaskStatus::Completed, TaskStatus::Completed, deltaStatuses)); @@ -1119,10 +1166,10 @@ struct LedgerReplayer_test : public beast::unit_test::suite PeerFeature::None); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); - std::vector deltaStatuses(totalReplay - 1, TaskStatus::Completed); + std::vector const deltaStatuses(totalReplay - 1, TaskStatus::Completed); BEAST_EXPECT(net.client.waitAndCheckStatus( finalHash, totalReplay, TaskStatus::Completed, TaskStatus::Completed, deltaStatuses)); @@ -1176,7 +1223,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite // feed client with start ledger since InboundLedgers drops all auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; for (int i = 0; i < totalReplay - 1; ++i) { l = net.server.ledgerMaster.getLedgerByHash(l->header().parentHash); @@ -1185,7 +1232,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); - std::vector deltaStatuses(totalReplay - 1, TaskStatus::Completed); + std::vector const deltaStatuses(totalReplay - 1, TaskStatus::Completed); BEAST_EXPECT(net.client.waitAndCheckStatus( finalHash, totalReplay, TaskStatus::Completed, TaskStatus::Completed, deltaStatuses)); BEAST_EXPECT(net.client.waitForLedgers(finalHash, totalReplay)); @@ -1199,7 +1246,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite testStop() { testcase("stop before timeout"); - int totalReplay = 3; + int const totalReplay = 3; NetworkOfTwo net( *this, {totalReplay + 1}, @@ -1208,10 +1255,10 @@ struct LedgerReplayer_test : public beast::unit_test::suite PeerFeature::LedgerReplayEnabled); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); - std::vector deltaStatuses; + std::vector const deltaStatuses; BEAST_EXPECT(net.client.checkStatus( finalHash, totalReplay, TaskStatus::NotDone, TaskStatus::NotDone, deltaStatuses)); @@ -1224,7 +1271,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite testSkipListBadReply() { testcase("SkipListAcquire bad reply"); - int totalReplay = 3; + int const totalReplay = 3; NetworkOfTwo net( *this, {totalReplay + 1 + 1}, @@ -1233,7 +1280,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite PeerFeature::LedgerReplayEnabled); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); auto skipList = net.client.findSkipListAcquire(finalHash); @@ -1242,7 +1289,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite auto item = make_shamapitem(uint256(12345), Slice(payload, sizeof(payload))); skipList->processData(l->seq(), item); - std::vector deltaStatuses; + std::vector const deltaStatuses; BEAST_EXPECT(net.client.waitAndCheckStatus( finalHash, totalReplay, TaskStatus::Failed, TaskStatus::Failed, deltaStatuses)); @@ -1257,7 +1304,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite testLedgerDeltaBadReply() { testcase("LedgerDeltaAcquire bad reply"); - int totalReplay = 3; + int const totalReplay = 3; NetworkOfTwo net( *this, {totalReplay + 1}, @@ -1266,7 +1313,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite PeerFeature::LedgerReplayEnabled); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; net.client.ledgerMaster.storeLedger(l); net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); @@ -1290,7 +1337,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite testLedgerReplayOverlap() { testcase("Overlap tasks"); - int totalReplay = 5; + int const totalReplay = 5; NetworkOfTwo net( *this, {(totalReplay * 3) + 1}, @@ -1298,7 +1345,7 @@ struct LedgerReplayer_test : public beast::unit_test::suite InboundLedgersBehavior::Good, PeerFeature::LedgerReplayEnabled); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); std::vector deltaStatuses(totalReplay - 1, TaskStatus::Completed); BEAST_EXPECT(net.client.waitAndCheckStatus( @@ -1388,7 +1435,7 @@ struct LedgerReplayerTimeout_test : public beast::unit_test::suite testSkipListTimeout() { testcase("SkipListAcquire timeout"); - int totalReplay = 3; + int const totalReplay = 3; NetworkOfTwo net( *this, {totalReplay + 1}, @@ -1397,10 +1444,10 @@ struct LedgerReplayerTimeout_test : public beast::unit_test::suite PeerFeature::LedgerReplayEnabled); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); - std::vector deltaStatuses; + std::vector const deltaStatuses; BEAST_EXPECT(net.client.waitAndCheckStatus( finalHash, totalReplay, TaskStatus::Failed, TaskStatus::Failed, deltaStatuses)); @@ -1414,7 +1461,7 @@ struct LedgerReplayerTimeout_test : public beast::unit_test::suite testLedgerDeltaTimeout() { testcase("LedgerDeltaAcquire timeout"); - int totalReplay = 3; + int const totalReplay = 3; NetworkOfTwo net( *this, {totalReplay + 1}, @@ -1423,7 +1470,7 @@ struct LedgerReplayerTimeout_test : public beast::unit_test::suite PeerFeature::LedgerReplayEnabled); auto l = net.server.ledgerMaster.getClosedLedger(); - uint256 finalHash = l->header().hash; + uint256 const finalHash = l->header().hash; net.client.ledgerMaster.storeLedger(l); net.client.replayer.replay(InboundLedger::Reason::GENERIC, finalHash, totalReplay); @@ -1452,8 +1499,8 @@ struct LedgerReplayerLong_test : public beast::unit_test::suite run() override { testcase("Acquire 1000 ledgers"); - int totalReplay = 250; - int rounds = 4; + int const totalReplay = 250; + int const rounds = 4; NetworkOfTwo net( *this, {(totalReplay * rounds) + 1}, @@ -1479,7 +1526,7 @@ struct LedgerReplayerLong_test : public beast::unit_test::suite InboundLedger::Reason::GENERIC, finishHashes[i], totalReplay); } - std::vector deltaStatuses(totalReplay - 1, TaskStatus::Completed); + std::vector const deltaStatuses(totalReplay - 1, TaskStatus::Completed); for (int i = 0; i < rounds; ++i) { BEAST_EXPECT(net.client.waitAndCheckStatus( diff --git a/src/test/app/LendingHelpers_test.cpp b/src/test/app/LendingHelpers_test.cpp index 24661c18fb..25fb507d2c 100644 --- a/src/test/app/LendingHelpers_test.cpp +++ b/src/test/app/LendingHelpers_test.cpp @@ -1,17 +1,15 @@ #include // DO NOT REMOVE -#include #include +#include #include -#include -#include -#include -#include +#include +#include +#include #include -#include -#include +#include #include #include @@ -265,7 +263,7 @@ class LendingHelpers_test : public beast::unit_test::suite auto const expectedOverpaymentManagementFee = Number{10}; // 10% of 100 auto const expectedPrincipalPortion = Number{400}; // 1,000 - 100 - 500 - auto const components = detail::computeOverpaymentComponents( + auto const components = xrpl::detail::computeOverpaymentComponents( IOU, loanScale, overpayment, @@ -593,7 +591,7 @@ class LendingHelpers_test : public beast::unit_test::suite using namespace jtx; using namespace xrpl::detail; - Env env{*this}; + Env const env{*this}; Account const issuer{"issuer"}; PrettyAsset const asset = issuer["USD"]; std::int32_t const loanScale = -5; @@ -680,7 +678,7 @@ class LendingHelpers_test : public beast::unit_test::suite using namespace jtx; using namespace xrpl::detail; - Env env{*this}; + Env const env{*this}; Account const issuer{"issuer"}; PrettyAsset const asset = issuer["USD"]; std::int32_t const loanScale = -5; @@ -773,7 +771,7 @@ class LendingHelpers_test : public beast::unit_test::suite using namespace jtx; using namespace xrpl::detail; - Env env{*this}; + Env const env{*this}; Account const issuer{"issuer"}; PrettyAsset const asset = issuer["USD"]; std::int32_t const loanScale = -5; @@ -872,7 +870,7 @@ class LendingHelpers_test : public beast::unit_test::suite using namespace jtx; using namespace xrpl::detail; - Env env{*this}; + Env const env{*this}; Account const issuer{"issuer"}; PrettyAsset const asset = issuer["USD"]; std::int32_t const loanScale = -5; @@ -979,7 +977,7 @@ class LendingHelpers_test : public beast::unit_test::suite using namespace jtx; using namespace xrpl::detail; - Env env{*this}; + Env const env{*this}; Account const issuer{"issuer"}; PrettyAsset const asset = issuer["USD"]; std::int32_t const loanScale = -5; @@ -1086,7 +1084,7 @@ class LendingHelpers_test : public beast::unit_test::suite using namespace jtx; using namespace xrpl::detail; - Env env{*this}; + Env const env{*this}; Account const issuer{"issuer"}; PrettyAsset const asset = issuer["USD"]; std::int32_t const loanScale = -5; diff --git a/src/test/app/LoadFeeTrack_test.cpp b/src/test/app/LoadFeeTrack_test.cpp index fed76288ef..f6d05bf0e6 100644 --- a/src/test/app/LoadFeeTrack_test.cpp +++ b/src/test/app/LoadFeeTrack_test.cpp @@ -1,7 +1,7 @@ #include -#include -#include +#include +#include #include namespace xrpl { @@ -13,7 +13,7 @@ public: run() override { Config d; // get a default configuration object - LoadFeeTrack l; + LoadFeeTrack const l; { Fees const fees = [&]() { Fees f; diff --git a/src/test/app/LoanBroker_test.cpp b/src/test/app/LoanBroker_test.cpp index 361f70209f..8efdd9872f 100644 --- a/src/test/app/LoanBroker_test.cpp +++ b/src/test/app/LoanBroker_test.cpp @@ -1,8 +1,62 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -31,7 +85,7 @@ class LoanBroker_test : public beast::unit_test::suite // Try to create a vault PrettyAsset const asset{xrpIssue(), 1'000'000}; - Vault vault{env}; + Vault const vault{env}; auto const [tx, keylet] = vault.create({.owner = alice, .asset = asset}); env(tx, ter(goodVault ? ter(tesSUCCESS) : ter(temDISABLED))); env.close(); @@ -493,14 +547,14 @@ class LoanBroker_test : public beast::unit_test::suite // MPT. That'll require three corresponding SAVs. Env env(*this, all); - Account issuer{"issuer"}; + Account const issuer{"issuer"}; // For simplicity, alice will be the sole actor for the vault & brokers. - Account alice{"alice"}; + Account const alice{"alice"}; // Evan will attempt to be naughty - Account evan{"evan"}; + Account const evan{"evan"}; // Bystander doesn't have anything to do with the SAV or Broker, or any // of the relevant tokens - Account bystander{"bystander"}; + Account const bystander{"bystander"}; Vault vault{env}; // Fund the accounts and trust lines with the same amount so that tests @@ -807,7 +861,7 @@ class LoanBroker_test : public beast::unit_test::suite Account const issuer{"issuer"}; Account const alice{"alice"}; Env env(*this); - Vault vault{env}; + Vault const vault{env}; env.fund(XRP(100'000), issuer, alice); env.close(); @@ -1070,7 +1124,7 @@ class LoanBroker_test : public beast::unit_test::suite env(jtx, ter(temINVALID)); // holder == beast::zero - STAmount bad(Issue{USD.currency, beast::zero}, 100); + STAmount const bad(Issue{USD.currency, beast::zero}, 100); jtx.jv[sfAmount] = bad.getJson(); jtx.stx = env.ust(jtx); Serializer s; @@ -1091,7 +1145,7 @@ class LoanBroker_test : public beast::unit_test::suite // MPTCanClawback is not set testLoanBroker( [&](Env& env, Account const& issuer, Account const& alice) -> MPT { - MPTTester mpt({.env = env, .issuer = issuer, .holders = {alice}}); + MPTTester const mpt({.env = env, .issuer = issuer, .holders = {alice}}); return mpt; }, CoverClawback); @@ -1171,7 +1225,7 @@ class LoanBroker_test : public beast::unit_test::suite // Create a Vault owned by alice with an XRP asset PrettyAsset const asset{xrpIssue(), 1}; - Vault vault{env}; + Vault const vault{env}; auto const [createTx, vaultKeylet] = vault.create({.owner = alice, .asset = asset}); env(createTx); env.close(); @@ -1193,7 +1247,7 @@ class LoanBroker_test : public beast::unit_test::suite // vault SLE OpenView ov{*env.current()}; test::StreamSink sink{beast::severities::kWarning}; - beast::Journal jlog{sink}; + beast::Journal const jlog{sink}; ApplyContext ac{env.app(), ov, tx, tesSUCCESS, env.current()->fees().base, tapNONE, jlog}; if (auto sleBroker = ac.view().peek(keylet::loanbroker(brokerKeylet.key))) @@ -1207,7 +1261,7 @@ class LoanBroker_test : public beast::unit_test::suite // Invoke preclaim against the mutated (ApplyView) view; triggers // nullptr deref - PreclaimContext pctx{env.app(), ac.view(), tesSUCCESS, tx, tapNONE, jlog}; + PreclaimContext const pctx{env.app(), ac.view(), tesSUCCESS, tx, tapNONE, jlog}; (void)LoanBrokerCoverDeposit::preclaim(pctx); } @@ -1290,7 +1344,7 @@ class LoanBroker_test : public beast::unit_test::suite auto const broker = env.le(brokerKeylet); if (!BEAST_EXPECT(broker)) return; - Account brokerPseudo("pseudo", broker->at(sfAccount)); + Account const brokerPseudo("pseudo", broker->at(sfAccount)); // Can't unauthorize LoanBroker pseudo-account asset.authorize( @@ -1326,7 +1380,7 @@ class LoanBroker_test : public beast::unit_test::suite Account const issuer{"issuer"}; Account const alice{"alice"}; Env env(*this); - Vault vault{env}; + Vault const vault{env}; env.fund(XRP(100'000), issuer, alice); env.close(); @@ -1348,7 +1402,7 @@ class LoanBroker_test : public beast::unit_test::suite env(tx); env.close(); auto const le = env.le(vaultKeylet); - VaultInfo vaultInfo = [&]() { + VaultInfo const vaultInfo = [&]() { if (BEAST_EXPECT(le)) return VaultInfo{asset, vaultKeylet.key, le->at(sfAccount)}; return VaultInfo{asset, {}, {}}; @@ -1438,7 +1492,7 @@ class LoanBroker_test : public beast::unit_test::suite auto const [token, deposit, err] = getToken(env); - Vault vault(env); + Vault const vault(env); auto const [tx, keylet] = vault.create({.owner = broker, .asset = token.asset()}); env(tx); env.close(); @@ -1466,7 +1520,7 @@ class LoanBroker_test : public beast::unit_test::suite std::optional, // max amount std::uint64_t, // deposit amount TER>> // expected error - mptTests = { + const mptTests = { // issuer can issue up to 2'000 tokens {2'000, 4'000, 1'000, tesSUCCESS}, // issuer can issue 500 tokens (250 VaultDeposit + @@ -1509,7 +1563,7 @@ class LoanBroker_test : public beast::unit_test::suite env.fund(XRP(20'000), issuer, lender, borrower); auto const IOU = issuer["IOU"]; - Vault vault{env}; + Vault const vault{env}; auto [tx, vaultKeylet] = vault.create({.owner = lender, .asset = IOU.asset()}); env(tx); env.close(); @@ -1527,9 +1581,9 @@ class LoanBroker_test : public beast::unit_test::suite testRIPD4274IOU() { using namespace jtx; - Account issuer("broker"); - Account broker("issuer"); - Account dest("destination"); + Account const issuer("broker"); + Account const broker("issuer"); + Account const dest("destination"); auto const token = issuer["IOU"]; enum TrustState { @@ -1597,7 +1651,7 @@ class LoanBroker_test : public beast::unit_test::suite env(pay(issuer, broker, token(2'000))); env.close(); - Vault vault(env); + Vault const vault(env); auto const [tx, keylet] = vault.create({.owner = broker, .asset = token.asset()}); env(tx); env.close(); @@ -1654,9 +1708,9 @@ class LoanBroker_test : public beast::unit_test::suite testRIPD4274MPT() { using namespace jtx; - Account issuer("broker"); - Account broker("issuer"); - Account dest("destination"); + Account const issuer("broker"); + Account const broker("issuer"); + Account const dest("destination"); enum MPTState { RequireAuth, @@ -1718,7 +1772,7 @@ class LoanBroker_test : public beast::unit_test::suite auto const& token = *maybeToken; - Vault vault(env); + Vault const vault(env); auto const [tx, keylet] = vault.create({.owner = broker, .asset = token.asset()}); env(tx); env.close(); diff --git a/src/test/app/Loan_test.cpp b/src/test/app/Loan_test.cpp index 4cdc62853c..14b0ca7227 100644 --- a/src/test/app/Loan_test.cpp +++ b/src/test/app/Loan_test.cpp @@ -1,16 +1,84 @@ #include // -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -87,7 +155,7 @@ protected: Number maxCoveredLoanValue(Number const& currentDebt) const { - NumberRoundModeGuard mg(Number::downward); + NumberRoundModeGuard const mg(Number::downward); auto debtLimit = coverDeposit * tenthBipsPerUnity.value() / coverRateMin.value(); return debtLimit - currentDebt; @@ -429,7 +497,7 @@ protected: { using namespace jtx; - Vault vault{env}; + Vault const vault{env}; auto const deposit = asset(params.vaultDeposit); auto const debtMaximumValue = asset(params.debtMax).value(); @@ -520,7 +588,7 @@ protected: : std::max(broker.vaultScale(env), state.principalOutstanding.exponent()))); BEAST_EXPECT(state.paymentInterval == 600); { - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); BEAST_EXPECT( state.totalValue == roundToAsset( @@ -886,7 +954,7 @@ protected: auto const borrowerInitialBalance = env.balance(borrower, broker.asset).number(); auto const initialState = state; - detail::PaymentComponents totalPaid{ + xrpl::detail::PaymentComponents totalPaid{ .trackedValueDelta = 0, .trackedPrincipalDelta = 0, .trackedManagementFeeDelta = 0}; Number totalInterestPaid = 0; Number totalFeesPaid = 0; @@ -921,7 +989,7 @@ protected: { validateBorrowerBalance(); // Compute the expected principal amount - auto const paymentComponents = detail::computePaymentComponents( + auto const paymentComponents = xrpl::detail::computePaymentComponents( broker.asset.raw(), state.loanScale, state.totalValue, @@ -934,7 +1002,7 @@ protected: BEAST_EXPECT( paymentComponents.trackedValueDelta <= roundedPeriodicPayment || - (paymentComponents.specialCase == detail::PaymentSpecialCase::final && + (paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final && paymentComponents.trackedValueDelta >= roundedPeriodicPayment)); BEAST_EXPECT( paymentComponents.trackedValueDelta == @@ -946,11 +1014,11 @@ protected: periodicRate, state.paymentRemaining - 1, broker.params.managementFeeRate); - detail::LoanStateDeltas const deltas = currentTrueState - nextTrueState; + xrpl::detail::LoanStateDeltas const deltas = currentTrueState - nextTrueState; BEAST_EXPECT( deltas.total() == deltas.principal + deltas.interest + deltas.managementFee); BEAST_EXPECT( - paymentComponents.specialCase == detail::PaymentSpecialCase::final || + paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final || deltas.total() == state.periodicPayment || (state.loanScale - (deltas.total() - state.periodicPayment).exponent()) > 14); @@ -963,9 +1031,9 @@ protected: << paymentComponents.trackedPrincipalDelta << ", " << paymentComponents.trackedInterestPart() << ", " << paymentComponents.trackedManagementFeeDelta << ", " << [&]() -> char const* { - if (paymentComponents.specialCase == detail::PaymentSpecialCase::final) + if (paymentComponents.specialCase == ::xrpl::detail::PaymentSpecialCase::final) return "final"; - if (paymentComponents.specialCase == detail::PaymentSpecialCase::extra) + if (paymentComponents.specialCase == ::xrpl::detail::PaymentSpecialCase::extra) return "extra"; return "none"; }() << std::endl; @@ -984,7 +1052,7 @@ protected: // IOUs, the difference should be dust. Number const diff = totalDue - totalDueAmount; BEAST_EXPECT( - paymentComponents.specialCase == detail::PaymentSpecialCase::final || + paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final || diff == beast::zero || (diff > beast::zero && ((broker.asset.integral() && (static_cast(diff) < 3)) || @@ -994,7 +1062,7 @@ protected: paymentComponents.trackedPrincipalDelta >= beast::zero && paymentComponents.trackedPrincipalDelta <= state.principalOutstanding); BEAST_EXPECT( - paymentComponents.specialCase != detail::PaymentSpecialCase::final || + paymentComponents.specialCase != xrpl::detail::PaymentSpecialCase::final || paymentComponents.trackedPrincipalDelta == state.principalOutstanding); } @@ -1054,7 +1122,7 @@ protected: --state.paymentRemaining; state.previousPaymentDate = state.nextPaymentDate; - if (paymentComponents.specialCase == detail::PaymentSpecialCase::final) + if (paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final) { state.paymentRemaining = 0; state.nextPaymentDate = 0; @@ -1149,7 +1217,7 @@ protected: auto loanKeylet = std::get(*loanResult); auto pseudoAcct = std::get(*loanResult); - VerifyLoanStatus verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); + VerifyLoanStatus const verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); makeLoanPayments( env, @@ -1822,7 +1890,7 @@ protected: std::function, TER> { // Freeze / lock the asset - std::function empty; + std::function const empty; if (broker.asset.native()) { // XRP can't be frozen @@ -1943,7 +2011,7 @@ protected: ? 0 : std::max( broker.vaultScale(env), state.principalOutstanding.exponent()))); - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); auto const defaultAmount = roundToAsset( broker.asset, std::min( @@ -2071,7 +2139,19 @@ protected: STAmount{broker.asset, state.periodicPayment * Number{15, -1}}, tfLoanOverpayment), fee(XRPAmount{baseFee * (Number{15, -1} / loanPaymentsPerFeeIncrement + 1)}), - ter(temINVALID_FLAG)); + ter(tecNO_PERMISSION)); + + { + env.disableFeature(fixSecurity3_1_3); + env(pay(borrower, + loanKeylet.key, + STAmount{broker.asset, state.periodicPayment * Number{15, -1}}, + tfLoanOverpayment), + fee(XRPAmount{ + baseFee * (Number{15, -1} / loanPaymentsPerFeeIncrement + 1)}), + ter(temINVALID_FLAG)); + env.enableFeature(fixSecurity3_1_3); + } } // Try to send a payment marked as multiple mutually exclusive // payment types. Do not include `txFlags`, so we don't duplicate @@ -2235,7 +2315,7 @@ protected: // service fee is 2 auto const startingPayments = state.paymentRemaining; STAmount const payoffAmount = [&]() { - NumberRoundModeGuard mg(Number::upward); + NumberRoundModeGuard const mg(Number::upward); auto const rawPayoff = startingPayments * (state.periodicPayment + broker.asset(2).value()); STAmount payoffAmount{broker.asset, rawPayoff}; @@ -2484,7 +2564,7 @@ protected: Number::upward)); auto const initialState = state; - detail::PaymentComponents totalPaid{ + xrpl::detail::PaymentComponents totalPaid{ .trackedValueDelta = 0, .trackedPrincipalDelta = 0, .trackedManagementFeeDelta = 0}; @@ -2500,7 +2580,7 @@ protected: while (state.paymentRemaining > 0) { // Compute the expected principal amount - auto const paymentComponents = detail::computePaymentComponents( + auto const paymentComponents = xrpl::detail::computePaymentComponents( broker.asset.raw(), state.loanScale, state.totalValue, @@ -2512,7 +2592,7 @@ protected: broker.params.managementFeeRate); BEAST_EXPECTS( - paymentComponents.specialCase == detail::PaymentSpecialCase::final || + paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final || paymentComponents.trackedValueDelta <= roundedPeriodicPayment, "Delta: " + to_string(paymentComponents.trackedValueDelta) + ", periodic payment: " + to_string(roundedPeriodicPayment)); @@ -2522,7 +2602,7 @@ protected: periodicRate, state.paymentRemaining - 1, broker.params.managementFeeRate); - detail::LoanStateDeltas const deltas = currentTrueState - nextTrueState; + xrpl::detail::LoanStateDeltas const deltas = currentTrueState - nextTrueState; testcase << currencyLabel << " Payment components: " << state.paymentRemaining << ", " << deltas.interest << ", " << deltas.principal << ", " @@ -2531,9 +2611,11 @@ protected: << paymentComponents.trackedInterestPart() << ", " << paymentComponents.trackedManagementFeeDelta << ", " << [&]() -> char const* { - if (paymentComponents.specialCase == detail::PaymentSpecialCase::final) + if (paymentComponents.specialCase == + ::xrpl::detail::PaymentSpecialCase::final) return "final"; - if (paymentComponents.specialCase == detail::PaymentSpecialCase::extra) + if (paymentComponents.specialCase == + ::xrpl::detail::PaymentSpecialCase::extra) return "extra"; return "none"; }(); @@ -2549,7 +2631,7 @@ protected: // IOUs, the difference should be after the 8th digit. Number const diff = totalDue - totalDueAmount; BEAST_EXPECT( - paymentComponents.specialCase == detail::PaymentSpecialCase::final || + paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final || diff == beast::zero || (diff > beast::zero && ((broker.asset.integral() && (static_cast(diff) < 3)) || @@ -2561,7 +2643,7 @@ protected: paymentComponents.trackedInterestPart() + paymentComponents.trackedManagementFeeDelta); BEAST_EXPECT( - paymentComponents.specialCase == detail::PaymentSpecialCase::final || + paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final || paymentComponents.trackedValueDelta <= roundedPeriodicPayment); BEAST_EXPECT( @@ -2576,10 +2658,10 @@ protected: paymentComponents.trackedPrincipalDelta >= beast::zero && paymentComponents.trackedPrincipalDelta <= state.principalOutstanding); BEAST_EXPECT( - paymentComponents.specialCase != detail::PaymentSpecialCase::final || + paymentComponents.specialCase != xrpl::detail::PaymentSpecialCase::final || paymentComponents.trackedPrincipalDelta == state.principalOutstanding); BEAST_EXPECT( - paymentComponents.specialCase == detail::PaymentSpecialCase::final || + paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final || (state.periodicPayment.exponent() - (deltas.principal + deltas.interest + deltas.managementFee - state.periodicPayment) @@ -2617,7 +2699,7 @@ protected: --state.paymentRemaining; state.previousPaymentDate = state.nextPaymentDate; - if (paymentComponents.specialCase == detail::PaymentSpecialCase::final) + if (paymentComponents.specialCase == xrpl::detail::PaymentSpecialCase::final) { state.paymentRemaining = 0; state.nextPaymentDate = 0; @@ -2835,7 +2917,7 @@ protected: {.flags = tfMPTCanTransfer | tfMPTCanLock | (args.requireAuth ? tfMPTRequireAuth : none)}); env.close(); - PrettyAsset mptAsset = mptt.issuanceID(); + PrettyAsset const mptAsset = mptt.issuanceID(); mptt.authorize({.account = lender}); mptt.authorize({.account = borrower}); env.close(); @@ -2962,7 +3044,7 @@ protected: CaseArgs{.requireAuth = true}); auto const [acctReserve, incReserve] = [this]() -> std::pair { - Env env{*this, testable_amendments()}; + Env const env{*this, testable_amendments()}; return { env.current()->fees().accountReserve(0).drops() / DROPS_PER_XRP.drops(), env.current()->fees().increment.drops() / DROPS_PER_XRP.drops()}; @@ -3247,7 +3329,7 @@ protected: jtx::Account const alice{"alice"}; jtx::Account const bella{"bella"}; auto const msigSetup = [&](Env& env, Account const& account) { - Json::Value tx1 = signers(account, 2, {{alice, 1}, {bella, 1}}); + Json::Value const tx1 = signers(account, 2, {{alice, 1}, {bella, 1}}); env(tx1); env.close(); }; @@ -3314,7 +3396,7 @@ protected: [&, this](Env& env, BrokerInfo const& broker, auto&) { using namespace loan; Number const principalRequest = broker.asset(1'000).value(); - Vault vault{env}; + Vault const vault{env}; auto tx = vault.set({.owner = lender, .id = broker.vaultID}); tx[sfAssetsMaximum] = BrokerParameters::defaults().vaultDeposit; env(tx); @@ -3334,7 +3416,7 @@ protected: [&, this](Env& env, BrokerInfo const& broker, auto&) { using namespace loan; Number const principalRequest = broker.asset(1'000).value(); - Vault vault{env}; + Vault const vault{env}; auto tx = vault.set({.owner = lender, .id = broker.vaultID}); tx[sfAssetsMaximum] = BrokerParameters::defaults().vaultDeposit + broker.asset(1).number(); @@ -3601,13 +3683,13 @@ protected: Account const lender{"lender"}; Account const borrower{"borrower"}; - BrokerParameters brokerParams; + BrokerParameters const brokerParams; env.fund(XRP(brokerParams.vaultDeposit * 100), lender, borrower); env.close(); PrettyAsset const xrpAsset{xrpIssue(), 1'000'000}; - BrokerInfo broker{createVaultAndBroker(env, xrpAsset, lender, brokerParams)}; + BrokerInfo const broker{createVaultAndBroker(env, xrpAsset, lender, brokerParams)}; using namespace loan; @@ -3664,13 +3746,13 @@ protected: Account const issuer{"issuer"}; Account const lender{"lender"}; - BrokerParameters brokerParams{.debtMax = 0}; + BrokerParameters const brokerParams{.debtMax = 0}; env.fund(XRP(brokerParams.vaultDeposit * 100), issuer, noripple(lender)); env.close(); PrettyAsset const xrpAsset{xrpIssue(), 1'000'000}; - BrokerInfo broker{createVaultAndBroker(env, xrpAsset, lender, brokerParams)}; + BrokerInfo const broker{createVaultAndBroker(env, xrpAsset, lender, brokerParams)}; if (auto const brokerSle = env.le(keylet::loanbroker(broker.brokerID)); BEAST_EXPECT(brokerSle)) @@ -3712,12 +3794,12 @@ protected: Account const lender{"lender"}; Account const borrower{"borrower"}; - BrokerParameters brokerParams; + BrokerParameters const brokerParams; env.fund(XRP(brokerParams.vaultDeposit * 100), issuer, lender, borrower); env.close(); PrettyAsset const xrpAsset{xrpIssue(), 1'000'000}; - BrokerInfo broker{createVaultAndBroker(env, xrpAsset, lender, brokerParams)}; + BrokerInfo const broker{createVaultAndBroker(env, xrpAsset, lender, brokerParams)}; using namespace loan; @@ -3786,9 +3868,9 @@ protected: Account const alice{"alice"}; std::string const borrowerPass = "borrower"; - Account borrower{borrowerPass, KeyType::ed25519}; + Account const borrower{borrowerPass, KeyType::ed25519}; auto const lenderPass = "lender"; - Account lender{lenderPass, KeyType::ed25519}; + Account const lender{lenderPass, KeyType::ed25519}; env.fund(XRP(1'000'000), alice, lender, borrower); env.close(); @@ -4169,7 +4251,8 @@ protected: env.fund(XRP(1'000), issuer, lender); std::int64_t constexpr issuerBalance = 10'000'000; - MPTTester asset({.env = env, .issuer = issuer, .holders = {lender}, .pay = issuerBalance}); + MPTTester const asset( + {.env = env, .issuer = issuer, .holders = {lender}, .pay = issuerBalance}); BrokerParameters const brokerParams{ .debtMax = 200, @@ -4319,7 +4402,7 @@ protected: env.fund(XRP(1'000), lender, issuer, borrower); env(trust(lender, IOU(10'000'000))); env(pay(issuer, lender, IOU(5'000'000))); - BrokerInfo brokerInfo{createVaultAndBroker(env, issuer["IOU"], lender)}; + BrokerInfo const brokerInfo{createVaultAndBroker(env, issuer["IOU"], lender)}; auto const loanSetFee = fee(env.current()->fees().base * 2); Number const debtMaximumRequest = brokerInfo.asset(1'000).value(); @@ -4381,7 +4464,7 @@ protected: // can it happen? the signature is checked before transactor // executes - JTx tx = env.jt( + JTx const tx = env.jt( set(borrower, brokerInfo.brokerID, debtMaximumRequest), sig(sfCounterpartySignature, lender), loanSetFee); @@ -4470,7 +4553,7 @@ protected: env(pay(issuer, borrower, mptAsset(1'000))); env.close(); - BrokerInfo broker{createVaultAndBroker(env, mptAsset, lender)}; + BrokerInfo const broker{createVaultAndBroker(env, mptAsset, lender)}; using namespace loan; @@ -4573,7 +4656,7 @@ protected: return Account("Broker pseudo-account", brokerPseudo); }(); - VerifyLoanStatus verifyLoanStatus(env, broker, pseudoAcct, keylet); + VerifyLoanStatus const verifyLoanStatus(env, broker, pseudoAcct, keylet); auto const originalState = getCurrentState(env, broker, keylet); verifyLoanStatus(originalState); @@ -4624,7 +4707,7 @@ protected: env(payIssuerTx); env.close(); - BrokerInfo broker{createVaultAndBroker(env, iouAsset, lender)}; + BrokerInfo const broker{createVaultAndBroker(env, iouAsset, lender)}; using namespace loan; @@ -4686,7 +4769,7 @@ protected: env(pay(issuer, borrower, iouAsset(1'000))); env.close(); - BrokerInfo broker{createVaultAndBroker(env, iouAsset, lender)}; + BrokerInfo const broker{createVaultAndBroker(env, iouAsset, lender)}; using namespace loan; @@ -4768,7 +4851,7 @@ protected: env(payIssuerTx); env.close(); - BrokerInfo broker{createVaultAndBroker(env, iouAsset, lender)}; + BrokerInfo const broker{createVaultAndBroker(env, iouAsset, lender)}; using namespace loan; @@ -4867,7 +4950,7 @@ protected: env(payIssuerTx); env.close(); - BrokerInfo broker{createVaultAndBroker(env, iouAsset, lender)}; + BrokerInfo const broker{createVaultAndBroker(env, iouAsset, lender)}; { auto const coverDepositValue = broker.asset(broker.params.coverDeposit * 10).value(); env(loanBroker::coverDeposit(lender, broker.brokerID, coverDepositValue)); @@ -5155,7 +5238,7 @@ protected: // pay all but the last payment { - NumberRoundModeGuard mg{Number::upward}; + NumberRoundModeGuard const mg{Number::upward}; Number const payment = beforeState.periodicPayment * (total - 1); XRPAmount const payFee{baseFee * ((total - 1) / loanPaymentsPerFeeIncrement + 1)}; STAmount const paymentAmount = @@ -5231,13 +5314,13 @@ protected: } void - testCoverDepositWithdrawNonTransferableMPT() + testCoverDepositWithdrawNonTransferableMPT(FeatureBitset feature) { testcase("CoverDeposit and CoverWithdraw reject MPT without CanTransfer"); using namespace jtx; using namespace loanBroker; - Env env(*this, all); + Env env(*this, feature); Account const issuer{"issuer"}; Account const alice{"alice"}; @@ -5259,7 +5342,7 @@ protected: env(pay(issuer, alice, asset(100))); env.close(); - Vault vault{env}; + Vault const vault{env}; auto const [createTx, vaultKeylet] = vault.create({.owner = alice, .asset = asset}); env(createTx); env.close(); @@ -5279,7 +5362,8 @@ protected: env.close(); // Standard Payment path should forbid third-party transfers. - env(pay(alice, pseudoAccount, asset(1)), ter(tecNO_AUTH)); + auto const err = feature[featureMPTokensV2] ? tecNO_PERMISSION : tecNO_AUTH; + env(pay(alice, pseudoAccount, asset(1)), ter(err)); env.close(); // Cover cannot be transferred to broker account @@ -5595,7 +5679,7 @@ protected: env.close(); PrettyAsset const asset{xrpIssue(), 1'000'000}; - BrokerParameters brokerParams{}; + BrokerParameters const brokerParams{}; auto const broker = createVaultAndBroker(env, asset, lender, brokerParams); // Create a 3-payment loan so full-payment path is enabled after 1 @@ -5643,7 +5727,7 @@ protected: // Compute a regular periodic due and pay it early (before next due). auto state = getCurrentState(env, broker, loanKeylet); Number const periodicRate = loanPeriodicRate(state.interestRate, state.paymentInterval); - auto const components = detail::computePaymentComponents( + auto const components = xrpl::detail::computePaymentComponents( asset.raw(), state.loanScale, state.totalValue, @@ -5676,7 +5760,7 @@ protected: // Accrued + prepayment-penalty interest based on current periodic // schedule auto const fullPaymentInterest = computeFullPaymentInterest( - detail::loanPrincipalFromPeriodicPayment( + xrpl::detail::loanPrincipalFromPeriodicPayment( after.periodicPayment, periodicRate2, after.paymentRemaining), periodicRate2, env.current()->parentCloseTime(), @@ -5709,7 +5793,7 @@ protected: // window by clamping prevPaymentDate to 'now' for the full-pay path. auto const prevClamped = std::min(after.previousPaymentDate, nowSecs); auto const fullPaymentInterestClamped = computeFullPaymentInterest( - detail::loanPrincipalFromPeriodicPayment( + xrpl::detail::loanPrincipalFromPeriodicPayment( after.periodicPayment, periodicRate2, after.paymentRemaining), periodicRate2, env.current()->parentCloseTime(), @@ -5792,10 +5876,10 @@ protected: Env env(*this, all); // Setup: Create accounts - Account issuer{"issuer"}; - Account lender{"lender"}; - Account borrower{"borrower"}; - Account victim{"victim"}; + Account const issuer{"issuer"}; + Account const lender{"lender"}; + Account const borrower{"borrower"}; + Account const victim{"victim"}; env.fund(XRP(1'000'000'00), issuer, lender, borrower, victim); env.close(); @@ -5810,7 +5894,7 @@ protected: env(pay(issuer, victim, asset(50000))); env.close(); - BrokerParameters brokerParams{ + BrokerParameters const brokerParams{ .vaultDeposit = 10000, .debtMax = Number{0}, .coverRateMin = TenthBips32{1000}, @@ -5838,8 +5922,8 @@ protected: { auto const vaultSle = env.le(vaultKeylet); - Number assetsTotal = vaultSle->at(sfAssetsTotal); - Number assetsAvail = vaultSle->at(sfAssetsAvailable); + Number const assetsTotal = vaultSle->at(sfAssetsTotal); + Number const assetsAvail = vaultSle->at(sfAssetsAvailable); log << "Before loan creation:" << std::endl; log << " AssetsTotal: " << assetsTotal << std::endl; @@ -5871,8 +5955,8 @@ protected: { auto const vaultSle = env.le(vaultKeylet); - Number assetsTotal = vaultSle->at(sfAssetsTotal); - Number assetsAvail = vaultSle->at(sfAssetsAvailable); + Number const assetsTotal = vaultSle->at(sfAssetsTotal); + Number const assetsAvail = vaultSle->at(sfAssetsAvailable); log << "After loan creation:" << std::endl; log << " AssetsTotal: " << assetsTotal << std::endl; @@ -5909,8 +5993,8 @@ protected: // Step 8: Verify phantom assets created { auto const vaultSle2 = env.le(vaultKeylet); - Number assetsTotal2 = vaultSle2->at(sfAssetsTotal); - Number assetsAvail2 = vaultSle2->at(sfAssetsAvailable); + Number const assetsTotal2 = vaultSle2->at(sfAssetsTotal); + Number const assetsAvail2 = vaultSle2->at(sfAssetsAvailable); log << "After default:" << std::endl; log << " AssetsTotal: " << assetsTotal2 << std::endl; @@ -6033,7 +6117,7 @@ protected: auto loanKeylet = std::get(*loanResult); auto pseudoAcct = std::get(*loanResult); - VerifyLoanStatus verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); + VerifyLoanStatus const verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); if (auto const brokerSle = env.le(broker.brokerKeylet()); BEAST_EXPECT(brokerSle)) { @@ -6077,7 +6161,7 @@ protected: auto const txfee = fee(XRP(100)); Env env(*this); - Vault vault(env); + Vault const vault(env); env.fund(XRP(10'000), lender, issuer, borrower, depositor); env.close(); @@ -6137,7 +6221,7 @@ protected: env.close(); // Vault with XRP asset - Vault vault{env}; + Vault const vault{env}; auto [vaultCreate, vaultKeylet] = vault.create({.owner = lender, .asset = xrpIssue()}); env(vaultCreate); env.close(); @@ -6239,7 +6323,7 @@ protected: auto loanKeylet = std::get(*loanResult); auto pseudoAcct = std::get(*loanResult); - VerifyLoanStatus verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); + VerifyLoanStatus const verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); makeLoanPayments( env, @@ -6266,7 +6350,7 @@ protected: auto testLoanAsset = [&](auto&& getMaxDebt, auto const& borrower) { Env env(*this); - Vault vault(env); + Vault const vault(env); if (borrower == broker) { @@ -6359,7 +6443,7 @@ protected: borrowerAcct); testLoanAsset( [&](Env& env) -> STAmount { - MPTTester mpt( + MPTTester const mpt( {.env = env, .issuer = issuer, .holders = {broker, depositor}, @@ -6403,7 +6487,7 @@ protected: auto loanKeylet = std::get(*loanResult); auto pseudoAcct = std::get(*loanResult); - VerifyLoanStatus verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); + VerifyLoanStatus const verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); makeLoanPayments( env, @@ -6459,7 +6543,7 @@ protected: auto loanKeylet = std::get(*loanResult); auto pseudoAcct = std::get(*loanResult); - VerifyLoanStatus verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); + VerifyLoanStatus const verifyLoanStatus(env, broker, pseudoAcct, loanKeylet); auto const state = getCurrentState(env, broker, loanKeylet); @@ -6470,7 +6554,7 @@ protected: tfLoanOverpayment)); env.close(); - PaymentParameters paymentParams{ + PaymentParameters const paymentParams{ .showStepBalances = false, .validateBalances = true, }; @@ -6993,7 +7077,9 @@ public: #endif testInvalidLoanSet(); - testCoverDepositWithdrawNonTransferableMPT(); + auto const all = jtx::testable_amendments(); + testCoverDepositWithdrawNonTransferableMPT(all); + testCoverDepositWithdrawNonTransferableMPT(all - featureMPTokensV2); testPoC_UnsignedUnderflowOnFullPayAfterEarlyPeriodic(); testDisabled(); @@ -7077,20 +7163,20 @@ protected: Account const borrower("borrower"); // Determine all the random parameters at once - AssetType assetType = static_cast(assetDist(engine_)); + AssetType const assetType = static_cast(assetDist(engine_)); auto const principalRequest = principalDist(engine_); - TenthBips16 managementFeeRate{managementFeeRateDist(engine_)}; + TenthBips16 const managementFeeRate{managementFeeRateDist(engine_)}; auto const serviceFee = serviceFeeDist(engine_); TenthBips32 interest{interestRateDist(engine_)}; auto const payTotal = paymentTotalDist(engine_); auto const payInterval = paymentIntervalDist(engine_); - BrokerParameters brokerParams{ + BrokerParameters const brokerParams{ .vaultDeposit = principalRequest * 10, .debtMax = 0, .coverRateMin = TenthBips32{0}, .managementFeeRate = managementFeeRate}; - LoanParameters loanParams{ + LoanParameters const loanParams{ .account = lender, .counter = borrower, .principalRequest = principalRequest, @@ -7108,7 +7194,7 @@ public: run() override { auto const numIterations = [s = arg()]() -> int { - int defaultNum = 5; + int const defaultNum = 5; if (s.empty()) return defaultNum; try diff --git a/src/test/app/MPToken_test.cpp b/src/test/app/MPToken_test.cpp index 5a90a3a71e..d2af168186 100644 --- a/src/test/app/MPToken_test.cpp +++ b/src/test/app/MPToken_test.cpp @@ -1,16 +1,71 @@ -#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include #include #include +#include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -26,7 +81,7 @@ class MPToken_test : public beast::unit_test::suite // test preflight of MPTokenIssuanceCreate { // If the MPT amendment is not enabled, you should not be able to - // create MPTokenIssuances + // create MPTokenIssuance Env env{*this, features - featureMPTokensV1}; MPTTester mptAlice(env, alice); @@ -816,6 +871,7 @@ class MPToken_test : public beast::unit_test::suite Account const alice("alice"); // issuer Account const bob("bob"); // holder Account const carol("carol"); // holder + auto const MPTokensV2 = features[featureMPTokensV2]; // preflight validation @@ -827,7 +883,7 @@ class MPToken_test : public beast::unit_test::suite env.fund(XRP(1'000), alice); env.fund(XRP(1'000), bob); - STAmount mpt{MPTIssue{makeMptID(1, alice)}, UINT64_C(100)}; + STAmount const mpt{MPTIssue{makeMptID(1, alice)}, UINT64_C(100)}; env(pay(alice, bob, mpt), ter(temDISABLED)); } @@ -841,7 +897,7 @@ class MPToken_test : public beast::unit_test::suite env.fund(XRP(1'000), alice); env.fund(XRP(1'000), carol); - STAmount mpt{MPTIssue{makeMptID(1, alice)}, UINT64_C(100)}; + STAmount const mpt{MPTIssue{makeMptID(1, alice)}, UINT64_C(100)}; Json::Value jv; jv[jss::secret] = alice.name(); @@ -862,8 +918,10 @@ class MPToken_test : public beast::unit_test::suite mptAlice.authorize({.account = bob}); - for (auto flags : {tfNoRippleDirect, tfLimitQuality}) - env(pay(alice, bob, MPT(10)), txflags(flags), ter(temINVALID_FLAG)); + auto err = !features[featureMPTokensV2] ? ter(temINVALID_FLAG) : ter(temRIPPLE_EMPTY); + env(pay(alice, bob, MPT(10)), txflags(tfNoRippleDirect), err); + err = !features[featureMPTokensV2] ? ter(temINVALID_FLAG) : ter(tesSUCCESS); + env(pay(alice, bob, MPT(10)), txflags(tfLimitQuality), err); } // Invalid combination of send, sendMax, deliverMin, paths @@ -874,31 +932,37 @@ class MPToken_test : public beast::unit_test::suite MPTTester mptAlice(env, alice, {.holders = {carol}}); - mptAlice.create({.ownerCount = 1, .holderCount = 0}); + mptAlice.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); mptAlice.authorize({.account = carol}); // sendMax and DeliverMin are valid XRP amount, // but is invalid combination with MPT amount auto const MPT = mptAlice["MPT"]; - env(pay(alice, carol, MPT(100)), sendmax(XRP(100)), ter(temMALFORMED)); + auto err = !MPTokensV2 ? ter(temMALFORMED) : ter(tecPATH_PARTIAL); + env(pay(alice, carol, MPT(100)), sendmax(XRP(100)), err); env(pay(alice, carol, MPT(100)), deliver_min(XRP(100)), ter(temBAD_AMOUNT)); // sendMax MPT is invalid with IOU or XRP auto const USD = alice["USD"]; - env(pay(alice, carol, USD(100)), sendmax(MPT(100)), ter(temMALFORMED)); - env(pay(alice, carol, XRP(100)), sendmax(MPT(100)), ter(temMALFORMED)); + err = !MPTokensV2 ? ter(temMALFORMED) : ter(tecPATH_DRY); + env(pay(alice, carol, USD(100)), sendmax(MPT(100)), err); + err = !MPTokensV2 ? ter(temMALFORMED) : ter(tecPATH_PARTIAL); + env(pay(alice, carol, XRP(100)), sendmax(MPT(100)), err); env(pay(alice, carol, USD(100)), deliver_min(MPT(100)), ter(temBAD_AMOUNT)); env(pay(alice, carol, XRP(100)), deliver_min(MPT(100)), ter(temBAD_AMOUNT)); // sendmax and amount are different MPT issue test::jtx::MPT const MPT1("MPT", makeMptID(env.seq(alice) + 10, alice)); - env(pay(alice, carol, MPT1(100)), sendmax(MPT(100)), ter(temMALFORMED)); - // paths is invalid - env(pay(alice, carol, MPT(100)), path(~USD), ter(temMALFORMED)); + err = !MPTokensV2 ? ter(temMALFORMED) : ter(tecOBJECT_NOT_FOUND); + env(pay(alice, carol, MPT1(100)), sendmax(MPT(100)), err); + // "paths" is invalid in V1 + err = !MPTokensV2 ? ter(temMALFORMED) : ter(tesSUCCESS); + env(pay(alice, carol, MPT(100)), path(~USD), err); } // build_path is invalid if MPT { - Env env{*this, features}; + Env env{*this, features - featureMPTokensV2}; Account const alice("alice"); Account const carol("carol"); @@ -1041,7 +1105,7 @@ class MPToken_test : public beast::unit_test::suite env(credentials::accept(bob, credIssuer1, credType)); env.close(); - MPTTester mptAlice(env, alice); + MPTTester mptAlice(env, alice, MPTInit{}); env.close(); mptAlice.create({ @@ -1083,7 +1147,7 @@ class MPToken_test : public beast::unit_test::suite env(credentials::accept(bob, credIssuer1, credType)); env.close(); - MPTTester mptAlice(env, alice); + MPTTester mptAlice(env, alice, MPTInit{}); env.close(); mptAlice.create({ @@ -1160,7 +1224,7 @@ class MPToken_test : public beast::unit_test::suite env(credentials::accept(carol, credIssuer2, credType)); env.close(); - MPTTester mptAlice(env, alice); + MPTTester mptAlice(env, alice, MPTInit{}); env.close(); mptAlice.create({ @@ -1287,11 +1351,14 @@ class MPToken_test : public beast::unit_test::suite mptAlice.pay(alice, bob, 100); mptAlice.pay(alice, carol, 100); + auto const err = + env.current()->rules().enabled(featureMPTokensV2) ? tecPATH_DRY : tecLOCKED; + // Global lock mptAlice.set({.account = alice, .flags = tfMPTLock}); // Can't send between holders - mptAlice.pay(bob, carol, 1, tecLOCKED); - mptAlice.pay(carol, bob, 2, tecLOCKED); + mptAlice.pay(bob, carol, 1, err); + mptAlice.pay(carol, bob, 2, err); // Issuer can send mptAlice.pay(alice, bob, 3); // Holder can send back to issuer @@ -1302,8 +1369,8 @@ class MPToken_test : public beast::unit_test::suite // Individual lock mptAlice.set({.account = alice, .holder = bob, .flags = tfMPTLock}); // Can't send between holders - mptAlice.pay(bob, carol, 5, tecLOCKED); - mptAlice.pay(carol, bob, 6, tecLOCKED); + mptAlice.pay(bob, carol, 5, err); + mptAlice.pay(carol, bob, 6, err); // Issuer can send mptAlice.pay(alice, bob, 7); // Holder can send back to issuer @@ -1356,10 +1423,13 @@ class MPToken_test : public beast::unit_test::suite // Payment succeeds if partial payment even if // SendMax is less than deliver amount env(pay(bob, carol, MPT(100)), sendmax(MPT(90)), txflags(tfPartialPayment)); - // 82 to carol, 8 to issuer (90 / 1.1 ~ 81.81 (rounded to nearest) = - // 82) + // 82 to carol, 8 to issuer (90 / 1.1 ~ 81.81 (rounded to nearest in + // v1) = 82) BEAST_EXPECT(mptAlice.checkMPTokenAmount(bob, 690)); - BEAST_EXPECT(mptAlice.checkMPTokenAmount(carol, 282)); + // In V2 the payments are executed via the payment engine and + // the rounding results in a higher quality trade + BEAST_EXPECT( + mptAlice.checkMPTokenAmount(carol, !features[featureMPTokensV2] ? 282 : 281)); } // Insufficient SendMax with no transfer fee @@ -1431,7 +1501,8 @@ class MPToken_test : public beast::unit_test::suite mptAlice.pay(alice, bob, 100); // issuer tries to exceed max amount - mptAlice.pay(alice, bob, 1, tecPATH_PARTIAL); + auto const err = MPTokensV2 ? tecPATH_DRY : tecPATH_PARTIAL; + mptAlice.pay(alice, bob, 1, err); } // Issuer fails trying to send more than the default maximum @@ -1449,7 +1520,8 @@ class MPToken_test : public beast::unit_test::suite mptAlice.pay(alice, bob, maxMPTokenAmount); // issuer tries to exceed max amount - mptAlice.pay(alice, bob, 1, tecPATH_PARTIAL); + auto const err = MPTokensV2 ? tecPATH_DRY : tecPATH_PARTIAL; + mptAlice.pay(alice, bob, 1, err); } // Pay more than max amount fails in the json parser before @@ -1457,7 +1529,7 @@ class MPToken_test : public beast::unit_test::suite { Env env{*this, features}; env.fund(XRP(1'000), alice, bob); - STAmount mpt{MPTIssue{makeMptID(1, alice)}, UINT64_C(100)}; + STAmount const mpt{MPTIssue{makeMptID(1, alice)}, UINT64_C(100)}; Json::Value jv; jv[jss::secret] = alice.name(); jv[jss::tx_json] = pay(alice, bob, mpt); @@ -1489,6 +1561,7 @@ class MPToken_test : public beast::unit_test::suite // payment between the holders env(pay(bob, carol, MPT(10'000)), sendmax(MPT(10'000)), txflags(tfPartialPayment)); + // Verify the metadata auto const meta = env.meta()->getJson(JsonOptions::none)[sfAffectedNodes.fieldName]; // Issuer got 10 in the transfer fees @@ -1508,7 +1581,8 @@ class MPToken_test : public beast::unit_test::suite // payment between the holders fails without // partial payment - env(pay(bob, carol, MPT(10'000)), sendmax(MPT(10'000)), ter(tecPATH_PARTIAL)); + auto const err = MPTokensV2 ? tecPATH_DRY : tecPATH_PARTIAL; + env(pay(bob, carol, MPT(10'000)), sendmax(MPT(10'000)), ter(err)); } // Pay maximum allowed amount @@ -1564,7 +1638,9 @@ class MPToken_test : public beast::unit_test::suite env.fund(XRP(1'000), alice, bob); STAmount const mpt{MPTID{0}, 100}; - env(pay(alice, bob, mpt), ter(tecOBJECT_NOT_FOUND)); + auto const err = + !features[featureMPTokensV2] ? ter(tecOBJECT_NOT_FOUND) : ter(temBAD_CURRENCY); + env(pay(alice, bob, mpt), err); } // Issuer fails trying to send to an account, which doesn't own MPT for @@ -1805,7 +1881,7 @@ class MPToken_test : public beast::unit_test::suite Account const alice("alice"); auto const USD = alice["USD"]; Account const carol("carol"); - MPTIssue issue(makeMptID(1, alice)); + MPTIssue const issue(makeMptID(1, alice)); STAmount mpt{issue, UINT64_C(100)}; auto const jvb = bridge(alice, USD, alice, USD); for (auto const& feature : {features, features - featureMPTokensV1}) @@ -1833,7 +1909,6 @@ class MPToken_test : public beast::unit_test::suite jrr = env.rpc("json", "sign", to_string(jv1)); BEAST_EXPECT(jrr[jss::result][jss::error] == "invalidParams"); }; - auto toSFieldRef = [](SField const& field) { return std::ref(field); }; auto setMPTFields = [&](SField const& field, Json::Value& jv, bool withAmount = true) { jv[jss::Asset] = to_json(xrpIssue()); jv[jss::Asset2] = to_json(USD.issue()); @@ -1856,22 +1931,6 @@ class MPToken_test : public beast::unit_test::suite // Transactions with amount fields, which can't be MPT. // Transactions with issue fields, which can't be MPT. - // AMMCreate - auto ammCreate = [&](SField const& field) { - Json::Value jv; - jv[jss::TransactionType] = jss::AMMCreate; - jv[jss::Account] = alice.human(); - jv[jss::Amount] = (field.fieldName == sfAmount.fieldName) - ? mpt.getJson(JsonOptions::none) - : "100000000"; - jv[jss::Amount2] = (field.fieldName == sfAmount2.fieldName) - ? mpt.getJson(JsonOptions::none) - : "100000000"; - jv[jss::TradingFee] = 0; - test(jv, field.fieldName); - }; - ammCreate(sfAmount); - ammCreate(sfAmount2); // AMMDeposit auto ammDeposit = [&](SField const& field) { Json::Value jv; @@ -1881,13 +1940,7 @@ class MPToken_test : public beast::unit_test::suite setMPTFields(field, jv); test(jv, field.fieldName); }; - for (SField const& field : - {toSFieldRef(sfAmount), - toSFieldRef(sfAmount2), - toSFieldRef(sfEPrice), - toSFieldRef(sfLPTokenOut), - toSFieldRef(sfAsset), - toSFieldRef(sfAsset2)}) + for (SField const& field : {std::ref(sfEPrice), std::ref(sfLPTokenOut)}) ammDeposit(field); // AMMWithdraw auto ammWithdraw = [&](SField const& field) { @@ -1898,13 +1951,7 @@ class MPToken_test : public beast::unit_test::suite setMPTFields(field, jv); test(jv, field.fieldName); }; - ammWithdraw(sfAmount); - for (SField const& field : - {toSFieldRef(sfAmount2), - toSFieldRef(sfEPrice), - toSFieldRef(sfLPTokenIn), - toSFieldRef(sfAsset), - toSFieldRef(sfAsset2)}) + for (SField const& field : {std::ref(sfEPrice), std::ref(sfLPTokenIn)}) ammWithdraw(field); // AMMBid auto ammBid = [&](SField const& field) { @@ -1914,72 +1961,8 @@ class MPToken_test : public beast::unit_test::suite setMPTFields(field, jv); test(jv, field.fieldName); }; - for (SField const& field : - {toSFieldRef(sfBidMin), - toSFieldRef(sfBidMax), - toSFieldRef(sfAsset), - toSFieldRef(sfAsset2)}) - ammBid(field); - // AMMClawback - auto ammClawback = [&](SField const& field) { - Json::Value jv; - jv[jss::TransactionType] = jss::AMMClawback; - jv[jss::Account] = alice.human(); - jv[jss::Holder] = carol.human(); - setMPTFields(field, jv); - test(jv, field.fieldName); - }; - for (SField const& field : - {toSFieldRef(sfAmount), toSFieldRef(sfAsset), toSFieldRef(sfAsset2)}) - ammClawback(field); - // AMMDelete - auto ammDelete = [&](SField const& field) { - Json::Value jv; - jv[jss::TransactionType] = jss::AMMDelete; - jv[jss::Account] = alice.human(); - setMPTFields(field, jv, false); - test(jv, field.fieldName); - }; - ammDelete(sfAsset); - ammDelete(sfAsset2); - // AMMVote - auto ammVote = [&](SField const& field) { - Json::Value jv; - jv[jss::TransactionType] = jss::AMMVote; - jv[jss::Account] = alice.human(); - jv[jss::TradingFee] = 100; - setMPTFields(field, jv, false); - test(jv, field.fieldName); - }; - ammVote(sfAsset); - ammVote(sfAsset2); - // CheckCash - auto checkCash = [&](SField const& field) { - Json::Value jv; - jv[jss::TransactionType] = jss::CheckCash; - jv[jss::Account] = alice.human(); - jv[sfCheckID.fieldName] = to_string(uint256{1}); - jv[field.fieldName] = mpt.getJson(JsonOptions::none); - test(jv, field.fieldName); - }; - checkCash(sfAmount); - checkCash(sfDeliverMin); - // CheckCreate - { - Json::Value jv; - jv[jss::TransactionType] = jss::CheckCreate; - jv[jss::Account] = alice.human(); - jv[jss::Destination] = carol.human(); - jv[jss::SendMax] = mpt.getJson(JsonOptions::none); - test(jv, jss::SendMax.c_str()); - } - // OfferCreate - { - Json::Value jv = offer(alice, USD(100), mpt); - test(jv, jss::TakerPays.c_str()); - jv = offer(alice, mpt, USD(100)); - test(jv, jss::TakerGets.c_str()); - } + ammBid(sfBidMin); + ammBid(sfBidMax); // PaymentChannelCreate { Json::Value jv; @@ -2876,7 +2859,7 @@ class MPToken_test : public beast::unit_test::suite mptAlice.create( {.metadata = "test", .ownerCount = 1, .mutableFlags = tmfMPTCanMutateMetadata}); - std::vector metadatas = { + std::vector const metadatas = { "mutate metadata", "mutate metadata 2", "mutate metadata 3", @@ -3059,45 +3042,83 @@ class MPToken_test : public beast::unit_test::suite testcase("Mutate MPTRequireAuth"); using namespace test::jtx; - Env env{*this, features}; - Account const alice("alice"); - Account const bob("bob"); + // test mutating RequireAuth flag on the issuance and its effect on payment authorization + { + Env env{*this, features}; + Account const alice("alice"); + Account const bob("bob"); - MPTTester mptAlice(env, alice, {.holders = {bob}}); - mptAlice.create( - {.ownerCount = 1, - .flags = tfMPTRequireAuth, - .mutableFlags = tmfMPTCanMutateRequireAuth}); + MPTTester mptAlice(env, alice, {.holders = {bob}}); + mptAlice.create( + {.ownerCount = 1, + .flags = tfMPTRequireAuth, + .mutableFlags = tmfMPTCanMutateRequireAuth}); - mptAlice.authorize({.account = bob}); - mptAlice.authorize({.account = alice, .holder = bob}); + mptAlice.authorize({.account = bob}); + mptAlice.authorize({.account = alice, .holder = bob}); - // Pay to bob - mptAlice.pay(alice, bob, 1000); + // Pay to bob + mptAlice.pay(alice, bob, 1000); - // Unauthorize bob - mptAlice.authorize({.account = alice, .holder = bob, .flags = tfMPTUnauthorize}); + // Unauthorize bob + mptAlice.authorize({.account = alice, .holder = bob, .flags = tfMPTUnauthorize}); - // Can not pay to bob - mptAlice.pay(bob, alice, 100, tecNO_AUTH); + // Can not pay to bob + mptAlice.pay(bob, alice, 100, tecNO_AUTH); - // Clear RequireAuth - mptAlice.set({.account = alice, .mutableFlags = tmfMPTClearRequireAuth}); + // Clear RequireAuth + mptAlice.set({.account = alice, .mutableFlags = tmfMPTClearRequireAuth}); - // Can pay to bob - mptAlice.pay(alice, bob, 1000); + // Can pay to bob + mptAlice.pay(alice, bob, 1000); - // Set RequireAuth again - mptAlice.set({.account = alice, .mutableFlags = tmfMPTSetRequireAuth}); + // Set RequireAuth again + mptAlice.set({.account = alice, .mutableFlags = tmfMPTSetRequireAuth}); - // Can not pay to bob since he is not authorized - mptAlice.pay(bob, alice, 100, tecNO_AUTH); + // Can not pay to bob since he is not authorized + mptAlice.pay(bob, alice, 100, tecNO_AUTH); - // Authorize bob again - mptAlice.authorize({.account = alice, .holder = bob}); + // Authorize bob again + mptAlice.authorize({.account = alice, .holder = bob}); - // Can pay to bob again - mptAlice.pay(alice, bob, 100); + // Can pay to bob again + mptAlice.pay(alice, bob, 100); + } + + // Cannot clear RequireAuth when a DomainID is set on the issuance + { + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const credIssuer{"credIssuer"}; + pdomain::Credentials const credentials{ + {.issuer = credIssuer, .credType = "credential"}}; + + Env env{*this, features}; + env.fund(XRP(1000), credIssuer); + env.close(); + + env(pdomain::setTx(credIssuer, credentials)); + env.close(); + auto const domainId = pdomain::getNewDomain(env.meta()); + + MPTTester mptAlice(env, alice, {.holders = {bob}}); + mptAlice.create({ + .ownerCount = 1, + .flags = tfMPTRequireAuth, + .mutableFlags = tmfMPTCanMutateRequireAuth, + .domainID = domainId, + }); + + // Clearing RequireAuth while a DomainID is present must be rejected, + mptAlice.set({ + .account = alice, + .mutableFlags = tmfMPTClearRequireAuth, + .err = tecNO_PERMISSION, + }); + + // Setting RequireAuth (already set) is still allowed, though it has no effect. + mptAlice.set({.account = alice, .mutableFlags = tmfMPTSetRequireAuth}); + } } void @@ -3197,7 +3218,19 @@ class MPToken_test : public beast::unit_test::suite BEAST_EXPECT(mptAlice.isTransferFeePresent()); // Bob can pay carol - mptAlice.pay(bob, carol, 50); + MPT const MPTC = mptAlice; + if (!features[featureMPTokensV2]) + { + mptAlice.pay(bob, carol, 50); + BEAST_EXPECT(env.balance(carol, MPTC) == MPTC(50)); + } + else + { + // The difference is due to the rounding in MPT/DEX. + // 1 MPTC is the transfer fee paid by bob to the issuer. + env(pay(bob, carol, mptAlice(50)), txflags(tfPartialPayment)); + BEAST_EXPECT(env.balance(carol, MPTC) == MPTC(49)); + } // Alice clears MPTCanTransfer mptAlice.set({.account = alice, .mutableFlags = tmfMPTClearCanTransfer}); @@ -3272,6 +3305,3403 @@ class MPToken_test : public beast::unit_test::suite mptAlice.claw(alice, bob, 1, tecNO_PERMISSION); } + void + testMultiSendMaximumAmount(FeatureBitset features) + { + // Verify that directSendNoLimitMultiMPT correctly enforces MaximumAmount + // when the issuer sends to multiple receivers. Pre-fixSecurity3_1_3, + // a stale view.read() snapshot caused per-iteration checks to miss + // aggregate overflows. Post-fix, a running total is used instead. + testcase("Multi-send MaximumAmount enforcement"); + + using namespace test::jtx; + + Account const issuer("issuer"); + Account const alice("alice"); + Account const bob("bob"); + + std::uint64_t constexpr maxAmt = 150; + Env env{*this, features}; + + MPTTester mptt(env, issuer, {.holders = {alice, bob}}); + mptt.create({.maxAmt = maxAmt, .ownerCount = 1, .flags = tfMPTCanTransfer}); + mptt.authorize({.account = alice}); + mptt.authorize({.account = bob}); + + Asset const asset{MPTIssue{mptt.issuanceID()}}; + + // Each test case creates a fresh ApplyView and calls + // accountSendMulti from the issuer to the given receivers. + auto const runTest = [&](MultiplePaymentDestinations const& receivers, + TER expectedTer, + std::optional expectedOutstanding, + std::string const& label) { + ApplyViewImpl av(&*env.current(), tapNONE); + auto const ter = + accountSendMulti(av, issuer.id(), asset, receivers, env.app().getJournal("View")); + BEAST_EXPECTS(ter == expectedTer, label); + + // Only verify OutstandingAmount on success — on error the + // view may contain partial state and must be discarded. + if (expectedOutstanding) + { + auto const sle = av.peek(keylet::mptIssuance(mptt.issuanceID())); + if (!BEAST_EXPECT(sle)) + return; + BEAST_EXPECTS(sle->getFieldU64(sfOutstandingAmount) == *expectedOutstanding, label); + } + }; + + using R = MultiplePaymentDestinations; + + // Post-amendment: aggregate check with running total + runTest( + R{{alice.id(), 100}, {bob.id(), 100}}, + tecPATH_DRY, + std::nullopt, + "aggregate exceeds max"); + + runTest(R{{alice.id(), 75}, {bob.id(), 75}}, tesSUCCESS, maxAmt, "aggregate at boundary"); + + runTest(R{{alice.id(), 50}, {bob.id(), 50}}, tesSUCCESS, 100, "aggregate within limit"); + + runTest( + R{{alice.id(), 150}, {bob.id(), 0}}, + tesSUCCESS, + maxAmt, + "one receiver at max, other zero"); + + runTest( + R{{alice.id(), 151}, {bob.id(), 0}}, + tecPATH_DRY, + std::nullopt, + "one receiver exceeds max, other zero"); + + // Issue 50 tokens so outstandingAmount is nonzero, then verify + // the third condition: outstandingAmount > maximumAmount - sendAmount - totalSendAmount + mptt.pay(issuer, alice, 50); + env.close(); + + // maxAmt=150, outstanding=50, so 100 more available + runTest( + R{{alice.id(), 50}, {bob.id(), 50}}, + tesSUCCESS, + maxAmt, + "nonzero outstanding, aggregate at boundary"); + + runTest( + R{{alice.id(), 50}, {bob.id(), 51}}, + tecPATH_DRY, + std::nullopt, + "nonzero outstanding, aggregate exceeds max"); + + runTest( + R{{alice.id(), 100}, {bob.id(), 0}}, + tesSUCCESS, + maxAmt, + "nonzero outstanding, single send at remaining capacity"); + + runTest( + R{{alice.id(), 101}, {bob.id(), 0}}, + tecPATH_DRY, + std::nullopt, + "nonzero outstanding, single send exceeds remaining capacity"); + + // Pre-amendment: the stale per-iteration check allows each + // individual send (100 <= 150) even though the aggregate (200) + // exceeds MaximumAmount. Preserved for ledger replay. + { + // KNOWN BUG (pre-fixSecurity3_1_3): preserved for ledger replay only + env.disableFeature(fixSecurity3_1_3); + runTest( + R{{alice.id(), 100}, {bob.id(), 100}}, + tesSUCCESS, + 250, + "pre-amendment allows over-send"); + env.enableFeature(fixSecurity3_1_3); + } + } + + void + testOfferCrossing(FeatureBitset features) + { + testcase("Offer Crossing"); + using namespace test::jtx; + Account const gw = Account("gw"); + Account const alice = Account("alice"); + Account const carol = Account("carol"); + auto const USD = gw["USD"]; + + // Blocking flags + for (auto flags : + {tfMPTCanTrade | tfMPTCanLock | tfMPTCanClawback, // global lock - holder, issuer fail + tfMPTCanTrade | tfMPTRequireAuth, // not authorized - holder fails + tfMPTCanTrade, // holder, issuer succeed + tfMPTCanTrade | tfMPTCanLock, // local lock - holder fails + tfMPTCanTransfer}) // can't trade - holder, issuer fail + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice); + env.close(); + + // Use CanClawback flag to distinguish global from local lock + bool const lockMPToken = (flags & (tfMPTCanLock | tfMPTCanClawback)) == tfMPTCanLock; + bool const lockMPTIssue = + (flags & (tfMPTCanLock | tfMPTCanClawback)) == (tfMPTCanLock | tfMPTCanClawback); + bool const requireAuth = (flags & tfMPTRequireAuth) != 0u; + + auto mpt = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 1'000, + .flags = flags, + .authHolder = true}); + MPT const BTC = mpt; + + if (requireAuth) + mpt.authorize({.account = gw, .holder = alice, .flags = tfMPTUnauthorize}); + if (lockMPToken) + { + mpt.set({.holder = alice, .flags = tfMPTLock}); + } + else if (lockMPTIssue) + { + mpt.set({.flags = tfMPTLock}); + } + + auto testOffer = + [&](Account const& account, auto const& buy, auto const& sell, bool buyUSD) { + auto error = [&](auto const err) -> TER { + if (account == gw) + return tesSUCCESS; + return err; + }; + auto const [errBuy, errSell] = [&]() -> std::pair { + // Global lock + if (lockMPTIssue) + return std::make_pair(tecFROZEN, tecFROZEN); + // Local lock + if (lockMPToken) + return std::make_pair(tesSUCCESS, error(tecUNFUNDED_OFFER)); + // MPToken doesn't exist + if (requireAuth) + return std::make_pair(error(tecNO_AUTH), error(tecUNFUNDED_OFFER)); + if (flags & tfMPTCanTransfer) + return std::make_pair(tecNO_PERMISSION, tecNO_PERMISSION); + return std::make_pair(tesSUCCESS, tesSUCCESS); + }(); + + auto const err = buyUSD ? errBuy : errSell; + + auto seq(env.seq(account)); + env(offer(account, buy(10), sell(10)), ter(err)); + env(offer_cancel(account, seq)); + env.close(); + }; + + auto testOffers = [&](Account const& account) { + testOffer(account, XRP, BTC, false); + testOffer(account, BTC, XRP, true); + }; + testOffers(alice); + testOffers(gw); + } + + // MPTokenV2 is disabled + { + Env env{*this, features - featureMPTokensV2}; + + MPTTester mpt(env, gw, {.holders = {alice}}); + + mpt.create({.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer}); + + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 200); + + env(offer(alice, XRP(100), mpt.mpt(101)), ter(temDISABLED)); + env.close(); + } + + // MPTokenIssuance object doesn't exist + { + Env env(*this); + env.fund(XRP(1'000), gw, alice); + env.close(); + MPT const BTC = MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 100}); + MPT const ETH = MPT(gw, 1); + + env(offer(alice, ETH(10), BTC(10)), ter(tecOBJECT_NOT_FOUND)); + env(offer(alice, BTC(10), ETH(10)), ter(tecUNFUNDED_OFFER)); + } + + // MPToken object doesn't exist and the account is not the issuer of MPT + { + Env env(*this); + env.fund(XRP(1'000), gw, alice); + MPTTester const BTC({.env = env, .issuer = gw, .holders = {alice}, .pay = 100}); + MPTTester const ETH({.env = env, .issuer = gw}); + + env(offer(alice, ETH(10), BTC(10))); + env(offer(alice, BTC(10), ETH(10)), ter(tecUNFUNDED_OFFER)); + } + + // MPTLock flag is set and the account is not the issuer of MPT + { + Account const bob = Account("bob"); + Account const dan = Account("dan"); + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol, bob, dan); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob, dan}, + .pay = 100, + .flags = tfMPTCanLock | MPTDEXFlags}); + MPTTester ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob, dan}, + .pay = 100, + .flags = tfMPTCanLock | MPTDEXFlags}); + + env(offer(bob, ETH(10), BTC(10)), txflags(tfPassive)); + env(offer(dan, BTC(10), ETH(10)), txflags(tfPassive)); + + auto test = [&](auto const& flag, bool gwOwner = false) { + BTC.set({.holder = carol, .flags = flag}); + BTC.set({.holder = alice, .flags = flag}); + + if (gwOwner) + { + // Succeeds if the account is the issuer + env(offer(gw, ETH(1), BTC(1))); + env(offer(gw, BTC(1), ETH(1))); + } + else + { + auto const err = flag == tfMPTLock ? ter(tecUNFUNDED_OFFER) : ter(tesSUCCESS); + env(offer(alice, ETH(1), BTC(1)), err); + // Offer created by not crossed + env(offer(carol, BTC(1), ETH(1))); + BEAST_EXPECT(expectOffers(env, carol, 1, {{BTC(1), ETH(1)}})); + } + }; + + test(tfMPTLock); + test(tfMPTLock, true); + test(tfMPTUnlock); + } + + // MPTRequireAuth flag is set and the account is not authorized + { + Env env(*this); + env.fund(XRP(1'000), gw, alice); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 100, + .flags = tfMPTRequireAuth | MPTDEXFlags, + .authHolder = true}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 100, + .flags = tfMPTRequireAuth | MPTDEXFlags, + .authHolder = true}); + + BTC.authorize({.account = gw, .holder = alice, .flags = tfMPTUnauthorize}); + + env(offer(alice, ETH(10), BTC(10)), ter(tecUNFUNDED_OFFER)); + + // issuer can create + + env(offer(gw, ETH(10), BTC(10))); + env.close(); + } + + // MPTCanTransfer is not set and the account is not the issuer of MPT + { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 100, + .flags = tfMPTCanTrade, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + MPTTester ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 100, + .flags = tfMPTCanTrade | tfMPTCanTransfer, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + + // Can create + env(offer(alice, ETH(10), BTC(10)), txflags(tfPassive)); + BTC.set({.mutableFlags = tmfMPTSetCanTransfer}); + ETH.set({.mutableFlags = tmfMPTClearCanTransfer}); + env(offer(alice, ETH(10), BTC(10)), txflags(tfPassive)); + BEAST_EXPECT(getAccountOffers(env, alice)[jss::offers].size() == 2); + + // issuer can create + env(offer(gw, ETH(10), BTC(10)), txflags(tfPassive)); + env.close(); + + // can cross issuer's offer, other offers are removed + env(offer(carol, BTC(10), ETH(10))); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, gw, 0)); + BEAST_EXPECT(expectOffers(env, carol, 0)); + // can't cross holder's offer, holder's offer is removed + env(offer(alice, ETH(10), BTC(10)), txflags(tfPassive)); + env(offer(carol, BTC(10), ETH(10))); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, carol, 1)); + } + + // MPTCanTrade is disabled + { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol); + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 100, + .flags = tfMPTCanTransfer, + .mutableFlags = tmfMPTCanMutateCanTrade}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 100, + .flags = tfMPTCanTrade, + .mutableFlags = tmfMPTCanMutateCanTrade}); + + // Can't create + env(offer(gw, ETH(10), BTC(10)), ter(tecNO_PERMISSION)); + env.close(); + } + + // XRP/MPT + { + Env env{*this, features}; + + MPTTester mpt(env, gw, {.holders = {alice, carol}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 200); + + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + env(offer(alice, XRP(100), MPT(101))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{XRP(100), MPT(101)}}})); + + env(offer(carol, MPT(101), XRP(100))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt.checkMPTokenAmount(alice, 99)); + BEAST_EXPECT(mpt.checkMPTokenAmount(carol, 301)); + } + + // IOU/MPT + { + Env env{*this, features}; + + MPTTester mpt(env, gw, {.holders = {alice, carol}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + env(trust(alice, USD(2'000))); + env(pay(gw, alice, USD(1'000))); + env.close(); + + env(trust(carol, USD(2'000))); + env(pay(gw, carol, USD(1'000))); + env.close(); + + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 200); + + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + env(offer(alice, USD(100), MPT(101))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{USD(100), MPT(101)}}})); + + env(offer(carol, MPT(101), USD(100))); + env.close(); + + BEAST_EXPECT(env.balance(alice, USD) == USD(1'100)); + BEAST_EXPECT(env.balance(carol, USD) == USD(900)); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt.checkMPTokenAmount(alice, 99)); + BEAST_EXPECT(mpt.checkMPTokenAmount(carol, 301)); + } + + // MPT/MPT + { + Env env{*this, features}; + + MPTTester mpt1(env, gw, {.holders = {alice, carol}}); + mpt1.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + + MPTTester mpt2(env, gw, {.holders = {alice, carol}, .fund = false}); + mpt2.create( + {.ownerCount = 2, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT2 = mpt2["MPT2"]; + + mpt1.authorize({.account = alice}); + mpt1.authorize({.account = carol}); + mpt1.pay(gw, alice, 200); + mpt1.pay(gw, carol, 200); + + mpt2.authorize({.account = alice}); + mpt2.authorize({.account = carol}); + mpt2.pay(gw, alice, 200); + mpt2.pay(gw, carol, 200); + + env(offer(alice, MPT2(100), MPT1(101))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{MPT2(100), MPT1(101)}}})); + + env(offer(carol, MPT1(101), MPT2(100))); + env.close(); + + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, carol, 0)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 99)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(carol, 301)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 300)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 100)); + } + } + + void + testCrossAssetPayment(FeatureBitset features) + { + testcase("Cross Asset Payment"); + using namespace test::jtx; + Account const gw = Account("gw"); + Account const alice = Account("alice"); + Account const carol = Account("carol"); + Account const bob = Account("bob"); + auto const USD = gw["USD"]; + + // Loop + { + Env env{*this, features}; + MPTTester mpt(env, gw, {.holders = {carol, bob}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + mpt.authorize({.account = bob}); + + // holder to holder + env(pay(carol, bob, MPT(1)), + test::jtx::path(~MPT, ~USD, ~MPT), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(temBAD_PATH_LOOP)); + env.close(); + + // issuer to holder + env(pay(gw, bob, MPT(1)), + test::jtx::path(~MPT, ~USD, ~MPT), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(temBAD_PATH_LOOP)); + env.close(); + + // holder to issuer + env(pay(bob, gw, MPT(1)), + test::jtx::path(~MPT, ~USD, ~MPT), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(temBAD_PATH_LOOP)); + env.close(); + } + + // Rippling + { + Env env{*this, features}; + MPTTester mpt(env, gw, {.holders = {carol, bob}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + mpt.authorize({.account = bob}); + + // holder to holder + env(pay(carol, bob, MPT(1)), + test::jtx::path(~MPT, gw), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(temBAD_PATH)); + env.close(); + + // issuer to holder + env(pay(gw, bob, MPT(1)), + test::jtx::path(~MPT, carol), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(temBAD_PATH)); + env.close(); + + // holder to issuer + env(pay(bob, gw, MPT(1)), + test::jtx::path(~MPT, carol), + sendmax(XRP(1)), + txflags(tfPartialPayment), + ter(temBAD_PATH)); + env.close(); + } + + // MPTokenV2 is disabled + { + Env env{*this, features - featureMPTokensV2}; + + MPTTester mpt(env, gw, {.holders = {alice}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + + env(pay(gw, alice, MPT(101)), + test::jtx::path(~MPT), + sendmax(XRP(100)), + txflags(tfPartialPayment), + ter(temMALFORMED)); + } + + { + auto const ed = Account{"ed"}; + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol, bob, ed); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = tfMPTCanLock | MPTDEXFlags, + .mutableFlags = tmfMPTCanMutateRequireAuth | tmfMPTCanMutateCanTrade | + tmfMPTCanMutateCanTransfer}); + MPTTester ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = tfMPTCanLock | MPTDEXFlags, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + MPTTester const USD( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = MPTDEXFlags | tfMPTCanLock, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + MPTTester const CAD( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = MPTDEXFlags | tfMPTCanLock, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + + env(offer(bob, ETH(1'000), BTC(1'000)), txflags(tfPassive)); + env.close(); + env(offer(bob, BTC(1'000), ETH(1'000)), txflags(tfPassive)); + env.close(); + + // MPTokenIssuance doesn't exist + + env(pay(alice, carol, MPT(gw, 1'000)(10)), sendmax(ETH(10)), ter(tecOBJECT_NOT_FOUND)); + env.close(); + env(pay(alice, carol, ETH(10)), sendmax(MPT(gw)(10)), ter(tecOBJECT_NOT_FOUND)); + env.close(); + + // MPToken object doesn't exist + + // holder and issuer fail + env(pay(ed, carol, BTC(10)), sendmax(ETH(10)), ter(tecNO_AUTH)); + env(pay(carol, ed, BTC(10)), sendmax(ETH(10)), ter(tecNO_AUTH)); + env(pay(ed, gw, BTC(10)), sendmax(ETH(10)), ter(tecNO_AUTH)); + env(pay(gw, ed, BTC(10)), sendmax(ETH(10)), ter(tecNO_AUTH)); + env.close(); + + // MPTRequireAuth is set + + BTC.authorize({.account = ed}); + ETH.authorize({.account = ed}); + env(pay(gw, ed, ETH(100))); + env(pay(gw, ed, BTC(100))); + env.close(); + BTC.set({.mutableFlags = tmfMPTSetRequireAuth}); + // authorize bob to enable the offers trading + BTC.authorize({.account = gw, .holder = bob}); + env.close(); + env(pay(ed, carol, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tecNO_AUTH)); + env(pay(carol, ed, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tecNO_AUTH)); + // BTC is transferred from bob to ed, ed is not authorized + env(pay(gw, ed, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tecNO_AUTH)); + // BTC is transferred from bob to issuer + env(pay(ed, gw, BTC(10)), path(~BTC), sendmax(ETH(10))); + // BTC is transferred from issuer to bob + env(pay(gw, ed, ETH(10)), path(~ETH), sendmax(BTC(10))); + // BTC is transferred from ed to bob, ed is not authorized + env(pay(ed, gw, ETH(10)), path(~ETH), sendmax(BTC(10)), ter(tecNO_AUTH)); + env.close(); + BTC.set({.mutableFlags = tmfMPTClearRequireAuth}); + + // MPTCanTransfer is not set + + // Fail regardless if source/destination is the issuer or + // not since the offer is owned by a holder. + BTC.set({.mutableFlags = tmfMPTClearCanTransfer}); + env(pay(ed, carol, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tecPATH_PARTIAL)); + env(pay(carol, ed, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tecPATH_PARTIAL)); + env(pay(ed, carol, ETH(10)), path(~ETH), sendmax(BTC(10)), ter(tecPATH_PARTIAL)); + env(pay(carol, ed, ETH(10)), path(~ETH), sendmax(BTC(10)), ter(tecPATH_PARTIAL)); + // Fail because BTC, which has CanTransfer disabled, is sent to + // bob + env(pay(ed, gw, ETH(10)), path(~ETH), sendmax(BTC(10)), ter(tecPATH_PARTIAL)); + env(pay(ed, gw, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tesSUCCESS)); + env(pay(gw, ed, ETH(10)), path(~ETH), sendmax(BTC(10)), ter(tesSUCCESS)); + // Fail because BTC, which has CanTransfer disabled, is sent to + // ed + env(pay(gw, ed, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tecPATH_PARTIAL)); + env.close(); + env(offer(gw, ETH(100), BTC(100)), txflags(tfPassive)); + env.close(); + env(offer(gw, BTC(100), ETH(100)), txflags(tfPassive)); + env.close(); + BEAST_EXPECT(expectOffers(env, bob, 2)); + env(pay(ed, carol, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tesSUCCESS)); + env(pay(ed, carol, ETH(10)), path(~ETH), sendmax(BTC(10)), ter(tesSUCCESS)); + env(pay(gw, carol, BTC(10)), path(~BTC), sendmax(ETH(10)), ter(tesSUCCESS)); + env.close(); + env(pay(ed, gw, BTC(10)), path(~BTC), sendmax(ETH(10))); + env.close(); + } + // Multiple steps: CAD/USD, USD/BTC, BTC/ETH + { + auto const ed = Account{"ed"}; + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol, bob, ed); + env.close(); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = tfMPTCanLock | MPTDEXFlags, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + MPTTester ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = tfMPTCanLock | MPTDEXFlags, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + MPTTester USD( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = MPTDEXFlags | tfMPTCanLock, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + MPTTester CAD( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = MPTDEXFlags | tfMPTCanLock, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + // takerGets can transfer if: + // - CanTransfer is set + // - The offer's owner is the issuer + // - BookStep is the last step, which means strand's destination is + // the issuer + // takerPays can transfer if + // - BookStep is the first step, which means strand's source is + // the issuer + // - The offer's owner is the issuer + // - Previous step is BookStep, which transfers per above + // - CanTransfer is set + env(offer(bob, CAD(100), USD(100)), txflags(tfPassive)); + env(offer(bob, USD(100), BTC(100)), txflags(tfPassive)); + env(offer(bob, BTC(100), ETH(100)), txflags(tfPassive)); + env.close(); + BEAST_EXPECT(expectOffers(env, bob, 3)); + BTC.set({.mutableFlags = tmfMPTSetCanTransfer}); + USD.set({.mutableFlags = tmfMPTClearCanTransfer}); + // TakerGets + // fail - CAD/USD is owned by bob + env(pay(alice, carol, ETH(1)), + path(~USD, ~BTC, ~ETH), + sendmax(CAD(1)), + ter(tecPATH_PARTIAL)); + auto seq(env.seq(gw)); + env(offer(gw, USD(1), BTC(1)), txflags(tfPassive)); + env.close(); + // fail - CAD/USD is owned by bob + env(pay(alice, carol, ETH(1)), + path(~USD, ~BTC, ~ETH), + sendmax(CAD(1)), + ter(tecPATH_PARTIAL)); + env.close(); + env(offer_cancel(gw, seq)); + env(offer(gw, CAD(1), USD(1)), txflags(tfPassive)); + env.close(); + BEAST_EXPECT(expectOffers(env, bob, 3)); + // succeed - CAD/USD is owned by issuer + env(pay(alice, carol, ETH(1)), path(~USD, ~BTC, ~ETH), sendmax(CAD(1))); + env.close(); + // bob's CAD/USD is deleted + BEAST_EXPECT(expectOffers(env, bob, 2)); + env(offer(bob, CAD(100), USD(100)), txflags(tfPassive)); + BEAST_EXPECT(expectOffers(env, gw, 0)); + USD.set({.mutableFlags = tmfMPTSetCanTransfer}); + ETH.set({.mutableFlags = tmfMPTClearCanTransfer}); + // fail - BTC/ETH is owned by bob, destination is carol + env(pay(alice, carol, ETH(1)), + path(~USD, ~BTC, ~ETH), + sendmax(CAD(1)), + ter(tecPATH_PARTIAL)); + env.close(); + BEAST_EXPECT(expectOffers(env, bob, 3)); + // succeed - destination is an issuer + env(pay(alice, gw, ETH(1)), path(~USD, ~BTC, ~ETH), sendmax(CAD(1))); + env.close(); + BEAST_EXPECT(expectOffers(env, bob, 3)); + // TakerPays + ETH.set({.mutableFlags = tmfMPTSetCanTransfer}); + CAD.set({.mutableFlags = tmfMPTClearCanTransfer}); + // fail - CAD/USD is owned by bob, source is alice + env(pay(alice, carol, ETH(1)), + path(~USD, ~BTC, ~ETH), + sendmax(CAD(1)), + ter(tecPATH_PARTIAL)); + // succeed - source is the issuer + env(pay(gw, carol, ETH(1)), path(~USD, ~BTC, ~ETH), sendmax(CAD(1))); + env.close(); + env(offer(gw, CAD(1), USD(1)), txflags(tfPassive)); + env.close(); + // succeed - CAD/USD is owned by issuer + env(pay(alice, carol, ETH(1)), path(~USD, ~BTC, ~ETH), sendmax(CAD(1))); + env.close(); + BEAST_EXPECT(expectOffers(env, gw, 0)); + BEAST_EXPECT(expectOffers(env, bob, 2)); + CAD.set({.mutableFlags = tmfMPTSetCanTransfer}); + BTC.set({.mutableFlags = tmfMPTClearCanTransfer}); + env(offer(bob, CAD(1), USD(1)), txflags(tfPassive)); + env(offer(gw, USD(1), BTC(1)), txflags(tfPassive)); + env.close(); + // succeed - USD/BTC is owned by issuer + env(pay(alice, carol, ETH(1)), path(~USD, ~BTC, ~ETH), sendmax(CAD(1))); + env.close(); + BEAST_EXPECT(expectOffers(env, gw, 0)); + } + + // MPTCanTrade is not set + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol, bob); + env.close(); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = tfMPTCanTransfer, + .mutableFlags = tmfMPTCanMutateCanTrade}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = tfMPTCanTransfer | tfMPTCanTrade, + .mutableFlags = tmfMPTCanMutateCanTrade}); + MPTTester const USD( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 1'000, + .flags = tfMPTCanTransfer | tfMPTCanTrade, + .mutableFlags = tmfMPTCanMutateCanTrade}); + + env(pay(alice, carol, ETH(1)), path(~ETH), sendmax(BTC(1)), ter(tecNO_PERMISSION)); + env(pay(alice, carol, BTC(1)), path(~BTC), sendmax(ETH(1)), ter(tecNO_PERMISSION)); + env.close(); + + BTC.set({.mutableFlags = tmfMPTSetCanTrade}); + env(offer(bob, XRP(1), BTC(1))); + env(offer(bob, BTC(1), ETH(1))); + env(offer(bob, ETH(1), USD(1))); + env.close(); + BTC.set({.mutableFlags = tmfMPTClearCanTrade}); + env(pay(gw, carol, USD(1)), + path(~BTC, ~ETH, ~USD), + sendmax(XRP(1)), + ter(tecPATH_PARTIAL)); + env.close(); + BEAST_EXPECT(expectOffers(env, bob, 3)); + } + + // Holders are locked + { + enum LockType { Global, Individual, None }; + struct TestArg + { + Account src; + Account dst; + Account offerOwner; + LockType srcFlag = None; + LockType dstFlag = None; + LockType offerFlagBuy = None; + LockType offerFlagSell = None; + LockType globalFlagBuy = None; + LockType globalFlagSell = None; + TER err = tesSUCCESS; + std::optional errIOU = std::nullopt; + }; + auto getErr = [&](Token const&, TestArg const& arg) { + if constexpr (std::is_same_v) + { + return arg.errIOU.value_or(arg.err); + } + else if constexpr (std::is_same_v) + { + return arg.err; + } + }; + auto getMPT = [&](Env& env) { + MPTTester const BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 100, + .flags = tfMPTCanLock | MPTDEXFlags}); + MPTTester const ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 100, + .flags = tfMPTCanLock | MPTDEXFlags}); + return std::make_pair(BTC, ETH); + }; + auto getIOU = [&](Env& env) { + for (auto const& iou : {gw["BTC"], gw["ETH"]}) + { + for (auto const& a : {alice, carol, bob}) + { + env(fset(a, asfDefaultRipple)); + env.close(); + env(trust(a, iou(200))); + env(pay(gw, a, iou(100))); + env.close(); + } + } + return std::make_pair(gw["BTC"], gw["ETH"]); + }; + auto lock = [&]( + Env& env, Account const& account, Token& token, LockType lock) { + if (lock == None) + return; + if constexpr (std::is_same_v) + { + if (lock == Global) + { + env(fset(gw, asfGlobalFreeze)); + } + else + { + IOU const iou{account, token.currency}; + env(trust(gw, iou(0), tfSetFreeze)); + } + } + else if constexpr (std::is_same_v) + { + if (lock == Global) + { + token.set({.flags = tfMPTLock}); + } + else if (token.issuer() != account) + { + token.set({.holder = account, .flags = tfMPTLock}); + } + } + }; + auto test = [&](auto&& getTokens, TestArg const& arg) { + Env env(*this); + env.fund(XRP(1'000), gw, alice, carol, bob); + + auto [BTC, ETH] = getTokens(env); + + env(offer(arg.offerOwner, ETH(10), BTC(10)), txflags(tfPassive)); + env.close(); + + if (arg.globalFlagBuy != LockType::None) + { + lock(env, gw, ETH, LockType::Global); + } + else + { + lock(env, arg.offerOwner, ETH, arg.offerFlagBuy); + lock(env, arg.src, ETH, arg.srcFlag); + } + if (arg.globalFlagSell != LockType::None) + { + lock(env, gw, BTC, LockType::Global); + } + else + { + lock(env, arg.offerOwner, BTC, arg.offerFlagSell); + lock(env, arg.dst, BTC, arg.dstFlag); + } + + auto const err = getErr(ETH, arg); + env(pay(arg.src, arg.dst, BTC(1)), + path(~BTC), + txflags(tfNoRippleDirect), + sendmax(ETH(1)), + ter(err)); + env.close(); + }; + // clang-format off + std::vector const tests = { + // src, dst, offer's owner are a holder + {.src = alice, .dst = carol, .offerOwner = bob, .srcFlag = Individual, .err = tecPATH_DRY}, + // dst can receive IOU even if the account is frozen + {.src = alice, .dst = carol, .offerOwner = bob, .dstFlag = Individual, .err = tecPATH_DRY, .errIOU = tesSUCCESS}, + {.src = alice, .dst = carol, .offerOwner = bob, .globalFlagBuy = Global, .err = tecPATH_DRY}, + {.src = alice, .dst = carol, .offerOwner = bob, .globalFlagSell = Global, .err = tecPATH_DRY}, + // offer's owner can receive IOU even if the account is frozen + {.src = alice, .dst = carol, .offerOwner = bob, .offerFlagBuy = Individual, .err = + tecPATH_PARTIAL, .errIOU = tesSUCCESS}, + {.src = alice, .dst = carol, .offerOwner = bob, .offerFlagSell = Individual, .err = tecPATH_PARTIAL}, + // src, dst are a holder, offer's owner is an issuer + {.src = alice, .dst = carol, .offerOwner = gw, .srcFlag = Individual, .err = tecPATH_DRY}, + // dst can receive IOU even if the account is frozen + {.src = alice, .dst = carol, .offerOwner = gw, .dstFlag = Individual, .err = tecPATH_DRY, .errIOU = tesSUCCESS}, + {.src = alice, .dst = carol, .offerOwner = gw, .globalFlagBuy = Global, .err = tecPATH_DRY}, + {.src = alice, .dst = carol, .offerOwner = gw, .globalFlagSell = Global, .err = tecPATH_DRY}, + // src is issuer, dst and offer's owner are a holder + // dst can receive IOU even if the account is frozen + {.src = gw, .dst = carol, .offerOwner = bob, .dstFlag = Individual, .err = tecPATH_DRY, .errIOU = tesSUCCESS}, + // offer's owner can receive IOU from an issuer even if takerBuys is frozen, MPT offer is unfunded in this case + {.src = gw, .dst = carol, .offerOwner = bob, .offerFlagBuy = Individual, .err = tecPATH_PARTIAL, .errIOU = tesSUCCESS}, + {.src = gw, .dst = carol, .offerOwner = bob, .offerFlagSell = Individual, .err = tecPATH_PARTIAL}, + // dst is issuer, src and offer's owner are a holder + {.src = alice, .dst = gw, .offerOwner = bob, .srcFlag = Individual, .err = tecPATH_DRY}, + // offer's owner can receive IOU even if the account is frozen + {.src = alice, .dst = gw, .offerOwner = bob, .offerFlagBuy = Individual, .err = tecPATH_PARTIAL, + .errIOU = tesSUCCESS}, + {.src = alice, .dst = gw, .offerOwner = bob, .offerFlagSell = Individual, .err = tecPATH_PARTIAL}, + }; + // clang-format on + + for (auto const& t : tests) + { + test(getMPT, t); + test(getIOU, t); + } + } + { + Env env(*this); + auto const USD = gw["USD"]; + env.fund(XRP(1'000), gw, alice, carol, bob); + MPTTester BTC( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 100, + .flags = tfMPTCanLock | MPTDEXFlags}); + MPTTester ETH( + {.env = env, + .issuer = gw, + .holders = {alice, carol, bob}, + .pay = 100, + .flags = tfMPTCanLock | MPTDEXFlags}); + + env(trust(alice, USD(100))); + env(pay(gw, alice, USD(100))); + env(trust(carol, USD(100))); + + env(offer(alice, XRP(10), ETH(10))); + env(offer(bob, ETH(10), BTC(10))); + env(offer(alice, BTC(10), USD(10))); + env.close(); + + BTC.set({.holder = bob, .flags = tfMPTLock}); + + // Bob's offer is unfunded + env(pay(alice, carol, USD(1)), + path(~(MPT)ETH, ~(MPT)BTC, ~USD), + txflags(tfNoRippleDirect | tfPartialPayment), + sendmax(XRP(1)), + ter(tecPATH_DRY)); + env.close(); + + BTC.set({.holder = bob, .flags = tfMPTUnlock}); + ETH.set({.holder = bob, .flags = tfMPTLock}); + + env(pay(alice, carol, USD(1)), + path(~(MPT)ETH, ~(MPT)BTC, ~USD), + txflags(tfNoRippleDirect | tfPartialPayment), + sendmax(XRP(1)), + ter(tecPATH_DRY)); + } + + // A domain payment should only consume a USD/MPT offer with a domain. + // It must not consume a regular USD/MPT offer. + { + Env env(*this, features); + Account const domainOwner("DomainOwner"); + env.fund(XRP(1'000), gw, alice, carol, bob); + auto const domainID = + setupDomain(env, {alice, bob, carol, gw}, domainOwner, "permdex-cred"); + + MPTTester BTC({.env = env, .issuer = gw, .holders = {alice, carol, bob}, .pay = 100}); + MPTTester ETH({.env = env, .issuer = gw, .holders = {alice, carol, bob}, .pay = 100}); + + auto test = [&](bool withDomain) { + if (withDomain) + { + env(offer(bob, ETH(1), BTC(1)), domain(domainID)); + } + else + { + env(offer(bob, ETH(1), BTC(1))); + } + + auto const err = withDomain ? ter(tesSUCCESS) : ter(tecPATH_DRY); + env(pay(alice, carol, BTC(1)), + path(~(MPT)BTC), + txflags(tfPartialPayment), + sendmax(ETH(1)), + domain(domainID), + err); + }; + test(true); + test(false); + } + + // A hybrid USD/MPT domain offer should still be consumable by + // a regular payment. + { + Env env(*this, features); + Account const domainOwner("DomainOwner"); + env.fund(XRP(1'000), gw, alice, carol, bob); + auto const domainID = + setupDomain(env, {alice, bob, carol, gw}, domainOwner, "permdex-cred"); + + MPTTester BTC({.env = env, .issuer = gw, .holders = {alice, carol, bob}, .pay = 100}); + MPTTester ETH({.env = env, .issuer = gw, .holders = {alice, carol, bob}, .pay = 100}); + + auto test = [&](bool isHybrid) { + auto const flags = isHybrid ? tfHybrid : 0; + env(offer(bob, ETH(1), BTC(1)), txflags(flags), domain(domainID)); + + auto const err = isHybrid ? ter(tesSUCCESS) : ter(tecPATH_DRY); + env(pay(alice, carol, BTC(1)), + path(~(MPT)BTC), + txflags(tfPartialPayment), + sendmax(ETH(1)), + err); + }; + test(true); + test(false); + } + + // MPT/XRP + { + Env env{*this, features}; + MPTTester mpt(env, gw, {.holders = {alice, carol, bob}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 200); + + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + mpt.authorize({.account = bob}); + + env(offer(alice, XRP(100), MPT(101))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{XRP(100), MPT(101)}}})); + + env(pay(carol, bob, MPT(101)), + test::jtx::path(~MPT), + sendmax(XRP(100)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt.checkMPTokenAmount(alice, 99)); + BEAST_EXPECT(mpt.checkMPTokenAmount(bob, 101)); + } + + // MPT/IOU + { + Env env{*this, features}; + + MPTTester mpt(env, gw, {.holders = {alice, carol, bob}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + env(trust(alice, USD(2'000))); + env(pay(gw, alice, USD(1'000))); + env(trust(bob, USD(2'000))); + env(pay(gw, bob, USD(1'000))); + env(trust(carol, USD(2'000))); + env(pay(gw, carol, USD(1'000))); + env.close(); + + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 200); + + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + mpt.authorize({.account = bob}); + + env(offer(alice, USD(100), MPT(101))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{USD(100), MPT(101)}}})); + + env(pay(carol, bob, MPT(101)), + test::jtx::path(~MPT), + sendmax(USD(100)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(env.balance(carol, USD) == USD(900)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt.checkMPTokenAmount(alice, 99)); + BEAST_EXPECT(mpt.checkMPTokenAmount(bob, 101)); + } + + // IOU/MPT + { + Env env{*this, features}; + + MPTTester mpt(env, gw, {.holders = {alice, carol, bob}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + env(trust(alice, USD(2'000)), txflags(tfClearNoRipple)); + env(pay(gw, alice, USD(1'000))); + env(trust(bob, USD(2'000)), txflags(tfClearNoRipple)); + env.close(); + + mpt.authorize({.account = alice}); + env(pay(gw, alice, MPT(200))); + + mpt.authorize({.account = carol}); + env(pay(gw, carol, MPT(200))); + + env(offer(alice, MPT(101), USD(100))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{MPT(101), USD(100)}}})); + + env(pay(carol, bob, USD(100)), + test::jtx::path(~USD), + sendmax(MPT(101)), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(env.balance(alice, USD) == USD(900)); + BEAST_EXPECT(mpt.checkMPTokenAmount(alice, 301)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt.checkMPTokenAmount(carol, 99)); + BEAST_EXPECT(env.balance(bob, USD) == USD(100)); + } + + // MPT/MPT + { + Env env{*this, features}; + + MPTTester mpt1(env, gw, {.holders = {alice, carol, bob}}); + mpt1.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + + MPTTester mpt2(env, gw, {.holders = {alice, carol, bob}, .fund = false}); + mpt2.create( + {.ownerCount = 2, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT2 = mpt2["MPT2"]; + + mpt1.authorize({.account = alice}); + mpt1.pay(gw, alice, 200); + mpt2.authorize({.account = alice}); + + mpt2.authorize({.account = carol}); + mpt2.pay(gw, carol, 200); + + mpt1.authorize({.account = bob}); + mpt2.authorize({.account = bob}); + mpt2.pay(gw, bob, 200); + + env(offer(alice, MPT2(100), MPT1(100))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{MPT2(100), MPT1(100)}}})); + + // holder to holder + env(pay(carol, bob, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 190)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 10)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(200)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(400)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 10)); + + // issuer to holder + env(pay(gw, bob, MPT1(20)), + test::jtx::path(~MPT1), + sendmax(MPT2(20)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 170)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 30)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(200)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(420)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 30)); + + // holder to issuer + env(pay(bob, gw, MPT1(70)), + test::jtx::path(~MPT1), + sendmax(MPT2(70)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 100)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 100)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(130)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(420)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 30)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(bob, 130)); + } + + // MPT/MPT, issuer owns the offer + { + Env env{*this, features}; + + MPTTester mpt1(env, gw, {.holders = {carol, bob}}); + mpt1.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + + MPTTester mpt2(env, gw, {.holders = {carol, bob}, .fund = false}); + mpt2.create( + {.ownerCount = 2, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT2 = mpt2["MPT2"]; + + mpt2.authorize({.account = carol}); + mpt2.pay(gw, carol, 200); + + mpt1.authorize({.account = bob}); + mpt2.authorize({.account = bob}); + mpt2.pay(gw, bob, 200); + + env(offer(gw, MPT2(100), MPT1(100))); + env.close(); + BEAST_EXPECT(expectOffers(env, gw, 1, {{Amounts{MPT2(100), MPT1(100)}}})); + + // holder to holder + env(pay(carol, bob, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, gw, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(10)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(390)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 10)); + + // issuer to holder + env(pay(gw, bob, MPT1(20)), + test::jtx::path(~MPT1), + sendmax(MPT2(20)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, gw, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(30)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(390)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 30)); + + // holder to issuer + env(pay(bob, gw, MPT1(70)), + test::jtx::path(~MPT1), + sendmax(MPT2(70)), + txflags(tfPartialPayment)); + env.close(); + + BEAST_EXPECT(expectOffers(env, gw, 0)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(30)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(320)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 30)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(bob, 130)); + } + + // MPT/MPT, different issuer + { + Env env{*this, features}; + Account const gw1{"gw1"}; + + MPTTester mpt1(env, gw, {.holders = {alice, carol, bob}}); + mpt1.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + + env.fund(XRP(1'000), gw1); + MPTTester mpt2(env, gw1, {.holders = {alice, carol, bob}, .fund = false}); + mpt2.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT2 = mpt2["MPT2"]; + + mpt1.authorize({.account = alice}); + mpt1.pay(gw, alice, 200); + mpt2.authorize({.account = alice}); + + mpt2.authorize({.account = carol}); + mpt2.pay(gw1, carol, 200); + + mpt1.authorize({.account = bob}); + mpt1.pay(gw, bob, 200); + mpt2.authorize({.account = bob}); + mpt2.pay(gw1, bob, 200); + + mpt1.authorize({.account = gw1}); + mpt1.pay(gw, gw1, 200); + + mpt2.authorize({.account = gw}); + mpt2.pay(gw1, gw, 200); + + env(offer(alice, MPT2(100), MPT1(100))); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1, {{Amounts{MPT2(100), MPT1(100)}}})); + + env(pay(carol, bob, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(600)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(600)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(gw1, 200)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(gw, 200)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(carol, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 210)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(bob, 200)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 190)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 10)); + + env(pay(bob, gw, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(590)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(600)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(gw1, 200)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(gw, 200)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 210)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(bob, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 180)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 20)); + + env(pay(gw, bob, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(590)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(600)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(gw1, 200)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(gw, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 220)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(bob, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 170)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 30)); + + env(pay(bob, gw1, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(590)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(600)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(gw1, 210)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(gw, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 220)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(bob, 180)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 160)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 40)); + + env(pay(gw1, bob, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(590)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(610)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(gw1, 210)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(gw, 190)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 230)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(bob, 180)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 150)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 50)); + + env(pay(gw, gw1, MPT1(10)), + test::jtx::path(~MPT1), + sendmax(MPT2(10)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 1)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(590)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(610)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(gw1, 220)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(gw, 180)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 140)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 60)); + + env(pay(gw1, gw, MPT1(40)), + test::jtx::path(~MPT1), + sendmax(MPT2(40)), + txflags(tfPartialPayment)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(mpt1.checkMPTokenOutstandingAmount(550)); + BEAST_EXPECT(mpt2.checkMPTokenOutstandingAmount(650)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(gw1, 220)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(gw, 180)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(alice, 100)); + BEAST_EXPECT(mpt2.checkMPTokenAmount(alice, 100)); + } + + // MPT/IOU IOU/MPT1 + { + Env env = pathTestEnv(*this); + Account const gw1{"gw1"}; + Account const gw2{"gw2"}; + Account const dan{"dan"}; + env.fund(XRP(1'000), gw2); + auto const USD = gw2["USD"]; + + MPTTester mpt(env, gw, {.holders = {alice, carol}}); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = alice}); + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + MPTTester mpt1(env, gw1, {.holders = {bob, dan}}); + mpt1.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + mpt1.authorize({.account = bob}); + mpt1.pay(gw1, bob, 200); + mpt1.authorize({.account = dan}); + + env(trust(alice, USD(400))); + env(pay(gw2, alice, USD(200))); + env(trust(bob, USD(400))); + + env(offer(alice, MPT(100), USD(100))); + env(offer(bob, USD(100), MPT1(100))); + env.close(); + + env(pay(carol, dan, MPT1(100)), + sendmax(MPT(100)), + path(~USD, ~MPT1), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + BEAST_EXPECT(expectOffers(env, alice, 0)); + BEAST_EXPECT(expectOffers(env, bob, 0)); + BEAST_EXPECT(mpt.checkMPTokenAmount(carol, 100)); + BEAST_EXPECT(mpt1.checkMPTokenAmount(dan, 100)); + } + + // XRP/MPT AMM + { + Env env{*this, features}; + + fund(env, gw, {alice, carol, bob}, XRP(11'000), {USD(20'000)}); + + MPTTester mpt(env, gw, {.fund = false}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + mpt.authorize({.account = bob}); + mpt.pay(gw, alice, 10'100); + + AMM const amm(env, alice, XRP(10'000), MPT(10'100)); + + env(pay(carol, bob, MPT(100)), + test::jtx::path(~MPT), + sendmax(XRP(100)), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + BEAST_EXPECT(amm.expectBalances(XRP(10'100), MPT(10'000), amm.tokens())); + BEAST_EXPECT(mpt.checkMPTokenAmount(bob, 100)); + } + + // IOU/MPT AMM + { + Env env{*this, features}; + + fund(env, gw, {alice, carol, bob}, XRP(11'000), {USD(20'000)}); + + MPTTester mpt(env, gw, {.fund = false}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + mpt.authorize({.account = bob}); + mpt.pay(gw, alice, 10'100); + + AMM const amm(env, alice, USD(10'000), MPT(10'100)); + + env(pay(carol, bob, MPT(100)), + test::jtx::path(~MPT), + sendmax(USD(100)), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + BEAST_EXPECT(amm.expectBalances(USD(10'100), MPT(10'000), amm.tokens())); + BEAST_EXPECT(mpt.checkMPTokenAmount(bob, 100)); + } + + // MPT/MPT AMM cross-asset payment + { + Env env{*this, features}; + env.fund(XRP(20'000), gw, alice, carol, bob); + env.close(); + + MPTTester mpt1(env, gw, {.fund = false}); + mpt1.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + mpt1.authorize({.account = alice}); + mpt1.authorize({.account = bob}); + mpt1.pay(gw, alice, 10'100); + + MPTTester mpt2(env, gw, {.fund = false}); + mpt2.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT2 = mpt2["MPT1"]; + mpt2.authorize({.account = alice}); + mpt2.authorize({.account = bob}); + mpt2.authorize({.account = carol}); + mpt2.pay(gw, alice, 10'100); + mpt2.pay(gw, carol, 100); + + AMM const amm(env, alice, MPT2(10'000), MPT1(10'100)); + + env(pay(carol, bob, MPT1(100)), + test::jtx::path(~MPT1), + sendmax(MPT2(100)), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + BEAST_EXPECT(amm.expectBalances(MPT2(10'100), MPT1(10'000), amm.tokens())); + BEAST_EXPECT(mpt1.checkMPTokenAmount(bob, 100)); + } + + // Multi-steps with AMM + // EUR/MPT1 MPT1/MPT2 MPT2/USD USD/CRN AMM:CRN/MPT MPT/YAN + { + Env env{*this, features}; + auto const USD = gw["USD"]; + auto const EUR = gw["EUR"]; + auto const CRN = gw["CRN"]; + auto const YAN = gw["YAN"]; + + fund( + env, + gw, + {alice, carol, bob}, + XRP(1'000), + {USD(1'000), EUR(1'000), CRN(2'000), YAN(1'000)}); + + auto createMPT = [&]() -> std::pair { + MPTTester mpt(env, gw, {.fund = false}); + mpt.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 2'000); + return {mpt, mpt["MPT"]}; + }; + + auto const [mpt1, MPT1] = createMPT(); + auto const [mpt2, MPT2] = createMPT(); + auto const [mpt3, MPT3] = createMPT(); + + env(offer(alice, EUR(100), MPT1(101))); + env(offer(alice, MPT1(101), MPT2(102))); + env(offer(alice, MPT2(102), USD(103))); + env(offer(alice, USD(103), CRN(104))); + env.close(); + AMM const amm(env, alice, CRN(1'000), MPT3(1'104)); + env(offer(alice, MPT3(104), YAN(100))); + + env(pay(carol, bob, YAN(100)), + test::jtx::path(~MPT1, ~MPT2, ~USD, ~CRN, ~MPT3, ~YAN), + sendmax(EUR(100)), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + BEAST_EXPECT(env.balance(carol, EUR) == EUR(900)); + BEAST_EXPECT(env.balance(bob, YAN) == YAN(1'100)); + BEAST_EXPECT(amm.expectBalances(CRN(1'104), MPT3(1'000), amm.tokens())); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + + // Multi-steps with AMM and MPT endpoints + // MPT1/EUR EUR/MPT2 MPT2/USD USD/CRN AMM:CRN/MPT3 MPT3/MPT4 + { + Env env{*this, features}; + auto const USD = gw["USD"]; + auto const EUR = gw["EUR"]; + auto const CRN = gw["CRN"]; + + fund(env, gw, {alice, carol, bob}, XRP(1'000), {USD(1'000), EUR(1'000), CRN(2'000)}); + + auto createMPT = [&]() -> std::pair { + MPTTester mpt(env, gw, {.fund = false}); + mpt.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 2'000); + return {mpt, mpt["MPT"]}; + }; + + auto const [mpt1, MPT1] = createMPT(); + auto const [mpt2, MPT2] = createMPT(); + auto const [mpt3, MPT3] = createMPT(); + auto [mpt4, MPT4] = createMPT(); + mpt4.authorize({.account = bob}); + + env(offer(alice, EUR(100), MPT1(101))); + env(offer(alice, MPT1(101), MPT2(102))); + env(offer(alice, MPT2(102), USD(103))); + env(offer(alice, USD(103), CRN(104))); + env.close(); + AMM const amm(env, alice, CRN(1'000), MPT3(1'104)); + env(offer(alice, MPT3(104), MPT4(100))); + + env(pay(carol, bob, MPT4(100)), + test::jtx::path(~MPT1, ~MPT2, ~USD, ~CRN, ~MPT3, ~MPT4), + sendmax(EUR(100)), + txflags(tfPartialPayment | tfNoRippleDirect)); + env.close(); + + BEAST_EXPECT(env.balance(carol, EUR) == EUR(900)); + BEAST_EXPECT(mpt4.checkMPTokenAmount(bob, 100)); + BEAST_EXPECT(amm.expectBalances(CRN(1'104), MPT3(1'000), amm.tokens())); + BEAST_EXPECT(expectOffers(env, alice, 0)); + } + + // Check that limiting step reduces maximumAmount returned by + // MPTEndpointStep::maxPaymentFlow() + { + Env env(*this, features); + + env.fund(XRP(1'000), gw, alice, carol, bob); + + MPTTester usd(env, gw, {.holders = {alice, carol, bob}, .fund = false}); + usd.create( + {.maxAmt = 1'000, + .authorize = MPTCreate::AllHolders, + .pay = {{{alice}, 1'000}}, + .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const USD = usd["USD"]; + + MPTTester eur(env, gw, {.holders = {alice, carol, bob}, .fund = false}); + eur.create( + {.maxAmt = 1'000, + .authorize = {{alice, carol}}, + .pay = {{{carol}, 100}}, + .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const EUR = eur["EUR"]; + + env(offer(alice, EUR(10), USD(10))); + + env(pay(carol, bob, USD(10)), + sendmax(EUR(10)), + path(~USD), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + { + Env env(*this, features); + env.fund(XRP(1'000), gw, alice, carol, bob); + + auto MUSD = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, carol, bob}, .maxAmt = 1'000}); + MPT const USD = MUSD; + env(pay(gw, alice, USD(800))); + env(offer(gw, XRP(300), USD(300))); + env(pay(carol, bob, USD(300)), + sendmax(XRP(300)), + path(~USD), + txflags(tfPartialPayment)); + BEAST_EXPECT(MUSD.checkMPTokenAmount(bob, 200)); + BEAST_EXPECT(MUSD.checkMPTokenOutstandingAmount(1'000)); + // initial + offer - fees + BEAST_EXPECT(env.balance(gw) == (XRP(1'000) + XRP(200) - txfee(env, 3))); + } + { + Env env(*this, features); + auto const EUR = gw["EUR"]; + env.fund(XRP(1'000), gw, alice, carol, bob); + env.close(); + + env(trust(alice, EUR(1'000))); + env(pay(gw, alice, EUR(300))); + env(trust(bob, EUR(1'000))); + + auto MUSD = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, carol, bob}, .maxAmt = 1'000}); + MPT const USD = MUSD; + + env(pay(gw, alice, USD(800))); + env(offer(gw, XRP(300), USD(300))); + env(offer(alice, USD(300), EUR(300))); + env(pay(carol, bob, EUR(300)), + sendmax(XRP(300)), + path(~USD, ~EUR), + txflags(tfPartialPayment)); + BEAST_EXPECT(MUSD.checkMPTokenAmount(alice, 1'000)); + BEAST_EXPECT(MUSD.checkMPTokenOutstandingAmount(1'000)); + // initial + offer - fees + BEAST_EXPECT(env.balance(gw) == (XRP(1'000) + XRP(200) - txfee(env, 4))); + BEAST_EXPECT(env.balance(bob, EUR) == EUR(200)); + } + } + + void + testPath(FeatureBitset features) + { + testcase("Path"); + using namespace test::jtx; + Account const gw{"gw"}; + Account const gw1{"gw1"}; + Account const alice{"alice"}; + Account const carol{"carol"}; + Account const bob{"bob"}; + Account const dan{"dan"}; + auto const USD = gw["USD"]; + auto const EUR = gw1["EUR"]; + + // MPT can be a mpt end point step or a book-step + + // Direct MPT payment + { + Env env = pathTestEnv(*this); + + MPTTester mpt(env, gw, {.holders = {dan, carol}}); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = dan}); + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + auto const [pathSet, srcAmt, dstAmt] = find_paths(env, carol, dan, MPT(-1)); + BEAST_EXPECT(srcAmt == MPT(200)); + BEAST_EXPECT(dstAmt == MPT(200)); + // Direct payment, no path + BEAST_EXPECT(pathSet.empty()); + } + + // Cross-asset payment via XRP/MPT offer (one step) + { + Env env = pathTestEnv(*this); + + env.fund(XRP(1'000), carol); + + MPTTester mpt(env, gw, {.holders = {alice, dan}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + mpt.authorize({.account = dan}); + mpt.pay(gw, alice, 200); + + env(offer(alice, XRP(100), MPT(100))); + env.close(); + + auto const [pathSet, srcAmt, dstAmt] = find_paths(env, carol, dan, MPT(-1)); + BEAST_EXPECT(srcAmt == XRP(100)); + BEAST_EXPECT(dstAmt == MPT(100)); + if (BEAST_EXPECT(same(pathSet, stpath(IPE(mpt.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT(10)), + path(~MPT), + sendmax(XRP(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + } + + // Cross-asset payment via IOU/MPT offer (one step) + { + Env env = pathTestEnv(*this); + + env.fund(XRP(1'000), carol); + env.fund(XRP(1'000), gw); + + MPTTester mpt(env, gw1, {.holders = {alice, dan}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + mpt.authorize({.account = dan}); + mpt.pay(gw1, alice, 200); + + env(trust(alice, USD(400))); + env(trust(carol, USD(400))); + env(pay(gw, carol, USD(200))); + + env(offer(alice, USD(100), MPT(100))); + env.close(); + + // No sendMax + STPathSet pathSet; + STAmount srcAmt; + STAmount dstAmt; + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT(-1)); + BEAST_EXPECT(srcAmt == USD(100)); + BEAST_EXPECT(dstAmt == MPT(100)); + if (BEAST_EXPECT( + pathSet.size() == 1 && same(pathSet, stpath(gw, IPE(mpt.issuanceID()))))) + { + // Validate the payment works with the path + env(pay(carol, dan, MPT(10)), + path(pathSet[0]), + sendmax(USD(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include sendMax + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT(-1), USD(-1)); + BEAST_EXPECT(srcAmt == USD(90)); + BEAST_EXPECT(dstAmt == MPT(90)); + if (BEAST_EXPECT(pathSet.size() == 1 && same(pathSet, stpath(IPE(mpt.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT(10)), + path(pathSet[0]), + sendmax(USD(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include source token + std::tie(pathSet, srcAmt, dstAmt) = + find_paths(env, carol, dan, MPT(-1), std::nullopt, USD.currency); + BEAST_EXPECT(srcAmt == USD(80)); + BEAST_EXPECT(dstAmt == MPT(80)); + if (BEAST_EXPECT( + pathSet.size() == 1 && same(pathSet, stpath(gw, IPE(mpt.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT(10)), + path(pathSet[0]), + sendmax(USD(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + } + + // Cross-asset payment via MPT/IOU offer (one step) + { + Env env = pathTestEnv(*this); + + env.fund(XRP(1'000), dan); + env.fund(XRP(1'000), gw); + + MPTTester mpt(env, gw1, {.holders = {carol, alice}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = carol}); + mpt.authorize({.account = alice}); + mpt.pay(gw1, carol, 200); + + env(trust(dan, USD(400))); + env(trust(alice, USD(400))); + env(pay(gw, alice, USD(200))); + + env(offer(alice, MPT(100), USD(100))); + env.close(); + + // No sendMax + STPathSet pathSet; + STAmount srcAmt; + STAmount dstAmt; + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, USD(-1)); + BEAST_EXPECT(srcAmt == MPT(100)); + BEAST_EXPECT(dstAmt == USD(100)); + if (BEAST_EXPECT(pathSet.size() == 1 && same(pathSet, stpath(IPE(USD))))) + { + // Validate the payment works with the path + env(pay(carol, dan, USD(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include sendMax + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, USD(-1), MPT(-1)); + BEAST_EXPECT(srcAmt == MPT(90)); + BEAST_EXPECT(dstAmt == USD(90)); + if (BEAST_EXPECT(pathSet.size() == 1 && same(pathSet, stpath(IPE(USD))))) + { + // validate a payment works with the path + env(pay(carol, dan, USD(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include source token + std::tie(pathSet, srcAmt, dstAmt) = + find_paths(env, carol, dan, USD(-1), std::nullopt, MPT.mpt()); + BEAST_EXPECT(srcAmt == MPT(80)); + BEAST_EXPECT(dstAmt == USD(80)); + if (BEAST_EXPECT(pathSet.size() == 1 && same(pathSet, stpath(IPE(USD))))) + { + // validate a payment works with the path + env(pay(carol, dan, USD(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + } + + // Cross-asset payment via MPT1/MPT offer (one step) + { + Env env = pathTestEnv(*this); + + MPTTester mpt(env, gw, {.holders = {alice, dan}}); + MPTTester mpt1(env, gw1, {.holders = {carol}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt1.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + + mpt.authorize({.account = alice}); + mpt.authorize({.account = dan}); + mpt.pay(gw, alice, 200); + + mpt1.authorize({.account = carol}); + mpt1.authorize({.account = alice}); + mpt1.pay(gw1, carol, 200); + + env(offer(alice, MPT1(100), MPT(100))); + env.close(); + + // No sendMax + STPathSet pathSet; + STAmount srcAmt; + STAmount dstAmt; + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT(-1)); + BEAST_EXPECT(srcAmt == MPT1(100)); + BEAST_EXPECT(dstAmt == MPT(100)); + if (BEAST_EXPECT(pathSet.size() == 1 && same(pathSet, stpath(IPE(mpt.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT(10)), + path(pathSet[0]), + sendmax(MPT1(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include sendMax + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT(-1), MPT1(-1)); + BEAST_EXPECT(srcAmt == MPT1(90)); + BEAST_EXPECT(dstAmt == MPT(90)); + if (BEAST_EXPECT(pathSet.size() == 1 && same(pathSet, stpath(IPE(mpt.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT(10)), + path(pathSet[0]), + sendmax(MPT1(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include source token + std::tie(pathSet, srcAmt, dstAmt) = + find_paths(env, carol, dan, MPT(-1), std::nullopt, MPT1.mpt()); + BEAST_EXPECT(srcAmt == MPT1(80)); + BEAST_EXPECT(dstAmt == MPT(80)); + if (BEAST_EXPECT(pathSet.size() == 1 && same(pathSet, stpath(IPE(mpt.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT(10)), + path(pathSet[0]), + sendmax(MPT1(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + } + + // Cross-asset payment via offers (two steps) + { + Env env = pathTestEnv(*this); + + env.fund(XRP(1'000), carol); + env.fund(XRP(1'000), dan); + + MPTTester mpt(env, gw, {.holders = {alice, bob}}); + + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + mpt.authorize({.account = alice}); + mpt.authorize({.account = bob}); + mpt.pay(gw, alice, 200); + mpt.pay(gw, bob, 200); + + env(trust(bob, USD(200))); + env(pay(gw, bob, USD(100))); + env(trust(dan, USD(200))); + env(trust(alice, USD(200))); + + env(offer(alice, XRP(100), MPT(100))); + env(offer(bob, MPT(100), USD(100))); + env.close(); + + // No sendMax + STPathSet pathSet; + STAmount srcAmt; + STAmount dstAmt; + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, USD(-1)); + BEAST_EXPECT(srcAmt == XRP(100)); + BEAST_EXPECT(dstAmt == USD(100)); + if (BEAST_EXPECT( + pathSet.size() == 1 && same(pathSet, stpath(IPE(mpt.issuanceID()), IPE(USD))))) + { + // validate a payment works with the path + env(pay(carol, dan, USD(10)), + path(pathSet[0]), + sendmax(XRP(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include sendMax + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, USD(-1), XRP(100)); + BEAST_EXPECT(srcAmt == XRP(90)); + BEAST_EXPECT(dstAmt == USD(90)); + if (BEAST_EXPECT( + pathSet.size() == 1 && same(pathSet, stpath(IPE(mpt.issuanceID()), IPE(USD))))) + { + // validate a payment works with the path + env(pay(carol, dan, USD(10)), + path(pathSet[0]), + sendmax(XRP(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + } + + // Cross-asset payment via offers (two steps) + // Start/End with mpt/mp1 and book steps in the middle + { + Env env = pathTestEnv(*this); + Account const gw2{"gw2"}; + env.fund(XRP(1'000), gw2); + auto const USD2 = gw2["USD"]; + + MPTTester mpt(env, gw, {.holders = {alice, carol}}); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = alice}); + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + MPTTester mpt1(env, gw1, {.holders = {bob, dan}}); + mpt1.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + mpt1.authorize({.account = bob}); + mpt1.pay(gw1, bob, 200); + mpt1.authorize({.account = dan}); + + env(trust(alice, USD2(400))); + env(pay(gw2, alice, USD2(200))); + env(trust(bob, USD2(400))); + + env(offer(alice, MPT(100), USD2(100))); + env(offer(bob, USD2(100), MPT1(100))); + env.close(); + + // No sendMax + STPathSet pathSet; + STAmount srcAmt; + STAmount dstAmt; + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT1(-1)); + BEAST_EXPECT(srcAmt == MPT(100)); + BEAST_EXPECT(dstAmt == MPT1(100)); + if (BEAST_EXPECT( + pathSet.size() == 1 && + same(pathSet, stpath(IPE(USD2), IPE(mpt1.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT1(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include sendMax + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT1(-1), MPT(-1)); + BEAST_EXPECT(srcAmt == MPT(90)); + BEAST_EXPECT(dstAmt == MPT1(90)); + if (BEAST_EXPECT( + pathSet.size() == 1 && + same(pathSet, stpath(IPE(USD2), IPE(mpt1.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT1(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include source token + std::tie(pathSet, srcAmt, dstAmt) = + find_paths(env, carol, dan, MPT1(-1), std::nullopt, MPT.mpt()); + BEAST_EXPECT(srcAmt == MPT(80)); + BEAST_EXPECT(dstAmt == MPT1(80)); + if (BEAST_EXPECT( + pathSet.size() == 1 && + same(pathSet, stpath(IPE(USD2), IPE(mpt1.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT1(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + } + + // Cross-asset payment via offers (two steps) + // Start/End with mpt/mp2 and book steps in the middle + // offers are MPT/MPT + { + Env env = pathTestEnv(*this); + Account const gw2{"gw2"}; + env.fund(XRP(1'000), gw, gw1, gw2, alice, bob, carol, dan); + + MPTTester mpt(env, gw, {.holders = {alice, carol}, .fund = false}); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = alice}); + mpt.authorize({.account = carol}); + mpt.pay(gw, carol, 200); + + MPTTester mpt1(env, gw1, {.holders = {bob, alice}, .fund = false}); + mpt1.create({.ownerCount = 1, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + mpt1.authorize({.account = alice}); + mpt1.pay(gw1, alice, 200); + mpt1.authorize({.account = bob}); + + MPTTester mpt2(env, gw2, {.holders = {bob, dan}, .fund = false}); + mpt2.create({.ownerCount = 1, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT2 = mpt2["MPT2"]; + mpt2.authorize({.account = bob}); + mpt2.pay(gw2, bob, 200); + mpt2.authorize({.account = dan}); + + env(offer(alice, MPT(100), MPT1(100))); + env(offer(bob, MPT1(100), MPT2(100))); + env.close(); + + // No sendMax + STPathSet pathSet; + STAmount srcAmt; + STAmount dstAmt; + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT2(-1)); + BEAST_EXPECT(srcAmt == MPT(100)); + BEAST_EXPECT(dstAmt == MPT2(100)); + if (BEAST_EXPECT( + pathSet.size() == 1 && + same(pathSet, stpath(IPE(mpt1.issuanceID()), IPE(mpt2.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT2(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include sendMax + std::tie(pathSet, srcAmt, dstAmt) = find_paths(env, carol, dan, MPT2(-1), MPT(-1)); + BEAST_EXPECT(srcAmt == MPT(90)); + BEAST_EXPECT(dstAmt == MPT2(90)); + if (BEAST_EXPECT( + pathSet.size() == 1 && + same(pathSet, stpath(IPE(mpt1.issuanceID()), IPE(mpt2.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT2(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + + // Include source token + std::tie(pathSet, srcAmt, dstAmt) = + find_paths(env, carol, dan, MPT2(-1), std::nullopt, MPT.mpt()); + BEAST_EXPECT(srcAmt == MPT(80)); + BEAST_EXPECT(dstAmt == MPT2(80)); + if (BEAST_EXPECT( + pathSet.size() == 1 && + same(pathSet, stpath(IPE(mpt1.issuanceID()), IPE(mpt2.issuanceID()))))) + { + // validate a payment works with the path + env(pay(carol, dan, MPT2(10)), + path(pathSet[0]), + sendmax(MPT(10)), + txflags(tfNoRippleDirect | tfPartialPayment)); + } + } + + // verify no MPT rippling + { + Env env = pathTestEnv(*this); + Account const gw{"gw"}; + Account const gw1{"gw1"}; + Account const carol{"carol"}; + Account const bob{"bob"}; + Account const dan{"dan"}; + Account const john{"john"}; + Account const sean{"sean"}; + + env.fund(XRP(1'000'000), gw); + env.fund(XRP(1'000'000), gw1); + env.fund(XRP(1'000'000), carol); + env.fund(XRP(1'000'000), dan); + env.fund(XRP(1'000'000), bob); + env.fund(XRP(1'000'000), john); + env.fund(XRP(1'000'000), sean); + env.close(); + + MPTTester usd(env, gw, {.holders = {carol, dan}, .fund = false}); + usd.create( + {.authorize = MPTCreate::AllHolders, + .pay = {{MPTCreate::AllHolders, 100}}, + .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const USD = usd["USD"]; + env(offer(carol, XRP(100), USD(100))); + + MPTTester gbp(env, gw, {.holders = {bob, sean}, .fund = false}); + gbp.create( + {.authorize = MPTCreate::AllHolders, + .pay = {{{bob}, 100}}, + .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const GBP = gbp["GBP"]; + + MPTTester usd1(env, gw1, {.holders = {bob, dan}, .fund = false}); + usd1.create( + {.authorize = MPTCreate::AllHolders, + .pay = {{{dan}, 100}}, + .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const USD1 = usd1["USD1"]; + env(offer(bob, USD1(100), GBP(100))); + + // dan has USD/gw and USD1/gw. Had USD been IOU, it would have + // been able to ripple through dan's account. + auto const [pathSet, srcAmt, dstAmt] = find_paths(env, john, sean, GBP(-1), XRP(-1)); + BEAST_EXPECT(pathSet.empty()); + + env(pay(john, sean, GBP(10)), + sendmax(XRP(20)), + path(~USD, dan, gw1, ~GBP), + txflags(tfNoRippleDirect | tfPartialPayment), + ter(temBAD_PATH)); + } + } + + void + testCheck(FeatureBitset features) + { + testcase("Check Create/Cash"); + + using namespace test::jtx; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const carol{"carol"}; + + // MPTokensV2 is disabled + { + Env env{*this, features - featureMPTokensV2}; + + MPTTester mpt(env, gw, {.holders = {alice}}); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = alice}); + + uint256 const checkId{keylet::check(gw, env.seq(gw)).key}; + + env(check::create(gw, alice, MPT(100)), ter(temDISABLED)); + env.close(); + + env(check::cash(alice, checkId, MPT(100)), ter(temDISABLED)); + env.close(); + } + + // Insufficient funds + { + Env env{*this, features}; + Account const carol{"carol"}; + + MPTTester mpt(env, gw, {.holders = {alice, carol}}); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 50); + + uint256 const checkId{keylet::check(alice, env.seq(alice)).key}; + + // can create + env(check::create(alice, carol, MPT(100))); + env.close(); + + // can't cash since alice only has 50 of MPT + env(check::cash(carol, checkId, MPT(100)), ter(tecPATH_PARTIAL)); + env.close(); + + // can cash if DeliverMin is set + // carol is not authorized, MPToken is authorized by CheckCash + env(check::cash(carol, checkId, check::DeliverMin(MPT(50)))); + env.close(); + BEAST_EXPECT(mpt.checkMPTokenAmount(carol, 50)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(50)); + } + + // Exceed max amount + { + Env env{*this, features}; + + MPTTester mpt(env, gw, {.holders = {alice}}); + mpt.create( + {.maxAmt = 100, + .ownerCount = 1, + .holderCount = 0, + .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + uint256 const checkId{keylet::check(gw, env.seq(gw)).key}; + + // can create + env(check::create(gw, alice, MPT(200))); + env.close(); + + // can't cash since the outstanding amount exceeds max amount + env(check::cash(alice, checkId, MPT(200)), ter(tecPATH_PARTIAL)); + env.close(); + + // can cash if DeliverMin is set + env(check::cash(alice, checkId, check::DeliverMin(MPT(100)))); + env.close(); + BEAST_EXPECT(mpt.checkMPTokenAmount(alice, 100)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(100)); + } + + // MPTokenIssuance object doesn't exist + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + env(check::create(alice, carol, MPT(gw)(50)), ter(tecOBJECT_NOT_FOUND)); + env.close(); + auto BTC = MPTTester({.env = env, .issuer = gw}); + uint256 const chkId{getCheckIndex(gw, env.seq(gw))}; + env(check::cash(carol, chkId, MPT(gw)(1)), ter(tecNO_ENTRY)); + env.close(); + } + + // MPToken doesn't exist - can create check since MPToken will be + // automatically created on cash check + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + auto BTC = MPTTester({.env = env, .issuer = gw}); + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, carol, BTC(50))); + env.close(); + + // But cashing fails if alice doesn't have MPToken + env(check::cash(carol, chkId, BTC(1)), ter(tecPATH_PARTIAL)); + env.close(); + } + + // MPTLock is set + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + env.close(); + auto mpt = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .pay = 100, + .flags = MPTDEXFlags | tfMPTCanLock}); + + mpt.set({.flags = tfMPTLock}); + + // Create Check fails, holder or issuer as destination + env(check::create(alice, carol, mpt(10)), ter(tecLOCKED)); + env.close(); + env(check::create(gw, carol, mpt(10)), ter(tecLOCKED)); + env.close(); + + mpt.set({.flags = tfMPTUnlock}); + + // Create Check succeeds, holder or issuer as destination + uint256 const chkIdAlice{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, carol, mpt(10))); + env.close(); + uint256 const chkIdGw{getCheckIndex(gw, env.seq(gw))}; + env(check::create(gw, carol, mpt(10))); + env.close(); + + mpt.set({.flags = tfMPTLock}); + + // Cash Check fails, holder and issuer env(check::cash(carol, + // chkIdAlice, mpt(1)), ter(tecPATH_PARTIAL)); // tec is different + // if the source is the issuer (this is consistent with IOU) + env(check::cash(carol, chkIdGw, mpt(2)), ter(tecLOCKED)); + env.close(); + + mpt.set({.flags = tfMPTUnlock}); + + // Cash Check succeeds, holder and issuer. + env(check::cash(carol, chkIdAlice, mpt(1))); + env(check::cash(carol, chkIdGw, mpt(2))); + + // Individual lock + mpt.set({.holder = alice, .flags = tfMPTLock}); + env(check::create(alice, carol, mpt(10)), ter(tecLOCKED)); + env.close(); + env(check::create(carol, alice, mpt(10)), ter(tecLOCKED)); + env.close(); + + mpt.set({.holder = alice, .flags = tfMPTUnlock}); + uint256 const chkId1{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, carol, mpt(10))); + env.close(); + uint256 const chkId2{getCheckIndex(gw, env.seq(gw))}; + env(check::create(gw, alice, mpt(10))); + env.close(); + uint256 const chkId3{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, gw, mpt(10))); + env.close(); + uint256 const chkId4{getCheckIndex(gw, env.seq(gw))}; + env(check::create(gw, alice, mpt(10))); + env.close(); + mpt.set({.holder = alice, .flags = tfMPTLock}); + env(check::cash(carol, chkId1, mpt(1)), ter(tecPATH_PARTIAL)); + env(check::cash(alice, chkId2, mpt(1)), ter(tecLOCKED)); + env(check::cash(gw, chkId3, mpt(1)), ter(tecPATH_PARTIAL)); + env(check::cash(alice, chkId4, mpt(1)), ter(tecLOCKED)); + } + + // MPTRequireAuth flag is set and the account is not authorized. + // Can create check, which is consistent with the trustlines. + // It should fail on cash check. + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + auto BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .flags = tfMPTRequireAuth | MPTDEXFlags}); + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, carol, BTC(50))); + env.close(); + + // Authorize alice + BTC.authorize({.account = gw, .holder = alice}); + env(pay(gw, alice, BTC(100))); + + // carol is still not authorized + env(check::cash(carol, chkId, BTC(10)), ter(tecNO_AUTH)); + env.close(); + + // authorize carol, can cash now + BTC.authorize({.account = gw, .holder = carol}); + env(check::cash(carol, chkId, BTC(10))); + env.close(); + } + + // MPTCanTransfer disabled + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + env.close(); + + MPTTester mpt( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .flags = tfMPTCanTrade, + .mutableFlags = tmfMPTCanMutateCanTransfer}); + + // src is issuer + uint256 checkId{keylet::check(gw, env.seq(gw)).key}; + + // can create + env(check::create(gw, alice, mpt(100))); + env.close(); + + // can cash since source is issuer + env(check::cash(alice, checkId, mpt(100))); + env.close(); + + BEAST_EXPECT(env.balance(alice, mpt) == mpt(100)); + BEAST_EXPECT(env.balance(gw, mpt) == mpt(-100)); + + // dst is issuer + checkId = keylet::check(alice, env.seq(alice)).key; + + // can create + env(check::create(alice, gw, mpt(100))); + env.close(); + + // can cash since source is issuer + env(check::cash(gw, checkId, mpt(100))); + env.close(); + + BEAST_EXPECT(env.balance(alice, mpt) == mpt(0)); + BEAST_EXPECT(env.balance(gw, mpt) == mpt(0)); + + // neither src nor dst is issuer, can still create + checkId = keylet::check(alice, env.seq(alice)).key; + env(check::create(alice, carol, mpt(100))); + env.close(); + + // can't cash + env(check::cash(carol, checkId, mpt(10)), ter(tecPATH_PARTIAL)); + env.close(); + + // can cash now + mpt.set({.account = gw, .mutableFlags = tmfMPTSetCanTransfer}); + env(pay(gw, alice, mpt(10))); + env.close(); + env(check::cash(carol, checkId, mpt(10))); + env.close(); + } + + // MPTCanTrade disabled + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + env.close(); + + MPTTester mpt( + {.env = env, + .issuer = gw, + .holders = {alice, carol}, + .flags = tfMPTCanTransfer, + .mutableFlags = tmfMPTCanMutateCanTrade}); + + uint256 checkId{keylet::check(gw, env.seq(gw)).key}; + + // can't create + env(check::create(gw, alice, mpt(100)), ter(tecNO_PERMISSION)); + env.close(); + mpt.set({.account = gw, .mutableFlags = tmfMPTSetCanTrade}); + + // can't cash + checkId = keylet::check(gw, env.seq(gw)).key; + env(check::create(gw, carol, mpt(100))); + env.close(); + mpt.set({.account = gw, .mutableFlags = tmfMPTClearCanTrade}); + env(check::cash(carol, checkId, mpt(10)), ter(tecNO_PERMISSION)); + env.close(); + } + + // MPTokenIssuance object doesn't exist + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + auto USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, carol, USD(1))); + env.close(); + + // temMALFORMED because MPT is not USD. It doesn't matter if it + // exists or not + env(check::cash(carol, chkId, MPT(alice)(1)), ter(temMALFORMED)); + env.close(); + } + + // MPToken object doesn't exist and the account is not the issuer of MPT + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + + auto BTC = MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 1'000}); + + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + + env(check::create(alice, carol, BTC(1))); + env.close(); + + // MPToken is automatically created + env(check::cash(carol, chkId, BTC(1))); + env.close(); + } + + // MPTRequireAuth flag is set and the account is not authorized. + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + + auto BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .flags = tfMPTRequireAuth | MPTDEXFlags, + .authHolder = true}); + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + env(check::create(alice, carol, BTC(1))); + env.close(); + + env(check::cash(carol, chkId, BTC(1)), ter(tecPATH_PARTIAL)); + env.close(); + } + + // MPTCanTransfer is not set and the account is not the issuer of MPT + { + Env env{*this, features}; + env.fund(XRP(1'000), gw, alice, carol); + + auto EUR = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, carol}, .flags = tfMPTCanTrade}); + uint256 const chkId{getCheckIndex(alice, env.seq(alice))}; + // alice can create + env(check::create(alice, carol, EUR(1))); + env.close(); + + // carol can't cash + env(check::cash(carol, chkId, EUR(1)), ter(tecPATH_PARTIAL)); + env.close(); + + // if issuer creates a check then carol can cash since + // it's a transfer from the issuer + uint256 const chkId1{getCheckIndex(gw, env.seq(gw))}; + // alice can't create since CanTransfer is not set + env(check::create(gw, carol, EUR(1))); + env.close(); + + env(check::cash(carol, chkId1, EUR(1))); + env.close(); + } + + // Can create check if src/dst don't own MPT + { + Env env{*this, features}; + + MPTTester mpt(env, gw); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + + env.fund(XRP(1'000), alice, carol); + + // src is issuer + uint256 const checkId{keylet::check(alice, env.seq(alice)).key}; + + // can create + env(check::create(alice, carol, MPT(100))); + env.close(); + + // authorize/fund alice + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 100); + + // carol can cash the check. MPToken is created automatically + env(check::cash(carol, checkId, MPT(100))); + env.close(); + + BEAST_EXPECT(mpt.checkMPTokenAmount(carol, 100)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(100)); + } + + // Normal create/cash + { + Env env{*this, features}; + + MPTTester mpt(env, gw, {.holders = {alice}}); + mpt.create( + {.ownerCount = 1, .holderCount = 0, .flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = alice}); + + uint256 const checkId{keylet::check(gw, env.seq(gw)).key}; + + env(check::create(gw, alice, MPT(100))); + env.close(); + + env(check::cash(alice, checkId, MPT(100))); + env.close(); + + BEAST_EXPECT(mpt.checkMPTokenAmount(alice, 100)); + BEAST_EXPECT(mpt.checkMPTokenOutstandingAmount(100)); + } + } + + void + testAMMClawback(FeatureBitset features) + { + using namespace jtx; + testcase("AMMClawback"); + Account const gw{"gw"}; + Account const alice{"alice"}; + auto const USD = gw["USD"]; + + // MPTokenIssuance object doesn't exist + { + Env env(*this, features); + env.fund(XRP(1'000), gw, alice); + MPTTester const BTC({.env = env, .issuer = gw}); + AMM const amm(env, gw, BTC(100), USD(100)); + env(amm::ammClawback(gw, alice, USD, MPT(alice), std::nullopt), ter(terNO_AMM)); + env(amm::ammClawback(gw, alice, USD, BTC, MPT(alice)(100)), ter(temBAD_AMOUNT)); + } + + // MPTLock flag is set and the account is not the issuer of MPT - + // can still clawback since the issuer clawbacks + { + Env env(*this, features); + env.fund(XRP(100'000), gw, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanLock | tfMPTCanClawback | MPTDEXFlags}); + + env.trust(USD(10'000), alice); + env(pay(gw, alice, USD(10'000))); + env.close(); + + AMM amm(env, gw, BTC(100), USD(100)); + env.close(); + amm.deposit(alice, 1'000); + env.close(); + + BTC.set({.flags = tfMPTLock}); + + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt)); + } + + // MPTRequireAuth flag is set and the account is not authorized - + // can still clawback since the issuer clawbacks + { + Env env(*this, features); + env.fund(XRP(100'000), gw, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTRequireAuth | tfMPTCanClawback | MPTDEXFlags, + .authHolder = true}); + + env.trust(USD(10'000), alice); + env(pay(gw, alice, USD(10'000))); + env.close(); + + AMM amm(env, gw, BTC(100), USD(100)); + env.close(); + amm.deposit(alice, 1'000); + env.close(); + + BTC.authorize({.account = gw, .holder = alice, .flags = tfMPTUnauthorize}); + + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt)); + } + + // MPTCanTransfer is not set and the account is not the issuer of MPT - + // can't clawback since a holder can't deposit + { + Env env(*this, features); + env.fund(XRP(100'000), gw, alice); + env.close(); + + env(fset(gw, asfAllowTrustLineClawback)); + env.close(); + + auto BTC = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 40'000, + .flags = tfMPTCanClawback | tfMPTCanTrade, + .authHolder = true}); + + env.trust(USD(10'000), alice); + env(pay(gw, alice, USD(10'000))); + env.close(); + + AMM amm(env, gw, BTC(100), USD(100)); + env.close(); + // alice can't deposit since MPTCanTransfer is not set + amm.deposit( + DepositArg{.account = alice, .tokens = 1'000, .err = ter(tecNO_PERMISSION)}); + env.close(); + + // can't clawback since alice is not an LP + env(amm::ammClawback(gw, alice, BTC, USD, std::nullopt), ter(tecAMM_BALANCE)); + } + + { + Env env(*this, features); + fund(env, gw, {alice}, XRP(1'000), {USD(1'000)}); + MPTTester mpt(env, gw, {.fund = false}); + mpt.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + AMM amm(env, gw, MPT(100), XRP(100)); + amm.deposit(DepositArg{.account = alice, .asset1In = XRP(10)}); + amm::ammClawback(gw, alice, MPTIssue(mpt.issuanceID()), xrpIssue(), MPT(10)); + } + + { + Env env(*this, features); + fund(env, gw, {alice}, XRP(1'000), {USD(1'000)}); + MPTTester mpt(env, gw, {.fund = false}); + mpt.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + mpt.authorize({.account = alice}); + mpt.pay(gw, alice, 1'000); + auto const MPT = mpt["MPT"]; + AMM amm(env, gw, MPT(100), XRP(100)); + amm.deposit(DepositArg{.account = alice, .tokens = 10'000}); + amm::ammClawback(gw, alice, MPTIssue(mpt.issuanceID()), xrpIssue(), MPT(10)); + } + + // clawback one asset from MPT/MPT AMM. MPToken for another asset + // is created for the Liquidity Provider + { + Env env(*this, features); + env.fund(XRP(1'000), gw, alice); + auto USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice}, + .pay = 10'000, + .flags = tfMPTCanClawback | MPTDEXFlags}); + auto EUR = + MPTTester({.env = env, .issuer = gw, .flags = tfMPTCanClawback | MPTDEXFlags}); + AMM amm(env, gw, USD(1'000), EUR(1'000)); + amm.deposit({.account = alice, .asset1In = USD(1'000)}); + // MPToken doesn't exist + BEAST_EXPECT(env.le(keylet::mptoken(EUR.issuanceID(), alice)) == nullptr); + env(amm::ammClawback(gw, alice, USD, EUR, USD(100))); + // MPToken is created + BEAST_EXPECT(env.le(keylet::mptoken(EUR.issuanceID(), alice))); + } + } + + void + testBasicAMM(FeatureBitset features) + { + testcase("Basic AMM"); + using namespace jtx; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const carol{"carol"}; + Account const bob{"bob"}; + auto const USD = gw["USD"]; + + // Create/deposit/withdraw + { + Env env{*this}; + + fund(env, gw, {alice, carol, bob}, XRP(1'000), {USD(1'000)}); + + MPTTester mpt(env, gw, {.fund = false}); + mpt.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + mpt.authorize({.account = alice}); + mpt.authorize({.account = carol}); + mpt.pay(gw, alice, 1'000); + mpt.pay(gw, carol, 1'000); + + MPTTester mpt1(env, gw, {.fund = false}); + mpt1.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT1 = mpt1["MPT1"]; + mpt1.authorize({.account = alice}); + mpt1.authorize({.account = carol}); + mpt1.pay(gw, alice, 1'000); + mpt1.pay(gw, carol, 1'000); + + std::vector> pools = { + {XRP(100), MPT(100), IOUAmount{100'000}}, + {USD(100), MPT(100), IOUAmount{100}}, + {MPT(100), MPT1(100), IOUAmount{100}}}; + for (auto& pool : pools) + { + AMM amm(env, gw, std::get<0>(pool), std::get<1>(pool)); + amm.deposit(alice, std::get<2>(pool)); + amm.deposit(carol, std::get<2>(pool)); + // bob doesn't own MPT + amm.deposit( + DepositArg{ + .account = bob, .tokens = std::get<2>(pool), .err = ter(tecNO_AUTH)}); + amm.withdrawAll(alice); + amm.withdrawAll(carol); + amm.withdrawAll(gw); + BEAST_EXPECT(!amm.ammExists()); + } + } + + // Payment, one step + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}}); + MPT const EUR = MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}}); + + env(pay(gw, alice, EUR(100))); + + AMM const amm(env, gw, USD(1'100), EUR(1'000)); + + env(pay(alice, carol, USD(100)), sendmax(EUR(100))); + + BEAST_EXPECT(amm.expectBalances(USD(1'000), EUR(1'100), amm.tokens())); + BEAST_EXPECT(env.balance(carol, USD) == USD(100)); + BEAST_EXPECT(env.balance(alice, EUR) == EUR(0)); + } + + // Payment, two steps + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice, carol); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}}); + MPT const EUR = MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}}); + MPT const BTC = MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}}); + env(pay(gw, alice, EUR(100))); + + AMM const ammEUR_USD(env, gw, EUR(1'000), USD(1'100)); + AMM const ammUSD_BTC(env, gw, USD(1'000), BTC(1'100)); + + env(pay(alice, carol, BTC(100)), + sendmax(EUR(100)), + path(~USD, ~BTC), + txflags(tfNoRippleDirect)); + + BEAST_EXPECT(ammEUR_USD.expectBalances(USD(1'000), EUR(1'100), ammEUR_USD.tokens())); + BEAST_EXPECT(ammUSD_BTC.expectBalances(USD(1'100), BTC(1'000), ammUSD_BTC.tokens())); + BEAST_EXPECT(env.balance(carol, BTC) == BTC(100)); + BEAST_EXPECT(env.balance(alice, EUR) == EUR(0)); + } + + // Offer crossing + { + Env env(*this); + + env.fund(XRP(1'000), gw, alice); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + MPT const EUR = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + env(pay(gw, alice, EUR(1'000))); + + AMM const amm(env, gw, EUR(1'000'000), USD(1'001'000)); + + env(offer(alice, USD(1'000), EUR(1'000))); + + BEAST_EXPECT(amm.expectBalances(USD(1'000'000), EUR(1'001'000), amm.tokens())); + BEAST_EXPECT(env.balance(alice, USD) == USD(1'000)); + BEAST_EXPECT(env.balance(alice, EUR) == EUR(0)); + } + + { + Env env(*this); + env.fund(XRP(1'000'000), gw, alice, carol); + + auto USD = MPTTester( + {.env = env, + .issuer = gw, + .flags = tfMPTCanLock | MPTDEXFlags, + .mutableFlags = tmfMPTCanMutateRequireAuth | tmfMPTCanMutateCanTransfer | + tmfMPTCanMutateCanClawback | tmfMPTCanMutateCanTrade}); + auto EUR = MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 1'000'000}); + + auto const increment = env.current()->fees().increment; + auto const txfee = fee(drops(increment)); + auto const badMPT = MPT(gw, 1'000); + + auto createDeleteAMM = [&](Account const& lp) { + AMM amm( + env, + lp, + USD(1'000), + EUR(1'000), + CreateArg{.fee = static_cast(increment.value())}); + amm.withdrawAll(lp); + BEAST_EXPECT(!amm.ammExists()); + }; + + // + // AMMCreate + // + + auto createJv = AMM::createJv(alice, badMPT(1'000), EUR(1'000), 0); + + auto createFail = [&](Account const& account, auto const& err) { + createJv[sfAccount] = account.human(); + env(createJv, txfee, ter(err)); + env.close(); + }; + + // MPTokenIssuance doesn't exist + + createFail(alice, tecOBJECT_NOT_FOUND); + + // MPToken doesn't exist + + createJv[sfAmount] = STAmount{USD(1'000)}.getJson(); + createFail(alice, tecNO_AUTH); + + // alice authorizes MPToken, can create + USD.authorize({.account = alice}); + env(pay(gw, alice, USD(1'000'000)), txfee); + env.close(); + createDeleteAMM(alice); + + // MPTLock is set + + // alice and issuer can't create + USD.set({.flags = tfMPTLock}); + createFail(alice, tecFROZEN); + createFail(gw, tecFROZEN); + + // MPTRequireAuth is set + + // alice is not authorized + USD.set({.flags = tfMPTUnlock}); + USD.set({.mutableFlags = tmfMPTSetRequireAuth}); + createFail(alice, tecNO_AUTH); + // issuer can create + createDeleteAMM(gw); + + // alice is authorized, can create + USD.authorize({.account = gw, .holder = alice}); + createDeleteAMM(alice); + + // MPTCanTransfer is not set + + USD.set({.mutableFlags = tmfMPTClearRequireAuth}); + USD.set({.mutableFlags = tmfMPTClearCanTransfer}); + // alice can't create + createFail(alice, tecNO_PERMISSION); + // issuer can create + createDeleteAMM(gw); + USD.set({.mutableFlags = tmfMPTSetCanTransfer}); + // alice can create + createDeleteAMM(alice); + + // MPTCanTrade is not set + + USD.set({.mutableFlags = tmfMPTSetCanTransfer}); + USD.set({.mutableFlags = tmfMPTClearCanTrade}); + // alice and issuer can't create + createFail(alice, tecNO_PERMISSION); + createFail(gw, tecNO_PERMISSION); + USD.set({.mutableFlags = tmfMPTSetCanTrade}); + + // + // AMMDeposit + // + + AMM amm(env, gw, USD(1'000), EUR(1'000)); + + // MPTokenIssuance doesn't exist + + amm.deposit( + {.account = alice, + .asset1In = badMPT(1), + .asset2In = EUR(1), + .assets = std::make_pair(badMPT, EUR), + .err = ter(terNO_AMM)}); + + // MPToken doesn't exist + + amm.deposit( + {.account = carol, .asset1In = USD(1), .asset2In = EUR(1), .err = ter(tecNO_AUTH)}); + + // MPTLock is set + + USD.set({.flags = tfMPTLock}); + // alice and issuer can't deposit + for (auto const& account : {carol, gw}) + { + amm.deposit( + {.account = account, + .asset1In = USD(1), + .asset2In = EUR(1), + .err = ter(tecFROZEN)}); + amm.deposit( + {.account = account, + .asset1In = EUR(1), + .assets = std::make_pair(EUR, USD), + .err = ter(tecFROZEN)}); + } + USD.set({.flags = tfMPTUnlock}); + + // MPTRequireAuth is set + + // carol authorizes MPToken but is not authorized by the issuer + USD.authorize({.account = carol}); + env(pay(gw, carol, USD(1'000'000))); + // carol authorizes EUR + EUR.authorize({.account = carol}); + env(pay(gw, carol, EUR(1'000'000))); + USD.set({.mutableFlags = tmfMPTSetRequireAuth}); + // have to authorize amm account + USD.authorize({.account = gw, .holder = Account{"amm", amm.ammAccount()}}); + env.close(); + amm.deposit( + {.account = carol, .asset1In = USD(1), .asset2In = EUR(1), .err = ter(tecNO_AUTH)}); + amm.deposit( + {.account = carol, + .asset1In = EUR(1), + .assets = std::make_pair(EUR, USD), + .err = ter(tecNO_AUTH)}); + // issuer can deposit + amm.deposit({.account = gw, .tokens = 1'000}); + // carol is authorized, can deposit + USD.authorize({.account = gw, .holder = carol}); + amm.deposit({.account = carol, .tokens = 1'000}); + + // MPTCanTransfer is not set + + USD.set({.mutableFlags = tmfMPTClearRequireAuth}); + USD.set({.mutableFlags = tmfMPTClearCanTransfer}); + // carol can't deposit + amm.deposit( + {.account = carol, + .asset1In = USD(1), + .asset2In = EUR(1), + .err = ter(tecNO_PERMISSION)}); + amm.deposit( + {.account = carol, + .asset1In = EUR(1), + .assets = std::make_pair(EUR, USD), + .err = ter(tecNO_PERMISSION)}); + // issuer can deposit + amm.deposit({.account = gw, .tokens = 1'000}); + // carol can deposit + USD.set({.mutableFlags = tmfMPTSetCanTransfer}); + amm.deposit({.account = carol, .tokens = 1'000}); + + // MPTCanTrade is not set + + USD.set({.mutableFlags = tmfMPTSetCanTransfer}); + USD.set({.mutableFlags = tmfMPTClearCanTrade}); + amm.deposit({.account = gw, .tokens = 1'000, .err = ter(tecNO_PERMISSION)}); + amm.deposit({.account = carol, .tokens = 1'000, .err = ter(tecNO_PERMISSION)}); + USD.set({.mutableFlags = tmfMPTSetCanTrade}); + + // + // AMMWithdraw + // + + // MPTokenIssuance doesn't exist + + amm.withdraw( + WithdrawArg{ + .account = carol, + .asset1Out = badMPT(1), + .asset2Out = EUR(1), + .assets = std::make_pair(badMPT, EUR), + .err = ter(terNO_AMM)}); + + // MPToken doesn't exist - doesn't apply since MPToken is created + // on withdraw in this case + + // MPTLock is set + + USD.set({.flags = tfMPTLock}); + // carol and issuer can't withdraw + for (auto const& account : {carol, gw}) + { + amm.withdraw( + {.account = account, + .asset1Out = USD(1), + .asset2Out = EUR(1), + .err = ter(tecFROZEN)}); + amm.withdraw({.account = account, .tokens = 1'000, .err = ter(tecFROZEN)}); + // can single withdraw another asset + amm.withdraw( + {.account = account, .asset1Out = EUR(1), .assets = std::make_pair(EUR, USD)}); + } + USD.set({.flags = tfMPTUnlock}); + + // MPTRequireAuth is set + + USD.set({.mutableFlags = tmfMPTSetRequireAuth}); + USD.authorize({.account = gw, .holder = carol, .flags = tfMPTUnauthorize}); + // carol can't withdraw + amm.withdraw( + {.account = carol, + .asset1Out = USD(1), + .asset2Out = EUR(1), + .err = ter(tecNO_AUTH)}); + // can withdraw another asset + amm.withdraw( + {.account = carol, .asset1Out = EUR(1), .assets = std::make_pair(EUR, USD)}); + // issuer can withdraw + amm.withdraw({.account = gw, .asset1Out = USD(1), .asset2Out = EUR(1)}); + // carol is authorized, can withdraw + USD.authorize({.account = gw, .holder = carol}); + amm.withdraw({.account = carol, .asset1Out = USD(1), .asset2Out = EUR(1)}); + + // MPTCanTransfer is set + + USD.set({.mutableFlags = tmfMPTClearRequireAuth}); + USD.set({.mutableFlags = tmfMPTClearCanTransfer}); + // carol can't withdraw + amm.withdraw( + {.account = carol, + .asset1Out = USD(1), + .asset2Out = EUR(1), + .err = ter(tecNO_PERMISSION)}); + // can withdraw another asset + amm.withdraw( + {.account = carol, .asset1Out = EUR(1), .assets = std::make_pair(EUR, USD)}); + // issuer can withdraw + amm.withdraw({.account = gw, .asset1Out = USD(1), .asset2Out = EUR(1)}); + // carol can withdraw + USD.set({.mutableFlags = tmfMPTSetCanTransfer}); + amm.withdraw({.account = carol, .asset1Out = USD(1), .asset2Out = EUR(1)}); + + USD.set({.mutableFlags = tmfMPTSetCanTransfer}); + USD.set({.mutableFlags = tmfMPTClearCanTrade}); + amm.withdraw({.account = gw, .tokens = 1'000, .err = ter(tecNO_PERMISSION)}); + amm.withdraw({.account = carol, .tokens = 1'000, .err = ter(tecNO_PERMISSION)}); + USD.set({.mutableFlags = tmfMPTSetCanTrade}); + + // MPToken created on withdraw + + // redeem all carol's USD and unauthorize USD + amm.withdrawAll(carol); + env(pay(carol, gw, env.balance(carol, USD))); + USD.authorize({.account = carol, .flags = tfMPTUnauthorize}); + BEAST_EXPECT(env.le(keylet::mptoken(USD.issuanceID(), carol)) == nullptr); + // single-deposit EUR + amm.deposit( + {.account = carol, .asset1In = EUR(1'000), .assets = std::make_pair(EUR, USD)}); + // withdraw in USD to create MPToken + amm.withdraw({.account = carol, .asset1Out = USD(100)}); + BEAST_EXPECT(env.le(keylet::mptoken(USD.issuanceID(), carol))); + } + } + public: void run() override @@ -3279,6 +6709,7 @@ public: using namespace test::jtx; FeatureBitset const all{testable_amendments()}; + testMultiSendMaximumAmount(all); // MPTokenIssuanceCreate testCreateValidation(all - featureSingleAssetVault); testCreateValidation(all - featurePermissionedDomains); @@ -3288,15 +6719,27 @@ public: // MPTokenIssuanceDestroy testDestroyValidation(all - featureSingleAssetVault); - testDestroyValidation(all); + testDestroyValidation(all - featureSingleAssetVault - featureMPTokensV2); + testDestroyValidation((all | featureSingleAssetVault) - featureMPTokensV2); + testDestroyValidation(all - featureMPTokensV2); + testDestroyValidation(all | featureSingleAssetVault); testDestroyEnabled(all - featureSingleAssetVault); - testDestroyEnabled(all); + testDestroyEnabled(all - featureSingleAssetVault - featureMPTokensV2); + testDestroyEnabled((all | featureSingleAssetVault) - featureMPTokensV2); + testDestroyEnabled(all - featureMPTokensV2); + testDestroyEnabled(all | featureSingleAssetVault); // MPTokenAuthorize testAuthorizeValidation(all - featureSingleAssetVault); - testAuthorizeValidation(all); + testAuthorizeValidation(all - featureSingleAssetVault - featureMPTokensV2); + testAuthorizeValidation((all | featureSingleAssetVault) - featureMPTokensV2); + testAuthorizeValidation(all - featureMPTokensV2); + testAuthorizeValidation(all | featureSingleAssetVault); testAuthorizeEnabled(all - featureSingleAssetVault); - testAuthorizeEnabled(all); + testAuthorizeEnabled(all - featureSingleAssetVault - featureMPTokensV2); + testAuthorizeEnabled((all | featureSingleAssetVault) - featureMPTokensV2); + testAuthorizeEnabled(all - featureMPTokensV2); + testAuthorizeEnabled(all | featureSingleAssetVault); // MPTokenIssuanceSet testSetValidation(all - featureSingleAssetVault - featureDynamicMPT); @@ -3310,12 +6753,20 @@ public: // MPT clawback testClawbackValidation(all); + testClawbackValidation(all - featureMPTokensV2); testClawback(all); + testClawback(all - featureMPTokensV2); // Test Direct Payment testPayment(all); + testPayment(all | featureSingleAssetVault); + testPayment((all | featureSingleAssetVault) - featureMPTokensV2); + testPayment(all - featureMPTokensV2); + testDepositPreauth(all); testDepositPreauth(all - featureCredentials); + testDepositPreauth(all - featureMPTokensV2); + testDepositPreauth(all - featureCredentials - featureMPTokensV2); // Test MPT Amount is invalid in Tx, which don't support MPT testMPTInvalidInTx(all); @@ -3337,7 +6788,26 @@ public: testMutateRequireAuth(all); testMutateCanEscrow(all); testMutateCanTransfer(all); + testMutateCanTransfer(all - featureMPTokensV2); testMutateCanClawback(all); + + // Test offer crossing + testOfferCrossing(all); + + // Test cross asset payment + testCrossAssetPayment(all); + + // Test path finding + testPath(all); + + // Test checks + testCheck(all); + + // Add AMMClawback + testAMMClawback(all); + + // Test AMM + testBasicAMM(all); } }; diff --git a/src/test/app/Manifest_test.cpp b/src/test/app/Manifest_test.cpp index 92a10ef7fa..b64a7f78f3 100644 --- a/src/test/app/Manifest_test.cpp +++ b/src/test/app/Manifest_test.cpp @@ -1,20 +1,41 @@ -#include +#include #include #include +#include #include #include -#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include -#include +#include #include #include -#include -#include -#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -249,8 +270,9 @@ public: { // save should store all trusted master keys to db std::vector s1; - std::vector keys; + std::vector const keys; s1.reserve(inManifests.size()); + for (auto const& man : inManifests) s1.push_back(toBase58(TokenType::NodePublic, man->masterKey)); unl->load({}, s1, keys); @@ -602,12 +624,12 @@ public: BEAST_EXPECT(!deserializeManifest(toString(st))); } { // invalid manifest (domain too long) - std::string s(254, 'a'); + std::string const s(254, 'a'); auto const st = buildManifestObject(++sequence, s + ".example.com"); BEAST_EXPECT(!deserializeManifest(toString(st))); } { // invalid manifest (domain component too long) - std::string s(72, 'a'); + std::string const s(72, 'a'); auto const st = buildManifestObject(++sequence, s + ".example.com"); BEAST_EXPECT(!deserializeManifest(toString(st))); } diff --git a/src/test/app/MultiSign_test.cpp b/src/test/app/MultiSign_test.cpp index f96bfba2d2..c27d9b642c 100644 --- a/src/test/app/MultiSign_test.cpp +++ b/src/test/app/MultiSign_test.cpp @@ -1,10 +1,50 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -63,7 +103,7 @@ public: { // Attach a signer list to alice. Should fail. - Json::Value signersList = signers(alice, 1, {{bogie, 1}}); + Json::Value const signersList = signers(alice, 1, {{bogie, 1}}); env(signersList, ter(tecINSUFFICIENT_RESERVE)); env.close(); env.require(owners(alice, 0)); @@ -81,7 +121,7 @@ public: env(pay(env.master, alice, fee - drops(1))); // Replace with the biggest possible signer list. Should fail. - Json::Value bigSigners = signers( + Json::Value const bigSigners = signers( alice, 1, {{bogie, 1}, @@ -163,25 +203,20 @@ public: {spook, 1}}), ter(temBAD_QUORUM)); - // clang-format off // Make a signer list that's too big. Should fail. Account const spare("spare", KeyType::secp256k1); env(signers( alice, 1, - std::vector{{bogie, 1}, {demon, 1}, {ghost, 1}, - {haunt, 1}, {jinni, 1}, {phase, 1}, - {shade, 1}, {spook, 1}, {spare, 1}, - {acc10, 1}, {acc11, 1}, {acc12, 1}, - {acc13, 1}, {acc14, 1}, {acc15, 1}, - {acc16, 1}, {acc17, 1}, {acc18, 1}, - {acc19, 1}, {acc20, 1}, {acc21, 1}, - {acc22, 1}, {acc23, 1}, {acc24, 1}, - {acc25, 1}, {acc26, 1}, {acc27, 1}, - {acc28, 1}, {acc29, 1}, {acc30, 1}, - {acc31, 1}, {acc32, 1}, {acc33, 1}}), + std::vector{ + {bogie, 1}, {demon, 1}, {ghost, 1}, {haunt, 1}, {jinni, 1}, {phase, 1}, + {shade, 1}, {spook, 1}, {spare, 1}, {acc10, 1}, {acc11, 1}, {acc12, 1}, + {acc13, 1}, {acc14, 1}, {acc15, 1}, {acc16, 1}, {acc17, 1}, {acc18, 1}, + {acc19, 1}, {acc20, 1}, {acc21, 1}, {acc22, 1}, {acc23, 1}, {acc24, 1}, + {acc25, 1}, {acc26, 1}, {acc27, 1}, {acc28, 1}, {acc29, 1}, {acc30, 1}, + {acc31, 1}, {acc32, 1}, {acc33, 1}, + }), ter(temMALFORMED)); - // clang-format on env.close(); env.require(owners(alice, 0)); } @@ -1017,7 +1052,7 @@ public: auto const baseFee = env.current()->fees().base; { // Single-sign, but leave an empty SigningPubKey. - JTx tx = env.jt(noop(alice), sig(alice)); + JTx const tx = env.jt(noop(alice), sig(alice)); STTx local = *(tx.stx); local.setFieldVL(sfSigningPubKey, Blob()); // Empty SigningPubKey auto const info = submitSTTx(local); @@ -1027,7 +1062,7 @@ public: } { // Single-sign, but invalidate the signature. - JTx tx = env.jt(noop(alice), sig(alice)); + JTx const tx = env.jt(noop(alice), sig(alice)); STTx local = *(tx.stx); // Flip some bits in the signature. auto badSig = local.getFieldVL(sfTxnSignature); @@ -1041,7 +1076,7 @@ public: } { // Single-sign, but invalidate the sequence number. - JTx tx = env.jt(noop(alice), sig(alice)); + JTx const tx = env.jt(noop(alice), sig(alice)); STTx local = *(tx.stx); // Flip some bits in the signature. auto seq = local.getFieldU32(sfSequence); @@ -1054,7 +1089,7 @@ public: } { // Multisign, but leave a nonempty sfSigningPubKey. - JTx tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); + JTx const tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); STTx local = *(tx.stx); local[sfSigningPubKey] = alice.pk(); // Insert sfSigningPubKey auto const info = submitSTTx(local); @@ -1064,7 +1099,7 @@ public: } { // Both multi- and single-sign with an empty SigningPubKey. - JTx tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); + JTx const tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); STTx local = *(tx.stx); local.sign(alice.pk(), alice.sk()); local.setFieldVL(sfSigningPubKey, Blob()); // Empty SigningPubKey @@ -1075,7 +1110,7 @@ public: } { // Multisign but invalidate one of the signatures. - JTx tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); + JTx const tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); STTx local = *(tx.stx); // Flip some bits in the signature. auto& signer = local.peekFieldArray(sfSigners).back(); @@ -1090,7 +1125,7 @@ public: } { // Multisign with an empty signers array should fail. - JTx tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); + JTx const tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie)); STTx local = *(tx.stx); local.peekFieldArray(sfSigners).clear(); // Empty Signers array. auto const info = submitSTTx(local); @@ -1099,7 +1134,7 @@ public: "fails local checks: Invalid Signers array size."); } { - JTx tx = env.jt( + JTx const tx = env.jt( noop(alice), fee(2 * baseFee), @@ -1137,7 +1172,7 @@ public: bogie, bogie, bogie)); - STTx local = *(tx.stx); + STTx const local = *(tx.stx); auto const info = submitSTTx(local); BEAST_EXPECT( info[jss::result][jss::error_exception] == @@ -1145,8 +1180,8 @@ public: } { // The account owner may not multisign for themselves. - JTx tx = env.jt(noop(alice), fee(2 * baseFee), msig(alice)); - STTx local = *(tx.stx); + JTx const tx = env.jt(noop(alice), fee(2 * baseFee), msig(alice)); + STTx const local = *(tx.stx); auto const info = submitSTTx(local); BEAST_EXPECT( info[jss::result][jss::error_exception] == @@ -1154,8 +1189,8 @@ public: } { // No duplicate multisignatures allowed. - JTx tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie, bogie)); - STTx local = *(tx.stx); + JTx const tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie, bogie)); + STTx const local = *(tx.stx); auto const info = submitSTTx(local); BEAST_EXPECT( info[jss::result][jss::error_exception] == @@ -1163,7 +1198,7 @@ public: } { // Multisignatures must be submitted in sorted order. - JTx tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie, demon)); + JTx const tx = env.jt(noop(alice), fee(2 * baseFee), msig(bogie, demon)); STTx local = *(tx.stx); // Unsort the Signers array. auto& signers = local.peekFieldArray(sfSigners); diff --git a/src/test/app/NFTokenAuth_test.cpp b/src/test/app/NFTokenAuth_test.cpp index 551882b51a..2542f2eb36 100644 --- a/src/test/app/NFTokenAuth_test.cpp +++ b/src/test/app/NFTokenAuth_test.cpp @@ -1,6 +1,31 @@ -#include -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include namespace xrpl { @@ -33,9 +58,9 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -86,9 +111,9 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -132,9 +157,9 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -190,9 +215,9 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -265,9 +290,9 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2); @@ -307,10 +332,10 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; - Account broker{"broker"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const broker{"broker"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2, broker); @@ -373,10 +398,10 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; - Account broker{"broker"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const broker{"broker"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2, broker); @@ -433,10 +458,10 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account A1{"A1"}; - Account A2{"A2"}; - Account broker{"broker"}; + Account const G1{"G1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const broker{"broker"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, A1, A2, broker); @@ -507,10 +532,10 @@ public: using namespace test::jtx; Env env(*this, features); - Account G1{"G1"}; - Account minter{"minter"}; - Account A1{"A1"}; - Account A2{"A2"}; + Account const G1{"G1"}; + Account const minter{"minter"}; + Account const A1{"A1"}; + Account const A2{"A2"}; auto const USD{G1["USD"]}; env.fund(XRP(10000), G1, minter, A1, A2); diff --git a/src/test/app/NFTokenBurn_test.cpp b/src/test/app/NFTokenBurn_test.cpp index b91b245a7f..69123649ce 100644 --- a/src/test/app/NFTokenBurn_test.cpp +++ b/src/test/app/NFTokenBurn_test.cpp @@ -1,10 +1,44 @@ -#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include #include +#include namespace xrpl { @@ -85,7 +119,7 @@ class NFTokenBurn_test : public beast::unit_test::suite if (state[i].isMember(sfNFTokens.jsonName) && state[i][sfNFTokens.jsonName].isArray()) { - std::uint32_t tokenCount = state[i][sfNFTokens.jsonName].size(); + std::uint32_t const tokenCount = state[i][sfNFTokens.jsonName].size(); std::cout << tokenCount << " NFtokens in page " << state[i][jss::index].asString() << std::endl; @@ -201,7 +235,7 @@ class NFTokenBurn_test : public beast::unit_test::suite { // We do the same work on alice and minter, so make a lambda. auto xferNFT = [&env, &becky](AcctStat& acct, auto& iter) { - uint256 offerIndex = keylet::nftoffer(acct.acct, env.seq(acct.acct)).key; + uint256 const offerIndex = keylet::nftoffer(acct.acct, env.seq(acct.acct)).key; env(token::createOffer(acct, *iter, XRP(0)), txflags(tfSellNFToken)); env.close(); env(token::acceptSellOffer(becky, offerIndex)); @@ -225,7 +259,7 @@ class NFTokenBurn_test : public beast::unit_test::suite // Next we'll create offers for all of those NFTs. This calls for // another lambda. auto addOffers = [&env](AcctStat& owner, AcctStat& other1, AcctStat& other2) { - for (uint256 nft : owner.nfts) + for (uint256 const nft : owner.nfts) { // Create sell offers for owner. env(token::createOffer(owner, nft, drops(1)), @@ -277,7 +311,7 @@ class NFTokenBurn_test : public beast::unit_test::suite // Decide which of the accounts should burn the nft. If the // owner is becky then any of the three accounts can burn. // Otherwise either alice or minter can burn. - AcctStat& burner = [&]() -> AcctStat& { + AcctStat const& burner = [&]() -> AcctStat& { if (owner.acct == becky.acct) return *(stats[acctDist(engine)]); return mintDist(engine) ? alice : minter; @@ -398,7 +432,7 @@ class NFTokenBurn_test : public beast::unit_test::suite // Generate three packed pages. Then burn the tokens in order from // first to last. This exercises specific cases where coalescing // pages is not possible. - std::vector nfts = genPackedTokens(); + std::vector const nfts = genPackedTokens(); BEAST_EXPECT(nftCount(env, alice) == 96); BEAST_EXPECT(ownerCount(env, alice) == 3); @@ -736,9 +770,9 @@ class NFTokenBurn_test : public beast::unit_test::suite // Create an ApplyContext we can use to run the invariant // checks. These variables must outlive the ApplyContext. OpenView ov{*env.current()}; - STTx tx{ttACCOUNT_SET, [](STObject&) {}}; + STTx const tx{ttACCOUNT_SET, [](STObject&) {}}; test::StreamSink sink{beast::severities::kWarning}; - beast::Journal jlog{sink}; + beast::Journal const jlog{sink}; ApplyContext ac{ env.app(), ov, tx, tesSUCCESS, env.current()->fees().base, tapNONE, jlog}; @@ -769,9 +803,9 @@ class NFTokenBurn_test : public beast::unit_test::suite // Create an ApplyContext we can use to run the invariant // checks. These variables must outlive the ApplyContext. OpenView ov{*env.current()}; - STTx tx{ttACCOUNT_SET, [](STObject&) {}}; + STTx const tx{ttACCOUNT_SET, [](STObject&) {}}; test::StreamSink sink{beast::severities::kWarning}; - beast::Journal jlog{sink}; + beast::Journal const jlog{sink}; ApplyContext ac{ env.app(), ov, tx, tesSUCCESS, env.current()->fees().base, tapNONE, jlog}; @@ -1114,7 +1148,7 @@ class NFTokenBurn_test : public beast::unit_test::suite env.close(); // minter sells the last 32 NFTs back to alice. - for (uint256 nftID : last32NFTs) + for (uint256 const nftID : last32NFTs) { // minter creates an offer for the NFToken. uint256 const minterOfferIndex = keylet::nftoffer(minter, env.seq(minter)).key; diff --git a/src/test/app/NFTokenDir_test.cpp b/src/test/app/NFTokenDir_test.cpp index 70514f497f..d731b9c2c6 100644 --- a/src/test/app/NFTokenDir_test.cpp +++ b/src/test/app/NFTokenDir_test.cpp @@ -1,11 +1,38 @@ -#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include + +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include #include -#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include namespace xrpl { @@ -46,7 +73,7 @@ class NFTokenDir_test : public beast::unit_test::suite if (state[i].isMember(sfNFTokens.jsonName) && state[i][sfNFTokens.jsonName].isArray()) { - std::uint32_t tokenCount = state[i][sfNFTokens.jsonName].size(); + std::uint32_t const tokenCount = state[i][sfNFTokens.jsonName].size(); std::cout << tokenCount << " NFtokens in page " << state[i][jss::index].asString() << std::endl; @@ -104,7 +131,7 @@ class NFTokenDir_test : public beast::unit_test::suite nftIDs.reserve(nftCount); for (int i = 0; i < nftCount; ++i) { - std::uint32_t taxon = toUInt32(nft::cipheredTaxon(i, nft::toTaxon(0))); + std::uint32_t const taxon = toUInt32(nft::cipheredTaxon(i, nft::toTaxon(0))); nftIDs.emplace_back(token::getNextID(env, issuer, taxon, tfTransferable)); env(token::mint(issuer, taxon), txflags(tfTransferable)); env.close(); @@ -160,7 +187,7 @@ class NFTokenDir_test : public beast::unit_test::suite // Create accounts for all of the seeds and fund those accounts. std::vector accounts; accounts.reserve(seeds.size()); - for (std::string_view seed : seeds) + for (std::string_view const seed : seeds) { Account const& account = accounts.emplace_back(Account::base58Seed, std::string(seed)); @@ -364,7 +391,7 @@ class NFTokenDir_test : public beast::unit_test::suite // Create accounts for all of the seeds and fund those accounts. std::vector accounts; accounts.reserve(seeds.size()); - for (std::string_view seed : seeds) + for (std::string_view const seed : seeds) { Account const& account = accounts.emplace_back(Account::base58Seed, std::string(seed)); @@ -595,7 +622,7 @@ class NFTokenDir_test : public beast::unit_test::suite // Create accounts for all of the seeds and fund those accounts. std::vector accounts; accounts.reserve(seeds.size()); - for (std::string_view seed : seeds) + for (std::string_view const seed : seeds) { Account const& account = accounts.emplace_back(Account::base58Seed, std::string(seed)); env.fund(XRP(10000), account); @@ -758,7 +785,7 @@ class NFTokenDir_test : public beast::unit_test::suite // Create accounts for all of the seeds and fund those accounts. std::vector accounts; accounts.reserve(seeds.size()); - for (std::string_view seed : seeds) + for (std::string_view const seed : seeds) { Account const& account = accounts.emplace_back(Account::base58Seed, std::string(seed)); env.fund(XRP(10000), account); @@ -783,7 +810,7 @@ class NFTokenDir_test : public beast::unit_test::suite for (Account const& account : accounts) { // Mint the NFT. Tweak the taxon so zero is always stored. - std::uint32_t taxon = toUInt32(nft::cipheredTaxon(i, nft::toTaxon(0))); + std::uint32_t const taxon = toUInt32(nft::cipheredTaxon(i, nft::toTaxon(0))); uint256 const& nftID = nftIDsByPage[i].emplace_back( token::getNextID(env, account, taxon, tfTransferable)); @@ -831,7 +858,7 @@ class NFTokenDir_test : public beast::unit_test::suite // buyer accepts all of the offers that won't cause an overflow. // Fill the center and outsides first to exercise different boundary // cases. - for (int i : std::initializer_list{3, 6, 0, 1, 2, 5, 4}) + for (int const i : std::initializer_list{3, 6, 0, 1, 2, 5, 4}) { for (uint256 const& offer : offers[i]) { diff --git a/src/test/app/NFToken_test.cpp b/src/test/app/NFToken_test.cpp index bd61c959fc..441d889868 100644 --- a/src/test/app/NFToken_test.cpp +++ b/src/test/app/NFToken_test.cpp @@ -1,11 +1,56 @@ -#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include + +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -580,7 +625,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite env.close(); BEAST_EXPECT(ownerCount(env, alice) == 1); - uint256 nftNoXferID = token::getNextID(env, alice, 0); + uint256 const nftNoXferID = token::getNextID(env, alice, 0); env(token::mint(alice, 0)); env.close(); BEAST_EXPECT(ownerCount(env, alice) == 1); @@ -849,7 +894,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite // List of tokens to delete is too long. { - std::vector offers(maxTokenOfferCancelCount + 1, buyerOfferIndex); + std::vector const offers(maxTokenOfferCancelCount + 1, buyerOfferIndex); env(token::cancelOffer(buyer, offers), ter(temMALFORMED)); env.close(); @@ -936,7 +981,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite env.close(); BEAST_EXPECT(ownerCount(env, alice) == aliceCount); - uint256 nftNoXferID = token::getNextID(env, alice, 0); + uint256 const nftNoXferID = token::getNextID(env, alice, 0); env(token::mint(alice, 0)); env.close(); BEAST_EXPECT(ownerCount(env, alice) == aliceCount); @@ -1515,7 +1560,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite // An nft without flagCreateTrustLines but with a non-zero transfer // fee will not allow creating offers that use IOUs for payment. - for (std::uint32_t xferFee : {0, 1}) + for (std::uint32_t const xferFee : {0, 1}) { uint256 const nftNoAutoTrustID{ token::getNextID(env, alice, 0u, tfTransferable, xferFee)}; @@ -1552,7 +1597,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite // An nft with flagCreateTrustLines but with a non-zero transfer // fee allows transfers using IOUs for payment. { - std::uint16_t transferFee = 10000; // 10% + std::uint16_t const transferFee = 10000; // 10% uint256 const nftAutoTrustID{ token::getNextID(env, alice, 0u, tfTransferable | tfTrustLine, transferFee)}; @@ -1606,7 +1651,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite // Now that alice has trust lines preestablished, an nft without // flagCreateTrustLines will work for preestablished trust lines. { - std::uint16_t transferFee = 5000; // 5% + std::uint16_t const transferFee = 5000; // 5% uint256 const nftNoAutoTrustID{ token::getNextID(env, alice, 0u, tfTransferable, transferFee)}; env(token::mint(alice, 0u), token::xferFee(transferFee), txflags(tfTransferable)); @@ -2253,15 +2298,14 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite env(pay(becky, gw, env.balance(becky, gwXAU))); env.close(); - STAmount const startXAUBalance( - gwXAU.issue(), STAmount::cMinValue, STAmount::cMinOffset + 5); + STAmount const startXAUBalance(gwXAU, STAmount::cMinValue, STAmount::cMinOffset + 5); env(pay(gw, alice, startXAUBalance)); env(pay(gw, minter, startXAUBalance)); env(pay(gw, becky, startXAUBalance)); env.close(); // Here is the smallest expressible gwXAU amount. - STAmount tinyXAU(gwXAU.issue(), STAmount::cMinValue, STAmount::cMinOffset); + STAmount const tinyXAU(gwXAU, STAmount::cMinValue, STAmount::cMinOffset); // minter buys the nft for tinyXAU. Since the transfer involves // alice there should be no transfer fee. @@ -2294,7 +2338,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite // carol sells to becky. This is the smallest gwXAU amount // to pay for a transfer that enables a transfer fee of 1. - STAmount const cheapNFT(gwXAU.issue(), STAmount::cMinValue, STAmount::cMinOffset + 5); + STAmount const cheapNFT(gwXAU, STAmount::cMinValue, STAmount::cMinOffset + 5); STAmount beckyBalance = env.balance(becky, gwXAU); uint256 const beckyBuyOfferIndex = keylet::nftoffer(becky, env.seq(becky)).key; @@ -3702,7 +3746,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite int line) { for (Account const& acct : accounts) { - if (std::uint32_t ownerCount = test::jtx::ownerCount(env, acct); + if (std::uint32_t const ownerCount = test::jtx::ownerCount(env, acct); ownerCount != 1) { std::stringstream ss; @@ -6596,7 +6640,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite env.close(); // issuer creates two NFTs: one with and one without AutoTrustLine. - std::uint16_t xferFee = 5000; // 5% + std::uint16_t const xferFee = 5000; // 5% uint256 const nftAutoTrustID{ token::getNextID(env, issuer, 0u, tfTransferable | tfTrustLine, xferFee)}; env(token::mint(issuer, 0u), @@ -6752,7 +6796,7 @@ class NFTokenBaseUtil_test : public beast::unit_test::suite env.close(); // issuer creates two NFTs: one with and one without AutoTrustLine. - std::uint16_t xferFee = 5000; // 5% + std::uint16_t const xferFee = 5000; // 5% uint256 const nftAutoTrustID{ token::getNextID(env, issuer, 0u, tfTransferable | tfTrustLine, xferFee)}; env(token::mint(issuer, 0u), diff --git a/src/test/app/NetworkID_test.cpp b/src/test/app/NetworkID_test.cpp index 17245f7ee5..d8666aff90 100644 --- a/src/test/app/NetworkID_test.cpp +++ b/src/test/app/NetworkID_test.cpp @@ -1,11 +1,26 @@ // Copyright (c) 2020 Dev Null Productions -#include #include +#include +#include +#include +#include +#include +#include + +#include +#include #include +#include +#include +#include +#include #include +#include +#include + namespace xrpl { namespace test { diff --git a/src/test/app/NetworkOPs_test.cpp b/src/test/app/NetworkOPs_test.cpp index a176279444..976a70d803 100644 --- a/src/test/app/NetworkOPs_test.cpp +++ b/src/test/app/NetworkOPs_test.cpp @@ -1,8 +1,19 @@ -#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include + +#include namespace xrpl { namespace test { diff --git a/src/test/app/OfferMPT_test.cpp b/src/test/app/OfferMPT_test.cpp new file mode 100644 index 0000000000..8af583089a --- /dev/null +++ b/src/test/app/OfferMPT_test.cpp @@ -0,0 +1,4775 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace xrpl { +namespace test { + +class OfferMPT_test : public beast::unit_test::suite +{ + static XRPAmount + reserve(jtx::Env& env, std::uint32_t count) + { + return env.current()->fees().accountReserve(count); + } + + static std::uint32_t + lastClose(jtx::Env& env) + { + return env.current()->header().parentCloseTime.time_since_epoch().count(); + } + +public: + void + testRmFundedOffer(FeatureBitset features) + { + testcase("Incorrect Removal of Funded Offers"); + + // We need at least two paths. One at good quality and one at bad + // quality. The bad quality path needs two offer books in a row. + // Each offer book should have two offers at the same quality, the + // offers should be completely consumed, and the payment should + // require both offers to be satisfied. The first offer must + // be "taker gets" XRP. Old, broken would remove the first + // "taker gets" xrp offer, even though the offer is still funded and + // not used for the payment. + + using namespace jtx; + auto const gw = Account{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice, bob, carol}}); + auto const BTC = + issue2({.env = env, .token = "BTC", .issuer = gw, .holders = {alice, bob, carol}}); + + env(pay(gw, alice, BTC(1'000))); + + env(pay(gw, carol, USD(1'000))); + env(pay(gw, carol, BTC(1'000))); + + // Must be two offers at the same quality + // "taker gets" must be XRP + // (Different amounts, so I can distinguish the offers) + env(offer(carol, BTC(49), XRP(49))); + env(offer(carol, BTC(51), XRP(51))); + + // Offers for the poor quality path + // Must be two offers at the same quality + env(offer(carol, XRP(50), USD(50))); + env(offer(carol, XRP(50), USD(50))); + + // Offers for the good quality path + env(offer(carol, BTC(1), USD(100))); + + PathSet const paths(Path(XRP, USD), Path(USD)); + + env(pay(alice, bob, USD(100)), + json(paths.json()), + sendmax(BTC(1'000)), + txflags(tfPartialPayment)); + + env.require(balance(bob, USD(100))); + BEAST_EXPECT( + !isOffer(env, carol, BTC(1), USD(100)) && isOffer(env, carol, BTC(49), XRP(49))); + }; + testHelper2TokensMix(test); + } + + void + testCanceledOffer(FeatureBitset features) + { + testcase("Removing Canceled Offers"); + + using namespace jtx; + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + + env.fund(XRP(10'000), alice, gw); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + env(pay(gw, alice, USD(50))); + env.close(); + + auto const offer1Seq = env.seq(alice); + + env(offer(alice, XRP(500), USD(100)), require(offers(alice, 1))); + env.close(); + + BEAST_EXPECT(isOffer(env, alice, XRP(500), USD(100))); + + // cancel the offer above and replace it with a new offer + auto const offer2Seq = env.seq(alice); + + env(offer(alice, XRP(300), USD(100)), + json(jss::OfferSequence, offer1Seq), + require(offers(alice, 1))); + env.close(); + + BEAST_EXPECT( + isOffer(env, alice, XRP(300), USD(100)) && !isOffer(env, alice, XRP(500), USD(100))); + + // Test canceling non-existent offer. + // auto const offer3Seq = env.seq (alice); + + env(offer(alice, XRP(400), USD(200)), + json(jss::OfferSequence, offer1Seq), + require(offers(alice, 2))); + env.close(); + + BEAST_EXPECT( + isOffer(env, alice, XRP(300), USD(100)) && isOffer(env, alice, XRP(400), USD(200))); + + // Test cancellation now with OfferCancel tx + auto const offer4Seq = env.seq(alice); + env(offer(alice, XRP(222), USD(111)), require(offers(alice, 3))); + env.close(); + + BEAST_EXPECT(isOffer(env, alice, XRP(222), USD(111))); + env(offer_cancel(alice, offer4Seq)); + env.close(); + BEAST_EXPECT(env.seq(alice) == offer4Seq + 2); + + BEAST_EXPECT(!isOffer(env, alice, XRP(222), USD(111))); + + // Create an offer that both fails with a tecEXPIRED code and removes + // an offer. Show that the attempt to remove the offer fails. + env.require(offers(alice, 2)); + + env(offer(alice, XRP(5), USD(2)), + json(sfExpiration.fieldName, lastClose(env)), + json(jss::OfferSequence, offer2Seq), + ter(TER{tecEXPIRED})); + env.close(); + + env.require(offers(alice, 2)); + BEAST_EXPECT(isOffer(env, alice, XRP(300), USD(100))); // offer2 + BEAST_EXPECT(!isOffer(env, alice, XRP(5), USD(2))); // expired + } + + void + testTinyPayment(FeatureBitset features) + { + testcase("Tiny payments"); + + // Regression test for tiny payments + using namespace jtx; + using namespace std::chrono_literals; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + auto const gw = Account{"gw"}; + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 400'000'000}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 400'000'000}); + + env(pay(gw, alice, USD(100'000'000))); + env(pay(gw, carol, EUR(100'000'000))); + + // Create more offers than the loop max count in DeliverNodeReverse + // Note: the DeliverNodeReverse code has been removed; however since + // this is a regression test the original test is being left as-is + // for now. + for (int i = 0; i < 101; ++i) + env(offer(carol, USD(1'000'000), EUR(2'000'000))); + + // Original Offer test sends EUR(10**-81). MPT is integral, + // therefore and integral value is sent respecting the exchange + // rate. I.e. if EUR(1) is sent then it'll result in USD(0). + env(pay(alice, bob, EUR(2)), path(~EUR), sendmax(USD(100))); + }; + testHelper2TokensMix(test); + } + + void + testXRPTinyPayment(FeatureBitset features) + { + testcase("XRP Tiny payments"); + + // Regression test for tiny xrp payments + // In some cases, when the payment code calculates + // the amount of xrp needed as input to an xrp->iou offer + // it would incorrectly round the amount to zero (even when + // round-up was set to true). + // The bug would cause funded offers to be incorrectly removed + // because the code thought they were unfunded. + // The conditions to trigger the bug are: + // 1) When we calculate the amount of input xrp needed for an offer + // from xrp->iou, the amount is less than 1 drop (after rounding + // up the float representation). + // 2) There is another offer in the same book with a quality + // sufficiently bad that when calculating the input amount + // needed the amount is not set to zero. + + using namespace jtx; + using namespace std::chrono_literals; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + auto const dan = Account{"dan"}; + auto const erin = Account{"erin"}; + auto const gw = Account{"gw"}; + + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol, dan, erin, gw); + env.close(); + + MPT const USD = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob, carol, dan, erin}, + .pay = std::nullopt}); + env(pay(gw, carol, USD(99'999))); + env(pay(gw, dan, USD(100'000))); + env(pay(gw, erin, USD(100'000))); + env.close(); + + // Carol doesn't quite have enough funds for this offer + // The amount left after this offer is taken will cause + // STAmount to incorrectly round to zero when the next offer + // (at a good quality) is considered. (when the now removed + // stAmountCalcSwitchover2 patch was inactive) + env(offer(carol, drops(1), USD(99'999))); + // Offer at a quality poor enough so when the input xrp is + // calculated in the reverse pass, the amount is not zero. + env(offer(dan, XRP(100), USD(1))); + + env.close(); + // This is the funded offer that will be incorrectly removed. + // It is considered after the offer from carol, which leaves a + // tiny amount left to pay. When calculating the amount of xrp + // needed for this offer, it will incorrectly compute zero in both + // the forward and reverse passes (when the now removed + // stAmountCalcSwitchover2 was inactive.) + env(offer(erin, drops(2), USD(100'000))); + + env(pay(alice, bob, USD(100'000)), + path(~USD), + sendmax(XRP(102)), + txflags(tfNoRippleDirect | tfPartialPayment)); + + env.require(offers(carol, 0), offers(dan, 1)); + + // offer was correctly consumed. There is still some + // liquidity left on that offer. + env.require(balance(erin, USD(99'999)), offers(erin, 1)); + } + + void + testRmSmallIncreasedQOffersXRP(FeatureBitset features) + { + testcase("Rm small increased q offers XRP"); + + // Carol places an offer, but cannot fully fund the offer. When her + // funding is taken into account, the offer's quality drops below its + // initial quality and has an input amount of 1 drop. This is removed as + // an offer that may block offer books. + + using namespace jtx; + using namespace std::chrono_literals; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + auto const gw = Account{"gw"}; + + // Test offer crossing + for (auto crossBothOffers : {false, true}) + { + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol, gw); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, carol}}); + // underfund carol's offer + auto initialCarolUSD = USD(499); + env(pay(gw, carol, initialCarolUSD)); + env(pay(gw, bob, USD(100'000))); + env.close(); + // This offer is underfunded + env(offer(carol, drops(1), USD(1'000))); + env.close(); + // offer at a lower quality + env(offer(bob, drops(2), USD(1'000), tfPassive)); + env.close(); + env.require(offers(bob, 1), offers(carol, 1)); + + // alice places an offer that crosses carol's; depending on + // "crossBothOffers" it may cross bob's as well + auto aliceTakerGets = crossBothOffers ? drops(2) : drops(1); + env(offer(alice, USD(1'000), aliceTakerGets)); + env.close(); + + env.require( + offers(carol, 0), + balance( + carol, + initialCarolUSD)); // offer is removed but not taken + if (crossBothOffers) + { + env.require( + offers(alice, 0), balance(alice, USD(1'000))); // alice's offer is crossed + } + else + { + env.require( + offers(alice, 1), balance(alice, USD(0))); // alice's offer is not crossed + } + } + + // Test payments + for (auto partialPayment : {false, true}) + { + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, carol}}); + auto const initialCarolUSD = USD(999); + env(pay(gw, carol, initialCarolUSD)); + env.close(); + env(pay(gw, bob, USD(100'000))); + env.close(); + env(offer(carol, drops(1), USD(1'000))); + env.close(); + env(offer(bob, drops(2), USD(2'000), tfPassive)); + env.close(); + env.require(offers(bob, 1), offers(carol, 1)); + + std::uint32_t const flags = + partialPayment ? (tfNoRippleDirect | tfPartialPayment) : tfNoRippleDirect; + + TER const expectedTer = partialPayment ? TER{tesSUCCESS} : TER{tecPATH_PARTIAL}; + + env(pay(alice, bob, USD(5'000)), + path(~USD), + sendmax(XRP(1)), + txflags(flags), + ter(expectedTer)); + env.close(); + + if (expectedTer == tesSUCCESS) + { + env.require(offers(carol, 0)); + env.require(balance(carol, + initialCarolUSD)); // offer is removed but not taken + } + else + { + // TODO: Offers are not removed when payments fail + // If that is addressed, the test should show that carol's + // offer is removed but not taken, as in the other branch of + // this if statement + } + } + } + + void + testRmSmallIncreasedQOffersMPT(FeatureBitset features) + { + testcase("Rm small increased q offers MPT"); + + // Carol places an offer, but cannot fully fund the offer. When her + // funding is taken into account, the offer's quality drops below its + // initial quality and has an input amount of 1 drop. This is removed as + // an offer that may block offer books. + + using namespace jtx; + using namespace std::chrono_literals; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + auto const gw = Account{"gw"}; + + auto test = [&](auto&& issue1, auto&& issue2) { + auto tinyAmount = [&](T const& token) -> PrettyAmount { + if constexpr (std::is_same_v) + { + STAmount const amt( + token, + /*mantissa*/ 1, + /*exponent*/ -81); + return PrettyAmount(amt, token.account.name()); + } + else + { + STAmount const amt( + token, + /*mantissa*/ 1, + /*exponent*/ 0); + return PrettyAmount(amt, "MPT"); + } + }; + + // Test offer crossing + for (auto crossBothOffers : {false, true}) + { + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000'000}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000'000}); + // underfund carol's offer + auto initialCarolUSD = tinyAmount(USD); + env(pay(gw, carol, initialCarolUSD)); + env(pay(gw, bob, USD(100'000))); + env(pay(gw, alice, EUR(100'000))); + env.close(); + // This offer is underfunded + env(offer(carol, EUR(10), USD(10'000))); + env.close(); + // offer at a lower quality + env(offer(bob, EUR(10), USD(5'000), tfPassive)); + env.close(); + env.require(offers(bob, 1), offers(carol, 1)); + + // alice places an offer that crosses carol's; depending on + // "crossBothOffers" it may cross bob's as well + // Whatever + auto aliceTakerGets = crossBothOffers ? EUR(2) : EUR(1); + env(offer(alice, USD(1'000), aliceTakerGets)); + env.close(); + + // carol's offer can be partially crossed when EUR is IOU: + // 10e-3EUR/1USD + using tEUR = std::decay_t; + bool constexpr isEURIOU = std::is_same_v; + // partially crossed if IOU, removed but not taken if MPT + auto const balanceCarolUSD = isEURIOU ? USD(0) : initialCarolUSD; + + env.require(offers(carol, 0), balance(carol, balanceCarolUSD)); + if (crossBothOffers) + { + env.require( + offers(alice, 0), balance(alice, USD(1'000))); // alice's offer is crossed + } + else + { + // partially crossed if IOU, not crossed if MPT + auto const balanceAliceUSD = isEURIOU ? USD(1) : USD(0); + env.require(offers(alice, 1), balance(alice, balanceAliceUSD)); + } + } + + // Test payments + for (auto partialPayment : {false, true}) + { + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol, gw); + env.close(); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000'000}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 100'000'000}); + // underfund carol's offer + auto const initialCarolUSD = tinyAmount(USD); + env(pay(gw, carol, initialCarolUSD)); + env(pay(gw, bob, USD(100'000))); + env(pay(gw, alice, EUR(100'000))); + env.close(); + // This offer is underfunded + env(offer(carol, EUR(10), USD(2'000))); + env.close(); + env(offer(bob, EUR(20), USD(4'000), tfPassive)); + env.close(); + env.require(offers(bob, 1), offers(carol, 1)); + + std::uint32_t const flags = + partialPayment ? (tfNoRippleDirect | tfPartialPayment) : tfNoRippleDirect; + + TER const expectedTer = partialPayment ? TER{tesSUCCESS} : TER{tecPATH_PARTIAL}; + + env(pay(alice, bob, USD(5'000)), + path(~USD), + sendmax(EUR(100)), + txflags(flags), + ter(expectedTer)); + env.close(); + + if (expectedTer == tesSUCCESS) + { + // carol's offer can be partially crossed when EUR is IOU: + // 10e-3EUR/1USD + using tEUR = std::decay_t; + bool constexpr isEURIOU = std::is_same_v; + // partially crossed if IOU, removed but not taken if MPT + auto const balanceCarolUSD = isEURIOU ? USD(0) : initialCarolUSD; + env.require(offers(carol, 0)); + env.require(balance(carol, balanceCarolUSD)); + } + else + { + // TODO: Offers are not removed when payments fail + // If that is addressed, the test should show that carol's + // offer is removed but not taken, as in the other branch of + // this if statement + } + } + }; + testHelper2TokensMix(test); + } + + void + testInsufficientReserve(FeatureBitset features) + { + testcase("Insufficient Reserve"); + + // If an account places an offer and its balance + // *before* the transaction began isn't high enough + // to meet the reserve *after* the transaction runs, + // then no offer should go on the books but if the + // offer partially or fully crossed the tx succeeds. + + using namespace jtx; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + + auto const xrpOffer = XRP(1'000); + + // No crossing: + { + Env env{*this, features}; + + env.fund(XRP(1'000'000), gw); + + auto const f = env.current()->fees().base; + auto const r = reserve(env, 0); + + env.fund(r + f, alice); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + auto const usdOffer = USD(1'000); + + env(pay(gw, alice, usdOffer), ter(tesSUCCESS)); + env(offer(alice, xrpOffer, usdOffer), ter(tecINSUF_RESERVE_OFFER)); + + env.require(balance(alice, r - f), owners(alice, 1)); + } + + // Partial cross: + { + Env env{*this, features}; + + env.fund(XRP(1'000'000), gw); + + auto const f = env.current()->fees().base; + auto const r = reserve(env, 0); + + env.fund(r + f, alice); + env.fund(r + 2 * f + xrpOffer, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + auto const usdOffer = USD(1'000); + auto const usdOffer2 = USD(500); + auto const xrpOffer2 = XRP(500); + + env(offer(bob, usdOffer2, xrpOffer2), ter(tesSUCCESS)); + + env(pay(gw, alice, usdOffer), ter(tesSUCCESS)); + env(offer(alice, xrpOffer, usdOffer), ter(tesSUCCESS)); + + env.require( + balance(alice, r - f + xrpOffer2), + balance(alice, usdOffer2), + owners(alice, 1), + balance(bob, r + xrpOffer2), + balance(bob, usdOffer2), + owners(bob, 1)); + } + + // Account has enough reserve as is, but not enough + // if an offer were added. Attempt to sell MPTs to + // buy XRP. If it fully crosses, we succeed. + { + Env env{*this, features}; + + env.fund(XRP(1'000'000), gw); + + auto const f = env.current()->fees().base; + auto const r = reserve(env, 0); + + env.fund(r + f, alice); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + auto const usdOffer = USD(1'000); + auto const usdOffer2 = USD(500); + auto const xrpOffer2 = XRP(500); + + env.fund(r + f + xrpOffer, bob, carol); + env(offer(bob, usdOffer2, xrpOffer2), ter(tesSUCCESS)); + env(offer(carol, usdOffer, xrpOffer), ter(tesSUCCESS)); + + env(pay(gw, alice, usdOffer), ter(tesSUCCESS)); + env(offer(alice, xrpOffer, usdOffer), ter(tesSUCCESS)); + + env.require( + balance(alice, r - f + xrpOffer), + balance(alice, USD(0)), + owners(alice, 1), + balance(bob, r + xrpOffer2), + balance(bob, usdOffer2), + owners(bob, 1), + balance(carol, r + xrpOffer2), + balance(carol, usdOffer2), + owners(carol, 2)); + } + } + + // Helper function that returns the Offers on an account. + static std::vector> + offersOnAccount(jtx::Env& env, jtx::Account account) + { + std::vector> result; + forEachItem(*env.current(), account, [&result](std::shared_ptr const& sle) { + if (sle->getType() == ltOFFER) + result.push_back(sle); + }); + return result; + } + + void + testFillModes(FeatureBitset features) + { + testcase("Fill Modes"); + + using namespace jtx; + + auto const startBalance = XRP(1'000'000); + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + // Fill or Kill - unless we fully cross, just charge a fee and don't + // place the offer on the books. But also clean up expired offers + // that are discovered along the way. + // + { + Env env{*this, features}; + + auto const f = env.current()->fees().base; + + env.fund(startBalance, gw, alice, bob); + + MPTTester MUSD({.env = env, .issuer = gw}); + MPT const USD = MUSD["USD"]; + + // bob creates an offer that expires before the next ledger close. + env(offer(bob, USD(500), XRP(500)), + json(sfExpiration.fieldName, lastClose(env) + 1), + ter(tesSUCCESS)); + + // The offer expires (it's not removed yet). + env.close(); + env.require(owners(bob, 1), offers(bob, 1)); + + // bob creates the offer that will be crossed. + env(offer(bob, USD(500), XRP(500)), ter(tesSUCCESS)); + env.close(); + env.require(owners(bob, 2), offers(bob, 2)); + + MUSD.authorize({.account = alice}); + env(pay(gw, alice, USD(1'000)), ter(tesSUCCESS)); + + // Order that can't be filled but will remove bob's expired offer: + env(offer(alice, XRP(1'000), USD(1'000)), txflags(tfFillOrKill), ter(tecKILLED)); + + env.require( + balance(alice, startBalance - (f * 2)), + balance(alice, USD(1'000)), + owners(alice, 1), + offers(alice, 0), + balance(bob, startBalance - (f * 2)), + balance(bob, USD(none)), + owners(bob, 1), + offers(bob, 1)); + + // Order that can be filled + env(offer(alice, XRP(500), USD(500)), txflags(tfFillOrKill), ter(tesSUCCESS)); + + env.require( + balance(alice, startBalance - (f * 3) + XRP(500)), + balance(alice, USD(500)), + owners(alice, 1), + offers(alice, 0), + balance(bob, startBalance - (f * 2) - XRP(500)), + balance(bob, USD(500)), + owners(bob, 1), + offers(bob, 0)); + } + + // Immediate or Cancel - cross as much as possible + // and add nothing on the books: + { + Env env{*this, features}; + + auto const f = env.current()->fees().base; + + env.fund(startBalance, gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + env(pay(gw, alice, USD(1'000)), ter(tesSUCCESS)); + + // No cross: + { + env(offer(alice, XRP(1'000), USD(1000)), + txflags(tfImmediateOrCancel), + ter(tecKILLED)); + } + + env.require( + balance(alice, startBalance - f - f), + balance(alice, USD(1000)), + owners(alice, 1), + offers(alice, 0)); + + // Partially cross: + env(offer(bob, USD(50), XRP(50)), ter(tesSUCCESS)); + env(offer(alice, XRP(1000), USD(1000)), txflags(tfImmediateOrCancel), ter(tesSUCCESS)); + + env.require( + balance(alice, startBalance - f - f - f + XRP(50)), + balance(alice, USD(950)), + owners(alice, 1), + offers(alice, 0), + balance(bob, startBalance - f - XRP(50)), + balance(bob, USD(50)), + owners(bob, 1), + offers(bob, 0)); + + // Fully cross: + env(offer(bob, USD(50), XRP(50)), ter(tesSUCCESS)); + env(offer(alice, XRP(50), USD(50)), txflags(tfImmediateOrCancel), ter(tesSUCCESS)); + + env.require( + balance(alice, startBalance - f - f - f - f + XRP(100)), + balance(alice, USD(900)), + owners(alice, 1), + offers(alice, 0), + balance(bob, startBalance - f - f - XRP(100)), + balance(bob, USD(100)), + owners(bob, 1), + offers(bob, 0)); + } + + // tfPassive -- place the offer without crossing it. + { + Env env(*this, features); + + env.fund(startBalance, gw, alice, bob); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {bob}}); + + env(pay(gw, bob, USD(1'000))); + env.close(); + + env(offer(alice, USD(1'000), XRP(2'000))); + env.close(); + + auto const aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + for (auto const& offerPtr : aliceOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfTakerGets] == XRP(2'000)); + BEAST_EXPECT(offer[sfTakerPays] == USD(1'000)); + } + + // bob creates a passive offer that could cross alice's. + // bob's offer should stay in the ledger. + env(offer(bob, XRP(2'000), USD(1'000), tfPassive)); + env.close(); + env.require(offers(alice, 1)); + + auto const bobOffers = offersOnAccount(env, bob); + BEAST_EXPECT(bobOffers.size() == 1); + for (auto const& offerPtr : bobOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfTakerGets] == USD(1'000)); + BEAST_EXPECT(offer[sfTakerPays] == XRP(2'000)); + } + + // It should be possible for gw to cross both of those offers. + env(offer(gw, XRP(2'000), USD(1'000))); + env.close(); + env.require(offers(alice, 0)); + env.require(offers(gw, 0)); + env.require(offers(bob, 1)); + + env(offer(gw, USD(1'000), XRP(2'000))); + env.close(); + env.require(offers(bob, 0)); + env.require(offers(gw, 0)); + } + + // tfPassive -- cross only offers of better quality. + { + Env env(*this, features); + + env.fund(startBalance, gw, "alice", "bob"); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {bob}}); + + env(pay(gw, "bob", USD(10'000))); + env(offer("alice", USD(5'000), XRP(1'001))); + env.close(); + + env(offer("alice", USD(5'000), XRP(1'000))); + env.close(); + + auto const aliceOffers = offersOnAccount(env, "alice"); + BEAST_EXPECT(aliceOffers.size() == 2); + + // bob creates a passive offer. That offer should cross one + // of alice's (the one with better quality) and leave alice's + // other offer untouched. + env(offer("bob", XRP(2'000), USD(10'000), tfPassive)); + env.close(); + env.require(offers("alice", 1)); + + auto const bobOffers = offersOnAccount(env, "bob"); + BEAST_EXPECT(bobOffers.size() == 1); + for (auto const& offerPtr : bobOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfTakerGets] == USD(4'995)); + BEAST_EXPECT(offer[sfTakerPays] == XRP(999)); + } + } + } + + void + testMalformed(FeatureBitset features) + { + testcase("Malformed Detection"); + + using namespace jtx; + + auto const startBalance = XRP(1'000'000); + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + + Env env{*this, features}; + + env.fund(startBalance, gw, alice); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + // Sell and buy the same asset + { + // Alice tries an MPT to MPT order: + env(pay(gw, alice, USD(1'000)), ter(tesSUCCESS)); + env(offer(alice, USD(1'000), USD(1'000)), ter(temREDUNDANT)); + env.require(owners(alice, 1), offers(alice, 0)); + } + + // Offers with negative amounts + { + env(offer(alice, -USD(1'000), XRP(1'000)), ter(temBAD_OFFER)); + env.require(owners(alice, 1), offers(alice, 0)); + } + + // Bad MPT + { + auto const BAD = MPT(badMPT()); + + env(offer(alice, XRP(1'000), BAD(1'000)), ter(temBAD_CURRENCY)); + env.require(owners(alice, 1), offers(alice, 0)); + } + } + + void + testExpiration(FeatureBitset features) + { + testcase("Offer Expiration"); + + using namespace jtx; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + auto const startBalance = XRP(1'000'000); + auto const xrpOffer = XRP(1'000); + + Env env{*this, features}; + + env.fund(startBalance, gw, alice, bob); + env.close(); + + auto const f = env.current()->fees().base; + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + auto const usdOffer = USD(1'000); + + env(pay(gw, alice, usdOffer), ter(tesSUCCESS)); + env.close(); + env.require( + balance(alice, startBalance - f), + balance(alice, usdOffer), + offers(alice, 0), + owners(alice, 1)); + + // Place an offer that should have already expired. + env(offer(alice, xrpOffer, usdOffer), + json(sfExpiration.fieldName, lastClose(env)), + ter(TER{tecEXPIRED})); + + env.require( + balance(alice, startBalance - f - f), + balance(alice, usdOffer), + offers(alice, 0), + owners(alice, 1)); + env.close(); + + // Add an offer that expires before the next ledger close + env(offer(alice, xrpOffer, usdOffer), + json(sfExpiration.fieldName, lastClose(env) + 1), + ter(tesSUCCESS)); + env.require( + balance(alice, startBalance - f - f - f), + balance(alice, usdOffer), + offers(alice, 1), + owners(alice, 2)); + + // The offer expires (it's not removed yet) + env.close(); + env.require( + balance(alice, startBalance - f - f - f), + balance(alice, usdOffer), + offers(alice, 1), + owners(alice, 2)); + + // Add offer - the expired offer is removed + env(offer(bob, usdOffer, xrpOffer), ter(tesSUCCESS)); + + env.require( + balance(alice, startBalance - f - f - f), + balance(alice, usdOffer), + offers(alice, 0), + owners(alice, 1), + balance(bob, startBalance - f), + balance(bob, USD(none)), + offers(bob, 1), + owners(bob, 1)); + } + + void + testUnfundedCross(FeatureBitset features) + { + testcase("Unfunded Crossing"); + + using namespace jtx; + + auto const gw = Account{"gateway"}; + + auto const xrpOffer = XRP(1'000); + + Env env{*this, features}; + + env.fund(XRP(1'000'000), gw); + + // The fee that's charged for transactions + auto const f = env.current()->fees().base; + + // Account is at the reserve, and will dip below once + // fees are subtracted. + env.fund(reserve(env, 0), "alice"); + MPT const USD = MPTTester({.env = env, .issuer = gw}); + auto const usdOffer = USD(1'000); + env(offer("alice", usdOffer, xrpOffer), ter(tecUNFUNDED_OFFER)); + env.require(balance("alice", reserve(env, 0) - f), owners("alice", 0)); + + // Account has just enough for the reserve and the + // fee. + env.fund(reserve(env, 0) + f, "bob"); + env(offer("bob", usdOffer, xrpOffer), ter(tecUNFUNDED_OFFER)); + env.require(balance("bob", reserve(env, 0)), owners("bob", 0)); + + // Account has enough for the reserve, the fee and + // the offer, and a bit more, but not enough for the + // reserve after the offer is placed. + env.fund(reserve(env, 0) + f + XRP(1), "carol"); + env(offer("carol", usdOffer, xrpOffer), ter(tecINSUF_RESERVE_OFFER)); + env.require(balance("carol", reserve(env, 0) + XRP(1)), owners("carol", 0)); + + // Account has enough for the reserve plus one + // offer, and the fee. + env.fund(reserve(env, 1) + f, "dan"); + env(offer("dan", usdOffer, xrpOffer), ter(tesSUCCESS)); + env.require(balance("dan", reserve(env, 1)), owners("dan", 1)); + + // Account has enough for the reserve plus one + // offer, the fee and the entire offer amount. + env.fund(reserve(env, 1) + f + xrpOffer, "eve"); + env(offer("eve", usdOffer, xrpOffer), ter(tesSUCCESS)); + env.require(balance("eve", reserve(env, 1) + xrpOffer), owners("eve", 1)); + } + + void + testSelfCross(bool use_partner, FeatureBitset features) + { + testcase(std::string("Self-crossing") + (use_partner ? ", with partner account" : "")); + + using namespace jtx; + auto const gw = Account{"gateway"}; + auto const partner = Account{"partner"}; + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + env.close(); + + env.fund(XRP(10'000), gw); + auto const USD = issue1({.env = env, .token = "USD", .issuer = gw}); + auto const BTC = issue2({.env = env, .token = "BTC", .issuer = gw}); + using tUSD = std::decay_t; + using tBTC = std::decay_t; + if (use_partner) + { + env.fund(XRP(10'000), partner); + if constexpr (std::is_same_v) + { + env(trust(partner, USD(100))); + } + else + { + MPTTester MUSD(env, gw, USD); + MUSD.authorize({.account = partner}); + } + if constexpr (std::is_same_v) + { + env(trust(partner, BTC(500))); + } + else + { + MPTTester MBTC(env, gw, BTC); + MBTC.authorize({.account = partner}); + } + env(pay(gw, partner, USD(100))); + env(pay(gw, partner, BTC(500))); + } + auto const& account_to_test = use_partner ? partner : gw; + + env.close(); + env.require(offers(account_to_test, 0)); + + // PART 1: + // we will make two offers that can be used to bridge BTC to USD + // through XRP + env(offer(account_to_test, BTC(250), XRP(1'000))); + env.require(offers(account_to_test, 1)); + + // validate that the book now shows a BTC for XRP offer + BEAST_EXPECT(isOffer(env, account_to_test, BTC(250), XRP(1'000))); + + auto const secondLegSeq = env.seq(account_to_test); + env(offer(account_to_test, XRP(1'000), USD(50))); + env.require(offers(account_to_test, 2)); + + // validate that the book also shows a XRP for USD offer + BEAST_EXPECT(isOffer(env, account_to_test, XRP(1'000), USD(50))); + + // now make an offer that will cross and auto-bridge, meaning + // the outstanding offers will be taken leaving us with none + env(offer(account_to_test, USD(50), BTC(250))); + + auto jrr = getBookOffers(env, USD, BTC); + BEAST_EXPECT(jrr[jss::offers].isArray()); + BEAST_EXPECT(jrr[jss::offers].size() == 0); + + jrr = getBookOffers(env, BTC, XRP); + BEAST_EXPECT(jrr[jss::offers].isArray()); + BEAST_EXPECT(jrr[jss::offers].size() == 0); + + // At this point, all offers are expected to be consumed. + { + auto acctOffers = offersOnAccount(env, account_to_test); + + // No stale offers + BEAST_EXPECT(acctOffers.empty()); + for (auto const& offerPtr : acctOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == USD(0)); + BEAST_EXPECT(offer[sfTakerPays] == XRP(0)); + } + } + + // cancel that lingering second offer so that it doesn't interfere + // with the next set of offers we test. This will not be needed once + // the bridging bug is fixed + env(offer_cancel(account_to_test, secondLegSeq)); + env.require(offers(account_to_test, 0)); + + // PART 2: + // simple direct crossing BTC to USD and then USD to BTC which + // causes the first offer to be replaced + env(offer(account_to_test, BTC(250), USD(50))); + env.require(offers(account_to_test, 1)); + + // validate that the book shows one BTC for USD offer and no USD for + // BTC offers + BEAST_EXPECT(isOffer(env, account_to_test, BTC(250), USD(50))); + + jrr = getBookOffers(env, USD, BTC); + BEAST_EXPECT(jrr[jss::offers].isArray()); + BEAST_EXPECT(jrr[jss::offers].size() == 0); + + // this second offer would self-cross directly, so it causes the + // first offer by the same owner/taker to be removed + env(offer(account_to_test, USD(50), BTC(250))); + env.require(offers(account_to_test, 1)); + + // validate that we now have just the second offer...the first + // was removed + jrr = getBookOffers(env, BTC, USD); + BEAST_EXPECT(jrr[jss::offers].isArray()); + BEAST_EXPECT(jrr[jss::offers].size() == 0); + + BEAST_EXPECT(isOffer(env, account_to_test, USD(50), BTC(250))); + }; + testHelper2TokensMix(test); + } + + void + testNegativeBalance(FeatureBitset features) + { + // This test creates an offer test for negative balance + // with transfer fees and miniscule funds. + testcase("Negative Balance"); + + using namespace jtx; + FeatureBitset const localFeatures = features | fixReducedOffersV2; + + Env env{*this, localFeatures}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + // these *interesting* amounts were taken + // from the original JS test that was ported here + auto const gw_initial_balance = drops(1'149'999'730); + auto const alice_initial_balance = drops(499'946'999'680); + auto const bob_initial_balance = drops(10'199'999'920); + + env.fund(gw_initial_balance, gw); + env.fund(alice_initial_balance, alice); + env.fund(bob_initial_balance, bob); + + MPTTester const MUSD( + {.env = env, .issuer = gw, .holders = {alice, bob}, .transferFee = 5'000}); + MPT const USD = MUSD; + auto const small_amount = STAmount{USD, 1}; + + env(pay(gw, alice, USD(50))); + env(pay(gw, bob, small_amount)); + + env(offer(alice, USD(50), XRP(150'000))); + + // unfund the offer + env(pay(alice, gw, USD(50))); + + // verify balances + auto jrr = ledgerEntryMPT(env, alice, USD); + // this represents 0 since MPTAmount is a default field + BEAST_EXPECT(!jrr[jss::node].isMember(sfMPTAmount.fieldName)); + + jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "1"); + + // create crossing offer + std::uint32_t const bobOfferSeq = env.seq(bob); + env(offer(bob, XRP(2000), USD(1))); + + // With the rounding introduced by fixReducedOffersV2, bob's + // offer does not cross alice's offer and goes straight into + // the ledger. + jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "1"); + + Json::Value const bobOffer = ledgerEntryOffer(env, bob, bobOfferSeq)[jss::node]; + BEAST_EXPECT(bobOffer[sfTakerGets.jsonName][jss::value] == "1"); + BEAST_EXPECT(bobOffer[sfTakerPays.jsonName] == "2000000000"); + } + + void + testOfferCrossWithXRP(bool reverse_order, FeatureBitset features) + { + testcase( + std::string("Offer Crossing with XRP, ") + (reverse_order ? "Reverse" : "Normal") + + " order"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + env.fund(XRP(10'000), gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + env(pay(gw, alice, USD(500))); + + if (reverse_order) + env(offer(bob, USD(1), XRP(4'000))); + + env(offer(alice, XRP(150'000), USD(50))); + + if (!reverse_order) + env(offer(bob, USD(1), XRP(4000))); + + // Existing offer pays better than this wants. + // Fully consume existing offer. + // Pay 1 USD, get 4000 XRP. + + auto jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "1"); + jrr = ledgerEntryRoot(env, bob); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + to_string( + (XRP(10000) - XRP(reverse_order ? 4000 : 3000) - env.current()->fees().base * 2) + .xrp())); + + jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "499"); + jrr = ledgerEntryRoot(env, alice); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + to_string( + (XRP(10000) + XRP(reverse_order ? 4000 : 3000) - env.current()->fees().base * 2) + .xrp())); + } + + void + testOfferCrossWithLimitOverride(FeatureBitset features) + { + testcase("Offer Crossing with Limit Override"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + env.fund(XRP(100000), gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + env(pay(gw, alice, USD(500))); + + env(offer(alice, XRP(150'000), USD(50))); + env(offer(bob, USD(1), XRP(3'000))); + + auto jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "1"); + jrr = ledgerEntryRoot(env, bob); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + to_string((XRP(100'000) - XRP(3'000) - env.current()->fees().base * 1).xrp())); + + jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "499"); + jrr = ledgerEntryRoot(env, alice); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + to_string((XRP(100'000) + XRP(3'000) - env.current()->fees().base * 2).xrp())); + } + + void + testOfferAcceptThenCancel(FeatureBitset features) + { + testcase("Offer Accept then Cancel."); + + using namespace jtx; + + Env env{*this, features}; + + MPT const USD = MPTTester({.env = env, .issuer = env.master}); + + auto const nextOfferSeq = env.seq(env.master); + env(offer(env.master, XRP(500), USD(100))); + env.close(); + + env(offer_cancel(env.master, nextOfferSeq)); + BEAST_EXPECT(env.seq(env.master) == nextOfferSeq + 2); + + // ledger_accept, call twice and verify no odd behavior + env.close(); + env.close(); + BEAST_EXPECT(env.seq(env.master) == nextOfferSeq + 2); + } + + void + testCurrencyConversionEntire(FeatureBitset features) + { + testcase("Currency Conversion: Entire Offer"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + env.fund(XRP(10'000), gw, alice, bob); + env.require(owners(bob, 0)); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + env.require(owners(alice, 1), owners(bob, 1)); + + env(pay(gw, alice, USD(100))); + auto const bobOfferSeq = env.seq(bob); + env(offer(bob, USD(100), XRP(500))); + + env.require(owners(alice, 1), owners(bob, 2)); + auto jro = ledgerEntryOffer(env, bob, bobOfferSeq); + BEAST_EXPECT(jro[jss::node][jss::TakerGets] == XRP(500).value().getText()); + BEAST_EXPECT(jro[jss::node][jss::TakerPays] == USD(100).value().getJson(JsonOptions::none)); + + env(pay(alice, alice, XRP(500)), sendmax(USD(100))); + + auto jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(!jrr[jss::node].isMember(sfMPTAmount.fieldName)); + jrr = ledgerEntryRoot(env, alice); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + to_string((XRP(10'000) + XRP(500) - env.current()->fees().base * 2).xrp())); + + jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "100"); + + jro = ledgerEntryOffer(env, bob, bobOfferSeq); + BEAST_EXPECT(jro[jss::error] == "entryNotFound"); + + env.require(owners(alice, 1), owners(bob, 1)); + } + + void + testCurrencyConversionIntoDebt(FeatureBitset features) + { + testcase("Currency Conversion: Offerer Into Debt"); + + using namespace jtx; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env{*this, features}; + + env.fund(XRP(10'000), alice, bob, carol); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = alice, .holders = {bob}}); + auto const EURC = + issue2({.env = env, .token = "EUC", .issuer = carol, .holders = {alice}}); + auto const EURB = + issue3({.env = env, .token = "EUB", .issuer = bob, .holders = {carol}}); + + auto const bobOfferSeq = env.seq(bob); + env(offer(bob, USD(50), EURC(200)), ter(tecUNFUNDED_OFFER)); + + env(offer(alice, EURC(200), USD(50))); + + auto jro = ledgerEntryOffer(env, bob, bobOfferSeq); + BEAST_EXPECT(jro[jss::error] == "entryNotFound"); + }; + testHelper3TokensMix(test); + } + + void + testCurrencyConversionInParts(FeatureBitset features) + { + testcase("Currency Conversion: In Parts"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + env.fund(XRP(10'000), gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + env(pay(gw, alice, USD(200))); + + auto const bobOfferSeq = env.seq(bob); + env(offer(bob, USD(100), XRP(500))); + + env(pay(alice, alice, XRP(200)), sendmax(USD(100))); + + // The previous payment reduced the remaining offer amount by 200 XRP + auto jro = ledgerEntryOffer(env, bob, bobOfferSeq); + BEAST_EXPECT(jro[jss::node][jss::TakerGets] == XRP(300).value().getText()); + BEAST_EXPECT(jro[jss::node][jss::TakerPays] == USD(60).value().getJson(JsonOptions::none)); + + // the balance between alice and gw is 160 USD..200 less the 40 taken + // by the offer + auto jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "160"); + // alice now has 200 more XRP from the payment + jrr = ledgerEntryRoot(env, alice); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + to_string((XRP(10'000) + XRP(200) - env.current()->fees().base * 2).xrp())); + + // bob got 40 USD from partial consumption of the offer + jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "40"); + + // Alice converts USD to XRP which should fail + // due to PartialPayment. + env(pay(alice, alice, XRP(600)), sendmax(USD(100)), ter(tecPATH_PARTIAL)); + + // Alice converts USD to XRP, should succeed because + // we permit partial payment + env(pay(alice, alice, XRP(600)), sendmax(USD(100)), txflags(tfPartialPayment)); + + // Verify the offer was consumed + jro = ledgerEntryOffer(env, bob, bobOfferSeq); + BEAST_EXPECT(jro[jss::error] == "entryNotFound"); + + // verify balances look right after the partial payment + // only 300 XRP should have been payed since that's all + // that remained in the offer from bob. The alice balance is now + // 100 USD because another 60 USD were transferred to bob in the second + // payment + jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "100"); + jrr = ledgerEntryRoot(env, alice); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + to_string((XRP(10'000) + XRP(200) + XRP(300) - env.current()->fees().base * 4).xrp())); + + // bob now has 100 USD - 40 from the first payment and 60 from the + // second (partial) payment + jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "100"); + } + + void + testCrossCurrencyStartXRP(FeatureBitset features) + { + testcase("Cross Currency Payment: Start with XRP"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + + env.fund(XRP(10'000), gw, alice, bob, carol); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {carol, bob}}); + + env(pay(gw, carol, USD(500))); + + auto const carolOfferSeq = env.seq(carol); + env(offer(carol, XRP(500), USD(50))); + + env(pay(alice, bob, USD(25)), sendmax(XRP(333))); + + auto jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "25"); + + jrr = ledgerEntryMPT(env, carol, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "475"); + + auto jro = ledgerEntryOffer(env, carol, carolOfferSeq); + BEAST_EXPECT(jro[jss::node][jss::TakerGets] == USD(25).value().getJson(JsonOptions::none)); + BEAST_EXPECT(jro[jss::node][jss::TakerPays] == XRP(250).value().getText()); + } + + void + testCrossCurrencyEndXRP(FeatureBitset features) + { + testcase("Cross Currency Payment: End with XRP"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + + env.fund(XRP(10'000), gw, alice, bob, carol); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, carol}}); + + env(pay(gw, alice, USD(500))); + + auto const carolOfferSeq = env.seq(carol); + env(offer(carol, USD(50), XRP(500))); + + env(pay(alice, bob, XRP(250)), sendmax(USD(333))); + + auto jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "475"); + + jrr = ledgerEntryMPT(env, carol, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "25"); + + jrr = ledgerEntryRoot(env, bob); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + std::to_string(XRP(10'000).value().mantissa() + XRP(250).value().mantissa())); + + auto jro = ledgerEntryOffer(env, carol, carolOfferSeq); + BEAST_EXPECT(jro[jss::node][jss::TakerGets] == XRP(250).value().getText()); + BEAST_EXPECT(jro[jss::node][jss::TakerPays] == USD(25).value().getJson(JsonOptions::none)); + } + + void + testCrossCurrencyBridged(FeatureBitset features) + { + testcase("Cross Currency Payment: Bridged"); + + using namespace jtx; + auto const gw1 = Account{"gateway_1"}; + auto const gw2 = Account{"gateway_2"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + auto const carol = Account{"carol"}; + auto const dan = Account{"dan"}; + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + env.fund(XRP(10'000), gw1, gw2, alice, bob, carol, dan); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw1, .holders = {alice, carol}}); + auto const EUR = + issue1({.env = env, .token = "EUR", .issuer = gw2, .holders = {bob, dan}}); + + env(pay(gw1, alice, USD(500))); + env(pay(gw2, dan, EUR(400))); + + auto const carolOfferSeq = env.seq(carol); + env(offer(carol, USD(50), XRP(500))); + + auto const danOfferSeq = env.seq(dan); + env(offer(dan, XRP(500), EUR(50))); + + Json::Value jtp{Json::arrayValue}; + jtp[0u][0u][jss::currency] = "XRP"; + env(pay(alice, bob, EUR(30)), json(jss::Paths, jtp), sendmax(USD(333))); + + BEAST_EXPECT(env.balance(alice, USD) == USD(470)); + BEAST_EXPECT(env.balance(bob, EUR) == EUR(30)); + BEAST_EXPECT(env.balance(carol, USD) == USD(30)); + BEAST_EXPECT(env.balance(dan, EUR) == EUR(370)); + + auto jro = ledgerEntryOffer(env, carol, carolOfferSeq); + BEAST_EXPECT(jro[jss::node][jss::TakerGets] == XRP(200).value().getText()); + BEAST_EXPECT( + jro[jss::node][jss::TakerPays] == USD(20).value().getJson(JsonOptions::none)); + + jro = ledgerEntryOffer(env, dan, danOfferSeq); + BEAST_EXPECT( + jro[jss::node][jss::TakerGets] == EUR(20).value().getJson(JsonOptions::none)); + BEAST_EXPECT(jro[jss::node][jss::TakerPays] == XRP(200).value().getText()); + }; + testHelper2TokensMix(test); + } + + void + testBridgedSecondLegDry(FeatureBitset features) + { + // At least with Taker bridging, a sensitivity was identified if the + // second leg goes dry before the first one. This test exercises that + // case. + testcase("Auto Bridged Second Leg Dry"); + + using namespace jtx; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; + Account const gw{"gateway"}; + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(100'000'000), alice, bob, carol, gw); + env.close(); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice, carol}}); + auto const EUR = issue1({.env = env, .token = "EUR", .issuer = gw, .holders = {bob}}); + + env(pay(gw, alice, USD(10))); + env(pay(gw, carol, USD(3))); + + env(offer(alice, EUR(2), XRP(1))); + env(offer(alice, EUR(2), XRP(1))); + + env(offer(alice, XRP(1), USD(4))); + env(offer(carol, XRP(1), USD(3))); + env.close(); + + // Bob offers to buy 10 USD for 10 EUR. + // 1. He spends 2 EUR taking Alice's auto-bridged offers and + // gets 4 USD for that. + // 2. He spends another 2 EUR taking Alice's last EUR->XRP offer + // and + // Carol's XRP-USD offer. He gets 3 USD for that. + // The key for this test is that Alice's XRP->USD leg goes dry + // before Alice's EUR->XRP. The XRP->USD leg is the second leg + // which showed some sensitivity. + env(pay(gw, bob, EUR(10))); + env.close(); + env(offer(bob, USD(10), EUR(10))); + env.close(); + + env.require(balance(bob, USD(7))); + env.require(balance(bob, EUR(6))); + env.require(offers(bob, 1)); + env.require(owners(bob, 3)); + + env.require(balance(alice, USD(6))); + env.require(balance(alice, EUR(4))); + env.require(offers(alice, 0)); + env.require(owners(alice, 2)); + + env.require(balance(carol, USD(0))); + env.require(balance(carol, EUR(none))); + + env.require(offers(carol, 0)); + env.require(owners(carol, 1)); + }; + testHelper2TokensMix(test); + } + + void + testOfferFeesConsumeFunds(FeatureBitset features) + { + testcase("Offer Fees Consume Funds"); + + using namespace jtx; + auto const gw1 = Account{"gateway_1"}; + auto const gw2 = Account{"gateway_2"}; + auto const gw3 = Account{"gateway_3"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + auto test = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env{*this, features}; + + // Provide micro amounts to compensate for fees to make results + // round nice. reserve: Alice has 3 entries in the ledger, via trust + // lines fees: + // 1 for each trust limit == 3 (alice < mtgox/amazon/bitstamp) + + // 1 for payment == 4 + auto const base = env.current()->fees().base; + auto const starting_xrp = XRP(100) + env.current()->fees().accountReserve(3) + base * 4; + + env.fund(starting_xrp, gw1, gw2, gw3, alice, bob); + env.close(); + + auto const USD1 = + issue1({.env = env, .token = "US1", .issuer = gw1, .holders = {alice, bob}}); + auto const USD2 = + issue2({.env = env, .token = "US2", .issuer = gw2, .holders = {alice, bob}}); + auto const USD3 = + issue3({.env = env, .token = "US3", .issuer = gw3, .holders = {alice}}); + + env(pay(gw1, bob, USD1(500))); + + env(offer(bob, XRP(200), USD1(200))); + // Alice has 350 fees - a reserve of 50 = 250 reserve = 100 + // available. Ask for more than available to prove reserve works. + env(offer(alice, USD1(200), XRP(200))); + + BEAST_EXPECT(env.balance(alice, USD1) == USD1(100)); + BEAST_EXPECT(env.balance(alice) == STAmount(env.current()->fees().accountReserve(3))); + + BEAST_EXPECT(env.balance(bob, USD1) == USD1(400)); + }; + testHelper3TokensMix(test); + } + + void + testOfferCreateThenCross(FeatureBitset features) + { + testcase("Offer Create, then Cross"); + + using namespace jtx; + + Env env{*this, features}; + env.enableFeature(fixUniversalNumber); + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + env.fund(XRP(10'000), gw, alice, bob); + + MPT const CUR = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .transferFee = 5'000}); + + env(pay(gw, bob, CUR(100))); + + env(offer(alice, CUR(50'000), XRP(150'000))); + env(offer(bob, XRP(100), CUR(100))); + + auto jrr = ledgerEntryMPT(env, alice, CUR); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "34"); + + jrr = ledgerEntryMPT(env, bob, CUR); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "64"); + } + + void + testSellFlagBasic(FeatureBitset features) + { + testcase("Offer tfSell: Basic Sell"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + auto const starting_xrp = + XRP(100) + env.current()->fees().accountReserve(1) + env.current()->fees().base * 2; + + env.fund(starting_xrp, gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + env(pay(gw, bob, USD(500))); + + env(offer(bob, XRP(200), USD(200)), json(jss::Flags, tfSell)); + // Alice has 350 + fees - a reserve of 50 = 250 reserve = 100 available. + // Alice has 350 + fees - a reserve of 50 = 250 reserve = 100 available. + // Ask for more than available to prove reserve works. + env(offer(alice, USD(200), XRP(200)), json(jss::Flags, tfSell)); + + auto jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "100"); + jrr = ledgerEntryRoot(env, alice); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + STAmount(env.current()->fees().accountReserve(1)).getText()); + + jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "400"); + } + + void + testSellFlagExceedLimit(FeatureBitset features) + { + testcase("Offer tfSell: 2x Sell Exceed Limit"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + auto const starting_xrp = + XRP(100) + env.current()->fees().accountReserve(1) + env.current()->fees().base * 2; + + env.fund(starting_xrp, gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + env(pay(gw, bob, USD(500))); + + env(offer(bob, XRP(100), USD(200))); + // Alice has 350 fees - a reserve of 50 = 250 reserve = 100 available. + // Ask for more than available to prove reserve works. + // Taker pays 100 USD for 100 XRP. + // Selling XRP. + // Will sell all 100 XRP and get more USD than asked for. + env(offer(alice, USD(100), XRP(100)), json(jss::Flags, tfSell)); + + auto jrr = ledgerEntryMPT(env, alice, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "200"); + jrr = ledgerEntryRoot(env, alice); + BEAST_EXPECT( + jrr[jss::node][sfBalance.fieldName] == + STAmount(env.current()->fees().accountReserve(1)).getText()); + + jrr = ledgerEntryMPT(env, bob, USD); + BEAST_EXPECT(jrr[jss::node][sfMPTAmount.fieldName] == "300"); + } + + void + testGatewayCrossCurrency(FeatureBitset features) + { + testcase("Client Issue #535: Gateway Cross Currency"); + + using namespace jtx; + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + auto const base = env.current()->fees().base; + auto const starting_xrp = + XRP(100.1) + env.current()->fees().accountReserve(1) + base * 2; + + env.fund(starting_xrp, gw, alice, bob); + env.close(); + + auto const XTS = + issue1({.env = env, .token = "XTS", .issuer = gw, .holders = {alice, bob}}); + auto const XXX = + issue2({.env = env, .token = "XXX", .issuer = gw, .holders = {alice, bob}}); + env.close(); + + env(pay(gw, alice, XTS(1'000))); + env(pay(gw, alice, XXX(100))); + env(pay(gw, bob, XTS(1'000))); + env(pay(gw, bob, XXX(100))); + + env(offer(alice, XTS(1'000), XXX(100))); + + // WS client is used here because the RPC client could not + // be convinced to pass the build_path argument + auto wsc = makeWSClient(env.app().config()); + Json::Value payment; + payment[jss::secret] = toBase58(generateSeed("bob")); + payment[jss::id] = env.seq(bob); + payment[jss::build_path] = true; + payment[jss::tx_json] = pay(bob, bob, XXX(1)); + payment[jss::tx_json][jss::Sequence] = + env.current()->read(keylet::account(bob.id()))->getFieldU32(sfSequence); + payment[jss::tx_json][jss::Fee] = to_string(env.current()->fees().base); + payment[jss::tx_json][jss::SendMax] = XTS(15).value().getJson(JsonOptions::none); + auto jrr = wsc->invoke("submit", payment); + BEAST_EXPECT(jrr[jss::status] == "success"); + BEAST_EXPECT(jrr[jss::result][jss::engine_result] == "tesSUCCESS"); + if (wsc->version() == 2) + { + BEAST_EXPECT(jrr.isMember(jss::jsonrpc) && jrr[jss::jsonrpc] == "2.0"); + BEAST_EXPECT(jrr.isMember(jss::ripplerpc) && jrr[jss::ripplerpc] == "2.0"); + BEAST_EXPECT(jrr.isMember(jss::id) && jrr[jss::id] == 5); + } + + BEAST_EXPECT(env.balance(alice, XTS) == XTS(1010)); + BEAST_EXPECT(env.balance(alice, XXX) == XXX(99)); + + BEAST_EXPECT(env.balance(bob, XTS) == XTS(990)); + BEAST_EXPECT(env.balance(bob, XXX) == XXX(101)); + }; + testHelper2TokensMix(test); + } + + void + testPartialCross(FeatureBitset features) + { + // Test a number of different corner cases regarding adding a + // possibly crossable offer to an account. The test is table + // driven so it should be easy to add or remove tests. + testcase("Partial Crossing"); + + using namespace jtx; + + auto const gw = Account("gateway"); + + Env env{*this, features}; + + env.fund(XRP(10'000'000), gw); + env.close(); + + auto MUSD = MPTTester({.env = env, .issuer = gw}); + MPT const USD = MUSD; + + // The fee that's charged for transactions + auto const f = env.current()->fees().base; + + // To keep things simple all offers are 1 : 1 for XRP : USD. + enum preAuthType { noPreAuth, acctPreAuth }; + struct TestData + { + std::string account; // Account operated on + STAmount fundXrp; // Account funded with + int bookAmount; // USD -> XRP offer on the books + preAuthType preAuth; // If true, pre-auth MPToken + int offerAmount; // Account offers this much XRP -> USD + TER tec; // Returned tec code + STAmount spentXrp; // Amount removed from fundXrp + PrettyAmount balanceUsd; // Balance on account end + int offers; // Offers on account + int owners; // Owners on account + int scale = 1; // Scale MPT + }; + + // clang-format off + TestData const tests[]{ + // acct fundXrp bookAmt preTrust offerAmt tec spentXrp balanceUSD offers owners scale + {"ann", reserve(env, 0) + 0 * f, 1, noPreAuth, 1000, tecUNFUNDED_OFFER, f, USD( 0), 0, 0}, // Account is at the reserve, and will dip below once fees are subtracted. + {"bev", reserve(env, 0) + 1 * f, 1, noPreAuth, 1000, tecUNFUNDED_OFFER, f, USD( 0), 0, 0}, // Account has just enough for the reserve and the fee. + {"cam", reserve(env, 0) + 2 * f, 0, noPreAuth, 1000, tecINSUF_RESERVE_OFFER, f, USD( 0), 0, 0}, // Account has enough for the reserve, the fee and the offer, and a bit more, but not enough for the reserve after the offer is placed. + {"deb", reserve(env, 0) + 2 * f, 1, noPreAuth, 1000, tesSUCCESS, 2 * f, USD( 1), 0, 1, 100000}, // Account has enough to buy a little USD then the offer runs dry. + {"eve", reserve(env, 1) + 0 * f, 0, noPreAuth, 1000, tesSUCCESS, f, USD( 0), 1, 1}, // No offer to cross + {"flo", reserve(env, 1) + 0 * f, 1, noPreAuth, 1000, tesSUCCESS, XRP( 1) + f, USD( 1), 0, 1}, + {"gay", reserve(env, 1) + 1 * f, 1000, noPreAuth, 1000, tesSUCCESS, XRP( 50) + f, USD( 50), 0, 1}, + {"hye", XRP(1000) + 1 * f, 1000, noPreAuth, 1000, tesSUCCESS, XRP( 800) + f, USD( 800), 0, 1}, + {"ivy", XRP( 1) + reserve(env, 1) + 1 * f, 1, noPreAuth, 1000, tesSUCCESS, XRP( 1) + f, USD( 1), 0, 1}, + {"joy", XRP( 1) + reserve(env, 2) + 1 * f, 1, noPreAuth, 1000, tesSUCCESS, XRP( 1) + f, USD( 1), 1, 2}, + {"kim", XRP( 900) + reserve(env, 2) + 1 * f, 999, noPreAuth, 1000, tesSUCCESS, XRP( 999) + f, USD( 999), 0, 1}, + {"liz", XRP( 998) + reserve(env, 0) + 1 * f, 999, noPreAuth, 1000, tesSUCCESS, XRP( 998) + f, USD( 998), 0, 1}, + {"meg", XRP( 998) + reserve(env, 1) + 1 * f, 999, noPreAuth, 1000, tesSUCCESS, XRP( 999) + f, USD( 999), 0, 1}, + {"nia", XRP( 998) + reserve(env, 2) + 1 * f, 999, noPreAuth, 1000, tesSUCCESS, XRP( 999) + f, USD( 999), 1, 2}, + {"ova", XRP( 999) + reserve(env, 0) + 1 * f, 1000, noPreAuth, 1000, tesSUCCESS, XRP( 999) + f, USD( 999), 0, 1}, + {"pam", XRP( 999) + reserve(env, 1) + 1 * f, 1000, noPreAuth, 1000, tesSUCCESS, XRP(1000) + f, USD( 1000), 0, 1}, + {"rae", XRP( 999) + reserve(env, 2) + 1 * f, 1000, noPreAuth, 1000, tesSUCCESS, XRP(1000) + f, USD( 1000), 0, 1}, + {"sue", XRP(1000) + reserve(env, 2) + 1 * f, 0, noPreAuth, 1000, tesSUCCESS, f, USD( 0), 1, 1}, + //---------------- Pre-created MPT --------------------- + // Unlike from IOU, an issuer can't pre-create MPToken for an account (see similar tests in Offer_test.cpp) + {"ned", reserve(env, 1) + 0 * f, 1, acctPreAuth, 1000, tecUNFUNDED_OFFER, 2 * f, USD( 0), 0, 1}, + {"ole", reserve(env, 1) + 1 * f, 1, acctPreAuth, 1000, tecUNFUNDED_OFFER, 2 * f, USD( 0), 0, 1}, + {"pat", reserve(env, 1) + 2 * f, 0, acctPreAuth, 1000, tecUNFUNDED_OFFER, 2 * f, USD( 0), 0, 1}, + {"quy", reserve(env, 1) + 2 * f, 1, acctPreAuth, 1000, tecUNFUNDED_OFFER, 2 * f, USD( 0), 0, 1}, + {"ron", reserve(env, 1) + 3 * f, 0, acctPreAuth, 1000, tecINSUF_RESERVE_OFFER, 2 * f, USD( 0), 0, 1}, + {"syd", reserve(env, 1) + 3 * f, 1, acctPreAuth, 1000, tesSUCCESS, 3 * f, USD( 1), 0, 1, 100000}, + {"ted", XRP( 20) + reserve(env, 1) + 2 * f, 1000, acctPreAuth, 1000, tesSUCCESS, XRP(20) + 2 * f, USD( 20), 0, 1}, + {"uli", reserve(env, 2) + 0 * f, 0, acctPreAuth, 1000, tecINSUF_RESERVE_OFFER, 2 * f, USD( 0), 0, 1}, + {"vic", reserve(env, 2) + 0 * f, 1, acctPreAuth, 1000, tesSUCCESS, XRP( 1) + 2 * f, USD( 1), 0, 1}, + {"wes", reserve(env, 2) + 1 * f, 0, acctPreAuth, 1000, tesSUCCESS, 2 * f, USD( 0), 1, 2}, + {"xan", reserve(env, 2) + 1 * f, 1, acctPreAuth, 1000, tesSUCCESS, XRP( 1) + 2 * f, USD( 1), 1, 2}, + }; + // clang-format on + + for (auto const& t : tests) + { + auto const acct = Account(t.account); + env.fund(t.fundXrp, acct); + env.close(); + + // Make sure gateway has no current offers. + env.require(offers(gw, 0)); + + // The gateway optionally creates an offer that would be crossed. + auto const book = t.bookAmount; + if (book != 0) + env(offer(gw, XRP(book), USD(book * t.scale))); + env.close(); + std::uint32_t const gwOfferSeq = env.seq(gw) - 1; + + // Optionally pre-authorize MPT for acct. + // Note this is not really part of the test, so we expect there + // to be enough XRP reserve for acct to create the trust line. + if (t.preAuth == acctPreAuth) + MUSD.authorize({.account = acct}); + env.close(); + + { + // Acct creates an offer. This is the heart of the test. + auto const acctOffer = t.offerAmount; + env(offer(acct, USD(acctOffer * t.scale), XRP(acctOffer)), ter(t.tec)); + env.close(); + } + std::uint32_t const acctOfferSeq = env.seq(acct) - 1; + + auto const expBalanceUsd = [&]() { + if (t.scale == 1) + return t.balanceUsd; + // crossed offer has XRP available balance of 1 fee + // mpt to XRP ratio is 10 + return USD(f.value() / 10); + }(); + BEAST_EXPECT(env.balance(acct, USD) == expBalanceUsd); + BEAST_EXPECT(env.balance(acct, xrpIssue()) == t.fundXrp - t.spentXrp); + env.require(offers(acct, t.offers)); + env.require(owners(acct, t.owners)); + + auto acctOffers = offersOnAccount(env, acct); + BEAST_EXPECT(acctOffers.size() == t.offers); + if (!acctOffers.empty() && t.offers != 0) + { + auto const& acctOffer = *(acctOffers.front()); + + auto const leftover = t.offerAmount - t.bookAmount; + BEAST_EXPECT(acctOffer[sfTakerGets] == XRP(leftover)); + BEAST_EXPECT(acctOffer[sfTakerPays] == USD(leftover)); + } + + if (t.preAuth == noPreAuth) + { + if (t.balanceUsd.value().signum() != 0) + { + // Verify the correct contents of MPT + BEAST_EXPECT(env.balance(acct, USD) == expBalanceUsd); + } + else + { + // Verify that no MPT was created. + auto const sle = env.le(keylet::mptoken(USD.issuanceID, acct)); + BEAST_EXPECT(!sle); + } + } + + // Give the next loop a clean slate by canceling any left-overs + // in the offers. + env(offer_cancel(acct, acctOfferSeq)); + env(offer_cancel(gw, gwOfferSeq)); + env.close(); + } + } + + void + testXRPDirectCross(FeatureBitset features) + { + testcase("XRP Direct Crossing"); + + using namespace jtx; + + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + Env env{*this, features}; + + env.fund(XRP(1'000'000), gw, bob); + env.close(); + + // The fee that's charged for transactions. + auto const fee = env.current()->fees().base; + + // alice's account has enough for the reserve, one trust line plus two + // offers, and two fees. + env.fund(reserve(env, 2) + fee * 2, alice); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + auto const usdOffer = USD(1'000); + auto const xrpOffer = XRP(1'000); + + env(pay(gw, alice, usdOffer)); + env.close(); + env.require(balance(alice, usdOffer), offers(alice, 0), offers(bob, 0)); + + // The scenario: + // o alice has USD but wants XRP. + // o bob has XRP but wants USD. + auto const aliceXRP = env.balance(alice); + auto const bobsXRP = env.balance(bob); + + env(offer(alice, xrpOffer, usdOffer)); + env.close(); + env(offer(bob, usdOffer, xrpOffer)); + + env.close(); + env.require( + balance(alice, USD(0)), + balance(bob, usdOffer), + balance(alice, aliceXRP + xrpOffer - fee), + balance(bob, bobsXRP - xrpOffer - fee), + offers(alice, 0), + offers(bob, 0)); + + BEAST_EXPECT(env.balance(bob, USD) == usdOffer); + + // Make two more offers that leave one of the offers non-dry. + env(offer(alice, USD(999), XRP(999))); + env(offer(bob, xrpOffer, usdOffer)); + + env.close(); + env.require(balance(alice, USD(999))); + env.require(balance(bob, USD(1))); + env.require(offers(alice, 0)); + BEAST_EXPECT(env.balance(bob, USD) == USD(1)); + { + auto const bobsOffers = offersOnAccount(env, bob); + BEAST_EXPECT(bobsOffers.size() == 1); + auto const& bobsOffer = *(bobsOffers.front()); + + BEAST_EXPECT(bobsOffer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(bobsOffer[sfTakerGets] == USD(1)); + BEAST_EXPECT(bobsOffer[sfTakerPays] == XRP(1)); + } + } + + void + testDirectCross(FeatureBitset features) + { + testcase("Direct Crossing"); + + using namespace jtx; + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + env.fund(XRP(1000000), gw); + env.close(); + + // The fee that's charged for transactions. + auto const fee = env.current()->fees().base; + + // Each account has enough for the reserve, two MPT's, one + // offer, and two fees. + env.fund(reserve(env, 3) + fee * 3, alice); + env.fund(reserve(env, 3) + fee * 2, bob); + env.close(); + + auto const USD = issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice}}); + auto const EUR = issue2({.env = env, .token = "EUR", .issuer = gw, .holders = {bob}}); + + auto const usdOffer = USD(1'000); + auto const eurOffer = EUR(1'000); + + env(pay(gw, alice, usdOffer)); + env(pay(gw, bob, eurOffer)); + env.close(); + + env.require(balance(alice, usdOffer), balance(bob, eurOffer)); + + // The scenario: + // o alice has USD but wants EUR. + // o bob has EUR but wants USD. + env(offer(alice, eurOffer, usdOffer)); + env(offer(bob, usdOffer, eurOffer)); + + env.close(); + env.require( + balance(alice, eurOffer), balance(bob, usdOffer), offers(alice, 0), offers(bob, 0)); + + // Alice's offer crossing created a default EUR trustline and + // Bob's offer crossing created a default USD trustline: + BEAST_EXPECT(env.balance(alice, EUR) == eurOffer); + BEAST_EXPECT(env.balance(bob, USD) == usdOffer); + + // Make two more offers that leave one of the offers non-dry. + // Guarantee the order of application by putting a close() + // between them. + env(offer(bob, eurOffer, usdOffer)); + env.close(); + + env(offer(alice, USD(999), eurOffer)); + env.close(); + + env.require(offers(alice, 0)); + env.require(offers(bob, 1)); + + env.require(balance(alice, USD(999))); + env.require(balance(alice, EUR(1))); + env.require(balance(bob, USD(1))); + env.require(balance(bob, EUR(999))); + + { + auto bobsOffers = offersOnAccount(env, bob); + if (BEAST_EXPECT(bobsOffers.size() == 1)) + { + auto const& bobsOffer = *(bobsOffers.front()); + + BEAST_EXPECT(bobsOffer[sfTakerGets] == USD(1)); + BEAST_EXPECT(bobsOffer[sfTakerPays] == EUR(1)); + } + } + + // alice makes one more offer that cleans out bob's offer. + env(offer(alice, USD(1), EUR(1))); + env.close(); + + env.require(balance(alice, USD(1'000))); + env.require(balance(alice, EUR(none))); + env.require(balance(bob, USD(none))); + env.require(balance(bob, EUR(1'000))); + env.require(offers(alice, 0)); + env.require(offers(bob, 0)); + + // The two MPT that were generated by the offers still here + // Unlike IOU, MPToken is not automatically deleted + if constexpr (std::is_same_v, MPT>) + { + BEAST_EXPECT(env.le(keylet::mptoken(EUR.issuanceID, alice))); + auto MEUR = MPTTester(env, gw, EUR, {bob}); + // Delete created MPToken to free up reserve + MEUR.authorize({.account = alice, .flags = tfMPTUnauthorize}); + } + if constexpr (std::is_same_v, MPT>) + { + BEAST_EXPECT(env.le(keylet::mptoken(USD.issuanceID, bob))); + auto MUSD = MPTTester(env, gw, USD, {alice}); + // Delete created MPToken to free up reserve + MUSD.authorize({.account = bob, .flags = tfMPTUnauthorize}); + } + + // Make two more offers that leave one of the offers non-dry. We + // need to properly sequence the transactions: + env(offer(alice, EUR(999), usdOffer)); + env.close(); + + env(offer(bob, usdOffer, eurOffer)); + env.close(); + + env.require(offers(alice, 0)); + env.require(offers(bob, 0)); + + env.require(balance(alice, USD(0))); + env.require(balance(alice, EUR(999))); + env.require(balance(bob, USD(1'000))); + env.require(balance(bob, EUR(1))); + }; + testHelper2TokensMix(test); + } + + void + testBridgedCross(FeatureBitset features) + { + testcase("Bridged Crossing"); + + using namespace jtx; + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const carol = Account("carol"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + env.fund(XRP(1'000'000), gw, alice, bob, carol); + env.close(); + + auto const USD = issue1({.env = env, .token = "USD", .issuer = gw, .holders = {alice}}); + auto const EUR = issue2({.env = env, .token = "EUR", .issuer = gw, .holders = {carol}}); + + auto const usdOffer = USD(1'000); + auto const eurOffer = EUR(1'000); + + env(pay(gw, alice, usdOffer)); + env(pay(gw, carol, eurOffer)); + env.close(); + + // The scenario: + // o alice has USD but wants XRP. + // o bob has XRP but wants EUR. + // o carol has EUR but wants USD. + // Note that carol's offer must come last. If carol's offer is + // placed before bob's or alice's, then autobridging will not occur. + env(offer(alice, XRP(1'000), usdOffer)); + env(offer(bob, eurOffer, XRP(1'000))); + auto const bobXrpBalance = env.balance(bob); + env.close(); + + // carol makes an offer that partially consumes alice and bob's + // offers. + env(offer(carol, USD(400), EUR(400))); + env.close(); + + env.require( + balance(alice, USD(600)), + balance(bob, EUR(400)), + balance(carol, USD(400)), + balance(bob, bobXrpBalance - XRP(400)), + offers(carol, 0)); + BEAST_EXPECT(env.balance(bob, EUR) == EUR(400)); + BEAST_EXPECT(env.balance(carol, USD) == USD(400)); + { + auto const aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + auto const& aliceOffer = *(aliceOffers.front()); + + BEAST_EXPECT(aliceOffer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(aliceOffer[sfTakerGets] == USD(600)); + BEAST_EXPECT(aliceOffer[sfTakerPays] == XRP(600)); + } + { + auto const bobsOffers = offersOnAccount(env, bob); + BEAST_EXPECT(bobsOffers.size() == 1); + auto const& bobsOffer = *(bobsOffers.front()); + + BEAST_EXPECT(bobsOffer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(bobsOffer[sfTakerGets] == XRP(600)); + BEAST_EXPECT(bobsOffer[sfTakerPays] == EUR(600)); + } + + // carol makes an offer that exactly consumes alice and bob's + // offers. + env(offer(carol, USD(600), EUR(600))); + env.close(); + + env.require( + balance(alice, USD(0)), + balance(bob, eurOffer), + balance(carol, usdOffer), + balance(bob, bobXrpBalance - XRP(1'000)), + offers(bob, 0), + offers(carol, 0)); + BEAST_EXPECT(env.balance(bob, EUR) == EUR(1'000)); + BEAST_EXPECT(env.balance(carol, USD) == USD(1'000)); + + // In pre-flow code alice's offer is left empty in the ledger. + auto const aliceOffers = offersOnAccount(env, alice); + if (!aliceOffers.empty()) + { + BEAST_EXPECT(aliceOffers.size() == 1); + auto const& aliceOffer = *(aliceOffers.front()); + + BEAST_EXPECT(aliceOffer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(aliceOffer[sfTakerGets] == USD(0)); + BEAST_EXPECT(aliceOffer[sfTakerPays] == XRP(0)); + } + }; + testHelper2TokensMix(test); + } + + void + testSellOffer(FeatureBitset features) + { + // Test a number of different corner cases regarding offer crossing + // when the tfSell flag is set. The test is table driven so it + // should be easy to add or remove tests. + testcase("Sell Offer"); + + using namespace jtx; + + auto const gw = Account("gateway"); + + Env env{*this, features}; + + env.fund(XRP(10'000'000), gw); + + auto MUSD = MPTTester({.env = env, .issuer = gw}); + MPT const USD = MUSD; + + // The fee that's charged for transactions + auto const f = env.current()->fees().base; + + // To keep things simple all offers are 1 : 1 for XRP : USD. + struct TestData + { + std::string account; // Account operated on + STAmount fundXrp; // XRP acct funded with + STAmount fundUSD; // USD acct funded with + STAmount gwGets; // gw's offer + STAmount gwPays; // + STAmount acctGets; // acct's offer + STAmount acctPays; // + TER tec; // Returned tec code + STAmount spentXrp; // Amount removed from fundXrp + STAmount finalUsd; // Final USD balance on acct + int offers; // Offers on acct + int owners; // Owners on acct + STAmount takerGets; // Remainder of acct's offer + STAmount takerPays; // + + // Constructor with takerGets/takerPays + TestData( + std::string&& account_, // Account operated on + STAmount const& fundXrp_, // XRP acct funded with + STAmount const& fundUSD_, // USD acct funded with + STAmount const& gwGets_, // gw's offer + STAmount const& gwPays_, // + STAmount const& acctGets_, // acct's offer + STAmount const& acctPays_, // + TER tec_, // Returned tec code + STAmount const& spentXrp_, // Amount removed from fundXrp + STAmount const& finalUsd_, // Final USD balance on acct + int offers_, // Offers on acct + int owners_, // Owners on acct + STAmount const& takerGets_, // Remainder of acct's offer + STAmount const& takerPays_) // + : account(std::move(account_)) + , fundXrp(fundXrp_) + , fundUSD(fundUSD_) + , gwGets(gwGets_) + , gwPays(gwPays_) + , acctGets(acctGets_) + , acctPays(acctPays_) + , tec(tec_) + , spentXrp(spentXrp_) + , finalUsd(finalUsd_) + , offers(offers_) + , owners(owners_) + , takerGets(takerGets_) + , takerPays(takerPays_) + { + } + + // Constructor without takerGets/takerPays + TestData( + std::string&& account_, // Account operated on + STAmount const& fundXrp_, // XRP acct funded with + STAmount const& fundUSD_, // USD acct funded with + STAmount const& gwGets_, // gw's offer + STAmount const& gwPays_, // + STAmount const& acctGets_, // acct's offer + STAmount const& acctPays_, // + TER tec_, // Returned tec code + STAmount const& spentXrp_, // Amount removed from fundXrp + STAmount const& finalUsd_, // Final USD balance on acct + int offers_, // Offers on acct + int owners_) // Owners on acct + : TestData( + std::move(account_), + fundXrp_, + fundUSD_, + gwGets_, + gwPays_, + acctGets_, + acctPays_, + tec_, + spentXrp_, + finalUsd_, + offers_, + owners_, + STAmount{0}, + STAmount{0}) + { + } + }; + + // clang-format off + TestData const tests[]{ + // acct pays XRP + // acct fundXrp fundUSD gwGets gwPays acctGets acctPays tec spentXrp finalUSD offers owners takerGets takerPays + {"ann", XRP(10) + reserve(env, 0) + 1 * f, USD( 0), XRP(10), USD( 5), USD(10), XRP(10), tecINSUF_RESERVE_OFFER, XRP( 0) + (1 * f), USD( 0), 0, 0}, + {"bev", XRP(10) + reserve(env, 1) + 1 * f, USD( 0), XRP(10), USD( 5), USD(10), XRP(10), tesSUCCESS, XRP( 0) + (1 * f), USD( 0), 1, 1, XRP(10), USD(10)}, + {"cam", XRP(10) + reserve(env, 0) + 1 * f, USD( 0), XRP(10), USD(10), USD(10), XRP(10), tesSUCCESS, XRP( 10) + (1 * f), USD(10), 0, 1}, + {"deb", XRP(10) + reserve(env, 0) + 1 * f, USD( 0), XRP(10), USD(20), USD(10), XRP(10), tesSUCCESS, XRP( 10) + (1 * f), USD(20), 0, 1}, + {"eve", XRP(10) + reserve(env, 0) + 1 * f, USD( 0), XRP(10), USD(20), USD( 5), XRP( 5), tesSUCCESS, XRP( 5) + (1 * f), USD(10), 0, 1}, + {"flo", XRP(10) + reserve(env, 0) + 1 * f, USD( 0), XRP(10), USD(20), USD(20), XRP(20), tesSUCCESS, XRP( 10) + (1 * f), USD(20), 0, 1}, + {"gay", XRP(20) + reserve(env, 1) + 1 * f, USD( 0), XRP(10), USD(20), USD(20), XRP(20), tesSUCCESS, XRP( 10) + (1 * f), USD(20), 0, 1}, + {"hye", XRP(20) + reserve(env, 2) + 1 * f, USD( 0), XRP(10), USD(20), USD(20), XRP(20), tesSUCCESS, XRP( 10) + (1 * f), USD(20), 1, 2, XRP(10), USD(10)}, + // acct pays USD + {"meg", reserve(env, 1) + 2 * f, USD(10), USD(10), XRP( 5), XRP(10), USD(10), tecINSUF_RESERVE_OFFER, XRP( 0) + (2 * f), USD(10), 0, 1}, + {"nia", reserve(env, 2) + 2 * f, USD(10), USD(10), XRP( 5), XRP(10), USD(10), tesSUCCESS, XRP( 0) + (2 * f), USD(10), 1, 2, USD(10), XRP(10)}, + {"ova", reserve(env, 1) + 2 * f, USD(10), USD(10), XRP(10), XRP(10), USD(10), tesSUCCESS, XRP(-10) + (2 * f), USD( 0), 0, 1}, + {"pam", reserve(env, 1) + 2 * f, USD(10), USD(10), XRP(20), XRP(10), USD(10), tesSUCCESS, XRP(-20) + (2 * f), USD( 0), 0, 1}, + {"qui", reserve(env, 1) + 2 * f, USD(10), USD(20), XRP(40), XRP(10), USD(10), tesSUCCESS, XRP(-20) + (2 * f), USD( 0), 0, 1}, + {"rae", reserve(env, 2) + 2 * f, USD(10), USD( 5), XRP( 5), XRP(10), USD(10), tesSUCCESS, XRP( -5) + (2 * f), USD( 5), 1, 2, USD( 5), XRP( 5)}, + {"sue", reserve(env, 2) + 2 * f, USD(10), USD( 5), XRP(10), XRP(10), USD(10), tesSUCCESS, XRP(-10) + (2 * f), USD( 5), 1, 2, USD( 5), XRP( 5)}, + }; + // clang-format on + + auto const zeroUsd = USD(0); + for (auto const& t : tests) + { + // Make sure gateway has no current offers. + env.require(offers(gw, 0)); + + auto const acct = Account(t.account); + + env.fund(t.fundXrp, acct); + env.close(); + + // Optionally give acct some USD. This is not part of the test, + // so we assume that acct has sufficient USD to cover the reserve + // on the trust line. + if (t.fundUSD != zeroUsd) + { + MUSD.authorize({.account = acct}); + env.close(); + env(pay(gw, acct, t.fundUSD)); + env.close(); + } + + env(offer(gw, t.gwGets, t.gwPays)); + env.close(); + std::uint32_t const gwOfferSeq = env.seq(gw) - 1; + + // Acct creates a tfSell offer. This is the heart of the test. + env(offer(acct, t.acctGets, t.acctPays, tfSell), ter(t.tec)); + env.close(); + std::uint32_t const acctOfferSeq = env.seq(acct) - 1; + + // Check results + BEAST_EXPECT(env.balance(acct, USD) == t.finalUsd); + BEAST_EXPECT(env.balance(acct, xrpIssue()) == t.fundXrp - t.spentXrp); + env.require(offers(acct, t.offers)); + env.require(owners(acct, t.owners)); + + if (t.offers != 0) + { + auto const acctOffers = offersOnAccount(env, acct); + if (!acctOffers.empty()) + { + BEAST_EXPECT(acctOffers.size() == 1); + auto const& acctOffer = *(acctOffers.front()); + + BEAST_EXPECT(acctOffer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(acctOffer[sfTakerGets] == t.takerGets); + BEAST_EXPECT(acctOffer[sfTakerPays] == t.takerPays); + } + } + + // Give the next loop a clean slate by canceling any left-overs + // in the offers. + env(offer_cancel(acct, acctOfferSeq)); + env(offer_cancel(gw, gwOfferSeq)); + env.close(); + } + } + + void + testSellWithFillOrKill(FeatureBitset features) + { + // Test a number of different corner cases regarding offer crossing + // when both the tfSell flag and tfFillOrKill flags are set. + testcase("Combine tfSell with tfFillOrKill"); + + using namespace jtx; + + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + Env env{*this, features}; + + env.fund(XRP(10'000'000), gw, alice, bob); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {bob}}); + + // bob offers XRP for USD. + env(pay(gw, bob, USD(100))); + env.close(); + env(offer(bob, XRP(2'000), USD(20))); + env.close(); + { + // alice submits a tfSell | tfFillOrKill offer that does not cross. + env(offer(alice, USD(21), XRP(2'100), tfSell | tfFillOrKill), ter(tecKILLED)); + env.close(); + env.require(balance(alice, USD(none))); + env.require(offers(alice, 0)); + env.require(balance(bob, USD(100))); + } + { + // alice submits a tfSell | tfFillOrKill offer that crosses. + // Even though tfSell is present it doesn't matter this time. + env(offer(alice, USD(20), XRP(2'000), tfSell | tfFillOrKill)); + env.close(); + env.require(balance(alice, USD(20))); + env.require(offers(alice, 0)); + env.require(balance(bob, USD(80))); + } + { + // alice submits a tfSell | tfFillOrKill offer that crosses and + // returns more than was asked for (because of the tfSell flag). + env(offer(bob, XRP(2'000), USD(20))); + env.close(); + env(offer(alice, USD(10), XRP(1'500), tfSell | tfFillOrKill)); + env.close(); + env.require(balance(alice, USD(35))); + env.require(offers(alice, 0)); + env.require(balance(bob, USD(65))); + } + { + // alice submits a tfSell | tfFillOrKill offer that doesn't cross. + // This would have succeeded with a regular tfSell, but the + // fillOrKill prevents the transaction from crossing since not + // all of the offer is consumed. + + // We're using bob's left-over offer for XRP(500), USD(5) + env(offer(alice, USD(1), XRP(501), tfSell | tfFillOrKill), ter(tecKILLED)); + env.close(); + env.require(balance(alice, USD(35))); + env.require(offers(alice, 0)); + env.require(balance(bob, USD(65))); + } + { + // Alice submits a tfSell | tfFillOrKill offer that finishes + // off the remainder of bob's offer. + + // We're using bob's left-over offer for XRP(500), USD(5) + env(offer(alice, USD(1), XRP(500), tfSell | tfFillOrKill)); + env.close(); + env.require(balance(alice, USD(40))); + env.require(offers(alice, 0)); + env.require(balance(bob, USD(60))); + } + } + + void + testTransferRateOffer(FeatureBitset features) + { + testcase("Transfer Rate Offer"); + + using namespace jtx; + auto const gw1 = Account("gateway1"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + // The fee that's charged for transactions. + auto const fee = env.current()->fees().base; + + env.fund(XRP(100'000), gw1); + env.close(); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = gw1, .transferFee = 25'000}); + using tUSD = std::decay_t; + { + auto const ann = Account("ann"); + auto const bob = Account("bob"); + env.fund(XRP(100) + reserve(env, 2) + (fee * 2), ann, bob); + env.close(); + + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw1, USD); + MUSD.authorize({.account = ann}); + MUSD.authorize({.account = bob}); + } + else + { + env(trust(ann, USD(20'000))); + env(trust(bob, USD(20'000))); + env.close(); + } + + env(pay(gw1, bob, USD(12'500))); + env.close(); + + // bob offers to sell USD(100) for XRP. alice takes bob's + // offer. Notice that although bob only offered USD(100), + // USD(125) was removed from his account due to the gateway fee. + // + // A comparable payment would look like this: + // env (pay (bob, alice, USD(100)), sendmax(USD(125))) + env(offer(bob, XRP(1), USD(10'000))); + env.close(); + + env(offer(ann, USD(10'000), XRP(1))); + env.close(); + + env.require(balance(ann, USD(10'000))); + env.require(balance(ann, XRP(99) + reserve(env, 2))); + env.require(offers(ann, 0)); + + env.require(balance(bob, USD(0))); + env.require(balance(bob, XRP(101) + reserve(env, 2))); + env.require(offers(bob, 0)); + } + { + // Reverse the order, so the offer in the books is to sell XRP + // in return for USD. Gateway rate should still apply + // identically. + auto const che = Account("che"); + auto const deb = Account("deb"); + env.fund(XRP(100) + reserve(env, 2) + (fee * 2), che, deb); + env.close(); + + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw1, USD); + MUSD.authorize({.account = che}); + MUSD.authorize({.account = deb}); + } + else + { + env(trust(che, USD(20'000))); + env(trust(deb, USD(20'000))); + env.close(); + } + + env(pay(gw1, deb, USD(12'500))); + env.close(); + + env(offer(che, USD(10'000), XRP(1))); + env.close(); + + env(offer(deb, XRP(1), USD(10'000))); + env.close(); + + env.require(balance(che, USD(10'000))); + env.require(balance(che, XRP(99) + reserve(env, 2))); + env.require(offers(che, 0)); + + env.require(balance(deb, USD(0))); + env.require(balance(deb, XRP(101) + reserve(env, 2))); + env.require(offers(deb, 0)); + } + { + auto const eve = Account("eve"); + auto const fyn = Account("fyn"); + + env.fund(XRP(20'000) + (fee * 2), eve, fyn); + env.close(); + + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw1, USD); + MUSD.authorize({.account = eve}); + MUSD.authorize({.account = fyn}); + } + else + { + env(trust(eve, USD(20'000))); + env(trust(fyn, USD(20'000))); + env.close(); + } + + env(pay(gw1, eve, USD(10'000))); + env(pay(gw1, fyn, USD(10'000))); + env.close(); + + // This test verifies that the amount removed from an offer + // accounts for the transfer fee that is removed from the + // account but not from the remaining offer. + env(offer(eve, USD(1'000), XRP(4'000))); + env.close(); + std::uint32_t const eveOfferSeq = env.seq(eve) - 1; + + env(offer(fyn, XRP(2'000), USD(500))); + env.close(); + + env.require(balance(eve, USD(10'500))); + env.require(balance(eve, XRP(18'000))); + auto const evesOffers = offersOnAccount(env, eve); + BEAST_EXPECT(evesOffers.size() == 1); + if (!evesOffers.empty()) + { + auto const& evesOffer = *(evesOffers.front()); + BEAST_EXPECT(evesOffer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(evesOffer[sfTakerGets] == XRP(2'000)); + BEAST_EXPECT(evesOffer[sfTakerPays] == USD(500)); + } + env(offer_cancel(eve, eveOfferSeq)); // For later tests + + env.require(balance(fyn, USD(9'375))); + env.require(balance(fyn, XRP(22'000))); + env.require(offers(fyn, 0)); + } + // Start messing with two non-native currencies. + auto const gw2 = Account("gateway2"); + + env.fund(XRP(100'000), gw2); + env.close(); + + auto const EUR = + issue2({.env = env, .token = "EUR", .issuer = gw2, .transferFee = 50'000}); + using tEUR = std::decay_t; + { + // Remove XRP from the equation. Give the two currencies two + // different transfer rates so we can see both transfer rates + // apply in the same transaction. + auto const gay = Account("gay"); + auto const hal = Account("hal"); + env.fund(reserve(env, 3) + (fee * 3), gay, hal); + env.close(); + + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw1, USD); + MUSD.authorize({.account = gay}); + MUSD.authorize({.account = hal}); + } + else + { + env(trust(gay, USD(20'000))); + env(trust(hal, USD(20'000))); + env.close(); + } + if constexpr (std::is_same_v) + { + auto MEUR = MPTTester(env, gw2, EUR); + MEUR.authorize({.account = gay}); + MEUR.authorize({.account = hal}); + } + else + { + env(trust(gay, EUR(20'000))); + env(trust(hal, EUR(20'000))); + env.close(); + } + + env(pay(gw1, gay, USD(12'500))); + env(pay(gw2, hal, EUR(150))); + env.close(); + + env(offer(gay, EUR(100), USD(10'000))); + env.close(); + + env(offer(hal, USD(10'000), EUR(100))); + env.close(); + + env.require(balance(gay, USD(0))); + env.require(balance(gay, EUR(100))); + env.require(balance(gay, reserve(env, 3))); + env.require(offers(gay, 0)); + + env.require(balance(hal, USD(10'000))); + env.require(balance(hal, EUR(0))); + env.require(balance(hal, reserve(env, 3))); + env.require(offers(hal, 0)); + } + + { + // Make sure things work right when we're auto-bridging as well. + auto const ova = Account("ova"); + auto const pat = Account("pat"); + auto const qae = Account("qae"); + env.fund(XRP(2) + reserve(env, 3) + (fee * 3), ova, pat, qae); + env.close(); + + // o ova has USD but wants XRP. + // o pat has XRP but wants EUR. + // o qae has EUR but wants USD. + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw1, USD); + MUSD.authorize({.account = ova}); + MUSD.authorize({.account = pat}); + MUSD.authorize({.account = qae}); + } + else + { + env(trust(ova, USD(20'000))); + env(trust(pat, USD(20'000))); + env(trust(qae, USD(20'000))); + env.close(); + } + if constexpr (std::is_same_v) + { + auto MEUR = MPTTester(env, gw2, EUR); + MEUR.authorize({.account = ova}); + MEUR.authorize({.account = pat}); + MEUR.authorize({.account = qae}); + } + else + { + env(trust(ova, EUR(20'000))); + env(trust(pat, EUR(20'000))); + env(trust(qae, EUR(20'000))); + env.close(); + } + + env(pay(gw1, ova, USD(12'500))); + env(pay(gw2, qae, EUR(150))); + env.close(); + + env(offer(ova, XRP(2), USD(10'000))); + env(offer(pat, EUR(100), XRP(2))); + env.close(); + + env(offer(qae, USD(10'000), EUR(100))); + env.close(); + + env.require(balance(ova, USD(0))); + env.require(balance(ova, EUR(0))); + env.require(balance(ova, XRP(4) + reserve(env, 3))); + + // In pre-flow code ova's offer is left empty in the ledger. + auto const ovasOffers = offersOnAccount(env, ova); + if (!ovasOffers.empty()) + { + BEAST_EXPECT(ovasOffers.size() == 1); + auto const& ovasOffer = *(ovasOffers.front()); + + BEAST_EXPECT(ovasOffer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(ovasOffer[sfTakerGets] == USD(0)); + BEAST_EXPECT(ovasOffer[sfTakerPays] == XRP(0)); + } + + env.require(balance(pat, USD(0))); + env.require(balance(pat, EUR(100))); + env.require(balance(pat, XRP(0) + reserve(env, 3))); + env.require(offers(pat, 0)); + + env.require(balance(qae, USD(10'000))); + env.require(balance(qae, EUR(0))); + env.require(balance(qae, XRP(2) + reserve(env, 3))); + env.require(offers(qae, 0)); + } + }; + testHelper2TokensMix(test); + } + + void + testSelfCrossOffer1(FeatureBitset features) + { + // The following test verifies some correct but slightly surprising + // behavior in offer crossing. The scenario: + // + // o An entity has created one or more offers. + // o The entity creates another offer that can be directly crossed + // (not autobridged) by the previously created offer(s). + // o Rather than self crossing the offers, delete the old offer(s). + // + // See a more complete explanation in the comments for + // BookOfferCrossingStep::limitSelfCrossQuality(). + // + // Note that, in this particular example, one offer causes several + // crossable offers (worth considerably more than the new offer) + // to be removed from the book. + using namespace jtx; + + auto const gw = Account("gateway"); + + Env env{*this, features}; + + // The fee that's charged for transactions. + auto const fee = env.current()->fees().base; + auto const startBalance = XRP(1'000'000); + + env.fund(startBalance + (fee * 5), gw); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw}); + + env(offer(gw, USD(60), XRP(600))); + env.close(); + env(offer(gw, USD(60), XRP(600))); + env.close(); + env(offer(gw, USD(60), XRP(600))); + env.close(); + + // three offers + MPTokenIssuance + env.require(owners(gw, 4)); + env.require(balance(gw, startBalance + fee)); + + auto gwOffers = offersOnAccount(env, gw); + BEAST_EXPECT(gwOffers.size() == 3); + for (auto const& offerPtr : gwOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == XRP(600)); + BEAST_EXPECT(offer[sfTakerPays] == USD(60)); + } + + // Since this offer crosses the first offers, the previous offers + // will be deleted and this offer will be put on the order book. + env(offer(gw, XRP(1'000), USD(100))); + env.close(); + env.require(owners(gw, 2)); + env.require(offers(gw, 1)); + env.require(balance(gw, startBalance)); + + gwOffers = offersOnAccount(env, gw); + BEAST_EXPECT(gwOffers.size() == 1); + for (auto const& offerPtr : gwOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == USD(100)); + BEAST_EXPECT(offer[sfTakerPays] == XRP(1'000)); + } + } + + void + testSelfCrossOffer2(FeatureBitset features) + { + using namespace jtx; + + auto const gw1 = Account("gateway1"); + auto const gw2 = Account("gateway2"); + auto const alice = Account("alice"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + env.fund(XRP(1'000'000), gw1, gw2); + env.close(); + + auto const USD = issue1({.env = env, .token = "USD", .issuer = gw1}); + using tUSD = std::decay_t; + auto const EUR = issue2({.env = env, .token = "EUR", .issuer = gw2}); + using tEUR = std::decay_t; + + // The fee that's charged for transactions. + auto const f = env.current()->fees().base; + + // Test cases + struct TestData + { + std::string acct; // Account operated on + STAmount fundXRP; // XRP acct funded with + STAmount fundUSD; // USD acct funded with + STAmount fundEUR; // EUR acct funded with + TER firstOfferTec; // tec code on first offer + TER secondOfferTec; // tec code on second offer + }; + + // clang-format off + TestData const tests[]{ + // acct fundXRP fundUSD fundEUR firstOfferTec secondOfferTec + {"ann", reserve(env, 3) + f * 4, USD(1000), EUR(1000), tesSUCCESS, tesSUCCESS}, + {"bev", reserve(env, 3) + f * 4, USD( 1), EUR(1000), tesSUCCESS, tesSUCCESS}, + {"cam", reserve(env, 3) + f * 4, USD(1000), EUR( 1), tesSUCCESS, tesSUCCESS}, + {"deb", reserve(env, 3) + f * 4, USD( 0), EUR( 1), tesSUCCESS, tecUNFUNDED_OFFER}, + {"eve", reserve(env, 3) + f * 4, USD( 1), EUR( 0), tecUNFUNDED_OFFER, tesSUCCESS}, + {"flo", reserve(env, 3) + 0, USD(1000), EUR(1000), tecINSUF_RESERVE_OFFER, tecINSUF_RESERVE_OFFER}, + }; + //clang-format on + + for (auto const& t : tests) + { + auto const acct = Account{t.acct}; + env.fund(t.fundXRP, acct); + env.close(); + + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw1, USD); + MUSD.authorize({.account = acct}); + } + else + { + env(trust(acct, USD(1'000))); + env.close(); + } + if constexpr (std::is_same_v) + { + auto MEUR = MPTTester(env, gw2, EUR); + MEUR.authorize({.account = acct}); + } + else + { + env(trust(acct, EUR(1'000))); + env.close(); + } + + if (t.fundUSD > USD(0)) + env(pay(gw1, acct, t.fundUSD)); + if (t.fundEUR > EUR(0)) + env(pay(gw2, acct, t.fundEUR)); + env.close(); + + env(offer(acct, USD(500), EUR(600)), ter(t.firstOfferTec)); + env.close(); + std::uint32_t const firstOfferSeq = env.seq(acct) - 1; + + int offerCount = t.firstOfferTec == tesSUCCESS ? 1 : 0; + env.require(owners(acct, 2 + offerCount)); + env.require(balance(acct, t.fundUSD)); + env.require(balance(acct, t.fundEUR)); + + auto acctOffers = offersOnAccount(env, acct); + BEAST_EXPECT(acctOffers.size() == offerCount); + for (auto const& offerPtr : acctOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == EUR(600)); + BEAST_EXPECT(offer[sfTakerPays] == USD(500)); + } + + env(offer(acct, EUR(600), USD(500)), ter(t.secondOfferTec)); + env.close(); + std::uint32_t const secondOfferSeq = env.seq(acct) - 1; + + offerCount = t.secondOfferTec == tesSUCCESS ? 1 : offerCount; + env.require(owners(acct, 2 + offerCount)); + env.require(balance(acct, t.fundUSD)); + env.require(balance(acct, t.fundEUR)); + + acctOffers = offersOnAccount(env, acct); + BEAST_EXPECT(acctOffers.size() == offerCount); + for (auto const& offerPtr : acctOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + if (offer[sfSequence] == firstOfferSeq) + { + BEAST_EXPECT(offer[sfTakerGets] == EUR(600)); + BEAST_EXPECT(offer[sfTakerPays] == USD(500)); + } + else + { + BEAST_EXPECT(offer[sfTakerGets] == USD(500)); + BEAST_EXPECT(offer[sfTakerPays] == EUR(600)); + } + } + + // Remove any offers from acct for the next pass. + env(offer_cancel(acct, firstOfferSeq)); + env.close(); + env(offer_cancel(acct, secondOfferSeq)); + env.close(); + } + }; + testHelper2TokensMix(test); + } + + void + testSelfCrossOffer(FeatureBitset features) + { + testcase("Self Cross Offer"); + testSelfCrossOffer1(features); + testSelfCrossOffer2(features); + } + + void + testSelfIssueOffer(FeatureBitset features) + { + // Folks who issue their own currency have, in effect, as many + // funds as they are trusted for. This test used to fail because + // self-issuing was not properly checked. Verify that it works + // correctly now. + using namespace jtx; + + Env env{*this, features}; + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const f = env.current()->fees().base; + + env.fund(XRP(50'000) + f, alice, bob); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = bob}); + + env(offer(alice, USD(5'000), XRP(50'000))); + env.close(); + + // This offer should take alice's offer up to Alice's reserve. + env(offer(bob, XRP(50'000), USD(5'000))); + env.close(); + + // alice's offer should have been removed, since she's down to her + // XRP reserve. + env.require(balance(alice, XRP(250))); + env.require(owners(alice, 1)); + env.require(mptokens(alice, 1)); + + // However bob's offer should be in the ledger, since it was not + // fully crossed. + auto const bobOffers = offersOnAccount(env, bob); + BEAST_EXPECT(bobOffers.size() == 1); + for (auto const& offerPtr : bobOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == USD(25)); + BEAST_EXPECT(offer[sfTakerPays] == XRP(250)); + } + } + + void + testDirectToDirectPath(FeatureBitset features) + { + // The offer crossing code expects that a DirectStep is always + // preceded by a BookStep. In one instance the default path + // was not matching that assumption. Here we recreate that case + // so we can prove the bug stays fixed. + testcase("Direct to Direct path"); + + using namespace jtx; + auto const ann = Account("ann"); + auto const bob = Account("bob"); + auto const cam = Account("cam"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + auto const fee = env.current()->fees().base; + env.fund(reserve(env, 4) + (fee * 5), ann, bob, cam); + env.close(); + + auto const A_BUX = issue1( + {.env = env, .token = "AUX", .issuer = ann, .holders = {cam}}); + auto const B_BUX = issue2( + {.env = env, + .token = "BUX", + .issuer = bob, + .holders = {ann, cam}}); + + env(pay(ann, cam, A_BUX(35))); + env(pay(bob, cam, B_BUX(35))); + + env(offer(bob, A_BUX(30), B_BUX(30))); + env.close(); + + // cam puts an offer on the books that her upcoming offer could + // cross. But this offer should be deleted, not crossed, by her + // upcoming offer. + env(offer(cam, A_BUX(29), B_BUX(30), tfPassive)); + env.close(); + env.require(balance(cam, A_BUX(35))); + env.require(balance(cam, B_BUX(35))); + env.require(offers(cam, 1)); + + // This offer caused the assert. + env(offer(cam, B_BUX(30), A_BUX(30))); + env.close(); + + env.require(balance(bob, A_BUX(30))); + env.require(balance(cam, A_BUX(5))); + env.require(balance(cam, B_BUX(65))); + env.require(offers(cam, 0)); + }; + testHelper2TokensMix(test); + } + + void + testSelfCrossLowQualityOffer(FeatureBitset features) + { + // The Flow offer crossing code used to assert if an offer was made + // for more XRP than the offering account held. This unit test + // reproduces that failing case. + testcase("Self crossing low quality offer"); + + using namespace jtx; + + Env env{*this, features}; + + auto const ann = Account("ann"); + auto const gw = Account("gateway"); + + auto const fee = env.current()->fees().base; + env.fund(reserve(env, 2) + drops(9999640) + (fee), ann); + env.fund(reserve(env, 2) + (fee * 4), gw); + env.close(); + + MPT const BTC = MPTTester( + {.env = env, .issuer = gw, .holders = {ann}, .transferFee = 2'000}); + + env(pay(gw, ann, BTC(2'856))); + env.close(); + + env(offer(ann, drops(365'611'702'030), BTC(5'713))); + env.close(); + + // This offer caused the assert. + env(offer(ann, BTC(687), drops(20'000'000'000)), + ter(tecINSUF_RESERVE_OFFER)); + } + + void + testOfferInScaling(FeatureBitset features) + { + // The Flow offer crossing code had a case where it was not rounding + // the offer crossing correctly after a partial crossing. The + // failing case was found on the network. Here we add the case to + // the unit tests. + testcase("Offer In Scaling"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + auto const fee = env.current()->fees().base; + env.fund(reserve(env, 2) + drops(400'000'000'000) + (fee), alice, bob); + env.fund(reserve(env, 2) + (fee * 4), gw); + env.close(); + + MPT const CNY = MPTTester({.env = env, .issuer = gw, .holders = {bob}}); + + env(pay(gw, bob, CNY(3'000'000))); + env.close(); + + env(offer(bob, drops(5'400'000'000), CNY(2'160'540))); + env.close(); + + // This offer did not round result of partial crossing correctly. + env(offer(alice, CNY(135'620'001), drops(339'000'000'000))); + env.close(); + + auto const aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + for (auto const& offerPtr : aliceOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + BEAST_EXPECT(offer[sfTakerGets] == drops(333'599'446'582)); + BEAST_EXPECT(offer[sfTakerPays] == CNY(13'3459'461)); + } + } + + void + testOfferInScalingWithXferRate(FeatureBitset features) + { + // After adding the previous case, there were still failing rounding + // cases in Flow offer crossing. This one was because the gateway + // transfer rate was not being correctly handled. + testcase("Offer In Scaling With Xfer Rate"); + + using namespace jtx; + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + + auto const fee = env.current()->fees().base; + env.fund( + reserve(env, 2) + drops(400'000'000'000) + fee, + alice, + bob); + env.fund(reserve(env, 2) + (fee * 4), gw); + env.close(); + + auto const JPY = issue1( + {.env = env, + .token = "JPY", + .issuer = gw, + .holders = {alice}, + .limit = maxMPTokenAmount, + .transferFee = 2'000}); + auto const BTC = issue2( + {.env = env, + .token = "BTC", + .issuer = gw, + .holders = {bob}, + .limit = maxMPTokenAmount, + .transferFee = 2'000}); + + env(pay(gw, alice, JPY(3'699'034'802'280'317))); + env(pay(gw, bob, BTC(115'672'255'914'031'100))); + env.close(); + + env(offer( + bob, JPY(1'241'913'390'770'747), BTC(1'969'825'690'469'254))); + env.close(); + + // This offer did not round result of partial crossing correctly. + env(offer( + alice, BTC(5'507'568'706'427'876), JPY(3'472'696'773'391'072))); + env.close(); + + auto const aliceOffers = offersOnAccount(env, alice); + BEAST_EXPECT(aliceOffers.size() == 1); + for (auto const& offerPtr : aliceOffers) + { + auto const& offer = *offerPtr; + BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); + // This test is similar to corresponding Offer_test, except + // that JPY is scaled by 10**12 and BTC is scaled by 10**17. + // There is a difference in the expected results. + // Offer_test expects values + // takerGets:2230.682446713524, takerPays: 0.035378 + // MPT test has the same order of magnitude for the scaled + // values and the first 5 digits match. Is the difference due to + // int arithmetics? + BEAST_EXPECT(offer[sfTakerGets] == JPY(2'230'659'191'281'247)); + BEAST_EXPECT(offer[sfTakerPays] == BTC(3'537'743'015'958'622)); + } + }; + testHelper2TokensMix(test); + } + + void + testSelfPayXferFeeOffer(FeatureBitset features) + { + testcase("Self Pay Xfer Fee"); + // The old offer crossing code does not charge a transfer fee + // if alice pays alice. That's different from how payments work. + // Payments always charge a transfer fee even if the money is staying + // in the same hands. + // + // What's an example where alice pays alice? There are three actors: + // gw, alice, and bob. + // + // 1. gw issues BTC and USD. gw charges a 0.2% transfer fee. + // + // 2. alice makes an offer to buy XRP and sell USD. + // 3. bob makes an offer to buy BTC and sell XRP. + // + // 4. alice now makes an offer to sell BTC and buy USD. + // + // This last offer crosses using auto-bridging. + // o alice's last offer sells BTC to... + // o bob' offer which takes alice's BTC and sells XRP to... + // o alice's first offer which takes bob's XRP and sells USD to... + // o alice's last offer. + // + // So alice sells USD to herself. + // + // There are six cases that we need to test: + // o alice crosses her own offer on the first leg (BTC). + // o alice crosses her own offer on the second leg (USD). + // o alice crosses her own offers on both legs. + // All three cases need to be tested: + // o In reverse (alice has enough BTC to cover her offer) and + // o Forward (alice owns less BTC than is in her final offer. + // + // It turns out that two of the forward cases fail for a different + // reason. They are therefore commented out here, But they are + // revisited in the testSelfPayUnlimitedFunds() unit test. + + using namespace jtx; + auto const gw = Account("gw"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + auto const baseFee = env.current()->fees().base.drops(); + + auto const startXrpBalance = XRP(4'000'000); + + env.fund(startXrpBalance, gw); + env.close(); + + auto const BTC = issue1( + {.env = env, + .token = "BTC", + .issuer = gw, + .transferFee = 25'000}); + using tBTC = std::decay_t; + env.close(); + auto const USD = issue2( + {.env = env, + .token = "USD", + .issuer = gw, + .transferFee = 25'000}); + using tUSD = std::decay_t; + env.close(); + + // Test cases + struct Actor + { + Account acct; + int offers{}; // offers on account after crossing + PrettyAmount xrp; // final expected after crossing + PrettyAmount btc; // final expected after crossing + PrettyAmount usd; // final expected after crossing + }; + struct TestData + { + // The first three integers give the *index* in actors + // to assign each of the three roles. By using indices it is + // easy for alice to own the offer in the first leg, the second + // leg, or both. + std::size_t self{}; + std::size_t leg0{}; + std::size_t leg1{}; + PrettyAmount btcStart; + std::vector actors; + }; + + // clang-format off + TestData const tests[]{ + // btcStart --------------------- actor[0] --------------------- -------------------- actor[1] ------------------- + {0, 0, 1, BTC(200), {{"ann", 0, drops(3900000'000000 - (4 * baseFee)), BTC(200), USD(3000)}, {"abe", 0, drops(4100000'000000 - (3 * baseFee)), BTC( 0), USD(750)}}}, // no BTC xfer fee + {0, 1, 0, BTC(200), {{"bev", 0, drops(4100000'000000 - (4 * baseFee)), BTC( 75), USD(2000)}, {"bob", 0, drops(3900000'000000 - (3 * baseFee)), BTC(100), USD( 0)}}}, // no USD xfer fee + {0, 0, 0, BTC(200), {{"cam", 0, drops(4000000'000000 - (5 * baseFee)), BTC(200), USD(2000)} }}, // no xfer fee + {0, 1, 0, BTC( 50), {{"deb", 1, drops(4040000'000000 - (4 * baseFee)), BTC( 0), USD(2000)}, {"dan", 1, drops(3960000'000000 - (3 * baseFee)), BTC( 40), USD( 0)}}}, // no USD xfer fee + }; + // clang-format on + + for (auto const& t : tests) + { + Account const& self = t.actors[t.self].acct; + Account const& leg0 = t.actors[t.leg0].acct; + Account const& leg1 = t.actors[t.leg1].acct; + + for (auto const& actor : t.actors) + { + env.fund(XRP(4'000'000), actor.acct); + env.close(); + + if constexpr (std::is_same_v) + { + auto MBTC = MPTTester(env, gw, BTC); + MBTC.authorize({.account = actor.acct}); + } + else + { + env(trust(actor.acct, BTC(400))); + env.close(); + } + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw, USD); + MUSD.authorize({.account = actor.acct}); + } + else + { + env(trust(actor.acct, USD(8000))); + env.close(); + } + env.close(); + } + + env(pay(gw, self, t.btcStart)); + env(pay(gw, self, USD(2'000))); + if (self.id() != leg1.id()) + env(pay(gw, leg1, USD(2'000))); + env.close(); + + // Get the initial offers in place. Remember their sequences + // so we can delete them later. + env(offer(leg0, BTC(100), XRP(100'000), tfPassive)); + env.close(); + std::uint32_t const leg0OfferSeq = env.seq(leg0) - 1; + + env(offer(leg1, XRP(100'000), USD(1'000), tfPassive)); + env.close(); + std::uint32_t const leg1OfferSeq = env.seq(leg1) - 1; + + // This is the offer that matters. + env(offer(self, USD(1'000), BTC(100))); + env.close(); + std::uint32_t const selfOfferSeq = env.seq(self) - 1; + + // Verify results. + for (auto const& actor : t.actors) + { + // Sometimes Taker crossing gets lazy about deleting offers. + // Treat an empty offer as though it is deleted. + auto actorOffers = offersOnAccount(env, actor.acct); + auto const offerCount = std::distance( + actorOffers.begin(), + std::remove_if( + actorOffers.begin(), + actorOffers.end(), + [](std::shared_ptr& offer) { + return (*offer)[sfTakerGets].signum() == 0; + })); + BEAST_EXPECT(offerCount == actor.offers); + + env.require(balance(actor.acct, actor.xrp)); + env.require(balance(actor.acct, actor.btc)); + env.require(balance(actor.acct, actor.usd)); + } + // Remove any offers that might be left hanging around. They + // could bollix up later loops. + env(offer_cancel(leg0, leg0OfferSeq)); + env.close(); + env(offer_cancel(leg1, leg1OfferSeq)); + env.close(); + env(offer_cancel(self, selfOfferSeq)); + env.close(); + } + }; + testHelper2TokensMix(test); + } + + void + testSelfPayUnlimitedFunds(FeatureBitset features) + { + testcase("Self Pay Unlimited Funds"); + // The Taker offer crossing code recognized when Alice was paying + // Alice the same denomination. In this case, as long as Alice + // has a little bit of that denomination, it treats Alice as though + // she has unlimited funds in that denomination. + // + // Huh? What kind of sense does that make? + // + // One way to think about it is to break a single payment into a + // series of very small payments executed sequentially but very + // quickly. Alice needs to pay herself 1 USD, but she only has + // 0.01 USD. Alice says, "Hey Alice, let me pay you a penny." + // Alice does this, taking the penny out of her pocket and then + // putting it back in her pocket. Then she says, "Hey Alice, + // I found another penny. I can pay you another penny." Repeat + // these steps 100 times and Alice has paid herself 1 USD even though + // she only owns 0.01 USD. + // + // That's all very nice, but the payment code does not support this + // optimization. In part that's because the payment code can + // operate on a whole batch of offers. As a matter of fact, it can + // deal in two consecutive batches of offers. It would take a great + // deal of sorting out to figure out which offers in the two batches + // had the same owner and give them special processing. And, + // honestly, it's a weird little corner case. + // + // So, since Flow offer crossing uses the payments engine, Flow + // offer crossing no longer supports this optimization. + // + // The following test shows the difference in the behaviors between + // Taker offer crossing and Flow offer crossing. + + using namespace jtx; + auto const gw = Account("gw"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env{*this, features}; + auto const baseFee = env.current()->fees().base.drops(); + + auto const startXrpBalance = XRP(4'000'000); + + env.fund(startXrpBalance, gw); + env.close(); + + auto const BTC = issue1( + {.env = env, .token = "BTC", .issuer = gw, .limit = 40, .transferFee = 25'000}); + using tBTC = std::decay_t; + auto const USD = issue2( + {.env = env, .token = "USD", .issuer = gw, .limit = 8'000, .transferFee = 25'000}); + using tUSD = std::decay_t; + env.close(); + + // Test cases + struct Actor + { + Account acct; + int offers{}; // offers on account after crossing + PrettyAmount xrp; // final expected after crossing + PrettyAmount btc; // final expected after crossing + PrettyAmount usd; // final expected after crossing + }; + struct TestData + { + // The first three integers give the *index* in actors + // to assign each of the three roles. By using indices it is + // easy for alice to own the offer in the first leg, the second + // leg, or both. + std::size_t self{}; + std::size_t leg0{}; + std::size_t leg1{}; + PrettyAmount btcStart; + std::vector actors; + }; + + // clang-format off + TestData const flowTests[]{ + // btcStart ------------------- actor[0] -------------------- ------------------- actor[1] -------------------- + {0, 0, 1, BTC(5), {{"gay", 1, drops(3950000'000000 - (4 * baseFee)), BTC(5), USD (2500)}, {"gar", 1, drops(4050000'000000 - (3 * baseFee)), BTC(0), USD(1375)}}}, // no BTC xfer fee + {0, 0, 0, BTC(5), {{"hye", 2, drops(4000000'000000 - (5 * baseFee)), BTC(5), USD (2000)} }} // no xfer fee + }; + // clang-format on + + for (auto const& t : flowTests) + { + Account const& self = t.actors[t.self].acct; + Account const& leg0 = t.actors[t.leg0].acct; + Account const& leg1 = t.actors[t.leg1].acct; + + for (auto const& actor : t.actors) + { + env.fund(XRP(4'000'000), actor.acct); + env.close(); + + if constexpr (std::is_same_v) + { + auto MBTC = MPTTester(env, gw, BTC); + MBTC.authorize({.account = actor.acct}); + } + else + { + env(trust(actor.acct, BTC(40))); + env.close(); + } + if constexpr (std::is_same_v) + { + auto MUSD = MPTTester(env, gw, USD); + MUSD.authorize({.account = actor.acct}); + } + else + { + env(trust(actor.acct, USD(8'000))); + env.close(); + } + } + + env(pay(gw, self, t.btcStart)); + env(pay(gw, self, USD(2'000))); + if (self.id() != leg1.id()) + env(pay(gw, leg1, USD(2'000))); + env.close(); + + // Get the initial offers in place. Remember their sequences + // so we can delete them later. + env(offer(leg0, BTC(10), XRP(100'000), tfPassive)); + env.close(); + std::uint32_t const leg0OfferSeq = env.seq(leg0) - 1; + + env(offer(leg1, XRP(100'000), USD(1'000), tfPassive)); + env.close(); + std::uint32_t const leg1OfferSeq = env.seq(leg1) - 1; + + // This is the offer that matters. + env(offer(self, USD(1'000), BTC(10))); + env.close(); + std::uint32_t const selfOfferSeq = env.seq(self) - 1; + + // Verify results. + for (auto const& actor : t.actors) + { + // Sometimes Taker offer crossing gets lazy about deleting + // offers. Treat an empty offer as though it is deleted. + auto actorOffers = offersOnAccount(env, actor.acct); + auto const offerCount = std::distance( + actorOffers.begin(), + std::remove_if( + actorOffers.begin(), + actorOffers.end(), + [](std::shared_ptr& offer) { + return (*offer)[sfTakerGets].signum() == 0; + })); + BEAST_EXPECT(offerCount == actor.offers); + + env.require(balance(actor.acct, actor.xrp)); + env.require(balance(actor.acct, actor.btc)); + env.require(balance(actor.acct, actor.usd)); + } + // Remove any offers that might be left hanging around. They + // could bollix up later loops. + env(offer_cancel(leg0, leg0OfferSeq)); + env.close(); + env(offer_cancel(leg1, leg1OfferSeq)); + env.close(); + env(offer_cancel(self, selfOfferSeq)); + env.close(); + } + }; + testHelper2TokensMix(test); + } + + void + testRequireAuth(FeatureBitset features) + { + testcase("lsfRequireAuth"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account("gw"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + env.fund(XRP(400'000), gw, alice, bob); + env.close(); + + // GW requires authorization for holders of its IOUs + auto gwMUSD = + MPTTester({.env = env, .issuer = gw, .flags = MPTDEXFlags | tfMPTRequireAuth}); + MPT const gwUSD = gwMUSD; + + // Have gw authorize bob and alice + gwMUSD.authorize({.account = alice}); + gwMUSD.authorize({.account = gw, .holder = alice}); + gwMUSD.authorize({.account = bob}); + gwMUSD.authorize({.account = gw, .holder = bob}); + // Alice is able to place the offer since the GW has authorized her + env(offer(alice, gwUSD(40), XRP(4'000))); + env.close(); + + env.require(offers(alice, 1)); + env.require(balance(alice, gwUSD(0))); + + env(pay(gw, bob, gwUSD(50))); + env.close(); + + env.require(balance(bob, gwUSD(50))); + + // Bob's offer should cross Alice's + env(offer(bob, XRP(4'000), gwUSD(40))); + env.close(); + + env.require(offers(alice, 0)); + env.require(balance(alice, gwUSD(40))); + + env.require(offers(bob, 0)); + env.require(balance(bob, gwUSD(10))); + } + + void + testMissingAuth(FeatureBitset features) + { + testcase("Missing Auth"); + // 1. gw creates MPTokenIssuance, which requires authorization. + // alice creates an offer to acquire USD/gw, an asset for which + // she does not own MPToken. This offer fails since alice + // doesn't own MPToken and authorization is required. + // + // 2. Next, alice creates MPT, but it's not authorized. + // alice attempts to create an offer and again fails. + // + // 3. Finally, gw authorizes alice to own USD/gw. + // At this point alice successfully + // creates and crosses an offer for USD/gw. + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account("gw"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + env.fund(XRP(400'000), gw, alice, bob); + env.close(); + + auto gwMUSD = + MPTTester({.env = env, .issuer = gw, .flags = MPTDEXFlags | tfMPTRequireAuth}); + MPT const gwUSD = gwMUSD; + + // alice can't create an offer because alice doesn't own + // MPToken and MPTokenIssuance requires authorization + env(offer(alice, gwUSD(40), XRP(4'000)), ter(tecNO_AUTH)); + env.close(); + + env.require(offers(alice, 0)); + env.require(balance(alice, gwUSD(none))); + + gwMUSD.authorize({.account = bob}); + gwMUSD.authorize({.account = gw, .holder = bob}); + + env(pay(gw, bob, gwUSD(50))); + env.close(); + env.require(balance(bob, gwUSD(50))); + + // bob can create an offer since bob owns MPToken + // and it is authorized. + env(offer(bob, XRP(4'000), gwUSD(40))); + env.close(); + std::uint32_t const bobOfferSeq = env.seq(bob) - 1; + + env.require(offers(alice, 0)); + + // alice creates MPToken, which is still not authorized. alice + // should still not be able to create an offer for USD/gw. + gwMUSD.authorize({.account = alice}); + + env(offer(alice, gwUSD(40), XRP(4'000)), ter(tecNO_AUTH)); + env.close(); + + env.require(offers(alice, 0)); + env.require(balance(alice, gwUSD(0))); + + env.require(offers(bob, 1)); + env.require(balance(bob, gwUSD(50))); + + // Delete bob's offer so alice can create an offer without crossing. + env(offer_cancel(bob, bobOfferSeq)); + env.close(); + env.require(offers(bob, 0)); + + // Finally, gw authorizes alice. Now alice's + // offer should succeed. + gwMUSD.authorize({.account = gw, .holder = alice}); + + env(offer(alice, gwUSD(40), XRP(4'000))); + env.close(); + + env.require(offers(alice, 1)); + + // Now bob creates his offer again. alice's offer should cross. + env(offer(bob, XRP(4'000), gwUSD(40))); + env.close(); + + env.require(offers(alice, 0)); + env.require(balance(alice, gwUSD(40))); + + env.require(offers(bob, 0)); + env.require(balance(bob, gwUSD(10))); + } + + void + testSelfAuth(FeatureBitset features) + { + testcase("Self Auth"); + + using namespace jtx; + + Env env{*this, features}; + + auto const gw = Account("gw"); + auto const alice = Account("alice"); + + env.fund(XRP(400'000), gw, alice); + env.close(); + + auto gwMUSD = + MPTTester({.env = env, .issuer = gw, .flags = MPTDEXFlags | tfMPTRequireAuth}); + MPT const gwUSD = gwMUSD; + + // Test that gw can create an offer to buy gw's currency. + env(offer(gw, gwUSD(40), XRP(4'000))); + env.close(); + std::uint32_t const gwOfferSeq = env.seq(gw) - 1; + env.require(offers(gw, 1)); + + // Cancel gw's offer + env(offer_cancel(gw, gwOfferSeq)); + env.close(); + env.require(offers(gw, 0)); + + // Before DepositPreauth an account with lsfRequireAuth set could not + // create an offer to buy their own currency. After DepositPreauth + // they can. + env(offer(gw, gwUSD(40), XRP(4'000))); + env.close(); + + env.require(offers(gw, 1)); + + // The rest of the test verifies DepositPreauth behavior. + + // Create/authorize alice's MPToken + gwMUSD.authorize({.account = alice}); + gwMUSD.authorize({.account = gw, .holder = alice}); + + env(pay(gw, alice, gwUSD(50))); + env.close(); + + env.require(balance(alice, gwUSD(50))); + + // alice's offer should cross gw's + env(offer(alice, XRP(4'000), gwUSD(40))); + env.close(); + + env.require(offers(alice, 0)); + env.require(balance(alice, gwUSD(10))); + + env.require(offers(gw, 0)); + } + + void + testDeletedOfferIssuer(FeatureBitset features) + { + // Show that an offer who's issuer has been deleted cannot be crossed. + using namespace jtx; + + testcase("Deleted offer issuer"); + + auto MPTokenExists = + [](jtx::Env const& env, AccountID const& account, MPTID const& issuanceID) -> bool { + return bool(env.le(keylet::mptoken(issuanceID, account))); + }; + + Account const alice("alice"); + Account const becky("becky"); + Account const carol("carol"); + Account const gw("gateway"); + + Env env{*this, features}; + + env.fund(XRP(10'000), alice, becky, carol, noripple(gw)); + + auto MUSD = MPTTester({.env = env, .issuer = gw}); + MPT const USD = MUSD; + + MUSD.authorize({.account = becky}); + BEAST_EXPECT(MPTokenExists(env, becky, USD.issuanceID)); + env(pay(gw, becky, USD(5))); + env.close(); + + auto MBUX = MPTTester({.env = env, .issuer = alice}); + MPT const BUX = MBUX; + + // Make offers that produce USD and can be crossed two ways: + // direct XRP -> USD + // direct BUX -> USD + env(offer(becky, XRP(2), USD(2)), txflags(tfPassive)); + std::uint32_t const beckyBuxUsdSeq{env.seq(becky)}; + env(offer(becky, BUX(3), USD(3)), txflags(tfPassive)); + env.close(); + + // becky keeps the offers, but removes MPT. + env(pay(becky, gw, USD(5))); + MUSD.authorize({.account = becky, .flags = tfMPTUnauthorize}); + + BEAST_EXPECT(!MPTokenExists(env, becky, USD.issuanceID)); + BEAST_EXPECT(isOffer(env, becky, XRP(2), USD(2))); + BEAST_EXPECT(isOffer(env, becky, BUX(3), USD(3))); + + // Have to delete MPTokenIssuance in order to delete + // the issuer account. + MUSD.destroy({}); + + // Delete gw's account. + { + // The ledger sequence needs to far enough ahead of the account + // sequence before the account can be deleted. + int const delta = [&env, &gw, openLedgerSeq = env.current()->seq()]() -> int { + std::uint32_t const gwSeq{env.seq(gw)}; + if (gwSeq + 255 > openLedgerSeq) + return gwSeq - openLedgerSeq + 255; + return 0; + }(); + + for (int i = 0; i < delta; ++i) + env.close(); + + // Account deletion has a high fee. Account for that. + env(acctdelete(gw, alice), fee(drops(env.current()->fees().increment))); + env.close(); + + // Verify that gw's account root is gone from the ledger. + BEAST_EXPECT(!env.closed()->exists(keylet::account(gw.id()))); + } + + // alice crosses becky's first offer. The offer create fails because + // the USD issuer is not in the ledger. + env(offer(alice, USD(2), XRP(2)), ter(tecNO_ISSUER)); + env.close(); + env.require(offers(alice, 0)); + BEAST_EXPECT(isOffer(env, becky, XRP(2), USD(2))); + BEAST_EXPECT(isOffer(env, becky, BUX(3), USD(3))); + + // alice crosses becky's second offer. Again, the offer create fails + // because the USD issuer is not in the ledger. + env(offer(alice, USD(3), BUX(3)), ter(tecNO_ISSUER)); + env.require(offers(alice, 0)); + BEAST_EXPECT(isOffer(env, becky, XRP(2), USD(2))); + BEAST_EXPECT(isOffer(env, becky, BUX(3), USD(3))); + + // Cancel becky's BUX -> USD offer so we can try auto-bridging. + env(offer_cancel(becky, beckyBuxUsdSeq)); + env.close(); + BEAST_EXPECT(!isOffer(env, becky, BUX(3), USD(3))); + + // alice creates an offer that can be auto-bridged with becky's + // remaining offer. + MBUX.authorize({.account = carol}); + env(pay(alice, carol, BUX(2))); + + env(offer(alice, BUX(2), XRP(2))); + env.close(); + + // carol attempts the auto-bridge. Again, the offer create fails + // because the USD issuer is not in the ledger. + env(offer(carol, USD(2), BUX(2)), ter(tecNO_ISSUER)); + env.close(); + BEAST_EXPECT(isOffer(env, alice, BUX(2), XRP(2))); + BEAST_EXPECT(isOffer(env, becky, XRP(2), USD(2))); + } + + // Helper function that returns offers on an account sorted by sequence. + static std::vector> + sortedOffersOnAccount(jtx::Env& env, jtx::Account const& acct) + { + std::vector> offers{offersOnAccount(env, acct)}; + std::sort( + offers.begin(), + offers.end(), + [](std::shared_ptr const& rhs, std::shared_ptr const& lhs) { + return (*rhs)[sfSequence] < (*lhs)[sfSequence]; + }); + return offers; + } + + void + testTicketOffer(FeatureBitset features) + { + testcase("Ticket Offers"); + + using namespace jtx; + + // Two goals for this test. + // + // o Verify that offers can be created using tickets. + // + // o Show that offers in the _same_ order book remain in + // chronological order regardless of sequence/ticket numbers. + Env env{*this, features}; + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + auto const bob = Account{"bob"}; + + env.fund(XRP(10'000), gw, alice, bob); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + env(pay(gw, alice, USD(200))); + env.close(); + + // Create four offers from the same account with identical quality + // so they go in the same order book. Each offer goes in a different + // ledger so the chronology is clear. + std::uint32_t const offerId_0{env.seq(alice)}; + env(offer(alice, XRP(50), USD(50))); + env.close(); + + // Create two tickets. + std::uint32_t const ticketSeq{env.seq(alice) + 1}; + env(ticket::create(alice, 2)); + env.close(); + + // Create another sequence-based offer. + std::uint32_t const offerId_1{env.seq(alice)}; + BEAST_EXPECT(offerId_1 == offerId_0 + 4); + env(offer(alice, XRP(50), USD(50))); + env.close(); + + // Create two ticket based offers in reverse order. + std::uint32_t const offerId_2{ticketSeq + 1}; + env(offer(alice, XRP(50), USD(50)), ticket::use(offerId_2)); + env.close(); + + // Create the last offer. + std::uint32_t const offerId_3{ticketSeq}; + env(offer(alice, XRP(50), USD(50)), ticket::use(offerId_3)); + env.close(); + + // Verify that all of alice's offers are present. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 4); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerId_0); + BEAST_EXPECT(offers[1]->getFieldU32(sfSequence) == offerId_3); + BEAST_EXPECT(offers[2]->getFieldU32(sfSequence) == offerId_2); + BEAST_EXPECT(offers[3]->getFieldU32(sfSequence) == offerId_1); + env.require(balance(alice, USD(200))); + env.require(owners(alice, 5)); + } + + // Cross alice's first offer. + env(offer(bob, USD(50), XRP(50))); + env.close(); + + // Verify that the first offer alice created was consumed. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 3); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerId_3); + BEAST_EXPECT(offers[1]->getFieldU32(sfSequence) == offerId_2); + BEAST_EXPECT(offers[2]->getFieldU32(sfSequence) == offerId_1); + } + + // Cross alice's second offer. + env(offer(bob, USD(50), XRP(50))); + env.close(); + + // Verify that the second offer alice created was consumed. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 2); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerId_3); + BEAST_EXPECT(offers[1]->getFieldU32(sfSequence) == offerId_2); + } + + // Cross alice's third offer. + env(offer(bob, USD(50), XRP(50))); + env.close(); + + // Verify that the third offer alice created was consumed. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 1); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerId_3); + } + + // Cross alice's last offer. + env(offer(bob, USD(50), XRP(50))); + env.close(); + + // Verify that the third offer alice created was consumed. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.empty()); + } + env.require(balance(alice, USD(0))); + env.require(owners(alice, 1)); + env.require(balance(bob, USD(200))); + env.require(owners(bob, 1)); + } + + void + testTicketCancelOffer(FeatureBitset features) + { + testcase("Ticket Cancel Offers"); + + using namespace jtx; + + // Verify that offers created with or without tickets can be canceled + // by transactions with or without tickets. + Env env{*this, features}; + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + + env.fund(XRP(10'000), gw, alice); + env.close(); + + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice}}); + + env.require(owners(alice, 1), tickets(alice, 0)); + + env(pay(gw, alice, USD(200))); + env.close(); + + // Create the first of four offers using a sequence. + std::uint32_t const offerSeqId_0{env.seq(alice)}; + env(offer(alice, XRP(50), USD(50))); + env.close(); + env.require(owners(alice, 2), tickets(alice, 0)); + + // Create four tickets. + std::uint32_t const ticketSeq{env.seq(alice) + 1}; + env(ticket::create(alice, 4)); + env.close(); + env.require(owners(alice, 6), tickets(alice, 4)); + + // Create the second (also sequence-based) offer. + std::uint32_t const offerSeqId_1{env.seq(alice)}; + BEAST_EXPECT(offerSeqId_1 == offerSeqId_0 + 6); + env(offer(alice, XRP(50), USD(50))); + env.close(); + + // Create the third (ticket-based) offer. + std::uint32_t const offerTixId_0{ticketSeq + 1}; + env(offer(alice, XRP(50), USD(50)), ticket::use(offerTixId_0)); + env.close(); + + // Create the last offer. + std::uint32_t const offerTixId_1{ticketSeq}; + env(offer(alice, XRP(50), USD(50)), ticket::use(offerTixId_1)); + env.close(); + + // Verify that all of alice's offers are present. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 4); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerSeqId_0); + BEAST_EXPECT(offers[1]->getFieldU32(sfSequence) == offerTixId_1); + BEAST_EXPECT(offers[2]->getFieldU32(sfSequence) == offerTixId_0); + BEAST_EXPECT(offers[3]->getFieldU32(sfSequence) == offerSeqId_1); + env.require(balance(alice, USD(200))); + env.require(owners(alice, 7)); + } + + // Use a ticket to cancel an offer created with a sequence. + env(offer_cancel(alice, offerSeqId_0), ticket::use(ticketSeq + 2)); + env.close(); + + // Verify that offerSeqId_0 was canceled. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 3); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerTixId_1); + BEAST_EXPECT(offers[1]->getFieldU32(sfSequence) == offerTixId_0); + BEAST_EXPECT(offers[2]->getFieldU32(sfSequence) == offerSeqId_1); + } + + // Use a ticket to cancel an offer created with a ticket. + env(offer_cancel(alice, offerTixId_0), ticket::use(ticketSeq + 3)); + env.close(); + + // Verify that offerTixId_0 was canceled. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 2); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerTixId_1); + BEAST_EXPECT(offers[1]->getFieldU32(sfSequence) == offerSeqId_1); + } + + // All of alice's tickets should now be used up. + env.require(owners(alice, 3), tickets(alice, 0)); + + // Use a sequence to cancel an offer created with a ticket. + env(offer_cancel(alice, offerTixId_1)); + env.close(); + + // Verify that offerTixId_1 was canceled. + { + auto offers = sortedOffersOnAccount(env, alice); + BEAST_EXPECT(offers.size() == 1); + BEAST_EXPECT(offers[0]->getFieldU32(sfSequence) == offerSeqId_1); + } + + // Use a sequence to cancel an offer created with a sequence. + env(offer_cancel(alice, offerSeqId_1)); + env.close(); + + // Verify that offerSeqId_1 was canceled. + // All of alice's tickets should now be used up. + env.require(owners(alice, 1), tickets(alice, 0), offers(alice, 0)); + } + + void + testFillOrKill(FeatureBitset features) + { + testcase("fixFillOrKill"); + using namespace jtx; + Account const issuer("issuer"); + Account const maker("maker"); + Account const taker("taker"); + + auto test = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(1'000), issuer); + env.fund(XRP(1'000), maker, taker); + env.close(); + + auto const USD = + issue1({.env = env, .token = "USD", .issuer = issuer, .holders = {maker, taker}}); + auto const EUR = + issue2({.env = env, .token = "EUR", .issuer = issuer, .holders = {maker, taker}}); + + env(pay(issuer, maker, USD(1'000))); + env(pay(issuer, taker, USD(1'000))); + env(pay(issuer, maker, EUR(1'000))); + env.close(); + + auto makerUSDBalance = env.balance(maker, USD).value(); + auto takerUSDBalance = env.balance(taker, USD).value(); + auto makerEURBalance = env.balance(maker, EUR).value(); + auto takerEURBalance = env.balance(taker, EUR).value(); + auto makerXRPBalance = env.balance(maker, XRP).value(); + auto takerXRPBalance = env.balance(taker, XRP).value(); + + // tfFillOrKill, TakerPays must be filled + { + TER const err = features[fixFillOrKill] ? TER(tesSUCCESS) : tecKILLED; + + env(offer(maker, XRP(100), USD(100))); + env.close(); + + env(offer(taker, USD(100), XRP(101)), txflags(tfFillOrKill), ter(err)); + env.close(); + + makerXRPBalance -= txfee(env, 1); + takerXRPBalance -= txfee(env, 1); + if (err == tesSUCCESS) + { + makerUSDBalance -= USD(100); + takerUSDBalance += USD(100); + makerXRPBalance += XRP(100).value(); + takerXRPBalance -= XRP(100).value(); + } + BEAST_EXPECT(expectOffers(env, taker, 0)); + + env(offer(maker, USD(100), XRP(100))); + env.close(); + + env(offer(taker, XRP(100), USD(101)), txflags(tfFillOrKill), ter(err)); + env.close(); + + makerXRPBalance -= txfee(env, 1); + takerXRPBalance -= txfee(env, 1); + if (err == tesSUCCESS) + { + makerUSDBalance += USD(100); + takerUSDBalance -= USD(100); + makerXRPBalance -= XRP(100).value(); + takerXRPBalance += XRP(100).value(); + } + BEAST_EXPECT(expectOffers(env, taker, 0)); + + env(offer(maker, USD(100), EUR(100))); + env.close(); + + env(offer(taker, EUR(100), USD(101)), txflags(tfFillOrKill), ter(err)); + env.close(); + + makerXRPBalance -= txfee(env, 1); + takerXRPBalance -= txfee(env, 1); + if (err == tesSUCCESS) + { + makerUSDBalance += USD(100); + takerUSDBalance -= USD(100); + makerEURBalance -= EUR(100); + takerEURBalance += EUR(100); + } + BEAST_EXPECT(expectOffers(env, taker, 0)); + } + + // tfFillOrKill + tfSell, TakerGets must be filled + { + env(offer(maker, XRP(101), USD(101))); + env.close(); + + env(offer(taker, USD(100), XRP(101)), txflags(tfFillOrKill | tfSell)); + env.close(); + + makerUSDBalance -= USD(101); + takerUSDBalance += USD(101); + makerXRPBalance += XRP(101).value() - txfee(env, 1); + takerXRPBalance -= XRP(101).value() + txfee(env, 1); + BEAST_EXPECT(expectOffers(env, taker, 0)); + + env(offer(maker, USD(101), XRP(101))); + env.close(); + + env(offer(taker, XRP(100), USD(101)), txflags(tfFillOrKill | tfSell)); + env.close(); + + makerUSDBalance += USD(101); + takerUSDBalance -= USD(101); + makerXRPBalance -= XRP(101).value() + txfee(env, 1); + takerXRPBalance += XRP(101).value() - txfee(env, 1); + BEAST_EXPECT(expectOffers(env, taker, 0)); + + env(offer(maker, USD(101), EUR(101))); + env.close(); + + env(offer(taker, EUR(100), USD(101)), txflags(tfFillOrKill | tfSell)); + env.close(); + + makerUSDBalance += USD(101); + takerUSDBalance -= USD(101); + makerEURBalance -= EUR(101); + takerEURBalance += EUR(101); + makerXRPBalance -= txfee(env, 1); + takerXRPBalance -= txfee(env, 1); + BEAST_EXPECT(expectOffers(env, taker, 0)); + } + + // Fail regardless of fixFillOrKill amendment + for (auto const flags : {tfFillOrKill, tfFillOrKill + tfSell}) + { + env(offer(maker, XRP(100), USD(100))); + env.close(); + + env(offer(taker, USD(100), XRP(99)), txflags(flags), ter(tecKILLED)); + env.close(); + + makerXRPBalance -= txfee(env, 1); + takerXRPBalance -= txfee(env, 1); + BEAST_EXPECT(expectOffers(env, taker, 0)); + + env(offer(maker, USD(100), XRP(100))); + env.close(); + + env(offer(taker, XRP(100), USD(99)), txflags(flags), ter(tecKILLED)); + env.close(); + + makerXRPBalance -= txfee(env, 1); + takerXRPBalance -= txfee(env, 1); + BEAST_EXPECT(expectOffers(env, taker, 0)); + + env(offer(maker, USD(100), EUR(100))); + env.close(); + + env(offer(taker, EUR(100), USD(99)), txflags(flags), ter(tecKILLED)); + env.close(); + + makerXRPBalance -= txfee(env, 1); + takerXRPBalance -= txfee(env, 1); + BEAST_EXPECT(expectOffers(env, taker, 0)); + } + + BEAST_EXPECT( + env.balance(maker, USD) == makerUSDBalance && + env.balance(taker, USD) == takerUSDBalance && + env.balance(maker, EUR) == makerEURBalance && + env.balance(taker, EUR) == takerEURBalance && + env.balance(maker, XRP) == makerXRPBalance && + env.balance(taker, XRP) == takerXRPBalance); + }; + testHelper2TokensMix(test); + } + + void + testTickSize(FeatureBitset features) + { + testcase("Tick Size"); + + using namespace jtx; + + auto const gw = Account{"gateway"}; + auto const alice = Account{"alice"}; + + auto getIOU = [&](Env& env) -> PrettyAsset { + static int i = 0; + std::string const name = "IO" + std::to_string(i++); + auto const iou = gw[name]; + env(trust(alice, iou(1'000))); + env(pay(gw, alice, iou(100))); + env.close(); + return iou; + }; + auto getMPT = [&](Env& env) -> PrettyAsset { + MPT const mpt = + MPTTester({.env = env, .issuer = gw, .holders = {alice}, .pay = 1'000'000'000}); + return mpt; + }; + auto getXRP = [&](Env& env) -> PrettyAsset { return XRP; }; + + using ToAsset = std::function; + struct TestInfo + { + ToAsset toAsset1; + ToAsset toAsset2; + int val1; + int val2; + }; + // XRP/MPT, MPT/XRP, MPT/MPT offers are not adjusted for TickSize + // IOU/IOU, XRP/IOU, IOU/XRP offers have TickSize logic unchanged + // IOU/MPT, MPT/IOU have TickSize logic applied to adjust IOU only + std::vector const tests = { + {getIOU, getIOU, 10, 30}, + {getIOU, getXRP, 10, 30'000'000}, + {getXRP, getIOU, 10'000'000, 30}, + {getMPT, getXRP, 10'000'000, 30'000'000}, + {getXRP, getMPT, 10'000'000, 30'000'000}, + {getIOU, getMPT, 10, 30'000'000}, + {getMPT, getIOU, 10'000'000, 30}, + {getMPT, getMPT, 10'000'000, 30'000'000}}; + for (TestInfo const& t : tests) + { + Env env{*this, features}; + env.fund(XRP(10'000), gw, alice); + env.close(); + + auto const XTS = t.toAsset1(env); + auto const XXX = t.toAsset2(env); + + auto tokenType = [](PrettyAsset const& asset) -> std::string { + return asset.raw().visit( + [&](Issue const& issue) { return issue.native() ? "XRPIssue" : "Issue"; }, + [&](MPTIssue const&) { return "MPTIssue"; }); + }; + + testcase << "offer: " << tokenType(XTS) << "/" << tokenType(XXX); + + { + // Gateway sets its tick size to 5 + auto txn = noop(gw); + txn[sfTickSize.fieldName] = 5; + env(txn); + BEAST_EXPECT((*env.le(gw))[sfTickSize] == 5); + } + + env(offer(alice, XTS(t.val1), XXX(t.val2))); + env(offer(alice, XTS(t.val2), XXX(t.val1))); + env(offer(alice, XTS(t.val1), XXX(t.val2)), json(jss::Flags, tfSell)); + env(offer(alice, XTS(t.val2), XXX(t.val1)), json(jss::Flags, tfSell)); + + std::map> offers; + forEachItem(*env.current(), alice, [&](std::shared_ptr const& sle) { + if (sle->getType() == ltOFFER) + { + offers.emplace( + (*sle)[sfSequence], + std::make_pair((*sle)[sfTakerPays], (*sle)[sfTakerGets])); + } + }); + + // first offer + auto it = offers.begin(); + BEAST_EXPECT(it != offers.end()); + if (XXX.native() && !XTS.holds()) + { + BEAST_EXPECT( + it->second.first == XTS(t.val1) && it->second.second == XRPAmount(29'999'400)); + } + else if (!XXX.integral()) + { + BEAST_EXPECT( + it->second.first == XTS(t.val1) && it->second.second < XXX(t.val2) && + it->second.second > STAmount(XXX, 29'9994, -4)); + } + else + { + BEAST_EXPECT(it->second.first == XTS(t.val1) && it->second.second == XXX(t.val2)); + } + + // second offer + ++it; + BEAST_EXPECT(it != offers.end()); + BEAST_EXPECT(it->second.first == XTS(t.val2) && it->second.second == XXX(t.val1)); + + // third offer + ++it; + BEAST_EXPECT(it != offers.end()); + if (XTS.native() && !XXX.holds()) + { + BEAST_EXPECT( + it->second.first == XRPAmount(10'000'200) && it->second.second == XXX(t.val2)); + } + else if (!XTS.integral()) + { + BEAST_EXPECT( + it->second.first == STAmount(XTS, 10'0002, -4) && + it->second.second == XXX(t.val2)); + } + else + { + BEAST_EXPECT(it->second.first == XTS(t.val1) && it->second.second == XXX(t.val2)); + } + + // fourth offer + // exact TakerPays is XTS(1/.033333) + ++it; + BEAST_EXPECT(it != offers.end()); + BEAST_EXPECT(it->second.first == XTS(t.val2) && it->second.second == XXX(t.val1)); + + BEAST_EXPECT(++it == offers.end()); + } + } + + void + testAll(FeatureBitset features) + { + testCanceledOffer(features); + testRmFundedOffer(features); + testTinyPayment(features); + testXRPTinyPayment(features); + testInsufficientReserve(features); + testFillModes(features); + testMalformed(features); + testExpiration(features); + testUnfundedCross(features); + testSelfCross(false, features); + testSelfCross(true, features); + testNegativeBalance(features); + testOfferCrossWithXRP(true, features); + testOfferCrossWithXRP(false, features); + testOfferCrossWithLimitOverride(features); + testOfferAcceptThenCancel(features); + testCurrencyConversionEntire(features); + testCurrencyConversionIntoDebt(features); + testCurrencyConversionInParts(features); + testCrossCurrencyStartXRP(features); + testCrossCurrencyEndXRP(features); + testCrossCurrencyBridged(features); + testBridgedSecondLegDry(features); + testOfferFeesConsumeFunds(features); + testOfferCreateThenCross(features); + testSellFlagBasic(features); + testSellFlagExceedLimit(features); + testGatewayCrossCurrency(features); + testPartialCross(features); + testXRPDirectCross(features); + testDirectCross(features); + testBridgedCross(features); + testSellOffer(features); + testSellWithFillOrKill(features); + testTransferRateOffer(features); + testSelfCrossOffer(features); + testSelfIssueOffer(features); + testDirectToDirectPath(features); + testSelfCrossLowQualityOffer(features); + testOfferInScaling(features); + testOfferInScalingWithXferRate(features); + testSelfPayXferFeeOffer(features); + testSelfPayUnlimitedFunds(features); + testRequireAuth(features); + testMissingAuth(features); + testSelfAuth(features); + testDeletedOfferIssuer(features); + testTicketOffer(features); + testTicketCancelOffer(features); + testRmSmallIncreasedQOffersXRP(features); + testRmSmallIncreasedQOffersMPT(features); + testFillOrKill(features); + testTickSize(features); + } + + void + run() override + { + using namespace jtx; + static FeatureBitset const all{testable_amendments()}; + testAll(all); + } +}; + +BEAST_DEFINE_TESTSUITE_PRIO(OfferMPT, tx, xrpl, 2); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/OfferStream_test.cpp b/src/test/app/OfferStream_test.cpp index becb190513..9cd3724b7b 100644 --- a/src/test/app/OfferStream_test.cpp +++ b/src/test/app/OfferStream_test.cpp @@ -1,5 +1,4 @@ -#include -#include +#include namespace xrpl { diff --git a/src/test/app/Offer_test.cpp b/src/test/app/Offer_test.cpp index 57f938e399..4679bc2e9b 100644 --- a/src/test/app/Offer_test.cpp +++ b/src/test/app/Offer_test.cpp @@ -1,11 +1,59 @@ -#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -93,7 +141,7 @@ public: // Offers for the good quality path env(offer(carol, BTC(1), USD(100))); - PathSet paths(Path(XRP, USD), Path(USD)); + PathSet const paths(Path(XRP, USD), Path(USD)); env(pay(alice, bob, USD(100)), json(paths.json()), @@ -419,8 +467,8 @@ public: auto const EUR = gw["EUR"]; auto tinyAmount = [&](IOU const& iou) -> PrettyAmount { - STAmount amt( - iou.issue(), + STAmount const amt( + iou, /*mantissa*/ 1, /*exponent*/ -81); return PrettyAmount(amt, iou.account.name()); @@ -709,7 +757,7 @@ public: // Helper function that returns the Offers on an account. static std::vector> - offersOnAccount(jtx::Env& env, jtx::Account account) + offersOnAccount(jtx::Env& env, jtx::Account const& account) { std::vector> result; forEachItem(*env.current(), account, [&result](std::shared_ptr const& sle) { @@ -1203,7 +1251,6 @@ public: BEAST_EXPECT(jrr[jss::offers].isArray()); BEAST_EXPECT(jrr[jss::offers].size() == 0); - // NOTE : // At this point, all offers are expected to be consumed. { auto acctOffers = offersOnAccount(env, account_to_test); @@ -1279,7 +1326,7 @@ public: auto const gw_initial_balance = drops(1149999730); auto const alice_initial_balance = drops(499946999680); auto const bob_initial_balance = drops(10199999920); - auto const small_amount = STAmount{bob["USD"].issue(), UINT64_C(2710505431213761), -33}; + auto const small_amount = STAmount{bob["USD"], UINT64_C(2710505431213761), -33}; env.fund(gw_initial_balance, gw); env.fund(alice_initial_balance, alice); @@ -2136,18 +2183,18 @@ public: jtx::Account const& account, jtx::PrettyAmount const& expectBalance) { - auto const sleTrust = env.le(keylet::line(account.id(), expectBalance.value().issue())); + Issue const& issue = expectBalance.value().get(); + auto const sleTrust = env.le(keylet::line(account.id(), issue)); BEAST_EXPECT(sleTrust); if (sleTrust) { - Issue const issue = expectBalance.value().issue(); bool const accountLow = account.id() < issue.account; STAmount low{issue}; STAmount high{issue}; - low.setIssuer(accountLow ? account.id() : issue.account); - high.setIssuer(accountLow ? issue.account : account.id()); + low.get().account = (accountLow ? account.id() : issue.account); + high.get().account = (accountLow ? issue.account : account.id()); BEAST_EXPECT(sleTrust->getFieldAmount(sfLowLimit) == low); BEAST_EXPECT(sleTrust->getFieldAmount(sfHighLimit) == high); @@ -2278,7 +2325,7 @@ public: } std::uint32_t const acctOfferSeq = env.seq(acct) - 1; - BEAST_EXPECT(env.balance(acct, USD.issue()) == t.balanceUsd); + BEAST_EXPECT(env.balance(acct, USD) == t.balanceUsd); BEAST_EXPECT(env.balance(acct, xrpIssue()) == t.fundXrp - t.spentXrp); env.require(offers(acct, t.offers)); env.require(owners(acct, t.owners)); @@ -2304,7 +2351,7 @@ public: else { // Verify that no trustline was created. - auto const sleTrust = env.le(keylet::line(acct, USD.issue())); + auto const sleTrust = env.le(keylet::line(acct, USD)); BEAST_EXPECT(!sleTrust); } } @@ -2489,8 +2536,8 @@ public: env.require(offers(bob, 0)); // The two trustlines that were generated by offers should be gone. - BEAST_EXPECT(!env.le(keylet::line(alice.id(), EUR.issue()))); - BEAST_EXPECT(!env.le(keylet::line(bob.id(), USD.issue()))); + BEAST_EXPECT(!env.le(keylet::line(alice.id(), EUR))); + BEAST_EXPECT(!env.le(keylet::line(bob.id(), USD))); // Make two more offers that leave one of the offers non-dry. We // need to properly sequence the transactions: @@ -2768,7 +2815,7 @@ public: std::uint32_t const acctOfferSeq = env.seq(acct) - 1; // Check results - BEAST_EXPECT(env.balance(acct, USD.issue()) == t.finalUsd); + BEAST_EXPECT(env.balance(acct, USD) == t.finalUsd); BEAST_EXPECT(env.balance(acct, xrpIssue()) == t.fundXrp - t.spentXrp); env.require(offers(acct, t.offers)); env.require(owners(acct, t.owners)); @@ -3675,7 +3722,7 @@ public: BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); BEAST_EXPECT( offer[sfTakerGets] == - STAmount(JPY.issue(), std::uint64_t(2230682446713524ul), -12)); + STAmount(JPY, std::uint64_t(2230682446713524ul), -12)); BEAST_EXPECT(offer[sfTakerPays] == BTC(0.035378)); } } @@ -3712,24 +3759,24 @@ public: env( pay(gw1, alice, - STAmount{USD.issue(), std::uint64_t(2185410179555600), -14})); + STAmount{USD, std::uint64_t(2185410179555600), -14})); env( pay(gw2, bob, - STAmount{JPY.issue(), std::uint64_t(6351823459548956), -12})); + STAmount{JPY, std::uint64_t(6351823459548956), -12})); env.close(); env(offer( bob, - STAmount{USD.issue(), std::uint64_t(4371257532306000), -17}, - STAmount{JPY.issue(), std::uint64_t(4573216636606000), -15})); + STAmount{USD, std::uint64_t(4371257532306000), -17}, + STAmount{JPY, std::uint64_t(4573216636606000), -15})); env.close(); // This offer did not partially cross correctly. env(offer( alice, - STAmount{JPY.issue(), std::uint64_t(2291181510070762), -12}, - STAmount{USD.issue(), std::uint64_t(2190218999914694), -14})); + STAmount{JPY, std::uint64_t(2291181510070762), -12}, + STAmount{USD, std::uint64_t(2190218999914694), -14})); env.close(); auto const aliceOffers = offersOnAccount(env, alice); @@ -3740,10 +3787,10 @@ public: BEAST_EXPECT(offer[sfLedgerEntryType] == ltOFFER); BEAST_EXPECT( offer[sfTakerGets] == - STAmount(USD.issue(), std::uint64_t(2185847305256635), -14)); + STAmount(USD, std::uint64_t(2185847305256635), -14)); BEAST_EXPECT( offer[sfTakerPays] == - STAmount(JPY.issue(), std::uint64_t(2286608293434156), -12)); + STAmount(JPY, std::uint64_t(2286608293434156), -12)); } } @@ -3772,21 +3819,21 @@ public: // Place alice's tiny offer in the book first. Let's see what happens // when a reasonable offer crosses it. STAmount const aliceCnyOffer{ - CNY.issue(), std::uint64_t(4926000000000000), -23}; + CNY, std::uint64_t(4926000000000000), -23}; env(offer(alice, aliceCnyOffer, drops(1), tfPassive)); env.close(); // bob places an ordinary offer STAmount const bobCnyStartBalance{ - CNY.issue(), std::uint64_t(3767479960090235), -15}; + CNY, std::uint64_t(3767479960090235), -15}; env(pay(gw, bob, bobCnyStartBalance)); env.close(); env(offer( bob, drops(203), - STAmount{CNY.issue(), std::uint64_t(1000000000000000), -20})); + STAmount{CNY, std::uint64_t(1000000000000000), -20})); env.close(); env.require(balance(alice, aliceCnyOffer)); @@ -4279,8 +4326,7 @@ public: Env env{*this, features}; - // This test mimics the payment flow used in the Ripple Connect - // smoke test. The players: + // This test mimics a payment flow. The players: // A USD gateway with hot and cold wallets // A EUR gateway with hot and cold walllets // A MM gateway that will provide offers from USD->EUR and EUR->USD diff --git a/src/test/app/Oracle_test.cpp b/src/test/app/Oracle_test.cpp index 9da0ee3a31..42dfe8fb11 100644 --- a/src/test/app/Oracle_test.cpp +++ b/src/test/app/Oracle_test.cpp @@ -1,7 +1,36 @@ +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include + namespace xrpl { namespace test { namespace jtx { @@ -23,7 +52,7 @@ private: Env env(*this); Account const bad("bad"); env.memoize(bad); - Oracle oracle( + Oracle const oracle( env, {.owner = bad, .seq = seq(1), @@ -35,7 +64,7 @@ private: { Env env(*this); env.fund(env.current()->fees().accountReserve(0), owner); - Oracle oracle( + Oracle const oracle( env, {.owner = owner, .fee = static_cast(env.current()->fees().base.drops()), @@ -302,7 +331,7 @@ private: Env env(*this); auto const baseFee = static_cast(env.current()->fees().base.drops()); env.fund(XRP(1'000), owner); - Oracle oracle( + Oracle const oracle( env, {.owner = owner, .series = {{"USD", "USD", 740, 1}}, @@ -315,7 +344,7 @@ private: Env env(*this); auto const baseFee = static_cast(env.current()->fees().base.drops()); env.fund(XRP(1'000), owner); - Oracle oracle( + Oracle const oracle( env, {.owner = owner, .series = {{"USD", "BTC", 740, maxPriceScale + 1}}, @@ -354,7 +383,7 @@ private: Env env(*this); env.fund(XRP(1'000), owner); Oracle oracle(env, {.owner = owner, .fee = -1, .err = ter(temBAD_FEE)}); - Oracle oracle1( + Oracle const oracle1( env, {.owner = owner, .fee = static_cast(env.current()->fees().base.drops())}); oracle.set(UpdateArg{.owner = owner, .fee = -1, .err = ter(temBAD_FEE)}); } @@ -371,7 +400,7 @@ private: auto const baseFee = static_cast(env.current()->fees().base.drops()); env.fund(XRP(1'000), owner); auto const count = ownerCount(env, owner); - Oracle oracle(env, {.owner = owner, .series = series, .fee = baseFee}); + Oracle const oracle(env, {.owner = owner, .series = series, .fee = baseFee}); BEAST_EXPECT(oracle.exists()); BEAST_EXPECT(ownerCount(env, owner) == (count + adj)); auto const entry = oracle.ledgerEntry(); @@ -506,9 +535,9 @@ private: auto const acctDelFee{drops(env.current()->fees().increment)}; env.fund(XRP(1'000), owner); env.fund(XRP(1'000), alice); - Oracle oracle( + Oracle const oracle( env, {.owner = owner, .series = {{"XRP", "USD", 740, 1}}, .fee = baseFee}); - Oracle oracle1( + Oracle const oracle1( env, {.owner = owner, .documentID = 2, @@ -764,7 +793,7 @@ private: env.fund(XRP(1'000), owner); { - Oracle oracle(env, {.owner = owner, .fee = baseFee, .err = ter(temDISABLED)}); + Oracle const oracle(env, {.owner = owner, .fee = baseFee, .err = ter(temDISABLED)}); } { diff --git a/src/test/app/OversizeMeta_test.cpp b/src/test/app/OversizeMeta_test.cpp index d6305bedb6..9c4e45b187 100644 --- a/src/test/app/OversizeMeta_test.cpp +++ b/src/test/app/OversizeMeta_test.cpp @@ -1,6 +1,16 @@ -#include -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include + +#include +#include + +#include +#include namespace xrpl { namespace test { diff --git a/src/test/app/PathMPT_test.cpp b/src/test/app/PathMPT_test.cpp new file mode 100644 index 0000000000..9126d28f40 --- /dev/null +++ b/src/test/app/PathMPT_test.cpp @@ -0,0 +1,465 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +namespace xrpl { +namespace test { +namespace detail { + +static Json::Value +rpf(jtx::Account const& src, + jtx::Account const& dst, + xrpl::test::jtx::MPT const& USD, + std::vector const& num_src) +{ + Json::Value jv = Json::objectValue; + jv[jss::command] = "ripple_path_find"; + jv[jss::source_account] = toBase58(src); + + if (!num_src.empty()) + { + auto& sc = (jv[jss::source_currencies] = Json::arrayValue); + Json::Value j = Json::objectValue; + for (auto const& id : num_src) + { + j[jss::mpt_issuance_id] = to_string(id); + sc.append(j); + } + } + + auto const d = toBase58(dst); + jv[jss::destination_account] = d; + + Json::Value& j = (jv[jss::destination_amount] = Json::objectValue); + j[jss::mpt_issuance_id] = to_string(USD.mpt()); + j[jss::value] = "1"; + + return jv; +} + +} // namespace detail + +//------------------------------------------------------------------------------ + +class PathMPT_test : public beast::unit_test::suite +{ + jtx::Env + pathTestEnv() + { + // These tests were originally written with search parameters that are + // different from the current defaults. This function creates an env + // with the search parameters that the tests were written for. + using namespace jtx; + return Env(*this, envconfig([](std::unique_ptr cfg) { + cfg->PATH_SEARCH_OLD = 7; + cfg->PATH_SEARCH = 7; + cfg->PATH_SEARCH_MAX = 10; + return cfg; + })); + } + +public: + void + source_currencies_limit() + { + testcase("source currency limits"); + using namespace std::chrono_literals; + using namespace jtx; + Env env = pathTestEnv(); + auto const gw = Account("gateway"); + auto const alice = Account("alice"); + auto const bob = Account("bob"); + + env.fund(XRP(10'000), "alice", "bob", gw); + + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 100}); + + auto& app = env.app(); + Resource::Charge loadType = Resource::feeReferenceRPC; + Resource::Consumer c; + + RPC::JsonContext context{ + {env.journal, + app, + loadType, + app.getOPs(), + app.getLedgerMaster(), + c, + Role::USER, + {}, + {}, + RPC::apiVersionIfUnspecified}, + {}, + {}}; + Json::Value result; + gate g; + // Test RPC::Tuning::max_src_cur source currencies. + std::vector num_src; + num_src.reserve(RPC::Tuning::max_src_cur); + for (std::uint8_t i = 0; i < RPC::Tuning::max_src_cur; ++i) + num_src.push_back(makeMptID(i, bob)); + app.getJobQueue().postCoro(jtCLIENT, "RPC-Client", [&](auto const& coro) { + context.params = xrpl::test::detail::rpf(alice, bob, USD, num_src); + context.coro = coro; + RPC::doCommand(context, result); + g.signal(); + }); + BEAST_EXPECT(g.wait_for(5s)); + BEAST_EXPECT(!result.isMember(jss::error)); + + // Test more than RPC::Tuning::max_src_cur source currencies. + num_src.push_back(makeMptID(RPC::Tuning::max_src_cur, bob)); + app.getJobQueue().postCoro(jtCLIENT, "RPC-Client", [&](auto const& coro) { + context.params = xrpl::test::detail::rpf(alice, bob, USD, num_src); + context.coro = coro; + RPC::doCommand(context, result); + g.signal(); + }); + BEAST_EXPECT(g.wait_for(5s)); + BEAST_EXPECT(result.isMember(jss::error)); + + // Test RPC::Tuning::max_auto_src_cur source currencies. + num_src.clear(); + for (auto i = 0; i < (RPC::Tuning::max_auto_src_cur - 1); ++i) + { + auto CURM = MPTTester({.env = env, .issuer = alice, .holders = {bob}}); + num_src.push_back(CURM.issuanceID()); + } + app.getJobQueue().postCoro(jtCLIENT, "RPC-Client", [&](auto const& coro) { + context.params = xrpl::test::detail::rpf(alice, bob, USD, {}); + context.coro = coro; + RPC::doCommand(context, result); + g.signal(); + }); + BEAST_EXPECT(g.wait_for(5s)); + BEAST_EXPECT(!result.isMember(jss::error)); + + // Test more than RPC::Tuning::max_auto_src_cur source currencies. + auto CURM = MPTTester({.env = env, .issuer = alice, .holders = {bob}}); + app.getJobQueue().postCoro(jtCLIENT, "RPC-Client", [&](auto const& coro) { + context.params = xrpl::test::detail::rpf(alice, bob, USD, {}); + context.coro = coro; + RPC::doCommand(context, result); + g.signal(); + }); + BEAST_EXPECT(g.wait_for(5s)); + BEAST_EXPECT(result.isMember(jss::error)); + } + + void + no_direct_path_no_intermediary_no_alternatives() + { + testcase("no direct path no intermediary no alternatives"); + using namespace jtx; + + Env env = pathTestEnv(); + + env.fund(XRP(10'000), "alice", "bob"); + + auto USDM = MPTTester({.env = env, .issuer = "bob"}); + + auto const result = find_paths(env, "alice", "bob", USDM(5)); + BEAST_EXPECT(std::get<0>(result).empty()); + } + + void + direct_path_no_intermediary() + { + testcase("direct path no intermediary"); + using namespace jtx; + Env env = pathTestEnv(); + env.fund(XRP(10'000), "alice", "bob"); + + MPT const USD = MPTTester({.env = env, .issuer = "alice", .holders = {"bob"}}); + + STPathSet st; + STAmount sa; + std::tie(st, sa, std::ignore) = find_paths(env, "alice", "bob", USD(5)); + BEAST_EXPECT(st.empty()); + BEAST_EXPECT(equal(sa, USD(5))); + } + + void + payment_auto_path_find() + { + testcase("payment auto path find"); + using namespace jtx; + Env env = pathTestEnv(); + auto const gw = Account("gateway"); + env.fund(XRP(10'000), "alice", "bob", gw); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {"alice", "bob"}}); + env(pay(gw, "alice", USD(70))); + env(pay("alice", "bob", USD(24))); + env.require(balance("alice", USD(46))); + env.require(balance("bob", USD(24))); + } + + void + path_find(bool const domainEnabled) + { + testcase(std::string("path find") + (domainEnabled ? " w/ " : " w/o ") + "domain"); + using namespace jtx; + Env env = pathTestEnv(); + auto const gw = Account("gateway"); + env.fund(XRP(10'000), "alice", "bob", gw); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {"alice", "bob"}}); + env(pay(gw, "alice", USD(70))); + env(pay(gw, "bob", USD(50))); + + std::optional domainID; + if (domainEnabled) + domainID = setupDomain(env, {"alice", "bob", gw}); + + STPathSet st; + STAmount sa; + STAmount da; + std::tie(st, sa, da) = find_paths( + env, "alice", "bob", USD(5), std::nullopt, std::nullopt, std::nullopt, domainID); + // Note, a direct IOU payment will have "gateway" as alternative path + // since IOU supports rippling + BEAST_EXPECT(st.empty()); + BEAST_EXPECT(equal(sa, USD(5))); + BEAST_EXPECT(equal(da, USD(5))); + } + + void + path_find_consume_all(bool const domainEnabled) + { + testcase( + std::string("path find consume all") + (domainEnabled ? " w/ " : " w/o ") + "domain"); + using namespace jtx; + + { + Env env = pathTestEnv(); + auto const gw = Account("gateway"); + env.fund(XRP(10'000), "alice", "bob", "carol", gw); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {"bob", "carol"}}); + MPT const AUD(makeMptID(0, gw)); + env(pay(gw, "carol", USD(100))); + std::optional domainID; + if (domainEnabled) + { + domainID = setupDomain(env, {"alice", "bob", "carol", "gateway"}); + env(offer("carol", XRP(100), USD(100)), domain(*domainID)); + } + else + { + env(offer("carol", XRP(100), USD(100))); + } + env.close(); + + STPathSet st; + STAmount sa; + STAmount da; + std::tie(st, sa, da) = find_paths( + env, + "alice", + "bob", + AUD(-1), + std::optional(XRP(100'000'000)), + std::nullopt, + std::nullopt, + domainID); + BEAST_EXPECT(st.empty()); + std::tie(st, sa, da) = find_paths( + env, + "alice", + "bob", + USD(-1), + std::optional(XRP(100'000'000)), + std::nullopt, + std::nullopt, + domainID); + if (BEAST_EXPECT(st.size() == 1 && st[0].size() == 1)) + { + auto const& pathElem = st[0][0]; + BEAST_EXPECT( + pathElem.isOffer() && pathElem.getIssuerID() == gw.id() && + pathElem.getMPTID() == USD.issuanceID); + } + BEAST_EXPECT(sa == XRP(100)); + BEAST_EXPECT(equal(da, USD(100))); + + // if domain is used, finding path in the open offerbook will return + // empty result + if (domainEnabled) + { + std::tie(st, sa, da) = find_paths( + env, + "alice", + "bob", + Account("bob")["USD"](-1), + std::optional(XRP(1000000)), + std::nullopt, + std::nullopt); // not specifying a domain + BEAST_EXPECT(st.empty()); + } + } + } + + void + alternative_paths_consume_best_transfer(bool const domainEnabled) + { + testcase( + std::string("alternative path consume best transfer") + + (domainEnabled ? " w/ " : " w/o ") + "domain"); + using namespace jtx; + Env env = pathTestEnv(); + auto const gw = Account("gateway"); + auto const gw2 = Account("gateway2"); + env.fund(XRP(10'000), "alice", "bob", gw, gw2); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {"alice", "bob"}}); + MPT const gw2_USD = MPTTester( + {.env = env, .issuer = gw2, .holders = {"alice", "bob"}, .transferFee = 1'000}); + std::optional domainID; + if (domainEnabled) + { + domainID = setupDomain(env, {"alice", "bob", "gateway", "gateway2"}); + env(pay(gw, "alice", USD(70)), domain(*domainID)); + env(pay(gw2, "alice", gw2_USD(70)), domain(*domainID)); + env(pay("alice", "bob", USD(70)), domain(*domainID)); + } + else + { + env(pay(gw, "alice", USD(70))); + env(pay(gw2, "alice", gw2_USD(70))); + env(pay("alice", "bob", USD(70))); + } + env.require(balance("alice", USD(0))); + env.require(balance("alice", gw2_USD(70))); + env.require(balance("bob", USD(70))); + env.require(balance("bob", gw2_USD(0))); + } + + void + receive_max(bool const domainEnabled) + { + testcase(std::string("Receive max") + (domainEnabled ? " w/ " : " w/o ") + "domain"); + using namespace jtx; + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const charlie = Account("charlie"); + auto const gw = Account("gw"); + { + // XRP -> MPT receive max + Env env = pathTestEnv(); + env.fund(XRP(10'000), alice, bob, charlie, gw); + env.close(); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, charlie}}); + env(pay(gw, charlie, USD(10))); + env.close(); + std::optional domainID; + if (domainEnabled) + { + domainID = setupDomain(env, {alice, bob, charlie, gw}); + env(offer(charlie, XRP(10), USD(10)), domain(*domainID)); + } + else + { + env(offer(charlie, XRP(10), USD(10))); + } + env.close(); + auto [st, sa, da] = find_paths( + env, alice, bob, USD(-1), XRP(100).value(), std::nullopt, std::nullopt, domainID); + BEAST_EXPECT(sa == XRP(10)); + BEAST_EXPECT(equal(da, USD(10))); + if (BEAST_EXPECT(st.size() == 1 && st[0].size() == 1)) + { + auto const& pathElem = st[0][0]; + BEAST_EXPECT( + pathElem.isOffer() && pathElem.getIssuerID() == gw.id() && + pathElem.getMPTID() == USD.mpt()); + } + } + { + // MPT -> XRP receive max + Env env = pathTestEnv(); + env.fund(XRP(10'000), alice, bob, charlie, gw); + env.close(); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob, charlie}}); + env(pay(gw, alice, USD(10))); + env.close(); + std::optional domainID; + if (domainEnabled) + { + domainID = setupDomain(env, {alice, bob, charlie, gw}); + env(offer(charlie, USD(10), XRP(10)), domain(*domainID)); + } + else + { + env(offer(charlie, USD(10), XRP(10))); + } + env.close(); + auto [st, sa, da] = find_paths( + env, alice, bob, drops(-1), USD(100).value(), std::nullopt, std::nullopt, domainID); + BEAST_EXPECT(sa == USD(10)); + BEAST_EXPECT(equal(da, XRP(10))); + if (BEAST_EXPECT(st.size() == 1 && st[0].size() == 1)) + { + auto const& pathElem = st[0][0]; + BEAST_EXPECT( + pathElem.isOffer() && pathElem.getIssuerID() == xrpAccount() && + pathElem.getCurrency() == xrpCurrency()); + } + } + } + + void + run() override + { + source_currencies_limit(); + no_direct_path_no_intermediary_no_alternatives(); + direct_path_no_intermediary(); + payment_auto_path_find(); + for (auto const domainEnabled : {false, true}) + { + path_find(domainEnabled); + path_find_consume_all(domainEnabled); + alternative_paths_consume_best_transfer(domainEnabled); + receive_max(domainEnabled); + } + } +}; + +BEAST_DEFINE_TESTSUITE(PathMPT, app, xrpl); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/Path_test.cpp b/src/test/app/Path_test.cpp index 53da92ce1c..3214986f8d 100644 --- a/src/test/app/Path_test.cpp +++ b/src/test/app/Path_test.cpp @@ -1,27 +1,60 @@ -#include #include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include // IWYU pragma: keep +#include +#include #include +#include +#include +#include +#include +#include +#include #include +#include #include -#include +#include +#include +#include #include #include +#include +#include #include +#include +#include +#include +#include #include +#include +#include #include +#include #include +#include +#include #include #include #include +#include +#include #include #include #include -#include +#include +#include namespace xrpl { namespace test { @@ -100,7 +133,7 @@ public: void signal() { - std::lock_guard lk(mutex_); + std::lock_guard const lk(mutex_); signaled_ = true; cv_.notify_all(); } @@ -848,7 +881,7 @@ public: })", jv); - auto const jv_l = env.le(keylet::line(Account("bob").id(), Account("alice")["USD"].issue())) + auto const jv_l = env.le(keylet::line(Account("bob").id(), Account("alice")["USD"])) ->getJson(JsonOptions::none); for (auto it = jv.begin(); it != jv.end(); ++it) BEAST_EXPECT(*it == jv_l[it.memberName()]); @@ -890,15 +923,14 @@ public: })", jv); - auto const jv_l = env.le(keylet::line(Account("bob").id(), Account("alice")["USD"].issue())) + auto const jv_l = env.le(keylet::line(Account("bob").id(), Account("alice")["USD"])) ->getJson(JsonOptions::none); for (auto it = jv.begin(); it != jv.end(); ++it) BEAST_EXPECT(*it == jv_l[it.memberName()]); env.trust(Account("bob")["USD"](0), "alice"); env.trust(Account("alice")["USD"](0), "bob"); - BEAST_EXPECT( - env.le(keylet::line(Account("bob").id(), Account("alice")["USD"].issue())) == nullptr); + BEAST_EXPECT(env.le(keylet::line(Account("bob").id(), Account("alice")["USD"])) == nullptr); } void @@ -941,14 +973,13 @@ public: })", jv); - auto const jv_l = env.le(keylet::line(Account("alice").id(), Account("bob")["USD"].issue())) + auto const jv_l = env.le(keylet::line(Account("alice").id(), Account("bob")["USD"])) ->getJson(JsonOptions::none); for (auto it = jv.begin(); it != jv.end(); ++it) BEAST_EXPECT(*it == jv_l[it.memberName()]); env(pay("alice", "bob", Account("alice")["USD"](50))); - BEAST_EXPECT( - env.le(keylet::line(Account("alice").id(), Account("bob")["USD"].issue())) == nullptr); + BEAST_EXPECT(env.le(keylet::line(Account("alice").id(), Account("bob")["USD"])) == nullptr); } void @@ -959,13 +990,13 @@ public: (domainEnabled ? " w/ " : " w/o ") + "domain"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account G1{"G1"}; - Account G2{"G2"}; - Account G3{"G3"}; - Account M1{"M1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account const G3{"G3"}; + Account const M1{"M1"}; env.fund(XRP(100000), A1); env.fund(XRP(10000), A2); @@ -1060,10 +1091,10 @@ public: "domain"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account G3{"G3"}; - Account M1{"M1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const G3{"G3"}; + Account const M1{"M1"}; env.fund(XRP(1000), A1, A2, G3); env.fund(XRP(11000), M1); @@ -1120,11 +1151,11 @@ public: (domainEnabled ? " w/ " : " w/o ") + "domain"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account G1BS{"G1BS"}; - Account G2SW{"G2SW"}; - Account M1{"M1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const G1BS{"G1BS"}; + Account const G2SW{"G2SW"}; + Account const M1{"M1"}; env.fund(XRP(1000), G1BS, G2SW, A1, A2); env.fund(XRP(11000), M1); @@ -1206,16 +1237,16 @@ public: (domainEnabled ? " w/ " : " w/o ") + "domain"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; - Account G1{"G1"}; - Account G2{"G2"}; - Account G3{"G3"}; - Account G4{"G4"}; - Account M1{"M1"}; - Account M2{"M2"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account const G3{"G3"}; + Account const G4{"G4"}; + Account const M1{"M1"}; + Account const M2{"M2"}; env.fund(XRP(1000), A1, A2, A3, G1, G2, G3, G4); env.fund(XRP(10000), A4); @@ -1349,12 +1380,12 @@ public: (domainEnabled ? " w/ " : " w/o ") + "domain"); using namespace jtx; Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account G1{"G1"}; - Account G2{"G2"}; - Account M1{"M1"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account const M1{"M1"}; env.fund(XRP(11000), M1); env.fund(XRP(1000), A1, A2, A3, G1, G2); @@ -1539,16 +1570,16 @@ public: // lambda param that creates different types of offers auto testPathfind = [&](auto func, bool const domainEnabled = false) { Env env = pathTestEnv(); - Account A1{"A1"}; - Account A2{"A2"}; - Account A3{"A3"}; - Account A4{"A4"}; - Account G1{"G1"}; - Account G2{"G2"}; - Account G3{"G3"}; - Account G4{"G4"}; - Account M1{"M1"}; - Account M2{"M2"}; + Account const A1{"A1"}; + Account const A2{"A2"}; + Account const A3{"A3"}; + Account const A4{"A4"}; + Account const G1{"G1"}; + Account const G2{"G2"}; + Account const G3{"G3"}; + Account const G4{"G4"}; + Account const M1{"M1"}; + Account const M2{"M2"}; env.fund(XRP(1000), A1, A2, A3, G1, G2, G3, G4); env.fund(XRP(10000), A4); @@ -1815,9 +1846,9 @@ public: testcase("AMM not used in domain path"); using namespace jtx; Env env = pathTestEnv(); - PermissionedDEX permDex(env); + PermissionedDEX const permDex(env); auto const& [gw, domainOwner, alice, bob, carol, USD, domainID, credType] = permDex; - AMM amm(env, alice, XRP(10), USD(50)); + AMM const amm(env, alice, XRP(10), USD(50)); STPathSet st; STAmount sa, da; diff --git a/src/test/app/PayChan_test.cpp b/src/test/app/PayChan_test.cpp index 1150ae4d86..7d8cbb4266 100644 --- a/src/test/app/PayChan_test.cpp +++ b/src/test/app/PayChan_test.cpp @@ -1,13 +1,57 @@ -#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include +#include #include #include +#include +#include #include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { using namespace jtx::paychan; @@ -1504,7 +1548,7 @@ struct PayChan_test : public beast::unit_test::suite auto const settleDelay = 3600s; auto const channelFunds = XRP(1000); - std::optional cancelAfter; + std::optional const cancelAfter; { auto const chan = to_string(channel(alice, bob, env.seq(alice))); diff --git a/src/test/app/PayStrandMPT_test.cpp b/src/test/app/PayStrandMPT_test.cpp new file mode 100644 index 0000000000..6854e382f5 --- /dev/null +++ b/src/test/app/PayStrandMPT_test.cpp @@ -0,0 +1,654 @@ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +namespace xrpl { +namespace test { + +struct PayStrandMPT_test : public beast::unit_test::suite +{ + static jtx::DirectStepInfo + makeEndpointStep(jtx::Account const& src, jtx::Account const& dst, jtx::IOU const& iou) + { + return jtx::DirectStepInfo{src, dst, iou.currency}; + } + static jtx::MPTEndpointStepInfo + makeEndpointStep(jtx::Account const& src, jtx::Account const& dst, jtx::MPT const& mpt) + { + return jtx::MPTEndpointStepInfo{src, dst, mpt.mpt()}; + } + + void + testToStrand(FeatureBitset features) + { + testcase("To Strand"); + + using namespace jtx; + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const carol = Account("carol"); + auto const gw = Account("gw"); + + using M = MPTEndpointStepInfo; + using B = xrpl::Book; + using XRPS = XRPEndpointStepInfo; + + AMMContext ammContext(alice, false); + + auto test = [&, this]( + jtx::Env& env, + Asset const& deliver, + std::optional const& sendMaxIssue, + STPath const& path, + TER expTer, + auto&&... expSteps) { + auto [ter, strand] = toStrand( + *env.current(), + alice, + bob, + deliver, + std::nullopt, + sendMaxIssue, + path, + true, + OfferCrossing::no, + ammContext, + std::nullopt, + env.app().getLogs().journal("Flow")); + BEAST_EXPECT(ter == expTer); + if (sizeof...(expSteps) != 0) + BEAST_EXPECT(jtx::equal(strand, std::forward(expSteps)...)); + }; + + { + auto testMultiToken = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + env.fund(XRP(10'000), alice, bob, gw); + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 1'000}); + auto const bobUSD = issue1( + {.env = env, + .token = "USD", + .issuer = bob, + .holders = {alice}, + .limit = 1'000}); + MPT const EUR = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 1'000}); + auto const bobEUR = issue2( + {.env = env, + .token = "EUR", + .issuer = bob, + .holders = {alice}, + .limit = 1'000}); + env(pay(gw, alice, EUR(100))); + + { + // Original test is + // STPath({ipe(bob["USD"]), cpe(EUR.currency)}); + // which ripples through same currency, different issuer. + // This results in 5 steps: + // 1 DirectStep alice -> gw EUR/gw + // 2 Book EUR/gw USD/bob + // 3 Book USD/bob EUR/bob + // 4 Book EUR/bob XRP + // 5 XRPEndpoint + // This is somewhat equivalent path with MPT + STPath const path = STPath({ipe(bobUSD), ipe(bobEUR), cpe(xrpCurrency())}); + auto [ter, _] = toStrand( + *env.current(), + alice, + alice, + /*deliver*/ xrpIssue(), + /*limitQuality*/ std::nullopt, + /*sendMaxIssue*/ EUR, + path, + true, + OfferCrossing::no, + ammContext, + std::nullopt, + env.app().getLogs().journal("Flow")); + (void)_; + BEAST_EXPECT(ter == tesSUCCESS); + } + { + STPath const path = STPath({ipe(USD), cpe(xrpCurrency())}); + auto [ter, _] = toStrand( + *env.current(), + alice, + alice, + /*deliver*/ xrpIssue(), + /*limitQuality*/ std::nullopt, + /*sendMaxIssue*/ EUR, + path, + true, + OfferCrossing::no, + ammContext, + std::nullopt, + env.app().getLogs().journal("Flow")); + (void)_; + BEAST_EXPECT(ter == tesSUCCESS); + } + }; + testHelper2TokensMix(testMultiToken); + } + { + auto testMultiToken = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + env.fund(XRP(10'000), alice, bob, carol, gw); + auto USD = issue1({.env = env, .token = "USD", .issuer = gw, .limit = 1'000}); + using tUSD = std::decay_t; + auto EUR = issue2({.env = env, .token = "EUR", .issuer = gw, .limit = 1'000}); + using tEUR = std::decay_t; + + auto const err = [&]() { + if constexpr (std::is_same_v) + { + return tecNO_AUTH; + } + else + { + return terNO_LINE; + } + }(); + test(env, USD, std::nullopt, STPath(), err); + + if constexpr (std::is_same_v) + { + MPTTester(env, gw, USD).authorizeHolders({alice, bob, carol}); + } + else + { + env.trust(USD(1'000), alice, bob, carol); + } + + test(env, USD, std::nullopt, STPath(), tecPATH_DRY); + + env(pay(gw, alice, USD(100))); + env(pay(gw, carol, USD(100))); + + // Insert implied account + test( + env, + USD, + std::nullopt, + STPath(), + tesSUCCESS, + makeEndpointStep(alice, gw, USD), + makeEndpointStep(gw, bob, USD)); + if constexpr (std::is_same_v) + { + MPTTester(env, gw, EUR).authorizeHolders({alice, bob}); + } + else + { + env.trust(EUR(1'000), alice, bob); + } + + // Insert implied offer + test( + env, + EUR, + USD, + STPath(), + tesSUCCESS, + makeEndpointStep(alice, gw, USD), + B{USD, EUR, std::nullopt}, + makeEndpointStep(gw, bob, EUR)); + + // Path with explicit offer + test( + env, + EUR, + USD, + STPath({ipe(EUR)}), + tesSUCCESS, + makeEndpointStep(alice, gw, USD), + B{USD, EUR, std::nullopt}, + makeEndpointStep(gw, bob, EUR)); + + // Path with XRP src currency + test( + env, + USD, + xrpIssue(), + STPath({ipe(USD)}), + tesSUCCESS, + XRPS{alice}, + B{XRP, USD, std::nullopt}, + makeEndpointStep(gw, bob, USD)); + + // Path with XRP dst currency. + test( + env, + xrpIssue(), + USD, + STPath({STPathElement{ + STPathElement::typeCurrency, xrpAccount(), xrpCurrency(), xrpAccount()}}), + tesSUCCESS, + makeEndpointStep(alice, gw, USD), + B{USD, XRP, std::nullopt}, + XRPS{bob}); + + // Path with XRP cross currency bridged payment + test( + env, + EUR, + USD, + STPath({cpe(xrpCurrency())}), + tesSUCCESS, + makeEndpointStep(alice, gw, USD), + B{USD, XRP, std::nullopt}, + B{XRP, EUR, std::nullopt}, + makeEndpointStep(gw, bob, EUR)); + + // Create an offer with the same in/out issue + test(env, EUR, USD, STPath({ipe(USD), ipe(EUR)}), temBAD_PATH); + + // The same offer can't appear more than once on a path + test(env, EUR, USD, STPath({ipe(EUR), ipe(USD), ipe(EUR)}), temBAD_PATH_LOOP); + }; + testHelper2TokensMix(testMultiToken); + } + + { + // cannot have more than one offer with the same output issue + + using namespace jtx; + + auto testMultiToken = [&](auto&& issue1, auto&& issue2) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 10'000}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 10'000}); + + env(pay(gw, bob, USD(100))); + env(pay(gw, bob, EUR(100))); + + env(offer(bob, XRP(100), USD(100))); + env(offer(bob, USD(100), EUR(100)), txflags(tfPassive)); + env(offer(bob, EUR(100), USD(100)), txflags(tfPassive)); + + // payment path: XRP -> XRP/USD -> USD/EUR -> EUR/USD + env(pay(alice, carol, USD(100)), + path(~USD, ~EUR, ~USD), + sendmax(XRP(200)), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper2TokensMix(testMultiToken); + } + + { + // check global freeze + Env env(*this, features); + env.fund(XRP(10000), alice, bob, gw); + auto USDM = MPTTester( + {.env = env, + .issuer = gw, + .holders = {alice, bob}, + .flags = MPTDEXFlags | tfMPTCanLock, + .maxAmt = 1'000}); + MPT const USD = USDM; + env(pay(gw, alice, USD(100))); + + // Account can't issue payments + USDM.set({.holder = alice, .flags = tfMPTLock}); + test(env, USD, std::nullopt, STPath(), terLOCKED); + USDM.set({.holder = alice, .flags = tfMPTUnlock}); + test(env, USD, std::nullopt, STPath(), tesSUCCESS); + + // Account can not issue funds + USDM.set({.flags = tfMPTLock}); + test(env, USD, std::nullopt, STPath(), terLOCKED); + USDM.set({.flags = tfMPTUnlock}); + test(env, USD, std::nullopt, STPath(), tesSUCCESS); + + // Account can not receive funds + USDM.set({.holder = bob, .flags = tfMPTLock}); + test(env, USD, std::nullopt, STPath(), terLOCKED); + USDM.set({.holder = bob, .flags = tfMPTUnlock}); + test(env, USD, std::nullopt, STPath(), tesSUCCESS); + } + + { + // check no auth + // An account may require authorization to receive MPTs from an + // issuer + Env env(*this, features); + env.fund(XRP(10'000), alice, bob, gw); + auto USDM = MPTTester( + {.env = env, + .issuer = gw, + .flags = MPTDEXFlags | tfMPTRequireAuth, + .maxAmt = 1'000}); + MPT const USD = USDM; + + // Authorize alice but not bob + USDM.authorize({.account = alice}); + USDM.authorize({.holder = alice}); + env(pay(gw, alice, USD(100))); + env.require(balance(alice, USD(100))); + test(env, USD, std::nullopt, STPath(), tecNO_AUTH); + + // Check pure issue redeem still works + auto [ter, strand] = toStrand( + *env.current(), + alice, + gw, + USD, + std::nullopt, + std::nullopt, + STPath(), + true, + OfferCrossing::no, + ammContext, + std::nullopt, + env.app().getLogs().journal("Flow")); + BEAST_EXPECT(ter == tesSUCCESS); + BEAST_EXPECT(equal(strand, M{alice, gw, USD})); + } + + { + // last step xrp from offer + Env env(*this, features); + env.fund(XRP(10'000), alice, bob, gw); + MPT const USD = + MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}, .maxAmt = 1'000}); + env(pay(gw, alice, USD(100))); + + // alice -> USD/XRP -> bob + STPath path; + path.emplace_back(std::nullopt, xrpCurrency(), std::nullopt); + + auto [ter, strand] = toStrand( + *env.current(), + alice, + bob, + XRP, + std::nullopt, + USD, + path, + false, + OfferCrossing::no, + ammContext, + std::nullopt, + env.app().getLogs().journal("Flow")); + BEAST_EXPECT(ter == tesSUCCESS); + BEAST_EXPECT( + equal(strand, M{alice, gw, USD}, B{USD, xrpIssue(), std::nullopt}, XRPS{bob})); + } + } + + void + testRIPD1373(FeatureBitset features) + { + using namespace jtx; + testcase("RIPD1373"); + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const carol = Account("carol"); + auto const gw = Account("gw"); + + { + Env env(*this, features); + + env.fund(XRP(10000), alice, bob, carol, gw); + MPT const USD = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .maxAmt = 10'000}); + + env(pay(gw, bob, USD(100))); + + env(offer(bob, XRP(100), USD(100)), txflags(tfPassive)); + env(offer(bob, USD(100), XRP(100)), txflags(tfPassive)); + + // payment path: XRP -> XRP/USD -> USD/XRP + env(pay(alice, carol, XRP(100)), + path(~USD, ~XRP), + txflags(tfNoRippleDirect), + ter(temBAD_SEND_XRP_PATHS)); + } + + { + Env env(*this, features); + + env.fund(XRP(10000), alice, bob, carol, gw); + MPT const USD = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .maxAmt = 10'000}); + + env(pay(gw, bob, USD(100))); + + env(offer(bob, XRP(100), USD(100)), txflags(tfPassive)); + env(offer(bob, USD(100), XRP(100)), txflags(tfPassive)); + + // payment path: XRP -> XRP/USD -> USD/XRP + env(pay(alice, carol, XRP(100)), + path(~USD, ~XRP), + sendmax(XRP(200)), + txflags(tfNoRippleDirect), + ter(temBAD_SEND_XRP_MAX)); + } + } + + void + testLoop(FeatureBitset features) + { + testcase("test loop"); + using namespace jtx; + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const carol = Account("carol"); + auto const gw = Account("gw"); + auto const EUR = gw["EUR"]; + auto const CNY = gw["CNY"]; + + { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + MPT const USD = MPTTester( + {.env = env, .issuer = gw, .holders = {alice, bob, carol}, .maxAmt = 10'000}); + + env(pay(gw, bob, USD(100))); + env(pay(gw, alice, USD(100))); + + env(offer(bob, XRP(100), USD(100)), txflags(tfPassive)); + env(offer(bob, USD(100), XRP(100)), txflags(tfPassive)); + + // payment path: USD -> USD/XRP -> XRP/USD + env(pay(alice, carol, USD(100)), + sendmax(USD(100)), + path(~XRP, ~USD), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + } + { + auto testMultiToken = [&](auto&& issue1, auto&& issue2, auto&& issue3) { + Env env(*this, features); + + env.fund(XRP(10'000), alice, bob, carol, gw); + auto const USD = issue1( + {.env = env, + .token = "USD", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 10'000}); + auto const EUR = issue2( + {.env = env, + .token = "EUR", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 10'000}); + auto const CNY = issue3( + {.env = env, + .token = "CNY", + .issuer = gw, + .holders = {alice, bob, carol}, + .limit = 10'000}); + + env(pay(gw, bob, USD(100))); + env(pay(gw, bob, EUR(100))); + env(pay(gw, bob, CNY(100))); + + env(offer(bob, XRP(100), USD(100)), txflags(tfPassive)); + env(offer(bob, USD(100), EUR(100)), txflags(tfPassive)); + env(offer(bob, EUR(100), CNY(100)), txflags(tfPassive)); + + // payment path: XRP->XRP/USD->USD/EUR->USD/CNY + env(pay(alice, carol, CNY(100)), + sendmax(XRP(100)), + path(~USD, ~EUR, ~USD, ~CNY), + txflags(tfNoRippleDirect), + ter(temBAD_PATH_LOOP)); + }; + testHelper3TokensMix(testMultiToken); + } + } + + void + testNoAccount(FeatureBitset features) + { + testcase("test no account"); + using namespace jtx; + + auto const alice = Account("alice"); + auto const bob = Account("bob"); + auto const gw = Account("gw"); + + Env env(*this, features); + env.fund(XRP(10'000), alice, bob, gw); + MPT const USD = MPTTester({.env = env, .issuer = gw, .holders = {alice, bob}}); + + STAmount const sendMax{USD, 100, 1}; + STAmount const noAccountAmount{MPTIssue{0, noAccount()}, 100, 1}; + STAmount const deliver; + AccountID const srcAcc = alice.id(); + AccountID const dstAcc = bob.id(); + STPathSet const pathSet; + xrpl::path::RippleCalc::Input inputs; + inputs.defaultPathsAllowed = true; + try + { + PaymentSandbox sb{env.current().get(), tapNONE}; + { + auto const r = ::xrpl::path::RippleCalc::rippleCalculate( + sb, + sendMax, + deliver, + dstAcc, + noAccount(), + pathSet, + std::nullopt, + env.app(), + &inputs); + BEAST_EXPECT(r.result() == temBAD_PATH); + } + { + auto const r = ::xrpl::path::RippleCalc::rippleCalculate( + sb, + sendMax, + deliver, + noAccount(), + srcAcc, + pathSet, + std::nullopt, + env.app(), + &inputs); + BEAST_EXPECT(r.result() == temBAD_PATH); + } + { + auto const r = ::xrpl::path::RippleCalc::rippleCalculate( + sb, + noAccountAmount, + deliver, + dstAcc, + srcAcc, + pathSet, + std::nullopt, + env.app(), + &inputs); + BEAST_EXPECT(r.result() == temBAD_PATH); + } + { + auto const r = ::xrpl::path::RippleCalc::rippleCalculate( + sb, + sendMax, + noAccountAmount, + dstAcc, + srcAcc, + pathSet, + std::nullopt, + env.app(), + &inputs); + BEAST_EXPECT(r.result() == temBAD_PATH); + } + } + catch (...) + { + this->fail(); + } + } + + void + run() override + { + using namespace jtx; + auto const sa = testable_amendments(); + testToStrand(sa); + + testRIPD1373(sa); + + testLoop(sa); + + testNoAccount(sa); + } +}; + +BEAST_DEFINE_TESTSUITE(PayStrandMPT, app, xrpl); + +} // namespace test +} // namespace xrpl diff --git a/src/test/app/PayStrand_test.cpp b/src/test/app/PayStrand_test.cpp index 256c5ae716..1fe3387310 100644 --- a/src/test/app/PayStrand_test.cpp +++ b/src/test/app/PayStrand_test.cpp @@ -1,34 +1,55 @@ -#include +#include +#include #include - -#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include #include #include +#include +#include #include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include namespace xrpl { namespace test { -struct DirectStepInfo -{ - AccountID src; - AccountID dst; - Currency currency; -}; - -struct XRPEndpointStepInfo -{ - AccountID acc; -}; - enum class TrustFlag { freeze, auth, noripple }; /*constexpr*/ std::uint32_t @@ -69,82 +90,6 @@ getTrustFlag( return false; // silence warning } -bool -equal(std::unique_ptr const& s1, DirectStepInfo const& dsi) -{ - if (!s1) - return false; - return test::directStepEqual(*s1, dsi.src, dsi.dst, dsi.currency); -} - -bool -equal(std::unique_ptr const& s1, XRPEndpointStepInfo const& xrpStepInfo) -{ - if (!s1) - return false; - return test::xrpEndpointStepEqual(*s1, xrpStepInfo.acc); -} - -bool -equal(std::unique_ptr const& s1, xrpl::Book const& bsi) -{ - if (!s1) - return false; - return bookStepEqual(*s1, bsi); -} - -template -bool -strandEqualHelper(Iter i) -{ - // base case. all args processed and found equal. - return true; -} - -template -bool -strandEqualHelper(Iter i, StepInfo&& si, Args&&... args) -{ - if (!equal(*i, std::forward(si))) - return false; - return strandEqualHelper(++i, std::forward(args)...); -} - -template -bool -equal(Strand const& strand, Args&&... args) -{ - if (strand.size() != sizeof...(Args)) - return false; - if (strand.empty()) - return true; - return strandEqualHelper(strand.begin(), std::forward(args)...); -} - -STPathElement -ape(AccountID const& a) -{ - return STPathElement(STPathElement::typeAccount, a, xrpCurrency(), xrpAccount()); -}; - -// Issue path element -STPathElement -ipe(Issue const& iss) -{ - return STPathElement( - STPathElement::typeCurrency | STPathElement::typeIssuer, - xrpAccount(), - iss.currency, - iss.account); -}; - -// Issuer path element -STPathElement -iape(AccountID const& account) -{ - return STPathElement(STPathElement::typeIssuer, xrpAccount(), xrpCurrency(), account); -}; - class ElementComboIter { enum class SB /*state bit*/ @@ -559,7 +504,7 @@ struct ExistingElementPool result.reserve(resultSize); while (outer.next()) { - StateGuard og{*this}; + StateGuard const og{*this}; outerResult = prefix; outer.emplace_into( outerResult, accF, issF, currencyF, existingAcc, existingCur, existingIss); @@ -567,7 +512,7 @@ struct ExistingElementPool ElementComboIter inner(prevInner); while (inner.next()) { - StateGuard ig{*this}; + StateGuard const ig{*this}; result = outerResult; inner.emplace_into( result, accF, issF, currencyF, existingAcc, existingCur, existingIss); @@ -644,7 +589,7 @@ struct PayStrand_test : public beast::unit_test::suite alice, /*deliver*/ xrpIssue(), /*limitQuality*/ std::nullopt, - /*sendMaxIssue*/ EUR.issue(), + /*sendMaxIssue*/ EUR, path, true, OfferCrossing::no, @@ -662,7 +607,7 @@ struct PayStrand_test : public beast::unit_test::suite alice, /*deliver*/ xrpIssue(), /*limitQuality*/ std::nullopt, - /*sendMaxIssue*/ EUR.issue(), + /*sendMaxIssue*/ EUR, path, true, OfferCrossing::no, @@ -695,7 +640,7 @@ struct PayStrand_test : public beast::unit_test::suite test( env, EUR, - USD.issue(), + USD, STPath(), tesSUCCESS, D{alice, gw, usdC}, @@ -706,7 +651,7 @@ struct PayStrand_test : public beast::unit_test::suite test( env, EUR, - USD.issue(), + USD, STPath({ipe(EUR)}), tesSUCCESS, D{alice, gw, usdC}, @@ -718,7 +663,7 @@ struct PayStrand_test : public beast::unit_test::suite test( env, carol["USD"], - USD.issue(), + USD, STPath({iape(carol)}), tesSUCCESS, D{alice, gw, usdC}, @@ -740,7 +685,7 @@ struct PayStrand_test : public beast::unit_test::suite test( env, xrpIssue(), - USD.issue(), + USD, STPath({STPathElement{ STPathElement::typeCurrency, xrpAccount(), xrpCurrency(), xrpAccount()}}), tesSUCCESS, @@ -752,7 +697,7 @@ struct PayStrand_test : public beast::unit_test::suite test( env, EUR, - USD.issue(), + USD, STPath({cpe(xrpCurrency())}), tesSUCCESS, D{alice, gw, usdC}, @@ -774,7 +719,7 @@ struct PayStrand_test : public beast::unit_test::suite xrpAccount(), XRP, std::nullopt, - USD.issue(), + USD, STPath(), true, OfferCrossing::no, @@ -820,7 +765,7 @@ struct PayStrand_test : public beast::unit_test::suite } // Create an offer with the same in/out issue - test(env, EUR, USD.issue(), STPath({ipe(USD), ipe(EUR)}), temBAD_PATH); + test(env, EUR, USD, STPath({ipe(USD), ipe(EUR)}), temBAD_PATH); // Path element with type zero test( @@ -836,7 +781,7 @@ struct PayStrand_test : public beast::unit_test::suite test(env, USD, std::nullopt, STPath({ape(gw), ape(carol)}), temBAD_PATH_LOOP); // The same offer can't appear more than once on a path - test(env, EUR, USD.issue(), STPath({ipe(EUR), ipe(USD), ipe(EUR)}), temBAD_PATH_LOOP); + test(env, EUR, USD, STPath({ipe(EUR), ipe(USD), ipe(EUR)}), temBAD_PATH_LOOP); } { @@ -958,7 +903,7 @@ struct PayStrand_test : public beast::unit_test::suite bob, XRP, std::nullopt, - USD.issue(), + USD, path, false, OfferCrossing::no, @@ -966,8 +911,8 @@ struct PayStrand_test : public beast::unit_test::suite std::nullopt, env.app().getJournal("Flow")); BEAST_EXPECT(isTesSuccess(ter)); - BEAST_EXPECT(equal( - strand, D{alice, gw, usdC}, B{USD.issue(), xrpIssue(), std::nullopt}, XRPS{bob})); + BEAST_EXPECT( + equal(strand, D{alice, gw, usdC}, B{USD, xrpIssue(), std::nullopt}, XRPS{bob})); } } @@ -1006,7 +951,7 @@ struct PayStrand_test : public beast::unit_test::suite return result; }(); - PathSet paths(p); + PathSet const paths(p); env(pay(alice, alice, EUR(1)), json(paths.json()), @@ -1125,12 +1070,12 @@ struct PayStrand_test : public beast::unit_test::suite Env env(*this, features); env.fund(XRP(10000), alice, bob, gw); - STAmount sendMax{USD.issue(), 100, 1}; - STAmount noAccountAmount{Issue{USD.currency, noAccount()}, 100, 1}; - STAmount deliver; + STAmount const sendMax{USD, 100, 1}; + STAmount const noAccountAmount{Issue{USD.currency, noAccount()}, 100, 1}; + STAmount const deliver; AccountID const srcAcc = alice.id(); - AccountID dstAcc = bob.id(); - STPathSet pathSet; + AccountID const dstAcc = bob.id(); + STPathSet const pathSet; ::xrpl::path::RippleCalc::Input inputs; inputs.defaultPathsAllowed = true; try diff --git a/src/test/app/PermissionedDEX_test.cpp b/src/test/app/PermissionedDEX_test.cpp index 7b622a1256..e2c567ec7f 100644 --- a/src/test/app/PermissionedDEX_test.cpp +++ b/src/test/app/PermissionedDEX_test.cpp @@ -1,27 +1,45 @@ -#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include -#include -#include +#include #include -#include +#include +#include +#include #include -#include #include #include #include #include +#include #include +#include +#include #include #include -#include -#include -#include +#include +#include #include -#include #include +#include #include #include #include @@ -183,7 +201,7 @@ class PermissionedDEX_test : public beast::unit_test::suite PermissionedDEX(env); // create devin account who is not part of the domain - Account devin("devin"); + Account const devin("devin"); env.fund(XRP(1000), devin); env.close(); env.trust(USD(1000), devin); @@ -216,7 +234,7 @@ class PermissionedDEX_test : public beast::unit_test::suite PermissionedDEX(env); // create devin account who is not part of the domain - Account devin("devin"); + Account const devin("devin"); env.fund(XRP(1000), devin); env.close(); env.trust(USD(1000), devin); @@ -402,7 +420,7 @@ class PermissionedDEX_test : public beast::unit_test::suite env.close(); // create devin account who is not part of the domain - Account devin("devin"); + Account const devin("devin"); env.fund(XRP(1000), devin); env.close(); env.trust(USD(1000), devin); @@ -448,7 +466,7 @@ class PermissionedDEX_test : public beast::unit_test::suite env.close(); // create devin account who is not part of the domain - Account devin("devin"); + Account const devin("devin"); env.fund(XRP(1000), devin); env.close(); env.trust(USD(1000), devin); @@ -641,8 +659,8 @@ class PermissionedDEX_test : public beast::unit_test::suite PermissionedDEX(env); // Fund devin and create USD trustline - Account badDomainOwner("badDomainOwner"); - Account devin("devin"); + Account const badDomainOwner("badDomainOwner"); + Account const devin("devin"); env.fund(XRP(1000), badDomainOwner, devin); env.close(); env.trust(USD(1000), devin); @@ -651,7 +669,7 @@ class PermissionedDEX_test : public beast::unit_test::suite env.close(); auto const badCredType = "badCred"; - pdomain::Credentials credentials{{badDomainOwner, badCredType}}; + pdomain::Credentials const credentials{{badDomainOwner, badCredType}}; env(pdomain::setTx(badDomainOwner, credentials)); auto objects = pdomain::getObjects(badDomainOwner, env); @@ -698,7 +716,7 @@ class PermissionedDEX_test : public beast::unit_test::suite env.close(); // fund devin but don't create a USD trustline with gateway - Account devin("devin"); + Account const devin("devin"); env.fund(XRP(1000), devin); env.close(); @@ -721,7 +739,7 @@ class PermissionedDEX_test : public beast::unit_test::suite PermissionedDEX(env); // create devin account who is not part of the domain - Account devin("devin"); + Account const devin("devin"); env.fund(XRP(1000), devin); env.close(); env.trust(USD(1000), devin); @@ -920,7 +938,7 @@ class PermissionedDEX_test : public beast::unit_test::suite Env env(*this, features); auto const& [gw, domainOwner, alice, bob, carol, USD, domainID, credType] = PermissionedDEX(env); - AMM amm(env, alice, XRP(10), USD(50)); + AMM const amm(env, alice, XRP(10), USD(50)); // a domain payment isn't able to consume AMM env(pay(bob, carol, USD(5)), @@ -1163,13 +1181,13 @@ class PermissionedDEX_test : public beast::unit_test::suite PermissionedDEX(env); // Fund accounts - Account badDomainOwner("badDomainOwner"); - Account devin("devin"); + Account const badDomainOwner("badDomainOwner"); + Account const devin("devin"); env.fund(XRP(1000), badDomainOwner, devin); env.close(); auto const badCredType = "badCred"; - pdomain::Credentials credentials{{badDomainOwner, badCredType}}; + pdomain::Credentials const credentials{{badDomainOwner, badCredType}}; env(pdomain::setTx(badDomainOwner, credentials)); auto objects = pdomain::getObjects(badDomainOwner, env); @@ -1297,8 +1315,8 @@ class PermissionedDEX_test : public beast::unit_test::suite std::vector offerSeqs; offerSeqs.reserve(100); - Book domainBook{Issue(XRP), Issue(USD), domainID}; - Book openBook{Issue(XRP), Issue(USD), std::nullopt}; + Book const domainBook{Issue(XRP), Issue(USD), domainID}; + Book const openBook{Issue(XRP), Issue(USD), std::nullopt}; auto const domainDir = getBookDirKey(domainBook, XRP(10), USD(10)); auto const openDir = getBookDirKey(openBook, XRP(10), USD(10)); @@ -1372,6 +1390,73 @@ class PermissionedDEX_test : public beast::unit_test::suite BEAST_EXPECT(!offerExists(env, bob, carolOfferSeq)); } + void + testHybridMalformedOffer(FeatureBitset features) + { + bool const fixS313Enabled = features[fixSecurity3_1_3]; + + testcase << "Hybrid offer with empty AdditionalBooks" + << (fixS313Enabled ? " (fixSecurity3_1_3 enabled)" + : " (fixSecurity3_1_3 disabled)"); + + // offerInDomain has two code paths gated by fixSecurity3_1_3: + // + // pre-fix: only rejects a hybrid offer when sfAdditionalBooks is + // entirely absent — an empty array (size 0) passes through. + // post-fix: also rejects a hybrid offer whose sfAdditionalBooks array + // has size != 1 (i.e. 0 or >1 entries). + // + // We create a valid hybrid offer, then directly manipulate its SLE to + // produce the size==0 case that cannot occur via normal transactions, + // and verify that the two code paths produce the expected outcomes. + // + // Note: the PermissionedDEX invariant checker (ValidPermissionedDEX) + // does not flag this malformation for ttPAYMENT — only for + // ttOFFER_CREATE — so the without-fix payment completes as tesSUCCESS. + + Env env(*this, features); + auto const& [gw, domainOwner, alice, bob, carol, USD, domainID, credType] = + PermissionedDEX(env); + + // Create a valid hybrid offer (sfAdditionalBooks has exactly 1 entry) + auto const bobOfferSeq{env.seq(bob)}; + env(offer(bob, XRP(10), USD(10)), txflags(tfHybrid), domain(domainID)); + env.close(); + BEAST_EXPECT(offerExists(env, bob, bobOfferSeq)); + + // Directly manipulate the offer SLE in the open ledger so that + // sfAdditionalBooks is present but empty (size 0). This is the + // malformed state that fixSecurity3_1_3 is designed to catch. + auto const offerKey = keylet::offer(bob.id(), bobOfferSeq); + env.app().getOpenLedger().modify([&offerKey](OpenView& view, beast::Journal) { + auto const sle = view.read(offerKey); + if (!sle) + return false; + auto replacement = std::make_shared(*sle, sle->key()); + replacement->setFieldArray(sfAdditionalBooks, STArray{}); + view.rawReplace(replacement); + return true; + }); + + if (fixS313Enabled) + { + // post-fixSecurity3_1_3: offerInDomain rejects the malformed + // offer (size == 0), so no valid domain offer is found. + env(pay(alice, carol, USD(10)), + path(~USD), + sendmax(XRP(10)), + domain(domainID), + ter(tecPATH_PARTIAL)); + } + else + { + // pre-fixSecurity3_1_3: offerInDomain only checks for a missing + // sfAdditionalBooks field; size == 0 passes through, so the + // malformed offer is crossed and the payment succeeds. + env(pay(alice, carol, USD(10)), path(~USD), sendmax(XRP(10)), domain(domainID)); + } + } + public: void run() override @@ -1393,6 +1478,8 @@ public: testHybridBookStep(all); testHybridInvalidOffer(all); testHybridOfferDirectories(all); + testHybridMalformedOffer(all); + testHybridMalformedOffer(all - fixSecurity3_1_3); } }; diff --git a/src/test/app/PermissionedDomains_test.cpp b/src/test/app/PermissionedDomains_test.cpp index c4bbd80e74..719ab5e7be 100644 --- a/src/test/app/PermissionedDomains_test.cpp +++ b/src/test/app/PermissionedDomains_test.cpp @@ -1,13 +1,31 @@ -#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include + +#include +#include +#include #include +#include +#include +#include #include -#include +#include #include #include #include #include +#include +#include #include #include @@ -49,7 +67,7 @@ class PermissionedDomains_test : public beast::unit_test::suite Account const alice("alice"); Env env(*this, features); env.fund(XRP(1000), alice); - pdomain::Credentials credentials{{alice, "first credential"}}; + pdomain::Credentials const credentials{{alice, "first credential"}}; env(pdomain::setTx(alice, credentials)); BEAST_EXPECT(env.ownerCount(alice) == 1); auto objects = pdomain::getObjects(alice, env); @@ -71,7 +89,7 @@ class PermissionedDomains_test : public beast::unit_test::suite Account const alice("alice"); Env env(*this, amendments); env.fund(XRP(1000), alice); - pdomain::Credentials credentials{{alice, "first credential"}}; + pdomain::Credentials const credentials{{alice, "first credential"}}; env(pdomain::setTx(alice, credentials), ter(temDISABLED)); } @@ -83,7 +101,7 @@ class PermissionedDomains_test : public beast::unit_test::suite Account const alice("alice"); Env env(*this, withoutFeature_); env.fund(XRP(1000), alice); - pdomain::Credentials credentials{{alice, "first credential"}}; + pdomain::Credentials const credentials{{alice, "first credential"}}; env(pdomain::setTx(alice, credentials), ter(temDISABLED)); env(pdomain::deleteTx(alice, uint256(75)), ter(temDISABLED)); } @@ -391,7 +409,7 @@ class PermissionedDomains_test : public beast::unit_test::suite constexpr std::size_t deleteDelta = 255; { // Close enough ledgers to make it potentially deletable if empty. - std::size_t ownerSeq = env.seq(alice[0]); + std::size_t const ownerSeq = env.seq(alice[0]); while (deleteDelta + ownerSeq > env.current()->seq()) env.close(); env(acctdelete(alice[0], alice[2]), fee(acctDelFee), ter(tecHAS_OBLIGATIONS)); @@ -402,7 +420,7 @@ class PermissionedDomains_test : public beast::unit_test::suite for (auto const& objs : pdomain::getObjects(alice[0], env)) env(pdomain::deleteTx(alice[0], objs.first)); env.close(); - std::size_t ownerSeq = env.seq(alice[0]); + std::size_t const ownerSeq = env.seq(alice[0]); while (deleteDelta + ownerSeq > env.current()->seq()) env.close(); env(acctdelete(alice[0], alice[2]), fee(acctDelFee)); @@ -420,7 +438,7 @@ class PermissionedDomains_test : public beast::unit_test::suite env.fund(XRP(1000), alice); auto const setFee(drops(env.current()->fees().increment)); - pdomain::Credentials credentials{{alice, "first credential"}}; + pdomain::Credentials const credentials{{alice, "first credential"}}; env(pdomain::setTx(alice, credentials)); env.close(); @@ -484,7 +502,7 @@ class PermissionedDomains_test : public beast::unit_test::suite BEAST_EXPECT(env.ownerCount(alice) == 0); // alice does not have enough XRP to cover the reserve. - pdomain::Credentials credentials{{alice, "first credential"}}; + pdomain::Credentials const credentials{{alice, "first credential"}}; env(pdomain::setTx(alice, credentials), ter(tecINSUFFICIENT_RESERVE)); BEAST_EXPECT(env.ownerCount(alice) == 0); BEAST_EXPECT(pdomain::getObjects(alice, env).empty()); diff --git a/src/test/app/PseudoTx_test.cpp b/src/test/app/PseudoTx_test.cpp index a9180d0e03..40d9977325 100644 --- a/src/test/app/PseudoTx_test.cpp +++ b/src/test/app/PseudoTx_test.cpp @@ -1,8 +1,20 @@ -#include +#include + +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include #include #include diff --git a/src/test/app/RCLValidations_test.cpp b/src/test/app/RCLValidations_test.cpp index 537563ecc4..0dae805696 100644 --- a/src/test/app/RCLValidations_test.cpp +++ b/src/test/app/RCLValidations_test.cpp @@ -1,10 +1,23 @@ -#include + +#include #include +#include +#include #include -#include +#include +#include #include +#include +#include +#include +#include +#include +#include + +#include +#include namespace xrpl { namespace test { @@ -55,7 +68,7 @@ class RCLValidations_test : public beast::unit_test::suite std::vector> history; jtx::Env env(*this); - Config config; + Config const config; auto prev = std::make_shared( create_genesis, Rules{config.features}, @@ -100,7 +113,7 @@ class RCLValidations_test : public beast::unit_test::suite // Empty ledger { - RCLValidatedLedger a{RCLValidatedLedger::MakeGenesis{}}; + RCLValidatedLedger const a{RCLValidatedLedger::MakeGenesis{}}; BEAST_EXPECT(a.seq() == Seq{0}); BEAST_EXPECT(a[Seq{0}] == ID{0}); BEAST_EXPECT(a.minSeq() == Seq{0}); @@ -108,8 +121,8 @@ class RCLValidations_test : public beast::unit_test::suite // Full history ledgers { - std::shared_ptr ledger = history.back(); - RCLValidatedLedger a{ledger, env.journal}; + std::shared_ptr const ledger = history.back(); + RCLValidatedLedger const a{ledger, env.journal}; BEAST_EXPECT(a.seq() == ledger->header().seq); BEAST_EXPECT(a.minSeq() == a.seq() - maxAncestors); // Ensure the ancestral 256 ledgers have proper ID @@ -130,21 +143,21 @@ class RCLValidations_test : public beast::unit_test::suite // Empty with non-empty { - RCLValidatedLedger a{RCLValidatedLedger::MakeGenesis{}}; + RCLValidatedLedger const a{RCLValidatedLedger::MakeGenesis{}}; for (auto const& ledger : {history.back(), history[maxAncestors - 1]}) { - RCLValidatedLedger b{ledger, env.journal}; + RCLValidatedLedger const b{ledger, env.journal}; BEAST_EXPECT(mismatch(a, b) == 1); BEAST_EXPECT(mismatch(b, a) == 1); } } // Same chains, different seqs { - RCLValidatedLedger a{history.back(), env.journal}; + RCLValidatedLedger const a{history.back(), env.journal}; for (Seq s = a.seq(); s > 0; s--) { - RCLValidatedLedger b{history[s - 1], env.journal}; + RCLValidatedLedger const b{history[s - 1], env.journal}; if (s >= a.minSeq()) { BEAST_EXPECT(mismatch(a, b) == b.seq() + 1); @@ -162,8 +175,8 @@ class RCLValidations_test : public beast::unit_test::suite // Alt history diverged at history.size()/2 for (Seq s = 1; s < history.size(); ++s) { - RCLValidatedLedger a{history[s - 1], env.journal}; - RCLValidatedLedger b{altHistory[s - 1], env.journal}; + RCLValidatedLedger const a{history[s - 1], env.journal}; + RCLValidatedLedger const b{altHistory[s - 1], env.journal}; BEAST_EXPECT(a.seq() == b.seq()); if (s <= diverge) @@ -183,10 +196,10 @@ class RCLValidations_test : public beast::unit_test::suite // Different chains, different seqs { // Compare around the divergence point - RCLValidatedLedger a{history[diverge], env.journal}; + RCLValidatedLedger const a{history[diverge], env.journal}; for (Seq offset = diverge / 2; offset < 3 * diverge / 2; ++offset) { - RCLValidatedLedger b{altHistory[offset - 1], env.journal}; + RCLValidatedLedger const b{altHistory[offset - 1], env.journal}; if (offset <= diverge) { BEAST_EXPECT(mismatch(a, b) == b.seq() + 1); @@ -221,7 +234,7 @@ class RCLValidations_test : public beast::unit_test::suite // Generate a chain of 256 + 10 ledgers jtx::Env env(*this); auto& j = env.journal; - Config config; + Config const config; auto prev = std::make_shared( create_genesis, Rules{config.features}, diff --git a/src/test/app/ReducedOffer_test.cpp b/src/test/app/ReducedOffer_test.cpp index 46193a1544..19e91fb846 100644 --- a/src/test/app/ReducedOffer_test.cpp +++ b/src/test/app/ReducedOffer_test.cpp @@ -1,10 +1,28 @@ -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include + +#include +#include +#include #include #include +#include +#include +#include #include +#include #include +#include namespace xrpl { namespace test { @@ -150,7 +168,7 @@ public: }; // bob's offer (the new offer) is the same every time: - Amounts const bobOffer{STAmount(XRP(1)), STAmount(USD.issue(), 1, 0)}; + Amounts const bobOffer{STAmount(XRP(1)), STAmount(USD, 1, 0)}; // alice's offer has a slightly smaller TakerPays with each // iteration. This should mean that the size of the offer bob @@ -160,12 +178,12 @@ public: mantissaReduce <= 5'000'000'000ull; mantissaReduce += 20'000'000ull) { - STAmount aliceUSD{ - bobOffer.out.issue(), + STAmount const aliceUSD{ + bobOffer.out.asset(), bobOffer.out.mantissa() - mantissaReduce, bobOffer.out.exponent()}; - STAmount aliceXRP{bobOffer.in.issue(), bobOffer.in.mantissa() - 1}; - Amounts aliceOffer{aliceUSD, aliceXRP}; + STAmount const aliceXRP{bobOffer.in.asset(), bobOffer.in.mantissa() - 1}; + Amounts const aliceOffer{aliceUSD, aliceXRP}; blockedCount += exerciseOfferPair(aliceOffer, bobOffer); } @@ -282,7 +300,7 @@ public: }; // alice's offer (the old offer) is the same every time: - Amounts const aliceOffer{STAmount(XRP(1)), STAmount(USD.issue(), 1, 0)}; + Amounts const aliceOffer{STAmount(XRP(1)), STAmount(USD, 1, 0)}; // bob's offer has a slightly smaller TakerPays with each iteration. // This should mean that the size of the offer alice leaves in the @@ -292,12 +310,12 @@ public: mantissaReduce <= 4'000'000'000ull; mantissaReduce += 20'000'000ull) { - STAmount bobUSD{ - aliceOffer.out.issue(), + STAmount const bobUSD{ + aliceOffer.out.asset(), aliceOffer.out.mantissa() - mantissaReduce, aliceOffer.out.exponent()}; - STAmount bobXRP{aliceOffer.in.issue(), aliceOffer.in.mantissa() - 1}; - Amounts bobOffer{bobUSD, bobXRP}; + STAmount const bobXRP{aliceOffer.in.asset(), aliceOffer.in.mantissa() - 1}; + Amounts const bobOffer{bobUSD, bobXRP}; blockedCount += exerciseOfferPair(aliceOffer, bobOffer); } @@ -407,7 +425,7 @@ public: auto const USD = gw["USD"]; auto const EUR = gw["EUR"]; - STAmount const tinyUSD(USD.issue(), /*mantissa*/ 1, /*exponent*/ -81); + STAmount const tinyUSD(USD, /*mantissa*/ 1, /*exponent*/ -81); { Env env{*this, testable_amendments()}; @@ -417,10 +435,10 @@ public: env.trust(USD(1000), alice, bob); env.trust(EUR(1000), alice, bob); - STAmount const eurOffer(EUR.issue(), /*mantissa*/ 2957, /*exponent*/ -76); - STAmount const usdOffer(USD.issue(), /*mantissa*/ 7109, /*exponent*/ -76); + STAmount const eurOffer(EUR, /*mantissa*/ 2957, /*exponent*/ -76); + STAmount const usdOffer(USD, /*mantissa*/ 7109, /*exponent*/ -76); - STAmount const endLoop(USD.issue(), /*mantissa*/ 50, /*exponent*/ -81); + STAmount const endLoop(USD, /*mantissa*/ 50, /*exponent*/ -81); int blockedOrderBookCount = 0; for (STAmount initialBobUSD = tinyUSD; initialBobUSD <= endLoop; @@ -445,7 +463,7 @@ public: // Examine the aftermath of alice's offer. { bool const bobOfferGone = !offerInLedger(env, bob, bobOfferSeq); - STAmount aliceBalanceUSD = env.balance(alice, USD); + STAmount const aliceBalanceUSD = env.balance(alice, USD); #if 0 std::cout << "bob initial: " << initialBobUSD @@ -580,7 +598,7 @@ public: { Json::Value aliceOffer = ledgerEntryOffer(env, alice, aliceOfferSeq); - Amounts aliceReducedOffer = jsonOfferToAmounts(aliceOffer[jss::node]); + Amounts const aliceReducedOffer = jsonOfferToAmounts(aliceOffer[jss::node]); BEAST_EXPECT(aliceReducedOffer.in < aliceInitialOffer.in); BEAST_EXPECT(aliceReducedOffer.out < aliceInitialOffer.out); @@ -595,7 +613,7 @@ public: if (badRate == 0) { STAmount const tweakedTakerGets( - aliceReducedOffer.in.issue(), + aliceReducedOffer.in.asset(), aliceReducedOffer.in.mantissa() + 1, aliceReducedOffer.in.exponent(), aliceReducedOffer.in.negative()); @@ -629,7 +647,7 @@ public: unsigned int blockedCount = 0; { STAmount increaseGets = USD(0); - STAmount const step(increaseGets.issue(), 1, -8); + STAmount const step(increaseGets.asset(), 1, -8); for (unsigned int i = 0; i < loopCount; ++i) { blockedCount += diff --git a/src/test/app/Regression_test.cpp b/src/test/app/Regression_test.cpp index 55b4b9a87c..4dcf1507f3 100644 --- a/src/test/app/Regression_test.cpp +++ b/src/test/app/Regression_test.cpp @@ -1,16 +1,56 @@ -#include +#include +#include +#include +#include +#include // IWYU pragma: keep #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include #include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include #include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -113,7 +153,8 @@ struct Regression_test : public beast::unit_test::suite auto test256r1key = [&env](Account const& acct) { auto const baseFee = env.current()->fees().base; std::uint32_t const acctSeq = env.seq(acct); - Json::Value jsonNoop = env.json(noop(acct), fee(baseFee), seq(acctSeq), sig(acct)); + Json::Value const jsonNoop = + env.json(noop(acct), fee(baseFee), seq(acctSeq), sig(acct)); JTx jt = env.jt(jsonNoop); jt.fill_sig = false; @@ -237,8 +278,8 @@ struct Regression_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Account alice("alice"); - Account bob("bob"); + Account const alice("alice"); + Account const bob("bob"); env.fund(XRP(10'000), alice, bob); env.close(); diff --git a/src/test/app/SHAMapStore_test.cpp b/src/test/app/SHAMapStore_test.cpp index 73cbf1c617..cdd8df972b 100644 --- a/src/test/app/SHAMapStore_test.cpp +++ b/src/test/app/SHAMapStore_test.cpp @@ -1,15 +1,37 @@ -#include +#include +#include #include #include #include #include #include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { diff --git a/src/test/app/SetAuth_test.cpp b/src/test/app/SetAuth_test.cpp index a38cf7175a..1cfa1225ff 100644 --- a/src/test/app/SetAuth_test.cpp +++ b/src/test/app/SetAuth_test.cpp @@ -1,8 +1,23 @@ -#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include #include +#include +#include +#include +#include #include +#include + namespace xrpl { namespace test { diff --git a/src/test/app/SetRegularKey_test.cpp b/src/test/app/SetRegularKey_test.cpp index 3cce01a112..af79bb75bc 100644 --- a/src/test/app/SetRegularKey_test.cpp +++ b/src/test/app/SetRegularKey_test.cpp @@ -1,6 +1,25 @@ -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { diff --git a/src/test/app/TheoreticalQuality_test.cpp b/src/test/app/TheoreticalQuality_test.cpp index b4f6f3697d..9cf9d0d68d 100644 --- a/src/test/app/TheoreticalQuality_test.cpp +++ b/src/test/app/TheoreticalQuality_test.cpp @@ -1,16 +1,49 @@ -#include -#include -#include -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include #include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -199,7 +232,7 @@ class TheoreticalQuality_test : public beast::unit_test::suite prettyQuality(Quality const& q) { std::stringstream sstr; - STAmount rate = q.rate(); + STAmount const rate = q.rate(); sstr << rate << " (" << q << ")"; return sstr.str(); }; @@ -220,22 +253,22 @@ class TheoreticalQuality_test : public beast::unit_test::suite std::shared_ptr closed, std::optional const& expectedQ = {}) { - PaymentSandbox sb(closed.get(), tapNONE); + PaymentSandbox const sb(closed.get(), tapNONE); AMMContext ammContext(rcp.srcAccount, false); - auto const sendMaxIssue = [&rcp]() -> std::optional { + auto const sendMaxIssue = [&rcp]() -> std::optional { if (rcp.sendMax) - return rcp.sendMax->issue(); + return rcp.sendMax->asset(); return std::nullopt; }(); - beast::Journal dummyJ{beast::Journal::getNullSink()}; + beast::Journal const dummyJ{beast::Journal::getNullSink()}; auto sr = toStrands( sb, rcp.srcAccount, rcp.dstAccount, - rcp.dstAmt.issue(), + rcp.dstAmt.asset(), /*limitQuality*/ std::nullopt, sendMaxIssue, rcp.paths, @@ -295,8 +328,6 @@ public: { testcase("Direct Step"); - // clang-format off - // Set up a payment through four accounts: alice -> bob -> carol -> dan // For each relevant trust line on the path, there are three things that can vary: // 1) input quality @@ -305,8 +336,6 @@ public: // For each account, there is one thing that can vary: // 1) transfer rate - // clang-format on - using namespace jtx; auto const currency = to_currency("USD"); @@ -370,7 +399,7 @@ public: // Accounts are set up, make the payment IOU const iou{accounts.back(), currency}; - RippleCalcTestParams rcp{env.json( + RippleCalcTestParams const rcp{env.json( pay(accounts.front(), accounts.back(), iou(paymentAmount)), accountsPath, txflags(tfNoRippleDirect))}; @@ -385,14 +414,12 @@ public: testcase("Book Step"); using namespace jtx; - // clang-format off + // Setup a payment through an offer: + // alice (USD/bob) -> bob -> (USD/bob)|(EUR/carol) -> carol -> dan + // For each relevant trust line, vary input quality, output quality, debt direction. For + // each account, vary transfer rate. - // Setup a payment through an offer: alice (USD/bob) -> bob -> (USD/bob)|(EUR/carol) -> carol -> dan - // For each relevant trust line, vary input quality, output quality, debt direction. - // For each account, vary transfer rate. - // The USD/bob|EUR/carol offer owner is "Oscar" - - // clang-format on + // The USD/bob|EUR/carol offer owner is "Oscar". int const numTestIterations = reqNumIterations.value_or(100); @@ -419,7 +446,7 @@ public: auto const USDB = bob["USD"]; auto const EURC = carol["EUR"]; constexpr std::size_t const numAccounts = 5; - std::array accounts{{alice, bob, carol, dan, oscar}}; + std::array const accounts{{alice, bob, carol, dan, oscar}}; // sendmax should be in USDB and delivered amount should be in EURC // normalized path should be: @@ -451,7 +478,7 @@ public: // Accounts are set up, make the payment IOU const srcIOU{bob, usdCurrency}; IOU const dstIOU{carol, eurCurrency}; - RippleCalcTestParams rcp{env.json( + RippleCalcTestParams const rcp{env.json( pay(alice, dan, dstIOU(paymentAmount)), sendmax(srcIOU(100 * paymentAmount)), bookPath, diff --git a/src/test/app/Ticket_test.cpp b/src/test/app/Ticket_test.cpp index 7d300f61ca..8ee41d12de 100644 --- a/src/test/app/Ticket_test.cpp +++ b/src/test/app/Ticket_test.cpp @@ -1,10 +1,48 @@ -#include + +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { class Ticket_test : public beast::unit_test::suite @@ -378,7 +416,7 @@ class Ticket_test : public beast::unit_test::suite { // Create tickets on a non-existent account. Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; env.memoize(alice); env(ticket::create(alice, 1), json(jss::Sequence, 1), ter(terNO_ACCOUNT)); @@ -387,11 +425,11 @@ class Ticket_test : public beast::unit_test::suite // Exceed the threshold where tickets can no longer be // added to an account. Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(100000), alice); - std::uint32_t ticketSeq{env.seq(alice) + 1}; + std::uint32_t const ticketSeq{env.seq(alice) + 1}; env(ticket::create(alice, 250)); checkTicketCreateMeta(env); env.close(); @@ -424,12 +462,12 @@ class Ticket_test : public beast::unit_test::suite { // Explore exceeding the ticket threshold from another angle. Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(100000), alice); env.close(); - std::uint32_t ticketSeq_AB{env.seq(alice) + 1}; + std::uint32_t const ticketSeq_AB{env.seq(alice) + 1}; env(ticket::create(alice, 2)); checkTicketCreateMeta(env); env.close(); @@ -462,7 +500,7 @@ class Ticket_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; // Fund alice not quite enough to make the reserve for a Ticket. env.fund(env.current()->fees().accountReserve(1) - drops(1), alice); @@ -515,7 +553,7 @@ class Ticket_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(10000), alice); env.close(); @@ -611,14 +649,14 @@ class Ticket_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(10000), alice); env.close(); // Lambda that returns the hash of the most recent transaction. auto getTxID = [&env, this]() -> uint256 { - std::shared_ptr tx{env.tx()}; + std::shared_ptr const tx{env.tx()}; if (!BEAST_EXPECTS(tx, "Transaction not found")) Throw("Invalid transaction ID"); @@ -689,7 +727,7 @@ class Ticket_test : public beast::unit_test::suite BEAST_EXPECT(txErrCode == rpcSUCCESS); if (auto txPtr = std::get_if(&maybeTx)) { - std::shared_ptr& tx = txPtr->first; + std::shared_ptr const& tx = txPtr->first; BEAST_EXPECT(tx->getLedger() == ledgerSeq); std::shared_ptr const& sttx = tx->getSTransaction(); BEAST_EXPECT((*sttx)[sfSequence] == txSeq); @@ -726,7 +764,7 @@ class Ticket_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(10000), alice); env.close(); @@ -812,7 +850,7 @@ class Ticket_test : public beast::unit_test::suite testcase("Fix both Seq and Ticket"); Env env{*this, testable_amendments()}; - Account alice{"alice"}; + Account const alice{"alice"}; env.fund(XRP(10000), alice); env.close(); diff --git a/src/test/app/Transaction_ordering_test.cpp b/src/test/app/Transaction_ordering_test.cpp index c50fbf4e56..ece3e25bae 100644 --- a/src/test/app/Transaction_ordering_test.cpp +++ b/src/test/app/Transaction_ordering_test.cpp @@ -1,6 +1,22 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include #include +#include + +#include +#include namespace xrpl { namespace test { diff --git a/src/test/app/TrustAndBalance_test.cpp b/src/test/app/TrustAndBalance_test.cpp index 3a2aa8e7c9..e6cc7e71ca 100644 --- a/src/test/app/TrustAndBalance_test.cpp +++ b/src/test/app/TrustAndBalance_test.cpp @@ -1,11 +1,26 @@ -#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include -#include +#include +#include +#include #include #include +#include #include +#include + namespace xrpl { class TrustAndBalance_test : public beast::unit_test::suite @@ -28,7 +43,7 @@ class TrustAndBalance_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this}; - Account alice{"alice"}; + Account const alice{"alice"}; env(trust(env.master, alice["USD"](100)), ter(tecNO_DST)); } @@ -40,9 +55,9 @@ class TrustAndBalance_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this}; - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env.close(); @@ -112,8 +127,8 @@ class TrustAndBalance_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this, features}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), alice, bob); env.close(); @@ -156,9 +171,9 @@ class TrustAndBalance_test : public beast::unit_test::suite Env env{*this, features}; auto wsc = test::makeWSClient(env.app().config()); - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env.close(); @@ -229,9 +244,9 @@ class TrustAndBalance_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this, features}; - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env.close(); @@ -276,9 +291,9 @@ class TrustAndBalance_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this, features}; - Account gw{"gateway"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gateway"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), gw, alice, bob); env.close(); @@ -319,11 +334,11 @@ class TrustAndBalance_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this, features}; - Account gw{"gateway"}; - Account amazon{"amazon"}; - Account alice{"alice"}; - Account bob{"bob"}; - Account carol{"carol"}; + Account const gw{"gateway"}; + Account const amazon{"amazon"}; + Account const alice{"alice"}; + Account const bob{"bob"}; + Account const carol{"carol"}; env.fund(XRP(10000), gw, amazon, alice, bob, carol); env.close(); @@ -358,8 +373,7 @@ class TrustAndBalance_test : public beast::unit_test::suite { env.require(balance( alice, - STAmount( - carol["USD"].issue(), 6500000000000000ull, -14, true, STAmount::unchecked{}))); + STAmount(carol["USD"], 6500000000000000ull, -14, true, STAmount::unchecked{}))); env.require(balance(carol, gw["USD"](35))); } else @@ -379,7 +393,7 @@ class TrustAndBalance_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this, features}; - Account alice{"alice"}; + Account const alice{"alice"}; auto wsc = test::makeWSClient(env.app().config()); env.fund(XRP(10000), alice); diff --git a/src/test/app/TrustSet_test.cpp b/src/test/app/TrustSet_test.cpp index d359ba1f26..9d117cb7a4 100644 --- a/src/test/app/TrustSet_test.cpp +++ b/src/test/app/TrustSet_test.cpp @@ -1,8 +1,29 @@ -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include + namespace xrpl { namespace test { diff --git a/src/test/app/TxQ_test.cpp b/src/test/app/TxQ_test.cpp index 566551fe2a..12808e7596 100644 --- a/src/test/app/TxQ_test.cpp +++ b/src/test/app/TxQ_test.cpp @@ -1,18 +1,59 @@ -#include +#include +#include +#include #include -#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include -#include #include #include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -261,9 +302,7 @@ public: env(noop(alice), fee(baseFee * 2.0), queued); // Queue is full now. - // clang-format off checkMetrics(*this, env, 6, 6, 4, 3, txFeeLevelByAccount(env, daria) + 1); - // clang-format on // Try to add another transaction with the default (low) fee, // it should fail because the queue is full. env(noop(charlie), ter(telCAN_NOT_QUEUE_FULL)); @@ -274,18 +313,22 @@ public: env(noop(charlie), fee(baseFee * 10), queued); // Queue is still full, of course, but the min fee has gone up - // clang-format off checkMetrics(*this, env, 6, 6, 4, 3, txFeeLevelByAccount(env, elmo) + 1); - // clang-format on // Close out the ledger, the transactions are accepted, the // queue is cleared, then the localTxs are retried. At this // point, daria's transaction that was dropped from the queue // is put back in. Neat. env.close(); - // clang-format off - checkMetrics(*this, env, 2, 8, 5, 4, baseFeeLevel.fee(), calcMedFeeLevel(FeeLevel64{baseFeeLevel.fee() * largeFeeMultiplier})); - // clang-format on + checkMetrics( + *this, + env, + 2, + 8, + 5, + 4, + baseFeeLevel.fee(), + calcMedFeeLevel(FeeLevel64{baseFeeLevel.fee() * largeFeeMultiplier})); env.close(); checkMetrics(*this, env, 0, 10, 2, 5); @@ -498,7 +541,7 @@ public: // We haven't yet shown that ticket-based transactions can be added // to the queue in any order. We should do that... - std::uint32_t tkt250 = tkt1 + 249; + std::uint32_t const tkt250 = tkt1 + 249; env(noop(alice), ticket::use(tkt250 - 0), fee(baseFee * 3.0), queued); env(noop(alice), ticket::use(tkt1 + 14), fee(baseFee * 2.9), queued); env(noop(alice), ticket::use(tkt250 - 1), fee(baseFee * 2.8), queued); @@ -750,15 +793,13 @@ public: env.close(); // alice's transaction is still hanging around - // clang-format off - checkMetrics(*this, env, 1, 8, 5, 4, baseFeeLevel.fee(), baseFeeLevel.fee() * largeFeeMultiplier); - // clang-format on + checkMetrics( + *this, env, 1, 8, 5, 4, baseFeeLevel.fee(), baseFeeLevel.fee() * largeFeeMultiplier); BEAST_EXPECT(env.seq(alice) == 3); constexpr auto anotherLargeFeeMultiplier = 800; auto const anotherLargeFee = baseFee * anotherLargeFeeMultiplier; // Keep alice's transaction waiting. - // clang-format off env(noop(bob), fee(anotherLargeFee), queued); env(noop(charlie), fee(anotherLargeFee), queued); env(noop(daria), fee(anotherLargeFee), queued); @@ -766,24 +807,36 @@ public: env(noop(edgar), fee(anotherLargeFee), queued); env(noop(felicia), fee(anotherLargeFee - 1), queued); env(noop(felicia), fee(anotherLargeFee - 1), seq(env.seq(felicia) + 1), queued); - checkMetrics(*this, env, 8, 8, 5, 4, baseFeeLevel.fee() + 1, baseFeeLevel.fee() * largeFeeMultiplier); - // clang-format on + checkMetrics( + *this, + env, + 8, + 8, + 5, + 4, + baseFeeLevel.fee() + 1, + baseFeeLevel.fee() * largeFeeMultiplier); env.close(); // alice's transaction expired without getting // into the ledger, so her transaction is gone, // though one of felicia's is still in the queue. - // clang-format off - checkMetrics(*this, env, 1, 10, 6, 5, baseFeeLevel.fee(), baseFeeLevel.fee() * largeFeeMultiplier); - // clang-format on + checkMetrics( + *this, env, 1, 10, 6, 5, baseFeeLevel.fee(), baseFeeLevel.fee() * largeFeeMultiplier); BEAST_EXPECT(env.seq(alice) == 3); BEAST_EXPECT(env.seq(felicia) == 7); env.close(); // And now the queue is empty - // clang-format off - checkMetrics(*this, env, 0, 12, 1, 6, baseFeeLevel.fee(), baseFeeLevel.fee() * anotherLargeFeeMultiplier); - // clang-format on + checkMetrics( + *this, + env, + 0, + 12, + 1, + 6, + baseFeeLevel.fee(), + baseFeeLevel.fee() * anotherLargeFeeMultiplier); BEAST_EXPECT(env.seq(alice) == 3); BEAST_EXPECT(env.seq(felicia) == 8); } @@ -857,9 +910,7 @@ public: feeCarol = (feeCarol + 1) * 125 / 100; ++seqCarol; } - // clang-format off checkMetrics(*this, env, 6, 6, 4, 3, (baseFeeLevel.fee() * aliceFeeMultiplier) + 1); - // clang-format on // Carol submits high enough to beat Bob's average fee which kicks // out Bob's queued transaction. However Bob's transaction stays @@ -1505,14 +1556,12 @@ public: env.close(); // If not for the maximum, the per ledger would be 11. - // clang-format off checkMetrics(*this, env, 0, 10, 0, 5, baseFeeLevel.fee(), calcMedFeeLevel(medFeeLevel)); - // clang-format on } try { - Env env( + Env const env( *this, makeConfig( {{"minimum_txn_in_ledger", "200"}, @@ -1533,7 +1582,7 @@ public: } try { - Env env( + Env const env( *this, makeConfig( {{"minimum_txn_in_ledger", "200"}, @@ -1554,7 +1603,7 @@ public: } try { - Env env( + Env const env( *this, makeConfig( {{"minimum_txn_in_ledger", "2"}, @@ -3379,6 +3428,7 @@ public: BEAST_EXPECT(jv[jss::status] == "success"); } + // NOLINTNEXTLINE(misc-const-correctness) Account a{"a"}, b{"b"}, c{"c"}, d{"d"}, e{"e"}, f{"f"}, g{"g"}, h{"h"}, i{"i"}; // Fund the first few accounts at non escalated fee @@ -3520,7 +3570,8 @@ public: } auto const den = (metrics.txPerLedger * metrics.txPerLedger); - FeeLevel64 feeLevel = (metrics.medFeeLevel * totalFactor + FeeLevel64{den - 1}) / den; + FeeLevel64 const feeLevel = + (metrics.medFeeLevel * totalFactor + FeeLevel64{den - 1}) / den; auto result = toDrops(feeLevel, env.current()->fees().base).drops(); diff --git a/src/test/app/ValidatorKeys_test.cpp b/src/test/app/ValidatorKeys_test.cpp index 29876dea7c..23f0432c5e 100644 --- a/src/test/app/ValidatorKeys_test.cpp +++ b/src/test/app/ValidatorKeys_test.cpp @@ -1,4 +1,5 @@ #include +#include #include #include @@ -6,10 +7,18 @@ #include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include namespace xrpl { namespace test { @@ -59,7 +68,7 @@ public: // We're only using Env for its Journal. That Journal gives better // coverage in unit tests. test::jtx::Env env{*this, test::jtx::envconfig(), nullptr, beast::severities::kDisabled}; - beast::Journal journal{env.app().getJournal("ValidatorKeys_test")}; + beast::Journal const journal{env.app().getJournal("ValidatorKeys_test")}; // Keys/ID when using [validation_seed] SecretKey const seedSecretKey = @@ -82,8 +91,8 @@ public: { // No config -> no key but valid - Config c; - ValidatorKeys k{c, journal}; + Config const c; + ValidatorKeys const k{c, journal}; BEAST_EXPECT(!k.keys); BEAST_EXPECT(k.manifest.empty()); BEAST_EXPECT(!k.configInvalid()); @@ -109,7 +118,7 @@ public: Config c; c.section(SECTION_VALIDATION_SEED).append("badseed"); - ValidatorKeys k{c, journal}; + ValidatorKeys const k{c, journal}; BEAST_EXPECT(k.configInvalid()); BEAST_EXPECT(!k.keys); BEAST_EXPECT(k.manifest.empty()); @@ -134,7 +143,7 @@ public: // invalid validator token Config c; c.section(SECTION_VALIDATOR_TOKEN).append("badtoken"); - ValidatorKeys k{c, journal}; + ValidatorKeys const k{c, journal}; BEAST_EXPECT(k.configInvalid()); BEAST_EXPECT(!k.keys); BEAST_EXPECT(k.manifest.empty()); @@ -145,7 +154,7 @@ public: Config c; c.section(SECTION_VALIDATION_SEED).append(seed); c.section(SECTION_VALIDATOR_TOKEN).append(tokenBlob); - ValidatorKeys k{c, journal}; + ValidatorKeys const k{c, journal}; BEAST_EXPECT(k.configInvalid()); BEAST_EXPECT(!k.keys); @@ -156,7 +165,7 @@ public: // Token manifest and private key must match Config c; c.section(SECTION_VALIDATOR_TOKEN).append(invalidTokenBlob); - ValidatorKeys k{c, journal}; + ValidatorKeys const k{c, journal}; BEAST_EXPECT(k.configInvalid()); BEAST_EXPECT(!k.keys); diff --git a/src/test/app/ValidatorList_test.cpp b/src/test/app/ValidatorList_test.cpp index 3f1c20ee25..ab1fc72c9e 100644 --- a/src/test/app/ValidatorList_test.cpp +++ b/src/test/app/ValidatorList_test.cpp @@ -1,20 +1,53 @@ -#include + +#include +#include #include +#include #include #include +#include #include +#include #include +#include +#include #include +#include #include +#include +#include #include +#include #include +#include #include #include -#include +#include +#include +#include #include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -272,7 +305,7 @@ private: auto const masterNode1 = randomMasterKey(); auto const masterNode2 = randomMasterKey(); - std::vector cfgMasterKeys( + std::vector const cfgMasterKeys( {format(masterNode1), format(masterNode2, " Comment")}); BEAST_EXPECT(trustedKeys->load({}, cfgMasterKeys, emptyCfgPublishers)); BEAST_EXPECT(trustedKeys->listed(masterNode1)); @@ -362,7 +395,8 @@ private: // load should reject validator list signing keys with invalid // encoding - std::vector keys({randomMasterKey(), randomMasterKey(), randomMasterKey()}); + std::vector const keys( + {randomMasterKey(), randomMasterKey(), randomMasterKey()}); badPublishers.clear(); for (auto const& key : keys) badPublishers.push_back(toBase58(TokenType::NodePublic, key)); @@ -391,7 +425,7 @@ private: app.config().legacy("database_path"), env.journal); - std::vector keys( + std::vector const keys( {randomMasterKey(), randomMasterKey(), randomMasterKey(), randomMasterKey()}); std::vector cfgPublishers; cfgPublishers.reserve(keys.size()); @@ -433,7 +467,7 @@ private: auto legitKey1 = randomMasterKey(); auto legitKey2 = randomMasterKey(); - std::vector cfgPublishers = { + std::vector const cfgPublishers = { strHex(pubRevokedPublic), strHex(legitKey1), strHex(legitKey2)}; BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublishers)); @@ -471,7 +505,8 @@ private: // this one is not revoked (and not in the manifest cache at all.) auto legitKey = randomMasterKey(); - std::vector cfgPublishers = {strHex(pubRevokedPublic), strHex(legitKey)}; + std::vector const cfgPublishers = { + strHex(pubRevokedPublic), strHex(legitKey)}; BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublishers, std::size_t(2))); BEAST_EXPECT(!trustedKeys->trustedPublisher(pubRevokedPublic)); @@ -563,8 +598,8 @@ private: auto const manifest1 = base64_encode(makeManifestString( publisherPublic, publisherSecret, pubSigningKeys1.first, pubSigningKeys1.second, 1)); - std::vector cfgPublisherKeys({strHex(publisherPublic)}); - std::vector emptyCfgKeys; + std::vector const cfgPublisherKeys({strHex(publisherPublic)}); + std::vector const emptyCfgKeys; BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublisherKeys)); @@ -909,8 +944,8 @@ private: auto const manifest = base64_encode(makeManifestString( publisherPublic, publisherSecret, pubSigningKeys1.first, pubSigningKeys1.second, 1)); - std::vector cfgPublisherKeys({strHex(publisherPublic)}); - std::vector emptyCfgKeys; + std::vector const cfgPublisherKeys({strHex(publisherPublic)}); + std::vector const emptyCfgKeys; BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublisherKeys)); @@ -1033,7 +1068,7 @@ private: app.config().legacy("database_path"), env.journal); - std::vector cfgPublishersOuter; + std::vector const cfgPublishersOuter; hash_set activeValidatorsOuter; std::size_t const maxKeys = 40; @@ -1101,7 +1136,7 @@ private: auto const masterPrivate = randomSecretKey(); auto const masterPublic = derivePublicKey(KeyType::ed25519, masterPrivate); - std::vector cfgKeys({toBase58(TokenType::NodePublic, masterPublic)}); + std::vector const cfgKeys({toBase58(TokenType::NodePublic, masterPublic)}); BEAST_EXPECT(trustedKeysOuter->load({}, cfgKeys, cfgPublishersOuter)); @@ -1201,12 +1236,12 @@ private: auto const publisherSecret = randomSecretKey(); auto const publisherPublic = derivePublicKey(KeyType::ed25519, publisherSecret); - std::vector cfgPublishers({strHex(publisherPublic)}); - std::vector emptyCfgKeys; + std::vector const cfgPublishers({strHex(publisherPublic)}); + std::vector const emptyCfgKeys; BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublishers)); - TrustChanges changes = trustedKeys->updateTrusted( + TrustChanges const changes = trustedKeys->updateTrusted( activeValidatorsOuter, env.timeKeeper().now(), env.app().getOPs(), @@ -1227,18 +1262,18 @@ private: env.journal); auto const masterPrivate = randomSecretKey(); auto const masterPublic = derivePublicKey(KeyType::ed25519, masterPrivate); - std::vector cfgKeys({toBase58(TokenType::NodePublic, masterPublic)}); + std::vector const cfgKeys({toBase58(TokenType::NodePublic, masterPublic)}); auto const publisher1Secret = randomSecretKey(); auto const publisher1Public = derivePublicKey(KeyType::ed25519, publisher1Secret); auto const publisher2Secret = randomSecretKey(); auto const publisher2Public = derivePublicKey(KeyType::ed25519, publisher2Secret); - std::vector cfgPublishers( + std::vector const cfgPublishers( {strHex(publisher1Public), strHex(publisher2Public)}); BEAST_EXPECT(trustedKeys->load({}, cfgKeys, cfgPublishers, std::size_t(2))); - TrustChanges changes = trustedKeys->updateTrusted( + TrustChanges const changes = trustedKeys->updateTrusted( activeValidatorsOuter, env.timeKeeper().now(), env.app().getOPs(), @@ -1261,7 +1296,7 @@ private: env.journal, minQuorum); - std::size_t n = 10; + std::size_t const n = 10; std::vector cfgKeys; cfgKeys.reserve(n); hash_set expectedTrusted; @@ -1316,7 +1351,7 @@ private: app.config().legacy("database_path"), env.journal); - std::vector emptyCfgKeys; + std::vector const emptyCfgKeys; auto const publisherKeys = randomKeyPair(KeyType::secp256k1); auto const pubSigningKeys = randomKeyPair(KeyType::secp256k1); auto const manifest = base64_encode(makeManifestString( @@ -1326,7 +1361,7 @@ private: pubSigningKeys.second, 1)); - std::vector cfgPublisherKeys({strHex(publisherKeys.first)}); + std::vector const cfgPublisherKeys({strHex(publisherKeys.first)}); BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublisherKeys)); @@ -1415,7 +1450,7 @@ private: app.config().legacy("database_path"), env.journal); - std::vector cfgPublishers; + std::vector const cfgPublishers; hash_set activeValidators; hash_set activeKeys; @@ -1429,7 +1464,7 @@ private: activeValidators.emplace(calcNodeID(valKey)); activeKeys.emplace(valKey); BEAST_EXPECT(trustedKeys->load({}, cfgKeys, cfgPublishers)); - TrustChanges changes = trustedKeys->updateTrusted( + TrustChanges const changes = trustedKeys->updateTrusted( activeValidators, env.timeKeeper().now(), env.app().getOPs(), @@ -1452,7 +1487,7 @@ private: env.journal); auto const localKey = randomNode(); - std::vector cfgPublishers; + std::vector const cfgPublishers; hash_set activeValidators; hash_set activeKeys; std::vector cfgKeys{toBase58(TokenType::NodePublic, localKey)}; @@ -1466,7 +1501,7 @@ private: activeKeys.emplace(valKey); BEAST_EXPECT(trustedKeys->load(localKey, cfgKeys, cfgPublishers)); - TrustChanges changes = trustedKeys->updateTrusted( + TrustChanges const changes = trustedKeys->updateTrusted( activeValidators, env.timeKeeper().now(), env.app().getOPs(), @@ -1532,8 +1567,8 @@ private: pubSigningKeys.second, 1)); - std::vector cfgPublishers({strHex(publisherPublic)}); - std::vector emptyCfgKeys; + std::vector const cfgPublishers({strHex(publisherPublic)}); + std::vector const emptyCfgKeys; // Threshold of 1 will result in a union of all the lists BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublishers, std::size_t(1))); @@ -1542,7 +1577,7 @@ private: auto const sequence = 1; using namespace std::chrono_literals; NetClock::time_point const validUntil = env.timeKeeper().now() + 3600s; - std::vector localKeys{locals[i].first, locals[i].second}; + std::vector const localKeys{locals[i].first, locals[i].second}; auto const blob = makeList(localKeys, sequence, validUntil.time_since_epoch().count()); auto const sig = signList(blob, pubSigningKeys); @@ -1558,7 +1593,7 @@ private: addPublishedList(i); BEAST_EXPECT(trustedKeys->getListThreshold() == 1); - TrustChanges changes = trustedKeys->updateTrusted( + TrustChanges const changes = trustedKeys->updateTrusted( activeValidators, env.timeKeeper().now(), env.app().getOPs(), @@ -1624,8 +1659,8 @@ private: pubSigningKeys.second, 1)); - std::vector cfgPublishers({strHex(publisherPublic)}); - std::vector emptyCfgKeys; + std::vector const cfgPublishers({strHex(publisherPublic)}); + std::vector const emptyCfgKeys; BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublishers)); @@ -1655,7 +1690,7 @@ private: { validUntil2 = validUntil; } - std::vector localKeys{locals[i].first, locals[i].second}; + std::vector const localKeys{locals[i].first, locals[i].second}; auto const blob = makeList(localKeys, sequence, validUntil.time_since_epoch().count()); auto const sig = signList(blob, pubSigningKeys); @@ -1797,7 +1832,7 @@ private: BEAST_EXPECT(trustedKeys->expires() == std::nullopt); // Config listed keys have maximum expiry - PublicKey localCfgListed = randomNode(); + PublicKey const localCfgListed = randomNode(); trustedKeys->load({}, {toStr(localCfgListed)}, {}); BEAST_EXPECT( trustedKeys->expires() && @@ -1841,8 +1876,8 @@ private: pubSigningKeys.second, 1)); - std::vector cfgPublishers({strHex(publisherPublic)}); - std::vector emptyCfgKeys; + std::vector const cfgPublishers({strHex(publisherPublic)}); + std::vector const emptyCfgKeys; BEAST_EXPECT(trustedKeys->load({}, emptyCfgKeys, cfgPublishers)); @@ -1874,7 +1909,7 @@ private: // Configure two publishers and prepare 2 lists PreparedList prep1 = addPublishedList(); env.timeKeeper().set(env.timeKeeper().now() + 200s); - PreparedList prep2 = addPublishedList(); + PreparedList const prep2 = addPublishedList(); // Initially, no list has been published, so no known expiration BEAST_EXPECT(trustedKeys->expires() == std::nullopt); @@ -1955,7 +1990,7 @@ private: env.journal, minimumQuorum); - std::vector cfgPublishers; + std::vector const cfgPublishers; std::vector cfgKeys; hash_set activeValidators; cfgKeys.reserve(vlSize); @@ -1995,10 +2030,10 @@ private: */ { - hash_set activeValidators; + hash_set const activeValidators; //== Combinations == - std::array unlSizes = {34, 35, 39, 60}; - std::array nUnlPercent = {0, 20, 30, 50}; + std::array const unlSizes = {34, 35, 39, 60}; + std::array const nUnlPercent = {0, 20, 30, 50}; for (auto us : unlSizes) { for (auto np : nUnlPercent) @@ -2007,7 +2042,7 @@ private: BEAST_EXPECT(validators); if (validators) { - std::uint32_t nUnlSize = us * np / 100; + std::uint32_t const nUnlSize = us * np / 100; auto unl = validators->getTrustedMasterKeys(); hash_set nUnl; auto it = unl.begin(); @@ -2082,12 +2117,12 @@ private: // 18 auto nUnl = validators->getNegativeUNL(); BEAST_EXPECT(nUnl.size() == 12); - std::size_t ss = 33; + std::size_t const ss = 33; std::vector data(ss, 0); data[0] = 0xED; for (int i = 0; i < 6; ++i) { - Slice s(data.data(), ss); + Slice const s(data.data(), ss); data[1]++; nUnl.emplace(s); } @@ -2167,7 +2202,7 @@ private: BEAST_EXPECT(global != sha512Half(signature, blobVector, version)); { - std::map blobMap{{99, blobVector[0]}}; + std::map const blobMap{{99, blobVector[0]}}; BEAST_EXPECT(global == sha512Half(manifest, blobMap, version)); BEAST_EXPECT(global != sha512Half(blob, blobMap, version)); } @@ -3698,7 +3733,7 @@ private: for (auto const& p : publishers) BEAST_EXPECT(trustedKeys->trustedPublisher(p.pubKey)); - TrustChanges changes = trustedKeys->updateTrusted( + TrustChanges const changes = trustedKeys->updateTrusted( activeValidators, env.timeKeeper().now(), env.app().getOPs(), @@ -3736,7 +3771,7 @@ private: for (auto const& p : publishers) BEAST_EXPECT(trustedKeys->trustedPublisher(p.pubKey)); - TrustChanges changes = trustedKeys->updateTrusted( + TrustChanges const changes = trustedKeys->updateTrusted( activeValidators, env.timeKeeper().now(), env.app().getOPs(), diff --git a/src/test/app/ValidatorSite_test.cpp b/src/test/app/ValidatorSite_test.cpp index ee28410d9e..7e88f20f4c 100644 --- a/src/test/app/ValidatorSite_test.cpp +++ b/src/test/app/ValidatorSite_test.cpp @@ -1,21 +1,34 @@ -#include +#include #include +#include #include +#include #include +#include #include -#include +#include +#include +#include +#include #include #include -#include -#include +#include +#include #include #include #include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace detail { @@ -53,11 +66,11 @@ private: auto trustedSites = std::make_unique(env.app(), env.journal); // load should accept empty sites list - std::vector emptyCfgSites; + std::vector const emptyCfgSites; BEAST_EXPECT(trustedSites->load(emptyCfgSites)); // load should accept valid validator site uris - std::vector cfgSites( + std::vector const cfgSites( {"http://ripple.com/", "http://ripple.com/validators", "http://ripple.com:8080/validators", @@ -65,7 +78,7 @@ private: "http://207.261.33.37:8080/validators", "https://ripple.com/validators", "https://ripple.com:443/validators", - "file:///etc/opt/ripple/validators.txt", + "file:///etc/opt/xrpld/validators.txt", "file:///C:/Lib/validators.txt" #if !_MSC_VER , @@ -145,7 +158,7 @@ private: test::StreamSink sink; beast::Journal journal{sink}; - std::vector emptyCfgKeys; + std::vector const emptyCfgKeys; struct publisher { publisher(FetchListConfig const& c) : cfg{c} @@ -181,7 +194,7 @@ private: {{effective2, expires2}}, cfg.ssl, cfg.serverVersion); - std::string pubHex = strHex(item.server->publisherPublic()); + std::string const pubHex = strHex(item.server->publisherPublic()); cfgPublishers.push_back(pubHex); if (item.cfg.failFetch) @@ -337,11 +350,12 @@ private: }; { // Create a file with a real validator list - detail::FileDirGuard good(*this, "test_val", "vl.txt", detail::realValidatorContents()); + detail::FileDirGuard const good( + *this, "test_val", "vl.txt", detail::realValidatorContents()); // Create a file with arbitrary content - detail::FileDirGuard hello(*this, "test_val", "helloworld.txt", "Hello, world!"); + detail::FileDirGuard const hello(*this, "test_val", "helloworld.txt", "Hello, world!"); // Create a file with malformed Json - detail::FileDirGuard json( + detail::FileDirGuard const json( *this, "test_val", "json.txt", R"json({ "version": 2, "extra" : "value" })json"); auto const goodPath = fullPath(good); auto const helloPath = fullPath(hello); @@ -362,7 +376,7 @@ public: { testConfigLoad(); - detail::DirGuard good(*this, "test_fetch"); + detail::DirGuard const good(*this, "test_fetch"); for (auto ssl : {true, false}) { // fetch single site diff --git a/src/test/app/Vault_test.cpp b/src/test/app/Vault_test.cpp index 54cc6646b1..0e6b680ff3 100644 --- a/src/test/app/Vault_test.cpp +++ b/src/test/app/Vault_test.cpp @@ -1,14 +1,37 @@ -#include +#include #include +#include #include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include +#include +#include #include #include +#include +#include #include #include #include @@ -17,16 +40,27 @@ #include #include #include +#include #include #include #include #include +#include #include #include +#include +#include #include #include +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { @@ -43,11 +77,11 @@ class Vault_test : public beast::unit_test::suite testSequences() { using namespace test::jtx; - Account issuer{"issuer"}; - Account owner{"owner"}; - Account depositor{"depositor"}; - Account charlie{"charlie"}; // authorized 3rd party - Account dave{"dave"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; + Account const charlie{"charlie"}; // authorized 3rd party + Account const dave{"dave"}; auto const testSequence = [&, this]( std::string const& prefix, @@ -90,8 +124,8 @@ class Vault_test : public beast::unit_test::suite env.memoize(vaultAccount); // Several 3rd party accounts which cannot receive funds - Account alice{"alice"}; - Account erin{"erin"}; // not authorized by issuer + Account const alice{"alice"}; + Account const erin{"erin"}; // not authorized by issuer env.fund(XRP(1000), alice, erin); env(fset(alice, asfDepositAuth)); env.close(); @@ -514,14 +548,14 @@ class Vault_test : public beast::unit_test::suite env.require(flags(issuer, asfAllowTrustLineClawback)); env.require(flags(issuer, asfRequireAuth)); - PrettyAsset asset = setup(env); + PrettyAsset const asset = setup(env); testSequence(prefix, env, vault, asset); }; testCases("XRP", [&](Env& env) -> PrettyAsset { return {xrpIssue(), 1'000'000}; }); testCases("IOU", [&](Env& env) -> Asset { - PrettyAsset asset = issuer["IOU"]; + PrettyAsset const asset = issuer["IOU"]; env(trust(owner, asset(1000))); env(trust(depositor, asset(1000))); env(trust(charlie, asset(1000))); @@ -538,7 +572,7 @@ class Vault_test : public beast::unit_test::suite testCases("MPT", [&](Env& env) -> Asset { MPTTester mptt{env, issuer, mptInitNoFund}; mptt.create({.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock}); - PrettyAsset asset = mptt.issuanceID(); + PrettyAsset const asset = mptt.issuanceID(); mptt.authorize({.account = depositor}); mptt.authorize({.account = charlie}); mptt.authorize({.account = dave}); @@ -567,8 +601,8 @@ class Vault_test : public beast::unit_test::suite Vault& vault)> test, CaseArgs args = {}) { Env env{*this, args.features}; - Account issuer{"issuer"}; - Account owner{"owner"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; Vault vault{env}; env.fund(XRP(1000), issuer, owner); env.close(); @@ -577,7 +611,7 @@ class Vault_test : public beast::unit_test::suite env(fset(issuer, asfRequireAuth)); env.close(); - PrettyAsset asset = issuer["IOU"]; + PrettyAsset const asset = issuer["IOU"]; env(trust(owner, asset(1000))); env(trust(issuer, asset(0), owner, tfSetfAuth)); env(pay(issuer, owner, asset(1000))); @@ -1081,13 +1115,13 @@ class Vault_test : public beast::unit_test::suite Asset const& asset, Vault& vault)> test) { Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; - Account depositor{"depositor"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; env.fund(XRP(1000), issuer, owner, depositor); env.close(); Vault vault{env}; - Asset asset = xrpIssue(); + Asset const asset = xrpIssue(); test(env, issuer, owner, depositor, asset, vault); }; @@ -1246,13 +1280,13 @@ class Vault_test : public beast::unit_test::suite testcase("IOU fail because MPT is disabled"); Env env{ *this, (testable_amendments() - featureMPTokensV1) | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; env.fund(XRP(1000), issuer, owner); env.close(); - Vault vault{env}; - Asset asset = issuer["IOU"].asset(); + Vault const vault{env}; + Asset const asset = issuer["IOU"].asset(); auto [tx, keylet] = vault.create({.owner = owner, .asset = asset}); env(tx, ter(temDISABLED)); @@ -1262,15 +1296,15 @@ class Vault_test : public beast::unit_test::suite { testcase("IOU fail create frozen"); Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; env.fund(XRP(1000), issuer, owner); env.close(); env(fset(issuer, asfGlobalFreeze)); env.close(); - Vault vault{env}; - Asset asset = issuer["IOU"].asset(); + Vault const vault{env}; + Asset const asset = issuer["IOU"].asset(); auto [tx, keylet] = vault.create({.owner = owner, .asset = asset}); env(tx, ter(tecFROZEN)); @@ -1280,15 +1314,15 @@ class Vault_test : public beast::unit_test::suite { testcase("IOU fail create no ripling"); Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; env.fund(XRP(1000), issuer, owner); env.close(); env(fclear(issuer, asfDefaultRipple)); env.close(); - Vault vault{env}; - Asset asset = issuer["IOU"].asset(); + Vault const vault{env}; + Asset const asset = issuer["IOU"].asset(); auto [tx, keylet] = vault.create({.owner = owner, .asset = asset}); env(tx, ter(terNO_RIPPLE)); env.close(); @@ -1297,13 +1331,13 @@ class Vault_test : public beast::unit_test::suite { testcase("IOU no issuer"); Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; env.fund(XRP(1000), owner); env.close(); - Vault vault{env}; - Asset asset = issuer["IOU"].asset(); + Vault const vault{env}; + Asset const asset = issuer["IOU"].asset(); { auto [tx, keylet] = vault.create({.owner = owner, .asset = asset}); env(tx, ter(terNO_ACCOUNT)); @@ -1329,10 +1363,10 @@ class Vault_test : public beast::unit_test::suite return defXRP; return a + XRP(1000); } - auto defIOU = STAmount{a.issue(), 30000}; + auto defIOU = STAmount{a.asset(), 30000}; if (a <= defIOU) return defIOU; - return a + STAmount{a.issue(), 1000}; + return a + STAmount{a.asset(), 1000}; }; auto const toFund1 = toFund(asset1); auto const toFund2 = toFund(asset2); @@ -1351,12 +1385,12 @@ class Vault_test : public beast::unit_test::suite fund(env, gw, {alice, carol}, toFund2, {toFund1}, Fund::All); } - AMM ammAlice(env, alice, asset1, asset2, CreateArg{.log = false, .tfee = 0}); + AMM const ammAlice(env, alice, asset1, asset2, CreateArg{.log = false, .tfee = 0}); Account const owner{"owner"}; env.fund(XRP(1000000), owner); - Vault vault{env}; + Vault const vault{env}; auto [tx, k] = vault.create({.owner = owner, .asset = ammAlice.lptIssue()}); env(tx, ter{tecWRONG_ASSET}); env.close(); @@ -1377,16 +1411,16 @@ class Vault_test : public beast::unit_test::suite Asset const& asset, Vault& vault)> test) { Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; - Account depositor{"depositor"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; env.fund(XRP(1000), issuer, owner, depositor); env.close(); Vault vault{env}; MPTTester mptt{env, issuer, mptInitNoFund}; // Locked because that is the default flag. mptt.create(); - Asset asset = mptt.issuanceID(); + Asset const asset = mptt.issuanceID(); test(env, issuer, owner, depositor, asset, vault); }; @@ -1436,14 +1470,14 @@ class Vault_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; - Account depositor{"depositor"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; env.fund(XRP(1000), issuer, owner, depositor); env.close(); - Vault vault{env}; - PrettyAsset asset = issuer["IOU"]; + Vault const vault{env}; + PrettyAsset const asset = issuer["IOU"]; env.trust(asset(1000), owner); env(pay(issuer, owner, asset(100))); env.trust(asset(1000), depositor); @@ -1480,7 +1514,7 @@ class Vault_test : public beast::unit_test::suite }(); auto const MptID = makeMptID(1, vaultAccount); - Asset shares = MptID; + Asset const shares = MptID; { testcase("nontransferable shares cannot be moved"); @@ -1549,9 +1583,9 @@ class Vault_test : public beast::unit_test::suite MPTTester& mptt)> test, CaseArgs args = {}) { Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; - Account depositor{"depositor"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; env.fund(XRP(args.initialXRP), issuer, owner, depositor); env.close(); Vault vault{env}; @@ -1563,7 +1597,7 @@ class Vault_test : public beast::unit_test::suite (args.enableClawback ? tfMPTCanClawback : none) | (args.requireAuth ? tfMPTRequireAuth : none), .mutableFlags = tmfMPTCanMutateCanTransfer}); - PrettyAsset asset = mptt.issuanceID(); + PrettyAsset const asset = mptt.issuanceID(); mptt.authorize({.account = owner}); mptt.authorize({.account = depositor}); if (args.requireAuth) @@ -1654,10 +1688,10 @@ class Vault_test : public beast::unit_test::suite // accounts for the issued shares. auto v = env.le(keylet); BEAST_EXPECT(v); - MPTID share = (*v)[sfShareMPTID]; + MPTID const share = (*v)[sfShareMPTID]; auto issuance = env.le(keylet::mptIssuance(share)); BEAST_EXPECT(issuance); - Number outstandingShares = issuance->at(sfOutstandingAmount); + Number const outstandingShares = issuance->at(sfOutstandingAmount); BEAST_EXPECT(outstandingShares == 100); mptt.set({.account = issuer, .flags = tfMPTLock}); @@ -1761,7 +1795,7 @@ class Vault_test : public beast::unit_test::suite { // Set destination to 3rd party without MPToken - Account charlie{"charlie"}; + Account const charlie{"charlie"}; env.fund(XRP(1000), charlie); env.close(); @@ -1838,7 +1872,7 @@ class Vault_test : public beast::unit_test::suite {.requireAuth = false}); auto const [acctReserve, incReserve] = [this]() -> std::pair { - Env env{*this, testable_amendments()}; + Env const env{*this, testable_amendments()}; return { env.current()->fees().accountReserve(0).drops() / DROPS_PER_XRP.drops(), env.current()->fees().increment.drops() / DROPS_PER_XRP.drops()}; @@ -1975,7 +2009,7 @@ class Vault_test : public beast::unit_test::suite auto const vault = env.le(keylet); return vault->at(sfShareMPTID); }(keylet); - PrettyAsset shares = MPTIssue(issuanceId); + PrettyAsset const shares = MPTIssue(issuanceId); { // owner has MPToken for shares they did not explicitly create @@ -2173,18 +2207,18 @@ class Vault_test : public beast::unit_test::suite testcase("MPT shares to a vault"); Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account owner{"owner"}; - Account issuer{"issuer"}; + Account const owner{"owner"}; + Account const issuer{"issuer"}; env.fund(XRP(1000000), owner, issuer); env.close(); - Vault vault{env}; + Vault const vault{env}; MPTTester mptt{env, issuer, mptInitNoFund}; mptt.create( {.flags = tfMPTCanTransfer | tfMPTCanLock | lsfMPTCanClawback | tfMPTRequireAuth}); mptt.authorize({.account = owner}); mptt.authorize({.account = issuer, .holder = owner}); - PrettyAsset asset = mptt.issuanceID(); + PrettyAsset const asset = mptt.issuanceID(); env(pay(issuer, owner, asset(100))); auto [tx1, k1] = vault.create({.owner = owner, .asset = asset}); env(tx1); @@ -2241,6 +2275,43 @@ class Vault_test : public beast::unit_test::suite // Delete vault with zero balance env(vault.del({.owner = owner, .id = keylet.key})); }); + + { + testcase("MPT OutstandingAmount > MaximumAmount"); + + Env env{*this, testable_amendments() | featureSingleAssetVault}; + Account const alice{"alice"}; + Account const issuer{"issuer"}; + env.fund(XRP(1'000), alice, issuer); + env.close(); + Vault const vault{env}; + + MPTTester const BTC({.env = env, .issuer = issuer, .holders = {alice}, .maxAmt = 100}); + + auto [tx, k] = vault.create({.owner = issuer, .asset = BTC}); + env(tx); + env.close(); + + tx = vault.deposit({.depositor = issuer, .id = k.key, .amount = BTC(110)}); + // accountHolds is the first check and the issuer has only BTC(100) + // available + env(tx, ter{tecINSUFFICIENT_FUNDS}); + env.close(); + + // OutstandingAmount == MaximumAmount + env(pay(issuer, alice, BTC(100))); + env.close(); + + tx = vault.deposit({.depositor = issuer, .id = k.key, .amount = BTC(100)}); + // the issuer has BTC(0) available + env(tx, ter{tecINSUFFICIENT_FUNDS}); + env.close(); + + tx = vault.deposit({.depositor = alice, .id = k.key, .amount = BTC(100)}); + // alice transfers BTC(100), OutstandingAmount is 100 + env(tx); + env.close(); + } } void @@ -2650,7 +2721,7 @@ class Vault_test : public beast::unit_test::suite } { - PrettyAsset shares = issuanceId(keylet); + PrettyAsset const shares = issuanceId(keylet); auto tx1 = vault.deposit({.depositor = owner, .id = keylet.key, .amount = asset(100)}); env(tx1); @@ -2761,7 +2832,7 @@ class Vault_test : public beast::unit_test::suite {.initialIOU = Number(11875, -2)}); auto const [acctReserve, incReserve] = [this]() -> std::pair { - Env env{*this, testable_amendments()}; + Env const env{*this, testable_amendments()}; return { env.current()->fees().accountReserve(0).drops() / DROPS_PER_XRP.drops(), env.current()->fees().increment.drops() / DROPS_PER_XRP.drops()}; @@ -2950,22 +3021,22 @@ class Vault_test : public beast::unit_test::suite testcase("private vault"); Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account issuer{"issuer"}; - Account owner{"owner"}; - Account depositor{"depositor"}; - Account charlie{"charlie"}; - Account pdOwner{"pdOwner"}; - Account credIssuer1{"credIssuer1"}; - Account credIssuer2{"credIssuer2"}; + Account const issuer{"issuer"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; + Account const charlie{"charlie"}; + Account const pdOwner{"pdOwner"}; + Account const credIssuer1{"credIssuer1"}; + Account const credIssuer2{"credIssuer2"}; std::string const credType = "credential"; - Vault vault{env}; + Vault const vault{env}; env.fund(XRP(1000), issuer, owner, depositor, charlie, pdOwner, credIssuer1, credIssuer2); env.close(); env(fset(issuer, asfAllowTrustLineClawback)); env.close(); env.require(flags(issuer, asfAllowTrustLineClawback)); - PrettyAsset asset = issuer["IOU"]; + PrettyAsset const asset = issuer["IOU"]; env.trust(asset(1000), owner); env(pay(issuer, owner, asset(500))); env.trust(asset(1000), depositor); @@ -3198,15 +3269,15 @@ class Vault_test : public beast::unit_test::suite testcase("private XRP vault"); Env env{*this, testable_amendments() | featureSingleAssetVault}; - Account owner{"owner"}; - Account depositor{"depositor"}; - Account alice{"charlie"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; + Account const alice{"charlie"}; std::string const credType = "credential"; - Vault vault{env}; + Vault const vault{env}; env.fund(XRP(100000), owner, depositor, alice); env.close(); - PrettyAsset asset = xrpIssue(); + PrettyAsset const asset = xrpIssue(); auto [tx, keylet] = vault.create({.owner = owner, .asset = asset, .flags = tfVaultPrivate}); env(tx); env.close(); @@ -3219,7 +3290,7 @@ class Vault_test : public beast::unit_test::suite }(); BEAST_EXPECT(env.le(keylet::account(vaultAccount))); BEAST_EXPECT(env.le(keylet::mptIssuance(issuanceId))); - PrettyAsset shares{issuanceId}; + PrettyAsset const shares{issuanceId}; { testcase("private XRP vault owner can deposit"); @@ -3296,7 +3367,7 @@ class Vault_test : public beast::unit_test::suite testcase("fail pseudo-account allocation"); Env env{*this, testable_amendments() | featureSingleAssetVault}; Account const owner{"owner"}; - Vault vault{env}; + Vault const vault{env}; env.fund(XRP(1000), owner); auto const keylet = keylet::vault(owner.id(), env.seq(owner)); @@ -3362,7 +3433,7 @@ class Vault_test : public beast::unit_test::suite auto const vault = env.le(keylet); return {Account("vault", vault->at(sfAccount)), vault->at(sfShareMPTID)}; }(keylet); - MPTIssue shares(issuanceId); + MPTIssue const shares(issuanceId); env.memoize(vaultAccount); auto const peek = [keylet, &env, this](std::function fn) -> bool { @@ -3370,10 +3441,10 @@ class Vault_test : public beast::unit_test::suite [&](OpenView& view, beast::Journal j) -> bool { Sandbox sb(&view, tapNONE); auto vault = sb.peek(keylet::vault(keylet.key)); - if (!BEAST_EXPECT(vault != nullptr)) + if (!BEAST_EXPECT(vault)) return false; auto shares = sb.peek(keylet::mptIssuance(vault->at(sfShareMPTID))); - if (!BEAST_EXPECT(shares != nullptr)) + if (!BEAST_EXPECT(shares)) return false; if (fn(*vault, *shares)) { @@ -4102,6 +4173,66 @@ class Vault_test : public beast::unit_test::suite BEAST_EXPECT(env.balance(d.vaultAccount, d.shares).number() == 0); } }); + + // Non-1:1 ratio (scale=1, 10:1 shares:assets) with an outstanding loan. + // Deposit 100 IOU → 1000 shares. Borrow 40 → assetsAvailable=60. + // Clawback 80 IOU → clamped to 60, then share math uses truncation. + testCase(1, [&, this](Env& env, Data d) { + using namespace loanBroker; + using namespace loan; + + testcase("Scale clawback clamped with outstanding loan"); + + auto tx = d.vault.deposit( + {.depositor = d.depositor, + .id = d.keylet.key, + .amount = STAmount(d.asset, Number(100, 0))}); + env(tx); + env.close(); + BEAST_EXPECT(env.balance(d.depositor, d.shares) == d.share(1000)); + + // Create a loan broker backed by this vault + auto const brokerKeylet = keylet::loanbroker(d.owner.id(), env.seq(d.owner)); + env(set(d.owner, d.keylet.key)); + env.close(); + + // Borrow 40: assetsAvailable=60, assetsTotal=100 + env(set(d.depositor, brokerKeylet.key, STAmount(d.asset, Number(40, 0))), + loan::interestRate(TenthBips32(0)), + gracePeriod(60), + paymentInterval(120), + paymentTotal(10), + sig(sfCounterpartySignature, d.owner), + fee(env.current()->fees().base * 2), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(d.keylet); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == STAmount(d.asset, Number(60, 0))); + BEAST_EXPECT(sle->at(sfAssetsTotal) == STAmount(d.asset, Number(100, 0))); + } + + // Request 80 IOU clawback — clamped to assetsAvailable (60) + // With scale=1 (10:1), 60 assets = 600 shares destroyed + tx = d.vault.clawback( + {.issuer = d.issuer, + .id = d.keylet.key, + .holder = d.depositor, + .amount = STAmount(d.asset, Number(80, 0))}); + env(tx, ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(d.keylet); + BEAST_EXPECT(sle != nullptr); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == STAmount(d.asset, Number(0, 0))); + BEAST_EXPECT(sle->at(sfAssetsTotal) == STAmount(d.asset, Number(40, 0))); + + // 600 of 1000 shares destroyed, 400 remain + BEAST_EXPECT(env.balance(d.depositor, d.shares) == d.share(400)); + } + }); } void @@ -4113,11 +4244,11 @@ class Vault_test : public beast::unit_test::suite Env env{*this, testable_amendments() | featureSingleAssetVault}; Account const owner{"owner"}; Account const issuer{"issuer"}; - Vault vault{env}; + Vault const vault{env}; env.fund(XRP(1000), issuer, owner); env.close(); - PrettyAsset asset = issuer["IOU"]; + PrettyAsset const asset = issuer["IOU"]; env.trust(asset(1000), owner); env(pay(issuer, owner, asset(200))); env.close(); @@ -4545,7 +4676,7 @@ class Vault_test : public beast::unit_test::suite auto const setupVault = [&](PrettyAsset const& asset, Account const& owner, Account const& depositor) -> std::pair { - Vault vault{env}; + Vault const vault{env}; auto const& [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset}); env(tx, ter(tesSUCCESS)); @@ -4554,7 +4685,7 @@ class Vault_test : public beast::unit_test::suite auto const& vaultSle = env.le(vaultKeylet); BEAST_EXPECT(vaultSle != nullptr); - Asset share = vaultSle->at(sfShareMPTID); + Asset const share = vaultSle->at(sfShareMPTID); env(vault.deposit( {.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}), @@ -4648,10 +4779,9 @@ class Vault_test : public beast::unit_test::suite "VaultClawback (share) - " + prefix + " owner incomplete share clawback fails"); auto [vault, vaultKeylet] = setupVault(asset, owner, depositor); auto const& vaultSle = env.le(vaultKeylet); - BEAST_EXPECT(vaultSle != nullptr); - if (!vaultSle) + if (!BEAST_EXPECT(vaultSle)) return; - Asset share = vaultSle->at(sfShareMPTID); + Asset const share = vaultSle->at(sfShareMPTID); env(vault.clawback({ .issuer = owner, .id = vaultKeylet.key, @@ -4684,10 +4814,9 @@ class Vault_test : public beast::unit_test::suite " owner explicit complete share clawback succeeds"); auto [vault, vaultKeylet] = setupVault(asset, owner, depositor); auto const& vaultSle = env.le(vaultKeylet); - BEAST_EXPECT(vaultSle != nullptr); - if (!vaultSle) + if (!BEAST_EXPECT(vaultSle)) return; - Asset share = vaultSle->at(sfShareMPTID); + Asset const share = vaultSle->at(sfShareMPTID); env(vault.clawback({ .issuer = owner, .id = vaultKeylet.key, @@ -4701,10 +4830,9 @@ class Vault_test : public beast::unit_test::suite testcase("VaultClawback (share) - " + prefix + " owner can clawback own shares"); auto [vault, vaultKeylet] = setupVault(asset, owner, owner); auto const& vaultSle = env.le(vaultKeylet); - BEAST_EXPECT(vaultSle != nullptr); - if (!vaultSle) + if (!BEAST_EXPECT(vaultSle)) return; - Asset share = vaultSle->at(sfShareMPTID); + Asset const share = vaultSle->at(sfShareMPTID); env(vault.clawback({ .issuer = owner, .id = vaultKeylet.key, @@ -4719,9 +4847,9 @@ class Vault_test : public beast::unit_test::suite testcase("VaultClawback (share) - " + prefix + " empty vault share clawback fails"); auto [vault, vaultKeylet] = setupVault(asset, owner, owner); auto const& vaultSle = env.le(vaultKeylet); - if (BEAST_EXPECT(vaultSle != nullptr)) + if (!BEAST_EXPECT(vaultSle)) return; - Asset share = vaultSle->at(sfShareMPTID); + Asset const share = vaultSle->at(sfShareMPTID); env(vault.clawback({ .issuer = owner, .id = vaultKeylet.key, @@ -4735,26 +4863,27 @@ class Vault_test : public beast::unit_test::suite .issuer = owner, .id = vaultKeylet.key, .holder = owner, + .amount = share(vaultShareBalance(vaultKeylet)).value(), }), ter(tecNO_PERMISSION)); env.close(); } }; - Account owner{"alice"}; - Account depositor{"bob"}; - Account issuer{"issuer"}; + Account const owner{"alice"}; + Account const depositor{"bob"}; + Account const issuer{"issuer"}; env.fund(XRP(10000), issuer, owner, depositor); env.close(); // Test XRP - PrettyAsset xrp = xrpIssue(); + PrettyAsset const xrp = xrpIssue(); testCase(xrp, "XRP", owner, depositor); testCase(xrp, "XRP (depositor is owner)", owner, owner); // Test IOU - PrettyAsset IOU = issuer["IOU"]; + PrettyAsset const IOU = issuer["IOU"]; env(fset(issuer, asfAllowTrustLineClawback)); env.close(); @@ -4769,7 +4898,7 @@ class Vault_test : public beast::unit_test::suite // Test MPT MPTTester mptt{env, issuer, mptInitNoFund}; mptt.create({.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock}); - PrettyAsset MPT = mptt.issuanceID(); + PrettyAsset const MPT = mptt.issuanceID(); mptt.authorize({.account = owner}); mptt.authorize({.account = depositor}); env(pay(issuer, owner, MPT(1000))); @@ -4786,12 +4915,13 @@ class Vault_test : public beast::unit_test::suite using namespace loanBroker; using namespace loan; Env env(*this); + env.enableFeature(fixSecurity3_1_3); auto const setupVault = [&](PrettyAsset const& asset, Account const& owner, Account const& depositor, Account const& issuer) -> std::pair { - Vault vault{env}; + Vault const vault{env}; auto const& [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset}); env(tx, ter(tesSUCCESS)); @@ -4799,6 +4929,7 @@ class Vault_test : public beast::unit_test::suite auto const& vaultSle = env.le(vaultKeylet); BEAST_EXPECT(vaultSle != nullptr); + env.memoize(Account("vault", vaultSle->at(sfAccount))); env(vault.deposit( {.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}), ter(tesSUCCESS)); @@ -4840,8 +4971,8 @@ class Vault_test : public beast::unit_test::suite "VaultClawback (asset) - " + prefix + " clawback for different asset fails"); auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer); - Account issuer2{"issuer2"}; - PrettyAsset asset2 = issuer2["FOO"]; + Account const issuer2{"issuer2"}; + PrettyAsset const asset2 = issuer2["FOO"]; env(vault.clawback({ .issuer = issuer, .id = vaultKeylet.key, @@ -4899,10 +5030,9 @@ class Vault_test : public beast::unit_test::suite testcase("VaultClawback (asset) - " + prefix + " issuer share clawback fails"); auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer); auto const& vaultSle = env.le(vaultKeylet); - BEAST_EXPECT(vaultSle != nullptr); - if (!vaultSle) + if (!BEAST_EXPECT(vaultSle)) return; - Asset share = vaultSle->at(sfShareMPTID); + Asset const share = vaultSle->at(sfShareMPTID); env(vault.clawback({ .issuer = issuer, @@ -4955,39 +5085,389 @@ class Vault_test : public beast::unit_test::suite }), ter(tesSUCCESS)); } + + { + testcase( + "VaultClawback (asset) - " + prefix + + " zero-amount clawback clamped with outstanding loan"); + auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer); + + auto const vaultSle = env.le(vaultKeylet); + if (!BEAST_EXPECT(vaultSle)) + return; + + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + // Create a loan broker backed by this vault + auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner)); + env(set(owner, vaultKeylet.key)); + env.close(); + + // Depositor borrows 40 units, reducing assetsAvailable to 60 + // while assetsTotal stays at 100 + env(set(depositor, brokerKeylet.key, asset(40).value()), + loan::interestRate(TenthBips32(0)), + gracePeriod(60), + paymentInterval(120), + paymentTotal(10), + sig(sfCounterpartySignature, owner), + fee(env.current()->fees().base * 2), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(60).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value()); + } + + // Zero-amount clawback (= "clawback all") should succeed, + // clamped to assetsAvailable (60) rather than the full + // share value (100). + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + }), + ter(tesSUCCESS)); + env.close(); + + // Only 60 assets clawed back; loan's 40 still outstanding + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle != nullptr); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(40).value()); + + // 60 of 100 shares destroyed (1:1 ratio), 40 remain + auto const sharesAfter = env.balance(depositor, shares); + BEAST_EXPECT(sharesAfter == shares(Number{4, sle->at(sfScale) + 1})); + } + } + + { + testcase( + "VaultClawback (asset) - " + prefix + + " non-zero clawback clamped with outstanding loan"); + auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer); + + auto const vaultSle = env.le(vaultKeylet); + if (!BEAST_EXPECT(vaultSle)) + return; + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + // Create a loan broker backed by this vault + auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner)); + env(set(owner, vaultKeylet.key)); + env.close(); + + // Depositor borrows 40 units + env(set(depositor, brokerKeylet.key, asset(40).value()), + loan::interestRate(TenthBips32(0)), + gracePeriod(60), + paymentInterval(120), + paymentTotal(10), + sig(sfCounterpartySignature, owner), + fee(env.current()->fees().base * 2), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(60).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value()); + } + + // Request 100 but only 60 available — clamped to 60 + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + .amount = asset(100).value(), + }), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle != nullptr); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(40).value()); + + // 60 of 100 shares destroyed (1:1 ratio), 40 remain + auto const sharesAfter = env.balance(depositor, shares); + BEAST_EXPECT(sharesAfter == shares(Number{4, sle->at(sfScale) + 1})); + } + } + + { + testcase( + "VaultClawback (asset) - " + prefix + + " partial clawback below available with outstanding loan"); + auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer); + + auto const vaultSle = env.le(vaultKeylet); + if (!BEAST_EXPECT(vaultSle)) + return; + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + // Create a loan broker backed by this vault + auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner)); + env(set(owner, vaultKeylet.key)); + env.close(); + + // Depositor borrows 40 units: assetsAvailable=60, assetsTotal=100 + env(set(depositor, brokerKeylet.key, asset(40).value()), + loan::interestRate(TenthBips32(0)), + gracePeriod(60), + paymentInterval(120), + paymentTotal(10), + sig(sfCounterpartySignature, owner), + fee(env.current()->fees().base * 2), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(60).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value()); + } + + // Clawback 30 — well under available (60), no clamping needed + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + .amount = asset(30).value(), + }), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle != nullptr); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(30).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(70).value()); + + // 30 of 100 shares destroyed (1:1 ratio), 70 remain + auto const sharesAfter = env.balance(depositor, shares); + BEAST_EXPECT(sharesAfter == shares(Number{7, sle->at(sfScale) + 1})); + } + } + + { + testcase( + "VaultClawback (asset) - " + prefix + + " clawback exactly equal to available with outstanding loan"); + auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer); + + auto const vaultSle = env.le(vaultKeylet); + if (!BEAST_EXPECT(vaultSle)) + return; + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner)); + env(set(owner, vaultKeylet.key)); + env.close(); + + // Depositor borrows 40 units: assetsAvailable=60, assetsTotal=100 + env(set(depositor, brokerKeylet.key, asset(40).value()), + loan::interestRate(TenthBips32(0)), + gracePeriod(60), + paymentInterval(120), + paymentTotal(10), + sig(sfCounterpartySignature, owner), + fee(env.current()->fees().base * 2), + ter(tesSUCCESS)); + env.close(); + + // Clawback exactly 60 — at the boundary, no clamping needed + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + .amount = asset(60).value(), + }), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle != nullptr); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(40).value()); + + // 60 of 100 shares destroyed (1:1 ratio), 40 remain + auto const sharesAfter = env.balance(depositor, shares); + BEAST_EXPECT(sharesAfter == shares(Number{4, sle->at(sfScale) + 1})); + } + } + + { + testcase( + "VaultClawback (asset) - " + prefix + + " clawback with zero available (fully borrowed)"); + auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer); + + auto const vaultSle = env.le(vaultKeylet); + if (!BEAST_EXPECT(vaultSle)) + return; + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner)); + env(set(owner, vaultKeylet.key)); + env.close(); + + // Depositor borrows all 100 units: assetsAvailable=0, assetsTotal=100 + env(set(depositor, brokerKeylet.key, asset(100).value()), + loan::interestRate(TenthBips32(0)), + gracePeriod(60), + paymentInterval(120), + paymentTotal(10), + sig(sfCounterpartySignature, owner), + fee(env.current()->fees().base * 2), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value()); + } + + auto const sharesBefore = env.balance(depositor, shares); + + // Zero-amount clawback — nothing available, clamped to 0, + // resulting in zero shares destroyed → tecPRECISION_LOSS + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + }), + ter(tecPRECISION_LOSS)); + env.close(); + + // Explicit amount clawback — also nothing available + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + .amount = asset(50).value(), + }), + ter(tecPRECISION_LOSS)); + env.close(); + + { + // Nothing changed — vault and shares unchanged + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle != nullptr); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value()); + auto const sharesAfter = env.balance(depositor, shares); + BEAST_EXPECT(sharesAfter == sharesBefore); + } + } }; Account owner{"alice"}; - Account depositor{"bob"}; - Account issuer{"issuer"}; + Account const depositor{"bob"}; + Account const issuer{"issuer"}; env.fund(XRP(10000), issuer, owner, depositor); env.close(); // Test XRP - PrettyAsset xrp = xrpIssue(); + PrettyAsset const xrp = xrpIssue(); testCase(xrp, "XRP", owner, depositor, issuer); // Test IOU - PrettyAsset IOU = issuer["IOU"]; + PrettyAsset const IOU = issuer["IOU"]; env(fset(issuer, asfAllowTrustLineClawback)); env.close(); - env.trust(IOU(1000), owner); - env.trust(IOU(1000), depositor); - env(pay(issuer, owner, IOU(1000))); - env(pay(issuer, depositor, IOU(1000))); + env.trust(IOU(2000), owner); + env.trust(IOU(2000), depositor); + env(pay(issuer, owner, IOU(2000))); + env(pay(issuer, depositor, IOU(2000))); env.close(); testCase(IOU, "IOU", owner, depositor, issuer); // Test MPT MPTTester mptt{env, issuer, mptInitNoFund}; mptt.create({.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock}); - PrettyAsset MPT = mptt.issuanceID(); + PrettyAsset const MPT = mptt.issuanceID(); mptt.authorize({.account = owner}); mptt.authorize({.account = depositor}); - env(pay(issuer, depositor, MPT(1000))); + env(pay(issuer, depositor, MPT(2000))); env.close(); testCase(MPT, "MPT", owner, depositor, issuer); + + // Test pre-fixSecurity3_1_3 legacy path: zero-amount clawback + // returns early without clamping to assetsAvailable. + { + testcase( + "VaultClawback (asset) - IOU pre-fixSecurity3_1_3" + " zero-amount clawback unclamped with outstanding loan"); + + env.disableFeature(fixSecurity3_1_3); + + auto [vault, vaultKeylet] = setupVault(IOU, owner, depositor, issuer); + + auto const vaultSle = env.le(vaultKeylet); + BEAST_EXPECT(vaultSle != nullptr); + if (!vaultSle) + return; + + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + // Create a loan broker backed by this vault + auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner)); + env(set(owner, vaultKeylet.key)); + env.close(); + + // Depositor borrows 40 units, reducing assetsAvailable to 60 + // while assetsTotal stays at 100 + env(set(depositor, brokerKeylet.key, IOU(40).value()), + loan::interestRate(TenthBips32(0)), + gracePeriod(60), + paymentInterval(120), + paymentTotal(10), + sig(sfCounterpartySignature, owner), + fee(env.current()->fees().base * 2), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == IOU(60).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == IOU(100).value()); + } + + auto const sharesBefore = env.balance(depositor, shares); + + // Legacy: zero-amount clawback tries to recover the full + // share value (100) without clamping to assetsAvailable (60). + // This causes the vault balance to go negative, triggering + // the sanity check in doApply → tefINTERNAL. + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + }), + ter(tefINTERNAL)); + env.close(); + + { + // Transaction rolled back — vault and shares unchanged + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle != nullptr); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == IOU(60).value()); + BEAST_EXPECT(sle->at(sfAssetsTotal) == IOU(100).value()); + auto const sharesAfter = env.balance(depositor, shares); + BEAST_EXPECT(sharesAfter == sharesBefore); + } + + env.enableFeature(fixSecurity3_1_3); + } } void @@ -5001,7 +5481,7 @@ class Vault_test : public beast::unit_test::suite Account const owner{"owner"}; Account const issuer{"issuer"}; - Vault vault{env}; + Vault const vault{env}; env.fund(XRP(1'000'000), issuer, owner); env.close(); @@ -5116,7 +5596,7 @@ class Vault_test : public beast::unit_test::suite testcase("Assets Maximum: IOU"); // Almost anything goes with IOUs - PrettyAsset iouAsset = issuer["IOU"]; + PrettyAsset const iouAsset = issuer["IOU"]; env.trust(iouAsset(1000), owner); env(pay(issuer, owner, iouAsset(200))); env.close(); @@ -5231,6 +5711,434 @@ class Vault_test : public beast::unit_test::suite } } + void + testVaultEscrowedMPT() + { + using namespace test::jtx; + using namespace std::literals; + + // Verify vault deposit/withdraw/clawback respect sfLockedAmount. + // When MPT tokens are escrowed, sfMPTAmount is reduced and + // sfLockedAmount is increased. Vault operations go through + // accountSend/accountHolds which read sfMPTAmount, so escrowed + // tokens are naturally excluded. + + { + testcase("Vault deposit fails when MPT asset is escrowed"); + + Env env{*this, testable_amendments()}; + auto const baseFee = env.current()->fees().base; + Account const owner{"owner"}; + Account const depositor{"depositor"}; + Account const issuer{"issuer"}; + Account const bob{"bob"}; + + env.fund(XRP(10000), issuer, owner, depositor, bob); + env.close(); + + MPTTester mptt{env, issuer, mptInitNoFund}; + mptt.create( + {.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock | tfMPTCanEscrow}); + mptt.authorize({.account = owner}); + mptt.authorize({.account = depositor}); + mptt.authorize({.account = bob}); + PrettyAsset const asset = mptt.issuanceID(); + env(pay(issuer, depositor, asset(100))); + env.close(); + + // Escrow 60 of 100 MPT tokens: sfMPTAmount drops to 40 + auto const escrowSeq = env.seq(depositor); + env(escrow::create(depositor, bob, asset(60)), + escrow::condition(escrow::cb1), + escrow::finish_time(env.now() + 1s), + fee(baseFee * 150), + ter(tesSUCCESS)); + env.close(); + + Vault const vault{env}; + auto [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset}); + env(tx, ter(tesSUCCESS)); + env.close(); + + // Deposit 100 should fail — only 40 spendable + env(vault.deposit( + {.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}), + ter(tecINSUFFICIENT_FUNDS)); + env.close(); + + // Deposit 40 (the unlocked balance) should succeed + env(vault.deposit({.depositor = depositor, .id = vaultKeylet.key, .amount = asset(40)}), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(40).value()); + } + + // Clean up escrow + env(escrow::finish(bob, depositor, escrowSeq), + escrow::condition(escrow::cb1), + escrow::fulfillment(escrow::fb1), + fee(baseFee * 150), + ter(tesSUCCESS)); + env.close(); + } + + { + testcase("Vault withdraw respects escrowed shares"); + + Env env{*this, testable_amendments()}; + auto const baseFee = env.current()->fees().base; + Account const owner{"owner"}; + Account const depositor{"depositor"}; + Account const issuer{"issuer"}; + Account const bob{"bob"}; + + env.fund(XRP(10000), issuer, owner, depositor, bob); + env.close(); + + MPTTester mptt{env, issuer, mptInitNoFund}; + mptt.create( + {.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock | tfMPTCanEscrow}); + mptt.authorize({.account = owner}); + mptt.authorize({.account = depositor}); + PrettyAsset const asset = mptt.issuanceID(); + env(pay(issuer, depositor, asset(100))); + env.close(); + + Vault const vault{env}; + auto [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset}); + env(tx, ter(tesSUCCESS)); + env.close(); + + // Deposit 100 → get shares + env(vault.deposit( + {.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}), + ter(tesSUCCESS)); + env.close(); + + auto const vaultSle = env.le(vaultKeylet); + if (!BEAST_EXPECT(vaultSle)) + return; + env.memoize(Account("vault", vaultSle->at(sfAccount))); + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + // Authorize bob for share MPT so he can receive escrowed shares + auto const shareMPTID = vaultSle->at(sfShareMPTID); + { + Json::Value jv; + jv[jss::Account] = bob.human(); + jv[sfMPTokenIssuanceID] = to_string(shareMPTID); + jv[jss::TransactionType] = jss::MPTokenAuthorize; + env(jv, ter(tesSUCCESS)); + env.close(); + } + + // Escrow 60% of shares + auto const escrowAmount = shares(Number{6, vaultSle->at(sfScale) + 1}); + env(escrow::create(depositor, bob, escrowAmount), + escrow::condition(escrow::cb1), + escrow::finish_time(env.now() + 1s), + fee(baseFee * 150), + ter(tesSUCCESS)); + env.close(); + + // Withdraw all 100 should fail — only 40% of shares are unlocked + env(vault.withdraw( + {.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}), + ter(tecINSUFFICIENT_FUNDS)); + env.close(); + + // Withdraw 40 (matching unlocked shares) should succeed + env(vault.withdraw( + {.depositor = depositor, .id = vaultKeylet.key, .amount = asset(40)}), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(60).value()); + } + } + + { + testcase("Vault clawback only recovers unlocked shares"); + + Env env{*this, testable_amendments() | fixSecurity3_1_3}; + auto const baseFee = env.current()->fees().base; + Account const owner{"owner"}; + Account const depositor{"depositor"}; + Account const issuer{"issuer"}; + Account const bob{"bob"}; + + env.fund(XRP(10000), issuer, owner, depositor, bob); + env.close(); + + MPTTester mptt{env, issuer, mptInitNoFund}; + mptt.create( + {.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock | tfMPTCanEscrow}); + mptt.authorize({.account = owner}); + mptt.authorize({.account = depositor}); + PrettyAsset const asset = mptt.issuanceID(); + env(pay(issuer, depositor, asset(100))); + env.close(); + + Vault const vault{env}; + auto [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset}); + env(tx, ter(tesSUCCESS)); + env.close(); + + // Deposit 100 → get shares + env(vault.deposit( + {.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}), + ter(tesSUCCESS)); + env.close(); + + auto const vaultSle = env.le(vaultKeylet); + if (!BEAST_EXPECT(vaultSle)) + return; + env.memoize(Account("vault", vaultSle->at(sfAccount))); + PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID)); + + // Authorize bob for share MPT so he can receive escrowed shares + auto const shareMPTID = vaultSle->at(sfShareMPTID); + { + Json::Value jv; + jv[jss::Account] = bob.human(); + jv[sfMPTokenIssuanceID] = to_string(shareMPTID); + jv[jss::TransactionType] = jss::MPTokenAuthorize; + env(jv, ter(tesSUCCESS)); + env.close(); + } + + // Escrow 60% of shares + auto const escrowAmount = shares(Number{6, vaultSle->at(sfScale) + 1}); + env(escrow::create(depositor, bob, escrowAmount), + escrow::condition(escrow::cb1), + escrow::finish_time(env.now() + 1s), + fee(baseFee * 150), + ter(tesSUCCESS)); + env.close(); + + // Zero-amount clawback ("all") — should only recover assets + // corresponding to unlocked shares (40%) + env(vault.clawback({ + .issuer = issuer, + .id = vaultKeylet.key, + .holder = depositor, + }), + ter(tesSUCCESS)); + env.close(); + + { + auto const sle = env.le(vaultKeylet); + BEAST_EXPECT(sle != nullptr); + // Only 40 of 100 assets recovered (matching 40% unlocked shares) + BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(60).value()); + BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(60).value()); + + // Depositor's unlocked shares are now 0 + auto const sharesAfter = env.balance(depositor, shares); + BEAST_EXPECT(sharesAfter == shares(0)); + } + } + } + + // Reproduction: canWithdraw IOU limit check bypassed when + // withdrawal amount is specified in shares (MPT) rather than in assets. + void + testBug6_LimitBypassWithShares() + { + using namespace test::jtx; + testcase("Bug6 - limit bypass with share-denominated withdrawal"); + + auto const allAmendments = testable_amendments() | featureSingleAssetVault; + + for (auto const& features : {allAmendments, allAmendments - fixSecurity3_1_3}) + { + bool const withFix = features[fixSecurity3_1_3]; + + Env env{*this, features}; + Account const owner{"owner"}; + Account const issuer{"issuer"}; + Account const depositor{"depositor"}; + Account const charlie{"charlie"}; + Vault const vault{env}; + + env.fund(XRP(1000), issuer, owner, depositor, charlie); + env(fset(issuer, asfAllowTrustLineClawback)); + env.close(); + + PrettyAsset const asset = issuer["IOU"]; + env.trust(asset(1000), owner); + env.trust(asset(1000), depositor); + env(pay(issuer, owner, asset(200))); + env(pay(issuer, depositor, asset(200))); + env.close(); + + // Charlie gets a LOW trustline limit of 5 + env.trust(asset(5), charlie); + env.close(); + + auto const [tx, keylet] = vault.create({.owner = owner, .asset = asset}); + env(tx); + env.close(); + + auto const depositTx = + vault.deposit({.depositor = depositor, .id = keylet.key, .amount = asset(100)}); + env(depositTx); + env.close(); + + // Get the share MPT info + auto const vaultSle = env.le(keylet); + if (!BEAST_EXPECT(vaultSle)) + return; + auto const mptIssuanceID = vaultSle->at(sfShareMPTID); + MPTIssue const shares(mptIssuanceID); + PrettyAsset const share(shares); + + // CONTROL: Withdraw 10 IOU (asset-denominated) to charlie. + // Charlie's limit is 5, so this should be rejected with tecNO_LINE + // regardless of the amendment. + { + auto withdrawTx = + vault.withdraw({.depositor = depositor, .id = keylet.key, .amount = asset(10)}); + withdrawTx[sfDestination] = charlie.human(); + env(withdrawTx, ter{tecNO_LINE}); + env.close(); + } + auto const charlieBalanceBefore = env.balance(charlie, asset.raw().get()); + + // Withdraw the equivalent amount in shares to charlie. + // Post-fix: rejected (tecNO_LINE) because the share amount is + // converted to assets and the trustline limit is checked. + // Pre-fix: succeeds (tesSUCCESS) because the limit check was + // skipped for share-denominated withdrawals. + { + auto withdrawTx = vault.withdraw( + {.depositor = depositor, + .id = keylet.key, + .amount = STAmount(share, 10'000'000)}); + withdrawTx[sfDestination] = charlie.human(); + env(withdrawTx, ter{withFix ? TER{tecNO_LINE} : TER{tesSUCCESS}}); + env.close(); + + auto const charlieBalanceAfter = env.balance(charlie, asset.raw().get()); + if (withFix) + { + // Post-fix: charlie's balance is unchanged — the withdrawal + // was correctly rejected despite being share-denominated. + BEAST_EXPECT(charlieBalanceAfter == charlieBalanceBefore); + } + else + { + // Pre-fix: charlie received the assets, bypassing the + // trustline limit. + BEAST_EXPECT(charlieBalanceAfter > charlieBalanceBefore); + } + } + } + } + + void + testRemoveEmptyHoldingLockedAmount() + { + testcase("removeEmptyHolding deletes MPToken with sfLockedAmount"); + using namespace test::jtx; + using namespace std::literals; + + auto const amendments = testable_amendments(); + auto runTest = [&](FeatureBitset f) { + Env env{*this, f}; + auto const baseFee = env.current()->fees().base; + + Account const issuer{"issuer"}; + Account const owner{"owner"}; + Account const depositor{"depositor"}; + Account const bob{"bob"}; + + env.fund(XRP(100000), issuer, owner, depositor, bob); + env.close(); + + Vault const vault{env}; + + // Create an MPT asset for the vault + MPTTester mptt{env, issuer, mptInitNoFund}; + mptt.create({.flags = tfMPTCanTransfer | tfMPTCanLock}); + PrettyAsset const asset = mptt.issuanceID(); + mptt.authorize({.account = owner}); + mptt.authorize({.account = depositor}); + env(pay(issuer, depositor, asset(1000))); + env.close(); + + // Create vault + auto [tx, keylet] = vault.create({.owner = owner, .asset = asset}); + env(tx); + env.close(); + + auto const vaultSle = env.le(keylet); + BEAST_EXPECT(vaultSle != nullptr); + auto const shareMptID = vaultSle->at(sfShareMPTID); + MPTIssue const shareIssue{shareMptID}; + + // Depositor deposits 1000 asset units into vault, receiving shares + env(vault.deposit({.depositor = depositor, .id = keylet.key, .amount = asset(1000)})); + env.close(); + + // Check depositor has shares + { + auto const sleMpt = env.le(keylet::mptoken(shareMptID, depositor)); + BEAST_EXPECT(sleMpt != nullptr); + BEAST_EXPECT(sleMpt->at(sfMPTAmount) == 1000); + } + + // Escrow 500 of those shares + env(escrow::create(depositor, bob, STAmount{shareIssue, 500}), + escrow::condition(escrow::cb1), + escrow::finish_time(env.now() + 1s), + fee(baseFee * 150), + ter(tesSUCCESS)); + env.close(); + + // Verify: sfMPTAmount=500, sfLockedAmount=500 + { + auto const sleMpt = env.le(keylet::mptoken(shareMptID, depositor)); + BEAST_EXPECT(sleMpt != nullptr); + BEAST_EXPECT(sleMpt->at(sfLockedAmount) == 500); + BEAST_EXPECT(sleMpt->at(sfMPTAmount) == 500); + } + + // Withdraw remaining spendable shares — triggers removeEmptyHolding + env(vault.withdraw({.depositor = depositor, .id = keylet.key, .amount = asset(500)}), + ter(tesSUCCESS)); + env.close(); + + auto const sleMptAfter = env.le(keylet::mptoken(shareMptID, depositor)); + if (!f[fixSecurity3_1_3]) + { + // Without the fix, removeEmptyHolding deletes the MPToken + // even though sfLockedAmount > 0, leaving the escrow's locked + // amount untracked. + BEAST_EXPECT(sleMptAfter == nullptr); + } + else + { + // With the fix, MPToken must still exist with sfLockedAmount > 0 + // and sfMPTAmount == 0 (all spendable shares withdrawn). + BEAST_EXPECT(sleMptAfter != nullptr); + if (sleMptAfter) + { + BEAST_EXPECT(sleMptAfter->at(sfLockedAmount) == 500); + BEAST_EXPECT(sleMptAfter->at(sfMPTAmount) == 0); + } + } + }; + + runTest(amendments - fixSecurity3_1_3); + runTest(amendments); + } + public: void run() override @@ -5250,7 +6158,10 @@ public: testRPC(); testVaultClawbackBurnShares(); testVaultClawbackAssets(); + testVaultEscrowedMPT(); testAssetsMaximum(); + testBug6_LimitBypassWithShares(); + testRemoveEmptyHoldingLockedAmount(); } }; diff --git a/src/test/app/XChain_test.cpp b/src/test/app/XChain_test.cpp index 72f2597883..4b1197efe9 100644 --- a/src/test/app/XChain_test.cpp +++ b/src/test/app/XChain_test.cpp @@ -1,25 +1,54 @@ -#include +#include #include +#include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include + +#include +#include #include +#include +#include +#include #include #include #include +#include #include +#include #include -#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include #include #include #include #include +#include +#include #include #include @@ -130,7 +159,7 @@ struct SEnv std::shared_ptr bridge(Json::Value const& jvb) { - STXChainBridge b(jvb); + STXChainBridge const b(jvb); auto tryGet = [&](STXChainBridge::ChainType ct) -> std::shared_ptr { if (auto r = env_.le(keylet::bridge(b, ct))) @@ -180,7 +209,7 @@ struct XEnv : public jtx::XChainBridgeObjects, public SEnv XEnv(T& s, bool side = false) : SEnv(s, jtx::envconfig(), features) { using namespace jtx; - STAmount xrp_funds{XRP(10000)}; + STAmount const xrp_funds{XRP(10000)}; if (!side) { @@ -291,7 +320,7 @@ struct BalanceTransfer bool has_happened(STAmount const& amt, STAmount const& reward, bool check_payer = true) { - auto reward_cost = multiply(reward, STAmount(reward_accounts.size()), reward.issue()); + auto reward_cost = multiply(reward, STAmount(reward_accounts.size()), reward.asset()); return check_most_balances(amt, reward) && (!check_payer || payer_.diff() == -(reward_cost + txFees_)); } @@ -359,7 +388,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj try { exceptionPresent = false; - [[maybe_unused]] STXChainBridge testBridge1(jBridge); + [[maybe_unused]] STXChainBridge const testBridge1(jBridge); } catch (std::exception& ec) { @@ -372,7 +401,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { exceptionPresent = false; jBridge["Extra"] = 1; - [[maybe_unused]] STXChainBridge testBridge2(jBridge); + [[maybe_unused]] STXChainBridge const testBridge2(jBridge); } catch ([[maybe_unused]] std::exception& ec) { @@ -385,7 +414,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj void testXChainCreateBridge() { - XRPAmount res1 = reserve(1); + XRPAmount const res1 = reserve(1); using namespace jtx; testcase("Create Bridge"); @@ -807,12 +836,12 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj auto const& expected = expected_result[test_result.size()]; mcEnv.tx(create_bridge(a, bridge(a, ia, b, ib)), ter(TER::fromInt(expected.first))); - TER mcTER = mcEnv.env_.ter(); + TER const mcTER = mcEnv.env_.ter(); scEnv.tx(create_bridge(b, bridge(a, ia, b, ib)), ter(TER::fromInt(expected.second))); - TER scTER = scEnv.env_.ter(); + TER const scTER = scEnv.env_.ter(); - bool pass = isTesSuccess(mcTER) && isTesSuccess(scTER); + bool const pass = isTesSuccess(mcTER) && isTesSuccess(scTER); test_result.emplace_back(mcTER, scTER, pass); }; @@ -1155,8 +1184,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj testXChainCreateClaimID() { using namespace jtx; - XRPAmount res1 = reserve(1); - XRPAmount tx_fee = txFee(); + XRPAmount const res1 = reserve(1); + XRPAmount const tx_fee = txFee(); testcase("Create ClaimID"); @@ -1173,7 +1202,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { XEnv xenv(*this, true); - Balance scAlice_bal(xenv, scAlice); + Balance const scAlice_bal(xenv, scAlice); xenv.tx(create_bridge(Account::master, jvb)) .tx(xchain_create_claim_id(scAlice, jvb, reward, mcAlice)) @@ -1240,8 +1269,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj testXChainCommit() { using namespace jtx; - XRPAmount res0 = reserve(0); - XRPAmount tx_fee = txFee(); + XRPAmount const res0 = reserve(0); + XRPAmount const tx_fee = txFee(); testcase("Commit"); @@ -1252,7 +1281,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { XEnv xenv(*this); - Balance alice_bal(xenv, mcAlice); + Balance const alice_bal(xenv, mcAlice); auto const amt = XRP(1000); xenv.tx(create_bridge(mcDoor, jvb)) @@ -1260,7 +1289,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .tx(xchain_commit(mcAlice, jvb, 1, amt, scBob)) .close(); - STAmount claim_cost = amt; + STAmount const claim_cost = amt; BEAST_EXPECT(alice_bal.diff() == -(claim_cost + tx_fee)); } @@ -1369,7 +1398,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj using namespace jtx; testcase("Add Attestation"); - XRPAmount res0 = reserve(0); + XRPAmount const res0 = reserve(0); XRPAmount tx_fee = txFee(); auto multiTtxFee = [&](std::uint32_t m) -> STAmount { @@ -1457,7 +1486,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj std::uint32_t const quorum_7 = 7; std::vector const signers_ = [] { constexpr int numSigners = 4; - std::uint32_t weights[] = {1, 2, 4, 4}; + std::uint32_t const weights[] = {1, 2, 4, 4}; std::vector result; result.reserve(numSigners); @@ -1503,7 +1532,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj BEAST_EXPECT(!scEnv.claimID(jvb, 1)); // claim id deleted - BEAST_EXPECT(transfer.has_happened(amt, divide(reward, STAmount(3), reward.issue()))); + BEAST_EXPECT(transfer.has_happened(amt, divide(reward, STAmount(3), reward.asset()))); } // 4,4 => should succeed @@ -1515,7 +1544,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj std::uint32_t const quorum_7 = 7; std::vector const signers_ = [] { constexpr int numSigners = 4; - std::uint32_t weights[] = {1, 2, 4, 4}; + std::uint32_t const weights[] = {1, 2, 4, 4}; std::vector result; result.reserve(numSigners); @@ -1528,7 +1557,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj return result; }(); STAmount const split_reward_ = - divide(reward, STAmount(signers_.size()), reward.issue()); + divide(reward, STAmount(signers_.size()), reward.asset()); mcEnv.tx(create_bridge(mcDoor, jvb)).close(); @@ -1563,7 +1592,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj BEAST_EXPECT(!scEnv.claimID(jvb, claimID)); // claim id deleted - BEAST_EXPECT(transfer.has_happened(amt, divide(reward, STAmount(2), reward.issue()))); + BEAST_EXPECT(transfer.has_happened(amt, divide(reward, STAmount(2), reward.asset()))); } // 1,2 => should fail @@ -1575,7 +1604,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj std::uint32_t const quorum_7 = 7; std::vector const signers_ = [] { constexpr int numSigners = 4; - std::uint32_t weights[] = {1, 2, 4, 4}; + std::uint32_t const weights[] = {1, 2, 4, 4}; std::vector result; result.reserve(numSigners); @@ -1634,7 +1663,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj std::uint32_t const quorum_7 = 7; std::vector const signers_ = [] { constexpr int numSigners = 4; - std::uint32_t weights[] = {1, 2, 4, 4}; + std::uint32_t const weights[] = {1, 2, 4, 4}; std::vector result; result.reserve(numSigners); @@ -1697,8 +1726,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj auto const amt_plus_reward = amt + reward; { - Balance door(mcEnv, mcDoor); - Balance carol(mcEnv, mcCarol); + Balance const door(mcEnv, mcDoor); + Balance const carol(mcEnv, mcCarol); mcEnv.tx(create_bridge(mcDoor, jvb, reward, XRP(20))) .close() @@ -1719,8 +1748,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { // send first batch of account create attest for all 3 // account create - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(1, amt, scuAlice, 2)) .multiTx(att_create_acct_vec(3, amt, scuCarol, 2)) @@ -1740,8 +1769,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { // complete attestations for 2nd account create => should // not complete - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(2, amt, scuBob, 3, 2)).close(); @@ -1756,8 +1785,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { // complete attestations for 3rd account create => should // not complete - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(3, amt, scuCarol, 3, 2)).close(); @@ -1772,8 +1801,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { // complete attestations for 1st account create => account // should be created - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(1, amt, scuAlice, 3, 1)).close(); @@ -1791,8 +1820,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { // resend attestations for 3rd account create => still // should not complete - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(3, amt, scuCarol, 3, 2)).close(); @@ -1808,8 +1837,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { // resend attestations for 2nd account create => account // should be created - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(2, amt, scuBob, 1)).close(); @@ -1824,8 +1853,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { // resend attestations for 3rc account create => account // should be created - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(3, amt, scuCarol, 1)).close(); @@ -1850,8 +1879,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, reward, XRP(20))).close(); { - Balance door(mcEnv, mcDoor); - Balance carol(mcEnv, mcCarol); + Balance const door(mcEnv, mcDoor); + Balance const carol(mcEnv, mcCarol); mcEnv.tx(sidechain_xchain_account_create(mcCarol, jvb, scuAlice, amt, reward)) .close(); @@ -1864,8 +1893,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .tx(jtx::signers(Account::master, quorum, signers)) .close(); - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); scEnv.multiTx(att_create_acct_vec(1, amt, scuAlice, 2)).close(); BEAST_EXPECT(!!scEnv.caClaimID(jvb, 1)); // claim id present @@ -1892,8 +1921,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, reward, XRP(20))).close(); { - Balance door(mcEnv, mcDoor); - Balance carol(mcEnv, mcCarol); + Balance const door(mcEnv, mcDoor); + Balance const carol(mcEnv, mcCarol); mcEnv.tx(sidechain_xchain_account_create(mcCarol, jvb, scAlice, amt, reward)) .close(); @@ -1906,9 +1935,9 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .tx(jtx::signers(Account::master, quorum, signers)) .close(); - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); - Balance alice(scEnv, scAlice); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); + Balance const alice(scEnv, scAlice); scEnv.multiTx(att_create_acct_vec(1, amt, scAlice, 2)).close(); BEAST_EXPECT(!!scEnv.caClaimID(jvb, 1)); // claim id present @@ -1935,8 +1964,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, reward, XRP(20))).close(); { - Balance door(mcEnv, mcDoor); - Balance carol(mcEnv, mcCarol); + Balance const door(mcEnv, mcDoor); + Balance const carol(mcEnv, mcCarol); mcEnv.tx(sidechain_xchain_account_create(mcCarol, jvb, scAlice, amt, reward)) .close(); @@ -1950,9 +1979,9 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .tx(fset("scAlice", asfDepositAuth)) // set deposit auth .close(); - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); - Balance alice(scEnv, scAlice); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); + Balance const alice(scEnv, scAlice); scEnv.multiTx(att_create_acct_vec(1, amt, scAlice, 2)).close(); BEAST_EXPECT(!!scEnv.caClaimID(jvb, 1)); // claim id present @@ -1979,8 +2008,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj auto const amt_plus_reward = amt + reward; { - Balance door(mcEnv, mcDoor); - Balance carol(mcEnv, mcCarol); + Balance const door(mcEnv, mcDoor); + Balance const carol(mcEnv, mcCarol); mcEnv.tx(create_bridge(mcDoor, jvb, reward, XRP(20))) .close() @@ -2002,8 +2031,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .close(); { - Balance attester(scEnv, scAttester); - Balance door(scEnv, Account::master); + Balance const attester(scEnv, scAttester); + Balance const door(scEnv, Account::master); auto const bad_amt = XRP(10); std::uint32_t txCount = 0; @@ -2290,16 +2319,16 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj XEnv mcEnv(*this); XEnv scEnv(*this, true); - XRPAmount tx_fee = mcEnv.txFee(); + XRPAmount const tx_fee = mcEnv.txFee(); - Account a{"a"}; - Account doorA{"doorA"}; + Account const a{"a"}; + Account const doorA{"doorA"}; - STAmount funds{XRP(10000)}; + STAmount const funds{XRP(10000)}; mcEnv.fund(funds, a); mcEnv.fund(funds, doorA); - Account ua{"ua"}; // unfunded account we want to create + Account const ua{"ua"}; // unfunded account we want to create BridgeDef xrp_b{ doorA, @@ -2317,8 +2346,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj auto const amt = XRP(777); auto const amt_plus_reward = amt + xrp_b.reward; { - Balance bal_doorA(mcEnv, doorA); - Balance bal_a(mcEnv, a); + Balance const bal_doorA(mcEnv, doorA); + Balance const bal_a(mcEnv, a); mcEnv.tx(sidechain_xchain_account_create(a, xrp_b.jvb, ua, amt, xrp_b.reward)).close(); @@ -2360,8 +2389,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj { using namespace jtx; - XRPAmount res0 = reserve(0); - XRPAmount tx_fee = txFee(); + XRPAmount const res0 = reserve(0); + XRPAmount const tx_fee = txFee(); testcase("Claim"); @@ -2436,7 +2465,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj BalanceTransfer transfer( scEnv, Account::master, scBob, scAlice, &payees[0], 1, withClaim); - jtx::signer master_signer(Account::master); + jtx::signer const master_signer(Account::master); scEnv .tx(claim_attestation( scAttester, @@ -2481,7 +2510,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj BalanceTransfer transfer( scEnv, Account::master, scBob, scAlice, &payees[0], 1, withClaim); - jtx::signer master_signer(payees[0]); + jtx::signer const master_signer(payees[0]); scEnv .tx(claim_attestation( scAttester, @@ -2861,7 +2890,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj XEnv scEnv(*this, true); mcEnv.tx(create_bridge(mcDoor, jvb)).close(); - STAmount huge_reward{XRP(20000)}; + STAmount const huge_reward{XRP(20000)}; BEAST_EXPECT(huge_reward > scEnv.balance(scAlice)); scEnv.tx(create_bridge(Account::master, jvb, huge_reward)) @@ -3009,7 +3038,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj // the transfer failed, but check that we can still use the // claimID with a different account - Balance scCarol_bal(scEnv, scCarol); + Balance const scCarol_bal(scEnv, scCarol); scEnv.tx(xchain_claim(scAlice, jvb, claimID, amt, scCarol)).close(); BEAST_EXPECT(scCarol_bal.diff() == amt); @@ -3026,7 +3055,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .tx(fset("scBob", 0, asfDepositAuth)) // clear deposit auth .close(); - Balance scBob_bal(scEnv, scBob); + Balance const scBob_bal(scEnv, scBob); scEnv.tx(txns.back()).close(); BEAST_EXPECT(scBob_bal.diff() == amt); } @@ -3078,7 +3107,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj // the transfer failed, but check that we can still use the // claimID with a different account - Balance scCarol_bal(scEnv, scCarol); + Balance const scCarol_bal(scEnv, scCarol); scEnv.tx(xchain_claim(scAlice, jvb, claimID, amt, scCarol)).close(); BEAST_EXPECT(scCarol_bal.diff() == amt); @@ -3095,7 +3124,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .tx(fset("scBob", 0, asfRequireDest)) // clear dest tag .close(); - Balance scBob_bal(scEnv, scBob); + Balance const scBob_bal(scEnv, scBob); scEnv.tx(txns.back()).close(); BEAST_EXPECT(scBob_bal.diff() == amt); @@ -3126,7 +3155,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj // we should be able to submit the attestations, but the transfer // should not occur because dest account has deposit auth set - Balance scBob_bal(scEnv, scBob); + Balance const scBob_bal(scEnv, scBob); scEnv.multiTx(claim_attestations( scAttester, jvb, mcAlice, amt, payees, true, claimID, dst, signers)); @@ -3134,7 +3163,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj // Check that check that we still can use the claimID to transfer // the amount to a different account - Balance scCarol_bal(scEnv, scCarol); + Balance const scCarol_bal(scEnv, scCarol); scEnv.tx(xchain_claim(scAlice, jvb, claimID, amt, scCarol)).close(); BEAST_EXPECT(scCarol_bal.diff() == amt); @@ -3213,7 +3242,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj &payees[0], UT_XCHAIN_DEFAULT_QUORUM, withClaim); - Balance scAlice_bal(scEnv, scAlice); + Balance const scAlice_bal(scEnv, scAlice); scEnv.multiTx(claim_attestations( scAttester, jvb, mcAlice, amt, payees, true, claimID, dst, signers)); @@ -3261,7 +3290,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj &payees[0], UT_XCHAIN_DEFAULT_QUORUM, withClaim); - Balance scAlice_bal(scEnv, scAlice); + Balance const scAlice_bal(scEnv, scAlice); scEnv.multiTx(claim_attestations( scAttester, jvb, mcAlice, amt, payees, true, claimID, dst, signers)); STAmount claim_cost = tiny_reward; @@ -3350,7 +3379,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(xchain_commit(mcAlice, jvb, claimID, amt, dst)).close(); // balance of last signer should not change (has deposit auth) - Balance last_signer(scEnv, unpaid); + Balance const last_signer(scEnv, unpaid); // make sure all signers except the last one get the // split_reward @@ -3414,7 +3443,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj using namespace jtx; testcase("Bridge Create Account"); - XRPAmount tx_fee = txFee(); + XRPAmount const tx_fee = txFee(); // coverage test: transferHelper() - dst == src { @@ -3427,7 +3456,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj .tx(jtx::signers(Account::master, quorum, signers)) .close(); - Balance door(scEnv, Account::master); + Balance const door(scEnv, Account::master); // scEnv.tx(att_create_acct_batch1(1, amt, // Account::master)).close(); @@ -3451,8 +3480,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, XRP(1), XRP(20))).close(); - Balance door(mcEnv, mcDoor); - Balance carol(mcEnv, mcCarol); + Balance const door(mcEnv, mcDoor); + Balance const carol(mcEnv, mcCarol); mcEnv .tx(sidechain_xchain_account_create(mcCarol, jvb, scuAlice, XRP(19), reward), @@ -3469,7 +3498,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, XRP(1), XRP(20))).close(); - Balance door(mcEnv, mcDoor); + Balance const door(mcEnv, mcDoor); mcEnv .tx(sidechain_xchain_account_create(mcCarol, jvb, scuAlice, XRP(20), reward), @@ -3487,7 +3516,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, XRP(1), XRP(20))).close(); - Balance door(mcEnv, mcDoor); + Balance const door(mcEnv, mcDoor); mcEnv.disableFeature(featureXChainBridge) .tx(sidechain_xchain_account_create(mcCarol, jvb, scuAlice, XRP(20), reward), @@ -3503,7 +3532,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, XRP(1), XRP(20))).close(); - Balance door(mcEnv, mcDoor); + Balance const door(mcEnv, mcDoor); mcEnv .tx(sidechain_xchain_account_create(mcCarol, jvb, scuAlice, XRP(-20), reward), @@ -3519,7 +3548,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, XRP(1), XRP(20))).close(); - Balance door(mcEnv, mcDoor); + Balance const door(mcEnv, mcDoor); mcEnv .tx(sidechain_xchain_account_create(mcCarol, jvb, scuAlice, XRP(20), XRP(-1)), @@ -3535,7 +3564,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, XRP(1), XRP(20))).close(); - Balance door(mcEnv, mcDoor); + Balance const door(mcEnv, mcDoor); mcEnv .tx(sidechain_xchain_account_create(mcDoor, jvb, scuAlice, XRP(20), XRP(1)), @@ -3551,7 +3580,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj mcEnv.tx(create_bridge(mcDoor, jvb, XRP(1), XRP(20))).close(); - Balance door(mcEnv, mcDoor); + Balance const door(mcEnv, mcDoor); mcEnv .tx(sidechain_xchain_account_create(mcCarol, jvb, scuAlice, XRP(20), XRP(2)), @@ -3566,8 +3595,8 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj testFeeDipsIntoReserve() { using namespace jtx; - XRPAmount res0 = reserve(0); - XRPAmount tx_fee = txFee(); + XRPAmount const res0 = reserve(0); + XRPAmount const tx_fee = txFee(); testcase("Fee dips into reserve"); @@ -3660,7 +3689,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj // Create a bridge and add an attestation with a bad public key XEnv scEnv(*this, true); std::uint32_t const claimID = 1; - std::optional dst{scBob}; + std::optional const dst{scBob}; auto const amt = XRP(1000); scEnv.tx(create_bridge(Account::master, jvb)) .tx(jtx::signers(Account::master, quorum, signers)) @@ -3689,7 +3718,7 @@ struct XChain_test : public beast::unit_test::suite, public jtx::XChainBridgeObj // public key XEnv scEnv(*this, true); std::uint32_t const createCount = 1; - Account dst{scBob}; + Account const dst{scBob}; auto const amt = XRP(1000); auto const rewardAmt = XRP(1); scEnv.tx(create_bridge(Account::master, jvb)) @@ -3789,8 +3818,8 @@ private: bool verify(ENV& env, jtx::Account const& acct) const { - STAmount diff{env.balance(acct) - startAmount}; - bool check = diff == expectedDiff; + STAmount const diff{env.balance(acct) - startAmount}; + bool const check = diff == expectedDiff; return check; } }; @@ -3887,7 +3916,7 @@ private: void receive(jtx::Account const& acct, STAmount amt, std::uint64_t divisor = 1) { - if (amt.issue() != xrpIssue()) + if (amt.asset() != xrpIssue()) return; auto it = accounts.find(acct); if (it == accounts.end()) @@ -3898,18 +3927,18 @@ private: else { it->second.expectedDiff += - (divisor == 1 ? amt : divide(amt, STAmount(amt.issue(), divisor), amt.issue())); + (divisor == 1 ? amt : divide(amt, STAmount(amt.asset(), divisor), amt.asset())); } } void spend(jtx::Account const& acct, STAmount amt, std::uint64_t times = 1) { - if (amt.issue() != xrpIssue()) + if (amt.asset() != xrpIssue()) return; receive( acct, - times == 1 ? -amt : -multiply(amt, STAmount(amt.issue(), times), amt.issue())); + times == 1 ? -amt : -multiply(amt, STAmount(amt.asset(), times), amt.asset())); } void @@ -4093,7 +4122,7 @@ private: size_t i = 0; for (i = 0; i < num_signers; ++i) { - size_t signer_idx = (rnd + i) % num_signers; + size_t const signer_idx = (rnd + i) % num_signers; if (!(cr.attested[signer_idx])) { @@ -4132,7 +4161,7 @@ private: assert(cr.claim_id - 1 == counters.claim_count); auto r = cr.reward; - auto reward = divide(r, STAmount(num_attestors), r.issue()); + auto reward = divide(r, STAmount(num_attestors), r.asset()); for (auto i : signers) st.receive(bridge_.signers[i].account, reward); @@ -4213,7 +4242,7 @@ private: ChainStateTrack& st = srcState(); jtx::Account const& srcdoor = srcDoor(); - if (xfer.amt.issue() != xrpIssue()) + if (xfer.amt.asset() != xrpIssue()) { st.env.tx(pay(srcdoor, xfer.from, xfer.amt)); st.spendFee(srcdoor); @@ -4233,7 +4262,7 @@ private: distribute_reward(ChainStateTrack& st) { auto r = bridge_.reward; - auto reward = divide(r, STAmount(bridge_.quorum), r.issue()); + auto reward = divide(r, STAmount(bridge_.quorum), r.asset()); for (size_t i = 0; i < num_signers; ++i) { @@ -4251,7 +4280,7 @@ private: // check all signers, but start at a random one for (size_t i = 0; i < num_signers; ++i) { - size_t signer_idx = (rnd + i) % num_signers; + size_t const signer_idx = (rnd + i) % num_signers; if (!(xfer.attested[signer_idx])) { // enqueue one attestation for this signer @@ -4275,7 +4304,7 @@ private: } // return true if quorum was reached, false otherwise - bool quorum = + bool const quorum = std::count(xfer.attested.begin(), xfer.attested.end(), true) >= bridge_.quorum; if (quorum && xfer.with_claim == WithClaim::no) { @@ -4380,7 +4409,7 @@ public: for (auto it = sm_.begin(); it != sm_.end();) { auto vis = [&](auto& sm) { - uint32_t rnd = distrib(gen); + uint32_t const rnd = distrib(gen); return sm.advance(time, rnd); }; auto& [t, sm] = *it; @@ -4446,14 +4475,14 @@ public: for (auto& acct : a) { - STAmount amt{XRP(100000)}; + STAmount const amt{XRP(100000)}; mcEnv.fund(amt, acct); scEnv.fund(amt, acct); } - Account USDLocking{"USDLocking"}; - IOU usdLocking{USDLocking["USD"]}; - IOU usdIssuing{doorUSDIssuing["USD"]}; + Account const USDLocking{"USDLocking"}; + IOU const usdLocking{USDLocking["USD"]}; + IOU const usdIssuing{doorUSDIssuing["USD"]}; mcEnv.fund(XRP(100000), USDLocking); mcEnv.close(); diff --git a/src/test/app/tx/apply_test.cpp b/src/test/app/tx/apply_test.cpp index 10b0544f49..ffacc0a563 100644 --- a/src/test/app/tx/apply_test.cpp +++ b/src/test/app/tx/apply_test.cpp @@ -2,10 +2,16 @@ #include +#include #include -#include +#include +#include +#include #include +#include +#include + namespace xrpl { class Apply_test : public beast::unit_test::suite @@ -37,7 +43,7 @@ public: { test::jtx::Env fully_canonical(*this, test::jtx::testable_amendments()); - Validity valid = + Validity const valid = checkValidity( fully_canonical.app().getHashRouter(), tx, fully_canonical.current()->rules()) .first; diff --git a/src/test/basics/Buffer_test.cpp b/src/test/basics/Buffer_test.cpp index a329e527ba..19f646cfdd 100644 --- a/src/test/basics/Buffer_test.cpp +++ b/src/test/basics/Buffer_test.cpp @@ -1,8 +1,12 @@ #include -#include +#include +#include +#include #include +#include #include +#include namespace xrpl { namespace test { @@ -26,7 +30,7 @@ struct Buffer_test : beast::unit_test::suite 0xac, 0x2d, 0x89, 0x4d, 0x19, 0x9c, 0xf0, 0x2c, 0x15, 0xd1, 0xf9, 0x9b, 0x66, 0xd2, 0x30, 0xd3}; - Buffer b0; + Buffer const b0; BEAST_EXPECT(sane(b0)); BEAST_EXPECT(b0.empty()); @@ -105,7 +109,7 @@ struct Buffer_test : beast::unit_test::suite { // Move-construct from empty buf Buffer x; - Buffer y{std::move(x)}; + Buffer const y{std::move(x)}; BEAST_EXPECT(sane(x)); // NOLINT(bugprone-use-after-move) BEAST_EXPECT(x.empty()); // NOLINT(bugprone-use-after-move) BEAST_EXPECT(sane(y)); @@ -115,7 +119,7 @@ struct Buffer_test : beast::unit_test::suite { // Move-construct from non-empty buf Buffer x{b1}; - Buffer y{std::move(x)}; + Buffer const y{std::move(x)}; BEAST_EXPECT(sane(x)); // NOLINT(bugprone-use-after-move) BEAST_EXPECT(x.empty()); // NOLINT(bugprone-use-after-move) BEAST_EXPECT(sane(y)); diff --git a/src/test/basics/Expected_test.cpp b/src/test/basics/Expected_test.cpp index 2caa15816f..3fb2457764 100644 --- a/src/test/basics/Expected_test.cpp +++ b/src/test/basics/Expected_test.cpp @@ -1,11 +1,17 @@ #include -#include +#include #include +#include +#include + +#include +#include +#include +#include + #if BOOST_VERSION >= 107500 -#include // Not part of boost before version 1.75 -#endif // BOOST_VERSION -#include +#endif // BOOST_VERSION #include namespace xrpl { @@ -46,7 +52,7 @@ struct Expected_test : beast::unit_test::suite BEAST_EXPECT(expected.value() == "Valid value"); BEAST_EXPECT(*expected == "Valid value"); BEAST_EXPECT(expected->at(0) == 'V'); - std::string mv = std::move(*expected); + std::string const mv = std::move(*expected); BEAST_EXPECT(mv == "Valid value"); bool throwOccurred = false; diff --git a/src/test/basics/FileUtilities_test.cpp b/src/test/basics/FileUtilities_test.cpp index 3d6f9b754b..b427e800ec 100644 --- a/src/test/basics/FileUtilities_test.cpp +++ b/src/test/basics/FileUtilities_test.cpp @@ -2,7 +2,10 @@ #include #include -#include +#include + +#include +#include namespace xrpl { @@ -17,7 +20,7 @@ public: constexpr char const* expectedContents = "This file is very short. That's all we need."; - FileDirGuard file( + FileDirGuard const file( *this, "test_file", "test.txt", "This is temporary text that should get overwritten"); error_code ec; diff --git a/src/test/basics/IOUAmount_test.cpp b/src/test/basics/IOUAmount_test.cpp index 73ab0343cd..95362c7545 100644 --- a/src/test/basics/IOUAmount_test.cpp +++ b/src/test/basics/IOUAmount_test.cpp @@ -1,6 +1,12 @@ -#include +#include +#include +#include #include +#include +#include +#include + namespace xrpl { class IOUAmount_test : public beast::unit_test::suite @@ -55,7 +61,7 @@ public: using beast::zero; { - IOUAmount z(zero); + IOUAmount const z(zero); BEAST_EXPECT(z == zero); BEAST_EXPECT(z >= zero); BEAST_EXPECT(z <= zero); @@ -94,9 +100,11 @@ public: BEAST_EXPECT(z >= z); BEAST_EXPECT(z <= z); BEAST_EXPECT(z == -z); + // NOLINTBEGIN(misc-redundant-expression) unexpected(z > z); unexpected(z < z); unexpected(z != z); + // NOLINTEND(misc-redundant-expression) unexpected(z != -z); BEAST_EXPECT(n < z); @@ -150,7 +158,7 @@ public: for (auto const mantissaSize : {MantissaRange::small, MantissaRange::large}) { - NumberMantissaScaleGuard mg(mantissaSize); + NumberMantissaScaleGuard const mg(mantissaSize); test(IOUAmount(-2, 0), "-2"); test(IOUAmount(0, 0), "0"); @@ -181,14 +189,14 @@ public: { // multiply by a number that would overflow the mantissa, then // divide by the same number, and check we didn't lose any value - IOUAmount bigMan(maxMantissa, 0); + IOUAmount const bigMan(maxMantissa, 0); BEAST_EXPECT(bigMan == mulRatio(bigMan, maxUInt, maxUInt, true)); // rounding mode shouldn't matter as the result is exact BEAST_EXPECT(bigMan == mulRatio(bigMan, maxUInt, maxUInt, false)); } { // Similar test as above, but for negative values - IOUAmount bigMan(-maxMantissa, 0); + IOUAmount const bigMan(-maxMantissa, 0); BEAST_EXPECT(bigMan == mulRatio(bigMan, maxUInt, maxUInt, true)); // rounding mode shouldn't matter as the result is exact BEAST_EXPECT(bigMan == mulRatio(bigMan, maxUInt, maxUInt, false)); @@ -196,7 +204,7 @@ public: { // small amounts - IOUAmount tiny(minMantissa, minExponent); + IOUAmount const tiny(minMantissa, minExponent); // Round up should give the smallest allowable number BEAST_EXPECT(tiny == mulRatio(tiny, 1, maxUInt, true)); BEAST_EXPECT(tiny == mulRatio(tiny, maxUInt - 1, maxUInt, true)); @@ -205,7 +213,7 @@ public: BEAST_EXPECT(beast::zero == mulRatio(tiny, maxUInt - 1, maxUInt, false)); // tiny negative numbers - IOUAmount tinyNeg(-minMantissa, minExponent); + IOUAmount const tinyNeg(-minMantissa, minExponent); // Round up should give zero BEAST_EXPECT(beast::zero == mulRatio(tinyNeg, 1, maxUInt, true)); BEAST_EXPECT(beast::zero == mulRatio(tinyNeg, maxUInt - 1, maxUInt, true)); @@ -216,20 +224,20 @@ public: { // rounding { - IOUAmount one(1, 0); + IOUAmount const one(1, 0); auto const rup = mulRatio(one, maxUInt - 1, maxUInt, true); auto const rdown = mulRatio(one, maxUInt - 1, maxUInt, false); BEAST_EXPECT(rup.mantissa() - rdown.mantissa() == 1); } { - IOUAmount big(maxMantissa, maxExponent); + IOUAmount const big(maxMantissa, maxExponent); auto const rup = mulRatio(big, maxUInt - 1, maxUInt, true); auto const rdown = mulRatio(big, maxUInt - 1, maxUInt, false); BEAST_EXPECT(rup.mantissa() - rdown.mantissa() == 1); } { - IOUAmount negOne(-1, 0); + IOUAmount const negOne(-1, 0); auto const rup = mulRatio(negOne, maxUInt - 1, maxUInt, true); auto const rdown = mulRatio(negOne, maxUInt - 1, maxUInt, false); BEAST_EXPECT(rup.mantissa() - rdown.mantissa() == 1); diff --git a/src/test/basics/IntrusiveShared_test.cpp b/src/test/basics/IntrusiveShared_test.cpp index 41ecf9a7a4..96517d9e48 100644 --- a/src/test/basics/IntrusiveShared_test.cpp +++ b/src/test/basics/IntrusiveShared_test.cpp @@ -1,21 +1,27 @@ -#include -#include +#include // IWYU pragma: keep +#include // IWYU pragma: keep #include -#include -#include +#include +#include #include #include -#include -#include +#include +#include // IWYU pragma: keep #include +#include +#include +#include #include +#include #include #include #include #include +#include #include +#include namespace xrpl { namespace tests { @@ -191,16 +197,16 @@ public: testcase("Basics"); { - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; - TIBase b; + TIBase const b; BEAST_EXPECT(b.use_count() == 1); b.addWeakRef(); BEAST_EXPECT(b.use_count() == 1); auto s = b.releaseStrongRef(); BEAST_EXPECT(s == ReleaseStrongRefAction::partialDestroy); BEAST_EXPECT(b.use_count() == 0); - TIBase* pb = &b; + TIBase const* pb = &b; partialDestructorFinished(&pb); BEAST_EXPECT(!pb); auto w = b.releaseWeakRef(); @@ -210,7 +216,7 @@ public: std::vector> strong; std::vector> weak; { - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; using enum TrackedState; auto b = make_SharedIntrusive(); @@ -251,7 +257,7 @@ public: BEAST_EXPECT(TIBase::getState(id) == deleted); } { - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; using enum TrackedState; auto b = make_SharedIntrusive(); @@ -275,7 +281,7 @@ public: BEAST_EXPECT(TIBase::getState(id) == deleted); } { - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; using enum TrackedState; using swu = SharedWeakUnion; @@ -309,7 +315,7 @@ public: { // Testing SharedWeakUnion assignment operator - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; auto strong1 = make_SharedIntrusive(); auto strong2 = make_SharedIntrusive(); @@ -338,7 +344,7 @@ public: // 2) Test self-assignment BEAST_EXPECT(union1.isStrong()); BEAST_EXPECT(TIBase::getState(id1) == TrackedState::alive); - int initialRefCount = strong1->use_count(); + int const initialRefCount = strong1->use_count(); #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wself-assign-overloaded" union1 = union1; // Self-assignment @@ -374,7 +380,7 @@ public: using enum TrackedState; - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; auto strong = make_SharedIntrusive(); WeakIntrusive weak{strong}; @@ -441,7 +447,7 @@ public: using enum TrackedState; - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; auto strong = make_SharedIntrusive(); WeakIntrusive weak{strong}; @@ -486,12 +492,12 @@ public: // and check that the invariants hold. using enum TrackedState; - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; std::atomic destructionState{0}; // returns destructorRan and partialDestructorRan (in that order) auto getDestructorState = [&]() -> std::pair { - int s = destructionState.load(std::memory_order_relaxed); + int const s = destructionState.load(std::memory_order_relaxed); return {(s & 1) != 0, (s & 2) != 0}; }; auto setDestructorRan = [&]() -> void { @@ -620,12 +626,12 @@ public: using enum TrackedState; - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; std::atomic destructionState{0}; // returns destructorRan and partialDestructorRan (in that order) auto getDestructorState = [&]() -> std::pair { - int s = destructionState.load(std::memory_order_relaxed); + int const s = destructionState.load(std::memory_order_relaxed); return {(s & 1) != 0, (s & 2) != 0}; }; auto setDestructorRan = [&]() -> void { @@ -761,12 +767,12 @@ public: using enum TrackedState; - TIBase::ResetStatesGuard rsg{true}; + TIBase::ResetStatesGuard const rsg{true}; std::atomic destructionState{0}; // returns destructorRan and partialDestructorRan (in that order) auto getDestructorState = [&]() -> std::pair { - int s = destructionState.load(std::memory_order_relaxed); + int const s = destructionState.load(std::memory_order_relaxed); return {(s & 1) != 0, (s & 2) != 0}; }; auto setDestructorRan = [&]() -> void { @@ -832,7 +838,7 @@ public: // Multiple threads all create a weak pointer from the same // strong pointer - WeakIntrusive weak{toLock[threadId]}; + WeakIntrusive const weak{toLock[threadId]}; for (int wi = 0; wi < lockWeakLoopIters; ++wi) { BEAST_EXPECT(!weak.expired()); diff --git a/src/test/basics/KeyCache_test.cpp b/src/test/basics/KeyCache_test.cpp index 55b275ae09..2370f87f5d 100644 --- a/src/test/basics/KeyCache_test.cpp +++ b/src/test/basics/KeyCache_test.cpp @@ -1,10 +1,13 @@ #include #include -#include +#include // IWYU pragma: keep #include +#include #include +#include + namespace xrpl { class KeyCache_test : public beast::unit_test::suite diff --git a/src/test/basics/Number_test.cpp b/src/test/basics/Number_test.cpp index 4676884660..cc7ccaa8c2 100644 --- a/src/test/basics/Number_test.cpp +++ b/src/test/basics/Number_test.cpp @@ -1,10 +1,18 @@ #include -#include +#include #include +#include #include #include +#include +#include +#include +#include +#include #include +#include +#include #include namespace xrpl { @@ -37,7 +45,8 @@ public: auto const minMantissa = Number::minMantissa(); try { - Number x = Number{false, minMantissa * 10, 32768, Number::normalized{}}; + [[maybe_unused]] Number const x = + Number{false, minMantissa * 10, 32768, Number::normalized{}}; } catch (std::overflow_error const&) { @@ -86,7 +95,7 @@ public: try { [[maybe_unused]] - Number q = Number{false, minMantissa, 32767, Number::normalized{}} * 100; + Number const q = Number{false, minMantissa, 32767, Number::normalized{}} * 100; } catch (std::overflow_error const&) { @@ -332,7 +341,7 @@ public: }; auto const maxMantissa = Number::maxMantissa(); - saveNumberRoundMode save{Number::setround(Number::to_nearest)}; + saveNumberRoundMode const save{Number::setround(Number::to_nearest)}; { auto const cSmall = std::to_array({ {Number{7}, Number{8}, Number{56}}, @@ -642,7 +651,7 @@ public: test(cLarge); } }; - saveNumberRoundMode save{Number::setround(Number::to_nearest)}; + saveNumberRoundMode const save{Number::setround(Number::to_nearest)}; { auto const cSmall = std::to_array( {{Number{1}, Number{2}, Number{5, -1}}, @@ -857,7 +866,7 @@ public: test(cSmall); if (Number::getMantissaScale() != MantissaRange::small) { - NumberRoundModeGuard mg(Number::towards_zero); + NumberRoundModeGuard const mg(Number::towards_zero); test(cLarge); } bool caught = false; @@ -928,7 +937,7 @@ public: { testcase << "test_power1 " << to_string(Number::getMantissaScale()); using Case = std::tuple; - Case c[]{ + Case const c[]{ {Number{64}, 0, Number{1}}, {Number{64}, 1, Number{64}}, {Number{64}, 2, Number{4096}}, @@ -946,7 +955,7 @@ public: { testcase << "test_power2 " << to_string(Number::getMantissaScale()); using Case = std::tuple; - Case c[]{ + Case const c[]{ {Number{1}, 3, 7, Number{1}}, {Number{-1}, 1, 0, Number{1}}, {Number{-1, -1}, 1, 0, Number{0}}, @@ -992,24 +1001,24 @@ public: { testcase << "testConversions " << to_string(Number::getMantissaScale()); - IOUAmount x{5, 6}; - Number y = x; + IOUAmount const x{5, 6}; + Number const y = x; BEAST_EXPECT((y == Number{5, 6})); - IOUAmount z{y}; + IOUAmount const z{y}; BEAST_EXPECT(x == z); - XRPAmount xrp{500}; - STAmount st = xrp; - Number n = st; + XRPAmount const xrp{500}; + STAmount const st = xrp; + Number const n = st; BEAST_EXPECT(XRPAmount{n} == xrp); - IOUAmount x0{0, 0}; - Number y0 = x0; + IOUAmount const x0{0, 0}; + Number const y0 = x0; BEAST_EXPECT((y0 == Number{0})); - IOUAmount z0{y0}; + IOUAmount const z0{y0}; BEAST_EXPECT(x0 == z0); - XRPAmount xrp0{0}; - Number n0 = xrp0; + XRPAmount const xrp0{0}; + Number const n0 = xrp0; BEAST_EXPECT(n0 == Number{0}); - XRPAmount xrp1{n0}; + XRPAmount const xrp1{n0}; BEAST_EXPECT(xrp1 == xrp0); } @@ -1018,9 +1027,9 @@ public: { testcase << "test_to_integer " << to_string(Number::getMantissaScale()); using Case = std::tuple; - saveNumberRoundMode save{Number::setround(Number::to_nearest)}; + saveNumberRoundMode const save{Number::setround(Number::to_nearest)}; { - Case c[]{ + Case const c[]{ {Number{0}, 0}, {Number{1}, 1}, {Number{2}, 2}, @@ -1058,7 +1067,7 @@ public: auto prev_mode = Number::setround(Number::towards_zero); BEAST_EXPECT(prev_mode == Number::to_nearest); { - Case c[]{ + Case const c[]{ {Number{0}, 0}, {Number{1}, 1}, {Number{2}, 2}, @@ -1096,7 +1105,7 @@ public: prev_mode = Number::setround(Number::downward); BEAST_EXPECT(prev_mode == Number::towards_zero); { - Case c[]{ + Case const c[]{ {Number{0}, 0}, {Number{1}, 1}, {Number{2}, 2}, @@ -1134,7 +1143,7 @@ public: prev_mode = Number::setround(Number::upward); BEAST_EXPECT(prev_mode == Number::downward); { - Case c[]{ + Case const c[]{ {Number{0}, 0}, {Number{1}, 1}, {Number{2}, 2}, @@ -1185,7 +1194,7 @@ public: test_squelch() { testcase << "test_squelch " << to_string(Number::getMantissaScale()); - Number limit{1, -6}; + Number const limit{1, -6}; BEAST_EXPECT((squelch(Number{2, -6}, limit) == Number{2, -6})); BEAST_EXPECT((squelch(Number{1, -6}, limit) == Number{1, -6})); BEAST_EXPECT((squelch(Number{9, -7}, limit) == Number{0})); @@ -1233,7 +1242,7 @@ public: test(Number::max(), "9999999999999999e32768"); test(Number::lowest(), "-9999999999999999e32768"); { - NumberRoundModeGuard mg(Number::towards_zero); + NumberRoundModeGuard const mg(Number::towards_zero); auto const maxMantissa = Number::maxMantissa(); BEAST_EXPECT(maxMantissa == 9'999'999'999'999'999); @@ -1263,7 +1272,7 @@ public: test(Number::max(), "9223372036854775807e32768"); test(Number::lowest(), "-9223372036854775807e32768"); { - NumberRoundModeGuard mg(Number::towards_zero); + NumberRoundModeGuard const mg(Number::towards_zero); auto const maxMantissa = Number::maxMantissa(); BEAST_EXPECT(maxMantissa == 9'999'999'999'999'999'999ULL); @@ -1314,7 +1323,7 @@ public: test_stream() { testcase << "test_stream " << to_string(Number::getMantissaScale()); - Number x{100}; + Number const x{100}; std::ostringstream os; os << x; BEAST_EXPECT(os.str() == to_string(x)); @@ -1325,7 +1334,7 @@ public: { testcase << "test_inc_dec " << to_string(Number::getMantissaScale()); Number x{100}; - Number y = +x; + Number const y = +x; BEAST_EXPECT(x == y); BEAST_EXPECT(x++ == y); BEAST_EXPECT(x == Number{101}); @@ -1336,7 +1345,7 @@ public: void test_toSTAmount() { - NumberSO stNumberSO{true}; + NumberSO const stNumberSO{true}; Issue const issue; Number const n{7'518'783'80596, -5}; saveNumberRoundMode const save{Number::setround(Number::to_nearest)}; @@ -1478,7 +1487,7 @@ public: { for (auto const& [mode, val] : roundings) { - NumberRoundModeGuard g{mode}; + NumberRoundModeGuard const g{mode}; auto const res = static_cast(num); BEAST_EXPECTS( res == val, @@ -1496,7 +1505,7 @@ public: // Control case BEAST_EXPECT(Number::maxMantissa() > 10); - Number ten{10}; + Number const ten{10}; BEAST_EXPECT(ten.exponent() <= 0); if (scale == MantissaRange::small) @@ -1528,7 +1537,7 @@ public: // 85'070'591'730'234'615'847'396'907'784'232'501'249 - 38 digits BEAST_EXPECT((power(maxInt64, 2) == Number{85'070'591'730'234'615'85, 19})); - NumberRoundModeGuard mg(Number::towards_zero); + NumberRoundModeGuard const mg(Number::towards_zero); auto const maxMantissa = Number::maxMantissa(); Number const max = Number{false, maxMantissa, 0, Number::normalized{}}; @@ -1546,7 +1555,7 @@ public: { for (auto const scale : {MantissaRange::small, MantissaRange::large}) { - NumberMantissaScaleGuard sg(scale); + NumberMantissaScaleGuard const sg(scale); testZero(); test_limits(); testToString(); diff --git a/src/test/basics/PerfLog_test.cpp b/src/test/basics/PerfLog_test.cpp index 470a52d220..c433e63f84 100644 --- a/src/test/basics/PerfLog_test.cpp +++ b/src/test/basics/PerfLog_test.cpp @@ -1,20 +1,39 @@ #include #include +#include #include #include -#include +#include #include +#include +#include #include #include +#include +#include #include -#include +#include +#include +#include +#include + +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include //------------------------------------------------------------------------------ diff --git a/src/test/basics/StringUtilities_test.cpp b/src/test/basics/StringUtilities_test.cpp index 78719e47c6..e566e43c9f 100644 --- a/src/test/basics/StringUtilities_test.cpp +++ b/src/test/basics/StringUtilities_test.cpp @@ -1,7 +1,9 @@ #include #include #include -#include +#include + +#include namespace xrpl { @@ -279,7 +281,7 @@ public: } { - std::string strUrl("s://" + std::string(8192, ':')); + std::string const strUrl("s://" + std::string(8192, ':')); parsedURL pUrl; BEAST_EXPECT(!parseUrl(pUrl, strUrl)); } diff --git a/src/test/basics/TaggedCache_test.cpp b/src/test/basics/TaggedCache_test.cpp index 78dc25380b..9621719803 100644 --- a/src/test/basics/TaggedCache_test.cpp +++ b/src/test/basics/TaggedCache_test.cpp @@ -1,10 +1,13 @@ #include #include -#include +#include // IWYU pragma: keep #include +#include #include +#include + namespace xrpl { /* diff --git a/src/test/basics/Units_test.cpp b/src/test/basics/Units_test.cpp index 9693c6d181..fb79c4978a 100644 --- a/src/test/basics/Units_test.cpp +++ b/src/test/basics/Units_test.cpp @@ -1,6 +1,13 @@ -#include +#include +#include +#include #include #include +#include + +#include +#include +#include namespace xrpl { namespace test { @@ -14,7 +21,7 @@ private: using FeeLevel32 = FeeLevel; { - XRPAmount x{100}; + XRPAmount const x{100}; BEAST_EXPECT(x.drops() == 100); BEAST_EXPECT((std::is_same_v)); auto y = 4u * x; @@ -25,8 +32,8 @@ private: BEAST_EXPECT(z.value() == 1600); BEAST_EXPECT((std::is_same_v)); - FeeLevel32 f{10}; - FeeLevel32 baseFee{100}; + FeeLevel32 const f{10}; + FeeLevel32 const baseFee{100}; auto drops = mulDiv(baseFee, x, f); @@ -39,15 +46,15 @@ private: BEAST_EXPECT((std::is_same_v, XRPAmount>)); } { - XRPAmount x{100}; + XRPAmount const x{100}; BEAST_EXPECT(x.value() == 100); BEAST_EXPECT((std::is_same_v)); auto y = 4u * x; BEAST_EXPECT(y.value() == 400); BEAST_EXPECT((std::is_same_v)); - FeeLevel64 f{10}; - FeeLevel64 baseFee{100}; + FeeLevel64 const f{10}; + FeeLevel64 const baseFee{100}; auto drops = mulDiv(baseFee, x, f); @@ -59,16 +66,16 @@ private: BEAST_EXPECT((std::is_same_v, XRPAmount>)); } { - FeeLevel64 x{1024}; + FeeLevel64 const x{1024}; BEAST_EXPECT(x.value() == 1024); BEAST_EXPECT((std::is_same_v)); - std::uint64_t m = 4; + std::uint64_t const m = 4; auto y = m * x; BEAST_EXPECT(y.value() == 4096); BEAST_EXPECT((std::is_same_v)); - XRPAmount basefee{10}; - FeeLevel64 referencefee{256}; + XRPAmount const basefee{10}; + FeeLevel64 const referencefee{256}; auto drops = mulDiv(x, basefee, referencefee); @@ -88,56 +95,56 @@ private: using FeeLevel32 = FeeLevel; { - FeeLevel32 x{std::numeric_limits::max()}; + FeeLevel32 const x{std::numeric_limits::max()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::uintValue); BEAST_EXPECT(y == Json::Value{x.fee()}); } { - FeeLevel32 x{std::numeric_limits::min()}; + FeeLevel32 const x{std::numeric_limits::min()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::uintValue); BEAST_EXPECT(y == Json::Value{x.fee()}); } { - FeeLevel64 x{std::numeric_limits::max()}; + FeeLevel64 const x{std::numeric_limits::max()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::uintValue); BEAST_EXPECT(y == Json::Value{std::numeric_limits::max()}); } { - FeeLevel64 x{std::numeric_limits::min()}; + FeeLevel64 const x{std::numeric_limits::min()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::uintValue); BEAST_EXPECT(y == Json::Value{0}); } { - FeeLevelDouble x{std::numeric_limits::max()}; + FeeLevelDouble const x{std::numeric_limits::max()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::realValue); BEAST_EXPECT(y == Json::Value{std::numeric_limits::max()}); } { - FeeLevelDouble x{std::numeric_limits::min()}; + FeeLevelDouble const x{std::numeric_limits::min()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::realValue); BEAST_EXPECT(y == Json::Value{std::numeric_limits::min()}); } { - XRPAmount x{std::numeric_limits::max()}; + XRPAmount const x{std::numeric_limits::max()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::intValue); BEAST_EXPECT(y == Json::Value{std::numeric_limits::max()}); } { - XRPAmount x{std::numeric_limits::min()}; + XRPAmount const x{std::numeric_limits::min()}; auto y = x.jsonClipped(); BEAST_EXPECT(y.type() == Json::intValue); BEAST_EXPECT(y == Json::Value{std::numeric_limits::min()}); @@ -156,7 +163,7 @@ private: auto explicitmake = [&](auto x) -> FeeLevel64 { return FeeLevel64{x}; }; [[maybe_unused]] - FeeLevel64 defaulted; + FeeLevel64 const defaulted{}; FeeLevel64 test{0}; BEAST_EXPECT(test.fee() == 0); @@ -241,7 +248,7 @@ private: auto explicitmake = [&](auto x) -> FeeLevelDouble { return FeeLevelDouble{x}; }; [[maybe_unused]] - FeeLevelDouble defaulted; + FeeLevelDouble const defaulted{}; FeeLevelDouble test{0}; BEAST_EXPECT(test.fee() == 0); diff --git a/src/test/basics/XRPAmount_test.cpp b/src/test/basics/XRPAmount_test.cpp index 58b15b5d2d..b0e8213b73 100644 --- a/src/test/basics/XRPAmount_test.cpp +++ b/src/test/basics/XRPAmount_test.cpp @@ -1,6 +1,10 @@ -#include +#include +#include #include +#include +#include + namespace xrpl { class XRPAmount_test : public beast::unit_test::suite @@ -127,7 +131,7 @@ public: // since some of them are templated, but not used anywhere else. auto make = [&](auto x) -> XRPAmount { return XRPAmount{x}; }; - XRPAmount defaulted{}; + XRPAmount const defaulted{}; (void)defaulted; XRPAmount test{0}; BEAST_EXPECT(test.drops() == 0); @@ -230,7 +234,8 @@ public: { // Similar test as above, but for negative values - XRPAmount big(minXRP); + XRPAmount big(minXRP); // NOLINT(misc-const-correctness): const breaks overflow check + // at end of this scope BEAST_EXPECT(big == mulRatio(big, maxUInt32, maxUInt32, true)); // rounding mode shouldn't matter as the result is exact BEAST_EXPECT(big == mulRatio(big, maxUInt32, maxUInt32, false)); @@ -244,7 +249,7 @@ public: { // small amounts - XRPAmount tiny(1); + XRPAmount const tiny(1); // Round up should give the smallest allowable number BEAST_EXPECT(tiny == mulRatio(tiny, 1, maxUInt32, true)); // rounding down should be zero @@ -252,7 +257,7 @@ public: BEAST_EXPECT(beast::zero == mulRatio(tiny, maxUInt32 - 1, maxUInt32, false)); // tiny negative numbers - XRPAmount tinyNeg(-1); + XRPAmount const tinyNeg(-1); // Round up should give zero BEAST_EXPECT(beast::zero == mulRatio(tinyNeg, 1, maxUInt32, true)); BEAST_EXPECT(beast::zero == mulRatio(tinyNeg, maxUInt32 - 1, maxUInt32, true)); @@ -262,21 +267,21 @@ public: { // rounding { - XRPAmount one(1); + XRPAmount const one(1); auto const rup = mulRatio(one, maxUInt32 - 1, maxUInt32, true); auto const rdown = mulRatio(one, maxUInt32 - 1, maxUInt32, false); BEAST_EXPECT(rup.drops() - rdown.drops() == 1); } { - XRPAmount big(maxXRP); + XRPAmount const big(maxXRP); auto const rup = mulRatio(big, maxUInt32 - 1, maxUInt32, true); auto const rdown = mulRatio(big, maxUInt32 - 1, maxUInt32, false); BEAST_EXPECT(rup.drops() - rdown.drops() == 1); } { - XRPAmount negOne(-1); + XRPAmount const negOne(-1); auto const rup = mulRatio(negOne, maxUInt32 - 1, maxUInt32, true); auto const rdown = mulRatio(negOne, maxUInt32 - 1, maxUInt32, false); BEAST_EXPECT(rup.drops() - rdown.drops() == 1); @@ -297,7 +302,7 @@ public: { // underflow - XRPAmount bigNegative(minXRP + 10); + XRPAmount const bigNegative(minXRP + 10); BEAST_EXPECT(mulRatio(bigNegative, 2, 1, true) == minXRP); } } // namespace xrpl diff --git a/src/test/basics/base58_test.cpp b/src/test/basics/base58_test.cpp index 52d06b324d..5e791bb7e1 100644 --- a/src/test/basics/base58_test.cpp +++ b/src/test/basics/base58_test.cpp @@ -1,12 +1,24 @@ +#include +#include + +#include // IWYU pragma: keep + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #ifndef _MSC_VER -#include #include #include -#include -#include - #include #include #include diff --git a/src/test/basics/base_uint_test.cpp b/src/test/basics/base_uint_test.cpp index c8f931e2b5..7eca024856 100644 --- a/src/test/basics/base_uint_test.cpp +++ b/src/test/basics/base_uint_test.cpp @@ -1,12 +1,23 @@ #include #include #include -#include +#include +#include -#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { namespace test { @@ -120,7 +131,7 @@ struct base_uint_test : beast::unit_test::suite // used to verify set insertion (hashing required) std::unordered_set> uset; - Blob raw{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12}; + Blob const raw{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12}; BEAST_EXPECT(test96::bytes == raw.size()); test96 u{raw}; @@ -144,7 +155,7 @@ struct base_uint_test : beast::unit_test::suite // back into another base_uint (w) for comparison with the original nonhash<96> h{}; hash_append(h, u); - test96 w{std::vector(h.data_.begin(), h.data_.end())}; + test96 const w{std::vector(h.data_.begin(), h.data_.end())}; BEAST_EXPECT(w == u); test96 v{~u}; @@ -200,7 +211,7 @@ struct base_uint_test : beast::unit_test::suite zp1++; test96 zm1{z}; zm1--; - test96 x{zm1 ^ zp1}; + test96 const x{zm1 ^ zp1}; uset.insert(x); BEAST_EXPECTS(to_string(x) == "FFFFFFFFFFFFFFFFFFFFFFFE", to_string(x)); BEAST_EXPECTS(to_short_string(x) == "FFFFFFFF...", to_short_string(x)); @@ -285,8 +296,8 @@ struct base_uint_test : beast::unit_test::suite { // Try to prevent constant evaluation. std::vector str(23, '7'); - std::string_view sView(str.data(), str.size()); - [[maybe_unused]] test96 t96(sView); + std::string_view const sView(str.data(), str.size()); + [[maybe_unused]] test96 const t96(sView); } catch (std::invalid_argument const& e) { @@ -303,8 +314,8 @@ struct base_uint_test : beast::unit_test::suite // Try to prevent constant evaluation. std::vector str(23, '7'); str.push_back('G'); - std::string_view sView(str.data(), str.size()); - [[maybe_unused]] test96 t96(sView); + std::string_view const sView(str.data(), str.size()); + [[maybe_unused]] test96 const t96(sView); } catch (std::range_error const& e) { diff --git a/src/test/basics/hardened_hash_test.cpp b/src/test/basics/hardened_hash_test.cpp index 1a6609ac29..b52a94e5d3 100644 --- a/src/test/basics/hardened_hash_test.cpp +++ b/src/test/basics/hardened_hash_test.cpp @@ -1,9 +1,14 @@ #include -#include +#include #include +#include #include #include +#include +#include +#include +#include #include #include @@ -189,13 +194,13 @@ public: check_container() { { - C> c; + C> const c; } pass(); { - C> c; + C> const c; } pass(); diff --git a/src/test/basics/join_test.cpp b/src/test/basics/join_test.cpp index 36d34eee04..7854b3d022 100644 --- a/src/test/basics/join_test.cpp +++ b/src/test/basics/join_test.cpp @@ -1,7 +1,15 @@ #include +#include #include -#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { diff --git a/src/test/beast/IPEndpoint_test.cpp b/src/test/beast/IPEndpoint_test.cpp index 6276f7cd96..ec8b148f3f 100644 --- a/src/test/beast/IPEndpoint_test.cpp +++ b/src/test/beast/IPEndpoint_test.cpp @@ -4,12 +4,23 @@ #include #include +#include +#include +#include #include -#include +#include -#include +#include #include +#include #include +#include + +#include +#include +#include +#include +#include namespace beast { namespace IP { @@ -51,7 +62,7 @@ public: BEAST_EXPECT(AddressV4{0x01020304}.to_uint() == 0x01020304); { - AddressV4::bytes_type d = {{1, 2, 3, 4}}; + AddressV4::bytes_type const d = {{1, 2, 3, 4}}; BEAST_EXPECT(AddressV4{d}.to_uint() == 0x01020304); unexpected(is_unspecified(AddressV4{d})); @@ -110,7 +121,7 @@ public: { testcase("AddressV4::Bytes"); - AddressV4::bytes_type d1 = {{10, 0, 0, 1}}; + AddressV4::bytes_type const d1 = {{10, 0, 0, 1}}; AddressV4 v4{d1}; BEAST_EXPECT(v4.to_bytes()[0] == 10); BEAST_EXPECT(v4.to_bytes()[1] == 0); @@ -136,8 +147,8 @@ public: testcase("Address"); boost::system::error_code ec; - Address result{boost::asio::ip::make_address("1.2.3.4", ec)}; - AddressV4::bytes_type d = {{1, 2, 3, 4}}; + Address const result{boost::asio::ip::make_address("1.2.3.4", ec)}; + AddressV4::bytes_type const d = {{1, 2, 3, 4}}; BEAST_EXPECT(!ec); BEAST_EXPECT(result.is_v4() && result.to_v4() == AddressV4{d}); } @@ -286,7 +297,7 @@ public: BEAST_EXPECTS(to_string(ep) == "::ffff:166.78.151.147", to_string(ep)); // a private IPv6 - AddressV6::bytes_type d2 = {{253, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}}; + AddressV6::bytes_type const d2 = {{253, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}}; ep = Endpoint(AddressV6{d2}); BEAST_EXPECT(!is_unspecified(ep)); BEAST_EXPECT(!is_public(ep)); diff --git a/src/test/beast/LexicalCast_test.cpp b/src/test/beast/LexicalCast_test.cpp index 5cfc73a6f6..410358111e 100644 --- a/src/test/beast/LexicalCast_test.cpp +++ b/src/test/beast/LexicalCast_test.cpp @@ -1,7 +1,12 @@ #include -#include +#include #include +#include +#include +#include +#include + namespace beast { class LexicalCast_test : public unit_test::suite @@ -224,7 +229,7 @@ public: while (i <= std::numeric_limits::max()) { - std::int16_t j = static_cast(i); + std::int16_t const j = static_cast(i); auto actual = std::to_string(j); diff --git a/src/test/beast/SemanticVersion_test.cpp b/src/test/beast/SemanticVersion_test.cpp index cae10497af..7e25e845fc 100644 --- a/src/test/beast/SemanticVersion_test.cpp +++ b/src/test/beast/SemanticVersion_test.cpp @@ -1,5 +1,7 @@ #include -#include +#include + +#include namespace beast { diff --git a/src/test/beast/aged_associative_container_test.cpp b/src/test/beast/aged_associative_container_test.cpp index 1578ffceca..21681ff31d 100644 --- a/src/test/beast/aged_associative_container_test.cpp +++ b/src/test/beast/aged_associative_container_test.cpp @@ -7,9 +7,18 @@ #include #include #include -#include +#include +#include +#include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include #ifndef BEAST_AGED_UNORDERED_NO_ALLOC_DEFAULTCTOR @@ -915,7 +924,7 @@ typename std::enable_if::type aged_associative_container_test_base::testConstructInitList() { using Traits = TestTraits; - typename Traits::ManualClock clock; + typename Traits::ManualClock const clock; // testcase (Traits::name() + " init-list"); testcase("init-list"); @@ -931,7 +940,7 @@ typename std::enable_if::type aged_associative_container_test_base::testConstructInitList() { using Traits = TestTraits; - typename Traits::ManualClock clock; + typename Traits::ManualClock const clock; // testcase (Traits::name() + " init-list"); testcase("init-list"); @@ -1033,8 +1042,8 @@ aged_associative_container_test_base::testIterator() using const_iterator = decltype(c.cbegin()); // Should be able to construct or assign an iterator from an iterator. - iterator nnIt_0{c.begin()}; - iterator nnIt_1{nnIt_0}; + iterator const nnIt_0{c.begin()}; + iterator const nnIt_1{nnIt_0}; BEAST_EXPECT(nnIt_0 == nnIt_1); iterator nnIt_2; nnIt_2 = nnIt_1; @@ -1042,8 +1051,8 @@ aged_associative_container_test_base::testIterator() // Should be able to construct or assign a const_iterator from a // const_iterator. - const_iterator ccIt_0{c.cbegin()}; - const_iterator ccIt_1{ccIt_0}; + const_iterator const ccIt_0{c.cbegin()}; + const_iterator const ccIt_1{ccIt_0}; BEAST_EXPECT(ccIt_0 == ccIt_1); const_iterator ccIt_2; ccIt_2 = ccIt_1; @@ -1054,8 +1063,8 @@ aged_associative_container_test_base::testIterator() BEAST_EXPECT(ccIt_1 == nnIt_1); // Should be able to construct a const_iterator from an iterator. - const_iterator ncIt_3{c.begin()}; - const_iterator ncIt_4{nnIt_0}; + const_iterator const ncIt_3{c.begin()}; + const_iterator const ncIt_4{nnIt_0}; BEAST_EXPECT(ncIt_3 == ncIt_4); const_iterator ncIt_5; ncIt_5 = nnIt_2; @@ -1098,8 +1107,8 @@ aged_associative_container_test_base::testReverseIterator() // Should be able to construct or assign a reverse_iterator from a // reverse_iterator. - reverse_iterator rNrNit_0{c.rbegin()}; - reverse_iterator rNrNit_1{rNrNit_0}; + reverse_iterator const rNrNit_0{c.rbegin()}; + reverse_iterator const rNrNit_1{rNrNit_0}; BEAST_EXPECT(rNrNit_0 == rNrNit_1); reverse_iterator xXrNit_2; xXrNit_2 = rNrNit_1; @@ -1107,8 +1116,8 @@ aged_associative_container_test_base::testReverseIterator() // Should be able to construct or assign a const_reverse_iterator from a // const_reverse_iterator - const_reverse_iterator rCrCit_0{c.crbegin()}; - const_reverse_iterator rCrCit_1{rCrCit_0}; + const_reverse_iterator const rCrCit_0{c.crbegin()}; + const_reverse_iterator const rCrCit_1{rCrCit_0}; BEAST_EXPECT(rCrCit_0 == rCrCit_1); const_reverse_iterator xXrCit_2; xXrCit_2 = rCrCit_1; @@ -1120,8 +1129,8 @@ aged_associative_container_test_base::testReverseIterator() // Should be able to construct or assign a const_reverse_iterator from a // reverse_iterator - const_reverse_iterator rNrCit_0{c.rbegin()}; - const_reverse_iterator rNrCit_1{rNrNit_0}; + const_reverse_iterator const rNrCit_0{c.rbegin()}; + const_reverse_iterator const rNrCit_1{rNrNit_0}; BEAST_EXPECT(rNrCit_0 == rNrCit_1); xXrCit_2 = rNrNit_1; BEAST_EXPECT(rNrCit_1 == xXrCit_2); @@ -1132,10 +1141,10 @@ aged_associative_container_test_base::testReverseIterator() // const_iterator. // Should be able to construct or assign reverse_iterators from // non-reverse iterators. - reverse_iterator fNrNit_0{c.begin()}; - const_reverse_iterator fNrCit_0{c.begin()}; + reverse_iterator const fNrNit_0{c.begin()}; + const_reverse_iterator const fNrCit_0{c.begin()}; BEAST_EXPECT(fNrNit_0 == fNrCit_0); - const_reverse_iterator fCrCit_0{c.cbegin()}; + const_reverse_iterator const fCrCit_0{c.cbegin()}; BEAST_EXPECT(fNrCit_0 == fCrCit_0); // None of these should compile because they construct a non-reverse @@ -1146,7 +1155,7 @@ aged_associative_container_test_base::testReverseIterator() // You should not be able to assign an iterator to a reverse_iterator or // vise-versa. So the following lines should not compile. - iterator xXfNit_0; + iterator const xXfNit_0; // xXfNit_0 = xXrNit_2; // xXrNit_2 = xXfNit_0; } @@ -1297,7 +1306,7 @@ aged_associative_container_test_base::testChronological() for (auto iter(v.crbegin()); iter != v.crend(); ++iter) { using iterator = typename decltype(c)::iterator; - iterator found(c.find(Traits::extract(*iter))); + iterator const found(c.find(Traits::extract(*iter))); BEAST_EXPECT(found != c.cend()); if (found == c.cend()) @@ -1317,7 +1326,7 @@ aged_associative_container_test_base::testChronological() for (auto iter(v.cbegin()); iter != v.cend(); ++iter) { using const_iterator = typename decltype(c)::const_iterator; - const_iterator found(c.find(Traits::extract(*iter))); + const_iterator const found(c.find(Traits::extract(*iter))); BEAST_EXPECT(found != c.cend()); if (found == c.cend()) @@ -1642,7 +1651,7 @@ aged_associative_container_test_base::testCompare() // testcase (Traits::name() + " array create"); testcase("array create"); - typename Traits::template Cont<> c1(v.begin(), v.end(), clock); + typename Traits::template Cont<> const c1(v.begin(), v.end(), clock); typename Traits::template Cont<> c2(v.begin(), v.end(), clock); c2.erase(c2.cbegin()); @@ -1672,7 +1681,7 @@ aged_associative_container_test_base::testObservers() // testcase (Traits::name() + " observers"); testcase("observers"); - typename Traits::template Cont<> c(clock); + typename Traits::template Cont<> const c(clock); c.key_comp(); c.value_comp(); @@ -1690,7 +1699,7 @@ aged_associative_container_test_base::testObservers() // testcase (Traits::name() + " observers"); testcase("observers"); - typename Traits::template Cont<> c(clock); + typename Traits::template Cont<> const c(clock); c.hash_function(); c.key_eq(); diff --git a/src/test/beast/beast_CurrentThreadName_test.cpp b/src/test/beast/beast_CurrentThreadName_test.cpp index 2a365c6e9c..fa3ce3fee6 100644 --- a/src/test/beast/beast_CurrentThreadName_test.cpp +++ b/src/test/beast/beast_CurrentThreadName_test.cpp @@ -1,8 +1,14 @@ #include -#include +#include #include +#if BOOST_OS_LINUX +#include +#endif + +#include +#include #include namespace xrpl { diff --git a/src/test/beast/beast_Journal_test.cpp b/src/test/beast/beast_Journal_test.cpp index cb190e57a0..7a96a1e2aa 100644 --- a/src/test/beast/beast_Journal_test.cpp +++ b/src/test/beast/beast_Journal_test.cpp @@ -1,6 +1,8 @@ -#include +#include #include +#include + namespace beast { class Journal_test : public unit_test::suite @@ -50,7 +52,7 @@ public: using namespace beast::severities; sink.threshold(kInfo); - Journal j(sink); + Journal const j(sink); j.trace() << " "; BEAST_EXPECT(sink.count() == 0); diff --git a/src/test/beast/beast_PropertyStream_test.cpp b/src/test/beast/beast_PropertyStream_test.cpp index 35aa91d18e..6709671a70 100644 --- a/src/test/beast/beast_PropertyStream_test.cpp +++ b/src/test/beast/beast_PropertyStream_test.cpp @@ -1,6 +1,8 @@ -#include +#include #include +#include + namespace beast { class PropertyStream_test : public unit_test::suite @@ -67,7 +69,7 @@ public: { try { - Source* source(root.find_one(name)); + Source const* source(root.find_one(name)); BEAST_EXPECT(source == expected); } catch (...) @@ -82,7 +84,7 @@ public: { try { - Source* source(root.find_path(path)); + Source const* source(root.find_path(path)); BEAST_EXPECT(source == expected); } catch (...) @@ -97,7 +99,7 @@ public: { try { - Source* source(root.find_one_deep(name)); + Source const* source(root.find_one_deep(name)); BEAST_EXPECT(source == expected); } catch (...) diff --git a/src/test/beast/beast_Zero_test.cpp b/src/test/beast/beast_Zero_test.cpp index c3dfbc8c4b..a509723773 100644 --- a/src/test/beast/beast_Zero_test.cpp +++ b/src/test/beast/beast_Zero_test.cpp @@ -1,4 +1,4 @@ -#include +#include #include namespace beast { diff --git a/src/test/beast/beast_abstract_clock_test.cpp b/src/test/beast/beast_abstract_clock_test.cpp index 43a210e128..c1a0c18839 100644 --- a/src/test/beast/beast_abstract_clock_test.cpp +++ b/src/test/beast/beast_abstract_clock_test.cpp @@ -2,9 +2,10 @@ #include #include -#include +#include -#include +#include +#include #include #include diff --git a/src/test/beast/beast_basic_seconds_clock_test.cpp b/src/test/beast/beast_basic_seconds_clock_test.cpp index ccdd76da20..b0d8ab5e92 100644 --- a/src/test/beast/beast_basic_seconds_clock_test.cpp +++ b/src/test/beast/beast_basic_seconds_clock_test.cpp @@ -1,5 +1,5 @@ #include -#include +#include namespace beast { diff --git a/src/test/beast/beast_io_latency_probe_test.cpp b/src/test/beast/beast_io_latency_probe_test.cpp index b2163f2630..dfd20eced0 100644 --- a/src/test/beast/beast_io_latency_probe_test.cpp +++ b/src/test/beast/beast_io_latency_probe_test.cpp @@ -1,16 +1,22 @@ #include #include -#include +#include #include -#include -#include +#include // IWYU pragma: keep #include +#include +#include -#include -#include -#include -#include +#include +#include // IWYU pragma: keep +#include +#include +#include // IWYU pragma: keep +#include // IWYU pragma: keep +#include +#include +#include // IWYU pragma: keep #include using namespace std::chrono_literals; @@ -60,7 +66,7 @@ class io_latency_probe_test : public beast::unit_test::suite, public beast::test wait_err = ec; auto const end{MeasureClock::now()}; elapsed_times_.emplace_back(end - start); - std::lock_guard lk{mtx}; + std::lock_guard const lk{mtx}; done = true; cv.notify_one(); }); @@ -157,7 +163,8 @@ class io_latency_probe_test : public beast::unit_test::suite, public beast::test auto interval = 99ms; auto probe_duration = 1s; - size_t expected_probe_count_max = (probe_duration / interval); + size_t const expected_probe_count_max = (probe_duration / interval); + // NOLINTNEXTLINE(misc-const-correctness) size_t expected_probe_count_min = expected_probe_count_max; #ifdef XRPL_RUNNING_IN_CI // adjust min expected based on measurements diff --git a/src/test/beast/define_print.cpp b/src/test/beast/define_print.cpp index 07b1422a54..92e57ca9d0 100644 --- a/src/test/beast/define_print.cpp +++ b/src/test/beast/define_print.cpp @@ -5,7 +5,10 @@ #include #include #include +#include +#include +#include #include // Include this .cpp in your project to gain access to the printing suite diff --git a/src/test/beast/xxhasher_test.cpp b/src/test/beast/xxhasher_test.cpp index 868d522384..385ed0558a 100644 --- a/src/test/beast/xxhasher_test.cpp +++ b/src/test/beast/xxhasher_test.cpp @@ -1,5 +1,7 @@ #include -#include +#include + +#include namespace beast { diff --git a/src/test/conditions/PreimageSha256_test.cpp b/src/test/conditions/PreimageSha256_test.cpp index 374b6eb925..e5d3c93add 100644 --- a/src/test/conditions/PreimageSha256_test.cpp +++ b/src/test/conditions/PreimageSha256_test.cpp @@ -1,14 +1,12 @@ #include #include #include -#include -#include +#include #include #include -#include -#include #include +#include #include #include diff --git a/src/test/consensus/ByzantineFailureSim_test.cpp b/src/test/consensus/ByzantineFailureSim_test.cpp index 245c52d9e3..a82064dd8f 100644 --- a/src/test/consensus/ByzantineFailureSim_test.cpp +++ b/src/test/consensus/ByzantineFailureSim_test.cpp @@ -1,8 +1,18 @@ #include +#include +#include +#include +#include +#include +#include -#include +#include -#include +#include + +#include +#include +#include namespace xrpl { namespace test { @@ -39,7 +49,7 @@ class ByzantineFailureSim_test : public beast::unit_test::suite f.trustAndConnect(f + d + e + g, delay); g.trustAndConnect(g + a + f, delay); - PeerGroup network = a + b + c + d + e + f + g; + PeerGroup const network = a + b + c + d + e + f + g; StreamCollector sc{std::cout}; diff --git a/src/test/consensus/Consensus_test.cpp b/src/test/consensus/Consensus_test.cpp index 3550717a4d..3d2933d4c0 100644 --- a/src/test/consensus/Consensus_test.cpp +++ b/src/test/consensus/Consensus_test.cpp @@ -1,10 +1,33 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include -#include -#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -144,7 +167,7 @@ public: testcase("standalone"); Sim s; - PeerGroup peers = s.createGroup(1); + PeerGroup const peers = s.createGroup(1); Peer* peer = peers[0]; peer->targetLedgers = 1; peer->start(); @@ -235,7 +258,7 @@ public: // All peers are in sync even with a slower peer 0 if (BEAST_EXPECT(sim.synchronized())) { - for (Peer* peer : network) + for (Peer const* peer : network) { auto const& lcl = peer->lastClosedLedger; BEAST_EXPECT(lcl.id() == peer->prevLedgerID()); @@ -292,7 +315,7 @@ public: // Verify all peers have same LCL but are missing // transaction 0,1 which was not received by all peers // before the ledger closed - for (Peer* peer : network) + for (Peer const* peer : network) { // Closed ledger has all but transaction 0,1 auto const& lcl = peer->lastClosedLedger; @@ -317,7 +340,7 @@ public: BEAST_EXPECT(slowPeer->prevProposers == fast.size()); } - for (Peer* peer : fast) + for (Peer const* peer : fast) { // Due to the network link delay settings // Peer 0 initially proposes {0} @@ -388,8 +411,8 @@ public: Sim sim; PeerGroup groupA = sim.createGroup(2); - PeerGroup groupB = sim.createGroup(2); - PeerGroup groupC = sim.createGroup(2); + PeerGroup const groupB = sim.createGroup(2); + PeerGroup const groupC = sim.createGroup(2); PeerGroup network = groupA + groupB + groupC; network.trust(network); @@ -397,7 +420,7 @@ public: // Run consensus without skew until we have a short close time // resolution - Peer* firstPeer = *groupA.begin(); + Peer const* firstPeer = *groupA.begin(); while (firstPeer->lastClosedLedger.closeTimeResolution() >= parms.proposeFRESHNESS) sim.run(1); @@ -412,7 +435,7 @@ public: // All nodes agreed to disagree on the close time if (BEAST_EXPECT(sim.synchronized())) { - for (Peer* peer : network) + for (Peer const* peer : network) BEAST_EXPECT(!peer->lastClosedLedger.closeAgree()); } } @@ -457,13 +480,13 @@ public: Sim sim; PeerGroup minority = sim.createGroup(2); - PeerGroup majorityA = sim.createGroup(3); - PeerGroup majorityB = sim.createGroup(5); + PeerGroup const majorityA = sim.createGroup(3); + PeerGroup const majorityB = sim.createGroup(5); PeerGroup majority = majorityA + majorityB; - PeerGroup network = minority + majority; + PeerGroup const network = minority + majority; - SimDuration delay = round(0.2 * parms.ledgerGRANULARITY); + SimDuration const delay = round(0.2 * parms.ledgerGRANULARITY); minority.trustAndConnect(minority + majorityA, delay); majority.trustAndConnect(majority, delay); @@ -556,10 +579,10 @@ public: Sim sim; PeerGroup loner = sim.createGroup(1); - PeerGroup friends = sim.createGroup(3); + PeerGroup const friends = sim.createGroup(3); loner.trust(loner + friends); - PeerGroup others = sim.createGroup(6); + PeerGroup const others = sim.createGroup(6); PeerGroup clique = friends + others; clique.trust(clique); @@ -581,7 +604,7 @@ public: sim.run(2); // Check all peers recovered - for (Peer* p : network) + for (Peer const* p : network) BEAST_EXPECT(p->prevLedgerID() == network[0]->prevLedgerID()); } } @@ -596,7 +619,7 @@ public: // This is a specialized test engineered to yield ledgers with different // close times even though the peers believe they had close time // consensus on the ledger. - ConsensusParms parms; + ConsensusParms const parms; Sim sim; @@ -634,7 +657,7 @@ public: NetClock::duration when = network[0]->now().time_since_epoch(); // Check we are before the 30s to 20s transition - NetClock::duration resolution = network[0]->lastClosedLedger.closeTimeResolution(); + NetClock::duration const resolution = network[0]->lastClosedLedger.closeTimeResolution(); BEAST_EXPECT(resolution == NetClock::duration{30s}); while (((when % NetClock::duration{30s}) != NetClock::duration{15s}) || @@ -650,7 +673,7 @@ public: { // close time should be ahead of clock time since we engineered // the close time to round up - for (Peer* peer : network) + for (Peer const* peer : network) { BEAST_EXPECT(peer->lastClosedLedger.closeTime() > peer->now()); BEAST_EXPECT(peer->lastClosedLedger.closeAgree()); @@ -692,26 +715,26 @@ public: using namespace std::chrono; testcase("fork"); - std::uint32_t numPeers = 10; + std::uint32_t const numPeers = 10; // Vary overlap between two UNLs for (std::uint32_t overlap = 0; overlap <= numPeers; ++overlap) { ConsensusParms const parms{}; Sim sim; - std::uint32_t numA = (numPeers - overlap) / 2; - std::uint32_t numB = numPeers - numA - overlap; + std::uint32_t const numA = (numPeers - overlap) / 2; + std::uint32_t const numB = numPeers - numA - overlap; - PeerGroup aOnly = sim.createGroup(numA); - PeerGroup bOnly = sim.createGroup(numB); - PeerGroup commonOnly = sim.createGroup(overlap); + PeerGroup const aOnly = sim.createGroup(numA); + PeerGroup const bOnly = sim.createGroup(numB); + PeerGroup const commonOnly = sim.createGroup(overlap); PeerGroup a = aOnly + commonOnly; PeerGroup b = bOnly + commonOnly; - PeerGroup network = a + b; + PeerGroup const network = a + b; - SimDuration delay = round(0.2 * parms.ledgerGRANULARITY); + SimDuration const delay = round(0.2 * parms.ledgerGRANULARITY); a.trustAndConnect(a, delay); b.trustAndConnect(b, delay); @@ -721,7 +744,7 @@ public: { // Nodes have only seen transactions from their neighbors peer->openTxs.insert(Tx{static_cast(peer->id)}); - for (Peer* to : sim.trustGraph.trustedPeers(peer)) + for (Peer const* to : sim.trustGraph.trustedPeers(peer)) peer->openTxs.insert(Tx{static_cast(to->id)}); } sim.run(1); @@ -759,7 +782,7 @@ public: validators.trust(validators); center.trust(validators); - SimDuration delay = round(0.2 * parms.ledgerGRANULARITY); + SimDuration const delay = round(0.2 * parms.ledgerGRANULARITY); validators.connect(center, delay); center[0]->runAsValidator = false; @@ -866,7 +889,7 @@ public: Sim sim; // Goes A->B->D - PeerGroup groupABD = sim.createGroup(2); + PeerGroup const groupABD = sim.createGroup(2); // Single node that initially fully validates C before the split PeerGroup groupCfast = sim.createGroup(1); // Generates C, but fails to fully validate before the split @@ -875,8 +898,8 @@ public: PeerGroup groupNotFastC = groupABD + groupCsplit; PeerGroup network = groupABD + groupCsplit + groupCfast; - SimDuration delay = round(0.2 * parms.ledgerGRANULARITY); - SimDuration fDelay = round(0.1 * parms.ledgerGRANULARITY); + SimDuration const delay = round(0.2 * parms.ledgerGRANULARITY); + SimDuration const fDelay = round(0.1 * parms.ledgerGRANULARITY); network.trust(network); // C must have a shorter delay to see all the validations before the @@ -987,14 +1010,14 @@ public: ConsensusParms const parms{}; Sim sim; - SimDuration delay = round(0.2 * parms.ledgerGRANULARITY); + SimDuration const delay = round(0.2 * parms.ledgerGRANULARITY); PeerGroup behind = sim.createGroup(3); - PeerGroup ahead = sim.createGroup(2); + PeerGroup const ahead = sim.createGroup(2); PeerGroup network = ahead + behind; hash_set trustedKeys; - for (Peer* p : network) + for (Peer const* p : network) trustedKeys.insert(p->key); for (Peer* p : network) p->trustedKeys = trustedKeys; @@ -1061,7 +1084,7 @@ public: Tx const txFollowingTrue{97}; Tx const txFollowingFalse{96}; int const numPeers = 100; - ConsensusParms p; + ConsensusParms const p; std::size_t peersUnchanged = 0; auto logs = std::make_unique(beast::severities::kError); diff --git a/src/test/consensus/DistributedValidatorsSim_test.cpp b/src/test/consensus/DistributedValidatorsSim_test.cpp index b430a63880..cd44318e4b 100644 --- a/src/test/consensus/DistributedValidatorsSim_test.cpp +++ b/src/test/consensus/DistributedValidatorsSim_test.cpp @@ -1,15 +1,24 @@ #include +#include +#include +#include +#include +#include +#include -#include - -#include -#include +#include #include +#include +#include #include +#include +#include +#include +#include #include #include -#include +#include namespace xrpl { namespace test { @@ -155,9 +164,9 @@ class DistributedValidators_test : public beast::unit_test::suite sim.run(1); // Run for 10 minutes, submitting 100 tx/second - std::chrono::nanoseconds simDuration = 10min; - std::chrono::nanoseconds quiet = 10s; - Rate rate{100, 1000ms}; + std::chrono::nanoseconds const simDuration = 10min; + std::chrono::nanoseconds const quiet = 10s; + Rate const rate{100, 1000ms}; // Initialize timers HeartbeatTimer heart(sim.scheduler); diff --git a/src/test/consensus/LedgerTiming_test.cpp b/src/test/consensus/LedgerTiming_test.cpp index 4441184af4..400fe620e7 100644 --- a/src/test/consensus/LedgerTiming_test.cpp +++ b/src/test/consensus/LedgerTiming_test.cpp @@ -1,6 +1,11 @@ -#include +#include +#include #include +#include +#include +#include + namespace xrpl { namespace test { @@ -66,7 +71,7 @@ class LedgerTiming_test : public beast::unit_test::suite using namespace std::chrono_literals; // A closeTime equal to the epoch is not modified using tp = NetClock::time_point; - tp def; + tp const def; BEAST_EXPECT(def == roundCloseTime(def, 30s)); // Otherwise, the closeTime is rounded to the nearest diff --git a/src/test/consensus/LedgerTrie_test.cpp b/src/test/consensus/LedgerTrie_test.cpp index 7fd8c71b64..9795c8d311 100644 --- a/src/test/consensus/LedgerTrie_test.cpp +++ b/src/test/consensus/LedgerTrie_test.cpp @@ -2,8 +2,10 @@ #include -#include +#include +#include +#include #include namespace xrpl { @@ -278,7 +280,7 @@ class LedgerTrie_test : public beast::unit_test::suite LedgerHistoryHelper h; BEAST_EXPECT(t.empty()); - Ledger genesis = h[""]; + Ledger const genesis = h[""]; t.insert(genesis); BEAST_EXPECT(!t.empty()); t.remove(genesis); @@ -344,7 +346,7 @@ class LedgerTrie_test : public beast::unit_test::suite using Seq = Ledger::Seq; // Empty { - LedgerTrie t; + LedgerTrie const t; BEAST_EXPECT(t.getPreferred(Seq{0}) == std::nullopt); BEAST_EXPECT(t.getPreferred(Seq{2}) == std::nullopt); } @@ -352,7 +354,7 @@ class LedgerTrie_test : public beast::unit_test::suite { LedgerTrie t; LedgerHistoryHelper h; - Ledger genesis = h[""]; + Ledger const genesis = h[""]; t.insert(genesis); // NOLINTNEXTLINE(bugprone-unchecked-optional-access) @@ -670,11 +672,11 @@ class LedgerTrie_test : public beast::unit_test::suite { // pick a random ledger history std::string curr; - char depth = depthDist(gen); + char const depth = depthDist(gen); char offset = 0; for (char d = 0; d < depth; ++d) { - char a = offset + widthDist(gen); + char const a = offset + widthDist(gen); curr += a; offset = (a + 1) * width; } diff --git a/src/test/consensus/NegativeUNL_test.cpp b/src/test/consensus/NegativeUNL_test.cpp index cf8c8e87ef..e634b04124 100644 --- a/src/test/consensus/NegativeUNL_test.cpp +++ b/src/test/consensus/NegativeUNL_test.cpp @@ -1,13 +1,41 @@ -#include + +#include #include #include #include -#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -261,7 +289,7 @@ class NegativeUNL_test : public beast::unit_test::suite { BEAST_EXPECT(l->validatorToDisable() == publicKeys[0]); //++ first ToDisable Tx in ledger's TxSet - uint256 txID = txDisable_0.getTransactionID(); + uint256 const txID = txDisable_0.getTransactionID(); BEAST_EXPECT(l->txExists(txID)); } } @@ -628,7 +656,7 @@ struct NetworkHistory walkHistoryAndAddValidations(NeedValidation&& needVal) { std::uint32_t curr = 0; - std::size_t need = 256 + 1; + std::size_t const need = 256 + 1; // only last 256 + 1 ledgers need validations if (history.size() > need) curr = history.size() - need; @@ -702,14 +730,14 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite testcase("Create UNLModify Tx"); jtx::Env env(*this); - NodeID myId(0xA0); + NodeID const myId(0xA0); NegativeUNLVote vote(myId, env.journal); // one add, one remove auto txSet = std::make_shared(SHAMapType::TRANSACTION, env.app().getNodeFamily()); - PublicKey toDisableKey(derivePublicKey(KeyType::ed25519, randomSecretKey())); - PublicKey toReEnableKey(derivePublicKey(KeyType::ed25519, randomSecretKey())); - LedgerIndex seq(1234); + PublicKey const toDisableKey(derivePublicKey(KeyType::ed25519, randomSecretKey())); + PublicKey const toReEnableKey(derivePublicKey(KeyType::ed25519, randomSecretKey())); + LedgerIndex const seq(1234); BEAST_EXPECT(countTx(txSet) == 0); vote.addTx(seq, toDisableKey, NegativeUNLVote::ToDisable, txSet); BEAST_EXPECT(countTx(txSet) == 1); @@ -723,16 +751,16 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite testPickOneCandidate() { testcase("Pick One Candidate"); - jtx::Env env(*this); + jtx::Env const env(*this); - NodeID myId(0xA0); - NegativeUNLVote vote(myId, env.journal); + NodeID const myId(0xA0); + NegativeUNLVote const vote(myId, env.journal); - uint256 pad_0(0); - uint256 pad_f = ~pad_0; - NodeID n_1(1); - NodeID n_2(2); - NodeID n_3(3); + uint256 const pad_0(0); + uint256 const pad_f = ~pad_0; + NodeID const n_1(1); + NodeID const n_2(2); + NodeID const n_3(3); std::vector candidates({n_1}); BEAST_EXPECT(vote.choose(pad_0, candidates) == n_1); BEAST_EXPECT(vote.choose(pad_f, candidates) == n_1); @@ -803,7 +831,7 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite // 5. local node had enough validations but on a wrong chain NetworkHistory history = {*this, {10, 0, false, false, 256 + 2}}; // We need two chains for these tests - bool wrongChainSuccess = history.goodHistory; + bool const wrongChainSuccess = history.goodHistory; BEAST_EXPECT(wrongChainSuccess); NetworkHistory::LedgerHistory wrongChain = std::move(history.history); // Create a new chain and use it as the one that majority of nodes @@ -814,7 +842,7 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite if (history.goodHistory && wrongChainSuccess) { NodeID myId = history.UNLNodeIDs[3]; - NodeID badNode = history.UNLNodeIDs[4]; + NodeID const badNode = history.UNLNodeIDs[4]; history.walkHistoryAndAddValidations( [&](std::shared_ptr const& l, std::size_t idx) -> bool { // everyone but me @@ -825,9 +853,9 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite // a node double validates for (auto& l : wrongChain) { - RCLValidation v1(history.createSTVal(l, myId)); + RCLValidation const v1(history.createSTVal(l, myId)); history.validations.add(myId, v1); - RCLValidation v2(history.createSTVal(l, badNode)); + RCLValidation const v2(history.createSTVal(l, badNode)); history.validations.add(badNode, v2); } @@ -909,8 +937,8 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite { auto [disableCandidates, reEnableCandidates] = vote.findAllCandidates(unl, negUnl, scoreTable); - bool rightDisable = disableCandidates.size() == numDisable; - bool rightReEnable = reEnableCandidates.size() == numReEnable; + bool const rightDisable = disableCandidates.size() == numDisable; + bool const rightReEnable = reEnableCandidates.size() == numReEnable; return rightDisable && rightReEnable; }; @@ -1009,9 +1037,9 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite { // 2 new validators - NodeID new_1(0xbead); - NodeID new_2(0xbeef); - hash_set nowTrusted = {new_1, new_2}; + NodeID const new_1(0xbead); + NodeID const new_2(0xbeef); + hash_set const nowTrusted = {new_1, new_2}; hash_set UNL_temp = history.UNLNodeIDSet; UNL_temp.insert(new_1); UNL_temp.insert(new_2); @@ -1065,13 +1093,13 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite * negativeUNLMinLocalValsToVote */ - jtx::Env env(*this); + jtx::Env const env(*this); - NodeID myId(0xA0); + NodeID const myId(0xA0); NegativeUNLVote vote(myId, env.journal); - std::array unlSizes = {34, 35, 80}; - std::array nUnlPercent = {0, 50, 100}; + std::array const unlSizes = {34, 35, 80}; + std::array const nUnlPercent = {0, 50, 100}; std::array scores = { 0, NegativeUNLVote::negativeUNLLowWaterMark - 1, @@ -1091,7 +1119,7 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite hash_set& negUnl, hash_map& scoreTable) { std::vector nodeIDs; - std::vector keys = createPublicKeys(unl_size); + std::vector const keys = createPublicKeys(unl_size); for (auto const& k : keys) { nodeIDs.emplace_back(calcNodeID(k)); @@ -1153,7 +1181,7 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite hash_set& negUnl, hash_map& scoreTable) { std::vector nodeIDs; - std::vector keys = createPublicKeys(unl_size); + std::vector const keys = createPublicKeys(unl_size); for (auto const& k : keys) { nodeIDs.emplace_back(calcNodeID(k)); @@ -1221,9 +1249,9 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite testNewValidators() { testcase("New Validators"); - jtx::Env env(*this); + jtx::Env const env(*this); - NodeID myId(0xA0); + NodeID const myId(0xA0); NegativeUNLVote vote(myId, env.journal); // test cases: @@ -1232,9 +1260,9 @@ class NegativeUNLVoteInternal_test : public beast::unit_test::suite // add a new one and some already added // purge and see some are expired - NodeID n1(0xA1); - NodeID n2(0xA2); - NodeID n3(0xA3); + NodeID const n1(0xA1); + NodeID const n2(0xA2); + NodeID const n3(0xA3); vote.newValidators(2, {n1}); BEAST_EXPECT(vote.newValidators_.size() == 1); @@ -1301,7 +1329,7 @@ class NegativeUNLVoteScoreTable_test : public beast::unit_test::suite * -- unl size: 10, 34, 35, 50 * -- score pattern: all 0, all 50%, all 100%, two 0% two 50% rest 100% */ - std::array unlSizes = {10, 34, 35, 50}; + std::array const unlSizes = {10, 34, 35, 50}; std::array, 4> scorePattern = { {{{0, 0, 0}}, {{50, 50, 50}}, {{100, 100, 100}}, {{0, 50, 100}}}}; @@ -1330,9 +1358,9 @@ class NegativeUNLVoteScoreTable_test : public beast::unit_test::suite k = 2; } - bool add_50 = scorePattern[sp][k] == 50 && l->seq() % 2 == 0; - bool add_100 = scorePattern[sp][k] == 100; - bool add_me = history.UNLNodeIDs[idx] == myId; + bool const add_50 = scorePattern[sp][k] == 50 && l->seq() % 2 == 0; + bool const add_100 = scorePattern[sp][k] == 100; + bool const add_me = history.UNLNodeIDs[idx] == myId; return add_50 || add_100 || add_me; }); @@ -1698,8 +1726,8 @@ class NegativeUNLVoteFilterValidations_test : public beast::unit_test::suite }; // create keys and validations - std::uint32_t numNodes = 10; - std::uint32_t negUnlSize = 3; + std::uint32_t const numNodes = 10; + std::uint32_t const negUnlSize = 3; std::vector cfgKeys; hash_set activeValidators; hash_set nUnlKeys; @@ -1719,7 +1747,7 @@ class NegativeUNLVoteFilterValidations_test : public beast::unit_test::suite // setup the ValidatorList auto& validators = env.app().getValidators(); auto& local = *nUnlKeys.begin(); - std::vector cfgPublishers; + std::vector const cfgPublishers; validators.load(local, cfgKeys, cfgPublishers); validators.updateTrusted( activeValidators, @@ -1765,9 +1793,9 @@ negUnlSizeTest( bool hasToDisable, bool hasToReEnable) { - bool sameSize = l->negativeUNL().size() == size; - bool sameToDisable = (l->validatorToDisable() != std::nullopt) == hasToDisable; - bool sameToReEnable = (l->validatorToReEnable() != std::nullopt) == hasToReEnable; + bool const sameSize = l->negativeUNL().size() == size; + bool const sameToDisable = (l->validatorToDisable() != std::nullopt) == hasToDisable; + bool const sameToReEnable = (l->validatorToReEnable() != std::nullopt) == hasToReEnable; return sameSize && sameToDisable && sameToReEnable; } @@ -1809,7 +1837,7 @@ VerifyPubKeyAndSeq( auto s = makeSlice(d); if (!publicKeyType(s)) return false; - PublicKey pk(s); + PublicKey const pk(s); auto it = nUnlLedgerSeq.find(pk); if (it == nUnlLedgerSeq.end()) return false; @@ -1835,13 +1863,13 @@ std::vector createPublicKeys(std::size_t n) { std::vector keys; - std::size_t ss = 33; + std::size_t const ss = 33; std::vector data(ss, 0); data[0] = 0xED; for (int i = 0; i < n; ++i) { data[1]++; - Slice s(data.data(), ss); + Slice const s(data.data(), ss); keys.emplace_back(s); } return keys; diff --git a/src/test/consensus/RCLCensorshipDetector_test.cpp b/src/test/consensus/RCLCensorshipDetector_test.cpp index 4093ffe900..aeb93b5ad9 100644 --- a/src/test/consensus/RCLCensorshipDetector_test.cpp +++ b/src/test/consensus/RCLCensorshipDetector_test.cpp @@ -1,8 +1,9 @@ #include -#include +#include #include +#include #include namespace xrpl { diff --git a/src/test/consensus/ScaleFreeSim_test.cpp b/src/test/consensus/ScaleFreeSim_test.cpp index 2c8014d8e8..2120431791 100644 --- a/src/test/consensus/ScaleFreeSim_test.cpp +++ b/src/test/consensus/ScaleFreeSim_test.cpp @@ -1,9 +1,19 @@ #include +#include +#include +#include #include +#include +#include -#include +#include -#include +#include + +#include +#include +#include +#include namespace xrpl { namespace test { diff --git a/src/test/consensus/Validations_test.cpp b/src/test/consensus/Validations_test.cpp index dc6dfe539c..9318122dbd 100644 --- a/src/test/consensus/Validations_test.cpp +++ b/src/test/consensus/Validations_test.cpp @@ -1,12 +1,22 @@ #include +#include #include #include +#include +#include #include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include #include namespace xrpl { @@ -233,12 +243,12 @@ class Validations_test : public beast::unit_test::suite testcase("Add validation"); LedgerHistoryHelper h; - Ledger ledgerA = h["a"]; + Ledger const ledgerA = h["a"]; Ledger ledgerAB = h["ab"]; Ledger ledgerAZ = h["az"]; Ledger ledgerABC = h["abc"]; - Ledger ledgerABCD = h["abcd"]; - Ledger ledgerABCDE = h["abcde"]; + Ledger const ledgerABCD = h["abcd"]; + Ledger const ledgerABCDE = h["abcde"]; { TestHarness harness(h.oracle); @@ -296,7 +306,7 @@ class Validations_test : public beast::unit_test::suite // Process validations out of order with shifted times TestHarness harness(h.oracle); - Node n = harness.makeNode(); + Node const n = harness.makeNode(); // Establish a new current validation BEAST_EXPECT(ValStatus::current == harness.add(n.validate(ledgerA))); @@ -312,7 +322,7 @@ class Validations_test : public beast::unit_test::suite { // Test stale on arrival validations TestHarness harness(h.oracle); - Node n = harness.makeNode(); + Node const n = harness.makeNode(); BEAST_EXPECT( ValStatus::stale == @@ -364,11 +374,11 @@ class Validations_test : public beast::unit_test::suite LedgerHistoryHelper h; Ledger ledgerA = h["a"]; - Ledger ledgerAB = h["ab"]; + Ledger const ledgerAB = h["ab"]; using Trigger = std::function; - std::vector triggers = { + std::vector const triggers = { [&](TestValidations& vals) { vals.currentTrusted(); }, [&](TestValidations& vals) { vals.getCurrentNodeIDs(); }, [&](TestValidations& vals) { vals.getPreferred(genesisLedger); }, @@ -376,7 +386,7 @@ class Validations_test : public beast::unit_test::suite for (Trigger const& trigger : triggers) { TestHarness harness(h.oracle); - Node n = harness.makeNode(); + Node const n = harness.makeNode(); BEAST_EXPECT(ValStatus::current == harness.add(n.validate(ledgerAB))); trigger(harness.vals()); @@ -405,39 +415,41 @@ class Validations_test : public beast::unit_test::suite testcase("Get nodes after"); LedgerHistoryHelper h; - Ledger ledgerA = h["a"]; - Ledger ledgerAB = h["ab"]; - Ledger ledgerABC = h["abc"]; - Ledger ledgerAD = h["ad"]; + Ledger const ledgerA = h["a"]; + Ledger const ledgerAB = h["ab"]; + Ledger const ledgerABC = h["abc"]; + Ledger const ledgerAD = h["ad"]; TestHarness harness(h.oracle); - Node a = harness.makeNode(), b = harness.makeNode(), c = harness.makeNode(), - d = harness.makeNode(); - c.untrust(); + Node const trustedNode1 = harness.makeNode(); + Node const trustedNode2 = harness.makeNode(); + Node const trustedNode3 = harness.makeNode(); + + Node notTrustedNode = harness.makeNode(); + notTrustedNode.untrust(); // first round a,b,c agree, d has is partial - BEAST_EXPECT(ValStatus::current == harness.add(a.validate(ledgerA))); - BEAST_EXPECT(ValStatus::current == harness.add(b.validate(ledgerA))); - BEAST_EXPECT(ValStatus::current == harness.add(c.validate(ledgerA))); - BEAST_EXPECT(ValStatus::current == harness.add(d.partial(ledgerA))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode1.validate(ledgerA))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode2.validate(ledgerA))); + BEAST_EXPECT(ValStatus::current == harness.add(notTrustedNode.validate(ledgerA))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode3.partial(ledgerA))); for (Ledger const& ledger : {ledgerA, ledgerAB, ledgerABC, ledgerAD}) BEAST_EXPECT(harness.vals().getNodesAfter(ledger, ledger.id()) == 0); harness.clock().advance(5s); - BEAST_EXPECT(ValStatus::current == harness.add(a.validate(ledgerAB))); - BEAST_EXPECT(ValStatus::current == harness.add(b.validate(ledgerABC))); - BEAST_EXPECT(ValStatus::current == harness.add(c.validate(ledgerAB))); - BEAST_EXPECT(ValStatus::current == harness.add(d.partial(ledgerABC))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode1.validate(ledgerAB))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode2.validate(ledgerABC))); + BEAST_EXPECT(ValStatus::current == harness.add(notTrustedNode.validate(ledgerAB))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode3.partial(ledgerABC))); BEAST_EXPECT(harness.vals().getNodesAfter(ledgerA, ledgerA.id()) == 3); BEAST_EXPECT(harness.vals().getNodesAfter(ledgerAB, ledgerAB.id()) == 2); BEAST_EXPECT(harness.vals().getNodesAfter(ledgerABC, ledgerABC.id()) == 0); BEAST_EXPECT(harness.vals().getNodesAfter(ledgerAD, ledgerAD.id()) == 0); - // If given a ledger inconsistent with the id, is still able to check - // using slower method + // If given a ledger inconsistent with the id, is still able to check using slower method BEAST_EXPECT(harness.vals().getNodesAfter(ledgerAD, ledgerA.id()) == 1); BEAST_EXPECT(harness.vals().getNodesAfter(ledgerAD, ledgerAB.id()) == 2); } @@ -449,12 +461,13 @@ class Validations_test : public beast::unit_test::suite testcase("Current trusted validations"); LedgerHistoryHelper h; - Ledger ledgerA = h["a"]; - Ledger ledgerB = h["b"]; - Ledger ledgerAC = h["ac"]; + Ledger const ledgerA = h["a"]; + Ledger const ledgerB = h["b"]; + Ledger const ledgerAC = h["ac"]; TestHarness harness(h.oracle); - Node a = harness.makeNode(), b = harness.makeNode(); + Node const a = harness.makeNode(); + Node b = harness.makeNode(); b.untrust(); BEAST_EXPECT(ValStatus::current == harness.add(a.validate(ledgerA))); @@ -487,8 +500,8 @@ class Validations_test : public beast::unit_test::suite testcase("Current public keys"); LedgerHistoryHelper h; - Ledger ledgerA = h["a"]; - Ledger ledgerAC = h["ac"]; + Ledger const ledgerA = h["a"]; + Ledger const ledgerAC = h["ac"]; TestHarness harness(h.oracle); Node a = harness.makeNode(), b = harness.makeNode(); @@ -567,7 +580,7 @@ class Validations_test : public beast::unit_test::suite sorted(harness.vals().getTrustedForLedger(id, seq)) == sorted(expectedValidations)); - std::uint32_t baseFee = 0; + std::uint32_t const baseFee = 0; std::vector expectedFees; expectedFees.reserve(expectedValidations.size()); for (auto const& val : expectedValidations) @@ -580,9 +593,9 @@ class Validations_test : public beast::unit_test::suite }; //---------------------------------------------------------------------- - Ledger ledgerA = h["a"]; - Ledger ledgerB = h["b"]; - Ledger ledgerAC = h["ac"]; + Ledger const ledgerA = h["a"]; + Ledger const ledgerB = h["b"]; + Ledger const ledgerAC = h["ac"]; // Add a dummy ID to cover unknown ledger identifiers trustedValidations[{Ledger::ID{100}, Ledger::Seq{100}}] = {}; @@ -689,14 +702,16 @@ class Validations_test : public beast::unit_test::suite LedgerHistoryHelper h; TestHarness harness(h.oracle); - Node a = harness.makeNode(), b = harness.makeNode(), c = harness.makeNode(); - c.untrust(); + Node const trustedNode1 = harness.makeNode(); + Node const trustedNode2 = harness.makeNode(); + Node notTrustedNode = harness.makeNode(); + notTrustedNode.untrust(); - Ledger ledgerA = h["a"]; - Ledger ledgerAB = h["ab"]; + Ledger const ledgerA = h["a"]; + Ledger const ledgerAB = h["ab"]; hash_map expected; - for (auto const& node : {a, b, c}) + for (auto const& node : {trustedNode1, trustedNode2, notTrustedNode}) { auto const val = node.validate(ledgerA); BEAST_EXPECT(ValStatus::current == harness.add(val)); @@ -706,9 +721,9 @@ class Validations_test : public beast::unit_test::suite // Send in a new validation for a, saving the new one into the expected // map after setting the proper prior ledger ID it replaced harness.clock().advance(1s); - auto newVal = a.validate(ledgerAB); + auto newVal = trustedNode1.validate(ledgerAB); BEAST_EXPECT(ValStatus::current == harness.add(newVal)); - expected.find(a.nodeID())->second = newVal; + expected.find(trustedNode1.nodeID())->second = newVal; } void @@ -719,14 +734,17 @@ class Validations_test : public beast::unit_test::suite LedgerHistoryHelper h; TestHarness harness(h.oracle); - Node a = harness.makeNode(), b = harness.makeNode(), c = harness.makeNode(), - d = harness.makeNode(); - c.untrust(); + Node const trustedNode1 = harness.makeNode(); + Node const trustedNode2 = harness.makeNode(); + Node const trustedNode3 = harness.makeNode(); - Ledger ledgerA = h["a"]; - Ledger ledgerB = h["b"]; - Ledger ledgerAC = h["ac"]; - Ledger ledgerACD = h["acd"]; + Node notTrustedNode = harness.makeNode(); + notTrustedNode.untrust(); + + Ledger const ledgerA = h["a"]; + Ledger const ledgerB = h["b"]; + Ledger const ledgerAC = h["ac"]; + Ledger const ledgerACD = h["acd"]; using Seq = Ledger::Seq; @@ -736,7 +754,7 @@ class Validations_test : public beast::unit_test::suite BEAST_EXPECT(harness.vals().getPreferred(ledgerA) == std::nullopt); // Single ledger - BEAST_EXPECT(ValStatus::current == harness.add(a.validate(ledgerB))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode1.validate(ledgerB))); BEAST_EXPECT(harness.vals().getPreferred(ledgerA) == pref(ledgerB)); BEAST_EXPECT(harness.vals().getPreferred(ledgerB) == pref(ledgerB)); @@ -745,21 +763,21 @@ class Validations_test : public beast::unit_test::suite // Untrusted doesn't impact preferred ledger // (ledgerB has tie-break over ledgerA) - BEAST_EXPECT(ValStatus::current == harness.add(b.validate(ledgerA))); - BEAST_EXPECT(ValStatus::current == harness.add(c.validate(ledgerA))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode2.validate(ledgerA))); + BEAST_EXPECT(ValStatus::current == harness.add(notTrustedNode.validate(ledgerA))); BEAST_EXPECT(ledgerB.id() > ledgerA.id()); BEAST_EXPECT(harness.vals().getPreferred(ledgerA) == pref(ledgerB)); BEAST_EXPECT(harness.vals().getPreferred(ledgerB) == pref(ledgerB)); // Partial does break ties - BEAST_EXPECT(ValStatus::current == harness.add(d.partial(ledgerA))); + BEAST_EXPECT(ValStatus::current == harness.add(trustedNode3.partial(ledgerA))); BEAST_EXPECT(harness.vals().getPreferred(ledgerA) == pref(ledgerA)); BEAST_EXPECT(harness.vals().getPreferred(ledgerB) == pref(ledgerA)); harness.clock().advance(5s); // Parent of preferred-> stick with ledger - for (auto const& node : {a, b, c, d}) + for (auto const& node : {trustedNode1, trustedNode2, notTrustedNode, trustedNode3}) BEAST_EXPECT(ValStatus::current == harness.add(node.validate(ledgerAC))); // Parent of preferred stays put BEAST_EXPECT(harness.vals().getPreferred(ledgerA) == pref(ledgerA)); @@ -770,7 +788,7 @@ class Validations_test : public beast::unit_test::suite // Any later grandchild or different chain is preferred harness.clock().advance(5s); - for (auto const& node : {a, b, c, d}) + for (auto const& node : {trustedNode1, trustedNode2, notTrustedNode, trustedNode3}) BEAST_EXPECT(ValStatus::current == harness.add(node.validate(ledgerACD))); for (auto const& ledger : {ledgerA, ledgerB, ledgerACD}) BEAST_EXPECT(harness.vals().getPreferred(ledger) == pref(ledgerACD)); @@ -784,11 +802,11 @@ class Validations_test : public beast::unit_test::suite LedgerHistoryHelper h; TestHarness harness(h.oracle); - Node a = harness.makeNode(); + Node const a = harness.makeNode(); - Ledger ledgerA = h["a"]; - Ledger ledgerB = h["b"]; - Ledger ledgerC = h["c"]; + Ledger const ledgerA = h["a"]; + Ledger const ledgerB = h["b"]; + Ledger const ledgerC = h["c"]; using ID = Ledger::ID; using Seq = Ledger::Seq; @@ -830,14 +848,14 @@ class Validations_test : public beast::unit_test::suite LedgerHistoryHelper h; TestHarness harness(h.oracle); - Node a = harness.makeNode(); - Node b = harness.makeNode(); + Node const a = harness.makeNode(); + Node const b = harness.makeNode(); using ID = Ledger::ID; using Seq = Ledger::Seq; // Validate the ledger before it is actually available - Validation val = a.validate(ID{2}, Seq{2}, 0s, 0s, true); + Validation const val = a.validate(ID{2}, Seq{2}, 0s, 0s, true); BEAST_EXPECT(ValStatus::current == harness.add(val)); // Validation is available @@ -854,13 +872,13 @@ class Validations_test : public beast::unit_test::suite BEAST_EXPECT(harness.vals().getPreferred(genesisLedger) == std::make_pair(Seq{2}, ID{3})); // Create the ledger - Ledger ledgerAB = h["ab"]; + Ledger const ledgerAB = h["ab"]; // Now it should be available BEAST_EXPECT(harness.vals().getNodesAfter(genesisLedger, ID{0}) == 1); // Create a validation that is not available harness.clock().advance(5s); - Validation val2 = a.validate(ID{4}, Seq{4}, 0s, 0s, true); + Validation const val2 = a.validate(ID{4}, Seq{4}, 0s, 0s, true); BEAST_EXPECT(ValStatus::current == harness.add(val2)); BEAST_EXPECT(harness.vals().numTrustedForLedger(ID{4}) == 1); BEAST_EXPECT( @@ -868,7 +886,7 @@ class Validations_test : public beast::unit_test::suite std::make_pair(ledgerAB.seq(), ledgerAB.id())); // Another node requesting that ledger still doesn't change things - Validation val3 = b.validate(ID{4}, Seq{4}, 0s, 0s, true); + Validation const val3 = b.validate(ID{4}, Seq{4}, 0s, 0s, true); BEAST_EXPECT(ValStatus::current == harness.add(val3)); BEAST_EXPECT(harness.vals().numTrustedForLedger(ID{4}) == 2); BEAST_EXPECT( @@ -877,7 +895,7 @@ class Validations_test : public beast::unit_test::suite // Switch to validation that is available harness.clock().advance(5s); - Ledger ledgerABCDE = h["abcde"]; + Ledger const ledgerABCDE = h["abcde"]; BEAST_EXPECT(ValStatus::current == harness.add(a.partial(ledgerABCDE))); BEAST_EXPECT(ValStatus::current == harness.add(b.partial(ledgerABCDE))); BEAST_EXPECT( @@ -891,9 +909,9 @@ class Validations_test : public beast::unit_test::suite testcase("NumTrustedForLedger"); LedgerHistoryHelper h; TestHarness harness(h.oracle); - Node a = harness.makeNode(); - Node b = harness.makeNode(); - Ledger ledgerA = h["a"]; + Node const a = harness.makeNode(); + Node const b = harness.makeNode(); + Ledger const ledgerA = h["a"]; BEAST_EXPECT(ValStatus::current == harness.add(a.partial(ledgerA))); BEAST_EXPECT(harness.vals().numTrustedForLedger(ledgerA.id()) == 0); @@ -912,7 +930,7 @@ class Validations_test : public beast::unit_test::suite beast::manual_clock clock; SeqEnforcer enforcer; - ValidationParms p; + ValidationParms const p; BEAST_EXPECT(enforcer(clock.now(), Seq{1}, p)); BEAST_EXPECT(enforcer(clock.now(), Seq{10}, p)); @@ -934,9 +952,9 @@ class Validations_test : public beast::unit_test::suite TestValidations& vals, hash_set const& listed, std::vector const& trustedVals) { - Ledger::ID testID = + Ledger::ID const testID = trustedVals.empty() ? this->genesisLedger.id() : trustedVals[0].ledgerID(); - Ledger::Seq testSeq = + Ledger::Seq const testSeq = trustedVals.empty() ? this->genesisLedger.seq() : trustedVals[0].seq(); BEAST_EXPECT(vals.currentTrusted() == trustedVals); BEAST_EXPECT(vals.getCurrentNodeIDs() == listed); @@ -958,12 +976,12 @@ class Validations_test : public beast::unit_test::suite // Trusted to untrusted LedgerHistoryHelper h; TestHarness harness(h.oracle); - Node a = harness.makeNode(); - Ledger ledgerAB = h["ab"]; - Validation v = a.validate(ledgerAB); + Node const a = harness.makeNode(); + Ledger const ledgerAB = h["ab"]; + Validation const v = a.validate(ledgerAB); BEAST_EXPECT(ValStatus::current == harness.add(v)); - hash_set listed({a.nodeID()}); + hash_set const listed({a.nodeID()}); std::vector trustedVals({v}); checker(harness.vals(), listed, trustedVals); @@ -978,11 +996,11 @@ class Validations_test : public beast::unit_test::suite TestHarness harness(h.oracle); Node a = harness.makeNode(); a.untrust(); - Ledger ledgerAB = h["ab"]; - Validation v = a.validate(ledgerAB); + Ledger const ledgerAB = h["ab"]; + Validation const v = a.validate(ledgerAB); BEAST_EXPECT(ValStatus::current == harness.add(v)); - hash_set listed({a.nodeID()}); + hash_set const listed({a.nodeID()}); std::vector trustedVals; checker(harness.vals(), listed, trustedVals); @@ -995,11 +1013,11 @@ class Validations_test : public beast::unit_test::suite // Trusted but not acquired -> untrusted LedgerHistoryHelper h; TestHarness harness(h.oracle); - Node a = harness.makeNode(); - Validation v = a.validate(Ledger::ID{2}, Ledger::Seq{2}, 0s, 0s, true); + Node const a = harness.makeNode(); + Validation const v = a.validate(Ledger::ID{2}, Ledger::Seq{2}, 0s, 0s, true); BEAST_EXPECT(ValStatus::current == harness.add(v)); - hash_set listed({a.nodeID()}); + hash_set const listed({a.nodeID()}); std::vector trustedVals({v}); auto& vals = harness.vals(); BEAST_EXPECT(vals.currentTrusted() == trustedVals); diff --git a/src/test/core/ClosureCounter_test.cpp b/src/test/core/ClosureCounter_test.cpp index 088b7b9ff9..ea8458b3aa 100644 --- a/src/test/core/ClosureCounter_test.cpp +++ b/src/test/core/ClosureCounter_test.cpp @@ -1,11 +1,14 @@ #include +#include -#include +#include +#include #include #include -#include +#include #include +#include namespace xrpl { namespace test { diff --git a/src/test/core/Config_test.cpp b/src/test/core/Config_test.cpp index edcb67b767..824ab3d511 100644 --- a/src/test/core/Config_test.cpp +++ b/src/test/core/Config_test.cpp @@ -4,15 +4,31 @@ #include #include +#include #include #include #include -#include -#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace detail { @@ -81,7 +97,7 @@ time.apple.com time.nist.gov pool.ntp.org -# Where to find some other servers speaking the Ripple protocol. +# Where to find some other servers speaking the XRPL protocol. # [ips] r.ripple.com 51235 @@ -107,7 +123,7 @@ backend=sqlite } /** - Write a xrpld config file and remove when done. + Write an xrpld config file and remove when done. */ class FileCfgGuard : public xrpl::detail::FileDirGuard { @@ -268,7 +284,7 @@ public: Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [server] port_rpc port_peer @@ -297,15 +313,15 @@ port_wss_admin auto const cwd = current_path(); // Test both config file names. - char const* configFiles[] = {Config::configFileName, Config::configLegacyName}; + std::string_view const configFiles[] = {Config::configFileName, Config::configLegacyName}; // Config file in current directory. for (auto const& configFile : configFiles) { // Use a temporary directory for testing. - beast::temp_dir td; + beast::temp_dir const td; current_path(td.path()); - path const f = td.file(configFile); + path const f = td.file(std::string{configFile}); std::ofstream o(f.string()); o << detail::configContents("", ""); o.close(); @@ -325,13 +341,13 @@ port_wss_admin { // Point the current working directory to a temporary directory, so // we don't pick up an actual config file from the repository root. - beast::temp_dir td; + beast::temp_dir const td; current_path(td.path()); // The XDG config directory is set: the config file must be in a // subdirectory named after the system. { - beast::temp_dir tc; + beast::temp_dir const tc; // Set the HOME and XDG_CONFIG_HOME environment variables. The // HOME variable is not used when XDG_CONFIG_HOME is set, but @@ -344,7 +360,7 @@ port_wss_admin // Create the config file in '${XDG_CONFIG_HOME}/[systemName]'. path p = tc.file(systemName()); create_directory(p); - p = tc.file(systemName() + "/" + configFile); + p = tc.file(systemName() + "/" + std::string{configFile}); std::ofstream o(p.string()); o << detail::configContents("", ""); o.close(); @@ -365,7 +381,7 @@ port_wss_admin // The XDG config directory is not set: the config file must be in a // subdirectory named .config followed by the system name. { - beast::temp_dir tc; + beast::temp_dir const tc; // Set only the HOME environment variable. char const* h = getenv("HOME"); @@ -380,7 +396,7 @@ port_wss_admin s += "/" + systemName(); p = tc.file(s); create_directory(p); - p = tc.file(s + "/" + configFile); + p = tc.file(s + "/" + std::string{configFile}); std::ofstream o(p.string()); o << detail::configContents("", ""); o.close(); @@ -507,7 +523,7 @@ port_wss_admin { c.loadFromString(boost::str(configTemplate % validationSeed % token)); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -528,7 +544,7 @@ port_wss_admin main )xrpldConfig"); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -541,7 +557,7 @@ main c.loadFromString(R"xrpldConfig( )xrpldConfig"); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -556,7 +572,7 @@ main 255 )xrpldConfig"); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -571,7 +587,7 @@ main 10000 )xrpldConfig"); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -598,7 +614,7 @@ main Config c; c.loadFromString(boost::str(cc % missingPath)); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -617,7 +633,7 @@ main Config c; c.loadFromString(boost::str(cc % invalidFile.string())); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -626,7 +642,7 @@ main { // load validators from config into single section Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [validators] n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7 n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj @@ -644,7 +660,7 @@ nHBu9PTL9dn2GuZtdW4U2WzBwffyX9qsQCd9CNU4Z5YG3PQfViM8 { // load validator list sites and keys from config Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [validator_list_sites] xrpl-validators.com trust-these-validators.gov @@ -674,7 +690,7 @@ trust-these-validators.gov { // load validator list sites and keys from config Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [validator_list_sites] xrpl-validators.com trust-these-validators.gov @@ -705,7 +721,7 @@ trust-these-validators.gov // load should throw if [validator_list_threshold] is greater than // the number of [validator_list_keys] Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [validator_list_sites] xrpl-validators.com trust-these-validators.gov @@ -725,7 +741,7 @@ trust-these-validators.gov c.loadFromString(toLoad); fail(); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -734,7 +750,7 @@ trust-these-validators.gov { // load should throw if [validator_list_threshold] is malformed Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [validator_list_sites] xrpl-validators.com trust-these-validators.gov @@ -754,7 +770,7 @@ value = 2 c.loadFromString(toLoad); fail(); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -763,7 +779,7 @@ value = 2 { // load should throw if [validator_list_threshold] is negative Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [validator_list_sites] xrpl-validators.com trust-these-validators.gov @@ -790,7 +806,7 @@ trust-these-validators.gov // load should throw if [validator_list_sites] is configured but // [validator_list_keys] is not Config c; - std::string toLoad(R"xrpldConfig( + std::string const toLoad(R"xrpldConfig( [validator_list_sites] xrpl-validators.com trust-these-validators.gov @@ -802,7 +818,7 @@ trust-these-validators.gov c.loadFromString(toLoad); fail(); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -948,7 +964,7 @@ trust-these-validators.gov c.loadFromString(boost::str(cc % vtg.validatorsFile())); fail(); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -958,7 +974,7 @@ trust-these-validators.gov // load should throw if [validators], [validator_keys] and // [validator_list_keys] are missing from xrpld.cfg and // validators file - Config c; + Config const c; boost::format cc("[validators_file]\n%1%\n"); std::string error; detail::ValidatorsTxtGuard const vtg(*this, "test_cfg", "validators.cfg"); @@ -968,13 +984,13 @@ trust-these-validators.gov "[validators], [validator_keys] or [validator_list_keys] " "section: " + vtg.validatorsFile(); - std::ofstream o(vtg.validatorsFile()); + std::ofstream const o(vtg.validatorsFile()); try { Config c2; c2.loadFromString(boost::str(cc % vtg.validatorsFile())); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -1141,7 +1157,7 @@ trust-these-validators.gov Config cfg; /* NOTE: this string includes some explicit * space chars in order to verify proper trimming */ - std::string toLoad( + std::string const toLoad( R"( [port_rpc])" "\x20" @@ -1182,7 +1198,7 @@ r.ripple.com 51235 Config cfg; /* NOTE: this string includes some explicit * space chars in order to verify proper trimming */ - std::string toLoad( + std::string const toLoad( R"( [port_rpc])" "\x20" @@ -1261,7 +1277,7 @@ r.ripple.com:51235 bool had_comment; }; - std::array tests = { + std::array const tests = { {{"password = aaaa\\#bbbb", "password", "aaaa#bbbb", false}, {"password = aaaa#bbbb", "password", "aaaa", true}, {"password = aaaa #bbbb", "password", "aaaa", true}, @@ -1419,7 +1435,7 @@ r.ripple.com:51235 bool shouldPass; }; - std::vector units = { + std::vector const units = { {"seconds", 1, 15 * 60, false}, {"minutes", 60, 14, false}, {"minutes", 60, 15, true}, @@ -1451,7 +1467,7 @@ r.ripple.com:51235 fail(); } } - catch (std::runtime_error&) + catch (std::runtime_error const&) { if (!shouldPass) { @@ -1477,7 +1493,7 @@ r.ripple.com:51235 c.loadFromString("[overlay]\nmax_unknown_time=" + value); return c.MAX_UNKNOWN_TIME; } - catch (std::runtime_error&) + catch (std::runtime_error const&) { return {}; } @@ -1511,7 +1527,7 @@ r.ripple.com:51235 c.loadFromString("[overlay]\nmax_diverged_time=" + value); return c.MAX_DIVERGED_TIME; } - catch (std::runtime_error&) + catch (std::runtime_error const&) { return {}; } diff --git a/src/test/core/Coroutine_test.cpp b/src/test/core/Coroutine_test.cpp index 73dc3c2f8f..952ea073de 100644 --- a/src/test/core/Coroutine_test.cpp +++ b/src/test/core/Coroutine_test.cpp @@ -1,8 +1,18 @@ -#include +#include +#include + +#include + +#include +#include +#include #include +#include #include +#include +#include #include namespace xrpl { @@ -34,7 +44,7 @@ public: void signal() { - std::lock_guard lk(mutex_); + std::lock_guard const lk(mutex_); signaled_ = true; cv_.notify_all(); } diff --git a/src/test/core/JobQueue_test.cpp b/src/test/core/JobQueue_test.cpp index 13142c299f..eac8b17239 100644 --- a/src/test/core/JobQueue_test.cpp +++ b/src/test/core/JobQueue_test.cpp @@ -1,8 +1,12 @@ #include -#include +#include +#include #include +#include +#include + namespace xrpl { namespace test { diff --git a/src/test/core/SociDB_test.cpp b/src/test/core/SociDB_test.cpp index 66b368176d..a3f8376901 100644 --- a/src/test/core/SociDB_test.cpp +++ b/src/test/core/SociDB_test.cpp @@ -2,10 +2,28 @@ #include #include +#include #include -#include -#include +#include +#include +#include +#include + +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { class SociDB_test final : public TestSuite @@ -87,7 +105,7 @@ public: for (auto const& i : d) { - DBConfig sc(c, i.first); + DBConfig const sc(c, i.first); BEAST_EXPECT(boost::ends_with(sc.connectionString(), i.first + i.second)); } } @@ -97,7 +115,7 @@ public: testcase("open"); BasicConfig c; setupSQLiteConfig(c, getDatabasePath()); - DBConfig sc(c, "SociTestDB"); + DBConfig const sc(c, "SociTestDB"); std::vector const stringData({"String1", "String2", "String3"}); std::vector const intData({1, 2, 3}); auto checkValues = [this, &stringData, &intData](soci::session& s) { @@ -142,7 +160,7 @@ public: { namespace bfs = boost::filesystem; // Remove the database - bfs::path dbPath(sc.connectionString()); + bfs::path const dbPath(sc.connectionString()); if (bfs::is_regular_file(dbPath)) bfs::remove(dbPath); } @@ -154,7 +172,7 @@ public: testcase("select"); BasicConfig c; setupSQLiteConfig(c, getDatabasePath()); - DBConfig sc(c, "SociTestDB"); + DBConfig const sc(c, "SociTestDB"); std::vector const ubid( {(std::uint64_t)std::numeric_limits::max(), 20, 30}); std::vector const bid({-10, -20, -30}); @@ -272,7 +290,7 @@ public: { namespace bfs = boost::filesystem; // Remove the database - bfs::path dbPath(sc.connectionString()); + bfs::path const dbPath(sc.connectionString()); if (bfs::is_regular_file(dbPath)) bfs::remove(dbPath); } @@ -283,11 +301,12 @@ public: testcase("deleteWithSubselect"); BasicConfig c; setupSQLiteConfig(c, getDatabasePath()); - DBConfig sc(c, "SociTestDB"); + DBConfig const sc(c, "SociTestDB"); { soci::session s; sc.open(s); - char const* dbInit[] = { + + std::string_view const dbInit[] = { "BEGIN TRANSACTION;", "CREATE TABLE Ledgers ( \ LedgerHash CHARACTER(64) PRIMARY KEY, \ @@ -323,7 +342,7 @@ public: } namespace bfs = boost::filesystem; // Remove the database - bfs::path dbPath(sc.connectionString()); + bfs::path const dbPath(sc.connectionString()); if (bfs::is_regular_file(dbPath)) bfs::remove(dbPath); } diff --git a/src/test/core/Workers_test.cpp b/src/test/core/Workers_test.cpp index 65245b8c94..84ff85f4ec 100644 --- a/src/test/core/Workers_test.cpp +++ b/src/test/core/Workers_test.cpp @@ -1,4 +1,5 @@ -#include +#include +#include #include #include #include @@ -88,7 +89,7 @@ public: void processTask(int instance) override { - std::lock_guard lk{mut}; + std::lock_guard const lk{mut}; if (--count == 0) cv.notify_all(); } @@ -106,7 +107,7 @@ public: std::to_string(tc3)); TestCallback cb; - std::unique_ptr perfLog = std::make_unique(); + std::unique_ptr const perfLog = std::make_unique(); Workers w(cb, perfLog.get(), "Test", tc1); BEAST_EXPECT(w.getNumberOfThreads() == tc1); diff --git a/src/test/csf/BasicNetwork.h b/src/test/csf/BasicNetwork.h index 697b20c2c7..384b4634ad 100644 --- a/src/test/csf/BasicNetwork.h +++ b/src/test/csf/BasicNetwork.h @@ -74,7 +74,7 @@ class BasicNetwork { bool inbound = false; duration delay{}; - time_point established{}; + time_point established; link_type() = default; link_type(bool inbound_, duration delay_, time_point established_) : inbound(inbound_), delay(delay_), established(established_) @@ -199,7 +199,7 @@ BasicNetwork::disconnect(Peer const& peer1, Peer const& peer2) { if (!links_.disconnect(peer1, peer2)) return false; - bool r = links_.disconnect(peer2, peer1); + bool const r = links_.disconnect(peer2, peer1); (void)r; assert(r); return true; diff --git a/src/test/csf/BasicNetwork_test.cpp b/src/test/csf/BasicNetwork_test.cpp index eee16c2ce1..221a4d750c 100644 --- a/src/test/csf/BasicNetwork_test.cpp +++ b/src/test/csf/BasicNetwork_test.cpp @@ -1,7 +1,7 @@ #include #include -#include +#include #include #include diff --git a/src/test/csf/Digraph_test.cpp b/src/test/csf/Digraph_test.cpp index a183234903..f2d5938546 100644 --- a/src/test/csf/Digraph_test.cpp +++ b/src/test/csf/Digraph_test.cpp @@ -1,8 +1,10 @@ #include -#include +#include +#include #include +#include #include namespace xrpl { @@ -57,7 +59,7 @@ public: // only 'a' has out edges BEAST_EXPECT(graph.outVertices().size() == 1); - std::vector expected = {'b', 'c'}; + std::vector const expected = {'b', 'c'}; BEAST_EXPECT((graph.outVertices('a') == expected)); BEAST_EXPECT(graph.outVertices('b').size() == 0); @@ -66,7 +68,7 @@ public: std::stringstream ss; graph.saveDot(ss, [](char v) { return v; }); - std::string expectedDot = + std::string const expectedDot = "digraph {\n" "a -> b;\n" "a -> c;\n" diff --git a/src/test/csf/Histogram.h b/src/test/csf/Histogram.h index 9e7b471a2b..cbc2d42d6c 100644 --- a/src/test/csf/Histogram.h +++ b/src/test/csf/Histogram.h @@ -92,7 +92,7 @@ public: percentile(float p) const { assert(p >= 0 && p <= 1); - std::size_t pos = std::round(p * samples); + std::size_t const pos = std::round(p * samples); if (counts_.empty()) return T{}; diff --git a/src/test/csf/Histogram_test.cpp b/src/test/csf/Histogram_test.cpp index b0a8d8490d..f22b8e534b 100644 --- a/src/test/csf/Histogram_test.cpp +++ b/src/test/csf/Histogram_test.cpp @@ -1,6 +1,6 @@ #include -#include +#include namespace xrpl { namespace test { diff --git a/src/test/csf/Peer.h b/src/test/csf/Peer.h index c36d600e6c..f502ca2bc7 100644 --- a/src/test/csf/Peer.h +++ b/src/test/csf/Peer.h @@ -1,5 +1,6 @@ #pragma once +#include #include #include #include @@ -62,8 +63,8 @@ struct Peer return proposal_.getJson(); } - std::string - render() const + static std::string + render() { return ""; } @@ -231,7 +232,7 @@ struct Peer // Number of proposers in the prior round std::size_t prevProposers = 0; // Duration of prior round - std::chrono::milliseconds prevRoundTime; + std::chrono::milliseconds prevRoundTime{}; // Quorum of validations needed for a ledger to be fully validated // TODO: Use the logic in ValidatorList to set this dynamically @@ -295,9 +296,13 @@ struct Peer using namespace std::chrono_literals; if (when == 0ns) + { what(); + } else + { scheduler.in(when, std::forward(what)); + } } // Issue a new event to the collectors @@ -340,8 +345,10 @@ struct Peer trusts(PeerID const& oId) { for (auto const p : trustGraph.trustedPeers(this)) + { if (p->id == oId) return true; + } return false; } @@ -501,16 +508,10 @@ struct Peer NetClock::duration const& closeResolution, ConsensusCloseTimes const& rawCloseTimes, ConsensusMode const& mode, - Json::Value&& consensusJson) + Json::Value const& consensusJson) { onAccept( - result, - prevLedger, - closeResolution, - rawCloseTimes, - mode, - std::move(consensusJson), - validating()); + result, prevLedger, closeResolution, rawCloseTimes, mode, consensusJson, validating()); } void @@ -520,10 +521,10 @@ struct Peer NetClock::duration const& closeResolution, ConsensusCloseTimes const& rawCloseTimes, ConsensusMode const& mode, - Json::Value&& consensusJson, + Json::Value const& consensusJson, bool const validating) { - schedule(delays.ledgerAccept, [=, this]() { + schedule(delays.ledgerAccept, [mode, result, prevLedger, closeResolution, this]() { bool const proposing = mode == ConsensusMode::proposing; bool const consensusFail = result.state == ConsensusState::MovedOn; @@ -550,9 +551,9 @@ struct Peer if (runAsValidator && isCompatible && !consensusFail && validations.canValidateSeq(newLedger.seq())) { - bool isFull = proposing; + bool const isFull = proposing; - Validation v{newLedger.id(), newLedger.seq(), now(), now(), key, id, isFull}; + Validation const v{newLedger.id(), newLedger.seq(), now(), now(), key, id, isFull}; // share the new validation; it is trusted by the receiver share(v); // we trust ourselves @@ -780,7 +781,7 @@ struct Peer { // Ignore and suppress relay of transactions already in last ledger TxSetType const& lastClosedTxs = lastClosedLedger.txs(); - if (lastClosedTxs.find(tx) != lastClosedTxs.end()) + if (lastClosedTxs.contains(tx)) return false; // only relay if it was new to our open ledger @@ -836,8 +837,8 @@ struct Peer { } - bool - validating() const + static bool + validating() { // does not matter return false; @@ -880,7 +881,7 @@ struct Peer issue(StartRound{bestLCL, lastClosedLedger}); // Not yet modeling dynamic UNL. - hash_set nowUntrusted; + hash_set const nowUntrusted; consensus.startRound(now(), bestLCL, lastClosedLedger, nowUntrusted, runAsValidator, {}); } diff --git a/src/test/csf/PeerGroup.h b/src/test/csf/PeerGroup.h index e900ab9934..5df6de84a6 100644 --- a/src/test/csf/PeerGroup.h +++ b/src/test/csf/PeerGroup.h @@ -313,8 +313,8 @@ randomRankedTrust( Generator& g) { std::vector const groups = randomRankedGroups(peers, ranks, numGroups, sizeDist, g); + std::uniform_int_distribution u(0, groups.size() - 1); // NOLINT(misc-const-correctness) - std::uniform_int_distribution u(0, groups.size() - 1); for (auto& peer : peers) { for (auto& target : groups[u(g)]) @@ -337,8 +337,8 @@ randomRankedConnect( SimDuration delay) { std::vector const groups = randomRankedGroups(peers, ranks, numGroups, sizeDist, g); + std::uniform_int_distribution u(0, groups.size() - 1); // NOLINT(misc-const-correctness) - std::uniform_int_distribution u(0, groups.size() - 1); for (auto& peer : peers) { for (auto& target : groups[u(g)]) diff --git a/src/test/csf/README.md b/src/test/csf/README.md index 30d5abb042..081c9807d7 100644 --- a/src/test/csf/README.md +++ b/src/test/csf/README.md @@ -2,7 +2,7 @@ The Consensus Simulation Framework is a set of software components for describing, running and analyzing simulations of the consensus algorithm in a -controlled manner. It is also used to unit test the generic Ripple consensus +controlled manner. It is also used to unit test the generic XRPL consensus algorithm implementation. The framework is in its early stages, so the design and supported features are subject to change. diff --git a/src/test/csf/Scheduler.h b/src/test/csf/Scheduler.h index 61ec8f62ff..984d97e277 100644 --- a/src/test/csf/Scheduler.h +++ b/src/test/csf/Scheduler.h @@ -265,7 +265,7 @@ inline Scheduler::queue_type::~queue_type() auto e = &*iter; ++iter; e->~event(); - alloc_->deallocate(e, sizeof(e)); + alloc_->deallocate(e, sizeof(e)); // NOLINT(bugprone-sizeof-expression) } } @@ -381,8 +381,10 @@ Scheduler::step() if (!step_one()) return false; for (;;) + { if (!step_one()) break; + } return true; } diff --git a/src/test/csf/Scheduler_test.cpp b/src/test/csf/Scheduler_test.cpp index a0b57dd87f..ef64915f6b 100644 --- a/src/test/csf/Scheduler_test.cpp +++ b/src/test/csf/Scheduler_test.cpp @@ -1,6 +1,6 @@ #include -#include +#include #include diff --git a/src/test/csf/TrustGraph.h b/src/test/csf/TrustGraph.h index bae0be4af7..85d1b4d975 100644 --- a/src/test/csf/TrustGraph.h +++ b/src/test/csf/TrustGraph.h @@ -1,5 +1,6 @@ #pragma once +#include #include #include @@ -122,9 +123,9 @@ public: { auto const& unlA = uniqueUNLs[i]; auto const& unlB = uniqueUNLs[j]; - double rhs = 2.0 * (1. - quorum) * std::max(unlA.size(), unlB.size()); + double const rhs = 2.0 * (1. - quorum) * std::max(unlA.size(), unlB.size()); - int intersectionSize = std::count_if( + int const intersectionSize = std::count_if( unlA.begin(), unlA.end(), [&](Peer p) { return unlB.find(p) != unlB.end(); }); if (intersectionSize < rhs) diff --git a/src/test/csf/Tx.h b/src/test/csf/Tx.h index f919b650db..fc57348443 100644 --- a/src/test/csf/Tx.h +++ b/src/test/csf/Tx.h @@ -100,7 +100,8 @@ public: { } - TxSet(MutableTxSet&& m) : txs_{std::move(m.txs_)}, id_{calcID(txs_)} + TxSet(MutableTxSet&& m) // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) + : txs_{m.txs_}, id_{calcID(txs_)} { } @@ -161,7 +162,7 @@ private: TxSetType txs_; //! The unique ID of this tx set - ID id_; + ID id_{}; }; //------------------------------------------------------------------------------ @@ -182,9 +183,13 @@ operator<<(std::ostream& o, boost::container::flat_set const& ts) for (auto const& t : ts) { if (do_comma) + { o << ", "; + } else + { do_comma = true; + } o << t; } o << " }"; diff --git a/src/test/csf/Validation.h b/src/test/csf/Validation.h index 5ebbcf3ae5..ba4da148f4 100644 --- a/src/test/csf/Validation.h +++ b/src/test/csf/Validation.h @@ -129,7 +129,7 @@ public: Validation const& unwrap() const { - // For the rippled implementation in which RCLValidation wraps + // For the xrpld implementation in which RCLValidation wraps // STValidation, the csf::Validation has no more specific type it // wraps, so csf::Validation unwraps to itself return *this; diff --git a/src/test/csf/collectors.h b/src/test/csf/collectors.h index cfe40330ff..ddd7c65784 100644 --- a/src/test/csf/collectors.h +++ b/src/test/csf/collectors.h @@ -134,7 +134,9 @@ struct SimDurationCollector init = true; } else + { stop = when; + } } }; diff --git a/src/test/csf/impl/Sim.cpp b/src/test/csf/impl/Sim.cpp index a775dd30ff..4b93b5c131 100644 --- a/src/test/csf/impl/Sim.cpp +++ b/src/test/csf/impl/Sim.cpp @@ -1,5 +1,13 @@ #include +#include +#include + +#include +#include +#include +#include + namespace xrpl { namespace test { namespace csf { diff --git a/src/test/csf/impl/ledgers.cpp b/src/test/csf/impl/ledgers.cpp index 2c5bf07880..f2405e12c9 100644 --- a/src/test/csf/impl/ledgers.cpp +++ b/src/test/csf/impl/ledgers.cpp @@ -1,6 +1,17 @@ #include +#include + +#include +#include +#include + #include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -42,14 +53,14 @@ mismatch(Ledger const& a, Ledger const& b) // end is 1 past end of range Seq start{0}; - Seq end = std::min(a.seq() + Seq{1}, b.seq() + Seq{1}); + Seq const end = std::min(a.seq() + Seq{1}, b.seq() + Seq{1}); // Find mismatch in [start,end) // Binary search Seq count = end - start; while (count > Seq{0}) { - Seq step = count / Seq{2}; + Seq const step = count / Seq{2}; Seq curr = start + step; if (a[curr] == b[curr]) { diff --git a/src/test/csf/random.h b/src/test/csf/random.h index fc5098af32..406252ff0d 100644 --- a/src/test/csf/random.h +++ b/src/test/csf/random.h @@ -25,7 +25,7 @@ random_weighted_shuffle(std::vector v, std::vector w, G& g) for (int i = 0; i < v.size() - 1; ++i) { // pick a random item weighted by w - std::discrete_distribution<> dd(w.begin() + i, w.end()); + std::discrete_distribution<> dd(w.begin() + i, w.end()); // NOLINT(misc-const-correctness) auto idx = dd(g); std::swap(v[i], v[idx]); std::swap(w[i], w[idx]); @@ -111,7 +111,7 @@ public: } template - inline double + double operator()(Generator&) { return t_; @@ -140,7 +140,7 @@ public: } template - inline double + double operator()(Generator& g) { // use inverse transform of CDF to sample diff --git a/src/test/csf/timers.h b/src/test/csf/timers.h index c8d71d5b7a..beb4e142d9 100644 --- a/src/test/csf/timers.h +++ b/src/test/csf/timers.h @@ -47,11 +47,11 @@ public: beat(SimTime when) { using namespace std::chrono; - RealTime realTime = RealClock::now(); - SimTime simTime = when; + RealTime const realTime = RealClock::now(); + SimTime const simTime = when; - RealDuration realDuration = realTime - startRealTime_; - SimDuration simDuration = simTime - startSimTime_; + RealDuration const realDuration = realTime - startRealTime_; + SimDuration const simDuration = simTime - startSimTime_; out_ << "Heartbeat. Time Elapsed: {sim: " << duration_cast(simDuration).count() << "s | real: " << duration_cast(realDuration).count() << "s}\n" << std::flush; diff --git a/src/test/jtx/AMM.h b/src/test/jtx/AMM.h index 210138f290..5697952ada 100644 --- a/src/test/jtx/AMM.h +++ b/src/test/jtx/AMM.h @@ -12,30 +12,36 @@ #include #include +#include + namespace xrpl { namespace test { namespace jtx { class LPToken { - IOUAmount const tokens_; + Number const tokens_; + Asset asset_; public: - LPToken(std::uint64_t tokens) : tokens_(tokens) + LPToken(std::uint64_t tokens) : tokens_(tokens), asset_(xrpIssue()) { } - LPToken(IOUAmount tokens) : tokens_(tokens) + LPToken(IOUAmount tokens) : tokens_(tokens), asset_(xrpIssue()) { } - IOUAmount const& + LPToken(STAmount tokens) : tokens_(tokens), asset_(tokens.asset()) + { + } + STAmount tokens() const { - return tokens_; + return STAmount{asset_, tokens_}; } STAmount tokens(Issue const& ammIssue) const { - return STAmount{tokens_, ammIssue}; + return STAmount{ammIssue, tokens_}; } }; @@ -59,7 +65,7 @@ struct DepositArg std::optional asset2In = std::nullopt; std::optional maxEP = std::nullopt; std::optional flags = std::nullopt; - std::optional> assets = std::nullopt; + std::optional> assets = std::nullopt; std::optional seq = std::nullopt; std::optional tfee = std::nullopt; std::optional err = std::nullopt; @@ -71,9 +77,9 @@ struct WithdrawArg std::optional tokens = std::nullopt; std::optional asset1Out = std::nullopt; std::optional asset2Out = std::nullopt; - std::optional maxEP = std::nullopt; + std::optional maxEP = std::nullopt; std::optional flags = std::nullopt; - std::optional> assets = std::nullopt; + std::optional> assets = std::nullopt; std::optional seq = std::nullopt; std::optional err = std::nullopt; }; @@ -84,7 +90,7 @@ struct VoteArg std::uint32_t tfee = 0; std::optional flags = std::nullopt; std::optional seq = std::nullopt; - std::optional> assets = std::nullopt; + std::optional> assets = std::nullopt; std::optional err = std::nullopt; }; @@ -93,9 +99,19 @@ struct BidArg std::optional account = std::nullopt; std::optional> bidMin = std::nullopt; std::optional> bidMax = std::nullopt; - std::vector authAccounts = {}; + std::vector authAccounts = {}; // NOLINT(readability-redundant-member-init) std::optional flags = std::nullopt; - std::optional> assets = std::nullopt; + std::optional> assets = std::nullopt; +}; + +struct ClawbackArg +{ + Account issuer; + Account holder; + std::optional> assets = std::nullopt; + std::optional amount = std::nullopt; + std::optional flags = std::nullopt; + std::optional err = std::nullopt; }; /** Convenience class to test AMM functionality. @@ -147,14 +163,21 @@ public: STAmount const& asset2, CreateArg const& arg); + static Json::Value + createJv( + AccountID const& account, + STAmount const& asset1, + STAmount const& asset2, + std::uint16_t const& tfee); + /** Send amm_info RPC command */ Json::Value ammRpcInfo( std::optional const& account = std::nullopt, std::optional const& ledgerIndex = std::nullopt, - std::optional issue1 = std::nullopt, - std::optional issue2 = std::nullopt, + std::optional asset1 = std::nullopt, + std::optional asset2 = std::nullopt, std::optional const& ammAccount = std::nullopt, bool ignoreParams = false, unsigned apiVersion = RPC::apiInvalidVersion) const; @@ -172,14 +195,14 @@ public: */ std::tuple balances( - Issue const& issue1, - Issue const& issue2, + Asset const& asset1, + Asset const& asset2, std::optional const& account = std::nullopt) const; std::tuple balances(std::optional const& account = std::nullopt) const { - return balances(asset1_.get(), asset2_.get(), account); + return balances(asset1_.asset(), asset2_.asset(), account); } [[nodiscard]] bool @@ -214,6 +237,9 @@ public: [[nodiscard]] bool ammExists() const; + static Json::Value + depositJv(DepositArg const& arg); + IOUAmount deposit( std::optional const& account, @@ -239,7 +265,7 @@ public: std::optional const& asset2In, std::optional const& maxEP, std::optional const& flags, - std::optional> const& assets, + std::optional> const& assets, std::optional const& seq, std::optional const& tfee = std::nullopt, std::optional const& ter = std::nullopt); @@ -247,6 +273,9 @@ public: IOUAmount deposit(DepositArg const& arg); + static Json::Value + withdrawJv(WithdrawArg const& arg); + IOUAmount withdraw( std::optional const& account, @@ -274,7 +303,7 @@ public: std::optional const& account, STAmount const& asset1Out, std::optional const& asset2Out = std::nullopt, - std::optional const& maxEP = std::nullopt, + std::optional const& maxEP = std::nullopt, std::optional const& ter = std::nullopt); IOUAmount @@ -283,22 +312,25 @@ public: std::optional const& tokens, std::optional const& asset1Out, std::optional const& asset2Out, - std::optional const& maxEP, + std::optional const& maxEP, std::optional const& flags, - std::optional> const& assets, + std::optional> const& assets, std::optional const& seq, std::optional const& ter = std::nullopt); IOUAmount withdraw(WithdrawArg const& arg); + static Json::Value + voteJv(VoteArg const& arg); + void vote( std::optional const& account, std::uint32_t feeVal, std::optional const& flags = std::nullopt, std::optional const& seq = std::nullopt, - std::optional> const& assets = std::nullopt, + std::optional> const& assets = std::nullopt, std::optional const& ter = std::nullopt); void @@ -307,6 +339,9 @@ public: Json::Value bid(BidArg const& arg); + void + clawback(ClawbackArg const& arg); + AccountID const& ammAccount() const { @@ -337,19 +372,22 @@ public: } std::string - operator[](AccountID const& lp) + operator[](AccountID const& lp) const { return ammRpcInfo(lp).toStyledString(); } Json::Value - operator()(AccountID const& lp) + operator()(AccountID const& lp) const { return ammRpcInfo(lp); } + static Json::Value + deleteJv(AccountID const& account, Asset const& asset1, Asset const& assets); + void - ammDelete(AccountID const& deleter, std::optional const& ter = std::nullopt); + ammDelete(AccountID const& account, std::optional const& ter = std::nullopt); void setClose(bool close) @@ -364,7 +402,83 @@ public: } void - setTokens(Json::Value& jv, std::optional> const& assets = std::nullopt); + setTokens(Json::Value& jv, std::optional> const& assets = std::nullopt); + + Asset const& + operator[](std::uint8_t i) + { + if (i > 1) + Throw("AMM: operator[], invalid index"); + return i == 0 ? asset1_.asset() : asset2_.asset(); + } + + struct Pool + { + AMM const& amm; + std::vector names; + Pool(AMM const& a, std::vector const& n = {}) : amm(a), names(n) + { + } + friend std::ostream& + operator<<(std::ostream& s, Pool const& p) + { + auto const& jr = p.amm.ammRpcInfo(); + auto out = [&](Json::Value const& jv) { + if (jv.isMember(jss::value)) + { + std::cout << jv[jss::value].asString(); + } + else + { + std::cout << jv.asString(); + } + std::cout << " "; + }; + if (p.names.empty()) + { + out(jr[jss::amm][jss::amount]); + out(jr[jss::amm][jss::amount2]); + out(jr[jss::amm][jss::lp_token]); + } + else + { + for (auto const& n : p.names) + out(jr[jss::amm][n]); + } + std::cout << std::endl; + return s; + } + }; + struct Offers + { + Json::Value const& jv; + Offers(Json::Value const& j) : jv(j) + { + } + friend std::ostream& + operator<<(std::ostream& s, Offers const& offers) + { + auto out = [&](Json::Value const& jv) { + if (jv.isMember(jss::value)) + { + s << jv[jss::value].asString(); + } + else + { + s << jv; + } + }; + for (auto const& o : offers.jv[jss::offers]) + { + s << "taker_pays: "; + out(o[jss::taker_pays]); + s << " taker_gets: "; + out(o[jss::taker_gets]); + s << std::endl; + } + return s; + } + }; private: AccountID @@ -374,22 +488,6 @@ private: std::optional const& seq = std::nullopt, std::optional const& ter = std::nullopt); - IOUAmount - deposit( - std::optional const& account, - Json::Value& jv, - std::optional> const& assets = std::nullopt, - std::optional const& seq = std::nullopt, - std::optional const& ter = std::nullopt); - - IOUAmount - withdraw( - std::optional const& account, - Json::Value& jv, - std::optional const& seq, - std::optional> const& assets = std::nullopt, - std::optional const& ter = std::nullopt); - void log(bool log) { @@ -417,17 +515,13 @@ private: }; namespace amm { -Json::Value -trust(AccountID const& account, STAmount const& amount, std::uint32_t flags = 0); -Json::Value -pay(Account const& account, AccountID const& to, STAmount const& amount); Json::Value ammClawback( Account const& issuer, Account const& holder, - Issue const& asset, - Issue const& asset2, + Asset const& asset, + Asset const& asset2, std::optional const& amount); } // namespace amm diff --git a/src/test/jtx/AMMTest.h b/src/test/jtx/AMMTest.h index dd18733ffd..a3d126646d 100644 --- a/src/test/jtx/AMMTest.h +++ b/src/test/jtx/AMMTest.h @@ -13,7 +13,7 @@ namespace jtx { class AMM; -enum class Fund { All, Acct, Gw, IOUOnly }; +enum class Fund { All, Acct, Gw, TokenOnly }; struct TestAMMArg { @@ -28,7 +28,13 @@ struct TestAMMArg bool noLog = false; }; -void +// A hint to testAMM() or fund() to create/fund MPT. +// A distinct MPT is created if both AMM assets +// are MPT. The actual MPT asset can be accessed +// via AMM::operator[](0|1). +inline static auto AMMMPT = MPT("AMM"); + +[[maybe_unused]] std::vector fund( jtx::Env& env, jtx::Account const& gw, @@ -36,7 +42,7 @@ fund( std::vector const& amts, Fund how); -void +[[maybe_unused]] std::vector fund( jtx::Env& env, jtx::Account const& gw, @@ -45,13 +51,22 @@ fund( std::vector const& amts = {}, Fund how = Fund::All); -void +[[maybe_unused]] std::vector fund( jtx::Env& env, std::vector const& accounts, STAmount const& xrp, std::vector const& amts = {}, - Fund how = Fund::All); + Fund how = Fund::All, + std::optional const& mptIssuer = std::nullopt); + +struct TestAMMArgs +{ + std::optional> const& pool = std::nullopt; + std::uint16_t tfee = 0; + std::optional const& ter = std::nullopt; + std::vector const& features = {testable_amendments()}; +}; class AMMTestBase : public beast::unit_test::suite { @@ -127,7 +142,7 @@ protected: void signal() { - std::lock_guard lk(mutex_); + std::lock_guard const lk(mutex_); signaled_ = true; cv_.notify_all(); } @@ -135,24 +150,6 @@ protected: jtx::Env pathTestEnv(); - - Json::Value - find_paths_request( - jtx::Env& env, - jtx::Account const& src, - jtx::Account const& dst, - STAmount const& saDstAmount, - std::optional const& saSendMax = std::nullopt, - std::optional const& saSrcCurrency = std::nullopt); - - std::tuple - find_paths( - jtx::Env& env, - jtx::Account const& src, - jtx::Account const& dst, - STAmount const& saDstAmount, - std::optional const& saSendMax = std::nullopt, - std::optional const& saSrcCurrency = std::nullopt); }; } // namespace jtx diff --git a/src/test/jtx/AbstractClient.h b/src/test/jtx/AbstractClient.h index 9b1ef178ca..94e58f60cd 100644 --- a/src/test/jtx/AbstractClient.h +++ b/src/test/jtx/AbstractClient.h @@ -5,10 +5,10 @@ namespace xrpl { namespace test { -/* Abstract Ripple Client interface. +/* Abstract XRPL client interface. This abstracts the transport layer, allowing - commands to be submitted to a rippled server. + commands to be submitted to an xrpld server. */ class AbstractClient { diff --git a/src/test/jtx/CaptureLogs.h b/src/test/jtx/CaptureLogs.h index 8419c4dc70..8c8da6817b 100644 --- a/src/test/jtx/CaptureLogs.h +++ b/src/test/jtx/CaptureLogs.h @@ -37,14 +37,14 @@ class CaptureLogs : public Logs void write(beast::severities::Severity level, std::string const& text) override { - std::lock_guard lock(strmMutex_); + std::lock_guard const lock(strmMutex_); strm_ << text; } void writeAlways(beast::severities::Severity level, std::string const& text) override { - std::lock_guard lock(strmMutex_); + std::lock_guard const lock(strmMutex_); strm_ << text; } }; diff --git a/src/test/jtx/Env.h b/src/test/jtx/Env.h index b494ade31c..e88b07becd 100644 --- a/src/test/jtx/Env.h +++ b/src/test/jtx/Env.h @@ -85,9 +85,13 @@ testable_amendments() { (void)vote; if (auto const f = getRegisteredFeature(s)) + { feats.push_back(*f); + } else + { Throw("Unknown feature: " + s + " in allAmendments."); + } } return FeatureBitset(feats); }(); @@ -128,12 +132,12 @@ public: /// Used by parseResult() and postConditions() struct ParsedResult { - std::optional ter{}; + std::optional ter; // RPC errors tend to return either a "code" and a "message" (sometimes // with an "error" that corresponds to the "code"), or with an "error" // and an "exception". However, this structure allows all possible // combinations. - std::optional rpcCode{}; + std::optional rpcCode; std::string rpcMessage; std::string rpcError; std::string rpcException; @@ -256,6 +260,7 @@ public: virtual ~Env() = default; Application& + // NOLINTNEXTLINE(readability-make-member-function-const) app() { return *bundle_.app; @@ -268,6 +273,7 @@ public: } ManualTimeKeeper& + // NOLINTNEXTLINE(readability-make-member-function-const) timeKeeper() { return *bundle_.timeKeeper; @@ -279,6 +285,7 @@ public: close or by callers. */ NetClock::time_point + // NOLINTNEXTLINE(readability-make-member-function-const) now() { return timeKeeper().now(); @@ -286,6 +293,7 @@ public: /** Returns the connected client. */ AbstractClient& + // NOLINTNEXTLINE(readability-make-member-function-const) client() { return *bundle_.client; @@ -510,15 +518,8 @@ public: */ // VFALCO NOTE This should return a unit-less amount PrettyAmount - // NOLINTNEXTLINE(readability-convert-member-functions-to-static) balance(Account const& account, Asset const& asset) const; - PrettyAmount - balance(Account const& account, Issue const& issue) const; - - PrettyAmount - balance(Account const& account, MPTIssue const& mptIssue) const; - /** Returns the IOU limit on an account. Returns 0 if the trust line does not exist. */ @@ -780,7 +781,7 @@ public: trust(STAmount const& amount, Account const& to0, Account const& to1, Accounts const&... toN) { trust(amount, to0); - trust(amount, to1, toN...); + trust(amount, to1, toN...); // NOLINT(readability-suspicious-call-argument) } /** @} */ diff --git a/src/test/jtx/Env_ss.h b/src/test/jtx/Env_ss.h index 9db96d5907..d6f5fd1a29 100644 --- a/src/test/jtx/Env_ss.h +++ b/src/test/jtx/Env_ss.h @@ -24,7 +24,7 @@ private: operator=(SignSubmitRunner&&) = delete; SignSubmitRunner(Env& env, JTx&& jt, std::source_location loc) - : env_(env), jt_(jt), loc_(loc) + : env_(env), jt_(std::move(jt)), loc_(loc) { } diff --git a/src/test/jtx/Env_test.cpp b/src/test/jtx/Env_test.cpp index 51abac8101..78c72765cf 100644 --- a/src/test/jtx/Env_test.cpp +++ b/src/test/jtx/Env_test.cpp @@ -1,17 +1,66 @@ -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include -#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include #include #include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include namespace xrpl { @@ -37,7 +86,7 @@ public: Account b(a); a = b; a = std::move(b); - Account c(std::move(a)); + Account const c(std::move(a)); } Account("alice"); // NOLINT(bugprone-unused-raii) Account("alice", KeyType::secp256k1); // NOLINT(bugprone-unused-raii) @@ -635,9 +684,10 @@ public: std::uint32_t const aliceSeq = env.seq("alice"); // Sign jsonNoop. - Json::Value jsonNoop = env.json(noop("alice"), fee(baseFee), seq(aliceSeq), sig("alice")); + Json::Value const jsonNoop = + env.json(noop("alice"), fee(baseFee), seq(aliceSeq), sig("alice")); // Re-sign jsonNoop. - JTx jt = env.jt(jsonNoop); + JTx const jt = env.jt(jsonNoop); env(jt); } @@ -752,7 +802,7 @@ public: Env env{*this, missingSomeFeatures}; BEAST_EXPECT(env.app().config().features.size() == (supported.count() - 2)); foreachFeature(supported, [&](uint256 const& f) { - bool hasnot = (f == featureDynamicMPT || f == featureTokenEscrow); + bool const hasnot = (f == featureDynamicMPT || f == featureTokenEscrow); this->BEAST_EXPECT(hasnot != hasFeature(env, f)); }); } @@ -771,7 +821,7 @@ public: BEAST_EXPECT(hasFeature(env, *neverSupportedFeat)); foreachFeature(supported, [&](uint256 const& f) { - bool has = (f == featureDynamicMPT || f == featureTokenEscrow); + bool const has = (f == featureDynamicMPT || f == featureTokenEscrow); this->BEAST_EXPECT(has == hasFeature(env, f)); }); } @@ -787,7 +837,7 @@ public: BEAST_EXPECT(env.app().config().features.size() == (supported.count() - 2 + 1)); BEAST_EXPECT(hasFeature(env, *neverSupportedFeat)); foreachFeature(supported, [&](uint256 const& f) { - bool hasnot = (f == featureDynamicMPT || f == featureTokenEscrow); + bool const hasnot = (f == featureDynamicMPT || f == featureTokenEscrow); this->BEAST_EXPECT(hasnot != hasFeature(env, f)); }); } @@ -811,7 +861,7 @@ public: testExceptionalShutdown() { except([this] { - jtx::Env env{ + jtx::Env const env{ *this, jtx::envconfig([](std::unique_ptr cfg) { (*cfg).deprecatedClearSection("port_rpc"); diff --git a/src/test/jtx/ManualTimeKeeper.h b/src/test/jtx/ManualTimeKeeper.h index d5fdd467e1..b054db96dd 100644 --- a/src/test/jtx/ManualTimeKeeper.h +++ b/src/test/jtx/ManualTimeKeeper.h @@ -10,7 +10,7 @@ namespace test { class ManualTimeKeeper : public TimeKeeper { private: - std::atomic now_{}; + std::atomic now_; public: ManualTimeKeeper() = default; diff --git a/src/test/jtx/Oracle.h b/src/test/jtx/Oracle.h index 8efd17802c..c64334e5d4 100644 --- a/src/test/jtx/Oracle.h +++ b/src/test/jtx/Oracle.h @@ -58,7 +58,7 @@ struct UpdateArg { std::optional owner = std::nullopt; std::optional documentID = std::nullopt; - DataSeries series = {}; + DataSeries series = {}; // NOLINT(readability-redundant-member-init) std::optional assetClass = std::nullopt; std::optional provider = std::nullopt; std::optional uri = "URI"; @@ -81,7 +81,7 @@ struct RemoveArg std::optional const& err = std::nullopt; }; -// Simulate testStartTime as 10'000s from Ripple epoch time to make +// Simulate testStartTime as 10'000s from XRPL epoch time to make // LastUpdateTime validation to work and to make unit-test consistent. // The value doesn't matter much, it has to be greater // than maxLastUpdateTimeDelta in order to pass LastUpdateTime @@ -99,7 +99,7 @@ private: static inline std::uint32_t fee = 0; Env& env_; AccountID owner_; - std::uint32_t documentID_; + std::uint32_t documentID_{}; private: void diff --git a/src/test/jtx/PathSet.h b/src/test/jtx/PathSet.h index c522ed635e..86b38f7eaf 100644 --- a/src/test/jtx/PathSet.h +++ b/src/test/jtx/PathSet.h @@ -15,13 +15,13 @@ inline std::size_t countOffers( jtx::Env& env, jtx::Account const& account, - Issue const& takerPays, - Issue const& takerGets) + Asset const& takerPays, + Asset const& takerGets) { size_t count = 0; forEachItem(*env.current(), account, [&](std::shared_ptr const& sle) { - if (sle->getType() == ltOFFER && sle->getFieldAmount(sfTakerPays).issue() == takerPays && - sle->getFieldAmount(sfTakerGets).issue() == takerGets) + if (sle->getType() == ltOFFER && sle->getFieldAmount(sfTakerPays).asset() == takerPays && + sle->getFieldAmount(sfTakerGets).asset() == takerGets) ++count; }); return count; @@ -58,7 +58,7 @@ isOffer( /** An offer exists */ inline bool -isOffer(jtx::Env& env, jtx::Account const& account, Issue const& takerPays, Issue const& takerGets) +isOffer(jtx::Env& env, jtx::Account const& account, Asset const& takerPays, Asset const& takerGets) { return countOffers(env, account, takerPays, takerGets) > 0; } @@ -84,6 +84,8 @@ public: Path& push_back(Issue const& iss); Path& + push_back(MPTIssue const& iss); + Path& push_back(jtx::Account const& acc); Path& push_back(STPathElement const& pe); @@ -114,10 +116,21 @@ Path::push_back(Issue const& iss) return *this; } +inline Path& +Path::push_back(MPTIssue const& iss) +{ + path.emplace_back( + STPathElement::typeMPT | STPathElement::typeIssuer, + beast::zero, + iss.getMptID(), + iss.getIssuer()); + return *this; +} + inline Path& Path::push_back(jtx::Account const& account) { - path.emplace_back(account.id(), beast::zero, beast::zero); + path.emplace_back(account.id(), Currency{beast::zero}, beast::zero); return *this; } diff --git a/src/test/jtx/TestHelpers.h b/src/test/jtx/TestHelpers.h index 08e86b40ac..c0004e3d6a 100644 --- a/src/test/jtx/TestHelpers.h +++ b/src/test/jtx/TestHelpers.h @@ -5,14 +5,13 @@ #include #include -#include #include #include #include #include -#include #include #include +#include #include #include @@ -402,6 +401,9 @@ equal(STAmount const& sa1, STAmount const& sa2); STPathElement IPE(Issue const& iss); +STPathElement +IPE(MPTIssue const& iss); + template STPath stpath(Args const&... args) @@ -428,6 +430,79 @@ same(STPathSet const& st1, Args const&... args) return true; } +Json::Value +rpf(jtx::Account const& src, + jtx::Account const& dst, + STAmount const& dstAmount, + std::optional const& sendMax = std::nullopt, + std::optional const& srcAsset = std::nullopt, + std::optional const& srcIssuer = std::nullopt); + +jtx::Env +pathTestEnv(beast::unit_test::suite& suite); + +class gate +{ +private: + std::condition_variable cv_; + std::mutex mutex_; + bool signaled_ = false; + +public: + // Thread safe, blocks until signaled or period expires. + // Returns `true` if signaled. + template + bool + wait_for(std::chrono::duration const& rel_time) + { + std::unique_lock lk(mutex_); + auto b = cv_.wait_for(lk, rel_time, [this] { return signaled_; }); + signaled_ = false; + return b; + } + + void + signal() + { + std::lock_guard const lk(mutex_); + signaled_ = true; + cv_.notify_all(); + } +}; + +Json::Value +find_paths_request( + jtx::Env& env, + jtx::Account const& src, + jtx::Account const& dst, + STAmount const& saDstAmount, + std::optional const& saSendMax = std::nullopt, + std::optional const& srcAsset = std::nullopt, + std::optional const& srcIssuer = std::nullopt, + std::optional const& domain = std::nullopt); + +std::tuple +find_paths( + jtx::Env& env, + jtx::Account const& src, + jtx::Account const& dst, + STAmount const& saDstAmount, + std::optional const& saSendMax = std::nullopt, + std::optional const& srcAsset = std::nullopt, + std::optional const& srcIssuer = std::nullopt, + std::optional const& domain = std::nullopt); + +std::tuple +find_paths_by_element( + jtx::Env& env, + jtx::Account const& src, + jtx::Account const& dst, + STAmount const& saDstAmount, + std::optional const& saSendMax = std::nullopt, + std::optional const& srcElement = std::nullopt, + std::optional const& srcIssuer = std::nullopt, + std::optional const& domain = std::nullopt); + /******************************************************************************/ XRPAmount @@ -453,6 +528,9 @@ expectHolding(Env& env, AccountID const& account, STAmount const& value, Amts co bool expectHolding(Env& env, AccountID const& account, None const& value); +bool +expectMPT(Env& env, AccountID const& account, STAmount const& value); + bool expectOffers( Env& env, @@ -470,6 +548,15 @@ ledgerEntryState( Account const& acct_b, std::string const& currency); +Json::Value +ledgerEntryOffer(jtx::Env& env, jtx::Account const& acct, std::uint32_t offer_seq); + +Json::Value +ledgerEntryMPT(jtx::Env& env, jtx::Account const& acct, MPTID const& mptID); + +Json::Value +getBookOffers(jtx::Env& env, Asset const& taker_pays, Asset const& taker_gets); + Json::Value accountBalance(Env& env, Account const& acct); @@ -545,13 +632,85 @@ n_offers(Env& env, std::size_t n, Account const& account, STAmount const& in, ST /* Pay Strand */ /***************************************************************/ -// Currency path element +struct DirectStepInfo +{ + AccountID src; + AccountID dst; + Currency currency; +}; + +struct MPTEndpointStepInfo +{ + AccountID src; + AccountID dst; + MPTID mptid; +}; + +struct XRPEndpointStepInfo +{ + AccountID acc; +}; + +// Currency/MPTID path element STPathElement -cpe(Currency const& c); +cpe(PathAsset const& pa); + +// Currency/MPTID and issuer path element +STPathElement +ipe(Asset const& asset); + +// Issuer path element +STPathElement +iape(AccountID const& account); + +// Account path element +STPathElement +ape(AccountID const& a); // All path element STPathElement -allPathElements(AccountID const& a, Issue const& iss); +allPathElements(AccountID const& a, Asset const& asset); + +bool +equal(std::unique_ptr const& s1, DirectStepInfo const& dsi); + +bool +equal(std::unique_ptr const& s1, MPTEndpointStepInfo const& dsi); + +bool +equal(std::unique_ptr const& s1, XRPEndpointStepInfo const& xrpStepInfo); + +bool +equal(std::unique_ptr const& s1, xrpl::Book const& bsi); + +template +bool +strandEqualHelper(Iter i) +{ + // base case. all args processed and found equal. + return true; +} + +template +bool +strandEqualHelper(Iter i, StepInfo&& si, Args&&... args) +{ + if (!jtx::equal(*i, std::forward(si))) + return false; + return strandEqualHelper(++i, std::forward(args)...); +} + +template +bool +equal(Strand const& strand, Args&&... args) +{ + if (strand.size() != sizeof...(Args)) + return false; + if (strand.empty()) + return true; + return strandEqualHelper(strand.begin(), std::forward(args)...); +} + /***************************************************************/ /* Check */ @@ -559,7 +718,6 @@ allPathElements(AccountID const& a, Issue const& iss); namespace check { /** Create a check. */ -// clang-format off template requires std::is_same_v Json::Value @@ -572,7 +730,6 @@ create(A const& account, A const& dest, STAmount const& sendMax) jv[sfTransactionType.jsonName] = jss::CheckCreate; return jv; } -// clang-format on inline Json::Value create(jtx::Account const& account, jtx::Account const& dest, STAmount const& sendMax) @@ -585,6 +742,12 @@ create(jtx::Account const& account, jtx::Account const& dest, STAmount const& se static constexpr FeeLevel64 baseFeeLevel{TxQ::baseLevel}; static constexpr FeeLevel64 minEscalationFeeLevel = baseFeeLevel * 500; +inline uint256 +getCheckIndex(AccountID const& account, std::uint32_t uSequence) +{ + return keylet::check(account, uSequence).key; +} + template void checkMetrics( @@ -598,7 +761,7 @@ checkMetrics( std::uint64_t expectedMedFeeLevel = minEscalationFeeLevel.fee(), std::source_location const location = std::source_location::current()) { - int line = location.line(); + int const line = location.line(); char const* file = location.file_name(); FeeLevel64 const expectedMin{expectedMinFeeLevel}; FeeLevel64 const expectedMed{expectedMedFeeLevel}; @@ -772,6 +935,106 @@ pay(AccountID const& account, } // namespace loan +/** Set Expiration on a JTx. */ +class expiration +{ +private: + std::uint32_t const expiry_; + +public: + explicit expiration(NetClock::time_point const& expiry) + : expiry_{expiry.time_since_epoch().count()} + { + } + + void + operator()(Env&, JTx& jt) const + { + jt[sfExpiration.jsonName] = expiry_; + } +}; + +/** Set SourceTag on a JTx. */ +class source_tag +{ +private: + std::uint32_t const tag_; + +public: + explicit source_tag(std::uint32_t tag) : tag_{tag} + { + } + + void + operator()(Env&, JTx& jt) const + { + jt[sfSourceTag.jsonName] = tag_; + } +}; + +/** Set DestinationTag on a JTx. */ +class dest_tag +{ +private: + std::uint32_t const tag_; + +public: + explicit dest_tag(std::uint32_t tag) : tag_{tag} + { + } + + void + operator()(Env&, JTx& jt) const + { + jt[sfDestinationTag.jsonName] = tag_; + } +}; + +struct IssuerArgs +{ + jtx::Env& env; + // 3-letter currency if Issue, ignored if MPT + std::string token; + jtx::Account issuer; + std::vector holders = {}; // NOLINT(readability-redundant-member-init) + // trust-limit if Issue, maxAmount if MPT + std::optional limit = std::nullopt; + // 0-50'000 (0-50%) + std::uint16_t transferFee = 0; +}; + +namespace detail { + +IOU +issueHelperIOU(IssuerArgs const& args); + +MPT +issueHelperMPT(IssuerArgs const& args); + +} // namespace detail + +template +void +testHelper2TokensMix(TTester&& tester) +{ + tester(detail::issueHelperMPT, detail::issueHelperMPT); + tester(detail::issueHelperIOU, detail::issueHelperMPT); + tester(detail::issueHelperMPT, detail::issueHelperIOU); +} + +template +void +testHelper3TokensMix(TTester&& tester) +{ + tester(detail::issueHelperMPT, detail::issueHelperMPT, detail::issueHelperMPT); + tester(detail::issueHelperMPT, detail::issueHelperMPT, detail::issueHelperIOU); + tester(detail::issueHelperMPT, detail::issueHelperIOU, detail::issueHelperMPT); + tester(detail::issueHelperMPT, detail::issueHelperIOU, detail::issueHelperIOU); + tester(detail::issueHelperIOU, detail::issueHelperMPT, detail::issueHelperMPT); + tester(detail::issueHelperIOU, detail::issueHelperMPT, detail::issueHelperIOU); + tester(detail::issueHelperIOU, detail::issueHelperIOU, detail::issueHelperMPT); +} + } // namespace jtx } // namespace test } // namespace xrpl diff --git a/src/test/jtx/TrustedPublisherServer.h b/src/test/jtx/TrustedPublisherServer.h index dc7682bb72..b0a8e3a017 100644 --- a/src/test/jtx/TrustedPublisherServer.h +++ b/src/test/jtx/TrustedPublisherServer.h @@ -54,7 +54,7 @@ class TrustedPublisherServer : public std::enable_shared_from_this( path.substr(strlen(refreshPrefix))); + } res.body() = getList2_(refresh); } } @@ -543,16 +553,22 @@ private: res.result(http::status::ok); res.insert("Content-Type", "application/json"); if (path == "/validators/bad") + { res.body() = "{ 'bad': \"1']"; + } else if (path == "/validators/missing") + { res.body() = "{\"version\": 1}"; + } else { int refresh = 5; constexpr char const* refreshPrefix = "/validators/refresh/"; if (boost::starts_with(path, refreshPrefix)) + { refresh = boost::lexical_cast( path.substr(strlen(refreshPrefix))); + } res.body() = getList_(refresh); } } @@ -562,7 +578,7 @@ private: res.result(http::status::ok); res.insert("Content-Type", "text/example"); // if huge was requested, lie about content length - std::uint64_t cl = boost::starts_with(path, "/textfile/huge") + std::uint64_t const cl = boost::starts_with(path, "/textfile/huge") ? std::numeric_limits::max() : 1024; res.content_length(cl); @@ -570,8 +586,10 @@ private: { std::stringstream body; for (auto i = 0; i < 1024; ++i) + { body << static_cast(rand_int(32, 126)), res.body() = body.str(); + } } } else if (boost::starts_with(path, "/sleep/")) @@ -582,13 +600,21 @@ private: else if (boost::starts_with(path, "/redirect")) { if (boost::ends_with(path, "/301")) + { res.result(http::status::moved_permanently); + } else if (boost::ends_with(path, "/302")) + { res.result(http::status::found); + } else if (boost::ends_with(path, "/307")) + { res.result(http::status::temporary_redirect); + } else if (boost::ends_with(path, "/308")) + { res.result(http::status::permanent_redirect); + } std::stringstream location; if (boost::starts_with(path, "/redirect_to/")) @@ -630,9 +656,13 @@ private: } if (ssl) + { write(*ssl_stream, res, ec); + } else + { write(sock, res, ec); + } if (ec || req.need_eof()) break; diff --git a/src/test/jtx/WSClient_test.cpp b/src/test/jtx/WSClient_test.cpp index 206b550b87..7a5d150a51 100644 --- a/src/test/jtx/WSClient_test.cpp +++ b/src/test/jtx/WSClient_test.cpp @@ -1,7 +1,11 @@ -#include +#include #include +#include -#include +#include +#include + +#include namespace xrpl { namespace test { diff --git a/src/test/jtx/amount.h b/src/test/jtx/amount.h index c4e97502db..0f6db6bdcd 100644 --- a/src/test/jtx/amount.h +++ b/src/test/jtx/amount.h @@ -4,6 +4,7 @@ #include #include +#include #include #include #include @@ -56,7 +57,7 @@ struct None // could change that value (however unlikely). constexpr XRPAmount dropsPerXRP{1'000'000}; -/** Represents an XRP or IOU quantity +/** Represents an XRP, IOU, or MPT quantity This customizes the string conversion and supports XRP conversions from integer and floating point. */ @@ -119,7 +120,7 @@ public: return amount_; } - inline int + int signum() const { return amount_.signum(); @@ -196,8 +197,8 @@ public: PrettyAmount operator()(Number v, Number::rounding_mode rounding = Number::getround()) const { - NumberRoundModeGuard mg(rounding); - STAmount amount{asset_, v * scale_}; + NumberRoundModeGuard const mg(rounding); + STAmount const amount{asset_, v * scale_}; return {amount, ""}; } @@ -231,11 +232,9 @@ public: // Specifies an order book struct BookSpec { - AccountID account; - xrpl::Currency currency; + xrpl::Asset asset; - BookSpec(AccountID const& account_, xrpl::Currency const& currency_) - : account(account_), currency(currency_) + BookSpec(xrpl::Asset const& asset_) : asset(asset_) { } }; @@ -253,9 +252,13 @@ struct XRP_t { return xrpIssue(); } + operator Asset() const + { + return xrpIssue(); + } - bool - integral() const + static bool + integral() { return true; } @@ -317,7 +320,7 @@ struct XRP_t friend BookSpec operator~(XRP_t const&) { - return BookSpec(xrpAccount(), xrpCurrency()); + return BookSpec(Issue{xrpCurrency(), xrpAccount()}); } }; @@ -413,6 +416,10 @@ public: { return issue(); } + operator Asset() const + { + return asset(); + } operator PrettyAsset() const { return asset(); @@ -447,7 +454,7 @@ public: friend BookSpec operator~(IOU const& iou) { - return BookSpec(iou.account.id(), iou.currency); + return BookSpec(Issue{iou.currency, iou.account.id()}); } }; @@ -472,6 +479,15 @@ public: MPT(std::string const& n, xrpl::MPTID const& issuanceID_) : name(n), issuanceID(issuanceID_) { } + MPT(std::string const& n = "") : name(n), issuanceID(noMPT()) + { + } + MPT(Asset const& asset) : issuanceID(asset.get()) + { + } + MPT(AccountID const& account, std::int32_t seq = 0) : issuanceID(makeMptID(seq, account)) + { + } xrpl::MPTID const& mpt() const @@ -491,8 +507,8 @@ public: { return mptIssue(); } - bool - integral() const + static bool + integral() { return true; } @@ -511,6 +527,14 @@ public: { return asset(); } + operator xrpl::Asset() const + { + return mpt(); + } + operator xrpl::MPTID() const + { + return mpt(); + } template requires(sizeof(T) >= sizeof(int) && std::is_arithmetic_v) @@ -529,15 +553,13 @@ public: None operator()(none_t) const { - return {mptIssue()}; + return {noMPT()}; } friend BookSpec operator~(MPT const& mpt) { - assert(false); - Throw("MPT is not supported"); - return BookSpec{beast::zero, noCurrency()}; + return BookSpec{Asset{mpt}}; } }; @@ -577,7 +599,7 @@ struct AnyAmount { if (!is_any) return; - value.setIssuer(id); + value.get().account = id; } }; diff --git a/src/test/jtx/batch.h b/src/test/jtx/batch.h index f81bed3c6e..0fc1fb1f68 100644 --- a/src/test/jtx/batch.h +++ b/src/test/jtx/batch.h @@ -2,14 +2,13 @@ #include #include +#include #include #include #include #include -#include "test/jtx/SignerUtils.h" - #include #include #include diff --git a/src/test/jtx/envconfig.h b/src/test/jtx/envconfig.h index e4a1975e74..b6fede686f 100644 --- a/src/test/jtx/envconfig.h +++ b/src/test/jtx/envconfig.h @@ -107,6 +107,52 @@ std::unique_ptr addGrpcConfig(std::unique_ptr); std::unique_ptr addGrpcConfigWithSecureGateway(std::unique_ptr, std::string const& secureGateway); +/// @brief add a grpc address, port and TLS certificate/key paths to config +/// +/// This is intended for use with envconfig, for tests that require a grpc +/// server with TLS enabled. +/// +/// @param cfg config instance to be modified +/// @param certPath path to SSL certificate file +/// @param keyPath path to SSL private key file +std::unique_ptr +addGrpcConfigWithTLS( + std::unique_ptr, + std::string const& certPath, + std::string const& keyPath); + +/// @brief add a grpc address, port and TLS certificate/key/client CA paths to config +/// +/// This is intended for use with envconfig, for tests that require a grpc +/// server with mutual TLS (client certificate verification) enabled. +/// +/// @param cfg config instance to be modified +/// @param certPath path to SSL certificate file +/// @param keyPath path to SSL private key file +/// @param clientCAPath path to SSL client CA certificate file for mTLS +std::unique_ptr +addGrpcConfigWithTLSAndClientCA( + std::unique_ptr, + std::string const& certPath, + std::string const& keyPath, + std::string const& clientCAPath); + +/// @brief add a grpc address, port and TLS with server cert chain to config +/// +/// This is intended for use with envconfig, for tests that require a grpc +/// server with TLS enabled and intermediate CA certificates. +/// +/// @param cfg config instance to be modified +/// @param certPath path to SSL certificate file +/// @param keyPath path to SSL private key file +/// @param certChainPath path to SSL intermediate CA certificate(s) file +std::unique_ptr +addGrpcConfigWithTLSAndCertChain( + std::unique_ptr, + std::string const& certPath, + std::string const& keyPath, + std::string const& certChainPath); + std::unique_ptr makeConfig( std::map extraTxQ = {}, diff --git a/src/test/jtx/flags.h b/src/test/jtx/flags.h index 3dde1fa414..c4fb5cb34c 100644 --- a/src/test/jtx/flags.h +++ b/src/test/jtx/flags.h @@ -12,7 +12,7 @@ namespace detail { class flags_helper { protected: - std::uint32_t mask_; + std::uint32_t mask_{0}; private: void @@ -79,7 +79,7 @@ private: protected: template - flags_helper(Args... args) : mask_(0) + flags_helper(Args... args) { set_args(args...); } @@ -104,7 +104,7 @@ fclear(Account const& account, std::uint32_t off) } /** Match set account flags */ -class flags : private detail::flags_helper +class flags : private xrpl::detail::flags_helper { private: Account account_; @@ -120,7 +120,7 @@ public: }; /** Match clear account flags */ -class nflags : private detail::flags_helper +class nflags : private xrpl::detail::flags_helper { private: Account account_; diff --git a/src/test/jtx/impl/AMM.cpp b/src/test/jtx/impl/AMM.cpp index 7109a2131d..a0e868905f 100644 --- a/src/test/jtx/impl/AMM.cpp +++ b/src/test/jtx/impl/AMM.cpp @@ -1,13 +1,42 @@ #include -#include +#include +#include +#include +#include +#include + +#include +#include #include +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -49,14 +78,14 @@ AMM::AMM( , creatorAccount_(account) , asset1_(asset1) , asset2_(asset2) - , ammID_(keylet::amm(asset1_.issue(), asset2_.issue()).key) + , ammID_(keylet::amm(asset1_.asset(), asset2_.asset()).key) , log_(log) , doClose_(close) , lastPurchasePrice_(0) , msig_(ms) , fee_(fee) , ammAccount_(create(tfee, flags, seq, ter)) - , lptIssue_(xrpl::ammLPTIssue(asset1_.issue().currency, asset2_.issue().currency, ammAccount_)) + , lptIssue_(xrpl::ammLPTIssue(asset1_.asset(), asset2_.asset(), ammAccount_)) , initialLPTokens_(initialTokens()) { } @@ -105,6 +134,23 @@ AMM::AMM( { } +Json::Value +AMM::createJv( + AccountID const& account, + STAmount const& asset1, + STAmount const& asset2, + std::uint16_t const& tfee) +{ + Json::Value jv; + jv[jss::Account] = to_string(account); + jv[jss::Amount] = asset1.getJson(JsonOptions::none); + jv[jss::Amount2] = asset2.getJson(JsonOptions::none); + jv[jss::TradingFee] = tfee; + jv[jss::TransactionType] = jss::AMMCreate; + + return jv; +} + [[nodiscard]] AccountID AMM::create( std::uint32_t tfee, @@ -112,12 +158,7 @@ AMM::create( std::optional const& seq, std::optional const& ter) { - Json::Value jv; - jv[jss::Account] = creatorAccount_.human(); - jv[jss::Amount] = asset1_.getJson(JsonOptions::none); - jv[jss::Amount2] = asset2_.getJson(JsonOptions::none); - jv[jss::TradingFee] = tfee; - jv[jss::TransactionType] = jss::AMMCreate; + Json::Value jv = createJv(creatorAccount_, asset1_, asset2_, tfee); if (flags) jv[jss::Flags] = *flags; if (fee_ != 0) @@ -132,7 +173,7 @@ AMM::create( if (!ter || env_.ter() == tesSUCCESS) { - if (auto const amm = env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue()))) + if (auto const amm = env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset()))) { return amm->getAccountID(sfAccount); } @@ -144,8 +185,8 @@ Json::Value AMM::ammRpcInfo( std::optional const& account, std::optional const& ledgerIndex, - std::optional issue1, - std::optional issue2, + std::optional asset1, + std::optional asset2, std::optional const& ammAccount, bool ignoreParams, unsigned apiVersion) const @@ -157,17 +198,17 @@ AMM::ammRpcInfo( jv[jss::ledger_index] = *ledgerIndex; if (!ignoreParams) { - if (issue1 || issue2) + if (asset1 || asset2) { - if (issue1) - jv[jss::asset] = STIssue(sfAsset, *issue1).getJson(JsonOptions::none); - if (issue2) - jv[jss::asset2] = STIssue(sfAsset2, *issue2).getJson(JsonOptions::none); + if (asset1) + jv[jss::asset] = STIssue(sfAsset, *asset1).getJson(JsonOptions::none); + if (asset2) + jv[jss::asset2] = STIssue(sfAsset2, *asset2).getJson(JsonOptions::none); } else if (!ammAccount) { - jv[jss::asset] = STIssue(sfAsset, asset1_.issue()).getJson(JsonOptions::none); - jv[jss::asset2] = STIssue(sfAsset2, asset2_.issue()).getJson(JsonOptions::none); + jv[jss::asset] = STIssue(sfAsset, asset1_.asset()).getJson(JsonOptions::none); + jv[jss::asset2] = STIssue(sfAsset2, asset2_.asset()).getJson(JsonOptions::none); } if (ammAccount) jv[jss::amm_account] = to_string(*ammAccount); @@ -182,18 +223,19 @@ AMM::ammRpcInfo( } std::tuple -AMM::balances(Issue const& issue1, Issue const& issue2, std::optional const& account) +AMM::balances(Asset const& asset1, Asset const& asset2, std::optional const& account) const { - if (auto const amm = env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue()))) + if (auto const amm = env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset()))) { auto const ammAccountID = amm->getAccountID(sfAccount); auto const [asset1Balance, asset2Balance] = ammPoolHolds( *env_.current(), ammAccountID, - issue1, - issue2, + asset1, + asset2, FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, env_.journal); auto const lptAMMBalance = account ? ammLPHolds(*env_.current(), *amm, *account, env_.journal) @@ -211,7 +253,7 @@ AMM::expectBalances( std::optional const& account) const { auto const [asset1Balance, asset2Balance, lptAMMBalance] = - balances(asset1.issue(), asset2.issue(), account); + balances(asset1.asset(), asset2.asset(), account); return asset1 == asset1Balance && asset2 == asset2Balance && lptAMMBalance == STAmount{lpt, lptIssue_}; } @@ -229,7 +271,7 @@ AMM::getLPTokensBalance(std::optional const& account) const env_.journal) .iou(); } - if (auto const amm = env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue()))) + if (auto const amm = env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset()))) return amm->getFieldAmount(sfLPTokenBalance).iou(); return IOUAmount{0}; } @@ -237,7 +279,7 @@ AMM::getLPTokensBalance(std::optional const& account) const bool AMM::expectLPTokens(AccountID const& account, IOUAmount const& expTokens) const { - if (auto const amm = env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue()))) + if (auto const amm = env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset()))) { auto const lptAMMBalance = ammLPHolds(*env_.current(), *amm, account, env_.journal); return lptAMMBalance == STAmount{expTokens, lptIssue_}; @@ -283,7 +325,7 @@ AMM::expectAuctionSlot(std::vector const& authAccounts) const bool AMM::expectTradingFee(std::uint16_t fee) const { - auto const amm = env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue())); + auto const amm = env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset())); return amm && (*amm)[sfTradingFee] == fee; } @@ -291,7 +333,7 @@ bool AMM::ammExists() const { return env_.current()->read(keylet::account(ammAccount_)) != nullptr && - env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue())) != nullptr; + env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset())) != nullptr; } bool @@ -329,14 +371,14 @@ AMM::expectAmmInfo( if (!amountFromJsonNoThrow(lptBalance, jv[jss::lp_token])) return false; // ammRpcInfo returns unordered assets - if (asset1Info.issue() != asset1.issue()) + if (asset1Info.asset() != asset1.asset()) std::swap(asset1Info, asset2Info); return asset1 == asset1Info && asset2 == asset2Info && lptBalance == STAmount{balance, lptIssue_}; } void -AMM::setTokens(Json::Value& jv, std::optional> const& assets) +AMM::setTokens(Json::Value& jv, std::optional> const& assets) { if (assets) { @@ -345,28 +387,65 @@ AMM::setTokens(Json::Value& jv, std::optional> const& as } else { - jv[jss::Asset] = STIssue(sfAsset, asset1_.issue()).getJson(JsonOptions::none); - jv[jss::Asset2] = STIssue(sfAsset, asset2_.issue()).getJson(JsonOptions::none); + jv[jss::Asset] = STIssue(sfAsset, asset1_.asset()).getJson(JsonOptions::none); + jv[jss::Asset2] = STIssue(sfAsset, asset2_.asset()).getJson(JsonOptions::none); } } -IOUAmount -AMM::deposit( - std::optional const& account, - Json::Value& jv, - std::optional> const& assets, - std::optional const& seq, - std::optional const& ter) +Json::Value +AMM::depositJv(DepositArg const& arg) { - auto const& acct = account ? *account : creatorAccount_; - auto const lpTokens = getLPTokensBalance(acct); - jv[jss::Account] = acct.human(); - setTokens(jv, assets); + Json::Value jv; + if (!arg.account || !arg.assets) + Throw("AMM::depositJv: account or assets not set"); + + jv[jss::Account] = arg.account->human(); + jv[jss::Asset] = STIssue(sfAsset, arg.assets->first).getJson(JsonOptions::none); + jv[jss::Asset2] = STIssue(sfAsset, arg.assets->second).getJson(JsonOptions::none); + if (arg.tokens) + arg.tokens->tokens().setJson(jv[jss::LPTokenOut]); + if (arg.asset1In) + arg.asset1In->setJson(jv[jss::Amount]); + if (arg.asset2In) + arg.asset2In->setJson(jv[jss::Amount2]); + if (arg.maxEP) + arg.maxEP->setJson(jv[jss::EPrice]); + if (arg.tfee) + jv[jss::TradingFee] = *arg.tfee; + std::uint32_t flags = 0; + if (arg.flags) + flags = *arg.flags; + // If including asset1In and asset2In or tokens as + // deposit min amounts then must set the flags + // explicitly instead of relying on this logic. + if ((flags & tfDepositSubTx) == 0u) + { + if (arg.tokens && !arg.asset1In) + { + flags |= tfLPToken; + } + else if (arg.tokens && arg.asset1In) + { + flags |= tfOneAssetLPToken; + } + else if (arg.asset1In && arg.asset2In) + { + flags |= tfTwoAsset; + } + else if (arg.maxEP && arg.asset1In) + { + flags |= tfLimitLPToken; + } + else if (arg.asset1In) + { + flags |= tfSingleAsset; + } + } + jv[jss::Flags] = flags; + jv[jss::TransactionType] = jss::AMMDeposit; - if (fee_ != 0) - jv[jss::Fee] = std::to_string(fee_); - submit(jv, seq, ter); - return getLPTokensBalance(acct) - lpTokens; + + return jv; } IOUAmount @@ -399,7 +478,8 @@ AMM::deposit( std::optional const& flags, std::optional const& ter) { - assert(!(asset2In && maxEP)); + if (asset2In && maxEP) + Throw("Invalid options: asset2In and maxEP"); return deposit( account, std::nullopt, @@ -421,53 +501,26 @@ AMM::deposit( std::optional const& asset2In, std::optional const& maxEP, std::optional const& flags, - std::optional> const& assets, + std::optional> const& assets, std::optional const& seq, std::optional const& tfee, std::optional const& ter) { - Json::Value jv; - if (tokens) - tokens->tokens(lptIssue_).setJson(jv[jss::LPTokenOut]); - if (asset1In) - asset1In->setJson(jv[jss::Amount]); - if (asset2In) - asset2In->setJson(jv[jss::Amount2]); - if (maxEP) - maxEP->setJson(jv[jss::EPrice]); - if (tfee) - jv[jss::TradingFee] = *tfee; - std::uint32_t jvFlags = 0; - if (flags) - jvFlags = *flags; - // If including asset1In and asset2In or tokens as - // deposit min amounts then must set the flags - // explicitly instead of relying on this logic. - if ((jvFlags & tfDepositSubTx) == 0u) - { - if (tokens && !asset1In) - { - jvFlags |= tfLPToken; - } - else if (tokens && asset1In) - { - jvFlags |= tfOneAssetLPToken; - } - else if (asset1In && asset2In) - { - jvFlags |= tfTwoAsset; - } - else if (maxEP && asset1In) - { - jvFlags |= tfLimitLPToken; - } - else if (asset1In) - { - jvFlags |= tfSingleAsset; - } - } - jv[jss::Flags] = jvFlags; - return deposit(account, jv, assets, seq, ter); + auto const acct = account ? account : creatorAccount_; + auto const lpTokens = getLPTokensBalance(acct); + Json::Value jv = depositJv( + {.account = acct, + .tokens = tokens ? tokens->tokens(lptIssue_) : tokens, + .asset1In = asset1In, + .asset2In = asset2In, + .maxEP = maxEP, + .flags = flags, + .assets = assets ? assets : std::make_pair(asset1_.asset(), asset2_.asset()), + .tfee = tfee}); + if (fee_ != 0) + jv[jss::Fee] = std::to_string(fee_); + submit(jv, seq, ter); + return getLPTokensBalance(acct) - lpTokens; } IOUAmount @@ -486,23 +539,54 @@ AMM::deposit(DepositArg const& arg) arg.err); } -IOUAmount -AMM::withdraw( - std::optional const& account, - Json::Value& jv, - std::optional const& seq, - std::optional> const& assets, - std::optional const& ter) +Json::Value +AMM::withdrawJv(WithdrawArg const& arg) { - auto const& acct = account ? *account : creatorAccount_; - auto const lpTokens = getLPTokensBalance(acct); - jv[jss::Account] = acct.human(); - setTokens(jv, assets); + Json::Value jv; + if (!arg.account || !arg.assets) + Throw("AMM::withdrawJv: account or assets not set"); + jv[jss::Account] = arg.account->human(); + jv[jss::Asset] = STIssue(sfAsset, arg.assets->first).getJson(JsonOptions::none); + jv[jss::Asset2] = STIssue(sfAsset, arg.assets->second).getJson(JsonOptions::none); + if (arg.tokens) + arg.tokens->tokens().setJson(jv[jss::LPTokenIn]); + if (arg.asset1Out) + arg.asset1Out->setJson(jv[jss::Amount]); + if (arg.asset2Out) + arg.asset2Out->setJson(jv[jss::Amount2]); + if (arg.maxEP) + arg.maxEP->tokens().setJson(jv[jss::EPrice]); + std::uint32_t flags = 0; + if (arg.flags) + flags = *arg.flags; + if ((flags & tfWithdrawSubTx) == 0u) + { + if (arg.tokens && !arg.asset1Out) + { + flags |= tfLPToken; + } + else if (arg.asset1Out && arg.asset2Out) + { + flags |= tfTwoAsset; + } + else if (arg.tokens && arg.asset1Out) + { + flags |= tfOneAssetLPToken; + } + else if (arg.asset1Out && arg.maxEP) + { + flags |= tfLimitLPToken; + } + else if (arg.asset1Out) + { + flags |= tfSingleAsset; + } + } + jv[jss::Flags] = flags; + jv[jss::TransactionType] = jss::AMMWithdraw; - if (fee_ != 0) - jv[jss::Fee] = std::to_string(fee_); - submit(jv, seq, ter); - return lpTokens - getLPTokensBalance(acct); + + return jv; } IOUAmount @@ -530,10 +614,11 @@ AMM::withdraw( std::optional const& account, STAmount const& asset1Out, std::optional const& asset2Out, - std::optional const& maxEP, + std::optional const& maxEP, std::optional const& ter) { - assert(!(asset2Out && maxEP)); + if (asset2Out && maxEP) + Throw("Invalid options: asset2Out and maxEP"); return withdraw( account, std::nullopt, @@ -552,52 +637,27 @@ AMM::withdraw( std::optional const& tokens, std::optional const& asset1Out, std::optional const& asset2Out, - std::optional const& maxEP, + std::optional const& maxEP, std::optional const& flags, - std::optional> const& assets, + std::optional> const& assets, std::optional const& seq, std::optional const& ter) { - Json::Value jv; - if (tokens) - tokens->tokens(lptIssue_).setJson(jv[jss::LPTokenIn]); - if (asset1Out) - asset1Out->setJson(jv[jss::Amount]); - if (asset2Out) - asset2Out->setJson(jv[jss::Amount2]); - if (maxEP) - { - STAmount const saMaxEP{*maxEP, lptIssue_}; - saMaxEP.setJson(jv[jss::EPrice]); - } - std::uint32_t jvFlags = 0; - if (flags) - jvFlags = *flags; - if ((jvFlags & tfWithdrawSubTx) == 0u) - { - if (tokens && !asset1Out) - { - jvFlags |= tfLPToken; - } - else if (asset1Out && asset2Out) - { - jvFlags |= tfTwoAsset; - } - else if (tokens && asset1Out) - { - jvFlags |= tfOneAssetLPToken; - } - else if (asset1Out && maxEP) - { - jvFlags |= tfLimitLPToken; - } - else if (asset1Out) - { - jvFlags |= tfSingleAsset; - } - } - jv[jss::Flags] = jvFlags; - return withdraw(account, jv, seq, assets, ter); + auto const acct = account ? account : creatorAccount_; + auto const lpTokens = getLPTokensBalance(acct); + Json::Value jv = withdrawJv({ + .account = acct, + .tokens = tokens ? tokens->tokens(lptIssue_) : tokens, + .asset1Out = asset1Out, + .asset2Out = asset2Out, + .maxEP = maxEP ? maxEP->tokens(lptIssue_) : maxEP, + .flags = flags, + .assets = assets ? assets : std::make_pair(asset1_.asset(), asset2_.asset()), + }); + if (fee_ != 0) + jv[jss::Fee] = std::to_string(fee_); + submit(jv, seq, ter); + return lpTokens - getLPTokensBalance(acct); } IOUAmount @@ -615,22 +675,39 @@ AMM::withdraw(WithdrawArg const& arg) arg.err); } +Json::Value +AMM::voteJv(VoteArg const& arg) +{ + Json::Value jv; + if (!arg.account || !arg.assets) + Throw("AMM::withdrawJv: account or assets not set"); + jv[jss::Account] = arg.account->human(); + jv[jss::Asset] = STIssue(sfAsset, arg.assets->first).getJson(JsonOptions::none); + jv[jss::Asset2] = STIssue(sfAsset, arg.assets->second).getJson(JsonOptions::none); + jv[jss::TradingFee] = arg.tfee; + if (arg.flags) + jv[jss::Flags] = *arg.flags; + + jv[jss::TransactionType] = jss::AMMVote; + + return jv; +} + void AMM::vote( std::optional const& account, std::uint32_t feeVal, std::optional const& flags, std::optional const& seq, - std::optional> const& assets, + std::optional> const& assets, std::optional const& ter) { - Json::Value jv; - jv[jss::Account] = account ? account->human() : creatorAccount_.human(); - setTokens(jv, assets); - jv[jss::TradingFee] = feeVal; - jv[jss::TransactionType] = jss::AMMVote; - if (flags) - jv[jss::Flags] = *flags; + Json::Value jv = voteJv({ + .account = account ? account : creatorAccount_, + .tfee = feeVal, + .flags = flags, + .assets = assets ? assets : std::make_pair(asset1_.asset(), asset2_.asset()), + }); if (fee_ != 0) jv[jss::Fee] = std::to_string(fee_); submit(jv, seq, ter); @@ -645,11 +722,11 @@ AMM::vote(VoteArg const& arg) Json::Value AMM::bid(BidArg const& arg) { - if (auto const amm = env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue()))) + if (auto const amm = env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset()))) { - assert( - !env_.current()->rules().enabled(fixInnerObjTemplate) || - amm->isFieldPresent(sfAuctionSlot)); + if (env_.current()->rules().enabled(fixInnerObjTemplate) && + !amm->isFieldPresent(sfAuctionSlot)) + Throw("AMM::Bid"); if (amm->isFieldPresent(sfAuctionSlot)) { auto const& auctionSlot = @@ -677,13 +754,13 @@ AMM::bid(BidArg const& arg) }; if (arg.bidMin) { - STAmount saTokens = getBid(*arg.bidMin); + STAmount const saTokens = getBid(*arg.bidMin); saTokens.setJson(jv[jss::BidMin]); bidMin_ = saTokens.iou(); } if (arg.bidMax) { - STAmount saTokens = getBid(*arg.bidMax); + STAmount const saTokens = getBid(*arg.bidMax); saTokens.setJson(jv[jss::BidMax]); bidMax_ = saTokens.iou(); } @@ -708,6 +785,22 @@ AMM::bid(BidArg const& arg) return jv; } +void +AMM::clawback(ClawbackArg const& arg) +{ + auto const& [asset, asset2] = [&]() { + if (arg.assets) + return *arg.assets; + return std::make_pair(asset1_.asset(), asset2_.asset()); + }(); + auto jv = amm::ammClawback(arg.issuer, arg.holder, asset, asset2, arg.amount); + if (arg.flags) + jv[jss::Flags] = *arg.flags; + if (fee_ != 0) + jv[jss::Fee] = std::to_string(fee_); + submit(jv, std::nullopt, arg.err); +} + void AMM::submit( Json::Value const& jv, @@ -758,11 +851,11 @@ AMM::submit( bool AMM::expectAuctionSlot(auto&& cb) const { - if (auto const amm = env_.current()->read(keylet::amm(asset1_.issue(), asset2_.issue()))) + if (auto const amm = env_.current()->read(keylet::amm(asset1_.asset(), asset2_.asset()))) { - assert( - !env_.current()->rules().enabled(fixInnerObjTemplate) || - amm->isFieldPresent(sfAuctionSlot)); + if (env_.current()->rules().enabled(fixInnerObjTemplate) && + !amm->isFieldPresent(sfAuctionSlot)) + Throw("AMM::expectAuctionSlot"); if (amm->isFieldPresent(sfAuctionSlot)) { auto const& auctionSlot = @@ -785,48 +878,36 @@ AMM::expectAuctionSlot(auto&& cb) const return false; } -void -AMM::ammDelete(AccountID const& deleter, std::optional const& ter) +Json::Value +AMM::deleteJv(AccountID const& account, Asset const& asset1, Asset const& asset2) { Json::Value jv; - jv[jss::Account] = to_string(deleter); - setTokens(jv); + jv[jss::Account] = to_string(account); + jv[jss::Asset] = STIssue(sfAsset, asset1).getJson(JsonOptions::none); + jv[jss::Asset2] = STIssue(sfAsset, asset2).getJson(JsonOptions::none); + jv[jss::TransactionType] = jss::AMMDelete; + + return jv; +} + +void +AMM::ammDelete(AccountID const& account, std::optional const& ter) +{ + Json::Value jv = deleteJv(account, asset1_.asset(), asset2_.asset()); if (fee_ != 0) jv[jss::Fee] = std::to_string(fee_); submit(jv, std::nullopt, ter); } namespace amm { -Json::Value -trust(AccountID const& account, STAmount const& amount, std::uint32_t flags) -{ - if (isXRP(amount)) - Throw("trust() requires IOU"); - Json::Value jv; - jv[jss::Account] = to_string(account); - jv[jss::LimitAmount] = amount.getJson(JsonOptions::none); - jv[jss::TransactionType] = jss::TrustSet; - jv[jss::Flags] = flags; - return jv; -} -Json::Value -pay(Account const& account, AccountID const& to, STAmount const& amount) -{ - Json::Value jv; - jv[jss::Account] = account.human(); - jv[jss::Amount] = amount.getJson(JsonOptions::none); - jv[jss::Destination] = to_string(to); - jv[jss::TransactionType] = jss::Payment; - return jv; -} Json::Value ammClawback( Account const& issuer, Account const& holder, - Issue const& asset, - Issue const& asset2, + Asset const& asset, + Asset const& asset2, std::optional const& amount) { Json::Value jv; diff --git a/src/test/jtx/impl/AMMTest.cpp b/src/test/jtx/impl/AMMTest.cpp index 9d9a537210..2c45a26850 100644 --- a/src/test/jtx/impl/AMMTest.cpp +++ b/src/test/jtx/impl/AMMTest.cpp @@ -1,20 +1,38 @@ -#include #include + +#include +#include #include #include +#include +#include +#include #include +#include -#include +#include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { namespace jtx { -void +[[maybe_unused]] std::vector fund( jtx::Env& env, jtx::Account const& gw, @@ -22,16 +40,17 @@ fund( std::vector const& amts, Fund how) { - fund(env, gw, accounts, XRP(30000), amts, how); + return fund(env, gw, accounts, XRP(30000), amts, how); } -void +[[maybe_unused]] std::vector fund( jtx::Env& env, std::vector const& accounts, STAmount const& xrp, std::vector const& amts, - Fund how) + Fund how, + std::optional const& mptIssuer) { for (auto const& account : accounts) { @@ -41,18 +60,37 @@ fund( } } env.close(); + + std::vector amtsOut; for (auto const& account : accounts) { + int i = 0; for (auto const& amt : amts) { - env.trust(amt + amt, account); - env(pay(amt.issue().account, account, amt)); + auto amt_ = [&]() { + if (amtsOut.size() == amts.size()) + { + return amtsOut[i++]; + } + if (amt.holds() && mptIssuer) + { + MPTTester const mpt({.env = env, .issuer = *mptIssuer, .holders = accounts}); + return STAmount{mpt.issuanceID(), amt.mpt().value()}; + } + return amt; + }(); + if (amt.holds()) + env.trust(amt_ + amt_, account); + if (amtsOut.size() != amts.size()) + amtsOut.push_back(amt_); + env(pay(amt_.getIssuer(), account, amt_)); } } env.close(); + return amtsOut; } -void +[[maybe_unused]] std::vector fund( jtx::Env& env, jtx::Account const& gw, @@ -64,7 +102,7 @@ fund( if (how == Fund::All || how == Fund::Gw) env.fund(xrp, gw); env.close(); - fund(env, accounts, xrp, amts, how); + return fund(env, accounts, xrp, amts, how, gw); } AMMTestBase::AMMTestBase() @@ -119,31 +157,41 @@ AMMTestBase::testAMM(std::function const& cb, TestAM return defXRP; return a + XRP(1000); } - auto defIOU = STAmount{a.issue(), 30000}; - if (a <= defIOU) - return defIOU; - return a + STAmount{a.issue(), 1000}; + auto defAmt = STAmount{a.asset(), 30000}; + if (a <= defAmt) + return defAmt; + return a + STAmount{a.asset(), 1000}; }; auto const toFund1 = toFund(asset1); auto const toFund2 = toFund(asset2); BEAST_EXPECT(asset1 <= toFund1 && asset2 <= toFund2); + // asset1/asset2 could be dummy MPT. In this case real MPT + // is created by fund(), which returns the funded amounts. + // The amounts then can be used to figure out the created + // MPT if any. + std::vector funded; if (!asset1.native() && !asset2.native()) { - fund(env, gw, {alice, carol}, {toFund1, toFund2}, Fund::All); + funded = fund(env, gw, {alice, carol}, {toFund1, toFund2}, Fund::All); } else if (asset1.native()) { - fund(env, gw, {alice, carol}, toFund1, {toFund2}, Fund::All); + funded = fund(env, gw, {alice, carol}, toFund1, {toFund2}, Fund::All); + funded.insert(funded.begin(), toFund1); } else if (asset2.native()) { - fund(env, gw, {alice, carol}, toFund2, {toFund1}, Fund::All); + funded = fund(env, gw, {alice, carol}, toFund2, {toFund1}, Fund::All); + funded.push_back(toFund2); } + auto const pool1 = STAmount{funded[0].asset(), static_cast(asset1)}; + auto const pool2 = STAmount{funded[1].asset(), static_cast(asset2)}; + AMM ammAlice( - env, alice, asset1, asset2, CreateArg{.log = false, .tfee = arg.tfee, .err = arg.ter}); - if (BEAST_EXPECT(ammAlice.expectBalances(asset1, asset2, ammAlice.tokens()))) + env, alice, pool1, pool2, CreateArg{.log = false, .tfee = arg.tfee, .err = arg.ter}); + if (BEAST_EXPECT(ammAlice.expectBalances(pool1, pool2, ammAlice.tokens()))) cb(ammAlice, env); } } @@ -173,111 +221,6 @@ AMMTest::pathTestEnv() return cfg; })); } - -Json::Value -AMMTest::find_paths_request( - jtx::Env& env, - jtx::Account const& src, - jtx::Account const& dst, - STAmount const& saDstAmount, - std::optional const& saSendMax, - std::optional const& saSrcCurrency) -{ - using namespace jtx; - - auto& app = env.app(); - Resource::Charge loadType = Resource::feeReferenceRPC; - Resource::Consumer c; - - RPC::JsonContext context{ - {env.journal, - app, - loadType, - app.getOPs(), - app.getLedgerMaster(), - c, - Role::USER, - {}, - {}, - RPC::apiVersionIfUnspecified}, - {}, - {}}; - - Json::Value params = Json::objectValue; - params[jss::command] = "ripple_path_find"; - params[jss::source_account] = toBase58(src); - params[jss::destination_account] = toBase58(dst); - params[jss::destination_amount] = saDstAmount.getJson(JsonOptions::none); - if (saSendMax) - params[jss::send_max] = saSendMax->getJson(JsonOptions::none); - if (saSrcCurrency) - { - auto& sc = params[jss::source_currencies] = Json::arrayValue; - Json::Value j = Json::objectValue; - j[jss::currency] = to_string(saSrcCurrency.value()); - sc.append(j); - } - - Json::Value result; - gate g; - app.getJobQueue().postCoro(jtCLIENT, "RPC-Client", [&](auto const& coro) { - context.params = std::move(params); - context.coro = coro; - RPC::doCommand(context, result); - g.signal(); - }); - - using namespace std::chrono_literals; - BEAST_EXPECT(g.wait_for(5s)); - BEAST_EXPECT(!result.isMember(jss::error)); - return result; -} - -std::tuple -AMMTest::find_paths( - jtx::Env& env, - jtx::Account const& src, - jtx::Account const& dst, - STAmount const& saDstAmount, - std::optional const& saSendMax, - std::optional const& saSrcCurrency) -{ - Json::Value result = find_paths_request(env, src, dst, saDstAmount, saSendMax, saSrcCurrency); - BEAST_EXPECT(!result.isMember(jss::error)); - - STAmount da; - if (result.isMember(jss::destination_amount)) - da = amountFromJson(sfGeneric, result[jss::destination_amount]); - - STAmount sa; - STPathSet paths; - if (result.isMember(jss::alternatives)) - { - auto const& alts = result[jss::alternatives]; - if (alts.size() > 0) - { - auto const& path = alts[0u]; - - if (path.isMember(jss::source_amount)) - sa = amountFromJson(sfGeneric, path[jss::source_amount]); - - if (path.isMember(jss::destination_amount)) - da = amountFromJson(sfGeneric, path[jss::destination_amount]); - - if (path.isMember(jss::paths_computed)) - { - Json::Value p; - p["Paths"] = path[jss::paths_computed]; - STParsedJSONObject po("generic", p); - // NOLINTNEXTLINE(bugprone-unchecked-optional-access) - paths = po.object->getFieldPathSet(sfPaths); - } - } - } - - return std::make_tuple(std::move(paths), std::move(sa), std::move(da)); -} - } // namespace jtx } // namespace test } // namespace xrpl diff --git a/src/test/jtx/impl/Account.cpp b/src/test/jtx/impl/Account.cpp index a7b71ea6eb..7a43fdc23d 100644 --- a/src/test/jtx/impl/Account.cpp +++ b/src/test/jtx/impl/Account.cpp @@ -1,8 +1,24 @@ #include + #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/Env.cpp b/src/test/jtx/impl/Env.cpp index 3f49a54ae6..b2b191a84d 100644 --- a/src/test/jtx/impl/Env.cpp +++ b/src/test/jtx/impl/Env.cpp @@ -1,25 +1,48 @@ #include + +#include #include +#include +#include +#include #include #include #include #include #include #include +#include #include #include +#include #include +#include +#include #include -#include +#include +#include +#include #include +#include #include +#include +#include +#include #include +#include #include #include +#include +#include #include #include +#include +#include +#include +#include +#include #include #include #include @@ -27,8 +50,20 @@ #include #include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -174,54 +209,47 @@ Env::balance(Account const& account) const } PrettyAmount -Env::balance(Account const& account, Issue const& issue) const -{ - if (isXRP(issue.currency)) - return balance(account); - auto const sle = le(keylet::line(account.id(), issue)); - if (!sle) - return {STAmount(issue, 0), account.name()}; - auto amount = sle->getFieldAmount(sfBalance); - amount.setIssuer(issue.account); - if (account.id() > issue.account) - amount.negate(); - return {amount, lookup(issue.account).name()}; -} - -PrettyAmount -Env::balance(Account const& account, MPTIssue const& mptIssue) const -{ - MPTID const id = mptIssue.getMptID(); - if (!id) - return {STAmount(mptIssue, 0), account.name()}; - - AccountID const issuer = mptIssue.getIssuer(); - if (account.id() == issuer) - { - // Issuer balance - auto const sle = le(keylet::mptIssuance(id)); - if (!sle) - return {STAmount(mptIssue, 0), account.name()}; - - // Make it negative - STAmount const amount{mptIssue, sle->getFieldU64(sfOutstandingAmount), 0, true}; - return {amount, lookup(issuer).name()}; - } - - // Holder balance - auto const sle = le(keylet::mptoken(id, account)); - if (!sle) - return {STAmount(mptIssue, 0), account.name()}; - - STAmount const amount{mptIssue, sle->getFieldU64(sfMPTAmount)}; - return {amount, lookup(issuer).name()}; -} - -PrettyAmount -// NOLINTNEXTLINE(readability-convert-member-functions-to-static) Env::balance(Account const& account, Asset const& asset) const { - return std::visit([&](auto const& issue) { return balance(account, issue); }, asset.value()); + return asset.visit( + [&](Issue const& issue) -> PrettyAmount { + if (isXRP(issue.currency)) + return balance(account); + auto const sle = le(keylet::line(account.id(), issue)); + if (!sle) + return {STAmount(issue, 0), account.name()}; + auto amount = sle->getFieldAmount(sfBalance); + amount.get().account = issue.account; + if (account.id() > issue.account) + amount.negate(); + return {amount, lookup(issue.account).name()}; + }, + [&](MPTIssue const& mptIssue) -> PrettyAmount { + MPTID const& id = mptIssue.getMptID(); + if (!id) + return {STAmount(mptIssue, 0), account.name()}; + + AccountID const& issuer = mptIssue.getIssuer(); + if (account.id() == issuer) + { + // Issuer balance + auto const sle = le(keylet::mptIssuance(id)); + if (!sle) + return {STAmount(mptIssue, 0), account.name()}; + + // Make it negative + STAmount const amount{mptIssue, sle->getFieldU64(sfOutstandingAmount), 0, true}; + return {amount, lookup(issuer).name()}; + } + + // Holder balance + auto const sle = le(keylet::mptoken(id, account)); + if (!sle) + return {STAmount(mptIssue, 0), account.name()}; + + STAmount const amount{mptIssue, sle->getFieldU64(sfMPTAmount)}; + return {amount, lookup(issuer).name()}; + }); } PrettyAmount @@ -300,6 +328,8 @@ Env::fund(bool setDefaultRipple, STAmount const& amount, Account const& account) void Env::trust(STAmount const& amount, Account const& account) { + if (!amount.holds()) + Throw("Env::trust: amount doesn't hold Issue"); auto const start = balance(account); apply( jtx::trust(account, amount), @@ -512,7 +542,7 @@ Env::autofill_sig(JTx& jt) { auto& jv = jt.jv; - scope_success success([&]() { + scope_success const success([&]() { // Call all the post-signers after the main signers or autofill are done for (auto const& signer : jt.postSigners) signer(*this, jt); @@ -561,7 +591,7 @@ Env::autofill(JTx& jt) if (jt.fill_netid) { - uint32_t networkID = app().getNetworkIDService().getNetworkID(); + uint32_t const networkID = app().getNetworkIDService().getNetworkID(); if (!jv.isMember(jss::NetworkID) && networkID > 1024) jv[jss::NetworkID] = std::to_string(networkID); } diff --git a/src/test/jtx/impl/JSONRPCClient.cpp b/src/test/jtx/impl/JSONRPCClient.cpp index 6b60744aad..07216a23ad 100644 --- a/src/test/jtx/impl/JSONRPCClient.cpp +++ b/src/test/jtx/impl/JSONRPCClient.cpp @@ -1,17 +1,34 @@ #include +#include + +#include + +#include +#include #include +#include #include #include #include -#include +#include +#include +#include +#include +#include +#include #include #include #include #include +#include #include +#include +#include +#include +#include #include namespace xrpl { @@ -31,7 +48,7 @@ class JSONRPCClient : public AbstractClient continue; ParsedPort pp; parse_Port(pp, cfg[name], log); - if (pp.protocol.count("http") == 0) + if (not pp.protocol.contains("http")) continue; using namespace boost::asio::ip; if (pp.ip && pp.ip->is_unspecified()) @@ -74,12 +91,6 @@ public: stream_.connect(ep_); } - ~JSONRPCClient() override - { - // stream_.shutdown(boost::asio::ip::tcp::socket::shutdown_both); - // stream_.close(); - } - /* Return value is an Object type with up to three keys: status diff --git a/src/test/jtx/impl/Oracle.cpp b/src/test/jtx/impl/Oracle.cpp index 0c9ddc8f0d..c98d649fb2 100644 --- a/src/test/jtx/impl/Oracle.cpp +++ b/src/test/jtx/impl/Oracle.cpp @@ -1,24 +1,45 @@ #include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include -#include +#include // IWYU pragma: keep +#include -#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { namespace jtx { namespace oracle { -Oracle::Oracle(Env& env, CreateArg const& arg, bool submit) : env_(env), documentID_{} +Oracle::Oracle(Env& env, CreateArg const& arg, bool submit) : env_(env) { // LastUpdateTime is checked to be in range // {close-maxLastUpdateTimeDelta, close+maxLastUpdateTimeDelta}. // To make the validation work and to make the clock consistent // for tests running at different time, simulate Unix time starting - // on testStartTime since Ripple epoch. + // on testStartTime since XRPL epoch. auto const now = env_.timeKeeper().now(); if (now.time_since_epoch().count() == 0 || arg.close) env_.close(now + testStartTime - epoch_offset); diff --git a/src/test/jtx/impl/TestHelpers.cpp b/src/test/jtx/impl/TestHelpers.cpp index e10a0c46d0..51fede19d7 100644 --- a/src/test/jtx/impl/TestHelpers.cpp +++ b/src/test/jtx/impl/TestHelpers.cpp @@ -1,9 +1,65 @@ #include + +#include +#include +#include +#include // IWYU pragma: keep +#include +#include #include #include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -55,7 +111,7 @@ stpath_append_one(STPath& st, STPathElement const& pe) bool equal(STAmount const& sa1, STAmount const& sa2) { - return sa1 == sa2 && sa1.issue().account == sa2.issue().account; + return sa1 == sa2 && sa1.getIssuer() == sa2.getIssuer(); } // Issue path element @@ -65,9 +121,211 @@ IPE(Issue const& iss) return STPathElement( STPathElement::typeCurrency | STPathElement::typeIssuer, xrpAccount(), - iss.currency, + PathAsset{iss.currency}, iss.account); } +STPathElement +IPE(MPTIssue const& iss) +{ + return STPathElement( + STPathElement::typeMPT | STPathElement::typeIssuer, + xrpAccount(), + PathAsset{iss.getMptID()}, + iss.getIssuer()); +} + +static void +addSourceAsset( + Json::Value& jv, + PathAsset const& srcAsset, + std::optional const& srcIssuer) +{ + std::visit( + [&](TAsset const& asset) { + if constexpr (std::is_same_v) + { + jv[jss::currency] = to_string(asset); + if (srcIssuer) + jv[jss::issuer] = to_string(*srcIssuer); + } + else + { + if (srcIssuer) + Throw("MPT source_currencies can't have issuer"); + jv[jss::mpt_issuance_id] = to_string(asset); + } + }, + srcAsset.value()); +} + +Json::Value +rpf(jtx::Account const& src, + jtx::Account const& dst, + STAmount const& dstAmount, + std::optional const& sendMax, + std::optional const& srcAsset, + std::optional const& srcIssuer) +{ + Json::Value jv = Json::objectValue; + jv[jss::command] = "ripple_path_find"; + jv[jss::source_account] = toBase58(src); + jv[jss::destination_account] = toBase58(dst); + jv[jss::destination_amount] = dstAmount.getJson(JsonOptions::none); + if (sendMax) + jv[jss::send_max] = sendMax->getJson(JsonOptions::none); + if (srcAsset) + { + auto& sc = jv[jss::source_currencies] = Json::arrayValue; + Json::Value j = Json::objectValue; + addSourceAsset(j, *srcAsset, srcIssuer); + sc.append(j); + } + + return jv; +} + +jtx::Env +pathTestEnv(beast::unit_test::suite& suite) +{ + // These tests were originally written with search parameters that are + // different from the current defaults. This function creates an env + // with the search parameters that the tests were written for. + using namespace jtx; + return Env(suite, envconfig([](std::unique_ptr cfg) { + cfg->PATH_SEARCH_OLD = 7; + cfg->PATH_SEARCH = 7; + cfg->PATH_SEARCH_MAX = 10; + return cfg; + })); +} + +Json::Value +find_paths_request( + jtx::Env& env, + jtx::Account const& src, + jtx::Account const& dst, + STAmount const& saDstAmount, + std::optional const& saSendMax, + std::optional const& srcAsset, + std::optional const& srcIssuer, + std::optional const& domain) +{ + using namespace jtx; + + auto& app = env.app(); + Resource::Charge loadType = Resource::feeReferenceRPC; + Resource::Consumer c; + + RPC::JsonContext context{ + {env.journal, + app, + loadType, + app.getOPs(), + app.getLedgerMaster(), + c, + Role::USER, + {}, + {}, + RPC::apiVersionIfUnspecified}, + {}, + {}}; + + Json::Value params = Json::objectValue; + params[jss::command] = "ripple_path_find"; + params[jss::source_account] = toBase58(src); + params[jss::destination_account] = toBase58(dst); + params[jss::destination_amount] = saDstAmount.getJson(JsonOptions::none); + if (saSendMax) + params[jss::send_max] = saSendMax->getJson(JsonOptions::none); + + if (srcAsset) + { + auto& sc = params[jss::source_currencies] = Json::arrayValue; + Json::Value j = Json::objectValue; + addSourceAsset(j, *srcAsset, srcIssuer); + sc.append(j); + } + + if (domain) + params[jss::domain] = to_string(*domain); + + Json::Value result; + gate g; + app.getJobQueue().postCoro(jtCLIENT, "RPC-Client", [&](auto const& coro) { + context.params = std::move(params); + context.coro = coro; + RPC::doCommand(context, result); + g.signal(); + }); + + using namespace std::chrono_literals; + using namespace beast::unit_test; + g.wait_for(5s); + return result; +} + +std::tuple +find_paths( + jtx::Env& env, + jtx::Account const& src, + jtx::Account const& dst, + STAmount const& saDstAmount, + std::optional const& saSendMax, + std::optional const& srcAsset, + std::optional const& srcIssuer, + std::optional const& domain) +{ + Json::Value result = + find_paths_request(env, src, dst, saDstAmount, saSendMax, srcAsset, srcIssuer, domain); + if (result.isMember(jss::error)) + return std::make_tuple(STPathSet{}, STAmount{}, STAmount{}); + + STAmount da; + if (result.isMember(jss::destination_amount)) + da = amountFromJson(sfGeneric, result[jss::destination_amount]); + + STAmount sa; + STPathSet paths; + if (result.isMember(jss::alternatives)) + { + auto const& alts = result[jss::alternatives]; + if (alts.size() > 0) + { + auto const& path = alts[0u]; + + if (path.isMember(jss::source_amount)) + sa = amountFromJson(sfGeneric, path[jss::source_amount]); + + if (path.isMember(jss::destination_amount)) + da = amountFromJson(sfGeneric, path[jss::destination_amount]); + + if (path.isMember(jss::paths_computed)) + { + Json::Value p; + p["Paths"] = path[jss::paths_computed]; + STParsedJSONObject po("generic", p); + paths = po.object->getFieldPathSet(sfPaths); + } + } + } + + return std::make_tuple(std::move(paths), std::move(sa), std::move(da)); +} + +std::tuple +find_paths_by_element( + jtx::Env& env, + jtx::Account const& src, + jtx::Account const& dst, + STAmount const& saDstAmount, + std::optional const& saSendMax, + std::optional const& srcElement, + std::optional const& srcIssuer, + std::optional const& domain) +{ + return find_paths( + env, src, dst, saDstAmount, saSendMax, srcElement->getPathAsset(), srcIssuer, domain); +} /******************************************************************************/ @@ -87,9 +345,9 @@ xrpMinusFee(Env const& env, std::int64_t xrpAmount) [[nodiscard]] bool expectHolding(Env& env, AccountID const& account, STAmount const& value, bool defaultLimits) { - if (auto const sle = env.le(keylet::line(account, value.issue()))) + if (auto const sle = env.le(keylet::line(account, value.get()))) { - Issue const issue = value.issue(); + Issue const issue = value.get(); bool const accountLow = account < issue.account; bool expectDefaultTrustLine = true; @@ -98,15 +356,15 @@ expectHolding(Env& env, AccountID const& account, STAmount const& value, bool de STAmount low{issue}; STAmount high{issue}; - low.setIssuer(accountLow ? account : issue.account); - high.setIssuer(accountLow ? issue.account : account); + low.get().account = accountLow ? account : issue.account; + high.get().account = accountLow ? issue.account : account; expectDefaultTrustLine = sle->getFieldAmount(sfLowLimit) == low && sle->getFieldAmount(sfHighLimit) == high; } auto amount = sle->getFieldAmount(sfBalance); - amount.setIssuer(value.issue().account); + amount.get().account = value.getIssuer(); if (!accountLow) amount.negate(); return amount == value && expectDefaultTrustLine; @@ -134,6 +392,14 @@ expectHolding(Env& env, AccountID const& account, None const& value) value.asset.value()); } +[[nodiscard]] bool +expectMPT(Env& env, AccountID const& account, STAmount const& value) +{ + auto const mptIssuanceID = keylet::mptIssuance(value.asset().get()); + auto const mptToken = env.le(keylet::mptoken(mptIssuanceID.key, account)); + return mptToken && (*mptToken)[sfMPTAmount] == value.mpt().value(); +} + [[nodiscard]] bool expectOffers( Env& env, @@ -157,7 +423,7 @@ expectOffers( } return true; }); - return size == cnt && matched == toMatch.size(); + return size == cnt && ((toMatch.empty() && size != 0) || (matched == toMatch.size())); } Json::Value @@ -185,6 +451,34 @@ ledgerEntryState( return env.rpc("json", "ledger_entry", to_string(jvParams))[jss::result]; } +Json::Value +ledgerEntryOffer(jtx::Env& env, jtx::Account const& acct, std::uint32_t offer_seq) +{ + Json::Value jvParams; + jvParams[jss::offer][jss::account] = acct.human(); + jvParams[jss::offer][jss::seq] = offer_seq; + return env.rpc("json", "ledger_entry", to_string(jvParams))[jss::result]; +} + +Json::Value +ledgerEntryMPT(jtx::Env& env, jtx::Account const& acct, MPTID const& mptID) +{ + Json::Value jvParams; + jvParams[jss::mptoken][jss::account] = acct.human(); + jvParams[jss::mptoken][jss::mpt_issuance_id] = to_string(mptID); + return env.rpc("json", "ledger_entry", to_string(jvParams))[jss::result]; +} + +Json::Value +getBookOffers(jtx::Env& env, Asset const& taker_pays, Asset const& taker_gets) +{ + Json::Value jvbp; + jvbp[jss::ledger_index] = "current"; + taker_pays.setJson(jvbp[jss::taker_pays]); + taker_gets.setJson(jvbp[jss::taker_gets]); + return env.rpc("json", "book_offers", to_string(jvbp))[jss::result]; +} + Json::Value accountBalance(Env& env, Account const& acct) { @@ -312,22 +606,133 @@ n_offers(Env& env, std::size_t n, Account const& account, STAmount const& in, ST // Currency path element STPathElement -cpe(Currency const& c) +cpe(PathAsset const& pa) { - return STPathElement(STPathElement::typeCurrency, xrpAccount(), c, xrpAccount()); + return pa.visit( + [](Currency const& currency) { + return STPathElement(STPathElement::typeCurrency, xrpAccount(), currency, xrpAccount()); + }, + [](MPTID const& mpt) { + return STPathElement(STPathElement::typeMPT, xrpAccount(), mpt, xrpAccount()); + }); }; // All path element STPathElement -allPathElements(AccountID const& a, Issue const& iss) +allPathElements(AccountID const& a, Asset const& asset) { - return STPathElement( - STPathElement::typeAccount | STPathElement::typeCurrency | STPathElement::typeIssuer, - a, - iss.currency, - iss.account); + return STPathElement(a, asset, asset.getIssuer()); }; +STPathElement +ipe(Asset const& asset) +{ + return asset.visit( + [](Issue const& issue) { + return STPathElement( + STPathElement::typeCurrency | STPathElement::typeIssuer, + xrpAccount(), + issue.currency, + issue.account); + }, + [](MPTIssue const& issue) { + return STPathElement( + STPathElement::typeMPT | STPathElement::typeIssuer, + xrpAccount(), + issue.getMptID(), + issue.getIssuer()); + }); +}; + +// Issuer path element +STPathElement +iape(AccountID const& account) +{ + return STPathElement(STPathElement::typeIssuer, xrpAccount(), xrpCurrency(), account); +}; + +// Account path element +STPathElement +ape(AccountID const& a) +{ + return STPathElement(STPathElement::typeAccount, a, xrpCurrency(), xrpAccount()); +}; + +bool +equal(std::unique_ptr const& s1, DirectStepInfo const& dsi) +{ + if (!s1) + return false; + return test::directStepEqual(*s1, dsi.src, dsi.dst, dsi.currency); +} + +bool +equal(std::unique_ptr const& s1, MPTEndpointStepInfo const& dsi) +{ + if (!s1) + return false; + return test::mptEndpointStepEqual(*s1, dsi.src, dsi.dst, dsi.mptid); +} + +bool +equal(std::unique_ptr const& s1, XRPEndpointStepInfo const& xrpStepInfo) +{ + if (!s1) + return false; + return test::xrpEndpointStepEqual(*s1, xrpStepInfo.acc); +} + +bool +equal(std::unique_ptr const& s1, xrpl::Book const& bsi) +{ + if (!s1) + return false; + return bookStepEqual(*s1, bsi); +} + +namespace detail { + +IOU +issueHelperIOU(IssuerArgs const& args) +{ + auto const iou = args.issuer[args.token]; + if (args.transferFee != 0) + { + auto const tfee = 1. + (static_cast(args.transferFee) / 100'000); + args.env(rate(args.issuer, tfee)); + } + for (auto const& account : args.holders) + { + args.env(trust(account, iou(args.limit.value_or(1'000)))); + } + return iou; +} + +MPT +issueHelperMPT(IssuerArgs const& args) +{ + using namespace jtx; + if (args.limit) + { + MPT const mpt = MPTTester( + {.env = args.env, + .issuer = args.issuer, + .holders = args.holders, + .transferFee = args.transferFee, + .maxAmt = args.limit}); + return mpt; + } + + MPT const mpt = MPTTester( + {.env = args.env, + .issuer = args.issuer, + .holders = args.holders, + .transferFee = args.transferFee}); + return mpt; +} + +} // namespace detail + /* LoanBroker */ /******************************************************************************/ diff --git a/src/test/jtx/impl/WSClient.cpp b/src/test/jtx/impl/WSClient.cpp index ebe4721d60..ad5958a2e6 100644 --- a/src/test/jtx/impl/WSClient.cpp +++ b/src/test/jtx/impl/WSClient.cpp @@ -1,20 +1,46 @@ -#include #include +#include + +#include +#include #include +#include #include #include #include +#include +#include #include #include +#include +#include +#include +#include #include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include #include +#include namespace xrpl { namespace test { @@ -184,7 +210,14 @@ public: jp[jss::command] = cmd; } auto const s = to_string(jp); - ws_.write_some(true, buffer(s)); + + // Use the error_code overload to avoid an unhandled exception + // when the server closes the WebSocket connection (e.g. after + // booting a client that exceeded resource thresholds). + error_code ec; + ws_.write_some(true, buffer(s), ec); + if (ec) + return {}; } auto jv = @@ -272,7 +305,7 @@ private: rb_.consume(rb_.size()); auto m = std::make_shared(std::move(jv)); { - std::lock_guard lock(m_); + std::lock_guard const lock(m_); msgs_.push_front(m); cv_.notify_all(); } @@ -286,7 +319,7 @@ private: void on_read_done() { - std::lock_guard lock(m0_); + std::lock_guard const lock(m0_); b0_ = true; cv0_.notify_all(); } diff --git a/src/test/jtx/impl/account_txn_id.cpp b/src/test/jtx/impl/account_txn_id.cpp index ceda6e7b50..ff067dbca5 100644 --- a/src/test/jtx/impl/account_txn_id.cpp +++ b/src/test/jtx/impl/account_txn_id.cpp @@ -1,5 +1,10 @@ #include +#include +#include + +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/acctdelete.cpp b/src/test/jtx/impl/acctdelete.cpp index 0b87d501dd..11afb7d38b 100644 --- a/src/test/jtx/impl/acctdelete.cpp +++ b/src/test/jtx/impl/acctdelete.cpp @@ -1,8 +1,15 @@ -#include #include +#include +#include + +#include +#include +#include #include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/amount.cpp b/src/test/jtx/impl/amount.cpp index 25fcb5c8f0..521f178a2c 100644 --- a/src/test/jtx/impl/amount.cpp +++ b/src/test/jtx/impl/amount.cpp @@ -1,33 +1,25 @@ -#include #include -#include +#include +#include +#include +#include +#include +#include + +#include +#include #include +#include +#include +#include +#include namespace xrpl { namespace test { namespace jtx { -#if 0 -std::ostream& -operator<<(std::ostream&& os, - AnyAmount const& amount) -{ - if (amount.is_any) - { - os << amount.value.getText() << "/" << - to_string(amount.value.issue().currency) << - "*"; - return os; - } - os << amount.value.getText() << "/" << - to_string(amount.value.issue().currency) << - "(" << amount.name() << ")"; - return os; -} -#endif - PrettyAmount:: operator AnyAmount() const { @@ -54,39 +46,45 @@ to_places(T const d, std::uint8_t places) std::ostream& operator<<(std::ostream& os, PrettyAmount const& amount) { - if (amount.value().native()) - { - // measure in hundredths - auto const c = dropsPerXRP.drops() / 100; - auto const n = amount.value().mantissa(); - if (n < c) - { - if (amount.value().negative()) + amount.value().asset().visit( + [&](Issue const& issue) { + if (issue.native()) { - os << "-" << n << " drops"; + // measure in hundredths + auto const c = dropsPerXRP.drops() / 100; + auto const n = amount.value().mantissa(); + if (n < c) + { + if (amount.value().negative()) + { + os << "-" << n << " drops"; + } + else + { + os << n << " drops"; + } + } + else + { + auto const d = double(n) / dropsPerXRP.drops(); + if (amount.value().negative()) + { + os << "-"; + } + + os << to_places(d, 6) << " XRP"; + } } else { - os << n << " drops"; + os << amount.value().getText() << "/" << to_string(issue.currency) << "(" + << amount.name() << ")"; } - return os; - } - auto const d = double(n) / dropsPerXRP.drops(); - if (amount.value().negative()) - os << "-"; - - os << to_places(d, 6) << " XRP"; - } - else if (amount.value().holds()) - { - os << amount.value().getText() << "/" << to_string(amount.value().issue().currency) << "(" - << amount.name() << ")"; - } - else - { - auto const& mptIssue = amount.value().asset().get(); - os << amount.value().getText() << "/" << to_string(mptIssue) << "(" << amount.name() << ")"; - } + }, + [&](MPTIssue const& issue) { + os << amount.value().getText() << "/" << to_string(issue) << "(" << amount.name() + << ")"; + }); return os; } @@ -101,7 +99,7 @@ IOU::operator()(epsilon_t) const } PrettyAmount -IOU::operator()(detail::epsilon_multiple m) const +IOU::operator()(xrpl::detail::epsilon_multiple m) const { return {STAmount(issue(), safe_cast(m.n), -81), account.name()}; } @@ -109,7 +107,14 @@ IOU::operator()(detail::epsilon_multiple m) const std::ostream& operator<<(std::ostream& os, IOU const& iou) { - os << to_string(iou.issue().currency) << "(" << iou.account.name() << ")"; + os << to_string(iou.currency) << "(" << iou.account.name() << ")"; + return os; +} + +std::ostream& +operator<<(std::ostream& os, MPT const& mpt) +{ + os << to_string(mpt.issuanceID); return os; } diff --git a/src/test/jtx/impl/attester.cpp b/src/test/jtx/impl/attester.cpp index d4693e69fb..36c5870332 100644 --- a/src/test/jtx/impl/attester.cpp +++ b/src/test/jtx/impl/attester.cpp @@ -1,10 +1,15 @@ #include +#include #include +#include #include #include #include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/balance.cpp b/src/test/jtx/impl/balance.cpp index 1c3cc0b3c3..de1c4b977c 100644 --- a/src/test/jtx/impl/balance.cpp +++ b/src/test/jtx/impl/balance.cpp @@ -1,5 +1,16 @@ #include +#include + +#include +#include +#include +#include +#include +#include + +#include + namespace xrpl { namespace test { namespace jtx { @@ -35,8 +46,8 @@ doBalance(Env& env, AccountID const& account, bool none, STAmount const& value, else if (TEST_EXPECT(sle)) { auto amount = sle->getFieldAmount(sfBalance); - amount.setIssuer(issue.account); - if (account > issue.account) + amount.get().account = value.getIssuer(); + if (account > value.getIssuer()) amount.negate(); TEST_EXPECTS(amount == value, amount.getText()); } diff --git a/src/test/jtx/impl/batch.cpp b/src/test/jtx/impl/batch.cpp index 65aca2a935..126b7c4d75 100644 --- a/src/test/jtx/impl/batch.cpp +++ b/src/test/jtx/impl/batch.cpp @@ -1,13 +1,32 @@ #include + +#include +#include +#include #include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include #include -#include +#include +#include namespace xrpl { namespace test { diff --git a/src/test/jtx/impl/check.cpp b/src/test/jtx/impl/check.cpp index 22f348aa3f..610fa48755 100644 --- a/src/test/jtx/impl/check.cpp +++ b/src/test/jtx/impl/check.cpp @@ -1,6 +1,11 @@ #include -#include +#include + +#include +#include +#include +#include #include namespace xrpl { diff --git a/src/test/jtx/impl/creds.cpp b/src/test/jtx/impl/creds.cpp index e1018cc0e5..380ab7a2e9 100644 --- a/src/test/jtx/impl/creds.cpp +++ b/src/test/jtx/impl/creds.cpp @@ -1,8 +1,15 @@ +#include +#include #include -#include +#include +#include +#include +#include #include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/delegate.cpp b/src/test/jtx/impl/delegate.cpp index 7cca9aa738..a1e4a42639 100644 --- a/src/test/jtx/impl/delegate.cpp +++ b/src/test/jtx/impl/delegate.cpp @@ -1,7 +1,16 @@ #include +#include +#include + +#include +#include +#include #include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/delivermin.cpp b/src/test/jtx/impl/delivermin.cpp index a5c1414525..bdb3ce35fd 100644 --- a/src/test/jtx/impl/delivermin.cpp +++ b/src/test/jtx/impl/delivermin.cpp @@ -1,5 +1,8 @@ #include +#include +#include + #include namespace xrpl { diff --git a/src/test/jtx/impl/deposit.cpp b/src/test/jtx/impl/deposit.cpp index 4a2ecf0139..c550719391 100644 --- a/src/test/jtx/impl/deposit.cpp +++ b/src/test/jtx/impl/deposit.cpp @@ -1,7 +1,14 @@ #include +#include + +#include +#include #include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/dids.cpp b/src/test/jtx/impl/dids.cpp index bb782bcd43..33cc10e895 100644 --- a/src/test/jtx/impl/dids.cpp +++ b/src/test/jtx/impl/dids.cpp @@ -1,6 +1,10 @@ +#include #include -#include +#include +#include +#include +#include #include namespace xrpl { diff --git a/src/test/jtx/impl/directory.cpp b/src/test/jtx/impl/directory.cpp index da0a338e7c..cc756aec46 100644 --- a/src/test/jtx/impl/directory.cpp +++ b/src/test/jtx/impl/directory.cpp @@ -1,6 +1,22 @@ #include +#include + +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include + +#include +#include +#include namespace xrpl::test::jtx { diff --git a/src/test/jtx/impl/domain.cpp b/src/test/jtx/impl/domain.cpp index 91568783d2..8255159310 100644 --- a/src/test/jtx/impl/domain.cpp +++ b/src/test/jtx/impl/domain.cpp @@ -1,6 +1,10 @@ #include -#include +#include +#include + +#include +#include namespace xrpl { namespace test { diff --git a/src/test/jtx/impl/envconfig.cpp b/src/test/jtx/impl/envconfig.cpp index e31e687c3d..47e9d9e098 100644 --- a/src/test/jtx/impl/envconfig.cpp +++ b/src/test/jtx/impl/envconfig.cpp @@ -1,8 +1,15 @@ -#include #include +#include + +#include #include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -125,6 +132,49 @@ addGrpcConfigWithSecureGateway(std::unique_ptr cfg, std::string const& s return cfg; } +std::unique_ptr +addGrpcConfigWithTLS( + std::unique_ptr cfg, + std::string const& certPath, + std::string const& keyPath) +{ + (*cfg)[SECTION_PORT_GRPC].set("ip", getEnvLocalhostAddr()); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", certPath); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", keyPath); + return cfg; +} + +std::unique_ptr +addGrpcConfigWithTLSAndClientCA( + std::unique_ptr cfg, + std::string const& certPath, + std::string const& keyPath, + std::string const& clientCAPath) +{ + (*cfg)[SECTION_PORT_GRPC].set("ip", getEnvLocalhostAddr()); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", certPath); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", keyPath); + (*cfg)[SECTION_PORT_GRPC].set("ssl_client_ca", clientCAPath); + return cfg; +} + +std::unique_ptr +addGrpcConfigWithTLSAndCertChain( + std::unique_ptr cfg, + std::string const& certPath, + std::string const& keyPath, + std::string const& certChainPath) +{ + (*cfg)[SECTION_PORT_GRPC].set("ip", getEnvLocalhostAddr()); + (*cfg)[SECTION_PORT_GRPC].set("port", "0"); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert", certPath); + (*cfg)[SECTION_PORT_GRPC].set("ssl_key", keyPath); + (*cfg)[SECTION_PORT_GRPC].set("ssl_cert_chain", certChainPath); + return cfg; +} + std::unique_ptr makeConfig( std::map extraTxQ, diff --git a/src/test/jtx/impl/escrow.cpp b/src/test/jtx/impl/escrow.cpp index 067c304178..e5509fe8c5 100644 --- a/src/test/jtx/impl/escrow.cpp +++ b/src/test/jtx/impl/escrow.cpp @@ -1,8 +1,19 @@ #include +#include +#include + +#include +#include +#include +#include +#include +#include #include #include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/fee.cpp b/src/test/jtx/impl/fee.cpp index fc05afcb46..76acf16d64 100644 --- a/src/test/jtx/impl/fee.cpp +++ b/src/test/jtx/impl/fee.cpp @@ -1,6 +1,11 @@ #include -#include +#include +#include + +#include + +#include namespace xrpl { namespace test { diff --git a/src/test/jtx/impl/flags.cpp b/src/test/jtx/impl/flags.cpp index aee01a107e..cb4f89a38f 100644 --- a/src/test/jtx/impl/flags.cpp +++ b/src/test/jtx/impl/flags.cpp @@ -1,7 +1,14 @@ #include +#include +#include + +#include +#include #include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/invoice_id.cpp b/src/test/jtx/impl/invoice_id.cpp index 6d6dae0fbf..b0c18d573e 100644 --- a/src/test/jtx/impl/invoice_id.cpp +++ b/src/test/jtx/impl/invoice_id.cpp @@ -1,5 +1,10 @@ #include +#include +#include + +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/jtx_json.cpp b/src/test/jtx/impl/jtx_json.cpp index c39503d038..e60e3d1b6d 100644 --- a/src/test/jtx/impl/jtx_json.cpp +++ b/src/test/jtx/impl/jtx_json.cpp @@ -1,8 +1,15 @@ #include + +#include +#include #include #include #include +#include + +#include +#include namespace xrpl { namespace test { diff --git a/src/test/jtx/impl/last_ledger_sequence.cpp b/src/test/jtx/impl/last_ledger_sequence.cpp index 5f29282ad6..94fb128a08 100644 --- a/src/test/jtx/impl/last_ledger_sequence.cpp +++ b/src/test/jtx/impl/last_ledger_sequence.cpp @@ -1,5 +1,8 @@ #include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/ledgerStateFixes.cpp b/src/test/jtx/impl/ledgerStateFixes.cpp index e5a7495a44..def48d8bd8 100644 --- a/src/test/jtx/impl/ledgerStateFixes.cpp +++ b/src/test/jtx/impl/ledgerStateFixes.cpp @@ -1,6 +1,8 @@ +#include #include -#include +#include +#include #include #include diff --git a/src/test/jtx/impl/memo.cpp b/src/test/jtx/impl/memo.cpp index e503b9a073..842cdcfb2e 100644 --- a/src/test/jtx/impl/memo.cpp +++ b/src/test/jtx/impl/memo.cpp @@ -1,5 +1,10 @@ #include +#include +#include + +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/mpt.cpp b/src/test/jtx/impl/mpt.cpp index 2b78777838..55d73dfcca 100644 --- a/src/test/jtx/impl/mpt.cpp +++ b/src/test/jtx/impl/mpt.cpp @@ -1,9 +1,42 @@ -#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { namespace jtx { @@ -84,6 +117,7 @@ makeMPTCreate(MPTInitDef const& arg) .transferFee = arg.transferFee, .pay = {{arg.holders, *arg.pay}}, .flags = arg.flags, + .mutableFlags = arg.mutableFlags, .authHolder = arg.authHolder}; } return { @@ -91,6 +125,7 @@ makeMPTCreate(MPTInitDef const& arg) .transferFee = arg.transferFee, .authorize = arg.holders, .flags = arg.flags, + .mutableFlags = arg.mutableFlags, .authHolder = arg.authHolder}; } @@ -140,7 +175,7 @@ MPTTester::create(MPTCreate const& arg) if (id_) Throw("MPT can't be reused"); id_ = makeMptID(env_.seq(issuer_), issuer_); - Json::Value jv = createJV( + Json::Value const jv = createJV( {.issuer = issuer_, .maxAmt = arg.maxAmt, .assetScale = arg.assetScale, @@ -217,7 +252,7 @@ MPTTester::destroy(MPTDestroy const& arg) { if (!arg.id && !id_) Throw("MPT has not been created"); - Json::Value jv = + Json::Value const jv = destroyJV({.issuer = arg.issuer ? arg.issuer : issuer_, .id = arg.id ? arg.id : id_}); submit(arg, jv); } @@ -251,7 +286,7 @@ MPTTester::authorize(MPTAuthorize const& arg) { if (!arg.id && !id_) Throw("MPT has not been created"); - Json::Value jv = authorizeJV({ + Json::Value const jv = authorizeJV({ .account = arg.account ? arg.account : issuer_, .holder = arg.holder, .id = arg.id ? arg.id : id_, @@ -361,7 +396,7 @@ MPTTester::set(MPTSet const& arg) { if (!arg.id && !id_) Throw("MPT has not been created"); - Json::Value jv = setJV( + Json::Value const jv = setJV( {.account = arg.account ? arg.account : issuer_, .holder = arg.holder, .id = arg.id ? arg.id : id_, diff --git a/src/test/jtx/impl/multisign.cpp b/src/test/jtx/impl/multisign.cpp index 02550b803c..192e0d5a5f 100644 --- a/src/test/jtx/impl/multisign.cpp +++ b/src/test/jtx/impl/multisign.cpp @@ -1,11 +1,29 @@ #include + +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include #include +#include +#include namespace xrpl { namespace test { @@ -78,7 +96,7 @@ msig::operator()(Env& env, JTx& jt) const jo[jss::Account] = e.acct.human(); jo[jss::SigningPubKey] = strHex(e.sig.pk().slice()); - Serializer ss{buildMultiSigningData(*st, e.acct.id())}; + Serializer const ss{buildMultiSigningData(*st, e.acct.id())}; auto const sig = xrpl::sign(*publicKeyType(e.sig.pk().slice()), e.sig.sk(), ss.slice()); jo[sfTxnSignature.getJsonName()] = strHex(Slice{sig.data(), sig.size()}); } diff --git a/src/test/jtx/impl/offer.cpp b/src/test/jtx/impl/offer.cpp index 5a2264601a..f2fc6c2764 100644 --- a/src/test/jtx/impl/offer.cpp +++ b/src/test/jtx/impl/offer.cpp @@ -1,7 +1,13 @@ #include +#include + +#include +#include #include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/owners.cpp b/src/test/jtx/impl/owners.cpp index 855c5b04ff..9099099d49 100644 --- a/src/test/jtx/impl/owners.cpp +++ b/src/test/jtx/impl/owners.cpp @@ -1,6 +1,16 @@ #include +#include + +#include +#include #include +#include +#include +#include + +#include +#include namespace xrpl { namespace detail { diff --git a/src/test/jtx/impl/paths.cpp b/src/test/jtx/impl/paths.cpp index af72b8bd5a..5231ed9a37 100644 --- a/src/test/jtx/impl/paths.cpp +++ b/src/test/jtx/impl/paths.cpp @@ -1,9 +1,23 @@ #include +#include +#include +#include + +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include namespace xrpl { @@ -30,11 +44,11 @@ paths::operator()(Env& env, JTx& jt) const } Pathfinder pf( - std::make_shared(env.current(), env.app().getJournal("RippleLineCache")), + std::make_shared(env.current(), env.app().getJournal("AssetCache")), from, to, - in_.currency, - in_.account, + in_, + in_.getIssuer(), amount, std::nullopt, domain, @@ -44,7 +58,7 @@ paths::operator()(Env& env, JTx& jt) const STPath fp; pf.computePathRanks(limit_); - auto const found = pf.getBestPaths(limit_, fp, {}, in_.account); + auto const found = pf.getBestPaths(limit_, fp, {}, in_.getIssuer()); // VFALCO TODO API to allow caller to examine the STPathSet // VFALCO isDefault should be renamed to empty() @@ -54,6 +68,11 @@ paths::operator()(Env& env, JTx& jt) const //------------------------------------------------------------------------------ +path::path(STPath const& p) +{ + jv_ = p.getJson(JsonOptions::none); +} + Json::Value& path::create() { @@ -77,16 +96,20 @@ void path::append_one(IOU const& iou) { auto& jv = create(); - jv["currency"] = to_string(iou.issue().currency); - jv["account"] = toBase58(iou.issue().account); + jv["currency"] = to_string(iou.currency); + jv["account"] = toBase58(iou.account); } void path::append_one(BookSpec const& book) { auto& jv = create(); - jv["currency"] = to_string(book.currency); - jv["issuer"] = toBase58(book.account); + book.asset.visit( + [&](Issue const& issue) { + jv["currency"] = to_string(issue.currency); + jv["issuer"] = toBase58(issue.account); + }, + [&](MPTIssue const& issue) { jv["mpt_issuance_id"] = to_string(issue.getMptID()); }); } void diff --git a/src/test/jtx/impl/pay.cpp b/src/test/jtx/impl/pay.cpp index 9e927c6270..bc8515bf0f 100644 --- a/src/test/jtx/impl/pay.cpp +++ b/src/test/jtx/impl/pay.cpp @@ -1,5 +1,10 @@ #include +#include +#include + +#include +#include #include #include diff --git a/src/test/jtx/impl/permissioned_dex.cpp b/src/test/jtx/impl/permissioned_dex.cpp index 87b7896663..d8c200fe99 100644 --- a/src/test/jtx/impl/permissioned_dex.cpp +++ b/src/test/jtx/impl/permissioned_dex.cpp @@ -1,9 +1,17 @@ -#include -#include -#include +#include -#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include namespace xrpl { namespace test { @@ -20,7 +28,7 @@ setupDomain( env.fund(XRP(100000), domainOwner); env.close(); - pdomain::Credentials credentials{{domainOwner, credType}}; + pdomain::Credentials const credentials{{domainOwner, credType}}; env(pdomain::setTx(domainOwner, credentials)); auto const objects = pdomain::getObjects(domainOwner, env); diff --git a/src/test/jtx/impl/permissioned_domains.cpp b/src/test/jtx/impl/permissioned_domains.cpp index 60d653e956..178deee4a7 100644 --- a/src/test/jtx/impl/permissioned_domains.cpp +++ b/src/test/jtx/impl/permissioned_domains.cpp @@ -1,4 +1,26 @@ -#include +#include + +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { diff --git a/src/test/jtx/impl/quality2.cpp b/src/test/jtx/impl/quality2.cpp index c202592b9d..51b1de4083 100644 --- a/src/test/jtx/impl/quality2.cpp +++ b/src/test/jtx/impl/quality2.cpp @@ -1,19 +1,26 @@ +#include +#include #include #include #include +#include +#include + namespace xrpl { namespace test { namespace jtx { qualityInPercent::qualityInPercent(double percent) + // NOLINTNEXTLINE(cppcoreguidelines-use-default-member-init) : qIn_(static_cast((percent / 100) * QUALITY_ONE)) { assert(percent <= 400 && percent >= 0); } qualityOutPercent::qualityOutPercent(double percent) + // NOLINTNEXTLINE(cppcoreguidelines-use-default-member-init) : qOut_(static_cast((percent / 100) * QUALITY_ONE)) { assert(percent <= 400 && percent >= 0); diff --git a/src/test/jtx/impl/rate.cpp b/src/test/jtx/impl/rate.cpp index b4e9b2cb60..b9c848a4a4 100644 --- a/src/test/jtx/impl/rate.cpp +++ b/src/test/jtx/impl/rate.cpp @@ -1,8 +1,12 @@ #include +#include + #include +#include #include +#include #include namespace xrpl { diff --git a/src/test/jtx/impl/regkey.cpp b/src/test/jtx/impl/regkey.cpp index a2e2198eee..5c1a43f122 100644 --- a/src/test/jtx/impl/regkey.cpp +++ b/src/test/jtx/impl/regkey.cpp @@ -1,5 +1,10 @@ #include +#include +#include + +#include +#include #include namespace xrpl { diff --git a/src/test/jtx/impl/sendmax.cpp b/src/test/jtx/impl/sendmax.cpp index f117458cfa..94d8341910 100644 --- a/src/test/jtx/impl/sendmax.cpp +++ b/src/test/jtx/impl/sendmax.cpp @@ -1,5 +1,8 @@ #include +#include +#include + #include namespace xrpl { diff --git a/src/test/jtx/impl/seq.cpp b/src/test/jtx/impl/seq.cpp index 99c6ddbf0d..26a9bc0a2a 100644 --- a/src/test/jtx/impl/seq.cpp +++ b/src/test/jtx/impl/seq.cpp @@ -1,5 +1,8 @@ #include +#include +#include + #include namespace xrpl { diff --git a/src/test/jtx/impl/sig.cpp b/src/test/jtx/impl/sig.cpp index 1bdadc0bd3..e50f7a731b 100644 --- a/src/test/jtx/impl/sig.cpp +++ b/src/test/jtx/impl/sig.cpp @@ -1,4 +1,7 @@ #include + +#include +#include #include namespace xrpl { diff --git a/src/test/jtx/impl/tag.cpp b/src/test/jtx/impl/tag.cpp index 8321322f75..aa738e4009 100644 --- a/src/test/jtx/impl/tag.cpp +++ b/src/test/jtx/impl/tag.cpp @@ -1,5 +1,8 @@ #include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/ticket.cpp b/src/test/jtx/impl/ticket.cpp index 2cb1826bbb..1f41ccb768 100644 --- a/src/test/jtx/impl/ticket.cpp +++ b/src/test/jtx/impl/ticket.cpp @@ -1,7 +1,15 @@ #include +#include +#include +#include + +#include +#include #include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/token.cpp b/src/test/jtx/impl/token.cpp index 9db79361eb..0c315be85a 100644 --- a/src/test/jtx/impl/token.cpp +++ b/src/test/jtx/impl/token.cpp @@ -1,10 +1,22 @@ -#include #include +#include +#include +#include +#include + +#include +#include #include +#include #include +#include #include +#include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/trust.cpp b/src/test/jtx/impl/trust.cpp index 08cd4ef94c..ab99b4a19f 100644 --- a/src/test/jtx/impl/trust.cpp +++ b/src/test/jtx/impl/trust.cpp @@ -1,8 +1,15 @@ #include +#include + #include +#include +#include +#include #include +#include +#include #include namespace xrpl { diff --git a/src/test/jtx/impl/txflags.cpp b/src/test/jtx/impl/txflags.cpp index 7b49f9380b..1735803b49 100644 --- a/src/test/jtx/impl/txflags.cpp +++ b/src/test/jtx/impl/txflags.cpp @@ -1,5 +1,8 @@ #include +#include +#include + #include namespace xrpl { diff --git a/src/test/jtx/impl/utility.cpp b/src/test/jtx/impl/utility.cpp index 7332358031..2b967ad654 100644 --- a/src/test/jtx/impl/utility.cpp +++ b/src/test/jtx/impl/utility.cpp @@ -1,15 +1,29 @@ #include +#include + #include #include +#include +#include +#include +#include +#include #include #include #include +#include +#include #include -#include +#include +#include +#include #include +#include +#include + namespace xrpl { namespace test { namespace jtx { diff --git a/src/test/jtx/impl/vault.cpp b/src/test/jtx/impl/vault.cpp index 49c0dddaec..73f8178561 100644 --- a/src/test/jtx/impl/vault.cpp +++ b/src/test/jtx/impl/vault.cpp @@ -1,11 +1,18 @@ -#include #include +#include + +#include #include -#include +#include +#include +#include +#include +#include #include #include +#include namespace xrpl { namespace test { diff --git a/src/test/jtx/impl/xchain_bridge.cpp b/src/test/jtx/impl/xchain_bridge.cpp index c2617f5073..75bf02127b 100644 --- a/src/test/jtx/impl/xchain_bridge.cpp +++ b/src/test/jtx/impl/xchain_bridge.cpp @@ -1,17 +1,30 @@ -#include -#include #include +#include +#include +#include +#include +#include + +#include #include +#include +#include #include +#include #include +#include #include #include -#include -#include -#include #include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { namespace jtx { @@ -413,25 +426,25 @@ XChainBridgeObjects::XChainBridgeObjects() } return r; }()) - , quorum(UT_XCHAIN_DEFAULT_QUORUM) , reward(XRP(1)) - , split_reward_quorum(divide(reward, STAmount(UT_XCHAIN_DEFAULT_QUORUM), reward.issue())) - , split_reward_everyone(divide(reward, STAmount(UT_XCHAIN_DEFAULT_NUM_SIGNERS), reward.issue())) + , split_reward_quorum(divide(reward, STAmount(UT_XCHAIN_DEFAULT_QUORUM), reward.get())) + , split_reward_everyone( + divide(reward, STAmount(UT_XCHAIN_DEFAULT_NUM_SIGNERS), reward.get())) , tiny_reward(drops(37)) , tiny_reward_split( - (divide(tiny_reward, STAmount(UT_XCHAIN_DEFAULT_QUORUM), tiny_reward.issue()))) + (divide(tiny_reward, STAmount(UT_XCHAIN_DEFAULT_QUORUM), tiny_reward.get()))) , tiny_reward_remainder( tiny_reward - - multiply(tiny_reward_split, STAmount(UT_XCHAIN_DEFAULT_QUORUM), tiny_reward.issue())) + multiply(tiny_reward_split, STAmount(UT_XCHAIN_DEFAULT_QUORUM), tiny_reward.get())) , one_xrp(XRP(1)) - , xrp_dust(divide(one_xrp, STAmount(10000), one_xrp.issue())) + , xrp_dust(divide(one_xrp, STAmount(10000), one_xrp.get())) { } void XChainBridgeObjects::createMcBridgeObjects(Env& mcEnv) { - STAmount xrp_funds{XRP(10000)}; + STAmount const xrp_funds{XRP(10000)}; mcEnv.fund(xrp_funds, mcDoor, mcAlice, mcBob, mcCarol, mcGw); // Signer's list must match the attestation signers @@ -448,7 +461,7 @@ XChainBridgeObjects::createMcBridgeObjects(Env& mcEnv) void XChainBridgeObjects::createScBridgeObjects(Env& scEnv) { - STAmount xrp_funds{XRP(10000)}; + STAmount const xrp_funds{XRP(10000)}; scEnv.fund(xrp_funds, scDoor, scAlice, scBob, scCarol, scGw, scAttester, scReward); // Signer's list must match the attestation signers diff --git a/src/test/jtx/mpt.h b/src/test/jtx/mpt.h index 3990dd3087..d058d11c0e 100644 --- a/src/test/jtx/mpt.h +++ b/src/test/jtx/mpt.h @@ -2,9 +2,11 @@ #include #include +#include #include #include +#include #include namespace xrpl { @@ -95,7 +97,7 @@ struct MPTCreate struct MPTInit { - Holders holders = {}; + Holders holders = {}; // NOLINT(readability-redundant-member-init) PrettyAmount const xrp = XRP(10'000); PrettyAmount const xrpHolders = XRP(10'000); bool fund = true; @@ -109,10 +111,11 @@ struct MPTInitDef { Env& env; Account issuer; - Holders holders = {}; + Holders holders = {}; // NOLINT(readability-redundant-member-init) std::uint16_t transferFee = 0; std::optional pay = std::nullopt; std::uint32_t flags = MPTDEXFlags; + std::optional mutableFlags = std::nullopt; bool authHolder = false; bool fund = false; bool close = true; @@ -272,6 +275,12 @@ public: operator Asset() const; + friend BookSpec + operator~(MPTTester const& mpt) + { + return ~static_cast(mpt); + } + private: using SLEP = SLE::const_pointer; bool diff --git a/src/test/jtx/owners.h b/src/test/jtx/owners.h index 3f54e0c55f..b24f0a686f 100644 --- a/src/test/jtx/owners.h +++ b/src/test/jtx/owners.h @@ -43,7 +43,7 @@ public: void operator()(Env& env) const { - detail::owned_count_helper(env, account_.id(), Type, value_); + xrpl::detail::owned_count_helper(env, account_.id(), Type, value_); } }; @@ -69,6 +69,9 @@ using lines = owner_count; /** Match the number of offers in the account's owner directory */ using offers = owner_count; +/** Match the number of MPToken in the account's owner directory */ +using mptokens = owner_count; + } // namespace jtx } // namespace test } // namespace xrpl diff --git a/src/test/jtx/paths.h b/src/test/jtx/paths.h index 6522364e14..8558b6232b 100644 --- a/src/test/jtx/paths.h +++ b/src/test/jtx/paths.h @@ -7,6 +7,7 @@ #include namespace xrpl { +class STPath; namespace test { namespace jtx { @@ -14,12 +15,12 @@ namespace jtx { class paths { private: - Issue in_; + Asset in_; int depth_; unsigned int limit_; public: - paths(Issue const& in, int depth = 7, unsigned int limit = 4) + paths(Asset const& in, int depth = 7, unsigned int limit = 4) : in_(in), depth_(depth), limit_(limit) { } @@ -45,6 +46,8 @@ public: template explicit path(T const& t, Args const&... args); + path(STPath const& p); + void operator()(Env&, JTx& jt) const; diff --git a/src/test/jtx/quality.h b/src/test/jtx/quality.h index 34c960224f..2da83eeef5 100644 --- a/src/test/jtx/quality.h +++ b/src/test/jtx/quality.h @@ -25,7 +25,7 @@ public: class qualityInPercent { private: - std::uint32_t qIn_; + std::uint32_t qIn_; // NOLINT(cppcoreguidelines-use-default-member-init) public: explicit qualityInPercent(double percent); @@ -53,7 +53,7 @@ public: class qualityOutPercent { private: - std::uint32_t qOut_; + std::uint32_t qOut_; // NOLINT(cppcoreguidelines-use-default-member-init) public: explicit qualityOutPercent(double percent); diff --git a/src/test/jtx/utility.h b/src/test/jtx/utility.h index 15c323f047..c9189efc36 100644 --- a/src/test/jtx/utility.h +++ b/src/test/jtx/utility.h @@ -49,7 +49,7 @@ fill_fee(Json::Value& jv, ReadView const& view); void fill_seq(Json::Value& jv, ReadView const& view); -/** Given a rippled unit test rpc command, return the corresponding JSON. */ +/** Given an xrpld unit test rpc command, return the corresponding JSON. */ Json::Value cmdToJSONRPC(std::vector const& args, beast::Journal j, unsigned int apiVersion); diff --git a/src/test/jtx/vault.h b/src/test/jtx/vault.h index 748d3341a5..8a21503be2 100644 --- a/src/test/jtx/vault.h +++ b/src/test/jtx/vault.h @@ -25,7 +25,8 @@ struct Vault { Account owner; Asset asset; - std::optional flags{}; + std::optional flags = + std::nullopt; // NOLINT(readability-redundant-member-init) }; /** Return a VaultCreate transaction and the Vault's expected keylet. */ @@ -75,7 +76,7 @@ struct Vault Account issuer; uint256 id; Account holder; - std::optional amount{}; + std::optional amount = std::nullopt; // NOLINT(readability-redundant-member-init) }; static Json::Value diff --git a/src/test/jtx/xchain_bridge.h b/src/test/jtx/xchain_bridge.h index 698426c59c..9359b3fdde 100644 --- a/src/test/jtx/xchain_bridge.h +++ b/src/test/jtx/xchain_bridge.h @@ -170,7 +170,7 @@ struct XChainBridgeObjects std::vector const alt_signers; std::vector const payee; std::vector const payees; - std::uint32_t const quorum; + std::uint32_t const quorum{UT_XCHAIN_DEFAULT_QUORUM}; STAmount const reward; // 1 xrp STAmount const split_reward_quorum; // 250,000 drops @@ -224,7 +224,7 @@ struct XChainBridgeObjects Account const& acc, Json::Value const& bridge = Json::nullValue, STAmount const& _reward = XRP(1), - std::optional const& minAccountCreate = std::nullopt) + std::optional const& minAccountCreate = std::nullopt) const { return bridge_create( acc, bridge == Json::nullValue ? jvb : bridge, _reward, minAccountCreate); diff --git a/src/test/ledger/BookDirs_test.cpp b/src/test/ledger/BookDirs_test.cpp index d7841fe502..71a3b67a7c 100644 --- a/src/test/ledger/BookDirs_test.cpp +++ b/src/test/ledger/BookDirs_test.cpp @@ -1,7 +1,19 @@ -#include +#include +#include +#include +#include +#include + +#include #include +#include #include +#include +#include + +#include +#include namespace xrpl { namespace test { @@ -19,7 +31,7 @@ struct BookDirs_test : public beast::unit_test::suite env.close(); { - Book book(xrpIssue(), USD.issue(), std::nullopt); + Book const book(xrpIssue(), USD, std::nullopt); { auto d = BookDirs(*env.current(), book); BEAST_EXPECT(std::begin(d) == std::end(d)); @@ -33,14 +45,14 @@ struct BookDirs_test : public beast::unit_test::suite { env(offer("alice", Account("alice")["USD"](50), XRP(10))); - auto d = BookDirs( - *env.current(), Book(Account("alice")["USD"].issue(), xrpIssue(), std::nullopt)); + auto d = + BookDirs(*env.current(), Book(Account("alice")["USD"], xrpIssue(), std::nullopt)); BEAST_EXPECT(std::distance(d.begin(), d.end()) == 1); } { env(offer("alice", gw["CNY"](50), XRP(10))); - auto d = BookDirs(*env.current(), Book(gw["CNY"].issue(), xrpIssue(), std::nullopt)); + auto d = BookDirs(*env.current(), Book(gw["CNY"], xrpIssue(), std::nullopt)); BEAST_EXPECT(std::distance(d.begin(), d.end()) == 1); } @@ -48,8 +60,7 @@ struct BookDirs_test : public beast::unit_test::suite env.trust(Account("bob")["CNY"](10), "alice"); env(pay("bob", "alice", Account("bob")["CNY"](10))); env(offer("alice", USD(50), Account("bob")["CNY"](10))); - auto d = BookDirs( - *env.current(), Book(USD.issue(), Account("bob")["CNY"].issue(), std::nullopt)); + auto d = BookDirs(*env.current(), Book(USD, Account("bob")["CNY"], std::nullopt)); BEAST_EXPECT(std::distance(d.begin(), d.end()) == 1); } @@ -61,7 +72,7 @@ struct BookDirs_test : public beast::unit_test::suite env(offer("alice", AUD(i), XRP(j))); } - auto d = BookDirs(*env.current(), Book(AUD.issue(), xrpIssue(), std::nullopt)); + auto d = BookDirs(*env.current(), Book(AUD, xrpIssue(), std::nullopt)); BEAST_EXPECT(std::distance(d.begin(), d.end()) == 240); auto i = 1, j = 3, k = 0; for (auto const& e : d) diff --git a/src/test/ledger/Directory_test.cpp b/src/test/ledger/Directory_test.cpp index aec472fc6f..52641a6741 100644 --- a/src/test/ledger/Directory_test.cpp +++ b/src/test/ledger/Directory_test.cpp @@ -1,16 +1,48 @@ -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include + +#include #include +#include +#include +#include +#include +#include #include #include #include +#include #include +#include +#include +#include #include +#include #include #include #include +#include +#include #include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -123,7 +155,7 @@ struct Directory_test : public beast::unit_test::suite // Now check the orderbook: it should be in the order we placed // the offers. - auto book = BookDirs(*env.current(), Book({xrpIssue(), USD.issue(), std::nullopt})); + auto book = BookDirs(*env.current(), Book({xrpIssue(), USD, std::nullopt})); int count = 1; for (auto const& offer : book) @@ -282,8 +314,8 @@ struct Directory_test : public beast::unit_test::suite // All the offers have been cancelled, so the book // should have no entries and be empty: { - Sandbox sb(env.closed().get(), tapNONE); - uint256 const bookBase = getBookBase({xrpIssue(), USD.issue(), std::nullopt}); + Sandbox const sb(env.closed().get(), tapNONE); + uint256 const bookBase = getBookBase({xrpIssue(), USD, std::nullopt}); BEAST_EXPECT(dirIsEmpty(sb, keylet::page(bookBase))); BEAST_EXPECT(!sb.succ(bookBase, getQualityNext(bookBase))); @@ -475,7 +507,7 @@ struct Directory_test : public beast::unit_test::suite testDirectoryFull() { using namespace test::jtx; - Account alice("alice"); + Account const alice("alice"); auto const testCase = [&, this](FeatureBitset features, auto setup) { using namespace test::jtx; diff --git a/src/test/ledger/PaymentSandbox_test.cpp b/src/test/ledger/PaymentSandbox_test.cpp index df23381ed3..99f7913cf7 100644 --- a/src/test/ledger/PaymentSandbox_test.cpp +++ b/src/test/ledger/PaymentSandbox_test.cpp @@ -1,11 +1,32 @@ +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include #include #include +#include #include #include +#include +#include +#include +#include +#include +#include + +#include namespace xrpl { namespace test { @@ -65,7 +86,7 @@ class PaymentSandbox_test : public beast::unit_test::suite env(offer(snd, USD_gw1(2), USD_gw2(2)), txflags(tfPassive)); env(offer(snd, USD_gw2(2), USD_gw1(2)), txflags(tfPassive)); - PathSet paths(Path(gw1, USD_gw2, gw2), Path(gw2, USD_gw1, gw1)); + PathSet const paths(Path(gw1, USD_gw2, gw2), Path(gw2, USD_gw1, gw1)); env(pay(snd, rcv, any(USD_gw1(4))), json(paths.json()), @@ -105,7 +126,7 @@ class PaymentSandbox_test : public beast::unit_test::suite // accountSend, no deferredCredits ApplyViewImpl av(&*env.current(), tapNONE); - auto const iss = USD_gw1.issue(); + auto const iss = USD_gw1; auto const startingAmount = accountHolds(av, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j); { @@ -125,19 +146,19 @@ class PaymentSandbox_test : public beast::unit_test::suite } { - // rippleCredit, no deferredCredits + // directSendNoFee, no deferredCredits ApplyViewImpl av(&*env.current(), tapNONE); - auto const iss = USD_gw1.issue(); + auto const iss = USD_gw1; auto const startingAmount = accountHolds(av, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j); - rippleCredit(av, gw1, alice, toCredit, true, j); + directSendNoFee(av, gw1, alice, toCredit, true, j); BEAST_EXPECT( accountHolds(av, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j) == startingAmount + toCredit); - rippleCredit(av, alice, gw1, toDebit, true, j); + directSendNoFee(av, alice, gw1, toDebit, true, j); BEAST_EXPECT( accountHolds(av, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j) == startingAmount + toCredit - toDebit); @@ -148,7 +169,7 @@ class PaymentSandbox_test : public beast::unit_test::suite ApplyViewImpl av(&*env.current(), tapNONE); PaymentSandbox pv(&av); - auto const iss = USD_gw1.issue(); + auto const iss = USD_gw1; auto const startingAmount = accountHolds(pv, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j); @@ -170,15 +191,15 @@ class PaymentSandbox_test : public beast::unit_test::suite } { - // rippleCredit, w/ deferredCredits + // directSendNoFee, w/ deferredCredits ApplyViewImpl av(&*env.current(), tapNONE); PaymentSandbox pv(&av); - auto const iss = USD_gw1.issue(); + auto const iss = USD_gw1; auto const startingAmount = accountHolds(pv, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j); - rippleCredit(pv, gw1, alice, toCredit, true, j); + directSendNoFee(pv, gw1, alice, toCredit, true, j); BEAST_EXPECT( accountHolds(pv, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j) == startingAmount); @@ -189,7 +210,7 @@ class PaymentSandbox_test : public beast::unit_test::suite ApplyViewImpl av(&*env.current(), tapNONE); PaymentSandbox pv(&av); - auto const iss = USD_gw1.issue(); + auto const iss = USD_gw1; auto const startingAmount = accountHolds(pv, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j); @@ -204,7 +225,7 @@ class PaymentSandbox_test : public beast::unit_test::suite ApplyViewImpl av(&*env.current(), tapNONE); PaymentSandbox pv(&av); - auto const iss = USD_gw1.issue(); + auto const iss = USD_gw1; auto const startingAmount = accountHolds(pv, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j); @@ -219,7 +240,7 @@ class PaymentSandbox_test : public beast::unit_test::suite ApplyViewImpl av(&*env.current(), tapNONE); PaymentSandbox pv(&av); - auto const iss = USD_gw1.issue(); + auto const iss = USD_gw1; auto const startingAmount = accountHolds(pv, alice, iss.currency, iss.account, fhIGNORE_FREEZE, j); @@ -266,22 +287,22 @@ class PaymentSandbox_test : public beast::unit_test::suite using namespace jtx; - Env env(*this, features); + Env const env(*this, features); Account const gw("gw"); Account const alice("alice"); auto const USD = gw["USD"]; - auto const issue = USD.issue(); - STAmount tinyAmt( + auto const issue = USD; + STAmount const tinyAmt( issue, STAmount::cMinValue, STAmount::cMinOffset + 1, false, STAmount::unchecked{}); - STAmount hugeAmt( + STAmount const hugeAmt( issue, STAmount::cMaxValue, STAmount::cMaxOffset - 1, false, STAmount::unchecked{}); ApplyViewImpl av(&*env.current(), tapNONE); PaymentSandbox pv(&av); - pv.creditHook(gw, alice, hugeAmt, -tinyAmt); - BEAST_EXPECT(pv.balanceHook(alice, gw, hugeAmt) == tinyAmt); + pv.creditHookIOU(gw, alice, hugeAmt, -tinyAmt); + BEAST_EXPECT(pv.balanceHookIOU(alice, gw, hugeAmt) == tinyAmt); } void @@ -328,12 +349,12 @@ class PaymentSandbox_test : public beast::unit_test::suite void testBalanceHook(FeatureBitset features) { - // Make sure the Issue::Account returned by PAymentSandbox::balanceHook - // is correct. + // Make sure the Issue::Account returned by + // PaymentSandbox::balanceHookIOU is correct. testcase("balanceHook"); using namespace jtx; - Env env(*this, features); + Env const env(*this, features); Account const gw("gw"); auto const USD = gw["USD"]; @@ -343,16 +364,18 @@ class PaymentSandbox_test : public beast::unit_test::suite PaymentSandbox sb(&av); // The currency we pass for the last argument mimics the currency that - // is typically passed to creditHook, since it comes from a trust line. + // is typically passed to creditHookIOU, since it comes from a trust + // line. Issue tlIssue = noIssue(); - tlIssue.currency = USD.issue().currency; + tlIssue.currency = USD.currency; - sb.creditHook(gw.id(), alice.id(), {USD, 400}, {tlIssue, 600}); - sb.creditHook(gw.id(), alice.id(), {USD, 100}, {tlIssue, 600}); + sb.creditHookIOU(gw.id(), alice.id(), {USD, 400}, {tlIssue, 600}); + sb.creditHookIOU(gw.id(), alice.id(), {USD, 100}, {tlIssue, 600}); - // Expect that the STAmount issuer returned by balanceHook() is correct. - STAmount const balance = sb.balanceHook(gw.id(), alice.id(), {USD, 600}); - BEAST_EXPECT(balance.getIssuer() == USD.issue().account); + // Expect that the STAmount issuer returned by balanceHookIOU() is + // correct. + STAmount const balance = sb.balanceHookIOU(gw.id(), alice.id(), {USD, 600}); + BEAST_EXPECT(balance.getIssuer() == USD.account.id()); } public: diff --git a/src/test/ledger/PendingSaves_test.cpp b/src/test/ledger/PendingSaves_test.cpp index 5e08fc53e4..55ea3b7aac 100644 --- a/src/test/ledger/PendingSaves_test.cpp +++ b/src/test/ledger/PendingSaves_test.cpp @@ -1,4 +1,4 @@ -#include +#include #include namespace xrpl { diff --git a/src/test/ledger/SkipList_test.cpp b/src/test/ledger/SkipList_test.cpp index ba339878ef..5009043462 100644 --- a/src/test/ledger/SkipList_test.cpp +++ b/src/test/ledger/SkipList_test.cpp @@ -1,9 +1,16 @@ #include -#include +#include + +#include +#include #include #include +#include +#include +#include + namespace xrpl { namespace test { @@ -15,7 +22,7 @@ class SkipList_test : public beast::unit_test::suite jtx::Env env(*this); std::vector> history; { - Config config; + Config const config; auto prev = std::make_shared( create_genesis, Rules{config.features}, diff --git a/src/test/ledger/View_test.cpp b/src/test/ledger/View_test.cpp index 6e11508156..2dc30427d3 100644 --- a/src/test/ledger/View_test.cpp +++ b/src/test/ledger/View_test.cpp @@ -1,17 +1,53 @@ -#include -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include +#include +#include +#include +#include +#include #include #include #include #include +#include #include +#include #include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include namespace xrpl { namespace test { @@ -114,7 +150,7 @@ class View_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Config config; + Config const config; std::shared_ptr const genesis = std::make_shared( create_genesis, Rules{config.features}, @@ -124,7 +160,7 @@ class View_test : public beast::unit_test::suite auto const ledger = std::make_shared(*genesis, env.app().getTimeKeeper().closeTime()); wipe(*ledger); - ReadView& v = *ledger; + ReadView const& v = *ledger; succ(v, 0, std::nullopt); ledger->rawInsert(sle(1, 1)); BEAST_EXPECT(v.exists(k(1))); @@ -338,7 +374,7 @@ class View_test : public beast::unit_test::suite BEAST_EXPECT(v2.seq() == v1.seq()); BEAST_EXPECT(v2.flags() == tapRETRY); - Sandbox v3(&v2); + Sandbox const v3(&v2); BEAST_EXPECT(v3.seq() == v2.seq()); BEAST_EXPECT(v3.parentCloseTime() == v2.parentCloseTime()); BEAST_EXPECT(v3.flags() == tapRETRY); @@ -349,7 +385,7 @@ class View_test : public beast::unit_test::suite BEAST_EXPECT(v2.seq() == v0.seq()); BEAST_EXPECT(v2.parentCloseTime() == v0.parentCloseTime()); BEAST_EXPECT(v2.flags() == tapRETRY); - PaymentSandbox v3(&v2); + PaymentSandbox const v3(&v2); BEAST_EXPECT(v3.seq() == v2.seq()); BEAST_EXPECT(v3.parentCloseTime() == v2.parentCloseTime()); BEAST_EXPECT(v3.flags() == v2.flags()); @@ -382,7 +418,7 @@ class View_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Config config; + Config const config; std::shared_ptr const genesis = std::make_shared( create_genesis, Rules{config.features}, @@ -591,7 +627,7 @@ class View_test : public beast::unit_test::suite using namespace jtx; Env env(*this); - Config config; + Config const config; std::shared_ptr const genesis = std::make_shared( create_genesis, Rules{config.features}, @@ -942,7 +978,7 @@ class View_test : public beast::unit_test::suite // erase the item, apply. { Env env(*this); - Config config; + Config const config; std::shared_ptr const genesis = std::make_shared( create_genesis, Rules{config.features}, @@ -953,7 +989,7 @@ class View_test : public beast::unit_test::suite std::make_shared(*genesis, env.app().getTimeKeeper().closeTime()); wipe(*ledger); ledger->rawInsert(sle(1)); - ReadView& v0 = *ledger; + ReadView const& v0 = *ledger; ApplyViewImpl v1(&v0, tapNONE); { Sandbox v2(&v1); diff --git a/src/test/nodestore/Backend_test.cpp b/src/test/nodestore/Backend_test.cpp index 19f3bc43e5..931044c738 100644 --- a/src/test/nodestore/Backend_test.cpp +++ b/src/test/nodestore/Backend_test.cpp @@ -1,13 +1,20 @@ #include #include +#include #include -#include +#include #include +#include +#include #include #include +#include #include +#include +#include +#include namespace xrpl { @@ -26,7 +33,7 @@ public: testcase("Backend type=" + type); Section params; - beast::temp_dir tempDir; + beast::temp_dir const tempDir; params.set("type", type); params.set("path", tempDir.path()); diff --git a/src/test/nodestore/Basics_test.cpp b/src/test/nodestore/Basics_test.cpp index e37544f58e..cbce3c6a78 100644 --- a/src/test/nodestore/Basics_test.cpp +++ b/src/test/nodestore/Basics_test.cpp @@ -1,8 +1,13 @@ #include +#include +#include #include #include +#include +#include + namespace xrpl { namespace NodeStore { @@ -38,7 +43,7 @@ public: for (int i = 0; i < batch.size(); ++i) { - EncodedBlob encoded(batch[i]); + EncodedBlob const encoded(batch[i]); DecodedBlob decoded(encoded.getKey(), encoded.getData(), encoded.getSize()); diff --git a/src/test/nodestore/Database_test.cpp b/src/test/nodestore/Database_test.cpp index 6943f0733e..99f6f6c59a 100644 --- a/src/test/nodestore/Database_test.cpp +++ b/src/test/nodestore/Database_test.cpp @@ -1,14 +1,31 @@ -#include #include +#include #include #include #include +#include + +#include +#include +#include #include +#include +#include #include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace NodeStore { @@ -191,7 +208,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -220,7 +237,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -249,7 +266,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -278,7 +295,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -306,7 +323,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -334,7 +351,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -362,7 +379,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -390,7 +407,7 @@ public: try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -445,7 +462,7 @@ public: } try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -468,7 +485,7 @@ public: } try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -491,7 +508,7 @@ public: } try { - Env env( + Env const env( *this, std::move(p), std::make_unique(expected, &found), @@ -515,7 +532,7 @@ public: { DummyScheduler scheduler; - beast::temp_dir node_db; + beast::temp_dir const node_db; Section srcParams; srcParams.set("type", srcBackendType); srcParams.set("path", node_db.path()); @@ -538,7 +555,7 @@ public: Manager::instance().make_Database(megabytes(4), scheduler, 2, srcParams, journal_); // Set up the destination database - beast::temp_dir dest_db; + beast::temp_dir const dest_db; Section destParams; destParams.set("type", destBackendType); destParams.set("path", dest_db.path()); @@ -572,11 +589,11 @@ public: { DummyScheduler scheduler; - std::string s = "NodeStore backend '" + type + "'"; + std::string const s = "NodeStore backend '" + type + "'"; testcase(s); - beast::temp_dir node_db; + beast::temp_dir const node_db; Section nodeParams; nodeParams.set("type", type); nodeParams.set("path", node_db.path()); @@ -639,7 +656,7 @@ public: try { nodeParams.set("earliest_seq", "0"); - std::unique_ptr db = Manager::instance().make_Database( + std::unique_ptr const db = Manager::instance().make_Database( megabytes(4), scheduler, 2, nodeParams, journal_); } catch (std::runtime_error const& e) @@ -662,7 +679,7 @@ public: { // Set to default earliest ledger sequence nodeParams.set("earliest_seq", std::to_string(XRP_LEDGER_EARLIEST_SEQ)); - std::unique_ptr db2 = Manager::instance().make_Database( + std::unique_ptr const db2 = Manager::instance().make_Database( megabytes(4), scheduler, 2, nodeParams, journal_); } catch (std::runtime_error const& e) diff --git a/src/test/nodestore/NuDBFactory_test.cpp b/src/test/nodestore/NuDBFactory_test.cpp index 0aa910ce01..759393ced3 100644 --- a/src/test/nodestore/NuDBFactory_test.cpp +++ b/src/test/nodestore/NuDBFactory_test.cpp @@ -3,12 +3,21 @@ #include #include +#include +#include +#include #include #include #include +#include +#include +#include #include #include +#include +#include +#include namespace xrpl { namespace NodeStore { @@ -76,12 +85,12 @@ private: std::string const& expectedMessage) { test::StreamSink sink(level); - beast::Journal journal(sink); + beast::Journal const journal(sink); DummyScheduler scheduler; auto backend = Manager::instance().make_Backend(params, megabytes(4), scheduler, journal); - std::string logOutput = sink.messages().str(); + std::string const logOutput = sink.messages().str(); BEAST_EXPECT(logOutput.find(expectedMessage) != std::string::npos); } @@ -89,17 +98,17 @@ private: void testPowerOfTwoValidation(std::string const& size, bool shouldWork) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), size); test::StreamSink sink(beast::severities::kWarning); - beast::Journal journal(sink); + beast::Journal const journal(sink); DummyScheduler scheduler; auto backend = Manager::instance().make_Backend(params, megabytes(4), scheduler, journal); - std::string logOutput = sink.messages().str(); - bool hasWarning = logOutput.find("Invalid nudb_block_size") != std::string::npos; + std::string const logOutput = sink.messages().str(); + bool const hasWarning = logOutput.find("Invalid nudb_block_size") != std::string::npos; BEAST_EXPECT(hasWarning == !shouldWork); } @@ -110,7 +119,7 @@ public: { testcase("Default block size (no nudb_block_size specified)"); - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path()); // Should work with default 4096 block size @@ -122,18 +131,18 @@ public: { testcase("Valid block sizes"); - std::vector validSizes = {4096, 8192, 16384, 32768}; + std::vector const validSizes = {4096, 8192, 16384, 32768}; for (auto const& size : validSizes) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), to_string(size)); BEAST_EXPECT(testBackendFunctionality(params, size)); } // Empty value is ignored by the config parser, so uses the // default - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), ""); BEAST_EXPECT(testBackendFunctionality(params, 4096)); @@ -144,7 +153,7 @@ public: { testcase("Invalid block sizes"); - std::vector invalidSizes = { + std::vector const invalidSizes = { "2048", // Too small "1024", // Too small "65536", // Too large @@ -161,7 +170,7 @@ public: for (auto const& size : invalidSizes) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), size); // Fails @@ -169,14 +178,14 @@ public: } // Test whitespace cases separately since lexical_cast may handle them - std::vector whitespaceInvalidSizes = { + std::vector const whitespaceInvalidSizes = { "4096 ", // Trailing space - might be handled by lexical_cast " 4096" // Leading space - might be handled by lexical_cast }; for (auto const& size : whitespaceInvalidSizes) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), size); // Fails @@ -191,7 +200,7 @@ public: // Test valid custom block size logging { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), "8192"); testLogMessage(params, beast::severities::kInfo, "Using custom NuDB block size: 8192"); @@ -199,11 +208,11 @@ public: // Test invalid block size failure { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), "5000"); test::StreamSink sink(beast::severities::kWarning); - beast::Journal journal(sink); + beast::Journal const journal(sink); DummyScheduler scheduler; try @@ -214,7 +223,7 @@ public: } catch (std::exception const& e) { - std::string logOutput{e.what()}; + std::string const logOutput{e.what()}; BEAST_EXPECT(logOutput.find("Invalid nudb_block_size: 5000") != std::string::npos); BEAST_EXPECT( logOutput.find("Must be power of 2 between 4096 and 32768") != @@ -224,11 +233,11 @@ public: // Test non-numeric value failure { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), "invalid"); test::StreamSink sink(beast::severities::kWarning); - beast::Journal journal(sink); + beast::Journal const journal(sink); DummyScheduler scheduler; try @@ -240,7 +249,7 @@ public: } catch (std::exception const& e) { - std::string logOutput{e.what()}; + std::string const logOutput{e.what()}; BEAST_EXPECT( logOutput.find("Invalid nudb_block_size value: invalid") != std::string::npos); } @@ -253,7 +262,7 @@ public: testcase("Power of 2 validation logic"); // Test edge cases around valid range - std::vector> testCases = { + std::vector> const testCases = { {"4095", false}, // Just below minimum {"4096", true}, // Minimum valid {"4097", false}, // Just above minimum, not power of 2 @@ -267,13 +276,13 @@ public: for (auto const& [size, shouldWork] : testCases) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), size); // We test the validation logic by catching exceptions for invalid // values test::StreamSink sink(beast::severities::kWarning); - beast::Journal journal(sink); + beast::Journal const journal(sink); DummyScheduler scheduler; try @@ -284,7 +293,7 @@ public: } catch (std::exception const& e) { - std::string logOutput{e.what()}; + std::string const logOutput{e.what()}; BEAST_EXPECT(logOutput.find("Invalid nudb_block_size") != std::string::npos); } } @@ -295,7 +304,7 @@ public: { testcase("Both constructor variants work with custom block size"); - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), "16384"); DummyScheduler scheduler; @@ -321,13 +330,13 @@ public: testcase("Configuration parsing edge cases"); // Test that whitespace is handled correctly - std::vector validFormats = { + std::vector const validFormats = { "8192" // Basic valid format }; // Test whitespace handling separately since lexical_cast behavior may // vary - std::vector whitespaceFormats = { + std::vector const whitespaceFormats = { " 8192", // Leading space - may or may not be handled by // lexical_cast "8192 " // Trailing space - may or may not be handled by @@ -337,19 +346,19 @@ public: // Test basic valid format for (auto const& format : validFormats) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), format); test::StreamSink sink(beast::severities::kInfo); - beast::Journal journal(sink); + beast::Journal const journal(sink); DummyScheduler scheduler; auto backend = Manager::instance().make_Backend(params, megabytes(4), scheduler, journal); // Should log success message for valid values - std::string logOutput = sink.messages().str(); - bool hasSuccessMessage = + std::string const logOutput = sink.messages().str(); + bool const hasSuccessMessage = logOutput.find("Using custom NuDB block size") != std::string::npos; BEAST_EXPECT(hasSuccessMessage); } @@ -358,12 +367,12 @@ public: // them for (auto const& format : whitespaceFormats) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), format); // Use a lower threshold to capture both info and warning messages test::StreamSink sink(beast::severities::kDebug); - beast::Journal journal(sink); + beast::Journal const journal(sink); DummyScheduler scheduler; try @@ -385,11 +394,11 @@ public: { testcase("Data persistence with different block sizes"); - std::vector blockSizes = {"4096", "8192", "16384", "32768"}; + std::vector const blockSizes = {"4096", "8192", "16384", "32768"}; for (auto const& size : blockSizes) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; auto params = createSection(tempDir.path(), size); DummyScheduler scheduler; diff --git a/src/test/nodestore/TestBase.h b/src/test/nodestore/TestBase.h index cb2a8e3bd5..13e5b4beba 100644 --- a/src/test/nodestore/TestBase.h +++ b/src/test/nodestore/TestBase.h @@ -75,9 +75,10 @@ public: return hotTRANSACTION_NODE; case 3: return hotUNKNOWN; + default: + // will never happen, but make static analysis tool happy. + return hotUNKNOWN; } - // will never happen, but make static analysis tool happy. - return hotUNKNOWN; }(); uint256 hash; @@ -118,7 +119,7 @@ public: } // Store a batch in a backend - void + static void storeBatch(Backend& backend, Batch const& batch) { for (int i = 0; i < batch.size(); ++i) @@ -187,7 +188,7 @@ public: for (int i = 0; i < batch.size(); ++i) { - std::shared_ptr object = db.fetchNodeObject(batch[i]->getHash(), 0); + std::shared_ptr const object = db.fetchNodeObject(batch[i]->getHash(), 0); if (object != nullptr) pCopy->push_back(object); diff --git a/src/test/nodestore/Timing_test.cpp b/src/test/nodestore/Timing_test.cpp index fc8c042252..abf14f3edc 100644 --- a/src/test/nodestore/Timing_test.cpp +++ b/src/test/nodestore/Timing_test.cpp @@ -2,27 +2,42 @@ #include #include +#include #include +#include +#include #include -#include +#include #include +#include #include #include +#include #include #include +#include +#include +#include -#include +#include +#include #include #include #include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include -#include -#include +#include #include +#include #ifndef NODESTORE_TIMING_DO_VERIFY #define NODESTORE_TIMING_DO_VERIFY 0 @@ -211,7 +226,7 @@ public: parallel_for(std::size_t const n, std::size_t number_of_threads, Args const&... args) { std::atomic c(0); - std::vector t; + std::vector t; t.reserve(number_of_threads); for (std::size_t id = 0; id < number_of_threads; ++id) t.emplace_back(*this, parallel_for_lambda(n, c), args...); @@ -224,7 +239,7 @@ public: parallel_for_id(std::size_t const n, std::size_t number_of_threads, Args const&... args) { std::atomic c(0); - std::vector t; + std::vector t; t.reserve(number_of_threads); for (std::size_t id = 0; id < number_of_threads; ++id) t.emplace_back(*this, parallel_for_lambda(n, c), id, args...); @@ -490,7 +505,7 @@ public: backend->close(); } - // Simulate a rippled workload: + // Simulate an xrpld workload: // Each thread randomly: // inserts a new key // fetches an old key @@ -645,7 +660,7 @@ public: params.threads = threads; for (auto i = default_repeat; (i--) != 0u;) { - beast::temp_dir tempDir; + beast::temp_dir const tempDir; Section config = parse(config_string); config.set("path", tempDir.path()); std::stringstream ss; @@ -672,7 +687,7 @@ public: items Number of objects to create in the database */ - std::string default_args = + std::string const default_args = "type=nudb" #if XRPL_ROCKSDB_AVAILABLE ";type=rocksdb,open_files=2000,filter_bits=12,cache_mb=256," diff --git a/src/test/nodestore/import_test.cpp b/src/test/nodestore/import_test.cpp index 54d55e5ad0..1341b98894 100644 --- a/src/test/nodestore/import_test.cpp +++ b/src/test/nodestore/import_test.cpp @@ -1,23 +1,46 @@ #include -#include #include -#include #include -#include +#include #include #include -#include +#include // IWYU pragma: keep +#include +#include +#include -#include +#include // IWYU pragma: keep +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include #include #include +#include +#include +#include +#include #include +#include #include +#include +#include +#include #include +#include +#include /* @@ -71,7 +94,7 @@ template std::ostream& pretty_time(std::ostream& os, std::chrono::duration d) { - save_stream_state _(os); + save_stream_state const _(os); using namespace std::chrono; if (d < microseconds{1}) { @@ -332,7 +355,7 @@ public: options.create_if_missing = false; options.max_open_files = 2000; // 5000? rocksdb::DB* pdb = nullptr; - rocksdb::Status status = rocksdb::DB::OpenForReadOnly(options, from_path, &pdb); + rocksdb::Status const status = rocksdb::DB::OpenForReadOnly(options, from_path, &pdb); if (!status.ok() || (pdb == nullptr)) Throw("Can't open '" + from_path + "': " + status.ToString()); db.reset(pdb); @@ -374,7 +397,7 @@ public: void const* const key = it->key().data(); void const* const data = it->value().data(); auto const size = it->value().size(); - std::unique_ptr clean(new char[size]); + std::unique_ptr const clean(new char[size]); std::memcpy(clean.get(), data, size); filter_inner(clean.get(), size); auto const out = nodeobject_compress(clean.get(), size, buf); @@ -458,7 +481,7 @@ public: // Create empty buckets for (std::size_t i = 0; i < bn; ++i) { - bucket b(kh.block_size, buf.get() + (i * kh.block_size), empty); + bucket const b(kh.block_size, buf.get() + (i * kh.block_size), empty); } // Insert all keys into buckets // Iterate Data File diff --git a/src/test/nodestore/varint_test.cpp b/src/test/nodestore/varint_test.cpp index f6145a9f52..54cbb4b890 100644 --- a/src/test/nodestore/varint_test.cpp +++ b/src/test/nodestore/varint_test.cpp @@ -1,7 +1,9 @@ -#include +#include #include #include +#include +#include #include namespace xrpl { diff --git a/src/test/overlay/ProtocolVersion_test.cpp b/src/test/overlay/ProtocolVersion_test.cpp index f0d02edbca..a04bb3b36e 100644 --- a/src/test/overlay/ProtocolVersion_test.cpp +++ b/src/test/overlay/ProtocolVersion_test.cpp @@ -1,6 +1,9 @@ #include -#include +#include + +#include +#include namespace xrpl { @@ -42,20 +45,14 @@ public: // Empty string check("", ""); - // clang-format off - check( - "RTXP/1.1,RTXP/1.2,RTXP/1.3,XRPL/2.1,XRPL/2.0,/XRPL/3.0", - "XRPL/2.0,XRPL/2.1"); - check( - "RTXP/0.9,RTXP/1.01,XRPL/0.3,XRPL/2.01,websocket", - ""); + check("RTXP/1.1,RTXP/1.2,RTXP/1.3,XRPL/2.1,XRPL/2.0,/XRPL/3.0", "XRPL/2.0,XRPL/2.1"); + check("RTXP/0.9,RTXP/1.01,XRPL/0.3,XRPL/2.01,websocket", ""); check( "XRPL/2.0,XRPL/2.0,XRPL/19.4,XRPL/7.89,XRPL/XRPL/3.0,XRPL/2.01", "XRPL/2.0,XRPL/7.89,XRPL/19.4"); check( "XRPL/2.0,XRPL/3.0,XRPL/4,XRPL/,XRPL,OPT XRPL/2.2,XRPL/5.67", "XRPL/2.0,XRPL/3.0,XRPL/5.67"); - // clang-format on } { diff --git a/src/test/overlay/TMGetObjectByHash_test.cpp b/src/test/overlay/TMGetObjectByHash_test.cpp index e4da8a28c7..504f7cc896 100644 --- a/src/test/overlay/TMGetObjectByHash_test.cpp +++ b/src/test/overlay/TMGetObjectByHash_test.cpp @@ -1,17 +1,40 @@ -#include #include +#include +#include #include +#include #include #include +#include #include -#include +#include +#include +#include #include -#include +#include +#include #include +#include +#include +#include #include -#include +#include +#include + +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include namespace xrpl { namespace test { @@ -100,10 +123,10 @@ class TMGetObjectByHash_test : public beast::unit_test::suite auto stream_ptr = std::make_unique(socket_type(env.app().getIOContext()), *context_); - beast::IP::Endpoint local(boost::asio::ip::make_address("172.1.1.1"), 51235); - beast::IP::Endpoint remote(boost::asio::ip::make_address("172.1.1.2"), 51235); + beast::IP::Endpoint const local(boost::asio::ip::make_address("172.1.1.1"), 51235); + beast::IP::Endpoint const remote(boost::asio::ip::make_address("172.1.1.2"), 51235); - PublicKey key(std::get<0>(randomKeyPair(KeyType::ed25519))); + PublicKey const key(std::get<0>(randomKeyPair(KeyType::ed25519))); auto consumer = overlay.resourceManager().newInboundEndpoint(remote); auto [slot, _] = overlay.peerFinder().new_inbound_slot(local, remote); @@ -132,7 +155,7 @@ class TMGetObjectByHash_test : public beast::unit_test::suite hashes.reserve(numObjects); for (int i = 0; i < numObjects; ++i) { - uint256 hash(xrpl::sha512Half(i)); + uint256 const hash(xrpl::sha512Half(i)); hashes.push_back(hash); Blob data(100, static_cast(i % 256)); diff --git a/src/test/overlay/cluster_test.cpp b/src/test/overlay/cluster_test.cpp index 59fa22a442..b53dd63e9a 100644 --- a/src/test/overlay/cluster_test.cpp +++ b/src/test/overlay/cluster_test.cpp @@ -4,7 +4,18 @@ #include #include +#include +#include +#include +#include #include +#include + +#include +#include +#include +#include +#include namespace xrpl { namespace tests { @@ -113,7 +124,7 @@ public: auto const node = randomNode(); auto const name = toBase58(TokenType::NodePublic, node); - std::uint32_t load = 0; + std::uint32_t const load = 0; NetClock::time_point tick = {}; // Initial update diff --git a/src/test/overlay/compression_test.cpp b/src/test/overlay/compression_test.cpp index 8cee7df7d2..22b8694928 100644 --- a/src/test/overlay/compression_test.cpp +++ b/src/test/overlay/compression_test.cpp @@ -2,33 +2,53 @@ #include #include #include +#include #include -#include +#include #include #include #include #include #include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include #include -#include +#include #include -#include +#include +#include +#include +#include #include +#include +#include #include #include #include -#include #include -#include +#include +#include #include -#include +#include + +#include #include +#include +#include +#include +#include +#include namespace xrpl { @@ -163,7 +183,7 @@ public: buildTransaction(Logs& logs) { Env env(*this, envconfig()); - int fund = 10000; + int const fund = 10000; auto const alice = Account("alice"); auto const bob = Account("bob"); env.fund(XRP(fund), "alice", "bob"); @@ -205,7 +225,7 @@ public: uint256 const hash(xrpl::sha512Half(123456789)); getLedger->set_ledgerhash(hash.begin(), hash.size()); getLedger->set_ledgerseq(123456789); - xrpl::SHAMapNodeID sha(64, hash); + xrpl::SHAMapNodeID const sha(64, hash); getLedger->add_nodeids(sha.getRawString()); getLedger->set_requestcookie(123456789); getLedger->set_querytype(protocol::qtINDIRECT); @@ -268,7 +288,7 @@ public: uint256 hash(xrpl::sha512Half(i)); auto object = getObject->add_objects(); object->set_hash(hash.data(), hash.size()); - xrpl::SHAMapNodeID sha(64, hash); + xrpl::SHAMapNodeID const sha(64, hash); object->set_nodeid(sha.getRawString()); object->set_index(""); object->set_data(""); @@ -295,7 +315,7 @@ public: st.add(s); list->set_manifest(s.data(), s.size()); list->set_version(3); - STObject signature(sfSignature); + STObject const signature(sfSignature); xrpl::sign(st, HashPrefix::manifest, KeyType::ed25519, std::get<1>(signing)); Serializer s1; st.add(s1); @@ -322,7 +342,7 @@ public: st.add(s); list->set_manifest(s.data(), s.size()); list->set_version(4); - STObject signature(sfSignature); + STObject const signature(sfSignature); xrpl::sign(st, HashPrefix::manifest, KeyType::ed25519, std::get<1>(signing)); Serializer s1; st.add(s1); @@ -338,14 +358,14 @@ public: auto thresh = beast::severities::Severity::kInfo; auto logs = std::make_unique(thresh); - protocol::TMManifests manifests; - protocol::TMEndpoints endpoints; - protocol::TMTransaction transaction; - protocol::TMGetLedger get_ledger; - protocol::TMLedgerData ledger_data; - protocol::TMGetObjectByHash get_object; - protocol::TMValidatorList validator_list; - protocol::TMValidatorListCollection validator_list_collection; + protocol::TMManifests const manifests; + protocol::TMEndpoints const endpoints; + protocol::TMTransaction const transaction; + protocol::TMGetLedger const get_ledger; + protocol::TMLedgerData const ledger_data; + protocol::TMGetObjectByHash const get_object; + protocol::TMValidatorList const validator_list; + protocol::TMValidatorListCollection const validator_list_collection; // 4.5KB doTest(buildManifests(20), protocol::mtMANIFESTS, 4, "TMManifests20"); @@ -399,7 +419,7 @@ public: return env; }; auto handshake = [&](int outboundEnable, int inboundEnable) { - beast::IP::Address addr = boost::asio::ip::make_address("172.1.1.100"); + beast::IP::Address const addr = boost::asio::ip::make_address("172.1.1.100"); auto env = getEnv(outboundEnable); auto request = xrpl::makeRequest( diff --git a/src/test/overlay/handshake_test.cpp b/src/test/overlay/handshake_test.cpp index 8e2d5d5ec1..8727f10b88 100644 --- a/src/test/overlay/handshake_test.cpp +++ b/src/test/overlay/handshake_test.cpp @@ -1,6 +1,6 @@ #include -#include +#include namespace xrpl { diff --git a/src/test/overlay/reduce_relay_test.cpp b/src/test/overlay/reduce_relay_test.cpp index 895332b94f..e0538a29b4 100644 --- a/src/test/overlay/reduce_relay_test.cpp +++ b/src/test/overlay/reduce_relay_test.cpp @@ -1,24 +1,50 @@ -#include #include +#include +#include #include #include +#include #include #include #include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include #include -#include -#include +#include + +#include #include +#include #include +#include +#include +#include #include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -120,7 +146,7 @@ public: uint256 const& getClosedLedgerHash() const override { - static uint256 hash{}; + static uint256 const hash{}; return hash; } bool @@ -481,7 +507,7 @@ public: onMessage(protocol::TMSquelch const& squelch) override { auto validator = squelch.validatorpubkey(); - PublicKey key(Slice(validator.data(), validator.size())); + PublicKey const key(Slice(validator.data(), validator.size())); if (squelch.squelch()) { squelch_.addSquelch(key, std::chrono::seconds{squelch.squelchduration()}); @@ -776,7 +802,7 @@ public: squelch.set_squelch(false); for (auto& v : validators_) { - PublicKey key = v; + PublicKey const key = v; squelch.clear_validatorpubkey(); squelch.set_validatorpubkey(key.data(), key.size()); v.for_links({peer}, [&](Link& l, MessageSPtr) { @@ -886,7 +912,7 @@ protected: std::optional duration) { protocol::TMSquelch squelch; - bool res = static_cast(duration); + bool const res = static_cast(duration); squelch.set_squelch(res); squelch.set_validatorpubkey(validator.data(), validator.size()); if (res) @@ -992,7 +1018,7 @@ protected: if (events[EventType::PeerDisconnected].state_ == State::On) { auto& event = events[EventType::PeerDisconnected]; - bool allCounting = network_.allCounting(event.peer_); + bool const allCounting = network_.allCounting(event.peer_); network_.overlay().deletePeer( event.peer_, [&](PublicKey const& v, PeerWPtr const& peerPtr) { if (event.isSelected_) @@ -1004,7 +1030,7 @@ protected: // take place because there is no peers in Squelched state in // any of the slots where the peer is in Selected state // (allCounting is true) - bool handled = (!event.isSelected_ && !event.handled_) || + bool const handled = (!event.isSelected_ && !event.handled_) || (event.isSelected_ && (event.handled_ || allCounting)); BEAST_EXPECT(handled); event.state_ = State::Off; @@ -1047,7 +1073,7 @@ protected: sendSquelch(validator, ptr, {}); } }); - bool handled = (event.handled_ && event.state_ == State::WaitReset) || + bool const handled = (event.handled_ && event.state_ == State::WaitReset) || (!event.handled_ && !mustHandle); BEAST_EXPECT(handled); } @@ -1055,7 +1081,7 @@ protected: (event.state_ == State::On && (now - event.time_ > (reduce_relay::IDLED + seconds(2))))) { - bool handled = event.state_ == State::WaitReset || !event.handled_; + bool const handled = event.state_ == State::WaitReset || !event.handled_; BEAST_EXPECT(handled); event.state_ = State::Off; event.isSelected_ = false; @@ -1270,10 +1296,10 @@ protected: doTest("Test Config - squelch enabled (legacy)", log, [&](bool log) { Config c; - std::string toLoad(R"rippleConfig( + std::string const toLoad(R"xrpldConfig( [reduce_relay] vp_enable=1 -)rippleConfig"); +)xrpldConfig"); c.loadFromString(toLoad); BEAST_EXPECT(c.VP_REDUCE_RELAY_BASE_SQUELCH_ENABLE == true); @@ -1282,19 +1308,19 @@ vp_enable=1 doTest("Test Config - squelch disabled (legacy)", log, [&](bool log) { Config c; - std::string toLoad(R"rippleConfig( + std::string toLoad(R"xrpldConfig( [reduce_relay] vp_enable=0 -)rippleConfig"); +)xrpldConfig"); c.loadFromString(toLoad); BEAST_EXPECT(c.VP_REDUCE_RELAY_BASE_SQUELCH_ENABLE == false); Config c1; - toLoad = R"rippleConfig( + toLoad = R"xrpldConfig( [reduce_relay] -)rippleConfig"; +)xrpldConfig"; c1.loadFromString(toLoad); BEAST_EXPECT(c1.VP_REDUCE_RELAY_BASE_SQUELCH_ENABLE == false); @@ -1303,10 +1329,10 @@ vp_enable=0 doTest("Test Config - squelch enabled", log, [&](bool log) { Config c; - std::string toLoad(R"rippleConfig( + std::string const toLoad(R"xrpldConfig( [reduce_relay] vp_base_squelch_enable=1 -)rippleConfig"); +)xrpldConfig"); c.loadFromString(toLoad); BEAST_EXPECT(c.VP_REDUCE_RELAY_BASE_SQUELCH_ENABLE == true); @@ -1315,10 +1341,10 @@ vp_base_squelch_enable=1 doTest("Test Config - squelch disabled", log, [&](bool log) { Config c; - std::string toLoad(R"rippleConfig( + std::string const toLoad(R"xrpldConfig( [reduce_relay] vp_base_squelch_enable=0 -)rippleConfig"); +)xrpldConfig"); c.loadFromString(toLoad); BEAST_EXPECT(c.VP_REDUCE_RELAY_BASE_SQUELCH_ENABLE == false); @@ -1327,11 +1353,11 @@ vp_base_squelch_enable=0 doTest("Test Config - legacy and new", log, [&](bool log) { Config c; - std::string toLoad(R"rippleConfig( + std::string const toLoad(R"xrpldConfig( [reduce_relay] vp_base_squelch_enable=0 vp_enable=0 -)rippleConfig"); +)xrpldConfig"); std::string error; auto const expectedError = @@ -1345,7 +1371,7 @@ vp_enable=0 { c.loadFromString(toLoad); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -1356,29 +1382,29 @@ vp_enable=0 doTest("Test Config - max selected peers", log, [&](bool log) { Config c; - std::string toLoad(R"rippleConfig( + std::string toLoad(R"xrpldConfig( [reduce_relay] -)rippleConfig"); +)xrpldConfig"); c.loadFromString(toLoad); BEAST_EXPECT(c.VP_REDUCE_RELAY_SQUELCH_MAX_SELECTED_PEERS == 5); Config c1; - toLoad = R"rippleConfig( + toLoad = R"xrpldConfig( [reduce_relay] vp_base_squelch_max_selected_peers=6 -)rippleConfig"; +)xrpldConfig"; c1.loadFromString(toLoad); BEAST_EXPECT(c1.VP_REDUCE_RELAY_SQUELCH_MAX_SELECTED_PEERS == 6); Config c2; - toLoad = R"rippleConfig( + toLoad = R"xrpldConfig( [reduce_relay] vp_base_squelch_max_selected_peers=2 -)rippleConfig"; +)xrpldConfig"; std::string error; auto const expectedError = @@ -1389,7 +1415,7 @@ vp_base_squelch_max_selected_peers=2 { c2.loadFromString(toLoad); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { error = e.what(); } @@ -1432,10 +1458,10 @@ vp_base_squelch_max_selected_peers=2 doTest("Duplicate Message", log, [&](bool log) { network_.reset(); // update message count for the same peer/validator - std::int16_t nMessages = 5; + std::int16_t const nMessages = 5; for (int i = 0; i < nMessages; i++) { - uint256 key(i); + uint256 const key(i); network_.overlay().updateSlotAndSquelch( key, network_.validator(0), 0, [&](PublicKey const&, PeerWPtr, std::uint32_t) { }); @@ -1445,7 +1471,7 @@ vp_base_squelch_max_selected_peers=2 // hence '-1'. BEAST_EXPECT(std::get<1>(peers[0]) == (nMessages - 1)); // add duplicate - uint256 key(nMessages - 1); + uint256 const key(nMessages - 1); network_.overlay().updateSlotAndSquelch( key, network_.validator(0), 0, [&](PublicKey const&, PeerWPtr, std::uint32_t) {}); // confirm the same number of messages @@ -1498,7 +1524,7 @@ vp_base_squelch_max_selected_peers=2 { // make unique message hash to make the // slot's internal hash router accept the message - std::uint64_t mid = (m * 1000) + peer; + std::uint64_t const mid = (m * 1000) + peer; uint256 const message{mid}; slots.updateSlotAndSquelch( message, validator, peer, protocol::MessageType::mtVALIDATION); @@ -1568,7 +1594,7 @@ vp_base_squelch_max_selected_peers=2 env_.app().config().COMPRESSION = c.COMPRESSION; }; auto handshake = [&](int outboundEnable, int inboundEnable) { - beast::IP::Address addr = boost::asio::ip::make_address("172.1.1.100"); + beast::IP::Address const addr = boost::asio::ip::make_address("172.1.1.100"); setEnv(outboundEnable); auto request = xrpl::makeRequest( @@ -1622,7 +1648,7 @@ public: void run() override { - bool log = false; + bool const log = false; testConfig(log); testInitialRound(log); testPeerUnsquelchedTooSoon(log); @@ -1649,7 +1675,7 @@ class reduce_relay_simulate_test : public reduce_relay_test void run() override { - bool log = false; + bool const log = false; testRandom(log); } }; diff --git a/src/test/overlay/short_read_test.cpp b/src/test/overlay/short_read_test.cpp index d96f67c8a1..6c8c68e95c 100644 --- a/src/test/overlay/short_read_test.cpp +++ b/src/test/overlay/short_read_test.cpp @@ -2,21 +2,39 @@ #include #include -#include +#include +#include #include #include +#include +#include +#include +#include #include +#include #include -#include +#include +#include #include #include -#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include #include #include +#include namespace xrpl { /* @@ -56,7 +74,7 @@ private: using boost::asio::buffer; using boost::asio::buffer_copy; using boost::asio::buffer_size; - boost::asio::const_buffer buf(s.data(), s.size()); + boost::asio::const_buffer const buf(s.data(), s.size()); sb.commit(buffer_copy(sb.prepare(buffer_size(buf)), buf)); } @@ -100,14 +118,14 @@ private: void add(std::shared_ptr const& child) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list_.emplace(child.get(), child); } void remove(Child* child) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list_.erase(child); if (list_.empty()) cond_.notify_one(); @@ -118,7 +136,7 @@ private: { std::vector> v; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); v.reserve(list_.size()); if (closed_) return; @@ -636,7 +654,7 @@ public: void run() override { - Server s(*this); + Server const s(*this); Client c(*this, s.endpoint()); c.wait(); pass(); diff --git a/src/test/overlay/traffic_count_test.cpp b/src/test/overlay/traffic_count_test.cpp index 5e6e4e685c..ffb1ceb9c2 100644 --- a/src/test/overlay/traffic_count_test.cpp +++ b/src/test/overlay/traffic_count_test.cpp @@ -1,8 +1,11 @@ -#include #include -#include -#include +#include + +#include + +#include +#include namespace xrpl { diff --git a/src/test/overlay/tx_reduce_relay_test.cpp b/src/test/overlay/tx_reduce_relay_test.cpp index 04d8bae768..354189904a 100644 --- a/src/test/overlay/tx_reduce_relay_test.cpp +++ b/src/test/overlay/tx_reduce_relay_test.cpp @@ -1,12 +1,47 @@ -#include #include +#include +#include +#include +#include +#include +#include #include #include -#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -159,10 +194,11 @@ private: auto stream_ptr = std::make_unique( socket_type(std::forward(env.app().getIOContext())), *context_); - beast::IP::Endpoint local(boost::asio::ip::make_address("172.1.1." + std::to_string(lid_))); - beast::IP::Endpoint remote( + beast::IP::Endpoint const local( + boost::asio::ip::make_address("172.1.1." + std::to_string(lid_))); + beast::IP::Endpoint const remote( boost::asio::ip::make_address("172.1.1." + std::to_string(rid_))); - PublicKey key(std::get<0>(randomKeyPair(KeyType::ed25519))); + PublicKey const key(std::get<0>(randomKeyPair(KeyType::ed25519))); auto consumer = overlay.resourceManager().newInboundEndpoint(remote); auto [slot, _] = overlay.peerFinder().new_inbound_slot(local, remote); auto const peer = std::make_shared( @@ -224,7 +260,7 @@ private: void run() override { - bool log = false; + bool const log = false; std::set skip = {0, 1, 2, 3, 4}; testConfig(log); // relay to all peers, no hash queue diff --git a/src/test/peerfinder/Livecache_test.cpp b/src/test/peerfinder/Livecache_test.cpp index b2d0eeeaf1..7678400e9e 100644 --- a/src/test/peerfinder/Livecache_test.cpp +++ b/src/test/peerfinder/Livecache_test.cpp @@ -1,13 +1,26 @@ #include #include +#include #include +#include #include -#include -#include +#include +#include +#include -#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { namespace PeerFinder { @@ -33,7 +46,7 @@ public: void add(beast::IP::Endpoint ep, C& c, std::uint32_t hops = 0) { - Endpoint cep{ep, hops}; + Endpoint const cep{ep, hops}; c.insert(cep); } diff --git a/src/test/peerfinder/PeerFinder_test.cpp b/src/test/peerfinder/PeerFinder_test.cpp index c39564c54c..8203b7d9c3 100644 --- a/src/test/peerfinder/PeerFinder_test.cpp +++ b/src/test/peerfinder/PeerFinder_test.cpp @@ -2,13 +2,27 @@ #include #include +#include #include +#include #include +#include #include +#include #include #include +#include + +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace PeerFinder { @@ -411,7 +425,7 @@ public: (c.PEERS_MAX == max && c.PEERS_IN_MAX == 0 && c.PEERS_OUT_MAX == 0) || (c.PEERS_IN_MAX == *maxIn && c.PEERS_OUT_MAX == *maxOut)); - Config config = Config::makeConfig(c, port, false, 0); + Config const config = Config::makeConfig(c, port, false, 0); Counts counts; counts.onConfig(config); @@ -469,32 +483,32 @@ public: pass(); } }; - run(R"rippleConfig( + run(R"xrpldConfig( [peers_in_max] 100 -)rippleConfig"); - run(R"rippleConfig( +)xrpldConfig"); + run(R"xrpldConfig( [peers_out_max] 100 -)rippleConfig"); - run(R"rippleConfig( +)xrpldConfig"); + run(R"xrpldConfig( [peers_in_max] 100 [peers_out_max] 5 -)rippleConfig"); - run(R"rippleConfig( +)xrpldConfig"); + run(R"xrpldConfig( [peers_in_max] 1001 [peers_out_max] 10 -)rippleConfig"); - run(R"rippleConfig( +)xrpldConfig"); + run(R"xrpldConfig( [peers_in_max] 10 [peers_out_max] 1001 -)rippleConfig"); +)xrpldConfig"); } void diff --git a/src/test/protocol/ApiVersion_test.cpp b/src/test/protocol/ApiVersion_test.cpp index 0b7babc764..fa0deec575 100644 --- a/src/test/protocol/ApiVersion_test.cpp +++ b/src/test/protocol/ApiVersion_test.cpp @@ -1,14 +1,6 @@ -#include #include #include -#include -#include -#include -#include -#include -#include - namespace xrpl { namespace test { struct ApiVersion_test : beast::unit_test::suite diff --git a/src/test/protocol/BuildInfo_test.cpp b/src/test/protocol/BuildInfo_test.cpp index d9810e93ea..d157978744 100644 --- a/src/test/protocol/BuildInfo_test.cpp +++ b/src/test/protocol/BuildInfo_test.cpp @@ -1,4 +1,4 @@ -#include +#include #include namespace xrpl { @@ -53,13 +53,13 @@ public: } void - testIsRippledVersion() + testIsXrpldVersion() { - testcase("IsRippledVersion"); + testcase("IsXrpldVersion"); auto vFF = 0xFFFF'FFFF'FFFF'FFFFLLU; - BEAST_EXPECT(!BuildInfo::isRippledVersion(vFF)); - auto vRippled = 0x183B'0000'0000'0000LLU; - BEAST_EXPECT(BuildInfo::isRippledVersion(vRippled)); + BEAST_EXPECT(!BuildInfo::isXrpldVersion(vFF)); + auto vXrpld = 0x183B'0000'0000'0000LLU; + BEAST_EXPECT(BuildInfo::isXrpldVersion(vXrpld)); } void @@ -83,7 +83,7 @@ public: run() override { testEncodeSoftwareVersion(); - testIsRippledVersion(); + testIsXrpldVersion(); testIsNewerVersion(); } }; diff --git a/src/test/protocol/Hooks_test.cpp b/src/test/protocol/Hooks_test.cpp index a280fd6bd4..c6254d16bb 100644 --- a/src/test/protocol/Hooks_test.cpp +++ b/src/test/protocol/Hooks_test.cpp @@ -1,7 +1,15 @@ -#include -#include +#include // IWYU pragma: keep + +#include +#include +#include +#include +#include +#include + +#include #include #include @@ -11,7 +19,7 @@ class Hooks_test : public beast::unit_test::suite { /** * This unit test was requested here: - * https://github.com/ripple/rippled/pull/4089#issuecomment-1050274539 + * https://github.com/XRPLF/rippled/pull/4089#issuecomment-1050274539 * These are tests that exercise facilities that are reserved for when Hooks * is merged in the future. **/ @@ -23,7 +31,7 @@ class Hooks_test : public beast::unit_test::suite using namespace test::jtx; - std::vector> fields_to_test = { + std::vector> const fields_to_test = { sfHookResult, sfHookStateChangeCount, sfHookEmitCount, @@ -116,7 +124,7 @@ class Hooks_test : public beast::unit_test::suite } case STI_UINT256: { - uint256 u = uint256::fromVoid( + uint256 const u = uint256::fromVoid( "DEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBE" "EFDEADBEEF"); dummy.setFieldH256(f, u); @@ -126,7 +134,7 @@ class Hooks_test : public beast::unit_test::suite } case STI_VL: { - std::vector v{1, 2, 3}; + std::vector const v{1, 2, 3}; dummy.setFieldVL(f, v); BEAST_EXPECT(dummy.getFieldVL(f) == v); BEAST_EXPECT(dummy.isFieldPresent(f)); @@ -135,7 +143,8 @@ class Hooks_test : public beast::unit_test::suite case STI_ACCOUNT: { // NOLINTNEXTLINE(bugprone-unchecked-optional-access) - AccountID id = *parseBase58("rwfSjJNK2YQuN64bSWn7T2eY9FJAyAPYJT"); + AccountID const id = + *parseBase58("rwfSjJNK2YQuN64bSWn7T2eY9FJAyAPYJT"); dummy.setAccountID(f, id); BEAST_EXPECT(dummy.getAccountID(f) == id); BEAST_EXPECT(dummy.isFieldPresent(f)); diff --git a/src/test/protocol/InnerObjectFormats_test.cpp b/src/test/protocol/InnerObjectFormats_test.cpp index c06524b90e..049f38596b 100644 --- a/src/test/protocol/InnerObjectFormats_test.cpp +++ b/src/test/protocol/InnerObjectFormats_test.cpp @@ -1,11 +1,16 @@ -#include + +#include #include -#include -#include // Json::Reader +#include +#include // Json::Reader +#include #include // RPC::containsError #include // STParsedJSONObject +#include +#include + namespace xrpl { namespace InnerObjectFormatsUnitTestDetail { @@ -155,7 +160,7 @@ public: using namespace InnerObjectFormatsUnitTestDetail; // Instantiate a jtx::Env so debugLog writes are exercised. - test::jtx::Env env(*this); + test::jtx::Env const env(*this); for (auto const& test : testArray) { @@ -166,7 +171,7 @@ public: Throw( "Internal InnerObjectFormatsParsedJSON error. Bad JSON."); } - STParsedJSONObject parsed("request", req); + STParsedJSONObject const parsed("request", req); bool const noObj = !parsed.object.has_value(); if (noObj == test.expectFail) { diff --git a/src/test/protocol/Issue_test.cpp b/src/test/protocol/Issue_test.cpp index 2321da4a6e..116ac7ca27 100644 --- a/src/test/protocol/Issue_test.cpp +++ b/src/test/protocol/Issue_test.cpp @@ -1,15 +1,16 @@ #include -#include +#include +#include +#include #include #include +#include -#include - +#include #include #include #include -#include -#include +#include #if BEAST_MSVC #define STL_SET_HAS_EMPLACE 1 @@ -42,7 +43,7 @@ public: BEAST_EXPECT(u3 >= u2); BEAST_EXPECT(u3 > u2); - std::hash hash; + std::hash const hash; BEAST_EXPECT(hash(u1) == hash(u1)); BEAST_EXPECT(hash(u2) == hash(u2)); @@ -83,7 +84,7 @@ public: BEAST_EXPECT(Issue(c1, i3) >= Issue(c1, i2)); BEAST_EXPECT(Issue(c1, i3) > Issue(c1, i2)); - std::hash hash; + std::hash const hash; BEAST_EXPECT(hash(Issue(c1, i1)) == hash(Issue(c1, i1))); BEAST_EXPECT(hash(Issue(c1, i2)) == hash(Issue(c1, i2))); @@ -394,10 +395,10 @@ public: Currency const c3(3); AccountID const i3(3); - Issue a1(c1, i1); - Issue a2(c1, i2); - Issue a3(c2, i2); - Issue a4(c3, i2); + Issue const a1(c1, i1); + Issue const a2(c1, i2); + Issue const a3(c2, i2); + Issue const a4(c3, i2); uint256 const domain1{1}; uint256 const domain2{2}; @@ -477,7 +478,7 @@ public: BEAST_EXPECT(Book(a3, a4, domain2) > Book(a2, a3, domain1)); } - std::hash hash; + std::hash const hash; // log << std::hex << hash (Book (a1, a2)); // log << std::hex << hash (Book (a1, a2)); diff --git a/src/test/protocol/Memo_test.cpp b/src/test/protocol/Memo_test.cpp index 9a0fd7d94c..fa6d7905a4 100644 --- a/src/test/protocol/Memo_test.cpp +++ b/src/test/protocol/Memo_test.cpp @@ -1,6 +1,17 @@ -#include + +#include +#include +#include +#include +#include +#include +#include #include +#include +#include + +#include namespace xrpl { @@ -13,7 +24,7 @@ public: testcase("Test memos"); using namespace test::jtx; - Account alice{"alice"}; + Account const alice{"alice"}; Env env(*this); env.fund(XRP(10000), alice); diff --git a/src/test/protocol/MultiApiJson_test.cpp b/src/test/protocol/MultiApiJson_test.cpp index 5aafa19771..1ead56c8d6 100644 --- a/src/test/protocol/MultiApiJson_test.cpp +++ b/src/test/protocol/MultiApiJson_test.cpp @@ -1,7 +1,10 @@ -#include +#include +#include +#include #include -#include +#include +#include #include #include #include diff --git a/src/test/protocol/PublicKey_test.cpp b/src/test/protocol/PublicKey_test.cpp index 79c1356bb4..cc5658d1c1 100644 --- a/src/test/protocol/PublicKey_test.cpp +++ b/src/test/protocol/PublicKey_test.cpp @@ -1,7 +1,17 @@ -#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include #include namespace xrpl { @@ -304,7 +314,7 @@ public: auto s = good; // Remove all characters from the string in random order: - std::hash r; + std::hash const r; while (!s.empty()) { @@ -421,7 +431,7 @@ public: KeyType::secp256k1, generateSecretKey(KeyType::secp256k1, generateSeed("masterpassphrase"))); - PublicKey pk2(pk1); + PublicKey const pk2(pk1); BEAST_EXPECT(pk1 == pk2); BEAST_EXPECT(pk2 == pk1); diff --git a/src/test/protocol/Quality_test.cpp b/src/test/protocol/Quality_test.cpp index 1dbbbfdf3d..3e45ac6bc0 100644 --- a/src/test/protocol/Quality_test.cpp +++ b/src/test/protocol/Quality_test.cpp @@ -1,6 +1,12 @@ -#include +#include +#include +#include +#include #include +#include +#include +#include #include namespace xrpl { @@ -66,7 +72,7 @@ public: { // 1 in, 1 out: - Quality q(Amounts(amount(1), amount(1))); + Quality const q(Amounts(amount(1), amount(1))); ceil_in( q, @@ -95,7 +101,7 @@ public: { // 1 in, 2 out: - Quality q(Amounts(amount(1), amount(2))); + Quality const q(Amounts(amount(1), amount(2))); ceil_in( q, @@ -124,7 +130,7 @@ public: { // 2 in, 1 out: - Quality q(Amounts(amount(2), amount(1))); + Quality const q(Amounts(amount(2), amount(1))); ceil_in( q, @@ -159,7 +165,7 @@ public: { // 1 in, 1 out: - Quality q(Amounts(amount(1), amount(1))); + Quality const q(Amounts(amount(1), amount(1))); ceil_out( q, @@ -188,7 +194,7 @@ public: { // 1 in, 2 out: - Quality q(Amounts(amount(1), amount(2))); + Quality const q(Amounts(amount(1), amount(2))); ceil_out( q, @@ -217,7 +223,7 @@ public: { // 2 in, 1 out: - Quality q(Amounts(amount(2), amount(1))); + Quality const q(Amounts(amount(2), amount(1))); ceil_out( q, @@ -251,7 +257,7 @@ public: testcase("raw"); { - Quality q(0x5d048191fb9130daull); // 126836389.7680090 + Quality const q(0x5d048191fb9130daull); // 126836389.7680090 Amounts const value( amount(349469768), // 349.469768 XRP raw(2755280000000000ull, -15)); // 2.75528 @@ -266,7 +272,7 @@ public: { testcase("round"); - Quality q(0x59148191fb913522ull); // 57719.63525051682 + Quality const q(0x59148191fb913522ull); // 57719.63525051682 BEAST_EXPECT(q.round(3).rate().getText() == "57800"); BEAST_EXPECT(q.round(4).rate().getText() == "57720"); BEAST_EXPECT(q.round(5).rate().getText() == "57720"); diff --git a/src/test/protocol/STAccount_test.cpp b/src/test/protocol/STAccount_test.cpp index 3b12605a92..eb356ecb8d 100644 --- a/src/test/protocol/STAccount_test.cpp +++ b/src/test/protocol/STAccount_test.cpp @@ -1,5 +1,12 @@ -#include +#include +#include +#include +#include #include +#include + +#include +#include namespace xrpl { diff --git a/src/test/protocol/STAmount_test.cpp b/src/test/protocol/STAmount_test.cpp index 4f652dddd9..78ef9c2a8a 100644 --- a/src/test/protocol/STAmount_test.cpp +++ b/src/test/protocol/STAmount_test.cpp @@ -1,10 +1,30 @@ -#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { class STAmount_test : public beast::unit_test::suite @@ -28,17 +48,17 @@ public: return amount; std::uint64_t mantissa = amount.mantissa(); - std::uint64_t valueDigits = mantissa % 1000000000; + std::uint64_t const valueDigits = mantissa % 1000000000; if (valueDigits == 1) { mantissa--; if (mantissa < STAmount::cMinValue) - return {amount.issue(), mantissa, amount.exponent(), amount.negative()}; + return {amount.asset(), mantissa, amount.exponent(), amount.negative()}; return { - amount.issue(), + amount.asset(), mantissa, amount.exponent(), amount.negative(), @@ -50,10 +70,10 @@ public: mantissa++; if (mantissa > STAmount::cMaxValue) - return {amount.issue(), mantissa, amount.exponent(), amount.negative()}; + return {amount.asset(), mantissa, amount.exponent(), amount.negative()}; return { - amount.issue(), + amount.asset(), mantissa, amount.exponent(), amount.negative(), @@ -67,19 +87,19 @@ public: roundTest(int n, int d, int m) { // check STAmount rounding - STAmount num(noIssue(), n); - STAmount den(noIssue(), d); - STAmount mul(noIssue(), m); - STAmount quot = divide(STAmount(n), STAmount(d), noIssue()); - STAmount res = roundSelf(multiply(quot, mul, noIssue())); + STAmount const num(noIssue(), n); + STAmount const den(noIssue(), d); + STAmount const mul(noIssue(), m); + STAmount const quot = divide(STAmount(n), STAmount(d), noIssue()); + STAmount const res = roundSelf(multiply(quot, mul, noIssue())); BEAST_EXPECT(!res.native()); - STAmount cmp(noIssue(), (n * m) / d); + STAmount const cmp(noIssue(), (n * m) / d); BEAST_EXPECT(!cmp.native()); - BEAST_EXPECT(cmp.issue().currency == res.issue().currency); + BEAST_EXPECT(cmp.get().currency == res.get().currency); if (res != cmp) { @@ -93,13 +113,14 @@ public: void mulTest(int a, int b) { - STAmount aa(noIssue(), a); - STAmount bb(noIssue(), b); - STAmount prod1(multiply(aa, bb, noIssue())); + STAmount const aa(noIssue(), a); + STAmount const bb(noIssue(), b); + STAmount const prod1(multiply(aa, bb, noIssue())); BEAST_EXPECT(!prod1.native()); - STAmount prod2(noIssue(), static_cast(a) * static_cast(b)); + STAmount const prod2( + noIssue(), static_cast(a) * static_cast(b)); if (prod1 != prod2) { @@ -196,7 +217,11 @@ public: testNativeCurrency() { testcase("native currency"); - STAmount zeroSt, one(1), hundred(100); + + STAmount const zeroSt; + STAmount const one(1); + STAmount const hundred(100); + // VFALCO NOTE Why repeat "STAmount fail" so many times?? unexpected(serializeAndDeserialize(zeroSt) != zeroSt, "STAmount fail"); unexpected(serializeAndDeserialize(one) != one, "STAmount fail"); @@ -206,60 +231,60 @@ public: unexpected(zeroSt != beast::zero, "STAmount fail"); unexpected(one == beast::zero, "STAmount fail"); unexpected(hundred == beast::zero, "STAmount fail"); - unexpected((zeroSt < zeroSt), "STAmount fail"); + unexpected((zeroSt < zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(zeroSt < one), "STAmount fail"); unexpected(!(zeroSt < hundred), "STAmount fail"); unexpected((one < zeroSt), "STAmount fail"); - unexpected((one < one), "STAmount fail"); + unexpected((one < one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(one < hundred), "STAmount fail"); unexpected((hundred < zeroSt), "STAmount fail"); unexpected((hundred < one), "STAmount fail"); - unexpected((hundred < hundred), "STAmount fail"); - unexpected((zeroSt > zeroSt), "STAmount fail"); + unexpected((hundred < hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected((zeroSt > zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((zeroSt > one), "STAmount fail"); unexpected((zeroSt > hundred), "STAmount fail"); unexpected(!(one > zeroSt), "STAmount fail"); - unexpected((one > one), "STAmount fail"); + unexpected((one > one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((one > hundred), "STAmount fail"); unexpected(!(hundred > zeroSt), "STAmount fail"); unexpected(!(hundred > one), "STAmount fail"); - unexpected((hundred > hundred), "STAmount fail"); - unexpected(!(zeroSt <= zeroSt), "STAmount fail"); + unexpected((hundred > hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected(!(zeroSt <= zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(zeroSt <= one), "STAmount fail"); unexpected(!(zeroSt <= hundred), "STAmount fail"); unexpected((one <= zeroSt), "STAmount fail"); - unexpected(!(one <= one), "STAmount fail"); + unexpected(!(one <= one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(one <= hundred), "STAmount fail"); unexpected((hundred <= zeroSt), "STAmount fail"); unexpected((hundred <= one), "STAmount fail"); - unexpected(!(hundred <= hundred), "STAmount fail"); - unexpected(!(zeroSt >= zeroSt), "STAmount fail"); + unexpected(!(hundred <= hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected(!(zeroSt >= zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((zeroSt >= one), "STAmount fail"); unexpected((zeroSt >= hundred), "STAmount fail"); unexpected(!(one >= zeroSt), "STAmount fail"); - unexpected(!(one >= one), "STAmount fail"); + unexpected(!(one >= one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((one >= hundred), "STAmount fail"); unexpected(!(hundred >= zeroSt), "STAmount fail"); unexpected(!(hundred >= one), "STAmount fail"); - unexpected(!(hundred >= hundred), "STAmount fail"); - unexpected(!(zeroSt == zeroSt), "STAmount fail"); + unexpected(!(hundred >= hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected(!(zeroSt == zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((zeroSt == one), "STAmount fail"); unexpected((zeroSt == hundred), "STAmount fail"); unexpected((one == zeroSt), "STAmount fail"); - unexpected(!(one == one), "STAmount fail"); + unexpected(!(one == one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((one == hundred), "STAmount fail"); unexpected((hundred == zeroSt), "STAmount fail"); unexpected((hundred == one), "STAmount fail"); - unexpected(!(hundred == hundred), "STAmount fail"); - unexpected((zeroSt != zeroSt), "STAmount fail"); + unexpected(!(hundred == hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected((zeroSt != zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(zeroSt != one), "STAmount fail"); unexpected(!(zeroSt != hundred), "STAmount fail"); unexpected(!(one != zeroSt), "STAmount fail"); - unexpected((one != one), "STAmount fail"); + unexpected((one != one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(one != hundred), "STAmount fail"); unexpected(!(hundred != zeroSt), "STAmount fail"); unexpected(!(hundred != one), "STAmount fail"); - unexpected((hundred != hundred), "STAmount fail"); + unexpected((hundred != hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(STAmount().getText() != "0", "STAmount fail"); unexpected(STAmount(31).getText() != "31", "STAmount fail"); unexpected(STAmount(310).getText() != "310", "STAmount fail"); @@ -279,7 +304,11 @@ public: testCustomCurrency() { testcase("custom currency"); - STAmount zeroSt(noIssue()), one(noIssue(), 1), hundred(noIssue(), 100); + + STAmount const zeroSt(noIssue()); + STAmount const one(noIssue(), 1); + STAmount const hundred(noIssue(), 100); + unexpected(serializeAndDeserialize(zeroSt) != zeroSt, "STAmount fail"); unexpected(serializeAndDeserialize(one) != one, "STAmount fail"); unexpected(serializeAndDeserialize(hundred) != hundred, "STAmount fail"); @@ -288,60 +317,60 @@ public: unexpected(zeroSt != beast::zero, "STAmount fail"); unexpected(one == beast::zero, "STAmount fail"); unexpected(hundred == beast::zero, "STAmount fail"); - unexpected((zeroSt < zeroSt), "STAmount fail"); + unexpected((zeroSt < zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(zeroSt < one), "STAmount fail"); unexpected(!(zeroSt < hundred), "STAmount fail"); unexpected((one < zeroSt), "STAmount fail"); - unexpected((one < one), "STAmount fail"); + unexpected((one < one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(one < hundred), "STAmount fail"); unexpected((hundred < zeroSt), "STAmount fail"); unexpected((hundred < one), "STAmount fail"); - unexpected((hundred < hundred), "STAmount fail"); - unexpected((zeroSt > zeroSt), "STAmount fail"); + unexpected((hundred < hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected((zeroSt > zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((zeroSt > one), "STAmount fail"); unexpected((zeroSt > hundred), "STAmount fail"); unexpected(!(one > zeroSt), "STAmount fail"); - unexpected((one > one), "STAmount fail"); + unexpected((one > one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((one > hundred), "STAmount fail"); unexpected(!(hundred > zeroSt), "STAmount fail"); unexpected(!(hundred > one), "STAmount fail"); - unexpected((hundred > hundred), "STAmount fail"); - unexpected(!(zeroSt <= zeroSt), "STAmount fail"); + unexpected((hundred > hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected(!(zeroSt <= zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(zeroSt <= one), "STAmount fail"); unexpected(!(zeroSt <= hundred), "STAmount fail"); unexpected((one <= zeroSt), "STAmount fail"); - unexpected(!(one <= one), "STAmount fail"); + unexpected(!(one <= one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(one <= hundred), "STAmount fail"); unexpected((hundred <= zeroSt), "STAmount fail"); unexpected((hundred <= one), "STAmount fail"); - unexpected(!(hundred <= hundred), "STAmount fail"); - unexpected(!(zeroSt >= zeroSt), "STAmount fail"); + unexpected(!(hundred <= hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected(!(zeroSt >= zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((zeroSt >= one), "STAmount fail"); unexpected((zeroSt >= hundred), "STAmount fail"); unexpected(!(one >= zeroSt), "STAmount fail"); - unexpected(!(one >= one), "STAmount fail"); + unexpected(!(one >= one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((one >= hundred), "STAmount fail"); unexpected(!(hundred >= zeroSt), "STAmount fail"); unexpected(!(hundred >= one), "STAmount fail"); - unexpected(!(hundred >= hundred), "STAmount fail"); - unexpected(!(zeroSt == zeroSt), "STAmount fail"); + unexpected(!(hundred >= hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected(!(zeroSt == zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((zeroSt == one), "STAmount fail"); unexpected((zeroSt == hundred), "STAmount fail"); unexpected((one == zeroSt), "STAmount fail"); - unexpected(!(one == one), "STAmount fail"); + unexpected(!(one == one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected((one == hundred), "STAmount fail"); unexpected((hundred == zeroSt), "STAmount fail"); unexpected((hundred == one), "STAmount fail"); - unexpected(!(hundred == hundred), "STAmount fail"); - unexpected((zeroSt != zeroSt), "STAmount fail"); + unexpected(!(hundred == hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) + unexpected((zeroSt != zeroSt), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(zeroSt != one), "STAmount fail"); unexpected(!(zeroSt != hundred), "STAmount fail"); unexpected(!(one != zeroSt), "STAmount fail"); - unexpected((one != one), "STAmount fail"); + unexpected((one != one), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(!(one != hundred), "STAmount fail"); unexpected(!(hundred != zeroSt), "STAmount fail"); unexpected(!(hundred != one), "STAmount fail"); - unexpected((hundred != hundred), "STAmount fail"); + unexpected((hundred != hundred), "STAmount fail"); // NOLINT(misc-redundant-expression) unexpected(STAmount(noIssue()).getText() != "0", "STAmount fail"); unexpected(STAmount(noIssue(), 31).getText() != "31", "STAmount fail"); unexpected(STAmount(noIssue(), 31, 1).getText() != "310", "STAmount fail"); @@ -382,7 +411,8 @@ public: divide(STAmount(noIssue(), 60), STAmount(noIssue(), 3), xrpIssue()).getText() != "20", "STAmount divide fail"); - STAmount a1(noIssue(), 60), a2(noIssue(), 10, -1); + STAmount const a1(noIssue(), 60); + STAmount const a2(noIssue(), 10, -1); unexpected( divide(a2, a1, noIssue()) != amountFromQuality(getRate(a1, a2)), @@ -464,14 +494,14 @@ public: { testcase("underflow"); - STAmount bigNative(STAmount::cMaxNative / 2); - STAmount bigValue( + STAmount const bigNative(STAmount::cMaxNative / 2); + STAmount const bigValue( noIssue(), (STAmount::cMinValue + STAmount::cMaxValue) / 2, STAmount::cMaxOffset - 1); - STAmount smallValue( + STAmount const smallValue( noIssue(), (STAmount::cMinValue + STAmount::cMaxValue) / 2, STAmount::cMinOffset + 1); - STAmount zeroSt(noIssue(), 0); + STAmount const zeroSt(noIssue(), 0); - STAmount smallXSmall = multiply(smallValue, smallValue, noIssue()); + STAmount const smallXSmall = multiply(smallValue, smallValue, noIssue()); BEAST_EXPECT(smallXSmall == beast::zero); @@ -822,43 +852,43 @@ public: // Adding zero { - STAmount amt1(XRPAmount(0)); - STAmount amt2(XRPAmount(1000)); + STAmount const amt1(XRPAmount(0)); + STAmount const amt2(XRPAmount(1000)); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding zero { - STAmount amt1(XRPAmount(1000)); - STAmount amt2(XRPAmount(0)); + STAmount const amt1(XRPAmount(1000)); + STAmount const amt2(XRPAmount(0)); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding two positive XRP amounts { - STAmount amt1(XRPAmount(500)); - STAmount amt2(XRPAmount(1500)); + STAmount const amt1(XRPAmount(500)); + STAmount const amt2(XRPAmount(1500)); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding two negative XRP amounts { - STAmount amt1(XRPAmount(-500)); - STAmount amt2(XRPAmount(-1500)); + STAmount const amt1(XRPAmount(-500)); + STAmount const amt2(XRPAmount(-1500)); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding a positive and a negative XRP amount { - STAmount amt1(XRPAmount(1000)); - STAmount amt2(XRPAmount(-1000)); + STAmount const amt1(XRPAmount(1000)); + STAmount const amt2(XRPAmount(-1000)); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Overflow check for max XRP amounts { - STAmount amt1(std::numeric_limits::max()); - STAmount amt2(XRPAmount(1)); + STAmount const amt1(std::numeric_limits::max()); + STAmount const amt2(XRPAmount(1)); BEAST_EXPECT(canAdd(amt1, amt2) == false); } @@ -866,7 +896,7 @@ public: { STAmount amt1(std::numeric_limits::max()); amt1 += XRPAmount(1); - STAmount amt2(XRPAmount(-1)); + STAmount const amt2(XRPAmount(-1)); BEAST_EXPECT(canAdd(amt1, amt2) == false); } } @@ -881,50 +911,50 @@ public: // Adding two IOU amounts { - STAmount amt1(usd, 500); - STAmount amt2(usd, 1500); + STAmount const amt1(usd, 500); + STAmount const amt2(usd, 1500); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding a positive and a negative IOU amount { - STAmount amt1(usd, 1000); - STAmount amt2(usd, -1000); + STAmount const amt1(usd, 1000); + STAmount const amt2(usd, -1000); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Overflow check for max IOU amounts { - STAmount amt1(usd, std::numeric_limits::max()); - STAmount amt2(usd, 1); + STAmount const amt1(usd, std::numeric_limits::max()); + STAmount const amt2(usd, 1); BEAST_EXPECT(canAdd(amt1, amt2) == false); } // Overflow check for min IOU amounts { - STAmount amt1(usd, std::numeric_limits::min()); - STAmount amt2(usd, -1); + STAmount const amt1(usd, std::numeric_limits::min()); + STAmount const amt2(usd, -1); BEAST_EXPECT(canAdd(amt1, amt2) == false); } // Adding XRP and IOU { - STAmount amt1(XRPAmount(1)); - STAmount amt2(usd, 1); + STAmount const amt1(XRPAmount(1)); + STAmount const amt2(usd, 1); BEAST_EXPECT(canAdd(amt1, amt2) == false); } // Adding different IOU issues (non zero) { - STAmount amt1(usd, 1000); - STAmount amt2(eur, 500); + STAmount const amt1(usd, 1000); + STAmount const amt2(eur, 500); BEAST_EXPECT(canAdd(amt1, amt2) == false); } // Adding different IOU issues (zero) { - STAmount amt1(usd, 0); - STAmount amt2(eur, 500); + STAmount const amt1(usd, 0); + STAmount const amt2(eur, 500); BEAST_EXPECT(canAdd(amt1, amt2) == false); } } @@ -939,43 +969,43 @@ public: // Adding zero { - STAmount amt1(mpt, 0); - STAmount amt2(mpt, 1000); + STAmount const amt1(mpt, 0); + STAmount const amt2(mpt, 1000); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding zero { - STAmount amt1(mpt, 1000); - STAmount amt2(mpt, 0); + STAmount const amt1(mpt, 1000); + STAmount const amt2(mpt, 0); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding two positive MPT amounts { - STAmount amt1(mpt, 500); - STAmount amt2(mpt, 1500); + STAmount const amt1(mpt, 500); + STAmount const amt2(mpt, 1500); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding two negative MPT amounts { - STAmount amt1(mpt, -500); - STAmount amt2(mpt, -1500); + STAmount const amt1(mpt, -500); + STAmount const amt2(mpt, -1500); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Adding a positive and a negative MPT amount { - STAmount amt1(mpt, 1000); - STAmount amt2(mpt, -1000); + STAmount const amt1(mpt, 1000); + STAmount const amt2(mpt, -1000); BEAST_EXPECT(canAdd(amt1, amt2) == true); } // Overflow check for max MPT amounts { - STAmount amt1(mpt, std::numeric_limits::max()); - STAmount amt2(mpt, 1); + STAmount const amt1(mpt, std::numeric_limits::max()); + STAmount const amt2(mpt, 1); BEAST_EXPECT(canAdd(amt1, amt2) == false); } @@ -985,22 +1015,22 @@ public: // Adding MPT and XRP { - STAmount amt1(XRPAmount(1000)); - STAmount amt2(mpt, 1000); + STAmount const amt1(XRPAmount(1000)); + STAmount const amt2(mpt, 1000); BEAST_EXPECT(canAdd(amt1, amt2) == false); } // Adding different MPT issues (non zero) { - STAmount amt1(mpt2, 500); - STAmount amt2(mpt, 500); + STAmount const amt1(mpt2, 500); + STAmount const amt2(mpt, 500); BEAST_EXPECT(canAdd(amt1, amt2) == false); } // Adding different MPT issues (non zero) { - STAmount amt1(mpt2, 0); - STAmount amt2(mpt, 500); + STAmount const amt1(mpt2, 0); + STAmount const amt2(mpt, 500); BEAST_EXPECT(canAdd(amt1, amt2) == false); } } @@ -1012,36 +1042,36 @@ public: // Subtracting zero { - STAmount amt1(XRPAmount(1000)); - STAmount amt2(XRPAmount(0)); + STAmount const amt1(XRPAmount(1000)); + STAmount const amt2(XRPAmount(0)); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } // Subtracting zero { - STAmount amt1(XRPAmount(0)); - STAmount amt2(XRPAmount(1000)); + STAmount const amt1(XRPAmount(0)); + STAmount const amt2(XRPAmount(1000)); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Subtracting two positive XRP amounts { - STAmount amt1(XRPAmount(1500)); - STAmount amt2(XRPAmount(500)); + STAmount const amt1(XRPAmount(1500)); + STAmount const amt2(XRPAmount(500)); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } // Subtracting two negative XRP amounts { - STAmount amt1(XRPAmount(-1500)); - STAmount amt2(XRPAmount(-500)); + STAmount const amt1(XRPAmount(-1500)); + STAmount const amt2(XRPAmount(-500)); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } // Subtracting a positive and a negative XRP amount { - STAmount amt1(XRPAmount(1000)); - STAmount amt2(XRPAmount(-1000)); + STAmount const amt1(XRPAmount(1000)); + STAmount const amt2(XRPAmount(-1000)); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } @@ -1049,14 +1079,14 @@ public: { STAmount amt1(std::numeric_limits::max()); amt1 += XRPAmount(1); - STAmount amt2(XRPAmount(1)); + STAmount const amt2(XRPAmount(1)); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Overflow check for max XRP amounts { - STAmount amt1(std::numeric_limits::max()); - STAmount amt2(XRPAmount(-1)); + STAmount const amt1(std::numeric_limits::max()); + STAmount const amt2(XRPAmount(-1)); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } } @@ -1070,29 +1100,29 @@ public: // Subtracting two IOU amounts { - STAmount amt1(usd, 1500); - STAmount amt2(usd, 500); + STAmount const amt1(usd, 1500); + STAmount const amt2(usd, 500); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } // Subtracting XRP and IOU { - STAmount amt1(XRPAmount(1000)); - STAmount amt2(usd, 1000); + STAmount const amt1(XRPAmount(1000)); + STAmount const amt2(usd, 1000); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Subtracting different IOU issues (non zero) { - STAmount amt1(usd, 1000); - STAmount amt2(eur, 500); + STAmount const amt1(usd, 1000); + STAmount const amt2(eur, 500); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Subtracting different IOU issues (zero) { - STAmount amt1(usd, 0); - STAmount amt2(eur, 500); + STAmount const amt1(usd, 0); + STAmount const amt2(eur, 500); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } } @@ -1107,36 +1137,36 @@ public: // Subtracting zero { - STAmount amt1(mpt, 1000); - STAmount amt2(mpt, 0); + STAmount const amt1(mpt, 1000); + STAmount const amt2(mpt, 0); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } // Subtracting zero { - STAmount amt1(mpt, 0); - STAmount amt2(mpt, 1000); + STAmount const amt1(mpt, 0); + STAmount const amt2(mpt, 1000); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Subtracting two positive MPT amounts { - STAmount amt1(mpt, 1500); - STAmount amt2(mpt, 500); + STAmount const amt1(mpt, 1500); + STAmount const amt2(mpt, 500); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } // Subtracting two negative MPT amounts { - STAmount amt1(mpt, -1500); - STAmount amt2(mpt, -500); + STAmount const amt1(mpt, -1500); + STAmount const amt2(mpt, -500); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } // Subtracting a positive and a negative MPT amount { - STAmount amt1(mpt, 1000); - STAmount amt2(mpt, -1000); + STAmount const amt1(mpt, 1000); + STAmount const amt2(mpt, -1000); BEAST_EXPECT(canSubtract(amt1, amt2) == true); } @@ -1146,29 +1176,29 @@ public: // Overflow check for max positive MPT amounts (should fail) { - STAmount amt1(mpt, std::numeric_limits::max()); - STAmount amt2(mpt, -2); + STAmount const amt1(mpt, std::numeric_limits::max()); + STAmount const amt2(mpt, -2); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Subtracting MPT and XRP { - STAmount amt1(XRPAmount(1000)); - STAmount amt2(mpt, 1000); + STAmount const amt1(XRPAmount(1000)); + STAmount const amt2(mpt, 1000); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Subtracting different MPT issues (non zero) { - STAmount amt1(mpt, 1000); - STAmount amt2(mpt2, 500); + STAmount const amt1(mpt, 1000); + STAmount const amt2(mpt2, 500); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } // Subtracting different MPT issues (zero) { - STAmount amt1(mpt, 0); - STAmount amt2(mpt2, 500); + STAmount const amt1(mpt, 0); + STAmount const amt2(mpt2, 500); BEAST_EXPECT(canSubtract(amt1, amt2) == false); } } diff --git a/src/test/protocol/STInteger_test.cpp b/src/test/protocol/STInteger_test.cpp index 937dbd1a7f..ccb3e726da 100644 --- a/src/test/protocol/STInteger_test.cpp +++ b/src/test/protocol/STInteger_test.cpp @@ -1,6 +1,7 @@ -#include +#include #include #include +#include #include #include @@ -12,14 +13,14 @@ struct STInteger_test : public beast::unit_test::suite testUInt8() { testcase("UInt8"); - STUInt8 u8(255); + STUInt8 const u8(255); BEAST_EXPECT(u8.value() == 255); BEAST_EXPECT(u8.getText() == "255"); BEAST_EXPECT(u8.getSType() == STI_UINT8); BEAST_EXPECT(u8.getJson(JsonOptions::none) == 255); // there is some special handling for sfTransactionResult - STUInt8 tr(sfTransactionResult, 0); + STUInt8 const tr(sfTransactionResult, 0); BEAST_EXPECT(tr.value() == 0); BEAST_EXPECT( tr.getText() == "The transaction was applied. Only final in a validated ledger."); @@ -27,7 +28,7 @@ struct STInteger_test : public beast::unit_test::suite BEAST_EXPECT(tr.getJson(JsonOptions::none) == "tesSUCCESS"); // invalid transaction result - STUInt8 tr2(sfTransactionResult, 255); + STUInt8 const tr2(sfTransactionResult, 255); BEAST_EXPECT(tr2.value() == 255); BEAST_EXPECT(tr2.getText() == "255"); BEAST_EXPECT(tr2.getSType() == STI_UINT8); @@ -38,21 +39,21 @@ struct STInteger_test : public beast::unit_test::suite testUInt16() { testcase("UInt16"); - STUInt16 u16(65535); + STUInt16 const u16(65535); BEAST_EXPECT(u16.value() == 65535); BEAST_EXPECT(u16.getText() == "65535"); BEAST_EXPECT(u16.getSType() == STI_UINT16); BEAST_EXPECT(u16.getJson(JsonOptions::none) == 65535); // there is some special handling for sfLedgerEntryType - STUInt16 let(sfLedgerEntryType, ltACCOUNT_ROOT); + STUInt16 const let(sfLedgerEntryType, ltACCOUNT_ROOT); BEAST_EXPECT(let.value() == ltACCOUNT_ROOT); BEAST_EXPECT(let.getText() == "AccountRoot"); BEAST_EXPECT(let.getSType() == STI_UINT16); BEAST_EXPECT(let.getJson(JsonOptions::none) == "AccountRoot"); // there is some special handling for sfTransactionType - STUInt16 tlt(sfTransactionType, ttPAYMENT); + STUInt16 const tlt(sfTransactionType, ttPAYMENT); BEAST_EXPECT(tlt.value() == ttPAYMENT); BEAST_EXPECT(tlt.getText() == "Payment"); BEAST_EXPECT(tlt.getSType() == STI_UINT16); @@ -63,19 +64,19 @@ struct STInteger_test : public beast::unit_test::suite testUInt32() { testcase("UInt32"); - STUInt32 u32(4'294'967'295u); + STUInt32 const u32(4'294'967'295u); BEAST_EXPECT(u32.value() == 4'294'967'295u); BEAST_EXPECT(u32.getText() == "4294967295"); BEAST_EXPECT(u32.getSType() == STI_UINT32); BEAST_EXPECT(u32.getJson(JsonOptions::none) == 4'294'967'295u); // there is some special handling for sfPermissionValue - STUInt32 pv(sfPermissionValue, ttPAYMENT + 1); + STUInt32 const pv(sfPermissionValue, ttPAYMENT + 1); BEAST_EXPECT(pv.value() == ttPAYMENT + 1); BEAST_EXPECT(pv.getText() == "Payment"); BEAST_EXPECT(pv.getSType() == STI_UINT32); BEAST_EXPECT(pv.getJson(JsonOptions::none) == "Payment"); - STUInt32 pv2(sfPermissionValue, PaymentMint); + STUInt32 const pv2(sfPermissionValue, PaymentMint); BEAST_EXPECT(pv2.value() == PaymentMint); BEAST_EXPECT(pv2.getText() == "PaymentMint"); BEAST_EXPECT(pv2.getSType() == STI_UINT32); @@ -86,7 +87,7 @@ struct STInteger_test : public beast::unit_test::suite testUInt64() { testcase("UInt64"); - STUInt64 u64(0xFFFFFFFFFFFFFFFFull); + STUInt64 const u64(0xFFFFFFFFFFFFFFFFull); BEAST_EXPECT(u64.value() == 0xFFFFFFFFFFFFFFFFull); BEAST_EXPECT(u64.getText() == "18446744073709551615"); BEAST_EXPECT(u64.getSType() == STI_UINT64); @@ -96,7 +97,7 @@ struct STInteger_test : public beast::unit_test::suite BEAST_EXPECT(jsonVal.isString()); BEAST_EXPECT(jsonVal.asString() == "ffffffffffffffff"); - STUInt64 u64_2(sfMaximumAmount, 0xFFFFFFFFFFFFFFFFull); + STUInt64 const u64_2(sfMaximumAmount, 0xFFFFFFFFFFFFFFFFull); BEAST_EXPECT(u64_2.value() == 0xFFFFFFFFFFFFFFFFull); BEAST_EXPECT(u64_2.getText() == "18446744073709551615"); BEAST_EXPECT(u64_2.getSType() == STI_UINT64); @@ -109,7 +110,7 @@ struct STInteger_test : public beast::unit_test::suite testcase("Int32"); { int const minInt32 = -2147483648; - STInt32 i32(minInt32); + STInt32 const i32(minInt32); BEAST_EXPECT(i32.value() == minInt32); BEAST_EXPECT(i32.getText() == "-2147483648"); BEAST_EXPECT(i32.getSType() == STI_INT32); @@ -118,7 +119,7 @@ struct STInteger_test : public beast::unit_test::suite { int const maxInt32 = 2147483647; - STInt32 i32(maxInt32); + STInt32 const i32(maxInt32); BEAST_EXPECT(i32.value() == maxInt32); BEAST_EXPECT(i32.getText() == "2147483647"); BEAST_EXPECT(i32.getSType() == STI_INT32); diff --git a/src/test/protocol/STIssue_test.cpp b/src/test/protocol/STIssue_test.cpp index 7e6fe5487c..3d921e9c66 100644 --- a/src/test/protocol/STIssue_test.cpp +++ b/src/test/protocol/STIssue_test.cpp @@ -1,7 +1,15 @@ -#include -#include +#include +#include // IWYU pragma: keep + +#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { namespace test { @@ -22,7 +30,7 @@ public: { issue = xrpIssue(); issue.account = alice; - STIssue stissue(sfAsset, Asset{issue}); + STIssue const stissue(sfAsset, Asset{issue}); fail("Inconsistent XRP Issue doesn't fail"); } catch (...) @@ -34,7 +42,7 @@ public: { issue = USD; issue.account = xrpAccount(); - STIssue stissue(sfAsset, Asset{issue}); + STIssue const stissue(sfAsset, Asset{issue}); fail("Inconsistent IOU Issue doesn't fail"); } catch (...) @@ -51,7 +59,7 @@ public: base_uint<320> uint; (void)uint.parseHex(data); SerialIter iter(Slice(uint.data(), uint.size())); - STIssue stissue(iter, sfAsset); + STIssue const stissue(iter, sfAsset); fail("Inconsistent IOU Issue doesn't fail on serializer"); } catch (...) @@ -61,7 +69,7 @@ public: try { - STIssue stissue(sfAsset, Asset{xrpIssue()}); + STIssue const stissue(sfAsset, Asset{xrpIssue()}); } catch (...) { @@ -70,7 +78,7 @@ public: try { - STIssue stissue(sfAsset, Asset{USD}); + STIssue const stissue(sfAsset, Asset{USD}); } catch (...) { @@ -85,7 +93,7 @@ public: base_uint<320> uint; (void)uint.parseHex(data); SerialIter iter(Slice(uint.data(), uint.size())); - STIssue stissue(iter, sfAsset); + STIssue const stissue(iter, sfAsset); BEAST_EXPECT(stissue.value() == USD); } catch (...) @@ -99,7 +107,7 @@ public: base_uint<160> uint; (void)uint.parseHex(data); SerialIter iter(Slice(uint.data(), uint.size())); - STIssue stissue(iter, sfAsset); + STIssue const stissue(iter, sfAsset); BEAST_EXPECT(stissue.value() == xrpCurrency()); } catch (...) diff --git a/src/test/protocol/STNumber_test.cpp b/src/test/protocol/STNumber_test.cpp index 9d43ace638..156f5b42aa 100644 --- a/src/test/protocol/STNumber_test.cpp +++ b/src/test/protocol/STNumber_test.cpp @@ -1,14 +1,20 @@ -#include +#include #include #include +#include #include #include #include #include +#include +#include +#include #include -#include #include +#include +#include +#include namespace xrpl { @@ -45,20 +51,20 @@ struct STNumber_test : public beast::unit_test::suite 0, 1, std::numeric_limits::max()}; - for (std::int64_t mantissa : mantissas) + for (std::int64_t const mantissa : mantissas) testCombo(Number{mantissa}); std::initializer_list const exponents = { Number::minExponent, -1, 0, 1, Number::maxExponent - 1}; - for (std::int32_t exponent : exponents) + for (std::int32_t const exponent : exponents) testCombo(Number{123, exponent}); { STAmount const strikePrice{noIssue(), 100}; STNumber const factor{sfNumber, 100}; auto const iouValue = strikePrice.iou(); - IOUAmount totalValue{iouValue * factor}; - STAmount const totalAmount{totalValue, strikePrice.issue()}; + IOUAmount const totalValue{iouValue * factor}; + STAmount const totalAmount{totalValue, strikePrice.get()}; BEAST_EXPECT(totalAmount == Number{10'000}); } @@ -95,7 +101,7 @@ struct STNumber_test : public beast::unit_test::suite BEAST_EXPECT(numberFromJson(sfNumber, "-0.000e6") == STNumber(sfNumber, 0)); { - NumberRoundModeGuard mg(Number::towards_zero); + NumberRoundModeGuard const mg(Number::towards_zero); // maxint64 9,223,372,036,854,775,807 auto const maxInt = std::to_string(std::numeric_limits::max()); // minint64 -9,223,372,036,854,775,808 @@ -276,7 +282,7 @@ struct STNumber_test : public beast::unit_test::suite for (auto const scale : {MantissaRange::small, MantissaRange::large}) { - NumberMantissaScaleGuard sg(scale); + NumberMantissaScaleGuard const sg(scale); testcase << to_string(Number::getMantissaScale()); doRun(); } diff --git a/src/test/protocol/STObject_test.cpp b/src/test/protocol/STObject_test.cpp index 0faa1946a9..0a72c57a8b 100644 --- a/src/test/protocol/STObject_test.cpp +++ b/src/test/protocol/STObject_test.cpp @@ -1,4 +1,30 @@ -#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -13,7 +39,8 @@ public: unexpected(sfGeneric.isUseful(), "sfGeneric must not be useful"); { // Try to put sfGeneric in an SOTemplate. - except([&]() { SOTemplate elements{{sfGeneric, soeREQUIRED}}; }); + except( + [&]() { SOTemplate const elements{{sfGeneric, soeREQUIRED}}; }); } unexpected(sfInvalid.isUseful(), "sfInvalid must not be useful"); @@ -31,12 +58,13 @@ public: } { // Try to put sfInvalid in an SOTemplate. - except([&]() { SOTemplate elements{{sfInvalid, soeREQUIRED}}; }); + except( + [&]() { SOTemplate const elements{{sfInvalid, soeREQUIRED}}; }); } { // Try to put the same SField into an SOTemplate twice. except([&]() { - SOTemplate elements{ + SOTemplate const elements{ {sfAccount, soeREQUIRED}, {sfAccount, soeREQUIRED}, }; @@ -59,7 +87,7 @@ public: }; STObject object1(elements, sfTestObject); - STObject object2(object1); + STObject const object2(object1); unexpected(object1.getSerializer() != object2.getSerializer(), "STObject error 1"); @@ -106,7 +134,7 @@ public: for (int i = 0; i < 1000; i++) { - Blob j(i, 2); + Blob const j(i, 2); object1.setFieldVL(sfTestVL, j); @@ -114,7 +142,7 @@ public: object1.add(s); SerialIter it(s.slice()); - STObject object3(elements, it, sfTestObject); + STObject const object3(elements, it, sfTestObject); unexpected(object1.getFieldVL(sfTestVL) != j, "STObject error"); @@ -134,7 +162,7 @@ public: object1.add(s); SerialIter it(s.slice()); - STObject object3(elements, it, sfTestObject); + STObject const object3(elements, it, sfTestObject); auto const& uints1 = object1.getFieldV256(sfTestV256); auto const& uints3 = object3.getFieldV256(sfTestV256); @@ -475,7 +503,7 @@ public: run() override { // Instantiate a jtx::Env so debugLog writes are exercised. - test::jtx::Env env(*this); + test::jtx::Env const env(*this); testFields(); testSerialization(); diff --git a/src/test/protocol/STParsedJSON_test.cpp b/src/test/protocol/STParsedJSON_test.cpp index 974975d05f..6d42bcafac 100644 --- a/src/test/protocol/STParsedJSON_test.cpp +++ b/src/test/protocol/STParsedJSON_test.cpp @@ -1,11 +1,27 @@ -#include -#include +#include + +#include +#include +#include #include +#include +#include +#include +#include +#include #include #include #include -#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -71,7 +87,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfCloseResolution] = -1; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -79,7 +95,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfCloseResolution] = 256; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -87,7 +103,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfCloseResolution] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -95,7 +111,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfCloseResolution] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -154,7 +170,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerEntryType] = -1; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -162,7 +178,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerEntryType] = 65536; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -170,7 +186,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerEntryType] = "65536"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -178,7 +194,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerEntryType] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -186,7 +202,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerEntryType] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -194,7 +210,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTransferFee] = "Payment"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -240,7 +256,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNetworkID] = -1; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -248,7 +264,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNetworkID] = "4294967296"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -256,7 +272,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNetworkID] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -264,7 +280,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNetworkID] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -298,7 +314,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfIndexNext] = -1; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -309,7 +325,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfIndexNext] = "10000000000000000"; // uint64 max + 1 (in hex) - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -317,7 +333,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfIndexNext] = "0xabcdefabcdef"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -325,7 +341,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfIndexNext] = "abcdefga"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -333,7 +349,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfIndexNext] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -341,7 +357,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfIndexNext] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -359,7 +375,7 @@ class STParsedJSON_test : public beast::unit_test::suite BEAST_EXPECT(obj.object->isFieldPresent(sfEmailHash)); // NOLINTNEXTLINE(bugprone-unchecked-optional-access) BEAST_EXPECT(obj.object->getFieldH128(sfEmailHash).size() == 16); - std::array expected = { + std::array const expected = { 0x01, 0x23, 0x45, @@ -403,7 +419,8 @@ class STParsedJSON_test : public beast::unit_test::suite // NOLINTNEXTLINE(bugprone-unchecked-optional-access) auto const& h128 = obj.object->getFieldH128(sfEmailHash); BEAST_EXPECT(h128.size() == 16); - bool allZero = std::all_of(h128.begin(), h128.end(), [](auto b) { return b == 0; }); + bool const allZero = + std::all_of(h128.begin(), h128.end(), [](auto b) { return b == 0; }); BEAST_EXPECT(allZero); } @@ -411,7 +428,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfEmailHash] = "0123456789ABCDEF0123456789ABCDE"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -419,7 +436,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfEmailHash] = "nothexstring"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -427,7 +444,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfEmailHash] = "01234567"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -435,7 +452,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfEmailHash] = "0123456789ABCDEF0123456789ABCDEF00"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -443,7 +460,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfEmailHash] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -451,7 +468,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfEmailHash] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -469,9 +486,9 @@ class STParsedJSON_test : public beast::unit_test::suite BEAST_EXPECT(obj.object->isFieldPresent(sfTakerPaysCurrency)); // NOLINTNEXTLINE(bugprone-unchecked-optional-access) BEAST_EXPECT(obj.object->getFieldH160(sfTakerPaysCurrency).size() == 20); - std::array expected = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, - 0xEF, 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, - 0xCD, 0xEF, 0x01, 0x23, 0x45, 0x67}; + std::array const expected = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, + 0xEF, 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, + 0xCD, 0xEF, 0x01, 0x23, 0x45, 0x67}; // NOLINTNEXTLINE(bugprone-unchecked-optional-access) BEAST_EXPECT(obj.object->getFieldH160(sfTakerPaysCurrency) == uint160{expected}); } @@ -498,7 +515,8 @@ class STParsedJSON_test : public beast::unit_test::suite // NOLINTNEXTLINE(bugprone-unchecked-optional-access) auto const& h160 = obj.object->getFieldH160(sfTakerPaysCurrency); BEAST_EXPECT(h160.size() == 20); - bool allZero = std::all_of(h160.begin(), h160.end(), [](auto b) { return b == 0; }); + bool const allZero = + std::all_of(h160.begin(), h160.end(), [](auto b) { return b == 0; }); BEAST_EXPECT(allZero); } @@ -506,7 +524,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTakerPaysCurrency] = "nothexstring"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -514,7 +532,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTakerPaysCurrency] = "01234567"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -522,7 +540,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTakerPaysCurrency] = "0123456789ABCDEF0123456789ABCDEF0123456789"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -530,7 +548,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTakerPaysCurrency] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -538,7 +556,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTakerPaysCurrency] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -556,9 +574,9 @@ class STParsedJSON_test : public beast::unit_test::suite BEAST_EXPECT(obj.object->isFieldPresent(sfMPTokenIssuanceID)); // NOLINTNEXTLINE(bugprone-unchecked-optional-access) BEAST_EXPECT(obj.object->getFieldH192(sfMPTokenIssuanceID).size() == 24); - std::array expected = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, - 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, - 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; + std::array const expected = { + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; // NOLINTNEXTLINE(bugprone-unchecked-optional-access) BEAST_EXPECT(obj.object->getFieldH192(sfMPTokenIssuanceID) == uint192{expected}); } @@ -586,7 +604,8 @@ class STParsedJSON_test : public beast::unit_test::suite // NOLINTNEXTLINE(bugprone-unchecked-optional-access) auto const& h192 = obj.object->getFieldH192(sfMPTokenIssuanceID); BEAST_EXPECT(h192.size() == 24); - bool allZero = std::all_of(h192.begin(), h192.end(), [](auto b) { return b == 0; }); + bool const allZero = + std::all_of(h192.begin(), h192.end(), [](auto b) { return b == 0; }); BEAST_EXPECT(allZero); } @@ -594,7 +613,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfMPTokenIssuanceID] = "0123456789ABCDEF0123456789ABCDEF0123456789ABCDE"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -602,7 +621,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfMPTokenIssuanceID] = "nothexstring"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -610,7 +629,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfMPTokenIssuanceID] = "01234567"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -618,7 +637,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfMPTokenIssuanceID] = "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF00"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -626,7 +645,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfMPTokenIssuanceID] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -634,7 +653,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfMPTokenIssuanceID] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -655,10 +674,10 @@ class STParsedJSON_test : public beast::unit_test::suite BEAST_EXPECT(obj.object->isFieldPresent(sfLedgerHash)); // NOLINTNEXTLINE(bugprone-unchecked-optional-access) BEAST_EXPECT(obj.object->getFieldH256(sfLedgerHash).size() == 32); - std::array expected = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, - 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, - 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, - 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF}; + std::array const expected = { + 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0x01, 0x23, 0x45, + 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, + 0xCD, 0xEF, 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF}; // NOLINTNEXTLINE(bugprone-unchecked-optional-access) BEAST_EXPECT(obj.object->getFieldH256(sfLedgerHash) == uint256{expected}); } @@ -687,7 +706,8 @@ class STParsedJSON_test : public beast::unit_test::suite // NOLINTNEXTLINE(bugprone-unchecked-optional-access) auto const& h256 = obj.object->getFieldH256(sfLedgerHash); BEAST_EXPECT(h256.size() == 32); - bool allZero = std::all_of(h256.begin(), h256.end(), [](auto b) { return b == 0; }); + bool const allZero = + std::all_of(h256.begin(), h256.end(), [](auto b) { return b == 0; }); BEAST_EXPECT(allZero); } @@ -697,7 +717,7 @@ class STParsedJSON_test : public beast::unit_test::suite j[sfLedgerHash] = "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCD" "E"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -705,7 +725,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerHash] = "nothexstring"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -713,7 +733,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerHash] = "01234567"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -723,7 +743,7 @@ class STParsedJSON_test : public beast::unit_test::suite j[sfLedgerHash] = "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCD" "EF00"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -731,7 +751,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerHash] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -739,7 +759,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLedgerHash] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -810,7 +830,7 @@ class STParsedJSON_test : public beast::unit_test::suite // Test with string negative value { Json::Value j; - int value = -2147483648; + int const value = -2147483648; j[sfLoanScale] = std::to_string(value); STParsedJSONObject obj("Test", j); BEAST_EXPECT(obj.object.has_value()); @@ -826,7 +846,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLoanScale] = "-2147483649"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -834,7 +854,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLoanScale] = 2147483648u; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -842,7 +862,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLoanScale] = "2147483648"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -850,7 +870,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLoanScale] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -858,7 +878,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfLoanScale] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -918,7 +938,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfPublicKey] = "XYZ123"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -926,7 +946,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfPublicKey] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -934,7 +954,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfPublicKey] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -967,7 +987,7 @@ class STParsedJSON_test : public beast::unit_test::suite // Test empty array for Vector256 (should be valid, size 0) { Json::Value j; - Json::Value arr(Json::arrayValue); + Json::Value const arr(Json::arrayValue); j[sfHashes] = arr; STParsedJSONObject obj("Test", j); BEAST_EXPECT(obj.object.has_value()); @@ -984,7 +1004,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value arr(Json::arrayValue); arr.append("nothexstring"); j[sfHashes] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -994,7 +1014,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value arr(Json::arrayValue); arr.append("0123456789ABCDEF"); // too short for uint256 j[sfHashes] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1004,7 +1024,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value arr(Json::arrayValue); arr.append(12345); j[sfHashes] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1012,7 +1032,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfHashes] = "notanarray"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1024,7 +1044,7 @@ class STParsedJSON_test : public beast::unit_test::suite objElem["foo"] = "bar"; arr.append(objElem); j[sfHashes] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1064,7 +1084,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAccount] = "notAValidBase58Account"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1072,7 +1092,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAccount] = "001122334455"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1080,7 +1100,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAccount] = "000102030405060708090A0B0C0D0E0F101112131415"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1088,7 +1108,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAccount] = "000102030405060708090A0B0C0D0E0F1011121G"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1096,7 +1116,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAccount] = ""; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1104,7 +1124,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAccount] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1112,7 +1132,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAccount] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1164,7 +1184,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfBaseAsset] = "USDD"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1185,7 +1205,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfBaseAsset] = "0123456789AB"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1193,7 +1213,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfBaseAsset] = "0123456789ABCDEF0123456789"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1214,7 +1234,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfBaseAsset] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1222,7 +1242,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfBaseAsset] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1259,7 +1279,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAmount] = "123.45"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1267,7 +1287,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAmount] = ""; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1275,7 +1295,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAmount] = "notanumber"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1283,7 +1303,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAmount] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1349,7 +1369,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfPaths] = "notanarray"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1359,7 +1379,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append("notanarray"); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1372,7 +1392,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1387,7 +1407,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1402,7 +1422,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1416,7 +1436,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1430,7 +1450,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1444,7 +1464,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1458,7 +1478,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1472,7 +1492,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value pathset(Json::arrayValue); pathset.append(path); j[sfPaths] = pathset; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1544,7 +1564,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value issue(Json::objectValue); issue["issuer"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; j[sfAsset] = issue; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1554,7 +1574,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value issue(Json::objectValue); issue["currency"] = "USD"; j[sfAsset] = issue; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1565,7 +1585,7 @@ class STParsedJSON_test : public beast::unit_test::suite issue["currency"] = "USDD"; issue["issuer"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; j[sfAsset] = issue; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1576,7 +1596,7 @@ class STParsedJSON_test : public beast::unit_test::suite issue["currency"] = "USD"; issue["issuer"] = "notAValidIssuer"; j[sfAsset] = issue; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1587,7 +1607,7 @@ class STParsedJSON_test : public beast::unit_test::suite issue["currency"] = Json::Value(Json::arrayValue); issue["issuer"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; j[sfAsset] = issue; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1598,7 +1618,7 @@ class STParsedJSON_test : public beast::unit_test::suite issue["currency"] = "USD"; issue["issuer"] = Json::Value(Json::objectValue); j[sfAsset] = issue; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1606,7 +1626,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfAsset] = "notanobject"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1676,7 +1696,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainDoor"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; bridge["IssuingChainDoor"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1691,7 +1711,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainDoor"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; bridge["IssuingChainDoor"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1709,7 +1729,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainIssue"] = lockingChainIssue; bridge["IssuingChainDoor"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1727,7 +1747,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainIssue"] = lockingChainIssue; bridge["LockingChainDoor"] = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1738,7 +1758,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainIssue"] = "notanobject"; bridge["IssuingChainIssue"] = "notanobject"; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1754,7 +1774,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainIssue"] = lockingChainIssue; bridge["IssuingChainIssue"] = asset; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1770,7 +1790,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainIssue"] = lockingChainIssue; bridge["IssuingChainIssue"] = asset; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1787,7 +1807,7 @@ class STParsedJSON_test : public beast::unit_test::suite bridge["LockingChainIssue"] = lockingChainIssue; bridge["IssuingChainIssue"] = asset; j[sfXChainBridge] = bridge; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1795,7 +1815,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfXChainBridge] = "notanobject"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1880,7 +1900,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNumber] = "notanumber"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1888,7 +1908,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNumber] = Json::Value(Json::arrayValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1896,7 +1916,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNumber] = Json::Value(Json::objectValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1904,7 +1924,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfNumber] = ""; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } } @@ -1932,7 +1952,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTransactionMetaData] = "notanobject"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1942,7 +1962,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value arr(Json::arrayValue); arr.append(1); j[sfTransactionMetaData] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1950,7 +1970,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfTransactionMetaData] = Json::Value(Json::nullValue); - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -1962,7 +1982,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value* current = &obj; for (int i = 0; i < 63; ++i) { - Json::Value next(Json::objectValue); + Json::Value const next(Json::objectValue); (*current)[sfTransactionMetaData] = next; current = &((*current)[sfTransactionMetaData]); } @@ -1981,13 +2001,13 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value* current = &obj; for (int i = 0; i < 64; ++i) { - Json::Value next(Json::objectValue); + Json::Value const next(Json::objectValue); (*current)[sfTransactionMetaData] = next; current = &((*current)[sfTransactionMetaData]); } (*current)[sfTransactionResult.getJsonName()] = 1; j[sfTransactionMetaData] = obj; - STParsedJSONObject parsed("Test", j); + STParsedJSONObject const parsed("Test", j); BEAST_EXPECT(!parsed.object.has_value()); } } @@ -2025,7 +2045,7 @@ class STParsedJSON_test : public beast::unit_test::suite Json::Value arr(Json::arrayValue); arr.append("notanobject"); j[sfSignerEntries] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -2037,7 +2057,7 @@ class STParsedJSON_test : public beast::unit_test::suite elem["invalidField"] = 1; arr.append(elem); j[sfSignerEntries] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -2050,7 +2070,7 @@ class STParsedJSON_test : public beast::unit_test::suite elem[sfNetworkID] = 3; arr.append(elem); j[sfSignerEntries] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -2058,7 +2078,7 @@ class STParsedJSON_test : public beast::unit_test::suite { Json::Value j; j[sfSignerEntries] = "notanarray"; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } @@ -2071,14 +2091,14 @@ class STParsedJSON_test : public beast::unit_test::suite elem[sfTransactionResult] = "notanint"; arr.append(elem); j[sfSignerEntries] = arr; - STParsedJSONObject obj("Test", j); + STParsedJSONObject const obj("Test", j); BEAST_EXPECT(!obj.object.has_value()); } // Test with empty array for Array (should be valid) { Json::Value j; - Json::Value arr(Json::arrayValue); + Json::Value const arr(Json::arrayValue); j[sfSignerEntries] = arr; STParsedJSONObject obj("Test", j); BEAST_EXPECT(obj.object.has_value()); @@ -2093,7 +2113,7 @@ class STParsedJSON_test : public beast::unit_test::suite obj.append(Json::Value(Json::objectValue)); obj[0u][sfTransactionResult] = 1; j[sfSignerEntries] = obj; - STParsedJSONObject parsed("Test", j); + STParsedJSONObject const parsed("Test", j); BEAST_EXPECT(!parsed.object.has_value()); } @@ -2113,22 +2133,22 @@ class STParsedJSON_test : public beast::unit_test::suite them. */ - std::string faulty( + std::string const faulty( "{\"Template\":[{" "\"ModifiedNode\":{\"Sequence\":1}, " "\"DeletedNode\":{\"Sequence\":1}" "}]}"); - std::unique_ptr so; + std::unique_ptr const so; Json::Value faultyJson; - bool parsedOK(parseJSONString(faulty, faultyJson)); + bool const parsedOK(parseJSONString(faulty, faultyJson)); unexpected(!parsedOK, "failed to parse"); - STParsedJSONObject parsed("test", faultyJson); + STParsedJSONObject const parsed("test", faultyJson); BEAST_EXPECT(!parsed.object); } - catch (std::runtime_error& e) + catch (std::runtime_error const& e) { - std::string what(e.what()); + std::string const what(e.what()); unexpected(what.find("First level children of `Template`") != 0); } } @@ -2380,7 +2400,7 @@ class STParsedJSON_test : public beast::unit_test::suite run() override { // Instantiate a jtx::Env so debugLog writes are exercised. - test::jtx::Env env(*this); + test::jtx::Env const env(*this); testUInt8(); testUInt16(); testUInt32(); diff --git a/src/test/protocol/STTx_test.cpp b/src/test/protocol/STTx_test.cpp index 93cfd16d3d..70074ed496 100644 --- a/src/test/protocol/STTx_test.cpp +++ b/src/test/protocol/STTx_test.cpp @@ -1,15 +1,34 @@ #include -#include -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include #include +#include +#include #include +#include +#include #include #include +#include +#include #include #include -#include +#include + +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { @@ -1149,7 +1168,7 @@ public: // Construct an SOTemplate to get the ball rolling on building // an STObject that can contain an STArray. - SOTemplate recurse{ + SOTemplate const recurse{ {sfTransactionMetaData, soeOPTIONAL}, {sfTransactionHash, soeOPTIONAL}, {sfTemplate, soeOPTIONAL}, @@ -1211,7 +1230,7 @@ public: // Make an otherwise legit STTx with a duplicate field. Should // generate an exception when we deserialize. auto const keypair = randomKeyPair(KeyType::secp256k1); - STTx acctSet(ttACCOUNT_SET, [&keypair](auto& obj) { + STTx const acctSet(ttACCOUNT_SET, [&keypair](auto& obj) { obj.setAccountID(sfAccount, calcAccountID(keypair.first)); obj.setFieldU32(sfSequence, 7); obj.setFieldAmount(sfFee, STAmount(2557891634ull)); @@ -1329,7 +1348,7 @@ public: Serializer rawTxn; j.add(rawTxn); SerialIter sit(rawTxn.slice()); - STTx copy(sit); + STTx const copy(sit); if (copy != j) { @@ -1466,7 +1485,7 @@ public: auto const id2 = calcAccountID(kp2.first); // Get the stream of the transaction for use in multi-signing. - Serializer s = buildMultiSigningData(txn, id2); + Serializer const s = buildMultiSigningData(txn, id2); auto const saMultiSignature = sign(kp2.first, kp2.second, s.slice()); @@ -1497,7 +1516,7 @@ public: bool serialized = false; try { - STTx copy(sit); + STTx const copy(sit); serialized = true; } catch (std::exception const&) diff --git a/src/test/protocol/STValidation_test.cpp b/src/test/protocol/STValidation_test.cpp index e426af3e44..779e4d4c55 100644 --- a/src/test/protocol/STValidation_test.cpp +++ b/src/test/protocol/STValidation_test.cpp @@ -1,12 +1,21 @@ -#include +#include #include -#include +#include #include -#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include namespace xrpl { diff --git a/src/test/protocol/SecretKey_test.cpp b/src/test/protocol/SecretKey_test.cpp index e42bec3363..f13a70ebea 100644 --- a/src/test/protocol/SecretKey_test.cpp +++ b/src/test/protocol/SecretKey_test.cpp @@ -1,13 +1,22 @@ #include -#include +#include +#include +#include #include #include +#include +#include #include #include #include +#include #include +#include +#include +#include +#include #include #include @@ -216,7 +225,7 @@ public: auto s = good; // Remove all characters from the string in random order: - std::hash r; + std::hash const r; while (!s.empty()) { diff --git a/src/test/protocol/Seed_test.cpp b/src/test/protocol/Seed_test.cpp index d7ad1f4afa..ee4709a780 100644 --- a/src/test/protocol/Seed_test.cpp +++ b/src/test/protocol/Seed_test.cpp @@ -1,11 +1,18 @@ +#include +#include #include -#include +#include #include +#include +#include #include #include #include +#include #include +#include +#include namespace xrpl { @@ -100,8 +107,8 @@ public: void testKeypairGenerationAndSigning() { - std::string const message1 = "http://www.ripple.com"; - std::string const message2 = "https://www.ripple.com"; + std::string const message1 = "http://www.xrpl.org"; + std::string const message2 = "https://www.xrpl.org"; { testcase("Node keypair generation & signing (secp256k1)"); diff --git a/src/test/protocol/SeqProxy_test.cpp b/src/test/protocol/SeqProxy_test.cpp index 7e7a21ab6e..4a5c0c4506 100644 --- a/src/test/protocol/SeqProxy_test.cpp +++ b/src/test/protocol/SeqProxy_test.cpp @@ -1,8 +1,10 @@ -#include +#include #include +#include #include #include +#include namespace xrpl { diff --git a/src/test/protocol/Serializer_test.cpp b/src/test/protocol/Serializer_test.cpp index c5b56c3029..7cf27b4348 100644 --- a/src/test/protocol/Serializer_test.cpp +++ b/src/test/protocol/Serializer_test.cpp @@ -1,6 +1,8 @@ -#include +#include #include +#include +#include #include namespace xrpl { @@ -17,7 +19,7 @@ struct Serializer_test : public beast::unit_test::suite 0, 1, std::numeric_limits::max()}; - for (std::int32_t value : values) + for (std::int32_t const value : values) { Serializer s; s.add32(value); @@ -33,7 +35,7 @@ struct Serializer_test : public beast::unit_test::suite 0, 1, std::numeric_limits::max()}; - for (std::int64_t value : values) + for (std::int64_t const value : values) { Serializer s; s.add64(value); diff --git a/src/test/protocol/TER_test.cpp b/src/test/protocol/TER_test.cpp index cf88a570c5..814fa4ece5 100644 --- a/src/test/protocol/TER_test.cpp +++ b/src/test/protocol/TER_test.cpp @@ -1,6 +1,8 @@ -#include +#include #include +#include +#include #include #include @@ -13,7 +15,7 @@ struct TER_test : public beast::unit_test::suite { for (auto i = -400; i < 400; ++i) { - TER t = TER::fromInt(i); + TER const t = TER::fromInt(i); auto inRange = isTelLocal(t) || isTemMalformed(t) || isTefFailure(t) || isTerRetry(t) || isTesSuccess(t) || isTecClaim(t); @@ -75,7 +77,7 @@ struct TER_test : public beast::unit_test::suite std::enable_if_t testIterate(Tup const& tup, beast::unit_test::suite& s) { - Func func; + Func const func; func(tup, s); testIterate(tup, s); } @@ -89,7 +91,7 @@ struct TER_test : public beast::unit_test::suite std::enable_if_t testIterate(Tup const& tup, beast::unit_test::suite& s) { - Func func; + Func const func; func(tup, s); testIterate::value - 1, I2 - 1, Func>(tup, s); } @@ -103,7 +105,7 @@ struct TER_test : public beast::unit_test::suite std::enable_if_t testIterate(Tup const& tup, beast::unit_test::suite& s) { - Func func; + Func const func; func(tup, s); } diff --git a/src/test/resource/Logic_test.cpp b/src/test/resource/Logic_test.cpp index 6d412b000f..095df62cfb 100644 --- a/src/test/resource/Logic_test.cpp +++ b/src/test/resource/Logic_test.cpp @@ -1,15 +1,25 @@ #include +#include #include #include -#include +#include +#include +#include +#include +#include #include -#include +#include +#include #include +#include #include +#include +#include #include +#include namespace xrpl { namespace Resource { @@ -54,7 +64,8 @@ public: { Gossip::Item item; item.balance = 100 + rand_int(499); - beast::IP::AddressV4::bytes_type d = {{192, 0, 2, static_cast(v + i)}}; + beast::IP::AddressV4::bytes_type const d = { + {192, 0, 2, static_cast(v + i)}}; item.address = beast::IP::Endpoint{beast::IP::AddressV4{d}}; gossip.items.push_back(item); } @@ -79,7 +90,7 @@ public: Charge const fee(dropThreshold + 1); beast::IP::Endpoint const addr(beast::IP::Endpoint::from_string("192.0.2.2")); - std::function ep = limited + std::function const ep = limited ? std::bind(&TestLogic::newInboundEndpoint, &logic, std::placeholders::_1) : std::bind(&TestLogic::newUnlimitedEndpoint, &logic, std::placeholders::_1); @@ -147,7 +158,7 @@ public: // Make sure the consumer is on the blacklist for a while. { - Consumer c(logic.newInboundEndpoint(addr)); + Consumer const c(logic.newInboundEndpoint(addr)); logic.periodicActivity(); if (c.disposition() != drop) { @@ -174,7 +185,7 @@ public: { ++logic.clock(); logic.periodicActivity(); - Consumer c(logic.newInboundEndpoint(addr)); + Consumer const c(logic.newInboundEndpoint(addr)); if (c.disposition() != drop) { readmitted = true; @@ -218,7 +229,7 @@ public: Gossip g; Gossip::Item item; item.balance = 100; - beast::IP::AddressV4::bytes_type d = {{192, 0, 2, 1}}; + beast::IP::AddressV4::bytes_type const d = {{192, 0, 2, 1}}; item.address = beast::IP::Endpoint{beast::IP::AddressV4{d}}; g.items.push_back(item); @@ -235,9 +246,9 @@ public: TestLogic logic(j); { - beast::IP::Endpoint address(beast::IP::Endpoint::from_string("192.0.2.1")); + beast::IP::Endpoint const address(beast::IP::Endpoint::from_string("192.0.2.1")); Consumer c(logic.newInboundEndpoint(address)); - Charge fee(1000); + Charge const fee(1000); JLOG(j.info()) << "Charging " << c.to_string() << " " << fee << " per second"; c.charge(fee); for (int i = 0; i < 128; ++i) @@ -249,9 +260,9 @@ public: } { - beast::IP::Endpoint address(beast::IP::Endpoint::from_string("192.0.2.2")); + beast::IP::Endpoint const address(beast::IP::Endpoint::from_string("192.0.2.2")); Consumer c(logic.newInboundEndpoint(address)); - Charge fee(1000); + Charge const fee(1000); JLOG(j.info()) << "Charging " << c.to_string() << " " << fee << " per second"; for (int i = 0; i < 128; ++i) { diff --git a/src/test/rpc/AMMInfo_test.cpp b/src/test/rpc/AMMInfo_test.cpp index 3f20e0378d..0a1d050520 100644 --- a/src/test/rpc/AMMInfo_test.cpp +++ b/src/test/rpc/AMMInfo_test.cpp @@ -1,10 +1,28 @@ -#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { namespace test { @@ -38,7 +56,7 @@ public: testAMM([&](AMM& ammAlice, Env&) { Account const gw("gw"); auto const USD = gw["USD"]; - auto const jv = ammAlice.ammRpcInfo({}, {}, USD.issue(), USD.issue()); + auto const jv = ammAlice.ammRpcInfo({}, {}, USD, USD); BEAST_EXPECT(jv[jss::error_message] == "Account not found."); }); @@ -51,10 +69,10 @@ public: std::vector, std::optional, TestAccount, bool>> const invalidParams = { {xrpIssue(), std::nullopt, None, false}, - {std::nullopt, USD.issue(), None, false}, + {std::nullopt, USD, None, false}, {xrpIssue(), std::nullopt, Alice, false}, - {std::nullopt, USD.issue(), Alice, false}, - {xrpIssue(), USD.issue(), Alice, false}, + {std::nullopt, USD, Alice, false}, + {xrpIssue(), USD, Alice, false}, {std::nullopt, std::nullopt, None, true}}; // Invalid parameters @@ -113,10 +131,10 @@ public: std::vector, std::optional, TestAccount, bool>> const invalidParamsBadAccount = { {xrpIssue(), std::nullopt, None, false}, - {std::nullopt, USD.issue(), None, false}, + {std::nullopt, USD, None, false}, {xrpIssue(), std::nullopt, Bogie, false}, - {std::nullopt, USD.issue(), Bogie, false}, - {xrpIssue(), USD.issue(), Bogie, false}, + {std::nullopt, USD, Bogie, false}, + {xrpIssue(), USD, Bogie, false}, {std::nullopt, std::nullopt, None, true}}; // Invalid parameters *and* invalid AMM account, default API version @@ -161,7 +179,6 @@ public: using namespace jtx; testAMM([&](AMM& ammAlice, Env&) { - BEAST_EXPECT(ammAlice.expectAmmRpcInfo(XRP(10000), USD(10000), IOUAmount{10000000, 0})); BEAST_EXPECT(ammAlice.expectAmmRpcInfo( XRP(10000), USD(10000), @@ -170,6 +187,32 @@ public: std::nullopt, ammAlice.ammAccount())); }); + + { + Env env{*this}; + env.fund(XRP(1'000), gw); + MPTTester mpt(env, gw, {.fund = false}); + mpt.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + MPTTester mpt1(env, gw, {.fund = false}); + mpt1.create({.flags = tfMPTCanTransfer | tfMPTCanTrade}); + auto const MPT = mpt["MPT"]; + auto const MPT1 = mpt1["MPT"]; + std::vector> pools = { + {XRP(100), MPT(100), IOUAmount{100'000}}, + {USD(100), MPT(100), IOUAmount{100}}, + {MPT(100), MPT1(100), IOUAmount{100}}}; + for (auto& pool : pools) + { + AMM const amm(env, gw, std::get<0>(pool), std::get<1>(pool)); + BEAST_EXPECT(amm.expectAmmRpcInfo( + std::get<0>(pool), + std::get<1>(pool), + std::get<2>(pool), + std::nullopt, + std::nullopt, + amm.ammAccount())); + } + } } void diff --git a/src/test/rpc/AccountCurrencies_test.cpp b/src/test/rpc/AccountCurrencies_test.cpp index bb8ccf0a85..41ce6a128c 100644 --- a/src/test/rpc/AccountCurrencies_test.cpp +++ b/src/test/rpc/AccountCurrencies_test.cpp @@ -1,8 +1,21 @@ -#include -#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include #include +#include +#include +#include +#include + namespace xrpl { class AccountCurrencies_test : public beast::unit_test::suite @@ -165,7 +178,8 @@ class AccountCurrencies_test : public beast::unit_test::suite env(pay(gw, alice, gw["USA"](50))); // USA should now be missing from receive_currencies result = env.rpc("json", "account_currencies", to_string(params))[jss::result]; - decltype(gwCurrencies) gwCurrenciesNoUSA(gwCurrencies.begin() + 1, gwCurrencies.end()); + decltype(gwCurrencies) + const gwCurrenciesNoUSA(gwCurrencies.begin() + 1, gwCurrencies.end()); BEAST_EXPECT(arrayCheck(jss::receive_currencies, gwCurrenciesNoUSA)); BEAST_EXPECT(arrayCheck(jss::send_currencies, gwCurrencies)); diff --git a/src/test/rpc/AccountInfo_test.cpp b/src/test/rpc/AccountInfo_test.cpp index 518398f9ea..b586ff45b0 100644 --- a/src/test/rpc/AccountInfo_test.cpp +++ b/src/test/rpc/AccountInfo_test.cpp @@ -1,10 +1,25 @@ -#include -#include -#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { diff --git a/src/test/rpc/AccountLines_test.cpp b/src/test/rpc/AccountLines_test.cpp index f91b2aed1c..26d8158545 100644 --- a/src/test/rpc/AccountLines_test.cpp +++ b/src/test/rpc/AccountLines_test.cpp @@ -1,10 +1,39 @@ -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include #include +#include +#include +#include +#include + namespace xrpl { namespace RPC { diff --git a/src/test/rpc/AccountObjects_test.cpp b/src/test/rpc/AccountObjects_test.cpp index 905f8f2bb7..92c571429a 100644 --- a/src/test/rpc/AccountObjects_test.cpp +++ b/src/test/rpc/AccountObjects_test.cpp @@ -1,17 +1,38 @@ -#include #include +#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include #include +#include +#include +#include #include #include #include +#include +#include +#include +#include #include #include #include -#include - #include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -107,7 +128,7 @@ public: // test error on no account { - Json::Value params; + Json::Value const params; auto resp = env.rpc("json", "account_objects", to_string(params)); BEAST_EXPECT(resp[jss::result][jss::error_message] == "Missing field 'account'."); } @@ -488,7 +509,7 @@ public: params[jss::type] = jss::nft_page; auto resp = env.rpc("json", "account_objects", to_string(params)); BEAST_EXPECT(!resp.isMember(jss::marker)); - Json::Value& aobjs = resp[jss::result][jss::account_objects]; + Json::Value const& aobjs = resp[jss::result][jss::account_objects]; BEAST_EXPECT(aobjs.size() == 2); } // test stepped one-at-a-time with limit=1, resume from prev marker @@ -1276,7 +1297,7 @@ public: // valid, because when dirIndex = 0, we will use root key to find // dir. { - std::string s = "0," + entryIndex; + std::string const s = "0," + entryIndex; Json::Value params; params[jss::account] = bob.human(); params[jss::limit] = limit; diff --git a/src/test/rpc/AccountOffers_test.cpp b/src/test/rpc/AccountOffers_test.cpp index 6b93e0570f..211671fad8 100644 --- a/src/test/rpc/AccountOffers_test.cpp +++ b/src/test/rpc/AccountOffers_test.cpp @@ -1,5 +1,17 @@ -#include +#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include + +#include +#include +#include +#include #include namespace xrpl { diff --git a/src/test/rpc/AccountTx_test.cpp b/src/test/rpc/AccountTx_test.cpp index a11f957628..833b35e0ea 100644 --- a/src/test/rpc/AccountTx_test.cpp +++ b/src/test/rpc/AccountTx_test.cpp @@ -1,14 +1,53 @@ -#include +#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include -#include +#include + +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include +#include #include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -97,7 +136,7 @@ class AccountTx_test : public beast::unit_test::suite cfg->FEES.reference_fee = 10; return cfg; })); - Account A1{"A1"}; + Account const A1{"A1"}; env.fund(XRP(10000), A1); env.close(); @@ -541,7 +580,7 @@ class AccountTx_test : public beast::unit_test::suite // PayChan { - std::uint32_t payChanSeq{env.seq(alice)}; + std::uint32_t const payChanSeq{env.seq(alice)}; Json::Value payChanCreate; payChanCreate[jss::TransactionType] = jss::PaymentChannelCreate; payChanCreate[jss::Account] = alice.human(); diff --git a/src/test/rpc/AmendmentBlocked_test.cpp b/src/test/rpc/AmendmentBlocked_test.cpp index e61f22fa0e..0476b7406a 100644 --- a/src/test/rpc/AmendmentBlocked_test.cpp +++ b/src/test/rpc/AmendmentBlocked_test.cpp @@ -1,11 +1,26 @@ -#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include #include +#include + namespace xrpl { class AmendmentBlocked_test : public beast::unit_test::suite diff --git a/src/test/rpc/BookChanges_test.cpp b/src/test/rpc/BookChanges_test.cpp index 6bd71b141b..ecda672517 100644 --- a/src/test/rpc/BookChanges_test.cpp +++ b/src/test/rpc/BookChanges_test.cpp @@ -1,8 +1,19 @@ -#include +#include #include +#include +#include +#include +#include +#include +#include +#include -#include "xrpl/beast/unit_test/suite.h" -#include "xrpl/protocol/jss.h" +#include +#include +#include +#include +#include +#include namespace xrpl { namespace test { @@ -78,7 +89,7 @@ public: featurePermissionedDEX}; Env env(*this, all); - PermissionedDEX permDex(env); + PermissionedDEX const permDex(env); auto const& [gw, domainOwner, alice, bob, carol, USD, domainID, credType] = permDex; auto wsc = makeWSClient(env.app().config()); diff --git a/src/test/rpc/Book_test.cpp b/src/test/rpc/Book_test.cpp index 41442edb06..59b7fd01aa 100644 --- a/src/test/rpc/Book_test.cpp +++ b/src/test/rpc/Book_test.cpp @@ -1,15 +1,38 @@ -#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include #include +#include +#include #include +#include #include +#include #include #include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -877,9 +900,9 @@ public: testcase("TrackOffers"); using namespace jtx; Env env(*this); - Account gw{"gw"}; - Account alice{"alice"}; - Account bob{"bob"}; + Account const gw{"gw"}; + Account const alice{"alice"}; + Account const bob{"bob"}; auto wsc = makeWSClient(env.app().config()); env.fund(XRP(20000), alice, bob, gw); env.close(); @@ -940,7 +963,7 @@ public: BEAST_EXPECT(jrr[jss::offers].size() == 1); auto const jrOffer = jrr[jss::offers][0u]; BEAST_EXPECT(jrOffer[sfAccount.fieldName] == alice.human()); - BEAST_EXPECT(jrOffer[sfBookDirectory.fieldName] == getBookDir(env, XRP, USD.issue())); + BEAST_EXPECT(jrOffer[sfBookDirectory.fieldName] == getBookDir(env, XRP, USD)); BEAST_EXPECT(jrOffer[sfBookNode.fieldName] == "0"); BEAST_EXPECT(jrOffer[jss::Flags] == 0); BEAST_EXPECT(jrOffer[sfLedgerEntryType.fieldName] == jss::Offer); @@ -984,7 +1007,7 @@ public: BEAST_EXPECT(jrr[jss::offers].size() == 2); auto const jrNextOffer = jrr[jss::offers][1u]; BEAST_EXPECT(jrNextOffer[sfAccount.fieldName] == bob.human()); - BEAST_EXPECT(jrNextOffer[sfBookDirectory.fieldName] == getBookDir(env, XRP, USD.issue())); + BEAST_EXPECT(jrNextOffer[sfBookDirectory.fieldName] == getBookDir(env, XRP, USD)); BEAST_EXPECT(jrNextOffer[sfBookNode.fieldName] == "0"); BEAST_EXPECT(jrNextOffer[jss::Flags] == 0); BEAST_EXPECT(jrNextOffer[sfLedgerEntryType.fieldName] == jss::Offer); @@ -1186,8 +1209,8 @@ public: testcase("BookOffersRPC Errors"); using namespace jtx; Env env(*this); - Account gw{"gw"}; - Account alice{"alice"}; + Account const gw{"gw"}; + Account const alice{"alice"}; env.fund(XRP(10000), alice, gw); env.close(); auto USD = gw["USD"]; @@ -1515,7 +1538,7 @@ public: testcase("BookOffer Limits"); using namespace jtx; Env env{*this, asAdmin ? envconfig() : envconfig(no_admin)}; - Account gw{"gw"}; + Account const gw{"gw"}; env.fund(XRP(200000), gw); // Note that calls to env.close() fail without admin permission. if (asAdmin) @@ -1562,7 +1585,7 @@ public: featurePermissionedDEX}; Env env(*this, all); - PermissionedDEX permDex(env); + PermissionedDEX const permDex(env); auto const alice = permDex.alice; auto const bob = permDex.bob; auto const carol = permDex.carol; @@ -1685,7 +1708,7 @@ public: featurePermissionedDEX}; Env env(*this, all); - PermissionedDEX permDex(env); + PermissionedDEX const permDex(env); auto const alice = permDex.alice; auto const bob = permDex.bob; auto const carol = permDex.carol; diff --git a/src/test/rpc/Connect_test.cpp b/src/test/rpc/Connect_test.cpp index c029356bf6..a37c36d907 100644 --- a/src/test/rpc/Connect_test.cpp +++ b/src/test/rpc/Connect_test.cpp @@ -1,5 +1,7 @@ -#include +#include + +#include #include namespace xrpl { diff --git a/src/test/rpc/DeliveredAmount_test.cpp b/src/test/rpc/DeliveredAmount_test.cpp index 31b9b2aebf..4367e54fe9 100644 --- a/src/test/rpc/DeliveredAmount_test.cpp +++ b/src/test/rpc/DeliveredAmount_test.cpp @@ -1,10 +1,29 @@ -#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include -#include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include + namespace xrpl { namespace test { @@ -90,7 +109,7 @@ public: if (t[jss::TransactionType].asString() != jss::Payment) return true; - bool isSet = metaData.isMember(jss::delivered_amount); + bool const isSet = metaData.isMember(jss::delivered_amount); bool isSetUnavailable = false; bool isSetAvailable = false; if (isSet) @@ -396,7 +415,7 @@ public: testTxDeliveredAmountRPC(); testAccountDeliveredAmountSubscribe(); - testMPTDeliveredAmountRPC(all - fixMPTDeliveredAmount); + testMPTDeliveredAmountRPC(all - fixMPTDeliveredAmount - featureMPTokensV2); testMPTDeliveredAmountRPC(all); } }; diff --git a/src/test/rpc/DepositAuthorized_test.cpp b/src/test/rpc/DepositAuthorized_test.cpp index 87951e397c..26e384dd27 100644 --- a/src/test/rpc/DepositAuthorized_test.cpp +++ b/src/test/rpc/DepositAuthorized_test.cpp @@ -1,7 +1,23 @@ -#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include +#include +#include +#include +#include +#include + namespace xrpl { namespace test { @@ -191,14 +207,14 @@ public: } { // Request an invalid ledger. - Json::Value args{depositAuthArgs(alice, becky, "-1")}; + Json::Value const args{depositAuthArgs(alice, becky, "-1")}; Json::Value const result{env.rpc("json", "deposit_authorized", args.toStyledString())}; verifyErr( result, "invalidParams", "Invalid field 'ledger_index', not string or number."); } { // Request a ledger that doesn't exist yet as a string. - Json::Value args{depositAuthArgs(alice, becky, "17")}; + Json::Value const args{depositAuthArgs(alice, becky, "17")}; Json::Value const result{env.rpc("json", "deposit_authorized", args.toStyledString())}; verifyErr(result, "lgrNotFound", "ledgerNotFound"); } @@ -211,7 +227,7 @@ public: } { // alice is not yet funded. - Json::Value args{depositAuthArgs(alice, becky)}; + Json::Value const args{depositAuthArgs(alice, becky)}; Json::Value const result{env.rpc("json", "deposit_authorized", args.toStyledString())}; verifyErr(result, "srcActNotFound", "Source account not found."); } @@ -219,7 +235,7 @@ public: env.close(); { // becky is not yet funded. - Json::Value args{depositAuthArgs(alice, becky)}; + Json::Value const args{depositAuthArgs(alice, becky)}; Json::Value const result{env.rpc("json", "deposit_authorized", args.toStyledString())}; verifyErr(result, "dstActNotFound", "Destination account not found."); } @@ -227,7 +243,7 @@ public: env.close(); { // Once becky is funded try it again and see it succeed. - Json::Value args{depositAuthArgs(alice, becky)}; + Json::Value const args{depositAuthArgs(alice, becky)}; Json::Value const result{env.rpc("json", "deposit_authorized", args.toStyledString())}; validateDepositAuthResult(result, true); } diff --git a/src/test/rpc/Feature_test.cpp b/src/test/rpc/Feature_test.cpp index 0050429c99..4eebc2d0e2 100644 --- a/src/test/rpc/Feature_test.cpp +++ b/src/test/rpc/Feature_test.cpp @@ -1,10 +1,25 @@ -#include +#include +#include + +#include + +#include +#include +#include +#include #include +#include #include #include #include +#include +#include +#include +#include +#include + namespace xrpl { class Feature_test : public beast::unit_test::suite @@ -105,7 +120,7 @@ class Feature_test : public beast::unit_test::suite } // Test an arbitrary unknown feature - uint256 zero{0}; + uint256 const zero{0}; BEAST_EXPECT(featureToName(zero) == to_string(zero)); BEAST_EXPECT( featureToName(zero) == @@ -143,8 +158,9 @@ class Feature_test : public beast::unit_test::suite return; // default config - so all should be disabled, and // supported. Some may be vetoed. - bool expectVeto = (votes.at(feature[jss::name].asString()) == VoteBehavior::DefaultNo); - bool expectObsolete = + bool const expectVeto = + (votes.at(feature[jss::name].asString()) == VoteBehavior::DefaultNo); + bool const expectObsolete = (votes.at(feature[jss::name].asString()) == VoteBehavior::Obsolete); BEAST_EXPECTS( feature.isMember(jss::enabled) && !feature[jss::enabled].asBool(), @@ -278,8 +294,8 @@ class Feature_test : public beast::unit_test::suite (void)id.parseHex(it.key().asString().c_str()); if (!BEAST_EXPECT((*it).isMember(jss::name))) return; - bool expectEnabled = env.app().getAmendmentTable().isEnabled(id); - bool expectSupported = env.app().getAmendmentTable().isSupported(id); + bool const expectEnabled = env.app().getAmendmentTable().isEnabled(id); + bool const expectSupported = env.app().getAmendmentTable().isSupported(id); BEAST_EXPECTS( (*it).isMember(jss::enabled) && (*it)[jss::enabled].asBool() == expectEnabled, (*it)[jss::name].asString() + " enabled"); @@ -339,10 +355,12 @@ class Feature_test : public beast::unit_test::suite (void)id.parseHex(it.key().asString().c_str()); if (!BEAST_EXPECT((*it).isMember(jss::name))) return; - bool expectEnabled = env.app().getAmendmentTable().isEnabled(id); - bool expectSupported = env.app().getAmendmentTable().isSupported(id); - bool expectVeto = (votes.at((*it)[jss::name].asString()) == VoteBehavior::DefaultNo); - bool expectObsolete = (votes.at((*it)[jss::name].asString()) == VoteBehavior::Obsolete); + bool const expectEnabled = env.app().getAmendmentTable().isEnabled(id); + bool const expectSupported = env.app().getAmendmentTable().isSupported(id); + bool const expectVeto = + (votes.at((*it)[jss::name].asString()) == VoteBehavior::DefaultNo); + bool const expectObsolete = + (votes.at((*it)[jss::name].asString()) == VoteBehavior::Obsolete); BEAST_EXPECTS( (*it).isMember(jss::enabled) && (*it)[jss::enabled].asBool() == expectEnabled, (*it)[jss::name].asString() + " enabled"); @@ -421,8 +439,9 @@ class Feature_test : public beast::unit_test::suite { if (!BEAST_EXPECT(feature.isMember(jss::name))) return; - bool expectVeto = (votes.at(feature[jss::name].asString()) == VoteBehavior::DefaultNo); - bool expectObsolete = + bool const expectVeto = + (votes.at(feature[jss::name].asString()) == VoteBehavior::DefaultNo); + bool const expectObsolete = (votes.at(feature[jss::name].asString()) == VoteBehavior::Obsolete); BEAST_EXPECTS( (expectVeto || expectObsolete) ^ feature.isMember(jss::majority), @@ -501,7 +520,7 @@ class Feature_test : public beast::unit_test::suite using namespace test::jtx; Env env{*this}; - auto const& supportedAmendments = detail::supportedAmendments(); + auto const& supportedAmendments = xrpl::detail::supportedAmendments(); auto obsoleteFeature = std::find_if( std::begin(supportedAmendments), std::end(supportedAmendments), [](auto const& pair) { return pair.second == VoteBehavior::Obsolete; diff --git a/src/test/rpc/GatewayBalances_test.cpp b/src/test/rpc/GatewayBalances_test.cpp index 0deb1fc627..20654c46ef 100644 --- a/src/test/rpc/GatewayBalances_test.cpp +++ b/src/test/rpc/GatewayBalances_test.cpp @@ -1,8 +1,18 @@ -#include +#include +#include #include +#include +#include +#include +#include +#include -#include +#include +#include +#include #include +#include +#include #include namespace xrpl { @@ -181,7 +191,7 @@ public: auto USD = alice["USD"]; // The largest valid STAmount of USD: - STAmount const maxUSD(USD.issue(), STAmount::cMaxValue, STAmount::cMaxOffset); + STAmount const maxUSD(USD, STAmount::cMaxValue, STAmount::cMaxOffset); // Create a hotwallet Account const hw{"hw"}; @@ -231,7 +241,7 @@ public: using namespace jtx; // Ensure MPT is enabled - FeatureBitset features = testable_amendments() | featureMPTokensV1; + FeatureBitset const features = testable_amendments() | featureMPTokensV1; Env env(*this, features); Account const alice{"alice"}; diff --git a/src/test/rpc/GetAggregatePrice_test.cpp b/src/test/rpc/GetAggregatePrice_test.cpp index 5facd683a5..d3d4729137 100644 --- a/src/test/rpc/GetAggregatePrice_test.cpp +++ b/src/test/rpc/GetAggregatePrice_test.cpp @@ -1,10 +1,18 @@ -#include +#include +#include #include +#include -#include - +#include +#include +#include #include +#include +#include +#include +#include + namespace xrpl { namespace test { namespace jtx { @@ -34,7 +42,7 @@ public: BEAST_EXPECT(ret[jss::error_message].asString() == "Missing field 'quote_asset'."); // invalid base_asset, quote_asset - std::vector invalidAsset = { + std::vector const invalidAsset = { NoneTag, 1, -1, @@ -76,7 +84,7 @@ public: ret = Oracle::aggregatePrice(env, "XRP", "USD", {{{owner, 2}}}); BEAST_EXPECT(ret[jss::error].asString() == "objectNotFound"); // invalid values - std::vector invalidDocument = {NoneTag, 1.2, -1, "", "none", "1.2"}; + std::vector const invalidDocument = {NoneTag, 1.2, -1, "", "none", "1.2"}; for (auto const& v : invalidDocument) { ret = Oracle::aggregatePrice(env, "XRP", "USD", {{{owner, v}}}); @@ -97,7 +105,7 @@ public: // oracles have wrong asset pair env.fund(XRP(1'000), owner); - Oracle oracle( + Oracle const oracle( env, {.owner = owner, .series = {{"XRP", "EUR", 740, 1}}, @@ -106,7 +114,7 @@ public: BEAST_EXPECT(ret[jss::error].asString() == "objectNotFound"); // invalid trim value - std::vector invalidTrim = {NoneTag, 0, 26, -1, 1.2, "", "none", "1.2"}; + std::vector const invalidTrim = {NoneTag, 0, 26, -1, 1.2, "", "none", "1.2"}; for (auto const& v : invalidTrim) { ret = @@ -115,7 +123,7 @@ public: } // invalid time threshold value - std::vector invalidTime = {NoneTag, -1, 1.2, "", "none", "1.2"}; + std::vector const invalidTime = {NoneTag, -1, 1.2, "", "none", "1.2"}; for (auto const& v : invalidTime) { ret = Oracle::aggregatePrice( @@ -134,7 +142,7 @@ public: { Account const owner(std::to_string(i)); env.fund(XRP(1'000), owner); - Oracle oracle(env, {.owner = owner, .documentID = i, .fee = baseFee}); + Oracle const oracle(env, {.owner = owner, .documentID = i, .fee = baseFee}); oracles.emplace_back(owner, oracle.documentID()); } auto const ret = Oracle::aggregatePrice(env, "XRP", "USD", oracles); @@ -156,7 +164,7 @@ public: Account const owner{std::to_string(i)}; env.fund(XRP(1'000), owner); - Oracle oracle( + Oracle const oracle( env, {.owner = owner, .documentID = rand(), @@ -178,7 +186,7 @@ public: // the global mantissa size. And since it's a thread-local, // overriding it locally won't make a difference either. // This will mean all RPC will use the default of "large". - NumberMantissaScaleGuard mg(mantissaSize); + NumberMantissaScaleGuard const mg(mantissaSize); Env env(*this, feats); OraclesData oracles; diff --git a/src/test/rpc/GetCounts_test.cpp b/src/test/rpc/GetCounts_test.cpp index 07c29e3648..62e2aadfe6 100644 --- a/src/test/rpc/GetCounts_test.cpp +++ b/src/test/rpc/GetCounts_test.cpp @@ -1,10 +1,16 @@ -#include + +#include +#include +#include +#include #include -#include -#include +#include +#include #include +#include + namespace xrpl { class GetCounts_test : public beast::unit_test::suite @@ -32,8 +38,8 @@ class GetCounts_test : public beast::unit_test::suite // create some transactions env.close(); - Account alice{"alice"}; - Account bob{"bob"}; + Account const alice{"alice"}; + Account const bob{"bob"}; env.fund(XRP(10000), alice, bob); env.trust(alice["USD"](1000), bob); for (auto i = 0; i < 20; ++i) diff --git a/src/test/rpc/Handler_test.cpp b/src/test/rpc/Handler_test.cpp index 7aeb059f56..996010059f 100644 --- a/src/test/rpc/Handler_test.cpp +++ b/src/test/rpc/Handler_test.cpp @@ -1,13 +1,20 @@ -#include + +#include #include -#include +#include +#include +#include +#include #include +#include +#include #include -#include #include +#include +#include // cspell: words stdev namespace xrpl::test { @@ -25,7 +32,7 @@ operator<<(std::ostream& os, std::chrono::nanoseconds ns) // NOTE This is a rather naive effort at a microbenchmark. Ideally we want // Google Benchmark, or something similar. Also, this actually does not belong // to unit tests, as it makes little sense to run it in conditions very -// dissimilar to how rippled will normally work. +// dissimilar to how xrpld will normally work. // TODO as https://github.com/XRPLF/rippled/issues/4765 class Handler_test : public beast::unit_test::suite diff --git a/src/test/rpc/JSONRPC_test.cpp b/src/test/rpc/JSONRPC_test.cpp index 87c7d3dcd0..83f6c04092 100644 --- a/src/test/rpc/JSONRPC_test.cpp +++ b/src/test/rpc/JSONRPC_test.cpp @@ -1,15 +1,40 @@ -#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include #include +#include #include #include -#include +#include #include +#include +#include #include +#include +#include +#include #include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -2119,7 +2144,7 @@ public: jt.jv.removeMember(jss::Fee); jt.jv.removeMember(jss::TxnSignature); req[jss::tx_json] = jt.jv; - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2189,7 +2214,7 @@ public: alice)); req[jss::tx_json] = jt.jv; - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2216,7 +2241,7 @@ public: { Json::Value req; Json::Reader().parse("{ \"fee_mult_max\" : 1, \"tx_json\" : { } } ", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2236,7 +2261,7 @@ public: "{ \"fee_mult_max\" : 3, \"fee_div_max\" : 2, " "\"tx_json\" : { } } ", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2253,7 +2278,7 @@ public: { Json::Value req; Json::Reader().parse("{ \"fee_mult_max\" : 0, \"tx_json\" : { } } ", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2274,7 +2299,7 @@ public: "{ \"fee_mult_max\" : 3, \"fee_div_max\" : 6, " "\"tx_json\" : { } } ", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2293,7 +2318,7 @@ public: "{ \"fee_mult_max\" : 0, \"fee_div_max\" : 2, " "\"tx_json\" : { } } ", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2312,7 +2337,7 @@ public: "{ \"fee_mult_max\" : 10, \"fee_div_max\" : 0, " "\"tx_json\" : { } } ", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2330,7 +2355,7 @@ public: Json::Value req; test::jtx::Account const alice("alice"); req[jss::tx_json] = test::jtx::acctdelete(env.master.human(), alice.human()); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2367,7 +2392,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2389,7 +2414,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2417,7 +2442,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2440,7 +2465,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2463,7 +2488,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2486,7 +2511,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2509,7 +2534,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2530,7 +2555,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2552,7 +2577,7 @@ public: "tx_json" : { } })", req); - Json::Value result = checkFee( + Json::Value const result = checkFee( req, Role::ADMIN, true, @@ -2648,7 +2673,7 @@ public: env(noop(env.master), fee(47)); } - Env_ss envs(env); + Env_ss const envs(env); Json::Value toSign; toSign[jss::tx_json] = noop(env.master); @@ -2732,7 +2757,7 @@ public: env(pay(g, env.master, USD(50))); env.close(); - ProcessTransactionFn processTxn = fakeProcessTransaction; + ProcessTransactionFn const processTxn = fakeProcessTransaction; // A list of all the functions we want to test. using signFunc = Json::Value (*)( @@ -2773,7 +2798,7 @@ public: static Role const testedRoles[] = { Role::GUEST, Role::USER, Role::ADMIN, Role::FORBID}; - for (Role testRole : testedRoles) + for (Role const testRole : testedRoles) { Json::Value result; auto const signFn = get<0>(testFunc); diff --git a/src/test/rpc/KeyGeneration_test.cpp b/src/test/rpc/KeyGeneration_test.cpp index e4af2608b7..806fe73e4b 100644 --- a/src/test/rpc/KeyGeneration_test.cpp +++ b/src/test/rpc/KeyGeneration_test.cpp @@ -1,12 +1,19 @@ #include #include -#include +#include +#include #include #include +#include #include +#include #include +#include + +#include +#include namespace xrpl { @@ -98,7 +105,7 @@ public: params.isMember(jss::key_type) ? params[jss::key_type] : "secp256k1"); BEAST_EXPECT(!result.isMember(jss::warning)); - std::string seed = result[jss::master_seed].asString(); + std::string const seed = result[jss::master_seed].asString(); result = walletPropose(params); @@ -685,9 +692,9 @@ public: } void - testRippleLibEd25519() + testXrplLibEd25519() { - testcase("ripple-lib encoded Ed25519 keys"); + testcase("XrplLib encoded Ed25519 keys"); auto test = [this](char const* seed, char const* addr) { { @@ -784,7 +791,7 @@ public: testKeypairForSignature(std::string("ed25519"), ed25519_strings); testKeypairForSignature(std::string("secp256k1"), strong_brain_strings); - testRippleLibEd25519(); + testXrplLibEd25519(); testKeypairForSignatureErrors(); } diff --git a/src/test/rpc/LedgerClosed_test.cpp b/src/test/rpc/LedgerClosed_test.cpp index 2bc5c2b0c9..efe7c2a815 100644 --- a/src/test/rpc/LedgerClosed_test.cpp +++ b/src/test/rpc/LedgerClosed_test.cpp @@ -1,8 +1,16 @@ -#include +#include +#include +#include +#include + +#include #include +#include #include +#include + namespace xrpl { class LedgerClosed_test : public beast::unit_test::suite diff --git a/src/test/rpc/LedgerData_test.cpp b/src/test/rpc/LedgerData_test.cpp index 472f5b2aa2..612899e47d 100644 --- a/src/test/rpc/LedgerData_test.cpp +++ b/src/test/rpc/LedgerData_test.cpp @@ -1,8 +1,31 @@ -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include + namespace xrpl { class LedgerData_test : public beast::unit_test::suite diff --git a/src/test/rpc/LedgerEntry_test.cpp b/src/test/rpc/LedgerEntry_test.cpp index 474f29da17..7f67c92e3b 100644 --- a/src/test/rpc/LedgerEntry_test.cpp +++ b/src/test/rpc/LedgerEntry_test.cpp @@ -1,18 +1,66 @@ -#include +#include +#include +#include #include +#include +#include #include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include namespace xrpl { @@ -26,7 +74,7 @@ enum class FieldType { HashField, HashOrObjectField, FixedHashField, - IssueField, + AssetField, ObjectField, StringField, TwoAccountArrayField, @@ -37,8 +85,8 @@ enum class FieldType { std::vector> mappings{ {jss::account, FieldType::AccountField}, {jss::accounts, FieldType::TwoAccountArrayField}, - {jss::asset, FieldType::IssueField}, - {jss::asset2, FieldType::IssueField}, + {jss::asset, FieldType::AssetField}, + {jss::asset2, FieldType::AssetField}, {jss::authorize, FieldType::AccountField}, {jss::authorized, FieldType::AccountField}, {jss::credential_type, FieldType::BlobField}, @@ -82,8 +130,8 @@ getTypeName(FieldType typeID) return "hex string"; case FieldType::HashOrObjectField: return "hex string or object"; - case FieldType::IssueField: - return "Issue"; + case FieldType::AssetField: + return "Asset"; case FieldType::TwoAccountArrayField: return "length-2 array of Accounts"; case FieldType::UInt32Field: @@ -172,7 +220,7 @@ class LedgerEntry_test : public beast::unit_test::suite }; auto remove = [&](std::vector indices) -> std::vector { - std::unordered_set indexSet(indices.begin(), indices.end()); + std::unordered_set const indexSet(indices.begin(), indices.end()); std::vector values; values.reserve(allBadValues.size() - indexSet.size()); for (std::size_t i = 0; i < allBadValues.size(); ++i) @@ -194,7 +242,7 @@ class LedgerEntry_test : public beast::unit_test::suite static auto const& badIndexValues = remove({12, 16, 18, 19}); static auto const& badUInt32Values = remove({2, 3}); static auto const& badUInt64Values = remove({2, 3}); - static auto const& badIssueValues = remove({}); + static auto const& badAssetValues = remove({}); switch (fieldType) { @@ -213,8 +261,8 @@ class LedgerEntry_test : public beast::unit_test::suite return badIndexValues; case FieldType::FixedHashField: return badFixedHashValues; - case FieldType::IssueField: - return badIssueValues; + case FieldType::AssetField: + return badAssetValues; case FieldType::UInt32Field: return badUInt32Values; case FieldType::UInt64Field: @@ -254,7 +302,7 @@ class LedgerEntry_test : public beast::unit_test::suite case FieldType::HashField: return "5233D68B4D44388F98559DE42903767803EFA7C1F8D01413FC16EE6" "B01403D6D"; - case FieldType::IssueField: + case FieldType::AssetField: return issueObject; case FieldType::HashOrObjectField: return "5233D68B4D44388F98559DE42903767803EFA7C1F8D01413FC16EE6" @@ -595,7 +643,7 @@ class LedgerEntry_test : public beast::unit_test::suite } { // Check malformed cases - Json::Value jvParams; + Json::Value const jvParams; testMalformedField( env, jvParams, jss::account_root, FieldType::AccountField, "malformedAddress"); } @@ -693,59 +741,67 @@ class LedgerEntry_test : public beast::unit_test::suite { testcase("AMM"); using namespace test::jtx; - Env env{*this}; - - // positive test Account const alice{"alice"}; - env.fund(XRP(10000), alice); - env.close(); - AMM amm(env, alice, XRP(10), alice["USD"](1000)); - env.close(); - { - Json::Value jvParams; - jvParams[jss::amm] = to_string(amm.ammID()); - auto const result = env.rpc("json", "ledger_entry", to_string(jvParams)); - BEAST_EXPECT( - result.isObject() && result.isMember(jss::result) && - !result[jss::result].isMember(jss::error) && - result[jss::result].isMember(jss::node) && - result[jss::result][jss::node].isMember(sfLedgerEntryType.jsonName) && - result[jss::result][jss::node][sfLedgerEntryType.jsonName] == jss::AMM); - } + auto test = [&](auto&& getAsset) { + Env env{*this}; + + // positive test + env.fund(XRP(10000), alice); + env.close(); + PrettyAsset const USD = getAsset(env); + AMM const amm(env, alice, XRP(10), USD(1000)); + env.close(); - { - Json::Value jvParams; - Json::Value ammParams(Json::objectValue); { - Json::Value obj(Json::objectValue); - obj[jss::currency] = "XRP"; - ammParams[jss::asset] = obj; + Json::Value jvParams; + jvParams[jss::amm] = to_string(amm.ammID()); + auto const result = env.rpc("json", "ledger_entry", to_string(jvParams)); + BEAST_EXPECT( + result.isObject() && result.isMember(jss::result) && + !result[jss::result].isMember(jss::error) && + result[jss::result].isMember(jss::node) && + result[jss::result][jss::node].isMember(sfLedgerEntryType.jsonName) && + result[jss::result][jss::node][sfLedgerEntryType.jsonName] == jss::AMM); } - { - Json::Value obj(Json::objectValue); - obj[jss::currency] = "USD"; - obj[jss::issuer] = alice.human(); - ammParams[jss::asset2] = obj; - } - jvParams[jss::amm] = ammParams; - auto const result = env.rpc("json", "ledger_entry", to_string(jvParams)); - BEAST_EXPECT( - result.isObject() && result.isMember(jss::result) && - !result[jss::result].isMember(jss::error) && - result[jss::result].isMember(jss::node) && - result[jss::result][jss::node].isMember(sfLedgerEntryType.jsonName) && - result[jss::result][jss::node][sfLedgerEntryType.jsonName] == jss::AMM); - } - // negative tests - runLedgerEntryTest( - env, - jss::amm, { - {jss::asset, "malformedRequest"}, - {jss::asset2, "malformedRequest"}, - }); + Json::Value jvParams; + Json::Value ammParams(Json::objectValue); + { + Json::Value obj(Json::objectValue); + obj[jss::currency] = "XRP"; + ammParams[jss::asset] = obj; + } + { + Json::Value const obj(Json::objectValue); + ammParams[jss::asset2] = to_json(USD.raw()); + } + jvParams[jss::amm] = ammParams; + auto const result = env.rpc("json", "ledger_entry", to_string(jvParams)); + BEAST_EXPECT( + result.isObject() && result.isMember(jss::result) && + !result[jss::result].isMember(jss::error) && + result[jss::result].isMember(jss::node) && + result[jss::result][jss::node].isMember(sfLedgerEntryType.jsonName) && + result[jss::result][jss::node][sfLedgerEntryType.jsonName] == jss::AMM); + } + + // negative tests + runLedgerEntryTest( + env, + jss::amm, + { + {jss::asset, "malformedRequest"}, + {jss::asset2, "malformedRequest"}, + }); + }; + auto getIOU = [&](Env& env) -> PrettyAsset { return alice["USD"]; }; + auto getMPT = [&](Env& env) -> PrettyAsset { + return MPTTester({.env = env, .issuer = alice}); + }; + test(getIOU); + test(getMPT); } void @@ -1961,7 +2017,7 @@ class LedgerEntry_test : public beast::unit_test::suite } { // Malformed DID index - Json::Value jvParams; + Json::Value const jvParams; testMalformedField( env, jvParams, jss::did, FieldType::AccountField, "malformedAddress"); } @@ -1977,7 +2033,7 @@ class LedgerEntry_test : public beast::unit_test::suite Env env(*this); Account const owner("owner"); env.fund(XRP(1'000), owner); - Oracle oracle( + Oracle const oracle( env, {.owner = owner, .fee = static_cast(env.current()->fees().base.drops())}); { @@ -2008,11 +2064,11 @@ class LedgerEntry_test : public beast::unit_test::suite Account const owner(std::string("owner") + std::to_string(i)); env.fund(XRP(1'000), owner); // different accounts can have the same asset pair - Oracle oracle(env, {.owner = owner, .documentID = i, .fee = baseFee}); + Oracle const oracle(env, {.owner = owner, .documentID = i, .fee = baseFee}); accounts.push_back(owner.id()); oracles.push_back(oracle.documentID()); // same account can have different asset pair - Oracle oracle1(env, {.owner = owner, .documentID = i + 10, .fee = baseFee}); + Oracle const oracle1(env, {.owner = owner, .documentID = i + 10, .fee = baseFee}); accounts.push_back(owner.id()); oracles.push_back(oracle1.documentID()); } @@ -2102,7 +2158,7 @@ class LedgerEntry_test : public beast::unit_test::suite } { // Malformed MPTIssuance index - Json::Value jvParams; + Json::Value const jvParams; testMalformedField( env, jvParams, jss::mptoken, FieldType::HashOrObjectField, "malformedRequest"); } diff --git a/src/test/rpc/LedgerHeader_test.cpp b/src/test/rpc/LedgerHeader_test.cpp index 8b460fe6a4..bb1ce8b51f 100644 --- a/src/test/rpc/LedgerHeader_test.cpp +++ b/src/test/rpc/LedgerHeader_test.cpp @@ -1,6 +1,8 @@ #include #include +#include +#include #include namespace xrpl { diff --git a/src/test/rpc/LedgerRPC_test.cpp b/src/test/rpc/LedgerRPC_test.cpp index 8f965aa2cf..b9a10ece7f 100644 --- a/src/test/rpc/LedgerRPC_test.cpp +++ b/src/test/rpc/LedgerRPC_test.cpp @@ -1,17 +1,30 @@ -#include -#include -#include -#include -#include -#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include #include +#include #include +#include #include +#include +#include +#include + namespace xrpl { namespace test { diff --git a/src/test/rpc/LedgerRequest_test.cpp b/src/test/rpc/LedgerRequest_test.cpp index 18c717ec19..8360c10619 100644 --- a/src/test/rpc/LedgerRequest_test.cpp +++ b/src/test/rpc/LedgerRequest_test.cpp @@ -1,12 +1,20 @@ -#include -#include -#include +#include +#include +#include +#include + +#include +#include +#include #include #include #include +#include +#include +#include namespace xrpl { @@ -102,7 +110,7 @@ public: } { - std::string ledgerHash(64, 'q'); + std::string const ledgerHash(64, 'q'); auto const result = env.rpc("ledger_request", ledgerHash); @@ -113,7 +121,7 @@ public: } { - std::string ledgerHash(64, '1'); + std::string const ledgerHash(64, '1'); auto const result = env.rpc("ledger_request", ledgerHash); diff --git a/src/test/rpc/ManifestRPC_test.cpp b/src/test/rpc/ManifestRPC_test.cpp index f42fdd7164..f85a9b3a70 100644 --- a/src/test/rpc/ManifestRPC_test.cpp +++ b/src/test/rpc/ManifestRPC_test.cpp @@ -1,12 +1,15 @@ // Copyright (c) 2020 Dev Null Productions -#include +#include +#include +#include #include -#include +#include #include +#include #include namespace xrpl { diff --git a/src/test/rpc/NoRippleCheck_test.cpp b/src/test/rpc/NoRippleCheck_test.cpp index 54a2931ba5..ac283a54b1 100644 --- a/src/test/rpc/NoRippleCheck_test.cpp +++ b/src/test/rpc/NoRippleCheck_test.cpp @@ -1,17 +1,37 @@ -#include +#include +#include +#include // IWYU pragma: keep #include +#include +#include +#include +#include +#include +#include +#include #include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include #include #include +#include +#include + namespace xrpl { class NoRippleCheck_test : public beast::unit_test::suite diff --git a/src/test/rpc/NoRipple_test.cpp b/src/test/rpc/NoRipple_test.cpp index fcf412bbd4..6004b28cc9 100644 --- a/src/test/rpc/NoRipple_test.cpp +++ b/src/test/rpc/NoRipple_test.cpp @@ -1,8 +1,26 @@ -#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include +#include +#include #include +#include + namespace xrpl { namespace test { diff --git a/src/test/rpc/OwnerInfo_test.cpp b/src/test/rpc/OwnerInfo_test.cpp index 8a09fed467..fb0cc47995 100644 --- a/src/test/rpc/OwnerInfo_test.cpp +++ b/src/test/rpc/OwnerInfo_test.cpp @@ -1,8 +1,18 @@ -#include -#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include + +#include +#include +#include #include +#include #include +#include #include namespace xrpl { diff --git a/src/test/rpc/Peers_test.cpp b/src/test/rpc/Peers_test.cpp index de46fd766c..3e36ddb5d7 100644 --- a/src/test/rpc/Peers_test.cpp +++ b/src/test/rpc/Peers_test.cpp @@ -1,12 +1,18 @@ -#include #include #include -#include +#include +#include +#include +#include +#include #include +#include +#include #include +#include namespace xrpl { @@ -31,7 +37,7 @@ class Peers_test : public beast::unit_test::suite { auto kp = generateKeyPair(KeyType::secp256k1, generateSeed("seed" + std::to_string(i))); - std::string name = "Node " + std::to_string(i); + std::string const name = "Node " + std::to_string(i); using namespace std::chrono_literals; env.app().getCluster().update(kp.first, name, 200, env.timeKeeper().now() - 10s); diff --git a/src/test/rpc/RPCCall_test.cpp b/src/test/rpc/RPCCall_test.cpp index e4ef3aca6a..524e14b5eb 100644 --- a/src/test/rpc/RPCCall_test.cpp +++ b/src/test/rpc/RPCCall_test.cpp @@ -1,17 +1,24 @@ -#include +#include +#include #include -#include +#include -#include +#include #include +#include #include -#include +#include -#include +#include +#include +#include #include #include +#include +#include +#include #include namespace xrpl { @@ -5854,7 +5861,7 @@ public: apiVersion <= RPC::apiMaximumValidVersion)) return; - test::jtx::Env env(*this, makeNetworkConfig(11111)); // Used only for its Journal. + test::jtx::Env const env(*this, makeNetworkConfig(11111)); // Used only for its Journal. // For each RPCCall test. for (RPCCallTestData const& rpcCallTest : rpcCallTestArray) diff --git a/src/test/rpc/RPCHelpers_test.cpp b/src/test/rpc/RPCHelpers_test.cpp index f180bd5c1a..ed981e16e8 100644 --- a/src/test/rpc/RPCHelpers_test.cpp +++ b/src/test/rpc/RPCHelpers_test.cpp @@ -1,6 +1,10 @@ +#include #include -#include +#include +#include +#include +#include #include namespace xrpl { diff --git a/src/test/rpc/RPCOverload_test.cpp b/src/test/rpc/RPCOverload_test.cpp index e5558af82c..85872dfeca 100644 --- a/src/test/rpc/RPCOverload_test.cpp +++ b/src/test/rpc/RPCOverload_test.cpp @@ -1,12 +1,23 @@ -#include +#include +#include +#include #include #include +#include +#include +#include +#include #include -#include +#include +#include +#include #include +#include +#include + namespace xrpl { namespace test { diff --git a/src/test/rpc/RobustTransaction_test.cpp b/src/test/rpc/RobustTransaction_test.cpp index 0d47a39573..8141bec410 100644 --- a/src/test/rpc/RobustTransaction_test.cpp +++ b/src/test/rpc/RobustTransaction_test.cpp @@ -1,10 +1,19 @@ -#include +#include #include +#include +#include // IWYU pragma: keep +#include +#include -#include +#include #include +#include +#include +#include #include +#include + namespace xrpl { namespace test { diff --git a/src/test/rpc/Roles_test.cpp b/src/test/rpc/Roles_test.cpp index e3d90a9c56..b503048bb4 100644 --- a/src/test/rpc/Roles_test.cpp +++ b/src/test/rpc/Roles_test.cpp @@ -1,7 +1,11 @@ -#include +#include #include +#include -#include +#include + +#include +#include #include #include @@ -43,6 +47,7 @@ class Roles_test : public beast::unit_test::suite Env env{*this, envconfig(secure_gateway)}; BEAST_EXPECT(env.rpc("ping")["result"]["role"] == "proxied"); + BEAST_EXPECT(!env.rpc("ping")["result"].isMember("ip")); auto wsRes = makeWSClient(env.app().config())->invoke("ping")["result"]; BEAST_EXPECT(!wsRes.isMember("unlimited") || !wsRes["unlimited"].asBool()); diff --git a/src/test/rpc/ServerDefinitions_test.cpp b/src/test/rpc/ServerDefinitions_test.cpp index a2c45cfa65..60c5c67d05 100644 --- a/src/test/rpc/ServerDefinitions_test.cpp +++ b/src/test/rpc/ServerDefinitions_test.cpp @@ -1,6 +1,7 @@ -#include -#include +#include + +#include #include #include #include diff --git a/src/test/rpc/ServerInfo_test.cpp b/src/test/rpc/ServerInfo_test.cpp index 978b995ce8..490248e45f 100644 --- a/src/test/rpc/ServerInfo_test.cpp +++ b/src/test/rpc/ServerInfo_test.cpp @@ -1,12 +1,17 @@ -#include +#include +#include + +#include #include -#include +#include #include #include -#include +#include + +#include namespace xrpl { @@ -33,7 +38,7 @@ public: makeValidatorConfig() { auto p = std::make_unique(); - boost::format toLoad(R"rippleConfig( + boost::format toLoad(R"xrpldConfig( [validator_token] %1% @@ -49,7 +54,7 @@ ip = 0.0.0.0 port = 50052 protocol = wss2 admin = 127.0.0.1 -)rippleConfig"); +)xrpldConfig"); p->loadFromString(boost::str(toLoad % validator_data::token % validator_data::public_key)); diff --git a/src/test/rpc/Simulate_test.cpp b/src/test/rpc/Simulate_test.cpp index e096b0479f..d9cd61ed93 100644 --- a/src/test/rpc/Simulate_test.cpp +++ b/src/test/rpc/Simulate_test.cpp @@ -1,18 +1,44 @@ -#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include #include +#include +#include +#include #include -#include +#include +#include +#include +#include #include -#include +#include namespace xrpl { @@ -1127,7 +1153,7 @@ class Simulate_test : public beast::unit_test::suite tx[jss::TransactionType] = jss::NFTokenMint; tx[sfNFTokenTaxon] = 1; - Json::Value nftokenId = to_string(token::getNextID(env, alice, 1)); + Json::Value const nftokenId = to_string(token::getNextID(env, alice, 1)); // test nft synthetic testTxJsonMetadataField(env, tx, validateOutput, jss::nftoken_id, nftokenId); } @@ -1137,7 +1163,7 @@ class Simulate_test : public beast::unit_test::suite tx[jss::Account] = alice.human(); tx[jss::TransactionType] = jss::MPTokenIssuanceCreate; - Json::Value mptIssuanceId = to_string(makeMptID(env.seq(alice), alice)); + Json::Value const mptIssuanceId = to_string(makeMptID(env.seq(alice), alice)); // test mpt issuance id testTxJsonMetadataField( env, tx, validateOutput, jss::mpt_issuance_id, mptIssuanceId); diff --git a/src/test/rpc/Status_test.cpp b/src/test/rpc/Status_test.cpp index 01fc81430f..5d79911f95 100644 --- a/src/test/rpc/Status_test.cpp +++ b/src/test/rpc/Status_test.cpp @@ -1,7 +1,16 @@ #include #include -#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include namespace xrpl { namespace RPC { @@ -136,7 +145,8 @@ private: expect(m == message, m + " != " + message); auto d = error[jss::data]; - size_t s1 = d.size(), s2 = messages.size(); + size_t const s1 = d.size(); + size_t const s2 = messages.size(); expect( s1 == s2, prefix + "Data sizes differ " + std::to_string(s1) + " != " + std::to_string(s2)); diff --git a/src/test/rpc/Subscribe_test.cpp b/src/test/rpc/Subscribe_test.cpp index e96286aefc..bb3692b0cc 100644 --- a/src/test/rpc/Subscribe_test.cpp +++ b/src/test/rpc/Subscribe_test.cpp @@ -1,19 +1,58 @@ -#include +#include #include +#include +#include #include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include -#include +#include +#include +#include +#include #include #include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { namespace test { @@ -461,7 +500,7 @@ public: if (!jv.isMember(jss::validated_hash)) return false; - uint32_t netID = env.app().getNetworkIDService().getNetworkID(); + uint32_t const netID = env.app().getNetworkIDService().getNetworkID(); if (!jv.isMember(jss::network_id) || jv[jss::network_id] != netID) return false; @@ -783,10 +822,10 @@ public: using namespace jtx; using IdxHashVec = std::vector>; - Account alice("alice"); - Account bob("bob"); - Account carol("carol"); - Account david("david"); + Account const alice("alice"); + Account const bob("bob"); + Account const carol("carol"); + Account const david("david"); /////////////////////////////////////////////////////////////////// /* @@ -820,8 +859,8 @@ public: idx = r[jss::account_history_tx_index].asInt(); if (r.isMember(jss::account_history_tx_first)) first_flag = true; - bool boundary = r.isMember(jss::account_history_boundary); - int ledger_idx = r[jss::ledger_index].asInt(); + bool const boundary = r.isMember(jss::account_history_boundary); + int const ledger_idx = r[jss::ledger_index].asInt(); if (r.isMember(jss::transaction) && r[jss::transaction].isMember(jss::hash)) { auto t{r[jss::transaction]}; @@ -932,7 +971,7 @@ public: // (-10, "E5B8B...", true, 4 auto checkBoundary = [](IdxHashVec const& vec, bool /* forward */) { - size_t num_tx = vec.size(); + size_t const num_tx = vec.size(); for (size_t i = 0; i < num_tx; ++i) { auto [idx, hash, boundary, ledger] = vec[i]; @@ -1075,7 +1114,7 @@ public: auto wscAccount = makeWSClient(env.app().config()); auto wscTxHistory = makeWSClient(env.app().config()); - std::array accounts = {alice, bob}; + std::array const accounts = {alice, bob}; env.fund(XRP(222222), accounts); BEAST_EXPECT(env.syncClose()); @@ -1143,7 +1182,7 @@ public: Env env(*this, single_thread_io(envconfig())); auto const USD_a = alice["USD"]; - std::array accounts = {alice, carol}; + std::array const accounts = {alice, carol}; env.fund(XRP(333333), accounts); env.trust(USD_a(20000), carol); BEAST_EXPECT(env.syncClose()); @@ -1180,7 +1219,7 @@ public: * long transaction history */ Env env(*this, single_thread_io(envconfig())); - std::array accounts = {alice, carol}; + std::array const accounts = {alice, carol}; env.fund(XRP(444444), accounts); BEAST_EXPECT(env.syncClose()); @@ -1234,7 +1273,7 @@ public: featurePermissionedDEX}; Env env(*this, single_thread_io(envconfig()), all); - PermissionedDEX permDex(env); + PermissionedDEX const permDex(env); auto const alice = permDex.alice; auto const bob = permDex.bob; auto const carol = permDex.carol; diff --git a/src/test/rpc/TransactionEntry_test.cpp b/src/test/rpc/TransactionEntry_test.cpp index 14e75d04da..1940194937 100644 --- a/src/test/rpc/TransactionEntry_test.cpp +++ b/src/test/rpc/TransactionEntry_test.cpp @@ -1,11 +1,26 @@ -#include +#include #include +#include +#include +#include +#include +#include + +#include +#include +#include #include #include +#include +#include +#include #include #include +#include +#include +#include namespace xrpl { @@ -211,8 +226,8 @@ class TransactionEntry_test : public beast::unit_test::suite BEAST_EXPECT(clHash["result"] == resIndex); }; - Account A1{"A1"}; - Account A2{"A2"}; + Account const A1{"A1"}; + Account const A2{"A2"}; env.fund(XRP(10000), A1); auto fund_1_tx = to_string(env.tx()->getTransactionID()); diff --git a/src/test/rpc/TransactionHistory_test.cpp b/src/test/rpc/TransactionHistory_test.cpp index 1d555ecd8c..bc6d2910d9 100644 --- a/src/test/rpc/TransactionHistory_test.cpp +++ b/src/test/rpc/TransactionHistory_test.cpp @@ -1,12 +1,20 @@ -#include +#include #include +#include #include +#include +#include +#include +#include +#include #include #include -#include +#include +#include +#include namespace xrpl { diff --git a/src/test/rpc/Transaction_test.cpp b/src/test/rpc/Transaction_test.cpp index c53207e04d..6ed37364a7 100644 --- a/src/test/rpc/Transaction_test.cpp +++ b/src/test/rpc/Transaction_test.cpp @@ -1,19 +1,42 @@ -#include +#include #include +#include #include +#include +#include +#include +#include #include #include +#include +#include +#include #include +#include +#include +#include #include +#include +#include #include +#include +#include +#include #include #include +#include #include +#include +#include +#include +#include #include +#include #include +#include namespace xrpl { @@ -283,7 +306,7 @@ class Transaction_test : public beast::unit_test::suite char const* EXCESSIVE = RPC::get_error_info(rpcEXCESSIVE_LGR_RANGE).token; Env env{*this, makeNetworkConfig(11111)}; - uint32_t netID = env.app().getNetworkIDService().getNetworkID(); + uint32_t const netID = env.app().getNetworkIDService().getNetworkID(); auto const alice = Account("alice"); env.fund(XRP(1000), alice); @@ -306,7 +329,7 @@ class Transaction_test : public beast::unit_test::suite { auto const& tx = txns[i]; auto const& meta = metas[i]; - uint32_t txnIdx = meta->getFieldU32(sfTransactionIndex); + uint32_t const txnIdx = meta->getFieldU32(sfTransactionIndex); auto const result = env.rpc( COMMAND, // NOLINTNEXTLINE(bugprone-unchecked-optional-access) @@ -347,7 +370,7 @@ class Transaction_test : public beast::unit_test::suite { // auto const& tx = txns[i]; auto const& meta = metas[i]; - uint32_t txnIdx = meta->getFieldU32(sfTransactionIndex); + uint32_t const txnIdx = meta->getFieldU32(sfTransactionIndex); auto const result = env.rpc( COMMAND, // NOLINTNEXTLINE(bugprone-unchecked-optional-access) @@ -407,7 +430,7 @@ class Transaction_test : public beast::unit_test::suite // field. (Tests parameter parsing) { auto const& meta = metas[0]; - uint32_t txnIdx = meta->getFieldU32(sfTransactionIndex); + uint32_t const txnIdx = meta->getFieldU32(sfTransactionIndex); auto const result = env.rpc( COMMAND, // NOLINTNEXTLINE(bugprone-unchecked-optional-access) @@ -500,7 +523,7 @@ class Transaction_test : public beast::unit_test::suite using namespace test::jtx; using std::to_string; - Env env{*this, makeNetworkConfig(11111)}; + Env const env{*this, makeNetworkConfig(11111)}; // Test case 1: Valid input values auto const expected11 = std::optional("CFFFFFFFFFFFFFFF"); @@ -583,7 +606,7 @@ class Transaction_test : public beast::unit_test::suite using namespace test::jtx; // Use a Concise Transaction Identifier to request a transaction. - for (uint32_t netID : {11111, 65535, 65536}) + for (uint32_t const netID : {11111, 65535, 65536}) { Env env{*this, makeNetworkConfig(netID)}; BEAST_EXPECT(netID == env.app().getNetworkIDService().getNetworkID()); @@ -655,7 +678,7 @@ class Transaction_test : public beast::unit_test::suite // test that if the network is 65535 the ctid is not in the response // Using a hash to request the transaction, test the network ID // boundary where the CTID is (not) in the response. - for (uint32_t netID : {2, 1024, 65535, 65536}) + for (uint32_t const netID : {2, 1024, 65535, 65536}) { Env env{*this, makeNetworkConfig(netID)}; BEAST_EXPECT(netID == env.app().getNetworkIDService().getNetworkID()); @@ -691,7 +714,7 @@ class Transaction_test : public beast::unit_test::suite // test the wrong network ID was submitted { Env env{*this, makeNetworkConfig(21337)}; - uint32_t netID = env.app().getNetworkIDService().getNetworkID(); + uint32_t const netID = env.app().getNetworkIDService().getNetworkID(); auto const alice = Account("alice"); auto const bob = Account("bob"); @@ -743,9 +766,9 @@ class Transaction_test : public beast::unit_test::suite // Payment env(pay(alice, gw, XRP(100))); - std::shared_ptr txn = env.tx(); + std::shared_ptr const txn = env.tx(); env.close(); - std::shared_ptr meta = + std::shared_ptr const meta = env.closed()->txRead(env.tx()->getTransactionID()).second; Json::Value expected = txn->getJson(JsonOptions::none); @@ -817,7 +840,8 @@ class Transaction_test : public beast::unit_test::suite to_string(txn->getTransactionID()) == "3F8BDE5A5F82C4F4708E5E9255B713E303E6E1A371FD5C7A704AFD1387C23981"); env.close(); - std::shared_ptr meta = env.closed()->txRead(txn->getTransactionID()).second; + std::shared_ptr const meta = + env.closed()->txRead(txn->getTransactionID()).second; std::string const expected_tx_blob = serializeHex(*txn); std::string const expected_meta_blob = serializeHex(*meta); diff --git a/src/test/rpc/ValidatorInfo_test.cpp b/src/test/rpc/ValidatorInfo_test.cpp index d4769f40fb..62182dc5db 100644 --- a/src/test/rpc/ValidatorInfo_test.cpp +++ b/src/test/rpc/ValidatorInfo_test.cpp @@ -1,12 +1,15 @@ // Copyright (c) 2020 Dev Null Productions -#include +#include +#include +#include #include -#include +#include #include +#include #include #include diff --git a/src/test/rpc/ValidatorRPC_test.cpp b/src/test/rpc/ValidatorRPC_test.cpp index eece5c4448..4926df2d05 100644 --- a/src/test/rpc/ValidatorRPC_test.cpp +++ b/src/test/rpc/ValidatorRPC_test.cpp @@ -1,15 +1,32 @@ -#include +#include #include +#include #include #include +#include #include -#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { @@ -27,7 +44,7 @@ public: for (bool const isAdmin : {true, false}) { - for (std::string cmd : {"validators", "validator_list_sites"}) + for (std::string const cmd : {"validators", "validator_list_sites"}) { Env env{*this, isAdmin ? envconfig() : envconfig(no_admin)}; env.set_retries(isAdmin ? 5 : 0); @@ -154,7 +171,7 @@ public: }; // Validator keys that will be in the published list - std::vector validators = { + std::vector const validators = { TrustedPublisherServer::randomValidator(), TrustedPublisherServer::randomValidator()}; std::set expectedKeys; for (auto const& val : validators) diff --git a/src/test/rpc/Version_test.cpp b/src/test/rpc/Version_test.cpp index 7fa6720f83..3a582df617 100644 --- a/src/test/rpc/Version_test.cpp +++ b/src/test/rpc/Version_test.cpp @@ -1,8 +1,16 @@ -#include +#include +#include + +#include +#include #include #include +#include +#include +#include + namespace xrpl { class Version_test : public beast::unit_test::suite @@ -77,13 +85,13 @@ class Version_test : public beast::unit_test::suite { testcase("test getAPIVersionNumber function"); - unsigned int versionIfUnspecified = + unsigned int const versionIfUnspecified = RPC::apiVersionIfUnspecified < RPC::apiMinimumSupportedVersion ? RPC::apiInvalidVersion : RPC::apiVersionIfUnspecified; - Json::Value j_array = Json::Value(Json::arrayValue); - Json::Value j_null = Json::Value(Json::nullValue); + Json::Value const j_array = Json::Value(Json::arrayValue); + Json::Value const j_null = Json::Value(Json::nullValue); BEAST_EXPECT(RPC::getAPIVersionNumber(j_array, false) == versionIfUnspecified); BEAST_EXPECT(RPC::getAPIVersionNumber(j_null, false) == versionIfUnspecified); @@ -185,7 +193,7 @@ class Version_test : public beast::unit_test::suite { testcase("config test"); { - Config c; + Config const c; BEAST_EXPECT(c.BETA_RPC_API == false); } diff --git a/src/test/server/ServerStatus_test.cpp b/src/test/server/ServerStatus_test.cpp index 1a5da25d65..b3ecd85aca 100644 --- a/src/test/server/ServerStatus_test.cpp +++ b/src/test/server/ServerStatus_test.cpp @@ -1,28 +1,48 @@ -#include +#include #include #include #include #include -#include #include #include +#include #include +#include +#include +#include +#include #include #include #include -#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include -#include #include +#include +#include #include #include +#include +#include +#include namespace xrpl { namespace test { @@ -572,7 +592,7 @@ class ServerStatus_test : public beast::unit_test::suite, public beast::test::en // for zero limit, pick an arbitrary nonzero number of clients - all // should connect fine. - int testTo = (limit == 0) ? 50 : limit + 1; + int const testTo = (limit == 0) ? 50 : limit + 1; while (connectionCount < testTo) { clients.emplace_back( @@ -1106,7 +1126,7 @@ class ServerStatus_test : public beast::unit_test::suite, public beast::test::en boost::system::error_code ec; doHTTPRequest(env, yield, false, resp, ec); BEAST_EXPECT(resp.result() == boost::beast::http::status::internal_server_error); - std::regex body{"Server cannot accept clients"}; + std::regex const body{"Server cannot accept clients"}; BEAST_EXPECT(std::regex_search(resp.body(), body)); } diff --git a/src/test/server/Server_test.cpp b/src/test/server/Server_test.cpp index b6ff180bd4..681115e2f7 100644 --- a/src/test/server/Server_test.cpp +++ b/src/test/server/Server_test.cpp @@ -1,26 +1,41 @@ -#include #include +#include #include #include +#include #include -#include #include -#include +#include +#include +#include +#include #include #include +#include +#include -#include +#include #include +#include +#include +#include +#include #include #include -#include +#include #include +#include +#include #include +#include #include +#include #include +#include +#include namespace xrpl { namespace test { @@ -282,7 +297,7 @@ public: TestSink sink{*this}; TestThread thread; sink.threshold(beast::severities::Severity::kAll); - beast::Journal journal{sink}; + beast::Journal const journal{sink}; TestHandler handler; auto s = make_Server(handler, thread.get_io_context(), journal); std::vector serverPort(1); @@ -377,7 +392,7 @@ public: std::string messages; except([&] { - Env env{ + Env const env{ *this, envconfig([](std::unique_ptr cfg) { (*cfg).deprecatedClearSection("port_rpc"); @@ -388,7 +403,7 @@ public: BEAST_EXPECT(messages.find("Missing 'ip' in [port_rpc]") != std::string::npos); except([&] { - Env env{ + Env const env{ *this, envconfig([](std::unique_ptr cfg) { (*cfg).deprecatedClearSection("port_rpc"); @@ -400,7 +415,7 @@ public: BEAST_EXPECT(messages.find("Missing 'port' in [port_rpc]") != std::string::npos); except([&] { - Env env{ + Env const env{ *this, envconfig([](std::unique_ptr cfg) { (*cfg).deprecatedClearSection("port_rpc"); @@ -414,7 +429,7 @@ public: messages.find("Invalid value '0' for key 'port' in [port_rpc]") == std::string::npos); except([&] { - Env env{ + Env const env{ *this, envconfig([](std::unique_ptr cfg) { (*cfg)["server"].set("port", "0"); @@ -426,7 +441,7 @@ public: messages.find("Invalid value '0' for key 'port' in [server]") != std::string::npos); except([&] { - Env env{ + Env const env{ *this, envconfig([](std::unique_ptr cfg) { (*cfg).deprecatedClearSection("port_rpc"); @@ -442,7 +457,7 @@ public: except([&] // this creates a standard test config without the server // section { - Env env{ + Env const env{ *this, envconfig([](std::unique_ptr cfg) { cfg = std::make_unique(); @@ -471,7 +486,7 @@ public: except([&] // this creates a standard test config without some of the // port sections { - Env env{ + Env const env{ *this, envconfig([](std::unique_ptr cfg) { cfg = std::make_unique(); diff --git a/src/test/shamap/FetchPack_test.cpp b/src/test/shamap/FetchPack_test.cpp index ad86e066af..eaa7992679 100644 --- a/src/test/shamap/FetchPack_test.cpp +++ b/src/test/shamap/FetchPack_test.cpp @@ -1,16 +1,31 @@ #include #include +#include +#include +#include +#include #include #include #include -#include +#include +#include #include +#include #include #include +#include +#include #include +#include -#include +#include + +#include +#include +#include +#include +#include #include namespace xrpl { @@ -53,7 +68,7 @@ public: std::optional getNode(SHAMapHash const& nodeHash) const override { - Map::iterator it = mMap.find(nodeHash); + Map::iterator const it = mMap.find(nodeHash); if (it == mMap.end()) { JLOG(mJournal.fatal()) << "Test filter missing node"; @@ -100,7 +115,7 @@ public: test::SuiteJournal journal("FetchPack_test", *this); TestNodeFamily f(journal); - std::shared_ptr t1(std::make_shared
(SHAMapType::FREE, f)); + std::shared_ptr
const t1(std::make_shared
(SHAMapType::FREE, f)); pass(); diff --git a/src/test/shamap/SHAMapSync_test.cpp b/src/test/shamap/SHAMapSync_test.cpp index a8f3a478b2..b355905769 100644 --- a/src/test/shamap/SHAMapSync_test.cpp +++ b/src/test/shamap/SHAMapSync_test.cpp @@ -1,11 +1,28 @@ #include #include +#include +#include +#include +#include #include -#include +#include #include +#include #include #include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace tests { @@ -30,7 +47,7 @@ public: { // add a bunch of random states to a map, then remove them // map should be the same - SHAMapHash beforeHash = map.getHash(); + SHAMapHash const beforeHash = map.getHash(); std::list items; @@ -74,7 +91,7 @@ public: SHAMap source(SHAMapType::FREE, f); SHAMap destination(SHAMapType::FREE, f2); - int items = 10000; + int const items = 10000; for (int i = 0; i < items; ++i) { source.addItem(SHAMapNodeType::tnACCOUNT_STATE, makeRandomAS()); @@ -96,10 +113,6 @@ public: source.walkMap(missingNodes, 2048); BEAST_EXPECT(missingNodes.empty()); - std::vector nodeIDs, gotNodeIDs; - std::vector gotNodes; - std::vector hashes; - destination.setSynching(); { diff --git a/src/test/shamap/SHAMap_test.cpp b/src/test/shamap/SHAMap_test.cpp index b16f7b157f..cbf67b6ff0 100644 --- a/src/test/shamap/SHAMap_test.cpp +++ b/src/test/shamap/SHAMap_test.cpp @@ -3,9 +3,25 @@ #include #include -#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace tests { @@ -175,8 +191,8 @@ public: testcase("snapshot unbacked"); } - SHAMapHash mapHash = sMap.getHash(); - std::shared_ptr map2 = sMap.snapShot(false); + SHAMapHash const mapHash = sMap.getHash(); + std::shared_ptr const map2 = sMap.snapShot(false); map2->invariants(); unexpected(sMap.getHash() != mapHash, "bad snapshot"); unexpected(map2->getHash() != mapHash, "bad snapshot"); @@ -370,7 +386,7 @@ class SHAMapPathProof_test : public beast::unit_test::suite path->insert(path->begin(), path->front()); BEAST_EXPECT(!map.verifyProofPath(root, k, *path)); // wrong key - uint256 wrongKey(c + 1); + uint256 const wrongKey(c + 1); BEAST_EXPECT(!map.getProofPath(wrongKey)); } if (c == 99) diff --git a/src/test/unit_test/FileDirGuard.h b/src/test/unit_test/FileDirGuard.h index b551b9389d..6b39ecd079 100644 --- a/src/test/unit_test/FileDirGuard.h +++ b/src/test/unit_test/FileDirGuard.h @@ -30,10 +30,14 @@ protected: rmDir(path const& toRm) { if (is_directory(toRm) && is_empty(toRm)) + { remove(toRm); + } else + { test_.log << "Expected " << toRm.string() << " to be an empty existing directory." << std::endl; + } } public: @@ -51,7 +55,9 @@ public: rmSubDir_ = true; } else if (is_directory(subDir_)) + { rmSubDir_ = false; + } else { // Cannot run the test. Someone created a file where we want to @@ -129,8 +135,10 @@ public: else { if (created_) + { test_.log << "Expected " << file_.string() << " to be an existing file." << std::endl; + } } } catch (std::exception& e) diff --git a/src/test/unit_test/SuiteJournal.h b/src/test/unit_test/SuiteJournal.h index 1eeefb68aa..36a580b7ed 100644 --- a/src/test/unit_test/SuiteJournal.h +++ b/src/test/unit_test/SuiteJournal.h @@ -22,7 +22,7 @@ public: } // For unit testing, always generate logging text. - inline bool + bool active(beast::severities::Severity level) const override { return true; @@ -70,7 +70,7 @@ SuiteJournalSink::writeAlways(beast::severities::Severity level, std::string con }(); static std::mutex log_mutex; - std::lock_guard lock(log_mutex); + std::lock_guard const lock(log_mutex); suite_.log << s << partition_ << text << std::endl; } @@ -87,11 +87,7 @@ public: : sink_(partition, threshold, suite), journal_(sink_) { } - // Clang 10.0.0 and 10.0.1 disagree about formatting operator& - // TBD Re-enable formatting when we upgrade to clang 11 - // clang-format off - operator beast::Journal &() - // clang-format on + operator beast::Journal&() { return journal_; } @@ -118,7 +114,7 @@ public: writeAlways(level, text); } - inline void + void writeAlways(beast::severities::Severity level, std::string const& text) override { strm_ << text << std::endl; diff --git a/src/test/unit_test/multi_runner.cpp b/src/test/unit_test/multi_runner.cpp index 239564bd7c..a4dc8de553 100644 --- a/src/test/unit_test/multi_runner.cpp +++ b/src/test/unit_test/multi_runner.cpp @@ -1,13 +1,29 @@ #include #include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include #include #include +#include +#include #include +#include +#include +#include +#include #include namespace xrpl { @@ -154,7 +170,7 @@ template std::size_t multi_runner_base::inner::tests() const { - std::lock_guard l{m_}; + std::lock_guard const l{m_}; return results_.total; } @@ -162,7 +178,7 @@ template std::size_t multi_runner_base::inner::suites() const { - std::lock_guard l{m_}; + std::lock_guard const l{m_}; return results_.suites; } @@ -184,7 +200,7 @@ template void multi_runner_base::inner::add(results const& r) { - std::lock_guard l{m_}; + std::lock_guard const l{m_}; results_.merge(r); } @@ -193,7 +209,7 @@ template void multi_runner_base::inner::print_results(S& s) { - std::lock_guard l{m_}; + std::lock_guard const l{m_}; results_.print(s); } @@ -326,7 +342,7 @@ void multi_runner_base::message_queue_send(MessageType mt, std::string const& s) { // must use a mutex since the two "sends" must happen in order - std::lock_guard l{inner_->m_}; + std::lock_guard const l{inner_->m_}; message_queue_->send(&mt, sizeof(mt), /*priority*/ 0); message_queue_->send(s.c_str(), s.size(), /*priority*/ 0); } @@ -386,7 +402,7 @@ multi_runner_parent::multi_runner_parent() : os_(std::cout) if (!recvd_size) continue; assert(recvd_size == 1); - MessageType mt{*reinterpret_cast(buf.data())}; + MessageType const mt{*reinterpret_cast(buf.data())}; this->message_queue_->receive(buf.data(), buf.size(), recvd_size, priority); if (recvd_size) diff --git a/src/test/unit_test/multi_runner.h b/src/test/unit_test/multi_runner.h index 8148079292..2eda4e66a0 100644 --- a/src/test/unit_test/multi_runner.h +++ b/src/test/unit_test/multi_runner.h @@ -131,10 +131,10 @@ class multi_runner_base print_results(S& s); }; - static constexpr char const* shared_mem_name_ = "RippledUnitTestSharedMem"; + static constexpr char const* shared_mem_name_ = "XrpldUnitTestSharedMem"; // name of the message queue a multi_runner_child will use to communicate // with multi_runner_parent - static constexpr char const* message_queue_name_ = "RippledUnitTestMessageQueue"; + static constexpr char const* message_queue_name_ = "XrpldUnitTestMessageQueue"; // `inner_` will be created in shared memory inner* inner_; diff --git a/src/tests/libxrpl/CMakeLists.txt b/src/tests/libxrpl/CMakeLists.txt index a82ed1472f..0b666441d1 100644 --- a/src/tests/libxrpl/CMakeLists.txt +++ b/src/tests/libxrpl/CMakeLists.txt @@ -32,20 +32,9 @@ xrpl_add_test(json) target_link_libraries(xrpl.test.json PRIVATE xrpl.imports.test) add_dependencies(xrpl.tests xrpl.test.json) -# protocol_autogen tests use explicit source list (not GLOB) because sources are generated -# Mark generated sources so CMake knows they'll be created at build time -set_source_files_properties( - ${PROTOCOL_AUTOGEN_TEST_SOURCES} - PROPERTIES GENERATED TRUE -) -add_executable(xrpl.test.protocol_autogen ${PROTOCOL_AUTOGEN_TEST_SOURCES}) +xrpl_add_test(protocol_autogen) target_link_libraries(xrpl.test.protocol_autogen PRIVATE xrpl.imports.test) add_dependencies(xrpl.tests xrpl.test.protocol_autogen) -add_test(NAME xrpl.test.protocol_autogen COMMAND xrpl.test.protocol_autogen) -# Ensure code generation runs before compiling tests -if(TARGET protocol_autogen_generate) - add_dependencies(xrpl.test.protocol_autogen protocol_autogen_generate) -endif() # Network unit tests are currently not supported on Windows if(NOT WIN32) diff --git a/src/tests/libxrpl/basics/MallocTrim.cpp b/src/tests/libxrpl/basics/MallocTrim.cpp index 483cf37fe2..7c72cd6781 100644 --- a/src/tests/libxrpl/basics/MallocTrim.cpp +++ b/src/tests/libxrpl/basics/MallocTrim.cpp @@ -1,9 +1,13 @@ #include +#include + #include #include +#include + using namespace xrpl; // cSpell:ignore statm @@ -52,8 +56,8 @@ TEST(parseStatmRSSkB, standard_format) // Test standard format: size resident shared text lib data dt // Assuming 4KB page size: resident=1000 pages = 4000 KB { - std::string statm = "25365 1000 2377 0 0 5623 0"; - long result = parseStatmRSSkB(statm); + std::string const statm = "25365 1000 2377 0 0 5623 0"; + long const result = parseStatmRSSkB(statm); // Note: actual result depends on system page size // On most systems it's 4KB, so 1000 pages = 4000 KB EXPECT_GT(result, 0); @@ -61,57 +65,57 @@ TEST(parseStatmRSSkB, standard_format) // Test with newline { - std::string statm = "12345 2000 1234 0 0 3456 0\n"; - long result = parseStatmRSSkB(statm); + std::string const statm = "12345 2000 1234 0 0 3456 0\n"; + long const result = parseStatmRSSkB(statm); EXPECT_GT(result, 0); } // Test with tabs { - std::string statm = "12345\t2000\t1234\t0\t0\t3456\t0"; - long result = parseStatmRSSkB(statm); + std::string const statm = "12345\t2000\t1234\t0\t0\t3456\t0"; + long const result = parseStatmRSSkB(statm); EXPECT_GT(result, 0); } // Test zero resident pages { - std::string statm = "25365 0 2377 0 0 5623 0"; - long result = parseStatmRSSkB(statm); + std::string const statm = "25365 0 2377 0 0 5623 0"; + long const result = parseStatmRSSkB(statm); EXPECT_EQ(result, 0); } // Test with extra whitespace { - std::string statm = " 25365 1000 2377 "; - long result = parseStatmRSSkB(statm); + std::string const statm = " 25365 1000 2377 "; + long const result = parseStatmRSSkB(statm); EXPECT_GT(result, 0); } // Test empty string { - std::string statm; - long result = parseStatmRSSkB(statm); + std::string const statm; + long const result = parseStatmRSSkB(statm); EXPECT_EQ(result, -1); } // Test malformed data (only one field) { - std::string statm = "25365"; - long result = parseStatmRSSkB(statm); + std::string const statm = "25365"; + long const result = parseStatmRSSkB(statm); EXPECT_EQ(result, -1); } // Test malformed data (non-numeric) { - std::string statm = "abc def ghi"; - long result = parseStatmRSSkB(statm); + std::string const statm = "abc def ghi"; + long const result = parseStatmRSSkB(statm); EXPECT_EQ(result, -1); } // Test malformed data (second field non-numeric) { - std::string statm = "25365 abc 2377"; - long result = parseStatmRSSkB(statm); + std::string const statm = "25365 abc 2377"; + long const result = parseStatmRSSkB(statm); EXPECT_EQ(result, -1); } } @@ -119,9 +123,9 @@ TEST(parseStatmRSSkB, standard_format) TEST(mallocTrim, without_debug_logging) { - beast::Journal journal{beast::Journal::getNullSink()}; + beast::Journal const journal{beast::Journal::getNullSink()}; - MallocTrimReport report = mallocTrim("without_debug", journal); + MallocTrimReport const report = mallocTrim("without_debug", journal); #if defined(__GLIBC__) && BOOST_OS_LINUX EXPECT_EQ(report.supported, true); @@ -142,8 +146,8 @@ TEST(mallocTrim, without_debug_logging) TEST(mallocTrim, empty_tag) { - beast::Journal journal{beast::Journal::getNullSink()}; - MallocTrimReport report = mallocTrim("", journal); + beast::Journal const journal{beast::Journal::getNullSink()}; + MallocTrimReport const report = mallocTrim("", journal); #if defined(__GLIBC__) && BOOST_OS_LINUX EXPECT_EQ(report.supported, true); @@ -171,9 +175,9 @@ TEST(mallocTrim, with_debug_logging) }; DebugSink sink; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; - MallocTrimReport report = mallocTrim("debug_test", journal); + MallocTrimReport const report = mallocTrim("debug_test", journal); #if defined(__GLIBC__) && BOOST_OS_LINUX EXPECT_EQ(report.supported, true); @@ -192,12 +196,12 @@ TEST(mallocTrim, with_debug_logging) TEST(mallocTrim, repeated_calls) { - beast::Journal journal{beast::Journal::getNullSink()}; + beast::Journal const journal{beast::Journal::getNullSink()}; // Call malloc_trim multiple times to ensure it's safe for (int i = 0; i < 5; ++i) { - MallocTrimReport report = mallocTrim("iteration_" + std::to_string(i), journal); + MallocTrimReport const report = mallocTrim("iteration_" + std::to_string(i), journal); #if defined(__GLIBC__) && BOOST_OS_LINUX EXPECT_EQ(report.supported, true); diff --git a/src/tests/libxrpl/basics/Mutex.cpp b/src/tests/libxrpl/basics/Mutex.cpp index 3bcee92276..e91781c463 100644 --- a/src/tests/libxrpl/basics/Mutex.cpp +++ b/src/tests/libxrpl/basics/Mutex.cpp @@ -6,6 +6,8 @@ #include #include #include +#include +#include #include using namespace xrpl; @@ -183,7 +185,7 @@ TEST_F(MutexConstCorrectnessTest, non_const_allows_modification) TEST_F(MutexConstCorrectnessTest, const_reference_provides_const_access) { - Mutex> m({1, 2, 3, 4, 5, 6}); + Mutex> const m({1, 2, 3, 4, 5, 6}); Mutex> const& const_ref = m; auto lock = const_ref.lock(); static_assert(std::is_const_v>); @@ -225,7 +227,7 @@ struct MutexSharedMutexTest : ::testing::Test TEST_F(MutexSharedMutexTest, shared_lock_for_const_access) { - Mutex m(100); + Mutex const m(100); Mutex const& const_ref = m; auto lock = const_ref.lock(); EXPECT_EQ(*lock, 100); diff --git a/src/tests/libxrpl/basics/RangeSet.cpp b/src/tests/libxrpl/basics/RangeSet.cpp index 41a33133f2..1d5d2391f8 100644 --- a/src/tests/libxrpl/basics/RangeSet.cpp +++ b/src/tests/libxrpl/basics/RangeSet.cpp @@ -1,5 +1,8 @@ #include +#include +#include + #include #include diff --git a/src/tests/libxrpl/basics/Slice.cpp b/src/tests/libxrpl/basics/Slice.cpp index 72f2d081c7..b7ef9f6a33 100644 --- a/src/tests/libxrpl/basics/Slice.cpp +++ b/src/tests/libxrpl/basics/Slice.cpp @@ -3,6 +3,7 @@ #include #include +#include #include using namespace xrpl; diff --git a/src/tests/libxrpl/basics/contract.cpp b/src/tests/libxrpl/basics/contract.cpp index d9b729e85d..721aa19fd3 100644 --- a/src/tests/libxrpl/basics/contract.cpp +++ b/src/tests/libxrpl/basics/contract.cpp @@ -3,7 +3,6 @@ #include #include -#include using namespace xrpl; diff --git a/src/tests/libxrpl/basics/scope.cpp b/src/tests/libxrpl/basics/scope.cpp index 8efa4a84b1..a13bab30df 100644 --- a/src/tests/libxrpl/basics/scope.cpp +++ b/src/tests/libxrpl/basics/scope.cpp @@ -2,6 +2,8 @@ #include +#include + using namespace xrpl; TEST(scope, scope_exit) @@ -10,7 +12,7 @@ TEST(scope, scope_exit) // unless release() is called int i = 0; { - scope_exit x{[&i]() { i = 1; }}; + scope_exit const x{[&i]() { i = 1; }}; } EXPECT_EQ(i, 1); { @@ -32,7 +34,7 @@ TEST(scope, scope_exit) { try { - scope_exit x{[&i]() { i = 5; }}; + scope_exit const x{[&i]() { i = 5; }}; throw 1; } catch (...) // NOLINT(bugprone-empty-catch) @@ -60,7 +62,7 @@ TEST(scope, scope_fail) // if an exception is unwinding, unless release() is called int i = 0; { - scope_fail x{[&i]() { i = 1; }}; + scope_fail const x{[&i]() { i = 1; }}; } EXPECT_EQ(i, 0); { @@ -82,7 +84,7 @@ TEST(scope, scope_fail) { try { - scope_fail x{[&i]() { i = 5; }}; + scope_fail const x{[&i]() { i = 5; }}; throw 1; } catch (...) // NOLINT(bugprone-empty-catch) @@ -110,7 +112,7 @@ TEST(scope, scope_success) // if an exception is not unwinding, unless release() is called int i = 0; { - scope_success x{[&i]() { i = 1; }}; + scope_success const x{[&i]() { i = 1; }}; } EXPECT_EQ(i, 1); { @@ -132,7 +134,7 @@ TEST(scope, scope_success) { try { - scope_success x{[&i]() { i = 5; }}; + scope_success const x{[&i]() { i = 5; }}; throw 1; } catch (...) // NOLINT(bugprone-empty-catch) diff --git a/src/tests/libxrpl/basics/tagged_integer.cpp b/src/tests/libxrpl/basics/tagged_integer.cpp index 09f8b6787b..fbff1aee6c 100644 --- a/src/tests/libxrpl/basics/tagged_integer.cpp +++ b/src/tests/libxrpl/basics/tagged_integer.cpp @@ -2,6 +2,7 @@ #include +#include #include using namespace xrpl; @@ -147,7 +148,7 @@ TEST(tagged_integer, increment_decrement_operators) TEST(tagged_integer, arithmetic_operators) { - TagInt a{-2}; + TagInt const a{-2}; EXPECT_EQ(+a, TagInt{-2}); EXPECT_EQ(-a, TagInt{2}); EXPECT_EQ(TagInt{-3} + TagInt{4}, TagInt{1}); diff --git a/src/tests/libxrpl/crypto/csprng.cpp b/src/tests/libxrpl/crypto/csprng.cpp index 41dcfd57a9..4a383cae62 100644 --- a/src/tests/libxrpl/crypto/csprng.cpp +++ b/src/tests/libxrpl/crypto/csprng.cpp @@ -2,6 +2,8 @@ #include +#include + using namespace xrpl; TEST(csprng, get_values) diff --git a/src/tests/libxrpl/helpers/TestSink.cpp b/src/tests/libxrpl/helpers/TestSink.cpp index 17cc110429..3b138edfd8 100644 --- a/src/tests/libxrpl/helpers/TestSink.cpp +++ b/src/tests/libxrpl/helpers/TestSink.cpp @@ -1,8 +1,11 @@ -#include - #include +#include + +#include + #include // for getenv +#include #if BOOST_OS_WINDOWS #include // for _isatty, _fileno diff --git a/src/tests/libxrpl/json/Output.cpp b/src/tests/libxrpl/json/Output.cpp index 96d7369d51..bc26c068ca 100644 --- a/src/tests/libxrpl/json/Output.cpp +++ b/src/tests/libxrpl/json/Output.cpp @@ -1,4 +1,5 @@ #include + #include #include diff --git a/src/tests/libxrpl/json/Value.cpp b/src/tests/libxrpl/json/Value.cpp index 943e517669..e15fdd5777 100644 --- a/src/tests/libxrpl/json/Value.cpp +++ b/src/tests/libxrpl/json/Value.cpp @@ -1,5 +1,6 @@ #include #include +#include #include #include #include @@ -7,10 +8,14 @@ #include #include -#include +#include +#include +#include +#include #include #include #include +#include namespace xrpl { @@ -38,7 +43,7 @@ TEST(json_value, construct_and_compare_Json_StaticString) EXPECT_EQ(test1, test2); EXPECT_NE(test1, test3); - std::string str{sample}; + std::string const str{sample}; EXPECT_EQ(str, test2); EXPECT_NE(str, test3); EXPECT_EQ(test2, str); @@ -52,7 +57,7 @@ TEST(json_value, different_types) auto testCopy = [](Json::ValueType typ) { Json::Value val{typ}; - Json::Value cpy{val}; + Json::Value const cpy{val}; EXPECT_EQ(val.type(), typ); EXPECT_EQ(cpy.type(), typ); return val; @@ -135,7 +140,7 @@ TEST(json_value, different_types) { Json::Value const staticStrV{staticStr}; { - Json::Value cpy{staticStrV}; + Json::Value const cpy{staticStrV}; EXPECT_EQ(staticStrV.type(), Json::stringValue); EXPECT_EQ(cpy.type(), Json::stringValue); } @@ -588,13 +593,13 @@ TEST(json_value, bad_json) TEST(json_value, edge_cases) { - std::uint32_t max_uint = std::numeric_limits::max(); - std::int32_t max_int = std::numeric_limits::max(); - std::int32_t min_int = std::numeric_limits::min(); + std::uint32_t const max_uint = std::numeric_limits::max(); + std::int32_t const max_int = std::numeric_limits::max(); + std::int32_t const min_int = std::numeric_limits::min(); - std::uint32_t a_uint = max_uint - 1978; - std::int32_t a_large_int = max_int - 1978; - std::int32_t a_small_int = min_int + 1978; + std::uint32_t const a_uint = max_uint - 1978; + std::int32_t const a_large_int = max_int - 1978; + std::int32_t const a_small_int = min_int + 1978; { std::string json = "{\"max_uint\":" + std::to_string(max_uint); @@ -628,7 +633,7 @@ TEST(json_value, edge_cases) EXPECT_LT(j1["a_small_int"], a_uint); } - std::uint64_t overflow = std::uint64_t(max_uint) + 1; + std::uint64_t const overflow = std::uint64_t(max_uint) + 1; { std::string json = "{\"overflow\":"; json += std::to_string(overflow); @@ -640,7 +645,7 @@ TEST(json_value, edge_cases) EXPECT_FALSE(r2.parse(json, j2)); } - std::int64_t underflow = std::int64_t(min_int) - 1; + std::int64_t const underflow = std::int64_t(min_int) - 1; { std::string json = "{\"underflow\":"; json += std::to_string(underflow); @@ -739,7 +744,7 @@ TEST(json_value, copy) EXPECT_TRUE(v1.isDouble()); EXPECT_EQ(v1.asDouble(), 2.5); - Json::Value v2 = v1; + Json::Value const v2 = v1; EXPECT_TRUE(v1.isDouble()); EXPECT_EQ(v1.asDouble(), 2.5); EXPECT_TRUE(v2.isDouble()); @@ -819,7 +824,7 @@ TEST(json_value, comparisons) b["a"] = Json::Int(-1); testGreaterThan("negative"); - Json::Int big = std::numeric_limits::max(); + Json::Int const big = std::numeric_limits::max(); Json::UInt bigger = big; bigger++; @@ -859,7 +864,7 @@ TEST(json_value, conversions) // TODO: What's the thinking here? { // null - Json::Value val; + Json::Value const val; EXPECT_TRUE(val.isNull()); // val.asCString() should trigger an assertion failure EXPECT_EQ(val.asString(), ""); @@ -880,7 +885,7 @@ TEST(json_value, conversions) } { // int - Json::Value val = -1234; + Json::Value const val = -1234; EXPECT_TRUE(val.isInt()); // val.asCString() should trigger an assertion failure EXPECT_EQ(val.asString(), "-1234"); @@ -901,7 +906,7 @@ TEST(json_value, conversions) } { // uint - Json::Value val = 1234U; + Json::Value const val = 1234U; EXPECT_TRUE(val.isUInt()); // val.asCString() should trigger an assertion failure EXPECT_EQ(val.asString(), "1234"); @@ -922,7 +927,7 @@ TEST(json_value, conversions) } { // real - Json::Value val = 2.0; + Json::Value const val = 2.0; EXPECT_TRUE(val.isDouble()); // val.asCString() should trigger an assertion failure EXPECT_TRUE(std::regex_match(val.asString(), std::regex("^2\\.0*$"))); @@ -943,7 +948,7 @@ TEST(json_value, conversions) } { // numeric string - Json::Value val = "54321"; + Json::Value const val = "54321"; EXPECT_TRUE(val.isString()); EXPECT_EQ(strcmp(val.asCString(), "54321"), 0); EXPECT_EQ(val.asString(), "54321"); @@ -964,7 +969,7 @@ TEST(json_value, conversions) } { // non-numeric string - Json::Value val(Json::stringValue); + Json::Value const val(Json::stringValue); EXPECT_TRUE(val.isString()); EXPECT_EQ(val.asCString(), nullptr); EXPECT_EQ(val.asString(), ""); @@ -985,7 +990,7 @@ TEST(json_value, conversions) } { // bool false - Json::Value val = false; + Json::Value const val = false; EXPECT_TRUE(val.isBool()); // val.asCString() should trigger an assertion failure EXPECT_EQ(val.asString(), "false"); @@ -1006,7 +1011,7 @@ TEST(json_value, conversions) } { // bool true - Json::Value val = true; + Json::Value const val = true; EXPECT_TRUE(val.isBool()); // val.asCString() should trigger an assertion failure EXPECT_EQ(val.asString(), "true"); @@ -1027,7 +1032,7 @@ TEST(json_value, conversions) } { // array type - Json::Value val(Json::arrayValue); + Json::Value const val(Json::arrayValue); EXPECT_TRUE(val.isArray()); // val.asCString should trigger an assertion failure EXPECT_THROW(val.asString(), Json::error); @@ -1048,7 +1053,7 @@ TEST(json_value, conversions) } { // object type - Json::Value val(Json::objectValue); + Json::Value const val(Json::objectValue); EXPECT_TRUE(val.isObject()); // val.asCString should trigger an assertion failure EXPECT_THROW(val.asString(), Json::error); diff --git a/src/tests/libxrpl/json/Writer.cpp b/src/tests/libxrpl/json/Writer.cpp index 7016b4322d..a21f27199f 100644 --- a/src/tests/libxrpl/json/Writer.cpp +++ b/src/tests/libxrpl/json/Writer.cpp @@ -1,6 +1,8 @@ #include -#include +#include +#include + #include #include diff --git a/src/tests/libxrpl/net/HTTPClient.cpp b/src/tests/libxrpl/net/HTTPClient.cpp index 36159cb089..d3dfd32361 100644 --- a/src/tests/libxrpl/net/HTTPClient.cpp +++ b/src/tests/libxrpl/net/HTTPClient.cpp @@ -1,24 +1,29 @@ -#include #include -#include -#include +#include +#include +#include + +#include +#include // IWYU pragma: keep #include +#include #include +#include #include -#include -#include -#include -#include +#include // IWYU pragma: keep +#include // IWYU pragma: keep +#include // IWYU pragma: keep #include #include -#include +#include +#include #include -#include -#include -#include +#include +#include +#include using namespace xrpl; @@ -267,7 +272,7 @@ protected: TEST_F(HTTPClientTest, case_insensitive_content_length) { // Test different cases of Content-Length header - std::vector headerCases = { + std::vector const headerCases = { "Content-Length", // Standard case "content-length", // Lowercase - this tests the regex icase fix "CONTENT-LENGTH", // Uppercase @@ -278,7 +283,7 @@ TEST_F(HTTPClientTest, case_insensitive_content_length) for (auto const& headerName : headerCases) { TestHTTPServer server; - std::string testBody = "Hello World!"; + std::string const testBody = "Hello World!"; server.setResponseBody(testBody); server.setHeader(headerName, std::to_string(testBody.size())); @@ -287,7 +292,7 @@ TEST_F(HTTPClientTest, case_insensitive_content_length) std::string resultData; boost::system::error_code resultError; - bool testCompleted = + bool const testCompleted = runHTTPTest(server, "/test", completed, resultStatus, resultData, resultError); // Verify results EXPECT_TRUE(testCompleted); @@ -300,7 +305,7 @@ TEST_F(HTTPClientTest, case_insensitive_content_length) TEST_F(HTTPClientTest, basic_http_request) { TestHTTPServer server; - std::string testBody = "Test response body"; + std::string const testBody = "Test response body"; server.setResponseBody(testBody); server.setHeader("Content-Type", "text/plain"); @@ -309,7 +314,7 @@ TEST_F(HTTPClientTest, basic_http_request) std::string resultData; boost::system::error_code resultError; - bool testCompleted = + bool const testCompleted = runHTTPTest(server, "/basic", completed, resultStatus, resultData, resultError); EXPECT_TRUE(testCompleted); @@ -329,7 +334,7 @@ TEST_F(HTTPClientTest, empty_response) std::string resultData; boost::system::error_code resultError; - bool testCompleted = + bool const testCompleted = runHTTPTest(server, "/empty", completed, resultStatus, resultData, resultError); EXPECT_TRUE(testCompleted); @@ -340,7 +345,7 @@ TEST_F(HTTPClientTest, empty_response) TEST_F(HTTPClientTest, different_status_codes) { - std::vector statusCodes = {200, 404, 500}; + std::vector const statusCodes = {200, 404, 500}; for (auto status : statusCodes) { @@ -353,7 +358,7 @@ TEST_F(HTTPClientTest, different_status_codes) std::string resultData; boost::system::error_code resultError; - bool testCompleted = + bool const testCompleted = runHTTPTest(server, "/status", completed, resultStatus, resultData, resultError); EXPECT_TRUE(testCompleted); diff --git a/src/tests/libxrpl/protocol_autogen/.clang-tidy b/src/tests/libxrpl/protocol_autogen/.clang-tidy new file mode 100644 index 0000000000..fbc003598d --- /dev/null +++ b/src/tests/libxrpl/protocol_autogen/.clang-tidy @@ -0,0 +1,3 @@ +# This disables all checks for this directory and its subdirectories +Checks: "-*" +InheritParentConfig: false diff --git a/src/tests/libxrpl/protocol_autogen/STObjectValidation.cpp b/src/tests/libxrpl/protocol_autogen/STObjectValidation.cpp deleted file mode 100644 index 5c100364dc..0000000000 --- a/src/tests/libxrpl/protocol_autogen/STObjectValidation.cpp +++ /dev/null @@ -1,70 +0,0 @@ -#include -#include -#include -#include - -#include - -namespace xrpl { -TEST(STObjectValidation, validate_required_field) -{ - SOTemplate format{{sfFlags, soeREQUIRED}}; - STObject obj(sfGeneric); - obj.setFieldU32(sfFlags, 0); - EXPECT_TRUE(protocol_autogen::validateSTObject(obj, format)); -} - -TEST(STObjectValidation, validate_missing_required_field) -{ - SOTemplate format{{sfFlags, soeREQUIRED}}; - STObject obj(sfGeneric); - EXPECT_FALSE(protocol_autogen::validateSTObject(obj, format)); -} - -TEST(STObjectValidation, validate_optional_field) -{ - SOTemplate format{{sfFlags, soeOPTIONAL}}; - STObject obj(sfGeneric); - obj.setFieldU32(sfFlags, 0); - EXPECT_TRUE(protocol_autogen::validateSTObject(obj, format)); -} - -TEST(STObjectValidation, validate_missing_optional_field) -{ - SOTemplate format{{sfFlags, soeOPTIONAL}}; - STObject obj(sfGeneric); - EXPECT_TRUE(protocol_autogen::validateSTObject(obj, format)); -} - -TEST(STObjectValidation, validate_mpt_amount_supported) -{ - SOTemplate format{{sfAmount, soeREQUIRED, soeMPTSupported}}; - STObject obj(sfGeneric); - obj.setFieldAmount(sfAmount, STAmount{MPTAmount{Number{1}}, MPTIssue{}}); - EXPECT_TRUE(protocol_autogen::validateSTObject(obj, format)); -} - -TEST(STObjectValidation, validate_mpt_amount_not_supported) -{ - SOTemplate format{{sfAmount, soeREQUIRED, soeMPTNotSupported}}; - STObject obj(sfGeneric); - obj.setFieldAmount(sfAmount, STAmount{MPTAmount{Number{1}}, MPTIssue{}}); - EXPECT_FALSE(protocol_autogen::validateSTObject(obj, format)); -} - -TEST(STObjectValidation, validate_mpt_issue_supported) -{ - SOTemplate format{{sfAsset, soeREQUIRED, soeMPTSupported}}; - STObject obj(sfGeneric); - obj.setFieldIssue(sfAsset, STIssue{sfAsset, MPTIssue{}}); - EXPECT_TRUE(protocol_autogen::validateSTObject(obj, format)); -} - -TEST(STObjectValidation, validate_mpt_issue_not_supported) -{ - SOTemplate format{{sfAsset, soeREQUIRED, soeMPTNotSupported}}; - STObject obj(sfGeneric); - obj.setFieldIssue(sfAsset, STIssue{sfAsset, MPTIssue{}}); - EXPECT_FALSE(protocol_autogen::validateSTObject(obj, format)); -} -} // namespace xrpl diff --git a/src/tests/libxrpl/protocol_autogen/ledger_entries/DirectoryNodeTests.cpp b/src/tests/libxrpl/protocol_autogen/ledger_entries/DirectoryNodeTests.cpp index d1b6edc704..af617c2634 100644 --- a/src/tests/libxrpl/protocol_autogen/ledger_entries/DirectoryNodeTests.cpp +++ b/src/tests/libxrpl/protocol_autogen/ledger_entries/DirectoryNodeTests.cpp @@ -23,8 +23,10 @@ TEST(DirectoryNodeTests, BuilderSettersRoundTrip) auto const ownerValue = canonical_ACCOUNT(); auto const takerPaysCurrencyValue = canonical_UINT160(); auto const takerPaysIssuerValue = canonical_UINT160(); + auto const takerPaysMPTValue = canonical_UINT192(); auto const takerGetsCurrencyValue = canonical_UINT160(); auto const takerGetsIssuerValue = canonical_UINT160(); + auto const takerGetsMPTValue = canonical_UINT192(); auto const exchangeRateValue = canonical_UINT64(); auto const indexesValue = canonical_VECTOR256(); auto const rootIndexValue = canonical_UINT256(); @@ -43,8 +45,10 @@ TEST(DirectoryNodeTests, BuilderSettersRoundTrip) builder.setOwner(ownerValue); builder.setTakerPaysCurrency(takerPaysCurrencyValue); builder.setTakerPaysIssuer(takerPaysIssuerValue); + builder.setTakerPaysMPT(takerPaysMPTValue); builder.setTakerGetsCurrency(takerGetsCurrencyValue); builder.setTakerGetsIssuer(takerGetsIssuerValue); + builder.setTakerGetsMPT(takerGetsMPTValue); builder.setExchangeRate(exchangeRateValue); builder.setIndexNext(indexNextValue); builder.setIndexPrevious(indexPreviousValue); @@ -98,6 +102,14 @@ TEST(DirectoryNodeTests, BuilderSettersRoundTrip) EXPECT_TRUE(entry.hasTakerPaysIssuer()); } + { + auto const& expected = takerPaysMPTValue; + auto const actualOpt = entry.getTakerPaysMPT(); + ASSERT_TRUE(actualOpt.has_value()); + expectEqualField(expected, *actualOpt, "sfTakerPaysMPT"); + EXPECT_TRUE(entry.hasTakerPaysMPT()); + } + { auto const& expected = takerGetsCurrencyValue; auto const actualOpt = entry.getTakerGetsCurrency(); @@ -114,6 +126,14 @@ TEST(DirectoryNodeTests, BuilderSettersRoundTrip) EXPECT_TRUE(entry.hasTakerGetsIssuer()); } + { + auto const& expected = takerGetsMPTValue; + auto const actualOpt = entry.getTakerGetsMPT(); + ASSERT_TRUE(actualOpt.has_value()); + expectEqualField(expected, *actualOpt, "sfTakerGetsMPT"); + EXPECT_TRUE(entry.hasTakerGetsMPT()); + } + { auto const& expected = exchangeRateValue; auto const actualOpt = entry.getExchangeRate(); @@ -186,8 +206,10 @@ TEST(DirectoryNodeTests, BuilderFromSleRoundTrip) auto const ownerValue = canonical_ACCOUNT(); auto const takerPaysCurrencyValue = canonical_UINT160(); auto const takerPaysIssuerValue = canonical_UINT160(); + auto const takerPaysMPTValue = canonical_UINT192(); auto const takerGetsCurrencyValue = canonical_UINT160(); auto const takerGetsIssuerValue = canonical_UINT160(); + auto const takerGetsMPTValue = canonical_UINT192(); auto const exchangeRateValue = canonical_UINT64(); auto const indexesValue = canonical_VECTOR256(); auto const rootIndexValue = canonical_UINT256(); @@ -203,8 +225,10 @@ TEST(DirectoryNodeTests, BuilderFromSleRoundTrip) sle->at(sfOwner) = ownerValue; sle->at(sfTakerPaysCurrency) = takerPaysCurrencyValue; sle->at(sfTakerPaysIssuer) = takerPaysIssuerValue; + sle->at(sfTakerPaysMPT) = takerPaysMPTValue; sle->at(sfTakerGetsCurrency) = takerGetsCurrencyValue; sle->at(sfTakerGetsIssuer) = takerGetsIssuerValue; + sle->at(sfTakerGetsMPT) = takerGetsMPTValue; sle->at(sfExchangeRate) = exchangeRateValue; sle->at(sfIndexes) = indexesValue; sle->at(sfRootIndex) = rootIndexValue; @@ -283,6 +307,19 @@ TEST(DirectoryNodeTests, BuilderFromSleRoundTrip) expectEqualField(expected, *fromBuilderOpt, "sfTakerPaysIssuer"); } + { + auto const& expected = takerPaysMPTValue; + + auto const fromSleOpt = entryFromSle.getTakerPaysMPT(); + auto const fromBuilderOpt = entryFromBuilder.getTakerPaysMPT(); + + ASSERT_TRUE(fromSleOpt.has_value()); + ASSERT_TRUE(fromBuilderOpt.has_value()); + + expectEqualField(expected, *fromSleOpt, "sfTakerPaysMPT"); + expectEqualField(expected, *fromBuilderOpt, "sfTakerPaysMPT"); + } + { auto const& expected = takerGetsCurrencyValue; @@ -309,6 +346,19 @@ TEST(DirectoryNodeTests, BuilderFromSleRoundTrip) expectEqualField(expected, *fromBuilderOpt, "sfTakerGetsIssuer"); } + { + auto const& expected = takerGetsMPTValue; + + auto const fromSleOpt = entryFromSle.getTakerGetsMPT(); + auto const fromBuilderOpt = entryFromBuilder.getTakerGetsMPT(); + + ASSERT_TRUE(fromSleOpt.has_value()); + ASSERT_TRUE(fromBuilderOpt.has_value()); + + expectEqualField(expected, *fromSleOpt, "sfTakerGetsMPT"); + expectEqualField(expected, *fromBuilderOpt, "sfTakerGetsMPT"); + } + { auto const& expected = exchangeRateValue; @@ -462,10 +512,14 @@ TEST(DirectoryNodeTests, OptionalFieldsReturnNullopt) EXPECT_FALSE(entry.getTakerPaysCurrency().has_value()); EXPECT_FALSE(entry.hasTakerPaysIssuer()); EXPECT_FALSE(entry.getTakerPaysIssuer().has_value()); + EXPECT_FALSE(entry.hasTakerPaysMPT()); + EXPECT_FALSE(entry.getTakerPaysMPT().has_value()); EXPECT_FALSE(entry.hasTakerGetsCurrency()); EXPECT_FALSE(entry.getTakerGetsCurrency().has_value()); EXPECT_FALSE(entry.hasTakerGetsIssuer()); EXPECT_FALSE(entry.getTakerGetsIssuer().has_value()); + EXPECT_FALSE(entry.hasTakerGetsMPT()); + EXPECT_FALSE(entry.getTakerGetsMPT().has_value()); EXPECT_FALSE(entry.hasExchangeRate()); EXPECT_FALSE(entry.getExchangeRate().has_value()); EXPECT_FALSE(entry.hasIndexNext()); diff --git a/src/tests/libxrpl/protocol_autogen/main.cpp b/src/tests/libxrpl/protocol_autogen/main.cpp deleted file mode 100644 index 5142bbe08a..0000000000 --- a/src/tests/libxrpl/protocol_autogen/main.cpp +++ /dev/null @@ -1,8 +0,0 @@ -#include - -int -main(int argc, char** argv) -{ - ::testing::InitGoogleTest(&argc, argv); - return RUN_ALL_TESTS(); -} diff --git a/src/xrpld/README.md b/src/xrpld/README.md index cf71589dd7..83dc8c6a84 100644 --- a/src/xrpld/README.md +++ b/src/xrpld/README.md @@ -1,4 +1,4 @@ -# Ripple Source Guidelines +# XRPL Source Guidelines Each folder contains a single module following the newest style: diff --git a/src/xrpld/app/consensus/RCLConsensus.cpp b/src/xrpld/app/consensus/RCLConsensus.cpp index 71f3d1cf2a..6d99c2ee15 100644 --- a/src/xrpld/app/consensus/RCLConsensus.cpp +++ b/src/xrpld/app/consensus/RCLConsensus.cpp @@ -1,34 +1,88 @@ #include + +#include +#include +#include +#include #include #include +#include #include #include #include #include #include +#include #include #include #include #include +#include +#include #include #include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include #include #include +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include + +#include + +#include #include +#include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -137,7 +191,7 @@ RCLConsensus::Adaptor::share(RCLCxPeerPos const& peerPos) prop.set_closetime(proposal.closeTime().time_since_epoch().count()); prop.set_currenttxhash(proposal.position().begin(), proposal.position().size()); - prop.set_previousledger(proposal.prevLedger().begin(), proposal.position().size()); + prop.set_previousledger(proposal.prevLedger().begin(), proposal.prevLedger().size()); auto const pk = peerPos.publicKey().slice(); prop.set_nodepubkey(pk.data(), pk.size()); @@ -160,7 +214,7 @@ RCLConsensus::Adaptor::share(RCLCxTx const& tx) msg.set_rawtransaction(slice.data(), slice.size()); msg.set_status(protocol::tsNEW); msg.set_receivetimestamp(app_.getTimeKeeper().now().time_since_epoch().count()); - static std::set skip{}; + static std::set const skip{}; app_.getOverlay().relay(tx.id(), msg, skip); } else @@ -853,7 +907,7 @@ RCLConsensus::getJson(bool full) const { Json::Value ret; { - std::lock_guard _{mutex_}; + std::lock_guard const _{mutex_}; ret = consensus_.getJson(full); } ret["validating"] = adaptor_.validating(); @@ -867,7 +921,7 @@ RCLConsensus::timerEntry( { try { - std::lock_guard _{mutex_}; + std::lock_guard const _{mutex_}; consensus_.timerEntry(now, clog); } catch (SHAMapMissingNode const& mn) @@ -886,7 +940,7 @@ RCLConsensus::gotTxSet(NetClock::time_point const& now, RCLTxSet const& txSet) { try { - std::lock_guard _{mutex_}; + std::lock_guard const _{mutex_}; consensus_.gotTxSet(now, txSet); } catch (SHAMapMissingNode const& mn) @@ -904,14 +958,14 @@ RCLConsensus::simulate( NetClock::time_point const& now, std::optional consensusDelay) { - std::lock_guard _{mutex_}; + std::lock_guard const _{mutex_}; consensus_.simulate(now, consensusDelay); } bool RCLConsensus::peerProposal(NetClock::time_point const& now, RCLCxPeerPos const& newProposal) { - std::lock_guard _{mutex_}; + std::lock_guard const _{mutex_}; return consensus_.peerProposal(now, newProposal); } @@ -1010,7 +1064,7 @@ RCLConsensus::startRound( hash_set const& nowTrusted, std::unique_ptr const& clog) { - std::lock_guard _{mutex_}; + std::lock_guard const _{mutex_}; consensus_.startRound( now, prevLgrId, prevLgr, nowUntrusted, adaptor_.preStartRound(prevLgr, nowTrusted), clog); } diff --git a/src/xrpld/app/consensus/RCLConsensus.h b/src/xrpld/app/consensus/RCLConsensus.h index 15d36a1aa6..c965ed3d87 100644 --- a/src/xrpld/app/consensus/RCLConsensus.h +++ b/src/xrpld/app/consensus/RCLConsensus.h @@ -472,7 +472,7 @@ public: RCLCxLedger::ID prevLedgerID() const { - std::lock_guard _{mutex_}; + std::lock_guard const _{mutex_}; return consensus_.prevLedgerID(); } diff --git a/src/xrpld/app/consensus/RCLCxPeerPos.cpp b/src/xrpld/app/consensus/RCLCxPeerPos.cpp index 8f99dceea8..7cc2ab8b90 100644 --- a/src/xrpld/app/consensus/RCLCxPeerPos.cpp +++ b/src/xrpld/app/consensus/RCLCxPeerPos.cpp @@ -1,7 +1,16 @@ #include +#include +#include +#include +#include +#include +#include #include #include +#include + +#include namespace xrpl { diff --git a/src/xrpld/app/consensus/RCLCxPeerPos.h b/src/xrpld/app/consensus/RCLCxPeerPos.h index e334320826..f5d3f0e8f0 100644 --- a/src/xrpld/app/consensus/RCLCxPeerPos.h +++ b/src/xrpld/app/consensus/RCLCxPeerPos.h @@ -95,7 +95,7 @@ private: { using beast::hash_append; hash_append(h, HashPrefix::proposal); - hash_append(h, std::uint32_t(proposal().proposeSeq())); + hash_append(h, proposal().proposeSeq()); hash_append(h, proposal().closeTime()); hash_append(h, proposal().prevLedger()); hash_append(h, proposal().position()); diff --git a/src/xrpld/app/consensus/RCLValidations.cpp b/src/xrpld/app/consensus/RCLValidations.cpp index 7bc16f194e..b969774954 100644 --- a/src/xrpld/app/consensus/RCLValidations.cpp +++ b/src/xrpld/app/consensus/RCLValidations.cpp @@ -1,16 +1,28 @@ #include + #include #include #include #include #include +#include #include +#include #include +#include +#include #include #include +#include +#include +#include +#include +#include +#include #include +#include namespace xrpl { diff --git a/src/xrpld/app/consensus/README.md b/src/xrpld/app/consensus/README.md index bdf5afe87c..44a4dc8ae7 100644 --- a/src/xrpld/app/consensus/README.md +++ b/src/xrpld/app/consensus/README.md @@ -2,11 +2,11 @@ This directory holds the types and classes needed to connect the generic consensus algorithm to the -rippled-specific instance of consensus. +xrpld-specific instance of consensus. - `RCLCxTx` adapts a `SHAMapItem` transaction. - `RCLCxTxSet` adapts a `SHAMap` to represent a set of transactions. - `RCLCxLedger` adapts a `Ledger`. - `RCLConsensus` is implements the requirements of the generic - `Consensus` class by connecting to the rest of the `rippled` + `Consensus` class by connecting to the rest of the `xrpld` application. diff --git a/src/xrpld/app/ledger/AcceptedLedger.cpp b/src/xrpld/app/ledger/AcceptedLedger.cpp index 1da70702bf..11ef55ad0c 100644 --- a/src/xrpld/app/ledger/AcceptedLedger.cpp +++ b/src/xrpld/app/ledger/AcceptedLedger.cpp @@ -1,6 +1,10 @@ #include +#include +#include + #include +#include namespace xrpl { diff --git a/src/xrpld/app/ledger/AccountStateSF.cpp b/src/xrpld/app/ledger/AccountStateSF.cpp index 79c1f0eaf6..d5fa5d83ff 100644 --- a/src/xrpld/app/ledger/AccountStateSF.cpp +++ b/src/xrpld/app/ledger/AccountStateSF.cpp @@ -1,5 +1,14 @@ #include +#include +#include +#include +#include + +#include +#include +#include + namespace xrpl { void diff --git a/src/xrpld/app/ledger/ConsensusTransSetSF.cpp b/src/xrpld/app/ledger/ConsensusTransSetSF.cpp index 2313d29f86..d42ff0a9e0 100644 --- a/src/xrpld/app/ledger/ConsensusTransSetSF.cpp +++ b/src/xrpld/app/ledger/ConsensusTransSetSF.cpp @@ -1,12 +1,25 @@ #include + #include #include +#include +#include +#include +#include +#include #include -#include #include -#include +#include +#include // IWYU pragma: keep #include +#include + +#include +#include +#include +#include +#include namespace xrpl { @@ -36,7 +49,7 @@ ConsensusTransSetSF::gotNode( try { // skip prefix - Serializer s(nodeData.data() + 4, nodeData.size() - 4); + Serializer const s(nodeData.data() + 4, nodeData.size() - 4); SerialIter sit(s.slice()); auto stx = std::make_shared(std::ref(sit)); XRPL_ASSERT( diff --git a/src/xrpld/app/ledger/InboundLedger.h b/src/xrpld/app/ledger/InboundLedger.h index 4795ea8f9f..b17b59b27f 100644 --- a/src/xrpld/app/ledger/InboundLedger.h +++ b/src/xrpld/app/ledger/InboundLedger.h @@ -152,11 +152,11 @@ private: clock_type::time_point mLastAction; std::shared_ptr mLedger; - bool mHaveHeader; - bool mHaveState; - bool mHaveTransactions; - bool mSignaled; - bool mByHash; + bool mHaveHeader{false}; + bool mHaveState{false}; + bool mHaveTransactions{false}; + bool mSignaled{false}; + bool mByHash{true}; std::uint32_t mSeq; Reason const mReason; @@ -168,7 +168,7 @@ private: std::mutex mReceivedDataLock; std::vector, std::shared_ptr>> mReceivedData; - bool mReceiveDispatched; + bool mReceiveDispatched{false}; std::unique_ptr mPeerSet; }; diff --git a/src/xrpld/app/ledger/LedgerHistory.cpp b/src/xrpld/app/ledger/LedgerHistory.cpp index b96760f04d..fcc44ba970 100644 --- a/src/xrpld/app/ledger/LedgerHistory.cpp +++ b/src/xrpld/app/ledger/LedgerHistory.cpp @@ -1,11 +1,33 @@ #include + #include #include #include +#include +#include +#include #include #include -#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -40,7 +62,7 @@ LedgerHistory::insert(std::shared_ptr const& ledger, bool validate XRPL_ASSERT( ledger->stateMap().getHash().isNonZero(), "xrpl::LedgerHistory::insert : nonzero hash"); - std::unique_lock sl(m_ledgers_by_hash.peekMutex()); + std::unique_lock const sl(m_ledgers_by_hash.peekMutex()); bool const alreadyHad = m_ledgers_by_hash.canonicalize_replace_cache(ledger->header().hash, ledger); @@ -53,7 +75,7 @@ LedgerHistory::insert(std::shared_ptr const& ledger, bool validate LedgerHash LedgerHistory::getLedgerHash(LedgerIndex index) { - std::unique_lock sl(m_ledgers_by_hash.peekMutex()); + std::unique_lock const sl(m_ledgers_by_hash.peekMutex()); if (auto it = mLedgersByIndex.find(index); it != mLedgersByIndex.end()) return it->second; return {}; @@ -68,7 +90,7 @@ LedgerHistory::getLedgerBySeq(LedgerIndex index) if (it != mLedgersByIndex.end()) { - uint256 hash = it->second; + uint256 const hash = it->second; sl.unlock(); return getLedgerByHash(hash); } @@ -86,7 +108,7 @@ LedgerHistory::getLedgerBySeq(LedgerIndex index) { // Add this ledger to the local tracking by index - std::unique_lock sl(m_ledgers_by_hash.peekMutex()); + std::unique_lock const sl(m_ledgers_by_hash.peekMutex()); XRPL_ASSERT( ret->isImmutable(), "xrpl::LedgerHistory::getLedgerBySeq : immutable result ledger"); @@ -405,11 +427,11 @@ LedgerHistory::builtLedger( uint256 const& consensusHash, Json::Value consensus) { - LedgerIndex index = ledger->header().seq; - LedgerHash hash = ledger->header().hash; + LedgerIndex const index = ledger->header().seq; + LedgerHash const hash = ledger->header().hash; XRPL_ASSERT(!hash.isZero(), "xrpl::LedgerHistory::builtLedger : nonzero hash"); - std::unique_lock sl(m_consensus_validated.peekMutex()); + std::unique_lock const sl(m_consensus_validated.peekMutex()); auto entry = std::make_shared(); m_consensus_validated.canonicalize_replace_client(index, entry); @@ -444,11 +466,11 @@ LedgerHistory::validatedLedger( std::shared_ptr const& ledger, std::optional const& consensusHash) { - LedgerIndex index = ledger->header().seq; - LedgerHash hash = ledger->header().hash; + LedgerIndex const index = ledger->header().seq; + LedgerHash const hash = ledger->header().hash; XRPL_ASSERT(!hash.isZero(), "xrpl::LedgerHistory::validatedLedger : nonzero hash"); - std::unique_lock sl(m_consensus_validated.peekMutex()); + std::unique_lock const sl(m_consensus_validated.peekMutex()); auto entry = std::make_shared(); m_consensus_validated.canonicalize_replace_client(index, entry); @@ -482,7 +504,7 @@ LedgerHistory::validatedLedger( bool LedgerHistory::fixIndex(LedgerIndex ledgerIndex, LedgerHash const& ledgerHash) { - std::unique_lock sl(m_ledgers_by_hash.peekMutex()); + std::unique_lock const sl(m_ledgers_by_hash.peekMutex()); auto it = mLedgersByIndex.find(ledgerIndex); if ((it != mLedgersByIndex.end()) && (it->second != ledgerHash)) @@ -496,7 +518,7 @@ LedgerHistory::fixIndex(LedgerIndex ledgerIndex, LedgerHash const& ledgerHash) void LedgerHistory::clearLedgerCachePrior(LedgerIndex seq) { - for (LedgerHash it : m_ledgers_by_hash.getKeys()) + for (LedgerHash const it : m_ledgers_by_hash.getKeys()) { auto const ledger = getLedgerByHash(it); if (!ledger || ledger->header().seq < seq) diff --git a/src/xrpld/app/ledger/LedgerHolder.h b/src/xrpld/app/ledger/LedgerHolder.h index 8d2ac9f308..bf9d478c40 100644 --- a/src/xrpld/app/ledger/LedgerHolder.h +++ b/src/xrpld/app/ledger/LedgerHolder.h @@ -28,7 +28,7 @@ public: LogicError("LedgerHolder::set with nullptr"); if (!ledger->isImmutable()) LogicError("LedgerHolder::set with mutable Ledger"); - std::lock_guard sl(m_lock); + std::lock_guard const sl(m_lock); m_heldLedger = std::move(ledger); } @@ -36,14 +36,14 @@ public: std::shared_ptr get() { - std::lock_guard sl(m_lock); + std::lock_guard const sl(m_lock); return m_heldLedger; } bool empty() { - std::lock_guard sl(m_lock); + std::lock_guard const sl(m_lock); return m_heldLedger == nullptr; } diff --git a/src/xrpld/app/ledger/LedgerMaster.h b/src/xrpld/app/ledger/LedgerMaster.h index 16e35c3dcd..220c04cc91 100644 --- a/src/xrpld/app/ledger/LedgerMaster.h +++ b/src/xrpld/app/ledger/LedgerMaster.h @@ -363,7 +363,7 @@ private: LedgerIndex const max_ledger_difference_{1000000}; // Time that the previous upgrade warning was issued. - TimeKeeper::time_point upgradeWarningPrevTime_{}; + TimeKeeper::time_point upgradeWarningPrevTime_; private: struct Stats @@ -387,7 +387,7 @@ private: void collect_metrics() { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); m_stats.validatedLedgerAge.set(getValidatedLedgerAge().count()); m_stats.publishedLedgerAge.set(getPublishedLedgerAge().count()); } diff --git a/src/xrpld/app/ledger/LedgerReplayTask.h b/src/xrpld/app/ledger/LedgerReplayTask.h index 030121b240..a1fadc95ff 100644 --- a/src/xrpld/app/ledger/LedgerReplayTask.h +++ b/src/xrpld/app/ledger/LedgerReplayTask.h @@ -31,8 +31,8 @@ public: // to be updated std::uint32_t finishSeq_ = 0; - std::vector skipList_ = {}; // including the finishHash - uint256 startHash_ = {}; + std::vector skipList_; // including the finishHash + uint256 startHash_; std::uint32_t startSeq_ = 0; bool full_ = false; @@ -146,7 +146,7 @@ private: TaskParameter parameter_; uint32_t maxTimeouts_; std::shared_ptr skipListAcquirer_; - std::shared_ptr parent_ = {}; + std::shared_ptr parent_; uint32_t deltaToBuild_ = 0; // should not build until have parent std::vector> deltas_; diff --git a/src/xrpld/app/ledger/LedgerReplayer.h b/src/xrpld/app/ledger/LedgerReplayer.h index 218d22fb07..ce2acb0699 100644 --- a/src/xrpld/app/ledger/LedgerReplayer.h +++ b/src/xrpld/app/ledger/LedgerReplayer.h @@ -103,21 +103,21 @@ public: std::size_t tasksSize() const { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); return tasks_.size(); } std::size_t deltasSize() const { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); return deltas_.size(); } std::size_t skipListsSize() const { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); return skipLists_.size(); } diff --git a/src/xrpld/app/ledger/LedgerToJson.h b/src/xrpld/app/ledger/LedgerToJson.h index 3686311656..53985f343b 100644 --- a/src/xrpld/app/ledger/LedgerToJson.h +++ b/src/xrpld/app/ledger/LedgerToJson.h @@ -19,7 +19,7 @@ struct LedgerFill std::vector q = {}) : ledger(l), options(o), txQueue(std::move(q)), context(ctx) { - if (context) + if (context != nullptr) closeTime = context->ledgerMaster.getCloseTimeBySeq(ledger.seq()); } diff --git a/src/xrpld/app/ledger/OrderBookDB.h b/src/xrpld/app/ledger/OrderBookDB.h new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/xrpld/app/ledger/OrderBookDBImpl.cpp b/src/xrpld/app/ledger/OrderBookDBImpl.cpp index c8ea46cf7f..1c64c5e6fa 100644 --- a/src/xrpld/app/ledger/OrderBookDBImpl.cpp +++ b/src/xrpld/app/ledger/OrderBookDBImpl.cpp @@ -1,10 +1,34 @@ -#include #include +#include + +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -56,8 +80,10 @@ OrderBookDBImpl::setup(std::shared_ptr const& ledger) } else { + // Shorten job name to fit Linux 15-char thread name limit with "j:" prefix + // "OB" + seq (max 9 digits) = 11 chars, + "j:" = 13 chars (fits in 15) registry_.get().getJobQueue().addJob( - jtUPDATE_PF, "OBUpd" + std::to_string(ledger->seq()), [this, ledger]() { + jtUPDATE_PF, "OB" + std::to_string(ledger->seq() % 1000000000), [this, ledger]() { update(ledger); }); } @@ -107,10 +133,34 @@ OrderBookDBImpl::update(std::shared_ptr const& ledger) { Book book; - book.in.currency = sle->getFieldH160(sfTakerPaysCurrency); - book.in.account = sle->getFieldH160(sfTakerPaysIssuer); - book.out.currency = sle->getFieldH160(sfTakerGetsCurrency); - book.out.account = sle->getFieldH160(sfTakerGetsIssuer); + if (sle->isFieldPresent(sfTakerPaysCurrency)) + { + Issue issue; + issue.currency = sle->getFieldH160(sfTakerPaysCurrency); + issue.account = sle->getFieldH160(sfTakerPaysIssuer); + book.in = issue; + } + else + { + XRPL_ASSERT( + sle->isFieldPresent(sfTakerPaysMPT), + "OrderBookDB::update, must be TakerPaysMPT"); + book.in = sle->getFieldH192(sfTakerPaysMPT); + } + if (sle->isFieldPresent(sfTakerGetsCurrency)) + { + Issue issue; + issue.currency = sle->getFieldH160(sfTakerGetsCurrency); + issue.account = sle->getFieldH160(sfTakerGetsIssuer); + book.out = issue; + } + else + { + XRPL_ASSERT( + sle->isFieldPresent(sfTakerGetsMPT), + "OrderBookDB::update, must be TakerGetsMPT"); + book.out = sle->getFieldH192(sfTakerGetsMPT); + } book.domain = (*sle)[~sfDomainID]; if (book.domain) @@ -135,9 +185,9 @@ OrderBookDBImpl::update(std::shared_ptr const& ledger) } else if (sle->getType() == ltAMM) { - auto const issue1 = (*sle)[sfAsset].get(); - auto const issue2 = (*sle)[sfAsset2].get(); - auto addBook = [&](Issue const& in, Issue const& out) { + auto const asset1 = (*sle)[sfAsset]; + auto const asset2 = (*sle)[sfAsset2]; + auto addBook = [&](Asset const& in, Asset const& out) { allBooks[in].insert(out); if (isXRP(out)) @@ -145,8 +195,8 @@ OrderBookDBImpl::update(std::shared_ptr const& ledger) ++cnt; }; - addBook(issue1, issue2); - addBook(issue2, issue1); + addBook(asset1, asset2); + addBook(asset2, asset1); } } } @@ -160,7 +210,7 @@ OrderBookDBImpl::update(std::shared_ptr const& ledger) JLOG(j_.debug()) << "Update completed (" << ledger->seq() << "): " << cnt << " books found"; { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); allBooks_.swap(allBooks); xrpBooks_.swap(xrpBooks); domainBooks_.swap(domainBooks); @@ -173,9 +223,9 @@ OrderBookDBImpl::update(std::shared_ptr const& ledger) void OrderBookDBImpl::addOrderBook(Book const& book) { - bool toXRP = isXRP(book.out); + bool const toXRP = isXRP(book.out); - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (book.domain) { @@ -198,12 +248,12 @@ OrderBookDBImpl::addOrderBook(Book const& book) // return list of all orderbooks that want this issuerID and currencyID std::vector -OrderBookDBImpl::getBooksByTakerPays(Issue const& issue, std::optional const& domain) +OrderBookDBImpl::getBooksByTakerPays(Asset const& asset, std::optional const& domain) { std::vector ret; { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); auto getBooks = [&](auto const& container, auto const& key) { if (auto it = container.find(key); it != container.end()) @@ -212,17 +262,17 @@ OrderBookDBImpl::getBooksByTakerPays(Issue const& issue, std::optional ret.reserve(books.size()); for (auto const& gets : books) - ret.emplace_back(issue, gets, domain); + ret.emplace_back(asset, gets, domain); } }; if (!domain) { - getBooks(allBooks_, issue); + getBooks(allBooks_, asset); } else { - getBooks(domainBooks_, std::make_pair(issue, *domain)); + getBooks(domainBooks_, std::make_pair(asset, *domain)); } } @@ -230,18 +280,18 @@ OrderBookDBImpl::getBooksByTakerPays(Issue const& issue, std::optional } int -OrderBookDBImpl::getBookSize(Issue const& issue, std::optional const& domain) +OrderBookDBImpl::getBookSize(Asset const& asset, std::optional const& domain) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (!domain) { - if (auto it = allBooks_.find(issue); it != allBooks_.end()) + if (auto it = allBooks_.find(asset); it != allBooks_.end()) return static_cast(it->second.size()); } else { - if (auto it = domainBooks_.find({issue, *domain}); it != domainBooks_.end()) + if (auto it = domainBooks_.find({asset, *domain}); it != domainBooks_.end()) return static_cast(it->second.size()); } @@ -249,18 +299,18 @@ OrderBookDBImpl::getBookSize(Issue const& issue, std::optional const& d } bool -OrderBookDBImpl::isBookToXRP(Issue const& issue, std::optional const& domain) +OrderBookDBImpl::isBookToXRP(Asset const& asset, std::optional const& domain) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (domain) - return xrpDomainBooks_.contains({issue, *domain}); - return xrpBooks_.contains(issue); + return xrpDomainBooks_.contains({asset, *domain}); + return xrpBooks_.contains(asset); } BookListeners::pointer OrderBookDBImpl::makeBookListeners(Book const& book) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); auto ret = getBookListeners(book); if (!ret) @@ -281,7 +331,7 @@ BookListeners::pointer OrderBookDBImpl::getBookListeners(Book const& book) { BookListeners::pointer ret; - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); auto it0 = mListeners.find(book); if (it0 != mListeners.end()) @@ -298,7 +348,7 @@ OrderBookDBImpl::processTxn( AcceptedLedgerTx const& alTx, MultiApiJson const& jvObj) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); // For this particular transaction, maintain the set of unique // subscriptions that have already published it. This prevents sending @@ -318,8 +368,8 @@ OrderBookDBImpl::processTxn( data->isFieldPresent(sfTakerPays) && data->isFieldPresent(sfTakerGets)) { auto listeners = getBookListeners( - {data->getFieldAmount(sfTakerGets).issue(), - data->getFieldAmount(sfTakerPays).issue(), + {data->getFieldAmount(sfTakerGets).asset(), + data->getFieldAmount(sfTakerPays).asset(), (*data)[~sfDomainID]}); if (listeners) listeners->publish(jvObj, havePublished); diff --git a/src/xrpld/app/ledger/OrderBookDBImpl.h b/src/xrpld/app/ledger/OrderBookDBImpl.h index 4dd413438e..a72669bef2 100644 --- a/src/xrpld/app/ledger/OrderBookDBImpl.h +++ b/src/xrpld/app/ledger/OrderBookDBImpl.h @@ -41,14 +41,14 @@ public: addOrderBook(Book const& book) override; std::vector - getBooksByTakerPays(Issue const& issue, std::optional const& domain = std::nullopt) + getBooksByTakerPays(Asset const& asset, std::optional const& domain = std::nullopt) override; int - getBookSize(Issue const& issue, std::optional const& domain = std::nullopt) override; + getBookSize(Asset const& asset, std::optional const& domain = std::nullopt) override; bool - isBookToXRP(Issue const& issue, std::optional const& domain = std::nullopt) override; + isBookToXRP(Asset const& asset, std::optional const& domain = std::nullopt) override; // OrderBookDBImpl-specific methods void @@ -71,16 +71,16 @@ private: int const pathSearchMax_; bool const standalone_; - // Maps order books by "issue in" to "issue out": - hardened_hash_map> allBooks_; + // Maps order books by "asset in" to "asset out": + hardened_hash_map> allBooks_; - hardened_hash_map, hardened_hash_set> domainBooks_; + hardened_hash_map, hardened_hash_set> domainBooks_; // does an order book to XRP exist - hash_set xrpBooks_; + hash_set xrpBooks_; // does an order book to XRP exist - hash_set> xrpDomainBooks_; + hash_set> xrpDomainBooks_; std::recursive_mutex mLock; diff --git a/src/xrpld/app/ledger/README.md b/src/xrpld/app/ledger/README.md index cb935897b8..7dc38ce9fa 100644 --- a/src/xrpld/app/ledger/README.md +++ b/src/xrpld/app/ledger/README.md @@ -63,7 +63,7 @@ that the validator sends its proposals and validations to the network. ## Ledger Priorities -There are two ledgers that are the most important for a rippled server to have: +There are two ledgers that are the most important for an xrpld server to have: - The consensus ledger and - The last validated ledger. @@ -224,7 +224,7 @@ conclusion about which last closed ledger is authoritative. ## Consensus -A distributed agreement protocol. Ripple uses the consensus process to solve +A distributed agreement protocol. XRPL uses the consensus process to solve the problem of double-spending. ## Validation @@ -402,7 +402,7 @@ are occupied by the exchange rate. ## Overview -The Ripple server permits clients to subscribe to a continuous stream of +The XRPL server permits clients to subscribe to a continuous stream of fully-validated ledgers. The publication code maintains this stream. The server attempts to maintain this continuous stream unless it falls diff --git a/src/xrpld/app/ledger/TransactionStateSF.cpp b/src/xrpld/app/ledger/TransactionStateSF.cpp index 11d3c83058..e2ec3ca7b6 100644 --- a/src/xrpld/app/ledger/TransactionStateSF.cpp +++ b/src/xrpld/app/ledger/TransactionStateSF.cpp @@ -1,5 +1,15 @@ #include +#include +#include +#include +#include +#include + +#include +#include +#include + namespace xrpl { void diff --git a/src/xrpld/app/ledger/detail/BuildLedger.cpp b/src/xrpld/app/ledger/detail/BuildLedger.cpp index 3b48ab13c5..8f5184336a 100644 --- a/src/xrpld/app/ledger/detail/BuildLedger.cpp +++ b/src/xrpld/app/ledger/detail/BuildLedger.cpp @@ -1,13 +1,27 @@ #include + #include #include #include +#include +#include +#include +#include +#include #include #include -#include +#include +#include +#include +#include #include +#include +#include +#include +#include + namespace xrpl { /* Generic buildLedgerImpl that dispatches to ApplyTxs invocable with signature diff --git a/src/xrpld/app/ledger/detail/InboundLedger.cpp b/src/xrpld/app/ledger/detail/InboundLedger.cpp index 4e7190c8c8..f36748be5c 100644 --- a/src/xrpld/app/ledger/detail/InboundLedger.cpp +++ b/src/xrpld/app/ledger/detail/InboundLedger.cpp @@ -1,21 +1,53 @@ -#include #include + +#include #include #include #include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include #include #include #include +#include #include +#include + #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -67,14 +99,8 @@ InboundLedger::InboundLedger( {jtLEDGER_DATA, "InboundLedger", 5}, app.getJournal("InboundLedger")) , m_clock(clock) - , mHaveHeader(false) - , mHaveState(false) - , mHaveTransactions(false) - , mSignaled(false) - , mByHash(true) , mSeq(seq) , mReason(reason) - , mReceiveDispatched(false) , mPeerSet(std::move(peerSet)) { JLOG(journal_.trace()) << "Acquiring ledger " << hash_; @@ -127,7 +153,7 @@ InboundLedger::getPeerCount() const void InboundLedger::update(std::uint32_t seq) { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); // If we didn't know the sequence number, but now do, save it if ((seq != 0) && (mSeq == 0)) @@ -140,7 +166,7 @@ InboundLedger::update(std::uint32_t seq) bool InboundLedger::checkLocal() { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); if (!isDone()) { if (mLedger) @@ -363,7 +389,7 @@ InboundLedger::onTimer(bool wasProgress, ScopedLockType&) mByHash = true; - std::size_t pc = getPeerCount(); + std::size_t const pc = getPeerCount(); JLOG(journal_.debug()) << "No progress(" << pc << ") for ledger " << hash_; // addPeers triggers if the reason is not HISTORY @@ -996,7 +1022,7 @@ InboundLedger::gotData( std::weak_ptr peer, std::shared_ptr const& data) { - std::lock_guard sl(mReceivedDataLock); + std::lock_guard const sl(mReceivedDataLock); if (isDone()) return false; @@ -1032,7 +1058,7 @@ InboundLedger::processData(std::shared_ptr peer, protocol::TMLedgerData& p SHAMapAddNode san; - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); try { @@ -1084,7 +1110,7 @@ InboundLedger::processData(std::shared_ptr peer, protocol::TMLedgerData& p return -1; } - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); // Verify node IDs and data are complete for (auto const& node : packet.nodes()) @@ -1208,7 +1234,7 @@ InboundLedger::runData() data.clear(); { - std::lock_guard sl(mReceivedDataLock); + std::lock_guard const sl(mReceivedDataLock); if (mReceivedData.empty()) { @@ -1223,7 +1249,7 @@ InboundLedger::runData() { if (auto peer = entry.first.lock()) { - int count = processData(peer, *(entry.second)); + int const count = processData(peer, *(entry.second)); dataCounts.update(std::move(peer), count); } } @@ -1242,7 +1268,7 @@ InboundLedger::getJson(int) { Json::Value ret(Json::objectValue); - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); ret[jss::hash] = to_string(hash_); diff --git a/src/xrpld/app/ledger/detail/InboundLedgers.cpp b/src/xrpld/app/ledger/detail/InboundLedgers.cpp index 3a83aa6018..a9a7386ece 100644 --- a/src/xrpld/app/ledger/detail/InboundLedgers.cpp +++ b/src/xrpld/app/ledger/detail/InboundLedgers.cpp @@ -1,18 +1,43 @@ #include + +#include #include #include +#include +#include #include +#include +#include +#include +#include #include #include +#include +#include +#include +#include #include #include +#include +#include +#include #include #include +#include +#include + +#include +#include +#include #include +#include #include #include +#include +#include +#include #include namespace xrpl { @@ -110,7 +135,7 @@ public: if (pendingAcquires_.contains(hash)) return; pendingAcquires_.insert(hash); - scope_unlock unlock(lock); + scope_unlock const unlock(lock); acquire(hash, seq, reason); } catch (std::exception const& e) @@ -133,7 +158,7 @@ public: std::shared_ptr ret; { - ScopedLockType sl(mLock); + ScopedLockType const sl(mLock); auto it = mLedgers.find(hash); if (it != mLedgers.end()) @@ -197,7 +222,7 @@ public: void logFailure(uint256 const& h, std::uint32_t seq) override { - ScopedLockType sl(mLock); + ScopedLockType const sl(mLock); mRecentFailures.emplace(h, seq); } @@ -205,7 +230,7 @@ public: bool isFailure(uint256 const& h) override { - ScopedLockType sl(mLock); + ScopedLockType const sl(mLock); beast::expire(mRecentFailures, kReacquireInterval); return mRecentFailures.find(h) != mRecentFailures.end(); @@ -250,7 +275,7 @@ public: void clearFailures() override { - ScopedLockType sl(mLock); + ScopedLockType const sl(mLock); mRecentFailures.clear(); mLedgers.clear(); @@ -259,7 +284,7 @@ public: std::size_t fetchRate() override { - std::lock_guard lock(fetchRateMutex_); + std::lock_guard const lock(fetchRateMutex_); return 60 * fetchRate_.value(m_clock.now()); } @@ -268,7 +293,7 @@ public: void onLedgerFetched() override { - std::lock_guard lock(fetchRateMutex_); + std::lock_guard const lock(fetchRateMutex_); fetchRate_.add(1, m_clock.now()); } @@ -280,7 +305,7 @@ public: std::vector>> acqs; { - ScopedLockType sl(mLock); + ScopedLockType const sl(mLock); acqs.reserve(mLedgers.size()); for (auto const& it : mLedgers) @@ -304,7 +329,7 @@ public: for (auto const& it : acqs) { // getJson is expensive, so call without the lock - std::uint32_t seq = it.second->getSeq(); + std::uint32_t const seq = it.second->getSeq(); if (seq > 1) { ret[std::to_string(seq)] = it.second->getJson(0); @@ -323,7 +348,7 @@ public: { std::vector> acquires; { - ScopedLockType sl(mLock); + ScopedLockType const sl(mLock); acquires.reserve(mLedgers.size()); for (auto const& it : mLedgers) @@ -352,7 +377,7 @@ public: std::size_t total = 0; { - ScopedLockType sl(mLock); + ScopedLockType const sl(mLock); MapType::iterator it(mLedgers.begin()); total = mLedgers.size(); @@ -393,7 +418,7 @@ public: void stop() override { - ScopedLockType lock(mLock); + ScopedLockType const lock(mLock); stopping_ = true; mLedgers.clear(); mRecentFailures.clear(); @@ -402,7 +427,7 @@ public: std::size_t cacheSize() override { - ScopedLockType lock(mLock); + ScopedLockType const lock(mLock); return mLedgers.size(); } diff --git a/src/xrpld/app/ledger/detail/InboundTransactions.cpp b/src/xrpld/app/ledger/detail/InboundTransactions.cpp index 064953f665..92c46e2e79 100644 --- a/src/xrpld/app/ledger/detail/InboundTransactions.cpp +++ b/src/xrpld/app/ledger/detail/InboundTransactions.cpp @@ -1,16 +1,29 @@ -#include #include + #include #include +#include -#include +#include +#include +#include +#include #include #include #include +#include +#include +#include + +#include #include +#include +#include #include #include +#include +#include namespace xrpl { @@ -64,7 +77,7 @@ public: getAcquire(uint256 const& hash) { { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); auto it = m_map.find(hash); @@ -80,7 +93,7 @@ public: TransactionAcquire::pointer ta; { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (auto it = m_map.find(hash); it != m_map.end()) { @@ -118,12 +131,12 @@ public: std::shared_ptr peer, std::shared_ptr packet_ptr) override { - protocol::TMLedgerData& packet = *packet_ptr; + protocol::TMLedgerData const& packet = *packet_ptr; JLOG(j_.trace()) << "Got data (" << packet.nodes().size() << ") for acquiring ledger: " << hash; - TransactionAcquire::pointer ta = getAcquire(hash); + TransactionAcquire::pointer const ta = getAcquire(hash); if (ta == nullptr) { @@ -163,7 +176,7 @@ public: bool isNew = true; { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); auto& inboundSet = m_map[hash]; @@ -188,7 +201,7 @@ public: void newRound(std::uint32_t seq) override { - std::lock_guard lock(mLock); + std::lock_guard const lock(mLock); // Protect zero set from expiration m_zeroSet.mSeq = seq; @@ -200,7 +213,7 @@ public: auto it = m_map.begin(); std::uint32_t const minSeq = (seq < setKeepRounds) ? 0 : (seq - setKeepRounds); - std::uint32_t maxSeq = seq + setKeepRounds; + std::uint32_t const maxSeq = seq + setKeepRounds; while (it != m_map.end()) { @@ -219,7 +232,7 @@ public: void stop() override { - std::lock_guard lock(mLock); + std::lock_guard const lock(mLock); stopping_ = true; m_map.clear(); } diff --git a/src/xrpld/app/ledger/detail/LedgerCleaner.cpp b/src/xrpld/app/ledger/detail/LedgerCleaner.cpp index af358fbfc6..850b60f4ed 100644 --- a/src/xrpld/app/ledger/detail/LedgerCleaner.cpp +++ b/src/xrpld/app/ledger/detail/LedgerCleaner.cpp @@ -1,12 +1,34 @@ -#include #include + +#include +#include #include #include #include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -76,7 +98,7 @@ public: { JLOG(j_.info()) << "Stopping"; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); shouldExit_ = true; wakeup_.notify_one(); } @@ -92,7 +114,7 @@ public: void onWrite(beast::PropertyStream::Map& map) override { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (maxRange_ == 0) { @@ -124,7 +146,7 @@ public: app_.getLedgerMaster().getFullValidatedRange(minRange, maxRange); { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); maxRange_ = maxRange; minRange_ = minRange; @@ -327,8 +349,8 @@ private: // No. Try to get another ledger that might have the hash we // need: compute the index and hash of a ledger that will have // the hash we need. - LedgerIndex refIndex = getCandidateLedger(ledgerIndex); - LedgerHash refHash = getLedgerHash(referenceLedger, refIndex); + LedgerIndex const refIndex = getCandidateLedger(ledgerIndex); + LedgerHash const refHash = getLedgerHash(referenceLedger, refIndex); bool const nonzero(refHash.isNonZero()); XRPL_ASSERT(nonzero, "xrpl::LedgerCleanerImp::getHash : nonzero hash"); @@ -354,7 +376,7 @@ private: doLedgerCleaner() { auto shouldExit = [this] { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return shouldExit_; }; @@ -375,7 +397,7 @@ private: } { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if ((minRange_ > maxRange_) || (maxRange_ == 0) || (minRange_ == 0)) { minRange_ = maxRange_ = 0; @@ -403,7 +425,7 @@ private: if (fail) { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); ++failures_; } // Wait for acquiring to catch up to us @@ -412,7 +434,7 @@ private: else { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (ledgerIndex == minRange_) ++minRange_; if (ledgerIndex == maxRange_) diff --git a/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.cpp b/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.cpp index 1d48a9741d..865e4f7e81 100644 --- a/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.cpp +++ b/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.cpp @@ -1,12 +1,34 @@ +#include + #include #include #include #include -#include +#include #include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -178,7 +200,7 @@ LedgerDeltaAcquire::tryBuild(std::shared_ptr const& parent) parent->header().hash == replayTemp_->header().parentHash, "xrpl::LedgerDeltaAcquire::tryBuild : parent hash match"); // build ledger - LedgerReplay replayData(parent, replayTemp_, std::move(orderedTxns_)); + LedgerReplay const replayData(parent, replayTemp_, std::move(orderedTxns_)); fullLedger_ = buildLedger(replayData, tapNONE, app_, journal_); if (fullLedger_ && fullLedger_->header().hash == hash_) { diff --git a/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.h b/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.h index 9ac58c2e7c..6839c44386 100644 --- a/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.h +++ b/src/xrpld/app/ledger/detail/LedgerDeltaAcquire.h @@ -125,8 +125,8 @@ private: InboundLedgers& inboundLedgers_; std::uint32_t const ledgerSeq_; std::unique_ptr peerSet_; - std::shared_ptr replayTemp_ = {}; - std::shared_ptr fullLedger_ = {}; + std::shared_ptr replayTemp_; + std::shared_ptr fullLedger_; std::map> orderedTxns_; std::vector dataReadyCallbacks_; std::set reasons_; diff --git a/src/xrpld/app/ledger/detail/LedgerMaster.cpp b/src/xrpld/app/ledger/detail/LedgerMaster.cpp index 6253b33da3..0ad9b3d6bf 100644 --- a/src/xrpld/app/ledger/detail/LedgerMaster.cpp +++ b/src/xrpld/app/ledger/detail/LedgerMaster.cpp @@ -1,6 +1,9 @@ -#include #include + +#include +#include #include +#include #include #include #include @@ -8,33 +11,71 @@ #include #include #include +#include #include #include #include #include +#include #include +#include +#include +#include #include +#include +#include #include #include #include +#include +#include +#include #include +#include +#include #include #include #include #include +#include +#include #include #include +#include +#include +#include +#include +#include #include #include #include #include #include +#include +#include +#include + +#include + +#include #include +#include #include +#include #include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include namespace xrpl { @@ -122,7 +163,7 @@ LedgerMaster::isCompatible(ReadView const& view, beast::Journal::Stream s, char } { - std::lock_guard sl(m_mutex); + std::lock_guard const sl(m_mutex); if ((mLastValidLedger.second != 0) && !areCompatible(mLastValidLedger.first, mLastValidLedger.second, view, s, reason)) @@ -138,7 +179,7 @@ std::chrono::seconds LedgerMaster::getPublishedLedgerAge() { using namespace std::chrono_literals; - std::chrono::seconds pubClose{mPubLedgerClose.load()}; + std::chrono::seconds const pubClose{mPubLedgerClose.load()}; if (pubClose == 0s) { JLOG(m_journal.debug()) << "No published ledger"; @@ -163,7 +204,7 @@ LedgerMaster::getValidatedLedgerAge() { using namespace std::chrono_literals; - std::chrono::seconds valClose{mValidLedgerSign.load()}; + std::chrono::seconds const valClose{mValidLedgerSign.load()}; if (valClose == 0s) { JLOG(m_journal.debug()) << "No validated ledger"; @@ -193,8 +234,8 @@ LedgerMaster::isCaughtUp(std::string& reason) reason = "No recently-published ledger"; return false; } - std::uint32_t validClose = mValidLedgerSign.load(); - std::uint32_t pubClose = mPubLedgerClose.load(); + std::uint32_t const validClose = mValidLedgerSign.load(); + std::uint32_t const pubClose = mPubLedgerClose.load(); if ((validClose == 0u) || (pubClose == 0u)) { reason = "No published ledger"; @@ -301,7 +342,7 @@ LedgerMaster::setPubLedger(std::shared_ptr const& l) void LedgerMaster::addHeldTransaction(std::shared_ptr const& transaction) { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); mHeldTransactions.insert(transaction->getSTransaction()); } @@ -384,7 +425,7 @@ LedgerMaster::switchLCL(std::shared_ptr const& lastClosed) LogicError("The new last closed ledger is open!"); { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); mClosedLedger.set(lastClosed); } @@ -408,7 +449,7 @@ LedgerMaster::fixIndex(LedgerIndex ledgerIndex, LedgerHash const& ledgerHash) bool LedgerMaster::storeLedger(std::shared_ptr ledger) { - bool validated = ledger->header().validated; + bool const validated = ledger->header().validated; // Returns true if we already had the ledger return mLedgerHistory.insert(ledger, validated); } @@ -422,7 +463,7 @@ void LedgerMaster::applyHeldTransactions() { CanonicalTXSet const set = [this]() { - std::lock_guard sl(m_mutex); + std::lock_guard const sl(m_mutex); // VFALCO NOTE The hash for an open ledger is undefined so we use // something that is a reasonable substitute. CanonicalTXSet set(app_.getOpenLedger().current()->header().parentHash); @@ -437,7 +478,7 @@ LedgerMaster::applyHeldTransactions() std::shared_ptr LedgerMaster::popAcctTransaction(std::shared_ptr const& tx) { - std::lock_guard sl(m_mutex); + std::lock_guard const sl(m_mutex); return mHeldTransactions.popAcctTransaction(tx); } @@ -451,14 +492,14 @@ LedgerMaster::setBuildingLedger(LedgerIndex i) bool LedgerMaster::haveLedger(std::uint32_t seq) { - std::lock_guard sl(mCompleteLock); + std::lock_guard const sl(mCompleteLock); return boost::icl::contains(mCompleteLedgers, seq); } void LedgerMaster::clearLedger(std::uint32_t seq) { - std::lock_guard sl(mCompleteLock); + std::lock_guard const sl(mCompleteLock); mCompleteLedgers.erase(seq); } @@ -485,7 +526,7 @@ LedgerMaster::isValidated(ReadView const& ledger) if (hash) { XRPL_ASSERT(hash->isNonZero(), "xrpl::LedgerMaster::isValidated : nonzero hash"); - uint256 valHash = app_.getRelationalDatabase().getHashByIndex(seq); + uint256 const valHash = app_.getRelationalDatabase().getHashByIndex(seq); if (valHash == ledger.header().hash) { // SQL database doesn't match ledger chain @@ -519,7 +560,7 @@ LedgerMaster::getFullValidatedRange(std::uint32_t& minVal, std::uint32_t& maxVal std::optional maybeMin; { - std::lock_guard sl(mCompleteLock); + std::lock_guard const sl(mCompleteLock); maybeMin = prevMissing(mCompleteLedgers, maxVal); } @@ -614,7 +655,7 @@ LedgerMaster::tryFill(std::shared_ptr ledger) while (!app_.getJobQueue().isStopping() && seq > 0) { { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); minHas = seq; --seq; @@ -630,7 +671,7 @@ LedgerMaster::tryFill(std::shared_ptr ledger) return; { - std::lock_guard ml(mCompleteLock); + std::lock_guard const ml(mCompleteLock); mCompleteLedgers.insert(range(minHas, maxHas)); } maxHas = minHas; @@ -658,11 +699,11 @@ LedgerMaster::tryFill(std::shared_ptr ledger) } { - std::lock_guard ml(mCompleteLock); + std::lock_guard const ml(mCompleteLock); mCompleteLedgers.insert(range(minHas, maxHas)); } { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); mFillInProgress = 0; tryAdvance(); } @@ -692,7 +733,7 @@ LedgerMaster::getFetchPack(LedgerIndex missing, InboundLedger::Reason reason) { if (peer->hasRange(missing, missing + 1)) { - int score = peer->getScore(true); + int const score = peer->getScore(true); if (!target || (score > maxScore)) { target = peer; @@ -791,7 +832,8 @@ LedgerMaster::setFullLedger( { // Check the SQL database's entry for the sequence before this // ledger, if it's not this ledger's parent, invalidate it - uint256 prevHash = app_.getRelationalDatabase().getHashByIndex(ledger->header().seq - 1); + uint256 const prevHash = + app_.getRelationalDatabase().getHashByIndex(ledger->header().seq - 1); if (prevHash.isNonZero() && prevHash != ledger->header().parentHash) clearLedger(ledger->header().seq - 1); } @@ -799,12 +841,12 @@ LedgerMaster::setFullLedger( pendSaveValidated(app_, ledger, isSynchronous, isCurrent); { - std::lock_guard ml(mCompleteLock); + std::lock_guard const ml(mCompleteLock); mCompleteLedgers.insert(ledger->header().seq); } { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); if (ledger->header().seq > mValidLedgerSeq) setValidLedger(ledger); @@ -854,7 +896,7 @@ LedgerMaster::checkAccept(uint256 const& hash, std::uint32_t seq) valCount = validations.size(); if (valCount >= app_.getValidators().quorum()) { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); if (seq > mLastValidLedger.second) mLastValidLedger = std::make_pair(hash, seq); } @@ -908,7 +950,7 @@ LedgerMaster::checkAccept(std::shared_ptr const& ledger) // Can we advance the last fully-validated ledger? If so, can we // publish? - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); if (ledger->header().seq <= mValidLedgerSeq) return; @@ -970,10 +1012,10 @@ LedgerMaster::checkAccept(std::shared_ptr const& ledger) if (ledger->seq() % 256 == 0) { - // Check if the majority of validators run a higher version rippled + // Check if the majority of validators run a higher version xrpld // software. If so print a warning. // - // Validators include their rippled software version in the validation + // Validators include their xrpld software version in the validation // messages of every (flag - 1) ledger. We wait for one ledger time // before checking the version information to accumulate more validation // messages. @@ -989,28 +1031,28 @@ LedgerMaster::checkAccept(std::shared_ptr const& ledger) auto const vals = app_.getValidations().getTrustedForLedger( ledger->header().parentHash, ledger->header().seq - 1); std::size_t higherVersionCount = 0; - std::size_t rippledCount = 0; + std::size_t xrpldCount = 0; for (auto const& v : vals) { if (v->isFieldPresent(sfServerVersion)) { auto version = v->getFieldU64(sfServerVersion); higherVersionCount += BuildInfo::isNewerVersion(version) ? 1 : 0; - rippledCount += BuildInfo::isRippledVersion(version) ? 1 : 0; + xrpldCount += BuildInfo::isXrpldVersion(version) ? 1 : 0; } } // We report only if (1) we have accumulated validation messages // from 90% validators from the UNL, (2) 60% of validators - // running the rippled implementation have higher version numbers, + // running the xrpld implementation have higher version numbers, // and (3) the calculation won't cause divide-by-zero. - if (higherVersionCount > 0 && rippledCount > 0) + if (higherVersionCount > 0 && xrpldCount > 0) { constexpr std::size_t reportingPercent = 90; constexpr std::size_t cutoffPercent = 60; auto const unlSize{app_.getValidators().getQuorumKeys().second.size()}; needPrint = unlSize > 0 && calculatePercent(vals.size(), unlSize) >= reportingPercent && - calculatePercent(higherVersionCount, rippledCount) >= cutoffPercent; + calculatePercent(higherVersionCount, xrpldCount) >= cutoffPercent; } } // To throttle the warning messages, instead of printing a warning @@ -1200,9 +1242,9 @@ LedgerMaster::findNewLedgersToPublish(std::unique_lock& sl auto pubSeq = mPubLedgerSeq + 1; // Next sequence to publish auto valLedger = mValidLedger.get(); - std::uint32_t valSeq = valLedger->header().seq; + std::uint32_t const valSeq = valLedger->header().seq; - scope_unlock sul{sl}; + scope_unlock const sul{sl}; try { for (std::uint32_t seq = pubSeq; seq <= valSeq; ++seq) @@ -1302,7 +1344,7 @@ LedgerMaster::findNewLedgersToPublish(std::unique_lock& sl void LedgerMaster::tryAdvance() { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); // Can't advance without at least one fully-valid ledger mAdvanceWork = true; @@ -1337,7 +1379,7 @@ void LedgerMaster::updatePaths() { { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); if (app_.getOPs().isNeedNetworkLedger()) { --mPathFindThread; @@ -1352,7 +1394,7 @@ LedgerMaster::updatePaths() JLOG(m_journal.debug()) << "updatePaths running"; std::shared_ptr lastLedger; { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); if (!mValidLedger.empty() && (!mPathLedger || (mPathLedger->header().seq != mValidLedgerSeq))) @@ -1381,7 +1423,7 @@ LedgerMaster::updatePaths() if (age > 1min) { JLOG(m_journal.debug()) << "Published ledger too old for updating paths"; - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); --mPathFindThread; mPathLedger.reset(); return; @@ -1392,7 +1434,7 @@ LedgerMaster::updatePaths() { auto& pathRequests = app_.getPathRequestManager(); { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); if (!pathRequests.requestsPending()) { --mPathFindThread; @@ -1406,7 +1448,7 @@ LedgerMaster::updatePaths() JLOG(m_journal.debug()) << "Updating paths"; pathRequests.updateAll(lastLedger); - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); if (!pathRequests.requestsPending()) { JLOG(m_journal.debug()) << "No path requests left. No need for further updating " @@ -1450,7 +1492,7 @@ LedgerMaster::newPathRequest() bool LedgerMaster::isNewPathRequest() { - std::lock_guard ml(m_mutex); + std::lock_guard const ml(m_mutex); bool const ret = mPathFindNewRequest; mPathFindNewRequest = false; return ret; @@ -1523,21 +1565,21 @@ LedgerMaster::getValidatedRules() std::shared_ptr LedgerMaster::getPublishedLedger() { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); return mPubLedger; } std::string LedgerMaster::getCompleteLedgers() { - std::lock_guard sl(mCompleteLock); + std::lock_guard const sl(mCompleteLock); return to_string(mCompleteLedgers); } std::optional LedgerMaster::getCloseTimeBySeq(LedgerIndex ledgerIndex) { - uint256 hash = getHashBySeq(ledgerIndex); + uint256 const hash = getHashBySeq(ledgerIndex); return hash.isNonZero() ? getCloseTimeByHash(hash, ledgerIndex) : std::nullopt; } @@ -1601,7 +1643,7 @@ LedgerMaster::walkHashBySeq( // The hash is not in the reference ledger. Get another ledger which can // be located easily and should contain the hash. - LedgerIndex refIndex = getCandidateLedger(index); + LedgerIndex const refIndex = getCandidateLedger(index); auto const refHash = hashOfSeq(*referenceLedger, refIndex, m_journal); XRPL_ASSERT(refHash, "xrpl::LedgerMaster::walkHashBySeq : found ledger"); if (refHash) @@ -1689,7 +1731,7 @@ LedgerMaster::getLedgerByHash(uint256 const& hash) void LedgerMaster::setLedgerRangePresent(std::uint32_t minV, std::uint32_t maxV) { - std::lock_guard sl(mCompleteLock); + std::lock_guard const sl(mCompleteLock); mCompleteLedgers.insert(range(minV, maxV)); } @@ -1709,7 +1751,7 @@ LedgerMaster::getCacheHitRate() void LedgerMaster::clearPriorLedgers(LedgerIndex seq) { - std::lock_guard sl(mCompleteLock); + std::lock_guard const sl(mCompleteLock); if (seq > 0) mCompleteLedgers.erase(range(0u, seq - 1)); } @@ -1739,7 +1781,7 @@ LedgerMaster::fetchForHistory( InboundLedger::Reason reason, std::unique_lock& sl) { - scope_unlock sul{sl}; + scope_unlock const sul{sl}; if (auto hash = getLedgerHashForHistory(missing, reason)) { XRPL_ASSERT(hash->isNonZero(), "xrpl::LedgerMaster::fetchForHistory : found ledger"); @@ -1770,7 +1812,7 @@ LedgerMaster::fetchForHistory( setFullLedger(ledger, false, false); int fillInProgress = 0; { - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); mHistLedger = ledger; fillInProgress = mFillInProgress; } @@ -1779,7 +1821,7 @@ LedgerMaster::fetchForHistory( { { // Previous ledger is in DB - std::lock_guard lock(m_mutex); + std::lock_guard const lock(m_mutex); mFillInProgress = seq; } app_.getJobQueue().addJob( @@ -1799,7 +1841,7 @@ LedgerMaster::fetchForHistory( { for (std::uint32_t i = 0; i < fetchSz; ++i) { - std::uint32_t seq = missing - i; + std::uint32_t const seq = missing - i; if (auto h = getLedgerHashForHistory(seq, reason)) { XRPL_ASSERT( @@ -1848,10 +1890,10 @@ LedgerMaster::doAdvance(std::unique_lock& sl) (app_.getNodeStore().getWriteLoad() < MAX_WRITE_LOAD_ACQUIRE)) { // We are in sync, so can acquire - InboundLedger::Reason reason = InboundLedger::Reason::HISTORY; + InboundLedger::Reason const reason = InboundLedger::Reason::HISTORY; std::optional missing; { - std::lock_guard sll(mCompleteLock); + std::lock_guard const sll(mCompleteLock); missing = prevMissing( mCompleteLedgers, mPubLedger->header().seq, @@ -1898,7 +1940,7 @@ LedgerMaster::doAdvance(std::unique_lock& sl) for (auto const& ledger : pubLedgers) { { - scope_unlock sul{sl}; + scope_unlock const sul{sl}; JLOG(m_journal.debug()) << "tryAdvance publishing seq " << ledger->header().seq; setFullLedger(ledger, true, true); } @@ -1906,7 +1948,7 @@ LedgerMaster::doAdvance(std::unique_lock& sl) setPubLedger(ledger); { - scope_unlock sul{sl}; + scope_unlock const sul{sl}; app_.getOPs().pubLedger(ledger); } } @@ -2087,7 +2129,7 @@ LedgerMaster::makeFetchPack( // the same process adding the previous ledger to the FetchPack. do { - std::uint32_t lSeq = want->header().seq; + std::uint32_t const lSeq = want->header().seq; { // Serialize the ledger header: diff --git a/src/xrpld/app/ledger/detail/LedgerPersistence.cpp b/src/xrpld/app/ledger/detail/LedgerPersistence.cpp index 91de010f1d..0edf425f13 100644 --- a/src/xrpld/app/ledger/detail/LedgerPersistence.cpp +++ b/src/xrpld/app/ledger/detail/LedgerPersistence.cpp @@ -1,14 +1,22 @@ #include +#include +#include #include #include +#include #include #include -#include #include -#include +#include #include +#include +#include +#include +#include +#include + namespace xrpl { static bool diff --git a/src/xrpld/app/ledger/detail/LedgerReplay.cpp b/src/xrpld/app/ledger/detail/LedgerReplay.cpp index a02267e4a1..925ede6d27 100644 --- a/src/xrpld/app/ledger/detail/LedgerReplay.cpp +++ b/src/xrpld/app/ledger/detail/LedgerReplay.cpp @@ -1,6 +1,12 @@ #include #include +#include + +#include +#include +#include +#include namespace xrpl { diff --git a/src/xrpld/app/ledger/detail/LedgerReplayMsgHandler.cpp b/src/xrpld/app/ledger/detail/LedgerReplayMsgHandler.cpp index a212629d28..9facb24c9d 100644 --- a/src/xrpld/app/ledger/detail/LedgerReplayMsgHandler.cpp +++ b/src/xrpld/app/ledger/detail/LedgerReplayMsgHandler.cpp @@ -1,12 +1,35 @@ +#include + #include #include -#include #include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include #include +#include +#include +#include namespace xrpl { LedgerReplayMsgHandler::LedgerReplayMsgHandler(Application& app, LedgerReplayer& replayer) @@ -82,7 +105,7 @@ bool LedgerReplayMsgHandler::processProofPathResponse( std::shared_ptr const& msg) { - protocol::TMProofPathResponse& reply = *msg; + protocol::TMProofPathResponse const& reply = *msg; if (reply.has_error() || !reply.has_key() || !reply.has_ledgerhash() || !reply.has_type() || !reply.has_ledgerheader() || reply.path_size() == 0) { @@ -98,7 +121,7 @@ LedgerReplayMsgHandler::processProofPathResponse( // deserialize the header auto info = deserializeHeader({reply.ledgerheader().data(), reply.ledgerheader().size()}); - uint256 replyHash(reply.ledgerhash()); + uint256 const replyHash(reply.ledgerhash()); if (calculateLedgerHash(info) != replyHash) { JLOG(journal_.debug()) << "Bad message: Hash mismatch"; @@ -106,7 +129,7 @@ LedgerReplayMsgHandler::processProofPathResponse( } info.hash = replyHash; - uint256 key(reply.key()); + uint256 const key(reply.key()); if (key != keylet::skip().key) { JLOG(journal_.debug()) << "Bad message: we only support the short skip list for now. " @@ -151,7 +174,7 @@ protocol::TMReplayDeltaResponse LedgerReplayMsgHandler::processReplayDeltaRequest( std::shared_ptr const& msg) { - protocol::TMReplayDeltaRequest& packet = *msg; + protocol::TMReplayDeltaRequest const& packet = *msg; protocol::TMReplayDeltaResponse reply; if (!packet.has_ledgerhash() || packet.ledgerhash().size() != uint256::size()) @@ -190,7 +213,7 @@ bool LedgerReplayMsgHandler::processReplayDeltaResponse( std::shared_ptr const& msg) { - protocol::TMReplayDeltaResponse& reply = *msg; + protocol::TMReplayDeltaResponse const& reply = *msg; if (reply.has_error() || !reply.has_ledgerheader()) { JLOG(journal_.debug()) << "Bad message: Error reply"; @@ -198,7 +221,7 @@ LedgerReplayMsgHandler::processReplayDeltaResponse( } auto info = deserializeHeader({reply.ledgerheader().data(), reply.ledgerheader().size()}); - uint256 replyHash(reply.ledgerhash()); + uint256 const replyHash(reply.ledgerhash()); if (calculateLedgerHash(info) != replyHash) { JLOG(journal_.debug()) << "Bad message: Hash mismatch"; @@ -217,7 +240,8 @@ LedgerReplayMsgHandler::processReplayDeltaResponse( // -- TxShaMapItem for building a ShaMap for verification // -- Tx // -- TxMetaData for Tx ordering - Serializer shaMapItemData(reply.transaction(i).data(), reply.transaction(i).size()); + Serializer const shaMapItemData( + reply.transaction(i).data(), reply.transaction(i).size()); SerialIter txMetaSit(makeSlice(reply.transaction(i))); SerialIter txSit(txMetaSit.getSlice(txMetaSit.getVLDataLength())); diff --git a/src/xrpld/app/ledger/detail/LedgerReplayTask.cpp b/src/xrpld/app/ledger/detail/LedgerReplayTask.cpp index 6db0cebf1a..f992b91a16 100644 --- a/src/xrpld/app/ledger/detail/LedgerReplayTask.cpp +++ b/src/xrpld/app/ledger/detail/LedgerReplayTask.cpp @@ -1,8 +1,23 @@ -#include #include + +#include +#include #include #include #include +#include +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include namespace xrpl { @@ -96,7 +111,7 @@ LedgerReplayTask::init() { JLOG(journal_.debug()) << "Task start " << hash_; - std::weak_ptr wptr = shared_from_this(); + std::weak_ptr const wptr = shared_from_this(); skipListAcquirer_->addDataCallback([wptr](bool good, uint256 const& hash) { if (auto sptr = wptr.lock(); sptr) { @@ -163,7 +178,8 @@ LedgerReplayTask::tryAdvance(ScopedLockType& sl) << ", deltaIndex=" << deltaToBuild_ << ", totalDeltas=" << deltas_.size() << ", parent " << (parent_ ? parent_->header().hash : uint256()); - bool shouldTry = parent_ && parameter_.full_ && parameter_.totalLedgers_ - 1 == deltas_.size(); + bool const shouldTry = + parent_ && parameter_.full_ && parameter_.totalLedgers_ - 1 == deltas_.size(); if (!shouldTry) return; @@ -204,7 +220,7 @@ LedgerReplayTask::updateSkipList( std::vector const& sList) { { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); if (isDone()) return; if (!parameter_.update(hash, seq, sList)) @@ -245,7 +261,7 @@ LedgerReplayTask::pmDowncast() void LedgerReplayTask::addDelta(std::shared_ptr const& delta) { - std::weak_ptr wptr = shared_from_this(); + std::weak_ptr const wptr = shared_from_this(); delta->addDataCallback(parameter_.reason_, [wptr](bool good, uint256 const& hash) { if (auto sptr = wptr.lock(); sptr) { @@ -260,7 +276,7 @@ LedgerReplayTask::addDelta(std::shared_ptr const& delta) } }); - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); if (!isDone()) { JLOG(journal_.trace()) << "addDelta task " << hash_ << " deltaIndex=" << deltaToBuild_ @@ -276,7 +292,7 @@ LedgerReplayTask::addDelta(std::shared_ptr const& delta) bool LedgerReplayTask::finished() const { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); return isDone(); } diff --git a/src/xrpld/app/ledger/detail/LedgerReplayer.cpp b/src/xrpld/app/ledger/detail/LedgerReplayer.cpp index 9161c05d9a..3d0fc6b5c3 100644 --- a/src/xrpld/app/ledger/detail/LedgerReplayer.cpp +++ b/src/xrpld/app/ledger/detail/LedgerReplayer.cpp @@ -1,6 +1,28 @@ #include + +#include +#include #include #include +#include +#include + +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -17,7 +39,7 @@ LedgerReplayer::LedgerReplayer( LedgerReplayer::~LedgerReplayer() { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); tasks_.clear(); } @@ -32,13 +54,14 @@ LedgerReplayer::replay( totalNumLedgers <= LedgerReplayParameters::MAX_TASK_SIZE, "xrpl::LedgerReplayer::replay : valid inputs"); + // NOLINTNEXTLINE(misc-const-correctness) LedgerReplayTask::TaskParameter parameter(r, finishLedgerHash, totalNumLedgers); std::shared_ptr task; std::shared_ptr skipList; bool newSkipList = false; { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); if (app_.isStopping()) return; if (tasks_.size() >= LedgerReplayParameters::MAX_TASKS) @@ -117,7 +140,7 @@ LedgerReplayer::createDeltas(std::shared_ptr task) std::shared_ptr delta; bool newDelta = false; { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); if (app_.isStopping()) return; auto i = deltas_.find(*skipListItem); @@ -147,7 +170,7 @@ LedgerReplayer::gotSkipList( { std::shared_ptr skipList = {}; { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); auto i = skipLists_.find(info.hash); if (i == skipLists_.end()) return; @@ -170,7 +193,7 @@ LedgerReplayer::gotReplayDelta( { std::shared_ptr delta = {}; { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); auto i = deltas_.find(info.hash); if (i == deltas_.end()) return; @@ -191,7 +214,7 @@ LedgerReplayer::sweep() { auto const start = std::chrono::steady_clock::now(); { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); JLOG(j_.debug()) << "Sweeping, LedgerReplayer has " << tasks_.size() << " tasks, " << skipLists_.size() << " skipLists, and " << deltas_.size() << " deltas."; @@ -237,7 +260,7 @@ LedgerReplayer::stop() { JLOG(j_.info()) << "Stopping..."; { - std::lock_guard lock(mtx_); + std::lock_guard const lock(mtx_); std::for_each(tasks_.begin(), tasks_.end(), [](auto& i) { i->cancel(); }); tasks_.clear(); auto lockAndCancel = [](auto& i) { diff --git a/src/xrpld/app/ledger/detail/LedgerToJson.cpp b/src/xrpld/app/ledger/detail/LedgerToJson.cpp index a48756f9b6..8ba45fb515 100644 --- a/src/xrpld/app/ledger/detail/LedgerToJson.cpp +++ b/src/xrpld/app/ledger/detail/LedgerToJson.cpp @@ -1,15 +1,35 @@ -#include #include + +#include #include #include #include #include #include +#include #include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include + +#include +#include +#include namespace xrpl { diff --git a/src/xrpld/app/ledger/detail/LocalTxs.cpp b/src/xrpld/app/ledger/detail/LocalTxs.cpp index 8f04da9c2d..5326568e35 100644 --- a/src/xrpld/app/ledger/detail/LocalTxs.cpp +++ b/src/xrpld/app/ledger/detail/LocalTxs.cpp @@ -1,7 +1,19 @@ #include -#include +#include +#include +#include +#include #include +#include +#include +#include + +#include +#include +#include +#include +#include /* This code prevents scenarios like the following: @@ -94,7 +106,7 @@ public: void push_back(LedgerIndex index, std::shared_ptr const& txn) override { - std::lock_guard lock(m_lock); + std::lock_guard const lock(m_lock); m_txns.emplace_back(index, txn); } @@ -107,7 +119,7 @@ public: // Get the set of local transactions as a canonical // set (so they apply in a valid order) { - std::lock_guard lock(m_lock); + std::lock_guard const lock(m_lock); for (auto const& it : m_txns) tset.insert(it.getTX()); @@ -121,7 +133,7 @@ public: void sweep(ReadView const& view) override { - std::lock_guard lock(m_lock); + std::lock_guard const lock(m_lock); m_txns.remove_if([&view](auto const& txn) { if (txn.isExpired(view.header().seq)) @@ -158,7 +170,7 @@ public: std::size_t size() override { - std::lock_guard lock(m_lock); + std::lock_guard const lock(m_lock); return m_txns.size(); } diff --git a/src/xrpld/app/ledger/detail/OpenLedger.cpp b/src/xrpld/app/ledger/detail/OpenLedger.cpp index da35a72bbc..5db4e23e1e 100644 --- a/src/xrpld/app/ledger/detail/OpenLedger.cpp +++ b/src/xrpld/app/ledger/detail/OpenLedger.cpp @@ -1,17 +1,39 @@ #include + #include #include #include -#include #include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include +#include + +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { OpenLedger::OpenLedger( @@ -25,26 +47,26 @@ OpenLedger::OpenLedger( bool OpenLedger::empty() const { - std::lock_guard lock(modify_mutex_); + std::lock_guard const lock(modify_mutex_); return current_->txCount() == 0; } std::shared_ptr OpenLedger::current() const { - std::lock_guard lock(current_mutex_); + std::lock_guard const lock(current_mutex_); return current_; } bool OpenLedger::modify(modify_type const& f) { - std::lock_guard lock1(modify_mutex_); + std::lock_guard const lock1(modify_mutex_); auto next = std::make_shared(*current_); auto const changed = f(*next, j_); if (changed) { - std::lock_guard lock2(current_mutex_); + std::lock_guard const lock2(current_mutex_); current_ = std::move(next); } return changed; @@ -73,7 +95,7 @@ OpenLedger::accept( // Block calls to modify, otherwise // new tx going into the open ledger // would get lost. - std::lock_guard lock1(modify_mutex_); + std::lock_guard const lock1(modify_mutex_); // Apply tx from the current open view if (!current_->txs.empty()) { @@ -131,7 +153,7 @@ OpenLedger::accept( } // Switch to the new open view - std::lock_guard lock2(current_mutex_); + std::lock_guard const lock2(current_mutex_); current_ = std::move(next); } diff --git a/src/xrpld/app/ledger/detail/SkipListAcquire.cpp b/src/xrpld/app/ledger/detail/SkipListAcquire.cpp index 3a60fbdc6d..559a075c57 100644 --- a/src/xrpld/app/ledger/detail/SkipListAcquire.cpp +++ b/src/xrpld/app/ledger/detail/SkipListAcquire.cpp @@ -1,9 +1,30 @@ +#include + #include #include -#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include + +#include +#include +#include +#include +#include + namespace xrpl { SkipListAcquire::SkipListAcquire( @@ -151,7 +172,7 @@ SkipListAcquire::addDataCallback(OnSkipListDataCB&& cb) std::shared_ptr SkipListAcquire::getData() const { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); return data_; } diff --git a/src/xrpld/app/ledger/detail/TimeoutCounter.cpp b/src/xrpld/app/ledger/detail/TimeoutCounter.cpp index e2d4409717..9cf58bee47 100644 --- a/src/xrpld/app/ledger/detail/TimeoutCounter.cpp +++ b/src/xrpld/app/ledger/detail/TimeoutCounter.cpp @@ -1,7 +1,19 @@ #include +#include + +#include +#include +#include +#include #include +#include +#include + +#include +#include + namespace xrpl { using namespace std::chrono_literals; @@ -15,10 +27,6 @@ TimeoutCounter::TimeoutCounter( : app_(app) , journal_(journal) , hash_(hash) - , timeouts_(0) - , complete_(false) - , failed_(false) - , progress_(false) , timerInterval_(interval) , queueJobParameter_(std::move(jobParameter)) , timer_(app_.getIOContext()) @@ -96,7 +104,7 @@ TimeoutCounter::invokeOnTimer() void TimeoutCounter::cancel() { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); if (!isDone()) { failed_ = true; diff --git a/src/xrpld/app/ledger/detail/TimeoutCounter.h b/src/xrpld/app/ledger/detail/TimeoutCounter.h index 5f5ccb2f43..a7e4c043be 100644 --- a/src/xrpld/app/ledger/detail/TimeoutCounter.h +++ b/src/xrpld/app/ledger/detail/TimeoutCounter.h @@ -59,6 +59,8 @@ public: virtual void cancel(); + virtual ~TimeoutCounter() = default; + protected: using ScopedLockType = std::unique_lock; @@ -76,8 +78,6 @@ protected: QueueJobParameter&& jobParameter, beast::Journal journal); - virtual ~TimeoutCounter() = default; - /** Schedule a call to queueJob() after mTimerInterval. */ void setTimer(ScopedLockType&); @@ -109,11 +109,11 @@ protected: /** The hash of the object (in practice, always a ledger) we are trying to * fetch. */ uint256 const hash_; - int timeouts_; - bool complete_; - bool failed_; + int timeouts_{0}; + bool complete_{false}; + bool failed_{false}; /** Whether forward progress has been made. */ - bool progress_; + bool progress_{false}; /** The minimum time to wait between calls to execute(). */ std::chrono::milliseconds timerInterval_; diff --git a/src/xrpld/app/ledger/detail/TransactionAcquire.cpp b/src/xrpld/app/ledger/detail/TransactionAcquire.cpp index 9cf35b93dc..7cdee8aedd 100644 --- a/src/xrpld/app/ledger/detail/TransactionAcquire.cpp +++ b/src/xrpld/app/ledger/detail/TransactionAcquire.cpp @@ -1,13 +1,28 @@ -#include -#include -#include #include -#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include +#include +#include +#include + +#include #include +#include +#include #include +#include +#include namespace xrpl { @@ -31,10 +46,9 @@ TransactionAcquire::TransactionAcquire( TX_ACQUIRE_TIMEOUT, {jtTXN_DATA, "TxAcq", {}}, app.getJournal("TransactionAcquire")) - , mHaveRoot(false) , mPeerSet(std::move(peerSet)) { - mMap = std::make_shared(SHAMapType::TRANSACTION, hash, app_.getNodeFamily()); + mMap = std::make_shared(SHAMapType::TRANSACTION, hash, app.getNodeFamily()); mMap->setUnbacked(); } @@ -162,7 +176,7 @@ TransactionAcquire::takeNodes( std::vector> const& data, std::shared_ptr const& peer) { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); if (complete_) { @@ -241,7 +255,7 @@ TransactionAcquire::init(int numPeers) void TransactionAcquire::stillNeed() { - ScopedLockType sl(mtx_); + ScopedLockType const sl(mtx_); timeouts_ = std::min(timeouts_, NORM_TIMEOUTS); failed_ = false; diff --git a/src/xrpld/app/ledger/detail/TransactionAcquire.h b/src/xrpld/app/ledger/detail/TransactionAcquire.h index a39f6a2f35..1fa6d0ec6f 100644 --- a/src/xrpld/app/ledger/detail/TransactionAcquire.h +++ b/src/xrpld/app/ledger/detail/TransactionAcquire.h @@ -1,5 +1,6 @@ #pragma once +#include #include #include @@ -31,7 +32,7 @@ public: private: std::shared_ptr mMap; - bool mHaveRoot; + bool mHaveRoot{false}; std::unique_ptr mPeerSet; void diff --git a/src/xrpld/app/ledger/detail/TransactionMaster.cpp b/src/xrpld/app/ledger/detail/TransactionMaster.cpp index 4be3c95993..798c29dc05 100644 --- a/src/xrpld/app/ledger/detail/TransactionMaster.cpp +++ b/src/xrpld/app/ledger/detail/TransactionMaster.cpp @@ -1,10 +1,29 @@ #include + #include #include -#include +#include +#include // IWYU pragma: keep +#include #include +#include +#include #include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { diff --git a/src/xrpld/app/main/Application.cpp b/src/xrpld/app/main/Application.cpp index 0d8325be54..ada0ec52ff 100644 --- a/src/xrpld/app/main/Application.cpp +++ b/src/xrpld/app/main/Application.cpp @@ -1,16 +1,20 @@ +#include + #include +#include #include #include #include #include #include +#include #include #include #include #include #include -#include #include +#include #include #include #include @@ -22,53 +26,109 @@ #include #include #include +#include #include #include #include #include #include +#include +#include +#include +#include #include +#include #include +#include #include +#include #include #include +#include +#include +#include +#include #include #include #include +#include +#include +#include +#include +#include #include +#include +#include #include #include +#include #include +#include #include +#include #include +#include +#include #include +#include #include +#include +#include #include #include #include #include #include +#include +#include #include +#include +#include #include +#include #include +#include #include +#include +#include +#include +#include +#include #include #include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include #include +#include +#include #include -#include +#include +#include #include +#include #include +#include +#include +#include #include -#include +#include #include +#include +#include +#include #include +#include namespace xrpl { @@ -1399,7 +1459,7 @@ ApplicationImp::setup(boost::program_options::variables_map const& cmdline) "implications and have"; JLOG(m_journal.warn()) << "*** been deprecated. They will be removed " "in a future release of"; - JLOG(m_journal.warn()) << "*** rippled."; + JLOG(m_journal.warn()) << "*** xrpld."; JLOG(m_journal.warn()) << "*** If you do not use them to sign " "transactions please edit your"; JLOG(m_journal.warn()) << "*** configuration file and remove the [enable_signing] stanza."; @@ -1811,7 +1871,7 @@ ApplicationImp::loadLedgerFromFile(std::string const& name) // VFALCO TODO This is the only place that // constructor is used, try to remove it - STLedgerEntry sle(*stp.object, uIndex); + STLedgerEntry const sle(*stp.object, uIndex); if (!loadLedger->addSLE(sle)) { @@ -1949,7 +2009,7 @@ ApplicationImp::loadOldLedger( << " UTC.\n" "This replay will not handle your ledger as it was " "originally " - "handled.\nConsider running an earlier version of rippled " + "handled.\nConsider running an earlier version of xrpld " "to " "get the older rules.\n*** CONTINUING ***\n"; } diff --git a/src/xrpld/app/main/Application.h b/src/xrpld/app/main/Application.h index 9c79aabb02..d0437be9a6 100644 --- a/src/xrpld/app/main/Application.h +++ b/src/xrpld/app/main/Application.h @@ -16,18 +16,9 @@ namespace xrpl { -namespace unl { -class Manager; -} -namespace Resource { -class Manager; -} -namespace NodeStore { -class Database; -} // namespace NodeStore namespace perf { class PerfLog; -} +} // namespace perf // VFALCO TODO Fix forward declares required for header dependency loops class AmendmentTable; diff --git a/src/xrpld/app/main/BasicApp.cpp b/src/xrpld/app/main/BasicApp.cpp index 2c5a2b0364..9de7dc53d3 100644 --- a/src/xrpld/app/main/BasicApp.cpp +++ b/src/xrpld/app/main/BasicApp.cpp @@ -4,6 +4,9 @@ #include +#include +#include + BasicApp::BasicApp(std::size_t numberOfThreads) { work_.emplace(boost::asio::make_work_guard(io_context_)); diff --git a/src/xrpld/app/main/CollectorManager.cpp b/src/xrpld/app/main/CollectorManager.cpp index 353a49de91..0b716558af 100644 --- a/src/xrpld/app/main/CollectorManager.cpp +++ b/src/xrpld/app/main/CollectorManager.cpp @@ -1,6 +1,16 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include + #include +#include namespace xrpl { diff --git a/src/xrpld/app/main/GRPCServer.cpp b/src/xrpld/app/main/GRPCServer.cpp index 130d0f01b9..e2592c8216 100644 --- a/src/xrpld/app/main/GRPCServer.cpp +++ b/src/xrpld/app/main/GRPCServer.cpp @@ -1,9 +1,55 @@ #include -#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include #include +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -16,8 +62,8 @@ getEndpoint(std::string const& peer) { try { - std::size_t first = peer.find_first_of(':'); - std::size_t last = peer.find_last_of(':'); + std::size_t const first = peer.find_first_of(':'); + std::size_t const last = peer.find_last_of(':'); std::string peerClean(peer); if (first != last) { @@ -88,7 +134,7 @@ GRPCServerImpl::CallData::process() // sanity check BOOST_ASSERT(!finished_); - std::shared_ptr> thisShared = this->shared_from_this(); + std::shared_ptr> const thisShared = this->shared_from_this(); // Need to set finished to true before processing the response, // because as soon as the response is posted to the completion @@ -107,7 +153,7 @@ GRPCServerImpl::CallData::process() // If coro is null, then the JobQueue has already been shutdown if (!coro) { - grpc::Status status{grpc::StatusCode::INTERNAL, "Job Queue is already stopped"}; + grpc::Status const status{grpc::StatusCode::INTERNAL, "Job Queue is already stopped"}; responder_.FinishWithError(status, this); } } @@ -119,10 +165,10 @@ GRPCServerImpl::CallData::process(std::shared_ptr::process(std::shared_ptr::process(std::shared_ptr("Error parsing secure_gateway section"); } } + + // Read TLS certificate configuration (optional) + sslCertPath_ = section.get("ssl_cert"); + sslKeyPath_ = section.get("ssl_key"); + sslCertChainPath_ = section.get("ssl_cert_chain"); + sslClientCAPath_ = section.get("ssl_client_ca"); + + // If cert or key is specified, both must be specified + if (sslCertPath_.has_value() || sslKeyPath_.has_value()) + { + if (!sslCertPath_.has_value() || !sslKeyPath_.has_value()) + { + JLOG(journal_.error()) + << "Both ssl_cert and ssl_key must be specified for gRPC TLS"; + Throw("Incomplete TLS configuration for gRPC"); + } + JLOG(journal_.info()) << "gRPC TLS enabled with certificate: " << *sslCertPath_; + } + + // Validate TLS configuration consistency: ssl_cert_chain only makes sense when TLS is + // enabled + if (sslCertChainPath_.has_value() && + (!sslCertPath_.has_value() || !sslKeyPath_.has_value())) + { + JLOG(journal_.error()) + << "ssl_cert_chain specified for gRPC without both ssl_cert and ssl_key; " + << "this is an invalid TLS configuration"; + Throw( + "Invalid gRPC TLS configuration: ssl_cert_chain requires both ssl_cert and " + "ssl_key"); + } + + // Validate TLS configuration consistency: ssl_client_ca only makes sense when TLS is + // enabled + if (sslClientCAPath_.has_value() && (!sslCertPath_.has_value() || !sslKeyPath_.has_value())) + { + JLOG(journal_.error()) + << "ssl_client_ca specified for gRPC without both ssl_cert and ssl_key; " + << "this is an invalid TLS configuration"; + Throw( + "Invalid gRPC TLS configuration: ssl_client_ca requires both ssl_cert and ssl_key"); + } } } @@ -514,6 +602,104 @@ GRPCServerImpl::setupListeners() return requests; } +std::shared_ptr +GRPCServerImpl::createServerCredentials() +{ + if (not sslCertPath_.has_value() or not sslKeyPath_.has_value()) + { + JLOG(journal_.info()) << "Configuring gRPC server without TLS"; + return grpc::InsecureServerCredentials(); + } + + JLOG(journal_.info()) << "Configuring gRPC server with TLS"; + + try + { + boost::system::error_code ec; + grpc::SslServerCredentialsOptions sslOpts; + grpc::SslServerCredentialsOptions::PemKeyCertPair keyCertPair; + + std::string const certContents = getFileContents(ec, *sslCertPath_); + if (ec) + { + JLOG(journal_.error()) << "Failed to read gRPC SSL certificate file: " << *sslCertPath_ + << " - " << ec.message(); // LCOV_EXCL_LINE + return nullptr; + } + + std::string const keyContents = getFileContents(ec, *sslKeyPath_); + if (ec) + { + JLOG(journal_.error()) << "Failed to read gRPC SSL key file: " << *sslKeyPath_ << " - " + << ec.message(); // LCOV_EXCL_LINE + return nullptr; + } + + keyCertPair.private_key = keyContents; + + // Read intermediate CA certificates for server certificate chain (optional) + std::string certChainContents; + if (sslCertChainPath_.has_value()) + { + certChainContents = getFileContents(ec, *sslCertChainPath_); + if (ec) + { + JLOG(journal_.error()) + << "Failed to read gRPC SSL cert chain file: " << *sslCertChainPath_ << " - " + << ec.message(); // LCOV_EXCL_LINE + return nullptr; + } + } + + // Read CA certificate for client verification (mTLS, optional) + if (sslClientCAPath_.has_value()) + { + auto const clientCAContents = getFileContents(ec, *sslClientCAPath_); + if (ec) + { + JLOG(journal_.error()) + << "Failed to read gRPC SSL client CA file: " << *sslClientCAPath_ << " - " + << ec.message(); // LCOV_EXCL_LINE + return nullptr; + } + + if (clientCAContents.empty()) + { + JLOG(journal_.error()) + << "Empty/truncated gRPC SSL client CA file: " << *sslClientCAPath_ + << " - failed to configure mutual TLS"; // LCOV_EXCL_LINE + return nullptr; + } + + sslOpts.pem_root_certs = clientCAContents; + sslOpts.client_certificate_request = + GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY; + JLOG(journal_.info()) << "gRPC mutual TLS enabled - client certificates will be " + "required and verified"; + } + + // Combine server cert with intermediate CA certs for complete chain + keyCertPair.cert_chain = certContents; + if (!certChainContents.empty()) + { + keyCertPair.cert_chain += '\n' + certChainContents; + JLOG(journal_.info()) << "gRPC server certificate chain configured with " + "intermediate CA certificates"; // LCOV_EXCL_LINE + } + + sslOpts.pem_key_cert_pairs.push_back(keyCertPair); + + JLOG(journal_.info()) << "gRPC TLS credentials configured successfully"; // LCOV_EXCL_LINE + return grpc::SslServerCredentials(sslOpts); + } + catch (std::exception const& e) + { + JLOG(journal_.error()) << "Exception while configuring gRPC TLS: " + << e.what(); // LCOV_EXCL_LINE + return nullptr; + } +} + bool GRPCServerImpl::start() { @@ -521,24 +707,63 @@ GRPCServerImpl::start() if (serverAddress_.empty()) return false; - JLOG(journal_.info()) << "Starting gRPC server at " << serverAddress_; + // Determine TLS mode for logging + bool const tlsEnabled = sslCertPath_.has_value() && sslKeyPath_.has_value(); + bool const mtlsEnabled = tlsEnabled && sslClientCAPath_.has_value(); + + std::string tlsMode = "without TLS"; + if (mtlsEnabled) + { + tlsMode = "with mutual TLS (mTLS)"; + } + else if (tlsEnabled) + { + tlsMode = "with TLS"; + } + + JLOG(journal_.info()) << "Starting gRPC server at " << serverAddress_ << " " + << tlsMode; // LCOV_EXCL_LINE grpc::ServerBuilder builder; - - // Listen on the given address without any authentication mechanism. - // Actually binded port will be returned into "port" variable. int port = 0; - builder.AddListeningPort(serverAddress_, grpc::InsecureServerCredentials(), &port); + + // Create credentials (TLS or insecure) based on configuration + auto credentials = createServerCredentials(); + if (!credentials) + { + JLOG(journal_.error()) << "Failed to create gRPC server credentials for " << serverAddress_ + << " (TLS mode: " << tlsMode + << ") - server will not start"; // LCOV_EXCL_LINE + return false; + } + + // Add listening port with appropriate credentials + builder.AddListeningPort(serverAddress_, credentials, &port); + // Register "service_" as the instance through which we'll communicate with // clients. In this case it corresponds to an *asynchronous* service. builder.RegisterService(&service_); + // Get hold of the completion queue used for the asynchronous communication // with the gRPC runtime. cq_ = builder.AddCompletionQueue(); + // Finally assemble the server. server_ = builder.BuildAndStart(); serverPort_ = static_cast(port); + if (serverPort_ != 0u) + { + JLOG(journal_.info()) << "gRPC server started successfully on port " << serverPort_; + } + else + { + JLOG(journal_.error()) + << "Failed to start gRPC server at " << serverAddress_ << " (TLS mode: " << tlsMode + << "); Possible causes: address already in use, invalid address format, or permission " + "denied"; // LCOV_EXCL_LINE + } + return static_cast(serverPort_); } @@ -557,7 +782,7 @@ GRPCServer::start() { thread_ = std::thread([this]() { // Start the event loop and begin handling requests - beast::setCurrentThreadName("rippled: grpc"); + beast::setCurrentThreadName("xrpld: grpc"); this->impl_.handleRpcs(); }); } diff --git a/src/xrpld/app/main/GRPCServer.h b/src/xrpld/app/main/GRPCServer.h index 037c91df93..178062df55 100644 --- a/src/xrpld/app/main/GRPCServer.h +++ b/src/xrpld/app/main/GRPCServer.h @@ -66,6 +66,13 @@ private: std::vector secureGatewayIPs_; + // TLS certificate paths + std::optional sslCertPath_; + std::optional sslKeyPath_; + std::optional sslCertChainPath_; // Intermediate CA certs for server cert chain + std::optional + sslClientCAPath_; // CA cert for client certificate verification (mTLS) + beast::Journal journal_; // typedef for function to bind a listener @@ -124,6 +131,10 @@ public: getEndpoint() const; private: + // Create server credentials (TLS or insecure) based on configuration + std::shared_ptr + createServerCredentials(); + // Class encompassing the state and logic needed to serve a request. template class CallData : public Processor, @@ -234,14 +245,14 @@ private: getClientEndpoint(); // If the request was proxied through - // another rippled node, returns the ip of the originating client. + // another xrpld node, returns the ip of the originating client. // Empty optional if request was not proxied or there was an error // decoding the client ip std::optional getProxiedClientIpAddress(); // If the request was proxied through - // another rippled node, returns the endpoint of the originating client. + // another xrpld node, returns the endpoint of the originating client. // Empty optional if request was not proxied or there was an error // decoding the client endpoint std::optional @@ -261,7 +272,7 @@ private: bool clientIsUnlimited(); - // True if the request was proxied through another rippled node prior + // True if the request was proxied through another xrpld node prior // to arriving here bool wasForwarded(); diff --git a/src/xrpld/app/main/LoadManager.cpp b/src/xrpld/app/main/LoadManager.cpp index f0fc4085ac..84c57ad360 100644 --- a/src/xrpld/app/main/LoadManager.cpp +++ b/src/xrpld/app/main/LoadManager.cpp @@ -1,11 +1,18 @@ -#include #include +#include + +#include +#include #include -#include +#include +#include +#include // IWYU pragma: keep #include #include +#include +#include #include #include #include @@ -35,7 +42,7 @@ LoadManager::~LoadManager() void LoadManager::activateStallDetector() { - std::lock_guard sl(mutex_); + std::lock_guard const sl(mutex_); armed_ = true; lastHeartbeat_ = std::chrono::steady_clock::now(); } @@ -44,7 +51,7 @@ void LoadManager::heartbeat() { auto const heartbeat = std::chrono::steady_clock::now(); - std::lock_guard sl(mutex_); + std::lock_guard const sl(mutex_); lastHeartbeat_ = heartbeat; } @@ -63,7 +70,7 @@ void LoadManager::stop() { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); stop_ = true; // There is at most one thread waiting on this condition. cv_.notify_all(); diff --git a/src/xrpld/app/main/LoadManager.h b/src/xrpld/app/main/LoadManager.h index c36afb1804..3ae1f45e3b 100644 --- a/src/xrpld/app/main/LoadManager.h +++ b/src/xrpld/app/main/LoadManager.h @@ -3,6 +3,7 @@ #include #include +#include #include #include #include diff --git a/src/xrpld/app/main/Main.cpp b/src/xrpld/app/main/Main.cpp index 570131b52d..ecd0cfc913 100644 --- a/src/xrpld/app/main/Main.cpp +++ b/src/xrpld/app/main/Main.cpp @@ -5,28 +5,48 @@ #include #include +#include +#include #include +#include +#include +#include +#include #include #include +#include #include -#include +#include +#include +#include #include -#include +#include // IWYU pragma: keep #include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include #ifdef ENABLE_TESTS #include #include #endif // ENABLE_TESTS -#include -#include #include #include -#include #include #include @@ -49,7 +69,7 @@ #endif #ifdef ENABLE_VOIDSTAR -#include "antithesis_instrumentation.h" +#include #endif namespace po = boost::program_options; @@ -215,7 +235,7 @@ public: namespace test { extern std::atomic envUseIPv4; -} +} // namespace test template static bool @@ -257,11 +277,11 @@ runUnitTests( if (!child && num_jobs == 1) { - multi_runner_parent parent_runner; + multi_runner_parent const parent_runner; multi_runner_child child_runner{num_jobs, quiet, log}; child_runner.arg(argument); - multi_selector pred(pattern); + multi_selector const pred(pattern); auto const any_failed = child_runner.run_multi(pred) || anyMissing(child_runner, pred); if (any_failed) @@ -470,8 +490,8 @@ run(int argc, char** argv) } catch (std::exception const& ex) { - std::cerr << "rippled: " << ex.what() << std::endl; - std::cerr << "Try 'rippled --help' for a list of options." << std::endl; + std::cerr << "xrpld: " << ex.what() << std::endl; + std::cerr << "Try 'xrpld --help' for a list of options." << std::endl; return 1; } @@ -483,7 +503,7 @@ run(int argc, char** argv) if (vm.contains("version")) { - std::cout << "rippled version " << BuildInfo::getVersionString() << std::endl; + std::cout << "xrpld version " << BuildInfo::getVersionString() << std::endl; std::cout << "Git commit hash: " << xrpl::git::getCommitHash() << std::endl; std::cout << "Git build branch: " << xrpl::git::getBuildBranch() << std::endl; return 0; @@ -492,8 +512,8 @@ run(int argc, char** argv) #ifndef ENABLE_TESTS if (vm.count("unittest") || vm.count("unittest-child")) { - std::cerr << "rippled: Tests disabled in this build." << std::endl; - std::cerr << "Try 'rippled --help' for a list of options." << std::endl; + std::cerr << "xrpld: Tests disabled in this build." << std::endl; + std::cerr << "Try 'xrpld --help' for a list of options." << std::endl; return 1; } #else @@ -529,7 +549,7 @@ run(int argc, char** argv) if (vm.contains("unittest-jobs")) { // unittest jobs only makes sense with `unittest` - std::cerr << "rippled: '--unittest-jobs' specified without " + std::cerr << "xrpld: '--unittest-jobs' specified without " "'--unittest'.\n"; std::cerr << "To run the unit tests the '--unittest' option must " "be present.\n"; @@ -793,7 +813,7 @@ run(int argc, char** argv) } // We have an RPC command to process: - beast::setCurrentThreadName("rippled: rpc"); + beast::setCurrentThreadName("xrpld: rpc"); return RPCCall::fromCommandLine( *config, vm["parameters"].as>(), *logs); // LCOV_EXCL_STOP diff --git a/src/xrpld/app/main/NodeIdentity.cpp b/src/xrpld/app/main/NodeIdentity.cpp index bc2c943b10..f52e7e372e 100644 --- a/src/xrpld/app/main/NodeIdentity.cpp +++ b/src/xrpld/app/main/NodeIdentity.cpp @@ -1,10 +1,22 @@ -#include #include + +#include #include #include +#include +#include +#include +#include #include +#include + +#include +#include +#include +#include + namespace xrpl { std::pair diff --git a/src/xrpld/app/main/NodeStoreScheduler.cpp b/src/xrpld/app/main/NodeStoreScheduler.cpp index 1ca8e80523..2aebe40252 100644 --- a/src/xrpld/app/main/NodeStoreScheduler.cpp +++ b/src/xrpld/app/main/NodeStoreScheduler.cpp @@ -1,5 +1,10 @@ #include +#include +#include +#include +#include + namespace xrpl { NodeStoreScheduler::NodeStoreScheduler(JobQueue& jobQueue) : jobQueue_(jobQueue) diff --git a/src/xrpld/app/misc/DeliverMax.h b/src/xrpld/app/misc/DeliverMax.h index 1b4241f091..7fec517d28 100644 --- a/src/xrpld/app/misc/DeliverMax.h +++ b/src/xrpld/app/misc/DeliverMax.h @@ -4,7 +4,7 @@ namespace Json { class Value; -} +} // namespace Json namespace xrpl { diff --git a/src/xrpld/app/misc/FeeEscalation.md b/src/xrpld/app/misc/FeeEscalation.md index 7843620320..5a3edbe95a 100644 --- a/src/xrpld/app/misc/FeeEscalation.md +++ b/src/xrpld/app/misc/FeeEscalation.md @@ -1,6 +1,6 @@ # Fees -Rippled's fee mechanism consists of several interrelated processes: +Xrpld's fee mechanism consists of several interrelated processes: 1. [Rapid Fee escalation](#fee-escalation) 2. [The Transaction Queue](#transaction-queue) @@ -184,7 +184,7 @@ than a more complex transaction paying more XRP. ### Load Fee -Each rippled server maintains a minimum cost threshold based on its current load. If you submit a transaction with a fee that is lower than the current load-based transaction cost of the rippled server, the server neither applies nor relays the transaction to its peers. A transaction is very unlikely to survive the consensus process unless its transaction fee value meets the requirements of a majority of servers. +Each xrpld server maintains a minimum cost threshold based on its current load. If you submit a transaction with a fee that is lower than the current load-based transaction cost of the xrpld server, the server neither applies nor relays the transaction to its peers. A transaction is very unlikely to survive the consensus process unless its transaction fee value meets the requirements of a majority of servers. ### Reference Transaction @@ -193,7 +193,7 @@ single-signed transaction (eg. Payment, Account Set, Offer Create, etc) that requires a fee. In the future, there may be other transaction types that require -more (or less) work for rippled to process. Those transactions may have +more (or less) work for xrpld to process. Those transactions may have a higher (or lower) base fee, requiring a correspondingly higher (or lower) fee to get into the same position as a reference transaction. @@ -211,7 +211,7 @@ Another factor to consider is the duration of the consensus process itself. This generally takes under 5 seconds on the main network under low volume. This is based on historical observations. However factors such as transaction volume -can increase consensus duration. This is because rippled performs +can increase consensus duration. This is because xrpld performs more work as transaction volume increases. Under sufficient load this tends to increase consensus duration. It's possible that relatively high consensus duration indicates a problem, but it is not appropriate to @@ -293,7 +293,7 @@ values by 5 for a multi-signed transaction with 4 signatures.) The `fee` result is always instantaneous, and relates to the open ledger. It includes the sequence number of the current open ledger, -but may not make sense if rippled is not synced to the network. +but may not make sense if xrpld is not synced to the network. Result format: diff --git a/src/xrpld/app/misc/FeeVoteImpl.cpp b/src/xrpld/app/misc/FeeVoteImpl.cpp index 450e53e86c..53e56286b8 100644 --- a/src/xrpld/app/misc/FeeVoteImpl.cpp +++ b/src/xrpld/app/misc/FeeVoteImpl.cpp @@ -1,10 +1,31 @@ #include #include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -255,7 +276,7 @@ FeeVoteImpl::doVoting( JLOG(journal_.warn()) << "We are voting for a fee change: " << baseFee.first << "/" << baseReserve.first << "/" << incReserve.first; - STTx feeTx(ttFEE, [=, &rules](auto& obj) { + STTx const feeTx(ttFEE, [=, &rules](auto& obj) { obj[sfAccount] = AccountID(); obj[sfLedgerSequence] = seq; if (rules.enabled(featureXRPFees)) @@ -277,7 +298,7 @@ FeeVoteImpl::doVoting( } }); - uint256 txID = feeTx.getTransactionID(); + uint256 const txID = feeTx.getTransactionID(); JLOG(journal_.warn()) << "Vote: " << txID; diff --git a/src/xrpld/app/misc/NegativeUNLVote.cpp b/src/xrpld/app/misc/NegativeUNLVote.cpp index fe031749bc..8db726ff48 100644 --- a/src/xrpld/app/misc/NegativeUNLVote.cpp +++ b/src/xrpld/app/misc/NegativeUNLVote.cpp @@ -1,8 +1,31 @@ -#include #include +#include + +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -90,7 +113,7 @@ NegativeUNLVote::addTx( NegativeUNLModify modify, std::shared_ptr const& initialSet) { - STTx negUnlTx(ttUNL_MODIFY, [&](auto& obj) { + STTx const negUnlTx(ttUNL_MODIFY, [&](auto& obj) { obj.setFieldU8(sfUNLModifyDisabling, modify == ToDisable ? 1 : 0); obj.setFieldU32(sfLedgerSequence, seq); obj.setFieldVL(sfUNLModifyValidator, vp.slice()); @@ -118,7 +141,7 @@ NegativeUNLVote::choose(uint256 const& randomPadData, std::vector const& { XRPL_ASSERT(!candidates.empty(), "xrpl::NegativeUNLVote::choose : non-empty input"); static_assert(NodeID::bytes <= uint256::bytes); - NodeID randomPad = NodeID::fromVoid(randomPadData.data()); + NodeID const randomPad = NodeID::fromVoid(randomPadData.data()); NodeID txNodeID = candidates[0]; for (int j = 1; j < candidates.size(); ++j) { @@ -285,7 +308,7 @@ NegativeUNLVote::findAllCandidates( void NegativeUNLVote::newValidators(LedgerIndex seq, hash_set const& nowTrusted) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); for (auto const& n : nowTrusted) { if (!newValidators_.contains(n)) @@ -299,7 +322,7 @@ NegativeUNLVote::newValidators(LedgerIndex seq, hash_set const& nowTrust void NegativeUNLVote::purgeNewValidators(LedgerIndex seq) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto i = newValidators_.begin(); while (i != newValidators_.end()) { diff --git a/src/xrpld/app/misc/NetworkOPs.cpp b/src/xrpld/app/misc/NetworkOPs.cpp index b323541362..3e2ee22914 100644 --- a/src/xrpld/app/misc/NetworkOPs.cpp +++ b/src/xrpld/app/misc/NetworkOPs.cpp @@ -1,7 +1,10 @@ +#include + #include #include #include #include +#include #include #include #include @@ -11,17 +14,19 @@ #include #include #include +#include #include #include #include #include -#include #include #include -#include #include +#include +#include #include #include +#include #include #include #include @@ -30,47 +35,122 @@ #include #include +#include +#include +#include #include +#include +#include +#include #include #include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include #include #include +#include #include #include #include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include #include #include #include +#include +#include +#include #include +#include #include +#include +#include +#include +#include #include #include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include #include +#include +#include #include +#include #include +#include #include +#include +#include #include +#include +#include #include #include +#include +#include +#include + +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include #include #include #include +#include #include -#include +#include +#include #include +#include +#include namespace xrpl { @@ -177,7 +257,7 @@ class NetworkOPsImp final : public NetworkOPs CounterData getCounterData() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return {counters_, mode_, start_, initialSyncUs_}; } }; @@ -1079,7 +1159,7 @@ NetworkOPsImp::processClusterTimer() n.set_nodename(node.name()); }); - Resource::Gossip gossip = registry_.get().getResourceManager().exportConsumers(); + Resource::Gossip const gossip = registry_.get().getResourceManager().exportConsumers(); for (auto& item : gossip.items) { protocol::TMLoadSource& node = *cluster.add_loadsources(); @@ -1249,7 +1329,7 @@ NetworkOPsImp::doTransactionAsync( bool bUnlimited, FailHard failType) { - std::lock_guard lock(mMutex); + std::lock_guard const lock(mMutex); if (transaction->getApplying()) return; @@ -1441,7 +1521,7 @@ NetworkOPsImp::apply(std::unique_lock& batchLock) validatedLedgerIndex = l->header().seq; auto newOL = registry_.get().getOpenLedger().current(); - for (TransactionStatus& e : transactions) + for (TransactionStatus const& e : transactions) { e.transaction->clearSubmitResult(); @@ -1471,7 +1551,7 @@ NetworkOPsImp::apply(std::unique_lock& batchLock) } #endif - bool addLocal = e.local; + bool const addLocal = e.local; if (isTesSuccess(e.result)) { @@ -1620,7 +1700,7 @@ NetworkOPsImp::apply(std::unique_lock& batchLock) batchLock.lock(); - for (TransactionStatus& e : transactions) + for (TransactionStatus const& e : transactions) e.transaction->clearApplying(); if (!submit_held.empty()) @@ -1782,7 +1862,7 @@ NetworkOPsImp::checkLastClosedLedger(Overlay::PeerSequence const& peerList, uint return false; uint256 closedLedger = ourClosed->header().hash; - uint256 prevClosedLedger = ourClosed->header().parentHash; + uint256 const prevClosedLedger = ourClosed->header().parentHash; JLOG(m_journal.trace()) << "OurClosed: " << closedLedger; JLOG(m_journal.trace()) << "PrevClosed: " << prevClosedLedger; @@ -1800,7 +1880,7 @@ NetworkOPsImp::checkLastClosedLedger(Overlay::PeerSequence const& peerList, uint for (auto& peer : peerList) { - uint256 peerLedger = peer->getClosedLedgerHash(); + uint256 const peerLedger = peer->getClosedLedgerHash(); if (peerLedger.isNonZero()) ++peerCounts[peerLedger]; @@ -1809,7 +1889,7 @@ NetworkOPsImp::checkLastClosedLedger(Overlay::PeerSequence const& peerList, uint for (auto const& it : peerCounts) JLOG(m_journal.debug()) << "L: " << it.first << " n=" << it.second; - uint256 preferredLCL = validations.getPreferredLCL( + uint256 const preferredLCL = validations.getPreferredLCL( RCLValidatedLedger{ourClosed, validations.adaptor().journal()}, m_ledgerMaster.getValidLedgerIndex(), peerCounts); @@ -2042,7 +2122,7 @@ NetworkOPsImp::mapComplete(std::shared_ptr const& map, bool fromAcquire) void NetworkOPsImp::endConsensus(std::unique_ptr const& clog) { - uint256 deadLedger = m_ledgerMaster.getClosedLedger()->header().parentHash; + uint256 const deadLedger = m_ledgerMaster.getClosedLedger()->header().parentHash; for (auto const& it : registry_.get().getOverlay().getActivePeers()) { if (it && (it->getClosedLedgerHash() == deadLedger)) @@ -2053,7 +2133,7 @@ NetworkOPsImp::endConsensus(std::unique_ptr const& clog) } uint256 networkClosed; - bool ledgerChange = + bool const ledgerChange = checkLastClosedLedger(registry_.get().getOverlay().getActivePeers(), networkClosed); if (networkClosed.isZero()) @@ -2107,7 +2187,7 @@ void NetworkOPsImp::pubManifest(Manifest const& mo) { // VFALCO consider std::shared_mutex - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); if (!mStreamMaps[sManifests].empty()) { @@ -2185,7 +2265,7 @@ NetworkOPsImp::pubServer() // list into a local array while holding the lock then release // the lock and call send on everyone. // - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); if (!mStreamMaps[sServer].empty()) { @@ -2223,7 +2303,7 @@ NetworkOPsImp::pubServer() for (auto i = mStreamMaps[sServer].begin(); i != mStreamMaps[sServer].end();) { - InfoSub::pointer p = i->second.lock(); + InfoSub::pointer const p = i->second.lock(); // VFALCO TODO research the possibility of using thread queues and // linearizing the deletion of subscribers with the @@ -2244,7 +2324,7 @@ NetworkOPsImp::pubServer() void NetworkOPsImp::pubConsensus(ConsensusPhase phase) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); auto& streamMap = mStreamMaps[sConsensusPhase]; if (!streamMap.empty()) @@ -2272,7 +2352,7 @@ void NetworkOPsImp::pubValidation(std::shared_ptr const& val) { // VFALCO consider std::shared_mutex - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); if (!mStreamMaps[sValidations].empty()) { @@ -2377,7 +2457,7 @@ NetworkOPsImp::pubValidation(std::shared_ptr const& val) void NetworkOPsImp::pubPeerStatus(std::function const& func) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); if (!mStreamMaps[sPeerStatus].empty()) { @@ -2387,7 +2467,7 @@ NetworkOPsImp::pubPeerStatus(std::function const& func) for (auto i = mStreamMaps[sPeerStatus].begin(); i != mStreamMaps[sPeerStatus].end();) { - InfoSub::pointer p = i->second.lock(); + InfoSub::pointer const p = i->second.lock(); if (p) { @@ -2448,7 +2528,7 @@ NetworkOPsImp::recvValidation(std::shared_ptr const& val, std::str { pendingValidations_.insert(val->getLedgerHash()); } - scope_unlock unlock(lock); + scope_unlock const unlock(lock); handleNewValidation(registry_.get().getApp(), val, source, bypassAccept, m_journal); } catch (std::exception const& e) @@ -2933,7 +3013,7 @@ NetworkOPsImp::pubProposedTransaction( MultiApiJson jvObj = transJson(transaction, result, false, ledger, std::nullopt); { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); auto it = mStreamMaps[sRTTransactions].begin(); while (it != mStreamMaps[sRTTransactions].end()) @@ -2980,7 +3060,7 @@ NetworkOPsImp::pubLedger(std::shared_ptr const& lpAccepted) JLOG(m_journal.debug()) << "Publishing ledger " << lpAccepted->header().seq << " " << lpAccepted->header().hash; - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); if (!mStreamMaps[sLedger].empty()) { @@ -3011,7 +3091,7 @@ NetworkOPsImp::pubLedger(std::shared_ptr const& lpAccepted) auto it = mStreamMaps[sLedger].begin(); while (it != mStreamMaps[sLedger].end()) { - InfoSub::pointer p = it->second.lock(); + InfoSub::pointer const p = it->second.lock(); if (p) { p->send(jvObj, true); @@ -3026,12 +3106,12 @@ NetworkOPsImp::pubLedger(std::shared_ptr const& lpAccepted) if (!mStreamMaps[sBookChanges].empty()) { - Json::Value jvObj = xrpl::RPC::computeBookChanges(lpAccepted); + Json::Value const jvObj = xrpl::RPC::computeBookChanges(lpAccepted); auto it = mStreamMaps[sBookChanges].begin(); while (it != mStreamMaps[sBookChanges].end()) { - InfoSub::pointer p = it->second.lock(); + InfoSub::pointer const p = it->second.lock(); if (p) { p->send(jvObj, true); @@ -3076,7 +3156,7 @@ NetworkOPsImp::pubLedger(std::shared_ptr const& lpAccepted) void NetworkOPsImp::reportFeeChange() { - ServerFeeSummary f{ + ServerFeeSummary const f{ registry_.get().getOpenLedger().current()->fees().base, registry_.get().getTxQ().getMetrics(*registry_.get().getOpenLedger().current()), registry_.get().getFeeTrack()}; @@ -3177,10 +3257,15 @@ NetworkOPsImp::transJson( auto const amount = transaction->getFieldAmount(sfTakerGets); // If the offer create is not self funded then add the owner balance - if (account != amount.issue().account) + if (account != amount.getIssuer()) { auto const ownerFunds = accountFunds( - *ledger, account, amount, fhIGNORE_FREEZE, registry_.get().getJournal("View")); + *ledger, + account, + amount, + fhIGNORE_FREEZE, + ahIGNORE_AUTH, + registry_.get().getJournal("View")); jvObj[jss::transaction][jss::owner_funds] = ownerFunds.getText(); } } @@ -3220,7 +3305,7 @@ NetworkOPsImp::pubValidatedTransaction( MultiApiJson jvObj = transJson(stTxn, trResult, true, ledger, metaRef); { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); auto it = mStreamMaps[sTransactions].begin(); while (it != mStreamMaps[sTransactions].end()) @@ -3279,7 +3364,7 @@ NetworkOPsImp::pubAccountTransaction( std::vector accountHistoryNotify; auto const currLedgerSeq = ledger->seq(); { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); if (!mSubAccount.empty() || !mSubRTAccount.empty() || !mSubAccountHistory.empty()) { @@ -3292,7 +3377,7 @@ NetworkOPsImp::pubAccountTransaction( while (it != simiIt->second.end()) { - InfoSub::pointer p = it->second.lock(); + InfoSub::pointer const p = it->second.lock(); if (p) { @@ -3312,7 +3397,7 @@ NetworkOPsImp::pubAccountTransaction( auto it = simiIt->second.begin(); while (it != simiIt->second.end()) { - InfoSub::pointer p = it->second.lock(); + InfoSub::pointer const p = it->second.lock(); if (p) { @@ -3412,7 +3497,7 @@ NetworkOPsImp::pubProposedAccountTransaction( std::vector accountHistoryNotify; { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); if (mSubRTAccount.empty()) return; @@ -3428,7 +3513,7 @@ NetworkOPsImp::pubProposedAccountTransaction( while (it != simiIt->second.end()) { - InfoSub::pointer p = it->second.lock(); + InfoSub::pointer const p = it->second.lock(); if (p) { @@ -3496,7 +3581,7 @@ NetworkOPsImp::subAccount( isrListener->insertSubAccountInfo(naAccountID, rt); } - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); for (auto const& naAccountID : vnaAccountIDs) { @@ -3539,7 +3624,7 @@ NetworkOPsImp::unsubAccountInternal( hash_set const& vnaAccountIDs, bool rt) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); SubInfoMapType& subMap = rt ? mSubRTAccount : mSubAccount; @@ -3672,7 +3757,7 @@ NetworkOPsImp::addAccountHistoryJob(SubAccountHistoryInfoWeak subInfo) { case Sqlite: { auto& db = registry_.get().getRelationalDatabase(); - RelationalDatabase::AccountTxPageOptions options{ + RelationalDatabase::AccountTxPageOptions const options{ accountId, {minLedger, maxLedger}, marker, 0, true}; return db.newestAccountTxPage(options); } @@ -3751,7 +3836,7 @@ NetworkOPsImp::addAccountHistoryJob(SubAccountHistoryInfoWeak subInfo) auto const& txns = dbResult->first; marker = dbResult->second; - size_t num_txns = txns.size(); + size_t const num_txns = txns.size(); for (size_t i = 0; i < num_txns; ++i) { auto const& [tx, meta] = txns[i]; @@ -3777,7 +3862,7 @@ NetworkOPsImp::addAccountHistoryJob(SubAccountHistoryInfoWeak subInfo) return; // LCOV_EXCL_STOP } - std::shared_ptr stTxn = tx->getSTransaction(); + std::shared_ptr const stTxn = tx->getSTransaction(); if (!stTxn) { // LCOV_EXCL_START @@ -3896,7 +3981,7 @@ NetworkOPsImp::subAccountHistory(InfoSub::ref isrListener, AccountID const& acco return rpcINVALID_PARAMS; } - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); SubAccountHistoryInfoWeak ahi{isrListener, std::make_shared(accountId)}; auto simIterator = mSubAccountHistory.find(accountId); if (simIterator == mSubAccountHistory.end()) @@ -3943,7 +4028,7 @@ NetworkOPsImp::unsubAccountHistoryInternal( AccountID const& account, bool historyOnly) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); auto simIterator = mSubAccountHistory.find(account); if (simIterator != mSubAccountHistory.end()) { @@ -4032,7 +4117,7 @@ NetworkOPsImp::subLedger(InfoSub::ref isrListener, Json::Value& jvResult) jvResult[jss::validated_ledgers] = registry_.get().getLedgerMaster().getCompleteLedgers(); } - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sLedger].emplace(isrListener->getSeq(), isrListener).second; } @@ -4040,7 +4125,7 @@ NetworkOPsImp::subLedger(InfoSub::ref isrListener, Json::Value& jvResult) bool NetworkOPsImp::subBookChanges(InfoSub::ref isrListener) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sBookChanges].emplace(isrListener->getSeq(), isrListener).second; } @@ -4048,7 +4133,7 @@ NetworkOPsImp::subBookChanges(InfoSub::ref isrListener) bool NetworkOPsImp::unsubLedger(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sLedger].erase(uSeq) != 0u; } @@ -4056,7 +4141,7 @@ NetworkOPsImp::unsubLedger(std::uint64_t uSeq) bool NetworkOPsImp::unsubBookChanges(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sBookChanges].erase(uSeq) != 0u; } @@ -4064,7 +4149,7 @@ NetworkOPsImp::unsubBookChanges(std::uint64_t uSeq) bool NetworkOPsImp::subManifests(InfoSub::ref isrListener) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sManifests].emplace(isrListener->getSeq(), isrListener).second; } @@ -4072,7 +4157,7 @@ NetworkOPsImp::subManifests(InfoSub::ref isrListener) bool NetworkOPsImp::unsubManifests(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sManifests].erase(uSeq) != 0u; } @@ -4097,7 +4182,7 @@ NetworkOPsImp::subServer(InfoSub::ref isrListener, Json::Value& jvResult, bool a jvResult[jss::pubkey_node] = toBase58(TokenType::NodePublic, registry_.get().getApp().nodeIdentity().first); - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sServer].emplace(isrListener->getSeq(), isrListener).second; } @@ -4105,7 +4190,7 @@ NetworkOPsImp::subServer(InfoSub::ref isrListener, Json::Value& jvResult, bool a bool NetworkOPsImp::unsubServer(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sServer].erase(uSeq) != 0u; } @@ -4113,7 +4198,7 @@ NetworkOPsImp::unsubServer(std::uint64_t uSeq) bool NetworkOPsImp::subTransactions(InfoSub::ref isrListener) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sTransactions].emplace(isrListener->getSeq(), isrListener).second; } @@ -4121,7 +4206,7 @@ NetworkOPsImp::subTransactions(InfoSub::ref isrListener) bool NetworkOPsImp::unsubTransactions(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sTransactions].erase(uSeq) != 0u; } @@ -4129,7 +4214,7 @@ NetworkOPsImp::unsubTransactions(std::uint64_t uSeq) bool NetworkOPsImp::subRTTransactions(InfoSub::ref isrListener) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sRTTransactions].emplace(isrListener->getSeq(), isrListener).second; } @@ -4137,7 +4222,7 @@ NetworkOPsImp::subRTTransactions(InfoSub::ref isrListener) bool NetworkOPsImp::unsubRTTransactions(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sRTTransactions].erase(uSeq) != 0u; } @@ -4145,7 +4230,7 @@ NetworkOPsImp::unsubRTTransactions(std::uint64_t uSeq) bool NetworkOPsImp::subValidations(InfoSub::ref isrListener) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sValidations].emplace(isrListener->getSeq(), isrListener).second; } @@ -4159,7 +4244,7 @@ NetworkOPsImp::stateAccounting(Json::Value& obj) bool NetworkOPsImp::unsubValidations(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sValidations].erase(uSeq) != 0u; } @@ -4167,7 +4252,7 @@ NetworkOPsImp::unsubValidations(std::uint64_t uSeq) bool NetworkOPsImp::subPeerStatus(InfoSub::ref isrListener) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sPeerStatus].emplace(isrListener->getSeq(), isrListener).second; } @@ -4175,7 +4260,7 @@ NetworkOPsImp::subPeerStatus(InfoSub::ref isrListener) bool NetworkOPsImp::unsubPeerStatus(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sPeerStatus].erase(uSeq) != 0u; } @@ -4183,7 +4268,7 @@ NetworkOPsImp::unsubPeerStatus(std::uint64_t uSeq) bool NetworkOPsImp::subConsensus(InfoSub::ref isrListener) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sConsensusPhase].emplace(isrListener->getSeq(), isrListener).second; } @@ -4191,16 +4276,16 @@ NetworkOPsImp::subConsensus(InfoSub::ref isrListener) bool NetworkOPsImp::unsubConsensus(std::uint64_t uSeq) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); return mStreamMaps[sConsensusPhase].erase(uSeq) != 0u; } InfoSub::pointer NetworkOPsImp::findRpcSub(std::string const& strUrl) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); - subRpcMapType::iterator it = mRpcSubMap.find(strUrl); + subRpcMapType::iterator const it = mRpcSubMap.find(strUrl); if (it != mRpcSubMap.end()) return it->second; @@ -4211,7 +4296,7 @@ NetworkOPsImp::findRpcSub(std::string const& strUrl) InfoSub::pointer NetworkOPsImp::addRpcSub(std::string const& strUrl, InfoSub::ref rspEntry) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); mRpcSubMap.emplace(strUrl, rspEntry); @@ -4221,7 +4306,7 @@ NetworkOPsImp::addRpcSub(std::string const& strUrl, InfoSub::ref rspEntry) bool NetworkOPsImp::tryRemoveRpcSub(std::string const& strUrl) { - std::lock_guard sl(mSubLock); + std::lock_guard const sl(mSubLock); auto pInfo = findRpcSub(strUrl); if (!pInfo) @@ -4271,7 +4356,7 @@ NetworkOPsImp::getBookPage( ReadView const& view = *lpLedger; bool const bGlobalFreeze = - isGlobalFrozen(view, book.out.account) || isGlobalFrozen(view, book.in.account); + isGlobalFrozen(view, book.out.getIssuer()) || isGlobalFrozen(view, book.in.getIssuer()); bool bDone = false; bool bDirectAdvance = true; @@ -4281,7 +4366,7 @@ NetworkOPsImp::getBookPage( unsigned int uBookEntry = 0; STAmount saDirRate; - auto const rate = transferRate(view, book.out.account); + auto const rate = transferRate(view, book.out.getIssuer()); auto viewJ = registry_.get().getJournal("View"); while (!bDone && iLimit-- > 0) @@ -4331,7 +4416,7 @@ NetworkOPsImp::getBookPage( STAmount saOwnerFunds; bool firstOwnerOffer(true); - if (book.out.account == uOfferOwnerID) + if (book.out.getIssuer() == uOfferOwnerID) { // If an offer is selling issuer's own IOUs, it is fully // funded. @@ -4360,9 +4445,9 @@ NetworkOPsImp::getBookPage( saOwnerFunds = accountHolds( view, uOfferOwnerID, - book.out.currency, - book.out.account, + book.out, fhZERO_IF_FROZEN, + ahZERO_IF_UNAUTHORIZED, viewJ); if (saOwnerFunds < beast::zero) @@ -4382,9 +4467,9 @@ NetworkOPsImp::getBookPage( if (rate != parityRate // Have a transfer fee. - && uTakerID != book.out.account + && uTakerID != book.out.getIssuer() // Not taking offers of own IOUs. - && book.out.account != uOfferOwnerID) + && book.out.getIssuer() != uOfferOwnerID) // Offer owner not issuing ownfunds { // Need to charge a transfer fee to offer owner. @@ -4405,11 +4490,11 @@ NetworkOPsImp::getBookPage( saTakerGetsFunded.setJson(jvOffer[jss::taker_gets_funded]); std::min( - saTakerPays, multiply(saTakerGetsFunded, saDirRate, saTakerPays.issue())) + saTakerPays, multiply(saTakerGetsFunded, saDirRate, saTakerPays.asset())) .setJson(jvOffer[jss::taker_pays_funded]); } - STAmount saOwnerPays = (parityRate == offerRate) + STAmount const saOwnerPays = (parityRate == offerRate) ? saTakerGetsFunded : std::min(saOwnerFunds, multiply(saTakerGetsFunded, offerRate)); @@ -4549,7 +4634,7 @@ NetworkOPsImp::getBookPage( // TODO(tom): The result of this expression is not used - what's // going on here? - std::min(saTakerPays, multiply(saTakerGetsFunded, saDirRate, saTakerPays.issue())) + std::min(saTakerPays, multiply(saTakerGetsFunded, saDirRate, saTakerPays.asset())) .setJson(jvOffer[jss::taker_pays_funded]); } @@ -4582,7 +4667,7 @@ NetworkOPsImp::collect_metrics() std::chrono::steady_clock::now() - start); counters[static_cast(mode)].dur += current; - std::lock_guard lock(m_statsMutex); + std::lock_guard const lock(m_statsMutex); m_stats.disconnected_duration.set( counters[static_cast(OperatingMode::DISCONNECTED)].dur.count()); m_stats.connected_duration.set( @@ -4610,7 +4695,7 @@ NetworkOPsImp::StateAccounting::mode(OperatingMode om) { auto now = std::chrono::steady_clock::now(); - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); ++counters_[static_cast(om)].transitions; if (om == OperatingMode::FULL && counters_[static_cast(om)].transitions == 1) { diff --git a/src/xrpld/app/misc/README.md b/src/xrpld/app/misc/README.md index 2f9fff0ca3..359f58578d 100644 --- a/src/xrpld/app/misc/README.md +++ b/src/xrpld/app/misc/README.md @@ -1,6 +1,6 @@ # Fee Voting -The Ripple payment protocol enforces a fee schedule expressed in units of the +The XRPL payment protocol enforces a fee schedule expressed in units of the native currency, XRP. Fees for transactions are paid directly from the account owner. There are also reserve requirements for each item that occupies storage in the ledger. The reserve fee schedule contains both a per-account reserve, @@ -20,7 +20,7 @@ subsequent ledgers a new fee schedule is enacted. ## Consensus -The Ripple consensus algorithm allows distributed participants to arrive at +The XRPL consensus algorithm allows distributed participants to arrive at the same answer for yes/no questions. The canonical case for consensus is whether or not a particular transaction is included in the ledger. Fees present a more difficult challenge, since the decision on the new fee is not @@ -54,7 +54,7 @@ be converged in the consensus process, the following algorithm is used: ## Configuration -A validating instance of rippled uses information in the configuration file +A validating instance of xrpld uses information in the configuration file to determine how it wants to vote on the fee schedule. It is the responsibility of the administrator to set these values. @@ -64,7 +64,7 @@ of the administrator to set these values. An Amendment is a new or proposed change to a ledger rule. Ledger rules affect transaction processing and consensus; peers must use the same set of rules for -consensus to succeed, otherwise different instances of rippled will get +consensus to succeed, otherwise different instances of xrpld will get different results. Amendments can be almost anything but they must be accepted by a network majority through a consensus process before they are utilized. An Amendment must receive at least an 80% approval rate from validating nodes for @@ -77,7 +77,7 @@ process of an Amendment from its conception to approval and usage. - Some members contribute their time and work to develop the Amendment. -- A pull request is created and the new code is folded into a rippled build +- A pull request is created and the new code is folded into an xrpld build and made available for use. - The consensus process begins with the validating nodes. diff --git a/src/xrpld/app/misc/SHAMapStore.h b/src/xrpld/app/misc/SHAMapStore.h index b377538f62..6788d15392 100644 --- a/src/xrpld/app/misc/SHAMapStore.h +++ b/src/xrpld/app/misc/SHAMapStore.h @@ -1,5 +1,7 @@ #pragma once +#include + #include #include diff --git a/src/xrpld/app/misc/SHAMapStoreImp.cpp b/src/xrpld/app/misc/SHAMapStoreImp.cpp index 6460d99686..518d9f6b14 100644 --- a/src/xrpld/app/misc/SHAMapStoreImp.cpp +++ b/src/xrpld/app/misc/SHAMapStoreImp.cpp @@ -1,29 +1,58 @@ -#include #include + +#include +#include #include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include #include #include +#include #include #include #include +#include #include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { void SHAMapStoreImp::SavedStateDB::init(BasicConfig const& config, std::string const& dbName) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); initStateDB(sqlDb_, config, dbName); } LedgerIndex SHAMapStoreImp::SavedStateDB::getCanDelete() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return xrpl::getCanDelete(sqlDb_); } @@ -31,7 +60,7 @@ SHAMapStoreImp::SavedStateDB::getCanDelete() LedgerIndex SHAMapStoreImp::SavedStateDB::setCanDelete(LedgerIndex canDelete) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return xrpl::setCanDelete(sqlDb_, canDelete); } @@ -39,7 +68,7 @@ SHAMapStoreImp::SavedStateDB::setCanDelete(LedgerIndex canDelete) SavedState SHAMapStoreImp::SavedStateDB::getState() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return xrpl::getSavedState(sqlDb_); } @@ -47,14 +76,14 @@ SHAMapStoreImp::SavedStateDB::getState() void SHAMapStoreImp::SavedStateDB::setState(SavedState const& state) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); xrpl::setSavedState(sqlDb_, state); } void SHAMapStoreImp::SavedStateDB::setLastRotated(LedgerIndex seq) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); xrpl::setLastRotated(sqlDb_, seq); } @@ -180,7 +209,7 @@ void SHAMapStoreImp::onLedgerClosed(std::shared_ptr const& ledger) { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); newLedger_ = ledger; working_ = true; } @@ -338,7 +367,7 @@ SHAMapStoreImp::run() void SHAMapStoreImp::dbPaths() { - Section section{app_.config().section(ConfigSection::nodeDatabase())}; + Section const section{app_.config().section(ConfigSection::nodeDatabase())}; boost::filesystem::path dbPath = get(section, "path"); if (boost::filesystem::exists(dbPath)) @@ -426,7 +455,7 @@ SHAMapStoreImp::dbPaths() } // The necessary directories exist. Now, remove any others. - for (boost::filesystem::path& p : pathsToDelete) + for (boost::filesystem::path const& p : pathsToDelete) boost::filesystem::remove_all(p); } @@ -595,7 +624,7 @@ SHAMapStoreImp::stop() if (thread_.joinable()) { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); stop_ = true; cond_.notify_one(); } diff --git a/src/xrpld/app/misc/SHAMapStoreImp.h b/src/xrpld/app/misc/SHAMapStoreImp.h index df3c16b24f..08e3dd70eb 100644 --- a/src/xrpld/app/misc/SHAMapStoreImp.h +++ b/src/xrpld/app/misc/SHAMapStoreImp.h @@ -61,7 +61,7 @@ private: // minimum # of ledgers required for standalone mode. static std::uint32_t const minimumDeletionIntervalSA_ = 8; // minimum ledger to maintain online. - std::atomic minimumOnline_{}; + std::atomic minimumOnline_; NodeStore::Scheduler& scheduler_; beast::Journal const journal_; @@ -102,7 +102,7 @@ public: std::uint32_t clampFetchDepth(std::uint32_t fetch_depth) const override { - return deleteInterval_ ? std::min(fetch_depth, deleteInterval_) : fetch_depth; + return (deleteInterval_ != 0u) ? std::min(fetch_depth, deleteInterval_) : fetch_depth; } std::unique_ptr @@ -195,7 +195,7 @@ private: clearPrior(LedgerIndex lastRotated); /** - * This is a health check for online deletion that waits until rippled is + * This is a health check for online deletion that waits until xrpld is * stable before returning. It returns an indication of whether the server * is stopping. * @@ -209,7 +209,7 @@ public: void start() override { - if (deleteInterval_) + if (deleteInterval_ != 0u) thread_ = std::thread(&SHAMapStoreImp::run, this); } diff --git a/src/xrpld/app/misc/Transaction.h b/src/xrpld/app/misc/Transaction.h index fa126e6bb5..31d899d99b 100644 --- a/src/xrpld/app/misc/Transaction.h +++ b/src/xrpld/app/misc/Transaction.h @@ -21,7 +21,6 @@ namespace xrpl { // class Application; -class Database; class Rules; enum TransStatus { @@ -139,7 +138,7 @@ public: * @return Whether transaction is being applied within a batch. */ bool - getApplying() + getApplying() const { // Note that all access to mApplying are made by NetworkOPsImp, and must // be done under that class's lock. @@ -308,7 +307,7 @@ public: // Calling the wrong getter function will throw an exception. // See documentation for the getter functions for more details bool - isFound() + isFound() const { return std::holds_alternative>(locator); } diff --git a/src/xrpld/app/misc/TxQ.h b/src/xrpld/app/misc/TxQ.h index 7c441867ea..49a29802bb 100644 --- a/src/xrpld/app/misc/TxQ.h +++ b/src/xrpld/app/misc/TxQ.h @@ -146,23 +146,23 @@ public: explicit Metrics() = default; /// Number of transactions in the queue - std::size_t txCount; + std::size_t txCount{}; /// Max transactions currently allowed in queue std::optional txQMaxSize; /// Number of transactions currently in the open ledger - std::size_t txInLedger; + std::size_t txInLedger{}; /// Number of transactions expected per ledger - std::size_t txPerLedger; + std::size_t txPerLedger{}; /// Reference transaction fee level - FeeLevel64 referenceFeeLevel; + FeeLevel64 referenceFeeLevel{}; /// Minimum fee level for a transaction to be considered for /// the open ledger or the queue - FeeLevel64 minProcessingFeeLevel; + FeeLevel64 minProcessingFeeLevel{}; /// Median fee level of the last ledger - FeeLevel64 medFeeLevel; + FeeLevel64 medFeeLevel{}; /// Minimum fee level to get into the current open ledger, /// bypassing the queue - FeeLevel64 openLedgerFeeLevel; + FeeLevel64 openLedgerFeeLevel{}; }; /** @@ -382,11 +382,12 @@ private: , targetTxnCount_( setup.targetTxnInLedger < minimumTxnCount_ ? minimumTxnCount_ : setup.targetTxnInLedger) - , maximumTxnCount_( - setup.maximumTxnInLedger ? *setup.maximumTxnInLedger < targetTxnCount_ - ? targetTxnCount_ - : *setup.maximumTxnInLedger - : std::optional(std::nullopt)) + , maximumTxnCount_([&]() -> std::optional { + if (!setup.maximumTxnInLedger) + return std::nullopt; + return *setup.maximumTxnInLedger < targetTxnCount_ ? targetTxnCount_ + : *setup.maximumTxnInLedger; + }()) , txnsExpected_(minimumTxnCount_) , recentTxnCounts_(setup.ledgersInQueue) , escalationMultiplier_(setup.minimumEscalationMultiplier) @@ -398,9 +399,9 @@ private: Updates fee metrics based on the transactions in the ReadView for use in fee escalation calculations. - @param app Rippled Application object. + @param app Xrpld Application object. @param view View of the LCL that was just closed or received. - @param timeLeap Indicates that rippled is under load so fees + @param timeLeap Indicates that xrpld is under load so fees should grow faster. @param setup Customization params. */ @@ -511,7 +512,7 @@ private: their `retriesRemaining` forced down as part of the penalty. */ - int retriesRemaining; + int retriesRemaining{retriesAllowed}; /// Flags provided to `apply`. If the transaction is later /// attempted with different flags, it will need to be /// `preflight`ed again. @@ -672,7 +673,7 @@ private: bool empty() const { - return !getTxnCount(); + return getTxnCount() == 0u; } /// Find the entry in transactions that precedes seqProx, if one does. diff --git a/src/xrpld/app/misc/ValidatorList.h b/src/xrpld/app/misc/ValidatorList.h index e774da4713..ff5aa8c71f 100644 --- a/src/xrpld/app/misc/ValidatorList.h +++ b/src/xrpld/app/misc/ValidatorList.h @@ -108,11 +108,11 @@ struct ValidatorBlobInfo Trusted Validators List ----------------------- - Rippled accepts ledger proposals and validations from trusted validator + Xrpld accepts ledger proposals and validations from trusted validator nodes. A ledger is considered fully-validated once the number of received trusted validations for a ledger meets or exceeds a quorum value. - This class manages the set of validation public keys the local rippled node + This class manages the set of validation public keys the local xrpld node trusts. The list of trusted keys is populated using the keys listed in the configuration file as well as lists signed by trusted publishers. The trusted publisher public keys are specified in the config. @@ -121,9 +121,9 @@ struct ValidatorBlobInfo @li @c "blob": Base64-encoded JSON string containing a @c "sequence", @c "validFrom", @c "validUntil", and @c "validators" field. @c "validFrom" - contains the Ripple timestamp (seconds since January 1st, 2000 (00:00 + contains the XRPL timestamp (seconds since January 1st, 2000 (00:00 UTC)) for when the list becomes valid. @c "validUntil" contains the - Ripple timestamp for when the list expires. @c "validators" contains + XRPL timestamp for when the list expires. @c "validators" contains an array of objects with a @c "validation_public_key" and optional @c "manifest" field. @c "validation_public_key" should be the hex-encoded master public key. @c "manifest" should be the @@ -157,7 +157,7 @@ class ValidatorList std::vector list; std::vector manifests; - std::size_t sequence; + std::size_t sequence{}; TimeKeeper::time_point validFrom; TimeKeeper::time_point validUntil; std::string siteUri; @@ -173,7 +173,7 @@ class ValidatorList struct PublisherListCollection { - PublisherStatus status; + PublisherStatus status = PublisherStatus::unavailable; /* The `current` VL is the one which 1. Has the largest sequence number that @@ -223,7 +223,7 @@ class ValidatorList hash_set trustedMasterKeys_; // Minimum number of lists on which a trusted validator must appear on - std::size_t listThreshold_; + std::size_t listThreshold_{1}; // The current list of trusted signing keys. For those validators using // a manifest, the signing key is the ephemeral key. For the ones using @@ -646,7 +646,7 @@ public: QuorumKeys getQuorumKeys() const { - shared_lock read_lock{mutex_}; + shared_lock const read_lock{mutex_}; return {quorum_, trustedSigningKeys_}; } diff --git a/src/xrpld/app/misc/ValidatorSite.h b/src/xrpld/app/misc/ValidatorSite.h index 9d9031b9a2..ab82ae168d 100644 --- a/src/xrpld/app/misc/ValidatorSite.h +++ b/src/xrpld/app/misc/ValidatorSite.h @@ -28,7 +28,7 @@ namespace xrpl { @li @c "blob": Base64-encoded JSON string containing a @c "sequence", @c "validUntil", and @c "validators" field. @c "validUntil" contains the - Ripple timestamp (seconds since January 1st, 2000 (00:00 UTC)) for when + XRPL timestamp (seconds since January 1st, 2000 (00:00 UTC)) for when the list expires. @c "validators" contains an array of objects with a @c "validation_public_key" and optional @c "manifest" field. @c "validation_public_key" should be the hex-encoded master public key. @@ -85,12 +85,12 @@ private: /// when we've gotten a temp redirect std::shared_ptr activeResource; - unsigned short redirCount; + unsigned short redirCount{0}; std::chrono::minutes refreshInterval; clock_type::time_point nextRefresh; std::optional lastRefreshStatus; endpoint_type lastRequestEndpoint; - bool lastRequestSuccessful; + bool lastRequestSuccessful{false}; }; Application& app_; diff --git a/src/xrpld/app/misc/detail/AccountTxPaging.cpp b/src/xrpld/app/misc/detail/AccountTxPaging.cpp index bb0a09426a..d29bedc19d 100644 --- a/src/xrpld/app/misc/detail/AccountTxPaging.cpp +++ b/src/xrpld/app/misc/detail/AccountTxPaging.cpp @@ -1,11 +1,22 @@ +#include + #include #include #include #include -#include +#include +#include #include +#include +#include #include +#include + +#include +#include +#include +#include namespace xrpl { diff --git a/src/xrpld/app/misc/detail/AmendmentTable.cpp b/src/xrpld/app/misc/detail/AmendmentTable.cpp index 7569fa13b5..c629853bd0 100644 --- a/src/xrpld/app/misc/detail/AmendmentTable.cpp +++ b/src/xrpld/app/misc/detail/AmendmentTable.cpp @@ -1,18 +1,48 @@ -#include #include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include #include #include +#include #include -#include -#include +#include +#include #include -#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -632,7 +662,7 @@ AmendmentTableImpl::get(uint256 const& amendmentHash, std::lock_guardvote != AmendmentVote::down) @@ -685,7 +715,7 @@ AmendmentTableImpl::unVeto(uint256 const& amendment) bool AmendmentTableImpl::enable(uint256 const& amendment) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); AmendmentState& s = add(amendment, lock); if (s.enabled) @@ -705,7 +735,7 @@ AmendmentTableImpl::enable(uint256 const& amendment) bool AmendmentTableImpl::isEnabled(uint256 const& amendment) const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); AmendmentState const* s = get(amendment, lock); return (s != nullptr) && s->enabled; } @@ -713,7 +743,7 @@ AmendmentTableImpl::isEnabled(uint256 const& amendment) const bool AmendmentTableImpl::isSupported(uint256 const& amendment) const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); AmendmentState const* s = get(amendment, lock); return (s != nullptr) && s->supported; } @@ -721,14 +751,14 @@ AmendmentTableImpl::isSupported(uint256 const& amendment) const bool AmendmentTableImpl::hasUnsupportedEnabled() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return unsupportedEnabled_; } std::optional AmendmentTableImpl::firstUnsupportedExpected() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return firstUnsupportedExpected_; } @@ -740,7 +770,7 @@ AmendmentTableImpl::doValidation(std::set const& enabled) const std::vector amendments; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); amendments.reserve(amendmentMap_.size()); for (auto const& e : amendmentMap_) { @@ -778,7 +808,7 @@ AmendmentTableImpl::doVoting( << enabledAmendments.size() << ", " << majorityAmendments.size() << ", " << valSet.size(); - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // Keep a record of the votes we received. previousTrustedVotes_.recordVotes(rules, valSet, closeTime, j_, lock); @@ -860,7 +890,7 @@ AmendmentTableImpl::doVoting( bool AmendmentTableImpl::needValidatedLedger(LedgerIndex ledgerSeq) const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // Is there a ledger in which an amendment could have been enabled // between these two ledger sequences? @@ -877,7 +907,7 @@ AmendmentTableImpl::doValidatedLedger( for (auto& e : enabled) enable(e); - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // Remember the ledger sequence of this update. lastUpdateSeq_ = ledgerSeq; @@ -888,7 +918,7 @@ AmendmentTableImpl::doValidatedLedger( firstUnsupportedExpected_.reset(); for (auto const& [hash, time] : majority) { - AmendmentState& s = add(hash, lock); + AmendmentState const& s = add(hash, lock); if (s.enabled) continue; @@ -908,7 +938,7 @@ AmendmentTableImpl::doValidatedLedger( void AmendmentTableImpl::trustChanged(hash_set const& allTrusted) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); previousTrustedVotes_.trustChanged(allTrusted, lock); } @@ -956,7 +986,7 @@ AmendmentTableImpl::getJson(bool isAdmin) const { Json::Value ret(Json::objectValue); { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); for (auto const& e : amendmentMap_) { injectJson( @@ -972,7 +1002,7 @@ AmendmentTableImpl::getJson(uint256 const& amendmentID, bool isAdmin) const Json::Value ret = Json::objectValue; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); AmendmentState const* a = get(amendmentID, lock); if (a != nullptr) { diff --git a/src/xrpld/app/misc/detail/DeliverMax.cpp b/src/xrpld/app/misc/detail/DeliverMax.cpp index 44500eec7e..d6f1067e80 100644 --- a/src/xrpld/app/misc/detail/DeliverMax.cpp +++ b/src/xrpld/app/misc/detail/DeliverMax.cpp @@ -1,5 +1,6 @@ #include +#include #include namespace xrpl { diff --git a/src/xrpld/app/misc/detail/Transaction.cpp b/src/xrpld/app/misc/detail/Transaction.cpp index f0cabf0fa6..758f560835 100644 --- a/src/xrpld/app/misc/detail/Transaction.cpp +++ b/src/xrpld/app/misc/detail/Transaction.cpp @@ -1,14 +1,34 @@ +#include + #include #include -#include #include +#include +#include +#include #include -#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include #include -#include + +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { diff --git a/src/xrpld/app/misc/detail/TxQ.cpp b/src/xrpld/app/misc/detail/TxQ.cpp index c03ef6872e..ca3f0b5da1 100644 --- a/src/xrpld/app/misc/detail/TxQ.cpp +++ b/src/xrpld/app/misc/detail/TxQ.cpp @@ -1,16 +1,53 @@ -#include -#include #include +#include +#include + +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include #include +#include + +#include #include +#include +#include +#include #include +#include +#include #include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -20,8 +57,8 @@ static FeeLevel64 getFeeLevelPaid(ReadView const& view, STTx const& tx) { auto const [baseFee, effectiveFeePaid] = [&view, &tx]() { - XRPAmount baseFee = calculateBaseFee(view, tx); - XRPAmount feePaid = tx[sfFee].xrp(); + XRPAmount const baseFee = calculateBaseFee(view, tx); + XRPAmount const feePaid = tx[sfFee].xrp(); // If baseFee is 0 then the cost of a basic transaction is free, but we // need the effective fee level to be non-zero. @@ -172,7 +209,7 @@ sumOfFirstSquares(std::size_t xIn) // We expect that size_t == std::uint64_t but, just in case, guarantee // we lose no bits. - std::uint64_t x{xIn}; + std::uint64_t const x{xIn}; // If x is anywhere on the order of 2^^21, it's going // to completely dominate the computation and is likely @@ -257,7 +294,6 @@ TxQ::MaybeTx::MaybeTx( , account(txn_->getAccountID(sfAccount)) , lastValid(getLastLedgerSequence(*txn_)) , seqProxy(txn_->getSeqProxy()) - , retriesRemaining(retriesAllowed) , flags(flags_) , pfResult(pfResult_) { @@ -268,7 +304,7 @@ TxQ::MaybeTx::apply(Application& app, OpenView& view, beast::Journal j) { // If the rules or flags change, preflight again XRPL_ASSERT(pfResult, "xrpl::TxQ::MaybeTx::apply : preflight result is set"); - NumberSO stNumberSO{view.rules().enabled(fixUniversalNumber)}; + NumberSO const stNumberSO{view.rules().enabled(fixUniversalNumber)}; if (pfResult->rules != view.rules() || pfResult->flags != flags) { @@ -691,7 +727,7 @@ TxQ::apply( ApplyFlags flags, beast::Journal j) { - NumberSO stNumberSO{view.rules().enabled(fixUniversalNumber)}; + NumberSO const stNumberSO{view.rules().enabled(fixUniversalNumber)}; // See if the transaction is valid, properly formed, // etc. before doing potentially expensive queue @@ -736,7 +772,7 @@ TxQ::apply( return {terPRE_TICKET, false}; } - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // accountIter is not const because it may be updated further down. AccountMap::iterator accountIter = byAccount_.find(account); @@ -1287,7 +1323,7 @@ TxQ::apply( void TxQ::processClosedLedger(Application& app, ReadView const& view, bool timeLeap) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); feeMetrics_.update(app, view, timeLeap, setup_); auto const& snapshot = feeMetrics_.getSnapshot(); @@ -1366,7 +1402,7 @@ TxQ::accept(Application& app, OpenView& view) auto ledgerChanged = false; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const metricsSnapshot = feeMetrics_.getSnapshot(); @@ -1530,7 +1566,7 @@ TxQ::accept(Application& app, OpenView& view) SeqProxy TxQ::nextQueuableSeq(std::shared_ptr const& sleAccount) const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return nextQueuableSeqImpl(sleAccount, lock); } @@ -1621,7 +1657,7 @@ TxQ::tryDirectApply( return {}; FeeLevel64 const requiredFeeLevel = [this, &view, flags]() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return getRequiredFeeLevel(view, flags, feeMetrics_.getSnapshot(), lock); }(); @@ -1645,9 +1681,9 @@ TxQ::tryDirectApply( { // If the applied transaction replaced a transaction in the // queue then remove the replaced transaction. - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); - AccountMap::iterator accountIter = byAccount_.find(account); + AccountMap::iterator const accountIter = byAccount_.find(account); if (accountIter != byAccount_.end()) { TxQAccount& txQAcct = accountIter->second; @@ -1694,7 +1730,7 @@ TxQ::getMetrics(OpenView const& view) const { Metrics result; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const snapshot = feeMetrics_.getSnapshot(); @@ -1715,7 +1751,7 @@ TxQ::getTxRequiredFeeAndSeq(OpenView const& view, std::shared_ptr co { auto const account = (*tx)[sfAccount]; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const snapshot = feeMetrics_.getSnapshot(); auto const baseFee = calculateBaseFee(view, *tx); @@ -1737,7 +1773,7 @@ TxQ::getAccountTxs(AccountID const& account) const { std::vector result; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); AccountMap::const_iterator const accountIter{byAccount_.find(account)}; @@ -1757,7 +1793,7 @@ TxQ::getTxs() const { std::vector result; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); result.reserve(byFee_.size()); diff --git a/src/xrpld/app/misc/detail/ValidatorKeys.cpp b/src/xrpld/app/misc/detail/ValidatorKeys.cpp index 59ddc6d702..bd9c723acb 100644 --- a/src/xrpld/app/misc/detail/ValidatorKeys.cpp +++ b/src/xrpld/app/misc/detail/ValidatorKeys.cpp @@ -1,11 +1,19 @@ #include + #include #include #include #include +#include +#include +#include +#include +#include #include +#include + namespace xrpl { ValidatorKeys::ValidatorKeys(Config const& config, beast::Journal j) { diff --git a/src/xrpld/app/misc/detail/ValidatorList.cpp b/src/xrpld/app/misc/detail/ValidatorList.cpp index abf64a4a93..ddadd74da0 100644 --- a/src/xrpld/app/misc/detail/ValidatorList.cpp +++ b/src/xrpld/app/misc/detail/ValidatorList.cpp @@ -1,24 +1,60 @@ #include -#include +#include +#include +#include + +#include #include +#include #include #include #include +#include +#include +#include +#include +#include #include +#include #include +#include #include #include +#include #include #include -#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include namespace xrpl { @@ -109,7 +145,7 @@ ValidatorList::ValidatorList( , j_(j) , quorum_(minimumQuorum.value_or(1)) // Genesis ledger quorum , minimumQuorum_(minimumQuorum) - , listThreshold_(1) + { } @@ -132,7 +168,7 @@ ValidatorList::load( ")?" // end optional comment block ); - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; JLOG(j_.debug()) << "Loading configured trusted validator list publisher keys"; @@ -340,7 +376,7 @@ ValidatorList::cacheValidatorFile(ValidatorList::lock_guard const& lock, PublicK boost::system::error_code ec; Json::Value value = buildFileData(strHex(pubKey), publisherLists_.at(pubKey), j_); - // rippled should be the only process writing to this file, so + // xrpld should be the only process writing to this file, so // if it ever needs to be read, it is not expected to change externally, so // delay the refresh as long as possible: 24 hours. (See also // `ValidatorSite::missingSite()`) @@ -901,7 +937,7 @@ ValidatorList::applyListsAndBroadcast( networkOPs.clearUNLBlocked(); } } - bool broadcast = disposition <= ListDisposition::known_sequence; + bool const broadcast = disposition <= ListDisposition::known_sequence; // this function is only called for PublicKeys which are not specified // in the config file (Note: Keys specified in the local config file are @@ -936,7 +972,7 @@ ValidatorList::applyLists( 1) return PublisherListStats{ListDisposition::unsupported_version}; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; PublisherListStats result; for (auto const& blobInfo : blobs) @@ -1106,7 +1142,7 @@ ValidatorList::applyList( // LCOV_EXCL_STOP } - PublicKey pubKey = *pubKeyOpt; + PublicKey const pubKey = *pubKeyOpt; if (result > ListDisposition::pending) { if (publisherLists_.contains(pubKey)) @@ -1238,7 +1274,7 @@ ValidatorList::loadLists() using namespace boost::filesystem; using namespace boost::system::errc; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; std::vector sites; sites.reserve(publisherLists_.size()); @@ -1381,7 +1417,7 @@ ValidatorList::verify( bool ValidatorList::listed(PublicKey const& identity) const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; auto const pubKey = validatorManifests_.getMasterKey(identity); return keyListings_.contains(pubKey); @@ -1397,14 +1433,14 @@ ValidatorList::trusted(ValidatorList::shared_lock const&, PublicKey const& ident bool ValidatorList::trusted(PublicKey const& identity) const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return trusted(read_lock, identity); } std::optional ValidatorList::getListedKey(PublicKey const& identity) const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; auto pubKey = validatorManifests_.getMasterKey(identity); if (keyListings_.contains(pubKey)) @@ -1424,7 +1460,7 @@ ValidatorList::getTrustedKey(ValidatorList::shared_lock const&, PublicKey const& std::optional ValidatorList::getTrustedKey(PublicKey const& identity) const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return getTrustedKey(read_lock, identity); } @@ -1432,7 +1468,7 @@ ValidatorList::getTrustedKey(PublicKey const& identity) const bool ValidatorList::trustedPublisher(PublicKey const& identity) const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return (identity.size() != 0u) && publisherLists_.contains(identity) && publisherLists_.at(identity).status < PublisherStatus::revoked; } @@ -1440,7 +1476,7 @@ ValidatorList::trustedPublisher(PublicKey const& identity) const std::optional ValidatorList::localPublicKey() const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return localPubKey_; } @@ -1490,7 +1526,7 @@ ValidatorList::count(ValidatorList::shared_lock const&) const std::size_t ValidatorList::count() const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return count(read_lock); } @@ -1533,7 +1569,7 @@ ValidatorList::expires(ValidatorList::shared_lock const&) const if (!localPublisherList.list.empty()) { - PublisherList collection = localPublisherList; + PublisherList const collection = localPublisherList; // Unfetched auto const& current = collection; auto chainedExpiration = current.validUntil; @@ -1550,7 +1586,7 @@ ValidatorList::expires(ValidatorList::shared_lock const&) const std::optional ValidatorList::expires() const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return expires(read_lock); } @@ -1559,7 +1595,7 @@ ValidatorList::getJson() const { Json::Value res(Json::objectValue); - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; res[jss::validation_quorum] = static_cast(quorum_); @@ -1687,7 +1723,7 @@ ValidatorList::getJson() const void ValidatorList::for_each_listed(std::function func) const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; for (auto const& v : keyListings_) func(v.first, trusted(read_lock, v.first)); @@ -1703,14 +1739,14 @@ ValidatorList::for_each_available( std::size_t maxSequence, uint256 const& hash)> func) const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; for (auto const& [key, plCollection] : publisherLists_) { if (plCollection.status != PublisherStatus::available) continue; XRPL_ASSERT( - plCollection.maxSequence != 0, + plCollection.maxSequence.value_or(0) != 0, "xrpl::ValidatorList::for_each_available : nonzero maxSequence"); func( plCollection.rawManifest, @@ -1727,7 +1763,7 @@ ValidatorList::getAvailable( std::string_view pubKey, std::optional forceVersion /* = {} */) { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; auto const keyBlob = strViewUnHex(pubKey); @@ -1851,7 +1887,7 @@ ValidatorList::updateTrusted( if (timeKeeper_.now() > closeTime + 30s) closeTime = timeKeeper_.now(); - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; // Rotate pending and remove expired published lists bool good = true; @@ -2023,28 +2059,28 @@ ValidatorList::updateTrusted( hash_set ValidatorList::getTrustedMasterKeys() const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return trustedMasterKeys_; } std::size_t ValidatorList::getListThreshold() const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return listThreshold_; } hash_set ValidatorList::getNegativeUNL() const { - std::shared_lock read_lock{mutex_}; + std::shared_lock const read_lock{mutex_}; return negativeUNL_; } void ValidatorList::setNegativeUNL(hash_set const& negUnl) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; negativeUNL_ = negUnl; } diff --git a/src/xrpld/app/misc/detail/ValidatorSite.cpp b/src/xrpld/app/misc/detail/ValidatorSite.cpp index b93a1b8007..5eda2d8eb5 100644 --- a/src/xrpld/app/misc/detail/ValidatorSite.cpp +++ b/src/xrpld/app/misc/detail/ValidatorSite.cpp @@ -1,14 +1,46 @@ -#include #include + +#include +#include +#include #include #include #include +#include +#include +#include +#include +#include +#include #include +#include #include #include +#include +#include +#include +#include +#include +#include +#include + #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -60,10 +92,9 @@ ValidatorSite::Site::Resource::Resource(std::string uri_) : uri{std::move(uri_)} ValidatorSite::Site::Site(std::string uri) : loadedResource{std::make_shared(std::move(uri))} , startingResource{loadedResource} - , redirCount{0} , refreshInterval{default_refresh_interval} , nextRefresh{clock_type::now()} - , lastRequestSuccessful{false} + { } @@ -110,7 +141,7 @@ ValidatorSite::load(std::vector const& siteURIs) { JLOG(j_.debug()) << "Loading configured validator list sites"; - std::lock_guard lock{sites_mutex_}; + std::lock_guard const lock{sites_mutex_}; return load(siteURIs, lock); } @@ -147,8 +178,8 @@ ValidatorSite::load( void ValidatorSite::start() { - std::lock_guard l0{sites_mutex_}; - std::lock_guard l1{state_mutex_}; + std::lock_guard const l0{sites_mutex_}; + std::lock_guard const l1{state_mutex_}; if (timer_.expiry() == clock_type::time_point{}) setTimer(l0, l1); } @@ -216,7 +247,7 @@ ValidatorSite::makeRequest( sites_[siteIdx].activeResource = resource; std::shared_ptr sp; auto timeoutCancel = [this]() { - std::lock_guard lock_state{state_mutex_}; + std::lock_guard const lock_state{state_mutex_}; // docs indicate cancel_one() can throw, but this // should be reconsidered if it changes to noexcept try @@ -280,7 +311,7 @@ ValidatorSite::makeRequest( sp->run(); // start a timer for the request, which shouldn't take more // than requestTimeout_ to complete - std::lock_guard lock_state{state_mutex_}; + std::lock_guard const lock_state{state_mutex_}; timer_.expires_after(requestTimeout_); timer_.async_wait([this, siteIdx](boost::system::error_code const& ec) { this->onRequestTimeout(siteIdx, ec); @@ -294,7 +325,7 @@ ValidatorSite::onRequestTimeout(std::size_t siteIdx, error_code const& ec) return; { - std::lock_guard lock_site{sites_mutex_}; + std::lock_guard const lock_site{sites_mutex_}; // In some circumstances, both this function and the response // handler (onSiteFetch or onTextFetch) can get queued and // processed. In all observed cases, the response handler @@ -311,7 +342,7 @@ ValidatorSite::onRequestTimeout(std::size_t siteIdx, error_code const& ec) "already been processed"; } - std::lock_guard lock_state{state_mutex_}; + std::lock_guard const lock_state{state_mutex_}; if (auto sp = work_.lock()) sp->cancel(); } @@ -330,7 +361,7 @@ ValidatorSite::onTimer(std::size_t siteIdx, error_code const& ec) try { - std::lock_guard lock{sites_mutex_}; + std::lock_guard const lock{sites_mutex_}; sites_[siteIdx].nextRefresh = clock_type::now() + sites_[siteIdx].refreshInterval; sites_[siteIdx].redirCount = 0; // the WorkSSL client ctor can throw if SSL init fails @@ -579,7 +610,7 @@ ValidatorSite::onSiteFetch( sites_[siteIdx].activeResource.reset(); } - std::lock_guard lock_state{state_mutex_}; + std::lock_guard const lock_state{state_mutex_}; fetching_ = false; if (!stopping_) setTimer(lock_sites, lock_state); @@ -592,7 +623,7 @@ ValidatorSite::onTextFetch( std::string const& res, std::size_t siteIdx) { - std::lock_guard lock_sites{sites_mutex_}; + std::lock_guard const lock_sites{sites_mutex_}; { try { @@ -616,7 +647,7 @@ ValidatorSite::onTextFetch( sites_[siteIdx].activeResource.reset(); } - std::lock_guard lock_state{state_mutex_}; + std::lock_guard const lock_state{state_mutex_}; fetching_ = false; if (!stopping_) setTimer(lock_sites, lock_state); @@ -632,7 +663,7 @@ ValidatorSite::getJson() const Json::Value jrr(Json::objectValue); Json::Value& jSites = (jrr[jss::validator_sites] = Json::arrayValue); { - std::lock_guard lock{sites_mutex_}; + std::lock_guard const lock{sites_mutex_}; for (Site const& site : sites_) { Json::Value& v = jSites.append(Json::objectValue); diff --git a/src/xrpld/app/misc/detail/WorkBase.h b/src/xrpld/app/misc/detail/WorkBase.h index 35f04efe00..20a4987bc4 100644 --- a/src/xrpld/app/misc/detail/WorkBase.h +++ b/src/xrpld/app/misc/detail/WorkBase.h @@ -47,7 +47,7 @@ protected: endpoint_type lastEndpoint_; bool lastStatus_; -public: +private: WorkBase( std::string const& host, std::string const& path, @@ -56,6 +56,8 @@ public: endpoint_type const& lastEndpoint, bool lastStatus, callback_type cb); + +public: ~WorkBase(); Impl& @@ -91,6 +93,8 @@ public: private: void close(); + + friend Impl; }; //------------------------------------------------------------------------------ @@ -130,10 +134,12 @@ void WorkBase::run() { if (!strand_.running_in_this_thread()) + { return boost::asio::post( ios_, boost::asio::bind_executor( strand_, std::bind(&WorkBase::run, impl().shared_from_this()))); + } resolver_.async_resolve( host_, diff --git a/src/xrpld/app/misc/detail/WorkFile.h b/src/xrpld/app/misc/detail/WorkFile.h index 896d7ddc71..06cca0f835 100644 --- a/src/xrpld/app/misc/detail/WorkFile.h +++ b/src/xrpld/app/misc/detail/WorkFile.h @@ -44,24 +44,27 @@ private: //------------------------------------------------------------------------------ -WorkFile::WorkFile(std::string const& path, boost::asio::io_context& ios, callback_type cb) +inline WorkFile::WorkFile(std::string const& path, boost::asio::io_context& ios, callback_type cb) : path_(path), cb_(std::move(cb)), ios_(ios), strand_(boost::asio::make_strand(ios)) { } -WorkFile::~WorkFile() +inline WorkFile::~WorkFile() { if (cb_) cb_(make_error_code(boost::system::errc::interrupted), {}); } -void +inline void WorkFile::run() { if (!strand_.running_in_this_thread()) - return boost::asio::post( + { + boost::asio::post( ios_, boost::asio::bind_executor(strand_, std::bind(&WorkFile::run, shared_from_this()))); + return; + } error_code ec; auto const fileContents = getFileContents(ec, path_, megabytes(1)); @@ -71,7 +74,7 @@ WorkFile::run() cb_ = nullptr; } -void +inline void WorkFile::cancel() { // Nothing to do. Either it finished in run, or it didn't start. diff --git a/src/xrpld/app/misc/detail/WorkPlain.h b/src/xrpld/app/misc/detail/WorkPlain.h index d1df5b4b3b..fbbc323193 100644 --- a/src/xrpld/app/misc/detail/WorkPlain.h +++ b/src/xrpld/app/misc/detail/WorkPlain.h @@ -35,7 +35,7 @@ private: //------------------------------------------------------------------------------ -WorkPlain::WorkPlain( +inline WorkPlain::WorkPlain( std::string const& host, std::string const& path, std::string const& port, @@ -47,11 +47,14 @@ WorkPlain::WorkPlain( { } -void +inline void WorkPlain::onConnect(error_code const& ec) { if (ec) - return fail(ec); + { + fail(ec); + return; + } onStart(); } diff --git a/src/xrpld/app/misc/detail/WorkSSL.cpp b/src/xrpld/app/misc/detail/WorkSSL.cpp index 3ae0db1a96..f5138eac8c 100644 --- a/src/xrpld/app/misc/detail/WorkSSL.cpp +++ b/src/xrpld/app/misc/detail/WorkSSL.cpp @@ -1,5 +1,21 @@ #include +#include +#include + +#include +#include + +#include +#include +#include +#include +#include + +#include +#include +#include + namespace xrpl { namespace detail { diff --git a/src/xrpld/app/misc/detail/setup_HashRouter.cpp b/src/xrpld/app/misc/detail/setup_HashRouter.cpp index 0cc61f0730..57e2b9b282 100644 --- a/src/xrpld/app/misc/detail/setup_HashRouter.cpp +++ b/src/xrpld/app/misc/detail/setup_HashRouter.cpp @@ -1,7 +1,14 @@ #include + #include #include +#include +#include + +#include +#include +#include namespace xrpl { diff --git a/src/xrpld/app/rdb/README.md b/src/xrpld/app/rdb/README.md index a50bb395c1..53e6b0c6fa 100644 --- a/src/xrpld/app/rdb/README.md +++ b/src/xrpld/app/rdb/README.md @@ -2,7 +2,7 @@ The guiding principles of the Relational Database Interface are summarized below: -- All hard-coded SQL statements should be stored in the [files](#source-files) under the `xrpld/app/rdb` directory. With the exception of test modules, no hard-coded SQL should be added to any other file in rippled. +- All hard-coded SQL statements should be stored in the [files](#source-files) under the `xrpld/app/rdb` directory. With the exception of test modules, no hard-coded SQL should be added to any other file in xrpld. - The base class `RelationalDatabase` is inherited by derived classes that each provide an interface for operating on distinct relational database systems. ## Overview diff --git a/src/xrpld/app/rdb/backend/detail/Node.cpp b/src/xrpld/app/rdb/backend/detail/Node.cpp index 926c01b8b3..99a812497d 100644 --- a/src/xrpld/app/rdb/backend/detail/Node.cpp +++ b/src/xrpld/app/rdb/backend/detail/Node.cpp @@ -1,22 +1,69 @@ +#include + #include #include #include #include #include -#include +#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include // IWYU pragma: keep #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include #include -#include +#include +#include +#include +#include -#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { namespace detail { @@ -105,7 +152,7 @@ makeLedgerDBs( std::optional getMinLedgerSeq(soci::session& session, TableType type) { - std::string query = "SELECT MIN(LedgerSeq) FROM " + to_string(type) + ";"; + std::string const query = "SELECT MIN(LedgerSeq) FROM " + to_string(type) + ";"; // SOCI requires boost::optional (not std::optional) as the parameter. boost::optional m; session << query, soci::into(m); @@ -115,7 +162,7 @@ getMinLedgerSeq(soci::session& session, TableType type) std::optional getMaxLedgerSeq(soci::session& session, TableType type) { - std::string query = "SELECT MAX(LedgerSeq) FROM " + to_string(type) + ";"; + std::string const query = "SELECT MAX(LedgerSeq) FROM " + to_string(type) + ";"; // SOCI requires boost::optional (not std::optional) as the parameter. boost::optional m; session << query, soci::into(m); @@ -330,7 +377,7 @@ saveValidatedLedger( } { - static std::string addLedger( + static std::string const addLedger( R"sql(INSERT OR REPLACE INTO Ledgers (LedgerHash,LedgerSeq,PrevHash,TotalCoins,ClosingTime,PrevClosingTime, CloseTimeRes,CloseFlags,AccountSetHash,TransSetHash) @@ -576,7 +623,7 @@ getHashesByIndex(soci::session& session, LedgerIndex minSeq, LedgerIndex maxSeq, std::pair>, int> getTxHistory(soci::session& session, Application& app, LedgerIndex startIndex, int quantity) { - std::string sql = boost::str( + std::string const sql = boost::str( boost::format( "SELECT LedgerSeq, Status, RawTxn " "FROM Transactions ORDER BY LedgerSeq DESC LIMIT %u,%u;") % @@ -749,7 +796,7 @@ getAccountTxs( { RelationalDatabase::AccountTxs ret; - std::string sql = transactionsSQL( + std::string const sql = transactionsSQL( app, "AccountTransactions.LedgerSeq,Status,RawTxn,TxnMeta", options, @@ -873,7 +920,7 @@ getAccountTxsB( { std::vector ret; - std::string sql = transactionsSQL( + std::string const sql = transactionsSQL( app, "AccountTransactions.LedgerSeq,Status,RawTxn,TxnMeta", options, @@ -1222,7 +1269,7 @@ getTransaction( if (!ledgerSeq) return std::pair{std::move(txn), nullptr}; - std::uint32_t inLedger = rangeCheckedCast(ledgerSeq.value()); + std::uint32_t const inLedger = rangeCheckedCast(ledgerSeq.value()); auto txMeta = std::make_shared(id, inLedger, rawMeta); @@ -1242,7 +1289,8 @@ getTransaction( bool dbHasSpace(soci::session& session, Config const& config, beast::Journal j) { - boost::filesystem::space_info space = boost::filesystem::space(config.legacy("database_path")); + boost::filesystem::space_info const space = + boost::filesystem::space(config.legacy("database_path")); if (space.available < megabytes(512)) { @@ -1252,8 +1300,8 @@ dbHasSpace(soci::session& session, Config const& config, beast::Journal j) if (config.useTxTables()) { - DatabaseCon::Setup dbSetup = setup_DatabaseCon(config); - boost::filesystem::path dbPath = dbSetup.dataDir / TxDBName; + DatabaseCon::Setup const dbSetup = setup_DatabaseCon(config); + boost::filesystem::path const dbPath = dbSetup.dataDir / TxDBName; boost::system::error_code ec; std::optional dbSize = boost::filesystem::file_size(dbPath, ec); if (ec) @@ -1274,8 +1322,8 @@ dbHasSpace(soci::session& session, Config const& config, beast::Journal j) }(); std::uint32_t pageCount = 0; session << "PRAGMA page_count;", soci::into(pageCount); - std::uint32_t freePages = maxPages - pageCount; - std::uint64_t freeSpace = safe_cast(freePages) * pageSize; + std::uint32_t const freePages = maxPages - pageCount; + std::uint64_t const freeSpace = safe_cast(freePages) * pageSize; JLOG(j.info()) << "Transaction DB pathname: " << dbPath.string() << "; file size: " << dbSize.value_or(-1) << " bytes" << "; SQLite page size: " << pageSize << " bytes" @@ -1287,7 +1335,7 @@ dbHasSpace(soci::session& session, Config const& config, beast::Journal j) if (freeSpace < megabytes(512)) { JLOG(j.fatal()) << "Free SQLite space for transaction db is less than " - "512MB. To fix this, rippled must be executed with the " + "512MB. To fix this, xrpld must be executed with the " "vacuum parameter before restarting. " "Note that this activity can take multiple days, " "depending on database size."; diff --git a/src/xrpld/app/rdb/backend/detail/SQLiteDatabase.cpp b/src/xrpld/app/rdb/backend/detail/SQLiteDatabase.cpp index 90d3b5a8e4..0ae39f41c1 100644 --- a/src/xrpld/app/rdb/backend/detail/SQLiteDatabase.cpp +++ b/src/xrpld/app/rdb/backend/detail/SQLiteDatabase.cpp @@ -1,13 +1,37 @@ -#include -#include -#include #include -#include -#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { bool diff --git a/src/xrpld/app/rdb/detail/PeerFinder.cpp b/src/xrpld/app/rdb/detail/PeerFinder.cpp index d619d4bb85..2f8d0355af 100644 --- a/src/xrpld/app/rdb/detail/PeerFinder.cpp +++ b/src/xrpld/app/rdb/detail/PeerFinder.cpp @@ -1,11 +1,33 @@ #include +#include + +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include + namespace xrpl { void initPeerFinderDB(soci::session& session, BasicConfig const& config, beast::Journal j) { - DBConfig m_sociConfig(config, "peerfinder"); + DBConfig const m_sociConfig(config, "peerfinder"); m_sociConfig.open(session); JLOG(j.info()) << "Opening database at '" << m_sociConfig.connectionString() << "'"; diff --git a/src/xrpld/consensus/Consensus.cpp b/src/xrpld/consensus/Consensus.cpp index 29d0e9db1c..309813cf7e 100644 --- a/src/xrpld/consensus/Consensus.cpp +++ b/src/xrpld/consensus/Consensus.cpp @@ -1,6 +1,16 @@ #include +#include +#include + #include +#include + +#include +#include +#include +#include +#include namespace xrpl { @@ -132,7 +142,7 @@ checkConsensusReached( CLOG(clog) << "agreeing and total adjusted: " << agreeing << ',' << total << ". "; } - std::size_t currentPercentage = (agreeing * 100) / total; + std::size_t const currentPercentage = (agreeing * 100) / total; CLOG(clog) << "currentPercentage: " << currentPercentage; bool const ret = currentPercentage >= minConsensusPct; diff --git a/src/xrpld/consensus/Consensus.h b/src/xrpld/consensus/Consensus.h index 2ed40cd2eb..4337e8da01 100644 --- a/src/xrpld/consensus/Consensus.h +++ b/src/xrpld/consensus/Consensus.h @@ -554,7 +554,7 @@ private: ConsensusParms::AvalancheState closeTimeAvalancheState_ = ConsensusParms::init; // Time it took for the last consensus round to converge - std::chrono::milliseconds prevRoundTime_; + std::chrono::milliseconds prevRoundTime_{}; //------------------------------------------------------------------------- // Network time measurements of consensus progress @@ -779,9 +779,13 @@ Consensus::peerProposalInternal( } if (peerPosIt != currPeerPositions_.end()) + { peerPosIt->second = newPeerPos; + } else + { currPeerPositions_.emplace(peerID, newPeerPos); + } } if (newPeerProp.isInitial()) @@ -803,7 +807,9 @@ Consensus::peerProposalInternal( // spawn a request for it and return nullopt/nullptr. It will call // gotTxSet once it arrives if (auto set = adaptor_.acquireTxSet(newPeerProp.position())) + { gotTxSet(now_, *set); + } else JLOG(j_.debug()) << "Don't have tx set for peer"; } @@ -843,9 +849,13 @@ Consensus::timerEntry( } if (phase_ == ConsensusPhase::open) + { phaseOpen(clog); + } else if (phase_ == ConsensusPhase::establish) + { phaseEstablish(clog); + } CLOG(clog) << "timerEntry finishing in phase " << to_string(phase_) << ". "; } @@ -932,7 +942,9 @@ Consensus::getJson(bool full) const ret["close_granularity"] = static_cast(closeResolution_.count()); } else + { ret["synched"] = false; + } ret["phase"] = to_string(phase_); @@ -1116,7 +1128,7 @@ Consensus::phaseOpen(std::unique_ptr const& clog) using namespace std::chrono; // it is shortly before ledger close time - bool anyTransactions = adaptor_.hasOpenTransactions(); + bool const anyTransactions = adaptor_.hasOpenTransactions(); auto proposersClosed = currPeerPositions_.size(); auto proposersValidated = adaptor_.proposersValidated(prevLedgerID_); @@ -1137,9 +1149,13 @@ Consensus::phaseOpen(std::unique_ptr const& clog) : prevCloseTime_; // use the time we saw internally if (now_ >= lastCloseTime) + { sinceClose = duration_cast(now_ - lastCloseTime); + } else + { sinceClose = -duration_cast(lastCloseTime - now_); + } CLOG(clog) << "calculating how long since last ledger's close time " "based on mode : " << to_string(mode) << ", previous closeAgree: " << closeAgree @@ -1186,7 +1202,7 @@ Consensus::shouldPause(std::unique_ptr const& clog) previousLedger_.seq() - std::min(adaptor_.getValidLedgerIndex(), previousLedger_.seq())); auto [quorum, trustedKeys] = adaptor_.getQuorumKeys(); std::size_t const totalValidators = trustedKeys.size(); - std::size_t laggards = adaptor_.laggards(previousLedger_.seq(), trustedKeys); + std::size_t const laggards = adaptor_.laggards(previousLedger_.seq(), trustedKeys); std::size_t const offline = trustedKeys.size(); std::stringstream vars; @@ -1201,7 +1217,7 @@ Consensus::shouldPause(std::unique_ptr const& clog) << "offline: " << offline << ", " << "quorum: " << quorum << ")"; - if (!ahead || !laggards || !totalValidators || !adaptor_.validator() || + if ((ahead == 0u) || (laggards == 0u) || (totalValidators == 0u) || !adaptor_.validator() || !adaptor_.haveValidated() || result_->roundTime.read() > parms.ledgerMAX_CONSENSUS) { j_.debug() << "not pausing (early)" << vars.str(); @@ -1408,7 +1424,7 @@ this. inline int participantsNeeded(int participants, int percent) { - int result = ((participants * percent) + (percent / 2)) / 100; + int const result = ((participants * percent) + (percent / 2)) / 100; return (result == 0) ? 1 : result; } @@ -1757,7 +1773,7 @@ Consensus::createDisputes(TxSet_t const& o, std::unique_ptrtxns.find(txId) && o.find(txId)), "xrpl::Consensus::createDisputes : has disputed transactions"); - Tx_t tx = inThisSet ? result_->txns.find(txId) : o.find(txId); + Tx_t const tx = inThisSet ? result_->txns.find(txId) : o.find(txId); auto txID = tx.id(); if (result_->disputes.find(txID) != result_->disputes.end()) diff --git a/src/xrpld/consensus/ConsensusTypes.h b/src/xrpld/consensus/ConsensusTypes.h index 2331c9dfbf..8aba48f34e 100644 --- a/src/xrpld/consensus/ConsensusTypes.h +++ b/src/xrpld/consensus/ConsensusTypes.h @@ -117,7 +117,7 @@ class ConsensusTimer { using time_point = std::chrono::steady_clock::time_point; time_point start_; - std::chrono::milliseconds dur_; + std::chrono::milliseconds dur_{}; public: std::chrono::milliseconds diff --git a/src/xrpld/consensus/DisputedTx.h b/src/xrpld/consensus/DisputedTx.h index 89cb5115bb..2cfbedf7f1 100644 --- a/src/xrpld/consensus/DisputedTx.h +++ b/src/xrpld/consensus/DisputedTx.h @@ -39,7 +39,7 @@ public: @param j Journal for debugging */ DisputedTx(Tx_t const& tx, bool ourVote, std::size_t numPeers, beast::Journal j) - : yays_(0), nays_(0), ourVote_(ourVote), tx_(tx), j_(j) + : ourVote_(ourVote), tx_(tx), j_(j) { votes_.reserve(numPeers); } @@ -97,10 +97,12 @@ public: // Compute the percentage of nodes voting 'yes' (possibly including us) int const support = (yays_ + (proposing && ourVote_ ? 1 : 0)) * 100; - int total = nays_ + yays_ + (proposing ? 1 : 0); - if (!total) + int const total = nays_ + yays_ + (proposing ? 1 : 0); + if (total == 0) + { // There are no votes, so we know nothing return false; + } int const weight = support / total; // Returns true if the tx has more than minCONSENSUS_PCT (80) percent // agreement. Either voting for _or_ voting against the tx. @@ -173,8 +175,8 @@ public: getJson() const; private: - int yays_; //< Number of yes votes - int nays_; //< Number of no votes + int yays_{0}; //< Number of yes votes + int nays_{0}; //< Number of no votes bool ourVote_; //< Our vote (true is yes) Tx_t tx_; //< Transaction under dispute Map_t votes_; //< Map from NodeID to vote @@ -210,7 +212,7 @@ DisputedTx::setVote(NodeID_t const& peer, bool votesYes) return true; } // changes vote to yes - else if (votesYes && !it->second) + if (votesYes && !it->second) { JLOG(j_.debug()) << "Peer " << peer << " now votes YES on " << tx_.id(); --nays_; @@ -219,7 +221,7 @@ DisputedTx::setVote(NodeID_t const& peer, bool votesYes) return true; } // changes vote to no - else if (!votesYes && it->second) + if (!votesYes && it->second) { JLOG(j_.debug()) << "Peer " << peer << " now votes NO on " << tx_.id(); ++nays_; @@ -240,9 +242,13 @@ DisputedTx::unVote(NodeID_t const& peer) if (it != votes_.end()) { if (it->second) + { --yays_; + } else + { --nays_; + } votes_.erase(it); } @@ -258,8 +264,8 @@ DisputedTx::updateVote(int percentTime, bool proposing, Consensu if (!ourVote_ && (yays_ == 0)) return false; - bool newPosition; - int weight; + bool newPosition = false; + int weight = 0; // When proposing, to prevent avalanche stalls, we increase the needed // weight slightly over time. We also need to ensure that the consensus has diff --git a/src/xrpld/consensus/LedgerTrie.h b/src/xrpld/consensus/LedgerTrie.h index d34dda8e1b..f042853712 100644 --- a/src/xrpld/consensus/LedgerTrie.h +++ b/src/xrpld/consensus/LedgerTrie.h @@ -72,7 +72,7 @@ public: XRPL_ASSERT(ledger_.seq() == start_, "xrpl::Span::Span : ledger is genesis"); } - Span(Ledger ledger) : start_{0}, end_{ledger.seq() + Seq{1}}, ledger_{std::move(ledger)} + Span(Ledger ledger) : end_{ledger.seq() + Seq{1}}, ledger_{std::move(ledger)} { } @@ -128,7 +128,7 @@ public: SpanTip tip() const { - Seq tipSeq{end_ - Seq{1}}; + Seq const tipSeq{end_ - Seq{1}}; return SpanTip{tipSeq, ledger_[tipSeq], ledger_}; } @@ -149,8 +149,8 @@ private: std::optional sub(Seq from, Seq to) const { - Seq newFrom = clamp(from); - Seq newTo = clamp(to); + Seq const newFrom = clamp(from); + Seq const newTo = clamp(to); if (newFrom < newTo) return Span(newFrom, newTo, ledger_); return std::nullopt; @@ -344,6 +344,7 @@ class LedgerTrie std::pair find(Ledger const& ledger) const { + // NOLINTNEXTLINE(misc-const-correctness) Node* curr = root.get(); // Root is always defined and is in common with all ledgers @@ -382,7 +383,7 @@ class LedgerTrie Node* findByLedgerID(Ledger const& ledger, Node* parent = nullptr) const { - if (!parent) + if (parent == nullptr) parent = root.get(); if (ledger.id() == parent->span.tip().id) return parent; @@ -512,7 +513,7 @@ public: { Node* loc = findByLedgerID(ledger); // Must be exact match with tip support - if (!loc || loc->tipSupport == 0) + if ((loc == nullptr) || loc->tipSupport == 0) return false; // found our node, remove it @@ -552,7 +553,9 @@ public: parent->erase(loc); } else + { break; + } loc = parent; } return true; @@ -581,7 +584,7 @@ public: branchSupport(Ledger const& ledger) const { Node const* loc = findByLedgerID(ledger); - if (!loc) + if (loc == nullptr) { Seq diffSeq; std::tie(loc, diffSeq) = find(ledger); @@ -691,8 +694,10 @@ public: uncommitted += uncommittedIt->second; uncommittedIt++; } - else // otherwise we jump to the end of the span + else + { // otherwise we jump to the end of the span nextSeq = curr->span.end(); + } } // We did not consume the entire span, so we have found the // preferred ledger @@ -735,9 +740,13 @@ public: // If the best child has margin exceeding the uncommitted support, // continue from that child, otherwise we are done if (best && ((margin > uncommitted) || (uncommitted == 0))) + { curr = best; - else // current is the best + } + else + { // current is the best done = true; + } } return curr->span.tip(); } @@ -784,7 +793,7 @@ public: { Node const* curr = nodes.top(); nodes.pop(); - if (!curr) + if (curr == nullptr) continue; // Node with 0 tip support must have multiple children diff --git a/src/xrpld/consensus/Validations.h b/src/xrpld/consensus/Validations.h index 4cd922d6b2..00f10f89cf 100644 --- a/src/xrpld/consensus/Validations.h +++ b/src/xrpld/consensus/Validations.h @@ -369,7 +369,9 @@ private: it = acquiring_.erase(it); } else + { ++it; + } } } @@ -422,7 +424,7 @@ private: checkAcquired(lock); - std::pair valPair{val.seq(), val.ledgerID()}; + std::pair const valPair{val.seq(), val.ledgerID()}; auto it = acquiring_.find(valPair); if (it != acquiring_.end()) { @@ -431,9 +433,13 @@ private: else { if (std::optional ledger = adaptor_.acquire(val.ledgerID())) + { updateTrie(lock, nodeID, *ledger); + } else + { acquiring_[valPair].insert(nodeID); + } } } @@ -479,7 +485,7 @@ private: void current(std::lock_guard const& lock, Pre&& pre, F&& f) { - NetClock::time_point t = adaptor_.now(); + NetClock::time_point const t = adaptor_.now(); pre(current_.size()); auto it = current_.begin(); while (it != current_.end()) @@ -569,7 +575,7 @@ public: bool canValidateSeq(Seq const s) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; return localSeqEnforcer_(byLedger_.clock().now(), s, parms_); } @@ -588,7 +594,7 @@ public: return ValStatus::stale; { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; // Check that validation sequence is greater than any non-expired // validations sequence from that validator; if it's not, perform @@ -645,7 +651,7 @@ public: if (!inserted) { // Replace existing only if this one is newer - Validation& oldVal = it->second; + Validation const& oldVal = it->second; if (val.signTime() > oldVal.signTime()) { std::pair old(oldVal.seq(), oldVal.ledgerID()); @@ -654,7 +660,9 @@ public: updateTrie(lock, nodeID, val, old); } else + { return ValStatus::stale; + } } else if (val.trusted()) { @@ -674,7 +682,7 @@ public: void setSeqToKeep(Seq const& low, Seq const& high) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; XRPL_ASSERT(low < high, "xrpl::Validations::setSeqToKeep : valid inputs"); toKeep_ = {low, high}; } @@ -689,7 +697,7 @@ public: { auto const start = std::chrono::steady_clock::now(); { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; if (toKeep_) { // We only need to refresh the keep range when it's just about @@ -746,7 +754,7 @@ public: void trustChanged(hash_set const& added, hash_set const& removed) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; for (auto& [nodeId, validation] : current_) { @@ -782,7 +790,7 @@ public: Json::Value getJsonTrie() const { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; return trie_.getJson(); } @@ -801,7 +809,7 @@ public: std::optional> getPreferred(Ledger const& curr) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; std::optional> preferred = withTrie(lock, [this](LedgerTrie& trie) { return trie.getPreferred(localSeqEnforcer_.largest()); }); @@ -913,13 +921,15 @@ public: std::size_t getNodesAfter(Ledger const& ledger, ID const& ledgerID) { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; // Use trie if ledger is the right one if (ledger.id() == ledgerID) + { return withTrie(lock, [&ledger](LedgerTrie& trie) { return trie.branchSupport(ledger) - trie.tipSupport(ledger); }); + } // Count parent ledgers as fallback return std::count_if(lastLedger_.begin(), lastLedger_.end(), [&ledgerID](auto const& it) { @@ -936,7 +946,7 @@ public: currentTrusted() { std::vector ret; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; current( lock, [&](std::size_t numValidations) { ret.reserve(numValidations); }, @@ -955,7 +965,7 @@ public: getCurrentNodeIDs() -> hash_set { hash_set ret; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; current( lock, [&](std::size_t numValidations) { ret.reserve(numValidations); }, @@ -973,7 +983,7 @@ public: numTrustedForLedger(ID const& ledgerID) { std::size_t count = 0; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; byLedger( lock, ledgerID, @@ -995,7 +1005,7 @@ public: getTrustedForLedger(ID const& ledgerID, Seq const& seq) { std::vector res; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; byLedger( lock, ledgerID, @@ -1018,7 +1028,7 @@ public: fees(ID const& ledgerID, std::uint32_t baseFee) { std::vector res; - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; byLedger( lock, ledgerID, @@ -1028,9 +1038,13 @@ public: { std::optional loadFee = v.loadFee(); if (loadFee) + { res.push_back(*loadFee); + } else + { res.push_back(baseFee); + } } }); return res; @@ -1041,7 +1055,7 @@ public: void flush() { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; current_.clear(); } @@ -1084,28 +1098,28 @@ public: std::size_t sizeOfCurrentCache() const { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; return current_.size(); } std::size_t sizeOfSeqEnforcersCache() const { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; return seqEnforcers_.size(); } std::size_t sizeOfByLedgerCache() const { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; return byLedger_.size(); } std::size_t sizeOfBySequenceCache() const { - std::lock_guard lock{mutex_}; + std::lock_guard const lock{mutex_}; return bySequence_.size(); } }; diff --git a/src/xrpld/core/Config.h b/src/xrpld/core/Config.h index 78a35c6bc1..d4d8396ba5 100644 --- a/src/xrpld/core/Config.h +++ b/src/xrpld/core/Config.h @@ -273,10 +273,10 @@ public: // First, attempt to load the latest ledger directly from disk. bool FAST_LOAD = false; - // When starting rippled with existing database it do not know it has those + // When starting xrpld with existing database it do not know it has those // ledgers locally until the server naturally tries to backfill. This makes // is difficult to test some functionality (in particular performance - // testing sidechains). With this variable the user is able to force rippled + // testing sidechains). With this variable the user is able to force xrpld // to consider the ledger range to be present. It should be used for testing // only. std::optional> FORCED_LEDGER_RANGE_PRESENT; diff --git a/src/xrpld/core/TimeKeeper.h b/src/xrpld/core/TimeKeeper.h index 72c4468e1f..83c0d81d60 100644 --- a/src/xrpld/core/TimeKeeper.h +++ b/src/xrpld/core/TimeKeeper.h @@ -11,7 +11,7 @@ namespace xrpl { class TimeKeeper : public beast::abstract_clock { private: - std::atomic closeOffset_{}; + std::atomic closeOffset_; // Adjust system_clock::time_point for NetClock epoch static constexpr time_point @@ -34,7 +34,7 @@ public: protocol, but it is possible for them to make an educated guess if this server publishes proposals or validations. - @note The network time is adjusted for the "Ripple epoch" which + @note The network time is adjusted for the "XRPL epoch" which was arbitrarily defined as 2000-01-01T00:00:00Z by Arthur Britto and David Schwartz during early development of the code. No rationale has been provided for this curious and diff --git a/src/xrpld/core/detail/Config.cpp b/src/xrpld/core/detail/Config.cpp index c7179c181b..23a0e8bee7 100644 --- a/src/xrpld/core/detail/Config.cpp +++ b/src/xrpld/core/detail/Config.cpp @@ -1,27 +1,55 @@ #include + #include +#include #include #include #include +#include #include #include -#include +#include +#include #include #include #include +#include +#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include // IWYU pragma: keep +#include +#include +#include #include +#include +#include +#include #include #include #include +#include +#include +#include #include +#include +#include +#include #include +#include +#include +#include #if BOOST_OS_WINDOWS #include @@ -43,7 +71,7 @@ getMemorySize() #endif #if BOOST_OS_LINUX -#include +#include // IWYU pragma: keep namespace xrpl { namespace detail { @@ -64,7 +92,6 @@ getMemorySize() #if BOOST_OS_MACOS #include -#include namespace xrpl { namespace detail { @@ -112,11 +139,12 @@ sizedItems {SizedItem::ramSizeGB, {{ 6, 8, 12, 24, 0 }}}, {SizedItem::accountIdCacheSize, {{ 20047, 50053, 77081, 150061, 300007 }}} }}; +// clang-format on // Ensure that the order of entries in the table corresponds to the // order of entries in the enum: static_assert( - []() constexpr->bool { + []() constexpr -> bool { std::underlying_type_t idx = 0; for (auto const& i : sizedItems) @@ -130,7 +158,6 @@ static_assert( return true; }(), "Mismatch between sized item enum & array indices"); -// clang-format on // // TODO: Check permissions on config file before using it. @@ -390,10 +417,10 @@ Config::setup(std::string const& strConf, bool bQuiet, bool bSilent, bool bStand if (RUN_STANDALONE) LEDGER_HISTORY = 0; - Section ledgerTxTablesSection = section("ledger_tx_tables"); + Section const ledgerTxTablesSection = section("ledger_tx_tables"); get_if_exists(ledgerTxTablesSection, "use_tx_tables", USE_TX_TABLES); - Section& nodeDbSection{section(ConfigSection::nodeDatabase())}; + Section const& nodeDbSection{section(ConfigSection::nodeDatabase())}; get_if_exists(nodeDbSection, "fast_load", FAST_LOAD); } @@ -471,7 +498,7 @@ Config::loadFromString(std::string const& fileContents) if (std::count(line.begin(), line.end(), ':') != 1) continue; - std::string result = std::regex_replace(line, e, " $1"); + std::string const result = std::regex_replace(line, e, " $1"); // sanity check the result of the replace, should be same length // as input if (result.size() == line.size()) @@ -487,7 +514,7 @@ Config::loadFromString(std::string const& fileContents) std::string dbPath; if (getSingleSection(secConfig, "database_path", dbPath, j_)) { - boost::filesystem::path p(dbPath); + boost::filesystem::path const p(dbPath); legacy("database_path", boost::filesystem::absolute(p).string()); } } @@ -890,7 +917,7 @@ Config::loadFromString(std::string const& fileContents) ", must be: [0-9]+ [minutes|hours|days|weeks]"); } - std::uint32_t duration = beast::lexicalCastThrow(match[1].str()); + std::uint32_t const duration = beast::lexicalCastThrow(match[1].str()); if (boost::iequals(match[2], "minutes")) { @@ -1226,7 +1253,7 @@ setup_DatabaseCon(Config const& c, std::optional j) "Configuration file may not define both " "\"safety_level\" and \"journal_mode\""); } - bool higherRisk = + bool const higherRisk = boost::iequals(journal_mode, "memory") || boost::iequals(journal_mode, "off"); showRiskWarning = showRiskWarning || higherRisk; if (higherRisk || boost::iequals(journal_mode, "delete") || @@ -1250,7 +1277,7 @@ setup_DatabaseCon(Config const& c, std::optional j) "Configuration file may not define both " "\"safety_level\" and \"synchronous\""); } - bool higherRisk = boost::iequals(synchronous, "off"); + bool const higherRisk = boost::iequals(synchronous, "off"); showRiskWarning = showRiskWarning || higherRisk; if (higherRisk || boost::iequals(synchronous, "normal") || boost::iequals(synchronous, "full") || boost::iequals(synchronous, "extra")) @@ -1271,7 +1298,7 @@ setup_DatabaseCon(Config const& c, std::optional j) "Configuration file may not define both " "\"safety_level\" and \"temp_store\""); } - bool higherRisk = boost::iequals(temp_store, "memory"); + bool const higherRisk = boost::iequals(temp_store, "memory"); showRiskWarning = showRiskWarning || higherRisk; if (higherRisk || boost::iequals(temp_store, "default") || boost::iequals(temp_store, "file")) diff --git a/src/xrpld/core/detail/NetworkIDServiceImpl.cpp b/src/xrpld/core/detail/NetworkIDServiceImpl.cpp index 839eb0c464..38e72a4db6 100644 --- a/src/xrpld/core/detail/NetworkIDServiceImpl.cpp +++ b/src/xrpld/core/detail/NetworkIDServiceImpl.cpp @@ -1,6 +1,7 @@ -#include #include +#include + namespace xrpl { NetworkIDServiceImpl::NetworkIDServiceImpl(std::uint32_t networkID) : networkID_(networkID) diff --git a/src/xrpld/overlay/ClusterNode.h b/src/xrpld/overlay/ClusterNode.h index c6ab208383..8a8a8bf052 100644 --- a/src/xrpld/overlay/ClusterNode.h +++ b/src/xrpld/overlay/ClusterNode.h @@ -50,7 +50,7 @@ private: PublicKey const identity_; std::string name_; std::uint32_t mLoadFee = 0; - NetClock::time_point mReportTime = {}; + NetClock::time_point mReportTime; }; } // namespace xrpl diff --git a/src/xrpld/overlay/Compression.h b/src/xrpld/overlay/Compression.h index e9f530035a..9c4e84f317 100644 --- a/src/xrpld/overlay/Compression.h +++ b/src/xrpld/overlay/Compression.h @@ -36,20 +36,20 @@ decompress( try { if (algorithm == Algorithm::LZ4) + { return xrpl::compression_algorithms::lz4Decompress( in, inSize, decompressed, decompressedSize); - else - { - // LCOV_EXCL_START - JLOG(debugLog().warn()) - << "decompress: invalid compression algorithm " << static_cast(algorithm); - UNREACHABLE( - "xrpl::compression::decompress : invalid compression " - "algorithm"); - // LCOV_EXCL_STOP } + + // LCOV_EXCL_START + JLOG(debugLog().warn()) << "decompress: invalid compression algorithm " + << static_cast(algorithm); + UNREACHABLE( + "xrpl::compression::decompress : invalid compression " + "algorithm"); + // LCOV_EXCL_STOP } - catch (...) + catch (...) // NOLINT(bugprone-empty-catch) { } return 0; @@ -75,20 +75,20 @@ compress( try { if (algorithm == Algorithm::LZ4) + { return xrpl::compression_algorithms::lz4Compress( in, inSize, std::forward(bf)); - else - { - // LCOV_EXCL_START - JLOG(debugLog().warn()) - << "compress: invalid compression algorithm" << static_cast(algorithm); - UNREACHABLE( - "xrpl::compression::compress : invalid compression " - "algorithm"); - // LCOV_EXCL_STOP } + + // LCOV_EXCL_START + JLOG(debugLog().warn()) << "compress: invalid compression algorithm" + << static_cast(algorithm); + UNREACHABLE( + "xrpl::compression::compress : invalid compression " + "algorithm"); + // LCOV_EXCL_STOP } - catch (...) + catch (...) // NOLINT(bugprone-empty-catch) { } return 0; diff --git a/src/xrpld/overlay/Overlay.h b/src/xrpld/overlay/Overlay.h index f1d1104d4e..7d2508a584 100644 --- a/src/xrpld/overlay/Overlay.h +++ b/src/xrpld/overlay/Overlay.h @@ -18,7 +18,7 @@ namespace boost { namespace asio { namespace ssl { class context; -} +} // namespace ssl } // namespace asio } // namespace boost diff --git a/src/xrpld/overlay/Peer.h b/src/xrpld/overlay/Peer.h index a0e4c040fd..df2cc5bcb7 100644 --- a/src/xrpld/overlay/Peer.h +++ b/src/xrpld/overlay/Peer.h @@ -11,7 +11,7 @@ namespace xrpl { namespace Resource { class Charge; -} +} // namespace Resource enum class ProtocolFeature { ValidatorListPropagation, diff --git a/src/xrpld/overlay/README.md b/src/xrpld/overlay/README.md index 51eb96a001..bda0027ea7 100644 --- a/src/xrpld/overlay/README.md +++ b/src/xrpld/overlay/README.md @@ -3,11 +3,11 @@ ## Introduction The _XRP Ledger network_ consists of a collection of _peers_ running -**`rippled`** or other compatible software. Each peer maintains multiple +**`xrpld`** or other compatible software. Each peer maintains multiple outgoing connections and optional incoming connections to other peers. These connections are made over both the public Internet and private local area networks. This network defines a connected directed graph of nodes -where vertices are instances of `rippled` and edges are persistent TCP/IP +where vertices are instances of `xrpld` and edges are persistent TCP/IP connections. Peers send and receive messages to other connected peers. This peer to peer network, layered on top of the public and private Internet, forms an [_overlay network_][overlay_network]. The contents of the messages @@ -56,7 +56,7 @@ failed (e.g. by sending HTTP 400 "Bad Request" or HTTP 503 "Service Unavailable" ``` GET / HTTP/1.1 -User-Agent: rippled-1.4.0-b1+DEBUG +User-Agent: xrpld-1.4.0-b1+DEBUG Upgrade: RTXP/1.2, XRPL/2.0 Connection: Upgrade Connect-As: Peer @@ -77,7 +77,7 @@ HTTP/1.1 101 Switching Protocols Connection: Upgrade Upgrade: RTXP/1.2 Connect-As: Peer -Server: rippled-1.3.1 +Server: xrpld-1.3.1 Crawl: public Public-Key: n9K1ZXXXzzA3dtgKBuQUnZXkhygMRgZbSo3diFNPVHLMsUG5osJM Session-Signature: MEQCIHMlLGTcGyPvHji7WY2nRM2B0iSBnw9xeDUGW7bPq7IjAiAmy+ofEu+8nOq2eChRTr3wjoKi3EYRqLgzP+q+ORFcig== @@ -90,7 +90,7 @@ Previous-Ledger: EPvIpAD2iavGFyyZYi8REexAXyKGXsi1jMF7OIBY6/Y= ``` HTTP/1.1 503 Service Unavailable -Server: rippled-0.27.0 +Server: xrpld-0.27.0 Remote-Address: 63.104.209.13 Content-Length: 253 Content-Type: application/json @@ -354,9 +354,9 @@ transferred between A and B and will not be able to intelligently tamper with th message stream between Alice and Bob, although she may be still be able to inject delays or terminate the link. -# Ripple Clustering +# XRPL clustering -A cluster consists of more than one Ripple server under common +A cluster consists of more than one XRPL server under common administration that share load information, distribute cryptography operations, and provide greater response consistency. diff --git a/src/xrpld/overlay/Slot.h b/src/xrpld/overlay/Slot.h index 11cbd09e36..f287ea46fc 100644 --- a/src/xrpld/overlay/Slot.h +++ b/src/xrpld/overlay/Slot.h @@ -98,9 +98,7 @@ private: * validator message source */ Slot(SquelchHandler const& handler, beast::Journal journal, uint16_t maxSelectedPeers) - : reachedThreshold_(0) - , lastSelected_(clock_type::now()) - , state_(SlotState::Counting) + : lastSelected_(clock_type::now()) , handler_(handler) , journal_(journal) , maxSelectedPeers_(maxSelectedPeers) @@ -220,14 +218,14 @@ private: std::unordered_set considered_; // number of peers that reached MAX_MESSAGE_THRESHOLD - std::uint16_t reachedThreshold_; + std::uint16_t reachedThreshold_{0}; // last time peers were selected, used to age the slot typename clock_type::time_point lastSelected_; - SlotState state_; // slot's state - SquelchHandler const& handler_; // squelch/unsquelch handler - beast::Journal const journal_; // logging + SlotState state_{SlotState::Counting}; // slot's state + SquelchHandler const& handler_; // squelch/unsquelch handler + beast::Journal const journal_; // logging // the maximum number of peers that should be selected as a validator // message source @@ -326,7 +324,7 @@ Slot::update( // idled peers. std::unordered_set selected; auto const consideredPoolSize = considered_.size(); - while (selected.size() != maxSelectedPeers_ && considered_.size() != 0) + while (selected.size() != maxSelectedPeers_ && !considered_.empty()) { auto i = considered_.size() == 1 ? 0 : rand_int(considered_.size() - 1); auto it = std::next(considered_.begin(), i); @@ -368,13 +366,15 @@ Slot::update( v.count = 0; if (selected.find(k) != selected.end()) + { v.state = PeerState::Selected; + } else if (v.state != PeerState::Squelched) { if (journal_.trace()) str << k << " "; v.state = PeerState::Squelched; - std::chrono::seconds duration = + std::chrono::seconds const duration = getSquelchDuration(peers_.size() - maxSelectedPeers_); v.expire = now + duration; handler_.squelch(validator, k, duration.count()); @@ -413,7 +413,7 @@ Slot::deletePeer(PublicKey const& validator, id_t id, bool erase) JLOG(journal_.trace()) << "deletePeer: " << Slice(validator) << " " << id << " selected " << (it->second.state == PeerState::Selected) << " considered " - << (considered_.find(id) != considered_.end()) << " erase " << erase; + << (considered_.contains(id)) << " erase " << erase; auto now = clock_type::now(); if (it->second.state == PeerState::Selected) { @@ -430,7 +430,7 @@ Slot::deletePeer(PublicKey const& validator, id_t id, bool erase) reachedThreshold_ = 0; state_ = SlotState::Counting; } - else if (considered_.find(id) != considered_.end()) + else if (considered_.contains(id)) { if (it->second.count > MAX_MESSAGE_THRESHOLD) --reachedThreshold_; @@ -492,8 +492,10 @@ Slot::getSelected() const { std::set r; for (auto const& [id, info] : peers_) + { if (info.state == PeerState::Selected) r.insert(id); + } return r; } @@ -506,6 +508,7 @@ Slot::getPeers() const unordered_map>(); for (auto const& [id, info] : peers_) + { r.emplace( std::make_pair( id, @@ -515,6 +518,7 @@ Slot::getPeers() const info.count, epoch(info.expire).count(), epoch(info.lastMessage).count())))); + } return r; } @@ -562,8 +566,10 @@ public: reduceRelayReady() { if (!reduceRelayReady_) + { reduceRelayReady_ = reduce_relay::epoch(clock_type::now()) > reduce_relay::WAIT_ON_BOOTUP; + } return reduceRelayReady_; } @@ -758,7 +764,9 @@ Slots::updateSlotAndSquelch( it->second.update(validator, id, type, callback); } else + { it->second.update(validator, id, type, callback); + } } template @@ -784,7 +792,9 @@ Slots::deleteIdlePeers() it = slots_.erase(it); } else + { ++it; + } } } diff --git a/src/xrpld/overlay/Squelch.h b/src/xrpld/overlay/Squelch.h index 1d92cfed3a..93f878a634 100644 --- a/src/xrpld/overlay/Squelch.h +++ b/src/xrpld/overlay/Squelch.h @@ -2,12 +2,11 @@ #include +#include #include #include -#include #include -#include namespace xrpl { @@ -89,7 +88,7 @@ Squelch::expireSquelch(PublicKey const& validator) auto const& it = squelched_.find(validator); if (it == squelched_.end()) return true; - else if (it->second > now) + if (it->second > now) return false; // squelch expired diff --git a/src/xrpld/overlay/detail/Cluster.cpp b/src/xrpld/overlay/detail/Cluster.cpp index 0ee633fb90..c74a9aa5bd 100644 --- a/src/xrpld/overlay/detail/Cluster.cpp +++ b/src/xrpld/overlay/detail/Cluster.cpp @@ -1,13 +1,24 @@ -#include -#include #include + #include +#include #include #include +#include +#include +#include #include -#include +#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -18,7 +29,7 @@ Cluster::Cluster(beast::Journal j) : j_(j) std::optional Cluster::member(PublicKey const& identity) const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto iter = nodes_.find(identity); if (iter == nodes_.end()) @@ -29,7 +40,7 @@ Cluster::member(PublicKey const& identity) const std::size_t Cluster::size() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return nodes_.size(); } @@ -41,7 +52,7 @@ Cluster::update( std::uint32_t loadFee, NetClock::time_point reportTime) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto iter = nodes_.find(identity); @@ -63,7 +74,7 @@ Cluster::update( void Cluster::for_each(std::function func) const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); for (auto const& ni : nodes_) func(ni); } diff --git a/src/xrpld/overlay/detail/ConnectAttempt.cpp b/src/xrpld/overlay/detail/ConnectAttempt.cpp index 406370ff19..d93a4ebe0f 100644 --- a/src/xrpld/overlay/detail/ConnectAttempt.cpp +++ b/src/xrpld/overlay/detail/ConnectAttempt.cpp @@ -1,11 +1,48 @@ -#include #include + +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { @@ -143,7 +180,7 @@ ConnectAttempt::onShutdown(error_code ec) // occur if a peer does not perform a graceful disconnect // - broken_pipe: the peer is gone // - application data after close notify: benign SSL shutdown condition - bool shouldLog = + bool const shouldLog = (ec != boost::asio::error::eof && ec != boost::asio::error::operation_aborted && ec.message().find("application data after close notify") == std::string::npos); @@ -287,8 +324,8 @@ ConnectAttempt::onTimer(error_code ec) // Determine which timer expired by checking their expiry times auto const now = std::chrono::steady_clock::now(); - bool globalExpired = (timer_.expiry() <= now); - bool stepExpired = (stepTimer_.expiry() <= now); + bool const globalExpired = (timer_.expiry() <= now); + bool const stepExpired = (stepTimer_.expiry() <= now); if (globalExpired) { diff --git a/src/xrpld/overlay/detail/ConnectAttempt.h b/src/xrpld/overlay/detail/ConnectAttempt.h index a3b2fd5cce..520ebe277e 100644 --- a/src/xrpld/overlay/detail/ConnectAttempt.h +++ b/src/xrpld/overlay/detail/ConnectAttempt.h @@ -145,7 +145,7 @@ public: beast::Journal journal, OverlayImpl& overlay); - ~ConnectAttempt(); + virtual ~ConnectAttempt(); /** * @brief Stop the connection attempt diff --git a/src/xrpld/overlay/detail/Handshake.cpp b/src/xrpld/overlay/detail/Handshake.cpp index 0992d252b0..22e971dd6e 100644 --- a/src/xrpld/overlay/detail/Handshake.cpp +++ b/src/xrpld/overlay/detail/Handshake.cpp @@ -1,15 +1,46 @@ -#include -#include #include +#include +#include +#include + +#include +#include +#include #include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include #include +#include -#include +#include +#include +#include +#include +#include +#include -#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include // VFALCO Shouldn't we have to include the OpenSSL // headers or something for SSL_get_finished? @@ -23,7 +54,7 @@ getFeatureValue(boost::beast::http::fields const& headers, std::string const& fe if (header == headers.end()) return {}; boost::smatch match; - boost::regex rx(feature + "=([^;\\s]+)"); + boost::regex const rx(feature + "=([^;\\s]+)"); std::string const allFeatures(header->value()); if (boost::regex_search(allFeatures, match, rx)) return {match[1]}; @@ -99,7 +130,7 @@ makeFeaturesResponseHeader( @note This construct is non-standard. There are potential "standard" alternatives that should be considered. For a discussion, on this topic, see https://github.com/openssl/openssl/issues/5509 and - https://github.com/ripple/rippled/issues/2413. + https://github.com/XRPLF/rippled/issues/2413. */ static std::optional> hashLastMessage(SSL const* ssl, size_t (*get)(const SSL*, void*, size_t)) @@ -107,12 +138,12 @@ hashLastMessage(SSL const* ssl, size_t (*get)(const SSL*, void*, size_t)) constexpr std::size_t sslMinimumFinishedLength = 12; unsigned char buf[1024]; - size_t len = get(ssl, buf, sizeof(buf)); + size_t const len = get(ssl, buf, sizeof(buf)); if (len < sslMinimumFinishedLength) return std::nullopt; - sha512_hasher h; + sha512_hasher const h; base_uint<512> cookie; SHA512(buf, len, cookie.data()); diff --git a/src/xrpld/overlay/detail/Message.cpp b/src/xrpld/overlay/detail/Message.cpp index 4d043500c7..f8d3fbc8ff 100644 --- a/src/xrpld/overlay/detail/Message.cpp +++ b/src/xrpld/overlay/detail/Message.cpp @@ -1,7 +1,20 @@ #include + +#include #include +#include +#include + +#include + +#include + +#include #include +#include +#include +#include namespace xrpl { @@ -202,7 +215,7 @@ Message::getBuffer(Compressed tryCompressed) int Message::getType(std::uint8_t const* in) { - int type = (static_cast(*(in + 4)) << 8) + *(in + 5); + int const type = (static_cast(*(in + 4)) << 8) + *(in + 5); return type; } diff --git a/src/xrpld/overlay/detail/OverlayImpl.cpp b/src/xrpld/overlay/detail/OverlayImpl.cpp index b4b0686ac8..5ff54b673b 100644 --- a/src/xrpld/overlay/detail/OverlayImpl.cpp +++ b/src/xrpld/overlay/detail/OverlayImpl.cpp @@ -1,30 +1,93 @@ +#include + #include #include #include #include +#include #include +#include #include #include -#include +#include +#include #include -#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include #include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include #include #include #include +#include #include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -36,7 +99,7 @@ enum { ServerCounts = (1 << 2), Unl = (1 << 3) }; -} +} // namespace CrawlOptions //------------------------------------------------------------------------------ @@ -126,7 +189,6 @@ OverlayImpl::OverlayImpl( collector)) , m_resolver(resolver) , next_id_(1) - , timer_count_(0) , slots_(app, *this, app.config()) , m_stats( std::bind(&OverlayImpl::collect_metrics, this), @@ -152,7 +214,7 @@ OverlayImpl::onHandoff( auto const id = next_id_++; auto peerJournal = app_.getJournal("Peer"); beast::WrappedSink sink(peerJournal.sink(), makePrefix(id)); - beast::Journal journal(sink); + beast::Journal const journal(sink); Handoff handoff; if (processRequest(request, handoff)) @@ -270,7 +332,7 @@ OverlayImpl::onHandoff( // As we are not on the strand, run() must be called // while holding the lock, otherwise new I/O can be // queued after a call to stop(). - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); { auto const result = m_peers.emplace(peer->slot(), peer); XRPL_ASSERT(result.second, "xrpl::OverlayImpl::onHandoff : peer is inserted"); @@ -393,7 +455,7 @@ OverlayImpl::connect(beast::IP::Endpoint const& remote_endpoint) app_.getJournal("Peer"), *this); - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list_.emplace(p.get(), p); p->run(); } @@ -405,9 +467,9 @@ void OverlayImpl::add_active(std::shared_ptr const& peer) { beast::WrappedSink sink{journal_.sink(), peer->prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); { auto const result = m_peers.emplace(peer->slot(), peer); @@ -435,7 +497,7 @@ OverlayImpl::add_active(std::shared_ptr const& peer) void OverlayImpl::remove(std::shared_ptr const& slot) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const iter = m_peers.find(slot); XRPL_ASSERT(iter != m_peers.end(), "xrpl::OverlayImpl::remove : valid input"); m_peers.erase(iter); @@ -444,7 +506,7 @@ OverlayImpl::remove(std::shared_ptr const& slot) void OverlayImpl::start() { - PeerFinder::Config config = PeerFinder::Config::makeConfig( + PeerFinder::Config const config = PeerFinder::Config::makeConfig( app_.config(), serverHandler_.setup().overlay.port(), app_.getValidationPublicKey().has_value(), @@ -522,7 +584,7 @@ OverlayImpl::start() }); } auto const timer = std::make_shared(*this); - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list_.emplace(timer.get(), timer); timer_ = timer; timer->async_wait(); @@ -571,11 +633,11 @@ void OverlayImpl::activate(std::shared_ptr const& peer) { beast::WrappedSink sink{journal_.sink(), peer->prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; // Now track this peer { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const result(ids_.emplace( std::piecewise_construct, std::make_tuple(peer->id()), std::make_tuple(peer))); XRPL_ASSERT(result.second, "xrpl::OverlayImpl::activate : peer ID is inserted"); @@ -591,7 +653,7 @@ OverlayImpl::activate(std::shared_ptr const& peer) void OverlayImpl::onPeerDeactivate(Peer::id_t id) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); ids_.erase(id); } @@ -664,12 +726,12 @@ OverlayImpl::reportOutboundTraffic(TrafficCount::category cat, int size) } /** The number of active peers on the network Active peers are only those peers that have completed the handshake - and are running the Ripple protocol. + and are running the XRPL protocol. */ std::size_t OverlayImpl::size() const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return ids_.size(); } @@ -916,8 +978,8 @@ OverlayImpl::processHealth(http_request_type const& req, Handoff& handoff) bool amendment_blocked = false; if (info.isMember(jss::amendment_blocked)) amendment_blocked = true; - int number_peers = info[jss::peers].asInt(); - std::string server_state = info[jss::server_state].asString(); + int const number_peers = info[jss::peers].asInt(); + std::string const server_state = info[jss::server_state].asString(); auto load_factor = info[jss::load_factor_server].asDouble() / info[jss::load_base].asDouble(); enum class HealthState { healthy, warning, critical }; @@ -1028,7 +1090,7 @@ OverlayImpl::getActivePeers( std::size_t& enabledInSkip) const { Overlay::PeerSequence ret; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); active = ids_.size(); disabled = enabledInSkip = 0; @@ -1068,7 +1130,7 @@ OverlayImpl::checkTracking(std::uint32_t index) std::shared_ptr OverlayImpl::findPeerByShortID(Peer::id_t const& id) const { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const iter = ids_.find(id); if (iter != ids_.end()) return iter->second.lock(); @@ -1080,7 +1142,7 @@ OverlayImpl::findPeerByShortID(Peer::id_t const& id) const std::shared_ptr OverlayImpl::findPeerByPublicKey(PublicKey const& pubKey) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // NOTE The purpose of peer is to delay the destruction of PeerImp std::shared_ptr peer; for (auto const& e : ids_) @@ -1141,7 +1203,7 @@ OverlayImpl::relay(protocol::TMValidation& m, uint256 const& uid, PublicKey cons std::shared_ptr OverlayImpl::getManifestsMessage() { - std::lock_guard g(manifestLock_); + std::lock_guard const g(manifestLock_); if (auto seq = app_.getValidatorManifests().sequence(); seq != manifestListSeq_) { @@ -1260,7 +1322,7 @@ OverlayImpl::relay( void OverlayImpl::remove(Child& child) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list_.erase(&child); if (list_.empty()) cond_.notify_all(); @@ -1279,7 +1341,7 @@ OverlayImpl::stopChildren() // won't be called until vector<> children leaves scope. std::vector> children; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (!work_) return; work_ = std::nullopt; @@ -1314,7 +1376,7 @@ OverlayImpl::sendEndpoints() { std::shared_ptr peer; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto const iter = m_peers.find(e.first); if (iter != m_peers.end()) peer = iter->second.lock(); diff --git a/src/xrpld/overlay/detail/OverlayImpl.h b/src/xrpld/overlay/detail/OverlayImpl.h index c816f24e0c..167d574188 100644 --- a/src/xrpld/overlay/detail/OverlayImpl.h +++ b/src/xrpld/overlay/detail/OverlayImpl.h @@ -49,9 +49,8 @@ public: explicit Child(OverlayImpl& overlay); - virtual ~Child(); - public: + virtual ~Child(); virtual void stop() = 0; }; @@ -98,7 +97,7 @@ private: hash_map> ids_; Resolver& m_resolver; std::atomic next_id_; - int timer_count_; + int timer_count_{0}; std::atomic jqTransOverflow_{0}; std::atomic peerDisconnects_{0}; std::atomic peerDisconnectsCharges_{0}; @@ -255,7 +254,7 @@ public: { std::vector> wp; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); // Iterate over a copy of the peer list because peer // destruction can invalidate iterators. @@ -573,7 +572,7 @@ private: collect_metrics() { auto counts = m_traffic.getCounts(); - std::lock_guard lock(m_statsMutex); + std::lock_guard const lock(m_statsMutex); XRPL_ASSERT( counts.size() == m_stats.trafficGauges.size(), "xrpl::OverlayImpl::collect_metrics : counts size do match"); diff --git a/src/xrpld/overlay/detail/PeerImp.cpp b/src/xrpld/overlay/detail/PeerImp.cpp index 92c5bcb221..0f87ba5a39 100644 --- a/src/xrpld/overlay/detail/PeerImp.cpp +++ b/src/xrpld/overlay/detail/PeerImp.cpp @@ -1,3 +1,6 @@ +#include + +#include #include #include #include @@ -5,31 +8,96 @@ #include #include #include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include #include #include +#include +#include #include #include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include + +#include + +#include #include #include +#include +#include +#include +#include +#include #include #include #include +#include +#include #include +#include +#include +#include +#include +#include using namespace std::chrono_literals; @@ -172,7 +240,7 @@ PeerImp::run() fail("Malformed handshake data (3)"); { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if (closed) closedLedgerHash_ = *closed; if (previous) @@ -411,7 +479,7 @@ PeerImp::json() ret[jss::protocol] = to_string(protocol_); { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if (latency_) ret[jss::latency] = static_cast(latency_->count()); } @@ -443,7 +511,7 @@ PeerImp::json() uint256 closedLedgerHash; protocol::TMStatusChange last_status; { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); closedLedgerHash = closedLedgerHash_; last_status = last_status_; } @@ -510,7 +578,7 @@ bool PeerImp::hasLedger(uint256 const& hash, std::uint32_t seq) const { { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if ((seq != 0) && (seq >= minLedger_) && (seq <= maxLedger_) && (tracking_.load() == Tracking::converged)) return true; @@ -523,7 +591,7 @@ PeerImp::hasLedger(uint256 const& hash, std::uint32_t seq) const void PeerImp::ledgerRange(std::uint32_t& minSeq, std::uint32_t& maxSeq) const { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); minSeq = minLedger_; maxSeq = maxLedger_; @@ -532,7 +600,7 @@ PeerImp::ledgerRange(std::uint32_t& minSeq, std::uint32_t& maxSeq) const bool PeerImp::hasTxSet(uint256 const& hash) const { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); return std::find(recentTxSets_.begin(), recentTxSets_.end(), hash) != recentTxSets_.end(); } @@ -541,7 +609,7 @@ PeerImp::cycleStatus() { // Operations on closedLedgerHash_ and previousLedgerHash_ must be // guarded by recentLock_. - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); previousLedgerHash_ = closedLedgerHash_; closedLedgerHash_.zero(); } @@ -549,7 +617,7 @@ PeerImp::cycleStatus() bool PeerImp::hasRange(std::uint32_t uMin, std::uint32_t uMax) { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); return (tracking_ != Tracking::diverged) && (uMin >= minLedger_) && (uMax <= maxLedger_); } @@ -641,7 +709,7 @@ PeerImp::onShutdown(error_code ec) // - stream_truncated: the tcp connection closed (no handshake) it could // occur if a peer does not perform a graceful disconnect // - broken_pipe: the peer is gone - bool shouldLog = + bool const shouldLog = (ec != boost::asio::error::eof && ec != boost::asio::error::operation_aborted && ec.message().find("application data after close notify") == std::string::npos); @@ -746,7 +814,7 @@ PeerImp::onTimer(error_code const& ec) clock_type::duration duration; { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); duration = clock_type::now() - trackingTime_; } @@ -821,7 +889,7 @@ PeerImp::doAccept() if (auto member = app_.getCluster().member(publicKey_)) { { - std::unique_lock lock{nameMutex_}; + std::unique_lock const lock{nameMutex_}; name_ = *member; } JLOG(journal_.info()) << "Cluster name: " << *member; @@ -879,7 +947,7 @@ PeerImp::doAccept() std::string PeerImp::name() const { - std::shared_lock read_lock{nameMutex_}; + std::shared_lock const read_lock{nameMutex_}; return name_; } @@ -1200,7 +1268,7 @@ PeerImp::onMessage(std::shared_ptr const& m) auto const rtt = std::chrono::round(clock_type::now() - lastPingTime_); - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if (latency_) { @@ -1246,7 +1314,7 @@ PeerImp::onMessage(std::shared_ptr const& m) } } - int loadSources = m->loadsources().size(); + int const loadSources = m->loadsources().size(); if (loadSources != 0) { Resource::Gossip gossip; @@ -1371,7 +1439,7 @@ PeerImp::handleTransaction( try { auto stx = std::make_shared(sit); - uint256 txID = stx->getTransactionID(); + uint256 const txID = stx->getTransactionID(); // Charge strongly for attempting to relay a txn with tfInnerBatchTxn // LCOV_EXCL_START @@ -1581,7 +1649,7 @@ PeerImp::onMessage(std::shared_ptr const& m) } // Queue a job to process the request - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); app_.getJobQueue().addJob(jtLEDGER_REQ, "RcvGetLedger", [weak, m]() { if (auto peer = weak.lock()) peer->processLedgerRequest(m); @@ -1599,7 +1667,7 @@ PeerImp::onMessage(std::shared_ptr const& m) } fee_.update(Resource::feeModerateBurdenPeer, "received a proof path request"); - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); app_.getJobQueue().addJob(jtREPLAY_REQ, "RcvProofPReq", [weak, m]() { if (auto peer = weak.lock()) { @@ -1649,7 +1717,7 @@ PeerImp::onMessage(std::shared_ptr const& m) } fee_.fee = Resource::feeModerateBurdenPeer; - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); app_.getJobQueue().addJob(jtREPLAY_REQ, "RcvReplDReq", [weak, m]() { if (auto peer = weak.lock()) { @@ -1769,7 +1837,7 @@ PeerImp::onMessage(std::shared_ptr const& m) // Otherwise check if received data for a candidate transaction set if (m->type() == protocol::liTS_CANDIDATE) { - std::weak_ptr weak{shared_from_this()}; + std::weak_ptr const weak{shared_from_this()}; app_.getJobQueue().addJob(jtTXN_DATA, "RcvPeerData", [weak, ledgerHash, m]() { if (auto peer = weak.lock()) { @@ -1786,7 +1854,7 @@ PeerImp::onMessage(std::shared_ptr const& m) void PeerImp::onMessage(std::shared_ptr const& m) { - protocol::TMProposeSet& set = *m; + protocol::TMProposeSet const& set = *m; auto const sig = makeSlice(set.signature()); @@ -1880,7 +1948,7 @@ PeerImp::onMessage(std::shared_ptr const& m) app_.getTimeKeeper().closeTime(), calcNodeID(app_.getValidatorManifests().getMasterKey(publicKey))}); - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); app_.getJobQueue().addJob( isTrusted ? jtPROPOSAL_t : jtPROPOSAL_ut, "checkPropose", [weak, isTrusted, m, proposal]() { if (auto peer = weak.lock()) @@ -1897,7 +1965,7 @@ PeerImp::onMessage(std::shared_ptr const& m) m->set_networktime(app_.getTimeKeeper().now().time_since_epoch().count()); { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if (!last_status_.has_newstatus() || m->has_newstatus()) { last_status_ = *m; @@ -1905,7 +1973,7 @@ PeerImp::onMessage(std::shared_ptr const& m) else { // preserve old status - protocol::NodeStatus status = last_status_.newstatus(); + protocol::NodeStatus const status = last_status_.newstatus(); last_status_ = *m; m->set_newstatus(status); } @@ -1917,7 +1985,7 @@ PeerImp::onMessage(std::shared_ptr const& m) { // Operations on closedLedgerHash_ and previousLedgerHash_ must be // guarded by recentLock_. - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if (!closedLedgerHash_.isZero()) { outOfSync = true; @@ -1939,7 +2007,7 @@ PeerImp::onMessage(std::shared_ptr const& m) { // Operations on closedLedgerHash_ and previousLedgerHash_ must be // guarded by recentLock_. - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if (peerChangedLedgers) { closedLedgerHash_ = m->ledgerhash(); @@ -1973,7 +2041,7 @@ PeerImp::onMessage(std::shared_ptr const& m) if (m->has_firstseq() && m->has_lastseq()) { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); minLedger_ = m->firstseq(); maxLedger_ = m->lastseq(); @@ -2040,7 +2108,7 @@ PeerImp::onMessage(std::shared_ptr const& m) { uint256 closedLedgerHash{}; { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); closedLedgerHash = closedLedgerHash_; } j[jss::ledger_hash] = to_string(closedLedgerHash); @@ -2068,7 +2136,7 @@ PeerImp::checkTracking(std::uint32_t validationSeq) { // Extract the sequence number of the highest // ledger this peer has - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); serverSeq = maxLedger_; } @@ -2083,7 +2151,7 @@ PeerImp::checkTracking(std::uint32_t validationSeq) void PeerImp::checkTracking(std::uint32_t seq1, std::uint32_t seq2) { - int diff = std::max(seq1, seq2) - std::min(seq1, seq2); + int const diff = std::max(seq1, seq2) - std::min(seq1, seq2); if (diff < Tuning::convergedLedgerLimit) { @@ -2094,7 +2162,7 @@ PeerImp::checkTracking(std::uint32_t seq1, std::uint32_t seq2) if ((diff > Tuning::divergedLedgerLimit) && (tracking_.load() != Tracking::diverged)) { // The peer's ledger sequence is way off the validation's - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); tracking_ = Tracking::diverged; trackingTime_ = clock_type::now(); @@ -2114,7 +2182,7 @@ PeerImp::onMessage(std::shared_ptr const& m) if (m->status() == protocol::tsHAVE) { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); if (std::find(recentTxSets_.begin(), recentTxSets_.end(), hash) != recentTxSets_.end()) { @@ -2181,7 +2249,7 @@ PeerImp::onValidatorListMessage( case ListDisposition::expired: // Future list case ListDisposition::pending: { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); XRPL_ASSERT( applyResult.publisherKey, @@ -2204,7 +2272,7 @@ PeerImp::onValidatorListMessage( case ListDisposition::known_sequence: #ifndef NDEBUG { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); XRPL_ASSERT( applyResult.sequence && applyResult.publisherKey, "xrpl::PeerImp::onValidatorListMessage : nonzero sequence " @@ -2464,7 +2532,7 @@ PeerImp::onMessage(std::shared_ptr const& m) { std::string const name = isTrusted ? "ChkTrust" : "ChkUntrust"; - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); app_.getJobQueue().addJob( isTrusted ? jtVALIDATION_t : jtVALIDATION_ut, name, [weak, val, m, key]() { if (auto peer = weak.lock()) @@ -2487,7 +2555,7 @@ PeerImp::onMessage(std::shared_ptr const& m) void PeerImp::onMessage(std::shared_ptr const& m) { - protocol::TMGetObjectByHash& packet = *m; + protocol::TMGetObjectByHash const& packet = *m; JLOG(p_journal_.trace()) << "received TMGetObjectByHash " << packet.type() << " " << packet.objects_size(); @@ -2516,7 +2584,7 @@ PeerImp::onMessage(std::shared_ptr const& m) return; } - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); app_.getJobQueue().addJob(jtREQUESTED_TXN, "DoTxs", [weak, m]() { if (auto peer = weak.lock()) peer->doTransactions(m); @@ -2555,7 +2623,7 @@ PeerImp::onMessage(std::shared_ptr const& m) uint256 const hash{obj.hash()}; // VFALCO TODO Move this someplace more sensible so we dont // need to inject the NodeStore interfaces. - std::uint32_t seq{obj.has_ledgerseq() ? obj.ledgerseq() : 0}; + std::uint32_t const seq{obj.has_ledgerseq() ? obj.ledgerseq() : 0}; auto nodeObject{app_.getNodeStore().fetchNodeObject(hash, seq)}; if (nodeObject) { @@ -2651,7 +2719,7 @@ PeerImp::onMessage(std::shared_ptr const& m) return; } - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); app_.getJobQueue().addJob(jtMISSING_TXN, "HandleHaveTxs", [weak, m]() { if (auto peer = weak.lock()) peer->handleHaveTransactions(m); @@ -2750,7 +2818,7 @@ PeerImp::onMessage(std::shared_ptr const& m) fee_.update(Resource::feeInvalidData, "squelch bad pubkey"); return; } - PublicKey key(slice); + PublicKey const key(slice); // Ignore the squelch for validator's own messages. if (key == app_.getValidationPublicKey()) @@ -2759,7 +2827,7 @@ PeerImp::onMessage(std::shared_ptr const& m) return; } - std::uint32_t duration = m->has_squelchduration() ? m->squelchduration() : 0; + std::uint32_t const duration = m->has_squelchduration() ? m->squelchduration() : 0; if (!m->squelch()) { squelch_.removeSquelch(key); @@ -2812,7 +2880,7 @@ PeerImp::doFetchPack(std::shared_ptr const& packet) uint256 const hash{packet->ledgerhash()}; - std::weak_ptr weak = shared_from_this(); + std::weak_ptr const weak = shared_from_this(); auto elapsed = UptimeClock::now(); auto const pap = &app_; app_.getJobQueue().addJob(jtPACK, "MakeFetchPack", [pap, weak, packet, hash, elapsed]() { @@ -3017,7 +3085,7 @@ PeerImp::checkPropose( if (!cluster() && !peerPos.checkSign()) { - std::string desc{"Proposal fails sig check"}; + std::string const desc{"Proposal fails sig check"}; JLOG(p_journal_.warn()) << desc; charge(Resource::feeInvalidSignature, desc); return; @@ -3061,7 +3129,7 @@ PeerImp::checkValidation( { if (!val->isValid()) { - std::string desc{"Validation forwarded by peer is invalid"}; + std::string const desc{"Validation forwarded by peer is invalid"}; JLOG(p_journal_.debug()) << desc; charge(Resource::feeInvalidSignature, desc); return; @@ -3493,7 +3561,7 @@ PeerImp::getScore(bool haveItem) const std::optional latency; { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); latency = latency_; } @@ -3512,7 +3580,7 @@ PeerImp::getScore(bool haveItem) const bool PeerImp::isHighLatency() const { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); return latency_ >= peerHighLatency; } @@ -3520,7 +3588,7 @@ void PeerImp::Metrics::add_message(std::uint64_t bytes) { using namespace std::chrono_literals; - std::unique_lock lock{mutex_}; + std::unique_lock const lock{mutex_}; totalBytes_ += bytes; accumBytes_ += bytes; @@ -3543,14 +3611,14 @@ PeerImp::Metrics::add_message(std::uint64_t bytes) std::uint64_t PeerImp::Metrics::average_bytes() const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; return rollingAvgBytes_; } std::uint64_t PeerImp::Metrics::total_bytes() const { - std::shared_lock lock{mutex_}; + std::shared_lock const lock{mutex_}; return totalBytes_; } diff --git a/src/xrpld/overlay/detail/PeerImp.h b/src/xrpld/overlay/detail/PeerImp.h index 5a687a9b2a..325dca6430 100644 --- a/src/xrpld/overlay/detail/PeerImp.h +++ b/src/xrpld/overlay/detail/PeerImp.h @@ -190,7 +190,7 @@ private: struct ChargeWithContext { Resource::Charge fee = Resource::feeTrivialPeer; - std::string context = {}; + std::string context{}; // NOLINT(readability-redundant-member-init) void update(Resource::Charge f, std::string const& add) @@ -408,7 +408,7 @@ public: return publicKey_; } - /** Return the version of rippled that the peer is running, if reported. */ + /** Return the version of xrpld that the peer is running, if reported. */ std::string getVersion() const; @@ -428,7 +428,7 @@ public: std::optional publisherListSequence(PublicKey const& pubKey) const override { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); auto iter = publisherListSequences_.find(pubKey); if (iter != publisherListSequences_.end()) @@ -439,7 +439,7 @@ public: void setPublisherListSequence(PublicKey const& pubKey, std::size_t const seq) override { - std::lock_guard sl(recentLock_); + std::lock_guard const sl(recentLock_); publisherListSequences_[pubKey] = seq; } diff --git a/src/xrpld/overlay/detail/PeerReservationTable.cpp b/src/xrpld/overlay/detail/PeerReservationTable.cpp index 78f29ad155..c61ac5cb87 100644 --- a/src/xrpld/overlay/detail/PeerReservationTable.cpp +++ b/src/xrpld/overlay/detail/PeerReservationTable.cpp @@ -1,13 +1,15 @@ #include + #include #include #include -#include +#include #include #include #include #include +#include #include #include @@ -30,7 +32,7 @@ PeerReservationTable::list() const -> std::vector { std::vector list; { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list.reserve(table_.size()); std::copy(table_.begin(), table_.end(), std::back_inserter(list)); } @@ -38,7 +40,7 @@ PeerReservationTable::list() const -> std::vector return list; } -// See `ripple/app/main/DBInit.cpp` for the `CREATE TABLE` statement. +// See `include/xrpl/rdb/DBInit.h` for the `CREATE TABLE` statement. // It is unfortunate that we do not get to define a function for it. // We choose a `bool` return type to fit in with the error handling scheme @@ -47,7 +49,7 @@ PeerReservationTable::list() const -> std::vector bool PeerReservationTable::load(DatabaseCon& connection) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); connection_ = &connection; auto db = connection.checkoutDb(); @@ -62,7 +64,7 @@ PeerReservationTable::insert_or_assign(PeerReservation const& reservation) { std::optional previous; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); auto hint = table_.find(reservation); if (hint != table_.end()) @@ -96,9 +98,9 @@ PeerReservationTable::erase(PublicKey const& nodeId) { std::optional previous; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); - auto const it = table_.find({nodeId}); + auto const it = table_.find({.nodeId = nodeId}); if (it != table_.end()) { previous = *it; diff --git a/src/xrpld/overlay/detail/PeerSet.cpp b/src/xrpld/overlay/detail/PeerSet.cpp index 3329f67e7a..b5895162aa 100644 --- a/src/xrpld/overlay/detail/PeerSet.cpp +++ b/src/xrpld/overlay/detail/PeerSet.cpp @@ -1,8 +1,24 @@ -#include -#include #include -#include +#include +#include +#include +#include + +#include +#include + +#include + +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -152,7 +168,7 @@ public: std::set const& getPeerIds() const override { - static std::set emptyPeers; + static std::set const emptyPeers; JLOG(j_.error()) << "DummyPeerSet getPeerIds should not be called"; return emptyPeers; } diff --git a/src/xrpld/overlay/detail/ProtocolMessage.h b/src/xrpld/overlay/detail/ProtocolMessage.h index ac06b10292..87098fb331 100644 --- a/src/xrpld/overlay/detail/ProtocolMessage.h +++ b/src/xrpld/overlay/detail/ProtocolMessage.h @@ -258,7 +258,9 @@ parseMessageContent(MessageHeader const& header, Buffers const& buffers) return {}; } else if (!m->ParseFromZeroCopyStream(&stream)) + { return {}; + } return m; } @@ -349,7 +351,7 @@ invokeProtocolMessage(Buffers const& buffers, Handler& handler, std::size_t& hin return result; } - bool success; + bool success = false; switch (header->message_type) { diff --git a/src/xrpld/overlay/detail/ProtocolVersion.cpp b/src/xrpld/overlay/detail/ProtocolVersion.cpp index 29bff996a9..c8bf9edfbd 100644 --- a/src/xrpld/overlay/detail/ProtocolVersion.cpp +++ b/src/xrpld/overlay/detail/ProtocolVersion.cpp @@ -3,11 +3,19 @@ #include #include +#include #include -#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include namespace xrpl { @@ -17,13 +25,10 @@ namespace xrpl { it may not contain any duplicates!) */ -// clang-format off -constexpr ProtocolVersion const supportedProtocolList[] -{ +constexpr ProtocolVersion const supportedProtocolList[]{ {2, 1}, - {2, 2} + {2, 2}, }; -// clang-format on // This ugly construct ensures that supportedProtocolList is sorted in strictly // ascending order and doesn't contain any duplicates. @@ -61,7 +66,7 @@ to_string(ProtocolVersion const& p) std::vector parseProtocolVersions(boost::beast::string_view const& value) { - static boost::regex re( + static boost::regex const re( "^" // start of line "XRPL/" // The string "XRPL/" "([2-9]|(?:[1-9][0-9]+))" // a number (greater than 2 with no leading @@ -115,9 +120,8 @@ negotiateProtocolVersion(std::vector const& versions) // output of std::set_intersection is sorted, that item is always going // to be the last one. So we get a little clever and avoid the need for // a container: - std::function pickVersion = [&result](ProtocolVersion const& v) { - result = v; - }; + std::function const pickVersion = + [&result](ProtocolVersion const& v) { result = v; }; std::set_intersection( std::begin(versions), diff --git a/src/xrpld/overlay/detail/ProtocolVersion.h b/src/xrpld/overlay/detail/ProtocolVersion.h index 5b3a1b3302..c4fa7ced0b 100644 --- a/src/xrpld/overlay/detail/ProtocolVersion.h +++ b/src/xrpld/overlay/detail/ProtocolVersion.h @@ -17,7 +17,7 @@ namespace xrpl { * */ using ProtocolVersion = std::pair; -inline constexpr ProtocolVersion +constexpr ProtocolVersion make_protocol(std::uint16_t major, std::uint16_t minor) { return {major, minor}; diff --git a/src/xrpld/overlay/detail/TrafficCount.cpp b/src/xrpld/overlay/detail/TrafficCount.cpp index 2ce32b4468..3841be28b0 100644 --- a/src/xrpld/overlay/detail/TrafficCount.cpp +++ b/src/xrpld/overlay/detail/TrafficCount.cpp @@ -1,5 +1,11 @@ #include +#include + +#include + +#include + namespace xrpl { std::unordered_map const type_lookup = { diff --git a/src/xrpld/overlay/detail/TrafficCount.h b/src/xrpld/overlay/detail/TrafficCount.h index 930e92129d..bdc0729a51 100644 --- a/src/xrpld/overlay/detail/TrafficCount.h +++ b/src/xrpld/overlay/detail/TrafficCount.h @@ -56,7 +56,7 @@ public: operator bool() const { - return messagesIn || messagesOut; + return (messagesIn != 0u) || (messagesOut != 0u); } }; diff --git a/src/xrpld/overlay/detail/TxMetrics.cpp b/src/xrpld/overlay/detail/TxMetrics.cpp index 72cd9d6fa2..c01136613d 100644 --- a/src/xrpld/overlay/detail/TxMetrics.cpp +++ b/src/xrpld/overlay/detail/TxMetrics.cpp @@ -1,8 +1,15 @@ #include +#include #include +#include + +#include +#include +#include #include +#include namespace xrpl { @@ -12,7 +19,7 @@ void TxMetrics::addMetrics(protocol::MessageType type, std::uint32_t val) { auto add = [&](auto& m, std::uint32_t val) { - std::lock_guard lock(mutex); + std::lock_guard const lock(mutex); m.addMetrics(val); }; @@ -41,7 +48,7 @@ TxMetrics::addMetrics(protocol::MessageType type, std::uint32_t val) void TxMetrics::addMetrics(std::uint32_t selected, std::uint32_t suppressed, std::uint32_t notenabled) { - std::lock_guard lock(mutex); + std::lock_guard const lock(mutex); selectedPeers.addMetrics(selected); suppressedPeers.addMetrics(suppressed); notEnabled.addMetrics(notenabled); @@ -50,7 +57,7 @@ TxMetrics::addMetrics(std::uint32_t selected, std::uint32_t suppressed, std::uin void TxMetrics::addMetrics(std::uint32_t missing) { - std::lock_guard lock(mutex); + std::lock_guard const lock(mutex); missingTx.addMetrics(missing); } @@ -94,7 +101,7 @@ SingleMetrics::addMetrics(std::uint32_t val) Json::Value TxMetrics::json() const { - std::lock_guard l(mutex); + std::lock_guard const l(mutex); Json::Value ret(Json::objectValue); diff --git a/src/xrpld/overlay/predicates.h b/src/xrpld/overlay/predicates.h index 3adecf7c6a..e0b4a626ec 100644 --- a/src/xrpld/overlay/predicates.h +++ b/src/xrpld/overlay/predicates.h @@ -101,10 +101,7 @@ struct match_peer bool operator()(std::shared_ptr const& peer) const { - if (matchPeer && (peer.get() == matchPeer)) - return true; - - return false; + return (matchPeer != nullptr) && (peer.get() == matchPeer); } }; @@ -146,10 +143,7 @@ struct peer_in_set bool operator()(std::shared_ptr const& peer) const { - if (peerSet.count(peer->id()) == 0) - return false; - - return true; + return peerSet.contains(peer->id()); } }; diff --git a/src/xrpld/peerfinder/PeerfinderManager.h b/src/xrpld/peerfinder/PeerfinderManager.h index b850a10975..2d22676e1b 100644 --- a/src/xrpld/peerfinder/PeerfinderManager.h +++ b/src/xrpld/peerfinder/PeerfinderManager.h @@ -2,6 +2,7 @@ #include #include +#include #include #include @@ -27,7 +28,7 @@ struct Config This includes both inbound and outbound, but does not include fixed peers. */ - std::size_t maxPeers; + std::size_t maxPeers{Tuning::defaultMaxPeers}; /** The number of automatic outbound connections to maintain. Outbound connections are only maintained if autoConnect @@ -39,25 +40,25 @@ struct Config Inbound connections are only maintained if wantIncoming is `true`. */ - std::size_t inPeers; + std::size_t inPeers{0}; /** `true` if we want our IP address kept private. */ bool peerPrivate = true; /** `true` if we want to accept incoming connections. */ - bool wantIncoming; + bool wantIncoming{true}; /** `true` if we want to establish connections automatically */ - bool autoConnect; + bool autoConnect{true}; /** The listening port number. */ - std::uint16_t listeningPort; + std::uint16_t listeningPort{0}; /** The set of features we advertise. */ std::string features; /** Limit how many incoming connections we allow per IP */ - int ipLimit; + int ipLimit{0}; //-------------------------------------------------------------------------- diff --git a/src/xrpld/peerfinder/README.md b/src/xrpld/peerfinder/README.md index 806984035b..e6eda747ce 100644 --- a/src/xrpld/peerfinder/README.md +++ b/src/xrpld/peerfinder/README.md @@ -2,8 +2,8 @@ ## Introduction -The _Ripple payment network_ consists of a collection of _peers_ running the -**rippled software**. Each peer maintains multiple outgoing connections and +The _XRPL payment network_ consists of a collection of _peers_ running the +**xrpld software**. Each peer maintains multiple outgoing connections and optional incoming connections to other peers. These connections are made over both the public Internet and private local area networks. This network defines a fully connected directed graph of nodes. Peers send and receive messages to @@ -175,7 +175,7 @@ When choosing addresses from the boot cache for the purpose of establishing outgoing connections, addresses are ranked in decreasing order of valence. The Bootcache is persistent. Entries are periodically inserted and updated in the corresponding SQLite database during program operation. When -**rippled** is launched, the existing Bootcache database data is accessed and +**xrpld** is launched, the existing Bootcache database data is accessed and loaded to accelerate the bootstrap process. Desirable entries in the Bootcache are addresses for servers which are known to @@ -306,7 +306,7 @@ the address, and its retry timer has expired. The PeerFinder makes its best effort to become fully connected to the fixed addresses specified in the configuration file before moving on to establish -outgoing connections to foreign peers. This security feature helps rippled +outgoing connections to foreign peers. This security feature helps xrpld establish itself with a trusted set of peers first before accepting untrusted data from the network. diff --git a/src/xrpld/peerfinder/detail/Bootcache.cpp b/src/xrpld/peerfinder/detail/Bootcache.cpp index d07ec444a4..f9a34e2b1e 100644 --- a/src/xrpld/peerfinder/detail/Bootcache.cpp +++ b/src/xrpld/peerfinder/detail/Bootcache.cpp @@ -1,20 +1,27 @@ #include + +#include +#include #include #include #include +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { namespace PeerFinder { Bootcache::Bootcache(Store& store, clock_type& clock, beast::Journal journal) - : m_store(store) - , m_clock(clock) - , m_journal(journal) - , m_whenUpdate(m_clock.now()) - , m_needsUpdate(false) + : m_store(store), m_clock(clock), m_journal(journal), m_whenUpdate(m_clock.now()) + { } @@ -137,7 +144,7 @@ Bootcache::on_success(beast::IP::Endpoint const& endpoint) ++entry.valence(); m_map.erase(result.first); result = m_map.insert(value_type(endpoint, entry)); - XRPL_ASSERT(result.second, "ripple:PeerFinder::Bootcache::on_success : endpoint inserted"); + XRPL_ASSERT(result.second, "xrpl::PeerFinder::Bootcache::on_success : endpoint inserted"); } Entry const& entry(result.first->right); JLOG(m_journal.info()) << beast::leftw(18) << "Bootcache connect " << endpoint << " with " @@ -161,7 +168,7 @@ Bootcache::on_failure(beast::IP::Endpoint const& endpoint) --entry.valence(); m_map.erase(result.first); result = m_map.insert(value_type(endpoint, entry)); - XRPL_ASSERT(result.second, "ripple:PeerFinder::Bootcache::on_failure : endpoint inserted"); + XRPL_ASSERT(result.second, "xrpl::PeerFinder::Bootcache::on_failure : endpoint inserted"); } Entry const& entry(result.first->right); auto const n(std::abs(entry.valence())); diff --git a/src/xrpld/peerfinder/detail/Bootcache.h b/src/xrpld/peerfinder/detail/Bootcache.h index a4687d95f4..a552c2f040 100644 --- a/src/xrpld/peerfinder/detail/Bootcache.h +++ b/src/xrpld/peerfinder/detail/Bootcache.h @@ -55,9 +55,7 @@ private: friend bool operator<(Entry const& lhs, Entry const& rhs) { - if (lhs.valence() > rhs.valence()) - return true; - return false; + return lhs.valence() > rhs.valence(); } private: @@ -97,7 +95,7 @@ private: clock_type::time_point m_whenUpdate; // Set to true when a database update is needed - bool m_needsUpdate; + bool m_needsUpdate{false}; public: static constexpr int staticValence = 32; diff --git a/src/xrpld/peerfinder/detail/Checker.h b/src/xrpld/peerfinder/detail/Checker.h index 3e67754db9..21cc0f160e 100644 --- a/src/xrpld/peerfinder/detail/Checker.h +++ b/src/xrpld/peerfinder/detail/Checker.h @@ -44,7 +44,7 @@ private: async_op(Checker& owner, boost::asio::io_context& io_context, Handler&& handler); - ~async_op(); + virtual ~async_op(); void stop() override; @@ -108,7 +108,7 @@ template Checker::async_op::async_op( Checker& owner, boost::asio::io_context& io_context, - Handler&& handler) + Handler&& handler) // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) : checker_(owner), socket_(io_context), handler_(std::forward(handler)) { } @@ -154,7 +154,7 @@ template void Checker::stop() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); if (!stop_) { stop_ = true; @@ -180,7 +180,7 @@ Checker::async_connect(beast::IP::Endpoint const& endpoint, Handler&& auto const op = std::make_shared>(*this, io_context_, std::forward(handler)); { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list_.push_back(*op); } op->socket_.async_connect( @@ -192,7 +192,7 @@ template void Checker::remove(basic_async_op& op) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); list_.erase(list_.iterator_to(op)); if (list_.size() == 0) cond_.notify_all(); diff --git a/src/xrpld/peerfinder/detail/Counts.h b/src/xrpld/peerfinder/detail/Counts.h index 26e02a4cb1..4b52453708 100644 --- a/src/xrpld/peerfinder/detail/Counts.h +++ b/src/xrpld/peerfinder/detail/Counts.h @@ -13,24 +13,6 @@ namespace PeerFinder { class Counts { public: - Counts() - : m_attempts(0) - , m_active(0) - , m_in_max(0) - , m_in_active(0) - , m_out_max(0) - , m_out_active(0) - , m_fixed(0) - , m_fixed_active(0) - , m_reserved(0) - - , m_acceptCount(0) - , m_closingCount(0) - { - } - - //-------------------------------------------------------------------------- - /** Adds the slot state and properties to the slot counts. */ void add(Slot const& s) @@ -197,15 +179,12 @@ public: // // Fixed peers do not count towards the active outgoing total. - if (m_out_max > 0) - return false; - - return true; + return m_out_max <= 0; } /** Output statistics. */ void - onWrite(beast::PropertyStream::Map& map) + onWrite(beast::PropertyStream::Map& map) const { map["accept"] = acceptCount(); map["connect"] = connectCount(); @@ -261,9 +240,13 @@ private: if (!s.fixed() && !s.reserved()) { if (s.inbound()) + { m_in_active += n; + } else + { m_out_active += n; + } } m_active += n; break; @@ -282,38 +265,38 @@ private: private: /** Outbound connection attempts. */ - int m_attempts; + int m_attempts{0}; /** Active connections, including fixed and reserved. */ - std::size_t m_active; + std::size_t m_active{0}; /** Total number of inbound slots. */ - std::size_t m_in_max; + std::size_t m_in_max{0}; /** Number of inbound slots assigned to active peers. */ - std::size_t m_in_active; + std::size_t m_in_active{0}; /** Maximum desired outbound slots. */ - std::size_t m_out_max; + std::size_t m_out_max{0}; /** Active outbound slots. */ - std::size_t m_out_active; + std::size_t m_out_active{0}; /** Fixed connections. */ - std::size_t m_fixed; + std::size_t m_fixed{0}; /** Active fixed connections. */ - std::size_t m_fixed_active; + std::size_t m_fixed_active{0}; /** Reserved connections. */ - std::size_t m_reserved; + std::size_t m_reserved{0}; // Number of inbound connections that are // not active or gracefully closing. - int m_acceptCount; + int m_acceptCount{0}; // Number of connections that are gracefully closing. - int m_closingCount; + int m_closingCount{0}; }; } // namespace PeerFinder diff --git a/src/xrpld/peerfinder/detail/Endpoint.cpp b/src/xrpld/peerfinder/detail/Endpoint.cpp index 46f4f28b88..6c277c1b66 100644 --- a/src/xrpld/peerfinder/detail/Endpoint.cpp +++ b/src/xrpld/peerfinder/detail/Endpoint.cpp @@ -1,6 +1,11 @@ #include #include +#include + +#include +#include + namespace xrpl { namespace PeerFinder { diff --git a/src/xrpld/peerfinder/detail/Fixed.h b/src/xrpld/peerfinder/detail/Fixed.h index 75b5ed9062..8b67347e6a 100644 --- a/src/xrpld/peerfinder/detail/Fixed.h +++ b/src/xrpld/peerfinder/detail/Fixed.h @@ -9,7 +9,7 @@ namespace PeerFinder { class Fixed { public: - explicit Fixed(clock_type& clock) : m_when(clock.now()), m_failures(0) + explicit Fixed(clock_type& clock) : m_when(clock.now()) { } @@ -40,7 +40,7 @@ public: private: clock_type::time_point m_when; - std::size_t m_failures; + std::size_t m_failures{0}; }; } // namespace PeerFinder diff --git a/src/xrpld/peerfinder/detail/Livecache.h b/src/xrpld/peerfinder/detail/Livecache.h index bedfd6c9d6..a9a641027f 100644 --- a/src/xrpld/peerfinder/detail/Livecache.h +++ b/src/xrpld/peerfinder/detail/Livecache.h @@ -327,7 +327,7 @@ public: friend class Livecache; lists_type m_lists; - Histogram m_hist; + Histogram m_hist{}; } hops; /** Returns `true` if the cache is empty. */ @@ -409,7 +409,7 @@ Livecache::insert(Endpoint const& ep) << " at hops " << ep.hops; return; } - else if (!result.second && (ep.hops > e.endpoint.hops)) + if (!result.second && (ep.hops > e.endpoint.hops)) { // Drop duplicates at higher hops std::size_t const excess(ep.hops - e.endpoint.hops); diff --git a/src/xrpld/peerfinder/detail/Logic.h b/src/xrpld/peerfinder/detail/Logic.h index 8f49da6c4f..8d60b49273 100644 --- a/src/xrpld/peerfinder/detail/Logic.h +++ b/src/xrpld/peerfinder/detail/Logic.h @@ -106,7 +106,7 @@ public: void load() { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); bootcache_.load(); } @@ -119,7 +119,7 @@ public: void stop() { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); stopping_ = true; if (fetchSource_ != nullptr) fetchSource_->cancel(); @@ -134,7 +134,7 @@ public: void config(Config const& c) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); config_ = c; counts_.onConfig(config_); } @@ -142,7 +142,7 @@ public: Config config() { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); return config_; } @@ -155,7 +155,7 @@ public: void addFixedPeer(std::string const& name, std::vector const& addresses) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); if (addresses.empty()) { @@ -197,7 +197,7 @@ public: if (ec == boost::asio::error::operation_aborted) return; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); auto const iter(slots_.find(remoteAddress)); if (iter == slots_.end()) { @@ -212,7 +212,7 @@ public: slot.connectivityCheckInProgress = false; beast::WrappedSink sink{m_journal.sink(), slot.prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; if (ec) { @@ -239,7 +239,7 @@ public: JLOG(m_journal.debug()) << beast::leftw(18) << "Logic accept" << remote_endpoint << " on local " << local_endpoint; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // Check for connection limit per address if (is_public(remote_endpoint)) @@ -254,7 +254,7 @@ public: } // Check for duplicate connection - if (slots_.find(remote_endpoint) != slots_.end()) + if (slots_.contains(remote_endpoint)) { JLOG(m_journal.debug()) << beast::leftw(18) << "Logic dropping " << remote_endpoint << " as duplicate incoming"; @@ -287,10 +287,10 @@ public: { JLOG(m_journal.debug()) << beast::leftw(18) << "Logic connect " << remote_endpoint; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // Check for duplicate connection - if (slots_.find(remote_endpoint) != slots_.end()) + if (slots_.contains(remote_endpoint)) { JLOG(m_journal.debug()) << beast::leftw(18) << "Logic dropping " << remote_endpoint << " as duplicate connect"; @@ -322,11 +322,11 @@ public: onConnected(SlotImp::ptr const& slot, beast::IP::Endpoint const& local_endpoint) { beast::WrappedSink sink{m_journal.sink(), slot->prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; JLOG(journal.trace()) << "Logic connected on local " << local_endpoint; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // The object must exist in our table XRPL_ASSERT( @@ -360,12 +360,12 @@ public: activate(SlotImp::ptr const& slot, PublicKey const& key, bool reserved) { beast::WrappedSink sink{m_journal.sink(), slot->prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; JLOG(journal.debug()) << "Logic handshake " << slot->remote_endpoint() << " with " << (reserved ? "reserved " : "") << "key " << key; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // The object must exist in our table XRPL_ASSERT( @@ -377,7 +377,7 @@ public: "xrpl::PeerFinder::Logic::activate : valid slot state"); // Check for duplicate connection by key - if (keys_.find(key) != keys_.end()) + if (keys_.contains(key)) return Result::duplicatePeer; // If the peer belongs to a cluster or is reserved, @@ -418,9 +418,11 @@ public: { auto iter(fixed_.find(slot->remote_endpoint())); if (iter == fixed_.end()) + { LogicError( "PeerFinder::Logic::activate(): remote_endpoint " "missing from fixed_"); + } iter->second.success(m_clock.now()); JLOG(journal.trace()) << "Logic fixed success"; @@ -436,7 +438,7 @@ public: std::vector redirect(SlotImp::ptr const& slot) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); RedirectHandouts h(slot); livecache_.hops.shuffle(); handout(&h, (&h) + 1, livecache_.hops.begin(), livecache_.hops.end()); @@ -454,7 +456,7 @@ public: { std::vector none; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // Count how many more outbound attempts to make // @@ -516,7 +518,7 @@ public: << ((h.list().size() > 1) ? "endpoints" : "endpoint"); return h.list(); } - else if (counts_.attempts() > 0) + if (counts_.attempts() > 0) { JLOG(m_journal.debug()) << beast::leftw(18) << "Logic waiting on " << counts_.attempts() << " attempts"; @@ -560,7 +562,7 @@ public: { std::vector, std::vector>> result; - std::lock_guard _(lock_); + std::lock_guard const _(lock_); clock_type::time_point const now = m_clock.now(); if (m_whenBroadcast <= now) @@ -624,7 +626,7 @@ public: SlotImp::ptr const& slot = t.slot(); auto const& list = t.list(); beast::WrappedSink sink{m_journal.sink(), slot->prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; JLOG(journal.trace()) << "Logic sending " << list.size() << ((list.size() == 1) ? " endpoint" : " endpoints"); result.push_back(std::make_pair(slot, list)); @@ -639,7 +641,7 @@ public: void once_per_second() { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // Expire the Livecache livecache_.expire(); @@ -725,7 +727,7 @@ public: on_endpoints(SlotImp::ptr const& slot, Endpoints list) { beast::WrappedSink sink{m_journal.sink(), slot->prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; // If we're sent too many endpoints, sample them at random: if (list.size() > Tuning::numberOfEndpointsMax) @@ -737,7 +739,7 @@ public: JLOG(journal.trace()) << "Endpoints contained " << list.size() << ((list.size() > 1) ? " entries" : " entry"); - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // The object must exist in our table XRPL_ASSERT( @@ -825,9 +827,11 @@ public: auto const iter = slots_.find(slot->remote_endpoint()); // The slot must exist in the table if (iter == slots_.end()) + { LogicError( "PeerFinder::Logic::remove(): remote_endpoint " "missing from slots_"); + } // Remove from slot by IP table slots_.erase(iter); @@ -838,9 +842,11 @@ public: auto const iter = keys_.find(*slot->public_key()); // Key must exist if (iter == keys_.end()) + { LogicError( "PeerFinder::Logic::remove(): public_key missing " "from keys_"); + } keys_.erase(iter); } @@ -849,9 +855,11 @@ public: auto const iter(connectedAddresses_.find(slot->remote_endpoint().address())); // Address must exist if (iter == connectedAddresses_.end()) + { LogicError( "PeerFinder::Logic::remove(): remote_endpoint " "address missing from connectedAddresses_"); + } connectedAddresses_.erase(iter); } @@ -863,21 +871,23 @@ public: void on_closed(SlotImp::ptr const& slot) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); remove(slot); beast::WrappedSink sink{m_journal.sink(), slot->prefix()}; - beast::Journal journal{sink}; + beast::Journal const journal{sink}; // Mark fixed slot failure if (slot->fixed() && !slot->inbound() && slot->state() != Slot::active) { auto iter(fixed_.find(slot->remote_endpoint())); if (iter == fixed_.end()) + { LogicError( "PeerFinder::Logic::on_closed(): remote_endpoint " "missing from fixed_"); + } iter->second.failure(m_clock.now()); JLOG(journal.debug()) << "Logic fixed failed"; @@ -921,7 +931,7 @@ public: void on_failure(SlotImp::ptr const& slot) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); bootcache_.on_failure(slot->remote_endpoint()); } @@ -939,8 +949,10 @@ public: fixed(beast::IP::Endpoint const& endpoint) const { for (auto const& entry : fixed_) + { if (entry.first == endpoint) return true; + } return false; } @@ -951,8 +963,10 @@ public: fixed(beast::IP::Address const& address) const { for (auto const& entry : fixed_) + { if (entry.first.address() == address) return true; + } return false; } @@ -1010,7 +1024,7 @@ public: addBootcacheAddresses(IPAddresses const& list) { int count(0); - std::lock_guard _(lock_); + std::lock_guard const _(lock_); for (auto const& addr : list) { if (bootcache_.insertStatic(addr)) @@ -1027,7 +1041,7 @@ public: { { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); if (stopping_) return; fetchSource_ = source; @@ -1039,7 +1053,7 @@ public: source->fetch(results, m_journal); { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); if (stopping_) return; fetchSource_ = nullptr; @@ -1110,7 +1124,7 @@ public: void onWrite(beast::PropertyStream::Map& map) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); // VFALCO NOTE These ugly casts are needed because // of how std::size_t is declared on some linuxes @@ -1188,7 +1202,7 @@ Logic::onRedirects( FwdIter last, boost::asio::ip::tcp::endpoint const& remote_address) { - std::lock_guard _(lock_); + std::lock_guard const _(lock_); std::size_t n = 0; for (; first != last && n < Tuning::maxRedirects; ++first, ++n) bootcache_.insert(beast::IPAddressConversion::from_asio(*first)); diff --git a/src/xrpld/peerfinder/detail/PeerfinderConfig.cpp b/src/xrpld/peerfinder/detail/PeerfinderConfig.cpp index 4de03c6ca6..c43e214826 100644 --- a/src/xrpld/peerfinder/detail/PeerfinderConfig.cpp +++ b/src/xrpld/peerfinder/detail/PeerfinderConfig.cpp @@ -1,19 +1,18 @@ +#include #include #include +#include + #include +#include +#include namespace xrpl { namespace PeerFinder { -Config::Config() - : maxPeers(Tuning::defaultMaxPeers) - , outPeers(calcOutPeers()) - , inPeers(0) - , wantIncoming(true) - , autoConnect(true) - , listeningPort(0) - , ipLimit(0) +Config::Config() : outPeers(calcOutPeers()) + { } @@ -23,7 +22,7 @@ operator==(Config const& lhs, Config const& rhs) return lhs.autoConnect == rhs.autoConnect && lhs.peerPrivate == rhs.peerPrivate && lhs.wantIncoming == rhs.wantIncoming && lhs.inPeers == rhs.inPeers && lhs.maxPeers == rhs.maxPeers && lhs.outPeers == rhs.outPeers && - lhs.features == lhs.features && lhs.ipLimit == rhs.ipLimit && + lhs.features == rhs.features && lhs.ipLimit == rhs.ipLimit && lhs.listeningPort == rhs.listeningPort; } diff --git a/src/xrpld/peerfinder/detail/PeerfinderManager.cpp b/src/xrpld/peerfinder/detail/PeerfinderManager.cpp index 70f082c0d5..375592222f 100644 --- a/src/xrpld/peerfinder/detail/PeerfinderManager.cpp +++ b/src/xrpld/peerfinder/detail/PeerfinderManager.cpp @@ -1,14 +1,32 @@ #include + +#include #include #include +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include + #include #include +#include +#include #include +#include #include +#include +#include +#include namespace xrpl { namespace PeerFinder { @@ -117,21 +135,21 @@ public: void on_endpoints(std::shared_ptr const& slot, Endpoints const& endpoints) override { - SlotImp::ptr impl(std::dynamic_pointer_cast(slot)); + SlotImp::ptr const impl(std::dynamic_pointer_cast(slot)); m_logic.on_endpoints(impl, endpoints); } void on_closed(std::shared_ptr const& slot) override { - SlotImp::ptr impl(std::dynamic_pointer_cast(slot)); + SlotImp::ptr const impl(std::dynamic_pointer_cast(slot)); m_logic.on_closed(impl); } void on_failure(std::shared_ptr const& slot) override { - SlotImp::ptr impl(std::dynamic_pointer_cast(slot)); + SlotImp::ptr const impl(std::dynamic_pointer_cast(slot)); m_logic.on_failure(impl); } @@ -149,21 +167,21 @@ public: onConnected(std::shared_ptr const& slot, beast::IP::Endpoint const& local_endpoint) override { - SlotImp::ptr impl(std::dynamic_pointer_cast(slot)); + SlotImp::ptr const impl(std::dynamic_pointer_cast(slot)); return m_logic.onConnected(impl, local_endpoint); } Result activate(std::shared_ptr const& slot, PublicKey const& key, bool reserved) override { - SlotImp::ptr impl(std::dynamic_pointer_cast(slot)); + SlotImp::ptr const impl(std::dynamic_pointer_cast(slot)); return m_logic.activate(impl, key, reserved); } std::vector redirect(std::shared_ptr const& slot) override { - SlotImp::ptr impl(std::dynamic_pointer_cast(slot)); + SlotImp::ptr const impl(std::dynamic_pointer_cast(slot)); return m_logic.redirect(impl); } @@ -226,7 +244,7 @@ private: void collect_metrics() { - std::lock_guard lock(m_statsMutex); + std::lock_guard const lock(m_statsMutex); m_stats.activeInboundPeers = m_logic.counts_.inboundActive(); m_stats.activeOutboundPeers = m_logic.counts_.out_active(); } diff --git a/src/xrpld/peerfinder/detail/SlotImp.cpp b/src/xrpld/peerfinder/detail/SlotImp.cpp index 07156c6a87..ac65b29e95 100644 --- a/src/xrpld/peerfinder/detail/SlotImp.cpp +++ b/src/xrpld/peerfinder/detail/SlotImp.cpp @@ -1,7 +1,15 @@ -#include #include + +#include +#include #include +#include +#include +#include + +#include + namespace xrpl { namespace PeerFinder { diff --git a/src/xrpld/peerfinder/detail/SourceStrings.cpp b/src/xrpld/peerfinder/detail/SourceStrings.cpp index eb2e62fc09..3f142bfdf4 100644 --- a/src/xrpld/peerfinder/detail/SourceStrings.cpp +++ b/src/xrpld/peerfinder/detail/SourceStrings.cpp @@ -1,5 +1,13 @@ #include +#include + +#include +#include + +#include +#include + namespace xrpl { namespace PeerFinder { diff --git a/src/xrpld/peerfinder/detail/Store.h b/src/xrpld/peerfinder/detail/Store.h index dab50b3ce0..390f80800a 100644 --- a/src/xrpld/peerfinder/detail/Store.h +++ b/src/xrpld/peerfinder/detail/Store.h @@ -22,7 +22,7 @@ public: explicit Entry() = default; beast::IP::Endpoint endpoint; - int valence; + int valence{}; }; virtual void save(std::vector const& v) = 0; diff --git a/src/xrpld/perflog/detail/PerfLogImp.cpp b/src/xrpld/perflog/detail/PerfLogImp.cpp index 960fdcb3ac..b47c5020d7 100644 --- a/src/xrpld/perflog/detail/PerfLogImp.cpp +++ b/src/xrpld/perflog/detail/PerfLogImp.cpp @@ -1,22 +1,34 @@ #include #include +#include +#include #include #include +#include +#include #include +#include +#include #include +#include -#include +#include +#include + +#include #include #include -#include +#include +#include +#include #include -#include -#include -#include +#include +#include #include #include #include +#include namespace xrpl { namespace perf { @@ -69,7 +81,7 @@ PerfLogImp::Counters::countersJson() const { Rpc value; { - std::lock_guard lock(proc.second.mutex); + std::lock_guard const lock(proc.second.mutex); if ((proc.second.value.started == 0u) && (proc.second.value.finished == 0u) && (proc.second.value.errored == 0u)) { @@ -107,7 +119,7 @@ PerfLogImp::Counters::countersJson() const { Jq value; { - std::lock_guard lock(proc.second.mutex); + std::lock_guard const lock(proc.second.mutex); if ((proc.second.value.queued == 0u) && (proc.second.value.started == 0u) && (proc.second.value.finished == 0u)) { @@ -156,7 +168,7 @@ PerfLogImp::Counters::currentJson() const Json::Value jobsArray(Json::arrayValue); auto const jobs = [this] { - std::lock_guard lock(jobsMutex_); + std::lock_guard const lock(jobsMutex_); return jobs_; }(); @@ -174,7 +186,7 @@ PerfLogImp::Counters::currentJson() const Json::Value methodsArray(Json::arrayValue); std::vector methods; { - std::lock_guard lock(methodsMutex_); + std::lock_guard const lock(methodsMutex_); methods.reserve(methods_.size()); for (auto const& m : methods_) methods.push_back(m.second); @@ -270,7 +282,7 @@ PerfLogImp::report() Json::Value report(Json::objectValue); report[jss::time] = to_string(std::chrono::floor(present)); { - std::lock_guard lock{counters_.jobsMutex_}; + std::lock_guard const lock{counters_.jobsMutex_}; report[jss::workers] = static_cast(counters_.jobs_.size()); } report[jss::hostid] = hostname_; @@ -311,10 +323,10 @@ PerfLogImp::rpcStart(std::string const& method, std::uint64_t const requestId) } { - std::lock_guard lock(counter->second.mutex); + std::lock_guard const lock(counter->second.mutex); ++counter->second.value.started; } - std::lock_guard lock(counters_.methodsMutex_); + std::lock_guard const lock(counters_.methodsMutex_); counters_.methods_[requestId] = {counter->first.c_str(), steady_clock::now()}; } @@ -331,7 +343,7 @@ PerfLogImp::rpcEnd(std::string const& method, std::uint64_t const requestId, boo } steady_time_point startTime; { - std::lock_guard lock(counters_.methodsMutex_); + std::lock_guard const lock(counters_.methodsMutex_); auto const e = counters_.methods_.find(requestId); if (e != counters_.methods_.end()) { @@ -345,7 +357,7 @@ PerfLogImp::rpcEnd(std::string const& method, std::uint64_t const requestId, boo // LCOV_EXCL_STOP } } - std::lock_guard lock(counter->second.mutex); + std::lock_guard const lock(counter->second.mutex); if (finish) { ++counter->second.value.finished; @@ -369,7 +381,7 @@ PerfLogImp::jobQueue(JobType const type) return; // LCOV_EXCL_STOP } - std::lock_guard lock(counter->second.mutex); + std::lock_guard const lock(counter->second.mutex); ++counter->second.value.queued; } @@ -390,11 +402,11 @@ PerfLogImp::jobStart( } { - std::lock_guard lock(counter->second.mutex); + std::lock_guard const lock(counter->second.mutex); ++counter->second.value.started; counter->second.value.queuedDuration += dur; } - std::lock_guard lock(counters_.jobsMutex_); + std::lock_guard const lock(counters_.jobsMutex_); if (instance >= 0 && instance < counters_.jobs_.size()) counters_.jobs_[instance] = {type, startTime}; } @@ -412,11 +424,11 @@ PerfLogImp::jobFinish(JobType const type, microseconds dur, int instance) } { - std::lock_guard lock(counter->second.mutex); + std::lock_guard const lock(counter->second.mutex); ++counter->second.value.finished; counter->second.value.runningDuration += dur; } - std::lock_guard lock(counters_.jobsMutex_); + std::lock_guard const lock(counters_.jobsMutex_); if (instance >= 0 && instance < counters_.jobs_.size()) counters_.jobs_[instance] = {jtINVALID, steady_time_point()}; } @@ -424,7 +436,7 @@ PerfLogImp::jobFinish(JobType const type, microseconds dur, int instance) void PerfLogImp::resizeJobs(int const resize) { - std::lock_guard lock(counters_.jobsMutex_); + std::lock_guard const lock(counters_.jobsMutex_); if (resize > counters_.jobs_.size()) counters_.jobs_.resize(resize, {jtINVALID, steady_time_point()}); } @@ -435,7 +447,7 @@ PerfLogImp::rotate() if (setup_.perfLog.empty()) return; - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); rotate_ = true; cond_.notify_one(); } @@ -453,7 +465,7 @@ PerfLogImp::stop() if (thread_.joinable()) { { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); stop_ = true; cond_.notify_one(); } diff --git a/src/xrpld/rpc/BookChanges.h b/src/xrpld/rpc/BookChanges.h index b2b1ae793b..89b99cabe3 100644 --- a/src/xrpld/rpc/BookChanges.h +++ b/src/xrpld/rpc/BookChanges.h @@ -11,7 +11,7 @@ namespace Json { class Value; -} +} // namespace Json namespace xrpl { @@ -44,7 +44,7 @@ computeBookChanges(std::shared_ptr const& lpAccepted) continue; std::optional offerCancel; - uint16_t tt = tx.first->getFieldU16(sfTransactionType); + uint16_t const tt = tx.first->getFieldU16(sfTransactionType); switch (tt) { case ttOFFER_CANCEL: @@ -62,7 +62,7 @@ computeBookChanges(std::shared_ptr const& lpAccepted) for (auto const& node : tx.second->getFieldArray(sfAffectedNodes)) { SField const& metaType = node.getFName(); - uint16_t nodeType = node.getFieldU16(sfLedgerEntryType); + uint16_t const nodeType = node.getFieldU16(sfLedgerEntryType); // we only care about ltOFFER objects being modified or // deleted @@ -94,15 +94,15 @@ computeBookChanges(std::shared_ptr const& lpAccepted) // compute the difference in gets and pays actually // affected onto the offer - STAmount deltaGets = finalFields.getFieldAmount(sfTakerGets) - + STAmount const deltaGets = finalFields.getFieldAmount(sfTakerGets) - previousFields.getFieldAmount(sfTakerGets); - STAmount deltaPays = finalFields.getFieldAmount(sfTakerPays) - + STAmount const deltaPays = finalFields.getFieldAmount(sfTakerPays) - previousFields.getFieldAmount(sfTakerPays); - std::string g{to_string(deltaGets.issue())}; - std::string p{to_string(deltaPays.issue())}; + std::string const g{to_string(deltaGets.asset())}; + std::string const p{to_string(deltaPays.asset())}; - bool const noswap = isXRP(deltaGets) ? true : (isXRP(deltaPays) ? false : (g < p)); + bool const noswap = isXRP(deltaGets) || (!isXRP(deltaPays) && (g < p)); STAmount first = noswap ? deltaGets : deltaPays; STAmount second = noswap ? deltaPays : deltaGets; @@ -111,7 +111,7 @@ computeBookChanges(std::shared_ptr const& lpAccepted) if (second == beast::zero) continue; - STAmount rate = divide(first, second, noIssue()); + STAmount const rate = divide(first, second, noIssue()); if (first < beast::zero) first = -first; @@ -121,15 +121,20 @@ computeBookChanges(std::shared_ptr const& lpAccepted) std::stringstream ss; if (noswap) + { ss << g << "|" << p; + } else + { ss << p << "|" << g; + } - std::optional domain = finalFields[~sfDomainID]; + std::optional const domain = finalFields[~sfDomainID]; - std::string key{ss.str()}; + std::string const key{ss.str()}; - if (tally.find(key) == tally.end()) + if (!tally.contains(key)) + { tally[key] = { first, // side A vol second, // side B vol @@ -138,6 +143,7 @@ computeBookChanges(std::shared_ptr const& lpAccepted) rate, // open rate, // close domain}; + } else { // increment volume @@ -170,18 +176,37 @@ computeBookChanges(std::shared_ptr const& lpAccepted) jvObj[jss::changes] = Json::arrayValue; + auto volToStr = [](STAmount const& vol) { + return vol.asset().visit( + [&](Issue const& issue) { + if (isXRP(issue)) + return to_string(vol.xrp()); + return to_string(vol.iou()); + }, + [&](MPTIssue const&) { return to_string(vol.mpt()); }); + }; + for (auto const& entry : tally) { Json::Value& inner = jvObj[jss::changes].append(Json::objectValue); - STAmount volA = std::get<0>(entry.second); - STAmount volB = std::get<1>(entry.second); + STAmount const volA = std::get<0>(entry.second); + STAmount const volB = std::get<1>(entry.second); - inner[jss::currency_a] = (isXRP(volA) ? "XRP_drops" : to_string(volA.issue())); - inner[jss::currency_b] = (isXRP(volB) ? "XRP_drops" : to_string(volB.issue())); + volA.asset().visit( + [&](Issue const&) { + inner[jss::currency_a] = (isXRP(volA) ? "XRP_drops" : to_string(volA.asset())); + }, + [&](MPTIssue const&) { inner[jss::mpt_issuance_id_a] = to_string(volA.asset()); }); - inner[jss::volume_a] = (isXRP(volA) ? to_string(volA.xrp()) : to_string(volA.iou())); - inner[jss::volume_b] = (isXRP(volB) ? to_string(volB.xrp()) : to_string(volB.iou())); + volB.asset().visit( + [&](Issue const&) { + inner[jss::currency_b] = (isXRP(volB) ? "XRP_drops" : to_string(volB.asset())); + }, + [&](MPTIssue const&) { inner[jss::mpt_issuance_id_b] = to_string(volB.asset()); }); + + inner[jss::volume_a] = volToStr(volA); + inner[jss::volume_b] = volToStr(volB); inner[jss::high] = to_string(std::get<2>(entry.second).iou()); inner[jss::low] = to_string(std::get<3>(entry.second).iou()); diff --git a/src/xrpld/rpc/CTID.h b/src/xrpld/rpc/CTID.h index cbae1f4498..42efb4c157 100644 --- a/src/xrpld/rpc/CTID.h +++ b/src/xrpld/rpc/CTID.h @@ -39,7 +39,7 @@ encodeCTID(uint32_t ledgerSeq, uint32_t txnIndex, uint32_t networkID) noexcept if (ledgerSeq > maxLedgerSeq || txnIndex > maxTxnIndex || networkID > maxNetworkID) return std::nullopt; - uint64_t ctidValue = ((0xC000'0000ULL + static_cast(ledgerSeq)) << 32) | + uint64_t const ctidValue = ((0xC000'0000ULL + static_cast(ledgerSeq)) << 32) | ((static_cast(txnIndex) << 16) | networkID); std::stringstream buffer; @@ -101,9 +101,9 @@ decodeCTID(T const ctid) noexcept if ((ctidValue & ctidPrefixMask) != ctidPrefix) return std::nullopt; - uint32_t ledgerSeq = static_cast((ctidValue >> 32) & 0x0FFF'FFFF); - uint16_t txnIndex = static_cast((ctidValue >> 16) & 0xFFFF); - uint16_t networkID = static_cast(ctidValue & 0xFFFF); + uint32_t const ledgerSeq = static_cast((ctidValue >> 32) & 0x0FFF'FFFF); + uint16_t const txnIndex = static_cast((ctidValue >> 16) & 0xFFFF); + uint16_t const networkID = static_cast(ctidValue & 0xFFFF); return std::make_tuple(ledgerSeq, txnIndex, networkID); } diff --git a/src/xrpld/rpc/Context.h b/src/xrpld/rpc/Context.h index e77d9adeb3..58768d028a 100644 --- a/src/xrpld/rpc/Context.h +++ b/src/xrpld/rpc/Context.h @@ -24,8 +24,8 @@ struct Context LedgerMaster& ledgerMaster; Resource::Consumer& consumer; Role role; - std::shared_ptr coro{}; - InfoSub::pointer infoSub{}; + std::shared_ptr coro; + InfoSub::pointer infoSub; unsigned int apiVersion; }; diff --git a/src/xrpld/rpc/DeliveredAmount.h b/src/xrpld/rpc/DeliveredAmount.h index c882190ade..65f11e9736 100644 --- a/src/xrpld/rpc/DeliveredAmount.h +++ b/src/xrpld/rpc/DeliveredAmount.h @@ -8,7 +8,7 @@ namespace Json { class Value; -} +} // namespace Json namespace xrpl { diff --git a/src/xrpld/rpc/MPTokenIssuanceID.h b/src/xrpld/rpc/MPTokenIssuanceID.h index 34aa0474d6..9e60c44ee0 100644 --- a/src/xrpld/rpc/MPTokenIssuanceID.h +++ b/src/xrpld/rpc/MPTokenIssuanceID.h @@ -25,7 +25,7 @@ canHaveMPTokenIssuanceID( std::shared_ptr const& serializedTx, TxMeta const& transactionMeta); -std::optional +std::optional getIDFromCreatedIssuance(TxMeta const& transactionMeta); void diff --git a/src/xrpld/rpc/README.md b/src/xrpld/rpc/README.md index 749f3d0ed1..cf023770ea 100644 --- a/src/xrpld/rpc/README.md +++ b/src/xrpld/rpc/README.md @@ -6,7 +6,7 @@ By default, an RPC handler runs as an uninterrupted task on the JobQueue. This is fine for commands that are fast to compute but might not be acceptable for tasks that require multiple parts or are large, like a full ledger. -For this purpose, the rippled RPC handler allows _suspension with continuation_ +For this purpose, the xrpld RPC handler allows _suspension with continuation_ - a request to suspend execution of the RPC response and to continue it after some function or job has been executed. A default continuation is supplied diff --git a/src/xrpld/rpc/RPCCall.h b/src/xrpld/rpc/RPCCall.h index 6ab9f1d1fa..9994195bb0 100644 --- a/src/xrpld/rpc/RPCCall.h +++ b/src/xrpld/rpc/RPCCall.h @@ -20,7 +20,7 @@ namespace xrpl { // // Improvements to be more strict and to provide better diagnostics are welcome. -/** Processes Ripple RPC calls. */ +/** Processes XRPL RPC calls. */ namespace RPCCall { int @@ -52,7 +52,7 @@ rpcCmdToJson( beast::Journal j); /** Internal invocation of RPC client. - * Used by both rippled command line as well as rippled unit tests + * Used by both xrpld command line as well as xrpld unit tests */ std::pair rpcClient( diff --git a/src/xrpld/rpc/ServerHandler.h b/src/xrpld/rpc/ServerHandler.h index 74f59756b0..2ffdc9556b 100644 --- a/src/xrpld/rpc/ServerHandler.h +++ b/src/xrpld/rpc/ServerHandler.h @@ -147,7 +147,7 @@ public: Handoff onHandoff( Session& session, - http_request_type&& request, + http_request_type&& request, // NOLINT(cppcoreguidelines-rvalue-reference-param-not-moved) boost::asio::ip::tcp::endpoint const& remote_address) { return onHandoff(session, {}, std::forward(request), remote_address); diff --git a/src/xrpld/rpc/Status.h b/src/xrpld/rpc/Status.h index c8ec9d0472..c7c9eed63e 100644 --- a/src/xrpld/rpc/Status.h +++ b/src/xrpld/rpc/Status.h @@ -29,7 +29,7 @@ public: // The enable_if allows only integers (not enums). Prevents enum narrowing. template ::value>> - Status(T code, Strings d = {}) : type_(Type::none), code_(code), messages_(std::move(d)) + Status(T code, Strings d = {}) : code_(code), messages_(std::move(d)) { } @@ -93,9 +93,13 @@ public: if (auto ec = toErrorCode()) { if (messages_.empty()) + { inject_error(ec, object); + } else + { inject_error(ec, message(), object); + } } } diff --git a/src/xrpld/rpc/detail/AccountAssets.cpp b/src/xrpld/rpc/detail/AccountAssets.cpp new file mode 100644 index 0000000000..b990939bd6 --- /dev/null +++ b/src/xrpld/rpc/detail/AccountAssets.cpp @@ -0,0 +1,97 @@ +#include + +#include +#include + +#include +#include +#include +#include +#include + +#include + +namespace xrpl { + +hash_set +accountSourceAssets( + AccountID const& account, + std::shared_ptr const& lrCache, + bool includeXRP) +{ + hash_set assets; + + // YYY Only bother if they are above reserve + if (includeXRP) + assets.insert(xrpCurrency()); + + if (auto const lines = lrCache->getRippleLines(account, LineDirection::outgoing)) + { + for (auto const& rspEntry : *lines) + { + auto& saBalance = rspEntry.getBalance(); + + // Filter out non + if (saBalance > beast::zero + // Have IOUs to send. + || (rspEntry.getLimitPeer() + // Peer extends credit. + && ((-saBalance) < rspEntry.getLimitPeer()))) // Credit left. + { + assets.insert(saBalance.get().currency); + } + } + } + + assets.erase(badCurrency()); + + if (auto const mpts = lrCache->getMPTs(account)) + { + for (auto const& rspEntry : *mpts) + { + if (!rspEntry.isZeroBalance() && !rspEntry.isMaxedOut()) + assets.insert(rspEntry.getMptID()); + } + } + + return assets; +} + +hash_set +accountDestAssets( + AccountID const& account, + std::shared_ptr const& lrCache, + bool includeXRP) +{ + hash_set assets; + + if (includeXRP) + assets.insert(xrpCurrency()); + // Even if account doesn't exist + + if (auto const lines = lrCache->getRippleLines(account, LineDirection::outgoing)) + { + for (auto const& rspEntry : *lines) + { + auto& saBalance = rspEntry.getBalance(); + + if (saBalance < rspEntry.getLimit()) // Can take more + assets.insert(saBalance.get().currency); + } + } + + assets.erase(badCurrency()); + + if (auto const mpts = lrCache->getMPTs(account)) + { + for (auto const& rspEntry : *mpts) + { + if (rspEntry.isZeroBalance() && !rspEntry.isMaxedOut()) + assets.insert(rspEntry.getMptID()); + } + } + + return assets; +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/detail/AccountAssets.h b/src/xrpld/rpc/detail/AccountAssets.h new file mode 100644 index 0000000000..55fce62fa6 --- /dev/null +++ b/src/xrpld/rpc/detail/AccountAssets.h @@ -0,0 +1,21 @@ +#pragma once + +#include + +#include + +namespace xrpl { + +hash_set +accountDestAssets( + AccountID const& account, + std::shared_ptr const& cache, + bool includeXRP); + +hash_set +accountSourceAssets( + AccountID const& account, + std::shared_ptr const& lrLedger, + bool includeXRP); + +} // namespace xrpl diff --git a/src/xrpld/rpc/detail/AccountCurrencies.cpp b/src/xrpld/rpc/detail/AccountCurrencies.cpp deleted file mode 100644 index c839b1475c..0000000000 --- a/src/xrpld/rpc/detail/AccountCurrencies.cpp +++ /dev/null @@ -1,66 +0,0 @@ -#include - -namespace xrpl { - -hash_set -accountSourceCurrencies( - AccountID const& account, - std::shared_ptr const& lrCache, - bool includeXRP) -{ - hash_set currencies; - - // YYY Only bother if they are above reserve - if (includeXRP) - currencies.insert(xrpCurrency()); - - if (auto const lines = lrCache->getRippleLines(account, LineDirection::outgoing)) - { - for (auto const& rspEntry : *lines) - { - auto& saBalance = rspEntry.getBalance(); - - // Filter out non - if (saBalance > beast::zero - // Have IOUs to send. - || (rspEntry.getLimitPeer() - // Peer extends credit. - && ((-saBalance) < rspEntry.getLimitPeer()))) // Credit left. - { - currencies.insert(saBalance.getCurrency()); - } - } - } - - currencies.erase(badCurrency()); - return currencies; -} - -hash_set -accountDestCurrencies( - AccountID const& account, - std::shared_ptr const& lrCache, - bool includeXRP) -{ - hash_set currencies; - - if (includeXRP) - currencies.insert(xrpCurrency()); - // Even if account doesn't exist - - if (auto const lines = lrCache->getRippleLines(account, LineDirection::outgoing)) - { - for (auto const& rspEntry : *lines) - { - auto& saBalance = rspEntry.getBalance(); - - if (saBalance < rspEntry.getLimit()) // Can take more - currencies.insert(saBalance.getCurrency()); - } - } - - currencies.erase(badCurrency()); - return currencies; -} - -} // namespace xrpl diff --git a/src/xrpld/rpc/detail/AccountCurrencies.h b/src/xrpld/rpc/detail/AccountCurrencies.h deleted file mode 100644 index 76c531cb9b..0000000000 --- a/src/xrpld/rpc/detail/AccountCurrencies.h +++ /dev/null @@ -1,21 +0,0 @@ -#pragma once - -#include - -#include - -namespace xrpl { - -hash_set -accountDestCurrencies( - AccountID const& account, - std::shared_ptr const& cache, - bool includeXRP); - -hash_set -accountSourceCurrencies( - AccountID const& account, - std::shared_ptr const& lrLedger, - bool includeXRP); - -} // namespace xrpl diff --git a/src/xrpld/rpc/detail/AssetCache.cpp b/src/xrpld/rpc/detail/AssetCache.cpp new file mode 100644 index 0000000000..bbe8fefc98 --- /dev/null +++ b/src/xrpld/rpc/detail/AssetCache.cpp @@ -0,0 +1,163 @@ +#include + +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +namespace xrpl { + +AssetCache::AssetCache(std::shared_ptr const& ledger, beast::Journal j) + : ledger_(ledger), journal_(j) +{ + JLOG(journal_.debug()) << "created for ledger " << ledger_->header().seq; +} + +AssetCache::~AssetCache() +{ + JLOG(journal_.debug()) << "destroyed for ledger " << ledger_->header().seq << " with " + << lines_.size() << " accounts and " << totalLineCount_ + << " distinct trust lines."; +} + +std::shared_ptr> +AssetCache::getRippleLines(AccountID const& accountID, LineDirection direction) +{ + auto const hash = hasher_(accountID); + AccountKey key(accountID, direction, hash); + AccountKey otherkey( + accountID, + direction == LineDirection::outgoing ? LineDirection::incoming : LineDirection::outgoing, + hash); + + std::lock_guard const sl(mLock); + + auto [it, inserted] = [&]() { + if (auto otheriter = lines_.find(otherkey); otheriter != lines_.end()) + { + // The whole point of using the direction flag is to reduce the + // number of trust line objects held in memory. Ensure that there is + // only a single set of trustlines in the cache per account. + auto const size = otheriter->second ? otheriter->second->size() : 0; + JLOG(journal_.info()) + << "Request for " + << (direction == LineDirection::outgoing ? "outgoing" : "incoming") + << " trust lines for account " << accountID << " found " << size + << (direction == LineDirection::outgoing ? " incoming" : " outgoing") + << " trust lines. " + << (direction == LineDirection::outgoing ? "Deleting the subset of incoming" + : "Returning the superset of outgoing") + << " trust lines. "; + if (direction == LineDirection::outgoing) + { + // This request is for the outgoing set, but there is already a + // subset of incoming lines in the cache. Erase that subset + // to be replaced by the full set. The full set will be built + // below, and will be returned, if needed, on subsequent calls + // for either value of outgoing. + XRPL_ASSERT( + size <= totalLineCount_, "xrpl::AssetCache::getRippleLines : maximum lines"); + totalLineCount_ -= size; + lines_.erase(otheriter); + } + else + { + // This request is for the incoming set, but there is + // already a superset of the outgoing trust lines in the cache. + // The path finding engine will disregard the non-rippling trust + // lines, so to prevent them from being stored twice, return the + // outgoing set. + key = otherkey; + return std::pair{otheriter, false}; + } + } + return lines_.emplace(key, nullptr); + }(); + + if (inserted) + { + XRPL_ASSERT(it->second == nullptr, "xrpl::Asset::getRippleLines : null lines"); + auto lines = PathFindTrustLine::getItems(accountID, *ledger_, direction); + if (!lines.empty()) + { + it->second = std::make_shared>(std::move(lines)); + totalLineCount_ += it->second->size(); + } + } + + XRPL_ASSERT( + !it->second || !it->second->empty(), + "xrpl::AssetCache::getRippleLines : null or nonempty lines"); + auto const size = it->second ? it->second->size() : 0; + JLOG(journal_.trace()) << "getRippleLines for ledger " << ledger_->header().seq << " found " + << size + << (key.direction_ == LineDirection::outgoing ? " outgoing" + : " incoming") + << " lines for " << (inserted ? "new " : "existing ") << accountID + << " out of a total of " << lines_.size() << " accounts and " + << totalLineCount_ << " trust lines"; + + return it->second; +} + +std::shared_ptr> const& +AssetCache::getMPTs(xrpl::AccountID const& account) +{ + std::lock_guard const sl(mLock); + + if (auto it = mpts_.find(account); it != mpts_.end()) + return it->second; + + std::vector mpts; + // Get issued/authorized tokens + forEachItem(*ledger_, account, [&](std::shared_ptr const& sle) { + if (sle->getType() == ltMPTOKEN_ISSUANCE) + { + auto const mptID = makeMptID(sle->getFieldU32(sfSequence), account); + bool const maxedOut = sle->at(sfOutstandingAmount) == maxMPTAmount(*sle); + mpts.emplace_back(mptID, false, maxedOut); + } + else if (sle->getType() == ltMPTOKEN) + { + auto const mptID = sle->getFieldH192(sfMPTokenIssuanceID); + bool const zeroBalance = sle->at(sfMPTAmount) == 0; + bool const maxedOut = [&] { + if (auto const sleIssuance = ledger_->read(keylet::mptIssuance(mptID))) + { + return sleIssuance->at(sfOutstandingAmount) == maxMPTAmount(*sleIssuance); + } + return true; + }(); + + mpts.emplace_back(mptID, zeroBalance, maxedOut); + } + }); + + if (mpts.empty()) + { + mpts_.emplace(account, nullptr); + } + else + { + mpts_.emplace(account, std::make_shared>(std::move(mpts))); + } + + return mpts_[account]; +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/detail/AssetCache.h b/src/xrpld/rpc/detail/AssetCache.h new file mode 100644 index 0000000000..0709df2c5f --- /dev/null +++ b/src/xrpld/rpc/detail/AssetCache.h @@ -0,0 +1,106 @@ +#pragma once + +#include +#include + +#include +#include +#include + +#include +#include +#include + +namespace xrpl { + +// Used by Pathfinder +class AssetCache final : public CountedObject +{ +public: + explicit AssetCache(std::shared_ptr const& l, beast::Journal j); + ~AssetCache(); + + std::shared_ptr const& + getLedger() const + { + return ledger_; + } + + /** Find the trust lines associated with an account. + + @param accountID The account + @param direction Whether the account is an "outgoing" link on the path. + "Outgoing" is defined as the source account, or an account found via a + trustline that has rippling enabled on the @accountID's side. If an + account is "outgoing", all trust lines will be returned. If an account is + not "outgoing", then any trust lines that don't have rippling enabled are + not usable, so only return trust lines that have rippling enabled on + @accountID's side. + @return Returns a vector of the usable trust lines. + */ + std::shared_ptr> + getRippleLines(AccountID const& accountID, LineDirection direction); + + std::shared_ptr> const& + getMPTs(AccountID const& account); + +private: + std::mutex mLock; + + xrpl::hardened_hash<> hasher_; + std::shared_ptr ledger_; + + beast::Journal journal_; + + struct AccountKey final : public CountedObject + { + AccountID account_; + LineDirection direction_; + std::size_t hash_value_; + + AccountKey(AccountID const& account, LineDirection direction, std::size_t hash) + : account_(account), direction_(direction), hash_value_(hash) + { + } + + AccountKey(AccountKey const& other) = default; + + AccountKey& + operator=(AccountKey const& other) = default; + + bool + operator==(AccountKey const& lhs) const + { + return hash_value_ == lhs.hash_value_ && account_ == lhs.account_ && + direction_ == lhs.direction_; + } + + std::size_t + get_hash() const + { + return hash_value_; + } + + struct Hash + { + Hash() = default; + + std::size_t + operator()(AccountKey const& key) const noexcept + { + return key.get_hash(); + } + }; + }; + + // Use a shared_ptr so entries can be removed from the map safely. + // Even though a shared_ptr to a vector will take more memory just a vector, + // most accounts are not going to have any entries (estimated over 90%), so + // vectors will not need to be created for them. This should lead to far + // less memory usage overall. + hash_map>, AccountKey::Hash> lines_; + std::size_t totalLineCount_ = 0; + hash_map>> mpts_; +}; + +} // namespace xrpl diff --git a/src/xrpld/rpc/detail/DeliveredAmount.cpp b/src/xrpld/rpc/detail/DeliveredAmount.cpp index e2f5bd8cd9..c6a6354a31 100644 --- a/src/xrpld/rpc/detail/DeliveredAmount.cpp +++ b/src/xrpld/rpc/detail/DeliveredAmount.cpp @@ -1,11 +1,20 @@ -#include -#include -#include -#include #include -#include -#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include namespace xrpl { namespace RPC { diff --git a/src/xrpld/rpc/detail/Handler.cpp b/src/xrpld/rpc/detail/Handler.cpp index 0f95e69d3f..c218d0052a 100644 --- a/src/xrpld/rpc/detail/Handler.cpp +++ b/src/xrpld/rpc/detail/Handler.cpp @@ -1,11 +1,22 @@ #include + +#include +#include #include -#include +#include +#include #include +#include +#include #include +#include +#include #include +#include +#include +#include namespace xrpl { namespace RPC { @@ -75,7 +86,7 @@ Handler const handlerArray[]{ {"account_nfts", byRef(&doAccountNFTs), Role::USER, NO_CONDITION}, {"account_objects", byRef(&doAccountObjects), Role::USER, NO_CONDITION}, {"account_offers", byRef(&doAccountOffers), Role::USER, NO_CONDITION}, - {"account_tx", byRef(&doAccountTxJson), Role::USER, NO_CONDITION}, + {"account_tx", byRef(&doAccountTx), Role::USER, NO_CONDITION}, {"amm_info", byRef(&doAMMInfo), Role::USER, NO_CONDITION}, {"blacklist", byRef(&doBlackList), Role::ADMIN, NO_CONDITION}, {"book_changes", byRef(&doBookChanges), Role::USER, NO_CONDITION}, diff --git a/src/xrpld/rpc/detail/Handler.h b/src/xrpld/rpc/detail/Handler.h index 908cb67750..3628962a69 100644 --- a/src/xrpld/rpc/detail/Handler.h +++ b/src/xrpld/rpc/detail/Handler.h @@ -10,7 +10,7 @@ namespace Json { class Object; -} +} // namespace Json namespace xrpl { namespace RPC { diff --git a/src/xrpld/rpc/detail/LegacyPathFind.cpp b/src/xrpld/rpc/detail/LegacyPathFind.cpp index b0fa07d676..396b9a8112 100644 --- a/src/xrpld/rpc/detail/LegacyPathFind.cpp +++ b/src/xrpld/rpc/detail/LegacyPathFind.cpp @@ -1,15 +1,18 @@ -#include #include + +#include #include #include #include #include +#include + namespace xrpl { namespace RPC { -LegacyPathFind::LegacyPathFind(bool isAdmin, Application& app) : m_isOk(false) +LegacyPathFind::LegacyPathFind(bool isAdmin, Application& app) { if (isAdmin) { diff --git a/src/xrpld/rpc/detail/LegacyPathFind.h b/src/xrpld/rpc/detail/LegacyPathFind.h index 139075b53d..3d45bc9cfd 100644 --- a/src/xrpld/rpc/detail/LegacyPathFind.h +++ b/src/xrpld/rpc/detail/LegacyPathFind.h @@ -23,7 +23,7 @@ public: private: static std::atomic inProgress; - bool m_isOk; + bool m_isOk{false}; }; } // namespace RPC diff --git a/src/xrpld/rpc/detail/MPT.h b/src/xrpld/rpc/detail/MPT.h new file mode 100644 index 0000000000..61dcb8fa7d --- /dev/null +++ b/src/xrpld/rpc/detail/MPT.h @@ -0,0 +1,45 @@ +#pragma once + +#include + +namespace xrpl { + +class PathFindMPT final +{ +private: + MPTID const mptID_; + // If true then holder's balance is 0, always false for issuer + bool const zeroBalance_; + // OutstandingAmount is equal to MaximumAmount + bool const maxedOut_; + +public: + PathFindMPT(MPTID const& mptID) : mptID_(mptID), zeroBalance_(false), maxedOut_(false) + { + } + PathFindMPT(MPTID const& mptID, bool zeroBalance, bool maxedOut) + : mptID_(mptID), zeroBalance_(zeroBalance), maxedOut_(maxedOut) + { + } + operator MPTID const&() const + { + return mptID_; + } + MPTID const& + getMptID() const + { + return mptID_; + } + bool + isZeroBalance() const + { + return zeroBalance_; + } + bool + isMaxedOut() const + { + return maxedOut_; + } +}; + +} // namespace xrpl diff --git a/src/xrpld/rpc/detail/MPTokenIssuanceID.cpp b/src/xrpld/rpc/detail/MPTokenIssuanceID.cpp index ef8bc448ee..7ce08d11ea 100644 --- a/src/xrpld/rpc/detail/MPTokenIssuanceID.cpp +++ b/src/xrpld/rpc/detail/MPTokenIssuanceID.cpp @@ -1,5 +1,21 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + namespace xrpl { namespace RPC { @@ -23,7 +39,7 @@ canHaveMPTokenIssuanceID( return true; } -std::optional +std::optional getIDFromCreatedIssuance(TxMeta const& transactionMeta) { for (STObject const& node : transactionMeta.getNodes()) @@ -48,7 +64,7 @@ insertMPTokenIssuanceID( if (!canHaveMPTokenIssuanceID(transaction, transactionMeta)) return; - std::optional result = getIDFromCreatedIssuance(transactionMeta); + std::optional result = getIDFromCreatedIssuance(transactionMeta); if (result) response[jss::mpt_issuance_id] = to_string(result.value()); } diff --git a/src/xrpld/rpc/detail/PathRequest.cpp b/src/xrpld/rpc/detail/PathRequest.cpp index f02377381c..b4ac252f10 100644 --- a/src/xrpld/rpc/detail/PathRequest.cpp +++ b/src/xrpld/rpc/detail/PathRequest.cpp @@ -1,21 +1,50 @@ +#include + #include #include -#include -#include +#include #include +#include #include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include #include -#include #include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include namespace xrpl { @@ -92,7 +121,7 @@ PathRequest::~PathRequest() bool PathRequest::isNew() { - std::lock_guard sl(mIndexLock); + std::lock_guard const sl(mIndexLock); // does this path request still need its first full path return mLastIndex == 0; @@ -101,7 +130,7 @@ PathRequest::isNew() bool PathRequest::needsUpdate(bool newOnly, LedgerIndex index) { - std::lock_guard sl(mIndexLock); + std::lock_guard const sl(mIndexLock); if (mInProgress) { @@ -133,7 +162,7 @@ PathRequest::hasCompletion() void PathRequest::updateComplete() { - std::lock_guard sl(mIndexLock); + std::lock_guard const sl(mIndexLock); XRPL_ASSERT(mInProgress, "xrpl::PathRequest::updateComplete : in progress"); mInProgress = false; @@ -146,7 +175,7 @@ PathRequest::updateComplete() } bool -PathRequest::isValid(std::shared_ptr const& crCache) +PathRequest::isValid(std::shared_ptr const& crCache) { if (!raSrcAccount || !raDstAccount) return false; @@ -192,10 +221,11 @@ PathRequest::isValid(std::shared_ptr const& crCache) { bool const disallowXRP((sleDest->getFlags() & lsfDisallowXRP) != 0u); - auto usDestCurrID = accountDestCurrencies(*raDstAccount, crCache, !disallowXRP); + auto const destAssets = accountDestAssets(*raDstAccount, crCache, !disallowXRP); + + for (auto const& asset : destAssets) + jvDestCur.append(to_string(asset)); - for (auto const& currency : usDestCurrID) - jvDestCur.append(to_string(currency)); jvStatus[jss::destination_tag] = (sleDest->getFlags() & lsfRequireDestTag); } @@ -214,7 +244,7 @@ PathRequest::isValid(std::shared_ptr const& crCache) in all cases. */ std::pair -PathRequest::doCreate(std::shared_ptr const& cache, Json::Value const& value) +PathRequest::doCreate(std::shared_ptr const& cache, Json::Value const& value) { bool valid = false; @@ -282,11 +312,9 @@ PathRequest::parseJson(Json::Value const& jvParams) return PFR_PJ_INVALID; } - convert_all_ = saDstAmount == STAmount(saDstAmount.issue(), 1u, 0, true); + convert_all_ = saDstAmount == STAmount(saDstAmount.asset(), 1u, 0, true); - if ((saDstAmount.getCurrency().isZero() && saDstAmount.getIssuer().isNonZero()) || - (saDstAmount.getCurrency() == badCurrency()) || - (!convert_all_ && saDstAmount <= beast::zero)) + if (!validAsset(saDstAmount.asset()) || (!convert_all_ && saDstAmount <= beast::zero)) { jvStatus = rpcError(rpcDST_AMT_MALFORMED); return PFR_PJ_INVALID; @@ -303,9 +331,8 @@ PathRequest::parseJson(Json::Value const& jvParams) saSendMax.emplace(); if (!amountFromJsonNoThrow(*saSendMax, jvParams[jss::send_max]) || - (saSendMax->getCurrency().isZero() && saSendMax->getIssuer().isNonZero()) || - (saSendMax->getCurrency() == badCurrency()) || - (*saSendMax <= beast::zero && *saSendMax != STAmount(saSendMax->issue(), 1u, 0, true))) + !validAsset(saSendMax->asset()) || + (*saSendMax <= beast::zero && *saSendMax != STAmount(saSendMax->asset(), 1u, 0, true))) { jvStatus = rpcError(rpcSENDMAX_MALFORMED); return PFR_PJ_INVALID; @@ -322,45 +349,71 @@ PathRequest::parseJson(Json::Value const& jvParams) return PFR_PJ_INVALID; } - sciSourceCurrencies.clear(); + sciSourceAssets.clear(); for (auto const& c : jvSrcCurrencies) { - // Mandatory currency - Currency srcCurrencyID; - if (!c.isObject() || !c.isMember(jss::currency) || !c[jss::currency].isString() || - !to_currency(srcCurrencyID, c[jss::currency].asString())) + // Mandatory currency or MPT + if (!validJSONAsset(c) || !c.isObject()) { jvStatus = rpcError(rpcSRC_CUR_MALFORMED); return PFR_PJ_INVALID; } + PathAsset srcPathAsset; + if (c.isMember(jss::currency)) + { + Currency currency; + if (!c[jss::currency].isString() || + !to_currency(currency, c[jss::currency].asString())) + { + jvStatus = rpcError(rpcSRC_CUR_MALFORMED); + return PFR_PJ_INVALID; + } + srcPathAsset = currency; + } + else + { + uint192 u; + if (!c[jss::mpt_issuance_id].isString() || + !u.parseHex(c[jss::mpt_issuance_id].asString())) + { + jvStatus = rpcError(rpcSRC_CUR_MALFORMED); + return PFR_PJ_INVALID; + } + srcPathAsset = u; + } + // Optional issuer AccountID srcIssuerID; if (c.isMember(jss::issuer) && - (!c[jss::issuer].isString() || !to_issuer(srcIssuerID, c[jss::issuer].asString()))) + (c.isMember(jss::mpt_issuance_id) || !c[jss::issuer].isString() || + !to_issuer(srcIssuerID, c[jss::issuer].asString()))) { jvStatus = rpcError(rpcSRC_ISR_MALFORMED); return PFR_PJ_INVALID; } - if (srcCurrencyID.isZero()) + if (srcPathAsset.holds()) { - if (srcIssuerID.isNonZero()) + if (srcPathAsset.get().isZero()) { - jvStatus = rpcError(rpcSRC_CUR_MALFORMED); - return PFR_PJ_INVALID; + if (srcIssuerID.isNonZero()) + { + jvStatus = rpcError(rpcSRC_CUR_MALFORMED); + return PFR_PJ_INVALID; + } + } + else if (srcIssuerID.isZero()) + { + srcIssuerID = *raSrcAccount; } - } - else if (srcIssuerID.isZero()) - { - srcIssuerID = *raSrcAccount; } if (saSendMax) { - // If the currencies don't match, ignore the source currency. - if (srcCurrencyID == saSendMax->getCurrency()) + // If the assets don't match, ignore the source asset. + if (srcPathAsset == saSendMax->asset()) { // If neither is the source and they are not equal, then the // source issuer is illegal. @@ -373,23 +426,30 @@ PathRequest::parseJson(Json::Value const& jvParams) // If both are the source, use the source. // Otherwise, use the one that's not the source. - if (srcIssuerID != *raSrcAccount) - { - sciSourceCurrencies.insert({srcCurrencyID, srcIssuerID}); - } - else if (saSendMax->getIssuer() != *raSrcAccount) - { - sciSourceCurrencies.insert({srcCurrencyID, saSendMax->getIssuer()}); - } - else - { - sciSourceCurrencies.insert({srcCurrencyID, *raSrcAccount}); - } + srcPathAsset.visit( + [&](Currency const& currency) { + if (srcIssuerID != *raSrcAccount) + { + sciSourceAssets.insert(Issue{currency, srcIssuerID}); + } + else if (saSendMax->getIssuer() != *raSrcAccount) + { + sciSourceAssets.insert(Issue{currency, saSendMax->getIssuer()}); + } + { + sciSourceAssets.insert(Issue{currency, *raSrcAccount}); + } + }, + [&](MPTID const& mpt) { sciSourceAssets.insert(mpt); }); } } else { - sciSourceCurrencies.insert({srcCurrencyID, srcIssuerID}); + srcPathAsset.visit( + [&](Currency const& currency) { + sciSourceAssets.insert(Issue{currency, srcIssuerID}); + }, + [&](MPTID const& mpt) { sciSourceAssets.insert(MPTIssue{mpt}); }); } } } @@ -416,7 +476,7 @@ Json::Value PathRequest::doClose() { JLOG(m_journal.debug()) << iIdentifier << " closed"; - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); jvStatus[jss::closed] = true; return jvStatus; } @@ -424,7 +484,7 @@ PathRequest::doClose() Json::Value PathRequest::doStatus(Json::Value const&) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); jvStatus[jss::status] = jss::success; return jvStatus; } @@ -437,21 +497,21 @@ PathRequest::doAborting() const std::unique_ptr const& PathRequest::getPathFinder( - std::shared_ptr const& cache, - hash_map>& currency_map, - Currency const& currency, + std::shared_ptr const& cache, + hash_map>& pathasset_map, + PathAsset const& asset, STAmount const& dst_amount, int const level, std::function const& continueCallback) { - auto i = currency_map.find(currency); - if (i != currency_map.end()) + auto i = pathasset_map.find(asset); + if (i != pathasset_map.end()) return i->second; auto pathfinder = std::make_unique( cache, *raSrcAccount, *raDstAccount, - currency, + asset, std::nullopt, dst_amount, saSendMax, @@ -465,47 +525,63 @@ PathRequest::getPathFinder( { pathfinder.reset(); // It's a bad request - clear it. } - return currency_map[currency] = std::move(pathfinder); + return pathasset_map[asset] = std::move(pathfinder); } bool PathRequest::findPaths( - std::shared_ptr const& cache, + std::shared_ptr const& cache, int const level, Json::Value& jvArray, std::function const& continueCallback) { - auto sourceCurrencies = sciSourceCurrencies; - if (sourceCurrencies.empty() && saSendMax) + auto sourceAssets = sciSourceAssets; + if (sourceAssets.empty() && saSendMax) { - sourceCurrencies.insert(saSendMax->issue()); + sourceAssets.insert(saSendMax->asset()); } - if (sourceCurrencies.empty()) + if (sourceAssets.empty()) { - auto currencies = accountSourceCurrencies(*raSrcAccount, cache, true); + auto assets = accountSourceAssets(*raSrcAccount, cache, true); bool const sameAccount = *raSrcAccount == *raDstAccount; - for (auto const& c : currencies) + for (auto const& asset : assets) { - if (!sameAccount || c != saDstAmount.getCurrency()) + if (!std::visit( + [&](TAsset const& a) { + if (!sameAccount || a != saDstAmount.asset()) + { + if (sourceAssets.size() >= RPC::Tuning::max_auto_src_cur) + return false; + if constexpr (std::is_same_v) + { + sourceAssets.insert( + Issue{a, a.isZero() ? xrpAccount() : *raSrcAccount}); + } + else + { + sourceAssets.insert(MPTIssue{a}); + } + } + return true; + }, + asset.value())) { - if (sourceCurrencies.size() >= RPC::Tuning::max_auto_src_cur) - return false; - sourceCurrencies.insert({c, c.isZero() ? xrpAccount() : *raSrcAccount}); + return false; } } } auto const dst_amount = convertAmount(saDstAmount, convert_all_); - hash_map> currency_map; - for (auto const& issue : sourceCurrencies) + hash_map> pathasset_map; + for (auto const& asset : sourceAssets) { if (continueCallback && !continueCallback()) break; JLOG(m_journal.debug()) << iIdentifier - << " Trying to find paths: " << STAmount(issue, 1).getFullText(); + << " Trying to find paths: " << STAmount(asset, 1).getFullText(); auto& pathfinder = - getPathFinder(cache, currency_map, issue.currency, dst_amount, level, continueCallback); + getPathFinder(cache, pathasset_map, asset, dst_amount, level, continueCallback); if (!pathfinder) { JLOG(m_journal.debug()) << iIdentifier << " No paths found"; @@ -514,21 +590,28 @@ PathRequest::findPaths( STPath fullLiquidityPath; auto ps = pathfinder->getBestPaths( - max_paths_, fullLiquidityPath, mContext[issue], issue.account, continueCallback); - mContext[issue] = ps; + max_paths_, fullLiquidityPath, mContext[asset], asset.getIssuer(), continueCallback); + mContext[asset] = ps; auto const& sourceAccount = [&] { - if (!isXRP(issue.account)) - return issue.account; + if (!isXRP(asset.getIssuer())) + return asset.getIssuer(); - if (isXRP(issue.currency)) + if (isXRP(asset)) return xrpAccount(); return *raSrcAccount; }(); - STAmount saMaxAmount = - saSendMax.value_or(STAmount(Issue{issue.currency, sourceAccount}, 1u, 0, true)); + STAmount const saMaxAmount = [&]() { + if (saSendMax) + return *saSendMax; + return asset.visit( + [&](Issue const& issue) { + return STAmount(Issue{issue.currency, sourceAccount}, 1u, 0, true); + }, + [](MPTIssue const& issue) { return STAmount(issue, 1u, 0, true); }); + }(); JLOG(m_journal.debug()) << iIdentifier << " Paths found, calling rippleCalc"; @@ -581,7 +664,8 @@ PathRequest::findPaths( if (rc.result() == tesSUCCESS) { Json::Value jvEntry(Json::objectValue); - rc.actualAmountIn.setIssuer(sourceAccount); + if (rc.actualAmountIn.holds()) + rc.actualAmountIn.get().account = sourceAccount; jvEntry[jss::source_amount] = rc.actualAmountIn.getJson(JsonOptions::none); jvEntry[jss::paths_computed] = ps.getJson(JsonOptions::none); @@ -607,14 +691,14 @@ PathRequest::findPaths( The minimum cost is 50 and the maximum is 400. The cost increases after four source currencies, 50 - (4 * 4) = 34. */ - int const size = sourceCurrencies.size(); + int const size = sourceAssets.size(); consumer_.charge({std::clamp((size * size) + 34, 50, 400), "path update"}); return true; } Json::Value PathRequest::doUpdate( - std::shared_ptr const& cache, + std::shared_ptr const& cache, bool fast, std::function const& continueCallback) { @@ -622,7 +706,7 @@ PathRequest::doUpdate( JLOG(m_journal.debug()) << iIdentifier << " update " << (fast ? "fast" : "normal"); { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (!isValid(cache)) return jvStatus; @@ -633,10 +717,10 @@ PathRequest::doUpdate( if (hasCompletion()) { // Old ripple_path_find API gives destination_currencies - auto& destCurrencies = (newStatus[jss::destination_currencies] = Json::arrayValue); - auto usCurrencies = accountDestCurrencies(*raDstAccount, cache, true); - for (auto const& c : usCurrencies) - destCurrencies.append(to_string(c)); + auto& destAssets = (newStatus[jss::destination_currencies] = Json::arrayValue); + auto const assets = accountDestAssets(*raDstAccount, cache, true); + for (auto const& asset : assets) + destAssets.append(to_string(asset)); } newStatus[jss::source_account] = toBase58(*raSrcAccount); @@ -647,7 +731,7 @@ PathRequest::doUpdate( if (jvId) newStatus[jss::id] = jvId; - bool loaded = app_.getFeeTrack().isLoadedLocal(); + bool const loaded = app_.getFeeTrack().isLoadedLocal(); if (iLevel == 0) { @@ -710,7 +794,7 @@ PathRequest::doUpdate( } { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); jvStatus = newStatus; } diff --git a/src/xrpld/rpc/detail/PathRequest.h b/src/xrpld/rpc/detail/PathRequest.h index db173e307b..3c8f89f5fe 100644 --- a/src/xrpld/rpc/detail/PathRequest.h +++ b/src/xrpld/rpc/detail/PathRequest.h @@ -1,11 +1,12 @@ #pragma once +#include #include -#include #include #include #include +#include #include #include @@ -19,11 +20,11 @@ namespace xrpl { // A pathfinding request submitted by a client // The request issuer must maintain a strong pointer -class RippleLineCache; +class AssetCache; class PathRequestManager; // Return values from parseJson <0 = invalid, >0 = valid -#define PFR_PJ_INVALID -1 +#define PFR_PJ_INVALID (-1) #define PFR_PJ_NOCHANGE 0 class PathRequest final : public InfoSubRequest, @@ -68,7 +69,7 @@ public: updateComplete(); std::pair - doCreate(std::shared_ptr const&, Json::Value const&); + doCreate(std::shared_ptr const&, Json::Value const&); Json::Value doClose() override; @@ -80,7 +81,7 @@ public: // update jvStatus Json::Value doUpdate( - std::shared_ptr const&, + std::shared_ptr const&, bool fast, std::function const& continueCallback = {}); InfoSub::pointer @@ -90,13 +91,13 @@ public: private: bool - isValid(std::shared_ptr const& crCache); + isValid(std::shared_ptr const& crCache); std::unique_ptr const& getPathFinder( - std::shared_ptr const&, - hash_map>&, - Currency const&, + std::shared_ptr const&, + hash_map>&, + PathAsset const&, STAmount const&, int const, std::function const&); @@ -106,7 +107,7 @@ private: */ bool findPaths( - std::shared_ptr const&, + std::shared_ptr const&, int const, Json::Value&, std::function const&); @@ -134,8 +135,8 @@ private: STAmount saDstAmount; std::optional saSendMax; - std::set sciSourceCurrencies; - std::map mContext; + std::set sciSourceAssets; + std::map mContext; std::optional domain; diff --git a/src/xrpld/rpc/detail/PathRequestManager.cpp b/src/xrpld/rpc/detail/PathRequestManager.cpp index e953f1ca70..b5707b22de 100644 --- a/src/xrpld/rpc/detail/PathRequestManager.cpp +++ b/src/xrpld/rpc/detail/PathRequestManager.cpp @@ -1,29 +1,44 @@ -#include -#include #include +#include +#include +#include +#include + +#include +#include #include +#include +#include #include #include #include +#include +#include #include +#include +#include +#include +#include +#include +#include namespace xrpl { -/** Get the current RippleLineCache, updating it if necessary. +/** Get the current AssetCache, updating it if necessary. Get the correct ledger to use. */ -std::shared_ptr -PathRequestManager::getLineCache(std::shared_ptr const& ledger, bool authoritative) +std::shared_ptr +PathRequestManager::getAssetCache(std::shared_ptr const& ledger, bool authoritative) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); - auto lineCache = lineCache_.lock(); + auto assetCache = assetCache_.lock(); - std::uint32_t const lineSeq = lineCache ? lineCache->getLedger()->seq() : 0; + std::uint32_t const lineSeq = assetCache ? assetCache->getLedger()->seq() : 0; std::uint32_t const lgrSeq = ledger->seq(); - JLOG(mJournal.debug()) << "getLineCache has cache for " << lineSeq << ", considering " + JLOG(mJournal.debug()) << "getAssetCache has cache for " << lineSeq << ", considering " << lgrSeq; if ((lineSeq == 0) || // no ledger @@ -31,14 +46,14 @@ PathRequestManager::getLineCache(std::shared_ptr const& ledger, (authoritative && ((lgrSeq + 8) < lineSeq)) || // we jumped way back for some reason (lgrSeq > (lineSeq + 8))) // we jumped way forward for some reason { - JLOG(mJournal.debug()) << "getLineCache creating new cache for " << lgrSeq; + JLOG(mJournal.debug()) << "getAssetCache creating new cache for " << lgrSeq; // Assign to the local before the member, because the member is a // weak_ptr, and will immediately discard it if there are no other // references. - lineCache_ = lineCache = - std::make_shared(ledger, app_.getJournal("RippleLineCache")); + assetCache_ = assetCache = + std::make_shared(ledger, app_.getJournal("AssetCache")); } - return lineCache; + return assetCache; } void @@ -47,13 +62,13 @@ PathRequestManager::updateAll(std::shared_ptr const& inLedger) auto event = app_.getJobQueue().makeLoadEvent(jtPATH_FIND, "PathRequest::updateAll"); std::vector requests; - std::shared_ptr cache; + std::shared_ptr cache; // Get the ledger and cache we should be using { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); requests = requests_; - cache = getLineCache(inLedger, true); + cache = getAssetCache(inLedger, true); } bool newRequests = app_.getLedgerMaster().isNewPathRequest(); @@ -130,7 +145,7 @@ PathRequestManager::updateAll(std::shared_ptr const& inLedger) if (remove) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); // Remove any dangling weak pointers or weak // pointers that refer to this path request. @@ -172,16 +187,16 @@ PathRequestManager::updateAll(std::shared_ptr const& inLedger) // Hold on to the line cache until after the lock is released, so it can // be destroyed outside of the lock - std::shared_ptr lastCache; + std::shared_ptr lastCache; { // Get the latest requests, cache, and ledger for next pass - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (requests_.empty()) break; requests = requests_; lastCache = cache; - cache = getLineCache(cache->getLedger(), false); + cache = getAssetCache(cache->getLedger(), false); } } while (!app_.getJobQueue().isStopping()); @@ -192,14 +207,14 @@ PathRequestManager::updateAll(std::shared_ptr const& inLedger) bool PathRequestManager::requestsPending() const { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); return !requests_.empty(); } void PathRequestManager::insertPathRequest(PathRequest::pointer const& req) { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); // Insert after any older unserviced requests but before // any serviced requests @@ -222,7 +237,7 @@ PathRequestManager::makePathRequest( { auto req = std::make_shared(app_, subscriber, ++mLastIdentifier, *this, mJournal); - auto [valid, jvRes] = req->doCreate(getLineCache(inLedger, false), requestJson); + auto [valid, jvRes] = req->doCreate(getAssetCache(inLedger, false), requestJson); if (valid) { @@ -247,7 +262,7 @@ PathRequestManager::makeLegacyPathRequest( req = std::make_shared( app_, completion, consumer, ++mLastIdentifier, *this, mJournal); - auto [valid, jvRes] = req->doCreate(getLineCache(inLedger, false), request); + auto [valid, jvRes] = req->doCreate(getAssetCache(inLedger, false), request); if (!valid) { @@ -273,7 +288,7 @@ PathRequestManager::doLegacyPathRequest( std::shared_ptr const& inLedger, Json::Value const& request) { - auto cache = std::make_shared(inLedger, app_.getJournal("RippleLineCache")); + auto cache = std::make_shared(inLedger, app_.getJournal("AssetCache")); auto req = std::make_shared(app_, [] {}, consumer, ++mLastIdentifier, *this, mJournal); diff --git a/src/xrpld/rpc/detail/PathRequestManager.h b/src/xrpld/rpc/detail/PathRequestManager.h index 0f884de5f3..f76a52bc1c 100644 --- a/src/xrpld/rpc/detail/PathRequestManager.h +++ b/src/xrpld/rpc/detail/PathRequestManager.h @@ -1,6 +1,7 @@ #pragma once #include +#include #include #include @@ -34,8 +35,8 @@ public: bool requestsPending() const; - std::shared_ptr - getLineCache(std::shared_ptr const& ledger, bool authoritative); + std::shared_ptr + getAssetCache(std::shared_ptr const& ledger, bool authoritative); // Create a new-style path request that pushes // updates to a subscriber @@ -89,8 +90,8 @@ private: // Track all requests std::vector requests_; - // Use a RippleLineCache - std::weak_ptr lineCache_; + // Use a AssetCache + std::weak_ptr assetCache_; std::atomic mLastIdentifier; diff --git a/src/xrpld/rpc/detail/Pathfinder.cpp b/src/xrpld/rpc/detail/Pathfinder.cpp index 176c7f9529..18847433d5 100644 --- a/src/xrpld/rpc/detail/Pathfinder.cpp +++ b/src/xrpld/rpc/detail/Pathfinder.cpp @@ -1,16 +1,46 @@ -#include #include + +#include +#include #include #include +#include +#include +#include #include +#include +#include +#include #include -#include +#include // IWYU pragma: keep +#include #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include /* @@ -66,12 +96,16 @@ compareAccountCandidate( AccountCandidate const& first, AccountCandidate const& second) { - if (first.priority < second.priority) - return false; + // Primary sort key: priority descending + if (first.priority != second.priority) + return first.priority > second.priority; - if (first.account > second.account) - return true; + // Secondary sort key: account descending + if (first.account != second.account) + return first.account > second.account; + // Tertiary sort key (tie-breaker): (priority ^ seq) ascending + // Note: The primary and secondary keys are equal here. return (first.priority ^ seq) < (second.priority ^ seq); } @@ -134,15 +168,38 @@ pathTypeToString(Pathfinder::PathType const& type) STAmount smallestUsefulAmount(STAmount const& amount, int maxPaths) { - return divide(amount, STAmount(maxPaths + 2), amount.issue()); + return divide(amount, STAmount(maxPaths + 2), amount.asset()); } + +STAmount +amountFromPathAsset( + PathAsset const& pathAsset, + std::optional const& srcIssuer, + AccountID const& srcAccount) +{ + return pathAsset.visit( + [&](Currency const& currency) { + auto const& account = srcIssuer.value_or(isXRP(currency) ? xrpAccount() : srcAccount); + return STAmount(Issue{currency, account}, 1u, 0, true); + }, + [](MPTID const& mpt) { return STAmount(mpt, 1u, 0, true); }); +} + +Asset +assetFromPathAsset(PathAsset const& pathAsset, AccountID const& account) +{ + return pathAsset.visit( + [&](Currency const& currency) { return Asset{Issue{currency, account}}; }, + [](MPTID const& mpt) { return Asset{mpt}; }); +} + } // namespace Pathfinder::Pathfinder( - std::shared_ptr const& cache, + std::shared_ptr const& cache, AccountID const& uSrcAccount, AccountID const& uDstAccount, - Currency const& uSrcCurrency, + PathAsset const& uSrcPathAsset, std::optional const& uSrcIssuer, STAmount const& saDstAmount, std::optional const& srcAmount, @@ -152,24 +209,18 @@ Pathfinder::Pathfinder( , mDstAccount(uDstAccount) , mEffectiveDst(isXRP(saDstAmount.getIssuer()) ? uDstAccount : saDstAmount.getIssuer()) , mDstAmount(saDstAmount) - , mSrcCurrency(uSrcCurrency) + , mSrcPathAsset(uSrcPathAsset) , mSrcIssuer(uSrcIssuer) - , mSrcAmount(srcAmount.value_or(STAmount( - Issue{ - uSrcCurrency, - uSrcIssuer.value_or(isXRP(uSrcCurrency) ? xrpAccount() : uSrcAccount)}, - 1u, - 0, - true))) + , mSrcAmount(amountFromPathAsset(uSrcPathAsset, uSrcIssuer, uSrcAccount)) , convert_all_(convertAllCheck(mDstAmount)) , mDomain(domain) , mLedger(cache->getLedger()) - , mRLCache(cache) + , mAssetCache(cache) , app_(app) , j_(app.getJournal("Pathfinder")) { XRPL_ASSERT( - !uSrcIssuer || isXRP(uSrcCurrency) == isXRP(uSrcIssuer.value()), + !uSrcIssuer || uSrcPathAsset.isXRP() == isXRP(uSrcIssuer.value()), "xrpl::Pathfinder::Pathfinder : valid inputs"); } @@ -189,7 +240,7 @@ Pathfinder::findPaths(int searchLevel, std::function const& continue } if (mSrcAccount == mDstAccount && mDstAccount == mEffectiveDst && - mSrcCurrency == mDstAmount.getCurrency()) + mSrcPathAsset == mDstAmount.asset()) { // No need to send to same account with same currency. JLOG(j_.debug()) << "Tried to send to same issuer"; @@ -197,24 +248,24 @@ Pathfinder::findPaths(int searchLevel, std::function const& continue return false; } - if (mSrcAccount == mEffectiveDst && mSrcCurrency == mDstAmount.getCurrency()) + if (mSrcAccount == mEffectiveDst && mSrcPathAsset == mDstAmount.asset()) { // Default path might work, but any path would loop return true; } m_loadEvent = app_.getJobQueue().makeLoadEvent(jtPATH_FIND, "FindPath"); - auto currencyIsXRP = isXRP(mSrcCurrency); + auto currencyIsXRP = isXRP(mSrcPathAsset); - bool useIssuerAccount = mSrcIssuer && !currencyIsXRP && !isXRP(*mSrcIssuer); + bool const useIssuerAccount = mSrcIssuer && !currencyIsXRP && !isXRP(*mSrcIssuer); auto& account = useIssuerAccount ? *mSrcIssuer : mSrcAccount; auto issuer = currencyIsXRP ? AccountID() : account; - mSource = STPathElement(account, mSrcCurrency, issuer); + mSource = STPathElement(account, mSrcPathAsset, issuer); auto issuerString = mSrcIssuer ? to_string(*mSrcIssuer) : std::string("none"); JLOG(j_.trace()) << "findPaths>" << " mSrcAccount=" << mSrcAccount << " mDstAccount=" << mDstAccount << " mDstAmount=" << mDstAmount.getFullText() - << " mSrcCurrency=" << mSrcCurrency << " mSrcIssuer=" << issuerString; + << " mSrcPathAsset=" << mSrcPathAsset << " mSrcIssuer=" << issuerString; if (!mLedger) { @@ -222,8 +273,8 @@ Pathfinder::findPaths(int searchLevel, std::function const& continue return false; } - bool bSrcXrp = isXRP(mSrcCurrency); - bool bDstXrp = isXRP(mDstAmount.getCurrency()); + bool const bSrcXrp = isXRP(mSrcPathAsset); + bool const bDstXrp = isXRP(mDstAmount.asset()); if (!mLedger->exists(keylet::account(mSrcAccount))) { @@ -278,7 +329,7 @@ Pathfinder::findPaths(int searchLevel, std::function const& continue JLOG(j_.debug()) << "non-XRP to XRP payment"; paymentType = pt_nonXRP_to_XRP; } - else if (mSrcCurrency == mDstAmount.getCurrency()) + else if (mSrcPathAsset == mDstAmount.asset()) { // non-XRP -> non-XRP - Same currency JLOG(j_.debug()) << "non-XRP to non-XRP - same currency"; @@ -550,7 +601,7 @@ Pathfinder::getBestPaths( XRPL_ASSERT( fullLiquidityPath.empty(), "xrpl::Pathfinder::getBestPaths : first empty path result"); - bool const issuerIsSender = isXRP(mSrcCurrency) || (srcIssuer == mSrcAccount); + bool const issuerIsSender = isXRP(mSrcPathAsset) || (srcIssuer == mSrcAccount); std::vector extraPathRanks; rankPaths(maxPaths, extraPaths, extraPathRanks, continueCallback); @@ -672,27 +723,27 @@ Pathfinder::getBestPaths( } bool -Pathfinder::issueMatchesOrigin(Issue const& issue) +Pathfinder::issueMatchesOrigin(Asset const& asset) { - bool matchingCurrency = (issue.currency == mSrcCurrency); - bool matchingAccount = isXRP(issue.currency) || (mSrcIssuer && issue.account == mSrcIssuer) || - issue.account == mSrcAccount; + bool const matchingAsset = (asset == mSrcPathAsset); + bool const matchingAccount = isXRP(asset) || (mSrcIssuer && asset.getIssuer() == mSrcIssuer) || + asset.getIssuer() == mSrcAccount; - return matchingCurrency && matchingAccount; + return matchingAsset && matchingAccount; } int Pathfinder::getPathsOut( - Currency const& currency, + PathAsset const& pathAsset, AccountID const& account, LineDirection direction, - bool isDstCurrency, + bool isDstAsset, AccountID const& dstAccount, std::function const& continueCallback) { - Issue const issue(currency, account); + Asset const asset = assetFromPathAsset(pathAsset, account); - auto [it, inserted] = mPathsOutCountMap.emplace(issue, 0); + auto [it, inserted] = mPathsOutCountMap.emplace(asset, 0); // If it was already present, return the stored number of paths if (!inserted) @@ -703,48 +754,87 @@ Pathfinder::getPathsOut( if (!sleAccount) return 0; - int aFlags = sleAccount->getFieldU32(sfFlags); - bool const bAuthRequired = (aFlags & lsfRequireAuth) != 0; - bool const bFrozen = ((aFlags & lsfGlobalFreeze) != 0); + auto const aFlags = sleAccount->getFieldU32(sfFlags); + bool const bAuthRequired = [&]() { + if (pathAsset.holds()) + return (aFlags & lsfRequireAuth) != 0; + return !isTesSuccess(requireAuth(*mLedger, asset.get(), account)); + }(); + bool const bFrozen = [&]() { + if (pathAsset.holds()) + return (aFlags & lsfGlobalFreeze) != 0; + return isGlobalFrozen(*mLedger, asset.get()); + }(); int count = 0; if (!bFrozen) { - count = app_.getOrderBookDB().getBookSize(issue, mDomain); + count = app_.getOrderBookDB().getBookSize(asset, mDomain); - if (auto const lines = mRLCache->getRippleLines(account, direction)) - { - for (auto const& rspEntry : *lines) - { - if (currency != rspEntry.getLimit().getCurrency()) + asset.visit( + [&](Issue const&) { + if (auto const lines = mAssetCache->getRippleLines(account, direction)) { + for (auto const& rspEntry : *lines) + { + if (pathAsset.get() != rspEntry.getLimit().get().currency) + { + } + else if ( + rspEntry.getBalance() <= beast::zero && + (!rspEntry.getLimitPeer() || + -rspEntry.getBalance() >= rspEntry.getLimitPeer() || + (bAuthRequired && !rspEntry.getAuth()))) + { + } + else if (isDstAsset && dstAccount == rspEntry.getAccountIDPeer()) + { + count += 10000; // count a path to the destination extra + } + else if (rspEntry.getNoRipplePeer()) + { + // This probably isn't a useful path out + } + else if (rspEntry.getFreezePeer()) + { + // Not a useful path out + } + else + { + ++count; + } + } } - else if ( - rspEntry.getBalance() <= beast::zero && - (!rspEntry.getLimitPeer() || - -rspEntry.getBalance() >= rspEntry.getLimitPeer() || - (bAuthRequired && !rspEntry.getAuth()))) + }, + [&](MPTIssue const&) { + if (auto const mpts = mAssetCache->getMPTs(account)) { + for (auto const& mpt : *mpts) + { + if (pathAsset.get() != mpt.getMptID()) + { + } + else if (mpt.isZeroBalance() || mpt.isMaxedOut()) + { + } + else if (bAuthRequired) + { + } + else if (isDstAsset && dstAccount == getMPTIssuer(mpt)) + { + count += 10000; + } + else if (isIndividualFrozen(*mLedger, account, MPTIssue{mpt.getMptID()})) + { + } + else + { + ++count; + } + } } - else if (isDstCurrency && dstAccount == rspEntry.getAccountIDPeer()) - { - count += 10000; // count a path to the destination extra - } - else if (rspEntry.getNoRipplePeer()) - { - // This probably isn't a useful path out - } - else if (rspEntry.getFreezePeer()) - { - // Not a useful path out - } - else - { - ++count; - } - } - } + }); } it->second = count; return count; @@ -794,7 +884,7 @@ Pathfinder::addPathsForType( JLOG(j_.debug()) << "getPaths< adding onto '" << pathTypeToString(parentPathType) << "' to get '" << pathTypeToString(pathType) << "'"; - int initialSize = mCompletePaths.size(); + int const initialSize = mCompletePaths.size(); // Add the last NodeType to the lists. auto nodeType = pathType.back(); @@ -872,7 +962,7 @@ Pathfinder::isNoRippleOut(STPath const& currentPath) auto const& fromAccount = (currentPath.size() == 1) ? mSrcAccount : (currentPath.end() - 2)->getAccountID(); auto const& toAccount = endElement.getAccountID(); - return isNoRipple(fromAccount, toAccount, endElement.getCurrency()); + return endElement.hasCurrency() && isNoRipple(fromAccount, toAccount, endElement.getCurrency()); } void @@ -896,10 +986,10 @@ Pathfinder::addLink( std::function const& continueCallback) { auto const& pathEnd = currentPath.empty() ? mSource : currentPath.back(); - auto const& uEndCurrency = pathEnd.getCurrency(); + auto const& uEndPathAsset = pathEnd.getPathAsset(); auto const& uEndIssuer = pathEnd.getIssuerID(); auto const& uEndAccount = pathEnd.getAccountID(); - bool const bOnXRP = uEndCurrency.isZero(); + bool const bOnXRP = isXRP(uEndPathAsset); // Does pathfinding really need to get this to // a gateway (the issuer of the destination amount) @@ -930,25 +1020,38 @@ Pathfinder::addLink( if (sleEnd) { bool const bRequireAuth((sleEnd->getFieldU32(sfFlags) & lsfRequireAuth) != 0u); - bool const bIsEndCurrency(uEndCurrency == mDstAmount.getCurrency()); + bool const bIsEndAsset(uEndPathAsset == mDstAmount.asset()); bool const bIsNoRippleOut(isNoRippleOut(currentPath)); bool const bDestOnly((addFlags & afAC_LAST) != 0u); - if (auto const lines = mRLCache->getRippleLines( - uEndAccount, - bIsNoRippleOut ? LineDirection::incoming : LineDirection::outgoing)) - { - auto& rippleLines = *lines; + AccountCandidates candidates; - AccountCandidates candidates; - candidates.reserve(rippleLines.size()); + auto forAssets = [&](AssetType const& assets) { + candidates.reserve(assets.size()); - for (auto const& rs : rippleLines) + static bool constexpr isLine = + std::is_same_v>; + static bool constexpr isMPT = + std::is_same_v>; + + for (auto const& asset : assets) { if (continueCallback && !continueCallback()) return; - auto const& acct = rs.getAccountIDPeer(); - LineDirection const direction = rs.getDirectionPeer(); + auto const& acct = [&]() constexpr { + if constexpr (isLine) + return asset.getAccountIDPeer(); + // Unlike trustline, MPT is not bidirectional + if constexpr (isMPT) + return getMPTIssuer(asset); + }(); + auto const direction = [&]() constexpr -> LineDirection { + if constexpr (isLine) + return asset.getDirectionPeer(); + // incoming for MPT since MPT doesn't support + // rippling (see LineDirection comments) + return LineDirection::incoming; + }(); if (hasEffectiveDestination && (acct == mDstAccount)) { @@ -956,32 +1059,53 @@ Pathfinder::addLink( continue; } - bool bToDestination = acct == mEffectiveDst; + bool const bToDestination = acct == mEffectiveDst; if (bDestOnly && !bToDestination) { continue; } - if ((uEndCurrency == rs.getLimit().getCurrency()) && - !currentPath.hasSeen(acct, uEndCurrency, acct)) + auto const correctAsset = [&]() { + if constexpr (isLine) + { + return uEndPathAsset.get() == + asset.getLimit().template get().currency; + } + if constexpr (isMPT) + { + return uEndPathAsset.get() == asset.getMptID(); + } + }(); + auto checkAsset = [&]() { + if constexpr (isLine) + { + return ( + (asset.getBalance() <= beast::zero && + (!asset.getLimitPeer() || + -asset.getBalance() >= asset.getLimitPeer() || + (bRequireAuth && !asset.getAuth()))) || + (bIsNoRippleOut && asset.getNoRipple())); + } + if constexpr (isMPT) + { + return asset.isZeroBalance() || asset.isMaxedOut() || + requireAuth(*mLedger, MPTIssue{asset}, acct); + } + }; + + if (correctAsset && !currentPath.hasSeen(acct, uEndPathAsset, acct)) { // path is for correct currency and has not been // seen - if (rs.getBalance() <= beast::zero && - (!rs.getLimitPeer() || -rs.getBalance() >= rs.getLimitPeer() || - (bRequireAuth && !rs.getAuth()))) - { - // path has no credit - } - else if (bIsNoRippleOut && rs.getNoRipple()) + if (checkAsset()) { // Can't leave on this path } else if (bToDestination) { // destination is always worth trying - if (uEndCurrency == mDstAmount.getCurrency()) + if (uEndPathAsset == mDstAmount.asset()) { // this is a complete path if (!currentPath.empty()) @@ -1004,11 +1128,11 @@ Pathfinder::addLink( else { // save this candidate - int out = getPathsOut( - uEndCurrency, + int const out = getPathsOut( + uEndPathAsset, acct, direction, - bIsEndCurrency, + bIsEndAsset, mEffectiveDst, continueCallback); if (out != 0) @@ -1016,40 +1140,56 @@ Pathfinder::addLink( } } } + }; - if (!candidates.empty()) + uEndPathAsset.visit( + [&](Currency const&) { + if (auto const lines = mAssetCache->getRippleLines( + uEndAccount, + bIsNoRippleOut ? LineDirection::incoming : LineDirection::outgoing)) + { + forAssets(*lines); + } + }, + [&](MPTID const&) { + if (auto const mpts = mAssetCache->getMPTs(uEndAccount)) + { + forAssets(*mpts); + } + }); + + if (!candidates.empty()) + { + std::sort( + candidates.begin(), + candidates.end(), + std::bind( + compareAccountCandidate, + mLedger->seq(), + std::placeholders::_1, + std::placeholders::_2)); + + int count = candidates.size(); + // allow more paths from source + if ((count > 10) && (uEndAccount != mSrcAccount)) { - std::sort( - candidates.begin(), - candidates.end(), - std::bind( - compareAccountCandidate, - mLedger->seq(), - std::placeholders::_1, - std::placeholders::_2)); + count = 10; + } + else if (count > 50) + { + count = 50; + } - int count = candidates.size(); - // allow more paths from source - if ((count > 10) && (uEndAccount != mSrcAccount)) - { - count = 10; - } - else if (count > 50) - { - count = 50; - } - - auto it = candidates.begin(); - while (count-- != 0) - { - if (continueCallback && !continueCallback()) - return; - // Add accounts to incompletePaths - STPathElement pathElement( - STPathElement::typeAccount, it->account, uEndCurrency, it->account); - incompletePaths.assembleAdd(currentPath, pathElement); - ++it; - } + auto it = candidates.begin(); + while (count-- != 0) + { + if (continueCallback && !continueCallback()) + return; + // Add accounts to incompletePaths + STPathElement const pathElement( + STPathElement::typeAccount, it->account, uEndPathAsset, it->account); + incompletePaths.assembleAdd(currentPath, pathElement); + ++it; } } } @@ -1065,38 +1205,40 @@ Pathfinder::addLink( if ((addFlags & afOB_XRP) != 0u) { // to XRP only - if (!bOnXRP && app_.getOrderBookDB().isBookToXRP({uEndCurrency, uEndIssuer}, mDomain)) + if (!bOnXRP && + app_.getOrderBookDB().isBookToXRP( + assetFromPathAsset(uEndPathAsset, uEndIssuer), mDomain)) { - STPathElement pathElement( + STPathElement const pathElement( STPathElement::typeCurrency, xrpAccount(), xrpCurrency(), xrpAccount()); incompletePaths.assembleAdd(currentPath, pathElement); } } else { - bool bDestOnly = (addFlags & afOB_LAST) != 0; - auto books = - app_.getOrderBookDB().getBooksByTakerPays({uEndCurrency, uEndIssuer}, mDomain); + bool const bDestOnly = (addFlags & afOB_LAST) != 0; + auto books = app_.getOrderBookDB().getBooksByTakerPays( + assetFromPathAsset(uEndPathAsset, uEndIssuer), mDomain); JLOG(j_.trace()) << books.size() << " books found from this currency/issuer"; for (auto const& book : books) { if (continueCallback && !continueCallback()) return; - if (!currentPath.hasSeen(xrpAccount(), book.out.currency, book.out.account) && + if (!currentPath.hasSeen(xrpAccount(), book.out, book.out.getIssuer()) && !issueMatchesOrigin(book.out) && - (!bDestOnly || (book.out.currency == mDstAmount.getCurrency()))) + (!bDestOnly || equalTokens(book.out, mDstAmount.asset()))) { STPath newPath(currentPath); - if (book.out.currency.isZero()) + if (isXRP(book.out)) { // to XRP // add the order book itself newPath.emplace_back( STPathElement::typeCurrency, xrpAccount(), xrpCurrency(), xrpAccount()); - if (mDstAmount.getCurrency().isZero()) + if (isXRP(mDstAmount.asset())) { // destination is XRP, add account and path is // complete @@ -1110,8 +1252,10 @@ Pathfinder::addLink( } } else if (!currentPath.hasSeen( - book.out.account, book.out.currency, book.out.account)) + book.out.getIssuer(), book.out, book.out.getIssuer())) { + auto const assetType = book.out.holds() ? STPathElement::typeCurrency + : STPathElement::typeMPT; // Don't want the book if we've already seen the issuer // book -> account -> book if ((newPath.size() >= 2) && (newPath.back().isAccount()) && @@ -1119,29 +1263,29 @@ Pathfinder::addLink( { // replace the redundant account with the order book newPath[newPath.size() - 1] = STPathElement( - STPathElement::typeCurrency | STPathElement::typeIssuer, + assetType | STPathElement::typeIssuer, xrpAccount(), - book.out.currency, - book.out.account); + book.out, + book.out.getIssuer()); } else { // add the order book newPath.emplace_back( - STPathElement::typeCurrency | STPathElement::typeIssuer, + assetType | STPathElement::typeIssuer, xrpAccount(), - book.out.currency, - book.out.account); + book.out, + book.out.getIssuer()); } - if (hasEffectiveDestination && book.out.account == mDstAccount && - book.out.currency == mDstAmount.getCurrency()) + if (hasEffectiveDestination && book.out.getIssuer() == mDstAccount && + equalTokens(book.out, mDstAmount.asset())) { // We skipped a required issuer } else if ( - book.out.account == mEffectiveDst && - book.out.currency == mDstAmount.getCurrency()) + book.out.getIssuer() == mEffectiveDst && + equalTokens(book.out, mDstAmount.asset())) { // with the destination account, this path is // complete JLOG(j_.trace()) << "complete path found ba: " @@ -1155,9 +1299,9 @@ Pathfinder::addLink( newPath, STPathElement( STPathElement::typeAccount, - book.out.account, - book.out.currency, - book.out.account)); + book.out.getIssuer(), + book.out, + book.out.getIssuer())); } } } diff --git a/src/xrpld/rpc/detail/Pathfinder.h b/src/xrpld/rpc/detail/Pathfinder.h index 5eaafd3370..964ec8c1d1 100644 --- a/src/xrpld/rpc/detail/Pathfinder.h +++ b/src/xrpld/rpc/detail/Pathfinder.h @@ -1,10 +1,12 @@ #pragma once -#include +#include +#include #include #include #include +#include #include #include @@ -21,10 +23,10 @@ class Pathfinder : public CountedObject public: /** Construct a pathfinder without an issuer.*/ Pathfinder( - std::shared_ptr const& cache, + std::shared_ptr const& cache, AccountID const& srcAccount, AccountID const& dstAccount, - Currency const& uSrcCurrency, + PathAsset const& uSrcPathAsset, std::optional const& uSrcIssuer, STAmount const& dstAmount, std::optional const& srcAmount, @@ -82,10 +84,10 @@ public: struct PathRank { - std::uint64_t quality; - std::uint64_t length; + std::uint64_t quality{}; + std::uint64_t length{}; STAmount liquidity; - int index; + int index{}; }; private: @@ -114,14 +116,14 @@ private: addPathsForType(PathType const& type, std::function const& continueCallback); bool - issueMatchesOrigin(Issue const&); + issueMatchesOrigin(Asset const&); int getPathsOut( - Currency const& currency, + PathAsset const& pathAsset, AccountID const& account, LineDirection direction, - bool isDestCurrency, + bool isDestPathAsset, AccountID const& dest, std::function const& continueCallback); @@ -170,7 +172,7 @@ private: AccountID mDstAccount; AccountID mEffectiveDst; // The account the paths need to end at STAmount mDstAmount; - Currency mSrcCurrency; + PathAsset mSrcPathAsset; std::optional mSrcIssuer; STAmount mSrcAmount; /** The amount remaining from mSrcAccount after the default liquidity has @@ -181,14 +183,14 @@ private: std::shared_ptr mLedger; std::unique_ptr m_loadEvent; - std::shared_ptr mRLCache; + std::shared_ptr mAssetCache; STPathElement mSource; STPathSet mCompletePaths; std::vector mPathRanks; std::map mPaths; - hash_map mPathsOutCountMap; + hash_map mPathsOutCountMap; Application& app_; beast::Journal const j_; diff --git a/src/xrpld/rpc/detail/PathfinderUtils.h b/src/xrpld/rpc/detail/PathfinderUtils.h index 560deca2d6..4f5566bdec 100644 --- a/src/xrpld/rpc/detail/PathfinderUtils.h +++ b/src/xrpld/rpc/detail/PathfinderUtils.h @@ -7,10 +7,13 @@ namespace xrpl { inline STAmount largestAmount(STAmount const& amt) { - if (amt.native()) - return INITIAL_XRP; - - return STAmount(amt.issue(), STAmount::cMaxValue, STAmount::cMaxOffset); + return amt.asset().visit( + [&](Issue const& issue) -> STAmount { + if (issue.native()) + return INITIAL_XRP; + return STAmount(amt.asset(), STAmount::cMaxValue, STAmount::cMaxOffset); + }, + [&](MPTIssue const&) { return STAmount(amt.asset(), maxMPTokenAmount, 0); }); } inline STAmount diff --git a/src/xrpld/rpc/detail/RPCCall.cpp b/src/xrpld/rpc/detail/RPCCall.cpp index 5c57f96d79..818e62e168 100644 --- a/src/xrpld/rpc/detail/RPCCall.cpp +++ b/src/xrpld/rpc/detail/RPCCall.cpp @@ -1,32 +1,56 @@ #include + +#include #include #include #include +#include #include #include +#include #include #include +#include +#include +#include #include #include +#include #include #include +#include #include #include +#include #include #include #include -#include #include +#include #include +#include #include -#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include #include +#include +#include namespace xrpl { @@ -104,21 +128,21 @@ private: // optionally followed by a forward slash and some other characters // (the issuer). // https://www.boost.org/doc/libs/1_82_0/libs/regex/doc/html/boost_regex/syntax/perl_syntax.html - static boost::regex reCurIss("\\`([][:alnum:]<>(){}[|?!@#$%^&*]{3})(?:/(.+))?\\'"); + static boost::regex const reCurIss("\\`([][:alnum:]<>(){}[|?!@#$%^&*]{3})(?:/(.+))?\\'"); boost::smatch smMatch; if (boost::regex_match(strCurrencyIssuer, smMatch, reCurIss)) { Json::Value jvResult(Json::objectValue); - std::string strCurrency = smMatch[1]; - std::string strIssuer = smMatch[2]; + std::string const strCurrency = smMatch[1]; + std::string const strIssuer = smMatch[2]; jvResult[jss::currency] = strCurrency; if (!strIssuer.empty()) { - // Could confirm issuer is a valid Ripple address. + // Could confirm issuer is a valid XRPL address. jvResult[jss::issuer] = strIssuer; } @@ -203,7 +227,7 @@ private: parseFetchInfo(Json::Value const& jvParams) { Json::Value jvRequest(Json::objectValue); - unsigned int iParams = jvParams.size(); + unsigned int const iParams = jvParams.size(); if (iParams != 0) jvRequest[jvParams[0u].asString()] = true; @@ -262,8 +286,8 @@ private: } else { - std::int64_t uLedgerMin = jvParams[1u].asInt(); - std::int64_t uLedgerMax = jvParams[2u].asInt(); + std::int64_t const uLedgerMin = jvParams[1u].asInt(); + std::int64_t const uLedgerMax = jvParams[2u].asInt(); if (uLedgerMax != -1 && uLedgerMax < uLedgerMin) { @@ -324,7 +348,7 @@ private: { try { - int iLimit = jvParams[4u].asInt(); + int const iLimit = jvParams[4u].asInt(); if (iLimit > 0) jvRequest[jss::limit] = iLimit; @@ -339,7 +363,7 @@ private: { try { - int bProof = jvParams[5u].asInt(); + int const bProof = jvParams[5u].asInt(); if (bProof != 0) jvRequest[jss::proof] = true; } @@ -365,7 +389,7 @@ private: if (jvParams.size() == 0u) return jvRequest; - std::string input = jvParams[0u].asString(); + std::string const input = jvParams[0u].asString(); if (input.find_first_not_of("0123456789") == std::string::npos) { jvRequest["can_delete"] = jvParams[0u].asUInt(); @@ -395,7 +419,7 @@ private: // handle case where there is one argument of the form ip:port if (std::count(ip.begin(), ip.end(), ':') == 1) { - std::size_t colon = ip.find_last_of(':'); + std::size_t const colon = ip.find_last_of(':'); jvRequest[jss::ip] = std::string{ip, 0, colon}; jvRequest[jss::port] = Json::Value{std::string{ip, colon + 1}}.asUInt(); return jvRequest; @@ -571,7 +595,7 @@ private: { Json::Reader reader; Json::Value jv; - bool valid_parse = reader.parse(jvParams[0u].asString(), jv); + bool const valid_parse = reader.parse(jvParams[0u].asString(), jv); if (valid_parse && isValidJson2(jv)) { if (jv.isObject()) @@ -653,7 +677,7 @@ private: { Json::Value jvRequest(Json::objectValue); - std::string strLedger = jvParams[0u].asString(); + std::string const strLedger = jvParams[0u].asString(); if (strLedger.length() == 64) { @@ -854,8 +878,8 @@ private: // NOLINTNEXTLINE(readability-convert-member-functions-to-static) parseAccountRaw1(Json::Value const& jvParams) { - std::string strIdent = jvParams[0u].asString(); - unsigned int iCursor = jvParams.size(); + std::string const strIdent = jvParams[0u].asString(); + unsigned int const iCursor = jvParams.size(); if (!parseBase58(strIdent)) return rpcError(rpcACT_MALFORMED); @@ -875,7 +899,7 @@ private: // NOLINTNEXTLINE(readability-convert-member-functions-to-static) parseVault(Json::Value const& jvParams) { - std::string strVaultID = jvParams[0u].asString(); + std::string const strVaultID = jvParams[0u].asString(); uint256 id = beast::zero; if (!id.parseHex(strVaultID)) return rpcError(rpcINVALID_PARAMS); @@ -919,7 +943,7 @@ private: { Json::Reader reader; Json::Value jvRequest{Json::objectValue}; - bool bLedger = 2 == jvParams.size(); + bool const bLedger = 2 == jvParams.size(); JLOG(j_.trace()) << "RPC json: " << jvParams[0u]; @@ -985,7 +1009,7 @@ private: return std::nullopt; if (jvParams.size() < 4 && bOffline) return std::nullopt; - Json::UInt index = bOffline ? 3u : 2u; + Json::UInt const index = bOffline ? 3u : 2u; return jvParams[index].asString(); }(); @@ -1406,7 +1430,7 @@ struct RPCCallImp { Throw( "no response from server. Please " - "ensure that the rippled server is running in another " + "ensure that the xrpld server is running in another " "process."); } @@ -1598,7 +1622,7 @@ rpcClient( else { // Transport error. - Json::Value jvRpcError = jvOutput; + Json::Value const jvRpcError = jvOutput; jvOutput = rpcError(rpcJSON_RPC); jvOutput["result"] = jvRpcError; @@ -1632,7 +1656,7 @@ rpcClient( // YYY We could have a command line flag for single line output for // scripts. YYY We would intercept output here and simplify it. } - catch (RequestNotParsable& e) + catch (RequestNotParsable const& e) { jvOutput = rpcError(rpcINVALID_PARAMS); jvOutput["error_what"] = e.what(); diff --git a/src/xrpld/rpc/detail/RPCHandler.cpp b/src/xrpld/rpc/detail/RPCHandler.cpp index eea24ab0c0..718758fc04 100644 --- a/src/xrpld/rpc/detail/RPCHandler.cpp +++ b/src/xrpld/rpc/detail/RPCHandler.cpp @@ -1,26 +1,27 @@ -#include -#include -#include +#include + #include #include #include -#include #include +#include #include #include #include +#include #include #include -#include +#include // IWYU pragma: keep #include #include #include -#include -#include #include #include +#include +#include +#include namespace xrpl { namespace RPC { @@ -129,7 +130,7 @@ fillHandler(JsonContext& context, Handler const*& result) return rpcUNKNOWN_COMMAND; } - std::string strCommand = context.params.isMember(jss::command) + std::string const strCommand = context.params.isMember(jss::command) ? context.params[jss::command].asString() : context.params[jss::method].asString(); @@ -143,7 +144,7 @@ fillHandler(JsonContext& context, Handler const*& result) if (handler->role_ == Role::ADMIN && context.role != Role::ADMIN) return rpcNO_PERMISSION; - error_code_i res = conditionMet(handler->condition_, context); + error_code_i const res = conditionMet(handler->condition_, context); if (res != rpcSUCCESS) { return res; diff --git a/src/xrpld/rpc/detail/RPCHelpers.cpp b/src/xrpld/rpc/detail/RPCHelpers.cpp index b4a0685bd6..782d8c986e 100644 --- a/src/xrpld/rpc/detail/RPCHelpers.cpp +++ b/src/xrpld/rpc/detail/RPCHelpers.cpp @@ -1,20 +1,48 @@ -#include +#include + #include #include -#include -#include +#include +#include +#include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include -#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { namespace RPC { @@ -114,10 +142,10 @@ readLimitField(unsigned int& limit, Tuning::LimitRange const& range, JsonContext } std::optional -parseRippleLibSeed(Json::Value const& value) +parseXrplLibSeed(Json::Value const& value) { - // ripple-lib encodes seed used to generate an Ed25519 wallet in a - // non-standard way. While rippled never encode seeds that way, we + // XrplLib encodes seed used to generate an Ed25519 wallet in a + // non-standard way. While xrpld never encode seeds that way, we // try to detect such keys to avoid user confusion. if (!value.isString()) return std::nullopt; @@ -258,14 +286,14 @@ keypairForSignature(Json::Value const& params, Json::Value& error, unsigned int } } - // ripple-lib encodes seed used to generate an Ed25519 wallet in a + // XrplLib encodes seed used to generate an Ed25519 wallet in a // non-standard way. While we never encode seeds that way, we try // to detect such keys to avoid user confusion. // using strcmp as pointers may not match (see // https://developercommunity.visualstudio.com/t/assigning-constexpr-char--to-static-cha/10021357?entry=problem) if (strcmp(secretType, jss::seed_hex.c_str()) != 0) { - seed = RPC::parseRippleLibSeed(params[secretType]); + seed = RPC::parseXrplLibSeed(params[secretType]); if (seed) { @@ -384,5 +412,64 @@ isAccountObjectsValidType(LedgerEntryType const& type) } } +error_code_i +parseSubUnsubJson( + Asset& asset, + Json::Value const& params, + Json::StaticString const& name, + beast::Journal j) +{ + auto const& jv = params[name]; + auto const [issuerError, assetError] = [&]() { + if (name == jss::taker_pays) + return std::make_pair(rpcSRC_ISR_MALFORMED, rpcSRC_CUR_MALFORMED); + return std::make_pair(rpcDST_ISR_MALFORMED, rpcDST_AMT_MALFORMED); + }(); + + if (jv.isMember(jss::mpt_issuance_id) && + (jv.isMember(jss::currency) || jv.isMember(jss::issuer))) + { + JLOG(j.info()) << boost::format("Bad %s currency or MPT.") % name.c_str(); + return rpcINVALID_PARAMS; + } + + if (jv.isMember(jss::currency)) + { + Issue issue = xrpIssue(); + // Parse mandatory currency. + if (!jv.isMember(jss::currency) || + !to_currency(issue.currency, jv[jss::currency].asString())) + { + JLOG(j.info()) << boost::format("Bad %s currency.") % name.c_str(); + return assetError; + } + + // Parse optional issuer. + if (((jv.isMember(jss::issuer)) && + (!jv[jss::issuer].isString() || !to_issuer(issue.account, jv[jss::issuer].asString()))) + // Don't allow illegal issuers. + || (!issue.currency != !issue.account) || noAccount() == issue.account) + { + JLOG(j.info()) << boost::format("Bad %s issuer.") % name.c_str(); + return issuerError; + } + asset = issue; + } + else if (jv.isMember(jss::mpt_issuance_id)) + { + MPTID mptid; + if (!mptid.parseHex(jv[jss::mpt_issuance_id].asString())) + return assetError; + asset = mptid; + } + else + { + JLOG(j.info()) << boost::format("Neither %s currency or MPT is present.") % name.c_str(); + return assetError; + } + + return rpcSUCCESS; +} + } // namespace RPC } // namespace xrpl diff --git a/src/xrpld/rpc/detail/RPCHelpers.h b/src/xrpld/rpc/detail/RPCHelpers.h index 54a976b78e..64f7d223a6 100644 --- a/src/xrpld/rpc/detail/RPCHelpers.h +++ b/src/xrpld/rpc/detail/RPCHelpers.h @@ -94,16 +94,16 @@ std::optional getSeedFromRPC(Json::Value const& params, Json::Value& error); /** - * @brief Parses a RippleLib seed from RPC parameters. + * @brief Parses a XrplLib seed from RPC parameters. * * Attempts to extract and return a Seed from the provided JSON parameters using - * RippleLib conventions. + * XrplLib conventions. * * @param params The JSON value containing RPC parameters. * @return An optional Seed if parsing is successful, or std::nullopt otherwise. */ std::optional -parseRippleLibSeed(Json::Value const& params); +parseXrplLibSeed(Json::Value const& params); /** * @brief Chooses the ledger entry type based on RPC parameters. @@ -154,6 +154,15 @@ keypairForSignature( Json::Value& error, unsigned int apiVersion = apiVersionIfUnspecified); +/** Parse subscribe/unsubscribe parameters + */ +error_code_i +parseSubUnsubJson( + Asset& asset, + Json::Value const& jv, + Json::StaticString const& name, + beast::Journal j); + } // namespace RPC } // namespace xrpl diff --git a/src/xrpld/rpc/detail/RPCLedgerHelpers.cpp b/src/xrpld/rpc/detail/RPCLedgerHelpers.cpp index 2216affa6f..ecc42be3e1 100644 --- a/src/xrpld/rpc/detail/RPCLedgerHelpers.cpp +++ b/src/xrpld/rpc/detail/RPCLedgerHelpers.cpp @@ -1,12 +1,30 @@ -#include -#include -#include -#include #include -#include +#include +#include +#include +#include +#include +#include +#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include namespace xrpl { namespace RPC { @@ -166,7 +184,7 @@ ledgerFromSpecifier( ledger.reset(); using LedgerCase = org::xrpl::rpc::v1::LedgerSpecifier::LedgerCase; - LedgerCase ledgerCase = specifier.ledger_case(); + LedgerCase const ledgerCase = specifier.ledger_case(); switch (ledgerCase) { case LedgerCase::kHash: { diff --git a/src/xrpld/rpc/detail/RPCSub.cpp b/src/xrpld/rpc/detail/RPCSub.cpp index 3aa5f75f6a..ad336c1837 100644 --- a/src/xrpld/rpc/detail/RPCSub.cpp +++ b/src/xrpld/rpc/detail/RPCSub.cpp @@ -1,12 +1,28 @@ -#include #include +#include + #include #include #include -#include +#include +#include +#include +#include +#include // IWYU pragma: keep +#include +#include + +#include #include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -68,7 +84,7 @@ public: void send(Json::Value const& jvObj, bool broadcast) override { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); auto jm = broadcast ? j_.debug() : j_.info(); JLOG(jm) << "RPCCall::fromNetwork push: " << jvObj; @@ -88,7 +104,7 @@ public: void setUsername(std::string const& strUsername) override { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); mUsername = strUsername; } @@ -96,7 +112,7 @@ public: void setPassword(std::string const& strPassword) override { - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); mPassword = strPassword; } @@ -114,7 +130,7 @@ private: { { // Obtain the lock to manipulate the queue and change sending. - std::lock_guard sl(mLock); + std::lock_guard const sl(mLock); if (mDeque.empty()) { diff --git a/src/xrpld/rpc/detail/RippleLineCache.cpp b/src/xrpld/rpc/detail/RippleLineCache.cpp index d6ed7b1478..e69de29bb2 100644 --- a/src/xrpld/rpc/detail/RippleLineCache.cpp +++ b/src/xrpld/rpc/detail/RippleLineCache.cpp @@ -1,101 +0,0 @@ -#include -#include - -namespace xrpl { - -RippleLineCache::RippleLineCache(std::shared_ptr const& ledger, beast::Journal j) - : ledger_(ledger), journal_(j) -{ - JLOG(journal_.debug()) << "created for ledger " << ledger_->header().seq; -} - -RippleLineCache::~RippleLineCache() -{ - JLOG(journal_.debug()) << "destroyed for ledger " << ledger_->header().seq << " with " - << lines_.size() << " accounts and " << totalLineCount_ - << " distinct trust lines."; -} - -std::shared_ptr> -RippleLineCache::getRippleLines(AccountID const& accountID, LineDirection direction) -{ - auto const hash = hasher_(accountID); - AccountKey key(accountID, direction, hash); - AccountKey otherkey( - accountID, - direction == LineDirection::outgoing ? LineDirection::incoming : LineDirection::outgoing, - hash); - - std::lock_guard sl(mLock); - - auto [it, inserted] = - [&]() { - if (auto otheriter = lines_.find(otherkey); otheriter != lines_.end()) - { - // The whole point of using the direction flag is to reduce the - // number of trust line objects held in memory. Ensure that there is - // only a single set of trustlines in the cache per account. - auto const size = otheriter->second ? otheriter->second->size() : 0; - JLOG(journal_.info()) - << "Request for " - << (direction == LineDirection::outgoing ? "outgoing" : "incoming") - << " trust lines for account " << accountID << " found " << size - << (direction == LineDirection::outgoing ? " incoming" : " outgoing") - << " trust lines. " - << (direction == LineDirection::outgoing ? "Deleting the subset of incoming" - : "Returning the superset of outgoing") - << " trust lines. "; - if (direction == LineDirection::outgoing) - { - // This request is for the outgoing set, but there is already a - // subset of incoming lines in the cache. Erase that subset - // to be replaced by the full set. The full set will be built - // below, and will be returned, if needed, on subsequent calls - // for either value of outgoing. - XRPL_ASSERT( - size <= totalLineCount_, - "xrpl::RippleLineCache::getRippleLines : maximum lines"); - totalLineCount_ -= size; - lines_.erase(otheriter); - } - else - { - // This request is for the incoming set, but there is - // already a superset of the outgoing trust lines in the cache. - // The path finding engine will disregard the non-rippling trust - // lines, so to prevent them from being stored twice, return the - // outgoing set. - key = otherkey; - return std::pair{otheriter, false}; - } - } - return lines_.emplace(key, nullptr); - }(); - - if (inserted) - { - XRPL_ASSERT(it->second == nullptr, "xrpl::RippleLineCache::getRippleLines : null lines"); - auto lines = PathFindTrustLine::getItems(accountID, *ledger_, direction); - if (!lines.empty()) - { - it->second = std::make_shared>(std::move(lines)); - totalLineCount_ += it->second->size(); - } - } - - XRPL_ASSERT( - !it->second || (!it->second->empty()), - "xrpl::RippleLineCache::getRippleLines : null or nonempty lines"); - auto const size = it->second ? it->second->size() : 0; - JLOG(journal_.trace()) << "getRippleLines for ledger " << ledger_->header().seq << " found " - << size - << (key.direction_ == LineDirection::outgoing ? " outgoing" - : " incoming") - << " lines for " << (inserted ? "new " : "existing ") << accountID - << " out of a total of " << lines_.size() << " accounts and " - << totalLineCount_ << " trust lines"; - - return it->second; -} - -} // namespace xrpl diff --git a/src/xrpld/rpc/detail/RippleLineCache.h b/src/xrpld/rpc/detail/RippleLineCache.h index 65607f2d25..e69de29bb2 100644 --- a/src/xrpld/rpc/detail/RippleLineCache.h +++ b/src/xrpld/rpc/detail/RippleLineCache.h @@ -1,101 +0,0 @@ -#pragma once - -#include - -#include -#include -#include - -#include -#include -#include - -namespace xrpl { - -// Used by Pathfinder -class RippleLineCache final : public CountedObject -{ -public: - explicit RippleLineCache(std::shared_ptr const& l, beast::Journal j); - ~RippleLineCache(); - - std::shared_ptr const& - getLedger() const - { - return ledger_; - } - - /** Find the trust lines associated with an account. - - @param accountID The account - @param direction Whether the account is an "outgoing" link on the path. - "Outgoing" is defined as the source account, or an account found via a - trustline that has rippling enabled on the @accountID's side. If an - account is "outgoing", all trust lines will be returned. If an account is - not "outgoing", then any trust lines that don't have rippling enabled are - not usable, so only return trust lines that have rippling enabled on - @accountID's side. - @return Returns a vector of the usable trust lines. - */ - std::shared_ptr> - getRippleLines(AccountID const& accountID, LineDirection direction); - -private: - std::mutex mLock; - - xrpl::hardened_hash<> hasher_; - std::shared_ptr ledger_; - - beast::Journal journal_; - - struct AccountKey final : public CountedObject - { - AccountID account_; - LineDirection direction_; - std::size_t hash_value_; - - AccountKey(AccountID const& account, LineDirection direction, std::size_t hash) - : account_(account), direction_(direction), hash_value_(hash) - { - } - - AccountKey(AccountKey const& other) = default; - - AccountKey& - operator=(AccountKey const& other) = default; - - bool - operator==(AccountKey const& lhs) const - { - return hash_value_ == lhs.hash_value_ && account_ == lhs.account_ && - direction_ == lhs.direction_; - } - - std::size_t - get_hash() const - { - return hash_value_; - } - - struct Hash - { - Hash() = default; - - std::size_t - operator()(AccountKey const& key) const noexcept - { - return key.get_hash(); - } - }; - }; - - // Use a shared_ptr so entries can be removed from the map safely. - // Even though a shared_ptr to a vector will take more memory just a vector, - // most accounts are not going to have any entries (estimated over 90%), so - // vectors will not need to be created for them. This should lead to far - // less memory usage overall. - hash_map>, AccountKey::Hash> lines_; - std::size_t totalLineCount_ = 0; -}; - -} // namespace xrpl diff --git a/src/xrpld/rpc/detail/Role.cpp b/src/xrpld/rpc/detail/Role.cpp index 499787cece..8878434827 100644 --- a/src/xrpld/rpc/detail/Role.cpp +++ b/src/xrpld/rpc/detail/Role.cpp @@ -1,9 +1,25 @@ #include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include #include -#include #include +#include +#include +#include +#include namespace xrpl { @@ -224,7 +240,7 @@ extractIpAddrFromField(std::string_view field) // If there's a port appended to the IP address, strip that by // terminating at the colon. - if (std::size_t colon = ret.find(':'); colon != std::string_view::npos) + if (std::size_t const colon = ret.find(':'); colon != std::string_view::npos) ret = ret.substr(0, colon); return ret; @@ -256,7 +272,7 @@ forwardedFor(http_request_type const& request) // We found a "for=". Scan for the end of the IP address. std::size_t const pos = [&found, &it]() { - std::size_t pos = + std::size_t const pos = std::string_view(found, it->value().end() - found).find_first_of(",;"); if (pos != std::string_view::npos) return pos; diff --git a/src/xrpld/rpc/detail/ServerHandler.cpp b/src/xrpld/rpc/detail/ServerHandler.cpp index ca026104cf..2006af7932 100644 --- a/src/xrpld/rpc/detail/ServerHandler.cpp +++ b/src/xrpld/rpc/detail/ServerHandler.cpp @@ -1,38 +1,74 @@ +#include + #include #include #include #include #include -#include #include #include -#include +#include #include #include #include +#include #include #include +#include +#include #include +#include +#include #include +#include +#include #include #include +#include #include #include +#include +#include +#include +#include #include #include +#include +#include #include +#include #include +#include #include +#include #include -#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -78,12 +114,12 @@ authorized(Port const& port, std::map const& h) return false; std::string strUserPass64 = it->second.substr(6); boost::trim(strUserPass64); - std::string strUserPass = base64_decode(strUserPass64); - std::string::size_type nColon = strUserPass.find(':'); + std::string const strUserPass = base64_decode(strUserPass64); + std::string::size_type const nColon = strUserPass.find(':'); if (nColon == std::string::npos) return false; - std::string strUser = strUserPass.substr(0, nColon); - std::string strPassword = strUserPass.substr(nColon + 1); + std::string const strUser = strUserPass.substr(0, nColon); + std::string const strPassword = strUserPass.substr(nColon + 1); return strUser == port.user && strPassword == port.password; } @@ -158,7 +194,7 @@ ServerHandler::onAccept(Session& session, boost::asio::ip::tcp::endpoint endpoin auto const& port = session.port(); auto const c = [this, &port]() { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); return ++count_[port]; }(); @@ -282,7 +318,7 @@ ServerHandler::onRequest(Session& session) return; } - std::shared_ptr detachedSession = session.detach(); + std::shared_ptr const detachedSession = session.detach(); auto const postResult = m_jobQueue.postCoro( jtCLIENT_RPC, "RPC-Client", [this, detachedSession](std::shared_ptr coro) { processSession(detachedSession, coro); @@ -343,14 +379,14 @@ ServerHandler::onWSMessage( void ServerHandler::onClose(Session& session, boost::system::error_code const&) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); --count_[session.port()]; } void ServerHandler::onStopped(Server&) { - std::lock_guard lock(mutex_); + std::lock_guard const lock(mutex_); stopped_ = true; condition_.notify_one(); } @@ -732,7 +768,7 @@ ServerHandler::processRequest( continue; } - std::string strMethod = method.asString(); + std::string const strMethod = method.asString(); if (strMethod.empty()) { usage.charge(Resource::feeMalformedRPC); diff --git a/src/xrpld/rpc/detail/Status.cpp b/src/xrpld/rpc/detail/Status.cpp index ce3082f0fa..d03046f04b 100644 --- a/src/xrpld/rpc/detail/Status.cpp +++ b/src/xrpld/rpc/detail/Status.cpp @@ -1,6 +1,13 @@ #include +#include +#include +#include +#include +#include + #include +#include namespace xrpl { namespace RPC { diff --git a/src/xrpld/rpc/detail/TransactionSign.cpp b/src/xrpld/rpc/detail/TransactionSign.cpp index 1fb6fc291f..d8d965c9f0 100644 --- a/src/xrpld/rpc/detail/TransactionSign.cpp +++ b/src/xrpld/rpc/detail/TransactionSign.cpp @@ -1,28 +1,66 @@ +#include + #include #include #include #include #include +#include +#include #include #include #include -#include +#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include +#include #include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include #include +#include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include #include // Validity::Valid #include #include -#include +#include +#include +#include +#include #include +#include +#include +#include namespace xrpl { namespace RPC { @@ -206,7 +244,10 @@ checkPayment( if (!dstAccountID) return RPC::invalid_field_error("tx_json.Destination"); - if (params.isMember(jss::build_path) && ((!doPath) || amount.holds())) + if (params.isMember(jss::build_path) && + (!doPath || + (!app.getOpenLedger().current()->rules().enabled(featureMPTokensV2) && + amount.holds()))) { return RPC::make_error( rpcINVALID_PARAMS, "Field 'build_path' not allowed in this context."); @@ -242,16 +283,18 @@ checkPayment( } else { - // If no SendMax, default to Amount with sender as issuer. + // If no SendMax, default to Amount with sender as issuer if Issue. sendMax = amount; - sendMax.setIssuer(srcAddressID); + sendMax.asset().visit( + [&](Issue const&) { sendMax.get().account = srcAddressID; }, + [](MPTIssue const&) {}); } if (sendMax.native() && amount.native()) return RPC::make_error(rpcINVALID_PARAMS, "Cannot build XRP to XRP paths."); { - LegacyPathFind lpf(isUnlimited(role), app); + LegacyPathFind const lpf(isUnlimited(role), app); if (!lpf.isOk()) return rpcError(rpcTOO_BUSY); @@ -260,11 +303,11 @@ checkPayment( if (auto ledger = app.getOpenLedger().current()) { Pathfinder pf( - std::make_shared(ledger, app.getJournal("RippleLineCache")), + std::make_shared(ledger, app.getJournal("AssetCache")), srcAddressID, *dstAccountID, - sendMax.issue().currency, - sendMax.issue().account, + sendMax.asset(), + sendMax.getIssuer(), amount, std::nullopt, domain, @@ -274,8 +317,8 @@ checkPayment( // 4 is the maximum paths pf.computePathRanks(4); STPath fullLiquidityPath; - STPathSet paths; - result = pf.getBestPaths(4, fullLiquidityPath, paths, sendMax.issue().account); + STPathSet const paths; + result = pf.getBestPaths(4, fullLiquidityPath, paths, sendMax.getIssuer()); } } @@ -614,7 +657,7 @@ transactionPreProcessImpl( stTx = std::make_shared(std::move(parsed.object.value())); } - catch (STObject::FieldErr& err) + catch (STObject::FieldErr const& err) { return RPC::make_error(rpcINVALID_PARAMS, err.what()); } @@ -631,7 +674,7 @@ transactionPreProcessImpl( // If multisign then return multiSignature, else set TxnSignature field. if (signingArgs.isMultiSigning()) { - Serializer s = buildMultiSigningData(*stTx, signingArgs.getSigner()); + Serializer const s = buildMultiSigningData(*stTx, signingArgs.getSigner()); auto multisig = xrpl::sign(pk, sk, s.slice()); @@ -673,7 +716,7 @@ transactionConstructImpl( { Serializer s; tpTrans->getSTransaction()->add(s); - Blob transBlob = s.getData(); + Blob const transBlob = s.getData(); SerialIter sit{makeSlice(transBlob)}; // Check the signature if that's called for. @@ -954,15 +997,15 @@ transactionSign( // Add and amend fields based on the transaction type. SigningForParams signForParams; - transactionPreProcessResult preprocResult = + transactionPreProcessResult const preprocResult = transactionPreProcessImpl(jvRequest, role, signForParams, validatedLedgerAge, app); if (!preprocResult.second) return preprocResult.first; - std::shared_ptr ledger = app.getOpenLedger().current(); + std::shared_ptr const ledger = app.getOpenLedger().current(); // Make sure the STTx makes a legitimate Transaction. - std::pair txn = + std::pair const txn = transactionConstructImpl(preprocResult.second, ledger->rules(), app); if (!txn.second) @@ -990,7 +1033,7 @@ transactionSubmit( // Add and amend fields based on the transaction type. SigningForParams signForParams; - transactionPreProcessResult preprocResult = + transactionPreProcessResult const preprocResult = transactionPreProcessImpl(jvRequest, role, signForParams, validatedLedgerAge, app); if (!preprocResult.second) @@ -1150,7 +1193,7 @@ transactionSignFor( // Add and amend fields based on the transaction type. SigningForParams signForParams(*signerAccountID); - transactionPreProcessResult preprocResult = + transactionPreProcessResult const preprocResult = transactionPreProcessImpl(jvRequest, role, signForParams, validatedLedgerAge, app); if (!preprocResult.second) @@ -1160,7 +1203,8 @@ transactionSignFor( signForParams.validMultiSign(), "xrpl::RPC::transactionSignFor : valid multi-signature"); { - std::shared_ptr account_state = ledger->read(keylet::account(*signerAccountID)); + std::shared_ptr const account_state = + ledger->read(keylet::account(*signerAccountID)); // Make sure the account and secret belong together. auto const err = acctMatchesPubKey(account_state, *signerAccountID, signForParams.getPublicKey()); @@ -1198,7 +1242,7 @@ transactionSignFor( } // Make sure the STTx makes a legitimate Transaction. - std::pair txn = + std::pair const txn = transactionConstructImpl(sttx, ledger->rules(), app); if (!txn.second) @@ -1245,7 +1289,7 @@ transactionSubmitMultiSigned( if (RPC::contains_error(txJsonResult)) return std::move(txJsonResult); - std::shared_ptr sle = ledger->read(keylet::account(srcAddressID)); + std::shared_ptr const sle = ledger->read(keylet::account(srcAddressID)); if (!sle) { @@ -1285,13 +1329,13 @@ transactionSubmitMultiSigned( { stTx = std::make_shared(std::move(parsedTx_json.object.value())); } - catch (STObject::FieldErr& err) + catch (STObject::FieldErr const& err) { return RPC::make_error(rpcINVALID_PARAMS, err.what()); } catch (std::exception& ex) { - std::string reason(ex.what()); + std::string const reason(ex.what()); return RPC::make_error( rpcINTERNAL, "Exception while serializing transaction: " + reason); } diff --git a/src/xrpld/rpc/detail/TransactionSign.h b/src/xrpld/rpc/detail/TransactionSign.h index 62a34d931e..8ffcb44a84 100644 --- a/src/xrpld/rpc/detail/TransactionSign.h +++ b/src/xrpld/rpc/detail/TransactionSign.h @@ -1,5 +1,6 @@ #pragma once +#include #include #include diff --git a/src/xrpld/rpc/detail/TrustLine.cpp b/src/xrpld/rpc/detail/TrustLine.cpp index c2bc152448..5b7b555eca 100644 --- a/src/xrpld/rpc/detail/TrustLine.cpp +++ b/src/xrpld/rpc/detail/TrustLine.cpp @@ -1,9 +1,17 @@ #include +#include +#include #include +#include +#include +#include #include +#include #include +#include +#include namespace xrpl { diff --git a/src/xrpld/rpc/detail/TrustLine.h b/src/xrpld/rpc/detail/TrustLine.h index a0fce8847a..f3bf397400 100644 --- a/src/xrpld/rpc/detail/TrustLine.h +++ b/src/xrpld/rpc/detail/TrustLine.h @@ -69,25 +69,25 @@ public: bool getAuth() const { - return mFlags & (mViewLowest ? lsfLowAuth : lsfHighAuth); + return (mFlags & (mViewLowest ? lsfLowAuth : lsfHighAuth)) != 0u; } bool getAuthPeer() const { - return mFlags & (!mViewLowest ? lsfLowAuth : lsfHighAuth); + return (mFlags & (!mViewLowest ? lsfLowAuth : lsfHighAuth)) != 0u; } bool getNoRipple() const { - return mFlags & (mViewLowest ? lsfLowNoRipple : lsfHighNoRipple); + return (mFlags & (mViewLowest ? lsfLowNoRipple : lsfHighNoRipple)) != 0u; } bool getNoRipplePeer() const { - return mFlags & (!mViewLowest ? lsfLowNoRipple : lsfHighNoRipple); + return (mFlags & (!mViewLowest ? lsfLowNoRipple : lsfHighNoRipple)) != 0u; } LineDirection @@ -106,28 +106,28 @@ public: bool getFreeze() const { - return mFlags & (mViewLowest ? lsfLowFreeze : lsfHighFreeze); + return (mFlags & (mViewLowest ? lsfLowFreeze : lsfHighFreeze)) != 0u; } /** Have we set the deep freeze flag on our peer */ bool getDeepFreeze() const { - return mFlags & (mViewLowest ? lsfLowDeepFreeze : lsfHighDeepFreeze); + return (mFlags & (mViewLowest ? lsfLowDeepFreeze : lsfHighDeepFreeze)) != 0u; } /** Has the peer set the freeze flag on us */ bool getFreezePeer() const { - return mFlags & (!mViewLowest ? lsfLowFreeze : lsfHighFreeze); + return (mFlags & (!mViewLowest ? lsfLowFreeze : lsfHighFreeze)) != 0u; } /** Has the peer set the deep freeze flag on us */ bool getDeepFreezePeer() const { - return mFlags & (!mViewLowest ? lsfLowDeepFreeze : lsfHighDeepFreeze); + return (mFlags & (!mViewLowest ? lsfLowDeepFreeze : lsfHighDeepFreeze)) != 0u; } STAmount const& diff --git a/src/xrpld/rpc/detail/Tuning.h b/src/xrpld/rpc/detail/Tuning.h index e9dd2c37d7..59994b1660 100644 --- a/src/xrpld/rpc/detail/Tuning.h +++ b/src/xrpld/rpc/detail/Tuning.h @@ -29,7 +29,7 @@ static LimitRange constexpr accountOffers = {10, 200, 400}; static LimitRange constexpr accountTx = {10, 200, 400}; /** Limits for the book_offers command. */ -static LimitRange constexpr bookOffers = {0, 60, 100}; +static LimitRange constexpr bookOffers = {1, 60, 100}; /** Limits for the no_ripple_check command. */ static LimitRange constexpr noRippleCheck = {10, 300, 400}; @@ -55,7 +55,7 @@ static int constexpr binaryPageLength = 2048; static int constexpr jsonPageLength = 256; /** Maximum number of pages in a LedgerData response. */ -inline int constexpr pageLength(bool isBinary) +int constexpr pageLength(bool isBinary) { return isBinary ? binaryPageLength : jsonPageLength; } diff --git a/src/xrpld/rpc/handlers/BookOffers.cpp b/src/xrpld/rpc/handlers/BookOffers.cpp deleted file mode 100644 index ec53473821..0000000000 --- a/src/xrpld/rpc/handlers/BookOffers.cpp +++ /dev/null @@ -1,220 +0,0 @@ -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include - -namespace xrpl { - -Json::Value -doBookOffers(RPC::JsonContext& context) -{ - // VFALCO TODO Here is a terrible place for this kind of business - // logic. It needs to be moved elsewhere and documented, - // and encapsulated into a function. - if (context.app.getJobQueue().getJobCountGE(jtCLIENT) > 200) - return rpcError(rpcTOO_BUSY); - - std::shared_ptr lpLedger; - auto jvResult = RPC::lookupLedger(lpLedger, context); - - if (!lpLedger) - return jvResult; - - if (!context.params.isMember(jss::taker_pays)) - return RPC::missing_field_error(jss::taker_pays); - - if (!context.params.isMember(jss::taker_gets)) - return RPC::missing_field_error(jss::taker_gets); - - Json::Value const& taker_pays = context.params[jss::taker_pays]; - Json::Value const& taker_gets = context.params[jss::taker_gets]; - - if (!taker_pays.isObjectOrNull()) - return RPC::object_field_error(jss::taker_pays); - - if (!taker_gets.isObjectOrNull()) - return RPC::object_field_error(jss::taker_gets); - - if (!taker_pays.isMember(jss::currency)) - return RPC::missing_field_error("taker_pays.currency"); - - if (!taker_pays[jss::currency].isString()) - return RPC::expected_field_error("taker_pays.currency", "string"); - - if (!taker_gets.isMember(jss::currency)) - return RPC::missing_field_error("taker_gets.currency"); - - if (!taker_gets[jss::currency].isString()) - return RPC::expected_field_error("taker_gets.currency", "string"); - - Currency pay_currency; - - if (!to_currency(pay_currency, taker_pays[jss::currency].asString())) - { - JLOG(context.j.info()) << "Bad taker_pays currency."; - return RPC::make_error( - rpcSRC_CUR_MALFORMED, "Invalid field 'taker_pays.currency', bad currency."); - } - - Currency get_currency; - - if (!to_currency(get_currency, taker_gets[jss::currency].asString())) - { - JLOG(context.j.info()) << "Bad taker_gets currency."; - return RPC::make_error( - rpcDST_AMT_MALFORMED, "Invalid field 'taker_gets.currency', bad currency."); - } - - AccountID pay_issuer; - - if (taker_pays.isMember(jss::issuer)) - { - if (!taker_pays[jss::issuer].isString()) - return RPC::expected_field_error("taker_pays.issuer", "string"); - - if (!to_issuer(pay_issuer, taker_pays[jss::issuer].asString())) - { - return RPC::make_error( - rpcSRC_ISR_MALFORMED, "Invalid field 'taker_pays.issuer', bad issuer."); - } - - if (pay_issuer == noAccount()) - { - return RPC::make_error( - rpcSRC_ISR_MALFORMED, "Invalid field 'taker_pays.issuer', bad issuer account one."); - } - } - else - { - pay_issuer = xrpAccount(); - } - - if (isXRP(pay_currency) && !isXRP(pay_issuer)) - { - return RPC::make_error( - rpcSRC_ISR_MALFORMED, - "Unneeded field 'taker_pays.issuer' for " - "XRP currency specification."); - } - - if (!isXRP(pay_currency) && isXRP(pay_issuer)) - { - return RPC::make_error( - rpcSRC_ISR_MALFORMED, "Invalid field 'taker_pays.issuer', expected non-XRP issuer."); - } - - AccountID get_issuer; - - if (taker_gets.isMember(jss::issuer)) - { - if (!taker_gets[jss::issuer].isString()) - return RPC::expected_field_error("taker_gets.issuer", "string"); - - if (!to_issuer(get_issuer, taker_gets[jss::issuer].asString())) - { - return RPC::make_error( - rpcDST_ISR_MALFORMED, "Invalid field 'taker_gets.issuer', bad issuer."); - } - - if (get_issuer == noAccount()) - { - return RPC::make_error( - rpcDST_ISR_MALFORMED, "Invalid field 'taker_gets.issuer', bad issuer account one."); - } - } - else - { - get_issuer = xrpAccount(); - } - - if (isXRP(get_currency) && !isXRP(get_issuer)) - { - return RPC::make_error( - rpcDST_ISR_MALFORMED, - "Unneeded field 'taker_gets.issuer' for " - "XRP currency specification."); - } - - if (!isXRP(get_currency) && isXRP(get_issuer)) - { - return RPC::make_error( - rpcDST_ISR_MALFORMED, "Invalid field 'taker_gets.issuer', expected non-XRP issuer."); - } - - std::optional takerID; - if (context.params.isMember(jss::taker)) - { - if (!context.params[jss::taker].isString()) - return RPC::expected_field_error(jss::taker, "string"); - - takerID = parseBase58(context.params[jss::taker].asString()); - if (!takerID) - return RPC::invalid_field_error(jss::taker); - } - - std::optional domain; - if (context.params.isMember(jss::domain)) - { - uint256 num; - if (!context.params[jss::domain].isString() || - !num.parseHex(context.params[jss::domain].asString())) - { - return RPC::make_error(rpcDOMAIN_MALFORMED, "Unable to parse domain."); - } - - domain = num; - } - - if (pay_currency == get_currency && pay_issuer == get_issuer) - { - JLOG(context.j.info()) << "taker_gets same as taker_pays."; - return RPC::make_error(rpcBAD_MARKET); - } - - unsigned int limit = 0; - if (auto err = readLimitField(limit, RPC::Tuning::bookOffers, context)) - return *err; - - bool const bProof(context.params.isMember(jss::proof)); - - Json::Value const jvMarker( - context.params.isMember(jss::marker) ? context.params[jss::marker] - : Json::Value(Json::nullValue)); - - context.netOps.getBookPage( - lpLedger, - {{pay_currency, pay_issuer}, {get_currency, get_issuer}, domain}, - takerID ? *takerID : beast::zero, - bProof, - limit, - jvMarker, - jvResult); - - context.loadType = Resource::feeMediumBurdenRPC; - - return jvResult; -} - -Json::Value -doBookChanges(RPC::JsonContext& context) -{ - std::shared_ptr ledger; - - Json::Value result = RPC::lookupLedger(ledger, context); - if (ledger == nullptr) - return result; - - return RPC::computeBookChanges(ledger); -} - -} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/ChannelVerify.cpp b/src/xrpld/rpc/handlers/ChannelVerify.cpp new file mode 100644 index 0000000000..c1c7ab750b --- /dev/null +++ b/src/xrpld/rpc/handlers/ChannelVerify.cpp @@ -0,0 +1,80 @@ +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +namespace xrpl { + +// { +// public_key: +// channel_id: 256-bit channel id +// drops: 64-bit uint (as string) +// signature: signature to verify +// } +Json::Value +doChannelVerify(RPC::JsonContext& context) +{ + auto const& params(context.params); + for (auto const& p : {jss::public_key, jss::channel_id, jss::amount, jss::signature}) + { + if (!params.isMember(p)) + return RPC::missing_field_error(p); + } + + std::optional pk; + { + std::string const strPk = params[jss::public_key].asString(); + pk = parseBase58(TokenType::AccountPublic, strPk); + + if (!pk) + { + auto pkHex = strUnHex(strPk); + if (!pkHex) + return rpcError(rpcPUBLIC_MALFORMED); + auto const pkType = publicKeyType(makeSlice(*pkHex)); + if (!pkType) + return rpcError(rpcPUBLIC_MALFORMED); + pk.emplace(makeSlice(*pkHex)); + } + } + + uint256 channelId; + if (!channelId.parseHex(params[jss::channel_id].asString())) + return rpcError(rpcCHANNEL_MALFORMED); + + std::optional const optDrops = + params[jss::amount].isString() ? to_uint64(params[jss::amount].asString()) : std::nullopt; + + if (!optDrops) + return rpcError(rpcCHANNEL_AMT_MALFORMED); + + std::uint64_t const drops = *optDrops; + + auto sig = strUnHex(params[jss::signature].asString()); + if (!sig || sig->empty()) + return rpcError(rpcINVALID_PARAMS); + + Serializer msg; + serializePayChanAuthorization(msg, channelId, XRPAmount(drops)); + + Json::Value result; + result[jss::signature_verified] = verify(*pk, msg.slice(), makeSlice(*sig)); + return result; +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/Handlers.h b/src/xrpld/rpc/handlers/Handlers.h index a5a96baa31..23328cf52a 100644 --- a/src/xrpld/rpc/handlers/Handlers.h +++ b/src/xrpld/rpc/handlers/Handlers.h @@ -1,6 +1,6 @@ #pragma once -#include +#include namespace xrpl { @@ -19,7 +19,7 @@ doAccountObjects(RPC::JsonContext&); Json::Value doAccountOffers(RPC::JsonContext&); Json::Value -doAccountTxJson(RPC::JsonContext&); +doAccountTx(RPC::JsonContext&); Json::Value doAMMInfo(RPC::JsonContext&); Json::Value diff --git a/src/xrpld/rpc/handlers/VaultInfo.cpp b/src/xrpld/rpc/handlers/VaultInfo.cpp index 4a704e0b0b..711478658a 100644 --- a/src/xrpld/rpc/handlers/VaultInfo.cpp +++ b/src/xrpld/rpc/handlers/VaultInfo.cpp @@ -1,12 +1,17 @@ #include #include +#include #include #include +#include #include #include +#include #include -#include + +#include +#include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/AccountChannels.cpp b/src/xrpld/rpc/handlers/account/AccountChannels.cpp similarity index 91% rename from src/xrpld/rpc/handlers/AccountChannels.cpp rename to src/xrpld/rpc/handlers/account/AccountChannels.cpp index 7bf8a03f21..03a383452b 100644 --- a/src/xrpld/rpc/handlers/AccountChannels.cpp +++ b/src/xrpld/rpc/handlers/account/AccountChannels.cpp @@ -3,15 +3,36 @@ #include #include +#include +#include +#include +#include +#include +#include #include -#include #include +#include #include +#include +#include #include #include +#include #include +#include #include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { void diff --git a/src/xrpld/rpc/handlers/AccountCurrenciesHandler.cpp b/src/xrpld/rpc/handlers/account/AccountCurrencies.cpp similarity index 85% rename from src/xrpld/rpc/handlers/AccountCurrenciesHandler.cpp rename to src/xrpld/rpc/handlers/account/AccountCurrencies.cpp index e509a72862..dfcfffbf27 100644 --- a/src/xrpld/rpc/handlers/AccountCurrenciesHandler.cpp +++ b/src/xrpld/rpc/handlers/account/AccountCurrencies.cpp @@ -2,11 +2,20 @@ #include #include +#include #include +#include #include +#include #include +#include +#include #include +#include +#include +#include + namespace xrpl { Json::Value @@ -55,9 +64,9 @@ doAccountCurrencies(RPC::JsonContext& context) STAmount const& saBalance = rspEntry.getBalance(); if (saBalance < rspEntry.getLimit()) - receive.insert(saBalance.getCurrency()); + receive.insert(saBalance.get().currency); if ((-saBalance) < rspEntry.getLimitPeer()) - send.insert(saBalance.getCurrency()); + send.insert(saBalance.get().currency); } send.erase(badCurrency()); diff --git a/src/xrpld/rpc/handlers/AccountInfo.cpp b/src/xrpld/rpc/handlers/account/AccountInfo.cpp similarity index 95% rename from src/xrpld/rpc/handlers/AccountInfo.cpp rename to src/xrpld/rpc/handlers/account/AccountInfo.cpp index becaea8a51..019ff83def 100644 --- a/src/xrpld/rpc/handlers/AccountInfo.cpp +++ b/src/xrpld/rpc/handlers/account/AccountInfo.cpp @@ -1,18 +1,36 @@ #include #include #include -#include #include +#include +#include +#include +#include +#include #include #include #include +#include #include +#include #include -#include +#include +#include +#include +#include #include #include +#include + +#include +#include +#include +#include +#include +#include +#include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/AccountLines.cpp b/src/xrpld/rpc/handlers/account/AccountLines.cpp similarity index 91% rename from src/xrpld/rpc/handlers/AccountLines.cpp rename to src/xrpld/rpc/handlers/account/AccountLines.cpp index f7fc9bdd2d..3b5329f83c 100644 --- a/src/xrpld/rpc/handlers/AccountLines.cpp +++ b/src/xrpld/rpc/handlers/account/AccountLines.cpp @@ -4,13 +4,34 @@ #include #include +#include +#include +#include +#include +#include #include #include +#include #include +#include +#include #include +#include +#include +#include #include #include +#include +#include + +#include +#include +#include +#include +#include +#include + namespace xrpl { void @@ -28,7 +49,7 @@ addLine(Json::Value& jsonLines, RPCTrustLine const& line) // Amount reported is negative if other account holds current // account's IOUs. jPeer[jss::balance] = saBalance.getText(); - jPeer[jss::currency] = to_string(saBalance.issue().currency); + jPeer[jss::currency] = to_string(saBalance.get().currency); jPeer[jss::limit] = saLimit.getText(); jPeer[jss::limit_peer] = saLimitPeer.getText(); jPeer[jss::quality_in] = line.getQualityIn().value; @@ -105,7 +126,7 @@ doAccountLines(RPC::JsonContext& context) // this flag allows the requester to ask incoming trustlines in default // state be omitted - bool ignoreDefault = + bool const ignoreDefault = params.isMember(jss::ignore_default) && params[jss::ignore_default].asBool(); Json::Value& jsonLines(result[jss::lines] = Json::arrayValue); diff --git a/src/xrpld/rpc/handlers/account/AccountNFTs.cpp b/src/xrpld/rpc/handlers/account/AccountNFTs.cpp new file mode 100644 index 0000000000..605dd3b07c --- /dev/null +++ b/src/xrpld/rpc/handlers/account/AccountNFTs.cpp @@ -0,0 +1,168 @@ +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +namespace xrpl { + +/** General RPC command that can retrieve objects in the account root. + { + account: + ledger_hash: // optional + ledger_index: // optional + type: // optional, defaults to all account objects types + limit: // optional + marker: // optional, resume previous query + } +*/ +Json::Value +doAccountNFTs(RPC::JsonContext& context) +{ + auto const& params = context.params; + if (!params.isMember(jss::account)) + return RPC::missing_field_error(jss::account); + + if (!params[jss::account].isString()) + return RPC::invalid_field_error(jss::account); + + auto id = parseBase58(params[jss::account].asString()); + if (!id) + { + return rpcError(rpcACT_MALFORMED); + } + + std::shared_ptr ledger; + auto result = RPC::lookupLedger(ledger, context); + if (ledger == nullptr) + return result; + auto const accountID{id.value()}; + + if (!ledger->exists(keylet::account(accountID))) + return rpcError(rpcACT_NOT_FOUND); + + unsigned int limit = 0; + if (auto err = readLimitField(limit, RPC::Tuning::accountNFTokens, context)) + return *err; + + uint256 marker; + bool const markerSet = params.isMember(jss::marker); + + if (markerSet) + { + auto const& m = params[jss::marker]; + if (!m.isString()) + return RPC::expected_field_error(jss::marker, "string"); + + if (!marker.parseHex(m.asString())) + return RPC::invalid_field_error(jss::marker); + } + + auto const first = keylet::nftpage(keylet::nftpage_min(accountID), marker); + auto const last = keylet::nftpage_max(accountID); + + auto cp = ledger->read( + Keylet(ltNFTOKEN_PAGE, ledger->succ(first.key, last.key.next()).value_or(last.key))); + + std::uint32_t cnt = 0; + auto& nfts = (result[jss::account_nfts] = Json::arrayValue); + + // Continue iteration from the current page: + bool pastMarker = marker.isZero(); + bool markerFound = false; + uint256 const maskedMarker = marker & nft::pageMask; + while (cp) + { + auto arr = cp->getFieldArray(sfNFTokens); + + for (auto const& o : arr) + { + // Scrolling past the marker gets weird. We need to look at + // a couple of conditions. + // + // 1. If the low 96-bits don't match, then we compare only + // against the low 96-bits, since that's what determines + // the sort order of the pages. + // + // 2. However, within one page there can be a number of + // NFTokenIDs that all have the same low 96 bits. If we're + // in that case then we need to compare against the full + // 256 bits. + uint256 const nftokenID = o[sfNFTokenID]; + uint256 const maskedNftokenID = nftokenID & nft::pageMask; + + if (!pastMarker) + { + if (maskedNftokenID < maskedMarker) + continue; + + if (maskedNftokenID == maskedMarker && nftokenID < marker) + continue; + + if (nftokenID == marker) + { + markerFound = true; + continue; + } + } + + if (markerSet && !markerFound) + return RPC::invalid_field_error(jss::marker); + + pastMarker = true; + + { + Json::Value& obj = nfts.append(o.getJson(JsonOptions::none)); + + // Pull out the components of the nft ID. + obj[sfFlags.jsonName] = nft::getFlags(nftokenID); + obj[sfIssuer.jsonName] = to_string(nft::getIssuer(nftokenID)); + obj[sfNFTokenTaxon.jsonName] = nft::toUInt32(nft::getTaxon(nftokenID)); + obj[jss::nft_serial] = nft::getSerial(nftokenID); + if (std::uint16_t const xferFee = {nft::getTransferFee(nftokenID)}) + obj[sfTransferFee.jsonName] = xferFee; + } + + if (++cnt == limit) + { + result[jss::limit] = limit; + result[jss::marker] = to_string(o.getFieldH256(sfNFTokenID)); + return result; + } + } + + if (auto npm = (*cp)[~sfNextPageMin]) + { + cp = ledger->read(Keylet(ltNFTOKEN_PAGE, *npm)); + } + else + { + cp = nullptr; + } + } + + if (markerSet && !markerFound) + return RPC::invalid_field_error(jss::marker); + + result[jss::account] = toBase58(accountID); + context.loadType = Resource::feeMediumBurdenRPC; + return result; +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/AccountObjects.cpp b/src/xrpld/rpc/handlers/account/AccountObjects.cpp similarity index 68% rename from src/xrpld/rpc/handlers/AccountObjects.cpp rename to src/xrpld/rpc/handlers/account/AccountObjects.cpp index cd67391da8..7a567be758 100644 --- a/src/xrpld/rpc/handlers/AccountObjects.cpp +++ b/src/xrpld/rpc/handlers/account/AccountObjects.cpp @@ -3,164 +3,29 @@ #include #include +#include +#include +#include #include +#include #include #include #include #include +#include #include #include #include -#include +#include +#include +#include +#include #include +#include namespace xrpl { -/** General RPC command that can retrieve objects in the account root. - { - account: - ledger_hash: // optional - ledger_index: // optional - type: // optional, defaults to all account objects types - limit: // optional - marker: // optional, resume previous query - } -*/ - -Json::Value -doAccountNFTs(RPC::JsonContext& context) -{ - auto const& params = context.params; - if (!params.isMember(jss::account)) - return RPC::missing_field_error(jss::account); - - if (!params[jss::account].isString()) - return RPC::invalid_field_error(jss::account); - - auto id = parseBase58(params[jss::account].asString()); - if (!id) - { - return rpcError(rpcACT_MALFORMED); - } - - std::shared_ptr ledger; - auto result = RPC::lookupLedger(ledger, context); - if (ledger == nullptr) - return result; - auto const accountID{id.value()}; - - if (!ledger->exists(keylet::account(accountID))) - return rpcError(rpcACT_NOT_FOUND); - - unsigned int limit = 0; - if (auto err = readLimitField(limit, RPC::Tuning::accountNFTokens, context)) - return *err; - - uint256 marker; - bool const markerSet = params.isMember(jss::marker); - - if (markerSet) - { - auto const& m = params[jss::marker]; - if (!m.isString()) - return RPC::expected_field_error(jss::marker, "string"); - - if (!marker.parseHex(m.asString())) - return RPC::invalid_field_error(jss::marker); - } - - auto const first = keylet::nftpage(keylet::nftpage_min(accountID), marker); - auto const last = keylet::nftpage_max(accountID); - - auto cp = ledger->read( - Keylet(ltNFTOKEN_PAGE, ledger->succ(first.key, last.key.next()).value_or(last.key))); - - std::uint32_t cnt = 0; - auto& nfts = (result[jss::account_nfts] = Json::arrayValue); - - // Continue iteration from the current page: - bool pastMarker = marker.isZero(); - bool markerFound = false; - uint256 const maskedMarker = marker & nft::pageMask; - while (cp) - { - auto arr = cp->getFieldArray(sfNFTokens); - - for (auto const& o : arr) - { - // Scrolling past the marker gets weird. We need to look at - // a couple of conditions. - // - // 1. If the low 96-bits don't match, then we compare only - // against the low 96-bits, since that's what determines - // the sort order of the pages. - // - // 2. However, within one page there can be a number of - // NFTokenIDs that all have the same low 96 bits. If we're - // in that case then we need to compare against the full - // 256 bits. - uint256 const nftokenID = o[sfNFTokenID]; - uint256 const maskedNftokenID = nftokenID & nft::pageMask; - - if (!pastMarker) - { - if (maskedNftokenID < maskedMarker) - continue; - - if (maskedNftokenID == maskedMarker && nftokenID < marker) - continue; - - if (nftokenID == marker) - { - markerFound = true; - continue; - } - } - - if (markerSet && !markerFound) - return RPC::invalid_field_error(jss::marker); - - pastMarker = true; - - { - Json::Value& obj = nfts.append(o.getJson(JsonOptions::none)); - - // Pull out the components of the nft ID. - obj[sfFlags.jsonName] = nft::getFlags(nftokenID); - obj[sfIssuer.jsonName] = to_string(nft::getIssuer(nftokenID)); - obj[sfNFTokenTaxon.jsonName] = nft::toUInt32(nft::getTaxon(nftokenID)); - obj[jss::nft_serial] = nft::getSerial(nftokenID); - if (std::uint16_t xferFee = {nft::getTransferFee(nftokenID)}) - obj[sfTransferFee.jsonName] = xferFee; - } - - if (++cnt == limit) - { - result[jss::limit] = limit; - result[jss::marker] = to_string(o.getFieldH256(sfNFTokenID)); - return result; - } - } - - if (auto npm = (*cp)[~sfNextPageMin]) - { - cp = ledger->read(Keylet(ltNFTOKEN_PAGE, *npm)); - } - else - { - cp = nullptr; - } - } - - if (markerSet && !markerFound) - return RPC::invalid_field_error(jss::marker); - - result[jss::account] = toBase58(accountID); - context.loadType = Resource::feeMediumBurdenRPC; - return result; -} - /** Gathers all objects for an account in a ledger. @param ledger Ledger to search account objects. @param account AccountID to find objects for. diff --git a/src/xrpld/rpc/handlers/AccountOffers.cpp b/src/xrpld/rpc/handlers/account/AccountOffers.cpp similarity index 89% rename from src/xrpld/rpc/handlers/AccountOffers.cpp rename to src/xrpld/rpc/handlers/account/AccountOffers.cpp index 517c0728e9..19b88e7499 100644 --- a/src/xrpld/rpc/handlers/AccountOffers.cpp +++ b/src/xrpld/rpc/handlers/account/AccountOffers.cpp @@ -3,21 +3,39 @@ #include #include +#include +#include +#include +#include #include #include -#include #include +#include #include +#include +#include #include +#include +#include #include #include +#include +#include + +#include +#include +#include +#include +#include +#include + namespace xrpl { void appendOfferJson(std::shared_ptr const& offer, Json::Value& offers) { - STAmount dirRate = amountFromQuality(getQuality(offer->getFieldH256(sfBookDirectory))); + STAmount const dirRate = amountFromQuality(getQuality(offer->getFieldH256(sfBookDirectory))); Json::Value& obj(offers.append(Json::objectValue)); offer->getFieldAmount(sfTakerPays).setJson(obj[jss::taker_pays]); offer->getFieldAmount(sfTakerGets).setJson(obj[jss::taker_gets]); diff --git a/src/xrpld/rpc/handlers/AccountTx.cpp b/src/xrpld/rpc/handlers/account/AccountTx.cpp similarity index 92% rename from src/xrpld/rpc/handlers/AccountTx.cpp rename to src/xrpld/rpc/handlers/account/AccountTx.cpp index e120c98523..61839524dc 100644 --- a/src/xrpld/rpc/handlers/AccountTx.cpp +++ b/src/xrpld/rpc/handlers/account/AccountTx.cpp @@ -7,19 +7,35 @@ #include #include #include +#include #include #include #include +#include +#include +#include +#include +#include #include #include +#include #include +#include #include #include -#include +#include #include +#include #include +#include +#include +#include +#include +#include +#include + namespace xrpl { using TxnsData = RelationalDatabase::AccountTxs; @@ -41,18 +57,18 @@ parseLedgerArgs(RPC::Context& context, Json::Value const& params) if ((params.isMember(jss::ledger_index_min) || params.isMember(jss::ledger_index_max)) && (params.isMember(jss::ledger_hash) || params.isMember(jss::ledger_index))) { - RPC::Status status{rpcINVALID_PARAMS, "invalidParams"}; + RPC::Status const status{rpcINVALID_PARAMS, "invalidParams"}; status.inject(response); return response; } } if (params.isMember(jss::ledger_index_min) || params.isMember(jss::ledger_index_max)) { - uint32_t min = + uint32_t const min = params.isMember(jss::ledger_index_min) && params[jss::ledger_index_min].asInt() >= 0 ? params[jss::ledger_index_min].asUInt() : 0; - uint32_t max = + uint32_t const max = params.isMember(jss::ledger_index_max) && params[jss::ledger_index_max].asInt() >= 0 ? params[jss::ledger_index_max].asUInt() : UINT32_MAX; @@ -64,7 +80,7 @@ parseLedgerArgs(RPC::Context& context, Json::Value const& params) auto& hashValue = params[jss::ledger_hash]; if (!hashValue.isString()) { - RPC::Status status{rpcINVALID_PARAMS, "ledgerHashNotString"}; + RPC::Status const status{rpcINVALID_PARAMS, "ledgerHashNotString"}; status.inject(response); return response; } @@ -72,7 +88,7 @@ parseLedgerArgs(RPC::Context& context, Json::Value const& params) LedgerHash hash; if (!hash.parseHex(hashValue.asString())) { - RPC::Status status{rpcINVALID_PARAMS, "ledgerHashMalformed"}; + RPC::Status const status{rpcINVALID_PARAMS, "ledgerHashMalformed"}; status.inject(response); return response; } @@ -87,7 +103,7 @@ parseLedgerArgs(RPC::Context& context, Json::Value const& params) } else { - std::string ledgerStr = params[jss::ledger_index].asString(); + std::string const ledgerStr = params[jss::ledger_index].asString(); if (ledgerStr == "current" || ledgerStr.empty()) { @@ -103,7 +119,7 @@ parseLedgerArgs(RPC::Context& context, Json::Value const& params) } else { - RPC::Status status{rpcINVALID_PARAMS, "ledger_index string malformed"}; + RPC::Status const status{rpcINVALID_PARAMS, "ledger_index string malformed"}; status.inject(response); return response; } @@ -118,7 +134,7 @@ getLedgerRange(RPC::Context& context, std::optional const& ledg { std::uint32_t uValidatedMin = 0; std::uint32_t uValidatedMax = 0; - bool bValidated = context.ledgerMaster.getValidatedRange(uValidatedMin, uValidatedMax); + bool const bValidated = context.ledgerMaster.getValidatedRange(uValidatedMin, uValidatedMax); if (!bValidated) { @@ -173,7 +189,7 @@ getLedgerRange(RPC::Context& context, std::optional const& ledg return status; } - bool validated = context.ledgerMaster.isValidated(*ledgerView); + bool const validated = context.ledgerMaster.isValidated(*ledgerView); if (!validated || ledgerView->header().seq > uValidatedMax || ledgerView->header().seq < uValidatedMin) @@ -210,7 +226,7 @@ doAccountTxHelp(RPC::Context& context, AccountTxArgs const& args) result.marker = args.marker; - RelationalDatabase::AccountTxPageOptions options = { + RelationalDatabase::AccountTxPageOptions const options = { args.account, result.ledgerRange, result.marker, args.limit, isUnlimited(context.role)}; auto& db = context.app.getRelationalDatabase(); @@ -364,7 +380,7 @@ populateJsonResponse( // resume previous query // } Json::Value -doAccountTxJson(RPC::JsonContext& context) +doAccountTx(RPC::JsonContext& context) { if (!context.app.config().useTxTables()) return rpcError(rpcNOT_ENABLED); @@ -419,7 +435,7 @@ doAccountTxJson(RPC::JsonContext& context) !token[jss::ledger].isConvertibleTo(Json::ValueType::uintValue) || !token[jss::seq].isConvertibleTo(Json::ValueType::uintValue)) { - RPC::Status status{ + RPC::Status const status{ rpcINVALID_PARAMS, "invalid marker. Provide ledger index via ledger field, and " "transaction sequence number via seq field"}; diff --git a/src/xrpld/rpc/handlers/GatewayBalances.cpp b/src/xrpld/rpc/handlers/account/GatewayBalances.cpp similarity index 90% rename from src/xrpld/rpc/handlers/GatewayBalances.cpp rename to src/xrpld/rpc/handlers/account/GatewayBalances.cpp index 8d03a3961d..81e464ba87 100644 --- a/src/xrpld/rpc/handlers/GatewayBalances.cpp +++ b/src/xrpld/rpc/handlers/account/GatewayBalances.cpp @@ -3,14 +3,30 @@ #include #include +#include +#include #include #include #include #include +#include +#include +#include #include +#include +#include +#include #include #include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { // Query: @@ -136,7 +152,7 @@ doGatewayBalances(RPC::JsonContext& context) if (escrow.holds()) return; - auto& bal = locked[escrow.getCurrency()]; + auto& bal = locked[escrow.get().currency]; if (bal == beast::zero) { // This is needed to set the currency code correctly @@ -154,7 +170,7 @@ doGatewayBalances(RPC::JsonContext& context) // On overflow return the largest valid STAmount. // Very large sums of STAmount are approximations // anyway. - bal = STAmount(bal.issue(), STAmount::cMaxValue, STAmount::cMaxOffset); + bal = STAmount(bal.get(), STAmount::cMaxValue, STAmount::cMaxOffset); } } } @@ -164,7 +180,7 @@ doGatewayBalances(RPC::JsonContext& context) if (!rs) return; - int balSign = rs->getBalance().signum(); + int const balSign = rs->getBalance().signum(); if (balSign == 0) return; @@ -192,7 +208,7 @@ doGatewayBalances(RPC::JsonContext& context) else { // normal negative balance, obligation to customer - auto& bal = sums[rs->getBalance().getCurrency()]; + auto& bal = sums[rs->getBalance().get().currency]; if (bal == beast::zero) { // This is needed to set the currency code correctly @@ -210,7 +226,7 @@ doGatewayBalances(RPC::JsonContext& context) // On overflow return the largest valid STAmount. // Very large sums of STAmount are approximations // anyway. - bal = STAmount(bal.issue(), STAmount::cMaxValue, STAmount::cMaxOffset); + bal = STAmount(bal.asset(), STAmount::cMaxValue, STAmount::cMaxOffset); } } } @@ -239,7 +255,7 @@ doGatewayBalances(RPC::JsonContext& context) for (auto const& balance : accBalances) { Json::Value entry; - entry[jss::currency] = to_string(balance.issue().currency); + entry[jss::currency] = to_string(balance.get().currency); entry[jss::value] = balance.getText(); balanceArray.append(std::move(entry)); } diff --git a/src/xrpld/rpc/handlers/NoRippleCheck.cpp b/src/xrpld/rpc/handlers/account/NoRippleCheck.cpp similarity index 88% rename from src/xrpld/rpc/handlers/NoRippleCheck.cpp rename to src/xrpld/rpc/handlers/account/NoRippleCheck.cpp index c3e36280a6..54964be8da 100644 --- a/src/xrpld/rpc/handlers/NoRippleCheck.cpp +++ b/src/xrpld/rpc/handlers/account/NoRippleCheck.cpp @@ -2,17 +2,26 @@ #include #include #include -#include #include +#include +#include #include #include +#include #include +#include +#include #include +#include #include +#include #include #include +#include +#include + namespace xrpl { static void @@ -88,7 +97,7 @@ doNoRippleCheck(RPC::JsonContext& context) if (!ledger) return result; - Json::Value dummy; + Json::Value dummy; // NOLINT(misc-const-correctness) Json::Value& jvTransactions = transactions ? (result[jss::transactions] = Json::arrayValue) : dummy; @@ -107,7 +116,7 @@ doNoRippleCheck(RPC::JsonContext& context) Json::Value& problems = (result["problems"] = Json::arrayValue); - bool bDefaultRipple = (sle->getFieldU32(sfFlags) & lsfDefaultRipple) != 0u; + bool const bDefaultRipple = (sle->getFieldU32(sfFlags) & lsfDefaultRipple) != 0u; if ((static_cast(bDefaultRipple) & static_cast(!roleGateway)) != 0) { @@ -151,17 +160,18 @@ doNoRippleCheck(RPC::JsonContext& context) } if (needFix) { - AccountID peer = + AccountID const peer = ownedItem->getFieldAmount(bLow ? sfHighLimit : sfLowLimit).getIssuer(); - STAmount peerLimit = ownedItem->getFieldAmount(bLow ? sfHighLimit : sfLowLimit); - problem += to_string(peerLimit.getCurrency()); + STAmount const peerLimit = + ownedItem->getFieldAmount(bLow ? sfHighLimit : sfLowLimit); + problem += to_string(peerLimit.get().currency); problem += " line to "; problem += to_string(peerLimit.getIssuer()); problems.append(problem); STAmount limitAmount( ownedItem->getFieldAmount(bLow ? sfLowLimit : sfHighLimit)); - limitAmount.setIssuer(peer); + limitAmount.get().account = peer; Json::Value& tx = jvTransactions.append(Json::objectValue); tx["TransactionType"] = jss::TrustSet; diff --git a/src/xrpld/rpc/handlers/OwnerInfo.cpp b/src/xrpld/rpc/handlers/account/OwnerInfo.cpp similarity index 89% rename from src/xrpld/rpc/handlers/OwnerInfo.cpp rename to src/xrpld/rpc/handlers/account/OwnerInfo.cpp index 202d0e9b5b..d287d2fd25 100644 --- a/src/xrpld/rpc/handlers/OwnerInfo.cpp +++ b/src/xrpld/rpc/handlers/account/OwnerInfo.cpp @@ -2,11 +2,15 @@ #include #include +#include #include #include #include #include +#include +#include + namespace xrpl { // { @@ -20,7 +24,7 @@ doOwnerInfo(RPC::JsonContext& context) return RPC::missing_field_error(jss::account); } - std::string strIdent = context.params.isMember(jss::account) + std::string const strIdent = context.params.isMember(jss::account) ? context.params[jss::account].asString() : context.params[jss::ident].asString(); Json::Value ret; diff --git a/src/xrpld/rpc/handlers/BlackList.cpp b/src/xrpld/rpc/handlers/admin/BlackList.cpp similarity index 92% rename from src/xrpld/rpc/handlers/BlackList.cpp rename to src/xrpld/rpc/handlers/admin/BlackList.cpp index 86abe53686..dfcb1aaa3a 100644 --- a/src/xrpld/rpc/handlers/BlackList.cpp +++ b/src/xrpld/rpc/handlers/admin/BlackList.cpp @@ -1,6 +1,7 @@ #include #include +#include #include #include diff --git a/src/xrpld/rpc/handlers/UnlList.cpp b/src/xrpld/rpc/handlers/admin/UnlList.cpp similarity index 83% rename from src/xrpld/rpc/handlers/UnlList.cpp rename to src/xrpld/rpc/handlers/admin/UnlList.cpp index 31f41b4a33..79eb2acf29 100644 --- a/src/xrpld/rpc/handlers/UnlList.cpp +++ b/src/xrpld/rpc/handlers/admin/UnlList.cpp @@ -2,8 +2,12 @@ #include #include -#include +#include +#include #include +#include + +#include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/CanDelete.cpp b/src/xrpld/rpc/handlers/admin/data/CanDelete.cpp similarity index 91% rename from src/xrpld/rpc/handlers/CanDelete.cpp rename to src/xrpld/rpc/handlers/admin/data/CanDelete.cpp index 052ebdf745..59d4b3a75c 100644 --- a/src/xrpld/rpc/handlers/CanDelete.cpp +++ b/src/xrpld/rpc/handlers/admin/data/CanDelete.cpp @@ -3,12 +3,18 @@ #include #include +#include #include +#include #include #include #include +#include +#include +#include + namespace xrpl { // can_delete [||now|always|never] @@ -22,7 +28,7 @@ doCanDelete(RPC::JsonContext& context) if (context.params.isMember(jss::can_delete)) { - Json::Value canDelete = context.params.get(jss::can_delete, 0); + Json::Value const canDelete = context.params.get(jss::can_delete, 0); std::uint32_t canDeleteSeq = 0; if (canDelete.isUInt()) diff --git a/src/xrpld/rpc/handlers/LedgerCleanerHandler.cpp b/src/xrpld/rpc/handlers/admin/data/LedgerCleaner.cpp similarity index 99% rename from src/xrpld/rpc/handlers/LedgerCleanerHandler.cpp rename to src/xrpld/rpc/handlers/admin/data/LedgerCleaner.cpp index 408cd16023..71dcb6d62f 100644 --- a/src/xrpld/rpc/handlers/LedgerCleanerHandler.cpp +++ b/src/xrpld/rpc/handlers/admin/data/LedgerCleaner.cpp @@ -1,4 +1,5 @@ #include + #include #include #include diff --git a/src/xrpld/rpc/handlers/LedgerRequest.cpp b/src/xrpld/rpc/handlers/admin/data/LedgerRequest.cpp similarity index 94% rename from src/xrpld/rpc/handlers/LedgerRequest.cpp rename to src/xrpld/rpc/handlers/admin/data/LedgerRequest.cpp index da29addd2d..ec31529226 100644 --- a/src/xrpld/rpc/handlers/LedgerRequest.cpp +++ b/src/xrpld/rpc/handlers/admin/data/LedgerRequest.cpp @@ -2,7 +2,7 @@ #include #include -#include +#include #include #include diff --git a/src/xrpld/rpc/handlers/ValidationCreate.cpp b/src/xrpld/rpc/handlers/admin/keygen/ValidationCreate.cpp similarity index 85% rename from src/xrpld/rpc/handlers/ValidationCreate.cpp rename to src/xrpld/rpc/handlers/admin/keygen/ValidationCreate.cpp index c82ddffea5..27ae21d393 100644 --- a/src/xrpld/rpc/handlers/ValidationCreate.cpp +++ b/src/xrpld/rpc/handlers/admin/keygen/ValidationCreate.cpp @@ -1,9 +1,16 @@ #include +#include #include +#include +#include #include +#include #include #include +#include + +#include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/WalletPropose.cpp b/src/xrpld/rpc/handlers/admin/keygen/WalletPropose.cpp similarity index 89% rename from src/xrpld/rpc/handlers/WalletPropose.cpp rename to src/xrpld/rpc/handlers/admin/keygen/WalletPropose.cpp index a5005ce701..bbd8f622be 100644 --- a/src/xrpld/rpc/handlers/WalletPropose.cpp +++ b/src/xrpld/rpc/handlers/admin/keygen/WalletPropose.cpp @@ -1,8 +1,11 @@ +#include + #include #include -#include #include +#include +#include #include #include #include @@ -10,9 +13,12 @@ #include #include #include +#include #include #include +#include +#include namespace xrpl { @@ -56,7 +62,7 @@ walletPropose(Json::Value const& params) { std::optional keyType; std::optional seed; - bool rippleLibSeed = false; + bool libSeed = false; if (params.isMember(jss::key_type)) { @@ -71,22 +77,22 @@ walletPropose(Json::Value const& params) return rpcError(rpcINVALID_PARAMS); } - // ripple-lib encodes seed used to generate an Ed25519 wallet in a + // XrplLib encodes seed used to generate an Ed25519 wallet in a // non-standard way. While we never encode seeds that way, we try // to detect such keys to avoid user confusion. { if (params.isMember(jss::passphrase)) { - seed = RPC::parseRippleLibSeed(params[jss::passphrase]); + seed = RPC::parseXrplLibSeed(params[jss::passphrase]); } else if (params.isMember(jss::seed)) { - seed = RPC::parseRippleLibSeed(params[jss::seed]); + seed = RPC::parseXrplLibSeed(params[jss::seed]); } if (seed) { - rippleLibSeed = true; + libSeed = true; // If the user *explicitly* requests a key type other than // Ed25519 we return an error. @@ -137,7 +143,7 @@ walletPropose(Json::Value const& params) // If a passphrase was specified, and it was hashed and used as a seed // run a quick entropy check and add an appropriate warning, because // "brain wallets" can be easily attacked. - if (!rippleLibSeed && params.isMember(jss::passphrase)) + if (!libSeed && params.isMember(jss::passphrase)) { auto const passphrase = params[jss::passphrase].asString(); diff --git a/src/xrpld/rpc/handlers/WalletPropose.h b/src/xrpld/rpc/handlers/admin/keygen/WalletPropose.h similarity index 100% rename from src/xrpld/rpc/handlers/WalletPropose.h rename to src/xrpld/rpc/handlers/admin/keygen/WalletPropose.h diff --git a/src/xrpld/rpc/handlers/LogLevel.cpp b/src/xrpld/rpc/handlers/admin/log/LogLevel.cpp similarity index 89% rename from src/xrpld/rpc/handlers/LogLevel.cpp rename to src/xrpld/rpc/handlers/admin/log/LogLevel.cpp index a932dfb198..9cfa321654 100644 --- a/src/xrpld/rpc/handlers/LogLevel.cpp +++ b/src/xrpld/rpc/handlers/admin/log/LogLevel.cpp @@ -9,6 +9,10 @@ #include +#include +#include +#include + namespace xrpl { Json::Value @@ -22,7 +26,7 @@ doLogLevel(RPC::JsonContext& context) Json::Value lev(Json::objectValue); lev[jss::base] = Logs::toString(Logs::fromSeverity(context.app.getLogs().threshold())); - std::vector> logTable( + std::vector> const logTable( context.app.getLogs().partition_severities()); for (auto const& [k, v] : logTable) lev[k] = v; @@ -49,7 +53,7 @@ doLogLevel(RPC::JsonContext& context) if (context.params.isMember(jss::partition)) { // set partition threshold - std::string partition(context.params[jss::partition].asString()); + std::string const partition(context.params[jss::partition].asString()); if (boost::iequals(partition, "base")) { diff --git a/src/xrpld/rpc/handlers/LogRotate.cpp b/src/xrpld/rpc/handlers/admin/log/LogRotate.cpp similarity index 83% rename from src/xrpld/rpc/handlers/LogRotate.cpp rename to src/xrpld/rpc/handlers/admin/log/LogRotate.cpp index 3cc7f35381..c1fdd58c23 100644 --- a/src/xrpld/rpc/handlers/LogRotate.cpp +++ b/src/xrpld/rpc/handlers/admin/log/LogRotate.cpp @@ -1,8 +1,10 @@ #include +#include #include #include #include +#include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/Connect.cpp b/src/xrpld/rpc/handlers/admin/peer/Connect.cpp similarity index 93% rename from src/xrpld/rpc/handlers/Connect.cpp rename to src/xrpld/rpc/handlers/admin/peer/Connect.cpp index fe3183484e..4d9667e4a9 100644 --- a/src/xrpld/rpc/handlers/Connect.cpp +++ b/src/xrpld/rpc/handlers/admin/peer/Connect.cpp @@ -4,11 +4,15 @@ #include #include +#include +#include #include #include #include #include +#include + namespace xrpl { // { diff --git a/src/xrpld/rpc/handlers/Reservations.cpp b/src/xrpld/rpc/handlers/admin/peer/PeerReservationsAdd.cpp similarity index 63% rename from src/xrpld/rpc/handlers/Reservations.cpp rename to src/xrpld/rpc/handlers/admin/peer/PeerReservationsAdd.cpp index fb874247ad..f70b8214df 100644 --- a/src/xrpld/rpc/handlers/Reservations.cpp +++ b/src/xrpld/rpc/handlers/admin/peer/PeerReservationsAdd.cpp @@ -1,15 +1,16 @@ #include #include +#include #include #include #include #include #include +#include #include #include -#include namespace xrpl { @@ -66,46 +67,4 @@ doPeerReservationsAdd(RPC::JsonContext& context) return result; } -Json::Value -doPeerReservationsDel(RPC::JsonContext& context) -{ - auto const& params = context.params; - - // We repeat much of the parameter parsing from `doPeerReservationsAdd`. - if (!params.isMember(jss::public_key)) - return RPC::missing_field_error(jss::public_key); - if (!params[jss::public_key].isString()) - return RPC::expected_field_error(jss::public_key, "a string"); - - std::optional optPk = - parseBase58(TokenType::NodePublic, params[jss::public_key].asString()); - if (!optPk) - return rpcError(rpcPUBLIC_MALFORMED); - PublicKey const& nodeId = *optPk; - - auto const previous = context.app.getPeerReservations().erase(nodeId); - - Json::Value result{Json::objectValue}; - if (previous) - { - result[jss::previous] = previous->toJson(); - } - return result; -} - -Json::Value -doPeerReservationsList(RPC::JsonContext& context) -{ - auto const& reservations = context.app.getPeerReservations().list(); - // Enumerate the reservations in context.app.getPeerReservations() - // as a Json::Value. - Json::Value result{Json::objectValue}; - Json::Value& jaReservations = result[jss::reservations] = Json::arrayValue; - for (auto const& reservation : reservations) - { - jaReservations.append(reservation.toJson()); - } - return result; -} - } // namespace xrpl diff --git a/src/xrpld/rpc/handlers/admin/peer/PeerReservationsDel.cpp b/src/xrpld/rpc/handlers/admin/peer/PeerReservationsDel.cpp new file mode 100644 index 0000000000..d60979aab3 --- /dev/null +++ b/src/xrpld/rpc/handlers/admin/peer/PeerReservationsDel.cpp @@ -0,0 +1,42 @@ +#include +#include + +#include +#include +#include +#include +#include +#include + +#include + +namespace xrpl { + +Json::Value +doPeerReservationsDel(RPC::JsonContext& context) +{ + auto const& params = context.params; + + // We repeat much of the parameter parsing from `doPeerReservationsAdd`. + if (!params.isMember(jss::public_key)) + return RPC::missing_field_error(jss::public_key); + if (!params[jss::public_key].isString()) + return RPC::expected_field_error(jss::public_key, "a string"); + + std::optional optPk = + parseBase58(TokenType::NodePublic, params[jss::public_key].asString()); + if (!optPk) + return rpcError(rpcPUBLIC_MALFORMED); + PublicKey const& nodeId = *optPk; + + auto const previous = context.app.getPeerReservations().erase(nodeId); + + Json::Value result{Json::objectValue}; + if (previous) + { + result[jss::previous] = previous->toJson(); + } + return result; +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/admin/peer/PeerReservationsList.cpp b/src/xrpld/rpc/handlers/admin/peer/PeerReservationsList.cpp new file mode 100644 index 0000000000..119af3f73c --- /dev/null +++ b/src/xrpld/rpc/handlers/admin/peer/PeerReservationsList.cpp @@ -0,0 +1,24 @@ +#include +#include + +#include +#include + +namespace xrpl { + +Json::Value +doPeerReservationsList(RPC::JsonContext& context) +{ + auto const& reservations = context.app.getPeerReservations().list(); + // Enumerate the reservations in context.app.getPeerReservations() + // as a Json::Value. + Json::Value result{Json::objectValue}; + Json::Value& jaReservations = result[jss::reservations] = Json::arrayValue; + for (auto const& reservation : reservations) + { + jaReservations.append(reservation.toJson()); + } + return result; +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/Peers.cpp b/src/xrpld/rpc/handlers/admin/peer/Peers.cpp similarity index 87% rename from src/xrpld/rpc/handlers/Peers.cpp rename to src/xrpld/rpc/handlers/admin/peer/Peers.cpp index ddcb674b33..9164089e83 100644 --- a/src/xrpld/rpc/handlers/Peers.cpp +++ b/src/xrpld/rpc/handlers/admin/peer/Peers.cpp @@ -1,13 +1,19 @@ #include #include #include +#include #include #include -#include +#include +#include +#include #include +#include #include +#include + namespace xrpl { Json::Value @@ -42,7 +48,7 @@ doPeers(RPC::JsonContext& context) auto const self = context.app.nodeIdentity().first; Json::Value& cluster = (jvResult[jss::cluster] = Json::objectValue); - std::uint32_t ref = context.app.getFeeTrack().getLoadBase(); + std::uint32_t const ref = context.app.getFeeTrack().getLoadBase(); context.app.getCluster().for_each([&cluster, now, ref, &self](ClusterNode const& node) { if (node.identity() == self) diff --git a/src/xrpld/rpc/handlers/LedgerAccept.cpp b/src/xrpld/rpc/handlers/admin/server_control/LedgerAccept.cpp similarity index 86% rename from src/xrpld/rpc/handlers/LedgerAccept.cpp rename to src/xrpld/rpc/handlers/admin/server_control/LedgerAccept.cpp index c7a828863a..7119b5235e 100644 --- a/src/xrpld/rpc/handlers/LedgerAccept.cpp +++ b/src/xrpld/rpc/handlers/admin/server_control/LedgerAccept.cpp @@ -3,7 +3,7 @@ #include #include -#include +#include #include #include @@ -22,7 +22,7 @@ doLedgerAccept(RPC::JsonContext& context) } else { - std::unique_lock lock{context.app.getMasterMutex()}; + std::unique_lock const lock{context.app.getMasterMutex()}; context.netOps.acceptLedger(); jvResult[jss::ledger_current_index] = context.ledgerMaster.getCurrentLedgerIndex(); } diff --git a/src/xrpld/rpc/handlers/Stop.cpp b/src/xrpld/rpc/handlers/admin/server_control/Stop.cpp similarity index 84% rename from src/xrpld/rpc/handlers/Stop.cpp rename to src/xrpld/rpc/handlers/admin/server_control/Stop.cpp index d2f1cd7a80..e3e0f29fa2 100644 --- a/src/xrpld/rpc/handlers/Stop.cpp +++ b/src/xrpld/rpc/handlers/admin/server_control/Stop.cpp @@ -2,12 +2,13 @@ #include #include +#include namespace xrpl { namespace RPC { struct JsonContext; -} +} // namespace RPC Json::Value doStop(RPC::JsonContext& context) diff --git a/src/xrpld/rpc/handlers/PayChanClaim.cpp b/src/xrpld/rpc/handlers/admin/signing/ChannelAuthorize.cpp similarity index 59% rename from src/xrpld/rpc/handlers/PayChanClaim.cpp rename to src/xrpld/rpc/handlers/admin/signing/ChannelAuthorize.cpp index b24a241147..d93e1efadc 100644 --- a/src/xrpld/rpc/handlers/PayChanClaim.cpp +++ b/src/xrpld/rpc/handlers/admin/signing/ChannelAuthorize.cpp @@ -1,15 +1,25 @@ #include #include +#include #include #include -#include +#include +#include +#include +#include #include #include #include +#include +#include +#include #include +#include +#include #include +#include namespace xrpl { @@ -83,61 +93,4 @@ doChannelAuthorize(RPC::JsonContext& context) return result; } -// { -// public_key: -// channel_id: 256-bit channel id -// drops: 64-bit uint (as string) -// signature: signature to verify -// } -Json::Value -doChannelVerify(RPC::JsonContext& context) -{ - auto const& params(context.params); - for (auto const& p : {jss::public_key, jss::channel_id, jss::amount, jss::signature}) - { - if (!params.isMember(p)) - return RPC::missing_field_error(p); - } - - std::optional pk; - { - std::string const strPk = params[jss::public_key].asString(); - pk = parseBase58(TokenType::AccountPublic, strPk); - - if (!pk) - { - auto pkHex = strUnHex(strPk); - if (!pkHex) - return rpcError(rpcPUBLIC_MALFORMED); - auto const pkType = publicKeyType(makeSlice(*pkHex)); - if (!pkType) - return rpcError(rpcPUBLIC_MALFORMED); - pk.emplace(makeSlice(*pkHex)); - } - } - - uint256 channelId; - if (!channelId.parseHex(params[jss::channel_id].asString())) - return rpcError(rpcCHANNEL_MALFORMED); - - std::optional const optDrops = - params[jss::amount].isString() ? to_uint64(params[jss::amount].asString()) : std::nullopt; - - if (!optDrops) - return rpcError(rpcCHANNEL_AMT_MALFORMED); - - std::uint64_t const drops = *optDrops; - - auto sig = strUnHex(params[jss::signature].asString()); - if (!sig || sig->empty()) - return rpcError(rpcINVALID_PARAMS); - - Serializer msg; - serializePayChanAuthorization(msg, channelId, XRPAmount(drops)); - - Json::Value result; - result[jss::signature_verified] = verify(*pk, msg.slice(), makeSlice(*sig)); - return result; -} - } // namespace xrpl diff --git a/src/xrpld/rpc/handlers/SignHandler.cpp b/src/xrpld/rpc/handlers/admin/signing/Sign.cpp similarity index 92% rename from src/xrpld/rpc/handlers/SignHandler.cpp rename to src/xrpld/rpc/handlers/admin/signing/Sign.cpp index e7150c5e2f..d92506c672 100644 --- a/src/xrpld/rpc/handlers/SignHandler.cpp +++ b/src/xrpld/rpc/handlers/admin/signing/Sign.cpp @@ -1,8 +1,11 @@ #include #include +#include #include +#include #include +#include #include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/SignFor.cpp b/src/xrpld/rpc/handlers/admin/signing/SignFor.cpp similarity index 92% rename from src/xrpld/rpc/handlers/SignFor.cpp rename to src/xrpld/rpc/handlers/admin/signing/SignFor.cpp index 54f23c9d81..572093856f 100644 --- a/src/xrpld/rpc/handlers/SignFor.cpp +++ b/src/xrpld/rpc/handlers/admin/signing/SignFor.cpp @@ -1,8 +1,11 @@ #include #include +#include #include +#include #include +#include #include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/ConsensusInfo.cpp b/src/xrpld/rpc/handlers/admin/status/ConsensusInfo.cpp similarity index 90% rename from src/xrpld/rpc/handlers/ConsensusInfo.cpp rename to src/xrpld/rpc/handlers/admin/status/ConsensusInfo.cpp index f9c5a97785..5ccbda2a16 100644 --- a/src/xrpld/rpc/handlers/ConsensusInfo.cpp +++ b/src/xrpld/rpc/handlers/admin/status/ConsensusInfo.cpp @@ -1,7 +1,6 @@ #include #include -#include #include #include diff --git a/src/xrpld/rpc/handlers/FetchInfo.cpp b/src/xrpld/rpc/handlers/admin/status/FetchInfo.cpp similarity index 93% rename from src/xrpld/rpc/handlers/FetchInfo.cpp rename to src/xrpld/rpc/handlers/admin/status/FetchInfo.cpp index f25f18acf7..fd916ef53e 100644 --- a/src/xrpld/rpc/handlers/FetchInfo.cpp +++ b/src/xrpld/rpc/handlers/admin/status/FetchInfo.cpp @@ -1,7 +1,6 @@ #include #include -#include #include #include diff --git a/src/xrpld/rpc/handlers/GetCounts.cpp b/src/xrpld/rpc/handlers/admin/status/GetCounts.cpp similarity index 95% rename from src/xrpld/rpc/handlers/GetCounts.cpp rename to src/xrpld/rpc/handlers/admin/status/GetCounts.cpp index 09a952e114..8cc687fec2 100644 --- a/src/xrpld/rpc/handlers/GetCounts.cpp +++ b/src/xrpld/rpc/handlers/admin/status/GetCounts.cpp @@ -1,4 +1,3 @@ -#include #include #include #include @@ -6,12 +5,16 @@ #include #include +#include #include #include -#include #include #include +#include +#include +#include + namespace xrpl { static void @@ -71,7 +74,7 @@ getCountsJson(Application& app, int minObjectCount) ret[jss::dbKBTransaction] = dbKB; { - std::size_t c = app.getOPs().getLocalTxCount(); + std::size_t const c = app.getOPs().getLocalTxCount(); if (c > 0) ret[jss::local_txs] = static_cast(c); } diff --git a/src/xrpld/rpc/handlers/GetCounts.h b/src/xrpld/rpc/handlers/admin/status/GetCounts.h similarity index 86% rename from src/xrpld/rpc/handlers/GetCounts.h rename to src/xrpld/rpc/handlers/admin/status/GetCounts.h index 60c7a3b693..286ad38af3 100644 --- a/src/xrpld/rpc/handlers/GetCounts.h +++ b/src/xrpld/rpc/handlers/admin/status/GetCounts.h @@ -7,4 +7,4 @@ namespace xrpl { Json::Value getCountsJson(Application& app, int minObjectCount); -} +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/Print.cpp b/src/xrpld/rpc/handlers/admin/status/Print.cpp similarity index 100% rename from src/xrpld/rpc/handlers/Print.cpp rename to src/xrpld/rpc/handlers/admin/status/Print.cpp diff --git a/src/xrpld/rpc/handlers/ValidatorInfo.cpp b/src/xrpld/rpc/handlers/admin/status/ValidatorInfo.cpp similarity index 95% rename from src/xrpld/rpc/handlers/ValidatorInfo.cpp rename to src/xrpld/rpc/handlers/admin/status/ValidatorInfo.cpp index aec9dba4b4..c8ec6a2c15 100644 --- a/src/xrpld/rpc/handlers/ValidatorInfo.cpp +++ b/src/xrpld/rpc/handlers/admin/status/ValidatorInfo.cpp @@ -1,13 +1,14 @@ // Copyright (c) 2019 Dev Null Productions #include -#include #include #include #include #include +#include #include +#include namespace xrpl { Json::Value diff --git a/src/xrpld/rpc/handlers/ValidatorListSites.cpp b/src/xrpld/rpc/handlers/admin/status/ValidatorListSites.cpp similarity index 87% rename from src/xrpld/rpc/handlers/ValidatorListSites.cpp rename to src/xrpld/rpc/handlers/admin/status/ValidatorListSites.cpp index 36e2064387..80823a8936 100644 --- a/src/xrpld/rpc/handlers/ValidatorListSites.cpp +++ b/src/xrpld/rpc/handlers/admin/status/ValidatorListSites.cpp @@ -2,7 +2,7 @@ #include #include -#include +#include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/Validators.cpp b/src/xrpld/rpc/handlers/admin/status/Validators.cpp similarity index 87% rename from src/xrpld/rpc/handlers/Validators.cpp rename to src/xrpld/rpc/handlers/admin/status/Validators.cpp index 95e6de9e68..cf9cab6b84 100644 --- a/src/xrpld/rpc/handlers/Validators.cpp +++ b/src/xrpld/rpc/handlers/admin/status/Validators.cpp @@ -2,7 +2,7 @@ #include #include -#include +#include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/LedgerHandler.cpp b/src/xrpld/rpc/handlers/ledger/Ledger.cpp similarity index 86% rename from src/xrpld/rpc/handlers/LedgerHandler.cpp rename to src/xrpld/rpc/handlers/ledger/Ledger.cpp index cd70cb064a..dd2280b51c 100644 --- a/src/xrpld/rpc/handlers/LedgerHandler.cpp +++ b/src/xrpld/rpc/handlers/ledger/Ledger.cpp @@ -1,14 +1,35 @@ +#include + #include #include +#include #include #include +#include #include -#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include #include #include +#include + +#include +#include + +#include +#include +#include +#include +#include namespace xrpl { namespace RPC { @@ -21,7 +42,7 @@ Status LedgerHandler::check() { auto const& params = context_.params; - bool needsLedger = params.isMember(jss::ledger) || params.isMember(jss::ledger_hash) || + bool const needsLedger = params.isMember(jss::ledger) || params.isMember(jss::ledger_hash) || params.isMember(jss::ledger_index); if (!needsLedger) return Status::OK; @@ -113,9 +134,9 @@ std::pair doLedgerGrpc(RPC::GRPCContext& context) { auto begin = std::chrono::system_clock::now(); - org::xrpl::rpc::v1::GetLedgerRequest& request = context.params; + org::xrpl::rpc::v1::GetLedgerRequest const& request = context.params; org::xrpl::rpc::v1::GetLedgerResponse response; - grpc::Status status = grpc::Status::OK; + grpc::Status const status = grpc::Status::OK; std::shared_ptr ledger; if (auto status = RPC::ledgerFromRequest(ledger, context)) @@ -147,11 +168,11 @@ doLedgerGrpc(RPC::GRPCContext& context) if (request.expand()) { auto txn = response.mutable_transactions_list()->add_transactions(); - Serializer sTxn = i.first->getSerializer(); + Serializer const sTxn = i.first->getSerializer(); txn->set_transaction_blob(sTxn.data(), sTxn.getLength()); if (i.second) { - Serializer sMeta = i.second->getSerializer(); + Serializer const sMeta = i.second->getSerializer(); txn->set_metadata_blob(sMeta.data(), sMeta.getLength()); } } @@ -173,30 +194,32 @@ doLedgerGrpc(RPC::GRPCContext& context) if (request.get_objects()) { - std::shared_ptr parent = + std::shared_ptr const parent = context.app.getLedgerMaster().getLedgerBySeq(ledger->seq() - 1); - std::shared_ptr base = std::dynamic_pointer_cast(parent); + std::shared_ptr const base = std::dynamic_pointer_cast(parent); if (!base) { - grpc::Status errorStatus{grpc::StatusCode::NOT_FOUND, "parent ledger not validated"}; + grpc::Status const errorStatus{ + grpc::StatusCode::NOT_FOUND, "parent ledger not validated"}; return {response, errorStatus}; } - std::shared_ptr desired = std::dynamic_pointer_cast(ledger); + std::shared_ptr const desired = + std::dynamic_pointer_cast(ledger); if (!desired) { - grpc::Status errorStatus{grpc::StatusCode::NOT_FOUND, "ledger not validated"}; + grpc::Status const errorStatus{grpc::StatusCode::NOT_FOUND, "ledger not validated"}; return {response, errorStatus}; } SHAMap::Delta differences; - int maxDifferences = std::numeric_limits::max(); + int const maxDifferences = std::numeric_limits::max(); - bool res = base->stateMap().compare(desired->stateMap(), differences, maxDifferences); + bool const res = base->stateMap().compare(desired->stateMap(), differences, maxDifferences); if (!res) { - grpc::Status errorStatus{ + grpc::Status const errorStatus{ grpc::StatusCode::RESOURCE_EXHAUSTED, "too many differences between specified ledgers"}; return {response, errorStatus}; diff --git a/src/xrpld/rpc/handlers/LedgerHandler.h b/src/xrpld/rpc/handlers/ledger/Ledger.h similarity index 98% rename from src/xrpld/rpc/handlers/LedgerHandler.h rename to src/xrpld/rpc/handlers/ledger/Ledger.h index 418958e9f1..f024241546 100644 --- a/src/xrpld/rpc/handlers/LedgerHandler.h +++ b/src/xrpld/rpc/handlers/ledger/Ledger.h @@ -14,7 +14,7 @@ namespace Json { class Object; -} +} // namespace Json namespace xrpl { namespace RPC { diff --git a/src/xrpld/rpc/handlers/LedgerClosed.cpp b/src/xrpld/rpc/handlers/ledger/LedgerClosed.cpp similarity index 87% rename from src/xrpld/rpc/handlers/LedgerClosed.cpp rename to src/xrpld/rpc/handlers/ledger/LedgerClosed.cpp index e26019cca6..43e6fa686e 100644 --- a/src/xrpld/rpc/handlers/LedgerClosed.cpp +++ b/src/xrpld/rpc/handlers/ledger/LedgerClosed.cpp @@ -1,6 +1,8 @@ #include #include +#include +#include #include #include #include diff --git a/src/xrpld/rpc/handlers/LedgerCurrent.cpp b/src/xrpld/rpc/handlers/ledger/LedgerCurrent.cpp similarity index 100% rename from src/xrpld/rpc/handlers/LedgerCurrent.cpp rename to src/xrpld/rpc/handlers/ledger/LedgerCurrent.cpp diff --git a/src/xrpld/rpc/handlers/LedgerData.cpp b/src/xrpld/rpc/handlers/ledger/LedgerData.cpp similarity index 91% rename from src/xrpld/rpc/handlers/LedgerData.cpp rename to src/xrpld/rpc/handlers/ledger/LedgerData.cpp index 733d1c99c6..f0a361d951 100644 --- a/src/xrpld/rpc/handlers/LedgerData.cpp +++ b/src/xrpld/rpc/handlers/ledger/LedgerData.cpp @@ -6,10 +6,21 @@ #include #include +#include +#include #include #include +#include #include +#include #include +#include + +#include +#include + +#include +#include namespace xrpl { @@ -116,9 +127,9 @@ doLedgerData(RPC::JsonContext& context) std::pair doLedgerDataGrpc(RPC::GRPCContext& context) { - org::xrpl::rpc::v1::GetLedgerDataRequest& request = context.params; + org::xrpl::rpc::v1::GetLedgerDataRequest const& request = context.params; org::xrpl::rpc::v1::GetLedgerDataResponse response; - grpc::Status status = grpc::Status::OK; + grpc::Status const status = grpc::Status::OK; std::shared_ptr ledger; if (auto status = RPC::ledgerFromRequest(ledger, context)) @@ -142,7 +153,7 @@ doLedgerDataGrpc(RPC::GRPCContext& con } else if (!request.marker().empty()) { - grpc::Status errorStatus{grpc::StatusCode::INVALID_ARGUMENT, "marker malformed"}; + grpc::Status const errorStatus{grpc::StatusCode::INVALID_ARGUMENT, "marker malformed"}; return {response, errorStatus}; } diff --git a/src/xrpld/rpc/handlers/LedgerDiff.cpp b/src/xrpld/rpc/handlers/ledger/LedgerDiff.cpp similarity index 65% rename from src/xrpld/rpc/handlers/LedgerDiff.cpp rename to src/xrpld/rpc/handlers/ledger/LedgerDiff.cpp index 2990315880..f1a9253de2 100644 --- a/src/xrpld/rpc/handlers/LedgerDiff.cpp +++ b/src/xrpld/rpc/handlers/ledger/LedgerDiff.cpp @@ -1,54 +1,66 @@ +#include #include #include +#include +#include +#include + +#include +#include + +#include +#include +#include + namespace xrpl { std::pair doLedgerDiffGrpc(RPC::GRPCContext& context) { - org::xrpl::rpc::v1::GetLedgerDiffRequest& request = context.params; + org::xrpl::rpc::v1::GetLedgerDiffRequest const& request = context.params; org::xrpl::rpc::v1::GetLedgerDiffResponse response; - grpc::Status status = grpc::Status::OK; + grpc::Status const status = grpc::Status::OK; std::shared_ptr baseLedgerRv; std::shared_ptr desiredLedgerRv; if (RPC::ledgerFromSpecifier(baseLedgerRv, request.base_ledger(), context)) { - grpc::Status errorStatus{grpc::StatusCode::NOT_FOUND, "base ledger not found"}; + grpc::Status const errorStatus{grpc::StatusCode::NOT_FOUND, "base ledger not found"}; return {response, errorStatus}; } if (RPC::ledgerFromSpecifier(desiredLedgerRv, request.desired_ledger(), context)) { - grpc::Status errorStatus{grpc::StatusCode::NOT_FOUND, "desired ledger not found"}; + grpc::Status const errorStatus{grpc::StatusCode::NOT_FOUND, "desired ledger not found"}; return {response, errorStatus}; } - std::shared_ptr baseLedger = + std::shared_ptr const baseLedger = std::dynamic_pointer_cast(baseLedgerRv); if (!baseLedger) { - grpc::Status errorStatus{grpc::StatusCode::NOT_FOUND, "base ledger not validated"}; + grpc::Status const errorStatus{grpc::StatusCode::NOT_FOUND, "base ledger not validated"}; return {response, errorStatus}; } - std::shared_ptr desiredLedger = + std::shared_ptr const desiredLedger = std::dynamic_pointer_cast(desiredLedgerRv); if (!desiredLedger) { - grpc::Status errorStatus{grpc::StatusCode::NOT_FOUND, "base ledger not validated"}; + grpc::Status const errorStatus{grpc::StatusCode::NOT_FOUND, "desired ledger not validated"}; return {response, errorStatus}; } SHAMap::Delta differences; - int maxDifferences = std::numeric_limits::max(); + int const maxDifferences = std::numeric_limits::max(); - bool res = + bool const res = baseLedger->stateMap().compare(desiredLedger->stateMap(), differences, maxDifferences); if (!res) { - grpc::Status errorStatus{ + grpc::Status const errorStatus{ grpc::StatusCode::RESOURCE_EXHAUSTED, "too many differences between specified ledgers"}; return {response, errorStatus}; } diff --git a/src/xrpld/rpc/handlers/LedgerEntry.cpp b/src/xrpld/rpc/handlers/ledger/LedgerEntry.cpp similarity index 96% rename from src/xrpld/rpc/handlers/LedgerEntry.cpp rename to src/xrpld/rpc/handlers/ledger/LedgerEntry.cpp index c7a47a0517..d686c9c8c0 100644 --- a/src/xrpld/rpc/handlers/LedgerEntry.cpp +++ b/src/xrpld/rpc/handlers/ledger/LedgerEntry.cpp @@ -1,21 +1,37 @@ #include #include #include -#include +#include -#include +#include +#include #include -#include #include +#include #include #include +#include #include #include +#include #include -#include +#include +#include +#include #include +#include #include +#include +#include + +#include +#include +#include +#include +#include +#include + namespace xrpl { using FunctionType = std::function( @@ -112,11 +128,11 @@ parseAMM( return Unexpected(value.error()); } - auto const asset = LedgerEntryHelpers::requiredIssue(params, jss::asset, "malformedRequest"); + auto const asset = LedgerEntryHelpers::requiredAsset(params, jss::asset, "malformedRequest"); if (!asset) return Unexpected(asset.error()); - auto const asset2 = LedgerEntryHelpers::requiredIssue(params, jss::asset2, "malformedRequest"); + auto const asset2 = LedgerEntryHelpers::requiredAsset(params, jss::asset2, "malformedRequest"); if (!asset2) return Unexpected(asset2.error()); @@ -370,7 +386,7 @@ parseDirectoryNode( "malformedRequest", "Must have exactly one of `owner` and `dir_root` fields."); } - std::uint64_t uSubIndex = params.get(jss::sub_index, 0).asUInt(); + std::uint64_t const uSubIndex = params.get(jss::sub_index, 0).asUInt(); if (params.isMember(jss::dir_root)) { @@ -897,7 +913,7 @@ doLedgerEntry(RPC::JsonContext& context) return RPC::make_param_error("No ledger_entry params provided."); } } - catch (Json::error& e) + catch (Json::error const& e) { if (context.apiVersion > 1u) { @@ -956,9 +972,9 @@ doLedgerEntry(RPC::JsonContext& context) std::pair doLedgerEntryGrpc(RPC::GRPCContext& context) { - org::xrpl::rpc::v1::GetLedgerEntryRequest& request = context.params; + org::xrpl::rpc::v1::GetLedgerEntryRequest const& request = context.params; org::xrpl::rpc::v1::GetLedgerEntryResponse response; - grpc::Status status = grpc::Status::OK; + grpc::Status const status = grpc::Status::OK; std::shared_ptr ledger; if (auto status = RPC::ledgerFromRequest(ledger, context)) @@ -978,14 +994,14 @@ doLedgerEntryGrpc(RPC::GRPCContext& c auto const key = uint256::fromVoidChecked(request.key()); if (!key) { - grpc::Status errorStatus{grpc::StatusCode::INVALID_ARGUMENT, "index malformed"}; + grpc::Status const errorStatus{grpc::StatusCode::INVALID_ARGUMENT, "index malformed"}; return {response, errorStatus}; } auto const sleNode = ledger->read(keylet::unchecked(*key)); if (!sleNode) { - grpc::Status errorStatus{grpc::StatusCode::NOT_FOUND, "object not found"}; + grpc::Status const errorStatus{grpc::StatusCode::NOT_FOUND, "object not found"}; return {response, errorStatus}; } diff --git a/src/xrpld/rpc/handlers/LedgerEntryHelpers.h b/src/xrpld/rpc/handlers/ledger/LedgerEntryHelpers.h similarity index 89% rename from src/xrpld/rpc/handlers/LedgerEntryHelpers.h rename to src/xrpld/rpc/handlers/ledger/LedgerEntryHelpers.h index 9182c9cfd7..4a4366556d 100644 --- a/src/xrpld/rpc/handlers/LedgerEntryHelpers.h +++ b/src/xrpld/rpc/handlers/ledger/LedgerEntryHelpers.h @@ -16,7 +16,7 @@ namespace xrpl { namespace LedgerEntryHelpers { -Unexpected +inline Unexpected missingFieldError(Json::StaticString const field, std::optional err = std::nullopt) { Json::Value json = Json::objectValue; @@ -26,7 +26,7 @@ missingFieldError(Json::StaticString const field, std::optional err return Unexpected(json); } -Unexpected +inline Unexpected invalidFieldError(std::string const& err, Json::StaticString const field, std::string const& type) { Json::Value json = Json::objectValue; @@ -36,7 +36,7 @@ invalidFieldError(std::string const& err, Json::StaticString const field, std::s return Unexpected(json); } -Unexpected +inline Unexpected malformedError(std::string const& err, std::string const& message) { Json::Value json = Json::objectValue; @@ -46,7 +46,7 @@ malformedError(std::string const& err, std::string const& message) return Unexpected(json); } -Expected +inline Expected hasRequired( Json::Value const& params, std::initializer_list fields, @@ -86,7 +86,7 @@ required( } template <> -std::optional +inline std::optional parse(Json::Value const& param) { if (!param.isString()) @@ -101,7 +101,7 @@ parse(Json::Value const& param) return account; } -Expected +inline Expected requiredAccountID( Json::Value const& params, Json::StaticString const fieldName, @@ -110,7 +110,7 @@ requiredAccountID( return required(params, fieldName, err, "AccountID"); } -std::optional +inline std::optional parseHexBlob(Json::Value const& param, std::size_t maxLength) { if (!param.isString()) @@ -123,7 +123,7 @@ parseHexBlob(Json::Value const& param, std::size_t maxLength) return blob; } -Expected +inline Expected requiredHexBlob( Json::Value const& params, Json::StaticString const fieldName, @@ -142,7 +142,7 @@ requiredHexBlob( } template <> -std::optional +inline std::optional parse(Json::Value const& param) { if (param.isUInt() || (param.isInt() && param.asInt() >= 0)) @@ -150,7 +150,7 @@ parse(Json::Value const& param) if (param.isString()) { - std::uint32_t v; + std::uint32_t v = 0; if (beast::lexicalCastChecked(v, param.asString())) return v; } @@ -158,7 +158,7 @@ parse(Json::Value const& param) return std::nullopt; } -Expected +inline Expected requiredUInt32( Json::Value const& params, Json::StaticString const fieldName, @@ -168,7 +168,7 @@ requiredUInt32( } template <> -std::optional +inline std::optional parse(Json::Value const& param) { uint256 uNodeIndex; @@ -180,7 +180,7 @@ parse(Json::Value const& param) return uNodeIndex; } -Expected +inline Expected requiredUInt256( Json::Value const& params, Json::StaticString const fieldName, @@ -190,7 +190,7 @@ requiredUInt256( } template <> -std::optional +inline std::optional parse(Json::Value const& param) { uint192 field; @@ -202,7 +202,7 @@ parse(Json::Value const& param) return field; } -Expected +inline Expected requiredUInt192( Json::Value const& params, Json::StaticString const fieldName, @@ -212,12 +212,12 @@ requiredUInt192( } template <> -std::optional +inline std::optional parse(Json::Value const& param) { try { - return issueFromJson(param); + return assetFromJson(param); } catch (std::runtime_error const&) { @@ -225,13 +225,13 @@ parse(Json::Value const& param) } } -Expected -requiredIssue(Json::Value const& params, Json::StaticString const fieldName, std::string const& err) +inline Expected +requiredAsset(Json::Value const& params, Json::StaticString const fieldName, std::string const& err) { - return required(params, fieldName, err, "Issue"); + return required(params, fieldName, err, "Asset"); } -Expected +inline Expected parseBridgeFields(Json::Value const& params) { if (auto const value = hasRequired( diff --git a/src/xrpld/rpc/handlers/LedgerHeader.cpp b/src/xrpld/rpc/handlers/ledger/LedgerHeader.cpp similarity index 85% rename from src/xrpld/rpc/handlers/LedgerHeader.cpp rename to src/xrpld/rpc/handlers/ledger/LedgerHeader.cpp index 6b93594020..6f01889b59 100644 --- a/src/xrpld/rpc/handlers/LedgerHeader.cpp +++ b/src/xrpld/rpc/handlers/ledger/LedgerHeader.cpp @@ -1,10 +1,16 @@ +#include + #include #include #include +#include #include +#include #include +#include + namespace xrpl { // { diff --git a/src/xrpld/rpc/handlers/AMMInfo.cpp b/src/xrpld/rpc/handlers/orderbook/AMMInfo.cpp similarity index 77% rename from src/xrpld/rpc/handlers/AMMInfo.cpp rename to src/xrpld/rpc/handlers/orderbook/AMMInfo.cpp index 9204f48907..2a93f1122a 100644 --- a/src/xrpld/rpc/handlers/AMMInfo.cpp +++ b/src/xrpld/rpc/handlers/orderbook/AMMInfo.cpp @@ -2,27 +2,48 @@ #include #include +#include +#include +#include +#include #include +#include +#include +#include #include #include +#include +#include #include -#include -#include +#include +#include +#include +#include +#include +#include +#include -#include +#include + +#include +#include +#include +#include +#include +#include namespace xrpl { -Expected -getIssue(Json::Value const& v, beast::Journal j) +Expected +getAsset(Json::Value const& v, beast::Journal j) { try { - return issueFromJson(v); + return assetFromJson(v); } catch (std::runtime_error const& ex) { - JLOG(j.debug()) << "getIssue " << ex.what(); + JLOG(j.debug()) << "getAsset " << ex.what(); } return Unexpected(rpcISSUE_MALFORMED); } @@ -52,15 +73,15 @@ doAMMInfo(RPC::JsonContext& context) struct ValuesFromContextParams { std::optional accountID; - Issue issue1; - Issue issue2; + Asset asset1; + Asset asset2; std::shared_ptr amm; }; auto getValuesFromContextParams = [&]() -> Expected { std::optional accountID; - std::optional issue1; - std::optional issue2; + std::optional asset1; + std::optional asset2; std::optional ammID; constexpr auto invalid = [](Json::Value const& params) -> bool { @@ -74,9 +95,9 @@ doAMMInfo(RPC::JsonContext& context) if (params.isMember(jss::asset)) { - if (auto const i = getIssue(params[jss::asset], context.j)) + if (auto const i = getAsset(params[jss::asset], context.j)) { - issue1 = *i; + asset1 = *i; } else { @@ -86,9 +107,9 @@ doAMMInfo(RPC::JsonContext& context) if (params.isMember(jss::asset2)) { - if (auto const i = getIssue(params[jss::asset2], context.j)) + if (auto const i = getAsset(params[jss::asset2], context.j)) { - issue2 = *i; + asset2 = *i; } else { @@ -121,25 +142,25 @@ doAMMInfo(RPC::JsonContext& context) return Unexpected(rpcINVALID_PARAMS); XRPL_ASSERT( - (issue1.has_value() == issue2.has_value()) && (issue1.has_value() != ammID.has_value()), - "xrpl::doAMMInfo : issue1 and issue2 do match"); + (asset1.has_value() == asset2.has_value()) && (asset1.has_value() != ammID.has_value()), + "xrpl::doAMMInfo : asset1 and asset2 do match"); auto const ammKeylet = [&]() { - if (issue1 && issue2) - return keylet::amm(*issue1, *issue2); + if (asset1 && asset2) + return keylet::amm(*asset1, *asset2); XRPL_ASSERT(ammID, "xrpl::doAMMInfo::ammKeylet : ammID is set"); return keylet::amm(*ammID); }(); auto const amm = ledger->read(ammKeylet); if (!amm) return Unexpected(rpcACT_NOT_FOUND); - if (!issue1 && !issue2) + if (!asset1 && !asset2) { - issue1 = (*amm)[sfAsset].get(); - issue2 = (*amm)[sfAsset2].get(); + asset1 = (*amm)[sfAsset]; + asset2 = (*amm)[sfAsset2]; } - return ValuesFromContextParams{accountID, *issue1, *issue2, amm}; + return ValuesFromContextParams{accountID, *asset1, *asset2, amm}; }; auto const r = getValuesFromContextParams(); @@ -149,13 +170,19 @@ doAMMInfo(RPC::JsonContext& context) return result; } - auto const& [accountID, issue1, issue2, amm] = *r; + auto const& [accountID, asset1, asset2, amm] = *r; auto const ammAccountID = amm->getAccountID(sfAccount); // provide funds if frozen, specify asset_frozen flag auto const [asset1Balance, asset2Balance] = ammPoolHolds( - *ledger, ammAccountID, issue1, issue2, FreezeHandling::fhIGNORE_FREEZE, context.j); + *ledger, + ammAccountID, + asset1, + asset2, + FreezeHandling::fhIGNORE_FREEZE, + AuthHandling::ahIGNORE_AUTH, + context.j); auto const lptAMMBalance = accountID ? ammLPHolds(*ledger, *amm, *accountID, context.j) : (*amm)[sfLPTokenBalance]; @@ -213,13 +240,11 @@ doAMMInfo(RPC::JsonContext& context) if (!isXRP(asset1Balance)) { - ammResult[jss::asset_frozen] = - isFrozen(*ledger, ammAccountID, issue1.currency, issue1.account); + ammResult[jss::asset_frozen] = isFrozen(*ledger, ammAccountID, asset1); } if (!isXRP(asset2Balance)) { - ammResult[jss::asset2_frozen] = - isFrozen(*ledger, ammAccountID, issue2.currency, issue2.account); + ammResult[jss::asset2_frozen] = isFrozen(*ledger, ammAccountID, asset2); } result[jss::amm] = std::move(ammResult); diff --git a/src/xrpld/rpc/handlers/orderbook/BookChanges.cpp b/src/xrpld/rpc/handlers/orderbook/BookChanges.cpp new file mode 100644 index 0000000000..502895e734 --- /dev/null +++ b/src/xrpld/rpc/handlers/orderbook/BookChanges.cpp @@ -0,0 +1,24 @@ +#include + +#include +#include + +#include + +#include + +namespace xrpl { + +Json::Value +doBookChanges(RPC::JsonContext& context) +{ + std::shared_ptr ledger; + + Json::Value result = RPC::lookupLedger(ledger, context); + if (ledger == nullptr) + return result; + + return RPC::computeBookChanges(ledger); +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/orderbook/BookOffers.cpp b/src/xrpld/rpc/handlers/orderbook/BookOffers.cpp new file mode 100644 index 0000000000..04fceac268 --- /dev/null +++ b/src/xrpld/rpc/handlers/orderbook/BookOffers.cpp @@ -0,0 +1,269 @@ +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +namespace xrpl { + +std::optional +validateTakerJSON(Json::Value const& taker, Json::StaticString const& name) +{ + if (!taker.isMember(jss::currency) && !taker.isMember(jss::mpt_issuance_id)) + { + return RPC::missing_field_error((boost::format("%s.currency") % name.c_str()).str()); + } + + if (taker.isMember(jss::mpt_issuance_id) && + (taker.isMember(jss::currency) || taker.isMember(jss::issuer))) + { + return RPC::invalid_field_error(name.c_str()); + } + + if ((taker.isMember(jss::currency) && !taker[jss::currency].isString()) || + (taker.isMember(jss::mpt_issuance_id) && !taker[jss::mpt_issuance_id].isString())) + { + return RPC::expected_field_error( + (boost::format("%s.currency") % name.c_str()).str(), "string"); + } + + return std::nullopt; +} + +std::optional +parseTakerAssetJSON( + Asset& asset, + Json::Value const& taker, + Json::StaticString const& name, + beast::Journal j) +{ + auto const assetError = [&]() { + if (name == jss::taker_pays) + return rpcSRC_CUR_MALFORMED; + return rpcDST_AMT_MALFORMED; + }(); + + if (taker.isMember(jss::currency)) + { + Issue issue = xrpIssue(); + + if (!to_currency(issue.currency, taker[jss::currency].asString())) + { + JLOG(j.info()) << boost::format("Bad %s currency.") % name.c_str(); + return RPC::make_error( + assetError, + (boost::format("Invalid field '%s.currency', bad currency.") % name.c_str()).str()); + } + asset = issue; + } + else if (taker.isMember(jss::mpt_issuance_id)) + { + MPTID mptid; + if (!mptid.parseHex(taker[jss::mpt_issuance_id].asString())) + { + return RPC::make_error( + assetError, + (boost::format("Invalid field '%s.mpt_issuance_id'") % name.c_str()).str()); + } + asset = mptid; + } + + return std::nullopt; +} + +std::optional +parseTakerIssuerJSON( + Asset& asset, + Json::Value const& taker, + Json::StaticString const& name, + beast::Journal j) +{ + auto const issuerError = [&]() { + if (name == jss::taker_pays) + return rpcSRC_ISR_MALFORMED; + return rpcDST_ISR_MALFORMED; + }(); + + if (taker.isMember(jss::currency)) + { + Issue& issue = asset.get(); + + if (taker.isMember(jss::issuer)) + { + if (!taker[jss::issuer].isString()) + { + return RPC::expected_field_error( + (boost::format("%s.issuer") % name.c_str()).str(), "string"); + } + + if (!to_issuer(issue.account, taker[jss::issuer].asString())) + { + return RPC::make_error( + issuerError, + (boost::format("Invalid field '%s.issuer', bad issuer.") % name.c_str()).str()); + } + + if (issue.account == noAccount()) + { + return RPC::make_error( + issuerError, + (boost::format("Invalid field '%s.issuer', bad issuer account one.") % + name.c_str()) + .str()); + } + } + else + { + issue.account = xrpAccount(); + } + + if (isXRP(issue.currency) && !isXRP(issue.account)) + { + return RPC::make_error( + issuerError, + (boost::format( + "Unneeded field '%s.issuer' for XRP currency " + "specification.") % + name.c_str()) + .str()); + } + + if (!isXRP(issue.currency) && isXRP(issue.account)) + { + return RPC::make_error( + issuerError, + (boost::format("Invalid field '%s.issuer', expected non-XRP issuer.") % + name.c_str()) + .str()); + } + } + + return std::nullopt; +} + +Json::Value +doBookOffers(RPC::JsonContext& context) +{ + // VFALCO TODO Here is a terrible place for this kind of business + // logic. It needs to be moved elsewhere and documented, + // and encapsulated into a function. + if (context.app.getJobQueue().getJobCountGE(jtCLIENT) > 200) + return rpcError(rpcTOO_BUSY); + + std::shared_ptr lpLedger; + auto jvResult = RPC::lookupLedger(lpLedger, context); + + if (!lpLedger) + return jvResult; + + if (!context.params.isMember(jss::taker_pays)) + return RPC::missing_field_error(jss::taker_pays); + + if (!context.params.isMember(jss::taker_gets)) + return RPC::missing_field_error(jss::taker_gets); + + Json::Value const& taker_pays = context.params[jss::taker_pays]; + Json::Value const& taker_gets = context.params[jss::taker_gets]; + + if (!taker_pays.isObjectOrNull()) + return RPC::object_field_error(jss::taker_pays); + + if (!taker_gets.isObjectOrNull()) + return RPC::object_field_error(jss::taker_gets); + + if (auto const err = validateTakerJSON(taker_pays, jss::taker_pays)) + return *err; + + if (auto const err = validateTakerJSON(taker_gets, jss::taker_gets)) + return *err; + + Book book; + + if (auto const err = parseTakerAssetJSON(book.in, taker_pays, jss::taker_pays, context.j)) + return *err; + + if (auto const err = parseTakerAssetJSON(book.out, taker_gets, jss::taker_gets, context.j)) + return *err; + + if (auto const err = parseTakerIssuerJSON(book.in, taker_pays, jss::taker_pays, context.j)) + return *err; + + if (auto const err = parseTakerIssuerJSON(book.out, taker_gets, jss::taker_gets, context.j)) + return *err; + + std::optional takerID; + if (context.params.isMember(jss::taker)) + { + if (!context.params[jss::taker].isString()) + return RPC::expected_field_error(jss::taker, "string"); + + takerID = parseBase58(context.params[jss::taker].asString()); + if (!takerID) + return RPC::invalid_field_error(jss::taker); + } + + std::optional domain; + if (context.params.isMember(jss::domain)) + { + uint256 num; + if (!context.params[jss::domain].isString() || + !num.parseHex(context.params[jss::domain].asString())) + { + return RPC::make_error(rpcDOMAIN_MALFORMED, "Unable to parse domain."); + } + + domain = num; + } + + if (book.in == book.out) + { + JLOG(context.j.info()) << "taker_gets same as taker_pays."; + return RPC::make_error(rpcBAD_MARKET); + } + + unsigned int limit = 0; + if (auto err = readLimitField(limit, RPC::Tuning::bookOffers, context)) + return *err; + + bool const bProof(context.params.isMember(jss::proof)); + + Json::Value const jvMarker( + context.params.isMember(jss::marker) ? context.params[jss::marker] + : Json::Value(Json::nullValue)); + + context.netOps.getBookPage( + lpLedger, + {book.in, book.out, domain}, + takerID ? *takerID : beast::zero, + bProof, + limit, + jvMarker, + jvResult); + + context.loadType = Resource::feeMediumBurdenRPC; + + return jvResult; +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/DepositAuthorized.cpp b/src/xrpld/rpc/handlers/orderbook/DepositAuthorized.cpp similarity index 94% rename from src/xrpld/rpc/handlers/DepositAuthorized.cpp rename to src/xrpld/rpc/handlers/orderbook/DepositAuthorized.cpp index fb1c0db884..95c7238d20 100644 --- a/src/xrpld/rpc/handlers/DepositAuthorized.cpp +++ b/src/xrpld/rpc/handlers/orderbook/DepositAuthorized.cpp @@ -1,13 +1,26 @@ #include #include +#include +#include +#include +#include #include #include +#include #include #include +#include +#include #include +#include #include +#include +#include +#include +#include + namespace xrpl { // { diff --git a/src/xrpld/rpc/handlers/GetAggregatePrice.cpp b/src/xrpld/rpc/handlers/orderbook/GetAggregatePrice.cpp similarity index 93% rename from src/xrpld/rpc/handlers/GetAggregatePrice.cpp rename to src/xrpld/rpc/handlers/orderbook/GetAggregatePrice.cpp index 4979c21f42..4b1af3a644 100644 --- a/src/xrpld/rpc/handlers/GetAggregatePrice.cpp +++ b/src/xrpld/rpc/handlers/orderbook/GetAggregatePrice.cpp @@ -3,15 +3,38 @@ #include #include +#include +#include #include +#include #include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include #include #include +#include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include + namespace xrpl { using namespace boost::bimaps; @@ -62,8 +85,8 @@ iteratePriceData( if (++history > maxHistory) return; - uint256 prevTx = chain->getFieldH256(sfPreviousTxnID); - std::uint32_t prevSeq = chain->getFieldU32(sfPreviousTxnLgrSeq); + uint256 const prevTx = chain->getFieldH256(sfPreviousTxnID); + std::uint32_t const prevSeq = chain->getFieldU32(sfPreviousTxnLgrSeq); auto const ledger = context.ledgerMaster.getLedgerBySeq(prevSeq); if (!ledger) @@ -320,7 +343,7 @@ doGetAggregatePrice(RPC::JsonContext& context) auto const middle = size_ / 2; if ((size_ % 2) == 0) { - static STAmount two{noIssue(), 2, 0}; + static STAmount const two{noIssue(), 2, 0}; auto it = itAdvance(prices.right.begin(), middle - 1); auto const& a1 = it->first; auto const& a2 = (++it)->first; diff --git a/src/xrpld/rpc/handlers/orderbook/NFTBuyOffers.cpp b/src/xrpld/rpc/handlers/orderbook/NFTBuyOffers.cpp new file mode 100644 index 0000000000..98c4a73784 --- /dev/null +++ b/src/xrpld/rpc/handlers/orderbook/NFTBuyOffers.cpp @@ -0,0 +1,26 @@ +#include +#include + +#include +#include +#include +#include +#include + +namespace xrpl { + +Json::Value +doNFTBuyOffers(RPC::JsonContext& context) +{ + if (!context.params.isMember(jss::nft_id)) + return RPC::missing_field_error(jss::nft_id); + + uint256 nftId; + + if (!nftId.parseHex(context.params[jss::nft_id].asString())) + return RPC::invalid_field_error(jss::nft_id); + + return enumerateNFTOffers(context, nftId, keylet::nft_buys(nftId)); +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/NFTOffers.cpp b/src/xrpld/rpc/handlers/orderbook/NFTOffersHelpers.h similarity index 82% rename from src/xrpld/rpc/handlers/NFTOffers.cpp rename to src/xrpld/rpc/handlers/orderbook/NFTOffersHelpers.h index 5fe2e3bede..8f68aeaadd 100644 --- a/src/xrpld/rpc/handlers/NFTOffers.cpp +++ b/src/xrpld/rpc/handlers/orderbook/NFTOffersHelpers.h @@ -1,3 +1,5 @@ +#pragma once + #include #include #include @@ -14,7 +16,7 @@ namespace xrpl { -static void +inline void appendNftOfferJson( Application const& app, std::shared_ptr const& offer, @@ -42,7 +44,7 @@ appendNftOfferJson( // limit: integer // optional // marker: opaque // optional, resume previous query // } -static Json::Value +inline Json::Value enumerateNFTOffers(RPC::JsonContext& context, uint256 const& nftId, Keylet const& directory) { unsigned int limit = 0; @@ -127,32 +129,4 @@ enumerateNFTOffers(RPC::JsonContext& context, uint256 const& nftId, Keylet const return result; } -Json::Value -doNFTSellOffers(RPC::JsonContext& context) -{ - if (!context.params.isMember(jss::nft_id)) - return RPC::missing_field_error(jss::nft_id); - - uint256 nftId; - - if (!nftId.parseHex(context.params[jss::nft_id].asString())) - return RPC::invalid_field_error(jss::nft_id); - - return enumerateNFTOffers(context, nftId, keylet::nft_sells(nftId)); -} - -Json::Value -doNFTBuyOffers(RPC::JsonContext& context) -{ - if (!context.params.isMember(jss::nft_id)) - return RPC::missing_field_error(jss::nft_id); - - uint256 nftId; - - if (!nftId.parseHex(context.params[jss::nft_id].asString())) - return RPC::invalid_field_error(jss::nft_id); - - return enumerateNFTOffers(context, nftId, keylet::nft_buys(nftId)); -} - } // namespace xrpl diff --git a/src/xrpld/rpc/handlers/orderbook/NFTSellOffers.cpp b/src/xrpld/rpc/handlers/orderbook/NFTSellOffers.cpp new file mode 100644 index 0000000000..8612fdf587 --- /dev/null +++ b/src/xrpld/rpc/handlers/orderbook/NFTSellOffers.cpp @@ -0,0 +1,26 @@ +#include +#include + +#include +#include +#include +#include +#include + +namespace xrpl { + +Json::Value +doNFTSellOffers(RPC::JsonContext& context) +{ + if (!context.params.isMember(jss::nft_id)) + return RPC::missing_field_error(jss::nft_id); + + uint256 nftId; + + if (!nftId.parseHex(context.params[jss::nft_id].asString())) + return RPC::invalid_field_error(jss::nft_id); + + return enumerateNFTOffers(context, nftId, keylet::nft_sells(nftId)); +} + +} // namespace xrpl diff --git a/src/xrpld/rpc/handlers/PathFind.cpp b/src/xrpld/rpc/handlers/orderbook/PathFind.cpp similarity index 87% rename from src/xrpld/rpc/handlers/PathFind.cpp rename to src/xrpld/rpc/handlers/orderbook/PathFind.cpp index 1b180167ea..ffe00f54a8 100644 --- a/src/xrpld/rpc/handlers/PathFind.cpp +++ b/src/xrpld/rpc/handlers/orderbook/PathFind.cpp @@ -3,10 +3,12 @@ #include #include +#include #include #include #include #include +#include namespace xrpl { @@ -40,7 +42,7 @@ doPathFind(RPC::JsonContext& context) if (sSubCommand == "close") { - InfoSubRequest::pointer request = context.infoSub->getRequest(); + InfoSubRequest::pointer const request = context.infoSub->getRequest(); if (!request) return rpcError(rpcNO_PF_REQUEST); @@ -51,7 +53,7 @@ doPathFind(RPC::JsonContext& context) if (sSubCommand == "status") { - InfoSubRequest::pointer request = context.infoSub->getRequest(); + InfoSubRequest::pointer const request = context.infoSub->getRequest(); if (!request) return rpcError(rpcNO_PF_REQUEST); diff --git a/src/xrpld/rpc/handlers/RipplePathFind.cpp b/src/xrpld/rpc/handlers/orderbook/RipplePathFind.cpp similarity index 92% rename from src/xrpld/rpc/handlers/RipplePathFind.cpp rename to src/xrpld/rpc/handlers/orderbook/RipplePathFind.cpp index cc695908fb..c0a2a17a49 100644 --- a/src/xrpld/rpc/handlers/RipplePathFind.cpp +++ b/src/xrpld/rpc/handlers/orderbook/RipplePathFind.cpp @@ -1,12 +1,22 @@ #include #include +#include #include +#include #include #include +#include +#include +#include +#include #include +#include #include +#include +#include + namespace xrpl { // This interface is deprecated. @@ -94,7 +104,7 @@ doRipplePathFind(RPC::JsonContext& context) // Both of these failure modes are hard to recreate in a unit test // because they are so dependent on inter-thread timing. However // the failure modes can be observed by synchronously (inside the - // rippled source code) shutting down the application. The code to + // xrpld source code) shutting down the application. The code to // do so looks like this: // // context.app.signalStop(); @@ -113,7 +123,7 @@ doRipplePathFind(RPC::JsonContext& context) // captured reference could evaporate when we return from // coroCopy->resume(). This is not strictly necessary, but // will make maintenance easier. - std::shared_ptr coroCopy{context.coro}; + std::shared_ptr const coroCopy{context.coro}; if (!coroCopy->post()) { // The post() failed, so we won't get a thread to let @@ -140,7 +150,7 @@ doRipplePathFind(RPC::JsonContext& context) if (!lpLedger) return jvResult; - RPC::LegacyPathFind lpf(isUnlimited(context.role), context.app); + RPC::LegacyPathFind const lpf(isUnlimited(context.role), context.app); if (!lpf.isOk()) return rpcError(rpcTOO_BUSY); diff --git a/src/xrpld/rpc/handlers/Feature1.cpp b/src/xrpld/rpc/handlers/server_info/Feature.cpp similarity index 94% rename from src/xrpld/rpc/handlers/Feature1.cpp rename to src/xrpld/rpc/handlers/server_info/Feature.cpp index 24ff0d62b8..f6f5316a55 100644 --- a/src/xrpld/rpc/handlers/Feature1.cpp +++ b/src/xrpld/rpc/handlers/server_info/Feature.cpp @@ -1,8 +1,12 @@ #include #include #include +#include +#include +#include #include +#include #include #include #include diff --git a/src/xrpld/rpc/handlers/Fee1.cpp b/src/xrpld/rpc/handlers/server_info/Fee.cpp similarity index 86% rename from src/xrpld/rpc/handlers/Fee1.cpp rename to src/xrpld/rpc/handlers/server_info/Fee.cpp index 49a36261f4..d943d02f77 100644 --- a/src/xrpld/rpc/handlers/Fee1.cpp +++ b/src/xrpld/rpc/handlers/server_info/Fee.cpp @@ -1,9 +1,9 @@ -#include #include #include #include -#include +#include +#include #include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/DoManifest.cpp b/src/xrpld/rpc/handlers/server_info/Manifest.cpp similarity index 96% rename from src/xrpld/rpc/handlers/DoManifest.cpp rename to src/xrpld/rpc/handlers/server_info/Manifest.cpp index ba3461033f..75533f0e78 100644 --- a/src/xrpld/rpc/handlers/DoManifest.cpp +++ b/src/xrpld/rpc/handlers/server_info/Manifest.cpp @@ -6,7 +6,9 @@ #include #include #include +#include #include +#include namespace xrpl { Json::Value diff --git a/src/xrpld/rpc/handlers/ServerDefinitions.cpp b/src/xrpld/rpc/handlers/server_info/ServerDefinitions.cpp similarity index 97% rename from src/xrpld/rpc/handlers/ServerDefinitions.cpp rename to src/xrpld/rpc/handlers/server_info/ServerDefinitions.cpp index 2f11e18efb..d3db8cf56d 100644 --- a/src/xrpld/rpc/handlers/ServerDefinitions.cpp +++ b/src/xrpld/rpc/handlers/server_info/ServerDefinitions.cpp @@ -1,8 +1,9 @@ #include -#include +#include #include #include +#include #include #include #include @@ -11,9 +12,14 @@ #include #include -#include +#include +#include +#include +#include +#include #include +#include #include #include @@ -123,7 +129,7 @@ ServerDefinitions::ServerDefinitions() : defs_{Json::objectValue} std::map typeMap{{-1, "Done"}}; for (auto const& [rawName, typeValue] : sTypeMap) { - std::string typeName = translate(std::string(rawName).substr(4) /* remove STI_ */); + std::string const typeName = translate(std::string(rawName).substr(4) /* remove STI_ */); defs_[jss::TYPES][typeName] = typeValue; typeMap[typeValue] = typeName; } diff --git a/src/xrpld/rpc/handlers/ServerInfo.cpp b/src/xrpld/rpc/handlers/server_info/ServerInfo.cpp similarity index 100% rename from src/xrpld/rpc/handlers/ServerInfo.cpp rename to src/xrpld/rpc/handlers/server_info/ServerInfo.cpp diff --git a/src/xrpld/rpc/handlers/ServerState.cpp b/src/xrpld/rpc/handlers/server_info/ServerState.cpp similarity index 100% rename from src/xrpld/rpc/handlers/ServerState.cpp rename to src/xrpld/rpc/handlers/server_info/ServerState.cpp diff --git a/src/xrpld/rpc/handlers/Version.h b/src/xrpld/rpc/handlers/server_info/Version.h similarity index 93% rename from src/xrpld/rpc/handlers/Version.h rename to src/xrpld/rpc/handlers/server_info/Version.h index a03212e906..cda47792e8 100644 --- a/src/xrpld/rpc/handlers/Version.h +++ b/src/xrpld/rpc/handlers/server_info/Version.h @@ -13,14 +13,14 @@ public: { } - Status + static Status check() { return Status::OK; } void - writeResult(Json::Value& obj) + writeResult(Json::Value& obj) const { setVersion(obj, apiVersion_, betaEnabled_); } diff --git a/src/xrpld/rpc/handlers/Subscribe.cpp b/src/xrpld/rpc/handlers/subscribe/Subscribe.cpp similarity index 83% rename from src/xrpld/rpc/handlers/Subscribe.cpp rename to src/xrpld/rpc/handlers/subscribe/Subscribe.cpp index fc5238b37b..9be273587d 100644 --- a/src/xrpld/rpc/handlers/Subscribe.cpp +++ b/src/xrpld/rpc/handlers/subscribe/Subscribe.cpp @@ -4,14 +4,26 @@ #include #include #include +#include +#include +#include +#include #include +#include +#include #include #include #include #include +#include #include +#include +#include +#include +#include + namespace xrpl { Json::Value @@ -32,7 +44,7 @@ doSubscribe(RPC::JsonContext& context) if (context.role != Role::ADMIN) return rpcError(rpcNO_PERMISSION); - std::string strUrl = context.params[jss::url].asString(); + std::string const strUrl = context.params[jss::url].asString(); std::string strUsername = context.params.isMember(jss::url_username) ? context.params[jss::url_username].asString() : ""; @@ -65,7 +77,7 @@ doSubscribe(RPC::JsonContext& context) ispSub = context.netOps.addRpcSub(strUrl, std::dynamic_pointer_cast(rspSub)); } - catch (std::runtime_error& ex) + catch (std::runtime_error const& ex) { return RPC::make_param_error(ex.what()); } @@ -106,7 +118,7 @@ doSubscribe(RPC::JsonContext& context) if (!it.isString()) return rpcError(rpcSTREAM_MALFORMED); - std::string streamName = it.asString(); + std::string const streamName = it.asString(); if (streamName == "server") { context.netOps.subServer(ispSub, jvResult, context.role == Role::ADMIN); @@ -217,48 +229,16 @@ doSubscribe(RPC::JsonContext& context) return rpcError(rpcINVALID_PARAMS); Book book; - Json::Value taker_pays = j[jss::taker_pays]; - Json::Value taker_gets = j[jss::taker_gets]; - // Parse mandatory currency. - if (!taker_pays.isMember(jss::currency) || - !to_currency(book.in.currency, taker_pays[jss::currency].asString())) - { - JLOG(context.j.info()) << "Bad taker_pays currency."; - return rpcError(rpcSRC_CUR_MALFORMED); - } + if (auto const err = RPC::parseSubUnsubJson(book.in, j, jss::taker_pays, context.j); + err != rpcSUCCESS) + return rpcError(err); - // Parse optional issuer. - if (((taker_pays.isMember(jss::issuer)) && - (!taker_pays[jss::issuer].isString() || - !to_issuer(book.in.account, taker_pays[jss::issuer].asString()))) - // Don't allow illegal issuers. - || (!book.in.currency != !book.in.account) || noAccount() == book.in.account) - { - JLOG(context.j.info()) << "Bad taker_pays issuer."; - return rpcError(rpcSRC_ISR_MALFORMED); - } + if (auto const err = RPC::parseSubUnsubJson(book.out, j, jss::taker_gets, context.j); + err != rpcSUCCESS) + return rpcError(err); - // Parse mandatory currency. - if (!taker_gets.isMember(jss::currency) || - !to_currency(book.out.currency, taker_gets[jss::currency].asString())) - { - JLOG(context.j.info()) << "Bad taker_gets currency."; - return rpcError(rpcDST_AMT_MALFORMED); - } - - // Parse optional issuer. - if (((taker_gets.isMember(jss::issuer)) && - (!taker_gets[jss::issuer].isString() || - !to_issuer(book.out.account, taker_gets[jss::issuer].asString()))) - // Don't allow illegal issuers. - || (!book.out.currency != !book.out.account) || noAccount() == book.out.account) - { - JLOG(context.j.info()) << "Bad taker_gets issuer."; - return rpcError(rpcDST_ISR_MALFORMED); - } - - if (book.in.currency == book.out.currency && book.in.account == book.out.account) + if (book.in == book.out) { JLOG(context.j.info()) << "taker_gets same as taker_pays."; return rpcError(rpcBAD_MARKET); diff --git a/src/xrpld/rpc/handlers/Unsubscribe.cpp b/src/xrpld/rpc/handlers/subscribe/Unsubscribe.cpp similarity index 75% rename from src/xrpld/rpc/handlers/Unsubscribe.cpp rename to src/xrpld/rpc/handlers/subscribe/Unsubscribe.cpp index 824d57203c..258774d12a 100644 --- a/src/xrpld/rpc/handlers/Unsubscribe.cpp +++ b/src/xrpld/rpc/handlers/subscribe/Unsubscribe.cpp @@ -3,11 +3,18 @@ #include #include +#include +#include +#include +#include #include #include #include +#include #include +#include + namespace xrpl { Json::Value @@ -28,7 +35,7 @@ doUnsubscribe(RPC::JsonContext& context) if (context.role != Role::ADMIN) return rpcError(rpcNO_PERMISSION); - std::string strUrl = context.params[jss::url].asString(); + std::string const strUrl = context.params[jss::url].asString(); ispSub = context.netOps.findRpcSub(strUrl); if (!ispSub) return jvResult; @@ -49,7 +56,7 @@ doUnsubscribe(RPC::JsonContext& context) if (!it.isString()) return rpcError(rpcSTREAM_MALFORMED); - std::string streamName = it.asString(); + std::string const streamName = it.asString(); if (streamName == "server") { context.netOps.unsubServer(ispSub->getSeq()); @@ -152,49 +159,15 @@ doUnsubscribe(RPC::JsonContext& context) return rpcError(rpcINVALID_PARAMS); } - Json::Value taker_pays = jv[jss::taker_pays]; - Json::Value taker_gets = jv[jss::taker_gets]; - Book book; - // Parse mandatory currency. - if (!taker_pays.isMember(jss::currency) || - !to_currency(book.in.currency, taker_pays[jss::currency].asString())) - { - JLOG(context.j.info()) << "Bad taker_pays currency."; - return rpcError(rpcSRC_CUR_MALFORMED); - } - // Parse optional issuer. - if (((taker_pays.isMember(jss::issuer)) && - (!taker_pays[jss::issuer].isString() || - !to_issuer(book.in.account, taker_pays[jss::issuer].asString()))) - // Don't allow illegal issuers. - || !isConsistent(book.in) || noAccount() == book.in.account) - { - JLOG(context.j.info()) << "Bad taker_pays issuer."; + if (auto const err = RPC::parseSubUnsubJson(book.in, jv, jss::taker_pays, context.j); + err != rpcSUCCESS) + return rpcError(err); - return rpcError(rpcSRC_ISR_MALFORMED); - } - - // Parse mandatory currency. - if (!taker_gets.isMember(jss::currency) || - !to_currency(book.out.currency, taker_gets[jss::currency].asString())) - { - JLOG(context.j.info()) << "Bad taker_gets currency."; - - return rpcError(rpcDST_AMT_MALFORMED); - } - // Parse optional issuer. - if (((taker_gets.isMember(jss::issuer)) && - (!taker_gets[jss::issuer].isString() || - !to_issuer(book.out.account, taker_gets[jss::issuer].asString()))) - // Don't allow illegal issuers. - || !isConsistent(book.out) || noAccount() == book.out.account) - { - JLOG(context.j.info()) << "Bad taker_gets issuer."; - - return rpcError(rpcDST_ISR_MALFORMED); - } + if (auto const err = RPC::parseSubUnsubJson(book.out, jv, jss::taker_gets, context.j); + err != rpcSUCCESS) + return rpcError(err); if (book.in == book.out) { diff --git a/src/xrpld/rpc/handlers/Simulate.cpp b/src/xrpld/rpc/handlers/transaction/Simulate.cpp similarity index 92% rename from src/xrpld/rpc/handlers/Simulate.cpp rename to src/xrpld/rpc/handlers/transaction/Simulate.cpp index c1d6d7f334..f5004bab13 100644 --- a/src/xrpld/rpc/handlers/Simulate.cpp +++ b/src/xrpld/rpc/handlers/transaction/Simulate.cpp @@ -4,18 +4,41 @@ #include #include #include -#include #include #include -#include +#include +#include +#include +#include +#include +#include #include +#include +#include +#include +#include +#include #include +#include #include #include +#include #include +#include +#include +#include +#include #include -#include + +#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -339,7 +362,7 @@ doSimulate(RPC::JsonContext& context) { return simulateTxn(context, transaction); } - // LCOV_EXCL_START this is just in case, so rippled doesn't crash + // LCOV_EXCL_START this is just in case, so xrpld doesn't crash catch (std::exception const& e) { Json::Value jvResult = Json::objectValue; diff --git a/src/xrpld/rpc/handlers/Submit.cpp b/src/xrpld/rpc/handlers/transaction/Submit.cpp similarity index 92% rename from src/xrpld/rpc/handlers/Submit.cpp rename to src/xrpld/rpc/handlers/transaction/Submit.cpp index cac7259a00..73260c0661 100644 --- a/src/xrpld/rpc/handlers/Submit.cpp +++ b/src/xrpld/rpc/handlers/transaction/Submit.cpp @@ -1,13 +1,27 @@ #include #include #include +#include #include +#include +#include +#include +#include #include #include +#include +#include +#include +#include +#include #include #include +#include +#include +#include + namespace xrpl { static NetworkOPs::FailHard diff --git a/src/xrpld/rpc/handlers/SubmitMultiSigned.cpp b/src/xrpld/rpc/handlers/transaction/SubmitMultiSigned.cpp similarity index 92% rename from src/xrpld/rpc/handlers/SubmitMultiSigned.cpp rename to src/xrpld/rpc/handlers/transaction/SubmitMultiSigned.cpp index 52213e174a..d121e9a850 100644 --- a/src/xrpld/rpc/handlers/SubmitMultiSigned.cpp +++ b/src/xrpld/rpc/handlers/transaction/SubmitMultiSigned.cpp @@ -2,7 +2,8 @@ #include #include -#include +#include +#include #include namespace xrpl { diff --git a/src/xrpld/rpc/handlers/TransactionEntry.cpp b/src/xrpld/rpc/handlers/transaction/TransactionEntry.cpp similarity index 96% rename from src/xrpld/rpc/handlers/TransactionEntry.cpp rename to src/xrpld/rpc/handlers/transaction/TransactionEntry.cpp index 36f53130fa..67fd2504fe 100644 --- a/src/xrpld/rpc/handlers/TransactionEntry.cpp +++ b/src/xrpld/rpc/handlers/transaction/TransactionEntry.cpp @@ -3,9 +3,14 @@ #include #include +#include +#include +#include #include #include +#include + namespace xrpl { // { diff --git a/src/xrpld/rpc/handlers/Tx.cpp b/src/xrpld/rpc/handlers/transaction/Tx.cpp similarity index 90% rename from src/xrpld/rpc/handlers/Tx.cpp rename to src/xrpld/rpc/handlers/transaction/Tx.cpp index 211372db45..530b45e225 100644 --- a/src/xrpld/rpc/handlers/Tx.cpp +++ b/src/xrpld/rpc/handlers/transaction/Tx.cpp @@ -5,20 +5,35 @@ #include #include #include -#include #include #include -#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include #include +#include +#include +#include #include #include #include -#include +#include +#include +#include +#include +#include +#include +#include namespace xrpl { @@ -125,7 +140,8 @@ doTxHelp(RPC::Context& context, TxArgs args) return {result, rpcSUCCESS}; } - std::shared_ptr ledger = context.ledgerMaster.getLedgerBySeq(txn->getLedger()); + std::shared_ptr const ledger = + context.ledgerMaster.getLedgerBySeq(txn->getLedger()); if (ledger && !ledger->open()) result.ledgerHash = ledger->header().hash; @@ -148,9 +164,9 @@ doTxHelp(RPC::Context& context, TxArgs args) // compute outgoing CTID if (meta->getAsObject().isFieldPresent(sfTransactionIndex)) { - uint32_t lgrSeq = ledger->header().seq; - uint32_t txnIdx = meta->getAsObject().getFieldU32(sfTransactionIndex); - uint32_t netID = context.app.getNetworkIDService().getNetworkID(); + uint32_t const lgrSeq = ledger->header().seq; + uint32_t const txnIdx = meta->getAsObject().getFieldU32(sfTransactionIndex); + uint32_t const netID = context.app.getNetworkIDService().getNetworkID(); if (txnIdx <= 0xFFFFU && netID < 0xFFFFU && lgrSeq < 0x0FFF'FFFFUL) result.ctid = RPC::encodeCTID(lgrSeq, txnIdx, netID); @@ -310,7 +326,7 @@ doTxJson(RPC::JsonContext& context) } } - std::pair res = doTxHelp(context, args); + std::pair const res = doTxHelp(context, args); return populateJsonResponse(res, args, context); } diff --git a/src/xrpld/rpc/handlers/TxHistory.cpp b/src/xrpld/rpc/handlers/transaction/TxHistory.cpp similarity index 91% rename from src/xrpld/rpc/handlers/TxHistory.cpp rename to src/xrpld/rpc/handlers/transaction/TxHistory.cpp index 02ff6fb43c..1669d289b4 100644 --- a/src/xrpld/rpc/handlers/TxHistory.cpp +++ b/src/xrpld/rpc/handlers/transaction/TxHistory.cpp @@ -1,4 +1,3 @@ -#include #include #include #include @@ -27,7 +26,7 @@ doTxHistory(RPC::JsonContext& context) if (!context.params.isMember(jss::start)) return rpcError(rpcINVALID_PARAMS); - unsigned int startIndex = context.params[jss::start].asUInt(); + unsigned int const startIndex = context.params[jss::start].asUInt(); if ((startIndex > 10000) && (!isUnlimited(context.role))) return rpcError(rpcNO_PERMISSION); diff --git a/src/xrpld/rpc/handlers/TxReduceRelay.cpp b/src/xrpld/rpc/handlers/transaction/TxReduceRelay.cpp similarity index 100% rename from src/xrpld/rpc/handlers/TxReduceRelay.cpp rename to src/xrpld/rpc/handlers/transaction/TxReduceRelay.cpp diff --git a/src/xrpld/rpc/handlers/Ping.cpp b/src/xrpld/rpc/handlers/utility/Ping.cpp similarity index 87% rename from src/xrpld/rpc/handlers/Ping.cpp rename to src/xrpld/rpc/handlers/utility/Ping.cpp index 4e9b18c4c9..695d90b964 100644 --- a/src/xrpld/rpc/handlers/Ping.cpp +++ b/src/xrpld/rpc/handlers/utility/Ping.cpp @@ -27,7 +27,9 @@ doPing(RPC::JsonContext& context) break; case Role::PROXY: ret[jss::role] = "proxied"; - ret[jss::ip] = std::string{context.headers.forwardedFor}; + if (!context.headers.forwardedFor.empty()) + ret[jss::ip] = std::string{context.headers.forwardedFor}; + break; default:; } diff --git a/src/xrpld/rpc/handlers/Random.cpp b/src/xrpld/rpc/handlers/utility/Random.cpp similarity index 95% rename from src/xrpld/rpc/handlers/Random.cpp rename to src/xrpld/rpc/handlers/utility/Random.cpp index 2fb8abf3c9..e17a8928bb 100644 --- a/src/xrpld/rpc/handlers/Random.cpp +++ b/src/xrpld/rpc/handlers/utility/Random.cpp @@ -6,11 +6,13 @@ #include #include +#include + namespace xrpl { namespace RPC { struct JsonContext; -} +} // namespace RPC // Result: // { diff --git a/src/xrpld/rpc/json_body.h b/src/xrpld/rpc/json_body.h index d70fafb2d4..2e9e774992 100644 --- a/src/xrpld/rpc/json_body.h +++ b/src/xrpld/rpc/json_body.h @@ -69,7 +69,7 @@ struct json_body { } - void + static void init(boost::beast::error_code& ec) { ec.assign(0, ec.category()); diff --git a/src/xrpld/shamap/NodeFamily.cpp b/src/xrpld/shamap/NodeFamily.cpp index ec5e9eb1b2..2c47515498 100644 --- a/src/xrpld/shamap/NodeFamily.cpp +++ b/src/xrpld/shamap/NodeFamily.cpp @@ -1,8 +1,22 @@ +#include + +#include #include #include #include #include -#include +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include namespace xrpl { @@ -39,7 +53,7 @@ void NodeFamily::reset() { { - std::lock_guard lock(maxSeqMutex_); + std::lock_guard const lock(maxSeqMutex_); maxSeq_ = 0; } diff --git a/src/xrpld/shamap/NodeFamily.h b/src/xrpld/shamap/NodeFamily.h index ab555919ac..3985a8bdf8 100644 --- a/src/xrpld/shamap/NodeFamily.h +++ b/src/xrpld/shamap/NodeFamily.h @@ -1,5 +1,8 @@ #pragma once +#include + +#include #include namespace xrpl { diff --git a/tests/README.md b/tests/README.md index c4a96005e7..431c2c464a 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,5 +1,5 @@ # Integration tests This directory contains integration tests for the project. These tests are run -against the `libxrpl` library or `rippled` binary to verify they are working as +against the `libxrpl` library or `xrpld` binary to verify they are working as expected.