@msafe/sui3-sdk 0.0.89 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@msafe/sui3-sdk",
-  "version": "0.0.89",
+  "version": "1.0.4",
   "description": "SDK for MSafe SUI V3",
   "type": "module",
   "module": "./dist/index.js",
@@ -17,7 +17,10 @@
     "src/**/*",
     "tsconfig.json"
   ],
-  "repository": "git@github.com:Momentum-Safe/msafe-sui3-sdk.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Momentum-Safe/msafe-sui3-sdk.git"
+  },
   "author": "MSafe <admin@m-safe.io>",
   "license": "MIT",
   "dependencies": {
@@ -26,12 +29,14 @@
     "buffer": "^6.0.3"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.7.0",
+    "@changesets/cli": "^2.31.0",
     "@msafe/mpay-sdk-sui": "^1.0.25",
-    "@msafe/sui-app-store": "^0.0.271",
-    "@msafe/sui3-utils": "^5.0.2",
-    "@mysten/sui.js": "^0.54.1",
-    "@mysten/wallet-standard": "^0.11.6",
-    "@types/jest": "^29.5.8",
+    "@msafe/sui-app-store": "^0.0.272",
+    "@msafe/sui3-utils": "^5.0.7",
+    "@mysten/sui": "^2.16.2",
+    "@mysten/wallet-standard": "^0.20.3",
+    "@types/jest": "^30.0.0",
     "@types/node": "^20.9.2",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@typescript-eslint/parser": "^6.5.0",
@@ -46,31 +51,41 @@
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-unused-imports": "^3.0.0",
     "exponential-backoff": "^3.1.1",
-    "jest": "^29.7.0",
+    "jest": "^30.0.0",
     "prettier": "^3.0.3",
+    "semver": "7.6.3",
     "sqlite3": "^5.1.7",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.4.0",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
     "tsup": "^8.0.1",
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "test": "jest",
-    "test:e2e": "jest test/unit/core/msafe-e2e.test.ts",
-    "test:e2e:testnet": "jest test/unit/core/msafe-e2e-testnet.test.ts --maxWorkers=1",
-    "unit": "TEST_ENV=UNIT jest",
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest --testPathIgnorePatterns=/test/unit/core/msafe-e2e\\\\.test\\\\.ts$ --testPathIgnorePatterns=/test/unit/core/msafe-e2e-testnet\\\\.test\\\\.ts$",
+    "test:e2e": "NODE_OPTIONS='--experimental-vm-modules' jest test/unit/core/msafe-e2e.test.ts",
+    "test:e2e:testnet": "NODE_OPTIONS='--experimental-vm-modules' jest test/unit/core/msafe-e2e-testnet.test.ts --maxWorkers=1",
+    "unit": "NODE_OPTIONS='--experimental-vm-modules' jest --testPathIgnorePatterns=/test/unit/core/msafe-e2e\\\\.test\\\\.ts$ --testPathIgnorePatterns=/test/unit/core/msafe-e2e-testnet\\\\.test\\\\.ts$",
     "clean": "rm -rf ./dist",
     "lint": "eslint . --ext .ts,.tsx",
-    "build": "yarn clean && tsup --platform browser --format cjs,esm --dts",
-    "build-yalc": "yarn build && yalc publish --private",
-    "prerelease": "yarn build && chmod +x ./scripts/prerelease.sh && ./scripts/prerelease.sh"
+    "typecheck": "tsc --noEmit",
+    "build": "bun run clean && tsup --platform browser --format cjs,esm --dts",
+    "build-yalc": "bun run build && yalc publish --private",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "bun run build && changeset publish"
   },
   "peerDependencies": {
     "@msafe/sui-app-store": ">0.0.100",
     "@msafe/sui3-utils": ">3.0.0",
-    "@mysten/sui.js": "^0.54.1",
-    "@mysten/wallet-standard": ">0.11.0"
+    "@mysten/sui": "^2.0.0",
+    "@mysten/wallet-standard": "^0.20.0"
+  },
+  "overrides": {
+    "semver": "7.6.3"
   },
