@mysten/sui 2.20.3 → 2.20.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist/bcs/bcs.d.mts +6 -6
  3. package/dist/bcs/index.d.mts +20 -20
  4. package/dist/client/core.d.mts.map +1 -1
  5. package/dist/client/core.mjs +4 -1
  6. package/dist/client/core.mjs.map +1 -1
  7. package/dist/client/mvr.d.mts.map +1 -1
  8. package/dist/client/mvr.mjs +29 -7
  9. package/dist/client/mvr.mjs.map +1 -1
  10. package/dist/cryptography/signature.d.mts +8 -8
  11. package/dist/grpc/client.d.mts.map +1 -1
  12. package/dist/grpc/client.mjs +1 -1
  13. package/dist/grpc/client.mjs.map +1 -1
  14. package/dist/grpc/core.d.mts +4 -4
  15. package/dist/grpc/core.d.mts.map +1 -1
  16. package/dist/grpc/core.mjs +44 -27
  17. package/dist/grpc/core.mjs.map +1 -1
  18. package/dist/grpc/proto/sui/forking/v1alpha/forking_service.client.d.mts +4 -4
  19. package/dist/grpc/proto/sui/rpc/v2/ledger_service.client.d.mts +4 -4
  20. package/dist/grpc/proto/sui/rpc/v2/move_package_service.client.d.mts +4 -4
  21. package/dist/grpc/proto/sui/rpc/v2/name_service.client.d.mts +4 -4
  22. package/dist/grpc/proto/sui/rpc/v2/transaction_execution_service.client.d.mts +4 -4
  23. package/dist/jsonRpc/client.d.mts +160 -0
  24. package/dist/jsonRpc/client.d.mts.map +1 -1
  25. package/dist/jsonRpc/client.mjs +142 -0
  26. package/dist/jsonRpc/client.mjs.map +1 -1
  27. package/dist/jsonRpc/core.d.mts +80 -0
  28. package/dist/jsonRpc/core.d.mts.map +1 -1
  29. package/dist/jsonRpc/core.mjs +80 -0
  30. package/dist/jsonRpc/core.mjs.map +1 -1
  31. package/dist/jsonRpc/errors.d.mts +12 -0
  32. package/dist/jsonRpc/errors.d.mts.map +1 -1
  33. package/dist/jsonRpc/errors.mjs +12 -0
  34. package/dist/jsonRpc/errors.mjs.map +1 -1
  35. package/dist/jsonRpc/http-transport.d.mts +30 -0
  36. package/dist/jsonRpc/http-transport.d.mts.map +1 -1
  37. package/dist/jsonRpc/http-transport.mjs +16 -0
  38. package/dist/jsonRpc/http-transport.mjs.map +1 -1
  39. package/dist/jsonRpc/network.d.mts +4 -0
  40. package/dist/jsonRpc/network.d.mts.map +1 -1
  41. package/dist/jsonRpc/network.mjs +4 -0
  42. package/dist/jsonRpc/network.mjs.map +1 -1
  43. package/dist/jsonRpc/types/chain.d.mts +68 -0
  44. package/dist/jsonRpc/types/chain.d.mts.map +1 -1
  45. package/dist/jsonRpc/types/changes.d.mts +24 -0
  46. package/dist/jsonRpc/types/changes.d.mts.map +1 -1
  47. package/dist/jsonRpc/types/coins.d.mts +4 -0
  48. package/dist/jsonRpc/types/coins.d.mts.map +1 -1
  49. package/dist/jsonRpc/types/common.d.mts +4 -0
  50. package/dist/jsonRpc/types/common.d.mts.map +1 -1
  51. package/dist/jsonRpc/types/generated.d.mts +497 -16
  52. package/dist/jsonRpc/types/generated.d.mts.map +1 -1
  53. package/dist/jsonRpc/types/params.d.mts +289 -41
  54. package/dist/jsonRpc/types/params.d.mts.map +1 -1
  55. package/dist/transactions/Transaction.d.mts +9 -9
  56. package/dist/version.mjs +1 -1
  57. package/dist/version.mjs.map +1 -1
  58. package/dist/zklogin/bcs.d.mts +14 -14
  59. package/dist/zklogin/bcs.d.mts.map +1 -1
  60. package/package.json +3 -3
  61. package/src/client/core.ts +1 -0
  62. package/src/client/mvr.ts +39 -6
  63. package/src/grpc/client.ts +10 -7
  64. package/src/grpc/core.ts +200 -134
  65. package/src/jsonRpc/client.ts +160 -0
  66. package/src/jsonRpc/core.ts +80 -0
  67. package/src/jsonRpc/errors.ts +12 -0
  68. package/src/jsonRpc/http-transport.ts +30 -0
  69. package/src/jsonRpc/network.ts +4 -0
  70. package/src/jsonRpc/types/chain.ts +68 -0
  71. package/src/jsonRpc/types/changes.ts +24 -0
  72. package/src/jsonRpc/types/coins.ts +4 -0
  73. package/src/jsonRpc/types/common.ts +4 -0
  74. package/src/jsonRpc/types/generated.ts +497 -16
  75. package/src/jsonRpc/types/params.ts +289 -41
  76. package/src/version.ts +1 -1
@@ -7,6 +7,10 @@
7
7
  * This file is generated from:
8
8
  * /crates/sui-open-rpc/spec/openrpc.json
9
9
  */
