@msafe/sui3-sdk 1.0.7 → 1.0.8

package/dist/index.d.cts

@@ -2,8 +2,9 @@ import * as _msafe_sui3_utils from '@msafe/sui3-utils';
 import { IAuthLoginReq, JWTToken, IMSafeConfig, IUserInfoResp, UserMSafeStatus, IPageOptions, IPagedResult, IGetPendingTransactionRequest, GetPendingTransactionResponse, IGetHistoryTransactionsRequest, GetHistoryTransactionsResponse, IGetIntentionsRequest, GetTransactionIntentionsResponse, IMSafeAddressRequest, TransactionIntentionItem, ICreateMSafeReq, IProposeIntentionRequest, IRejectTransactionRequest, IVoteTransactionRequest, IBuildTransactionRequest, ISkipIntentionRequest, IProposeIntentionAndBuildAndVoteRequest, IGetAddressBookResult, UpdateAddressBookEntry, IGetAddressBookModeResult, ISetAddressBookModeReq, Report, IGetDashboardReq, IGetDashboardResp, TransactionType, TxIntention, IGasOption, PublicKeyWithSchema, AddressBookMode, MultiSigAccount, CoinTransferIntention, ObjectTransferIntention, PlainPayloadIntention } from '@msafe/sui3-utils';
 import * as _mysten_sui_cryptography from '@mysten/sui/cryptography';
 import { PublicKey, SignatureWithBytes } from '@mysten/sui/cryptography';
-import * as _mysten_sui_jsonRpc from '@mysten/sui/jsonRpc';
-import { JsonRpcTransport, ExecuteTransactionRequestType, SuiTransactionBlockResponseOptions, SuiTransactionBlockResponse, SuiJsonRpcClient, GasCostSummary, SuiObjectRef, DryRunTransactionBlockResponse, CoinMetadata, SuiObjectDataOptions, SuiObjectResponse, SuiObjectData, CoinStruct } from '@mysten/sui/jsonRpc';
+import { RpcTransport, SuiGrpcClient } from '@mysten/sui/grpc';
+import * as _mysten_sui_client from '@mysten/sui/client';
+import { SuiClientTypes } from '@mysten/sui/client';
 import { Transaction } from '@mysten/sui/transactions';
 import { Buffer } from 'buffer';
 
@@ -97,10 +98,12 @@ declare enum MSafeEnv {
     prev = "prev",
     prod = "prod"
 }
