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

package/LICENSE

@@ -0,0 +1,92 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor:             Obelisk Labs
+
+Licensed Work:        Dubhe
+                      The Licensed Work is (c) 2023 Obelisk Labs
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.

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, NetworkType } from './types';
 import { DubheChannelClient } from './libs/dubheChannel';
 export declare function isUndefined(value?: unknown): value is undefined;
 export declare function withMeta<T extends {
@@ -24,8 +24,13 @@ export declare class Dubhe {
     contractFactory: SuiContractFactory;
     dubheChannelClient: DubheChannelClient;
     packageId: string | undefined;
+    /** Fully-qualified Move type string for this DApp's DappKey, e.g. `<64-hex>::dapp_key::DappKey`. */
+    dappKey: string | undefined;
     metadata: SuiMoveNormalizedModules | undefined;
     projectName: string | undefined;
+    frameworkPackageId: string | undefined;
+    dappStorageId: string | undefined;
+    dappHubId: string | undefined;
     /**
      * Support the following ways to init the DubheClient:
      * 1. mnemonics
@@ -39,8 +44,9 @@ export declare class Dubhe {
      * @param packageId
      * @param metadata
      * @param channelUrl, the base URL for Dubhe Channel API, optional
+     * @param frameworkPackageId, the published package ID of the dubhe framework, required for proxy operations
      */
-    constructor({ mnemonics, secretKey, networkType, fullnodeUrls, packageId, metadata, channelUrl }?: DubheParams);
+    constructor({ mnemonics, secretKey, networkType, fullnodeUrls, packageId, dappKey: dappKeyParam, metadata, channelUrl, frameworkPackageId, dappStorageId, dappHubId }?: DubheParams);
     get query(): MapMoudleFuncQuery;
     get tx(): MapMoudleFuncTx;
     get object(): MapObjectStruct;
@@ -76,8 +82,27 @@ export declare class Dubhe {
     getAddress(derivePathParams?: DerivePathParams): string;
     currentAddress(): string;
     getPackageId(): string;
+    /**
+     * Return the fully-qualified Move type string for this DApp's `DappKey`.
+     *
+     * The format matches what `std::type_name::get<DappKey>()` returns on-chain:
+     * `<64-char-zero-padded-address>::dapp_key::DappKey`
+     *
+     * Use this whenever you need to pass a type argument or build a `target`
+     * string that references the DApp's DappKey type.
+     *
+     * @example
+     * ```typescript
+     * tx.moveCall({
+     *   target: `${frameworkPackageId}::dapp_system::settle_writes`,
+     *   typeArguments: [contract.getDappKey()],
+     *   arguments: [...],
+     * });
+     * ```
+     */
+    getDappKey(): string | undefined;
     getMetadata(): SuiMoveNormalizedModules | undefined;
-    getNetwork(): import("./types").NetworkType | undefined;
+    getNetwork(): NetworkType | undefined;
     getNetworkConfig(): NetworkConfig;
     getTxExplorerUrl(txHash: string): string;
     getAccountExplorerUrl(address: string): string;
@@ -148,7 +173,7 @@ export declare class Dubhe {
      *   { onMessage: (data) => console.log(data) }
      * );
      */
-    subscribeChannelTable({ packageId, account, table, key }?: {
+    subscribeChannelTable({ packageId: _packageId, account, table, key }?: {
         packageId?: string;
         account?: string;
         table?: string;
@@ -221,4 +246,392 @@ export declare class Dubhe {
     entity_key_from_address_with_seed(objectId: string, seed: string): Promise<string | undefined>;
     entity_key_from_address_with_u256(objectId: string, x: number): Promise<string | undefined>;
     entity_key_from_u256(x: number): Promise<string>;
+    /**
+     * Call the DApp's generated `user_storage_init::init_user_storage` entry function,
+     * which creates and shares a `UserStorage` object for the signer.
+     *
+     * Each DApp exposes this entry point under its own package ID.
+     * On Sui, the `UserStorage` object is shared immediately so all transactions
+     * can reference it without knowing the object ID in advance.
+     *
+     * @param dappHubId      Object ID of the DappHub shared object
+     * @param dappStorageId  Object ID of the DApp's DappStorage shared object
+     */
+    initUserStorage({ dappHubId, dappStorageId: dappStorageIdParam, derivePathParams, onSuccess, onError }: {
+        dappHubId: string;
+        dappStorageId?: string;
+        derivePathParams?: DerivePathParams;
+        onSuccess?: (result: SuiTransactionBlockResponse) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<SuiTransactionBlockResponse>;
+    /**
+     * Activate a session key for the signer's `UserStorage`.
+     *
+     * The signer must be the `canonical_owner` of the `UserStorage` object.
+     * Calls `<frameworkPackageId>::dapp_system::activate_session<DappKey>`.
+     *
+     * @param userStorageId  Object ID of the UserStorage to activate a session for
+     * @param sessionWallet  Sui address of the session wallet
+     * @param durationMs     Session duration in milliseconds ([60_000, 604_800_000])
+     * @param clockObjectId  Object ID of the Sui Clock (default: 0x6)
+     */
+    activateSession({ userStorageId, sessionWallet, durationMs, dappHubId: dappHubIdParam, clockObjectId, derivePathParams, onSuccess, onError }: {
+        userStorageId: string;
+        sessionWallet: string;
+        durationMs: number;
+        dappHubId?: string;
+        clockObjectId?: string;
+        derivePathParams?: DerivePathParams;
+        onSuccess?: (result: SuiTransactionBlockResponse) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<SuiTransactionBlockResponse>;
+    /**
+     * Deactivate the current session key on a `UserStorage`.
+     *
+     * Allowed callers:
+     *   - The `canonical_owner` (revoke at any time).
+     *   - The session key itself (voluntary sign-out).
+     *   - Anyone, once the session has expired.
+     *
+     * Calls `<frameworkPackageId>::dapp_system::deactivate_session<DappKey>`.
+     *
+     * @param userStorageId  Object ID of the UserStorage to deactivate the session on
+     */
+    deactivateSession({ userStorageId, dappHubId: dappHubIdParam, derivePathParams, onSuccess, onError }: {
+        userStorageId: string;
+        dappHubId?: string;
+        derivePathParams?: DerivePathParams;
+        onSuccess?: (result: SuiTransactionBlockResponse) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<SuiTransactionBlockResponse>;
+    /**
+     * Look up the `UserStorage` object ID for the given address in this DApp.
+     *
+     * Scans the transaction history for `user_storage_init::init_user_storage`
+     * calls from the given address and extracts the created `UserStorage` object
+     * ID from the transaction's object changes.
+     *
+     * Returns the object ID on success, or `null` when:
+     *   - `packageId` or `frameworkPackageId` is not set.
+     *   - The user has not yet called `initUserStorage`.
+     *
+     * @param userAddress  Sui address to look up (with or without 0x prefix).
+     */
+    getUserStorageId(userAddress: string): Promise<string | null>;
+    /**
+     * Fetch and return the on-chain fields of a `UserStorage` shared object.
+     *
+     * The returned object mirrors Move's `UserStorage` struct plus two
+     * convenience fields computed from the raw counters:
+     *   - `unsettled_count`  = write_count  − settled_count
+     *   - `unsettled_bytes`  = write_bytes  − settled_bytes
+     *
+     * @param userStorageId  Object ID of the UserStorage to inspect.
+     */
+    getUserStorageFields(userStorageId: string): Promise<{
+        objectId: string;
+        dapp_key: string;
+        canonical_owner: string;
+        session_key: string;
+        session_expires_at: bigint;
+        write_count: bigint;
+        settled_count: bigint;
+        write_bytes: bigint;
+        settled_bytes: bigint;
+        unsettled_count: bigint;
+        unsettled_bytes: bigint;
+    }>;
+    /**
+     * Fetch and return the on-chain fields of a `DappStorage` shared object.
+     *
+     * Covers the full metadata + fee/credit subset of the Move struct.
+     *
+     * @param dappStorageId  Object ID of the DappStorage to inspect.
+     */
+    /**
+     * Read the framework-level fields from the DappHub shared object.
+     *
+     * Key fields:
+     * - `treasury`          — address that directly receives framework fee income
+     * - `pending_treasury`  — queued treasury address during two-step rotation
+     * - `framework_admin`   — address that can update framework configuration
+     * - `version`           — current framework version
+     */
+    getDappHubFields(dappHubId: string): Promise<{
+        objectId: string;
+        version: number;
+        framework_admin: string;
+        treasury: string;
+        pending_treasury: string;
+    }>;
+    getDappStorageFields(dappStorageId: string): Promise<{
+        objectId: string;
+        dapp_key: string;
+        name: string;
+        description: string;
+        website_url: string;
+        admin: string;
+        version: number;
+        paused: boolean;
+        free_credit: bigint;
+        free_credit_expires_at: bigint;
+        credit_pool: bigint;
+        min_credit_to_unsuspend: bigint;
+        suspended: boolean;
+        total_settled: bigint;
+        base_fee_per_write: bigint;
+        bytes_fee_per_byte: bigint;
+        /**
+         * Settlement mode: 0 = DAPP_SUBSIDIZES (operator pays from credit_pool),
+         * 1 = USER_PAYS (user provides Coin via settle_writes_user_pays).
+         * Only `settle_writes` (no-coin variant) is safe to auto-call in mode 0.
+         */
+        settlement_mode: number;
+        /**
+         * BPS (0-10000) of each write-fee payment that flows into the DApp's
+         * revenue pool. The remainder goes to the framework treasury.
+         * Set exclusively by the framework admin via set_dapp_write_fee_share.
+         * Default: 0 (100% to framework treasury).
+         */
+        write_fee_dapp_share_bps: number;
+    }>;
+    /**
+     * Append a `dapp_system::settle_writes` moveCall to an existing PTB.
+     *
+     * Does NOT send the transaction — call this before your own moveCall(s) to
+     * settle any accumulated write debt within the same PTB at no extra round-trip.
+     *
+     * The framework function never aborts due to insufficient credit (it silently
+     * skips or partially settles), so prepending this to any PTB is always safe.
+     *
+     * @param tx             The Transaction object to append the moveCall to.
+     * @param dappHubId      Object ID of the DappHub shared object.
+     * @param dappStorageId  Object ID of the DApp's DappStorage (falls back to constructor value).
+     * @param userStorageId  Object ID of the user's UserStorage shared object.
+     */
+    buildSettleWritesTx(tx: Transaction, { dappHubId, dappStorageId: dappStorageIdParam, userStorageId }: {
+        dappHubId: string;
+        dappStorageId?: string;
+        userStorageId: string;
+    }): void;
+    /**
+     * Settle accumulated write debt for a user (standalone transaction).
+     *
+     * Builds a PTB containing a single `dapp_system::settle_writes` call and
+     * sends it. For embedding settlement into an existing PTB, use
+     * `buildSettleWritesTx` instead.
+     *
+     * This is safe to call at any time — the framework function never aborts
+     * due to insufficient credit; it silently skips or partially settles.
+     *
+     * @param dappHubId      Object ID of the DappHub shared object.
+     * @param dappStorageId  Object ID of the DApp's DappStorage shared object.
+     * @param userStorageId  Object ID of the user's UserStorage shared object.
+     */
+    settleWrites({ dappHubId, dappStorageId, userStorageId, derivePathParams, onSuccess, onError }: {
+        dappHubId: string;
+        dappStorageId?: string;
+        userStorageId: string;
+        derivePathParams?: DerivePathParams;
+        onSuccess?: (result: SuiTransactionBlockResponse) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<SuiTransactionBlockResponse>;
+    /**
+     * Recharge a DApp's credit pool by paying with the framework's accepted coin type.
+     *
+     * Wraps `dapp_system::recharge_credit<DappKey, CoinType>`. Any account may call
+     * this — no admin restriction. Payment is forwarded to the framework treasury and
+     * the DApp's `credit_pool` is increased by the coin value.
+     *
+     * Only valid in DAPP_SUBSIDIZES settlement mode. Aborts with
+     * `wrong_settlement_mode` if the DApp is in USER_PAYS mode.
+     *
+     * @param dappHubId      Object ID of the DappHub shared object.
+     * @param dappStorageId  Object ID of the DApp's DappStorage shared object.
+     * @param coinObjectId   Object ID of the Coin to use as payment.
+     * @param coinType       Move type of the coin (default: "0x2::sui::SUI").
+     */
+    rechargeCredit({ dappHubId, dappStorageId: dappStorageIdParam, coinObjectId, coinType, derivePathParams, onSuccess, onError }: {
+        dappHubId: string;
+        dappStorageId?: string;
+        coinObjectId: string;
+        coinType?: string;
+        derivePathParams?: DerivePathParams;
+        onSuccess?: (result: SuiTransactionBlockResponse) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<SuiTransactionBlockResponse>;
+    /**
+     * Append a `dapp_system::settle_writes_user_pays` moveCall to an existing PTB.
+     *
+     * Splits `maxPaymentMist` MIST from `tx.gas` as the payment coin, then calls
+     * `settle_writes_user_pays`. The framework returns any overpayment automatically,
+     * so it is safe to over-estimate. This lets a session key pay for settlement
+     * inline without requiring a separate owned Coin object.
+     *
+     * @param tx              The Transaction object to append the moveCall to.
+     * @param dappHubId       Object ID of the DappHub shared object.
+     * @param dappStorageId   Object ID of the DApp's DappStorage (falls back to constructor value).
+     * @param userStorageId   Object ID of the user's UserStorage shared object.
+     * @param maxPaymentMist  Upper bound for the payment in MIST (default: 50_000_000 = 0.05 SUI).
+     * @param coinType        Move type of the payment coin (default: "0x2::sui::SUI").
+     */
+    buildSettleWritesUserPaysTx(tx: Transaction, { dappHubId, dappStorageId: dappStorageIdParam, userStorageId, maxPaymentMist, coinType }: {
+        dappHubId: string;
+        dappStorageId?: string;
+        userStorageId: string;
+        maxPaymentMist?: bigint;
+        coinType?: string;
+    }): void;
+    /**
+     * Settle accumulated write debt where the user pays directly (USER_PAYS mode).
+     *
+     * Wraps `dapp_system::settle_writes_user_pays<DappKey, CoinType>`. The exact
+     * cost is computed on-chain; any overpayment from the coin is returned to the
+     * sender after settlement.
+     *
+     * Aborts if:
+     * - The DApp is not in USER_PAYS mode (`wrong_settlement_mode`)
+     * - The coin type does not match the accepted type (`wrong_payment_coin_type`)
+     * - The coin value is less than the total cost (`insufficient_credit`)
+     *
+     * @param dappHubId      Object ID of the DappHub shared object.
+     * @param dappStorageId  Object ID of the DApp's DappStorage shared object.
+     * @param userStorageId  Object ID of the user's UserStorage shared object.
+     * @param coinObjectId   Object ID of the Coin to use as payment.
+     * @param coinType       Move type of the coin (default: "0x2::sui::SUI").
+     */
+    settleWritesUserPays({ dappHubId, dappStorageId: dappStorageIdParam, userStorageId, coinObjectId, coinType, derivePathParams, onSuccess, onError }: {
+        dappHubId: string;
+        dappStorageId?: string;
+        userStorageId: string;
+        coinObjectId: string;
+        coinType?: string;
+        derivePathParams?: DerivePathParams;
+        onSuccess?: (result: SuiTransactionBlockResponse) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<SuiTransactionBlockResponse>;
+    /**
+     * Query `WritesSettled` events from the Sui full node.
+     *
+     * Returns the most recent settlement events across ALL users of this DApp.
+     * Each event captures one user's write debt settlement: number of writes,
+     * bytes, and the amount charged (`paid_cost`).
+     *
+     * Note: Sui full nodes may prune old events. For long-term history use a
+     * dedicated indexer table (`writes_settled_history`).
+     *
+     * @param limit   Max events to return (default: 30, max: 50).
+     * @param cursor  Pagination cursor from a previous response.
+     */
+    queryWritesSettledEvents(limit?: number, cursor?: {
+        txDigest: string;
+        eventSeq: string;
+    }): Promise<Array<{
+        txDigest: string;
+        eventSeq: string;
+        timestampMs: number;
+        dappKey: string;
+        account: string;
+        writes: number;
+        bytes: string;
+        freeCost: string;
+        paidCost: string;
+    }>>;
+    /**
+     * Query `MarketplaceFeeSettled` events from the Sui full node.
+     *
+     * Each event records the fee split for a completed marketplace purchase:
+     * total fee, framework treasury share, and DApp revenue share.
+     *
+     * @param limit   Max events to return (default: 30, max: 50).
+     * @param cursor  Pagination cursor from a previous response.
+     */
+    queryMarketplaceFeeSettledEvents(limit?: number, cursor?: {
+        txDigest: string;
+        eventSeq: string;
+    }): Promise<Array<{
+        txDigest: string;
+        eventSeq: string;
+        timestampMs: number;
+        dappKey: string;
+        listingId: string;
+        coinType: string;
+        totalFee: string;
+        treasuryAmount: string;
+        dappAmount: string;
+    }>>;
+    /**
+     * Read the DApp's accumulated revenue balance directly from the chain.
+     *
+     * `dapp_revenue` is stored as a dynamic field (`DappRevenueKey<CoinType>`)
+     * on the DappStorage object — it is NOT a top-level field, so `getObject`
+     * alone cannot return it. This method calls `getDynamicFields` to locate
+     * the correct child object and returns its balance.
+     *
+     * Returns 0n when the dynamic field has never been created (no revenue yet).
+     *
+     * @param dappStorageId  Object ID of the DApp's DappStorage shared object.
+     * @param coinType       Move type of the revenue coin (default: "0x2::sui::SUI").
+     */
+    getDappRevenueBalance(dappStorageId: string, coinType?: string): Promise<bigint>;
+    /**
+     * Withdraw all accumulated DApp revenue to the DApp admin address.
+     *
+     * Wraps `dapp_system::withdraw_dapp_revenue<DappKey, CoinType>`.
+     * The entire revenue balance is transferred to the DApp admin on-chain.
+     * Aborts if the balance is zero (`no_revenue_to_withdraw`).
+     *
+     * @param dappHubId     Object ID of the DappHub shared object.
+     * @param dappStorageId Object ID of the DApp's DappStorage shared object.
+     * @param coinType      Move type of the revenue coin (default: "0x2::sui::SUI").
+     */
+    withdrawDappRevenue({ dappHubId, dappStorageId: dappStorageIdParam, coinType, derivePathParams, onSuccess, onError }: {
+        dappHubId: string;
+        dappStorageId?: string;
+        coinType?: string;
+        derivePathParams?: DerivePathParams;
+        onSuccess?: (result: SuiTransactionBlockResponse) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<SuiTransactionBlockResponse>;
+    /**
+     * Return a combined settlement health snapshot for a user.
+     *
+     * Fetches `UserStorage` fields (always) and optionally `DappStorage` fields
+     * (when `dappStorageId` is supplied) to produce high-level diagnostic values:
+     *
+     * - `utilizationPct`  — how close the user is to the 2 000-write hard limit
+     * - `isAtRisk`        — utilization >= 80 % (settlement recommended soon)
+     * - `isBlocked`       — utilization >= 100 % (writes will be rejected)
+     * - `estimatedWritesAffordable` — writes the credit pool can still cover
+     * - `creditAtRisk`    — fewer than 500 writes of credit remaining
+     *
+     * @param userStorageId  Object ID of the user's UserStorage shared object.
+     * @param dappStorageId  Object ID of the DApp's DappStorage (optional).
+     */
+    getSettlementHealth({ userStorageId, dappStorageId }: {
+        userStorageId: string;
+        dappStorageId?: string;
+    }): Promise<{
+        unsettledCount: bigint;
+        writeLimit: bigint;
+        utilizationPct: number;
+        isAtRisk: boolean;
+        isBlocked: boolean;
+        creditPool?: bigint;
+        baseFeePerWrite?: bigint;
+        estimatedWritesAffordable?: bigint;
+        creditAtRisk?: boolean;
+    }>;
+    /**
+     * Return the default network configuration for the given network type.
+     *
+     * Useful for reading `frameworkPackageId` without instantiating a full client:
+     *
+     * ```ts
+     * const { frameworkPackageId } = Dubhe.getDefaultConfig('testnet');
+     * // → '0x8817b...' (known constant for testnet/mainnet)
+     * // → undefined   (for localnet/devnet — supply after local deployment)
+     * ```
+     */
+    static getDefaultConfig(networkType: NetworkType): NetworkConfig;
 }

package/dist/index.d.ts

@@ -14,3 +14,5 @@ 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';