@mysten/sui 2.20.3 → 2.21.0

package/dist/jsonRpc/types/params.d.mts

@@ -7,6 +7,9 @@ import "../../transactions/index.mjs";
  * Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call)
  * with any arguments. Detailed results are provided, including both the transaction effects and any
  * return values.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface DevInspectTransactionBlockParams {
   sender: string;
@@ -23,6 +26,9 @@ interface DevInspectTransactionBlockParams {
 /**
  * Return transaction execution effects including the gas cost summary, while the effects are not
  * committed to the chain.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface DryRunTransactionBlockParams {
   transactionBlock: Uint8Array | string;
@@ -37,6 +43,9 @@ interface DryRunTransactionBlockParams {
  * the transaction locally in a timely manner, a bool type in the response is set to false to indicated
  * the case. request_type is default to be `WaitForEffectsCert` unless options.show_events or
  * options.show_effects is true
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface ExecuteTransactionBlockParams {
   /** BCS serialized transaction data bytes without its type tag, as base-64 encoded string. */
@@ -48,21 +57,36 @@ interface ExecuteTransactionBlockParams {
   signature: string | string[];
   /** options for specifying the content to be returned */
   options?: SuiTransactionBlockResponseOptions | null | undefined;
-  /** @deprecated requestType will be ignored by JSON RPC in the future */
+  /** @deprecated requestType is deprecated and should not be used */
   requestType?: ExecuteTransactionRequestType | null | undefined;
   signal?: AbortSignal;
 }
-/** Return the first four bytes of the chain's genesis checkpoint digest. */
+/**
+ * Return the first four bytes of the chain's genesis checkpoint digest.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetChainIdentifierParams {
   signal?: AbortSignal;
 }
-/** Return a checkpoint */
+/**
+ * Return a checkpoint
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetCheckpointParams {
   /** Checkpoint identifier, can use either checkpoint digest, or checkpoint sequence number as input. */
   id: CheckpointId;
   signal?: AbortSignal;
 }
-/** Return paginated list of checkpoints */
+/**
+ * Return paginated list of checkpoints
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetCheckpointsParams {
   /**
    * An optional paging cursor. If provided, the query will start from the next item after the specified
@@ -75,49 +99,89 @@ interface GetCheckpointsParams {
   descendingOrder: boolean;
   signal?: AbortSignal;
 }
-/** Return transaction events. */
+/**
+ * Return transaction events.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetEventsParams {
   /** the event query criteria. */
   transactionDigest: string;
   signal?: AbortSignal;
 }
-/** Return the sequence number of the latest checkpoint that has been executed */
+/**
+ * Return the sequence number of the latest checkpoint that has been executed
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetLatestCheckpointSequenceNumberParams {
   signal?: AbortSignal;
 }
-/** Return the argument types of a Move function, based on normalized Type. */
+/**
+ * Return the argument types of a Move function, based on normalized Type.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetMoveFunctionArgTypesParams {
   package: string;
   module: string;
   function: string;
   signal?: AbortSignal;
 }
-/** Return a structured representation of Move function */
+/**
+ * Return a structured representation of Move function
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetNormalizedMoveFunctionParams {
   package: string;
   module: string;
   function: string;
   signal?: AbortSignal;
 }
-/** Return a structured representation of Move module */
+/**
+ * Return a structured representation of Move module
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetNormalizedMoveModuleParams {
   package: string;
   module: string;
   signal?: AbortSignal;
 }
-/** Return structured representations of all modules in the given package */
+/**
+ * Return structured representations of all modules in the given package
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetNormalizedMoveModulesByPackageParams {
   package: string;
   signal?: AbortSignal;
 }
-/** Return a structured representation of Move struct */
+/**
+ * Return a structured representation of Move struct
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetNormalizedMoveStructParams {
   package: string;
   module: string;
   struct: string;
   signal?: AbortSignal;
 }
-/** Return the object information for a specified object */
+/**
+ * Return the object information for a specified object
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetObjectParams {
   /** the ID of the queried object */
   id: string;