-  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
 }

package/src/backend/BackendImpl.ts

@@ -37,7 +37,7 @@ import {
   UpdateAddressBookEntry,
   UserMSafeStatus,
 } from '@msafe/sui3-utils';
-import { PublicKey, SerializedSignature } from '@mysten/sui.js/cryptography';
+import { PublicKey } from '@mysten/sui/cryptography';
 import axios, { AxiosError, AxiosRequestConfig, AxiosRequestTransformer, AxiosResponse } from 'axios';
 
 import { IBackend } from '@/backend/interface';
@@ -104,7 +104,7 @@ export class BackendImpl implements IBackend {
       headers: this.headers(),
     });
     return res.data?.map((publicKeyWithSchema) =>
-      publicKeyWithSchema ? PublicKeySerde.de(publicKeyWithSchema) : undefined,
+      publicKeyWithSchema ? (PublicKeySerde.de(publicKeyWithSchema) as unknown as PublicKey) : undefined,
     );
   }
 
@@ -265,7 +265,7 @@ export class BackendImpl implements IBackend {
     return res.data;
   }
 
-  async updateAddressBook(input: { updates: UpdateAddressBookEntry[]; signature: SerializedSignature }) {
+  async updateAddressBook(input: { updates: UpdateAddressBookEntry[]; signature: string }) {
     await this.post(`/address-book`, input, { headers: this.headers() });
   }
 

package/src/backend/interface.ts

@@ -29,7 +29,7 @@ import {
   UpdateAddressBookEntry,
   UserMSafeStatus,
 } from '@msafe/sui3-utils';
-import { PublicKey, SerializedSignature } from '@mysten/sui.js/cryptography';
+import { PublicKey } from '@mysten/sui/cryptography';
 
 import { NotificationInfo, NotificationSubscribeDto, NotificationUpdateDto } from './types/notification';
 
@@ -65,7 +65,7 @@ export interface IBackend {
   proposeIntentionAndBuildVote(input: IProposeIntentionAndBuildAndVoteRequest): Promise<void>;
 
   getAddressBookEntries(pagination?: IPageOptions): Promise<IGetAddressBookResult>;
-  updateAddressBook(input: { updates: UpdateAddressBookEntry[]; signature: SerializedSignature }): Promise<void>;
+  updateAddressBook(input: { updates: UpdateAddressBookEntry[]; signature: string }): Promise<void>;
   getAddressBookMode(): Promise<IGetAddressBookModeResult>;
   setAddressBookMode(input: ISetAddressBookModeReq): Promise<void>;
 

package/src/core/CreateHelper.ts

@@ -6,7 +6,7 @@ import {
   PublicKeyWithSchema,
   SigningMessageHelper,
 } from '@msafe/sui3-utils';
-import { PublicKey, SerializedSignature } from '@mysten/sui.js/cryptography';
+import { PublicKey } from '@mysten/sui/cryptography';
 
 import { PublicKeyHelper } from '@/core/PublicKeyHelper';
 import { MSafeGlobals } from '@/globals/MSafeGlobals';
@@ -47,7 +47,7 @@ export class CreateHelper {
     if (!isSameAddress(address, pk.toSuiAddress())) {
       throw new Error('Public key not match');
     }
-    this.pkHelper.addPublicKey(address, pk);
+    this.pkHelper.addPublicKey(address, pk as unknown as PublicKey);
   }
 
   async submitMSafeCreation(creationInfo: CreateMSafeInfo) {
@@ -70,21 +70,21 @@ export class CreateHelper {
     return {
       threshold: info.threshold,
       ownersWithWeight: info.owners.map((owner, i) => ({
-        publicKey: publicKeys[i] as PublicKey,
+        publicKey: publicKeys[i] as unknown as PublicKey,
         weight: owner.weight,
       })),
       creationNonce: info.creationNonce,
-    };
+    } as unknown as MultiSigConfig;
   }
 
-  private async submitToBackend(createInfo: CreateMSafeInfo, signature: SerializedSignature) {
+  private async submitToBackend(createInfo: CreateMSafeInfo, signature: string) {
     const pks = await this.pkHelper.getPublicKeyBatch(createInfo.owners.map((owner) => owner.address));
     await this.globals.backend.createMSafeAccount({
       owners: createInfo.owners.map((owner, i) => ({
         address: owner.address,
         weight: owner.weight,
         status: '',
-        ...PublicKeySerde.ser(pks[i] as PublicKey),
+        ...PublicKeySerde.ser(pks[i] as never),
       })),
       threshold: createInfo.threshold,
       name: createInfo.name, // name validation is deferred to backend

package/src/core/MSafeAccount.ts

@@ -15,10 +15,8 @@ import {
   buildRejectTxb,
   isSameAddress,
 } from '@msafe/sui3-utils';
-import { SuiObjectData, SuiObjectResponse } from '@mysten/sui.js/client';
-import { SerializedSignature } from '@mysten/sui.js/cryptography';
-import { TransactionBlock } from '@mysten/sui.js/transactions';
-import { fromHEX, normalizeStructTag, toHEX } from '@mysten/sui.js/utils';
+import { Transaction } from '@mysten/sui/transactions';
+import { fromHex, normalizeStructTag, toHex } from '@mysten/sui/utils';
 import { SUI_MAINNET_CHAIN, SUI_TESTNET_CHAIN } from '@mysten/wallet-standard';
 
 import { MSafeGlobals } from '@/globals/MSafeGlobals';
@@ -27,7 +25,8 @@ import { OwnedCoin } from '@/types/assets';
 import { Pagination, PendingTx, SimulationResult } from '@/types/msafe';
 import { CoinHelper } from '@/utils';
 import { HexToUint8Array } from '@/utils/buffer';
-import { BatchObjectOptions, getAllOwnedObjects } from '@/utils/iter/object';
+import { BatchObjectOptions, getAllOwnedObjects, type OwnedObjectData } from '@/utils/iter/object';
+import { toSuiTransaction } from '@/utils/transaction';
 
 export class MSafeAccount {
   public multiSig: MultiSigAccount;
@@ -58,26 +57,30 @@ export class MSafeAccount {
   }
 
   async ownedCoins(): Promise<OwnedCoin[]> {
-    const balances = await this.suiClient.getAllBalances({ owner: this.address });
+    const balances: { coinType: string; addressBalance: string }[] = [];
+    let cursor: string | null = null;
+    let hasNext = true;
+    while (hasNext) {
+      const page = await this.suiClient.listBalances({ owner: this.address, cursor, limit: 50 });
+      balances.push(...page.balances);
+      hasNext = page.hasNextPage;
+      cursor = page.cursor;
+    }
     return Promise.all(
       balances.map(async (balance): Promise<OwnedCoin> => {
         const meta = await this.coinHelper.getCoinMeta(balance.coinType);
-        const unlockedBalance = balance.lockedBalance.number
-          ? BigInt(balance.totalBalance) - BigInt(balance.lockedBalance.number)
-          : BigInt(balance.totalBalance);
-
         return {
           type: normalizeStructTag(balance.coinType),
-          balance: BigInt(unlockedBalance),
+          balance: BigInt(balance.addressBalance),
           metadata: meta,
         };
       }),
     );
   }
 
-  async ownedObjects(options?: BatchObjectOptions): Promise<SuiObjectData[]> {
+  async ownedObjects(options?: BatchObjectOptions): Promise<OwnedObjectData[]> {
     const filterCoinObjectOptions = {
-      filter: (objRes: SuiObjectResponse) => !objRes?.data?.type?.startsWith('0x2::coin::Coin'),
+      filter: (obj: OwnedObjectData) => !obj?.type?.startsWith('0x2::coin::Coin'),
       ...options,
     };
     return getAllOwnedObjects(this.suiClient, this.address, filterCoinObjectOptions);
@@ -133,10 +136,10 @@ export class MSafeAccount {
 
   async simulateIntention(
     request: Omit<IProposeIntentionRequest, 'msafeAddress' | 'signature'> & {
-      txb?: TransactionBlock;
+      txb?: Transaction;
     },
   ) {
-    let txb: TransactionBlock;
+    let txb: Transaction;
     if (request.txb) {
       txb = request.txb;
     } else {
@@ -144,19 +147,21 @@ export class MSafeAccount {
       if (!appHelper) {
         throw new Error(`Can't find app helper for application ${request.application}`);
       }
-      txb = await appHelper.build({
-        network: this.globals.config.network,
-        intentionData: request.intention,
-        txType: request.txType,
-        txSubType: request.txSubType,
-        clientUrl: this.globals.config.suiClient.url,
-        account: {
-          address: this.address,
-          publicKey: fromHEX(this.address),
-          chains: [SUI_MAINNET_CHAIN, SUI_TESTNET_CHAIN],
-          features: [],
-        },
-      });
+      txb = toSuiTransaction(
+        await appHelper.build({
+          network: this.globals.config.network,
+          intentionData: request.intention,
+          txType: request.txType,
+          txSubType: request.txSubType,
+          clientUrl: this.globals.config.suiClient.url,
+          account: {
+            address: this.address,
+            publicKey: fromHex(this.address),
+            chains: [SUI_MAINNET_CHAIN, SUI_TESTNET_CHAIN],
+            features: [],
+          },
+        }),
+      );
     }
     txb.setSender(this.address);
     return this.simulator.simulate({ txb, sender: this.address });
@@ -181,10 +186,10 @@ export class MSafeAccount {
 
   async proposeIntentionAndBuildVote(
     input: Omit<IProposeIntentionAndBuildAndVoteRequest, 'signature' | 'msafeAddress' | 'payload' | 'digest'> & {
-      txb?: TransactionBlock;
+      txb?: Transaction;
     },
   ): Promise<void> {
-    let txb: TransactionBlock;
+    let txb: Transaction;
     if (input.txb) {
       txb = input.txb;
     } else {
@@ -192,19 +197,21 @@ export class MSafeAccount {
       if (!appHelper) {
         throw new Error(`Can't find app helper for application ${input.application}`);
       }
-      txb = await appHelper.build({
-        network: this.globals.config.network,
-        intentionData: input.intention,
-        txType: input.txType,
-        txSubType: input.txSubType,
-        clientUrl: this.globals.config.suiClient.url,
-        account: {
-          address: this.address,
-          publicKey: fromHEX(this.address),
-          chains: [SUI_MAINNET_CHAIN, SUI_TESTNET_CHAIN],
-          features: [],
-        },
-      });
+      txb = toSuiTransaction(
+        await appHelper.build({
+          network: this.globals.config.network,
+          intentionData: input.intention,
+          txType: input.txType,
+          txSubType: input.txSubType,
+          clientUrl: this.globals.config.suiClient.url,
+          account: {
+            address: this.address,
+            publicKey: fromHex(this.address),
+            chains: [SUI_MAINNET_CHAIN, SUI_TESTNET_CHAIN],
+            features: [],
+          },
+        }),
+      );
     }
     txb.setGasPrice(input.gasPrice);
     txb.setGasBudget(input.gasBudget);
@@ -216,7 +223,7 @@ export class MSafeAccount {
 
     return this.backend.proposeIntentionAndBuildVote({
       ...input,
-      payload: toHEX(payload),
+      payload: toHex(payload),
       digest,
       msafeAddress: this.address,
       signature: signature.signature,
@@ -281,9 +288,10 @@ export class MSafeAccount {
   async proposePlainPayloadIntention(intention: PlainPayloadIntention) {
     const sn = await this.nextSequenceNumber();
 
-    const tb = TransactionBlock.from(intention.payload);
+    const tb = Transaction.from(intention.payload);
 
-    if (!tb.blockData.sender || !isSameAddress(tb.blockData.sender, this.address)) {
+    const data = tb.getData();
+    if (!data.sender || !isSameAddress(data.sender, this.address)) {
       throw new Error('Transaction sender is not same as the multisig address');
     }
 
@@ -314,7 +322,7 @@ export class MSafeAccount {
       throw new Error('Already rejected');
     }
 
-    const txb = buildRejectTxb(this.address);
+    const txb = toSuiTransaction(buildRejectTxb(this.address));
     txb.setSender(this.address);
     return this.simulator.simulate({ txb, sender: this.address });
   }
@@ -325,7 +333,7 @@ export class MSafeAccount {
       throw new Error('Already rejected');
     }
 
-    const rejectTxb = buildRejectTxb(this.address);
+    const rejectTxb = toSuiTransaction(buildRejectTxb(this.address));
     const digest = await rejectTxb.getDigest({ client: this.suiClient });
     const payload = await rejectTxb.build({ client: this.suiClient });
     const signature = await this.wallet.signTransactionBlock({ transactionBlock: payload });
@@ -343,19 +351,21 @@ export class MSafeAccount {
     if (!appHelper) {
       throw new Error(`Can't find app helper for application ${intention.application}`);
     }
-    const txb = await appHelper.build({
-      network: this.globals.config.network,
-      intentionData: intention.intention,
-      txType: intention.txType as TransactionType,
-      txSubType: intention.txSubType,
-      clientUrl: this.globals.config.suiClient.url,
-      account: {
-        address: this.address,
-        publicKey: fromHEX(this.address),
-        chains: [SUI_MAINNET_CHAIN, SUI_TESTNET_CHAIN],
-        features: [],
-      },
-    });
+    const txb = toSuiTransaction(
+      await appHelper.build({
+        network: this.globals.config.network,
+        intentionData: intention.intention,
+        txType: intention.txType as TransactionType,
+        txSubType: intention.txSubType,
+        clientUrl: this.globals.config.suiClient.url,
+        account: {
+          address: this.address,
+          publicKey: fromHex(this.address),
+          chains: [SUI_MAINNET_CHAIN, SUI_TESTNET_CHAIN],
+          features: [],
+        },
+      }),
+    );
     txb.setSender(this.address);
     return this.simulator.simulate({ txb, sender: this.address });
   }
@@ -385,7 +395,7 @@ export class MSafeAccount {
       throw new Error('Not enough signature');
     }
 
-    const sortedSigs: SerializedSignature[] = [];
+    const sortedSigs: string[] = [];
     const gotSigs = new Map(votes.map((vote) => [vote.userAddress, vote.signature]));
     for (let i = 0; i < this.info.owners.length; i++) {
       const owner = this.info.owners[i];
@@ -395,10 +405,10 @@ export class MSafeAccount {
       }
     }
     const multiSignature = this.multiSig.combinePartialSignatures(sortedSigs);
-    return this.suiClient.executeTransactionBlock({
-      transactionBlock: HexToUint8Array(payload),
-      signature: multiSignature,
-      options: { showEffects: true, showEvents: true },
+    return this.suiClient.executeTransaction({
+      transaction: HexToUint8Array(payload),
+      signatures: [multiSignature],
+      include: { effects: true, events: true },
     });
   }
 

package/src/core/PublicKeyHelper.ts

@@ -1,6 +1,6 @@
 import { isSameAddress } from '@msafe/sui3-utils';
-import { PublicKey } from '@mysten/sui.js/cryptography';
-import { normalizeSuiAddress } from '@mysten/sui.js/utils';
+import { PublicKey } from '@mysten/sui/cryptography';
+import { normalizeSuiAddress } from '@mysten/sui/utils';
 
 import { MSafeGlobals } from '@/globals/MSafeGlobals';
 import { getPublicKeyFromChain } from '@/utils/sui';

package/src/globals/MSafeGlobals.ts

@@ -1,20 +1,27 @@
-import { SuiClient } from '@mysten/sui.js/client';
+import { SuiGrpcClient } from '@mysten/sui/grpc';
 
 import { BackendImpl } from '@/backend/BackendImpl';
 import { IBackend } from '@/backend/interface';
-import { getMSafeConfig, MSafeConfig, MSafeConfigOptions, MSafeEnv } from '@/globals/const';
+import {
+  getMSafeConfig,
+  httpUrlToGrpcBaseUrl,
+  MSafeConfig,
+  MSafeConfigOptions,
+  MSafeEnv,
+  msafeChainToSuiNetwork,
+} from '@/globals/const';
 import { IWallet } from '@/types/wallet';
 
 export class MSafeGlobals {
   public readonly backend: IBackend;
 
-  public readonly suiClient: SuiClient;
+  public readonly suiClient: SuiGrpcClient;
 
   public readonly config: MSafeConfig;
 
   _wallet: IWallet | undefined;
 
-  constructor(input: { backend: IBackend; suiClient: SuiClient; config: MSafeConfig }) {
+  constructor(input: { backend: IBackend; suiClient: SuiGrpcClient; config: MSafeConfig }) {
     this.backend = input.backend;
     this.suiClient = input.suiClient;
     this.config = input.config;
@@ -22,9 +29,15 @@ export class MSafeGlobals {
 
   static async New(env: MSafeEnv, options?: MSafeConfigOptions) {
     const config = getMSafeConfig(env, options);
-    const suiClient = new SuiClient(
-      config.suiClient.transport ? { transport: config.suiClient.transport } : { url: config.suiClient.url },
-    );
+    const suiClient = config.suiClient.transport
+      ? new SuiGrpcClient({
+          transport: config.suiClient.transport,
+          network: msafeChainToSuiNetwork(config.network),
+        })
+      : new SuiGrpcClient({
+          baseUrl: httpUrlToGrpcBaseUrl(config.suiClient.url),
+          network: msafeChainToSuiNetwork(config.network),
+        });
     const backend = new BackendImpl(config.backend.url, options?.mockAddress);
     return new MSafeGlobals({
       backend,

package/src/globals/const.ts

@@ -1,4 +1,8 @@
-import type { SuiClientOptions } from '@mysten/sui.js/client';
+import type { RpcTransport } from '@mysten/sui/grpc';
+
+export function msafeChainToSuiNetwork(chain: 'sui:mainnet' | 'sui:testnet'): 'mainnet' | 'testnet' {
+  return chain === 'sui:mainnet' ? 'mainnet' : 'testnet';
+}
 
 export enum MSafeEnv {
   local = 'local',
@@ -8,10 +12,22 @@ export enum MSafeEnv {
   prod = 'prod',
 }
 
+/** Normalize HTTP(S) fullnode URL for SuiGrpcClient (gRPC-web) baseUrl. */
+export function httpUrlToGrpcBaseUrl(url: string): string {
+  const parsed = new URL(url);
+  if (parsed.protocol === 'https:' && parsed.port === '') {
+    return `https://${parsed.hostname}:443${parsed.pathname}${parsed.search}`;
+  }
+  if (parsed.protocol === 'http:' && parsed.port === '') {
+    return `http://${parsed.hostname}:80${parsed.pathname}${parsed.search}`;
+  }
+  return `${parsed.origin}${parsed.pathname}${parsed.search}`;
+}
+
 export interface MSafeConfig {
   suiClient: {
     url: string;
-    transport?: SuiClientOptions['transport'];
+    transport?: RpcTransport;
   };
   backend: {
     url: string;
@@ -23,7 +39,7 @@ export interface MSafeConfig {
 export interface MSafeConfigOptions {
   suiClient?: {
     url: string;
-    transport?: SuiClientOptions['transport'];
+    transport?: RpcTransport;
   };
   backend?: {
     url?: string;
@@ -52,9 +68,9 @@ export const ENV_CONFIGS = new Map<MSafeEnv, MSafeConfig>([
         url: TESTNET_RPC_URL,
       },
       backend: {
-        url: LOCAL_API_URL,
+        url: DEV_API_URL,
       },
-      syncingURL: LOCAL_SYNCING_URL,
+      syncingURL: DEV_SYNCING_URL,
       network: 'sui:testnet',
     },
   ],