@0xobelisk/sui-client 0.5.2 → 0.5.4

package/src/obelisk.ts

@@ -1,16 +1,23 @@
+// import { RawSigner, SuiAddress } from '@mysten/sui.js';
+
+import { getFullnodeUrl, SuiParsedData } from '@mysten/sui.js/client';
 import {
+  TransactionBlock,
+  TransactionResult,
+} from '@mysten/sui.js/transactions';
+
+import type {
+  SuiTransactionBlockResponse,
   DevInspectResults,
-  RawSigner,
-  SuiAddress,
   SuiMoveNormalizedModules,
-  SuiTransactionBlockResponse,
-  TransactionBlock,
-} from '@mysten/sui.js';
+  SuiObjectData,
+} from '@mysten/sui.js/client';
+
 import { SuiAccountManager } from './libs/suiAccountManager';
 import { SuiTxBlock } from './libs/suiTxBuilder';
-import { getDefaultConnection, SuiInteractor } from './libs/suiInteractor';
+import { SuiInteractor } from './libs/suiInteractor';
 
-import { ObeliskObjectData } from './types';
+import { ObeliskObjectContent } from './types';
 import { SuiContractFactory } from './libs/suiContractFactory';
 import {
   SuiMoveMoudleFuncType,
@@ -27,7 +34,6 @@ import {
   SuiTxArg,
   SuiTxArgument,
   SuiVecTxArg,
-  TransactionResult,
 } from './types';
 import { normalizeHexAddress, numberToAddressHex } from './utils';
 import keccak256 from 'keccak256';
@@ -128,7 +134,7 @@ export class Obelisk {
     // Init the account manager
     this.accountManager = new SuiAccountManager({ mnemonics, secretKey });
     // Init the rpc provider
-    fullnodeUrls = fullnodeUrls || [getDefaultConnection(networkType).fullnode];
+    fullnodeUrls = fullnodeUrls || [getFullnodeUrl(networkType ?? 'mainnet')];
     this.suiInteractor = new SuiInteractor(fullnodeUrls, networkType);
 
     this.packageId = packageId;
@@ -225,15 +231,15 @@ export class Obelisk {
     });
     return await this.inspectTxn(tx);
   };
+
   /**
-   * if derivePathParams is not provided or mnemonics is empty, it will return the currentSigner.
+   * if derivePathParams is not provided or mnemonics is empty, it will return the keypair.
    * else:
    * it will generate signer from the mnemonic with the given derivePathParams.
    * @param derivePathParams, such as { accountIndex: 2, isExternal: false, addressIndex: 10 }, comply with the BIP44 standard
    */
