@0xobelisk/client 0.3.0 → 0.3.2

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

@@ -0,0 +1,205 @@
+import { SuiTransactionBlockResponse, JsonRpcProvider, DynamicFieldName, SuiAddress } from '@mysten/sui.js';
+import { FaucetNetworkType, NetworkType, ObjectData, EntityData } from 'src/types';
+import { SuiOwnedObject, SuiSharedObject } from '../suiModel';
+/**
+ * `SuiTransactionSender` is used to send transaction with a given gas coin.
+ * It always uses the gas coin to pay for the gas,
+ * and update the gas coin after the transaction.
+ */
+export declare class SuiInteractor {
+    readonly providers: JsonRpcProvider[];
+    currentProvider: JsonRpcProvider;
+    network?: NetworkType;
+    constructor(fullNodeUrls: string[], network?: NetworkType);
+    switchToNextProvider(): void;
+    sendTx(transactionBlock: Uint8Array | string, signature: string | string[]): Promise<SuiTransactionBlockResponse>;
+    getObjects(ids: string[]): Promise<ObjectData[]>;
+    getObject(id: string): Promise<ObjectData>;
+    getEntitiesObjects(ids: string[]): Promise<EntityData[]>;
+    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[];
+        }>;
+    }>>;
+    /**
+     * @description Update objects in a batch
+     * @param suiObjects
+     */
+    updateObjects(suiObjects: (SuiOwnedObject | SuiSharedObject)[]): Promise<void>;
+    /**
+     * @description Select coins that add up to the given amount.
+     * @param addr the address of the owner
+     * @param amount the amount that is needed for the coin
+     * @param coinType the coin type, default is '0x2::SUI::SUI'
+     */
+    selectCoins(addr: string, amount: number, coinType?: string): Promise<{
+        objectId: string;
+        digest: string;
+        version: string;
+    }[]>;
+    requestFaucet(address: SuiAddress, network: FaucetNetworkType): Promise<void>;
+}