docs: Update documentation for Arbitrum Sepolia, Stylus CLI, and content clarity #1242
Conversation
omarespejel
commented
May 6, 2024
omarespejel
commented
- Added detailed instructions for adding the Arbitrum Sepolia network to the MetaMask wallet, ensuring users have clear guidance for network setup.
- Updated the output details for the Stylus CLI to reflect the latest functionalities and expected results, enhancing user understanding.
- Revised various sections across the documentation to improve clarity and readability, making the content more accessible to users.
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
omarespejel
requested review from
symbolpunk,
TucksonDev,
mahsamoosavi,
anegg0 and
hkalodner
as code owners
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
FYI, i already signed the Contributor License Agreement. |
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
| For additional sources of testnet ETH, please use a faucet on Arbitrum Sepolia or Ethereum Sepolia: | ||
| 1. Visit a faucet such as [Bware Labs' Arbitrum Stylus Testnet faucet](https://bwarelabs.com/faucets/arbitrum-stylus-testnet). | ||
| 2. Enter your wallet address. | ||
| 3. Click `Claim` to receive your testnet ETH. Some faucets may offer additional steps to get more tokens. |
There was a problem hiding this comment.
I would change "offer" to "require".
There was a problem hiding this comment.
Please don't delete static assets in PR.
There was a problem hiding this comment.
@chrisco512, does this mean I should restore the deleted images? I can do that, imo, I felt they were redundant and didn’t add much value to the content. Let me know how you’d like to proceed!
| To verify the transfer, you can track the transaction on the [Arbiscan block explorer]((https://sepolia.arbiscan.io/) for the source and the [Stylus testnet block explorer](https://stylus-testnet-explorer.arbitrum.io/) for the destination. | ||
|
|
||
| <p align="center"> | ||
| <img src="./assets/bridge-to-stylus.png" alt="Stylus Wallet" width="400"> |
There was a problem hiding this comment.
This URL does not work and image is broken. This is due to how Docusaurus bundles and links static assets at compile time. While it will automatically convert URLs for Markdown image tags, it will not for embedded JSX. Use Markdown here and remove <p> tag.
There was a problem hiding this comment.
| @@ -11,89 +11,150 @@ import PublicPreviewBannerPartial from './partials/_stylus-public-preview-banner | |||
|
|
|||
| <PublicPreviewBannerPartial /> | |||
|
|
|||
| This tutorial will guide you through the process of deploying a smart contract in Rust using Stylus. Stylus is a tool that simplifies the development and deployment of smart contracts on the Arbitrum network. By the end of this tutorial, you will understand how to create, and deploy your own smart contracts using Rust and Stylus. | |||
There was a problem hiding this comment.
The first sentence is ok, but the other two sentences are not correct. The Quickstart is designed to get a quick example deployed and get familiar with cargo stylus, it's not in-depth enough to understand how to write a full contract on your own.
|
|
||
| We recommend VSCode as the IDE of choice for developing Stylus contracts for its excellent Rust support. See **[code.visualstudio.com](https://code.visualstudio.com/)** to install. Feel free to use another text editor or IDE if you’re comfortable with those. | ||
|
|
||
| Some helpful VS Code extensions for Rust development: | ||
| Some helpful VSCode extensions for Rust development: |
There was a problem hiding this comment.
I see we have inconsistent usage of VS Code vs VSCode. Let's stick with VS Code since that's how MS describes it: https://code.visualstudio.com/
|
|
||
| #### Testnet ETH for deployment | ||
|
|
There was a problem hiding this comment.
Can we remove extra line here
| cargo stylus check | ||
| ``` | ||
|
|
||
| This command will attempt to verify that your program can be deployed and activated onchain without requiring a transaction by specifying a JSON-RPC endpoint. See `cargo stylus check --help` for more options. | ||
| This command verifies that your program can be deployed and activated onchain without a transaction, by connecting to a specified JSON-RPC endpoint. The defalt endpoint is the Arbitrum Stylus testnet: `https://stylus-testnet.arbitrum.io/rpc`. |
There was a problem hiding this comment.
default is misspelled here. Let's keep "See cargo stylus check --help for more options." inlined here and skip the callout on lines 189 through 193 below.
|
|
||
| ``` | ||
| Once validated, you can deploy your program using the `cargo stylus deploy` subcommand. Start by estimating the gas required for deployment. `--private-key-path` is a text file containing your private key. You could also use the `--private-key` flag to input your private key directly but this is not recommended for security reasons. |
There was a problem hiding this comment.
Let's remove the --private-key flag sentence here. We have no specific recommendation wrt security on using an inline key vs a key path; and it distracts from single prescribed way for basic example.
| ``` | ||
|
|
||
| Next, attempt an actual deployment. Two transactions will be sent onchain. | ||
| To proceed with the deployment, two transactions will be sent onchain: |
|
|
||
| ## Deploying non-Rust WASM projects | ||
| ## Deploying Non-Rust WASM Projects |
There was a problem hiding this comment.
Other than this line I'd remove the changes in this section. It was meant as a short aside, and it probably should be moved to another part of the docs altogether since it's focused on WASM and this page is meant as a Rust quick start guide. We'll revisit closer to mainnet.
|
|
||
| can be saved as `add.wat` and used as `cargo stylus check --wasm-file-path=add.wat` or `cargo stylus deploy --priv-key-path=<YOUR PRIV KEY FILE PATH> --wasm-file-path=add.wat` | ||
| # Conclusion |
There was a problem hiding this comment.
Remove this section. The quick start guide does not teach you to write smart contracts, just to deploy them, and the conclusion section is superfluous.
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
Hi @symbolpunk: Kind reminder on this point: |
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
Hey @eljobe @chrisco512 @symbolpunk,
|
|
@cla-bot check |
|
The cla-bot has been summoned, and re-checked this pull request! |
|
Sorry about the delay on the CLA! |
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
hey @hkalodner! It seems like the PR is still being flagged as blocked due to CLA |
