Sign in
hydra

Commit the local participant funds into the head. (admin access required)

Changed on

Funds the head from the local participant's own L1 wallet UTxOs: builds and validates the node's commit draft, signs it, and submits it to L1.

post/hydra/head/commit

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/commit
  • Auth: API key in header token

Request body

headIdstring required

ID of the HydraHead

lovelacestring required

How much to put into the head. A dedicated UTxO of exactly this amount is carved on L1 first and only that is committed, so the rest of the wallet — its other ADA, its stablecoins, an agent's registry NFT — stays on L1 and spendable. Costs one L1 confirmation before the deposit is built.

Example request

{
  "headId": "cuid_v2_auto_generated",
  "lovelace": "10000000"
}

Response

Commit result

status'success' required

Example response

{
  "status": "success",
  "data": {
    "headId": "cuid_v2_auto_generated",
    "committed": true,
    "commitTxHash": null
  }
}

Changes