serai/docs/Getting Started.md
Luke Parker 482a8ec209
Update to the latest Serai Substrate (#125)
* Update to the latest Serai Substrate

* Add Protobuf to build dependencies

Docker shouldn't need updating as this should've been added to the image 
in 
2dbace5b01.

* Get substrate to build

* Correct protoc build step

* Remove the benchmarking code

There's some macro resolution error that isn't apparent. I worked on it 
for about half an hour but...

* Remove unnecessary clone

* Correct runtime-benchmarks flag usage
2022-09-29 13:33:09 -05:00

67 lines
1,019 B
Markdown

# Getting Started
### System Dependencies
##### Ubuntu
```
sudo apt-get install -y build-essential cmake clang-11 git curl python3-pip protobuf-compiler
```
### Install rustup
##### Linux
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
##### macOS
```
brew install rustup
```
### Install Rust
```
rustup update
rustup toolchain install nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```
### Install Solidity
```
sudo pip3 install solc-select
solc-select install 0.8.16
solc-select use 0.8.16
```
### Install foundry and anvil (for tests)
```
cargo install --git https://github.com/foundry-rs/foundry --profile local --locked foundry-cli anvil
```
### Clone and Build Serai
```
git clone https://github.com/serai-dex/serai
cd serai
cargo build --release
```
### Run Tests
Running tests requires a Monero regtest node running in the background.
```
cargo test --all-features
```
### Run Serai in Development Mode
```
./target/release/serai-node --dev
```