@bitgo/sdk-coin-sui 2.0.1 → 3.0.0

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 (122) hide show
  1. package/.eslintignore +1 -0
  2. package/CHANGELOG.md +33 -0
  3. package/dist/src/lib/constants.d.ts +3 -15
  4. package/dist/src/lib/constants.d.ts.map +1 -1
  5. package/dist/src/lib/constants.js +7 -20
  6. package/dist/src/lib/iface.d.ts +35 -181
  7. package/dist/src/lib/iface.d.ts.map +1 -1
  8. package/dist/src/lib/iface.js +11 -38
  9. package/dist/src/lib/index.d.ts +2 -0
  10. package/dist/src/lib/index.d.ts.map +1 -1
  11. package/dist/src/lib/index.js +6 -2
  12. package/dist/src/lib/keyPair.d.ts +4 -0
  13. package/dist/src/lib/keyPair.d.ts.map +1 -1
  14. package/dist/src/lib/keyPair.js +7 -10
  15. package/dist/src/lib/mystenlab/builder/Inputs.d.ts +66 -0
  16. package/dist/src/lib/mystenlab/builder/Inputs.d.ts.map +1 -0
  17. package/dist/src/lib/mystenlab/builder/Inputs.js +56 -0
  18. package/dist/src/lib/mystenlab/builder/TransactionBlock.d.ts +616 -0
  19. package/dist/src/lib/mystenlab/builder/TransactionBlock.d.ts.map +1 -0
  20. package/dist/src/lib/mystenlab/builder/TransactionBlock.js +260 -0
  21. package/dist/src/lib/mystenlab/builder/TransactionDataBlock.d.ts +566 -0
  22. package/dist/src/lib/mystenlab/builder/TransactionDataBlock.d.ts.map +1 -0
  23. package/dist/src/lib/mystenlab/builder/TransactionDataBlock.js +171 -0
  24. package/dist/src/lib/mystenlab/builder/Transactions.d.ts +992 -0
  25. package/dist/src/lib/mystenlab/builder/Transactions.d.ts.map +1 -0
  26. package/dist/src/lib/mystenlab/builder/Transactions.js +119 -0
  27. package/dist/src/lib/mystenlab/builder/bcs.d.ts +25 -0
  28. package/dist/src/lib/mystenlab/builder/bcs.d.ts.map +1 -0
  29. package/dist/src/lib/mystenlab/builder/bcs.js +141 -0
  30. package/dist/src/lib/mystenlab/builder/index.d.ts +5 -0
  31. package/dist/src/lib/mystenlab/builder/index.d.ts.map +1 -0
  32. package/dist/src/lib/mystenlab/builder/index.js +17 -0
  33. package/dist/src/lib/mystenlab/builder/serializer.d.ts +4 -0
  34. package/dist/src/lib/mystenlab/builder/serializer.d.ts.map +1 -0
  35. package/dist/src/lib/mystenlab/builder/serializer.js +101 -0
  36. package/dist/src/lib/mystenlab/builder/utils.d.ts +10 -0
  37. package/dist/src/lib/mystenlab/builder/utils.d.ts.map +1 -0
  38. package/dist/src/lib/mystenlab/builder/utils.js +10 -0
  39. package/dist/src/lib/mystenlab/cryptography/hash.d.ts +8 -0
  40. package/dist/src/lib/mystenlab/cryptography/hash.d.ts.map +1 -0
  41. package/dist/src/lib/mystenlab/cryptography/hash.js +22 -0
  42. package/dist/src/lib/mystenlab/framework/framework.d.ts +93 -0
  43. package/dist/src/lib/mystenlab/framework/framework.d.ts.map +1 -0
  44. package/dist/src/lib/mystenlab/framework/framework.js +138 -0
  45. package/dist/src/lib/mystenlab/framework/index.d.ts +3 -0
  46. package/dist/src/lib/mystenlab/framework/index.d.ts.map +1 -0
  47. package/dist/src/lib/mystenlab/framework/index.js +15 -0
  48. package/dist/src/lib/mystenlab/framework/sui-system-state.d.ts +12 -0
  49. package/dist/src/lib/mystenlab/framework/sui-system-state.d.ts.map +1 -0
  50. package/dist/src/lib/mystenlab/framework/sui-system-state.js +19 -0
  51. package/dist/src/lib/mystenlab/txn-data-serializers/type-tag-serializer.d.ts +7 -0
  52. package/dist/src/lib/mystenlab/txn-data-serializers/type-tag-serializer.d.ts.map +1 -0
  53. package/dist/src/lib/mystenlab/txn-data-serializers/type-tag-serializer.js +119 -0
  54. package/dist/src/lib/mystenlab/types/coin.d.ts +89 -0
  55. package/dist/src/lib/mystenlab/types/coin.d.ts.map +1 -0
  56. package/dist/src/lib/mystenlab/types/coin.js +32 -0
  57. package/dist/src/lib/mystenlab/types/common.d.ts +45 -0
  58. package/dist/src/lib/mystenlab/types/common.d.ts.map +1 -0
  59. package/dist/src/lib/mystenlab/types/common.js +84 -0
  60. package/dist/src/lib/mystenlab/types/events.d.ts +198 -0
  61. package/dist/src/lib/mystenlab/types/events.d.ts.map +1 -0
  62. package/dist/src/lib/mystenlab/types/events.js +46 -0
  63. package/dist/src/lib/mystenlab/types/index.d.ts +9 -0
  64. package/dist/src/lib/mystenlab/types/index.d.ts.map +1 -0
  65. package/dist/src/lib/mystenlab/types/index.js +21 -0
  66. package/dist/src/lib/mystenlab/types/normalized.d.ts +254 -0
  67. package/dist/src/lib/mystenlab/types/normalized.d.ts.map +1 -0
  68. package/dist/src/lib/mystenlab/types/normalized.js +111 -0
  69. package/dist/src/lib/mystenlab/types/objects.d.ts +806 -0
  70. package/dist/src/lib/mystenlab/types/objects.d.ts.map +1 -0
  71. package/dist/src/lib/mystenlab/types/objects.js +302 -0
  72. package/dist/src/lib/mystenlab/types/option.d.ts +8 -0
  73. package/dist/src/lib/mystenlab/types/option.d.ts.map +1 -0
  74. package/dist/src/lib/mystenlab/types/option.js +14 -0
  75. package/dist/src/lib/mystenlab/types/sui-bcs.d.ts +111 -0
  76. package/dist/src/lib/mystenlab/types/sui-bcs.d.ts.map +1 -0
  77. package/dist/src/lib/mystenlab/types/sui-bcs.js +107 -0
  78. package/dist/src/lib/mystenlab/types/transactions.d.ts +6703 -0
  79. package/dist/src/lib/mystenlab/types/transactions.d.ts.map +1 -0
  80. package/dist/src/lib/mystenlab/types/transactions.js +405 -0
  81. package/dist/src/lib/mystenlab/types/validator.d.ts +641 -0
  82. package/dist/src/lib/mystenlab/types/validator.d.ts.map +1 -0
  83. package/dist/src/lib/mystenlab/types/validator.js +156 -0
  84. package/dist/src/lib/stakingBuilder.d.ts +24 -35
  85. package/dist/src/lib/stakingBuilder.d.ts.map +1 -1
  86. package/dist/src/lib/stakingBuilder.js +93 -129
  87. package/dist/src/lib/stakingTransaction.d.ts +5 -21
  88. package/dist/src/lib/stakingTransaction.d.ts.map +1 -1
  89. package/dist/src/lib/stakingTransaction.js +77 -219
  90. package/dist/src/lib/transaction.d.ts +8 -6
  91. package/dist/src/lib/transaction.d.ts.map +1 -1
  92. package/dist/src/lib/transaction.js +74 -124
  93. package/dist/src/lib/transactionBuilder.d.ts +9 -9
  94. package/dist/src/lib/transactionBuilder.d.ts.map +1 -1
  95. package/dist/src/lib/transactionBuilder.js +27 -16
  96. package/dist/src/lib/transactionBuilderFactory.d.ts +8 -5
  97. package/dist/src/lib/transactionBuilderFactory.d.ts.map +1 -1
  98. package/dist/src/lib/transactionBuilderFactory.js +17 -11
  99. package/dist/src/lib/transferBuilder.d.ts +15 -10
  100. package/dist/src/lib/transferBuilder.d.ts.map +1 -1
  101. package/dist/src/lib/transferBuilder.js +38 -101
  102. package/dist/src/lib/transferTransaction.d.ts +5 -4
  103. package/dist/src/lib/transferTransaction.d.ts.map +1 -1
  104. package/dist/src/lib/transferTransaction.js +45 -96
  105. package/dist/src/lib/unstakingBuilder.d.ts +55 -0
  106. package/dist/src/lib/unstakingBuilder.d.ts.map +1 -0
  107. package/dist/src/lib/unstakingBuilder.js +148 -0
  108. package/dist/src/lib/unstakingTransaction.d.ts +51 -0
  109. package/dist/src/lib/unstakingTransaction.d.ts.map +1 -0
  110. package/dist/src/lib/unstakingTransaction.js +206 -0
  111. package/dist/src/lib/utils.d.ts +30 -92
  112. package/dist/src/lib/utils.d.ts.map +1 -1
  113. package/dist/src/lib/utils.js +115 -177
  114. package/dist/src/sui.d.ts.map +1 -1
  115. package/dist/src/sui.js +23 -13
  116. package/package.json +9 -9
  117. package/dist/src/lib/bcs.d.ts +0 -3
  118. package/dist/src/lib/bcs.d.ts.map +0 -1
  119. package/dist/src/lib/bcs.js +0 -109
  120. package/dist/src/lib/txnSchema.d.ts +0 -7
  121. package/dist/src/lib/txnSchema.d.ts.map +0 -1
  122. package/dist/src/lib/txnSchema.js +0 -81
