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.

Sign up for GitHub

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

Jump to bottom

Update cross-chain-messenger.ts - Deposits some CustomGas-ERC20 token… #10469

Closed
wants to merge 1 commit into from
Closed

Update cross-chain-messenger.ts - Deposits some CustomGas-ERC20 token… #10469

wants to merge 1 commit into from

Conversation

nidz-the-fact
Copy link

Deposits some CustomGas-ERC20 tokens into the L2 Native chain. (Version - Testing)

Do not use approve, approveERC20 because it must be retrieved. getBridgeForTokenPair Request to add first
Therefore use approval from Token directly to avoid getBridgeForTokenPair For this test function: "depositERC20Transaction" (OptimismPortalProxy)
Clone: https://github.com/nidz-the-fact/op-stack-bridge-Testing-erc20-to-native

Repo: https://github.com/nidz-the-fact
Team ThaiChain Foundation (https://www.thaichain.io)

@title Deposits some CustomGas-ERC20 tokens into the L2 Native chain. (Version - Testing)
@notice Version - Testing = Therefore use approval from Token directly to avoid getBridgeForTokenPair For this test function: "depositERC20Transaction" (OptimismPortalProxy)

@nidz-the-fact
Update cross-chain-messenger.ts - Deposits some CustomGas-ERC20 token…
cd3a0cc 
…s into the L2 Native chain. (Version - Testing)

Deposits some CustomGas-ERC20 tokens into the L2 Native chain. (Version - Testing)

Do not use approve, approveERC20 because it must be retrieved. getBridgeForTokenPair Request to add first 
Therefore use approval from Token directly to avoid getBridgeForTokenPair For this test function: "depositERC20Transaction" (OptimismPortalProxy)
Clone: https://github.com/nidz-the-fact/op-stack-bridge-Testing-erc20-to-native

Repo: https://github.com/nidz-the-fact
Team ThaiChain Foundation (https://www.thaichain.io)


@title Deposits some CustomGas-ERC20 tokens into the L2 Native chain. (Version - Testing)
@notice Version - Testing = Therefore use approval from Token directly to avoid getBridgeForTokenPair For this test function: "depositERC20Transaction" (OptimismPortalProxy)
@nidz-the-fact nidz-the-fact requested a review from a team as a code owner May 9, 2024 16:15
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 9, 2024 •
edited

Walkthrough

Walkthrough

The recent updates involve enhancements to the CrossChainMessenger class in the SDK, specifically around ERC20 token transactions. New methods for depositing and withdrawing ERC20 tokens have been added, along with modifications to their signatures to accommodate additional parameters. This includes the importation of BigNumberish and BytesLike types from 'ethers' to handle these transactions more effectively.

Changes

File Path Change Summary
.../src/cross-chain-messenger.ts Added imports; Added and modified methods for ERC20 transactions (depositERC20Transaction, withdrawERC20Transaction) with new parameters and async arrow functions.
Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 4854ed9 and cd3a0cc.
Files selected for processing (1)
  • packages/sdk/src/cross-chain-messenger.ts (7 hunks)
Additional comments not posted (3)
packages/sdk/src/cross-chain-messenger.ts (3)

80-81: Imports of BigNumberish and BytesLike from 'ethers' are appropriate as these types are used in the newly added methods for handling numeric and binary data.

2141-2184: The method depositERC20Transaction simplifies the deposit process by not requiring a bridge pair retrieval. This aligns with the PR's objective to streamline testing. Ensure that the bypassing of getBridgeForTokenPair does not introduce any security or functional issues in the testing environment.

Verification successful

The method depositERC20Transaction in the cross-chain-messenger.ts file bypasses the getBridgeForTokenPair function as part of a testing simplification. A search for related issues or pull requests did not return any results, indicating that no problems have been reported concerning this change. However, it is important to remain vigilant as the absence of reported issues does not guarantee that there are no underlying problems that have not yet been identified or reported.

  • Continue to monitor for any future reports or feedback related to this change.
  • Consider additional testing or review to ensure that bypassing getBridgeForTokenPair does not introduce security or functional issues in the testing environment.
Scripts Executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that bypassing `getBridgeForTokenPair` does not introduce issues.

# Test: Search for any issues reported in issues or pull requests related to this change.
gh issue list --search "bypassing getBridgeForTokenPair in depositERC20Transaction introduces issues"

Length of output: 103

2187-2209: The method withdrawERC20Transaction correctly handles the withdrawal of ERC20 tokens back to the L1 chain. This method is necessary for testing the full cycle of deposit and withdrawal in a controlled environment.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@codecov Codecov
Copy link

codecov bot commented May 9, 2024 •
edited

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.39%. Comparing base (1c33c39) to head (cd3a0cc).
Report is 4 commits behind head on develop.

Additional details and impacted files 
@@             Coverage Diff             @@
##           develop   #10469      +/-   ##
===========================================
+ Coverage    42.31%   43.39%   +1.08%     
===========================================
  Files           73       50      -23     
  Lines         4838     3157    -1681     
  Branches       766      363     -403     
===========================================
- Hits          2047     1370     -677     
+ Misses        2682     1678    -1004     
  Partials       109      109
Flag Coverage Δ
cannon-go-tests 81.59% <ø> (ø)
chain-mon-tests 27.14% <ø> (ø)
common-ts-tests 26.72% <ø> (ø)
contracts-ts-tests 12.25% <ø> (ø)
core-utils-tests 44.03% <ø> (ø)
sdk-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

see 23 files with indirect coverage changes

@tynes
Copy link
Contributor

tynes commented May 9, 2024

Thank you for opening this PR @nidz-the-fact! Unfortunately we are not maintaining the sdk anymore, I recommend checking out the following discussion in viem: wevm/viem#2197

@tynes tynes closed this May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@nidz-the-fact @tynes