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

feat: use new solvers schema for driver <> solver_engine interface #139

Closed
fleupold opened this issue Nov 29, 2023 · 3 comments
Closed

feat: use new solvers schema for driver <> solver_engine interface #139

fleupold opened this issue Nov 29, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation E:2.1: Documentation and Tutorials https://github.com/cowprotocol/pm/issues/10 team:solvers Issues / PRs scoped to solvers

Comments

@fleupold
Copy link
Contributor

Problem

The legacy instance.json format is terribly redundant, full of inconsistencies and unnecessary fields and was refactored during the solver-driver colocation project in favour of a new/cleaner interface between driver and solver_engines (https://github.com/cowprotocol/services/blob/a72c4c374afea785929a0a0a98d7840faf3df34c/crates/solvers/openapi.yml)

Suggested solution

Explain the problem/result file in terms of the new data model and mark the existing document as deprecated (or remove altogether)

Alternatives considered

Keep maintaining the old json (but I think that's a bad idea)

@mfw78
Copy link
Contributor

mfw78 commented Dec 4, 2023

In regards to scoping for this, would this be a joint effort between backend and solvers?

@mfw78 mfw78 added documentation Improvements or additions to documentation E:2.1: Documentation and Tutorials https://github.com/cowprotocol/pm/issues/10 labels Dec 4, 2023
@fleupold
Copy link
Contributor Author

fleupold commented Dec 4, 2023

I think it should be driven by the solver team with the backend team providing clarification and help where needed. The interface itself is documented using swagger (and in code).
Maybe @fhenneke's test solver from dappcon could be adopted to work with the new interface.

@mfw78 mfw78 added the team:solvers Issues / PRs scoped to solvers label Dec 4, 2023
@mfw78 mfw78 changed the title feat: Replace Solvers Schema documentation with new driver <> solver_engine interface feat: use new solvers schema for driver <> solver_engine interface Dec 4, 2023
@fhenneke
Copy link
Contributor

One thing blocking me from changing the documentation is that the code and api specification for the new interface are inconsistent, see this issue.
I suppose the rust code is the reference then. But I am not familiar enough with it to derive the format of request and response.

@mfw78 mfw78 mentioned this issue Jan 9, 2024
5 tasks
mfw78 added a commit that referenced this issue Jan 9, 2024
# Description

This PR ensures that there is no missing content for blocking prod
release.

# Changes

- [x] Programmatic tutorials removed (to be migrated to tutorial repo)

Migrated to `draft` status (not visible in prod):
- [x] MEVBlocker (tracked in #268)
- [x] Grants section (tracked in #267)
- [x] Create a solver (tracked in #43)
- [x] Auction schemas (tracked in #139)
harisang added a commit that referenced this issue Feb 15, 2024
This PR updates the documentation regarding the solver/driver api, and
addresses issue #139 .

---------

Co-authored-by: Felix Henneke <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation E:2.1: Documentation and Tutorials https://github.com/cowprotocol/pm/issues/10 team:solvers Issues / PRs scoped to solvers
Projects
None yet
Development

No branches or pull requests

4 participants