-
Notifications
You must be signed in to change notification settings - Fork 14
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
Comments
In regards to scoping for this, would this be a joint effort between backend and solvers? |
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). |
One thing blocking me from changing the documentation is that the code and api specification for the new interface are inconsistent, see this issue. |
# 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)
This PR updates the documentation regarding the solver/driver api, and addresses issue #139 . --------- Co-authored-by: Felix Henneke <[email protected]>
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)
The text was updated successfully, but these errors were encountered: