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

fix variable name $PRIVATE_KEY #1164

Merged
merged 2 commits into from
Dec 6, 2024
Merged

Conversation

plamarque
Copy link
Contributor

@plamarque plamarque commented Dec 6, 2024

Description

Before this fix, the script referred to the private key in variable named $PRIVATE_KEY while it's declared as $TUTORIAL_PRIVATE_KEY at the beginning of the tutorial.

Hence, the code snippet won't work for someone following the whole tutorial from beginning to end.

This change replaces the variable in the snippet to be $TUTORIAL_PRIVATE_KEY so it can be copy-pasted and work.

Additional context

Metadata

before this fix, the script revered to the private key in variable named $PRIVATE_KEY.

This made the snippet to not work is following the whole tutorial at https://docs.optimism.io/builders/app-developers/tutorials/cross-dom-bridge-erc20 where private key is declared under a different name

This change updates the variable name so the tutorial can work end to end by copy-pasting code snippets

fixes ethereum-optimism#1163
@plamarque plamarque requested a review from a team as a code owner December 6, 2024 15:25
Copy link

netlify bot commented Dec 6, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit f120d5c
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/67531a6924e33d0008bc2cda
😎 Deploy Preview https://deploy-preview-1164--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces a modification in the script located at public/tutorials/standard-bridge-standard-token.sh. Specifically, the environment variable used for the private key in a transaction command has been changed from $PRIVATE_KEY to $TUTORIAL_PRIVATE_KEY. This adjustment affects the command executed by cast send, which is responsible for creating an Optimism Mintable ERC20 token. The change is intended to correct an error identified in the linked issue, ensuring that the correct private key variable is utilized for the transaction execution.

Assessment against linked issues

Objective Addressed Explanation
Correct the variable from $PRIVATE_KEY to $TUTORIAL_PRIVATE_KEY (#1163)

Suggested reviewers

  • krofax
  • bradleycamacho

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 19fa26b and f120d5c.

📒 Files selected for processing (1)
  • pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
🔇 Additional comments (1)
pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx (1)

91-91: LGTM! Variable name correctly updated.

The change from $PRIVATE_KEY to $TUTORIAL_PRIVATE_KEY aligns with the variable declaration earlier in the tutorial, fixing the inconsistency reported in issue #1163. This update ensures users can successfully execute the commands when following the tutorial from start to finish.


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>, 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 @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 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 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 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.

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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
public/tutorials/standard-bridge-standard-token.sh (1)

6-6: Consider adding a comment explaining the command's purpose.

The cast send command performs a critical operation (creating an Optimism Mintable ERC20 token), but its purpose isn't immediately clear from the code. Consider adding a comment explaining what this command does and what the output represents.

+# Create an Optimism Mintable ERC20 token and extract the deployed token address from the logs
 cast send 0x4200000000000000000000000000000000000012 "createOptimismMintableERC20(address,string,string)" $TUTORIAL_L1_ERC20_ADDRESS "My Standard Demo Token" "L2TKN" --private-key $TUTORIAL_PRIVATE_KEY --rpc-url $TUTORIAL_RPC_URL --json | jq -r '.logs[0].topics[2]' | cast parse-bytes32-address
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 84ec35a and 19fa26b.

📒 Files selected for processing (1)
  • public/tutorials/standard-bridge-standard-token.sh (1 hunks)
🔇 Additional comments (1)
public/tutorials/standard-bridge-standard-token.sh (1)

6-6: LGTM! Variable name now matches tutorial declaration.

The change from $PRIVATE_KEY to $TUTORIAL_PRIVATE_KEY correctly aligns with the variable declared at the beginning of the tutorial, fixing the inconsistency reported in issue #1163.

updates the hash related to standard-bridge-standard-token.sh following change for ethereum-optimism#1163
@krofax krofax merged commit 96ec3ad into ethereum-optimism:main Dec 6, 2024
6 of 7 checks passed
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.

Feedback for “Bridging your standard ERC-20 token using the Standard Bridge”
2 participants