Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove bridge snippet test, the sidechain has been shut down #2773

Merged
merged 6 commits into from
Sep 26, 2024

Conversation

ckeshava
Copy link
Collaborator

@ckeshava ckeshava commented Sep 9, 2024

High Level Overview of Change

The sidechain devnet (https://sidechain-net2.devnet.rippletest.net:51234/) has been shutdown. This PR removes the snippet pertaining to XChainBridge examples.

The CI/CD pipeline has been failing with errors. Here's an example: https://github.com/XRPLF/xrpl-py/actions/runs/10410149343/job/29898229766#step:8:168

Context of Change

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Tests (You added tests for code that already exists, or your new feature included in this PR)
  • Documentation Updates
  • Release

Did you update HISTORY.md?

  • Yes
  • No, this change does not impact library users

Test Plan

Summary by CodeRabbit

  • New Features

    • Updated cross-currency transaction setup for improved testing scenarios on the XRPL.
    • Introduced a simplified command for pathfinding requests.
  • Bug Fixes

    • Removed outdated bridge transfer functionality to streamline operations.
  • Documentation

    • Added comments to clarify prerequisites for using the updated snippet.

@justinr1234
Copy link
Collaborator

@CodeRabbit full review

@justinr1234
Copy link
Collaborator

@coderabbitai full review

Copy link

coderabbitai bot commented Sep 19, 2024

Actions performed

Full review triggered.

Copy link

coderabbitai bot commented Sep 19, 2024

Walkthrough

The pull request introduces significant changes to the XRPL codebase, including the removal of the bridgeTransfer.ts file, which handled cross-chain fund transfers. Additionally, the paths.ts file has been modified to enhance the createTxWithPaths function, updating the destination account and currency for cross-currency transactions, and simplifying the pathfinding command. These alterations streamline the code and align it with current XRPL specifications.

Changes

File Path Change Summary
packages/xrpl/snippets/src/bridgeTransfer.ts Removed the bridgeTransfer function that facilitated fund transfers between blockchain networks.
packages/xrpl/snippets/src/paths.ts Updated createTxWithPaths to modify the destination account and currency, simplified the pathfinding command, and added comments for test network prerequisites.

Poem

In the land of code where rabbits play,
Changes hop in, brightening the day.
Funds once bridged now take a new route,
With paths simplified, there's no doubt!
Hooray for the tweaks, let the tests begin,
A dance of transactions, let the fun spin! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ckeshava ckeshava mentioned this pull request Sep 19, 2024
9 tasks
@ckeshava ckeshava merged commit 8992d39 into XRPLF:main Sep 26, 2024
13 checks passed
ckeshava added a commit to ckeshava/xrpl.js that referenced this pull request Oct 3, 2024
)

* update Paths snippet test: perform prerequisite test setup within the test, remove dependence on theexternal state of testnet

* remove bridge snippet test, the sidechain has been shut down

* [FIX] Update paths snippet. Replace RipplePathFind with PathFind RPC (fixes XRPLF#2385)
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.

4 participants