Update docs and Readme.

Author: mesudip

docs/docs/hydra-js-client/examples/minting-native-tokens.md

@@ -0,0 +1,83 @@
+---
+sidebar_position: 4
+sidebar_label: Minting Native Tokens
+---
+
+# Minting Native Tokens
+
+This guide demonstrates how to mint native tokens within an open Hydra Head using the cip30 interface and `KuberHydraApiProvider`.
+
+## Prerequisites
+
+- Node.js environment
+- `libcardano` and `libcardano-wallet` installed.
+- An active Hydra Head (in "Open" state).
+- A configured `KuberHydraApiProvider` instance.
+- A minting policy script and its corresponding key hash.
+
+This example demonstrates how to build and submit a transaction that mints native tokens within an open Hydra Head.
+
+```typescript
+import { KuberHydraApiProvider } from "kuber-client";
+import { Value, Ed25519Key, loadCrypto } from "libcardano";
+import { ShelleyWallet, Cip30ShelleyWallet } from "libcardano-wallet";
+import { readFileSync } from "fs";
+
+async function runMintNativeTokensExample() {
+  // Initialize Hydra API Provider (replace with your Hydra node URL)
+  const hydra = new KuberHydraApiProvider("http://172.31.6.1:8082");
+
+  // Load test wallet signing key (used for signing the transaction)
+  const testWalletSigningKey = await Ed25519Key.fromCardanoCliJson(
+    JSON.parse(readFileSync(process.env.HOME + "/.cardano/preview/hydra-0/credentials/funds.sk", "utf-8")),
+  );
+
+  // Setup libcardano crypto and Shelley wallet
+  await loadCrypto();
+  const shelleyWallet = new ShelleyWallet(testWalletSigningKey);
+  const cip30Wallet = new Cip30ShelleyWallet(hydra, hydra, shelleyWallet, 0);
+  const walletAddress = (await cip30Wallet.getChangeAddress()).toBech32();
+
+  console.log("Wallet Address:", walletAddress);
+
+  // Ensure head is in 'Open' state
+  const headState = await hydra.queryHeadState();
+  if (headState.state !== "Open") {
+    console.log("Head is not in 'Open' state. Please ensure it's in 'Open' state before running this example.");
+    return;
+  }
+  console.log("Hydra Head is Open. Proceeding with minting transaction.");
+
+  // Define the minting transaction
+  // For a comprehensive reference on transaction builder fields, refer to:
+  // https://kuberide.com/kuber/docs/tx-builder-reference
+  const mintingTransaction = {
+    mint: [
+      {
+        script: {
+          type: "sig",
+          keyHash: shelleyWallet.paymentKey.pkh.toString('hex'), 
+        },
+        amount: {
+          Token1: 2,
+        },
+      },
+    ],
+    changeAddress: walletAddress,
+  };
+
+  try {
+    // Use the buildAndSubmitWithWallet function from KuberProvider to mint tokens
+    const mintResult = await hydra.buildAndSubmitWithWallet(cip30Wallet, mintingTransaction);
+    console.log("Minting transaction submitted to Hydra Head. Hash:", mintResult.hash);
+    console.log("CBOR Hex:", mintResult.cborHex);
+  } catch (error: unknown) {
+    if (error instanceof Error) {
+      console.error("Error building or submitting minting transaction:", error.message);
+    } else {
+      console.error("An unknown error occurred:", error);
+    }
+  }
+}
+
+runMintNativeTokensExample();

docs/docs/hydra-js-client/examples/submitting-hydra-transactions.md

@@ -14,6 +14,9 @@ This guide demonstrates how to build and submit transactions within an open Hydr
 - An active Hydra Head (in "Open" state).
 - A configured `KuberHydraApiProvider` instance.
 
+##### Transaction builder
+R efer to the [KuberIDE TxBuilder Object Reference](https://kuberide.com/kuber/docs/tx-builder-reference) for details of all transaction builder properties.
+
 This example demonstrates how to build and submit a simple transaction (sending Lovelace to an address) within an open Hydra Head using the `KuberHydraApiProvider` and a CIP-30 compatible wallet.
 
 ```typescript
@@ -48,15 +51,18 @@ async function runBuildAndSubmitTransactionExample() {
   console.log("Hydra Head is Open. Proceeding with transaction.");
 
   // Define the transaction outputs
-  const transaction = {
-    outputs: [{ address: walletAddress, value: { lovelace: "3000000" } }], // Sending 3 ADA
+  // For a comprehensive reference on transaction builder fields, refer to:
+  // https://kuberide.com/kuber/docs/tx-builder-reference
+  const txBuilder = {
+    outputs: [{ address: walletAddress, value: "3_000_000" } }], // Sending 3 ADA
     changeAddress: walletAddress,
   };
 
   try {
     // Use the buildAndSubmitWithWallet function from KuberProvider
-    const submitResult = await hydra.buildAndSubmitWithWallet(cip30Wallet, transaction);
-    console.log("Transaction submitted to Hydra Head. Result:", submitResult);    
+    const submitResult = await hydra.buildAndSubmitWithWallet(cip30Wallet, txBuilder);
+    console.log("Transaction submitted to Hydra Head. Hash:", submitResult.hash);
+    console.log("CBOR Hex:", submitResult.cborHex);
 
   } catch (error: unknown) {
     if (error instanceof Error) {

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

@@ -34,7 +34,8 @@ async function main() {
   try {
     console.log("Submitting transaction...");
     const result = await hydra.submitTx(signedCborTx);
-    console.log("Transaction submitted:", result);
+    console.log("Transaction submitted. Hash:", result.hash);
+    console.log("CBOR Hex:", result.cborHex);
   } catch (error) {
     console.error("Error submitting transaction:", error);
   }

docs/sidebars.ts

@@ -88,6 +88,7 @@ const sidebars: SidebarsConfig = {
         "hydra-js-client/examples/working-with-wallets",
         "hydra-js-client/examples/commiting-utxos-to-hydra",
         "hydra-js-client/examples/submitting-hydra-transactions",
+        "hydra-js-client/examples/minting-native-tokens",
       ],
     },
     {

kuber-hydra/README.md

@@ -4,6 +4,10 @@
 - [Architecture](https://dquadrant.github.io/kuber/hydra_docusaurus/docs/architecture)
 - [Getting Started with Kuber-Hydra](https://dquadrant.github.io/kuber/hydra_docusaurus/docs/hydra-js-client/getting-started)
 
+
+### Tests:
+ - [✅ Passing](https://dquadrant.github.io/kuber/test-reports/hydra/) on v4.0.0
+
 ## Running Kuber-Hydra
 
 ### With cabal