@0xobelisk/sui-client 0.5.24 → 0.5.26

package/src/{obelisk.ts → dubhe.ts}

@@ -16,8 +16,8 @@ import { SuiInteractor } from './libs/suiInteractor';
 import {
   MapObjectStruct,
   MoveStructType,
-  ObeliskObjectContent,
-  SuiObeliskReturnType,
+  DubheObjectContent,
+  SuiDubheReturnType,
 } from './types';
 import { SuiContractFactory } from './libs/suiContractFactory';
 import {
@@ -31,7 +31,7 @@ import {
   FaucetNetworkType,
   MapMoudleFuncQuery,
   MapMoudleFuncTx,
-  ObeliskParams,
+  DubheParams,
   SuiTxArg,
   // SuiTxArgument,
   SuiObjectArg,
@@ -39,7 +39,6 @@ import {
 } from './types';
 import { normalizeHexAddress, numberToAddressHex } from './utils';
 import { bcs, fromHEX, toHEX } from '@mysten/bcs';
-import { TypeTagSerializer } from '@mysten/sui/bcs';
 
 export function isUndefined(value?: unknown): value is undefined {
   return value === undefined;
@@ -94,17 +93,16 @@ function createTx(
       typeArguments?: string[],
       isRaw?: boolean
     ): Promise<SuiTransactionBlockResponse | TransactionResult> => {
-      // const result = await fn(tx, params, typeArguments, isRaw);
       return await fn(tx, params, typeArguments, isRaw);
     }
   );
 }
 
 /**
- * @class Obelisk
+ * @class Dubhe
  * @description This class is used to aggregate the tools that used to interact with SUI network.
  */
-export class Obelisk {
+export class Dubhe {
   public accountManager: SuiAccountManager;
   public suiInteractor: SuiInteractor;
   public contractFactory: SuiContractFactory;
@@ -159,7 +157,7 @@ export class Obelisk {
   };
 
   /**
-   * Support the following ways to init the ObeliskClient:
+   * Support the following ways to init the DubheClient:
    * 1. mnemonics
    * 2. secretKey (base64 or hex)
    * If none of them is provided, will generate a random mnemonics with 24 words.
@@ -177,7 +175,7 @@ export class Obelisk {
     fullnodeUrls,
     packageId,
     metadata,
-  }: ObeliskParams = {}) {
+  }: DubheParams = {}) {
     // Init the account manager
     this.accountManager = new SuiAccountManager({ mnemonics, secretKey });
     // Init the rpc provider
@@ -200,18 +198,24 @@ export class Obelisk {
             const objMoudleId = `${packageId}::${moduleName}`;
 
             Object.entries(data.structs).forEach(([objectName, objectType]) => {
-              const objId = `${objMoudleId}::${objectName}`;
+              const objectId = `${objMoudleId}::${objectName}`;
               const bcsmeta: MoveStructType = {
+                objectId,
                 objectName,
                 objectType,
               };
-              // if (isUndefined(this.#object[objId])) {
+              // if (isUndefined(this.#object[objectId])) {
               let bcsObj = this.#bcs(bcsmeta);
               if (bcsObj.loopFlag === true) {
                 loopFlag = bcsObj.loopFlag;
               }
-              this.#object[objId] = bcsObj.bcs;
-              // }
+
+              this.#object[objectId] = bcsObj.bcs;
+
+              this.#object[`vector<${objectId}>`] = bcs.vector(bcsObj.bcs);
+              this.#object[`0x1::option::Option<${objectId}>`] = bcs.option(
+                bcsObj.bcs
+              );
             });
 
             Object.entries(data.exposedFunctions).forEach(
@@ -458,7 +462,6 @@ export class Obelisk {
                   default:
                   // throw new Error('Unsupported type');
                 }
-
               case 'TypeParameter':
                 bcsJson[objName] = bcs.u128();
                 return;
@@ -518,7 +521,6 @@ export class Obelisk {
   view(dryResult: DevInspectResults) {
     let returnValues = [];
 
-    // "success" | "failure";
     if (dryResult.effects.status.status === 'success') {
       const resultList = dryResult.results![0].returnValues!;
 
@@ -527,7 +529,31 @@ export class Obelisk {
         let baseType = res[1];
 
         const value = Uint8Array.from(baseValue);
-        returnValues.push(this.object[baseType].parse(value));
+
+        if (!this.#object[baseType]) {
+          console.log(
+            '\n\x1b[41m\x1b[37m ERROR \x1b[0m \x1b[31mUnsupported Type\x1b[0m'
+          );
+          console.log('\x1b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\x1b[0m');
+          console.log(`\x1b[95m•\x1b[0m Type: \x1b[33m"${baseType}"\x1b[0m`);
+          console.log('\x1b[95m\n✨ Available Types:\x1b[0m');
+          Object.keys(this.#object).forEach((type) => {
+            console.log(`  \x1b[36m◆\x1b[0m ${type}`);
+          });
+          console.log('\n\x1b[34m💡 How to Add Custom Type:\x1b[0m');
+          console.log(
+            `  You can add custom type by extending the #object map in your code:`
+          );
+          console.log(
+            `  \x1b[32mdubhe.object["${baseType}"] = bcs.struct("YourTypeName", {\n    field1: bcs.string(),\n    field2: bcs.u64(),\n    // ... other fields\n  });\x1b[0m`
+          );
+          console.log(
+            '\x1b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\x1b[0m\n'
+          );
+          throw new Error(`Unsupported type: ${baseType}`);
+        }
+
+        returnValues.push(this.#object[baseType].parse(value));
       }
       return returnValues;
     } else {
@@ -816,64 +842,6 @@ export class Obelisk {
     });
   }
 
-  async getWorld(worldObjectId: string) {
-    return this.suiInteractor.getObject(worldObjectId);
-  }
-
-  async listSchemaNames(worldId: string) {
-    const worldObject = await this.getObject(worldId);
-    const newObjectContent = worldObject.content;
-    if (newObjectContent != null) {
-      const objectContent = newObjectContent as ObeliskObjectContent;
-      const objectFields = objectContent.fields as Record<string, any>;
-      return objectFields['schema_names'];
-    } else {
-      return [];
-    }
-  }
-
-  async getEntity(
-    worldId: string,
-    schemaName: string,
-    entityId?: string
-  ): Promise<any[] | undefined> {
-    const schemaModuleName = `${schemaName}_schema`;
-    const tx = new Transaction();
-    const params = [tx.object(worldId)] as TransactionArgument[];
-
-    if (entityId !== undefined) {
-      params.push(tx.object(entityId));
-    }
-
-    const dryResult = (await this.query[schemaModuleName].get(
-      tx,
-      params
-    )) as DevInspectResults;
-    // "success" | "failure";
-    return this.view(dryResult);
-  }
-
-  async containEntity(
-    worldId: string,
-    schemaName: string,
-    entityId?: string
-  ): Promise<boolean | undefined> {
-    const schemaModuleName = `${schemaName}_schema`;
-    const tx = new Transaction();
-    const params = [tx.object(worldId)] as TransactionArgument[];
-
-    if (entityId !== undefined) {
-      params.push(tx.object(entityId));
-    }
-
-    const dryResult = (await this.query[schemaModuleName].contains(
-      tx,
-      params
-    )) as DevInspectResults;
-
-    return this.view(dryResult) as boolean | undefined;
-  }
-
   async getOwnedObjects(owner: string, cursor?: string, limit?: number) {
     const ownedObjects = await this.suiInteractor.getOwnedObjects(
       owner,

package/src/index.ts

@@ -6,7 +6,7 @@ export * from '@mysten/sui/keypairs/ed25519';
 export * from '@mysten/sui/keypairs/secp256k1';
 export * from '@mysten/sui/keypairs/secp256r1';
 export { bcs, BcsType } from '@mysten/bcs';
-export { Obelisk } from './obelisk';
+export { Dubhe } from './dubhe';
 export { SuiAccountManager } from './libs/suiAccountManager';
 export { SuiTx } from './libs/suiTxBuilder';
 export { MultiSigClient } from './libs/multiSig';

package/src/types/index.ts

@@ -25,7 +25,7 @@ import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
 export const ObjectContentFields = record(string(), any());
 export type ObjectContentFields = Infer<typeof ObjectContentFields>;
 
-export type ObeliskObjectData = {
+export type DubheObjectData = {
   objectId: string;
   objectType: string;
   objectVersion: number;
@@ -33,14 +33,14 @@ export type ObeliskObjectData = {
   objectFields: ObjectContentFields;
 };
 
-export type ObeliskObjectContent = {
+export type DubheObjectContent = {
   dataType: 'moveObject';
   fields: MoveStruct;
   hasPublicTransfer: boolean;
   type: string;
 };
 
-export type ObeliskParams = {
+export type DubheParams = {
   mnemonics?: string;
   secretKey?: string;
   fullnodeUrls?: string[];
@@ -124,6 +124,7 @@ export type MoveStructValueType = {
   }[];
 };
 export type MoveStructType = {
+  objectId: string;
   objectType: MoveStructValueType;
   objectName: string;
 };
@@ -275,6 +276,6 @@ export type ObjectContent = {
   dataType: string;
 };
 
-export type SuiObeliskReturnType<T extends boolean> = T extends true
+export type SuiDubheReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
   : SuiTx;