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.

Sign up for GitHub

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

fix: update dex README with up-to-date compile and deploy instructions #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: update dex README with up-to-date compile and deploy instructions #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 32 additions & 44 deletions dex/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,54 @@
# Openbook DEX

## Deploying the DEX

Run these commands from the repository's dex directory.
## Testing

### Run unit tests

```bash
cargo test
```

### Compile the dex binary
## Run fuzz tests

```bash
cargo build --relase dex
cargo install cargo-fuzz
cargo fuzz run multiple_orders
```

### Deploy the dex to the configured solana cluster
If this doesn't work, you may need to switch to the nightly version of the Rust compiler:

```bash
DEX_PROGRAM_ID="$(solana deploy ./target/bpfel-unknown-unknown/release/serum_dex.so | jq .programId -r)"
rustup toolchain install nightly
rustup override set nightly
```

## Run the fuzz tests
## Deploying

### Compiling

```bash
cargo install cargo-fuzz
cargo fuzz run multiple_orders
cargo build-bpf
```

### Deploying locally

```bash
solana config set -u localhost
solana-test-validator
# generate a key & give yourself some SOL if you haven't already
solana-keygen new
solana airdrop 100
solana program deploy target/deploy/serum_dex.so
```

### Deploying remotely

```
solana config set -u devnet # options are mainnet-beta, testnet, & devnet
# verify that you have SOL balances for gas
KEYPAIR=~/.config/solana/id.json
solana balance -k $KEYPAIR
solana program deploy target/deploy/serum_dex.so
```

## Using the crank client utility
Expand All @@ -53,37 +75,3 @@ COIN_MINT="..."
PRICE_CURRENCY_MINT="..."
cargo run -- $CLUSTER list-market $KEYPAIR $DEX_PROGRAM_ID --coin-mint $COIN_MINT --pc-mint $PRICE_CURRENCY_MINT
```

## First-time setup

```bash
# Building the dex
sudo apt-get install -y pkg-config build-essential python3-pip jq
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
curl -sSf https://raw.githubusercontent.com/solana-labs/solana/v1.4.14/install/solana-install-init.sh | sh -s - v1.4.14
export PATH="/home/ubuntu/.local/share/solana/install/active_release/bin:$PATH"

git clone https://github.com/openbook-dex/program
cd dex
cargo build --release

# run a solana cluster. in a new shell:
git clone https://github.com/solana-labs/solana --branch v1.4.14
cd solana
sudo apt-get install -y libssl-dev libudev-dev zlib1g-dev llvm clang
cargo build --release
export RUST_LOG=solana_runtime::system_instruction_processor=trace,solana_runtime::message_processor=info,solana_bpf_loader=debug,solana_rbpf=debug
NDEBUG=1 ./run.sh

# Deploy the dex to our cluster (in the old shell)
solana config set -u http://127.0.0.1:8899
solana-keygen new
solana airdrop 100
DEX_PROGRAM_ID="$(solana deploy dex/target/bpfel-unknown-unknown/release/serum_dex.so | jq .programId -r)"
CLUSTER=localnet
KEYPAIR=~/.config/solana/id.json

# run the demo script (this is mostly a smoke test)
cargo run -- $CLUSTER whole-shebang $KEYPAIR $DEX_PROGRAM_ID
```