@0xobelisk/sui-client 0.5.23 → 0.5.25

package/LICENSE

@@ -9,7 +9,7 @@ Parameters
 
 Licensor:             Obelisk Labs
 
-Licensed Work:        Obelisk Engine
+Licensed Work:        Dubhe
                       The Licensed Work is (c) 2023 Obelisk Labs
 
 -----------------------------------------------------------------------------

package/README.md

@@ -1,6 +1,6 @@
-# Obelisk Client SDK
+# Dubhe Client SDK
 
-Obelisk is client agnostic: any client -- a browser, a game engine, or an ios/android app -- can implement the synchronization protocol and a client-side cache to replicate Store tables, along with the necessary infrastructure to send transactions to the World.
+Dubhe is client agnostic: any client -- a browser, a game engine, or an ios/android app -- can implement the synchronization protocol and a client-side cache to replicate Store tables, along with the necessary infrastructure to send transactions to the World.
 
 Currently we only support browsers, Node and the COCOS game engine.
 
@@ -16,7 +16,7 @@ We create a Project called Counter and declare sigleton schema called counter, w
 
 
 ```typescript
-import { ObeliskConfig } from '@0xobelisk/sui-common';
+import { DubheConfig } from '@0xobelisk/sui-common';
 
 export const obeliskConfig = {
   name: 'counter',
@@ -29,13 +29,13 @@ export const obeliskConfig = {
     },
   },
   sample_schema: 'u64',
-} as ObeliskConfig;
+} as DubheConfig;
 ```
 
-Through the CLI, we will generate the corresponding contract based on obelisk.config.ts At this point we need to write the system logic.
+Through the CLI, we will generate the corresponding contract based on dubhe.config.ts At this point we need to write the system logic.
 
 ```bash
-obelisk schemagen obelisk.config.ts
+obelisk schemagen dubhe.config.ts
 ```
 
 The next step is simply to write the system file method.
@@ -57,22 +57,22 @@ Finally we deploy the complete contract to devnet
 
 
 ```bash
-obelisk publish --network devnet --configPath obelisk.config.ts
+obelisk publish --network devnet --configPath dubhe.config.ts
 ```
 
 We'll get the `packageId` and `worldId` on the command line.
 
-### Init Obelisk Client
+### Init Dubhe Client
 
 ```typescript
-import { getMetadata, Obelisk, NetworkType } from "@0xobelisk/sui-client";
+import { getMetadata, Dubhe, NetworkType } from "@0xobelisk/sui-client";
 
 const network = "devnet" as NetworkType
 const packageId = "0x804578b9eed47d461bba52c393cf148302819e2ba0a0f558356cc419b3e941ed"
 
 const metadata = await getMetadata(network, packageId);
 
-const obelisk = new Obelisk({
+const obelisk = new Dubhe({
     networkType: network,
     packageId: packageId,
     metadata: metadata,
@@ -85,11 +85,11 @@ const obelisk = new Obelisk({
 If you need to call a method in the system, you can do so using the `obelisk.tx.moudleName.funcName()` form.
 
 ```typescript
-import { getMetadata, Obelisk, TransactionBlock } from "@0xobelisk/sui-client";
+import { getMetadata, Dubhe, TransactionBlock } from "@0xobelisk/sui-client";
 
 const metadata = await getMetadata(network, packageId);
 
