mirror of
https://github.com/serai-dex/serai.git
synced 2025-01-07 03:19:30 +00:00
978304e224
* add file * builds + caching fixed * bitcoin orchestration * remove default entrypoint * eth image and cleanup * working monero * remove signature file * cleanup on aisle eth * cleanup on aisle btc * eth working * remove docker ignore * remove bitcoin image readme * fix serai builds * serai clusters * added readme for docker * formatting * share the image * newlines at EOF * add multi profile example * coin order * coin order * profile order * fix grammar * fix whitespace * reduce trusted signature set, require at least 3 signatures. * remove echo * update comment to ref trusted keys * comment fix * use 16 keys, check for laanwj, name compose * don't use bash * monero fingerprints & eth fixes * eth fixes * remove extra eth keys
67 lines
1,001 B
Markdown
67 lines
1,001 B
Markdown
# Getting Started
|
|
|
|
### System Dependencies
|
|
|
|
##### Ubuntu
|
|
|
|
```
|
|
sudo apt-get install -y build-essential cmake clang-11 git curl python3-pip
|
|
```
|
|
|
|
### 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
|
|
```
|