curl --request GET \
--url https://api.example.com/v1/provider/get_commitment_info{
"commitments": [
{
"blockNumber": "<string>",
"commitments": [
{
"txnHashes": [
"<string>"
],
"revertableTxnHashes": [
"<string>"
],
"amount": "<string>",
"blockNumber": "<string>",
"providerAddress": "<string>",
"decayStartTimestamp": "<string>",
"decayEndTimestamp": "<string>",
"dispatchTimestamp": "<string>",
"slashAmount": "<string>",
"status": "<string>",
"details": "<string>",
"payment": "<string>",
"refund": "<string>",
"bidOptions": {
"options": [
{
"positionConstraint": {
"anchor": "ANCHOR_TOP",
"basis": "BASIS_PERCENTILE",
"value": 123
}
}
]
}
}
]
}
]
}GetCommitmentInfo
GetCommitmentInfo is called by the provider to retrieve the commitment information.
curl --request GET \
--url https://api.example.com/v1/provider/get_commitment_info{
"commitments": [
{
"blockNumber": "<string>",
"commitments": [
{
"txnHashes": [
"<string>"
],
"revertableTxnHashes": [
"<string>"
],
"amount": "<string>",
"blockNumber": "<string>",
"providerAddress": "<string>",
"decayStartTimestamp": "<string>",
"decayEndTimestamp": "<string>",
"dispatchTimestamp": "<string>",
"slashAmount": "<string>",
"status": "<string>",
"details": "<string>",
"payment": "<string>",
"refund": "<string>",
"bidOptions": {
"options": [
{
"positionConstraint": {
"anchor": "ANCHOR_TOP",
"basis": "BASIS_PERCENTILE",
"value": 123
}
}
]
}
}
]
}
]
}Query Parameters
Optional block number for which to get the commitment information. If not specified all block numbers are returned in ascending order
Optional page number for pagination. Defaults to 0.
Optional limit for the number of commitments to return per page. Defaults to 100.
Response
A successful response.
Response containing the commitment information.
List of commitments made in the block.
Show child attributes
Show child attributes
Block number for which the commitments are made.
List of commitments made in the block.
Show child attributes
Show child attributes
List of transaction hashes that are part of the commitment.
List of transaction hashes that are allowed to revert.
Amount of ETH in wei committed by the bidder.
Block number at which the commitment is made.
Hex string encoding of the address of the provider that signed the commitment signature.
Timestamp at which the bid starts decaying.
Timestamp at which the bid ends decaying.
Timestamp at which the commitment is published.
Amount of ETH that will be slashed from the provider if they fail to include the transaction.
Status of the commitment. Possible values: 'pending', 'stored', 'opened', 'settled', 'slashed', 'failed'.
Additional details about the commitment status.
Payment amount in wei for the commitment.
Refund amount in wei for the commitment, if applicable.
Options for the bid.
Show child attributes
Show child attributes
List of bid options.
Show child attributes
Show child attributes
Constraint on the position of the transaction in the block.
Show child attributes
Show child attributes
ANCHOR_TOP, ANCHOR_BOTTOM BASIS_PERCENTILE, BASIS_ABSOLUTE, BASIS_GAS_PERCENTILE Value of the position constraint. If anchor is TOP, this is the position from the top of the block. If anchor is BOTTOM, this is the position from the bottom of the block.