10
+ /**
11
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
12
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
13
+ */
10
14
  interface AccumulatorEvent {
11
15
  accumulatorObj: string;
12
16
  address: string;
@@ -14,7 +18,15 @@ interface AccumulatorEvent {
14
18
  ty: string;
15
19
  value: AccumulatorValue;
16
20
  }
21
+ /**
22
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
23
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
24
+ */
17
25
  type AccumulatorOperation = 'merge' | 'split';
26
+ /**
27
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
28
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
29
+ */
18
30
  type AccumulatorValue = {
19
31
  integer: string;
20
32
  } | {
@@ -22,6 +34,10 @@ type AccumulatorValue = {
22
34
  } | {
23
35
  eventDigest: [string, string][];
24
36
  };
37
+ /**
38
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
39
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
40
+ */
25
41
  interface Balance {
26
42
  coinObjectCount: number;
27
43
  coinType: string;
@@ -36,6 +52,10 @@ interface Balance {
36
52
  };
37
53
  totalBalance: string;
38
54
  }
55
+ /**
56
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
57
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
58
+ */
39
59
  interface BalanceChange {
40
60
  /**
41
61
  * The amount indicate the balance value changes, negative amount means spending coin value and
@@ -46,6 +66,10 @@ interface BalanceChange {
46
66
  /** Owner of the balance change */
47
67
  owner: ObjectOwner;
48
68
  }
69
+ /**
70
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
71
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
72
+ */
49
73
  interface Checkpoint {
50
74
  /** Commitments to checkpoint state */
51
75
  checkpointCommitments: CheckpointCommitment[];
@@ -77,17 +101,34 @@ interface Checkpoint {
77
101
  /** Validator Signature */
78
102
  validatorSignature: string;
79
103
  }
104
+ /**
105
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
106
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
107
+ */
80
108
  type CheckpointCommitment = {
81
109
  ECMHLiveObjectSetDigest: ECMHLiveObjectSetDigest;
82
110
  } | {
83
111
  CheckpointArtifactsDigest: string;
84
112
  };
113
+ /**
114
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
115
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
116
+ */
85
117
  type CheckpointId = string | string;
86
- /** A claim consists of value and index_mod_4. */
118
+ /**
119
+ * A claim consists of value and index_mod_4.
120
+ *
121
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
122
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
123
+ */
87
124
  interface Claim {
88
125
  indexMod4: number;
89
126
  value: string;
90
127
  }
128
+ /**
129
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
130
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
131
+ */
91
132
  interface CoinStruct {
92
133
  balance: string;
93
134
  coinObjectId: string;
@@ -96,12 +137,22 @@ interface CoinStruct {
96
137
  previousTransaction: string;
97
138
  version: string;
98
139
  }
99
- /** RPC representation of the [Committee] type. */
140
+ /**
141
+ * RPC representation of the [Committee] type.
142
+ *
143
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
144
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
145
+ */
100
146
  interface CommitteeInfo {
101
147
  epoch: string;
102
148
  validators: [string, string][];
103
149
  }
104
- /** Unlike [enum Signature], [enum CompressedSignature] does not contain public key. */
150
+ /**
151
+ * Unlike [enum Signature], [enum CompressedSignature] does not contain public key.
152
+ *
153
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
154
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
155
+ */
105
156
  type CompressedSignature = {
106
157
  Ed25519: string;
107
158
  } | {
@@ -113,11 +164,19 @@ type CompressedSignature = {
113
164
  } | {
114
165
  Passkey: string;
115
166
  };
167
+ /**
168
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
169
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
170
+ */
116
171
  type ConsensusDeterminedVersionAssignments = {
117
172
  CancelledTransactions: [string, [string, string][]][];
118
173
  } | {
119
174
  CancelledTransactionsV2: [string, [[string, string], string][]][];
120
175
  };
176
+ /**
177
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
178
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
179
+ */
121
180
  type SuiParsedData = {
122
181
  dataType: 'moveObject';
123
182
  fields: MoveStruct;
@@ -129,6 +188,10 @@ type SuiParsedData = {
129
188
  [key: string]: unknown;
130
189
  };
131
190
  };
191
+ /**
192
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
193
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
194
+ */
132
195
  interface DelegatedStake {
133
196
  stakes: StakeObject[];
134
197
  /** Staking pool object id. */
@@ -136,7 +199,12 @@ interface DelegatedStake {
136
199
  /** Validator's Address. */
137
200
  validatorAddress: string;
138
201
  }
139
- /** Additional rguments supplied to dev inspect beyond what is allowed in today's API. */
202
+ /**
203
+ * Additional rguments supplied to dev inspect beyond what is allowed in today's API.
204
+ *
205
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
206
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
207
+ */
140
208
  interface DevInspectArgs {
141
209
  /** The gas budget for the transaction. */
142
210
  gasBudget?: string | null;
@@ -149,7 +217,12 @@ interface DevInspectArgs {
149
217
  /** Whether to skip transaction checks for the transaction. */
150
218
  skipChecks?: boolean | null;
151
219
  }
152
- /** The response from processing a dev inspect transaction */
220
+ /**
221
+ * The response from processing a dev inspect transaction
222
+ *
223
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
224
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
225
+ */
153
226
  interface DevInspectResults {
154
227
  /**
155
228
  * Summary of effects that likely would be generated if the transaction is actually run. Note however,
@@ -168,12 +241,20 @@ interface DevInspectResults {
168
241
  /** Execution results (including return values) from executing the transactions */
169
242
  results?: SuiExecutionResult[] | null;
170
243
  }
244
+ /**
245
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
246
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
247
+ */
171
248
  interface DisplayFieldsResponse {
172
249
  data?: {
173
250
  [key: string]: unknown;
174
251
  } | null;
175
252
  error?: ObjectResponseError | null;
176
253
  }
254
+ /**
255
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
256
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
257
+ */
177
258
  interface DryRunTransactionBlockResponse {
178
259
  balanceChanges: BalanceChange[];
179
260
  effects: TransactionEffects;
@@ -183,6 +264,10 @@ interface DryRunTransactionBlockResponse {
183
264
  objectChanges: SuiObjectChange[];
184
265
  suggestedGasPrice?: string | null;
185
266
  }
267
+ /**
268
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
269
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
270
+ */
186
271
  type DynamicFieldInfo = {
187
272
  digest: string;
188
273
  name: DynamicFieldName;
@@ -202,15 +287,32 @@ type DynamicFieldInfo = {
202
287
  bcsEncoding: 'base58';
203
288
  bcsName: string;
204
289
  };
290
+ /**
291
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
292
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
293
+ */
205
294
  interface DynamicFieldName {
206
295
  type: string;
207
296
  value: unknown;
208
297
  }
298
+ /**
299
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
300
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
301
+ */
209
302
  type DynamicFieldType = 'DynamicField' | 'DynamicObject';
210
- /** The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set. */
303
+ /**
304
+ * The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set.
305
+ *
306
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
307
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
308
+ */
211
309
  interface ECMHLiveObjectSetDigest {
212
310
  digest: number[];
213
311
  }
312
+ /**
313
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
314
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
315
+ */
214
316
  interface EndOfEpochData {
215
317
  /** Commitments to epoch specific state (e.g. live object set) */
216
318
  epochCommitments: CheckpointCommitment[];
@@ -229,6 +331,10 @@ interface EndOfEpochData {
229
331
  */
230
332
  nextEpochProtocolVersion: string;
231
333
  }
334
+ /**
335
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
336
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
337
+ */
232
338
  type SuiEvent = {
233
339
  /**
234
340
  * Sequential event ID, ie (transaction seq number, event seq number). 1) Serves as a unique event ID
@@ -260,6 +366,10 @@ type SuiEvent = {
260
366
  bcs: string;
261
367
  bcsEncoding: 'base58';
262
368
  };
369
+ /**
370
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
371
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
372
+ */
263
373
  type SuiEventFilter = /** Return all events. */{
264
374
  All: [];
265
375
  } /** Return events that match any of the given filters. Only supported on event subscriptions. */ | {
@@ -303,12 +413,25 @@ type SuiEventFilter = /** Return all events. */{
303
413
  startTime: string;
304
414
  };
305
415
  };
306
- /** Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number. */
416
+ /**
417
+ * Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number.
418
+ *
419
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
420
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
421
+ */
307
422
  interface EventId {
308
423
  eventSeq: string;
309
424
  txDigest: string;
310
425
  }
426
+ /**
427
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
428
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
429
+ */
311
430
  type ExecuteTransactionRequestType = 'WaitForEffectsCert' | 'WaitForLocalExecution';
431
+ /**
432
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
433
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
434
+ */
312
435
  type ExecutionStatus = {
313
436
  status: 'success' | 'failure';
314
437
  error?: string;
@@ -331,6 +454,9 @@ type ExecutionStatus = {
331
454
  * objects added up to a pool of "potential rebate". This rebate then is reduced by the "nonrefundable
332
455
  * rate" such that:
333
456
  * `potential_rebate(storage cost of deleted/mutated objects) = storage_rebate + non_refundable_storage_fee`
457
+ *
458
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
459
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
334
460
  */
335
461
  interface GasCostSummary {
336
462
  /** Cost of computation/execution */
@@ -345,18 +471,30 @@ interface GasCostSummary {
345
471
  */
346
472
  storageRebate: string;
347
473
  }
474
+ /**
475
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
476
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
477
+ */
348
478
  interface SuiGasData {
349
479
  budget: string;
350
480
  owner: string;
351
481
  payment: SuiObjectRef[];
352
482
  price: string;
353
483
  }
484
+ /**
485
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
486
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
487
+ */
354
488
  interface GetPastObjectRequest {
355
489
  /** the ID of the queried object */
356
490
  objectId: string;
357
491
  /** the version of the queried object. */
358
492
  version: string;
359
493
  }
494
+ /**
495
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
496
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
497
+ */
360
498
  type InputObjectKind = {
361
499
  MovePackage: string;
362
500
  } | {
@@ -368,6 +506,10 @@ type InputObjectKind = {
368
506
  mutable?: boolean;
369
507
  };
370
508
  };
509
+ /**
510
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
511
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
512
+ */
371
513
  interface MoveCallParams {
372
514
  arguments: unknown[];
373
515
  function: string;
@@ -375,9 +517,17 @@ interface MoveCallParams {
375
517
  packageObjectId: string;
376
518
  typeArguments?: string[];
377
519
  }
520
+ /**
521
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
522
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
523
+ */
378
524
  type SuiMoveFunctionArgType = 'Pure' | {
379
525
  Object: ObjectValueKind;
380
526
  };
527
+ /**
528
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
529
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
530
+ */
381
531
  type MoveStruct = MoveValue[] | {
382
532
  fields: {
383
533
  [key: string]: MoveValue;
@@ -386,9 +536,17 @@ type MoveStruct = MoveValue[] | {
386
536
  } | {
387
537
  [key: string]: MoveValue;
388
538
  };
539
+ /**
540
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
541
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
542
+ */
389
543
  type MoveValue = number | boolean | string | MoveValue[] | string | {
390
544
  id: string;
391
545
  } | MoveStruct | null | MoveVariant;
546
+ /**
547
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
548
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
549
+ */
392
550
  interface MoveVariant {
393
551
  fields: {
394
552
  [key: string]: MoveValue;
@@ -396,7 +554,12 @@ interface MoveVariant {
396
554
  type: string;
397
555
  variant: string;
398
556
  }
399
- /** The struct that contains signatures and public keys necessary for authenticating a MultiSig. */
557
+ /**
558
+ * The struct that contains signatures and public keys necessary for authenticating a MultiSig.
559
+ *
560
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
561
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
562
+ */
400
563
  interface MultiSig {
401
564
  /** A bitmap that indicates the position of which public key the signature should be authenticated with. */
402
565
  bitmap: number;
@@ -411,6 +574,9 @@ interface MultiSig {
411
574
  /**
412
575
  * Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys
413
576
  * necessary for authenticating a MultiSigLegacy.
577
+ *
578
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
579
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
414
580
  */
415
581
  interface MultiSigLegacy {
416
582
  /** A bitmap that indicates the position of which public key the signature should be authenticated with. */
@@ -423,7 +589,12 @@ interface MultiSigLegacy {
423
589
  /** The plain signature encoded with signature scheme. */
424
590
  sigs: CompressedSignature[];
425
591
  }
426
- /** The struct that contains the public key used for authenticating a MultiSig. */
592
+ /**
593
+ * The struct that contains the public key used for authenticating a MultiSig.
594
+ *
595
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
596
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
597
+ */
427
598
  interface MultiSigPublicKey {
428
599
  /** A list of public key and its corresponding weight. */
429
600
  pk_map: [PublicKey, number][];
@@ -436,6 +607,9 @@ interface MultiSigPublicKey {
436
607
  /**
437
608
  * Deprecated, use [struct MultiSigPublicKey] instead. The struct that contains the public key used for
438
609
  * authenticating a MultiSig.
610
+ *
611
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
612
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
439
613
  */
440
614
  interface MultiSigPublicKeyLegacy {
441
615
  /** A list of public key and its corresponding weight. */
@@ -449,6 +623,9 @@ interface MultiSigPublicKeyLegacy {
449
623
  /**
450
624
  * ObjectChange are derived from the object mutations in the TransactionEffect to provide richer object
451
625
  * information.
626
+ *
627
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
628
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
452
629
  */
453
630
  type SuiObjectChange = /** Module published */{
454
631
  digest: string;
@@ -494,6 +671,10 @@ type SuiObjectChange = /** Module published */{
494
671
  type: 'created';
495
672
  version: string;
496
673
  };
674
+ /**
675
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
676
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
677
+ */
497
678
  interface SuiObjectData {
498
679
  /**
499
680
  * Move object content or package content in BCS, default to be None unless
@@ -531,6 +712,10 @@ interface SuiObjectData {
531
712
  /** Object version. */
532
713
  version: string;
533
714
  }
715
+ /**
716
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
717
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
718
+ */
534
719
  interface SuiObjectDataOptions {
535
720
  /** Whether to show the content in BCS format. Default to be False */
536
721
  showBcs?: boolean;
@@ -550,6 +735,10 @@ interface SuiObjectDataOptions {
550
735
  /** Whether to show the type of the object. Default to be False */
551
736
  showType?: boolean;
552
737
  }
738
+ /**
739
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
740
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
741
+ */
553
742
  type ObjectRead = /** The object exists and is found with this version */{
554
743
  details: SuiObjectData;
555
744
  status: 'VersionFound';
@@ -570,6 +759,10 @@ type ObjectRead = /** The object exists and is found with this version */{
570
759
  };
571
760
  status: 'VersionTooHigh';
572
761
  };
762
+ /**
763
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
764
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
765
+ */
573
766
  interface SuiObjectRef {
574
767
  /** Base64 string representing the object digest */
575
768
  digest: string;
@@ -578,6 +771,10 @@ interface SuiObjectRef {
578
771
  /** Object version. */
579
772
  version: string;
580
773
  }
774
+ /**
775
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
776
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
777
+ */
581
778
  type ObjectResponseError = {
582
779
  code: 'notExists';
583
780
  object_id: string;
@@ -595,17 +792,33 @@ type ObjectResponseError = {
595
792
  code: 'displayError';
596
793
  error: string;
597
794
  };
795
+ /**
796
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
797
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
798
+ */
598
799
  interface SuiObjectResponseQuery {
599
800
  /** If None, no filter will be applied */
600
801
  filter?: SuiObjectDataFilter | null;
601
802
  /** config which fields to include in the response, by default only digest is included */
602
803
  options?: SuiObjectDataOptions | null;
603
804
  }
805
+ /**
806
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
807
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
808
+ */
604
809
  type ObjectValueKind = 'ByImmutableReference' | 'ByMutableReference' | 'ByValue';
810
+ /**
811
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
812
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
813
+ */
605
814
  interface OwnedObjectRef {
606
815
  owner: ObjectOwner;
607
816
  reference: SuiObjectRef;
608
817
  }
818
+ /**
819
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
820
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
821
+ */
609
822
  type ObjectOwner = /** Object is exclusively owned by a single address, and is mutable. */{
610
823
  AddressOwner: string;
611
824
  }
@@ -633,6 +846,9 @@ type ObjectOwner = /** Object is exclusively owned by a single address, and is m
633
846
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
634
847
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
635
848
  * item.
849
+ *
850
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
851
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
636
852
  */
637
853
  interface PaginatedCheckpoints {
638
854
  data: Checkpoint[];
@@ -643,6 +859,9 @@ interface PaginatedCheckpoints {
643
859
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
644
860
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
645
861
  * item.
862
+ *
863
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
864
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
646
865
  */
647
866
  interface PaginatedCoins {
648
867
  data: CoinStruct[];
@@ -653,6 +872,9 @@ interface PaginatedCoins {
653
872
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
654
873
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
655
874
  * item.
875
+ *
876
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
877
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
656
878
  */
657
879
  interface PaginatedDynamicFieldInfos {
658
880
  data: DynamicFieldInfo[];
@@ -663,6 +885,9 @@ interface PaginatedDynamicFieldInfos {
663
885
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
664
886
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
665
887
  * item.
888
+ *
889
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
890
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
666
891
  */
667
892
  interface PaginatedEvents {
668
893
  data: SuiEvent[];
@@ -673,6 +898,9 @@ interface PaginatedEvents {
673
898
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
674
899
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
675
900
  * item.
901
+ *
902
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
903
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
676
904
  */
677
905
  interface PaginatedStrings {
678
906
  data: string[];
@@ -683,6 +911,9 @@ interface PaginatedStrings {
683
911
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
684
912
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
685
913
  * item.
914
+ *
915
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
916
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
686
917
  */
687
918
  interface PaginatedObjectsResponse {
688
919
  data: SuiObjectResponse[];
@@ -693,6 +924,9 @@ interface PaginatedObjectsResponse {
693
924
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
694
925
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
695
926
  * item.
927
+ *
928
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
929
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
696
930
  */
697
931
  interface PaginatedTransactionResponse {
698
932
  data: SuiTransactionBlockResponse[];
@@ -702,6 +936,9 @@ interface PaginatedTransactionResponse {
702
936
  /**
703
937
  * An passkey authenticator with parsed fields. See field defition below. Can be initialized from
704
938
  * [struct RawPasskeyAuthenticator].
939
+ *
940
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
941
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
705
942
  */
706
943
  interface PasskeyAuthenticator {
707
944
  /**
@@ -717,6 +954,10 @@ interface PasskeyAuthenticator {
717
954
  */
718
955
  client_data_json: string;
719
956
  }
957
+ /**
958
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
959
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
960
+ */
720
961
  interface ProtocolConfig {
721
962
  attributes: {
722
963
  [key: string]: ProtocolConfigValue | null;
@@ -728,6 +969,10 @@ interface ProtocolConfig {
728
969
  minSupportedProtocolVersion: string;
729
970
  protocolVersion: string;
730
971
  }
972
+ /**
973
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
974
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
975
+ */
731
976
  type ProtocolConfigValue = {
732
977
  u16: string;
733
978
  } | {
@@ -739,6 +984,10 @@ type ProtocolConfigValue = {
739
984
  } | {
740
985
  bool: string;
741
986
  };
987
+ /**
988
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
989
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
990
+ */
742
991
  type PublicKey = {
743
992
  Ed25519: string;
744
993
  } | {
@@ -750,11 +999,19 @@ type PublicKey = {
750
999
  } | {
751
1000
  Passkey: string;
752
1001
  };
1002
+ /**
1003
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1004
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1005
+ */
753
1006
  type RPCTransactionRequestParams = {
754
1007
  transferObjectRequestParams: TransferObjectParams;
755
1008
  } | {
756
1009
  moveCallRequestParams: MoveCallParams;
757
1010
  };
1011
+ /**
1012
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1013
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1014
+ */
758
1015
  type RawData = {
759
1016
  bcsBytes: string;
760
1017
  dataType: 'moveObject';
@@ -773,6 +1030,10 @@ type RawData = {
773
1030
  typeOriginTable: TypeOrigin[];
774
1031
  version: string;
775
1032
  };
1033
+ /**
1034
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1035
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1036
+ */
776
1037
  type Signature = {
777
1038
  Ed25519SuiSignature: string;
778
1039
  } | {
@@ -780,6 +1041,10 @@ type Signature = {
780
1041
  } | {
781
1042
  Secp256r1SuiSignature: string;
782
1043
  };
1044
+ /**
1045
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1046
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1047
+ */
783
1048
  type StakeObject = {
784
1049
  principal: string;
785
1050
  stakeActiveEpoch: string;
@@ -800,12 +1065,21 @@ type StakeObject = {
800
1065
  stakedSuiId: string;
801
1066
  status: 'Unstaked';
802
1067
  };
1068
+ /**
1069
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1070
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1071
+ */
803
1072
  interface SuiActiveJwk {
804
1073
  epoch: string;
805
1074
  jwk: SuiJWK;
806
1075
  jwk_id: SuiJwkId;
807
1076
  }
808
- /** An argument to a transaction in a programmable transaction block */
1077
+ /**
1078
+ * An argument to a transaction in a programmable transaction block
1079
+ *
1080
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1081
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1082
+ */
809
1083
  type SuiArgument = 'GasCoin' /** One of the input objects or primitive values (from `ProgrammableTransactionBlock` inputs) */ | {
810
1084
  Input: number;
811
1085
  } /** The result of another transaction (from `ProgrammableTransactionBlock` transactions) */ | {
@@ -818,9 +1092,17 @@ type SuiArgument = 'GasCoin' /** One of the input objects or primitive values (f
818
1092
  | {
819
1093
  NestedResult: [number, number];
820
1094
  };
1095
+ /**
1096
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1097
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1098
+ */
821
1099
  interface SuiAuthenticatorStateExpire {
822
1100
  min_epoch: string;
823
1101
  }
1102
+ /**
1103
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1104
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1105
+ */
824
1106
  type SuiCallArg = {
825
1107
  type: 'object';
826
1108
  digest: string;
@@ -849,6 +1131,10 @@ type SuiCallArg = {
849
1131
  typeArg: SuiWithdrawalTypeArg;
850
1132
  withdrawFrom: SuiWithdrawFrom;
851
1133
  };
1134
+ /**
1135
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1136
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1137
+ */
852
1138
  interface SuiChangeEpoch {
853
1139
  computation_charge: string;
854
1140
  epoch: string;
@@ -856,6 +1142,10 @@ interface SuiChangeEpoch {
856
1142
  storage_charge: string;
857
1143
  storage_rebate: string;
858
1144
  }
1145
+ /**
1146
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1147
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1148
+ */
859
1149
  interface CoinMetadata {
860
1150
  /** Number of decimal places the coin uses. */
861
1151
  decimals: number;
@@ -870,6 +1160,10 @@ interface CoinMetadata {
870
1160
  /** Symbol for the token */
871
1161
  symbol: string;
872
1162
  }
1163
+ /**
1164
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1165
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1166
+ */
873
1167
  type SuiEndOfEpochTransactionKind = 'AuthenticatorStateCreate' | 'RandomnessStateCreate' | 'CoinDenyListStateCreate' | 'StoreExecutionTimeObservations' | 'AccumulatorRootCreate' | 'CoinRegistryCreate' | 'DisplayRegistryCreate' | 'AddressAliasStateCreate' | 'WriteAccumulatorStorageCost' | {
874
1168
  ChangeEpoch: SuiChangeEpoch;
875
1169
  } | {
@@ -879,36 +1173,68 @@ type SuiEndOfEpochTransactionKind = 'AuthenticatorStateCreate' | 'RandomnessStat
879
1173
  } | {
880
1174
  BridgeCommitteeUpdate: string;
881
1175
  };
1176
+ /**
1177
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1178
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1179
+ */
882
1180
  interface SuiExecutionResult {
883
1181
  /** The value of any arguments that were mutably borrowed. Non-mut borrowed values are not included */
884
1182
  mutableReferenceOutputs?: [SuiArgument, number[], string][];
885
1183
  /** The return values from the transaction */
886
1184
  returnValues?: [number[], string][];
887
1185
  }
1186
+ /**
1187
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1188
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1189
+ */
888
1190
  interface SuiJWK {
889
1191
  alg: string;
890
1192
  e: string;
891
1193
  kty: string;
892
1194
  n: string;
893
1195
  }
1196
+ /**
1197
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1198
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1199
+ */
894
1200
  interface SuiJwkId {
895
1201
  iss: string;
896
1202
  kid: string;
897
1203
  }
1204
+ /**
1205
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1206
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1207
+ */
898
1208
  type SuiMoveAbility = 'Copy' | 'Drop' | 'Store' | 'Key';
1209
+ /**
1210
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1211
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1212
+ */
899
1213
  interface SuiMoveAbilitySet {
900
1214
  abilities: SuiMoveAbility[];
901
1215
  }
1216
+ /**
1217
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1218
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1219
+ */
902
1220
  interface SuiMoveAbort {
903
1221
  error_code?: string | null;
904
1222
  function?: string | null;
905
1223
  line?: number | null;
906
1224
  module_id?: string | null;
907
1225
  }
1226
+ /**
1227
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1228
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1229
+ */
908
1230
  interface SuiMoveModuleId {
909
1231
  address: string;
910
1232
  name: string;
911
1233
  }
1234
+ /**
1235
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1236
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1237
+ */
912
1238
  interface SuiMoveNormalizedEnum {
913
1239
  abilities: SuiMoveAbilitySet;
914
1240
  typeParameters: SuiMoveStructTypeParameter[];
@@ -917,10 +1243,18 @@ interface SuiMoveNormalizedEnum {
917
1243
  [key: string]: SuiMoveNormalizedField[];
918
1244
  };
919
1245
  }
1246
+ /**
1247
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1248
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1249
+ */
920
1250
  interface SuiMoveNormalizedField {
921
1251
  name: string;
922
1252
  type: SuiMoveNormalizedType;
923
1253
  }
1254
+ /**
1255
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1256
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1257
+ */
924
1258
  interface SuiMoveNormalizedFunction {
925
1259
  isEntry: boolean;
926
1260
  parameters: SuiMoveNormalizedType[];
@@ -928,6 +1262,10 @@ interface SuiMoveNormalizedFunction {
928
1262
  typeParameters: SuiMoveAbilitySet[];
929
1263
  visibility: SuiMoveVisibility;
930
1264
  }
1265
+ /**
1266
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1267
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1268
+ */
931
1269
  interface SuiMoveNormalizedModule {
932
1270
  address: string;
933
1271
  enums?: {
@@ -943,11 +1281,19 @@ interface SuiMoveNormalizedModule {
943
1281
  [key: string]: SuiMoveNormalizedStruct;
944
1282
  };
945
1283
  }
1284
+ /**
1285
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1286
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1287
+ */
946
1288
  interface SuiMoveNormalizedStruct {
947
1289
  abilities: SuiMoveAbilitySet;
948
1290
  fields: SuiMoveNormalizedField[];
949
1291
  typeParameters: SuiMoveStructTypeParameter[];
950
1292
  }
1293
+ /**
1294
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1295
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1296
+ */
951
1297
  type SuiMoveNormalizedType = 'Bool' | 'U8' | 'U16' | 'U32' | 'U64' | 'U128' | 'U256' | 'Address' | 'Signer' | {
952
1298
  Struct: {
953
1299
  address: string;
@@ -964,11 +1310,23 @@ type SuiMoveNormalizedType = 'Bool' | 'U8' | 'U16' | 'U32' | 'U64' | 'U128' | 'U
964
1310
  } | {
965
1311
  MutableReference: SuiMoveNormalizedType;
966
1312
  };
1313
+ /**
1314
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1315
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1316
+ */
967
1317
  interface SuiMoveStructTypeParameter {
968
1318
  constraints: SuiMoveAbilitySet;
969
1319
  isPhantom: boolean;
970
1320
  }
1321
+ /**
1322
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1323
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1324
+ */
971
1325
  type SuiMoveVisibility = 'Private' | 'Public' | 'Friend';
1326
+ /**
1327
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1328
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1329
+ */
972
1330
  type SuiObjectDataFilter = {
973
1331
  MatchAll: SuiObjectDataFilter[];
974
1332
  } | {
@@ -995,6 +1353,10 @@ type SuiObjectDataFilter = {
995
1353
  } | {
996
1354
  Version: string;
997
1355
  };
1356
+ /**
1357
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1358
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1359
+ */
998
1360
  interface SuiObjectResponse {
999
1361
  data?: SuiObjectData | null;
1000
1362
  error?: ObjectResponseError | null;
@@ -1002,6 +1364,9 @@ interface SuiObjectResponse {
1002
1364
  /**
1003
1365
  * The transaction for calling a Move function, either an entry function or a public function (which
1004
1366
  * cannot return references).
1367
+ *
1368
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1369
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1005
1370
  */
1006
1371
  interface MoveCallSuiTransaction {
1007
1372
  /** The arguments to the function. */
@@ -1015,6 +1380,10 @@ interface MoveCallSuiTransaction {
1015
1380
  /** The type arguments to the function. */
1016
1381
  type_arguments?: string[];
1017
1382
  }
1383
+ /**
1384
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1385
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1386
+ */
1018
1387
  type SuiReservation = {
1019
1388
  maxAmountU64: string;
1020
1389
  };
@@ -1022,6 +1391,9 @@ type SuiReservation = {
1022
1391
  * This is the JSON-RPC type for the SUI system state object. It flattens all fields to make them
1023
1392
  * top-level fields such that it as minimum dependencies to the internal data structures of the SUI
1024
1393
  * system state type.
1394
+ *
1395
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1396
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1025
1397
  */
1026
1398
  interface SuiSystemStateSummary {
1027
1399
  /** The list of active validators in the current epoch. */
@@ -1131,7 +1503,12 @@ interface SuiSystemStateSummary {
1131
1503
  */
1132
1504
  validatorVeryLowStakeThreshold: string;
1133
1505
  }
1134
- /** A single transaction in a programmable transaction block. */
1506
+ /**
1507
+ * A single transaction in a programmable transaction block.
1508
+ *
1509
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1510
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1511
+ */
1135
1512
  type SuiTransaction = /** A call to either an entry or a public Move function */{
1136
1513
  MoveCall: MoveCallSuiTransaction;
1137
1514
  }
@@ -1168,10 +1545,17 @@ type SuiTransaction = /** A call to either an entry or a public Move function */
1168
1545
  | {
1169
1546
  MakeMoveVec: [string | null, SuiArgument[]];
1170
1547
  };
1548
+ /**
1549
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1550
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1551
+ */
1171
1552
  type SuiTransactionBlockBuilderMode = 'Commit' | 'DevInspect';
1172
1553
  /**
1173
1554
  * This is the JSON-RPC type for the SUI validator. It flattens all inner structures to top-level
1174
1555
  * fields so that they are decoupled from the internal definitions.
1556
+ *
1557
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1558
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1175
1559
  */
1176
1560
  interface SuiValidatorSummary {
1177
1561
  commissionRate: string;
@@ -1225,17 +1609,37 @@ interface SuiValidatorSummary {
1225
1609
  workerAddress: string;
1226
1610
  workerPubkeyBytes: string;
1227
1611
  }
1612
+ /**
1613
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1614
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1615
+ */
1228
1616
  type SuiWithdrawFrom = 'sender' | 'sponsor';
1617
+ /**
1618
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1619
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1620
+ */
1229
1621
  type SuiWithdrawalTypeArg = {
1230
1622
  balance: string;
1231
1623
  };
1624
+ /**
1625
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1626
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1627
+ */
1232
1628
  interface CoinSupply {
1233
1629
  value: string;
1234
1630
  }
1631
+ /**
1632
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1633
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1634
+ */
1235
1635
  interface SuiTransactionBlock {
1236
1636
  data: TransactionBlockData;
1237
1637
  txSignatures: string[];
1238
1638
  }
1639
+ /**
1640
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1641
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1642
+ */
1239
1643
  interface TransactionBlockBytes {
1240
1644
  /** the gas objects to be used */
1241
1645
  gas: SuiObjectRef[];
@@ -1244,12 +1648,20 @@ interface TransactionBlockBytes {
1244
1648
  /** BCS serialized transaction data bytes without its type tag, as base-64 encoded string. */
1245
1649
  txBytes: string;
1246
1650
  }
1651
+ /**
1652
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1653
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1654
+ */
1247
1655
  type TransactionBlockData = {
1248
1656
  gasData: SuiGasData;
1249
1657
  messageVersion: 'v1';
1250
1658
  sender: string;
1251
1659
  transaction: SuiTransactionBlockKind;
1252
1660
  };
1661
+ /**
1662
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1663
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1664
+ */
1253
1665
  type TransactionEffects = /** The response from processing a transaction or a certified transaction */{
1254
1666
  /** The abort error populated if the transaction failed with an abort code. */abortError?: SuiMoveAbort | null;
1255
1667
  accumulatorEvents?: AccumulatorEvent[]; /** ObjectRef and owner of new objects created. */
@@ -1290,10 +1702,18 @@ type TransactionEffects = /** The response from processing a transaction or a ce
1290
1702
  unwrappedThenDeleted?: SuiObjectRef[]; /** Object refs of objects now wrapped in other objects. */
1291
1703
  wrapped?: SuiObjectRef[];
1292
1704
  };
1705
+ /**
1706
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1707
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1708
+ */
1293
1709
  interface TransactionBlockEffectsModifiedAtVersions {
1294
1710
  objectId: string;
1295
1711
  sequenceNumber: string;
1296
1712
  }
1713
+ /**
1714
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1715
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1716
+ */
1297
1717
  type SuiTransactionBlockKind = /** A system transaction that will update epoch information on-chain. */{
1298
1718
  computation_charge: string;
1299
1719
  epoch: string;
@@ -1362,6 +1782,10 @@ type SuiTransactionBlockKind = /** A system transaction that will update epoch i
1362
1782
  */
1363
1783
  transactions: SuiTransaction[];
1364
1784
  };
1785
+ /**
1786
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1787
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1788
+ */
1365
1789
  interface SuiTransactionBlockResponse {
1366
1790
  balanceChanges?: BalanceChange[] | null;
1367
1791
  /**
@@ -1385,6 +1809,10 @@ interface SuiTransactionBlockResponse {
1385
1809
  /** Transaction input data */
1386
1810
  transaction?: SuiTransactionBlock | null;
1387
1811
  }
1812
+ /**
1813
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1814
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1815
+ */
1388
1816
  interface SuiTransactionBlockResponseOptions {
1389
1817
  /** Whether to show balance_changes. Default to be False */
1390
1818
  showBalanceChanges?: boolean;
@@ -1401,12 +1829,20 @@ interface SuiTransactionBlockResponseOptions {
1401
1829
  /** Whether to show bcs-encoded transaction input data */
1402
1830
  showRawInput?: boolean;
1403
1831
  }
1832
+ /**
1833
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1834
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1835
+ */
1404
1836
  interface SuiTransactionBlockResponseQuery {
1405
1837
  /** If None, no filter will be applied */
1406
1838
  filter?: TransactionFilter | null;
1407
1839
  /** config which fields to include in the response, by default only digest is included */
1408
1840
  options?: SuiTransactionBlockResponseOptions | null;
1409
1841
  }
1842
+ /**
1843
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1844
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1845
+ */
1410
1846
  type TransactionFilter = /** CURRENTLY NOT SUPPORTED. Query by checkpoint. */{
1411
1847
  Checkpoint: string;
1412
1848
  } /** Query by move function. */ | {
@@ -1439,51 +1875,96 @@ type TransactionFilter = /** CURRENTLY NOT SUPPORTED. Query by checkpoint. */{
1439
1875
  } /** Query transactions of any given kind in the input. */ | {
1440
1876
  TransactionKindIn: string[];
1441
1877
  };
1878
+ /**
1879
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1880
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1881
+ */
1442
1882
  interface TransferObjectParams {
1443
1883
  objectId: string;
1444
1884
  recipient: string;
1445
1885
  }
1446
- /** Identifies a struct and the module it was defined in */
1886
+ /**
1887
+ * Identifies a struct and the module it was defined in
1888
+ *
1889
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1890
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1891
+ */
1447
1892
  interface TypeOrigin {
1448
1893
  datatype_name: string;
1449
1894
  module_name: string;
1450
1895
  package: string;
1451
1896
  }
1452
- /** Upgraded package info for the linkage table */
1897
+ /**
1898
+ * Upgraded package info for the linkage table
1899
+ *
1900
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1901
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1902
+ */
1453
1903
  interface UpgradeInfo {
1454
1904
  /** ID of the upgraded packages */
1455
1905
  upgraded_id: string;
1456
1906
  /** Version of the upgraded package */
1457
1907
  upgraded_version: string;
1458
1908
  }
1909
+ /**
1910
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1911
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1912
+ */
1459
1913
  interface ValidatorApy {
1460
1914
  address: string;
1461
1915
  apy: number;
1462
1916
  }
1917
+ /**
1918
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1919
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1920
+ */
1463
1921
  interface ValidatorsApy {
1464
1922
  apys: ValidatorApy[];
1465
1923
  epoch: string;
1466
1924
  }
1467
- /** An zk login authenticator with all the necessary fields. */
1925
+ /**
1926
+ * An zk login authenticator with all the necessary fields.
1927
+ *
1928
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1929
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1930
+ */
1468
1931
  interface ZkLoginAuthenticator {
1469
1932
  inputs: ZkLoginInputs;
1470
1933
  maxEpoch: string;
1471
1934
  userSignature: Signature;
1472
1935
  }
1473
- /** All inputs required for the zk login proof verification and other public inputs. */
1936
+ /**
1937
+ * All inputs required for the zk login proof verification and other public inputs.
1938
+ *
1939
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1940
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1941
+ */
1474
1942
  interface ZkLoginInputs {
1475
1943
  addressSeed: string;
1476
1944
  headerBase64: string;
1477
1945
  issBase64Details: Claim;
1478
1946
  proofPoints: ZkLoginProof;
1479
1947
  }
1948
+ /**
1949
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1950
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1951
+ */
1480
1952
  type ZkLoginIntentScope = 'TransactionData' | 'PersonalMessage';
1481
- /** The struct for zk login proof. */
1953
+ /**
1954
+ * The struct for zk login proof.
1955
+ *
1956
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1957
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1958
+ */
1482
1959
  interface ZkLoginProof {
1483
1960
  a: string[];
1484
1961
  b: string[][];
1485
1962
  c: string[];
1486
1963
  }
1964
+ /**
1965
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1966
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1967
+ */
1487
1968
  interface ZkLoginVerifyResult {
1488
1969
  /** The errors field captures any verification error */
1489
1970
  errors: string[];