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

sdk: decouple from contracts-bedrock #10258

Merged
merged 3 commits into from
Apr 23, 2024
Merged

sdk: decouple from contracts-bedrock #10258

merged 3 commits into from
Apr 23, 2024

Conversation

tynes
Copy link
Contributor

@tynes tynes commented Apr 22, 2024

Description

Decouples the sdk from contracts-bedrock to enable
it to easily be moved out of the monorepo.

The foundry artifacts are build from 3fc229e and then
copy/pasted into the sdk. There are no large breaking changes
planned which is why this is safe to do. This sdk has already
been replaced by viem and in the future a Go sdk can be broken
out of the op-e2e package to serve as the reference implementation
of a sdk.

The typescript sdk will be subject to just work until new breaking
changes are introduced but at that point we should have sufficient
migration to the alternative solutions.

Decouples the sdk from `contracts-bedrock` to enable
it to easily be moved out of the monorepo.

The foundry artifacts are build from 3fc229e and then
copy/pasted into the sdk. There are no large breaking changes
planned which is why this is safe to do. This sdk has already
been replaced by viem and in the future a Go sdk can be broken
out of the `op-e2e` package to serve as the reference implementation
of a sdk.

The typescript sdk will be subject to just work until new breaking
changes are introduced but at that point we should have sufficient
migration to the alternative solutions.
@tynes tynes requested a review from a team as a code owner April 22, 2024 22:26
Copy link
Contributor

coderabbitai bot commented Apr 22, 2024

Walkthrough

This update involves modifying the import paths in several files within an SDK project. The changes switch from absolute to relative import paths, enhancing modularity and improving the maintainability of the codebase. This adjustment affects files related to both Ethereum (ETH) and ERC-20 token deposits.

Changes

Files Change Summary
.../standard-bridge.ts, .../deposit-eth.ts Updated import paths from absolute to relative.
.../contracts.ts, .../deposit-erc20.ts Updated import paths from absolute to relative.

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.

Copy link

codecov bot commented Apr 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 42.40%. Comparing base (3fc229e) to head (f7422cf).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop   #10258   +/-   ##
========================================
  Coverage    42.40%   42.40%           
========================================
  Files           73       73           
  Lines         4830     4830           
  Branches       766      766           
========================================
  Hits          2048     2048           
  Misses        2676     2676           
  Partials       106      106           
Flag Coverage Δ
cannon-go-tests 82.29% <ø> (ø)
chain-mon-tests 27.14% <ø> (ø)
common-ts-tests 26.72% <ø> (ø)
contracts-ts-tests 12.25% <ø> (ø)
core-utils-tests 44.03% <ø> (ø)
sdk-tests 40.27% <100.00%> (ø)

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

Files Coverage Δ
packages/sdk/src/adapters/standard-bridge.ts 27.36% <100.00%> (ø)
packages/sdk/src/utils/contracts.ts 80.15% <100.00%> (ø)
packages/sdk/tasks/deposit-erc20.ts 10.52% <100.00%> (ø)
packages/sdk/tasks/deposit-eth.ts 8.37% <100.00%> (ø)

Copy link
Member

@nickbalestra nickbalestra left a comment

Choose a reason for hiding this comment

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

Thanks @tynes !

@tynes tynes enabled auto-merge April 22, 2024 22:59
@tynes tynes added this pull request to the merge queue Apr 22, 2024
Merged via the queue into develop with commit 53afefd Apr 23, 2024
75 checks passed
@tynes tynes deleted the feat/sdk-decouple branch April 23, 2024 00:05
nitaliano pushed a commit that referenced this pull request May 20, 2024
* sdk: decouple from contracts-bedrock

Decouples the sdk from `contracts-bedrock` to enable
it to easily be moved out of the monorepo.

The foundry artifacts are build from 3fc229e and then
copy/pasted into the sdk. There are no large breaking changes
planned which is why this is safe to do. This sdk has already
been replaced by viem and in the future a Go sdk can be broken
out of the `op-e2e` package to serve as the reference implementation
of a sdk.

The typescript sdk will be subject to just work until new breaking
changes are introduced but at that point we should have sufficient
migration to the alternative solutions.

* sdk: remove dead dep

* deps: fix pnpm lock
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