Sign in

v1

latestOpenAPI 3.0.02026-07-17493090.2 KB
Scabbard

Get the statuses of a list of batches

This endpoint can be used to check the status of one or more batches that were submitted to a Scabbard service. The IDs of the batches to check should be specified with the ids query parameter. The wait query parameter requests that the server wait for the given number of seconds for the batches to be committed; however, this wait time is not guaranteed.

This endpoint requires the permission "scabbard.read".

get/scabbard/{circuit}/{service_id}/batch_statuses

Path parameters

circuitstring required

Circuit the targeted service belongs to

service_idstring required

ID of the targeted service

Query parameters

idsstring required

Comma-separated list of batch IDs

waitinteger

Time (in seconds) to wait for batches to be committed. If not provided, the server will return the batch statuses immediately. If the parameter is provided without a value, the default time (300 seconds) will be used.

Headers

Authorizationstring required

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersioninteger
Example:2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Response

The statuses of the batches were successfully retrieved

idstring

The batch's ID

Example response

[
  {
    "id": "6ff35474a572087e08fd6a54d563bd8172951b363e5c9731f1a40a855e14bba45dac515364a08d8403f4fb5d4a206174b7f63c29e4f4e425dc71b95494b8a798",
    "status": {
      "message": [
        {
          "transaction_id": "f4e147ff464013deccb3e68bb8619beffb29ff86b401257c93bcf8ef76d7ca173fa84b4f4a58414ad2d00a2c9f810cbb726e01cd26ebd44720239d9d35853099",
          "error_message": "Wasm contract returned invalid transaction: xo, 0.3.3"
        }
      ]
    }
  }
]