@0xobelisk/sui-client 1.2.0-pre.99 → 2.0.0

package/src/index.ts

@@ -14,3 +14,12 @@ export { MultiSigClient } from './libs/multiSig';
 export { SuiContractFactory } from './libs/suiContractFactory';
 export { loadMetadata } from './metadata';
 export type * from './types';
+export {
+  getDefaultConfig,
+  getDefaultURL,
+  TESTNET_DUBHE_FRAMEWORK_PACKAGE_ID,
+  TESTNET_DUBHE_HUB_OBJECT_ID,
+  MAINNET_DUBHE_FRAMEWORK_PACKAGE_ID,
+  MAINNET_DUBHE_HUB_OBJECT_ID
+} from './libs/suiInteractor/defaultConfig';
+export type { NetworkConfig } from './libs/suiInteractor/defaultConfig';

package/src/libs/suiInteractor/defaultConfig.ts

@@ -1,5 +1,25 @@
 import { NetworkType } from 'src/types';
 
+/**
+ * Testnet deployment of the Dubhe framework.
+ * Update these constants whenever the framework is redeployed to testnet.
+ */
+export const TESTNET_DUBHE_FRAMEWORK_PACKAGE_ID =
+  '0xae33be6675639d6f1a5c468ae6bbc457ae4e22e57cd7526741d6143ce219d995';
+
+export const TESTNET_DUBHE_HUB_OBJECT_ID =
+  '0x80391929a8772aba091156fd1f099bf79240d2cf4471a14026b4aa68e3a240cc';
+
+/**
+ * Mainnet deployment of the Dubhe framework.
+ * Update these constants whenever the framework is redeployed to mainnet.
+ */
+export const MAINNET_DUBHE_FRAMEWORK_PACKAGE_ID =
+  '0x5bc40de124588b1e3514ca50f5e7109869351c4d9544e5f0cb9d30dd47bf8de7';
+
+export const MAINNET_DUBHE_HUB_OBJECT_ID =
+  '0x96e92d9baccfd0a2927b4f209756e1edbc18904bff34e486e4bb4a151320e1e5';
+
 export interface NetworkConfig {
   fullNode: string;
   graphql?: string;
@@ -9,21 +29,36 @@ export interface NetworkConfig {
   explorer: string;
   indexerUrl: string;
   channelUrl: string;
+  /**
+   * Published package ID of the Dubhe framework for this network.
+   * Defined for testnet and mainnet (known constants).
+   * Undefined for localnet/devnet — supply after deploying dubhe locally.
+   */
+  frameworkPackageId?: string;
+  /**
+   * Shared DappHub object ID for this network.
+   * Defined for testnet and mainnet (known constants).
+   * Undefined for localnet/devnet — read from the deployment JSON after publishing.
+   */
+  dappHubId?: string;
 }
 
-export const getDefaultURL = (networkType: NetworkType = 'testnet'): NetworkConfig => {
+export const getDefaultConfig = (networkType: NetworkType = 'testnet'): NetworkConfig => {
   switch (networkType) {
-    case 'localnet':
+    case 'localnet': {
+      const localRpc = encodeURIComponent('http://127.0.0.1:9000');
       return {
         fullNode: 'http://127.0.0.1:9000',
         graphql: 'http://127.0.0.1:9125',
         network: 'localnet',
-        txExplorer: 'https://explorer.polymedia.app/txblock/:txHash?network=local',
-        accountExplorer: 'https://explorer.polymedia.app/address/:address?network=local',
-        explorer: 'https://explorer.polymedia.app?network=local',
+        txExplorer: `https://custom.suiscan.xyz/custom/tx/:txHash?network=${localRpc}`,
+        accountExplorer: `https://custom.suiscan.xyz/custom/account/:address?network=${localRpc}`,
+        explorer: `https://custom.suiscan.xyz/custom?network=${localRpc}`,
         indexerUrl: 'http://127.0.0.1:3001',
         channelUrl: 'http://127.0.0.1:8080'
+        // frameworkPackageId: undefined — set after deploying dubhe locally
       };
+    }
     case 'devnet':
       return {
         fullNode: 'https://fullnode.devnet.sui.io:443',
@@ -33,6 +68,7 @@ export const getDefaultURL = (networkType: NetworkType = 'testnet'): NetworkConf
         explorer: 'https://suiscan.xyz/devnet',
         indexerUrl: 'http://127.0.0.1:3001',
         channelUrl: 'http://127.0.0.1:8080'
+        // frameworkPackageId: undefined — no persistent deployment on devnet
       };
     case 'testnet':
       return {
@@ -43,7 +79,9 @@ export const getDefaultURL = (networkType: NetworkType = 'testnet'): NetworkConf
         accountExplorer: 'https://suiscan.xyz/testnet/address/:address',
         explorer: 'https://suiscan.xyz/testnet',
         indexerUrl: 'http://127.0.0.1:3001',
-        channelUrl: 'http://127.0.0.1:8080'
+        channelUrl: 'http://127.0.0.1:8080',
+        frameworkPackageId: TESTNET_DUBHE_FRAMEWORK_PACKAGE_ID,
+        dappHubId: TESTNET_DUBHE_HUB_OBJECT_ID
       };
     case 'mainnet':
       return {
@@ -54,7 +92,9 @@ export const getDefaultURL = (networkType: NetworkType = 'testnet'): NetworkConf
         accountExplorer: 'https://suiscan.xyz/mainnet/address/:address',
         explorer: 'https://suiscan.xyz/mainnet',
         indexerUrl: 'http://127.0.0.1:3001',
-        channelUrl: 'http://127.0.0.1:8080'
+        channelUrl: 'http://127.0.0.1:8080',
+        frameworkPackageId: MAINNET_DUBHE_FRAMEWORK_PACKAGE_ID || undefined,
+        dappHubId: MAINNET_DUBHE_HUB_OBJECT_ID || undefined
       };
     default:
       return {
@@ -65,7 +105,12 @@ export const getDefaultURL = (networkType: NetworkType = 'testnet'): NetworkConf
         accountExplorer: 'https://suiscan.xyz/testnet/address/:address',
         explorer: 'https://suiscan.xyz/testnet',
         indexerUrl: 'http://127.0.0.1:3001',
-        channelUrl: 'http://127.0.0.1:8080'
+        channelUrl: 'http://127.0.0.1:8080',
+        frameworkPackageId: TESTNET_DUBHE_FRAMEWORK_PACKAGE_ID,
+        dappHubId: TESTNET_DUBHE_HUB_OBJECT_ID
       };
   }
 };
+
+/** @deprecated Use `getDefaultConfig` instead. */
+export const getDefaultURL = getDefaultConfig;

package/src/libs/suiInteractor/index.ts

@@ -1,3 +1,3 @@
 export { SuiInteractor } from './suiInteractor';
-export { getDefaultURL } from './defaultConfig';
+export { getDefaultConfig, getDefaultURL } from './defaultConfig';
 export type { NetworkConfig } from './defaultConfig';

package/src/types/index.ts

@@ -47,8 +47,22 @@ export type DubheParams = {
   faucetUrl?: string;
   networkType?: NetworkType;
   packageId?: string;
+  /**
+   * The canonical dapp_key type string, e.g. `"0105c1...::dapp_key::DappKey"`.
+   * Stable across all upgrades — derived from the original (genesis) package ID.
+   * When provided this value is used directly; otherwise it is computed from packageId
+   * (only safe before the first upgrade).
+   * Obtain from the generated `DappKey` export in deployment.ts.
+   */
+  dappKey?: string;
   metadata?: SuiMoveNormalizedModules;
   channelUrl?: string;
+  /** Published package ID of the dubhe framework. Required for session and user-storage operations. */
+  frameworkPackageId?: string;
+  /** Object ID of the DappStorage shared object. Stored for convenience; also passed to individual methods. */
+  dappStorageId?: string;
+  /** Object ID of the DappHub shared object. Required for activate/deactivate session and other DappHub-gated calls. */
+  dappHubId?: string;
 };
 
 export type SchemaFieldType = {

package/src/utils/index.ts

@@ -40,11 +40,34 @@ function convertHttpToWebSocket(url: string): string {
   return url;
 }
 
+/**
+ * Build the fully-qualified Move type string for a DApp's `DappKey`.
+ *
+ * The format matches what `std::type_name::get<DappKey>()` returns on-chain:
+ * `<64-char-zero-padded-address>::dapp_key::DappKey`
+ *
+ * @param packageId - The DApp's published package ID (with or without 0x prefix).
+ *
+ * @example
+ * ```typescript
+ * tx.moveCall({
+ *   target: `${frameworkPackageId}::dapp_system::settle_writes`,
+ *   typeArguments: [normalizeDappKey(packageId)],
+ *   arguments: [...],
+ * });
+ * ```
+ */
+function normalizeDappKey(packageId: string): string {
+  const raw = packageId.replace(/^0x/, '');
+  return `${raw.padStart(64, '0')}::dapp_key::DappKey`;
+}
+
 export {
   BasicBcsTypes,
   capitalizeFirstLetter,
   normalizeHexAddress,
   numberToAddressHex,
   normalizePackageId,
-  convertHttpToWebSocket
+  convertHttpToWebSocket,
+  normalizeDappKey
 };