@0xobelisk/sui-client 1.1.6 → 1.1.8

package/README.md

@@ -45,17 +45,17 @@ There are two ways to initialize the Dubhe client:
 1. Using dynamic metadata loading:
 
 ```typescript
-import { loadMetadata, Dubhe, NetworkType } from "@0xobelisk/sui-client";
+import { loadMetadata, Dubhe, NetworkType } from '@0xobelisk/sui-client';
 
-const network = "devnet" as NetworkType;
-const packageId = "YOUR_PACKAGE_ID";
+const network = 'devnet' as NetworkType;
+const packageId = 'YOUR_PACKAGE_ID';
 
 const metadata = await loadMetadata(network, packageId);
 const dubhe = new Dubhe({
-    networkType: network,
-    packageId: packageId,
-    metadata: metadata,
-    secretKey: privkey
+  networkType: network,
+  packageId: packageId,
+  metadata: metadata,
+  secretKey: privkey,
 });
 ```
 
@@ -65,10 +65,10 @@ const dubhe = new Dubhe({
 import metadata from './metadata.json';
 
 const dubhe = new Dubhe({
-    networkType: network,
-    packageId: packageId,
-    metadata: metadata,
-    secretKey: privkey
+  networkType: network,
+  packageId: packageId,
+  metadata: metadata,
+  secretKey: privkey,
 });
 ```
 
@@ -77,11 +77,13 @@ const dubhe = new Dubhe({
 To call contract methods:
 
 ```typescript
-import { Transaction } from "@0xobelisk/sui-client";
+import { Transaction } from '@0xobelisk/sui-client';
 
 // Create transaction
 const tx = new Transaction();
-const params = [/* your parameters */];
+const params = [
+  /* your parameters */
+];
 
 // Execute transaction
 const response = await dubhe.tx.counter_system.inc(tx, params);
@@ -97,7 +99,9 @@ To query contract state:
 
 ```typescript
 const tx = new Transaction();
-const params = [/* your parameters */];
+const params = [
+  /* your parameters */
+];
 const result = await dubhe.query.counter_system.get(tx, params);
 
 // For BCS encoded results
@@ -162,7 +166,8 @@ const numberKey = await dubhe.entity_key_from_u256(123);
 To query objects owned by a specific address:
 
 ```typescript
-const owner = "0xfa99b5b0463fcfb7d0203c701a76da5eda21a96190eb1368ab36a437cc89195e";
+const owner =
+  '0xfa99b5b0463fcfb7d0203c701a76da5eda21a96190eb1368ab36a437cc89195e';
 const ownedObjects = await dubhe.getOwnedObjects(owner);
 ```
 

package/dist/dubhe.d.ts

@@ -7,7 +7,7 @@ import { MapObjectStruct } from './types';
 import { SuiContractFactory } from './libs/suiContractFactory';
 import { SuiMoveMoudleFuncType } from './libs/suiContractFactory/types';
 import { NetworkConfig } from './libs/suiInteractor';
-import { DerivePathParams, FaucetNetworkType, MapMoudleFuncQuery, MapMoudleFuncTx, DubheParams, SuiTxArg, SuiObjectArg, SuiVecTxArg } from './types';
+import { DerivePathParams, FaucetNetworkType, MapMoudleFuncQuery, MapMoudleFuncTx, DubheParams, SuiTxArg, SuiObjectArg, SuiVecTxArg, SubscribableType } from './types';
 import { ConnectionResponse, IndexerTransaction, IndexerEvent, IndexerSchema, SuiIndexerClient, StorageResponse, StorageItemResponse } from './libs/suiIndexerClient';
 import { Http } from './libs/http';
 export declare function isUndefined(value?: unknown): value is undefined;
@@ -63,6 +63,12 @@ export declare class Dubhe {
         checkpoint?: number;
         orderBy?: string[];
     }): Promise<ConnectionResponse<IndexerTransaction>>;
+    getTransaction(digest: string): Promise<IndexerTransaction | undefined>;
+    awaitIndexerTransaction(digest: string, options?: {
+        checkInterval?: number;
+        timeout?: number;
+        maxRetries?: number;
+    }): Promise<IndexerTransaction | undefined>;
     getEvents({ first, after, name, sender, digest, checkpoint, orderBy, }: {
         first?: number;
         after?: string;
@@ -105,7 +111,7 @@ export declare class Dubhe {
         last_update_digest?: string;
         value?: any;
     }): Promise<StorageItemResponse<IndexerSchema> | undefined>;
-    subscribe(names: string[], handleData: (data: any) => void): Promise<WebSocket>;
+    subscribe(types: SubscribableType[], handleData: (data: any) => void): Promise<WebSocket>;
     /**
      * else:
      * it will generate signer from the mnemonic with the given derivePathParams.

package/dist/index.d.ts

@@ -11,5 +11,6 @@ export { SuiAccountManager } from './libs/suiAccountManager';
 export { SuiTx } from './libs/suiTxBuilder';
 export { MultiSigClient } from './libs/multiSig';
 export { SuiContractFactory } from './libs/suiContractFactory';
+export { SubscriptionKind } from './libs/suiIndexerClient';
 export { loadMetadata } from './metadata';
 export type * from './types';

package/dist/index.js

@@ -51,6 +51,7 @@ __export(src_exports, {
   BcsType: () => import_bcs4.BcsType,
   Dubhe: () => Dubhe,
   MultiSigClient: () => MultiSigClient,
+  SubscriptionKind: () => SubscriptionKind,
   SuiAccountManager: () => SuiAccountManager,
   SuiContractFactory: () => SuiContractFactory,
   SuiTx: () => SuiTx,
@@ -1115,6 +1116,11 @@ var parseValue = (value) => {
 };
 
 // src/libs/suiIndexerClient/index.ts
+var SubscriptionKind = /* @__PURE__ */ ((SubscriptionKind2) => {
+  SubscriptionKind2["Event"] = "event";
+  SubscriptionKind2["Schema"] = "schema";
+  return SubscriptionKind2;
+})(SubscriptionKind || {});
 var SuiIndexerClient = class {
   constructor(http) {
     this.http = http;
@@ -1147,6 +1153,13 @@ var SuiIndexerClient = class {
     const response = await this.fetchGraphql(query, params);
     return response.transactions;
   }
+  async getTransaction(digest) {
+    const response = await this.getTransactions({
+      first: 1,
+      digest
+    });
+    return response.edges[0]?.node;
+  }
   async getSchemas(params) {
     const query = `
       query GetSchemas(
@@ -1288,8 +1301,8 @@ var SuiIndexerClient = class {
       value: result
     };
   }
-  async subscribe(names, handleData) {
-    return this.http.subscribe(names, handleData);
+  async subscribe(types, handleData) {
+    return this.http.subscribe(types, handleData);
   }
 };
 
@@ -1427,14 +1440,11 @@ var Http = class {
       );
     }
   }
