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

Development into main #847

Merged
merged 11 commits into from
Mar 12, 2024
15 changes: 13 additions & 2 deletions docs/integrators/snapshotless-observing-squad.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,24 @@ The nodes started with the flag `--operation-mode snapshotless-observer` will no

### Creating a Snapshotless Observing Squad from scratch

If you choose to install a snapshotless observing squad from scratch, you should follow the instruction from the [observing squad section](/integrators/observing-squad) and remember to add in the `variables.cfg` file the operation mode in the node's extra flags definition:
If you choose to install a snapshotless Observing Squad from scratch, you should follow the instruction from the [observing squad section](/integrators/observing-squad) and remember to add in the `variables.cfg` file the operation mode in the node's extra flags definition:
```
NODE_EXTRA_FLAGS="-log-save -operation-mode snapshotless-observer"
```

After that, you can resume the normal Observing Squad installation steps.

Then, based on the needs there are multiple options concerning the proxy:
* if only a snapshotless squad is needed, nothing else should be done
* if both regular and snapshotless squads are needed:
* with two different proxies: one started with regular observers and one started with snapshotless observers, nothing else should be done
* with only one proxy (being served by all 8 observers), `IsSnapshotless = true` should be added to each observer started with this flag, in the proxy config (found at `$CUSTOM_HOME/elrond-proxy/config/config.toml`), as follows. Please note that this step is optional, although it would help the proxy to forward the requests in an efficient manner.
```toml
[[Observers]]
ShardId = 0
Address = "http://127.0.0.1:8080"
IsSnapshotless = true
```

[comment]: # (mx-context-auto)

### Converting a normal Observing Squad to a Snapshotless Observing Squad
Expand Down
8 changes: 8 additions & 0 deletions docs/sdk-and-tools/sdk-py/mxpy-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ If no tag is provided **the default version** will be installed.
Generally speaking, the default `rust` version installed by `mxpy` is the one referenced by [the latest Docker image](https://github.com/multiversx/mx-sdk-rust-contract-builder/blob/main/Dockerfile) used for reproducible builds.
:::

:::note
On Ubuntu (or Windows with WSL), you might need to install the following dependencies of Rust and `sc-meta` before running `mxpy deps install rust`:

```bash
sudo apt-get install build-essential pkg-config libssl-dev
```
:::

Here's how to install a specific version of `rust` (example):
```sh
mxpy deps install rust --overwrite
Expand Down
40 changes: 27 additions & 13 deletions docs/sdk-and-tools/troubleshooting/rust-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ rustup self uninstall

### With mxpy

On Ubuntu (or Windows with WSL), you might need to install the following dependencies of Rust and `sc-meta` first:

```bash
sudo apt-get install build-essential pkg-config libssl-dev
```

Install Rust and `sc-meta` using `mxpy`:

```bash
mxpy deps install rust --overwrite
```
Expand All @@ -84,7 +92,13 @@ For more information, go to [managing dependencies using `mxpy`](/sdk-and-tools/

### Without mxpy

As recommended on [rust-lang.org](https://www.rust-lang.org/tools/install):
On Ubuntu (or Windows with WSL), you might need to install the following dependencies of Rust and `sc-meta` first:

```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
Expand Down Expand Up @@ -116,7 +130,13 @@ cargo install twiggy

### Without mxpy (CI / CD)

For CI / CD, use the following:
On Ubuntu (or Windows with WSL), you might need to install the following dependencies of Rust and `sc-meta` first:

```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 && \
Expand All @@ -128,22 +148,16 @@ cargo install multiversx-sc-meta --locked

[comment]: # (mx-context-auto)

### Handle missing dependencies of sc-meta

`sc-meta` requires a few dependencies that are not installed by default on some systems. In this case, installation of `sc-meta` fails.

For a workaround, please follow this [GitHub issue](https://github.com/multiversx/mx-sdk-py-cli/issues/338).
### Handle missing dependencies

[comment]: # (mx-context-auto)

### Handle missing dependencies: build-essential

On Ubuntu, you might also need to install `build-essential`:
On Ubuntu (or Windows with WSL), you might need to install the following dependencies of Rust and `sc-meta` before installing Rust:

```bash
sudo apt-get install build-essential
sudo apt-get install build-essential pkg-config libssl-dev
```

Also see this [GitHub issue](https://github.com/multiversx/mx-sdk-py-cli/issues/338).

[comment]: # (mx-context-auto)

## Check your Rust installation
Expand Down
Binary file modified static/developers/tutorial/config-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/developers/tutorial/dapp-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/developers/tutorial/dapp-problem.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/developers/tutorial/faucet-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/developers/tutorial/folder-structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading