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.

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

Conversation

m-lord-renkse
Copy link
Contributor

Description

Remove the references to /reveal endpoint, since it was removed.

Fixes #2942

Copy link

vercel bot commented Sep 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Sep 13, 2024 7:04am

Copy link

github-actions bot commented Sep 10, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@m-lord-renkse
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@m-lord-renkse m-lord-renkse marked this pull request as ready for review September 11, 2024 11:49
@m-lord-renkse m-lord-renkse requested a review from a team as a code owner September 11, 2024 11:49
@m-lord-renkse m-lord-renkse requested review from MartinquaXD and sunce86 and removed request for MartinquaXD September 11, 2024 11:49
Copy link
Contributor

@MartinquaXD MartinquaXD left a comment

Choose a reason for hiding this comment

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

Great that you though about updating the docs right away. 👍

Probably worth while to add a section about the shadow competition.
What we have at the moment is a bit thin.

@@ -122,7 +119,6 @@ The scoring process is described in detail in the [description of CoW Protocol's
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.

docs/cow-protocol/tutorials/arbitrate/README.mdx Outdated Show resolved Hide resolved
@m-lord-renkse
Copy link
Contributor Author

m-lord-renkse commented Sep 11, 2024

Probably worth while to add a section about the shadow competition.
What we have at the moment is a bit thin.

Good point @MartinquaXD ! do you think need to do it in this PR or in an upcoming one just for it?

Copy link
Contributor

@MartinquaXD MartinquaXD left a comment

Choose a reason for hiding this comment

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

I think a section about the shadow driver can happen in another PR.

docs/cow-protocol/tutorials/arbitrate/autopilot.md Outdated Show resolved Hide resolved
@m-lord-renkse
Copy link
Contributor Author

Issue created for extending/creating section for shadow competition: #415

@m-lord-renkse m-lord-renkse merged commit a81cd91 into main Sep 17, 2024
4 checks passed
@m-lord-renkse m-lord-renkse deleted the reveal-endpoint-removed branch September 17, 2024 16:11
@github-actions github-actions bot locked and limited conversation to collaborators Sep 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants