API Reference
Preconfirmer API
This namespace defines endpoints that should be called by users or applications to interact with the Taiyi preconfirmer
Index
- Submit Preconf Request
- Cancel Preconf Request
- Submit Preconf Transaction
- Get Preconf Request
- Get Available Slots
Submit Preconf Request
/commitments/v1/preconf_request
Endpoint for submitting a preconfirmation request.
Property | Value | Description |
---|---|---|
Method | POST | The HTTP method used for this endpoint |
Response | PreconfResponse | The type of response returned by the endpoint |
Headers | Content-Type: application/json | The required headers for the request |
Body | PreconfRequest | The type of data expected in the request body |
Cancel Preconf Request
/commitments/v1/preconf_request
Endpoint for cancelling a preconfirmation request.
Property | Value | Description |
---|---|---|
Method | DELETE | The HTTP method used for this endpoint |
Response | CancelPreconfResponse | The type of response returned by the endpoint |
Headers | Content-Type: application/json | The required headers for the request |
Body | CancelPreconfRequest | The type of data expected in the request body |
Submit Preconf Transaction
/commitments/v1/preconf_request/tx
Endpoint for submitting a preconfirmation transaction.
Property | Value | Description |
---|---|---|
Method | POST | The HTTP method used for this endpoint |
Response | - | - |
Headers | Content-Type: application/json | The required headers for the request |
Body | PreconfTxRequest | The type of data expected in the request body |
Get Preconf Request Status
/commitments/v1/preconf_request/:preconf_hash
Endpoint for checking the status of a preconfirmation request.
Property | Value | Description |
---|---|---|
Method | GET | The HTTP method used for this endpoint |
Response | PreconfStatusResponse | The type of response returned by the endpoint |
Headers | Content-Type: application/json | The required headers for the request |
Path Parameters | preconf_hash: PreconfHash | The hash of the preconfirmation request |
Get Available Slots
/commitments/v1/slots
Endpoint for retrieving available slots for preconfirmation.
Property | Value | Description |
---|---|---|
Method | GET | The HTTP method used for this endpoint |
Response | AvailableSlotResponse | The type of response returned by the endpoint |
Headers | Content-Type: application/json | The required headers for the request |