-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
484bb1c
commit 1b959b4
Showing
1 changed file
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,34 @@ | ||
# solvers | ||
  | ||
# SOLVERS | ||
|
||
## Description | ||
|
||
This project is a solver engine that interfaces with several Decentralized Exchanges (DEXes), including Balancer, 0x, OneInch, and ParaSwap. | ||
The specific DEX solver that is instantiated depends on the command line argument provided when initiating the project. | ||
|
||
## Pre-requisites | ||
|
||
To build and run this project, you will need: | ||
|
||
- **[Rust](https://www.rust-lang.org/tools/install)**. It's recommended to use the stable branch. | ||
|
||
### Usage | ||
|
||
1. Build the project by running: | ||
```bash | ||
cargo build --release | ||
``` | ||
This command will create an executable `solvers` in the `./target/release` directory. | ||
|
||
2. Run the project with the following command: | ||
```bash | ||
solvers <solver_name> --config <config_path> | ||
``` | ||
|
||
Replace `<solver_name>` with the necessary solver you want to run: | ||
- `zeroex` | ||
- `balancer` | ||
- `oneinch` | ||
- `paraswap` | ||
|
||
`<config_path>` is the path to the corresponding solver's config. Examples for each solver can be found in the `./config` directory. |