Docs(quick start): Add Interacting with a smart contract using Remix #1210
Conversation
|
Thank you @LeandroCarvajal for the contribution! @stoobie, the easiest way to get started with Starknet smart contracts is using Remix, thats why we added this section at the beginning of the SN Book. I recommend adding content on this, such as the one by @LeandroCarvajal, to the beginning of the Docs. |
|
@LeandroCarvajal and @omarespejel This is on my list of to-dos. I apologize for not getting to it more quickly. I'll try to review it in the coming days. |
There was a problem hiding this comment.
In general this content is great!
There are several technical writing guidelines that you (or I) need to implement. A few that jump out are:
- Use the active/imperative voice instead of the passive.
- Use simple words wherever possible. For example:
useinstead ofutilize. - Let's see if we can avoid using
We.
I didn't get very far yet. I'll continue reviewing later.
|
|
||
| == Introduction | ||
|
|
||
| . Access the https://remix.ethereum.org/#activate=Starknet&lang=en&optimize=false&runs=200&evmVersion=null&version=soljson-v0.8.24+commit.e11b9ed9.js)[Remix IDE] website with the Starknet plugin activated. |
There was a problem hiding this comment.
Is the closing parentheses after .js at the end of the URL supposed to be there?
I click on the link, but how do activate the Starknet plugin?
There was a problem hiding this comment.
The link provided by NethermindEth simplifies the steps by providing the plug-in already activated.
| == Introduction | ||
|
|
||
| . Access the https://remix.ethereum.org/#activate=Starknet&lang=en&optimize=false&runs=200&evmVersion=null&version=soljson-v0.8.24+commit.e11b9ed9.js)[Remix IDE] website with the Starknet plugin activated. | ||
| . Navigate to the `settings` option and opt for the Cairo version, as depicted in the accompanying image. The latest iteration available in Remix is `v2.5.4`. |
There was a problem hiding this comment.
as depicted in the accompanying image.
What image?
The latest iteration available in Remix isv2.5.4.
Remove this. It's going to be obsolete as soon as Remix updates this.
There was a problem hiding this comment.
You gave me the cue for a doubt that came up, in the original repository screenshots were used, but they were out of context. I'm working on new images to fit the repository.
| . Navigate to the `settings` option and opt for the Cairo version, as depicted in the accompanying image. The latest iteration available in Remix is `v2.5.4`. | ||
| . Proceed to the `file explorer` tab to review the particulars of the sample project. Within the `Scarb.toml` file, the version of this sample project is delineated. | ||
|
|
||
| Given our intent to utilize `version 2.5.4` for this project, it is imperative to ensure its alignment within our `Scarb.toml`. Any disparities should be rectified accordingly, setting `starknet = "2.5.4"`. |
There was a problem hiding this comment.
How many places are there to make sure are aligned?
Does starknet = 2.5.4 refer to the Cairo compiler version?
There was a problem hiding this comment.
The default project is a hello_world, so the folders are modified step by step.
Do you mean the [dependencies]. Is it out of context?
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
|
Thank you very much for the suggestions @stoobie, I am already working to fix it, I am attentive to make the necessary changes. |
|
Hi @stoobie, i've been improving the syntax according to what you suggested, any comments for improvement are welcome, thanks. |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
5 similar comments
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
There was a problem hiding this comment.
@SimplementeCao Some more comments. I'm still reviewing it.
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
| * Navigate to the `Starknet` tab within Remix, then click on `Home`. | ||
| * In the 1 Compile section, choose compile a single file. | ||
| * Grant the necessary permissions when prompted. Opt to Remember my choice for smoother processes in the future. | ||
| * After compilation, you'll see an "artifacts" directory containing the compiled contract in two formats: Sierra (JSON file) and CASM. For Starknet deployment, Remix will use the Sierra file. |
There was a problem hiding this comment.
- provide the path to
artififactsstarting from the root of the project. - State the full file names for the Sierra and CASM files.
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
7 similar comments
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
10 similar comments
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1210/documentation/ . |
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
components/Starknet/modules/quick_start/pages/interact_with_a_smart_contract_using_remix.adoc
Outdated
Show resolved
Hide resolved
|
Closing this. #1315 replaces this PR. |
Description of the Changes
Add a step-by-step on how to interact and deploy a smart contract using the Starknet Remix Plugin. Follow the migration of the Starknet book
Getting Started -> Starknet Documentation - Quick Start
Full issue starknet-edu/starknetbook#352
I suggest placing this tutorial at the end of Quick start senction.
PR Preview URL
Interacting with a smart contract using Remix
Check List
<docs/feat/fix/chore>(optional scope): <description>, e.g:fix: minor typos in code@omarespejel Please have a look here. Thanks
@stoobie I would like your feedback here as well. Thanks
This change is