Skip to content

Commit

Permalink
Readme (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
squadgazzz authored Jan 5, 2024
1 parent 484bb1c commit 1b959b4
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# solvers
![pull request](https://github.com/cowprotocol/solvers/workflows/pull%20request/badge.svg) ![deploy](https://github.com/cowprotocol/solvers/workflows/deploy/badge.svg)
# 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.

0 comments on commit 1b959b4

Please sign in to comment.