fix(sdk): maybe add proof node

[smartcontracts]

Description
Fixes a bug in the SDK that would cause it to be unable to prove certain types of withdrawals. Bug can be easily fixed on the client side by adding an extra proof element in certain cases.

Tests

Adds a test for the case where a node is added and for the case where a node does not need to be added.

[coderabbitai]

Warning

Rate Limit Exceeded

@smartcontracts has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 24 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 416cdcc and d11e89d.

Walkthrough

The update encompasses a crucial patch for @eth-optimism/sdk to rectify issues with proof submission failures. Additionally, a significant enhancement includes the implementation of the maybeAddProofNode function within merkle-utils.ts, aimed at adjusting Merkle proofs when the final element is less than 32 bytes and situated within a branch node. This function ensures the integrity of the proof. Furthermore, new tests in merkle-utils.spec.ts verify the functionality of maybeAddProofNode across various Merkle proof adjustment scenarios.

Changes

File Path	Change Summary
.changeset/soft-pants-change.md	Introduces a patch for @eth-optimism/sdk addressing proof submission reverts.
packages/sdk/src/utils/.../merkle-utils.ts	Adds maybeAddProofNode function to modify Merkle proofs under specific conditions.
packages/sdk/test/utils/.../merkle-utils.spec.ts	Includes new tests for maybeAddProofNode function, testing scenarios of adding a proof node.

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

• 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>.
  • Generate unit-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[codecov]

Codecov Report

Attention: Patch coverage is 92.30769% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 40.75%. Comparing base (416cdcc) to head (d11e89d).

Additional details and impacted files

@@             Coverage Diff              @@
##           develop    #9663       +/-   ##
============================================
+ Coverage    28.62%   40.75%   +12.13%     
============================================
  Files          162       27      -135     
  Lines         7131     1742     -5389     
  Branches      1306      398      -908     
============================================
- Hits          2041      710     -1331     
+ Misses        4984     1032     -3952     
+ Partials       106        0      -106     

Flag	Coverage Δ
cannon-go-tests	?
chain-mon-tests	27.14% <ø> (ø)
common-ts-tests	?
contracts-bedrock-tests	?
contracts-ts-tests	?
core-utils-tests	?
sdk-next-tests	41.94% <92.30%> (+0.41%)	⬆️
sdk-tests	41.94% <92.30%> (+0.41%)	⬆️

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

Files	Coverage Δ
packages/sdk/src/utils/merkle-utils.ts	50.00% <92.30%> (+26.19%)	⬆️

... and 135 files with indirect coverage changes

[roninjin10]

This is going over my head what bug this pr is fixing. Can you ELI5?