Skip to content

refactor: Rename non-functional uses of ripple(d) to xrpl(d)#6676

Open
bthomee wants to merge 6 commits intodevelopfrom
bthomee/rename_docs
Open

refactor: Rename non-functional uses of ripple(d) to xrpl(d)#6676
bthomee wants to merge 6 commits intodevelopfrom
bthomee/rename_docs

Conversation

@bthomee
Copy link
Collaborator

@bthomee bthomee commented Mar 26, 2026

High Level Overview of Change

This change modifies non-functional uses of ripple(d) to xrpl(d), such as in documentation, comments, and internal function names.

Context of Change

Per XLS-0095, we are taking steps to rename ripple(d) to xrpl(d).

This change updates the references in files that have no impact on functionality of the binary. Note that the current documentation is known to be out of date. This PR does not address this issue. A full rewrite of the documentation and ensuring it is correct is planned for later this year. The docs/README.md file was deleted, however, as it was no longer relevant.

Note that a small tweak was made to the config and namespace scripts, as some of the changes found during development of this PR better belong in those files.

A few functions were renamed:

  • rippleLockEscrowMPT and rippleUnlockEscrowMPT to lockEscrowMPT and unlockEscrowMPT, resp.
  • rippleCredit, rippleCreditIOU, and rippleCreditMPT to directSend, directSendIOU, and directSendMPT, resp.
  • isRippledVersion to isXrpldVersion.
  • parseRippleLibSeed to parseXrplLibSeed.
  • testRippleLibEd25519 to testXrplLibEd25519.

Changes that were not made:

  • The GitHub repository will be renamed in the future, at which time the docs.sh script will be updated.
  • References to the validators and other nodes run by Ripple.
  • The concept of "rippling" is not affected by any of the renaming.

Copy link
Contributor

@xrplf-ai-reviewer xrplf-ai-reviewer bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went through the changes

Two TSan suppression patterns (xrpl::ServerHandler, xrpl::Workers::Worker) will silently break if the actual namespace in the compiled binary is still ripple:: — needs confirmation before merge. Also, the pinned historical URL in README.md was incorrectly rewritten to src/rippled/ when that path didn't exist at that commit. See inline comments.


Review by ReviewBot 🤖

Review by Claude Opus 4.6 · Prompt: V12

race:src/libxrpl/beast/utility/beast_Journal.cpp
race:src/test/beast/LexicalCast_test.cpp
race:ripple::ServerHandler
race:xrpl::ServerHandler
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TSan suppression pattern must match the actual mangled symbol in the binary. If ServerHandler is still in ripple:: namespace, this becomes a no-op and races will surface in CI. Confirm the namespace rename is live before merging.

signal:src/xrpld/core/detail/Workers.cpp
signal:src/xrpld/core/JobQueue.cpp
signal:ripple::Workers::Worker
signal:xrpl::Workers::Worker
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same risk as the ServerHandler suppression — if Workers::Worker is still under ripple::, this pattern won't match and signal-related TSan reports will reappear.

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/rippled/app/tx/impl/PayChan.cpp#L229-L236))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken link — at this pinned commit the path was src/ripple/, not src/rippled/. The rename script incorrectly modified a historical URL.

Suggested change
([Real example](https://github.com/XRPLF/rippled/blob/35f4698aed5dce02f771b34cfbb690495cb5efcc/src/rippled/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))

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix in follow-up commit.

@codecov
Copy link

codecov bot commented Mar 26, 2026

Codecov Report

❌ Patch coverage is 82.14286% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.4%. Comparing base (509677a) to head (1490a14).

Files with missing lines Patch % Lines
src/xrpld/app/ledger/detail/LedgerMaster.cpp 0.0% 4 Missing ⚠️
src/xrpld/app/main/Main.cpp 0.0% 3 Missing ⚠️
src/libxrpl/server/Vacuum.cpp 0.0% 2 Missing ⚠️
src/libxrpl/tx/paths/DirectStep.cpp 75.0% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           develop   #6676     +/-   ##
=========================================
- Coverage     81.5%   81.4%   -0.0%     
=========================================
  Files          998     998             
  Lines        74456   74456             
  Branches      7578    7563     -15     
=========================================
- Hits         60648   60634     -14     
- Misses       13808   13822     +14     
Files with missing lines Coverage Δ
include/xrpl/basics/CountedObject.h 100.0% <ø> (ø)
include/xrpl/basics/IntrusivePointer.h 91.7% <ø> (ø)
include/xrpl/basics/IntrusiveRefCounts.h 92.7% <ø> (ø)
include/xrpl/ledger/LedgerTiming.h 90.9% <100.0%> (ø)
include/xrpl/protocol/AccountID.h 61.5% <ø> (ø)
include/xrpl/protocol/ErrorCodes.h 100.0% <ø> (ø)
include/xrpl/protocol/Feature.h 97.8% <ø> (ø)
include/xrpl/protocol/STAccount.h 84.6% <ø> (ø)
include/xrpl/protocol/SecretKey.h 66.7% <ø> (ø)
include/xrpl/protocol/Seed.h 100.0% <ø> (ø)
... and 39 more

... and 6 files with indirect coverage changes

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bthomee bthomee requested review from dangell7 and legleux March 26, 2026 21:40
Copy link
Contributor

@xrplf-ai-reviewer xrplf-ai-reviewer bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two correctness issues flagged inline: unverified repo URL rename in docs, and a broken path exclusion in the rename script.

Review by Claude Opus 4.6 · Prompt: V12

5. Add the appropriate Ripple 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" | \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verify xrpld-deb/xrpld-rpm repo URLs are live before merging — broken URLs will cause install failures for users.

exit 1
fi

find "${DIRECTORY}" -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exclusion path is CWD-relative but find uses ${DIRECTORY} — when DIRECTORY isn't ., the exclusion silently fails and the script processes its own source files.

Suggested change
find "${DIRECTORY}" -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
find "${DIRECTORY}" -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 "${DIRECTORY}/.github/scripts/*" | while read -r FILE; do

Copy link
Contributor

@xrplf-ai-reviewer xrplf-ai-reviewer bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues.

Review by Claude Opus 4.6 · Prompt: V12

@bthomee bthomee mentioned this pull request Mar 27, 2026
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant