sdk-rs - toolchain setup page & Rust version

docs/developers/meta/rust-nightly.md → docs/developers/meta/rust-stable-vs-nightly.md

@@ -1,5 +1,5 @@
 ---
-id: rust-nightly
+id: rust-stable-vs-nightly
 title: Stable vs. Nightly Rust
 ---
 
@@ -17,22 +17,28 @@ Before this version, nightly Rust was required.
 
 For everything after v0.50.0 we recommend running the latest stable version of Rust. Older versions have had compatibility issues with certain framework dependencies, on certain versions of the compiler.
 
-Nightly Rust is still allowed, but not recommended. We will still be supporting nightly builds and running continuous integration on `nightly-2024-05-22`.
-
 Also, everything on versions older than v0.50.0 needs to run on nightly Rust.
 
-So, to summarize:
-- Before `v0.50`: `nightly-2023-12-11` and `nightly-2024-05-22` are both known to be running fine;
-- On `v0.50` (use `v0.50.6`): any version of `stable` Rust;
-- Starting with `v0.51`: `stable`, Rust >= 1.78 required.
+:::important
+
+- For Versions Prior to `v0.50`:
+  - **Requirement**: A specific nightly build is necessary.
+  - **Known Working Builds**:`nightly-2023-12-11` and `nightly-2024-05-22` are confirmed to run correctly.
+- For Versions `v0.50` through `v0.57`:
+  - **Requirement**: The **stable channel** must be used, requiring a Rust version that is **greater than or equal** to `1.78` and **less than or equal** to `1.86`.
+- For Version `v0.58` and Higher:
+  - **Requirement**: The **stable channel** must be used, requiring a **minimum** Rust version of `1.78` or newer.
+
+:::
 
 [comment]: # (mx-context-auto)
 
-## Why Nighly for the older versions?
+## Why Nightly for the older versions?
 
 There were several nightly features that the framework was using, which we had hoped to see stabilized sooner.
 
 These are of little relevance to the average developer, but for the record, let's mention a few of them and how we managed to circumvent their usage:
+
 - `never_type` - avoided by using slightly different syntax;
 - `auto_traits` and `negative_impls` - avoided by redesigning the `CodecFrom`/`TypeAbiFrom` trait systems;
 - `generic_const_exprs` - replaced with massive amounts of macros;

docs/developers/toolchain-setup.md