@@ -0,0 +1,806 @@
1
+ import { Infer } from 'superstruct';
2
+ import { ObjectId, ObjectOwner, TransactionDigest } from './common';
3
+ import { OwnedObjectRef } from './transactions';
4
+ export declare const ObjectType: import("superstruct").Struct<string, null>;
5
+ export declare type ObjectType = Infer<typeof ObjectType>;
6
+ export declare const SuiObjectRef: import("superstruct").Struct<{
7
+ objectId: string;
8
+ version: string | number;
9
+ digest: string;
10
+ }, {
11
+ /** Base64 string representing the object digest */
12
+ digest: import("superstruct").Struct<string, null>;
13
+ /** Hex code as string representing the object id */
14
+ objectId: import("superstruct").Struct<string, null>;
15
+ /** Object version */
16
+ version: import("superstruct").Struct<string | number, null>;
17
+ }>;
18
+ export declare type SuiObjectRef = Infer<typeof SuiObjectRef>;
19
+ export declare const SuiGasData: import("superstruct").Struct<{
20
+ payment: {
21
+ objectId: string;
22
+ version: string | number;
23
+ digest: string;
24
+ }[];
25
+ owner: string;
26
+ price: number;
27
+ budget: number;
28
+ }, {
29
+ payment: import("superstruct").Struct<{
30
+ objectId: string;
31
+ version: string | number;
32
+ digest: string;
33
+ }[], import("superstruct").Struct<{
34
+ objectId: string;
35
+ version: string | number;
36
+ digest: string;
37
+ }, {
38
+ /** Base64 string representing the object digest */
39
+ digest: import("superstruct").Struct<string, null>;
40
+ /** Hex code as string representing the object id */
41
+ objectId: import("superstruct").Struct<string, null>;
42
+ /** Object version */
43
+ version: import("superstruct").Struct<string | number, null>;
44
+ }>>;
45
+ /** Gas Object's owner */
46
+ owner: import("superstruct").Struct<string, null>;
47
+ price: import("superstruct").Struct<number, null>;
48
+ budget: import("superstruct").Struct<number, null>;
49
+ }>;
50
+ export declare type SuiGasData = Infer<typeof SuiGasData>;
51
+ export declare const SuiObjectInfo: import("superstruct").Struct<{
52
+ type: string;
53
+ objectId: string;
54
+ version: string | number;
55
+ digest: string;
56
+ owner: {
57
+ AddressOwner: string;
58
+ } | {
59
+ ObjectOwner: string;
60
+ } | {
61
+ Shared: {
62
+ initial_shared_version: number;
63
+ };
64
+ } | "Immutable";
65
+ previousTransaction: string;
66
+ }, {
67
+ type: import("superstruct").Struct<string, null>;
68
+ owner: import("superstruct").Struct<{
69
+ AddressOwner: string;
70
+ } | {
71
+ ObjectOwner: string;
72
+ } | {
73
+ Shared: {
74
+ initial_shared_version: number;
75
+ };
76
+ } | "Immutable", null>;
77
+ previousTransaction: import("superstruct").Struct<string, null>;
78
+ objectId: import("superstruct").Struct<string, null>;
79
+ version: import("superstruct").Struct<string | number, null>;
80
+ digest: import("superstruct").Struct<string, null>;
81
+ }>;
82
+ export declare type SuiObjectInfo = Infer<typeof SuiObjectInfo>;
83
+ export declare const ObjectContentFields: import("superstruct").Struct<Record<string, any>, null>;
84
+ export declare type ObjectContentFields = Infer<typeof ObjectContentFields>;
85
+ export declare const MovePackageContent: import("superstruct").Struct<Record<string, string>, null>;
86
+ export declare type MovePackageContent = Infer<typeof MovePackageContent>;
87
+ export declare const SuiMoveObject: import("superstruct").Struct<{
88
+ type: string;
89
+ fields: Record<string, any>;
90
+ hasPublicTransfer: boolean;
91
+ }, {
92
+ /** Move type (e.g., "0x2::coin::Coin<0x2::sui::SUI>") */
93
+ type: import("superstruct").Struct<string, null>;
94
+ /** Fields and values stored inside the Move object */
95
+ fields: import("superstruct").Struct<Record<string, any>, null>;
96
+ hasPublicTransfer: import("superstruct").Struct<boolean, null>;
97
+ }>;
98
+ export declare type SuiMoveObject = Infer<typeof SuiMoveObject>;
99
+ export declare const SuiMovePackage: import("superstruct").Struct<{
100
+ disassembled: Record<string, string>;
101
+ }, {
102
+ /** A mapping from module name to disassembled Move bytecode */
103
+ disassembled: import("superstruct").Struct<Record<string, string>, null>;
104
+ }>;
105
+ export declare type SuiMovePackage = Infer<typeof SuiMovePackage>;
106
+ export declare const SuiParsedData: import("superstruct").Struct<{
107
+ type: string;
108
+ fields: Record<string, any>;
109
+ hasPublicTransfer: boolean;
110
+ dataType: "moveObject";
111
+ } | {
112
+ disassembled: Record<string, string>;
113
+ dataType: "package";
114
+ }, null>;
115
+ export declare type SuiParsedData = Infer<typeof SuiParsedData>;
116
+ export declare const SuiRawMoveObject: import("superstruct").Struct<{
117
+ type: string;
118
+ version: number;
119
+ hasPublicTransfer: boolean;
120
+ bcsBytes: number[];
121
+ }, {
122
+ /** Move type (e.g., "0x2::coin::Coin<0x2::sui::SUI>") */
123
+ type: import("superstruct").Struct<string, null>;
124
+ hasPublicTransfer: import("superstruct").Struct<boolean, null>;
125
+ version: import("superstruct").Struct<number, null>;
126
+ bcsBytes: import("superstruct").Struct<number[], import("superstruct").Struct<number, null>>;
127
+ }>;
128
+ export declare type SuiRawMoveObject = Infer<typeof SuiRawMoveObject>;
129
+ export declare const SuiRawMovePackage: import("superstruct").Struct<{
130
+ id: string;
131
+ moduleMap: Record<string, string>;
132
+ }, {
133
+ id: import("superstruct").Struct<string, null>;
134
+ /** A mapping from module name to Move bytecode enocded in base64*/
135
+ moduleMap: import("superstruct").Struct<Record<string, string>, null>;
136
+ }>;
137
+ export declare type SuiRawMovePackage = Infer<typeof SuiRawMovePackage>;
138
+ export declare const SuiRawData: import("superstruct").Struct<{
139
+ type: string;
140
+ fields: Record<string, any>;
141
+ hasPublicTransfer: boolean;
142
+ dataType: "moveObject";
143
+ } | {
144
+ id: string;
145
+ dataType: "package";
146
+ moduleMap: Record<string, string>;
147
+ }, null>;
148
+ export declare type SuiRawData = Infer<typeof SuiRawData>;
149
+ export declare const MIST_PER_SUI: bigint;
150
+ export declare const ObjectDigest: import("superstruct").Struct<string, null>;
151
+ export declare type ObjectDigest = Infer<typeof ObjectDigest>;
152
+ export declare const SuiObjectData: import("superstruct").Struct<{
153
+ objectId: string;
154
+ version: number;
155
+ digest: string;
156
+ type?: string | undefined;
157
+ bcs?: {
158
+ type: string;
159
+ fields: Record<string, any>;
160
+ hasPublicTransfer: boolean;
161
+ dataType: "moveObject";
162
+ } | {
163
+ id: string;
164
+ dataType: "package";
165
+ moduleMap: Record<string, string>;
166
+ } | undefined;
167
+ owner?: {
168
+ AddressOwner: string;
169
+ } | {
170
+ ObjectOwner: string;
171
+ } | {
172
+ Shared: {
173
+ initial_shared_version: number;
174
+ };
175
+ } | "Immutable" | undefined;
176
+ storageRebate?: number | undefined;
177
+ previousTransaction?: string | undefined;
178
+ content?: {
179
+ type: string;
180
+ fields: Record<string, any>;
181
+ hasPublicTransfer: boolean;
182
+ dataType: "moveObject";
183
+ } | {
184
+ disassembled: Record<string, string>;
185
+ dataType: "package";
186
+ } | undefined;
187
+ display?: Record<string, string> | undefined;
188
+ }, {
189
+ objectId: import("superstruct").Struct<string, null>;
190
+ version: import("superstruct").Struct<number, null>;
191
+ digest: import("superstruct").Struct<string, null>;
192
+ /**
193
+ * Type of the object, default to be undefined unless SuiObjectDataOptions.showType is set to true
194
+ */
195
+ type: import("superstruct").Struct<string | undefined, null>;
196
+ /**
197
+ * Move object content or package content, default to be undefined unless SuiObjectDataOptions.showContent is set to true
198
+ */
199
+ content: import("superstruct").Struct<{
200
+ type: string;
201
+ fields: Record<string, any>;
202
+ hasPublicTransfer: boolean;
203
+ dataType: "moveObject";
204
+ } | {
205
+ disassembled: Record<string, string>;
206
+ dataType: "package";
207
+ } | undefined, null>;
208
+ /**
209
+ * Move object content or package content in BCS bytes, default to be undefined unless SuiObjectDataOptions.showBcs is set to true
210
+ */
211
+ bcs: import("superstruct").Struct<{
212
+ type: string;
213
+ fields: Record<string, any>;
214
+ hasPublicTransfer: boolean;
215
+ dataType: "moveObject";
216
+ } | {
217
+ id: string;
218
+ dataType: "package";
219
+ moduleMap: Record<string, string>;
220
+ } | undefined, null>;
221
+ /**
222
+ * The owner of this object. Default to be undefined unless SuiObjectDataOptions.showOwner is set to true
223
+ */
224
+ owner: import("superstruct").Struct<{
225
+ AddressOwner: string;
226
+ } | {
227
+ ObjectOwner: string;
228
+ } | {
229
+ Shared: {
230
+ initial_shared_version: number;
231
+ };
232
+ } | "Immutable" | undefined, null>;
233
+ /**
234
+ * The digest of the transaction that created or last mutated this object.
235
+ * Default to be undefined unless SuiObjectDataOptions.showPreviousTransaction is set to true
236
+ */
237
+ previousTransaction: import("superstruct").Struct<string | undefined, null>;
238
+ /**
239
+ * The amount of SUI we would rebate if this object gets deleted.
240
+ * This number is re-calculated each time the object is mutated based on
241
+ * the present storage gas price.
242
+ * Default to be undefined unless SuiObjectDataOptions.showStorageRebate is set to true
243
+ */
244
+ storageRebate: import("superstruct").Struct<number | undefined, null>;
245
+ /**
246
+ * Display metadata for this object, default to be undefined unless SuiObjectDataOptions.showDisplay is set to true
247
+ * This can also be None if the struct type does not have Display defined
248
+ * See more details in https://forums.sui.io/t/nft-object-display-proposal/4872
249
+ */
250
+ display: import("superstruct").Struct<Record<string, string> | undefined, null>;
251
+ }>;
252
+ export declare type SuiObjectData = Infer<typeof SuiObjectData>;
253
+ /**
254
+ * Config for fetching object data
255
+ */
256
+ export declare const SuiObjectDataOptions: import("superstruct").Struct<{
257
+ showType?: boolean | undefined;
258
+ showContent?: boolean | undefined;
259
+ showBcs?: boolean | undefined;
260
+ showOwner?: boolean | undefined;
261
+ showPreviousTransaction?: boolean | undefined;
262
+ showStorageRebate?: boolean | undefined;
263
+ showDisplay?: boolean | undefined;
264
+ }, {
265
+ showType: import("superstruct").Struct<boolean | undefined, null>;
266
+ showContent: import("superstruct").Struct<boolean | undefined, null>;
267
+ showBcs: import("superstruct").Struct<boolean | undefined, null>;
268
+ showOwner: import("superstruct").Struct<boolean | undefined, null>;
269
+ showPreviousTransaction: import("superstruct").Struct<boolean | undefined, null>;
270
+ showStorageRebate: import("superstruct").Struct<boolean | undefined, null>;
271
+ showDisplay: import("superstruct").Struct<boolean | undefined, null>;
272
+ }>;
273
+ export declare type SuiObjectDataOptions = Infer<typeof SuiObjectDataOptions>;
274
+ export declare const ObjectStatus: import("superstruct").Struct<"Exists" | "NotExists" | "Deleted", null>;
275
+ export declare type ObjectStatus = Infer<typeof ObjectStatus>;
276
+ export declare const GetOwnedObjectsResponse: import("superstruct").Struct<{
277
+ type: string;
278
+ objectId: string;
279
+ version: string | number;
280
+ digest: string;
281
+ owner: {
282
+ AddressOwner: string;
283
+ } | {
284
+ ObjectOwner: string;
285
+ } | {
286
+ Shared: {
287
+ initial_shared_version: number;
288
+ };
289
+ } | "Immutable";
290
+ previousTransaction: string;
291
+ }[], import("superstruct").Struct<{
292
+ type: string;
293
+ objectId: string;
294
+ version: string | number;
295
+ digest: string;
296
+ owner: {
297
+ AddressOwner: string;
298
+ } | {
299
+ ObjectOwner: string;
300
+ } | {
301
+ Shared: {
302
+ initial_shared_version: number;
303
+ };
304
+ } | "Immutable";
305
+ previousTransaction: string;
306
+ }, {
307
+ type: import("superstruct").Struct<string, null>;
308
+ owner: import("superstruct").Struct<{
309
+ AddressOwner: string;
310
+ } | {
311
+ ObjectOwner: string;
312
+ } | {
313
+ Shared: {
314
+ initial_shared_version: number;
315
+ };
316
+ } | "Immutable", null>;
317
+ previousTransaction: import("superstruct").Struct<string, null>;
318
+ objectId: import("superstruct").Struct<string, null>;
319
+ version: import("superstruct").Struct<string | number, null>;
320
+ digest: import("superstruct").Struct<string, null>;
321
+ }>>;
322
+ export declare type GetOwnedObjectsResponse = Infer<typeof GetOwnedObjectsResponse>;
323
+ export declare const SuiObjectResponseError: import("superstruct").Struct<{
324
+ tag: string;
325
+ version?: number | undefined;
326
+ digest?: string | undefined;
327
+ object_id?: string | undefined;
328
+ }, {
329
+ tag: import("superstruct").Struct<string, null>;
330
+ object_id: import("superstruct").Struct<string | undefined, null>;
331
+ version: import("superstruct").Struct<number | undefined, null>;
332
+ digest: import("superstruct").Struct<string | undefined, null>;
333
+ }>;
334
+ export declare type SuiObjectResponseError = Infer<typeof SuiObjectResponseError>;
335
+ export declare const SuiObjectResponse: import("superstruct").Struct<{
336
+ data?: {
337
+ objectId: string;
338
+ version: number;
339
+ digest: string;
340
+ type?: string | undefined;
341
+ bcs?: {
342
+ type: string;
343
+ fields: Record<string, any>;
344
+ hasPublicTransfer: boolean;
345
+ dataType: "moveObject";
346
+ } | {
347
+ id: string;
348
+ dataType: "package";
349
+ moduleMap: Record<string, string>;
350
+ } | undefined;
351
+ owner?: {
352
+ AddressOwner: string;
353
+ } | {
354
+ ObjectOwner: string;
355
+ } | {
356
+ Shared: {
357
+ initial_shared_version: number;
358
+ };
359
+ } | "Immutable" | undefined;
360
+ storageRebate?: number | undefined;
361
+ previousTransaction?: string | undefined;
362
+ content?: {
363
+ type: string;
364
+ fields: Record<string, any>;
365
+ hasPublicTransfer: boolean;
366
+ dataType: "moveObject";
367
+ } | {
368
+ disassembled: Record<string, string>;
369
+ dataType: "package";
370
+ } | undefined;
371
+ display?: Record<string, string> | undefined;
372
+ } | undefined;
373
+ error?: {
374
+ tag: string;
375
+ version?: number | undefined;
376
+ digest?: string | undefined;
377
+ object_id?: string | undefined;
378
+ } | undefined;
379
+ }, {
380
+ data: import("superstruct").Struct<{
381
+ objectId: string;
382
+ version: number;
383
+ digest: string;
384
+ type?: string | undefined;
385
+ bcs?: {
386
+ type: string;
387
+ fields: Record<string, any>;
388
+ hasPublicTransfer: boolean;
389
+ dataType: "moveObject";
390
+ } | {
391
+ id: string;
392
+ dataType: "package";
393
+ moduleMap: Record<string, string>;
394
+ } | undefined;
395
+ owner?: {
396
+ AddressOwner: string;
397
+ } | {
398
+ ObjectOwner: string;
399
+ } | {
400
+ Shared: {
401
+ initial_shared_version: number;
402
+ };
403
+ } | "Immutable" | undefined;
404
+ storageRebate?: number | undefined;
405
+ previousTransaction?: string | undefined;
406
+ content?: {
407
+ type: string;
408
+ fields: Record<string, any>;
409
+ hasPublicTransfer: boolean;
410
+ dataType: "moveObject";
411
+ } | {
412
+ disassembled: Record<string, string>;
413
+ dataType: "package";
414
+ } | undefined;
415
+ display?: Record<string, string> | undefined;
416
+ } | undefined, {
417
+ objectId: import("superstruct").Struct<string, null>;
418
+ version: import("superstruct").Struct<number, null>;
419
+ digest: import("superstruct").Struct<string, null>;
420
+ /**
421
+ * Type of the object, default to be undefined unless SuiObjectDataOptions.showType is set to true
422
+ */
423
+ type: import("superstruct").Struct<string | undefined, null>;
424
+ /**
425
+ * Move object content or package content, default to be undefined unless SuiObjectDataOptions.showContent is set to true
426
+ */
427
+ content: import("superstruct").Struct<{
428
+ type: string;
429
+ fields: Record<string, any>;
430
+ hasPublicTransfer: boolean;
431
+ dataType: "moveObject";
432
+ } | {
433
+ disassembled: Record<string, string>;
434
+ dataType: "package";
435
+ } | undefined, null>;
436
+ /**
437
+ * Move object content or package content in BCS bytes, default to be undefined unless SuiObjectDataOptions.showBcs is set to true
438
+ */
439
+ bcs: import("superstruct").Struct<{
440
+ type: string;
441
+ fields: Record<string, any>;
442
+ hasPublicTransfer: boolean;
443
+ dataType: "moveObject";
444
+ } | {
445
+ id: string;
446
+ dataType: "package";
447
+ moduleMap: Record<string, string>;
448
+ } | undefined, null>;
449
+ /**
450
+ * The owner of this object. Default to be undefined unless SuiObjectDataOptions.showOwner is set to true
451
+ */
452
+ owner: import("superstruct").Struct<{
453
+ AddressOwner: string;
454
+ } | {
455
+ ObjectOwner: string;
456
+ } | {
457
+ Shared: {
458
+ initial_shared_version: number;
459
+ };
460
+ } | "Immutable" | undefined, null>;
461
+ /**
462
+ * The digest of the transaction that created or last mutated this object.
463
+ * Default to be undefined unless SuiObjectDataOptions.showPreviousTransaction is set to true
464
+ */
465
+ previousTransaction: import("superstruct").Struct<string | undefined, null>;
466
+ /**
467
+ * The amount of SUI we would rebate if this object gets deleted.
468
+ * This number is re-calculated each time the object is mutated based on
469
+ * the present storage gas price.
470
+ * Default to be undefined unless SuiObjectDataOptions.showStorageRebate is set to true
471
+ */
472
+ storageRebate: import("superstruct").Struct<number | undefined, null>;
473
+ /**
474
+ * Display metadata for this object, default to be undefined unless SuiObjectDataOptions.showDisplay is set to true
475
+ * This can also be None if the struct type does not have Display defined
476
+ * See more details in https://forums.sui.io/t/nft-object-display-proposal/4872
477
+ */
478
+ display: import("superstruct").Struct<Record<string, string> | undefined, null>;
479
+ }>;
480
+ error: import("superstruct").Struct<{
481
+ tag: string;
482
+ version?: number | undefined;
483
+ digest?: string | undefined;
484
+ object_id?: string | undefined;
485
+ } | undefined, {
486
+ tag: import("superstruct").Struct<string, null>;
487
+ object_id: import("superstruct").Struct<string | undefined, null>;
488
+ version: import("superstruct").Struct<number | undefined, null>;
489
+ digest: import("superstruct").Struct<string | undefined, null>;
490
+ }>;
491
+ }>;
492
+ export declare type SuiObjectResponse = Infer<typeof SuiObjectResponse>;
493
+ export declare type Order = 'ascending' | 'descending';
494
+ export declare function getSuiObjectData(resp: SuiObjectResponse): SuiObjectData | undefined;
495
+ export declare function getObjectDeletedResponse(resp: SuiObjectResponse): SuiObjectRef | undefined;
496
+ export declare function getObjectNotExistsResponse(resp: SuiObjectResponse): ObjectId | undefined;
497
+ export declare function getObjectReference(resp: SuiObjectResponse | OwnedObjectRef): SuiObjectRef | undefined;
498
+ export declare function getObjectId(data: SuiObjectResponse | SuiObjectRef | OwnedObjectRef): ObjectId;
499
+ export declare function getObjectVersion(data: SuiObjectResponse | SuiObjectRef | SuiObjectData): string | number | undefined;
500
+ export declare function isSuiObjectResponse(resp: SuiObjectResponse | SuiObjectData): resp is SuiObjectResponse;
501
+ /**
502
+ * Deriving the object type from the object response
503
+ * @returns 'package' if the object is a package, move object type(e.g., 0x2::coin::Coin<0x2::sui::SUI>)
504
+ * if the object is a move object
505
+ */
506
+ export declare function getObjectType(resp: SuiObjectResponse | SuiObjectData): ObjectType | undefined;
507
+ export declare function getObjectPreviousTransactionDigest(resp: SuiObjectResponse): TransactionDigest | undefined;
508
+ export declare function getObjectOwner(resp: SuiObjectResponse | ObjectOwner): ObjectOwner | undefined;
509
+ export declare function getObjectDisplay(resp: SuiObjectResponse): Record<string, string> | undefined;
510
+ export declare function getSharedObjectInitialVersion(resp: SuiObjectResponse | ObjectOwner): number | undefined;
511
+ export declare function isSharedObject(resp: SuiObjectResponse | ObjectOwner): boolean;
512
+ export declare function isImmutableObject(resp: SuiObjectResponse | ObjectOwner): boolean;
513
+ export declare function getMoveObjectType(resp: SuiObjectResponse): string | undefined;
514
+ export declare function getObjectFields(resp: SuiObjectResponse | SuiMoveObject | SuiObjectData): ObjectContentFields | undefined;
515
+ export interface SuiObjectDataWithContent extends SuiObjectData {
516
+ content: SuiParsedData;
517
+ }
518
+ export declare function getMoveObject(data: SuiObjectResponse | SuiObjectData): SuiMoveObject | undefined;
519
+ export declare function hasPublicTransfer(data: SuiObjectResponse | SuiObjectData): boolean;
520
+ export declare function getMovePackageContent(data: SuiObjectResponse | SuiMovePackage): MovePackageContent | undefined;
521
+ export declare const CheckpointedObjectId: import("superstruct").Struct<{
522
+ objectId: string;
523
+ atCheckpoint?: number | undefined;
524
+ }, {
525
+ objectId: import("superstruct").Struct<string, null>;
526
+ atCheckpoint: import("superstruct").Struct<number | undefined, null>;
527
+ }>;
528
+ export declare type CheckpointedObjectId = Infer<typeof CheckpointedObjectId>;
529
+ export declare const PaginatedObjectsResponse: import("superstruct").Struct<{
530
+ data: {
531
+ data?: {
532
+ objectId: string;
533
+ version: number;
534
+ digest: string;
535
+ type?: string | undefined;
536
+ bcs?: {
537
+ type: string;
538
+ fields: Record<string, any>;
539
+ hasPublicTransfer: boolean;
540
+ dataType: "moveObject";
541
+ } | {
542
+ id: string;
543
+ dataType: "package";
544
+ moduleMap: Record<string, string>;
545
+ } | undefined;
546
+ owner?: {
547
+ AddressOwner: string;
548
+ } | {
549
+ ObjectOwner: string;
550
+ } | {
551
+ Shared: {
552
+ initial_shared_version: number;
553
+ };
554
+ } | "Immutable" | undefined;
555
+ storageRebate?: number | undefined;
556
+ previousTransaction?: string | undefined;
557
+ content?: {
558
+ type: string;
559
+ fields: Record<string, any>;
560
+ hasPublicTransfer: boolean;
561
+ dataType: "moveObject";
562
+ } | {
563
+ disassembled: Record<string, string>;
564
+ dataType: "package";
565
+ } | undefined;
566
+ display?: Record<string, string> | undefined;
567
+ } | undefined;
568
+ error?: {
569
+ tag: string;
570
+ version?: number | undefined;
571
+ digest?: string | undefined;
572
+ object_id?: string | undefined;
573
+ } | undefined;
574
+ }[];
575
+ hasNextPage: boolean;
576
+ nextCursor?: {
577
+ objectId: string;
578
+ atCheckpoint?: number | undefined;
579
+ } | undefined;
580
+ }, {
581
+ data: import("superstruct").Struct<{
582
+ data?: {
583
+ objectId: string;
584
+ version: number;
585
+ digest: string;
586
+ type?: string | undefined;
587
+ bcs?: {
588
+ type: string;
589
+ fields: Record<string, any>;
590
+ hasPublicTransfer: boolean;
591
+ dataType: "moveObject";
592
+ } | {
593
+ id: string;
594
+ dataType: "package";
595
+ moduleMap: Record<string, string>;
596
+ } | undefined;
597
+ owner?: {
598
+ AddressOwner: string;
599
+ } | {
600
+ ObjectOwner: string;
601
+ } | {
602
+ Shared: {
603
+ initial_shared_version: number;
604
+ };
605
+ } | "Immutable" | undefined;
606
+ storageRebate?: number | undefined;
607
+ previousTransaction?: string | undefined;
608
+ content?: {
609
+ type: string;
610
+ fields: Record<string, any>;
611
+ hasPublicTransfer: boolean;
612
+ dataType: "moveObject";
613
+ } | {
614
+ disassembled: Record<string, string>;
615
+ dataType: "package";
616
+ } | undefined;
617
+ display?: Record<string, string> | undefined;
618
+ } | undefined;
619
+ error?: {
620
+ tag: string;
621
+ version?: number | undefined;
622
+ digest?: string | undefined;
623
+ object_id?: string | undefined;
624
+ } | undefined;
625
+ }[], import("superstruct").Struct<{
626
+ data?: {
627
+ objectId: string;
628
+ version: number;
629
+ digest: string;
630
+ type?: string | undefined;
631
+ bcs?: {
632
+ type: string;
633
+ fields: Record<string, any>;
634
+ hasPublicTransfer: boolean;
635
+ dataType: "moveObject";
636
+ } | {
637
+ id: string;
638
+ dataType: "package";
639
+ moduleMap: Record<string, string>;
640
+ } | undefined;
641
+ owner?: {
642
+ AddressOwner: string;
643
+ } | {
644
+ ObjectOwner: string;
645
+ } | {
646
+ Shared: {
647
+ initial_shared_version: number;
648
+ };
649
+ } | "Immutable" | undefined;
650
+ storageRebate?: number | undefined;
651
+ previousTransaction?: string | undefined;
652
+ content?: {
653
+ type: string;
654
+ fields: Record<string, any>;
655
+ hasPublicTransfer: boolean;
656
+ dataType: "moveObject";
657
+ } | {
658
+ disassembled: Record<string, string>;
659
+ dataType: "package";
660
+ } | undefined;
661
+ display?: Record<string, string> | undefined;
662
+ } | undefined;
663
+ error?: {
664
+ tag: string;
665
+ version?: number | undefined;
666
+ digest?: string | undefined;
667
+ object_id?: string | undefined;
668
+ } | undefined;
669
+ }, {
670
+ data: import("superstruct").Struct<{
671
+ objectId: string;
672
+ version: number;
673
+ digest: string;
674
+ type?: string | undefined;
675
+ bcs?: {
676
+ type: string;
677
+ fields: Record<string, any>;
678
+ hasPublicTransfer: boolean;
679
+ dataType: "moveObject";
680
+ } | {
681
+ id: string;
682
+ dataType: "package";
683
+ moduleMap: Record<string, string>;
684
+ } | undefined;
685
+ owner?: {
686
+ AddressOwner: string;
687
+ } | {
688
+ ObjectOwner: string;
689
+ } | {
690
+ Shared: {
691
+ initial_shared_version: number;
692
+ };
693
+ } | "Immutable" | undefined;
694
+ storageRebate?: number | undefined;
695
+ previousTransaction?: string | undefined;
696
+ content?: {
697
+ type: string;
698
+ fields: Record<string, any>;
699
+ hasPublicTransfer: boolean;
700
+ dataType: "moveObject";
701
+ } | {
702
+ disassembled: Record<string, string>;
703
+ dataType: "package";
704
+ } | undefined;
705
+ display?: Record<string, string> | undefined;
706
+ } | undefined, {
707
+ objectId: import("superstruct").Struct<string, null>;
708
+ version: import("superstruct").Struct<number, null>;
709
+ digest: import("superstruct").Struct<string, null>;
710
+ /**
711
+ * Type of the object, default to be undefined unless SuiObjectDataOptions.showType is set to true
712
+ */
713
+ type: import("superstruct").Struct<string | undefined, null>;
714
+ /**
715
+ * Move object content or package content, default to be undefined unless SuiObjectDataOptions.showContent is set to true
716
+ */
717
+ content: import("superstruct").Struct<{
718
+ type: string;
719
+ fields: Record<string, any>;
720
+ hasPublicTransfer: boolean;
721
+ dataType: "moveObject";
722
+ } | {
723
+ disassembled: Record<string, string>;
724
+ dataType: "package";
725
+ } | undefined, null>;
726
+ /**
727
+ * Move object content or package content in BCS bytes, default to be undefined unless SuiObjectDataOptions.showBcs is set to true
728
+ */
729
+ bcs: import("superstruct").Struct<{
730
+ type: string;
731
+ fields: Record<string, any>;
732
+ hasPublicTransfer: boolean;
733
+ dataType: "moveObject";
734
+ } | {
735
+ id: string;
736
+ dataType: "package";
737
+ moduleMap: Record<string, string>;
738
+ } | undefined, null>;
739
+ /**
740
+ * The owner of this object. Default to be undefined unless SuiObjectDataOptions.showOwner is set to true
741
+ */
742
+ owner: import("superstruct").Struct<{
743
+ AddressOwner: string;
744
+ } | {
745
+ ObjectOwner: string;
746
+ } | {
747
+ Shared: {
748
+ initial_shared_version: number;
749
+ };
750
+ } | "Immutable" | undefined, null>;
751
+ /**
752
+ * The digest of the transaction that created or last mutated this object.
753
+ * Default to be undefined unless SuiObjectDataOptions.showPreviousTransaction is set to true
754
+ */
755
+ previousTransaction: import("superstruct").Struct<string | undefined, null>;
756
+ /**
757
+ * The amount of SUI we would rebate if this object gets deleted.
758
+ * This number is re-calculated each time the object is mutated based on
759
+ * the present storage gas price.
760
+ * Default to be undefined unless SuiObjectDataOptions.showStorageRebate is set to true
761
+ */
762
+ storageRebate: import("superstruct").Struct<number | undefined, null>;
763
+ /**
764
+ * Display metadata for this object, default to be undefined unless SuiObjectDataOptions.showDisplay is set to true
765
+ * This can also be None if the struct type does not have Display defined
766
+ * See more details in https://forums.sui.io/t/nft-object-display-proposal/4872
767
+ */
768
+ display: import("superstruct").Struct<Record<string, string> | undefined, null>;
769
+ }>;
770
+ error: import("superstruct").Struct<{
771
+ tag: string;
772
+ version?: number | undefined;
773
+ digest?: string | undefined;
774
+ object_id?: string | undefined;
775
+ } | undefined, {
776
+ tag: import("superstruct").Struct<string, null>;
777
+ object_id: import("superstruct").Struct<string | undefined, null>;
778
+ version: import("superstruct").Struct<number | undefined, null>;
779
+ digest: import("superstruct").Struct<string | undefined, null>;
780
+ }>;
781
+ }>>;
782
+ nextCursor: import("superstruct").Struct<{
783
+ objectId: string;
784
+ atCheckpoint?: number | undefined;
785
+ } | undefined, {
786
+ objectId: import("superstruct").Struct<string, null>;
787
+ atCheckpoint: import("superstruct").Struct<number | undefined, null>;
788
+ }>;
789
+ hasNextPage: import("superstruct").Struct<boolean, null>;
790
+ }>;
791
+ export declare type PaginatedObjectsResponse = Infer<typeof PaginatedObjectsResponse>;
792
+ export declare type SuiObjectDataFilter = {
793
+ Package: ObjectId;
794
+ } | {
795
+ MoveModule: {
796
+ package: ObjectId;
797
+ module: string;
798
+ };
799
+ } | {
800
+ StructType: string;
801
+ };
802
+ export declare type SuiObjectResponseQuery = {
803
+ filter?: SuiObjectDataFilter;
804
+ options?: SuiObjectDataOptions;
805
+ };
806
+ //# sourceMappingURL=objects.d.ts.map