Fix: update docs

Temasar1 · Temasar1 · commit 5e8791c658dd · 2025-09-21T15:34:09.000+01:00
diff --git a/apps/docs/content/docs/hydra/tutorial.mdx b/apps/docs/content/docs/hydra/tutorial.mdx
@@ -214,7 +214,7 @@ After initialization, both participants need to commit funds to the head. In thi
 import { HydraInstance , HydraProvider} from "@meshsdk/hydra";
 
 const provider = new HydraProvider({
-  url: "<URL>",
+  httpUrl: "<URL>",
 });
 const hInstance = new HydraInstance({
   provider: provider,
diff --git a/apps/docs/content/docs/providers/hydra.mdx b/apps/docs/content/docs/providers/hydra.mdx
@@ -2,6 +2,7 @@
 title: "Hydra Provider (beta)"
 desceription: "Layer 2 scaling solution for Cardano that increases transaction throughput and ensures cost efficiency while maintaining security."
 ---
+
 import Link from "fumadocs-core/link";
 
 The <Link href="https://hydra.family/head-protocol/">Hydra Head protocol</Link> is a layer 2 scaling solution for Cardano rooted in peer-reviewed research that increases transaction throughput and ensures cost efficiency while maintaining rigorous security.
@@ -13,66 +14,80 @@ import { HydraProvider } from "@meshsdk/hydra";
 
 // Hydra Head URL and PORT: e.g. http://123.45.67.890:4001
 
-const provider = new HydraProvider('<URL>');
-await provider.connect();
+const provider = new HydraProvider("<httpUrl>");
 ```
 
+## connect
 
-## Connect Hydra Head
-
-Connects to the Hydra Head. This command is a no-op when a Head is already open.
+Establishes a connection to a Hydra Head. This is typically managed through the HydraProvider..
 
 ```tsx
 await provider.connect();
 ```
 
+## disconnect
+
+Closes the active connection to a Hydra Head. This is typically managed through the HydraProvider.
 
-## Initializes a new Hydra Head
+Parameter (Optional)
 
-Initializes a new Head. This command is a no-op when a Head is already open and the server will output an `CommandFailed` message should this happen.
+- timeout: Specifies the timeout duration in milliseconds. The default timeout is 5 minutes (300,000 ms).
 
 ```tsx
-await provider.init();
+// Disconnect with default timeout (5 minutes)
+await disconnect(timeout);
+
+// Disconnect with custom timeout (e.g., 10 minutes)
+await disconnect(10 * 60 * 1000);
 ```
 
+## Hydra commands APIs
 
-## Commit to Hydra Head
+### Initialize
 
-Commit a particular UTxO to the head. This will make the UTxO available on the layer 2.
+Initializes a new Head. This command is a no-op when a Head is already open and the server will
+output an `CommandFailed` message should this happen.
 
 ```tsx
-// Params: CommitUtxo, KeyToSign
-await instance.commit("", undefined);
+await provider.init();
 ```
 
+### Abort
 
-## Aborts a head
-
-Aborts a head before it is opened. This can only be done before all participants have committed. Once opened, the head can't be aborted anymore but it can be closed using: `Close`.
+Aborts a head before it is opened. This can only be done before all participants have committed.
+Once opened, the head can't be aborted anymore but it can be closed using: `Close`.
 
 ```tsx
 await provider.abort();
 ```
 
+### Commit
 
-## New Transaction
+Commit a particular UTxO to the head. This will make the UTxO available on the layer 2.
+This is used together with the [`HydraInstance`](../hydra/instance) (see the Hydra Instance page for details).
 
-Submit a transaction through the head. Note that the transaction is only broadcast if well-formed and valid.
+```tsx
+await instance.commitFunds(txHash, outputIndex);
+```
 
-You can also the `await provider.submitTx(signedTx)` method to submit a signed transaction.
+### New Transaction
 
+Submit a transaction through the head. Note that the transaction is only broadcast if well-formed and valid.
 The `newTx` method accepts the following arguments:
 
+**parameters**
+
+- cborHex: This is the transaction in hex format usually the unsigned transaction.
+- type: Any transaction is tried to decode as a 'ConwayEra' transaction, which mostly is backward compatible to previous eras.
+- description(optional): transaction description
+
 ```tsx
-async newTx(
-  cborHex: string,
-  type:
-    | "Tx ConwayEra"
-    | "Unwitnessed Tx ConwayEra"
-    | "Witnessed Tx ConwayEra",
-  description = "",
-  txId?: string
-)
+async newTx({
+    cborHex: "<unsignedTx>",
+    description: "commit tx",
+    type: "Tx ConwayEra",
+  })
+
 ```
 
 Here is an example of how to create a transaction using the Hydra provider, Mesh wallet and Mesh transaction builder:
@@ -105,10 +120,9 @@ async function makeTx() {
   });
 
   const unsignedTx = await txBuilder
-    .txOut(
-      "addr_test1vpd5axpq4qsh8sxvzny49cp22gc5tqx0djf6wmjv5cx7q5qyrzuw8",
-      [{ unit: "lovelace", quantity: "3000000" }],
-    )
+    .txOut("addr_test1vpd5axpq4qsh8sxvzny49cp22gc5tqx0djf6wmjv5cx7q5qyrzuw8", [
+      { unit: "lovelace", quantity: "3000000" },
+    ])
     .changeAddress(changeAddress)
     .selectUtxosFrom(utxos)
     .complete();
@@ -119,80 +133,66 @@ async function makeTx() {
 }
 ```
 
-
-## Decommit
+### Decommit
 
 Request to decommit a UTxO from a Head by providing a decommit tx. Upon reaching consensus, this will eventually result in corresponding transaction outputs becoming available on the layer 1.
 
 The decommit method accepts the following arguments:
 
 ```tsx
-async decommit(
-  cborHex: string,
-  type:
-    | "Tx ConwayEra"
-    | "Unwitnessed Tx ConwayEra"
-    | "Witnessed Tx ConwayEra",
-  description = "",
-)
+async decommit({
+  cborHex: "<unsignedTx>",
+  description: "commit tx",
+  type: "Tx ConwayEra"
+})
 ```
 
-
-## Close Hydra Head
+### Close
 
 Terminate a head with the latest known snapshot. This effectively moves the head from the Open state to the Close state where the contestation phase begin. As a result of closing a head, no more transactions can be submitted via NewTx.
 
 ```tsx
 await provider.close();
 ```
 
+### Contest
 
-## Contest
-
-Challenge the latest snapshot announced as a result of a head closure from another participant. Note that this necessarily contest with the latest snapshot known of your local Hydra node. Participants can only contest once.
+Challenge the latest snapshot announced as a result of a head closure from another participant.
+Note that this necessarily contest with the latest snapshot known of your local Hydra node. Participants can only contest once.
 
 ```tsx
 await provider.contest();
 ```
 
+### Fanout
 
-## Fanout
-
-Finalize a head after the contestation period passed. This will distribute the final (as closed and maybe contested) head state back on the layer 1.
+Finalize a head UTxOs to L1 after the contestation period passed.
 
 ```tsx
 await provider.fanout();
 ```
 
-
-## Listens for new messages from Hydra node
-
-Listens for new messages from Hydra node. The callback function will be called with the message as the only argument. Check <Link href="https://hydra.family/head-protocol/api-reference">all events emitted</Link> by the Hydra node.
-
-```tsx
-provider.onMessage((message) => {
-  console.log("HydraProvider received message", message);
-  // do something with the message
-});
-```
-
-The callback function is typed, so you can access the message properties directly.
-
 ```tsx
 provider.onMessage((message) => {
-  if (message.tag === "Greetings") {
-    console.log("message.snapshotUtxo", message.snapshotUtxo);
+  if (
+    message.headStatus === "FanoutPossible" ||
+    message.tag === "HeadIsFinalized"
+  ) {
+    provider.fanout();
   }
 });
 ```
 
+## Hydra Query APIs
 
-## Fetch Address UTxOs
+### Fetch Address UTxOs
 
 Fetch UTxOs controlled by an address.
 
 ```tsx
-await provider.fetchAddressUTxOs('addr_test1qpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0uafhxhu32dys6pvn6wlw8dav6cmp4pmtv7cc3yel9uu0nq93swx9')
+await provider.fetchAddressUTxOs(
+  "addr_test1qpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0uafhxhu32dys6pvn6wlw8dav6cmp4pmtv7cc3yel9uu0nq93swx9"
+);
 ```
 
 Optionally, you can filter UTXOs containing a particular asset by providing `asset`, where it is the concatenation of policy ID and asset.
@@ -202,37 +202,55 @@ Optionally, you can filter UTXOs containing a particular asset by providing `ass
 await fetchAddressUTxOs(address: string, asset?: string)
 ```
 
-
-## Fetch Protocol Parameters
+### Fetch Protocol Parameters
 
 Fetch the latest protocol parameters.
 
 ```tsx
-await provider.fetchProtocolParameters()
+await provider.fetchProtocolParameters();
 ```
 
 Optionally, you can provide an epoch number to fetch the protocol parameters of that epoch.
 
-
-## Fetch UTxOs
+### Fetch UTxOs
 
 Get UTxOs for a given hash.
 
 ```tsx
-await provider.fetchUTxOs('dfd2a2616e6154a092807b1ceebb9ddcadc0f22cf5c8e0e6b0757815083ccb70')
+await provider.fetchUTxOs("txHash");
 ```
 
 Optionally, you can specify the index of the index output.
 
 ```tsx
-await provider.fetchUTxOs('hash_here', 0)
+await provider.fetchUTxOs("txHash", 0);
 ```
 
+### Listens for new messages from Hydra node
 
-## Submit Transaction
+Listens for new messages from Hydra node. The callback function will be called with the message as the only argument. Check <Link href="https://hydra.family/head-protocol/api-reference">all events emitted</Link> by the Hydra node.
+
+```tsx
+provider.onMessage((message) => {
+  console.log("HydraProvider received message", message);
+  // do something with the message
+});
+```
+
+The callback function is typed, so you can access the message properties directly.
+
+```tsx
+provider.onMessage((message) => {
+  if (message.tag === "Greetings") {
+    console.log("message.snapshotUtxo", message.snapshotUtxo);
+  }
+});
+```
+
+### Submit Transaction
 
 Submit a serialized transaction to the network.
 
 ```tsx
 await provider.submitTx(signedTx);
-```
+```
