feat(core): Client.waitTransaction

ckb-devrel · Oct 10, 2024 · 8824ff2 · 8824ff2
1 parent c092988
commit 8824ff2
Show file tree

Hide file tree

Showing 11 changed files with 103 additions and 37 deletions.
diff --git a/.changeset/curvy-horses-arrive.md b/.changeset/curvy-horses-arrive.md
@@ -0,0 +1,9 @@
+---
+"@ckb-ccc/core": patch
+"@ckb-ccc/ccc": patch
+"ckb-ccc": patch
+"@ckb-ccc/connector": patch
+"@ckb-ccc/connector-react": patch
+---
+
+feat(core): Client.waitTransaction
diff --git a/packages/core/src/client/client.ts b/packages/core/src/client/client.ts
@@ -12,7 +12,7 @@ import {
 import { Zero } from "../fixedPoint/index.js";
 import { Hex, HexLike, hexFrom } from "../hex/index.js";
 import { Num, NumLike, numFrom, numMax } from "../num/index.js";
-import { apply, reduceAsync } from "../utils/index.js";
+import { apply, reduceAsync, sleep } from "../utils/index.js";
 import { ClientCache } from "./cache/index.js";
 import { ClientCacheMemory } from "./cache/memory.js";
 import { ClientCollectableSearchKeyLike } from "./clientTypes.advanced.js";
@@ -26,6 +26,7 @@ import {
   ClientIndexerSearchKeyLike,
   ClientIndexerSearchKeyTransactionLike,
   ClientTransactionResponse,
+  ErrorClientWaitTransactionTimeout,
   OutputsValidator,
 } from "./clientTypes.js";
 
@@ -567,4 +568,48 @@ export abstract class Client {
       transaction: tx,
     };
   }
+
+  async waitTransaction(
+    txHash: HexLike,
+    confirmations: number = 0,
+    timeout: number = 30000,
+    interval: number = 2000,
+  ): Promise<ClientTransactionResponse | undefined> {
+    const startTime = Date.now();
+    let tx: ClientTransactionResponse | undefined;
+
+    const getTx = async () => {
+      const res = await this.getTransaction(txHash);
+      if (
+        !res ||
+        res.blockNumber == null ||
+        ["sent", "pending", "proposed"].includes(res.status)
+      ) {
+        return undefined;
+      }
+
+      tx = res;
+      return res;
+    };
+
+    while (true) {
+      if (!tx) {
+        if (await getTx()) {
+          continue;
+        }
+      } else if (confirmations === 0) {
+        return tx;
+      } else if (
+        (await this.getTipHeader()).number - tx!.blockNumber! >=
+        confirmations
+      ) {
+        return tx;
+      }
+
+      if (Date.now() - startTime + interval >= timeout) {
+        throw new ErrorClientWaitTransactionTimeout();
+      }
+      await sleep(interval);
+    }
+  }
 }
diff --git a/packages/core/src/client/clientTypes.ts b/packages/core/src/client/clientTypes.ts
@@ -304,3 +304,9 @@ export class ErrorClientRBFRejected extends ErrorClientBase {
     this.leastFee = numFrom(leastFee);
   }
 }
+
+export class ErrorClientWaitTransactionTimeout extends Error {
+  constructor() {
+    super("Wait transaction timeout");
+  }
+}
diff --git a/packages/core/src/utils/index.ts b/packages/core/src/utils/index.ts
@@ -1,3 +1,5 @@
+import { NumLike, numFrom } from "../num/index.js";
+
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
  * @public
@@ -166,6 +168,10 @@ export async function reduceAsync<T, V>(
   );
 }
 
+export function sleep(ms: NumLike) {
+  return new Promise((resolve) => setTimeout(resolve, Number(numFrom(ms))));
+}
+
 /**
  * @public
  */

diff --git a/packages/demo/src/app/connected/(tools)/IssueXUdtSus/page.tsx b/packages/demo/src/app/connected/(tools)/IssueXUdtSus/page.tsx
@@ -167,10 +167,10 @@ export default function IssueXUdtSul() {
                 ccc.bytesFrom(ccc.hashTypeId(mintTx.inputs[0], 1)).slice(0, 20),
               );
               await mintTx.completeFeeBy(signer);
-              log(
-                "Transaction sent:",
-                explorerTransaction(await signer.sendTransaction(mintTx)),
-              );
+              const mintTxHash = await signer.sendTransaction(mintTx);
+              log("Transaction sent:", explorerTransaction(mintTxHash));
+              await signer.client.waitTransaction(mintTxHash);
+              log("Transaction committed:", explorerTransaction(mintTxHash));
             }}
           >
             Issue

diff --git a/packages/demo/src/app/connected/(tools)/IssueXUdtTypeId/page.tsx b/packages/demo/src/app/connected/(tools)/IssueXUdtTypeId/page.tsx
@@ -196,10 +196,10 @@ export default function IssueXUdtTypeId() {
                 ccc.bytesFrom(ccc.hashTypeId(mintTx.inputs[0], 2)).slice(0, 20),
               );
               await mintTx.completeFeeBy(signer);
