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 solver openapi spec #2323

Merged
merged 4 commits into from
Jan 30, 2024
Merged

Update solver openapi spec #2323

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5bf0757
Update solver openapi spec
MartinquaXD Jan 24, 2024
3fa6528
Merge branch 'main' into update-solver-openapi-spec
MartinquaXD Jan 24, 2024
74639d5
Merge branch 'main' into update-solver-openapi-spec
MartinquaXD Jan 29, 2024
6b43b08
Merge branch 'main' into update-solver-openapi-spec
MartinquaXD Jan 30, 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
69 changes: 53 additions & 16 deletions crates/solvers/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ info:
version: 0.0.1

paths:
/:
/solve:
post:
description: |
Solve the passed in auction instance.
Expand All @@ -23,9 +23,16 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Solution"
type: object
required:
- solutions
properties:
solutions:
description: |
Proposed solutions to settle some of the orders in the auction.
type: array
items:
$ref: "#/components/schemas/Solution"
400:
description: There is something wrong with the request.
429:
Expand All @@ -35,19 +42,24 @@ paths:
/notify:
post:
description: |
Receive a status notification about a previously provided solution
Receive a status notification about a previously provided solution.
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
description: |
A notification that informs the solver how its solution performed in the auction.
Depending on the notification type additional meta data may be attached but this
is not guaranteed to be stable.
properties:
auctionId:
description: |
The auction ID of the auction that the solution was provided
for.
type: number
type: string
solutionId:
description: |
The solution ID within the auction for which the notification applies
Expand All @@ -56,7 +68,7 @@ paths:
description: |
The kind of notification.
type: string
enum: [Timeout, EmptySolution, DuplicatedSolutionId, SimulationFailed, ZeroScore, ScoreHigherThanQuality, SuccessProbabilityOutOfRange, ObjectiveValueNonPositive, NonBufferableTokensUsed, SolverAccountInsufficientBalance, Success, Revert, Cancelled, Failed, PostprocessingTimedOut]
enum: [timeout, emptySolution, duplicatedSolutionId, simulationFailed, zeroScore, scoreHigherThanQuality, successProbabilityOutOfRange, objectiveValueNonPositive, nonBufferableTokensUsed, solverAccountInsufficientBalance, success, revert, driverError, cancelled, fail, postprocessingTimedOut]
Copy link
Contributor

Choose a reason for hiding this comment

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

simulationRevert instead of cancelled, at least the code says

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These are the notifications the solver currently understands.
Which part of the code are you referring to?

responses:
200:
description: notification successfully received.
Expand All @@ -81,6 +93,30 @@ components:
type: string
example: "1234567890"

U256:
description: |
256 bit unsigned integer in decimal notation.
type: string
example: "1234567890"

U128:
description: |
128 bit unsigned integer in decimal notation.
type: string
example: "1234567890"

I128:
description: |
128 bit signed integer in decimal notation.
type: string
example: "-1234567890"

I32:
description: |
32 bit signed integer in decimal notation.
type: number
example: -12345

BigInt:
description: |
An arbitrary-precision integer value.
Expand Down Expand Up @@ -206,7 +242,7 @@ components:
description: |
How was the order signed?
type: string
enum: [eip712, ethsign, presign, eip1271]
enum: [eip712, ethSign, preSign, eip1271]

Signature:
description: |
Expand Down Expand Up @@ -307,7 +343,7 @@ components:
- weight
properties:
scalingFactor:
$ref: "#/components/schemas/BigInt"
$ref: "#/components/schemas/Decimal"
weight:
$ref: "#/components/schemas/Decimal"
fee:
Expand Down Expand Up @@ -341,7 +377,7 @@ components:
- scalingFactor
properties:
scalingFactor:
$ref: "#/components/schemas/BigInt"
$ref: "#/components/schemas/Decimal"
amplificationParameter:
$ref: "#/components/schemas/Decimal"
fee:
Expand All @@ -368,17 +404,17 @@ components:
items:
$ref: "#/components/schemas/Token"
sqrtPrice:
$ref: "#/components/schemas/BigInt"
$ref: "#/components/schemas/U256"
liquidity:
$ref: "#/components/schemas/TokenAmount"
$ref: "#/components/schemas/U128"
tick:
type: integer
$ref: "#/components/schemas/I32"
liquidityNet:
description: |
A map of tick indices to their liquidity values.
type: object
additionalProperties:
$ref: "#/components/schemas/BigInt"
$ref: "#/components/schemas/I128"
fee:
$ref: "#/components/schemas/Decimal"

Expand Down Expand Up @@ -586,6 +622,7 @@ components:
required:
- kind
- order
- executedAmount
properties:
kind:
type: string
Expand Down Expand Up @@ -711,7 +748,7 @@ components:

Solution:
description: |
The computed solution for a given auction.
A computed solution for a given auction.
type: object
required:
- id
Expand All @@ -729,7 +766,7 @@ components:
arbitrary denomination.
type: object
additionalProperties:
$ref: "#/components/schemas/BigInt"
$ref: "#/components/schemas/U256"
trades:
description: |
CoW Protocol order trades included in the solution.
Expand Down
Loading