serum-dex

Project Serum Rust Monorepo

Website | Discord | Awesome | DEX | TypeScript

## Program Deployments | Program | Devnet | Mainnet Beta | | --------|--------|------------- | | [DEX](/dex) | `DESVgJVGajEgKGXhb6XmqDHGz3VjdgP7rEVESBgxmroY` | `9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin` | ## Note * **Serum is in active development so all APIs and protocols are subject to change.** * **The code is unaudited. Use at your own risk.** ## Contributing ### Install Rust ```bash curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh source $HOME/.cargo/env rustup component add rustfmt ``` On Linux systems you may need to install additional dependencies. On Ubuntu, ```bash sudo apt-get install -y pkg-config build-essential python3-pip jq ``` ### Install Solana Directions can be found [here](https://docs.solana.com/cli/install-solana-cli-tools#use-solanas-install-tool). ### Download the source ```bash git clone https://github.com/project-serum/serum-dex.git ``` ### Build, deploy, and test programs See individual crates for documentation. For example, to build the dex see its [README](https://github.com/project-serum/serum-dex/tree/master/dex). ## Running a local Solana cluster The easiest way to run a local cluster is to use [solana-test-validator](https://docs.solana.com/developing/test-validator). ## Directories * `assert-owner`: Solana utility program for checking account ownership. * `common`: Common rust utilities. * `dex`: Serum DEX program and client utility. * `pool`: Serum pool protocol. * `scripts`: Bash scripts for development. 18:T9b1,# serum-dex ## Deploying the DEX Using the `do.sh` script from the repository's top level directory, ### Run unit tests ```bash ./do.sh test dex ``` ### Compile the dex binary ```bash ./do.sh build dex ``` ### Deploy the dex to the configured solana cluster ```bash DEX_PROGRAM_ID="$(solana deploy dex/target/bpfel-unknown-unknown/release/serum_dex.so | jq .programId -r)" ``` ## Run the fuzz tests ```bash cd dex cargo install cargo-fuzz cargo fuzz run multiple_orders ``` ## Using the crank client utility ```bash cd crank # read the autogenerated help text cargo run -- help # supported options are localnet, mainnet, testnet, devnet CLUSTER=localnet # verify that you have SOL balances for gas KEYPAIR=~/.config/solana/id.json solana balance -k $KEYPAIR # run the demo script (this is mostly a smoke test) cargo run -- $CLUSTER whole-shebang $KEYPAIR $DEX_PROGRAM_ID # list a market with the default tick size and minimum quantity. # if both assets have 6 decimals, this will be a quantity of 1 and a tick size of 0.01 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/solan