@0xobelisk/client 0.4.3 → 0.4.6

package/dist/types/index.d.ts

@@ -0,0 +1,141 @@
+import { Infer } from 'superstruct';
+import { DisplayFieldsResponse, ObjectCallArg, ObjectContentFields, SharedObjectRef, SuiObjectRef, TransactionArgument, TransactionBlock, SuiTransactionBlockResponse, DevInspectResults, SuiMoveNormalizedModules } from '@mysten/sui.js';
+import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
+export type ObeliskObjectData = {
+    objectId: string;
+    objectType: string;
+    objectVersion: number;
+    objectDisplay: DisplayFieldsResponse;
+    objectFields: ObjectContentFields;
+};
+export type ObeliskParams = {
+    mnemonics?: string;
+    secretKey?: string;
+    fullnodeUrls?: string[];
+    faucetUrl?: string;
+    networkType?: NetworkType;
+    packageId?: string;
+    metadata?: SuiMoveNormalizedModules;
+};
+export type SchemaFieldType = {
+    schemas: {
+        type: string;
+        fields: {
+            id: {
+                id: string;
+            };
+            size: string;
+        };
+    };
+};
+export type SchemaValueType = {
+    id: {
+        id: string;
+    };
+    name: string;
+    value: {
+        type: string;
+        fields: SchemaFieldType;
+    };
+};
+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 SchemaContentType = {
+    type: string;
+    fields: SchemaValueType;
+    hasPublicTransfer: boolean;
+    dataType: 'moveObject';
+};
+export interface MessageMeta {
+    readonly meta: SuiMoveMoudleFuncType;
+}
+export interface ContractQuery extends MessageMeta {
+    (tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean): Promise<DevInspectResults | TransactionBlock>;
+}
+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>>;
+export type AccountMangerParams = {
+    mnemonics?: string;
+    secretKey?: string;
+};
+export type DerivePathParams = {
+    accountIndex?: number;
+    isExternal?: boolean;
+    addressIndex?: number;
+};
+export type NetworkType = 'testnet' | 'mainnet' | 'devnet' | 'localnet';
+export type FaucetNetworkType = 'testnet' | 'devnet' | 'localnet';
+export type SuiKitParams = {
+    mnemonics?: string;
+    secretKey?: string;
+    fullnodeUrls?: string[];
+    faucetUrl?: string;
+    networkType?: NetworkType;
+};
+export type ObjectData = {
+    objectId: string;
+    objectType: string;
+    objectVersion: number;
+    objectDigest: string;
+    initialSharedVersion?: number;
+    objectDisplay: DisplayFieldsResponse;
+    objectFields: ObjectContentFields;
+};
+export type ObjectFieldType = {
+    id: {
+        id: string;
+    };
+    name: string;
+    value: string;
+};
+export type EntityData = {
+    objectId: string;
+    index: string;
+    key: string;
+};
+export type SuiTxArg = Infer<typeof TransactionArgument> | Infer<typeof ObjectCallArg> | string | number | bigint | boolean;
+export type SuiObjectArg = SharedObjectRef | Infer<typeof SuiObjectRef> | string | Infer<typeof ObjectCallArg> | Infer<typeof TransactionArgument>;
+export type SuiVecTxArg = {
+    value: SuiTxArg[];
+    vecType: SuiInputTypes;
+} | SuiTxArg[];
+/**
+ * These are the basics types that can be used in the SUI
+ */
+export type SuiBasicTypes = 'address' | 'bool' | 'u8' | 'u16' | 'u32' | 'u64' | 'u128' | 'u256';
+export type SuiInputTypes = 'object' | SuiBasicTypes;
+export type SuiReturnValues = {
+    returnValues: [number[], string][];
+}[];
+export type DynamicFieldContentType = {
+    type: string;
+    fields: Record<string, any>;
+    hasPublicTransfer: boolean;
+    dataType: string;
+};
+export type ObjectContent = {
+    type: string;
+    fields: Record<string, any>;
+    hasPublicTransfer: boolean;
+    dataType: string;
+};

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export declare function capitalizeFirstLetter(input: string): string;
+export declare function normalizeHexAddress(input: string): string | null;
+export declare function numberToAddressHex(num: number): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/client",
-  "version": "0.4.3",
+  "version": "0.4.6",
   "description": "Tookit for interacting with move eps framework",
   "keywords": [
     "sui",

package/src/libs/suiAccountManager/index.ts

@@ -2,7 +2,7 @@ import { Ed25519Keypair } from '@mysten/sui.js';
 import { getKeyPair } from './keypair';
 import { hexOrBase64ToUint8Array, normalizePrivateKey } from './util';
 import { generateMnemonic } from './crypto';
-import type { AccountMangerParams, DerivePathParams } from 'src/types';
+import type { AccountMangerParams, DerivePathParams } from '../../types';
 
 export class SuiAccountManager {
   private mnemonics: string;

package/src/libs/suiInteractor/defaultConfig.ts

@@ -5,7 +5,7 @@ import {
   mainnetConnection,
 } from '@mysten/sui.js';
 import type { Connection } from '@mysten/sui.js';
-import type { NetworkType } from 'src/types';
+import type { NetworkType } from '../../types';
 export const defaultGasBudget = 10 ** 8; // 0.1 SUI, should be enough for most of the transactions
 export const defaultGasPrice = 1000; // 1000 MIST
 

package/src/libs/suiInteractor/suiInteractor.ts

@@ -24,7 +24,7 @@ import {
   ObjectData,
   ObjectFieldType,
   EntityData,
-} from 'src/types';
+} from '../../types';
 import { SuiOwnedObject, SuiSharedObject } from '../suiModel';
 import { delay } from './util';
 

package/src/libs/suiTxBuilder/index.ts

@@ -10,7 +10,7 @@ import {
   ObjectCallArg,
 } from '@mysten/sui.js';
 import { convertArgs } from './util';
-import type { SuiTxArg, SuiObjectArg, SuiVecTxArg } from 'src/types';
+import type { SuiTxArg, SuiObjectArg, SuiVecTxArg } from '../../types';
 
 export class SuiTxBlock {
   public txBlock: TransactionBlock;

package/src/libs/suiTxBuilder/util.ts

@@ -3,7 +3,7 @@ import {
   TransactionArgument,
   TransactionBlock,
 } from '@mysten/sui.js';
-import { SuiTxArg, SuiInputTypes } from 'src/types';
+import { SuiTxArg, SuiInputTypes } from '../../types';
 
 export const getDefaultSuiInputType = (value: any): SuiInputTypes => {
   if (typeof value === 'string' && value.startsWith('0x')) {

package/src/metadata/index.ts

@@ -1,7 +1,7 @@
 import { SuiMoveNormalizedModules } from '@mysten/sui.js';
 import { SuiInteractor, getDefaultConnection } from '../libs/suiInteractor';
 
-import { NetworkType } from 'src/types';
+import { NetworkType } from '../types';
 
 export async function loadMetadata(
   networkType: NetworkType,

package/src/obelisk.ts

@@ -10,7 +10,7 @@ import { SuiAccountManager } from './libs/suiAccountManager';
 import { SuiTxBlock } from './libs/suiTxBuilder';
 import { getDefaultConnection, SuiInteractor } from './libs/suiInteractor';
 
-import { ObeliskObjectData } from 'src/types';
+import { ObeliskObjectData } from './types';
 import { SuiContractFactory } from './libs/suiContractFactory';
 import {
   SuiMoveMoudleFuncType,
@@ -475,7 +475,8 @@ export class Obelisk {
       for (const res of resultList) {
         const bcs = new BCS(getSuiMoveConfig());
         const value = Uint8Array.from(res[0]);
-        const data = bcs.de(res[1], value);
+        const bcsType = res[1].replace(/0x1::ascii::String/g, 'string');
+        const data = bcs.de(bcsType, value);
         returnValue.push(data);
       }
       return returnValue;

package/src/types/index.ts

@@ -12,10 +12,7 @@ import {
   SuiMoveNormalizedModules,
 } from '@mysten/sui.js';
 
-import {
-  SuiMoveMoudleValueType,
-  SuiMoveMoudleFuncType,
-} from '../libs/suiContractFactory/types';
+import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
 
 export type ObeliskObjectData = {
   objectId: string;