Sign in
hydra

Read a Hydra head state on L1. (admin access required)

Changed on

Reads the newest transaction that moved the head's state token, through the payment source's independent L1 observer. Returns whether the head is still open, closed (contestation running), or fanned out. Read-only.

post/hydra/head/chain-check

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/hydra/head/chain-check
  • Auth: API key in header token

Request body

idstring required

ID of the HydraHead to check

Example request

{
  "id": "cuid_v2_auto_generated"
}

Response

Head state on chain

status'success' required

Example response

{
  "status": "success",
  "data": {
    "chainState": "open",
    "latestTxHash": "cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd"
  }
}

Changes