API docs by Redocly

Provider API (1.0.0-alpha)

Download OpenAPI specification:Download

License: Business Source License 1.1

CancelTransaction

CancelTransaction is called by the provider to cancel a transaction sent from this wallet.

path Parameters
txHash
required
string

Hex string encoding of the hash of the transaction that the bidder wants to cancel.

Responses

Response samples

Content type
application/json
{
  • "txHash": "71c1348f2d7ff7e814f9c3617983703435ea7446de420aeac488bf1de35737e8"
}

GetMinStake

GetMinStake is called by the provider to get the minimum stake required to be in the provider registry.

Responses

Response samples

Content type
application/json
{
  • "amount": "1000000000000000000"
}

GetPendingTxns

GetPendingTxns is called by the provider to get the pending transactions for the wallet.

Responses

Response samples

Content type
application/json
{
  • "pendingTxns": [
    ]
}

GetStake

GetStake is called by the provider to get its stake in the provider registry.

Responses

Response samples

Content type
application/json
{
  • "amount": "1000000000000000000"
}

ReceiveBids

ReceiveBids is called by the provider to receive bids from the mev-commit node. The mev-commit node will stream bids to the provider as the response.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

RegisterStake

RegisterStake is called by the provider to register its stake in the provider registry.

path Parameters
amount
required
string

Amount of ETH to stake in the provider provider_registry.

Responses

Response samples

Content type
application/json
{
  • "amount": "1000000000000000000"
}

SendProcessedBids

SendProcessedBids is called by the provider to send processed bids to the mev-commit node. The provider will stream processed bids to the mev-commit node.

Request Body schema: application/json

Response sent by the provider with the decision on the bid received. (streaming inputs)

bidDigest
required
string <byte>

Digest of the bid message signed by the bidder.

status
required
string (v1BidResponseStatus)
Enum: "STATUS_ACCEPTED" "STATUS_REJECTED"

Responses

Request samples

Content type
application/json
{
  • "bidDigest": "9dJinwL+FZ6B1xsIQQo8t8B0ZXJubJwY86l/Yu7yAH159QrPHU0qj2P+YFj+llbuI1ZygdxGsX8+P3byMEA5ig==",
  • "status": "STATUS_ACCEPTED"
}

Response samples

Content type
application/json
{ }