@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
@@ -10,6 +10,10 @@
10
10
  * /crates/sui-open-rpc/spec/openrpc.json
11
11
  */
12
12
 
13
+ /**
14
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
15
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
16
+ */
13
17
  export interface AccumulatorEvent {
14
18
  accumulatorObj: string;
15
19
  address: string;
@@ -17,7 +21,15 @@ export interface AccumulatorEvent {
17
21
  ty: string;
18
22
  value: AccumulatorValue;
19
23
  }
24
+ /**
25
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
26
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
27
+ */
20
28
  export type AccumulatorOperation = 'merge' | 'split';
29
+ /**
30
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
31
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
32
+ */
21
33
  export type AccumulatorValue =
22
34
  | {
23
35
  integer: string;
@@ -28,6 +40,10 @@ export type AccumulatorValue =
28
40
  | {
29
41
  eventDigest: [string, string][];
30
42
  };
43
+ /**
44
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
45
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
46
+ */
31
47
  export interface Balance {
32
48
  coinObjectCount: number;
33
49
  coinType: string;
@@ -42,6 +58,10 @@ export interface Balance {
42
58
  };
43
59
  totalBalance: string;
44
60
  }
61
+ /**
62
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
63
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
64
+ */
45
65
  export interface BalanceChange {
46
66
  /**
47
67
  * The amount indicate the balance value changes, negative amount means spending coin value and
@@ -52,6 +72,10 @@ export interface BalanceChange {
52
72
  /** Owner of the balance change */
53
73
  owner: ObjectOwner;
54
74
  }
75
+ /**
76
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
77
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
78
+ */
55
79
  export interface Checkpoint {
56
80
  /** Commitments to checkpoint state */
57
81
  checkpointCommitments: CheckpointCommitment[];
@@ -83,6 +107,10 @@ export interface Checkpoint {
83
107
  /** Validator Signature */
84
108
  validatorSignature: string;
85
109
  }
110
+ /**
111
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
112
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
113
+ */
86
114
  export type CheckpointCommitment =
87
115
  | {
88
116
  ECMHLiveObjectSetDigest: ECMHLiveObjectSetDigest;
@@ -90,12 +118,25 @@ export type CheckpointCommitment =
90
118
  | {
91
119
  CheckpointArtifactsDigest: string;
92
120
  };
121
+ /**
122
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
123
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
124
+ */
93
125
  export type CheckpointId = string | string;
94
- /** A claim consists of value and index_mod_4. */
126
+ /**
127
+ * A claim consists of value and index_mod_4.
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
+ */
95
132
  export interface Claim {
96
133
  indexMod4: number;
97
134
  value: string;
98
135
  }
136
+ /**
137
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
138
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
139
+ */
99
140
  export interface CoinStruct {
100
141
  balance: string;
101
142
  coinObjectId: string;
@@ -104,12 +145,22 @@ export interface CoinStruct {
104
145
  previousTransaction: string;
105
146
  version: string;
106
147
  }
107
- /** RPC representation of the [Committee] type. */
148
+ /**
149
+ * RPC representation of the [Committee] type.
150
+ *
151
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
152
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
153
+ */
108
154
  export interface CommitteeInfo {
109
155
  epoch: string;
110
156
  validators: [string, string][];
111
157
  }
112
- /** Unlike [enum Signature], [enum CompressedSignature] does not contain public key. */
158
+ /**
159
+ * Unlike [enum Signature], [enum CompressedSignature] does not contain public key.
160
+ *
161
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
162
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
163
+ */
113
164
  export type CompressedSignature =
114
165
  | {
115
166
  Ed25519: string;
@@ -126,6 +177,10 @@ export type CompressedSignature =
126
177
  | {
127
178
  Passkey: string;
128
179
  };
180
+ /**
181
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
182
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
183
+ */
129
184
  export type ConsensusDeterminedVersionAssignments =
130
185
  | {
131
186
  CancelledTransactions: [string, [string, string][]][];
@@ -133,6 +188,10 @@ export type ConsensusDeterminedVersionAssignments =
133
188
  | {
134
189
  CancelledTransactionsV2: [string, [[string, string], string][]][];
135
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
+ */
136
195
  export type SuiParsedData =
137
196
  | {
138
197
  dataType: 'moveObject';
@@ -146,6 +205,10 @@ export type SuiParsedData =
146
205
  [key: string]: unknown;
147
206
  };
148
207
  };
208
+ /**
209
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
210
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
211
+ */
149
212
  export interface DelegatedStake {
150
213
  stakes: StakeObject[];
151
214
  /** Staking pool object id. */
@@ -153,7 +216,12 @@ export interface DelegatedStake {
153
216
  /** Validator's Address. */
154
217
  validatorAddress: string;
155
218
  }
156
- /** Additional rguments supplied to dev inspect beyond what is allowed in today's API. */
219
+ /**
220
+ * Additional rguments supplied to dev inspect beyond what is allowed in today's API.
221
+ *
222
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
223
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
224
+ */
157
225
  export interface DevInspectArgs {
158
226
  /** The gas budget for the transaction. */
159
227
  gasBudget?: string | null;
@@ -166,7 +234,12 @@ export interface DevInspectArgs {
166
234
  /** Whether to skip transaction checks for the transaction. */
167
235
  skipChecks?: boolean | null;
168
236
  }
169
- /** The response from processing a dev inspect transaction */
237
+ /**
238
+ * The response from processing a dev inspect transaction
239
+ *
240
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
241
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
242
+ */
170
243
  export interface DevInspectResults {
171
244
  /**
172
245
  * Summary of effects that likely would be generated if the transaction is actually run. Note however,
@@ -185,12 +258,20 @@ export interface DevInspectResults {
185
258
  /** Execution results (including return values) from executing the transactions */
186
259
  results?: SuiExecutionResult[] | null;
187
260
  }
261
+ /**
262
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
263
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
264
+ */
188
265
  export interface DisplayFieldsResponse {
189
266
  data?: {
190
267
  [key: string]: unknown;
191
268
  } | null;
192
269
  error?: ObjectResponseError | null;
193
270
  }
271
+ /**
272
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
273
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
274
+ */
194
275
  export interface DryRunTransactionBlockResponse {
195
276
  balanceChanges: BalanceChange[];
196
277
  effects: TransactionEffects;
@@ -200,6 +281,10 @@ export interface DryRunTransactionBlockResponse {
200
281
  objectChanges: SuiObjectChange[];
201
282
  suggestedGasPrice?: string | null;
202
283
  }
284
+ /**
285
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
286
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
287
+ */
203
288
  export type DynamicFieldInfo =
204
289
  | {
205
290
  digest: string;
@@ -221,15 +306,32 @@ export type DynamicFieldInfo =
221
306
  bcsEncoding: 'base58';
222
307
  bcsName: string;
223
308
  };
309
+ /**
310
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
311
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
312
+ */
224
313
  export interface DynamicFieldName {
225
314
  type: string;
226
315
  value: unknown;
227
316
  }
317
+ /**
318
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
319
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
320
+ */
228
321
  export type DynamicFieldType = 'DynamicField' | 'DynamicObject';
229
- /** The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set. */
322
+ /**
323
+ * The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set.
324
+ *
325
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
326
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
327
+ */
230
328
  export interface ECMHLiveObjectSetDigest {
231
329
  digest: number[];
232
330
  }
331
+ /**
332
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
333
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
334
+ */
233
335
  export interface EndOfEpochData {
234
336
  /** Commitments to epoch specific state (e.g. live object set) */
235
337
  epochCommitments: CheckpointCommitment[];
@@ -248,6 +350,10 @@ export interface EndOfEpochData {
248
350
  */
249
351
  nextEpochProtocolVersion: string;
250
352
  }
353
+ /**
354
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
355
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
356
+ */
251
357
  export type SuiEvent =
252
358
  | {
253
359
  /**
@@ -293,6 +399,10 @@ export type SuiEvent =
293
399
  bcs: string;
294
400
  bcsEncoding: 'base58';
295
401
  };
402
+ /**
403
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
404
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
405
+ */
296
406
  export type SuiEventFilter =
297
407
  /** Return all events. */
298
408
  | {
@@ -345,12 +455,25 @@ export type SuiEventFilter =
345
455
  startTime: string;
346
456
  };
347
457
  };
348
- /** Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number. */
458
+ /**
459
+ * Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number.
460
+ *
461
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
462
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
463
+ */
349
464
  export interface EventId {
350
465
  eventSeq: string;
351
466
  txDigest: string;
352
467
  }
468
+ /**
469
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
470
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
471
+ */
353
472
  export type ExecuteTransactionRequestType = 'WaitForEffectsCert' | 'WaitForLocalExecution';
473
+ /**
474
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
475
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
476
+ */
354
477
  export type ExecutionStatus = {
355
478
  status: 'success' | 'failure';
356
479
  error?: string;
@@ -373,6 +496,9 @@ export type ExecutionStatus = {
373
496
  * objects added up to a pool of "potential rebate". This rebate then is reduced by the "nonrefundable
374
497
  * rate" such that:
375
498
  * `potential_rebate(storage cost of deleted/mutated objects) = storage_rebate + non_refundable_storage_fee`
499
+ *
500
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
501
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
376
502
  */
377
503
  export interface GasCostSummary {
378
504
  /** Cost of computation/execution */
@@ -387,18 +513,30 @@ export interface GasCostSummary {
387
513
  */
388
514
  storageRebate: string;
389
515
  }
516
+ /**
517
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
518
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
519
+ */
390
520
  export interface SuiGasData {
391
521
  budget: string;
392
522
  owner: string;
393
523
  payment: SuiObjectRef[];
394
524
  price: string;
395
525
  }
526
+ /**
527
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
528
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
529
+ */
396
530
  export interface GetPastObjectRequest {
397
531
  /** the ID of the queried object */
398
532
  objectId: string;
399
533
  /** the version of the queried object. */
400
534
  version: string;
401
535
  }
536
+ /**
537
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
538
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
539
+ */
402
540
  export type InputObjectKind =
403
541
  | {
404
542
  MovePackage: string;
@@ -413,6 +551,10 @@ export type InputObjectKind =
413
551
  mutable?: boolean;
414
552
  };
415
553
  };
554
+ /**
555
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
556
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
557
+ */
416
558
  export interface MoveCallParams {
417
559
  arguments: unknown[];
418
560
  function: string;
@@ -420,11 +562,19 @@ export interface MoveCallParams {
420
562
  packageObjectId: string;
421
563
  typeArguments?: string[];
422
564
  }
565
+ /**
566
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
567
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
568
+ */
423
569
  export type SuiMoveFunctionArgType =
424
570
  | 'Pure'
425
571
  | {
426
572
  Object: ObjectValueKind;
427
573
  };
574
+ /**
575
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
576
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
577
+ */
428
578
  export type MoveStruct =
429
579
  | MoveValue[]
430
580
  | {
@@ -436,6 +586,10 @@ export type MoveStruct =
436
586
  | {
437
587
  [key: string]: MoveValue;
438
588
  };
589
+ /**
590
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
591
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
592
+ */
439
593
  export type MoveValue =
440
594
  | number
441
595
  | boolean
@@ -448,6 +602,10 @@ export type MoveValue =
448
602
  | MoveStruct
449
603
  | null
450
604
  | MoveVariant;
605
+ /**
606
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
607
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
608
+ */
451
609
  export interface MoveVariant {
452
610
  fields: {
453
611
  [key: string]: MoveValue;
@@ -455,7 +613,12 @@ export interface MoveVariant {
455
613
  type: string;
456
614
  variant: string;
457
615
  }
458
- /** The struct that contains signatures and public keys necessary for authenticating a MultiSig. */
616
+ /**
617
+ * The struct that contains signatures and public keys necessary for authenticating a MultiSig.
618
+ *
619
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
620
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
621
+ */
459
622
  export interface MultiSig {
460
623
  /** A bitmap that indicates the position of which public key the signature should be authenticated with. */
461
624
  bitmap: number;
@@ -470,6 +633,9 @@ export interface MultiSig {
470
633
  /**
471
634
  * Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys
472
635
  * necessary for authenticating a MultiSigLegacy.
636
+ *
637
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
638
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
473
639
  */
474
640
  export interface MultiSigLegacy {
475
641
  /** A bitmap that indicates the position of which public key the signature should be authenticated with. */
@@ -482,7 +648,12 @@ export interface MultiSigLegacy {
482
648
  /** The plain signature encoded with signature scheme. */
483
649
  sigs: CompressedSignature[];
484
650
  }
485
- /** The struct that contains the public key used for authenticating a MultiSig. */
651
+ /**
652
+ * The struct that contains the public key used for authenticating a MultiSig.
653
+ *
654
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
655
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
656
+ */
486
657
  export interface MultiSigPublicKey {
487
658
  /** A list of public key and its corresponding weight. */
488
659
  pk_map: [PublicKey, number][];
@@ -495,6 +666,9 @@ export interface MultiSigPublicKey {
495
666
  /**
496
667
  * Deprecated, use [struct MultiSigPublicKey] instead. The struct that contains the public key used for
497
668
  * authenticating a MultiSig.
669
+ *
670
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
671
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
498
672
  */
499
673
  export interface MultiSigPublicKeyLegacy {
500
674
  /** A list of public key and its corresponding weight. */
@@ -508,6 +682,9 @@ export interface MultiSigPublicKeyLegacy {
508
682
  /**
509
683
  * ObjectChange are derived from the object mutations in the TransactionEffect to provide richer object
510
684
  * information.
685
+ *
686
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
687
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
511
688
  */
512
689
  export type SuiObjectChange =
513
690
  /** Module published */
@@ -560,6 +737,10 @@ export type SuiObjectChange =
560
737
  type: 'created';
561
738
  version: string;
562
739
  };
740
+ /**
741
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
742
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
743
+ */
563
744
  export interface SuiObjectData {
564
745
  /**
565
746
  * Move object content or package content in BCS, default to be None unless
@@ -597,6 +778,10 @@ export interface SuiObjectData {
597
778
  /** Object version. */
598
779
  version: string;
599
780
  }
781
+ /**
782
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
783
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
784
+ */
600
785
  export interface SuiObjectDataOptions {
601
786
  /** Whether to show the content in BCS format. Default to be False */
602
787
  showBcs?: boolean;
@@ -616,6 +801,10 @@ export interface SuiObjectDataOptions {
616
801
  /** Whether to show the type of the object. Default to be False */
617
802
  showType?: boolean;
618
803
  }
804
+ /**
805
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
806
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
807
+ */
619
808
  export type ObjectRead =
620
809
  /** The object exists and is found with this version */
621
810
  | {
@@ -642,6 +831,10 @@ export type ObjectRead =
642
831
  };
643
832
  status: 'VersionTooHigh';
644
833
  };
834
+ /**
835
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
836
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
837
+ */
645
838
  export interface SuiObjectRef {
646
839
  /** Base64 string representing the object digest */
647
840
  digest: string;
@@ -650,6 +843,10 @@ export interface SuiObjectRef {
650
843
  /** Object version. */
651
844
  version: string;
652
845
  }
846
+ /**
847
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
848
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
849
+ */
653
850
  export type ObjectResponseError =
654
851
  | {
655
852
  code: 'notExists';
@@ -674,17 +871,33 @@ export type ObjectResponseError =
674
871
  code: 'displayError';
675
872
  error: string;
676
873
  };
874
+ /**
875
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
876
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
877
+ */
677
878
  export interface SuiObjectResponseQuery {
678
879
  /** If None, no filter will be applied */
679
880
  filter?: SuiObjectDataFilter | null;
680
881
  /** config which fields to include in the response, by default only digest is included */
681
882
  options?: SuiObjectDataOptions | null;
682
883
  }
884
+ /**
885
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
886
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
887
+ */
683
888
  export type ObjectValueKind = 'ByImmutableReference' | 'ByMutableReference' | 'ByValue';
889
+ /**
890
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
891
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
892
+ */
684
893
  export interface OwnedObjectRef {
685
894
  owner: ObjectOwner;
686
895
  reference: SuiObjectRef;
687
896
  }
897
+ /**
898
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
899
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
900
+ */
688
901
  export type ObjectOwner =
689
902
  /** Object is exclusively owned by a single address, and is mutable. */
690
903
  | {
@@ -717,6 +930,9 @@ export type ObjectOwner =
717
930
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
718
931
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
719
932
  * item.
933
+ *
934
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
935
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
720
936
  */
721
937
  export interface PaginatedCheckpoints {
722
938
  data: Checkpoint[];
@@ -727,6 +943,9 @@ export interface PaginatedCheckpoints {
727
943
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
728
944
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
729
945
  * item.
946
+ *
947
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
948
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
730
949
  */
731
950
  export interface PaginatedCoins {
732
951
  data: CoinStruct[];
@@ -737,6 +956,9 @@ export interface PaginatedCoins {
737
956
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
738
957
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
739
958
  * item.
959
+ *
960
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
961
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
740
962
  */
741
963
  export interface PaginatedDynamicFieldInfos {
742
964
  data: DynamicFieldInfo[];
@@ -747,6 +969,9 @@ export interface PaginatedDynamicFieldInfos {
747
969
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
748
970
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
749
971
  * item.
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.
750
975
  */
751
976
  export interface PaginatedEvents {
752
977
  data: SuiEvent[];
@@ -757,6 +982,9 @@ export interface PaginatedEvents {
757
982
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
758
983
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
759
984
  * item.
985
+ *
986
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
987
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
760
988
  */
761
989
  export interface PaginatedStrings {
762
990
  data: string[];
@@ -767,6 +995,9 @@ export interface PaginatedStrings {
767
995
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
768
996
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
769
997
  * item.
998
+ *
999
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1000
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
770
1001
  */
771
1002
  export interface PaginatedObjectsResponse {
772
1003
  data: SuiObjectResponse[];
@@ -777,6 +1008,9 @@ export interface PaginatedObjectsResponse {
777
1008
  * `next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the
778
1009
  * next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first
779
1010
  * item.
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.
780
1014
  */
781
1015
  export interface PaginatedTransactionResponse {
782
1016
  data: SuiTransactionBlockResponse[];
@@ -786,6 +1020,9 @@ export interface PaginatedTransactionResponse {
786
1020
  /**
787
1021
  * An passkey authenticator with parsed fields. See field defition below. Can be initialized from
788
1022
  * [struct RawPasskeyAuthenticator].
1023
+ *
1024
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1025
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
789
1026
  */
790
1027
  export interface PasskeyAuthenticator {
791
1028
  /**
@@ -801,6 +1038,10 @@ export interface PasskeyAuthenticator {
801
1038
  */
802
1039
  client_data_json: string;
803
1040
  }
1041
+ /**
1042
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1043
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1044
+ */
804
1045
  export interface ProtocolConfig {
805
1046
  attributes: {
806
1047
  [key: string]: ProtocolConfigValue | null;
@@ -812,6 +1053,10 @@ export interface ProtocolConfig {
812
1053
  minSupportedProtocolVersion: string;
813
1054
  protocolVersion: string;
814
1055
  }
1056
+ /**
1057
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1058
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1059
+ */
815
1060
  export type ProtocolConfigValue =
816
1061
  | {
817
1062
  u16: string;
@@ -828,6 +1073,10 @@ export type ProtocolConfigValue =
828
1073
  | {
829
1074
  bool: string;
830
1075
  };
1076
+ /**
1077
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1078
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1079
+ */
831
1080
  export type PublicKey =
832
1081
  | {
833
1082
  Ed25519: string;
@@ -844,6 +1093,10 @@ export type PublicKey =
844
1093
  | {
845
1094
  Passkey: string;
846
1095
  };
1096
+ /**
1097
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1098
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1099
+ */
847
1100
  export type RPCTransactionRequestParams =
848
1101
  | {
849
1102
  transferObjectRequestParams: TransferObjectParams;
@@ -851,6 +1104,10 @@ export type RPCTransactionRequestParams =
851
1104
  | {
852
1105
  moveCallRequestParams: MoveCallParams;
853
1106
  };
1107
+ /**
1108
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1109
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1110
+ */
854
1111
  export type RawData =
855
1112
  | {
856
1113
  bcsBytes: string;
@@ -871,6 +1128,10 @@ export type RawData =
871
1128
  typeOriginTable: TypeOrigin[];
872
1129
  version: string;
873
1130
  };
1131
+ /**
1132
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1133
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1134
+ */
874
1135
  export type Signature =
875
1136
  | {
876
1137
  Ed25519SuiSignature: string;
@@ -881,6 +1142,10 @@ export type Signature =
881
1142
  | {
882
1143
  Secp256r1SuiSignature: string;
883
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
+ */
884
1149
  export type StakeObject =
885
1150
  | {
886
1151
  principal: string;
@@ -907,12 +1172,21 @@ export type StakeObject =
907
1172
  stakedSuiId: string;
908
1173
  status: 'Unstaked';
909
1174
  };
1175
+ /**
1176
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1177
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1178
+ */
910
1179
  export interface SuiActiveJwk {
911
1180
  epoch: string;
912
1181
  jwk: SuiJWK;
913
1182
  jwk_id: SuiJwkId;
914
1183
  }
915
- /** An argument to a transaction in a programmable transaction block */
1184
+ /**
1185
+ * An argument to a transaction in a programmable transaction block
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
+ */
916
1190
  export type SuiArgument =
917
1191
  | 'GasCoin' /** One of the input objects or primitive values (from `ProgrammableTransactionBlock` inputs) */
918
1192
  | {
@@ -927,9 +1201,17 @@ export type SuiArgument =
927
1201
  | {
928
1202
  NestedResult: [number, number];
929
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
+ */
930
1208
  export interface SuiAuthenticatorStateExpire {
931
1209
  min_epoch: string;
932
1210
  }
1211
+ /**
1212
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1213
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1214
+ */
933
1215
  export type SuiCallArg =
934
1216
  | {
935
1217
  type: 'object';
@@ -963,6 +1245,10 @@ export type SuiCallArg =
963
1245
  typeArg: SuiWithdrawalTypeArg;
964
1246
  withdrawFrom: SuiWithdrawFrom;
965
1247
  };
1248
+ /**
1249
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1250
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1251
+ */
966
1252
  export interface SuiChangeEpoch {
967
1253
  computation_charge: string;
968
1254
  epoch: string;
@@ -970,6 +1256,10 @@ export interface SuiChangeEpoch {
970
1256
  storage_charge: string;
971
1257
  storage_rebate: string;
972
1258
  }
1259
+ /**
1260
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1261
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1262
+ */
973
1263
  export interface CoinMetadata {
974
1264
  /** Number of decimal places the coin uses. */
975
1265
  decimals: number;
@@ -984,6 +1274,10 @@ export interface CoinMetadata {
984
1274
  /** Symbol for the token */
985
1275
  symbol: string;
986
1276
  }
1277
+ /**
1278
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1279
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1280
+ */
987
1281
  export type SuiEndOfEpochTransactionKind =
988
1282
  | 'AuthenticatorStateCreate'
989
1283
  | 'RandomnessStateCreate'
@@ -1006,36 +1300,68 @@ export type SuiEndOfEpochTransactionKind =
1006
1300
  | {
1007
1301
  BridgeCommitteeUpdate: string;
1008
1302
  };
1303
+ /**
1304
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1305
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1306
+ */
1009
1307
  export interface SuiExecutionResult {
1010
1308
  /** The value of any arguments that were mutably borrowed. Non-mut borrowed values are not included */
1011
1309
  mutableReferenceOutputs?: [SuiArgument, number[], string][];
1012
1310
  /** The return values from the transaction */
1013
1311
  returnValues?: [number[], string][];
1014
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
+ */
1015
1317
  export interface SuiJWK {
1016
1318
  alg: string;
1017
1319
  e: string;
1018
1320
  kty: string;
1019
1321
  n: string;
1020
1322
  }
1323
+ /**
1324
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1325
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1326
+ */
1021
1327
  export interface SuiJwkId {
1022
1328
  iss: string;
1023
1329
  kid: string;
1024
1330
  }
1331
+ /**
1332
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1333
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1334
+ */
1025
1335
  export type SuiMoveAbility = 'Copy' | 'Drop' | 'Store' | 'Key';
1336
+ /**
1337
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1338
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1339
+ */
1026
1340
  export interface SuiMoveAbilitySet {
1027
1341
  abilities: SuiMoveAbility[];
1028
1342
  }
1343
+ /**
1344
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1345
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1346
+ */
1029
1347
  export interface SuiMoveAbort {
1030
1348
  error_code?: string | null;
1031
1349
  function?: string | null;
1032
1350
  line?: number | null;
1033
1351
  module_id?: string | null;
1034
1352
  }
1353
+ /**
1354
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1355
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1356
+ */
1035
1357
  export interface SuiMoveModuleId {
1036
1358
  address: string;
1037
1359
  name: string;
1038
1360
  }
1361
+ /**
1362
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1363
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1364
+ */
1039
1365
  export interface SuiMoveNormalizedEnum {
1040
1366
  abilities: SuiMoveAbilitySet;
1041
1367
  typeParameters: SuiMoveStructTypeParameter[];
@@ -1044,10 +1370,18 @@ export interface SuiMoveNormalizedEnum {
1044
1370
  [key: string]: SuiMoveNormalizedField[];
1045
1371
  };
1046
1372
  }
1373
+ /**
1374
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1375
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1376
+ */
1047
1377
  export interface SuiMoveNormalizedField {
1048
1378
  name: string;
1049
1379
  type: SuiMoveNormalizedType;
1050
1380
  }
1381
+ /**
1382
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1383
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1384
+ */
1051
1385
  export interface SuiMoveNormalizedFunction {
1052
1386
  isEntry: boolean;
1053
1387
  parameters: SuiMoveNormalizedType[];
@@ -1055,6 +1389,10 @@ export interface SuiMoveNormalizedFunction {
1055
1389
  typeParameters: SuiMoveAbilitySet[];
1056
1390
  visibility: SuiMoveVisibility;
1057
1391
  }
1392
+ /**
1393
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1394
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1395
+ */
1058
1396
  export interface SuiMoveNormalizedModule {
1059
1397
  address: string;
1060
1398
  enums?: {
@@ -1070,11 +1408,19 @@ export interface SuiMoveNormalizedModule {
1070
1408
  [key: string]: SuiMoveNormalizedStruct;
1071
1409
  };
1072
1410
  }
1411
+ /**
1412
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1413
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1414
+ */
1073
1415
  export interface SuiMoveNormalizedStruct {
1074
1416
  abilities: SuiMoveAbilitySet;
1075
1417
  fields: SuiMoveNormalizedField[];
1076
1418
  typeParameters: SuiMoveStructTypeParameter[];
1077
1419
  }
1420
+ /**
1421
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1422
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1423
+ */
1078
1424
  export type SuiMoveNormalizedType =
1079
1425
  | 'Bool'
1080
1426
  | 'U8'
@@ -1105,11 +1451,23 @@ export type SuiMoveNormalizedType =
1105
1451
  | {
1106
1452
  MutableReference: SuiMoveNormalizedType;
1107
1453
  };
1454
+ /**
1455
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1456
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1457
+ */
1108
1458
  export interface SuiMoveStructTypeParameter {
1109
1459
  constraints: SuiMoveAbilitySet;
1110
1460
  isPhantom: boolean;
1111
1461
  }
1462
+ /**
1463
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1464
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1465
+ */
1112
1466
  export type SuiMoveVisibility = 'Private' | 'Public' | 'Friend';
1467
+ /**
1468
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1469
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1470
+ */
1113
1471
  export type SuiObjectDataFilter =
1114
1472
  | {
1115
1473
  MatchAll: SuiObjectDataFilter[];
@@ -1149,6 +1507,10 @@ export type SuiObjectDataFilter =
1149
1507
  | {
1150
1508
  Version: string;
1151
1509
  };
1510
+ /**
1511
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1512
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1513
+ */
1152
1514
  export interface SuiObjectResponse {
1153
1515
  data?: SuiObjectData | null;
1154
1516
  error?: ObjectResponseError | null;
@@ -1156,6 +1518,9 @@ export interface SuiObjectResponse {
1156
1518
  /**
1157
1519
  * The transaction for calling a Move function, either an entry function or a public function (which
1158
1520
  * cannot return references).
1521
+ *
1522
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1523
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1159
1524
  */
1160
1525
  export interface MoveCallSuiTransaction {
1161
1526
  /** The arguments to the function. */
@@ -1169,6 +1534,10 @@ export interface MoveCallSuiTransaction {
1169
1534
  /** The type arguments to the function. */
1170
1535
  type_arguments?: string[];
1171
1536
  }
1537
+ /**
1538
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1539
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1540
+ */
1172
1541
  export type SuiReservation = {
1173
1542
  maxAmountU64: string;
1174
1543
  };
@@ -1176,6 +1545,9 @@ export type SuiReservation = {
1176
1545
  * This is the JSON-RPC type for the SUI system state object. It flattens all fields to make them
1177
1546
  * top-level fields such that it as minimum dependencies to the internal data structures of the SUI
1178
1547
  * system state type.
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.
1179
1551
  */
1180
1552
  export interface SuiSystemStateSummary {
1181
1553
  /** The list of active validators in the current epoch. */
@@ -1285,7 +1657,12 @@ export interface SuiSystemStateSummary {
1285
1657
  */
1286
1658
  validatorVeryLowStakeThreshold: string;
1287
1659
  }
1288
- /** A single transaction in a programmable transaction block. */
1660
+ /**
1661
+ * A single transaction in a programmable transaction block.
1662
+ *
1663
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1664
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1665
+ */
1289
1666
  export type SuiTransaction =
1290
1667
  /** A call to either an entry or a public Move function */
1291
1668
  | {
@@ -1322,10 +1699,17 @@ export type SuiTransaction =
1322
1699
  | {
1323
1700
  MakeMoveVec: [string | null, SuiArgument[]];
1324
1701
  };
1702
+ /**
1703
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1704
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1705
+ */
1325
1706
  export type SuiTransactionBlockBuilderMode = 'Commit' | 'DevInspect';
1326
1707
  /**
1327
1708
  * This is the JSON-RPC type for the SUI validator. It flattens all inner structures to top-level
1328
1709
  * fields so that they are decoupled from the internal definitions.
1710
+ *
1711
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1712
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1329
1713
  */
1330
1714
  export interface SuiValidatorSummary {
1331
1715
  commissionRate: string;
@@ -1379,17 +1763,37 @@ export interface SuiValidatorSummary {
1379
1763
  workerAddress: string;
1380
1764
  workerPubkeyBytes: string;
1381
1765
  }
1766
+ /**
1767
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1768
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1769
+ */
1382
1770
  export type SuiWithdrawFrom = 'sender' | 'sponsor';
1771
+ /**
1772
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1773
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1774
+ */
1383
1775
  export type SuiWithdrawalTypeArg = {
1384
1776
  balance: string;
1385
1777
  };
1778
+ /**
1779
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1780
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1781
+ */
1386
1782
  export interface CoinSupply {
1387
1783
  value: string;
1388
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
+ */
1389
1789
  export interface SuiTransactionBlock {
1390
1790
  data: TransactionBlockData;
1391
1791
  txSignatures: string[];
1392
1792
  }
1793
+ /**
1794
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1795
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1796
+ */
1393
1797
  export interface TransactionBlockBytes {
1394
1798
  /** the gas objects to be used */
1395
1799
  gas: SuiObjectRef[];
@@ -1398,12 +1802,20 @@ export interface TransactionBlockBytes {
1398
1802
  /** BCS serialized transaction data bytes without its type tag, as base-64 encoded string. */
1399
1803
  txBytes: string;
1400
1804
  }
1805
+ /**
1806
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1807
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1808
+ */
1401
1809
  export type TransactionBlockData = {
1402
1810
  gasData: SuiGasData;
1403
1811
  messageVersion: 'v1';
1404
1812
  sender: string;
1405
1813
  transaction: SuiTransactionBlockKind;
1406
1814
  };
1815
+ /**
1816
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1817
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1818
+ */
1407
1819
  export type TransactionEffects =
1408
1820
  /** The response from processing a transaction or a certified transaction */
1409
1821
  {
@@ -1456,10 +1868,18 @@ export type TransactionEffects =
1456
1868
  /** Object refs of objects now wrapped in other objects. */
1457
1869
  wrapped?: SuiObjectRef[];
1458
1870
  };
1871
+ /**
1872
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1873
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1874
+ */
1459
1875
  export interface TransactionBlockEffectsModifiedAtVersions {
1460
1876
  objectId: string;
1461
1877
  sequenceNumber: string;
1462
1878
  }
1879
+ /**
1880
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1881
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1882
+ */
1463
1883
  export type SuiTransactionBlockKind =
1464
1884
  /** A system transaction that will update epoch information on-chain. */
1465
1885
  | {
@@ -1542,6 +1962,10 @@ export type SuiTransactionBlockKind =
1542
1962
  */
1543
1963
  transactions: SuiTransaction[];
1544
1964
  };
1965
+ /**
1966
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1967
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1968
+ */
1545
1969
  export interface SuiTransactionBlockResponse {
1546
1970
  balanceChanges?: BalanceChange[] | null;
1547
1971
  /**
@@ -1565,6 +1989,10 @@ export interface SuiTransactionBlockResponse {
1565
1989
  /** Transaction input data */
1566
1990
  transaction?: SuiTransactionBlock | null;
1567
1991
  }
1992
+ /**
1993
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
1994
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
1995
+ */
1568
1996
  export interface SuiTransactionBlockResponseOptions {
1569
1997
  /** Whether to show balance_changes. Default to be False */
1570
1998
  showBalanceChanges?: boolean;
@@ -1581,12 +2009,20 @@ export interface SuiTransactionBlockResponseOptions {
1581
2009
  /** Whether to show bcs-encoded transaction input data */
1582
2010
  showRawInput?: boolean;
1583
2011
  }
2012
+ /**
2013
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2014
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2015
+ */
1584
2016
  export interface SuiTransactionBlockResponseQuery {
1585
2017
  /** If None, no filter will be applied */
1586
2018
  filter?: TransactionFilter | null;
1587
2019
  /** config which fields to include in the response, by default only digest is included */
1588
2020
  options?: SuiTransactionBlockResponseOptions | null;
1589
2021
  }
2022
+ /**
2023
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2024
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2025
+ */
1590
2026
  export type TransactionFilter =
1591
2027
  /** CURRENTLY NOT SUPPORTED. Query by checkpoint. */
1592
2028
  | {
@@ -1631,51 +2067,96 @@ export type TransactionFilter =
1631
2067
  | {
1632
2068
  TransactionKindIn: string[];
1633
2069
  };
2070
+ /**
2071
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2072
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2073
+ */
1634
2074
  export interface TransferObjectParams {
1635
2075
  objectId: string;
1636
2076
  recipient: string;
1637
2077
  }
1638
- /** Identifies a struct and the module it was defined in */
2078
+ /**
2079
+ * Identifies a struct and the module it was defined in
2080
+ *
2081
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2082
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2083
+ */
1639
2084
  export interface TypeOrigin {
1640
2085
  datatype_name: string;
1641
2086
  module_name: string;
1642
2087
  package: string;
1643
2088
  }
1644
- /** Upgraded package info for the linkage table */
2089
+ /**
2090
+ * Upgraded package info for the linkage table
2091
+ *
2092
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2093
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2094
+ */
1645
2095
  export interface UpgradeInfo {
1646
2096
  /** ID of the upgraded packages */
1647
2097
  upgraded_id: string;
1648
2098
  /** Version of the upgraded package */
1649
2099
  upgraded_version: string;
1650
2100
  }
2101
+ /**
2102
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2103
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2104
+ */
1651
2105
  export interface ValidatorApy {
1652
2106
  address: string;
1653
2107
  apy: number;
1654
2108
  }
2109
+ /**
2110
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2111
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2112
+ */
1655
2113
  export interface ValidatorsApy {
1656
2114
  apys: ValidatorApy[];
1657
2115
  epoch: string;
1658
2116
  }
1659
- /** An zk login authenticator with all the necessary fields. */
2117
+ /**
2118
+ * An zk login authenticator with all the necessary fields.
2119
+ *
2120
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2121
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2122
+ */
1660
2123
  export interface ZkLoginAuthenticator {
1661
2124
  inputs: ZkLoginInputs;
1662
2125
  maxEpoch: string;
1663
2126
  userSignature: Signature;
1664
2127
  }
1665
- /** All inputs required for the zk login proof verification and other public inputs. */
2128
+ /**
2129
+ * All inputs required for the zk login proof verification and other public inputs.
2130
+ *
2131
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2132
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2133
+ */
1666
2134
  export interface ZkLoginInputs {
1667
2135
  addressSeed: string;
1668
2136
  headerBase64: string;
1669
2137
  issBase64Details: Claim;
1670
2138
  proofPoints: ZkLoginProof;
1671
2139
  }
2140
+ /**
2141
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2142
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2143
+ */
1672
2144
  export type ZkLoginIntentScope = 'TransactionData' | 'PersonalMessage';
1673
- /** The struct for zk login proof. */
2145
+ /**
2146
+ * The struct for zk login proof.
2147
+ *
2148
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2149
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2150
+ */
1674
2151
  export interface ZkLoginProof {
1675
2152
  a: string[];
1676
2153
  b: string[][];
1677
2154
  c: string[];
1678
2155
  }
2156
+ /**
2157
+ * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient` from
2158
+ * `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
2159
+ */
1679
2160
  export interface ZkLoginVerifyResult {
1680
2161
  /** The errors field captures any verification error */
1681
2162
  errors: string[];