-  getSigner(derivePathParams?: DerivePathParams) {
-    const keyPair = this.accountManager.getKeyPair(derivePathParams);
-    return new RawSigner(keyPair, this.suiInteractor.currentProvider);
+  getKeypair(derivePathParams?: DerivePathParams) {
+    return this.accountManager.getKeyPair(derivePathParams);
   }
 
   /**
@@ -251,14 +257,11 @@ export class Obelisk {
   getAddress(derivePathParams?: DerivePathParams) {
     return this.accountManager.getAddress(derivePathParams);
   }
+
   currentAddress() {
     return this.accountManager.currentAddress;
   }
 
-  provider() {
-    return this.suiInteractor.currentProvider;
-  }
-
   getPackageId() {
     return this.contractFactory.packageId;
   }
@@ -270,14 +273,18 @@ export class Obelisk {
    * Request some SUI from faucet
    * @Returns {Promise<boolean>}, true if the request is successful, false otherwise.
    */
-  async requestFaucet(address: SuiAddress, network: FaucetNetworkType) {
+  async requestFaucet(address: string, network: FaucetNetworkType) {
     // const addr = this.accountManager.getAddress(derivePathParams);
     return this.suiInteractor.requestFaucet(address, network);
   }
 
   async getBalance(coinType?: string, derivePathParams?: DerivePathParams) {
     const owner = this.accountManager.getAddress(derivePathParams);
-    return this.suiInteractor.currentProvider.getBalance({ owner, coinType });
+    return this.suiInteractor.currentClient.getBalance({ owner, coinType });
+  }
+
+  client() {
+    return this.suiInteractor.currentClient;
   }
 
   async getObject(objectId: string) {
@@ -292,20 +299,24 @@ export class Obelisk {
     tx: Uint8Array | TransactionBlock | SuiTxBlock,
     derivePathParams?: DerivePathParams
   ) {
-    tx = tx instanceof SuiTxBlock ? tx.txBlock : tx;
-    const signer = this.getSigner(derivePathParams);
-    return signer.signTransactionBlock({ transactionBlock: tx });
+    if (tx instanceof SuiTxBlock) {
+      tx.setSender(this.getAddress(derivePathParams));
+    }
+    const txBlock = tx instanceof SuiTxBlock ? tx.txBlock : tx;
+    const txBytes =
+      txBlock instanceof TransactionBlock
+        ? await txBlock.build({ client: this.client() })
+        : txBlock;
+    const keyPair = this.getKeypair(derivePathParams);
+    return await keyPair.signTransactionBlock(txBytes);
   }
 
   async signAndSendTxn(
     tx: Uint8Array | TransactionBlock | SuiTxBlock,
     derivePathParams?: DerivePathParams
   ): Promise<SuiTransactionBlockResponse> {
-    const { transactionBlockBytes, signature } = await this.signTxn(
-      tx,
-      derivePathParams
-    );
-    return this.suiInteractor.sendTx(transactionBlockBytes, signature);
+    const { bytes, signature } = await this.signTxn(tx, derivePathParams);
+    return this.suiInteractor.sendTx(bytes, signature);
   }
 
   /**
@@ -454,9 +465,9 @@ export class Obelisk {
     tx: Uint8Array | TransactionBlock | SuiTxBlock,
     derivePathParams?: DerivePathParams
   ): Promise<DevInspectResults> {
-    tx = tx instanceof SuiTxBlock ? tx.txBlock : tx;
-    return this.suiInteractor.currentProvider.devInspectTransactionBlock({
-      transactionBlock: tx,
+    const txBlock = tx instanceof SuiTxBlock ? tx.txBlock : tx;
+    return this.suiInteractor.currentClient.devInspectTransactionBlock({
+      transactionBlock: txBlock,
       sender: this.getAddress(derivePathParams),
     });
   }
@@ -467,8 +478,14 @@ export class Obelisk {
 
   async listSchemaNames(worldId: string) {
     const worldObject = await this.getObject(worldId);
-    const newObjectContent = worldObject.objectFields;
-    return newObjectContent['schemaNames'];
+    const newObjectContent = worldObject.content;
+    if (newObjectContent != null) {
+      const objectContent = newObjectContent as ObeliskObjectContent;
+      const objectFields = objectContent.fields as Record<string, any>;
+      return objectFields['schema_names'];
+    } else {
+      return [];
+    }
   }
 
   async getEntity(
@@ -567,20 +584,18 @@ export class Obelisk {
   //   };
   // }
 
-  async getOwnedObjects(owner: SuiAddress, cursor?: string, limit?: number) {
+  async getOwnedObjects(owner: string, cursor?: string, limit?: number) {
     const ownedObjects = await this.suiInteractor.getOwnedObjects(
       owner,
       cursor,
       limit
     );
-    const ownedObjectsRes: ObeliskObjectData[] = [];
+    const ownedObjectsRes: SuiObjectData[] = [];
 
     for (const object of ownedObjects.data) {
       const objectDetail = await this.getObject(object.data!.objectId);
-
       if (
-        objectDetail.objectType.split('::')[0] ===
-        this.contractFactory.packageId
+        objectDetail.type!.split('::')[0] === this.contractFactory.packageId
       ) {
         ownedObjectsRes.push(objectDetail);
       }

package/src/types/index.ts

@@ -1,18 +1,21 @@
-import { Infer } from 'superstruct';
-import {
-  DisplayFieldsResponse,
-  ObjectCallArg,
-  ObjectContentFields,
-  SharedObjectRef,
-  SuiObjectRef,
-  TransactionArgument,
+import { ObjectContentFields } from '@mysten/sui.js/src/types';
+import type {
   TransactionBlock,
-  SuiTransactionBlockResponse,
-  DevInspectResults,
+  TransactionObjectArgument,
+  TransactionArgument,
+  TransactionResult,
+} from '@mysten/sui.js/transactions';
+import type {
+  SuiObjectRef,
   SuiMoveNormalizedModules,
-} from '@mysten/sui.js';
-
-export type TransactionResult = TransactionArgument & TransactionArgument[];
+  DevInspectResults,
+  SuiTransactionBlockResponse,
+  DisplayFieldsResponse,
+  MoveStruct,
+} from '@mysten/sui.js/client';
+import type { SharedObjectRef, ObjectArg } from '@mysten/sui.js/bcs';
+import type { SerializedBcs } from '@mysten/bcs';
+// export type TransactionResult = TransactionArgument & TransactionArgument[];
 
 import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
 
@@ -24,6 +27,13 @@ export type ObeliskObjectData = {
   objectFields: ObjectContentFields;
 };
 
+export type ObeliskObjectContent = {
+  dataType: 'moveObject';
+  fields: MoveStruct;
+  hasPublicTransfer: boolean;
+  type: string;
+};
+
 export type ObeliskParams = {
   mnemonics?: string;
   secretKey?: string;
@@ -102,7 +112,7 @@ export interface ContractTx extends MessageMeta {
     params: SuiTxArgument[],
     typeArguments?: string[],
     isRaw?: boolean
-  ): SuiTransactionBlockResponse | TransactionResult;
+  ): Promise<SuiTransactionBlockResponse | TransactionResult>;
 }
 
 export type MapMessageTx = Record<string, ContractTx>;
@@ -145,6 +155,24 @@ export type ObjectData = {
   objectDisplay: DisplayFieldsResponse;
   objectFields: ObjectContentFields;
 };
+type TransactionBlockType = InstanceType<typeof TransactionBlock>;
+
+export type PureCallArg = {
+  Pure: number[];
+};
+export type ObjectCallArg = {
+  Object: ObjectArg;
+};
+
+export type TransactionType = Parameters<TransactionBlockType['add']>;
+
+export type TransactionPureArgument = Extract<
+  TransactionArgument,
+  {
+    kind: 'Input';
+    type: 'pure';
+  }
+>;
 
 export type ObjectFieldType = {
   id: {
@@ -160,20 +188,20 @@ export type EntityData = {
   key: string;
 };
 
-export type SuiTxArg =
-  | Infer<typeof TransactionArgument>
-  | Infer<typeof ObjectCallArg>
+export type SuiAddressArg =
+  | TransactionArgument
+  | SerializedBcs<any>
   | string
-  | number
-  | bigint
-  | boolean;
+  | PureCallArg;
+
+export type SuiTxArg = SuiAddressArg | number | bigint | boolean;
 
 export type SuiObjectArg =
-  | SharedObjectRef
-  | Infer<typeof SuiObjectRef>
+  | TransactionObjectArgument
   | string
-  | Infer<typeof ObjectCallArg>
-  | Infer<typeof TransactionArgument>;
+  | SharedObjectRef
+  | SuiObjectRef
+  | ObjectCallArg;
 
 export type SuiVecTxArg =
   | { value: SuiTxArg[]; vecType: SuiInputTypes }
@@ -190,7 +218,8 @@ export type SuiBasicTypes =
   | 'u32'
   | 'u64'
   | 'u128'
-  | 'u256';
+  | 'u256'
+  | 'signer';
 
 export type SuiInputTypes = 'object' | SuiBasicTypes;
 

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

@@ -1,10 +0,0 @@
-import type { Connection } from '@mysten/sui.js';
-import type { NetworkType } from '../../types';
-export declare const defaultGasBudget: number;
-export declare const defaultGasPrice = 1000;
-/**
- * @description Get the default fullnode url and faucet url for the given network type
- * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
- * @returns { fullNode: string, websocket: string, faucet?: string }
- */
-export declare const getDefaultConnection: (networkType?: NetworkType) => Connection;

package/src/libs/suiInteractor/defaultConfig.ts

@@ -1,32 +0,0 @@
-import {
-  localnetConnection,
-  devnetConnection,
-  testnetConnection,
-  mainnetConnection,
-} from '@mysten/sui.js';
-import type { Connection } from '@mysten/sui.js';
-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
-
-/**
- * @description Get the default fullnode url and faucet url for the given network type
- * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
- * @returns { fullNode: string, websocket: string, faucet?: string }
- */
-export const getDefaultConnection = (
-  networkType: NetworkType = 'devnet'
-): Connection => {
-  switch (networkType) {
-    case 'localnet':
-      return localnetConnection;
-    case 'devnet':
-      return devnetConnection;
-    case 'testnet':
-      return testnetConnection;
-    case 'mainnet':
-      return mainnetConnection;
-    default:
-      return devnetConnection;
-  }
-};