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

Update docs: /reveal endpoint removed #414

Merged
merged 5 commits into from
Sep 17, 2024
Merged

Update docs: /reveal endpoint removed #414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e8a27c
Update docs: /reveal endpoint removed
m-lord-renkse Sep 10, 2024
9d289eb
Update docs: /reveal endpoint removed
m-lord-renkse Sep 10, 2024
f4318f9
Rework comment
m-lord-renkse Sep 11, 2024
da2ea5a
Rework comment
m-lord-renkse Sep 11, 2024
9920347
Update docs/cow-protocol/tutorials/arbitrate/autopilot.md
m-lord-renkse Sep 13, 2024
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
4 changes: 0 additions & 4 deletions docs/cow-protocol/tutorials/arbitrate/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@ sequenceDiagram
activate Solver
Solver-->>Autopilot: Score
deactivate Solver
Autopilot->>Solver: /reveal
activate Solver
Solver-->>Autopilot: Solution with call data
deactivate Solver
Autopilot->>Solver: /settle
activate Solver
Note over Solver: Settles transaction on-chain
Expand Down
7 changes: 2 additions & 5 deletions docs/cow-protocol/tutorials/arbitrate/autopilot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,8 @@ sequenceDiagram
solver 1->>autopilot: Proposed batch
deactivate solver 1
solver 2->>autopilot: Proposed batch
deactivate solver 2

Note over autopilot: Pick winner
autopilot->>+solver 2: /reveal
solver 2->>-autopilot: Ethereum transaction data
autopilot->>+solver 2: /settle
solver 2->>+blockchain: Execute transaction
blockchain->>-solver 2: Transaction receipt
Expand Down Expand Up @@ -121,8 +118,8 @@ Solvers have a short amount of time (seconds) to come up with a [solution](/cow-
The scoring process is described in detail in the [description of CoW Protocol's optimization problem](/cow-protocol/reference/core/auctions/the-problem).
The autopilot selects the winner according to the highest score once the allotted time expires or all solvers have returned their batch proposal.

Up to this point, the autopilot only knows the score and not the full solution that achieves that score.
The autopilot then asks the winning solver to reveal its score (through `/reveal`) and then to execute the corresponding settlement transaction (`/settle`).
Copy link
Contributor

Choose a reason for hiding this comment

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

Should still mention that we do a /settle call.

Up to this point, the autopilot only knows the score.
The autopilot then tells the winning driver to execute the settlement (`/settle`).
The solver is responsible for executing the transaction on-chain (through the [driver](./solver/driver) if using the reference implementation).

### Auction data storage
Expand Down
1 change: 0 additions & 1 deletion docs/cow-protocol/tutorials/arbitrate/solver/driver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ sequenceDiagram
solver engine-->>driver: set of solutions
driver->>driver: post-process solutions
driver-->>autopilot: participate with the best solution
autopilot->>driver: request to reveal details about the settlement,<br>in case this solver won
autopilot->>driver: request to execute the settlement,<br>in case this solver won
driver->>driver: execute the settlement
```
Expand Down
2 changes: 1 addition & 1 deletion docs/cow-protocol/tutorials/solvers/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Starting from this hash, we can use the competition endpoint:

[https://api.cow.fi/mainnet/api/v1/solver_competition/by_tx_hash/0x17271e39305217d36635afbcc882e9431f9195d561d814aba96986cdd12dd240](https://api.cow.fi/mainnet/api/v1/solver_competition/by_tx_hash/0x17271e39305217d36635afbcc882e9431f9195d561d814aba96986cdd12dd240)

and then we can see that the auction id was 6462225. Note also that the competition endpoint reveals the calldata of all submitted solutions that successfully simulated and got ranked.
and then we can see that the auction id was 6462225.

Using this id, we can now recover the instance.json of that auction:

Expand Down
Loading