Skip to content

Improves tutorial documentation #467

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

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

Improves tutorial documentation #467

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
23 changes: 10 additions & 13 deletions docs/cow-protocol/tutorials/solvers/local_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,28 @@ In order to test a solver against CoW Protocol's orderflow, one needs to locally

It is assumed you have rust setup correctly with `rustup`.

CoW Protocol services infrastructure can be very heavy on RPC resource consumption. Be careful if using with post-paid plans, it's recommended to keep a close eye on RPC resource consumption.

:::

The repository where all the backend services can be found is this one: [https://github.com/cowprotocol/services](https://github.com/cowprotocol/services). Here are the main instructions to run the autopilot and the driver.
The repository where all the backend services can be found is this one: [https://github.com/cowprotocol/services](https://github.com/cowprotocol/services). Here are the main instructions to run the driver and the autopilot.

For the autopilot, we run
For the driver, we run

```
cargo run --bin autopilot -- --native-price-estimators "baseline|http://driver/baseline" --skip-event-sync true --node-url $NODE_URL --shadow https://api.cow.fi/mainnet --drivers "mysolver1|http://localhost:11088/mysolver1"
cargo run -p driver -- --config crates/driver/example.toml --ethrpc $NODE_URL
```

where one needs to set the NODE_URL appropriately (e.g., a free Infura endpoint).

:::caution

CoW Protocol services infrastructure can be very heavy on RPC resource consumption. Be careful if using with post-paid plans, it's recommended to keep a close eye on RPC resource consumption.

:::
where one needs to configure driver.config.toml to point to their solver engine. A sample such file can be found [here](https://github.com/cowprotocol/services/blob/main/crates/driver/example.toml).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A sample such file can be found [here] --> A sample file can be found [here]


For the driver, we run
For the autopilot, we run

```
cargo run -p driver -- --config driver.config.toml --ethrpc $NODE_URL
cargo run --bin autopilot -- --native-price-estimators "baseline|http://driver/baseline" --skip-event-sync true --node-url $NODE_URL --shadow https://api.cow.fi/mainnet --drivers "mysolver|http://localhost:11088/mysolver|$ADDRESS"
```

where one needs to configure driver.config.toml to point to their solver engine. A sample such file can be found [here](https://github.com/cowprotocol/services/blob/main/crates/driver/example.toml).
where one needs to set the NODE_URL appropriately (e.g., a free Infura endpoint) and the corresponding H160 ADDRESS.


Once the above are set up and running, one can then start testing their solver engine against one of the following orderbooks:

Expand Down
Loading