-const obelisk = new Obelisk({
+const obelisk = new Dubhe({
     networkType: network,
     packageId: packageId,
     metadata: metadata,
@@ -130,7 +130,7 @@ If your system method provides a method with no modification status and a return
 
 ```typescript
 const metadata = await getMetadata(NETWORK, PACKAGE_ID);
-const obelisk = new Obelisk({
+const obelisk = new Dubhe({
     networkType: NETWORK,
     packageId: PACKAGE_ID,
     metadata: metadata,
@@ -150,7 +150,7 @@ Queries the Object information of worldId.
 
 ```typescript
     const metadata = await getMetadata(NETWORK, PACKAGE_ID);
-    const obelisk = new Obelisk({
+    const obelisk = new Dubhe({
         networkType: NETWORK,
         packageId: PACKAGE_ID,
         metadata: metadata,
@@ -165,7 +165,7 @@ List all schema name in the world store.
 
 ```typescript
 const metadata = await getMetadata(NETWORK, PACKAGE_ID);
-const obelisk = new Obelisk({
+const obelisk = new Dubhe({
     networkType: NETWORK,
     packageId: PACKAGE_ID,
     metadata: metadata,
@@ -182,7 +182,7 @@ Get the entity's data based on schema name and entity id(option).
 
 ```typescript
 const metadata = await getMetadata(NETWORK, PACKAGE_ID);
-const obelisk = new Obelisk({
+const obelisk = new Dubhe({
     networkType: NETWORK,
     packageId: PACKAGE_ID,
     metadata: metadata,
@@ -215,7 +215,7 @@ Determine if the entity exists
 
 ```typescript
 const metadata = await getMetadata(NETWORK, PACKAGE_ID);
-const obelisk = new Obelisk({
+const obelisk = new Dubhe({
     networkType: NETWORK,
     packageId: PACKAGE_ID,
     metadata: metadata,
@@ -247,7 +247,7 @@ Query all the objects under the current worldId that are owned by a certain addr
 
 ```typescript
 const metadata = await getMetadata(NETWORK, PACKAGE_ID);
-const obelisk = new Obelisk({
+const obelisk = new Dubhe({
     networkType: NETWORK,
     packageId: PACKAGE_ID,
     metadata: metadata,

package/dist/{obelisk.d.ts → dubhe.d.ts}

@@ -7,16 +7,16 @@ import { SuiInteractor } from './libs/suiInteractor';
 import { MapObjectStruct } from './types';
 import { SuiContractFactory } from './libs/suiContractFactory';
 import { SuiMoveMoudleFuncType } from './libs/suiContractFactory/types';
-import { DerivePathParams, FaucetNetworkType, MapMoudleFuncQuery, MapMoudleFuncTx, ObeliskParams, SuiTxArg, SuiObjectArg, SuiVecTxArg } from './types';
+import { DerivePathParams, FaucetNetworkType, MapMoudleFuncQuery, MapMoudleFuncTx, DubheParams, SuiTxArg, SuiObjectArg, SuiVecTxArg } from './types';
 export declare function isUndefined(value?: unknown): value is undefined;
 export declare function withMeta<T extends {
     meta: SuiMoveMoudleFuncType;
 }>(meta: SuiMoveMoudleFuncType, creator: Omit<T, 'meta'>): T;
 /**
- * @class Obelisk
+ * @class Dubhe
  * @description This class is used to aggregate the tools that used to interact with SUI network.
  */
-export declare class Obelisk {
+export declare class Dubhe {
     #private;
     accountManager: SuiAccountManager;
     suiInteractor: SuiInteractor;
@@ -24,7 +24,7 @@ export declare class Obelisk {
     packageId: string | undefined;
     metadata: SuiMoveNormalizedModules | undefined;
     /**
-     * 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.
@@ -35,7 +35,7 @@ export declare class Obelisk {
      * @param fullnodeUrl, the fullnode url, default is the preconfig fullnode url for the given network type
      * @param packageId
      */
-    constructor({ mnemonics, secretKey, networkType, fullnodeUrls, packageId, metadata, }?: ObeliskParams);
+    constructor({ mnemonics, secretKey, networkType, fullnodeUrls, packageId, metadata, }?: DubheParams);
     get query(): MapMoudleFuncQuery;
     get tx(): MapMoudleFuncTx;
     get object(): MapObjectStruct;

package/dist/index.d.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/dist/index.js

@@ -45,8 +45,8 @@ var __privateAdd = (obj, member, value) => {
 var src_exports = {};
 __export(src_exports, {
   BcsType: () => import_bcs3.BcsType,
+  Dubhe: () => Dubhe,
   MultiSigClient: () => MultiSigClient,
-  Obelisk: () => Obelisk,
   SuiAccountManager: () => SuiAccountManager,
   SuiContractFactory: () => SuiContractFactory,
   SuiTx: () => SuiTx,
@@ -63,7 +63,7 @@ __reExport(src_exports, require("@mysten/sui/keypairs/secp256k1"), module.export
 __reExport(src_exports, require("@mysten/sui/keypairs/secp256r1"), module.exports);
 var import_bcs3 = require("@mysten/bcs");
 
-// src/obelisk.ts
+// src/dubhe.ts
 var import_keccak256 = __toESM(require("keccak256"));
 var import_client2 = require("@mysten/sui/client");
 var import_transactions3 = require("@mysten/sui/transactions");
@@ -944,7 +944,7 @@ function numberToAddressHex(num) {
   return paddedHex;
 }
 
-// src/obelisk.ts
+// src/dubhe.ts
 var import_bcs2 = require("@mysten/bcs");
 function isUndefined(value) {
   return value === void 0;
@@ -971,9 +971,9 @@ function createTx(meta, fn) {
   );
 }
 var _query, _tx, _object, _exec, _read, _bcs;
-var Obelisk = class {
+var Dubhe = class {
   /**
-   * 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.
@@ -1667,8 +1667,8 @@ var MultiSigClient = class _MultiSigClient {
 
 // src/metadata/index.ts
 var import_client4 = require("@mysten/sui/client");
-async function loadMetadata(networkType, packageId) {
-  const fullnodeUrls = [(0, import_client4.getFullnodeUrl)(networkType)];
+async function loadMetadata(networkType, packageId, fullnodeUrls) {
+  fullnodeUrls = fullnodeUrls || [(0, import_client4.getFullnodeUrl)(networkType)];
   const suiInteractor = new SuiInteractor(fullnodeUrls);
   if (packageId !== void 0) {
     const jsonData = await suiInteractor.getNormalizedMoveModulesByPackage(
@@ -1682,8 +1682,8 @@ async function loadMetadata(networkType, packageId) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BcsType,
+  Dubhe,
   MultiSigClient,
-  Obelisk,
   SuiAccountManager,
   SuiContractFactory,
   SuiTx,