Merge feat/support-node-v11 into master

Author: mesudip

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

@@ -22,12 +22,13 @@ A `Promise` that resolves to an object containing information about the abort pr
 const { KuberHydraApiProvider } = require("kuber-client");
 
 async function main() {
-  const hydra = new KuberHydraApiProvider("http://localhost:8081"); // Replace with your Hydra API URL
+  const hydra = new KuberHydraApiProvider("http://localhost:8082");
 
   try {
     console.log("Aborting Hydra head initialization...");
-    const result = await hydra.abort(true); // Wait for abort to complete
-    console.log("Hydra head aborted:", result);
+    await hydra.abort(true); // Wait for abort to complete
+    const headState = await hydra.queryHeadState();
+    console.log("Hydra head state:", headState.state);
   } catch (error) {
     console.error("Error aborting Hydra head:", error);
   }

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

@@ -19,32 +19,34 @@ A `Promise` that resolves to a `CommonTxObject` representing the built transacti
 
 ## Example
 
-```javascript
-const { KuberHydraApiProvider } = require("kuber-client");
+```typescript
+import { readFileSync } from "fs";
+import { CardanoKeyAsync } from "libcardano";
+import { ShelleyWallet, SimpleCip30Wallet } from "libcardano-wallet";
+import { KuberHydraApiProvider } from "kuber-client";
 
 async function main() {
-  const hydra = new KuberHydraApiProvider("http://localhost:8081"); // Replace with your Hydra API URL
+  const hydra = new KuberHydraApiProvider("http://localhost:8082");
+  const signingKey = await CardanoKeyAsync.fromCardanoCliJson(
+    JSON.parse(readFileSync("../../kuber-hydra/devnet/credentials/alice-funds.sk", "utf-8")),
+  );
+  const wallet = new SimpleCip30Wallet(hydra, hydra, new ShelleyWallet(signingKey), 0);
+  const walletAddress = (await wallet.getChangeAddress()).toBech32();
 
   const transaction = {
-    outputs: [
-      {
-        address: "addr_test1qr...", // Recipient address
-        value: {
-          lovelace: "500000", // 0.5 ADA
-        },
-      },
-    ],
-    // Add other transaction parameters as needed, e.g., inputs, metadata
+    selections: [walletAddress],
+    outputs: [{ address: walletAddress, value: "1_000_000" }],
+    changeAddress: walletAddress,
   };
 
   try {
     console.log("Building transaction...");
     const builtTx = await hydra.buildTx(transaction, true); // Submit the transaction
-    console.log("Built transaction:", builtTx);
+    console.log("Transaction hash:", builtTx.hash);
   } catch (error) {
     console.error("Error building transaction:", error);
   }
 }
 
 main();
-```
+```

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

@@ -22,12 +22,13 @@ A `Promise` that resolves to an object containing information about the close pr
 const { KuberHydraApiProvider } = require("kuber-client");
 
 async function main() {
-  const hydra = new KuberHydraApiProvider("http://localhost:8081"); // Replace with your Hydra API URL
+  const hydra = new KuberHydraApiProvider("http://localhost:8082");
 
   try {
     console.log("Closing Hydra head...");
-    const result = await hydra.close(true); // Wait for closure to complete
-    console.log("Hydra head closed:", result);
+    await hydra.close(true); // Wait for closure to complete
+    const headState = await hydra.queryHeadState();
+    console.log("Hydra head state:", headState.state);
   } catch (error) {
     console.error("Error closing Hydra head:", error);
   }

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

@@ -19,27 +19,35 @@ A `Promise` that resolves to a `CommonTxObject` representing the commitment tran
 
 ## Example
 
-```javascript
-const { KuberHydraApiProvider } = require("kuber-client");
+```typescript
+import { readFileSync } from "fs";
+import { CardanoKeyAsync, Value } from "libcardano";
+import { ShelleyWallet, SimpleCip30Wallet } from "libcardano-wallet";
+import { UTxO } from "libcardano/serialization";
+import { KuberHydraApiProvider } from "kuber-client";
 
 async function main() {
-  const hydra = new KuberHydraApiProvider("http://localhost:8081"); // Replace with your Hydra API URL
-
-  const utxosToCommit = {
-    utxos: [
-      {
-        txIn: "yourTxHash#0", // Replace with a valid UTxO
-        value: {
-          lovelace: "1000000", // 1 ADA
-        },
-      },
-    ],
-  };
+  const hydra = new KuberHydraApiProvider("http://localhost:8082");
+  const signingKey = await CardanoKeyAsync.fromCardanoCliJson(
+    JSON.parse(readFileSync("../../kuber-hydra/devnet/credentials/alice-funds.sk", "utf-8")),
+  );
+  const wallet = new SimpleCip30Wallet(hydra, hydra, new ShelleyWallet(signingKey), 0);
+  const walletAddress = (await wallet.getChangeAddress()).toBech32();
+
+  const l1Utxos = await hydra.l1Api.queryUTxOByAddress(walletAddress);
+  const selectedUtxo = l1Utxos.find((utxo: UTxO) => utxo.txOut.value.greaterThan(Value.fromString("4A")));
+  if (!selectedUtxo) {
+    throw new Error(`Alice has no L1 UTxO larger than 4 ADA at ${walletAddress}`);
+  }
+
+  const txIn = `${selectedUtxo.txIn.txHash.toString("hex")}#${selectedUtxo.txIn.index}`;
 
   try {
     console.log("Committing UTxOs...");
-    const result = await hydra.commit(utxosToCommit, true); // Submit the transaction
-    console.log("Commit transaction:", result);
+    const commitTx = await hydra.commit({ utxos: [txIn] });
+    const signedTx = await wallet.signTx(commitTx.cborHex);
+    await hydra.l1Api.submitTx(signedTx.transaction.toBytes().toString("hex"));
+    console.log("Commit transaction hash:", commitTx.hash);
   } catch (error) {
     console.error("Error committing UTxOs:", error);
   }

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

@@ -19,25 +19,33 @@ A `Promise` that resolves to a `DecommitResult` object containing information ab
 
 ## Example
 
-```javascript
-const { KuberHydraApiProvider } = require("kuber-client");
+```typescript
+import { readFileSync } from "fs";
+import { CardanoKeyAsync } from "libcardano";
+import { ShelleyWallet, SimpleCip30Wallet } from "libcardano-wallet";
+import { KuberHydraApiProvider } from "kuber-client";
 
 async function main() {
-  const hydra = new KuberHydraApiProvider("http://localhost:8081"); // Replace with your Hydra API URL
-
-  // First, create the decommit transaction
-  const utxoToDecommit = "yourTxHash#0"; // Replace with a valid UTxO from the head
-  const decommitTx = await hydra.createDecommitTx(utxoToDecommit);
+  const hydra = new KuberHydraApiProvider("http://localhost:8082");
+  const signingKey = await CardanoKeyAsync.fromCardanoCliJson(
+    JSON.parse(readFileSync("../../kuber-hydra/devnet/credentials/alice-funds.sk", "utf-8")),
+  );
+  const wallet = new SimpleCip30Wallet(hydra, hydra, new ShelleyWallet(signingKey), 0);
+  const walletAddress = (await wallet.getChangeAddress()).toBech32();
+
+  const headUtxos = await hydra.queryUTxOByAddress(walletAddress);
+  if (headUtxos.length === 0) {
+    throw new Error(`Alice has no UTxO in the Hydra head at ${walletAddress}`);
+  }
 
-  // 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
+  const txIn = `${headUtxos[0].txIn.txHash.toString("hex")}#${headUtxos[0].txIn.index}`;
+  const decommitTx = await hydra.createDecommitTx(txIn);
+  const signedTx = await wallet.signTx(decommitTx.cborHex);
 
   try {
     console.log("Decommitting UTxOs...");
-    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);
+    const result = await hydra.decommit(signedTx.transaction.toBytes().toString("hex"), true);
+    console.log("Decommit transaction hash:", result.decommitTx.hash);
   } catch (error) {
     console.error("Error decommitting UTxOs:", error);
   }

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

@@ -33,7 +33,7 @@ async function runBurnNativeTokensExample() {
   const signingKey = await CardanoKeyAsync.fromCardanoCliJson(
     JSON.parse(
       readFileSync(
-        process.env.HOME + "/.cardano/preview/hydra-0/credentials/funds.sk",
+        "../../kuber-hydra/devnet/credentials/alice-funds.sk",
         "utf-8",
       ),
     ),
@@ -54,7 +54,7 @@ async function runBurnNativeTokensExample() {
       {
         script: {
           type: "sig",
-          keyHash: shelleyWallet.paymentKey.pkh.toString("hex"),
+          keyHash: shelleyWallet.paymentKey.publicKeyHash().toString("hex"),
         },
         amount: {
           Token1: -1,
@@ -65,7 +65,7 @@ async function runBurnNativeTokensExample() {
   };
 
   const result = await hydra.buildAndSubmitWithWallet(wallet, burnTx);
-  console.log("Burn transaction submitted:", result.transaction.toBytes().toString("hex"));
+  console.log("Burn transaction hash:", result.transaction.hash().toString("hex"));
 }
 
 runBurnNativeTokensExample().catch((err) => {

docs/docs/hydra-js-client/examples/commiting-utxos-to-hydra.md

@@ -11,7 +11,7 @@ The Kuber Hydra Client can be integrated with a CIP-30 compatible wallet to sign
 
 - Node.js environment
 - `libcardano` and `libcardano-wallet` installed.
-- Access to a running Hydra node and its credentials (e.g., `node.addr`, `funds.sk`).
+- Access to a running Hydra node and its credentials (e.g., `node.addr`, `alice-funds.sk`).
 
 This example demonstrates how to set up a `SimpleCip30Wallet` and use it to sign and submit a transaction to a Hydra Head.
 
@@ -22,20 +22,32 @@ import { ShelleyWallet, SimpleCip30Wallet } from "libcardano-wallet";
 import { KuberHydraApiProvider } from "kuber-client"; // Adjust path as needed
 import { UTxO } from "libcardano/serialization";
 
+function formatUtxo(utxo: UTxO) {
+  return {
+    txIn: `${utxo.txIn.txHash.toString("hex")}#${utxo.txIn.index}`,
+    address: utxo.txOut.address.toBech32(),
+    lovelace: utxo.txOut.value.lovelace.toString(),
+    assetPolicies: Object.keys(utxo.txOut.value.multiassets ?? {}).length,
+  };
+}
+
 async function runCip30CommitExample() {
   // Initialize Hydra API Provider
-  const hydra = new KuberHydraApiProvider("http://172.31.6.1:8082"); // Replace with your Hydra node URL
+  const hydra = new KuberHydraApiProvider("http://localhost:8082");
 
   // Load node address and test wallet signing key
   const node_addr_path = process.env.HOME + "/.cardano/preview/hydra-0/credentials/node.addr";
   const nodeAddr = readFileSync(node_addr_path).toString("utf-8").trim();
 
   // Setup Shelley wallet
   const testWalletSigningKey = await CardanoKeyAsync.fromCardanoCliJson(
-    JSON.parse(readFileSync(process.env.HOME + "/.cardano/preview/hydra-0/credentials/funds.sk", "utf-8")),
+    JSON.parse(readFileSync("../../kuber-hydra/devnet/credentials/alice-funds.sk", "utf-8")),
   );
   const shelleyWallet = new ShelleyWallet(testWalletSigningKey);
-  console.log("Wallet", shelleyWallet.toJSON());
+  console.table({
+    paymentKeyHash: shelleyWallet.paymentKey.publicKeyHash().toString("hex"),
+    networkId: 0,
+  });
 
   // Create SimpleCip30Wallet instance
   // The first two arguments are for the L1 API provider and the Hydra API provider, respectively.
@@ -66,10 +78,11 @@ async function runCip30CommitExample() {
 
   const txIn = selectedUtxos[0].txIn;
   const utxoToCommit = [`${txIn.txHash.toString("hex")}#${txIn.index}`];
+  console.table(selectedUtxos.map(formatUtxo));
 
   // Build the commit transaction using Hydra API
   const commitResult = await hydra.commit({ utxos: utxoToCommit });
-  console.log("Transaction to be signed:", commitResult.hash);
+  console.log("Commit transaction hash:", commitResult.hash);
 
   // Sign the transaction using the CIP-30 wallet
   const signResult = await cip30Wallet.signTx(commitResult.cborHex);

docs/docs/hydra-js-client/examples/devnet-cluster.md

@@ -12,9 +12,9 @@ This tutorial shows how to use `HydraTestCluster` from `kuber-client` to control
 - Local devnet is running (`cardano-node`, `hydra-node-{1,2,3}`, and `kuber-hydra-{1,2,3}`).
 - Devnet credentials exist in `kuber-hydra/devnet/credentials`.
 - You can reach relay endpoints:
-  - `http://localhost:8082` (alice)
-  - `http://localhost:8083` (bob)
-  - `http://localhost:8084` (carol)
+- `http://localhost:8082` (alice)
+- `http://localhost:8083` (bob)
+- `http://localhost:8084` (carol)
 
 ## 1) Configure cluster participants
 
@@ -38,20 +38,20 @@ const cluster = new HydraTestCluster();
 
 cluster.addParticipantConfig(
   "http://localhost:8082",
-  "../kuber-hydra/devnet/credentials/alice-funds.sk",
-  "../kuber-hydra/devnet/credentials/alice-hydra.sk"
+  "../../kuber-hydra/devnet/credentials/alice-funds.sk",
+  "../../kuber-hydra/devnet/credentials/alice-hydra.sk"
 );
 
 cluster.addParticipantConfig(
   "http://localhost:8083",
-  "../kuber-hydra/devnet/credentials/bob-funds.sk",
-  "../kuber-hydra/devnet/credentials/bob-hydra.sk"
+  "../../kuber-hydra/devnet/credentials/bob-funds.sk",
+  "../../kuber-hydra/devnet/credentials/bob-hydra.sk"
 );
 
 cluster.addParticipantConfig(
   "http://localhost:8084",
-  "../kuber-hydra/devnet/credentials/carol-funds.sk",
-  "../kuber-hydra/devnet/credentials/carol-hydra.sk"
+  "../../kuber-hydra/devnet/credentials/carol-funds.sk",
+  "../../kuber-hydra/devnet/credentials/carol-hydra.sk"
 );
 ```
 
@@ -79,9 +79,11 @@ async function runClusterFlow(cluster) {
   const bobHydra = bob.getKuberHydraApiProvider();
   const carolHydra = carol.getKuberHydraApiProvider();
 
-  console.log("Alice head:", await aliceHydra.queryHeadState());
-  console.log("Bob head:", await bobHydra.queryHeadState());
-  console.log("Carol head:", await carolHydra.queryHeadState());
+  console.table([
+    { participant: "alice", state: (await aliceHydra.queryHeadState()).state },
+    { participant: "bob", state: (await bobHydra.queryHeadState()).state },
+    { participant: "carol", state: (await carolHydra.queryHeadState()).state },
+  ]);
 
   await cluster.resetClusterToClosedState({ fanoutReady: true });
   await aliceHydra.fanout(true);

docs/docs/hydra-js-client/examples/full-end-to-end-example.md

@@ -128,9 +128,9 @@ The script targets three relays:
 
 Signing keys are loaded from:
 
-- `kuber-hydra/devnet/credentials/alice-hydra.sk`
-- `kuber-hydra/devnet/credentials/bob-hydra.sk`
-- `kuber-hydra/devnet/credentials/carol-hydra.sk`
+- `kuber-hydra/devnet/credentials/alice-funds.sk`
+- `kuber-hydra/devnet/credentials/bob-funds.sk`
+- `kuber-hydra/devnet/credentials/carol-funds.sk`
 
 ### Deterministic start
 
@@ -218,7 +218,7 @@ import { UTxO } from "libcardano/serialization";
 
 // Set your work directory and paths according to your local setup. 
 // This example assumes a specific structure for the devnet, so adjust as necessary for your environment. 
-const WORK_DIR = process.env.HOME + "/work/kuber/kuber-hydra/devnet";
+const WORK_DIR = "../../kuber-hydra/devnet";
 
 const hydraAlice = new KuberHydraApiProvider("http://localhost:8082");
 const hydraBob = new KuberHydraApiProvider("http://localhost:8083");
@@ -237,9 +237,9 @@ type PartyRuntime = PartyConfig & {
 };
 
 const PARTIES: PartyConfig[] = [
-  { name: "Alice", skPath: WORK_DIR + "/credentials/alice-hydra.sk", hydra: hydraAlice },
-  { name: "Bob", skPath: WORK_DIR + "/credentials/bob-hydra.sk", hydra: hydraBob },
-  { name: "Carol", skPath: WORK_DIR + "/credentials/carol-hydra.sk", hydra: hydraCarol },
+  { name: "Alice", skPath: WORK_DIR + "/credentials/alice-funds.sk", hydra: hydraAlice },
+  { name: "Bob", skPath: WORK_DIR + "/credentials/bob-funds.sk", hydra: hydraBob },
+  { name: "Carol", skPath: WORK_DIR + "/credentials/carol-funds.sk", hydra: hydraCarol },
 ];
 
 const DEVNET_RELAYS = [8082, 8083, 8084];
@@ -654,4 +654,3 @@ runHydraE2EFlow();
 }
 
 ```
-