@0xobelisk/sui-client 0.5.27 → 0.5.29

package/dist/libs/suiTxBuilder/util.d.ts

@@ -1,6 +1,6 @@
 import type { TransactionArgument, Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
 import type { SuiObjectArg, SuiAddressArg, SuiTxArg, SuiVecTxArg, SuiInputTypes, SuiAmountsArg } from 'src/types';
-export declare const getDefaultSuiInputType: (value: SuiTxArg) => 'u64' | 'bool' | 'object' | undefined;
+export declare const getDefaultSuiInputType: (value: SuiTxArg) => "u64" | "bool" | "object" | undefined;
 /**
  * Since we know the elements in the array are the same type
  * If type is not provided, we will try to infer the type from the first element

package/dist/types/index.d.ts

@@ -60,10 +60,22 @@ export interface MessageMeta {
     readonly meta: SuiMoveMoudleFuncType;
 }
 export interface ContractQuery extends MessageMeta {
-    (tx: Transaction, params: (TransactionArgument | SerializedBcs<any>)[], typeArguments?: string[], isRaw?: boolean): Promise<DevInspectResults | TransactionResult>;
+    (): Promise<DevInspectResults | TransactionResult>;
+    ({ tx, params, typeArguments, isRaw, }: {
+        tx: Transaction;
+        params?: (TransactionArgument | SerializedBcs<any>)[];
+        typeArguments?: string[];
+        isRaw?: boolean;
+    }): Promise<DevInspectResults | TransactionResult>;
 }
 export interface ContractTx extends MessageMeta {
-    (tx: Transaction, params: (TransactionArgument | SerializedBcs<any>)[], typeArguments?: string[], isRaw?: boolean): Promise<SuiTransactionBlockResponse | TransactionResult>;
+    (): Promise<SuiTransactionBlockResponse | TransactionResult>;
+    ({ tx, params, typeArguments, isRaw, }: {
+        tx: Transaction;
+        params?: (TransactionArgument | SerializedBcs<any>)[];
+        typeArguments?: string[];
+        isRaw?: boolean;
+    }): Promise<SuiTransactionBlockResponse | TransactionResult>;
 }
 export type MapMessageTx = Record<string, ContractTx>;
 export type MapMessageQuery = Record<string, ContractQuery>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/sui-client",
-  "version": "0.5.27",
+  "version": "0.5.29",
   "description": "Tookit for interacting with move eps framework",
   "keywords": [
     "sui",

package/src/dubhe.ts

@@ -39,6 +39,7 @@ import {
 } from './types';
 import { normalizeHexAddress, numberToAddressHex } from './utils';
 import { bcs, fromHEX, toHEX } from '@mysten/bcs';
+import { ContractDataParsingError } from './errors';
 
 export function isUndefined(value?: unknown): value is undefined {
   return value === undefined;
@@ -57,19 +58,24 @@ function createQuery(
   meta: SuiMoveMoudleFuncType,
   fn: (
     tx: Transaction,
-    params: (TransactionArgument | SerializedBcs<any>)[],
+    params?: (TransactionArgument | SerializedBcs<any>)[],
     typeArguments?: string[],
     isRaw?: boolean
   ) => Promise<DevInspectResults | TransactionResult>
 ): ContractQuery {
   return withMeta(
     meta,
-    async (
-      tx: Transaction,
-      params: (TransactionArgument | SerializedBcs<any>)[],
-      typeArguments?: string[],
-      isRaw?: boolean
-    ): Promise<DevInspectResults | TransactionResult> => {
+    async ({
+      tx,
+      params,
+      typeArguments,
+      isRaw,
+    }: {
+      tx: Transaction;
+      params?: (TransactionArgument | SerializedBcs<any>)[];
+      typeArguments?: string[];
+      isRaw?: boolean;
+    }): Promise<DevInspectResults | TransactionResult> => {
       const result = await fn(tx, params, typeArguments, isRaw);
       return result;
     }
@@ -80,19 +86,24 @@ function createTx(
   meta: SuiMoveMoudleFuncType,
   fn: (
     tx: Transaction,
-    params: (TransactionArgument | SerializedBcs<any>)[],
+    params?: (TransactionArgument | SerializedBcs<any>)[],
     typeArguments?: string[],
     isRaw?: boolean
   ) => Promise<SuiTransactionBlockResponse | TransactionResult>
 ): ContractTx {
   return withMeta(
     meta,
-    async (
-      tx: Transaction,
-      params: (TransactionArgument | SerializedBcs<any>)[],
-      typeArguments?: string[],
-      isRaw?: boolean
-    ): Promise<SuiTransactionBlockResponse | TransactionResult> => {
+    async ({
+      tx,
+      params,
+      typeArguments,
+      isRaw,
+    }: {
+      tx: Transaction;
+      params?: (TransactionArgument | SerializedBcs<any>)[];
+      typeArguments?: string[];
+      isRaw?: boolean;
+    }): Promise<SuiTransactionBlockResponse | TransactionResult> => {
       return await fn(tx, params, typeArguments, isRaw);
     }
   );
@@ -306,7 +317,7 @@ export class Dubhe {
   #exec = async (
     meta: SuiMoveMoudleFuncType,
     tx: Transaction,
-    params: (TransactionArgument | SerializedBcs<any>)[],
+    params?: (TransactionArgument | SerializedBcs<any>)[],
     typeArguments?: string[],
     isRaw?: boolean
   ) => {
@@ -329,7 +340,7 @@ export class Dubhe {
   #read = async (
     meta: SuiMoveMoudleFuncType,
     tx: Transaction,
-    params: (TransactionArgument | SerializedBcs<any>)[],
+    params?: (TransactionArgument | SerializedBcs<any>)[],
     typeArguments?: string[],
     isRaw?: boolean
   ) => {
@@ -589,7 +600,7 @@ export class Dubhe {
       }
       return returnValues;
     } else {
-      return undefined;
+      throw new ContractDataParsingError(dryResult);
     }
   }
 

package/src/errors/index.ts

@@ -0,0 +1,31 @@
+export class ContractDataParsingError extends Error {
+  public readonly errorType: string;
+  public readonly functionName: string;
+  public readonly moduleAddress: string;
+  public readonly errorMessage: string;
+
+  constructor(dryResult: any) {
+    const error = dryResult?.effects?.status?.error || '';
+    const functionMatch = error
+      ? error.match(/function_name: Some\("([^"]+)"\)/)
+      : null;
+    const moduleMatch = error ? error.match(/address: ([a-fA-F0-9]+)/) : null;
+
+    const functionName = functionMatch ? functionMatch[1] : 'unknown';
+    const moduleAddress = moduleMatch ? '0x' + moduleMatch[1] : 'unknown';
+    const errorMessage = dryResult.error ? dryResult.error : 'UNKNOWN_ERROR';
+
+    const message = [
+      `\n- Function: ${functionName}`,
+      `- Module Address: ${moduleAddress}`,
+      `- Error Message: ${errorMessage}`,
+    ].join('\n');
+
+    super(message);
+
+    this.errorType = 'ContractDataParsingError';
+    this.functionName = functionName;
+    this.moduleAddress = moduleAddress;
+    this.errorMessage = errorMessage;
+  }
+}

package/src/types/index.ts

@@ -85,21 +85,33 @@ export interface MessageMeta {
 }
 
 export interface ContractQuery extends MessageMeta {
-  (
-    tx: Transaction,
-    params: (TransactionArgument | SerializedBcs<any>)[],
-    typeArguments?: string[],
-    isRaw?: boolean
-  ): Promise<DevInspectResults | TransactionResult>;
+  (): Promise<DevInspectResults | TransactionResult>;
+  ({
+    tx,
+    params,
+    typeArguments,
+    isRaw,
+  }: {
+    tx: Transaction;
+    params?: (TransactionArgument | SerializedBcs<any>)[];
+    typeArguments?: string[];
+    isRaw?: boolean;
+  }): Promise<DevInspectResults | TransactionResult>;
 }
 
 export interface ContractTx extends MessageMeta {
-  (
-    tx: Transaction,
-    params: (TransactionArgument | SerializedBcs<any>)[],
-    typeArguments?: string[],
-    isRaw?: boolean
-  ): Promise<SuiTransactionBlockResponse | TransactionResult>;
+  (): Promise<SuiTransactionBlockResponse | TransactionResult>;
+  ({
+    tx,
+    params,
+    typeArguments,
+    isRaw,
+  }: {
+    tx: Transaction;
+    params?: (TransactionArgument | SerializedBcs<any>)[];
+    typeArguments?: string[];
+    isRaw?: boolean;
+  }): Promise<SuiTransactionBlockResponse | TransactionResult>;
 }
 
 export type MapMessageTx = Record<string, ContractTx>;