Skip to content

Commit

Permalink
Updates the project configuration and documentation (#16)
Browse files Browse the repository at this point in the history
Fixes some issues in the project documentations and configuration.
The local setup session is reduced to 10 as 50 was too long and was
delaying the onboarding of the parachain.
  • Loading branch information
thadouk authored Sep 20, 2023
1 parent 65a42d6 commit a66f7f8
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 6 deletions.
50 changes: 45 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ First [Install Rust](https://www.rust-lang.org/tools/install):

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# set default cargo location
source $HOME/.cargo/env
```

If you already have Rust installed, make sure you're using the latest version by running:
Expand All @@ -40,15 +42,53 @@ If you already have Rust installed, make sure you're using the latest version by
rustup update
```

Once done, finish installing the support software:
Once done, finish installing the support software and configure your default toolchain:

```bash
# Additional rust targets
rustup target add wasm32-unknown-unknown --toolchain nightly-2020-10-18
# Install nightly toolchain and use it
rustup toolchain install nightly-2022-10-18
rustup default nightly-2022-10-18
rustup target add --toolchain nightly-2022-10-18 wasm32-unknown-unknown

# Additional OS dependencies
sudo apt install build-essential git clang libclang-dev pkg-config libssl-dev
sudo apt install build-essential
sudo apt install --assume-yes git clang curl libssl-dev protobuf-compiler
```

Verify the configuration of your development environment by running the following command:
```bash
rustup show
rustup +nightly show
```
The command displays output similar to the following:
```bash
# rustup show

active toolchain
----------------

stable-x86_64-unknown-linux-gnu (default)
rustc 1.62.1 (e092d0b6b 2022-07-16)

# rustup +nightly show

active toolchain
----------------

nightly-x86_64-unknown-linux-gnu (overridden by +toolchain on the command line)
rustc 1.65.0-nightly (34a6cae28 2022-08-09)
```
See [here](https://docs.substrate.io/install/linux/) for a more detailed guide on installing Rust and the required dependecies.

Build the client by cloning this repository and running the following commands from the root
directory of the repo:

```bash
git checkout <latest tagged release>
cargo build --release
```


### Building the client

Build the client by cloning this repository and running the following commands from the root
Expand All @@ -66,7 +106,7 @@ Prerequisites:

```sh
# Builds the docker image with the build artefacts under target/release
docker build . --tag avn-dev-node:latest
docker build . --tag aventus/avn-dev-node:latest
```

## Running the node
Expand Down
2 changes: 1 addition & 1 deletion parachain-launch/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ relaychain:
validation_upgrade_cooldown: 5
validation_upgrade_delay: 5
overrides: # additonal runtime override
session_length_in_blocks: 50
session_length_in_blocks: 10
env: # environment variables for all relaychain nodes
RUST_LOG: parachain::candidate-backing=trace
flags: # additional CLI flags for all relaychain nodes
Expand Down

0 comments on commit a66f7f8

Please sign in to comment.