@@ -0,0 +1,99 @@
+---
+id: toolchain-setup
+title: Toolchain Setup 
+---
+
+[comment]: # (mx-context-auto)
+
+## Installing Rust and sc-meta
+
+:::note
+`sc-meta` is universal smart contract management tool. Please follow [this](/developers/meta/sc-meta) for more information.
+:::
+
+[comment]: # (mx-context-auto)
+
+For systems running Ubuntu or Windows with WSL, you should first ensure the following system-level dependencies required by Rust and sc-meta are in place:
+
+```bash
+sudo apt-get install build-essential pkg-config libssl-dev
+```
+
+Install Rust as recommended on [rust-lang.org](https://www.rust-lang.org/tools/install):
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+Then, choose **Proceed with installation (default)**.
+
+:::tip
+Generally speaking, you should install Rust `v1.85.0` (stable channel) or later.
+:::
+
+```bash
+rustup update
+rustup default stable
+```
+
+Afterwards, open a new terminal (shell) and install `sc-meta`:
+
+```bash
+cargo install multiversx-sc-meta --locked
+```
+
+Once `sc-meta` is ready, install the `wasm32` target (for the Rust compiler), `wasm-opt`, and others dependencies as follows:
+
+```bash
+# Installs `wasm32`, `wasm-opt`, and others in one go:
+sc-meta install all
+
+cargo install twiggy
+```
+
+[comment]: # (mx-context-auto)
+
+### Within Continuous Integration / Continuous Delivery
+
+For automated environments like CI/CD pipelines, start by installing the necessary foundational libraries. On platforms such as Ubuntu (or WSL), this means installing:
+
+```bash
+sudo apt-get install build-essential pkg-config libssl-dev
+```
+
+For CI / CD, install Rust as follows:
+
+```bash
+wget -O rustup.sh https://sh.rustup.rs && \
+    chmod +x rustup.sh && \
+    ./rustup.sh --verbose --default-toolchain stable -y
+
+cargo install multiversx-sc-meta --locked
+
+sc-meta install wasm32
+```
+
+[comment]: # (mx-context-auto)
+
+## Check your Rust installation
+
+You can check your Rust installation by invoking `rustup show`:
+
+```sh
+$ rustup show
+
+Default host: x86_64-unknown-linux-gnu
+rustup home:  /home/ubuntu/.rustup
+
+installed toolchains
+--------------------
+stable-x86_64-unknown-linux-gnu (default)
+[...]
+
+active toolchain
+----------------
+name: stable-x86_64-unknown-linux-gnu
+installed targets:
+  wasm32-unknown-unknown
+  wasm32v1-none
+  x86_64-unknown-linux-gnu

docs/developers/tutorials/chain-simulator-adder.md

@@ -5,20 +5,22 @@ title: Chain Simulator in Adder - SpaceCraft interactors
 
 [comment]: # (mx-abstract)
 
-This tutorial will guide you to interact with **Chain Simulator** using the SpaceCraft interactors in _Adder_ smart contract. 
+This tutorial will guide you to interact with **Chain Simulator** using the SpaceCraft interactors in _Adder_ smart contract.
 
 [comment]: # (mx-context-auto)
 
 ## Introduction
 
-[Chain Simulator](../../sdk-and-tools/chain-simulator.md) mimics the functionality of a local blockchain test network. It offers a convenient, faster, and realistic way to test smart contracts. 
+[Chain Simulator](../../sdk-and-tools/chain-simulator.md) mimics the functionality of a local blockchain test network. It offers a convenient, faster, and realistic way to test smart contracts.
 
 [SpaceCraft interactor](../meta/interactor/interactors-overview.md) allows testing any complex scenario defined in a smart contract using **Chain Simulator**. Rather than going through the full setup of a local testnet, you can get straight to developing and debugging in a streamlined environment. This tool handles the setup details so you can focus on what matters most: **building and testing your contracts**.
 
 :::important
 Before we dive in and explore how easy it can be, make sure you have the following:
-- `stable` Rust version `≥ 1.78.0` (install via [rustup](https://docs.multiversx.com/sdk-and-tools/troubleshooting/rust-setup/#without-mxpy)): 
-- `multiversx-sc-meta` version `≥ 0.54.0` (cargo install [multiversx-sc-meta](https://docs.multiversx.com/developers/meta/sc-meta-cli/#introduction))
+
+- `stable` Rust version `≥ 1.85.0` (install via [rustup](/docs/developers/toolchain-setup.md#installing-rust-and-sc-meta)):
+- `multiversx-sc-meta` version `≥ 0.54.0` (cargo install [multiversx-sc-meta](/docs/developers/meta/sc-meta-cli.md))
+
 :::
 
 [comment]: # (mx-context-auto)
@@ -54,7 +56,7 @@ After running the command, you’ll see that the contract `my-adder` has been ge
 
 Our main focus will be the `interactor` directory. Let’s take a closer look:
 
-The directory that makes the connection with Chain Simulator contains the following structures: 
+The directory that makes the connection with Chain Simulator contains the following structures:
 
 ```bash
 .
@@ -84,10 +86,11 @@ gateway_uri = 'http://localhost:8085'
 ```
 
 You can customize two settings in the configuration:
+
 - **Type of blockchain**;
 - **Gateway URI**.
 
-To use a simulator for your blockchain, set `chain_type` as shown in the example above. 
+To use a simulator for your blockchain, set `chain_type` as shown in the example above.
 
 By default, the simulator runs on `http://localhost:8085`. However, depending on your Docker image settings, the simulator's URI **might have a different port or name**.
 
@@ -96,6 +99,7 @@ Make sure to set both `chain_type` and `gateway_uri` for the interactor to work.
 :::
 
 The configuration is parsed by `basic_interactor_config.rs`. This file contains **two** functions that will be important for interacting with Chain Simulator:
+
 - `use_chain_simulator()`: returns if the chain type is real or simulator;
 - `chain_simulator_config()`: initialize the proper configuration for simulator environment; this function is useful for **continuous integration tests**.
 
@@ -172,11 +176,12 @@ pub async fn new(config: Config) -> Self {
 }
 ```
 
-Let's find out what is mandatory for initializing the Chain Simulator interactor. 
+Let's find out what is mandatory for initializing the Chain Simulator interactor.
 
 ```rust
 let adder_owner_address = interactor.register_wallet(test_wallets::heidi()).await;
 ```
+
 Every time you initialize an interactor, you’ll need to register a wallet. When a wallet is registered in the Chain Simulator, its associated account is automatically credited with a generous amount of EGLD. This way, you don’t have to worry about running out of tokens while testing!
 
 :::tip
@@ -190,13 +195,14 @@ Whenever the Chain Simulator stops, the account will be dissolved.
 ```rust
 interactor.generate_blocks_until_epoch(1).await.unwrap();
 ```
+
 Node enables `ESDTSystemSCAddress` in **epoch number one**. If you want to use functionality like issuing or minting tokens, it is necessary to generate blocks until the simulator chain reaches **epoch number one**.
 
 [comment]: # (mx-context-auto)
 
 ## Step 4: Create tests that run on Chain Simulator
 
-One of the best parts about using the Chain Simulator with your interactor is that it lets you create **continuous integration tests in an environment that mirrors the real blockchain**. 
+One of the best parts about using the Chain Simulator with your interactor is that it lets you create **continuous integration tests in an environment that mirrors the real blockchain**.
 
 `tests/` holds all your test suites, where you are able to verify your contract’s behaviour effectively.
 
@@ -277,6 +283,7 @@ async fn simulator_adder_test() {}
 ### 1. Deploy the contract
 
 **Deploy** on Chain Simulator _MyAdder_ contract which sets the initial sum with **zero**.
+
 ```rust
 use basic_interactor::{Config, MyAdderInteract};
 
@@ -369,6 +376,7 @@ async fn simulator_upgrade_test() {
 [comment]: # (mx-context-auto)
 
 ### 5. Unauthorized Upgrade
+
 Attempt to upgrade the contract with an unauthorized user to confirm that it results in a failed transaction. To ensure no changes occur, you need to query the storage again to check that the number remains unchanged.
 
 ```rust
@@ -417,6 +425,7 @@ async fn simulator_upgrade_test() {
 [comment]: # (mx-context-auto)
 
 ### Install
+
 To run the test provided, you will need to install the Docker image that includes the Chain Simulator.
 
 ```bash
@@ -427,38 +436,46 @@ Successfully pulled the latest Chain Simulator image.
 
 :::note
 If you encounter the following error while installing:
+
 ```bash
 Attempting to install prerequisites for the Chain Simulator...
 Error: Failed to execute command: permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock
 ```
 
 You will need to run the command with root privileges due to Docker usage:
+
 ```bash
 my-adder/interactor$ sudo sc-meta cs install
 ```
 
 If you get this error:
+
 ```bash
 sudo: sc-meta: command not found
 ```
+
 You can find the sc-meta path and choose one of these solutions:
+
 ```bash
 my-adder/interactor$ which sc-meta
 my-path/.cargo/bin/sc-meta
 ```
 
 1. Add the sc-meta path to root privileges:
 2. Run sc-meta directly using the full path:
+
 ```bash
 sudo my-path/.cargo/bin/sc-meta cs install
 ```
+
 :::
 
 [comment]: # (mx-context-auto)
 
 ### Start
 
 Once you’ve successfully installed the Docker image, you can start the Chain Simulator.
+
 ```bash
 my-adder/interactor$ sudo my-path/.cargo/bin/sc-meta cs start
 Attempting to start the Chain Simulator...
@@ -477,6 +494,7 @@ INFO [2024-11-11 13:09:15.699]   updated config value                     file =
 [comment]: # (mx-context-auto)
 
 ### Run
+
 While Chain Simulator is running, open a new terminal window in parallel. In this new terminal, you will run the test provided in [Step 4](./chain-simulator-adder.md#step-4-create-tests-that-run-on-chain-simulator).
 
 ```bash
@@ -489,17 +507,22 @@ test simulator_upgrade_test ... ok
 
 test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 1.09s
 ```
+
 [comment]: # (mx-context-auto)
 
 ### Stop
+
 In the **same** terminal window you ran the tests, **stop** Chain Simulator using the next command:
+
 ```bash
 my-adder/interactor$ sc-meta cs stop
 Attempting to close the Chain Simulator...
 Successfully stopped the Chain Simulator.
 ```
+
 :::note
 If you encounter the following error while stopping:
+
 ```bash
 Attempting to close the Chain Simulator...
 Error: Failed to execute command: permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock
@@ -508,4 +531,4 @@ Error: Failed to execute command: permission denied while trying to connect to t
 Solution is presented in [Run](./chain-simulator-adder.md#install) section.
 :::
 
-By following these steps, you've mastered the basics of smart contract development and testing. Now, it's time to explore more advanced techniques and create innovative applications :sparkles: :rocket:
+By following these steps, you've mastered the basics of smart contract development and testing. Now, it's time to explore more advanced techniques and create innovative applications :sparkles: :rocket:

docs/developers/tutorials/crowdfunding-p1.md

@@ -52,8 +52,8 @@ Automated testing is exceptionally important for the development of smart contra
 :::important
 Before starting this tutorial, make sure you have the following:
 
-- `stable` **Rust** version `≥ 1.83.0` (install via [rustup](/docs/sdk-and-tools/troubleshooting/rust-setup.md#installing-rust-and-sc-meta))
-- `sc-meta` (install [multiversx-sc-meta](/docs/sdk-and-tools/troubleshooting/rust-setup.md#installing-rust-and-sc-meta))
+- `stable` **Rust** version `≥ 1.85.0` (install via [rustup](/docs/developers/toolchain-setup.md#installing-rust-and-sc-meta))
+- `sc-meta` (install [multiversx-sc-meta](/docs/developers/meta/sc-meta-cli.md))
 
 :::