Update docs for decommit

Author: mesudip

docs/docs/hydra-js-client/decommit.md

@@ -5,18 +5,17 @@
 ## Function Signature
 
 ```typescript
-async decommit(utxos: Commit, wait: boolean = false, submit: boolean = false): Promise<any>
+async decommit(tx: HexString, wait: boolean = false): Promise<DecommitResult>
 ```
 
 ## Parameters
 
-- `utxos`: A `Commit` object specifying the UTxOs to be decommitted.
+- `tx`: A `HexString` representing the CBOR-encoded transaction to be decommitted.
 - `wait`: An optional `boolean` indicating whether to wait for the decommit to complete. Defaults to `false`.
-- `submit`: An optional `boolean` indicating whether to submit the transaction to the chain. Defaults to `false`.
 
 ## Returns
 
-A `Promise` that resolves to an object containing information about the decommit process.
+A `Promise` that resolves to a `DecommitResult` object containing information about the decommit process.
 
 ## Example
 
@@ -29,21 +28,19 @@ async function main() {
 
   const hydra = new KuberHydraApiProvider("http://localhost:8081"); // Replace with your Hydra API URL
 
-  const utxosToDecommit = {
-    utxos: [
-      {
-        txIn: "yourTxHash#0", // Replace with a valid UTxO from the head
-        value: {
-          lovelace: "500000", // 0.5 ADA
-        },
-      },
-    ],
-  };
+  // First, create the decommit transaction
+  const utxoToDecommit = "yourTxHash#0"; // Replace with a valid UTxO from the head
+  const decommitTx = await hydra.createDecommitTx(utxoToDecommit);
+
+  // Then, sign the transaction (assuming you have a wallet setup)
+  // const signedTx = await wallet.signTx(decommitTx.cborHex); // Replace 'wallet' with your actual wallet instance
+  const signedTxCbor = decommitTx.cborHex; // For demonstration, using unsigned CBOR
 
   try {
     console.log("Decommitting UTxOs...");
-    const result = await hydra.decommit(utxosToDecommit, true, true); // Wait and submit
+    const result = await hydra.decommit(signedTxCbor, true); // Pass the signed transaction CBOR and wait
     console.log("Decommit result:", result);
+    console.log("Decommit transaction hash:", result.decommitTx.txHash);
   } catch (error) {
     console.error("Error decommitting UTxOs:", error);
   }

docs/docs/kuber-hydra-api-reference.md

@@ -58,25 +58,38 @@ This section provides detailed documentation for the Kuber-Hydra backend API end
   ]}
 />
 
+<ApiEndpoint
+  method="GET"
+  path="/hydra/decommit"
+  title="Build Decommit Transaction"
+  description="Builds a decommit transaction."
+  queryParams={[
+    { name: "txin", type: "Array of T.Text", description: "List of transaction inputs to decommit." },
+  ]}
+  responses={[
+    { code: "200 OK", description: "Returns TxModal (transaction details)." },
+  ]}
+/>
+
 <ApiEndpoint
   method="POST"
   path="/hydra/decommit"
-  title="Decommit UTxOs from Hydra Head"
-  description="Decommits UTxOs from the Hydra Head."
+  title="Submit Decommit Transaction"
+  description="Submits a decommit transaction."
   queryParams={[
-    { name: "submit", type: "Boolean", description: "If true, the transaction will be submitted to the chain.", optional: true },
     { name: "wait", type: "Boolean", description: "If true, the request will wait for the transaction to be confirmed.", optional: true },
   ]}
   requestBody={{
-    type: "CommitUTxOs",
-    description: "Payload containing UTxOs to decommit and an optional signing key.",
+    type: "TxModal",
+    description: "Signed transaction details.",
     fields: [
-      { name: "utxos", type: "Array of TxIn (string)", description: "List of transaction inputs to decommit." },
-      { name: "signKey", type: "A.Value", description: "The signing key for the transaction.", optional: true },
+      { name: "cborHex", type: "string", description: "The CBOR-encoded transaction in hexadecimal format." },
+      { name: "type", type: "string", description: "The type of transaction (e.g., 'Witnessed Tx ConwayEra')." },
+      { name: "description", type: "string", description: "An optional description for the transaction." },
     ],
   }}
   responses={[
-    { code: "200 OK", description: "Success message." },
+    { code: "200 OK", description: "Returns DecommitResult (decommit transaction details)." },
   ]}
 />
 
@@ -154,9 +167,9 @@ This section provides detailed documentation for the Kuber-Hydra backend API end
     type: "TxModal",
     description: "Signed transaction details.",
     fields: [
-      { name: "signedTx", type: "string", description: "The signed transaction." },
-      { name: "witnesses", type: "Array", description: "Transaction witnesses." },
-      // Add more TxModal fields as needed based on its actual structure
+      { name: "cborHex", type: "string", description: "The CBOR-encoded transaction in hexadecimal format." },
+      { name: "type", type: "string", description: "The type of transaction (e.g., 'Witnessed Tx ConwayEra')." },
+      { name: "description", type: "string", description: "An optional description for the transaction." },
     ],
   }}
   responses={[
@@ -206,7 +219,7 @@ This section provides detailed documentation for the Kuber-Hydra backend API end
   title="Retrieve Hydra State"
   description="Retrieves the current state of the Hydra."
   responses={[
-    { code: "200 OK", description: "Returns the Hydra state." },
+    { code: "200 OK", description: "Returns an object containing the current HydraHeadState (e.g., { state: 'Open' })." },
   ]}
 />
 

docs/package.json

@@ -21,7 +21,7 @@
     "@docusaurus/theme-mermaid": "^3.8.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
-    "kuber-client": "3.3.2",
+    "kuber-client": "3.3.4",
     "libcardano": "2.2.8",
     "libcardano-wallet": "2.2.14",
     "prism-react-renderer": "^2.3.0",

docs/yarn.lock

@@ -7839,10 +7839,10 @@ kolorist@^1.8.0:
   resolved "https://registry.npmjs.org/kolorist/-/kolorist-1.8.0.tgz"
   integrity sha512-Y+60/zizpJ3HRH8DCss+q95yr6145JXZo46OTpFvDZWLfRCE4qChOyk1b26nMaNpfHHgxagk9dXT5OP0Tfe+dQ==
 
-kuber-client@3.3.2:
-  version "3.3.2"
-  resolved "https://registry.yarnpkg.com/kuber-client/-/kuber-client-3.3.2.tgz#29c233074b915c8a5af4b60bc0219b8d269a4d16"
-  integrity sha512-I4QHnnRaK4gBnsCjDv5EJzU/svd8WLQLG8dTERBPPWBSU53F4ncYAA1P9Vl9yoDoOgVCdWjZEBShKsNv3yxuFg==
+kuber-client@3.3.4:
+  version "3.3.4"
+  resolved "https://registry.yarnpkg.com/kuber-client/-/kuber-client-3.3.4.tgz#bdba16593def3e2f6c3cbe60ae8b18ba02c1cf93"
+  integrity sha512-NAOdZTVDN/gwnvkGCPvDiBU7UCPHqHM05HcbJuyFMqrB1yT2foPX8eD9Dr71p8onAeNxHGRKRb/pncRw4PJ1Kg==
   dependencies:
     axios "^1.9.0"
     buffer "^6.0.3"