ethereum-optimism
Tracing Deposits and Withdrawals
Description
This tutorial explains how you can use the Viem race a deposit or withdrawal transaction between L1 and L2. It deprecates the Optimism SDK.
Tests
Additional context
Metadata
- Fixes https://github.com/ethereum-optimism/devrel/issues/257
Deploy Preview for docs-optimism ready!
| Name | Link |
|---|---|
| Latest commit | 400306c92c4cf8ff1499d32ebc06dc2520773d5c |
| Latest deploy log | https://app.netlify.com/sites/docs-optimism/deploys/672cb779f1637d0008bec4e9 |
| Deploy Preview | https://deploy-preview-966--docs-optimism.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Walkthrough
The pull request updates documentation and code to transition from the "Optimism SDK" to the "viem" library. The tutorial content has been revised to instruct users on utilizing the viem library for tracing transactions between Layer 1 and Layer 2. Additionally, JavaScript scripts have been modified to replace SDK-specific functions and providers with their viem counterparts. The words.txt file has also been updated to standardize terminology and introduce new terms relevant to the context.
Changes
| File Path | Change Summary |
|---|---|
| pages/builders/app-developers/tutorials/sdk-trace-txns.mdx | Updated references from "Optimism SDK" to "viem" library, revised tutorial content accordingly. |
| public/tutorials/sdk-trace-txns.js | Replaced @eth-optimism/sdk and ethers with viem, updated client instances and method calls. |
| words.txt | Normalized case of existing terms, added new terms, and standardized terminology. |
Possibly related issues
- ethereum-optimism/docs#594: This issue involves rewriting a tutorial for viem, which aligns with the changes made in this PR.
- ethereum-optimism/docs#593: Similar to the previous issue, this also pertains to updating a tutorial for viem.
- ethereum-optimism/docs#595: This issue focuses on updating a tutorial for estimating transaction costs with viem, relevant to the changes in this PR.
- ethereum-optimism/docs#596: This issue addresses the need to update a tutorial for chain operators to viem.
- ethereum-optimism/docs#597: This issue pertains to updating a tutorial for communicating between chains in Solidity to viem.
Possibly related PRs
- #906: Updates a tutorial to use the Viem library for bridging ETH, similar to the main PR's focus.
- #913: Transitions from the Optimism SDK to Viem for estimating transaction costs, directly related to this PR.
- #936: Revises a tutorial to replace the Optimism SDK with Viem, aligning with this PR's updates.
- #989: Updates a tutorial to use Viem for cross-domain messaging in Solidity contracts, relevant to this PR.
- #1025: Discusses the deprecation of the Optimism SDK in favor of the Viem library, directly related to this PR.
- #1064: Updates documentation for Viem, reinforcing the transition made in this PR.
- #1065: Confirms the use of Viem in a tutorial, aligning with this PR's updates.
Suggested reviewers
- brokewhale
- ZakAyesh
- cpengilly
📜 Recent review details
Configuration used: .coderabbit.yaml Review profile: CHILL
📥 Commits
Reviewing files that changed from the base of the PR and between 3a0a9bb72ad4b9b0a02b6d80ecfa50a07e9c2ebf and 400306c92c4cf8ff1499d32ebc06dc2520773d5c.
📒 Files selected for processing (1)
-
pages/builders/app-developers/tutorials/sdk-trace-txns.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/builders/app-developers/tutorials/sdk-trace-txns.mdx
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere 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.
![coderabbitai[bot] avatar](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}
For all of these tutorials usually there is a step for running the command mkdir op-sample-project if we assume that developers go through a couple of these they may have trouble creating the directories since they will have to overwrite their old one. Can we name the directories something based on the content of the tutorial. Like for this one:
mkdir op-tracing-tutorial
For all of these tutorials usually there is a step for running the command
mkdir op-sample-projectif we assume that developers go through a couple of these they may have trouble creating the directories since they will have to overwrite their old one. Can we name the directories something based on the content of the tutorial. Like for this one:
mkdir op-tracing-tutorial
@ZakAyesh Updated the tut, can you take a second review?