-              log(
-                "Transaction sent:",
-                explorerTransaction(await signer.sendTransaction(mintTx)),
-              );
+              const mintTxHash = await signer.sendTransaction(mintTx);
+              log("Transaction sent:", explorerTransaction(mintTxHash));
+              await signer.client.waitTransaction(mintTxHash);
+              log("Transaction committed:", explorerTransaction(mintTxHash));
             }}
           >
             Issue

diff --git a/packages/demo/src/app/connected/(tools)/NervosDao/page.tsx b/packages/demo/src/app/connected/(tools)/NervosDao/page.tsx
@@ -230,10 +230,10 @@ function DaoButton({ dao }: { dao: ccc.Cell }) {
           }
 
           // Sign and send the transaction
-          log(
-            "Transaction sent:",
-            explorerTransaction(await signer.sendTransaction(tx)),
-          );
+          const txHash = await signer.sendTransaction(tx);
+          log("Transaction sent:", explorerTransaction(txHash));
+          await signer.client.waitTransaction(txHash);
+          log("Transaction committed:", explorerTransaction(txHash));
         })();
       }}
       className={`align-center ${isNew ? "text-yellow-400" : "text-orange-400"}`}
@@ -400,10 +400,10 @@ export default function Transfer() {
             await tx.completeFeeBy(signer, feeRate);
 
             // Sign and send the transaction
-            log(
-              "Transaction sent:",
-              explorerTransaction(await signer.sendTransaction(tx)),
-            );
+            const txHash = await signer.sendTransaction(tx);
+            log("Transaction sent:", explorerTransaction(txHash));
+            await signer.client.waitTransaction(txHash);
+            log("Transaction committed:", explorerTransaction(txHash));
           }}
         >
           Deposit

diff --git a/packages/demo/src/app/connected/(tools)/TimeLockedTransfer/page.tsx b/packages/demo/src/app/connected/(tools)/TimeLockedTransfer/page.tsx
@@ -83,10 +83,10 @@ function ClaimButton({ cell, lock }: { cell: ccc.Cell; lock: ccc.Script }) {
           await tx.completeInputsByCapacity(signer);
           await tx.completeFeeChangeToOutput(signer, 0);
 
-          log(
-            "Transaction sent:",
-            explorerTransaction(await signer.sendTransaction(tx)),
-          );
+          const txHash = await signer.sendTransaction(tx);
+          log("Transaction sent:", explorerTransaction(txHash));
+          await signer.client.waitTransaction(txHash);
+          log("Transaction committed:", explorerTransaction(txHash));
         })();
       }}
       className="align-center text-yellow-400"
@@ -149,10 +149,10 @@ export default function TimeLockedTransfer() {
     await tx.completeInputsByCapacity(signer);
     await tx.completeFeeBy(signer);
 
-    log(
-      "Transaction sent:",
-      explorerTransaction(await signer.sendTransaction(tx)),
-    );
+    const txHash = await signer.sendTransaction(tx);
+    log("Transaction sent:", explorerTransaction(txHash));
+    await signer.client.waitTransaction(txHash);
+    log("Transaction committed:", explorerTransaction(txHash));
   }, [
     signer,
     amount,

diff --git a/packages/demo/src/app/connected/(tools)/Transfer/page.tsx b/packages/demo/src/app/connected/(tools)/Transfer/page.tsx
@@ -106,10 +106,10 @@ export default function Transfer() {
             await tx.completeFeeBy(signer, feeRate);
 
             // Sign and send the transaction
-            log(
-              "Transaction sent:",
-              explorerTransaction(await signer.sendTransaction(tx)),
-            );
+            const txHash = await signer.sendTransaction(tx);
+            log("Transaction sent:", explorerTransaction(txHash));
+            await signer.client.waitTransaction(txHash);
+            log("Transaction committed:", explorerTransaction(txHash));
           }}
         >
           Transfer

diff --git a/packages/demo/src/app/connected/(tools)/TransferLumos/page.tsx b/packages/demo/src/app/connected/(tools)/TransferLumos/page.tsx
@@ -113,10 +113,10 @@ export default function TransferLumos() {
               tx.outputsData[0] = ccc.hexFrom(dataBytes);
 
               // Sign and send the transaction
-              log(
-                "Transaction sent:",
-                explorerTransaction(await signer.sendTransaction(tx)),
-              );
+              const txHash = await signer.sendTransaction(tx);
+              log("Transaction sent:", explorerTransaction(txHash));
+              await signer.client.waitTransaction(txHash);
+              log("Transaction committed:", explorerTransaction(txHash));
             }}
           >
             Transfer

diff --git a/packages/demo/src/app/connected/(tools)/TransferXUdt/page.tsx b/packages/demo/src/app/connected/(tools)/TransferXUdt/page.tsx
@@ -86,10 +86,10 @@ export default function TransferXUdt() {
             await tx.completeFeeBy(signer);
 
             // Sign and send the transaction
-            log(
-              "Transaction sent:",
-              explorerTransaction(await signer.sendTransaction(tx)),
-            );
+            const txHash = await signer.sendTransaction(tx);
+            log("Transaction sent:", explorerTransaction(txHash));
+            await signer.client.waitTransaction(txHash);
+            log("Transaction committed:", explorerTransaction(txHash));
           }}
         >
           Transfer