@0xobelisk/client 0.0.1 → 0.0.3

package/dist/obelisk.d.ts

@@ -1,21 +1,27 @@
-/**
- * @file src.ts
- * @description This file is used to aggregate the tools that used to interact with SUI network.
- * @author IceFox
- * @version 0.1.0
- */
-import { RawSigner, TransactionBlock, DevInspectResults, SuiTransactionBlockResponse, JsonRpcProvider } from '@mysten/sui.js';
+import { RawSigner, TransactionBlock, DevInspectResults, SuiTransactionBlockResponse, SuiMoveNormalizedModules } from '@mysten/sui.js';
 import { SuiAccountManager } from './libs/suiAccountManager';
 import { SuiRpcProvider } from './libs/suiRpcProvider';
 import { SuiTxBlock } from './libs/suiTxBuilder';
-import { SuiKitParams, DerivePathParams, SuiTxArg, SuiVecTxArg } from './types';
+import { SuiContractFactory } from './libs/suiContractFactory';
+import { SuiMoveMoudleFuncType } from './libs/suiContractFactory/types';
+import { ObeliskParams, DerivePathParams, SuiTxArg, SuiVecTxArg, MapMoudleFuncQuery, MapMoudleFuncTx } 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 SuiKit
+ * @class Obelisk
  * @description This class is used to aggregate the tools that used to interact with SUI network.
  */
 export declare class Obelisk {
+    #private;
     accountManager: SuiAccountManager;
     rpcProvider: SuiRpcProvider;
+    contractFactory: SuiContractFactory;
+    packageId: string | undefined;
+    metadata: SuiMoveNormalizedModules;
+    epsId: string;
+    componentsId: string;
     /**
      * Support the following ways to init the SuiToolkit:
      * 1. mnemonics
@@ -27,8 +33,11 @@ export declare class Obelisk {
      * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
      * @param fullnodeUrl, the fullnode url, default is the preconfig fullnode url for the given network type
      * @param faucetUrl, the faucet url, default is the preconfig faucet url for the given network type
+     * @param packageId
      */
-    constructor({ mnemonics, secretKey, networkType, fullnodeUrl, faucetUrl, }?: SuiKitParams);
+    constructor({ mnemonics, secretKey, networkType, fullnodeUrl, faucetUrl, packageId, metadata }?: ObeliskParams);
+    get query(): MapMoudleFuncQuery;
+    get tx(): MapMoudleFuncTx;
     /**
      * if derivePathParams is not provided or mnemonics is empty, it will return the currentSigner.
      * else:
@@ -47,7 +56,41 @@ export declare class Obelisk {
      */
     getAddress(derivePathParams?: DerivePathParams): string;
     currentAddress(): string;
-    provider(): JsonRpcProvider;
+    provider(): import("@mysten/sui.js").JsonRpcProvider;
+    getPackageId(): string;
+    getMetadata(): 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[];
+        }>;
+    }> | undefined;
     /**
      * Request some SUI from faucet
      * @Returns {Promise<boolean>}, true if the request is successful, false otherwise.
@@ -62,6 +105,7 @@ export declare class Obelisk {
             epochId?: number | undefined;
         };
     }>;
+    getObject(objectId: string): Promise<import("./libs/suiRpcProvider/types").ObjectData>;
     getObjects(objectIds: string[]): Promise<import("./libs/suiRpcProvider/types").ObjectData[]>;
     signTxn(tx: Uint8Array | TransactionBlock | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<import("@mysten/sui.js").SignedTransaction>;
     signAndSendTxn(tx: Uint8Array | TransactionBlock | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
@@ -2511,147 +2555,8 @@ export declare class Obelisk {
      * @returns the effects and events of the transaction, such as object changes, gas cost, event emitted.
      */
     inspectTxn(tx: Uint8Array | TransactionBlock | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<DevInspectResults>;
-    call(world_id: string, system_name: string, counter: any, derivePathParams?: DerivePathParams): Promise<{
-        digest: string;
-        timestampMs?: string | undefined;
-        transaction?: {
-            data: {
-                sender: string;
-                messageVersion: "v1";
-                transaction: {
-                    epoch: string;
-                    storage_charge: string;
-                    computation_charge: string;
-                    storage_rebate: string;
-                    kind: "ChangeEpoch";
-                    epoch_start_timestamp_ms?: string | undefined;
-                } | {
-                    epoch: string;
-                    round: string;
-                    commit_timestamp_ms: string;
-                    kind: "ConsensusCommitPrologue";
-                } | {
-                    objects: string[];
-                    kind: "Genesis";
-                } | {
-                    transactions: ({
-                        MoveCall: {
-                            function: string;
-                            package: string;
-                            module: string;
-                            arguments?: ("GasCoin" | {
-                                Input: number;
-                            } | {
-                                Result: number;
-                            } | {
-                                NestedResult: [number, number];
-                            })[] | undefined;
-                            type_arguments?: string[] | undefined;
-                        };
-                    } | {
-                        TransferObjects: [("GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        })[], "GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        }];
-                    } | {
-                        SplitCoins: ["GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        }, ("GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        })[]];
-                    } | {
-                        MergeCoins: ["GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        }, ("GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        })[]];
-                    } | {
-                        Publish: string[] | [{
-                            disassembled: Record<string, string>;
-                        }, string[]];
-                    } | {
-                        Upgrade: [string[], string, "GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        }] | [{
-                            disassembled: Record<string, string>;
-                        }, string[], string, "GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        }];
-                    } | {
-                        MakeMoveVec: [string | null, ("GasCoin" | {
-                            Input: number;
-                        } | {
-                            Result: number;
-                        } | {
-                            NestedResult: [number, number];
-                        })[]];
-                    })[];
-                    inputs: ({
-                        type: "pure";
-                        valueType: string | null;
-                        value: import("@mysten/sui.js").SuiJsonValue;
-                    } | {
-                        type: "object";
-                        objectType: "immOrOwnedObject";
-                        objectId: string;
-                        version: string;
-                        digest: string;
-                    } | {
-                        type: "object";
-                        objectType: "sharedObject";
-                        objectId: string;
-                        initialSharedVersion: string;
-                        mutable: boolean;
-                    })[];
-                    kind: "ProgrammableTransaction";
-                };
-                gasData: {
-                    payment: {
-                        objectId: string;
-                        version: string | number;
-                        digest: string;
-                    }[];
-                    owner: string;
-                    price: string;
-                    budget: string;
-                };
-            };
-            txSignatures: string[];
-        } | undefined;
-        effects?: {
+    getBirthTime(objectId: string, derivePathParams?: DerivePathParams): Promise<{
+        effects: {
             messageVersion: "v1";
             status: {
                 status: "success" | "failure";
@@ -2755,8 +2660,8 @@ export declare class Obelisk {
             }[] | undefined;
             eventsDigest?: string | undefined;
             dependencies?: string[] | undefined;
-        } | undefined;
-        events?: {
+        };
+        events: {
             id: {
                 txDigest: string;
                 eventSeq: string;
@@ -2768,39 +2673,54 @@ export declare class Obelisk {
             parsedJson?: Record<string, any> | undefined;
             bcs?: string | undefined;
             timestampMs?: string | undefined;
+        }[];
+        error?: string | undefined;
+        results?: {
+            mutableReferenceOutputs?: ["GasCoin" | {
+                Input: number;
+            } | {
+                Result: number;
+            } | {
+                NestedResult: [number, number];
+            }, number[], string][] | undefined;
+            returnValues?: [number[], string][] | undefined;
         }[] | undefined;
-        checkpoint?: string | undefined;
-        confirmedLocalExecution?: boolean | undefined;
-        objectChanges?: ({
-            packageId: string;
-            type: "published";
-            version: string;
-            digest: string;
-            modules: string[];
-        } | {
-            sender: string;
-            type: "transferred";
+    }>;
+    getWorld(worldObjectId: string): Promise<import("./libs/suiRpcProvider/types").ObjectData>;
+    getAllEntities(worldId: string, cursor?: string, limit?: number): Promise<{
+        data: {
+            type: "DynamicField" | "DynamicObject";
             objectType: string;
             objectId: string;
-            version: string;
+            version: number;
             digest: string;
-            recipient: "Immutable" | {
-                AddressOwner: string;
-            } | {
-                ObjectOwner: string;
-            } | {
-                Shared: {
-                    initial_shared_version: number;
-                };
-            };
-        } | {
-            sender: string;
-            type: "mutated";
-            objectType: string;
+            name: {
+                type: string;
+                value?: any;
+            };
+            bcsName: string;
+        }[];
+        nextCursor: string | null;
+        hasNextPage: boolean;
+    }>;
+    getEntity(worldId: string, entityId: string): Promise<{
+        data?: {
             objectId: string;
             version: string;
             digest: string;
-            owner: "Immutable" | {
+            type?: string | undefined;
+            bcs?: {
+                type: string;
+                version: number;
+                hasPublicTransfer: boolean;
+                dataType: "moveObject";
+                bcsBytes: string;
+            } | {
+                id: string;
+                dataType: "package";
+                moduleMap: Record<string, string>;
+            } | undefined;
+            owner?: {
                 AddressOwner: string;
             } | {
                 ObjectOwner: string;
@@ -2808,39 +2728,73 @@ export declare class Obelisk {
                 Shared: {
                     initial_shared_version: number;
                 };
-            };
-            previousVersion: string;
-        } | {
-            sender: string;
-            type: "deleted";
-            objectType: string;
-            objectId: string;
-            version: string;
-        } | {
-            sender: string;
-            type: "wrapped";
+            } | "Immutable" | undefined;
+            storageRebate?: string | undefined;
+            previousTransaction?: string | undefined;
+            content?: {
+                type: string;
+                fields: Record<string, any>;
+                hasPublicTransfer: boolean;
+                dataType: "moveObject";
+            } | {
+                disassembled: Record<string, string>;
+                dataType: "package";
+            } | undefined;
+            display?: Record<string, string> | {
+                data: Record<string, string> | null;
+                error: {
+                    code: string;
+                    version?: number | undefined;
+                    digest?: string | undefined;
+                    error?: string | undefined;
+                    object_id?: string | undefined;
+                    parent_object_id?: string | undefined;
+                } | null;
+            } | undefined;
+        } | undefined;
+        error?: {
+            code: string;
+            version?: number | undefined;
+            digest?: string | undefined;
+            error?: string | undefined;
+            object_id?: string | undefined;
+            parent_object_id?: string | undefined;
+        } | undefined;
+    }>;
+    getEntityComponents(worldId: string, entityId: string, cursor?: string, limit?: number): Promise<{
+        data: {
+            type: "DynamicField" | "DynamicObject";
             objectType: string;
             objectId: string;
-            version: string;
-        } | {
-            sender: string;
-            type: "created";
-            objectType: string;
+            version: number;
+            digest: string;
+            name: {
+                type: string;
+                value?: any;
+            };
+            bcsName: string;
+        }[];
+        nextCursor: string | null;
+        hasNextPage: boolean;
+    }>;
+    getEntityComponent(entityId: string, componentId: string): Promise<{
+        data?: {
             objectId: string;
             version: string;
             digest: string;
-            owner: "Immutable" | {
-                AddressOwner: string;
-            } | {
-                ObjectOwner: string;
-            } | {
-                Shared: {
-                    initial_shared_version: number;
-                };
-            };
-        })[] | undefined;
-        balanceChanges?: {
-            owner: "Immutable" | {
+            type?: string | undefined;
+            bcs?: {
+                type: string;
+                version: number;
+                hasPublicTransfer: boolean;
+                dataType: "moveObject";
+                bcsBytes: string;
+            } | {
+                id: string;
+                dataType: "package";
+                moduleMap: Record<string, string>;
+            } | undefined;
+            owner?: {
                 AddressOwner: string;
             } | {
                 ObjectOwner: string;
@@ -2848,10 +2802,37 @@ export declare class Obelisk {
                 Shared: {
                     initial_shared_version: number;
                 };
-            };
-            coinType: string;
-            amount: string;
-        }[] | undefined;
-        errors?: string[] | undefined;
+            } | "Immutable" | undefined;
+            storageRebate?: string | undefined;
+            previousTransaction?: string | undefined;
+            content?: {
+                type: string;
+                fields: Record<string, any>;
+                hasPublicTransfer: boolean;
+                dataType: "moveObject";
+            } | {
+                disassembled: Record<string, string>;
+                dataType: "package";
+            } | undefined;
+            display?: Record<string, string> | {
+                data: Record<string, string> | null;
+                error: {
+                    code: string;
+                    version?: number | undefined;
+                    digest?: string | undefined;
+                    error?: string | undefined;
+                    object_id?: string | undefined;
+                    parent_object_id?: string | undefined;
+                } | null;
+            } | undefined;
+        } | undefined;
+        error?: {
+            code: string;
+            version?: number | undefined;
+            digest?: string | undefined;
+            error?: string | undefined;
+            object_id?: string | undefined;
+            parent_object_id?: string | undefined;
+        } | undefined;
     }>;
 }

package/dist/types/index.d.ts

@@ -1,11 +1,72 @@
+import { SuiMoveNormalizedModules, DevInspectResults, SuiTransactionBlockResponse, TransactionBlock } from "@mysten/sui.js";
 import type { NetworkType as SuiNetworkType } from '../libs/suiRpcProvider/types';
 export type { DerivePathParams } from '../libs/suiAccountManager/types';
+import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
 export type { SuiTxArg, SuiVecTxArg, SuiObjectArg, } from '../libs/suiTxBuilder/types';
 export type NetworkType = SuiNetworkType;
-export type SuiKitParams = {
+export type ObeliskParams = {
     mnemonics?: string;
     secretKey?: string;
     fullnodeUrl?: string;
     faucetUrl?: string;
     networkType?: NetworkType;
+    packageId?: string;
+    metadata?: SuiMoveNormalizedModules;
 };
+export type ComponentFieldType = {
+    components: {
+        type: string;
+        fields: {
+            id: {
+                id: string;
+            };
+            size: string;
+        };
+    };
+};
+export type ComponentValueType = {
+    id: {
+        id: string;
+    };
+    name: string;
+    value: {
+        type: string;
+        fields: ComponentFieldType;
+    };
+};
+export type SuiTxArgument = {
+    kind: "Input";
+    index: number;
+    type?: "object" | "pure" | undefined;
+    value?: any;
+} | {
+    kind: "GasCoin";
+} | {
+    kind: "Result";
+    index: number;
+} | {
+    kind: "NestedResult";
+    index: number;
+    resultIndex: number;
+};
+export type ComponentContentType = {
+    type: string;
+    fields: ComponentValueType;
+    hasPublicTransfer: boolean;
+    dataType: "moveObject";
+};
+export interface MessageMeta {
+    readonly meta: SuiMoveMoudleFuncType;
+}
+export interface ContractQuery extends MessageMeta {
+    (tx: TransactionBlock, params: SuiTxArgument[]): Promise<DevInspectResults>;
+}
+export interface ContractTx extends MessageMeta {
+    (tx: TransactionBlock, params: SuiTxArgument[], isRaw: boolean): SuiTransactionBlockResponse | TransactionBlock;
+}
+export type MapMessageTx = Record<string, ContractTx>;
+export type MapMessageQuery = Record<string, ContractQuery>;
+export type MapMoudleFuncTx = Record<string, MapMessageTx>;
+export type MapMoudleFuncQuery = Record<string, MapMessageQuery>;
+export type MapMoudleFuncTest = Record<string, Record<string, string>>;
+export type MapMoudleFuncQueryTest = Record<string, Record<string, string>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/client",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Tookit for interacting with move eps framework",
   "keywords": [
     "sui",
@@ -50,15 +50,18 @@
     "test:watch": "vitest",
     "format:fix": "prettier --ignore-path 'dist/* docs/*' --write '**/*.{ts,json,md}'",
     "lint:fix": "eslint . --ignore-pattern dist --ext .ts --fix",
-    "prepare": "husky install",
     "commit": "commit",
     "doc": "typedoc --out docs src/index.ts"
   },
   "dependencies": {
+    "@mysten/bcs": "^0.7.3",
     "@mysten/sui.js": "^0.37.1",
     "@scure/bip39": "^1.2.1",
     "assert": "^2.0.0",
     "colorts": "^0.1.63",
+    "fs": "^0.0.1-security",
+    "husky": "^8.0.3",
+    "process": "^0.11.10",
     "superstruct": "^1.0.3",
     "tmp": "^0.2.1",
     "ts-retry-promise": "^0.7.0"
@@ -70,19 +73,18 @@
     "@commitlint/cli": "^17.6.6",
     "@commitlint/config-conventional": "^17.6.6",
     "@commitlint/prompt-cli": "^17.6.6",
-    "@types/node": "^20.3.2",
+    "@types/node": "^20.5.0",
+    "@types/tmp": "^0.2.3",
     "@typescript-eslint/eslint-plugin": "^5.60.1",
     "@typescript-eslint/parser": "^5.60.1",
-    "@types/tmp": "^0.2.3",
     "dotenv": "^16.3.1",
     "eslint": "^8.43.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.3",
     "lint-staged": "^13.2.3",
     "prettier": "^2.8.8",
-    "tsconfig-paths": "^4.2.0",
     "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
     "tsup": "^7.1.0",
     "typedoc": "^0.24.8",
     "typescript": "^5.0.4",
@@ -97,11 +99,6 @@
       "pnpm run format:fix"
     ]
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"

package/src/framework/bcs.ts

@@ -0,0 +1,6 @@
+
+import { BCS, getSuiMoveConfig } from '@mysten/bcs'
+
+export const bcsSource = new BCS(getSuiMoveConfig())
+export const bcsOnchain = new BCS(getSuiMoveConfig())
+