@@ -128,6 +192,9 @@ interface GetObjectParams {
 /**
  * Return the protocol config table for the given version number. If none is specified, the node uses
  * the version of the latest epoch it has processed.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface GetProtocolConfigParams {
   /**
@@ -137,11 +204,21 @@ interface GetProtocolConfigParams {
   version?: string | null | undefined;
   signal?: AbortSignal;
 }
-/** Return the total number of transaction blocks known to the server. */
+/**
+ * Return the total number of transaction blocks known to the server.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetTotalTransactionBlocksParams {
   signal?: AbortSignal;
 }
-/** Return the transaction response object. */
+/**
+ * Return the transaction response object.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetTransactionBlockParams {
   /** the digest of the queried transaction */
   digest: string;
@@ -149,7 +226,12 @@ interface GetTransactionBlockParams {
   options?: SuiTransactionBlockResponseOptions | null | undefined;
   signal?: AbortSignal;
 }
-/** Return the object data for a list of objects */
+/**
+ * Return the object data for a list of objects
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface MultiGetObjectsParams {
   /** the IDs of the queried objects */
   ids: string[];
@@ -160,6 +242,9 @@ interface MultiGetObjectsParams {
 /**
  * Returns an ordered list of transaction responses The method will throw an error if the input
  * contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface MultiGetTransactionBlocksParams {
   /** A list of transaction digests. */
@@ -172,6 +257,9 @@ interface MultiGetTransactionBlocksParams {
  * Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by
  * this API, even if the object and version exists/existed. The result may vary across nodes depending
  * on their pruning policies. Return the object information for a specified version
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface TryGetPastObjectParams {
   /** the ID of the queried object */
@@ -186,6 +274,9 @@ interface TryGetPastObjectParams {
  * Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by
  * this API, even if the object and version exists/existed. The result may vary across nodes depending
  * on their pruning policies. Return the object information for a specified version
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface TryMultiGetPastObjectsParams {
   /** a vector of object and versions to be queried */
@@ -194,7 +285,12 @@ interface TryMultiGetPastObjectsParams {
   options?: SuiObjectDataOptions | null | undefined;
   signal?: AbortSignal;
 }
-/** Verify a zklogin signature for the given bytes, intent scope and author. */
+/**
+ * Verify a zklogin signature for the given bytes, intent scope and author.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface VerifyZkLoginSignatureParams {
   /**
    * The Base64 string of bcs bytes for raw transaction data or personal message indicated by
@@ -209,13 +305,23 @@ interface VerifyZkLoginSignatureParams {
   author: string;
   signal?: AbortSignal;
 }
-/** Return the total coin balance for all coin type, owned by the address owner. */
+/**
+ * Return the total coin balance for all coin type, owned by the address owner.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetAllBalancesParams {
   /** the owner's Sui address */
   owner: string;
   signal?: AbortSignal;
 }
-/** Return all Coin objects owned by an address. */
+/**
+ * Return all Coin objects owned by an address.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetAllCoinsParams {
   /** the owner's Sui address */
   owner: string;
@@ -225,7 +331,12 @@ interface GetAllCoinsParams {
   limit?: number | null | undefined;
   signal?: AbortSignal;
 }
-/** Return the total coin balance for one coin type, owned by the address owner. */
+/**
+ * Return the total coin balance for one coin type, owned by the address owner.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetBalanceParams {
   /** the owner's Sui address */
   owner: string;
@@ -240,13 +351,21 @@ interface GetBalanceParams {
  * Return metadata (e.g., symbol, decimals) for a coin. Note that if the coin's metadata was wrapped in
  * the transaction that published its marker type, or the latest version of the metadata object is
  * wrapped or deleted, it will not be found.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface GetCoinMetadataParams {
   /** type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) */
   coinType: string;
   signal?: AbortSignal;
 }
-/** Return all Coin<`coin_type`> objects owned by an address. */
+/**
+ * Return all Coin<`coin_type`> objects owned by an address.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetCoinsParams {
   /** the owner's Sui address */
   owner: string;
@@ -261,13 +380,23 @@ interface GetCoinsParams {
   limit?: number | null | undefined;
   signal?: AbortSignal;
 }
-/** Return the committee information for the asked `epoch`. */
+/**
+ * Return the committee information for the asked `epoch`.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetCommitteeInfoParams {
   /** The epoch of interest. If None, default to the latest epoch */
   epoch?: string | null | undefined;
   signal?: AbortSignal;
 }
-/** Return the dynamic field object information for a specified object */
+/**
+ * Return the dynamic field object information for a specified object
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetDynamicFieldObjectParams {
   /** The ID of the queried parent object */
   parentId: string;
@@ -275,7 +404,12 @@ interface GetDynamicFieldObjectParams {
   name: DynamicFieldName;
   signal?: AbortSignal;
 }
-/** Return the list of dynamic field objects owned by an object. */
+/**
+ * Return the list of dynamic field objects owned by an object.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetDynamicFieldsParams {
   /** The ID of the parent object */
   parentId: string;
@@ -288,7 +422,12 @@ interface GetDynamicFieldsParams {
   limit?: number | null | undefined;
   signal?: AbortSignal;
 }
-/** Return the latest SUI system state object on-chain. */
+/**
+ * Return the latest SUI system state object on-chain.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetLatestSuiSystemStateParams {
   signal?: AbortSignal;
 }
@@ -296,6 +435,9 @@ interface GetLatestSuiSystemStateParams {
  * Return the list of objects owned by an address. Note that if the address owns more than
  * `QUERY_MAX_RESULT_LIMIT` objects, the pagination is not accurate, because previous page may have
  * been updated when the next page is fetched. Please use suix_queryObjects if this is a concern.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 type GetOwnedObjectsParams = {
   /** the owner's Sui address */owner: string;
@@ -307,31 +449,61 @@ type GetOwnedObjectsParams = {
   limit?: number | null | undefined;
   signal?: AbortSignal;
 } & SuiObjectResponseQuery;
-/** Return the reference gas price for the network */
+/**
+ * Return the reference gas price for the network
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetReferenceGasPriceParams {
   signal?: AbortSignal;
 }
-/** Return all [DelegatedStake]. */
+/**
+ * Return all [DelegatedStake].
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetStakesParams {
   owner: string;
   signal?: AbortSignal;
 }
-/** Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked. */
+/**
+ * Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetStakesByIdsParams {
   stakedSuiIds: string[];
   signal?: AbortSignal;
 }
-/** Return total supply for a coin */
+/**
+ * Return total supply for a coin
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetTotalSupplyParams {
   /** type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) */
   coinType: string;
   signal?: AbortSignal;
 }
-/** Return the validator APY */
+/**
+ * Return the validator APY
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface GetValidatorsApyParams {
   signal?: AbortSignal;
 }
-/** Return list of events for a specified query criteria. */
+/**
+ * Return list of events for a specified query criteria.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface QueryEventsParams {
   /**
    * The event query criteria. See [Event filter](https://docs.sui.io/build/event_api#event-filters)
@@ -346,7 +518,12 @@ interface QueryEventsParams {
   order?: 'ascending' | 'descending' | null | undefined;
   signal?: AbortSignal;
 }
-/** Return list of transactions for a specified query criteria. */
+/**
+ * Return list of transactions for a specified query criteria.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 type QueryTransactionBlocksParams = {
   /**
    * An optional paging cursor. If provided, the query will start from the next item after the specified
@@ -357,7 +534,12 @@ type QueryTransactionBlocksParams = {
   order?: 'ascending' | 'descending' | null | undefined;
   signal?: AbortSignal;
 } & SuiTransactionBlockResponseQuery;
-/** Return the resolved address given resolver and name */
+/**
+ * Return the resolved address given resolver and name
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface ResolveNameServiceAddressParams {
   /** The name to resolve */
   name: string;
@@ -366,6 +548,9 @@ interface ResolveNameServiceAddressParams {
 /**
  * Return the resolved names given address, if multiple names are resolved, the first one is the
  * primary name.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface ResolveNameServiceNamesParams {
   /** The address to resolve */
@@ -374,7 +559,12 @@ interface ResolveNameServiceNamesParams {
   limit?: number | null | undefined;
   signal?: AbortSignal;
 }
-/** Subscribe to a stream of Sui event */
+/**
+ * Subscribe to a stream of Sui event
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface SubscribeEventParams {
   /**
    * The filter criteria of the event stream. See
@@ -383,12 +573,22 @@ interface SubscribeEventParams {
   filter: SuiEventFilter;
   signal?: AbortSignal;
 }
-/** Subscribe to a stream of Sui transaction effects */
+/**
+ * Subscribe to a stream of Sui transaction effects
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface SubscribeTransactionParams {
   filter: TransactionFilter;
   signal?: AbortSignal;
 }
-/** Create an unsigned batched transaction. */
+/**
+ * Create an unsigned batched transaction.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface UnsafeBatchTransactionParams {
   /** the transaction signer's Sui address */
   signer: string;
@@ -405,7 +605,12 @@ interface UnsafeBatchTransactionParams {
   txnBuilderMode?: SuiTransactionBlockBuilderMode | null | undefined;
   signal?: AbortSignal;
 }
-/** Create an unsigned transaction to merge multiple coins into one coin. */
+/**
+ * Create an unsigned transaction to merge multiple coins into one coin.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface UnsafeMergeCoinsParams {
   /** the transaction signer's Sui address */
   signer: string;
@@ -428,6 +633,9 @@ interface UnsafeMergeCoinsParams {
 /**
  * Create an unsigned transaction to execute a Move call on the network, by calling the specified
  * function in the module of a given package.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface UnsafeMoveCallParams {
   /** the transaction signer's Sui address */
@@ -464,6 +672,9 @@ interface UnsafeMoveCallParams {
  * The object specified in the `gas` field will be used to pay the gas fee for the transaction. The gas
  * object can not appear in `input_coins`. If the gas object is not specified, the RPC server will
  * auto-select one.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface UnsafePayParams {
   /** the transaction signer's Sui address */
@@ -489,6 +700,9 @@ interface UnsafePayParams {
  * deposit all SUI to the first input coin 2. transfer the updated first coin to the recipient and also
  * use this first coin as gas coin object. 3. the balance of the first input coin after tx is
  * sum(input_coins) - actual_gas_cost. 4. all other input coins other than the first are deleted.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface UnsafePayAllSuiParams {
   /** the transaction signer's Sui address */
@@ -509,6 +723,9 @@ interface UnsafePayAllSuiParams {
  * input coin, then use the first input coin as the gas coin object. 3. the balance of the first input
  * coin after tx is sum(input_coins) - sum(amounts) - actual_gas_cost 4. all other input coins other
  * than the first one are deleted.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface UnsafePaySuiParams {
   /** the transaction signer's Sui address */
@@ -523,7 +740,12 @@ interface UnsafePaySuiParams {
   gasBudget: string;
   signal?: AbortSignal;
 }
-/** Create an unsigned transaction to publish a Move package. */
+/**
+ * Create an unsigned transaction to publish a Move package.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface UnsafePublishParams {
   /** the transaction signer's Sui address */
   sender: string;
@@ -540,7 +762,12 @@ interface UnsafePublishParams {
   gasBudget: string;
   signal?: AbortSignal;
 }
-/** Add stake to a validator's staking pool using multiple coins and amount. */
+/**
+ * Add stake to a validator's staking pool using multiple coins and amount.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface UnsafeRequestAddStakeParams {
   /** the transaction signer's Sui address */
   signer: string;
@@ -559,7 +786,12 @@ interface UnsafeRequestAddStakeParams {
   gasBudget: string;
   signal?: AbortSignal;
 }
-/** Withdraw stake from a validator's staking pool. */
+/**
+ * Withdraw stake from a validator's staking pool.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface UnsafeRequestWithdrawStakeParams {
   /** the transaction signer's Sui address */
   signer: string;
@@ -574,7 +806,12 @@ interface UnsafeRequestWithdrawStakeParams {
   gasBudget: string;
   signal?: AbortSignal;
 }
-/** Create an unsigned transaction to split a coin object into multiple coins. */
+/**
+ * Create an unsigned transaction to split a coin object into multiple coins.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface UnsafeSplitCoinParams {
   /** the transaction signer's Sui address */
   signer: string;
@@ -591,7 +828,12 @@ interface UnsafeSplitCoinParams {
   gasBudget: string;
   signal?: AbortSignal;
 }
-/** Create an unsigned transaction to split a coin object into multiple equal-size coins. */
+/**
+ * Create an unsigned transaction to split a coin object into multiple equal-size coins.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+ */
 interface UnsafeSplitCoinEqualParams {
   /** the transaction signer's Sui address */
   signer: string;
@@ -611,6 +853,9 @@ interface UnsafeSplitCoinEqualParams {
 /**
  * Create an unsigned transaction to transfer an object from one address to another. The object's type
  * must allow public transfers
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface UnsafeTransferObjectParams {
   /** the transaction signer's Sui address */
@@ -631,6 +876,9 @@ interface UnsafeTransferObjectParams {
 /**
  * Create an unsigned transaction to send SUI coin object to a Sui address. The SUI object is also used
  * as the gas object.
+ *
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
  */
 interface UnsafeTransferSuiParams {
   /** the transaction signer's Sui address */