@0xobelisk/sui-client 0.5.2 → 0.5.4

package/dist/libs/suiInteractor/suiInteractor.d.ts

@@ -1,5 +1,7 @@
-import { SuiTransactionBlockResponse, JsonRpcProvider, DynamicFieldName, SuiAddress } from '@mysten/sui.js';
-import { FaucetNetworkType, NetworkType, ObjectData } from '../../types';
+import { SuiClient } from '@mysten/sui.js/client';
+import type { SuiTransactionBlockResponse, SuiObjectDataOptions, SuiObjectData } from '@mysten/sui.js/client';
+import type * as RpcTypes from '@mysten/sui.js/dist/cjs/client/types/generated';
+import { FaucetNetworkType, NetworkType } from '../../types';
 import { SuiOwnedObject, SuiSharedObject } from '../suiModel';
 /**
  * `SuiTransactionSender` is used to send transaction with a given gas coin.
@@ -7,183 +9,21 @@ import { SuiOwnedObject, SuiSharedObject } from '../suiModel';
  * and update the gas coin after the transaction.
  */
 export declare class SuiInteractor {
-    readonly providers: JsonRpcProvider[];
-    currentProvider: JsonRpcProvider;
+    readonly clients: SuiClient[];
+    currentClient: SuiClient;
+    readonly fullNodes: string[];
+    currentFullNode: string;
     network?: NetworkType;
     constructor(fullNodeUrls: string[], network?: NetworkType);
-    switchToNextProvider(): void;
+    switchToNextClient(): void;
     sendTx(transactionBlock: Uint8Array | string, signature: string | string[]): Promise<SuiTransactionBlockResponse>;
-    getObjects(ids: string[]): Promise<ObjectData[]>;
-    getObject(id: string): Promise<ObjectData>;
-    getDynamicFieldObject(parentId: string, name: string | DynamicFieldName): Promise<{
-        data?: {
-            objectId: string;
-            version: string;
-            digest: string;
-            type?: string | null | undefined;
-            bcs?: {
-                type: string;
-                version: string;
-                hasPublicTransfer: boolean;
-                dataType: "moveObject";
-                bcsBytes: string;
-            } | {
-                id: string;
-                dataType: "package";
-                moduleMap: Record<string, string>;
-            } | null | undefined;
-            owner?: {
-                AddressOwner: string;
-            } | {
-                ObjectOwner: string;
-            } | {
-                Shared: {
-                    initial_shared_version: string | null;
-                };
-            } | "Immutable" | null | undefined;
-            storageRebate?: string | null | undefined;
-            previousTransaction?: string | null | undefined;
-            content?: {
-                type: string;
-                fields: Record<string, any>;
-                hasPublicTransfer: boolean;
-                dataType: "moveObject";
-            } | {
-                disassembled: Record<string, unknown>;
-                dataType: "package";
-            } | null | undefined;
-            display?: Record<string, string> | {
-                data?: Record<string, string> | null | undefined;
-                error?: {
-                    code: string;
-                    version?: string | undefined;
-                    digest?: string | undefined;
-                    error?: string | undefined;
-                    object_id?: string | undefined;
-                    parent_object_id?: string | undefined;
-                } | null | undefined;
-            } | null | undefined;
-        } | null | undefined;
-        error?: {
-            code: string;
-            version?: string | undefined;
-            digest?: string | undefined;
-            error?: string | undefined;
-            object_id?: string | undefined;
-            parent_object_id?: string | undefined;
-        } | null | undefined;
-    }>;
-    getDynamicFields(parentId: string, cursor?: string, limit?: number): Promise<{
-        data: {
-            type: "DynamicField" | "DynamicObject";
-            objectType: string;
-            objectId: string;
-            version: number;
-            digest: string;
-            name: {
-                type: string;
-                value?: any;
-            };
-            bcsName: string;
-        }[];
-        nextCursor: string | null;
-        hasNextPage: boolean;
-    }>;
-    getOwnedObjects(owner: SuiAddress, cursor?: string, limit?: number): Promise<{
-        data: {
-            data?: {
-                objectId: string;
-                version: string;
-                digest: string;
-                type?: string | null | undefined;
-                bcs?: {
-                    type: string;
-                    version: string;
-                    hasPublicTransfer: boolean;
-                    dataType: "moveObject";
-                    bcsBytes: string;
-                } | {
-                    id: string;
-                    dataType: "package";
-                    moduleMap: Record<string, string>;
-                } | null | undefined;
-                owner?: "Immutable" | {
-                    AddressOwner: string;
-                } | {
-                    ObjectOwner: string;
-                } | {
-                    Shared: {
-                        initial_shared_version: string | null;
-                    };
-                } | null | undefined;
-                storageRebate?: string | null | undefined;
-                previousTransaction?: string | null | undefined;
-                content?: {
-                    type: string;
-                    fields: Record<string, any>;
-                    hasPublicTransfer: boolean;
-                    dataType: "moveObject";
-                } | {
-                    disassembled: Record<string, unknown>;
-                    dataType: "package";
-                } | null | undefined;
-                display?: Record<string, string> | {
-                    data?: Record<string, string> | null | undefined;
-                    error?: {
-                        code: string;
-                        version?: string | undefined;
-                        digest?: string | undefined;
-                        error?: string | undefined;
-                        object_id?: string | undefined;
-                        parent_object_id?: string | undefined;
-                    } | null | undefined;
-                } | null | undefined;
-            } | null | undefined;
-            error?: {
-                code: string;
-                version?: string | undefined;
-                digest?: string | undefined;
-                error?: string | undefined;
-                object_id?: string | undefined;
-                parent_object_id?: string | undefined;
-            } | null | undefined;
-        }[];
-        hasNextPage: boolean;
-        nextCursor?: string | null | undefined;
-    }>;
-    getNormalizedMoveModulesByPackage(packageId: string): Promise<Record<string, {
-        address: string;
-        name: string;
-        fileFormatVersion: number;
-        friends: {
-            address: string;
-            name: string;
-        }[];
-        structs: Record<string, {
-            fields: {
-                type: import("@mysten/sui.js").SuiMoveNormalizedType;
-                name: string;
-            }[];
-            abilities: {
-                abilities: string[];
-            };
-            typeParameters: {
-                constraints: {
-                    abilities: string[];
-                };
-                isPhantom: boolean;
-            }[];
-        }>;
-        exposedFunctions: Record<string, {
-            visibility: "Private" | "Public" | "Friend";
-            isEntry: boolean;
-            typeParameters: {
-                abilities: string[];
-            }[];
-            parameters: import("@mysten/sui.js").SuiMoveNormalizedType[];
-            return: import("@mysten/sui.js").SuiMoveNormalizedType[];
-        }>;
-    }>>;
+    getObjects(ids: string[], options?: SuiObjectDataOptions): Promise<SuiObjectData[]>;
+    getObject(id: string): Promise<SuiObjectData>;
+    getDynamicFieldObject(parentId: string, name: RpcTypes.DynamicFieldName): Promise<RpcTypes.SuiObjectResponse>;
+    getDynamicFields(parentId: string, cursor?: string, limit?: number): Promise<import("@mysten/sui.js/client").DynamicFieldPage>;
+    getTxDetails(digest: string): Promise<SuiTransactionBlockResponse>;
+    getOwnedObjects(owner: string, cursor?: string, limit?: number): Promise<RpcTypes.PaginatedObjectsResponse>;
+    getNormalizedMoveModulesByPackage(packageId: string): Promise<import("@mysten/sui.js/client").SuiMoveNormalizedModules>;
     /**
      * @description Update objects in a batch
      * @param suiObjects
@@ -200,5 +40,5 @@ export declare class SuiInteractor {
         digest: string;
         version: string;
     }[]>;
-    requestFaucet(address: SuiAddress, network: FaucetNetworkType): Promise<void>;
+    requestFaucet(address: string, network: FaucetNetworkType): Promise<void>;
 }

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

@@ -0,0 +1 @@
+export declare const delay: (ms: number) => Promise<unknown>;

package/dist/libs/suiModel/index.d.ts

@@ -0,0 +1,2 @@
+export { SuiOwnedObject } from './suiOwnedObject';
+export { SuiSharedObject } from './suiSharedObject';

package/dist/libs/suiModel/suiOwnedObject.d.ts

@@ -0,0 +1,24 @@
+import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
+import type { CallArg } from '@mysten/sui.js/bcs';
+export declare class SuiOwnedObject {
+    readonly objectId: string;
+    version?: string;
+    digest?: string;
+    constructor(param: {
+        objectId: string;
+        version?: string;
+        digest?: string;
+    });
+    /**
+     * Check if the object is fully initialized.
+     * So that when it's used as an input, it won't be necessary to fetch from fullnode again.
+     * Which can save time when sending transactions.
+     */
+    isFullObject(): boolean;
+    asCallArg(): CallArg | string;
+    /**
+     * Update object version & digest based on the transaction response.
+     * @param txResponse
+     */
+    updateFromTxResponse(txResponse: SuiTransactionBlockResponse): void;
+}

package/dist/libs/suiModel/suiSharedObject.d.ts

@@ -0,0 +1,11 @@
+import type { CallArg } from '@mysten/sui.js/bcs';
+export declare class SuiSharedObject {
+    readonly objectId: string;
+    initialSharedVersion?: string;
+    constructor(param: {
+        objectId: string;
+        initialSharedVersion?: string;
+        mutable?: boolean;
+    });
+    asCallArg(mutable?: boolean): CallArg | string;
+}