Skip to content

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

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

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

Conversation

@bthomee
Copy link
Copy Markdown
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 directSendNoFee, directSendNoFeeIOU, and directSendNoFeeMPT, resp.
  • rippleSendIOU, rippleSendMultiIOU, rippleSendMPT, and rippleSendMultiMPT to directSendNoLimitIOU, directSendNoLimitMultiIOU, directSendNoLimitMPT, and directSendNoLimitMultiMPT, 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
Copy Markdown
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

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 26, 2026

Codecov Report

❌ Patch coverage is 86.30137% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.4%. Comparing base (3d9c545) to head (27e0e8f).

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          999     999             
  Lines        74456   74457      +1     
  Branches      7559    7559             
=========================================
- Hits         60651   60644      -7     
- Misses       13805   13813      +8     
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/basics/random.h 100.0% <ø> (ø)
include/xrpl/ledger/LedgerTiming.h 90.9% <100.0%> (ø)
include/xrpl/ledger/View.h 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/PublicKey.h 80.5% <ø> (ø)
... and 49 more

... and 2 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
Copy Markdown
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

Copy link
Copy Markdown
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
Copy link
Copy Markdown
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.

Several correctness bugs flagged inline: sed alternation patterns are no-ops without -E (lines 41-47 of docs.sh), a typo makes one pattern unmatchable, the namespace.sh replacement corrupts config section strings, and two documentation paths/URLs are broken (/etc/opt/ for a binary, dead XRPLF/xrpld links). Also worth confirming the renamed package repo URLs are live before merging.

Review by Claude Opus 4.6 · Prompt: V12

Copy link
Copy Markdown
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.

Several correctness issues flagged inline: two regex bugs in docs.sh (unintended character-class range on line 35, word-boundary missing on line 48), an asymmetric colon in namespace.sh line 44, a cert/script O= mismatch in TrustedPublisherServer.h, a grammar nit in xrpld-example.cfg, and unverified live URLs in install.md.

Review by Claude Opus 4.6 · Prompt: V12

Copy link
Copy Markdown
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 over-broad TSan suppressions lost their namespace qualifier (should be xrpl::) — see inline. A colon-count mismatch in the rename script will silently misfire. Install docs reference renamed infra URLs that will break users if not yet live.


Review by ReviewBot 🤖

Review by Claude Opus 4.6 · Prompt: V12

@bthomee bthomee requested a review from legleux March 27, 2026 21:49
Copy link
Copy Markdown
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.

Critical sed bug in namespace.sh corrupts URI string literals (line 44). Functional install URLs/package names changed in docs without confirmed infra readiness. TSAN suppressions lost their namespace qualifiers. See inline comments.

Review by Claude Opus 4.6 · Prompt: V12

Copy link
Copy Markdown
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.

Several real bugs found — see inline comments. The namespace.sh sed command introduces an extra colon into string literals (high severity). TSAN suppressions dropped namespace qualifiers instead of updating them, making them overly broad. Package repo URLs need infrastructure verification before merging.

Review by Claude Opus 4.6 · Prompt: V12

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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Inconsistent capitalization in proper noun — consensus should be capitalized to match "XRPL Consensus Ledger" (same issue on line 59):

Suggested change
detailed mechanics of the XRPL consensus Ledger. Most notably, the algorithm
detailed mechanics of the XRPL Consensus Ledger. Most notably, the algorithm

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.

2 participants