-  async subscribe(names, handleData) {
+  async subscribe(types, handleData) {
     const ws = createWebSocketClient(this.wsEndpoint);
     ws.onopen = () => {
       console.log("Connected to the WebSocket server");
-      const subscribeMessage = JSON.stringify({
-        type: "subscribe",
-        names
-      });
+      const subscribeMessage = JSON.stringify(types);
       ws.send(subscribeMessage);
     };
     ws.onmessage = (event) => {
@@ -2296,6 +2306,40 @@ var Dubhe = class {
       orderBy
     });
   }
+  async getTransaction(digest) {
+    return await this.suiIndexerClient.getTransaction(digest);
+  }
+  async awaitIndexerTransaction(digest, options) {
+    const {
+      checkInterval = 100,
+      timeout = 3e4,
+      // 30 seconds default timeout
+      maxRetries = 300
+      // 300 times default max retries
+    } = options ?? {};
+    const startTime = Date.now();
+    let retryCount = 0;
+    while (retryCount < maxRetries) {
+      try {
+        if (Date.now() - startTime > timeout) {
+          throw new Error(`Timeout waiting for transaction ${digest}`);
+        }
+        await new Promise((resolve) => setTimeout(resolve, checkInterval));
+        const transaction = await this.getTransaction(digest);
+        if (transaction) {
+          return transaction;
+        }
+        retryCount++;
+      } catch (error) {
+        throw new Error(
+          `Error while waiting for transaction ${digest}: ${error}`
+        );
+      }
+    }
+    throw new Error(
+      `Max retries (${maxRetries}) reached while waiting for transaction ${digest}`
+    );
+  }
   async getEvents({
     first,
     after,
@@ -2385,8 +2429,8 @@ var Dubhe = class {
     });
     return response;
   }
-  async subscribe(names, handleData) {
-    return this.suiIndexerClient.subscribe(names, handleData);
+  async subscribe(types, handleData) {
+    return this.suiIndexerClient.subscribe(types, handleData);
   }
   /**
    * else:
@@ -2785,9 +2829,7 @@ async function loadMetadata(networkType, packageId, fullnodeUrls) {
   fullnodeUrls = fullnodeUrls || [(0, import_client3.getFullnodeUrl)(networkType)];
   const suiInteractor = new SuiInteractor(fullnodeUrls);
   if (packageId !== void 0) {
-    const jsonData = await suiInteractor.getNormalizedMoveModulesByPackage(
-      packageId
-    );
+    const jsonData = await suiInteractor.getNormalizedMoveModulesByPackage(packageId);
     return jsonData;
   } else {
     console.error("please set your package id.");
@@ -2798,6 +2840,7 @@ async function loadMetadata(networkType, packageId, fullnodeUrls) {
   BcsType,
   Dubhe,
   MultiSigClient,
+  SubscriptionKind,
   SuiAccountManager,
   SuiContractFactory,
   SuiTx,