+/** Normalize HTTP(S) fullnode URL for SuiGrpcClient (gRPC-web) baseUrl. */
+declare function httpUrlToGrpcBaseUrl(url: string): string;
 interface MSafeConfig {
     suiClient: {
         url: string;
-        transport?: JsonRpcTransport;
+        transport?: RpcTransport;
     };
     backend: {
         url: string;
@@ -111,7 +114,7 @@ interface MSafeConfig {
 interface MSafeConfigOptions {
     suiClient?: {
         url: string;
-        transport?: JsonRpcTransport;
+        transport?: RpcTransport;
     };
     backend?: {
         url?: string;
@@ -140,19 +143,18 @@ interface IWallet {
     }): Promise<SignatureWithBytes>;
     signAndExecuteTransactionBlock(input: {
         transactionBlock: Transaction | Uint8Array;
-        requestType?: ExecuteTransactionRequestType;
-        options?: SuiTransactionBlockResponseOptions;
-    }): Promise<SuiTransactionBlockResponse>;
+        include?: SuiClientTypes.TransactionInclude;
+    }): Promise<SuiClientTypes.TransactionResult>;
 }
 
 declare class MSafeGlobals {
     readonly backend: IBackend;
-    readonly suiClient: SuiJsonRpcClient;
+    readonly suiClient: SuiGrpcClient;
     readonly config: MSafeConfig;
     _wallet: IWallet | undefined;
     constructor(input: {
         backend: IBackend;
-        suiClient: SuiJsonRpcClient;
+        suiClient: SuiGrpcClient;
         config: MSafeConfig;
     });
     static New(env: MSafeEnv, options?: MSafeConfigOptions): Promise<MSafeGlobals>;
@@ -177,6 +179,15 @@ declare class PublicKeyHelper {
     private getPublicKeyFromChain;
 }
 
+/** Gas coin reference derived from simulation / execution effects. */
+interface GasObjectReference {
+    objectId: string;
+    version: string;
+    digest: string;
+}
+type SimulateDryRunResponse = SuiClientTypes.SimulateTransactionResult<{
+    effects: true;
+}>;
 interface PendingTx {
     application: string;
     txType: TransactionType;
@@ -250,15 +261,15 @@ type SimulationResult = SimulationSuccessResult | SimulationFailedResult;
 interface SimulationSuccessResult {
     success: true;
     gasPrice: bigint;
-    gasUsed: GasCostSummary;
+    gasUsed: SuiClientTypes.GasCostSummary;
     gasBudget: bigint;
-    gasObject: SuiObjectRef;
-    response: DryRunTransactionBlockResponse;
+    gasObject: GasObjectReference;
+    response: SimulateDryRunResponse;
 }
 interface SimulationFailedResult {
     success: false;
     gasPrice: bigint;
-    response: DryRunTransactionBlockResponse;
+    response?: SimulateDryRunResponse;
     simulationError: string;
 }
 interface SimulationOption extends IGasOption {
@@ -329,17 +340,23 @@ declare class Simulator {
     private copyTransaction;
 }
 
+type CoinMetadata = SuiClientTypes.CoinMetadata;
 interface OwnedCoin {
     type: string;
     balance: bigint;
     metadata?: CoinMetadata;
 }
 
-type ObjectFilter = (objRes: SuiObjectResponse) => boolean;
+/** Owned object row with Move JSON content (for helpers like Coin.getBalance). */
+type OwnedObjectData = SuiClientTypes.Object<{
+    json: true;
+}>;
+type ObjectFilter = (obj: OwnedObjectData) => boolean;
 interface BatchObjectOptions {
     filter?: ObjectFilter;
     pageSize?: number;
-    objectOptions?: SuiObjectDataOptions;
+    /** Extra fields to request from the node; defaults include Move JSON for struct fields. */
+    objectInclude?: SuiClientTypes.ObjectInclude;
 }
 
 declare class MSafeAccount {
@@ -351,7 +368,7 @@ declare class MSafeAccount {
     constructor(globals: MSafeGlobals, info: IMSafeConfig);
     static New(globals: MSafeGlobals, address: string): Promise<void>;
     ownedCoins(): Promise<OwnedCoin[]>;
-    ownedObjects(options?: BatchObjectOptions): Promise<SuiObjectData[]>;
+    ownedObjects(options?: BatchObjectOptions): Promise<OwnedObjectData[]>;
     pendingTransaction(): Promise<PendingTx | undefined>;
     historyTransaction(pagination?: Pagination): Promise<_msafe_sui3_utils.GetHistoryTransactionsResponse>;
     futureIntentions(pagination?: Pagination): Promise<_msafe_sui3_utils.GetTransactionIntentionsResponse>;
@@ -381,7 +398,10 @@ declare class MSafeAccount {
     }): Promise<void>;
     skipNextFailedIntention(): Promise<void>;
     fetchTransaction(): Promise<string[]>;
-    executePendingTx(pending: PendingTx, isRejectTx?: boolean): Promise<_mysten_sui_jsonRpc.SuiTransactionBlockResponse>;
+    executePendingTx(pending: PendingTx, isRejectTx?: boolean): Promise<_mysten_sui_client.SuiClientTypes.TransactionResult<{
+        effects: true;
+        events: true;
+    }>>;
     dashboard(): Promise<_msafe_sui3_utils.IGetDashboardResp>;
     private calculateWeightFromVotes;
     private calculateWeight;
@@ -467,17 +487,17 @@ declare class Formatter {
 declare function addPrefix(s: string, prefix: string): string;
 
 declare const SUI_COIN = "0x2::sui::SUI";
-declare function getPublicKeyFromChain(suiClient: SuiJsonRpcClient, address: string): Promise<PublicKey | undefined>;
+declare function getPublicKeyFromChain(suiClient: SuiGrpcClient, address: string): Promise<PublicKey | undefined>;
 declare function getAllCoins(input: {
-    suiClient: SuiJsonRpcClient;
+    suiClient: SuiGrpcClient;
     owner: string;
     coinType: string | undefined;
-}): Promise<CoinStruct[]>;
+}): Promise<SuiClientTypes.Coin[]>;
 
 declare class CoinHelper {
     private _client;
     private _coinMetaReg;
-    constructor(client: SuiJsonRpcClient);
+    constructor(client: SuiGrpcClient);
     getCoinMeta(coinType: string): Promise<CoinMetadata | undefined>;
     private queryCoinMeta;
 }
@@ -485,12 +505,21 @@ declare const COIN_TYPE_ARG_REGEX: RegExp;
 declare class Coin {
     static isCoin(type: string | undefined | null): boolean;
     static getCoinType(type: string): string | null;
-    static getBalance(data: SuiObjectData): bigint | undefined;
+    static getBalance(data: {
+        type?: string | null;
+        json?: Record<string, unknown> | null;
+        content?: {
+            dataType?: string;
+            fields?: {
+                balance?: string;
+            };
+        };
+    }): bigint | undefined;
 }
 
 /**
- * Normalize a transaction from legacy helpers (sui.js TransactionBlock) or v2 Transaction.
+ * Normalize a transaction value to {@link Transaction} (handles plain Transaction or serialized legacy shapes).
  */
 declare function toSuiTransaction(txb: Transaction | unknown): Transaction;
 
-export { AddressBookSDK, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeInfo, DEV_API_URL, DEV_SYNCING_URL, ENV_CONFIGS, Formatter, type FutureIntention, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, InfoTypeEnabledDto, InfoTypeKey, LOCAL_API_URL, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnabledDto, MSafeEnv, MSafeGlobals, type NotificationData, type NotificationInfo, NotificationSubscribeDto, NotificationUpdateDto, PREV_API_URL, PROD_API_URL, type Pagination, type PendingTx, type PendingVote, type ProposeIntention, type ReceiveTransaction, SUI_COIN, SignatureVerifier, type SimulationFailedResult, type SimulationOption, type SimulationResult, type SimulationSuccessResult, TESTNET_RPC_URL, Uint8ArrayToHex, addPrefix, getAllCoins, getMSafeConfig, getPublicKeyFromChain, msafeChainToSuiNetwork, stringToBuffer, toSuiTransaction };
+export { AddressBookSDK, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeInfo, DEV_API_URL, DEV_SYNCING_URL, ENV_CONFIGS, Formatter, type FutureIntention, type GasObjectReference, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, InfoTypeEnabledDto, InfoTypeKey, LOCAL_API_URL, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnabledDto, MSafeEnv, MSafeGlobals, type NotificationData, type NotificationInfo, NotificationSubscribeDto, NotificationUpdateDto, PREV_API_URL, PROD_API_URL, type Pagination, type PendingTx, type PendingVote, type ProposeIntention, type ReceiveTransaction, SUI_COIN, SignatureVerifier, type SimulateDryRunResponse, type SimulationFailedResult, type SimulationOption, type SimulationResult, type SimulationSuccessResult, TESTNET_RPC_URL, Uint8ArrayToHex, addPrefix, getAllCoins, getMSafeConfig, getPublicKeyFromChain, httpUrlToGrpcBaseUrl, msafeChainToSuiNetwork, stringToBuffer, toSuiTransaction };

package/dist/index.d.ts

@@ -2,8 +2,9 @@ import * as _msafe_sui3_utils from '@msafe/sui3-utils';
 import { IAuthLoginReq, JWTToken, IMSafeConfig, IUserInfoResp, UserMSafeStatus, IPageOptions, IPagedResult, IGetPendingTransactionRequest, GetPendingTransactionResponse, IGetHistoryTransactionsRequest, GetHistoryTransactionsResponse, IGetIntentionsRequest, GetTransactionIntentionsResponse, IMSafeAddressRequest, TransactionIntentionItem, ICreateMSafeReq, IProposeIntentionRequest, IRejectTransactionRequest, IVoteTransactionRequest, IBuildTransactionRequest, ISkipIntentionRequest, IProposeIntentionAndBuildAndVoteRequest, IGetAddressBookResult, UpdateAddressBookEntry, IGetAddressBookModeResult, ISetAddressBookModeReq, Report, IGetDashboardReq, IGetDashboardResp, TransactionType, TxIntention, IGasOption, PublicKeyWithSchema, AddressBookMode, MultiSigAccount, CoinTransferIntention, ObjectTransferIntention, PlainPayloadIntention } from '@msafe/sui3-utils';
 import * as _mysten_sui_cryptography from '@mysten/sui/cryptography';
 import { PublicKey, SignatureWithBytes } from '@mysten/sui/cryptography';
-import * as _mysten_sui_jsonRpc from '@mysten/sui/jsonRpc';
-import { JsonRpcTransport, ExecuteTransactionRequestType, SuiTransactionBlockResponseOptions, SuiTransactionBlockResponse, SuiJsonRpcClient, GasCostSummary, SuiObjectRef, DryRunTransactionBlockResponse, CoinMetadata, SuiObjectDataOptions, SuiObjectResponse, SuiObjectData, CoinStruct } from '@mysten/sui/jsonRpc';
+import { RpcTransport, SuiGrpcClient } from '@mysten/sui/grpc';
+import * as _mysten_sui_client from '@mysten/sui/client';
+import { SuiClientTypes } from '@mysten/sui/client';
 import { Transaction } from '@mysten/sui/transactions';
 import { Buffer } from 'buffer';
 
@@ -97,10 +98,12 @@ declare enum MSafeEnv {
     prev = "prev",
     prod = "prod"
 }
+/** Normalize HTTP(S) fullnode URL for SuiGrpcClient (gRPC-web) baseUrl. */
+declare function httpUrlToGrpcBaseUrl(url: string): string;
 interface MSafeConfig {
     suiClient: {
         url: string;
-        transport?: JsonRpcTransport;
+        transport?: RpcTransport;
     };
     backend: {
         url: string;
@@ -111,7 +114,7 @@ interface MSafeConfig {
 interface MSafeConfigOptions {
     suiClient?: {
         url: string;
-        transport?: JsonRpcTransport;
+        transport?: RpcTransport;
     };
     backend?: {
         url?: string;
@@ -140,19 +143,18 @@ interface IWallet {
     }): Promise<SignatureWithBytes>;
     signAndExecuteTransactionBlock(input: {
         transactionBlock: Transaction | Uint8Array;
-        requestType?: ExecuteTransactionRequestType;
-        options?: SuiTransactionBlockResponseOptions;
-    }): Promise<SuiTransactionBlockResponse>;
+        include?: SuiClientTypes.TransactionInclude;
+    }): Promise<SuiClientTypes.TransactionResult>;
 }
 
 declare class MSafeGlobals {
     readonly backend: IBackend;
-    readonly suiClient: SuiJsonRpcClient;
+    readonly suiClient: SuiGrpcClient;
     readonly config: MSafeConfig;
     _wallet: IWallet | undefined;
     constructor(input: {
         backend: IBackend;
-        suiClient: SuiJsonRpcClient;
+        suiClient: SuiGrpcClient;
         config: MSafeConfig;
     });
     static New(env: MSafeEnv, options?: MSafeConfigOptions): Promise<MSafeGlobals>;
@@ -177,6 +179,15 @@ declare class PublicKeyHelper {
     private getPublicKeyFromChain;
 }
 
+/** Gas coin reference derived from simulation / execution effects. */
+interface GasObjectReference {
+    objectId: string;
+    version: string;
+    digest: string;
+}
+type SimulateDryRunResponse = SuiClientTypes.SimulateTransactionResult<{
+    effects: true;
+}>;
 interface PendingTx {
     application: string;
     txType: TransactionType;
@@ -250,15 +261,15 @@ type SimulationResult = SimulationSuccessResult | SimulationFailedResult;
 interface SimulationSuccessResult {
     success: true;
     gasPrice: bigint;
-    gasUsed: GasCostSummary;
+    gasUsed: SuiClientTypes.GasCostSummary;
     gasBudget: bigint;
-    gasObject: SuiObjectRef;
-    response: DryRunTransactionBlockResponse;
+    gasObject: GasObjectReference;
+    response: SimulateDryRunResponse;
 }
 interface SimulationFailedResult {
     success: false;
     gasPrice: bigint;
-    response: DryRunTransactionBlockResponse;
+    response?: SimulateDryRunResponse;
     simulationError: string;
 }
 interface SimulationOption extends IGasOption {
@@ -329,17 +340,23 @@ declare class Simulator {
     private copyTransaction;
 }
 
+type CoinMetadata = SuiClientTypes.CoinMetadata;
 interface OwnedCoin {
     type: string;
     balance: bigint;
     metadata?: CoinMetadata;
 }
 
-type ObjectFilter = (objRes: SuiObjectResponse) => boolean;
+/** Owned object row with Move JSON content (for helpers like Coin.getBalance). */
+type OwnedObjectData = SuiClientTypes.Object<{
+    json: true;
+}>;
+type ObjectFilter = (obj: OwnedObjectData) => boolean;
 interface BatchObjectOptions {
     filter?: ObjectFilter;
     pageSize?: number;
-    objectOptions?: SuiObjectDataOptions;
+    /** Extra fields to request from the node; defaults include Move JSON for struct fields. */
+    objectInclude?: SuiClientTypes.ObjectInclude;
 }
 
 declare class MSafeAccount {
@@ -351,7 +368,7 @@ declare class MSafeAccount {
     constructor(globals: MSafeGlobals, info: IMSafeConfig);
     static New(globals: MSafeGlobals, address: string): Promise<void>;
     ownedCoins(): Promise<OwnedCoin[]>;
-    ownedObjects(options?: BatchObjectOptions): Promise<SuiObjectData[]>;
+    ownedObjects(options?: BatchObjectOptions): Promise<OwnedObjectData[]>;
     pendingTransaction(): Promise<PendingTx | undefined>;
     historyTransaction(pagination?: Pagination): Promise<_msafe_sui3_utils.GetHistoryTransactionsResponse>;
     futureIntentions(pagination?: Pagination): Promise<_msafe_sui3_utils.GetTransactionIntentionsResponse>;
@@ -381,7 +398,10 @@ declare class MSafeAccount {
     }): Promise<void>;
     skipNextFailedIntention(): Promise<void>;
     fetchTransaction(): Promise<string[]>;
-    executePendingTx(pending: PendingTx, isRejectTx?: boolean): Promise<_mysten_sui_jsonRpc.SuiTransactionBlockResponse>;
+    executePendingTx(pending: PendingTx, isRejectTx?: boolean): Promise<_mysten_sui_client.SuiClientTypes.TransactionResult<{
+        effects: true;
+        events: true;
+    }>>;
     dashboard(): Promise<_msafe_sui3_utils.IGetDashboardResp>;
     private calculateWeightFromVotes;
     private calculateWeight;
@@ -467,17 +487,17 @@ declare class Formatter {
 declare function addPrefix(s: string, prefix: string): string;
 
 declare const SUI_COIN = "0x2::sui::SUI";
-declare function getPublicKeyFromChain(suiClient: SuiJsonRpcClient, address: string): Promise<PublicKey | undefined>;
+declare function getPublicKeyFromChain(suiClient: SuiGrpcClient, address: string): Promise<PublicKey | undefined>;
 declare function getAllCoins(input: {
-    suiClient: SuiJsonRpcClient;
+    suiClient: SuiGrpcClient;
     owner: string;
     coinType: string | undefined;
-}): Promise<CoinStruct[]>;
+}): Promise<SuiClientTypes.Coin[]>;
 
 declare class CoinHelper {
     private _client;
     private _coinMetaReg;
-    constructor(client: SuiJsonRpcClient);
+    constructor(client: SuiGrpcClient);
     getCoinMeta(coinType: string): Promise<CoinMetadata | undefined>;
     private queryCoinMeta;
 }
@@ -485,12 +505,21 @@ declare const COIN_TYPE_ARG_REGEX: RegExp;
 declare class Coin {
     static isCoin(type: string | undefined | null): boolean;
     static getCoinType(type: string): string | null;
-    static getBalance(data: SuiObjectData): bigint | undefined;
+    static getBalance(data: {
+        type?: string | null;
+        json?: Record<string, unknown> | null;
+        content?: {
+            dataType?: string;
+            fields?: {
+                balance?: string;
+            };
+        };
+    }): bigint | undefined;
 }
 
 /**
- * Normalize a transaction from legacy helpers (sui.js TransactionBlock) or v2 Transaction.
+ * Normalize a transaction value to {@link Transaction} (handles plain Transaction or serialized legacy shapes).
  */
 declare function toSuiTransaction(txb: Transaction | unknown): Transaction;
 
-export { AddressBookSDK, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeInfo, DEV_API_URL, DEV_SYNCING_URL, ENV_CONFIGS, Formatter, type FutureIntention, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, InfoTypeEnabledDto, InfoTypeKey, LOCAL_API_URL, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnabledDto, MSafeEnv, MSafeGlobals, type NotificationData, type NotificationInfo, NotificationSubscribeDto, NotificationUpdateDto, PREV_API_URL, PROD_API_URL, type Pagination, type PendingTx, type PendingVote, type ProposeIntention, type ReceiveTransaction, SUI_COIN, SignatureVerifier, type SimulationFailedResult, type SimulationOption, type SimulationResult, type SimulationSuccessResult, TESTNET_RPC_URL, Uint8ArrayToHex, addPrefix, getAllCoins, getMSafeConfig, getPublicKeyFromChain, msafeChainToSuiNetwork, stringToBuffer, toSuiTransaction };
+export { AddressBookSDK, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeInfo, DEV_API_URL, DEV_SYNCING_URL, ENV_CONFIGS, Formatter, type FutureIntention, type GasObjectReference, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, InfoTypeEnabledDto, InfoTypeKey, LOCAL_API_URL, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnabledDto, MSafeEnv, MSafeGlobals, type NotificationData, type NotificationInfo, NotificationSubscribeDto, NotificationUpdateDto, PREV_API_URL, PROD_API_URL, type Pagination, type PendingTx, type PendingVote, type ProposeIntention, type ReceiveTransaction, SUI_COIN, SignatureVerifier, type SimulateDryRunResponse, type SimulationFailedResult, type SimulationOption, type SimulationResult, type SimulationSuccessResult, TESTNET_RPC_URL, Uint8ArrayToHex, addPrefix, getAllCoins, getMSafeConfig, getPublicKeyFromChain, httpUrlToGrpcBaseUrl, msafeChainToSuiNetwork, stringToBuffer, toSuiTransaction };