Hanan/await tx

[HananINouman]

Summary by CodeRabbit

• Bug Fixes

  • Improved the process for obtaining transaction receipts during withdrawal requests to ensure more reliable handling.

• Tests

  • Added a test case to verify correct behavior when a withdrawal request returns a null transaction hash.

[coderabbitai]

Walkthrough

The pull request updates the submitEOAWithdrawalRequest function to obtain the transaction receipt using tx.wait() instead of provider.getTransactionReceipt. Additionally, a new test case is added to verify the function's behavior when it returns an object with a null txHash.

Changes

Cohort / File(s)	Change Summary
EOA Withdrawal Helper Logic src/eoa/eoaHelpers.ts	Refactored receipt retrieval in submitEOAWithdrawalRequest to use tx.wait() instead of provider.getTransactionReceipt.
EOA Withdrawal Tests test/eoa/eoa.spec.ts	Added a test case for handling a { txHash: null } response from submitEOAWithdrawalRequest.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant EOAHelpers
    participant Signer
    participant Transaction

    Caller->>EOAHelpers: submitEOAWithdrawalRequest()
    EOAHelpers->>Signer: sendTransaction()
    Signer-->>EOAHelpers: tx (Transaction object)
    EOAHelpers->>Transaction: wait()
    Transaction-->>EOAHelpers: receipt
    EOAHelpers-->>Caller: { txHash: receipt?.transactionHash || null }

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

• Hanan/eoa withdrawal #135: Directly related as it introduced the submitEOAWithdrawalRequest function, which is modified in this PR.

Suggested reviewers

• agaskrobot

Poem

A rabbit hopped through helpers' code,
Awaiting receipts on the blockchain road.
With tx.wait() now the way,
Tests ensure things don't go astray.
If txHash is null, don't fear—
The logic and tests are crystal clear!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1290d82 and f8accb3.

📒 Files selected for processing (2)

• src/eoa/eoaHelpers.ts (1 hunks)
• test/eoa/eoa.spec.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/eoa/eoaHelpers.ts (3)

test/sdk-package/utils.ts (1)

• signer (16-16)

src/eoa/eoa.ts (2)

• requestWithdrawal (58-93)
• EOA (19-94)

src/splits/splits.ts (1)

• requestWithdrawal (434-453)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build

🔇 Additional comments (2)

src/eoa/eoaHelpers.ts (1)

32-41: Excellent improvement to transaction handling!

The change from provider.getTransactionReceipt(hash) to tx.wait() is a significant improvement:

• tx.wait() automatically waits for transaction confirmation rather than just checking if a receipt exists
• This approach is more reliable and follows blockchain development best practices
• The null handling correctly accounts for edge cases where tx.wait() might return null

test/eoa/eoa.spec.ts (1)

114-133: Excellent test coverage for the null txHash scenario!

This test case provides valuable coverage for the edge case where transaction receipts might be null, ensuring the updated transaction handling logic works correctly. The test follows the established testing patterns and properly validates the expected behavior.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch Hanan/await-tx

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

CodeRabbit Configuration 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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud