docs
docs copied to clipboard
Estimate cost tut
Description
This tutorial explains how estimate transaction costs on OP Sepolia using Viem
Tests
Please describe any tests you've added. If you've added no tests, or left important behavior untested, please explain why not.
Additional context
Add any other context about the problem you're solving.
Metadata
- Fixes https://github.com/ethereum-optimism/devrel/issues/256
[!WARNING]
Rate limit exceeded
@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 48 seconds before requesting another review.
⌛ How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the
@coderabbitai reviewcommand 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 9801f242ea53cfce1e332383d0f1f2dc442e7660 and 792a49ff2c6c7fb339024470a48193f35340b39d.
Walkthrough
The changes involve significant updates to the tutorial on estimating transaction costs, transitioning from the Optimism SDK to the Viem library. The document now includes new sections detailing Viem's compatibility with Superchain networks and reorganizes tutorial steps for clarity. The sdk-estimate-costs.js file has been refactored to utilize the Viem library for Ethereum interactions, including new transaction cost estimation logic. Additionally, the words.txt file has been modified to remove the entry "Fastnode," resulting in a reduced list of terms.
Changes
| File(s) | Change Summary |
|---|---|
| pages/builders/app-developers/tutorials/... | Updated to reflect the transition from the Optimism SDK to the Viem library, including changes to prerequisites, tutorial steps, and transaction cost estimation methods. |
| public/tutorials/sdk-estimate-costs.js | Refactored to utilize the Viem library for Ethereum interactions, including new transaction cost estimation logic and improved error handling. |
| words.txt | Removed the entry "Fastnode" from the list of terms, reducing the total number of terms. |
Possibly related issues
- ethereum-optimism/docs#595: This PR addresses the objective of updating SDK tutorials to use the Viem library, as the Optimism SDK is in maintenance mode.
Possibly related PRs
- #928: This PR discusses the deprecation of the Optimism SDK and the transition to the
viemlibrary, aligning with the main PR's emphasis on Viem for estimating transaction costs. - #965: Although this PR primarily focuses on minor updates to the fjord calculator, it is part of the broader context of tools and documentation that may be affected by the transition to Viem, making it somewhat relevant.
- #986: This PR introduces the SuperchainERC20 Token Standard, which is part of the evolving ecosystem that includes the Viem library and its functionalities, thus connecting it to the main PR's changes regarding transaction cost estimation.
Suggested labels
flag:merge-pending-release
Suggested reviewers
- cpengilly
- nitaliano
- bradleycamacho
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.
Deploy Preview for docs-optimism ready!
| Name | Link |
|---|---|
| Latest commit | 792a49ff2c6c7fb339024470a48193f35340b39d |
| Latest deploy log | https://app.netlify.com/sites/docs-optimism/deploys/671bae563b0a59000878ae01 |
| Deploy Preview | https://deploy-preview-913--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.
Can we also deprecate this page (or point it to this tutorial?) https://docs.optimism.io/builders/app-developers/transactions/estimates
It will be confusing to have 2 different tutorials in 2 different places for the same thing
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-est-cost-tutorial
For estimating the combined gas fee should we pushing the users to utilize this method in Viem? https://viem.sh/op-stack/actions/estimateTotalFee
This seems like it would be a much easier DevEx than adding the individual estimations.
This is a great point, i'll update the codebase.
Can we also deprecate this page (or point it to this tutorial?) https://docs.optimism.io/builders/app-developers/transactions/estimates
It will be confusing to have 2 different tutorials in 2 different places for the same thing
@ZakAyesh Thanks for the suggestion, i've updated the codebase