Artela EVM++ Tutorial #436
Conversation
WalkthroughThe changes introduce a new section titled "EVM++" in the sidebar configuration of the Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range, codebase verification and nitpick comments (1)
tutorials/artela-evm-plus-plus.md (1)
90-90: Consider alternative wording.Consider using "profound" instead of "deeper" for stronger wording.
-If you want to gain a deeper understanding of Aspect’s capabilities and limitations to fully grasp how it can enhance or constrain your project, make sure not to overlook these essential concepts: +If you want to gain a profound understanding of Aspect’s capabilities and limitations to fully grasp how it can enhance or constrain your project, make sure not to overlook these essential concepts:Tools
LanguageTool
[style] ~90-~90: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (3)
package-lock.jsonis excluded by!**/package-lock.jsonpublic/evmpp/evmpp.pngis excluded by!**/*.pngyarn.lockis excluded by!**/yarn.lock,!**/*.lock
Files selected for processing (2)
- .vitepress/config.ts (1 hunks)
- tutorials/artela-evm-plus-plus.md (1 hunks)
Additional context used
LanguageTool
tutorials/artela-evm-plus-plus.md
[misspelling] ~7-~7: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...guide will assist you to quickly set up an rollup node with [Artela EVM++](https:/...(EN_A_VS_AN)
[style] ~90-~90: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Markdownlint
tutorials/artela-evm-plus-plus.md
92-92: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
93-93: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
94-94: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
95-95: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
96-96: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
104-104: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
105-105: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
106-106: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
110-110: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
111-111: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
83-83: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
84-84: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
85-85: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
Gitleaks
tutorials/artela-evm-plus-plus.md
67-68: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
Additional comments not posted (4)
tutorials/artela-evm-plus-plus.md (3)
13-20: LGTM!The instructions for cloning the repository are clear and correct.
22-47: LGTM!The instructions for running the Artela rollup node with Docker Compose are clear and correct.
114-126: LGTM!The instructions for stopping the node and the conclusion are clear and correct.
.vitepress/config.ts (1)
251-269: LGTM!The changes to the sidebar configuration are well-structured and improve the organization of the sidebar.
There was a problem hiding this comment.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/artela-evm-plus-plus.md (1 hunks)
Additional context used
Learnings (1)
tutorials/artela-evm-plus-plus.md (1)
Learnt from: dumbeng PR: rollkit/docs#436 File: tutorials/artela-evm-plus-plus.md:49-69 Timestamp: 2024-08-27T02:42:42.659Z Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.
LanguageTool
tutorials/artela-evm-plus-plus.md
[style] ~90-~90: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Markdownlint
tutorials/artela-evm-plus-plus.md
92-92: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
93-93: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
94-94: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
95-95: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
96-96: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
104-104: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
105-105: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
106-106: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
110-110: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
111-111: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
Gitleaks
tutorials/artela-evm-plus-plus.md
67-68: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
Additional comments not posted (5)
tutorials/artela-evm-plus-plus.md (5)
1-11: LGTM!The introduction is clear and concise.
The content is approved.
13-20: LGTM!The instructions for cloning the repository are clear and correct.
The content is approved.
22-47: LGTM!The instructions for running the Artela rollup node with Docker Compose are clear and correct.
The content is approved.
114-126: LGTM!The instructions for stopping the node and the conclusion are clear and correct.
The content is approved.
73-86: Fix indentation issue.Correct the indentation of the unordered list.
- - Have a basic understanding of Artela technology. - - Have installed and played with Artela development tools. - - Understand how Aspect functions and its impact on making dApps distinct and superior. - - May already have numerous innovative ideas for building on Artela. + - Have a basic understanding of Artela technology. + - Have installed and played with Artela development tools. + - Understand how Aspect functions and its impact on making dApps distinct and superior. + - May already have numerous innovative ideas for building on Artela.The indentation of the unordered list needs to be corrected.
Likely invalid or redundant comment.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/artela-evm-plus-plus.md (1 hunks)
Additional context used
LanguageTool
tutorials/artela-evm-plus-plus.md
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...y your first smart contract on Artela. 👉 [Quick Start for Aspect on EVM++](https...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Additional comments not posted (8)
tutorials/artela-evm-plus-plus.md (8)
1-11: LGTM!The introduction section is clear and concise.
13-20: LGTM!The instructions for cloning the repository are clear and easy to follow.
22-47: LGTM!The instructions for running the node with Docker Compose are clear and easy to follow.
49-71: LGTM!The instructions for obtaining test accounts are clear and the issue of exposing a private key has been addressed.
73-114: LGTM!The instructions and links are clear and the issues with unordered list indentation and consistent list style have been addressed.
Tools
LanguageTool
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...y your first smart contract on Artela. 👉 [Quick Start for Aspect on EVM++](https...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
116-124: LGTM!The instructions for stopping the node are clear and easy to follow.
126-128: LGTM!The conclusion is clear and concise.
1-128: LGTM!The entire document is well-written and the issues have been addressed.
Tools
LanguageTool
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...y your first smart contract on Artela. 👉 [Quick Start for Aspect on EVM++](https...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
There was a problem hiding this comment.
My general impression is, that in this tutorial you're setting up rollkit based development environment and then use public testnet. I understand that docs on Artela website are generic, but this tutorial could include some steps on how to configure deploy.mjs file to actually use local dev env and rollkit.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/artela-evm-plus-plus.md (1 hunks)
Additional context used
LanguageTool
tutorials/artela-evm-plus-plus.md
[style] ~90-~90: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Additional comments not posted (7)
tutorials/artela-evm-plus-plus.md (7)
1-11: LGTM!The introductory section is clear and informative.
13-20: LGTM!The instructions for cloning the repository are clear and accurate.
22-47: LGTM!The instructions for running Docker Compose are clear and accurate.
49-71: LGTM!The instructions for getting prefunded test accounts are clear and accurate. The issue of exposing private keys has been addressed.
73-86: LGTM!The instructions and links for building on EVM++ are clear and accurate. The issues of indentation and list style consistency have been addressed.
88-96: LGTM!The links to additional resources are clear and accurate. The issue of list style consistency has been addressed.
Tools
LanguageTool
[style] ~90-~90: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
114-126: LGTM!The instructions for stopping the node are clear and accurate. The conclusion is well-written.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/artela-evm-plus-plus.md (1 hunks)
Additional context used
LanguageTool
tutorials/artela-evm-plus-plus.md
[style] ~94-~94: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Additional comments not posted (6)
tutorials/artela-evm-plus-plus.md (6)
1-10: LGTM!The introduction section is clear and provides the necessary context for the guide. The image helps to visually represent the content.
13-20: LGTM!The instructions for cloning the repository and navigating to the directory are clear and concise.
22-47: LGTM!The instructions for running the Artela rollup node with Docker Compose are clear and provide all necessary steps. The sample output helps users verify successful operation.
49-71: LGTM!The instructions for accessing testing accounts are clear and provide all necessary steps. The use of a placeholder for the private key is a good practice.
73-90: LGTM!The instructions and links for building on EVM++ are clear and provide valuable resources. The tip to replace the Artela Testnet node URL with the local node URL is helpful. The list of prerequisites is well-defined.
118-130: LGTM!The instructions for stopping the node are clear. The conclusion effectively summarizes the guide and reinforces the key points.
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/artela-evm-plus-plus.md (1 hunks)
Additional context used
LanguageTool
tutorials/artela-evm-plus-plus.md
[style] ~104-~104: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Markdownlint
tutorials/artela-evm-plus-plus.md
81-81: null
Bare URL used(MD034, no-bare-urls)
Additional comments not posted (3)
tutorials/artela-evm-plus-plus.md (3)
3-5: Clarify the usage of imported constants.The script tag imports constants from a JavaScript file, but there is no visible usage of these constants in the provided snippet. Can you clarify if these constants are used later in the tutorial? If not, consider removing the import to clean up the code.
22-47: Verify Docker commands and expected outputs.The Docker setup instructions are clear, but it's crucial to ensure that the commands and the expected outputs are accurate. Can you confirm if the provided Docker commands and the logs shown as expected outputs have been tested and are correct?
138-140: Well-Written Conclusion.The conclusion effectively summarizes the tutorial's achievements and provides a positive closure. Well done!
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
tutorials/artela-evm-plus-plus.md (1)
74-93: Improve URL Presentation in Tutorial Instructions.The instructions include a bare URL which could be improved for better readability and adherence to Markdown best practices. Consider embedding the URL within descriptive text or using Markdown link syntax to enhance the presentation and user experience.
Apply this diff to improve the URL presentation:
-1. Use https://github.com/artela-network/gm-portal.git instead of the original `gm-portal` repo. +1. Use [artela-network/gm-portal](https://github.com/artela-network/gm-portal.git) instead of the original `gm-portal` repo.Tools
Markdownlint
81-81: null
Bare URL used(MD034, no-bare-urls)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/artela-evm-plus-plus.md (1 hunks)
Additional context used
Learnings (1)
tutorials/artela-evm-plus-plus.md (2)
Learnt from: dumbeng PR: rollkit/docs#436 File: tutorials/artela-evm-plus-plus.md:49-69 Timestamp: 2024-08-27T02:42:42.659Z Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.Learnt from: dumbeng PR: rollkit/docs#436 File: tutorials/artela-evm-plus-plus.md:0-0 Timestamp: 2024-08-27T02:53:35.650Z Learning: Even testing private keys should be handled carefully in documentation to avoid promoting bad practices. It's better to use placeholders or provide instructions to generate new keys.
LanguageTool
tutorials/artela-evm-plus-plus.md
[style] ~104-~104: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
Markdownlint
tutorials/artela-evm-plus-plus.md
81-81: null
Bare URL used(MD034, no-bare-urls)
Additional comments not posted (6)
tutorials/artela-evm-plus-plus.md (6)
1-12: Introduction looks good!The introduction provides a clear overview of EVM++ and its capabilities. No changes are required.
13-20: Repository cloning instructions are accurate.The instructions to clone the Artela Rollkit repository are clear and accurate. No changes are required.
22-47: Docker Compose instructions are accurate.The instructions to run the Artela rollup node using Docker Compose are clear and accurate. No changes are required.
49-69: Security Concern: Display of Private Keys.It's generally not a good practice to display private keys directly in documentation, even for testing purposes. Consider using placeholders like
{YOUR_PRIVATE_KEY_HERE}and providing instructions on how users can generate their own keys. This approach enhances security practices and prevents accidental misuse.
102-110: "More to know" section looks good!The links to essential concepts are helpful for users to gain a deeper understanding of Aspect. The LanguageTool hint suggesting an alternative to "deeper" can be safely ignored as "deeper" is an appropriate adjective in this context.
Tools
LanguageTool
[style] ~104-~104: Consider an alternative adjective to strengthen your wording.
Context: ... 📖 More to know If you want to gain a deeper understanding of Aspect’s capabilities ...(DEEP_PROFOUND)
112-140: Remaining sections look good!The "Build with examples", "Stopping the Node", and "Conclusion" sections are clear, informative, and accurate. No changes are required.
Overview
Hello, Rollkit team! We are the buidlers from Artela. Recently we have integrated our EVM++ execution layer with Rollkit (👉 repo is here). Also that we have prepared a tutorial doc (in this PR) explaining how to setup an Artela rollup node with local DA and how to deploy smart contracts & Aspect (EVM++'s WASM extension) to the L2.
Summary by CodeRabbit
New Features
Documentation