@mysten/sui 1.17.0 → 1.18.1

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 (177) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/dist/cjs/bcs/bcs.d.ts +95 -95
  3. package/dist/cjs/bcs/effects.d.ts +41 -41
  4. package/dist/cjs/bcs/index.d.ts +136 -136
  5. package/dist/cjs/client/client.d.ts +1 -0
  6. package/dist/cjs/client/types/generated.d.ts +76 -27
  7. package/dist/cjs/client/types/generated.js.map +1 -1
  8. package/dist/cjs/client/types/params.d.ts +5 -1
  9. package/dist/cjs/client/types/params.js.map +1 -1
  10. package/dist/cjs/cryptography/intent.d.ts +1 -1
  11. package/dist/cjs/cryptography/publickey.d.ts +4 -0
  12. package/dist/cjs/cryptography/publickey.js +6 -0
  13. package/dist/cjs/cryptography/publickey.js.map +2 -2
  14. package/dist/cjs/cryptography/signature.d.ts +9 -9
  15. package/dist/cjs/graphql/generated/2024.1/tada-env.d.ts +11380 -0
  16. package/dist/cjs/graphql/generated/2024.1/tada-env.js +13142 -0
  17. package/dist/cjs/graphql/generated/2024.1/tada-env.js.map +7 -0
  18. package/dist/cjs/graphql/generated/2024.1/tsconfig.tada.js +1 -1
  19. package/dist/cjs/graphql/generated/2024.1/tsconfig.tada.js.map +1 -1
  20. package/dist/cjs/graphql/generated/2024.4/tada-env.d.ts +11496 -0
  21. package/dist/cjs/graphql/generated/2024.4/tada-env.js +13288 -0
  22. package/dist/cjs/graphql/generated/2024.4/tada-env.js.map +7 -0
  23. package/dist/cjs/graphql/generated/2024.4/tsconfig.tada.js +1 -1
  24. package/dist/cjs/graphql/generated/2024.4/tsconfig.tada.js.map +1 -1
  25. package/dist/cjs/graphql/generated/latest/tada-env.d.ts +12540 -0
  26. package/dist/cjs/graphql/generated/latest/tada-env.js +14498 -0
  27. package/dist/cjs/graphql/generated/latest/tada-env.js.map +7 -0
  28. package/dist/cjs/graphql/generated/latest/tsconfig.tada.js +12 -0
  29. package/dist/cjs/graphql/generated/latest/tsconfig.tada.js.map +7 -0
  30. package/dist/cjs/graphql/schemas/2024.1/index.d.ts +6 -8999
  31. package/dist/cjs/graphql/schemas/2024.1/index.js.map +1 -1
  32. package/dist/cjs/graphql/schemas/2024.4/index.d.ts +6 -9053
  33. package/dist/cjs/graphql/schemas/2024.4/index.js.map +1 -1
  34. package/dist/cjs/graphql/schemas/latest/index.d.ts +10 -0
  35. package/dist/cjs/graphql/schemas/latest/index.js +31 -0
  36. package/dist/cjs/graphql/schemas/latest/index.js.map +7 -0
  37. package/dist/cjs/keypairs/ed25519/ed25519-hd-key.d.ts +0 -5
  38. package/dist/cjs/keypairs/ed25519/ed25519-hd-key.js +1 -25
  39. package/dist/cjs/keypairs/ed25519/ed25519-hd-key.js.map +3 -3
  40. package/dist/cjs/keypairs/ed25519/keypair.d.ts +1 -1
  41. package/dist/cjs/keypairs/ed25519/keypair.js +22 -18
  42. package/dist/cjs/keypairs/ed25519/keypair.js.map +3 -3
  43. package/dist/cjs/keypairs/ed25519/publickey.js +2 -12
  44. package/dist/cjs/keypairs/ed25519/publickey.js.map +3 -3
  45. package/dist/cjs/keypairs/passkey/keypair.d.ts +1 -1
  46. package/dist/cjs/keypairs/passkey/publickey.d.ts +4 -4
  47. package/dist/cjs/keypairs/secp256k1/keypair.d.ts +1 -1
  48. package/dist/cjs/keypairs/secp256r1/keypair.d.ts +1 -1
  49. package/dist/cjs/transactions/Arguments.d.ts +11 -980
  50. package/dist/cjs/transactions/Arguments.js +1 -3
  51. package/dist/cjs/transactions/Arguments.js.map +2 -2
  52. package/dist/cjs/transactions/ObjectCache.d.ts +2 -1
  53. package/dist/cjs/transactions/ObjectCache.js +8 -3
  54. package/dist/cjs/transactions/ObjectCache.js.map +2 -2
  55. package/dist/cjs/transactions/Transaction.d.ts +13 -33
  56. package/dist/cjs/transactions/Transaction.js +8 -8
  57. package/dist/cjs/transactions/Transaction.js.map +2 -2
  58. package/dist/cjs/transactions/TransactionData.d.ts +1 -1
  59. package/dist/cjs/transactions/executor/caching.d.ts +1 -1
  60. package/dist/cjs/transactions/executor/serial.d.ts +3 -3
  61. package/dist/cjs/transactions/executor/serial.js +3 -5
  62. package/dist/cjs/transactions/executor/serial.js.map +3 -3
  63. package/dist/cjs/verify/verify.d.ts +5 -1
  64. package/dist/cjs/verify/verify.js +10 -1
  65. package/dist/cjs/verify/verify.js.map +2 -2
  66. package/dist/cjs/version.d.ts +2 -2
  67. package/dist/cjs/version.js +2 -2
  68. package/dist/cjs/version.js.map +1 -1
  69. package/dist/cjs/zklogin/publickey.d.ts +6 -2
  70. package/dist/cjs/zklogin/publickey.js +22 -10
  71. package/dist/cjs/zklogin/publickey.js.map +2 -2
  72. package/dist/esm/bcs/bcs.d.ts +95 -95
  73. package/dist/esm/bcs/effects.d.ts +41 -41
  74. package/dist/esm/bcs/index.d.ts +136 -136
  75. package/dist/esm/client/client.d.ts +1 -0
  76. package/dist/esm/client/types/generated.d.ts +76 -27
  77. package/dist/esm/client/types/params.d.ts +5 -1
  78. package/dist/esm/cryptography/intent.d.ts +1 -1
  79. package/dist/esm/cryptography/publickey.d.ts +4 -0
  80. package/dist/esm/cryptography/publickey.js +6 -0
  81. package/dist/esm/cryptography/publickey.js.map +2 -2
  82. package/dist/esm/cryptography/signature.d.ts +9 -9
  83. package/dist/esm/graphql/generated/2024.1/tada-env.d.ts +11380 -0
  84. package/dist/esm/graphql/generated/2024.1/tada-env.js +13122 -0
  85. package/dist/esm/graphql/generated/2024.1/tada-env.js.map +7 -0
  86. package/dist/esm/graphql/generated/2024.1/tsconfig.tada.js +1 -1
  87. package/dist/esm/graphql/generated/2024.1/tsconfig.tada.js.map +1 -1
  88. package/dist/esm/graphql/generated/2024.4/tada-env.d.ts +11496 -0
  89. package/dist/esm/graphql/generated/2024.4/tada-env.js +13268 -0
  90. package/dist/esm/graphql/generated/2024.4/tada-env.js.map +7 -0
  91. package/dist/esm/graphql/generated/2024.4/tsconfig.tada.js +1 -1
  92. package/dist/esm/graphql/generated/2024.4/tsconfig.tada.js.map +1 -1
  93. package/dist/esm/graphql/generated/latest/tada-env.d.ts +12540 -0
  94. package/dist/esm/graphql/generated/latest/tada-env.js +14478 -0
  95. package/dist/esm/graphql/generated/latest/tada-env.js.map +7 -0
  96. package/dist/esm/graphql/generated/latest/tsconfig.tada.js +17 -0
  97. package/dist/esm/graphql/generated/latest/tsconfig.tada.js.map +7 -0
  98. package/dist/esm/graphql/schemas/2024.1/index.d.ts +6 -8999
  99. package/dist/esm/graphql/schemas/2024.1/index.js.map +1 -1
  100. package/dist/esm/graphql/schemas/2024.4/index.d.ts +6 -9053
  101. package/dist/esm/graphql/schemas/2024.4/index.js.map +1 -1
  102. package/dist/esm/graphql/schemas/latest/index.d.ts +10 -0
  103. package/dist/esm/graphql/schemas/latest/index.js +10 -0
  104. package/dist/esm/graphql/schemas/latest/index.js.map +7 -0
  105. package/dist/esm/keypairs/ed25519/ed25519-hd-key.d.ts +0 -5
  106. package/dist/esm/keypairs/ed25519/ed25519-hd-key.js +1 -15
  107. package/dist/esm/keypairs/ed25519/ed25519-hd-key.js.map +2 -2
  108. package/dist/esm/keypairs/ed25519/keypair.d.ts +1 -1
  109. package/dist/esm/keypairs/ed25519/keypair.js +22 -8
  110. package/dist/esm/keypairs/ed25519/keypair.js.map +2 -2
  111. package/dist/esm/keypairs/ed25519/publickey.js +2 -2
  112. package/dist/esm/keypairs/ed25519/publickey.js.map +2 -2
  113. package/dist/esm/keypairs/passkey/keypair.d.ts +1 -1
  114. package/dist/esm/keypairs/passkey/publickey.d.ts +4 -4
  115. package/dist/esm/keypairs/secp256k1/keypair.d.ts +1 -1
  116. package/dist/esm/keypairs/secp256r1/keypair.d.ts +1 -1
  117. package/dist/esm/transactions/Arguments.d.ts +11 -980
  118. package/dist/esm/transactions/Arguments.js +1 -3
  119. package/dist/esm/transactions/Arguments.js.map +2 -2
  120. package/dist/esm/transactions/ObjectCache.d.ts +2 -1
  121. package/dist/esm/transactions/ObjectCache.js +8 -3
  122. package/dist/esm/transactions/ObjectCache.js.map +2 -2
  123. package/dist/esm/transactions/Transaction.d.ts +13 -33
  124. package/dist/esm/transactions/Transaction.js +8 -8
  125. package/dist/esm/transactions/Transaction.js.map +2 -2
  126. package/dist/esm/transactions/TransactionData.d.ts +1 -1
  127. package/dist/esm/transactions/executor/caching.d.ts +1 -1
  128. package/dist/esm/transactions/executor/serial.d.ts +3 -3
  129. package/dist/esm/transactions/executor/serial.js +3 -5
  130. package/dist/esm/transactions/executor/serial.js.map +2 -2
  131. package/dist/esm/verify/verify.d.ts +5 -1
  132. package/dist/esm/verify/verify.js +10 -1
  133. package/dist/esm/verify/verify.js.map +2 -2
  134. package/dist/esm/version.d.ts +2 -2
  135. package/dist/esm/version.js +2 -2
  136. package/dist/esm/version.js.map +1 -1
  137. package/dist/esm/zklogin/publickey.d.ts +6 -2
  138. package/dist/esm/zklogin/publickey.js +21 -9
  139. package/dist/esm/zklogin/publickey.js.map +2 -2
  140. package/dist/tsconfig.esm.tsbuildinfo +1 -1
  141. package/dist/tsconfig.tsbuildinfo +1 -1
  142. package/graphql/schemas/latest/package.json +6 -0
  143. package/package.json +15 -13
  144. package/src/client/types/generated.ts +110 -59
  145. package/src/client/types/params.ts +5 -1
  146. package/src/cryptography/publickey.ts +7 -0
  147. package/src/graphql/generated/2024.1/tada-env.ts +13144 -0
  148. package/src/graphql/generated/2024.1/tsconfig.tada.json +1 -1
  149. package/src/graphql/generated/2024.4/tada-env.ts +13290 -0
  150. package/src/graphql/generated/2024.4/tsconfig.tada.json +1 -1
  151. package/src/graphql/generated/latest/schema.graphql +4808 -0
  152. package/src/graphql/generated/latest/tada-env.ts +14500 -0
  153. package/src/graphql/generated/latest/tsconfig.tada.json +11 -0
  154. package/src/graphql/schemas/2024.1/index.ts +1 -1
  155. package/src/graphql/schemas/2024.4/index.ts +1 -1
  156. package/src/graphql/schemas/latest/index.ts +17 -0
  157. package/src/keypairs/ed25519/ed25519-hd-key.ts +4 -14
  158. package/src/keypairs/ed25519/keypair.ts +23 -8
  159. package/src/keypairs/ed25519/publickey.ts +2 -2
  160. package/src/transactions/Arguments.ts +6 -5
  161. package/src/transactions/ObjectCache.ts +5 -1
  162. package/src/transactions/Transaction.ts +21 -15
  163. package/src/transactions/__tests__/bcs.test.ts +1 -1
  164. package/src/transactions/executor/serial.ts +3 -5
  165. package/src/verify/verify.ts +21 -3
  166. package/src/version.ts +2 -2
  167. package/src/zklogin/publickey.ts +19 -8
  168. package/dist/cjs/graphql/generated/2024.1/tada-env.d.js +0 -17
  169. package/dist/cjs/graphql/generated/2024.1/tada-env.d.js.map +0 -7
  170. package/dist/cjs/graphql/generated/2024.4/tada-env.d.js +0 -17
  171. package/dist/cjs/graphql/generated/2024.4/tada-env.d.js.map +0 -7
  172. package/dist/esm/graphql/generated/2024.1/tada-env.d.js +0 -1
  173. package/dist/esm/graphql/generated/2024.1/tada-env.d.js.map +0 -7
  174. package/dist/esm/graphql/generated/2024.4/tada-env.d.js +0 -1
  175. package/dist/esm/graphql/generated/2024.4/tada-env.d.js.map +0 -7
  176. package/src/graphql/generated/2024.1/tada-env.d.ts +0 -201
  177. package/src/graphql/generated/2024.4/tada-env.d.ts +0 -203
@@ -0,0 +1,4808 @@
1
+ type ActiveJwk {
2
+ """
3
+ The string (Issuing Authority) that identifies the OIDC provider.
4
+ """
5
+ iss: String!
6
+ """
7
+ The string (Key ID) that identifies the JWK among a set of JWKs, (RFC 7517, Section 4.5).
8
+ """
9
+ kid: String!
10
+ """
11
+ The JWK key type parameter, (RFC 7517, Section 4.1).
12
+ """
13
+ kty: String!
14
+ """
15
+ The JWK RSA public exponent, (RFC 7517, Section 9.3).
16
+ """
17
+ e: String!
18
+ """
19
+ The JWK RSA modulus, (RFC 7517, Section 9.3).
20
+ """
21
+ n: String!
22
+ """
23
+ The JWK algorithm parameter, (RFC 7517, Section 4.4).
24
+ """
25
+ alg: String!
26
+ """
27
+ The most recent epoch in which the JWK was validated.
28
+ """
29
+ epoch: Epoch
30
+ }
31
+
32
+ type ActiveJwkConnection {
33
+ """
34
+ Information to aid in pagination.
35
+ """
36
+ pageInfo: PageInfo!
37
+ """
38
+ A list of edges.
39
+ """
40
+ edges: [ActiveJwkEdge!]!
41
+ """
42
+ A list of nodes.
43
+ """
44
+ nodes: [ActiveJwk!]!
45
+ }
46
+
47
+ """
48
+ An edge in a connection.
49
+ """
50
+ type ActiveJwkEdge {
51
+ """
52
+ The item at the end of the edge
53
+ """
54
+ node: ActiveJwk!
55
+ """
56
+ A cursor for use in pagination
57
+ """
58
+ cursor: String!
59
+ }
60
+
61
+ """
62
+ The 32-byte address that is an account address (corresponding to a public key).
63
+ """
64
+ type Address implements IOwner {
65
+ address: SuiAddress!
66
+ """
67
+ Objects owned by this address, optionally `filter`-ed.
68
+ """
69
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
70
+ """
71
+ Total balance of all coins with marker type owned by this address. If type is not supplied,
72
+ it defaults to `0x2::sui::SUI`.
73
+ """
74
+ balance(type: String): Balance
75
+ """
76
+ The balances of all coin types owned by this address.
77
+ """
78
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
79
+ """
80
+ The coin objects for this address.
81
+
82
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
83
+ """
84
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
85
+ """
86
+ The `0x3::staking_pool::StakedSui` objects owned by this address.
87
+ """
88
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
89
+ """
90
+ The domain explicitly configured as the default domain pointing to this address.
91
+ """
92
+ defaultSuinsName(format: DomainFormat): String
93
+ """
94
+ The SuinsRegistration NFTs owned by this address. These grant the owner the capability to
95
+ manage the associated domain.
96
+ """
97
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
98
+ """
99
+ Similar behavior to the `transactionBlocks` in Query but supporting the additional
100
+ `AddressTransactionBlockRelationship` filter, which defaults to `SENT`.
101
+
102
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
103
+ results. It is required for queries that apply more than two complex filters (on function,
104
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
105
+ `serviceConfig.maxScanLimit`.
106
+
107
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
108
+ results when paginating forward (`last` when paginating backwards). If there are more
109
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
110
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
111
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
112
+
113
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
114
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
115
+ transactions in the scanning range have been visited.
116
+
117
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
118
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
119
+ `afterCheckpoint` and `atCheckpoint` filters.
120
+ """
121
+ transactionBlocks(first: Int, after: String, last: Int, before: String, relation: AddressTransactionBlockRelationship, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
122
+ }
123
+
124
+ type AddressConnection {
125
+ """
126
+ Information to aid in pagination.
127
+ """
128
+ pageInfo: PageInfo!
129
+ """
130
+ A list of edges.
131
+ """
132
+ edges: [AddressEdge!]!
133
+ """
134
+ A list of nodes.
135
+ """
136
+ nodes: [Address!]!
137
+ }
138
+
139
+ """
140
+ An edge in a connection.
141
+ """
142
+ type AddressEdge {
143
+ """
144
+ The item at the end of the edge
145
+ """
146
+ node: Address!
147
+ """
148
+ A cursor for use in pagination
149
+ """
150
+ cursor: String!
151
+ }
152
+
153
+ """
154
+ An address-owned object is owned by a specific 32-byte address that is
155
+ either an account address (derived from a particular signature scheme) or
156
+ an object ID. An address-owned object is accessible only to its owner and no others.
157
+ """
158
+ type AddressOwner {
159
+ owner: Owner
160
+ }
161
+
162
+ """
163
+ The possible relationship types for a transaction block: sent, or received.
164
+ """
165
+ enum AddressTransactionBlockRelationship {
166
+ """
167
+ Transactions this address has sent.
168
+ """
169
+ SENT
170
+ """
171
+ Transactions that this address was involved in, either as the sender, sponsor, or as the
172
+ owner of some object that was created, modified or transfered.
173
+ """
174
+ AFFECTED
175
+ }
176
+
177
+ """
178
+ An Authenticator represents the access control rules for a ConsensusV2 object.
179
+ """
180
+ union Authenticator = Address
181
+
182
+ """
183
+ System transaction for creating the on-chain state used by zkLogin.
184
+ """
185
+ type AuthenticatorStateCreateTransaction {
186
+ """
187
+ A workaround to define an empty variant of a GraphQL union.
188
+ """
189
+ _: Boolean
190
+ }
191
+
192
+ type AuthenticatorStateExpireTransaction {
193
+ """
194
+ Expire JWKs that have a lower epoch than this.
195
+ """
196
+ minEpoch: Epoch
197
+ """
198
+ The initial version that the AuthenticatorStateUpdate was shared at.
199
+ """
200
+ authenticatorObjInitialSharedVersion: UInt53!
201
+ }
202
+
203
+ """
204
+ System transaction for updating the on-chain state used by zkLogin.
205
+ """
206
+ type AuthenticatorStateUpdateTransaction {
207
+ """
208
+ Epoch of the authenticator state update transaction.
209
+ """
210
+ epoch: Epoch
211
+ """
212
+ Consensus round of the authenticator state update.
213
+ """
214
+ round: UInt53!
215
+ """
216
+ Newly active JWKs (JSON Web Keys).
217
+ """
218
+ newActiveJwks(first: Int, after: String, last: Int, before: String): ActiveJwkConnection!
219
+ """
220
+ The initial version of the authenticator object that it was shared at.
221
+ """
222
+ authenticatorObjInitialSharedVersion: UInt53!
223
+ }
224
+
225
+ """
226
+ Range of checkpoints that the RPC is guaranteed to produce a consistent response for.
227
+ """
228
+ type AvailableRange {
229
+ first: Checkpoint
230
+ last: Checkpoint
231
+ }
232
+
233
+ """
234
+ The total balance for a particular coin type.
235
+ """
236
+ type Balance {
237
+ """
238
+ Coin type for the balance, such as 0x2::sui::SUI
239
+ """
240
+ coinType: MoveType!
241
+ """
242
+ How many coins of this type constitute the balance
243
+ """
244
+ coinObjectCount: UInt53
245
+ """
246
+ Total balance across all coin objects of the coin type
247
+ """
248
+ totalBalance: BigInt
249
+ }
250
+
251
+ """
252
+ Effects to the balance (sum of coin values per coin type) owned by an address or object.
253
+ """
254
+ type BalanceChange {
255
+ """
256
+ The address or object whose balance has changed.
257
+ """
258
+ owner: Owner
259
+ """
260
+ The inner type of the coin whose balance has changed (e.g. `0x2::sui::SUI`).
261
+ """
262
+ coinType: MoveType
263
+ """
264
+ The signed balance change.
265
+ """
266
+ amount: BigInt
267
+ }
268
+
269
+ type BalanceChangeConnection {
270
+ """
271
+ Information to aid in pagination.
272
+ """
273
+ pageInfo: PageInfo!
274
+ """
275
+ A list of edges.
276
+ """
277
+ edges: [BalanceChangeEdge!]!
278
+ """
279
+ A list of nodes.
280
+ """
281
+ nodes: [BalanceChange!]!
282
+ }
283
+
284
+ """
285
+ An edge in a connection.
286
+ """
287
+ type BalanceChangeEdge {
288
+ """
289
+ The item at the end of the edge
290
+ """
291
+ node: BalanceChange!
292
+ """
293
+ A cursor for use in pagination
294
+ """
295
+ cursor: String!
296
+ }
297
+
298
+ type BalanceConnection {
299
+ """
300
+ Information to aid in pagination.
301
+ """
302
+ pageInfo: PageInfo!
303
+ """
304
+ A list of edges.
305
+ """
306
+ edges: [BalanceEdge!]!
307
+ """
308
+ A list of nodes.
309
+ """
310
+ nodes: [Balance!]!
311
+ }
312
+
313
+ """
314
+ An edge in a connection.
315
+ """
316
+ type BalanceEdge {
317
+ """
318
+ The item at the end of the edge
319
+ """
320
+ node: Balance!
321
+ """
322
+ A cursor for use in pagination
323
+ """
324
+ cursor: String!
325
+ }
326
+
327
+ """
328
+ String containing Base64-encoded binary data.
329
+ """
330
+ scalar Base64
331
+
332
+ """
333
+ String representation of an arbitrary width, possibly signed integer.
334
+ """
335
+ scalar BigInt
336
+
337
+
338
+ type BridgeCommitteeInitTransaction {
339
+ bridgeObjInitialSharedVersion: UInt53!
340
+ }
341
+
342
+ type BridgeStateCreateTransaction {
343
+ chainId: String!
344
+ }
345
+
346
+ """
347
+ A system transaction that updates epoch information on-chain (increments the current epoch).
348
+ Executed by the system once per epoch, without using gas. Epoch change transactions cannot be
349
+ submitted by users, because validators will refuse to sign them.
350
+
351
+ This transaction kind is deprecated in favour of `EndOfEpochTransaction`.
352
+ """
353
+ type ChangeEpochTransaction {
354
+ """
355
+ The next (to become) epoch.
356
+ """
357
+ epoch: Epoch
358
+ """
359
+ The protocol version in effect in the new epoch.
360
+ """
361
+ protocolVersion: UInt53!
362
+ """
363
+ The total amount of gas charged for storage during the previous epoch (in MIST).
364
+ """
365
+ storageCharge: BigInt!
366
+ """
367
+ The total amount of gas charged for computation during the previous epoch (in MIST).
368
+ """
369
+ computationCharge: BigInt!
370
+ """
371
+ The SUI returned to transaction senders for cleaning up objects (in MIST).
372
+ """
373
+ storageRebate: BigInt!
374
+ """
375
+ The total gas retained from storage fees, that will not be returned by storage rebates when
376
+ the relevant objects are cleaned up (in MIST).
377
+ """
378
+ nonRefundableStorageFee: BigInt!
379
+ """
380
+ Time at which the next epoch will start.
381
+ """
382
+ startTimestamp: DateTime!
383
+ """
384
+ System packages (specifically framework and move stdlib) that are written before the new
385
+ epoch starts, to upgrade them on-chain. Validators write these packages out when running the
386
+ transaction.
387
+ """
388
+ systemPackages(first: Int, after: String, last: Int, before: String): MovePackageConnection!
389
+ }
390
+
391
+ """
392
+ Checkpoints contain finalized transactions and are used for node synchronization
393
+ and global transaction ordering.
394
+ """
395
+ type Checkpoint {
396
+ """
397
+ A 32-byte hash that uniquely identifies the checkpoint contents, encoded in Base58. This
398
+ hash can be used to verify checkpoint contents by checking signatures against the committee,
399
+ Hashing contents to match digest, and checking that the previous checkpoint digest matches.
400
+ """
401
+ digest: String!
402
+ """
403
+ This checkpoint's position in the total order of finalized checkpoints, agreed upon by
404
+ consensus.
405
+ """
406
+ sequenceNumber: UInt53!
407
+ """
408
+ The timestamp at which the checkpoint is agreed to have happened according to consensus.
409
+ Transactions that access time in this checkpoint will observe this timestamp.
410
+ """
411
+ timestamp: DateTime!
412
+ """
413
+ This is an aggregation of signatures from a quorum of validators for the checkpoint
414
+ proposal.
415
+ """
416
+ validatorSignatures: Base64!
417
+ """
418
+ The digest of the checkpoint at the previous sequence number.
419
+ """
420
+ previousCheckpointDigest: String
421
+ """
422
+ The total number of transaction blocks in the network by the end of this checkpoint.
423
+ """
424
+ networkTotalTransactions: UInt53
425
+ """
426
+ The computation cost, storage cost, storage rebate, and non-refundable storage fee
427
+ accumulated during this epoch, up to and including this checkpoint. These values increase
428
+ monotonically across checkpoints in the same epoch, and reset on epoch boundaries.
429
+ """
430
+ rollingGasSummary: GasCostSummary
431
+ """
432
+ The epoch this checkpoint is part of.
433
+ """
434
+ epoch: Epoch
435
+ """
436
+ Transactions in this checkpoint.
437
+
438
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
439
+ results. It is required for queries that apply more than two complex filters (on function,
440
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
441
+ `serviceConfig.maxScanLimit`.
442
+
443
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
444
+ results when paginating forward (`last` when paginating backwards). If there are more
445
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
446
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
447
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
448
+
449
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
450
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
451
+ transactions in the scanning range have been visited.
452
+
453
+ By default, the scanning range consists of all transactions in this checkpoint.
454
+ """
455
+ transactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
456
+ """
457
+ The Base64 serialized BCS bytes of CheckpointSummary for this checkpoint.
458
+ """
459
+ bcs: Base64
460
+ }
461
+
462
+ type CheckpointConnection {
463
+ """
464
+ Information to aid in pagination.
465
+ """
466
+ pageInfo: PageInfo!
467
+ """
468
+ A list of edges.
469
+ """
470
+ edges: [CheckpointEdge!]!
471
+ """
472
+ A list of nodes.
473
+ """
474
+ nodes: [Checkpoint!]!
475
+ }
476
+
477
+ """
478
+ An edge in a connection.
479
+ """
480
+ type CheckpointEdge {
481
+ """
482
+ The item at the end of the edge
483
+ """
484
+ node: Checkpoint!
485
+ """
486
+ A cursor for use in pagination
487
+ """
488
+ cursor: String!
489
+ }
490
+
491
+ """
492
+ Filter either by the digest, or the sequence number, or neither, to get the latest checkpoint.
493
+ """
494
+ input CheckpointId {
495
+ digest: String
496
+ sequenceNumber: UInt53
497
+ }
498
+
499
+ """
500
+ Some 0x2::coin::Coin Move object.
501
+ """
502
+ type Coin implements IMoveObject & IObject & IOwner {
503
+ address: SuiAddress!
504
+ """
505
+ Objects owned by this object, optionally `filter`-ed.
506
+ """
507
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
508
+ """
509
+ Total balance of all coins with marker type owned by this object. If type is not supplied,
510
+ it defaults to `0x2::sui::SUI`.
511
+ """
512
+ balance(type: String): Balance
513
+ """
514
+ The balances of all coin types owned by this object.
515
+ """
516
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
517
+ """
518
+ The coin objects for this object.
519
+
520
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
521
+ """
522
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
523
+ """
524
+ The `0x3::staking_pool::StakedSui` objects owned by this object.
525
+ """
526
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
527
+ """
528
+ The domain explicitly configured as the default domain pointing to this object.
529
+ """
530
+ defaultSuinsName(format: DomainFormat): String
531
+ """
532
+ The SuinsRegistration NFTs owned by this object. These grant the owner the capability to
533
+ manage the associated domain.
534
+ """
535
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
536
+ version: UInt53!
537
+ """
538
+ The current status of the object as read from the off-chain store. The possible states are:
539
+ NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or
540
+ system package upgrade transaction. LIVE, the version returned is the most recent for the
541
+ object, and it is not deleted or wrapped at that version. HISTORICAL, the object was
542
+ referenced at a specific version or checkpoint, so is fetched from historical tables and may
543
+ not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or
544
+ wrapped and only partial information can be loaded."
545
+ """
546
+ status: ObjectKind!
547
+ """
548
+ 32-byte hash that identifies the object's contents, encoded as a Base58 string.
549
+ """
550
+ digest: String
551
+ """
552
+ The owner type of this object: Immutable, Shared, Parent, Address
553
+ """
554
+ owner: ObjectOwner
555
+ """
556
+ The transaction block that created this version of the object.
557
+ """
558
+ previousTransactionBlock: TransactionBlock
559
+ """
560
+ The amount of SUI we would rebate if this object gets deleted or mutated. This number is
561
+ recalculated based on the present storage gas price.
562
+ """
563
+ storageRebate: BigInt
564
+ """
565
+ The transaction blocks that sent objects to this object.
566
+
567
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
568
+ results. It is required for queries that apply more than two complex filters (on function,
569
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
570
+ `serviceConfig.maxScanLimit`.
571
+
572
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
573
+ results when paginating forward (`last` when paginating backwards). If there are more
574
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
575
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
576
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
577
+
578
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
579
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
580
+ transactions in the scanning range have been visited.
581
+
582
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
583
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
584
+ `afterCheckpoint` and `atCheckpoint` filters.
585
+ """
586
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
587
+ """
588
+ The Base64-encoded BCS serialization of the object's content.
589
+ """
590
+ bcs: Base64
591
+ """
592
+ Displays the contents of the Move object in a JSON string and through GraphQL types. Also
593
+ provides the flat representation of the type signature, and the BCS of the corresponding
594
+ data.
595
+ """
596
+ contents: MoveValue
597
+ """
598
+ Determines whether a transaction can transfer this object, using the TransferObjects
599
+ transaction command or `sui::transfer::public_transfer`, both of which require the object to
600
+ have the `key` and `store` abilities.
601
+ """
602
+ hasPublicTransfer: Boolean!
603
+ """
604
+ The set of named templates defined on-chain for the type of this object, to be handled
605
+ off-chain. The server substitutes data from the object into these templates to generate a
606
+ display string per template.
607
+ """
608
+ display: [DisplayEntry!]
609
+ """
610
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose
611
+ type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS
612
+ contents, Base64 encoded.
613
+
614
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
615
+ type.
616
+ """
617
+ dynamicField(name: DynamicFieldName!): DynamicField
618
+ """
619
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values
620
+ whose type have `copy`, `drop`, and `store`, and are specified using their type, and their
621
+ BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed
622
+ off-chain directly via its address (e.g. using `Query.object`).
623
+
624
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
625
+ type.
626
+ """
627
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
628
+ """
629
+ The dynamic fields and dynamic object fields on an object.
630
+
631
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
632
+ type.
633
+ """
634
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
635
+ """
636
+ Balance of this coin object.
637
+ """
638
+ coinBalance: BigInt
639
+ }
640
+
641
+ type CoinConnection {
642
+ """
643
+ Information to aid in pagination.
644
+ """
645
+ pageInfo: PageInfo!
646
+ """
647
+ A list of edges.
648
+ """
649
+ edges: [CoinEdge!]!
650
+ """
651
+ A list of nodes.
652
+ """
653
+ nodes: [Coin!]!
654
+ }
655
+
656
+ type CoinDenyListStateCreateTransaction {
657
+ """
658
+ A workaround to define an empty variant of a GraphQL union.
659
+ """
660
+ _: Boolean
661
+ }
662
+
663
+ """
664
+ An edge in a connection.
665
+ """
666
+ type CoinEdge {
667
+ """
668
+ The item at the end of the edge
669
+ """
670
+ node: Coin!
671
+ """
672
+ A cursor for use in pagination
673
+ """
674
+ cursor: String!
675
+ }
676
+
677
+ """
678
+ The metadata for a coin type.
679
+ """
680
+ type CoinMetadata implements IMoveObject & IObject & IOwner {
681
+ address: SuiAddress!
682
+ """
683
+ Objects owned by this object, optionally `filter`-ed.
684
+ """
685
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
686
+ """
687
+ Total balance of all coins with marker type owned by this object. If type is not supplied,
688
+ it defaults to `0x2::sui::SUI`.
689
+ """
690
+ balance(type: String): Balance
691
+ """
692
+ The balances of all coin types owned by this object.
693
+ """
694
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
695
+ """
696
+ The coin objects for this object.
697
+
698
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
699
+ """
700
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
701
+ """
702
+ The `0x3::staking_pool::StakedSui` objects owned by this object.
703
+ """
704
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
705
+ """
706
+ The domain explicitly configured as the default domain pointing to this object.
707
+ """
708
+ defaultSuinsName(format: DomainFormat): String
709
+ """
710
+ The SuinsRegistration NFTs owned by this object. These grant the owner the capability to
711
+ manage the associated domain.
712
+ """
713
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
714
+ version: UInt53!
715
+ """
716
+ The current status of the object as read from the off-chain store. The possible states are:
717
+ NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or
718
+ system package upgrade transaction. LIVE, the version returned is the most recent for the
719
+ object, and it is not deleted or wrapped at that version. HISTORICAL, the object was
720
+ referenced at a specific version or checkpoint, so is fetched from historical tables and may
721
+ not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or
722
+ wrapped and only partial information can be loaded."
723
+ """
724
+ status: ObjectKind!
725
+ """
726
+ 32-byte hash that identifies the object's contents, encoded as a Base58 string.
727
+ """
728
+ digest: String
729
+ """
730
+ The owner type of this object: Immutable, Shared, Parent, Address
731
+ """
732
+ owner: ObjectOwner
733
+ """
734
+ The transaction block that created this version of the object.
735
+ """
736
+ previousTransactionBlock: TransactionBlock
737
+ """
738
+ The amount of SUI we would rebate if this object gets deleted or mutated. This number is
739
+ recalculated based on the present storage gas price.
740
+ """
741
+ storageRebate: BigInt
742
+ """
743
+ The transaction blocks that sent objects to this object.
744
+
745
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
746
+ results. It is required for queries that apply more than two complex filters (on function,
747
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
748
+ `serviceConfig.maxScanLimit`.
749
+
750
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
751
+ results when paginating forward (`last` when paginating backwards). If there are more
752
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
753
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
754
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
755
+
756
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
757
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
758
+ transactions in the scanning range have been visited.
759
+
760
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
761
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
762
+ `afterCheckpoint` and `atCheckpoint` filters.
763
+ """
764
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
765
+ """
766
+ The Base64-encoded BCS serialization of the object's content.
767
+ """
768
+ bcs: Base64
769
+ """
770
+ Displays the contents of the Move object in a JSON string and through GraphQL types. Also
771
+ provides the flat representation of the type signature, and the BCS of the corresponding
772
+ data.
773
+ """
774
+ contents: MoveValue
775
+ """
776
+ Determines whether a transaction can transfer this object, using the TransferObjects
777
+ transaction command or `sui::transfer::public_transfer`, both of which require the object to
778
+ have the `key` and `store` abilities.
779
+ """
780
+ hasPublicTransfer: Boolean!
781
+ """
782
+ The set of named templates defined on-chain for the type of this object, to be handled
783
+ off-chain. The server substitutes data from the object into these templates to generate a
784
+ display string per template.
785
+ """
786
+ display: [DisplayEntry!]
787
+ """
788
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose
789
+ type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS
790
+ contents, Base64 encoded.
791
+
792
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
793
+ type.
794
+ """
795
+ dynamicField(name: DynamicFieldName!): DynamicField
796
+ """
797
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values
798
+ whose type have `copy`, `drop`, and `store`, and are specified using their type, and their
799
+ BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed
800
+ off-chain directly via its address (e.g. using `Query.object`).
801
+
802
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
803
+ type.
804
+ """
805
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
806
+ """
807
+ The dynamic fields and dynamic object fields on an object.
808
+
809
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
810
+ type.
811
+ """
812
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
813
+ """
814
+ The number of decimal places used to represent the token.
815
+ """
816
+ decimals: Int
817
+ """
818
+ Full, official name of the token.
819
+ """
820
+ name: String
821
+ """
822
+ The token's identifying abbreviation.
823
+ """
824
+ symbol: String
825
+ """
826
+ Optional description of the token, provided by the creator of the token.
827
+ """
828
+ description: String
829
+ iconUrl: String
830
+ """
831
+ The overall quantity of tokens that will be issued.
832
+ """
833
+ supply: BigInt
834
+ }
835
+
836
+ """
837
+ System transaction that runs at the beginning of a checkpoint, and is responsible for setting
838
+ the current value of the clock, based on the timestamp from consensus.
839
+ """
840
+ type ConsensusCommitPrologueTransaction {
841
+ """
842
+ Epoch of the commit prologue transaction.
843
+ """
844
+ epoch: Epoch
845
+ """
846
+ Consensus round of the commit.
847
+ """
848
+ round: UInt53!
849
+ """
850
+ Unix timestamp from consensus.
851
+ """
852
+ commitTimestamp: DateTime!
853
+ """
854
+ Digest of consensus output, encoded as a Base58 string (only available from V2 of the
855
+ transaction).
856
+ """
857
+ consensusCommitDigest: String
858
+ }
859
+
860
+ """
861
+ A ConsensusV2 object is an object that is automatically versioned by the consensus protocol
862
+ and allows different authentication modes based on the chosen authenticator.
863
+ (Initially, only single-owner authentication is supported.)
864
+ """
865
+ type ConsensusV2 {
866
+ startVersion: UInt53!
867
+ authenticator: Authenticator
868
+ }
869
+
870
+ """
871
+ ISO-8601 Date and Time: RFC3339 in UTC with format: YYYY-MM-DDTHH:MM:SS.mmmZ. Note that the milliseconds part is optional, and it may be omitted if its value is 0.
872
+ """
873
+ scalar DateTime
874
+
875
+ type DependencyConnection {
876
+ """
877
+ Information to aid in pagination.
878
+ """
879
+ pageInfo: PageInfo!
880
+ """
881
+ A list of edges.
882
+ """
883
+ edges: [DependencyEdge!]!
884
+ """
885
+ A list of nodes.
886
+ """
887
+ nodes: [TransactionBlock!]!
888
+ }
889
+
890
+ """
891
+ An edge in a connection.
892
+ """
893
+ type DependencyEdge {
894
+ """
895
+ The item at the end of the edge
896
+ """
897
+ node: TransactionBlock
898
+ """
899
+ A cursor for use in pagination
900
+ """
901
+ cursor: String!
902
+ }
903
+
904
+ """
905
+ The set of named templates defined on-chain for the type of this object,
906
+ to be handled off-chain. The server substitutes data from the object
907
+ into these templates to generate a display string per template.
908
+ """
909
+ type DisplayEntry {
910
+ """
911
+ The identifier for a particular template string of the Display object.
912
+ """
913
+ key: String!
914
+ """
915
+ The template string for the key with placeholder values substituted.
916
+ """
917
+ value: String
918
+ """
919
+ An error string describing why the template could not be rendered.
920
+ """
921
+ error: String
922
+ }
923
+
924
+ enum DomainFormat {
925
+ AT
926
+ DOT
927
+ }
928
+
929
+ type DryRunEffect {
930
+ """
931
+ Changes made to arguments that were mutably borrowed by each command in this transaction.
932
+ """
933
+ mutatedReferences: [DryRunMutation!]
934
+ """
935
+ Return results of each command in this transaction.
936
+ """
937
+ returnValues: [DryRunReturn!]
938
+ }
939
+
940
+ type DryRunMutation {
941
+ input: TransactionArgument!
942
+ type: MoveType!
943
+ bcs: Base64!
944
+ }
945
+
946
+ type DryRunResult {
947
+ """
948
+ The error that occurred during dry run execution, if any.
949
+ """
950
+ error: String
951
+ """
952
+ The intermediate results for each command of the dry run execution, including
953
+ contents of mutated references and return values.
954
+ """
955
+ results: [DryRunEffect!]
956
+ """
957
+ The transaction block representing the dry run execution.
958
+ """
959
+ transaction: TransactionBlock
960
+ }
961
+
962
+ type DryRunReturn {
963
+ type: MoveType!
964
+ bcs: Base64!
965
+ }
966
+
967
+ """
968
+ Dynamic fields are heterogeneous fields that can be added or removed at runtime,
969
+ and can have arbitrary user-assigned names. There are two sub-types of dynamic
970
+ fields:
971
+
972
+ 1) Dynamic Fields can store any value that has the `store` ability, however an object
973
+ stored in this kind of field will be considered wrapped and will not be accessible
974
+ directly via its ID by external tools (explorers, wallets, etc) accessing storage.
975
+ 2) Dynamic Object Fields values must be Sui objects (have the `key` and `store`
976
+ abilities, and id: UID as the first field), but will still be directly accessible off-chain
977
+ via their object ID after being attached.
978
+ """
979
+ type DynamicField {
980
+ """
981
+ The string type, data, and serialized value of the DynamicField's 'name' field.
982
+ This field is used to uniquely identify a child of the parent object.
983
+ """
984
+ name: MoveValue
985
+ """
986
+ The returned dynamic field is an object if its return type is `MoveObject`,
987
+ in which case it is also accessible off-chain via its address. Its contents
988
+ will be from the latest version that is at most equal to its parent object's
989
+ version
990
+ """
991
+ value: DynamicFieldValue
992
+ }
993
+
994
+ type DynamicFieldConnection {
995
+ """
996
+ Information to aid in pagination.
997
+ """
998
+ pageInfo: PageInfo!
999
+ """
1000
+ A list of edges.
1001
+ """
1002
+ edges: [DynamicFieldEdge!]!
1003
+ """
1004
+ A list of nodes.
1005
+ """
1006
+ nodes: [DynamicField!]!
1007
+ }
1008
+
1009
+ """
1010
+ An edge in a connection.
1011
+ """
1012
+ type DynamicFieldEdge {
1013
+ """
1014
+ The item at the end of the edge
1015
+ """
1016
+ node: DynamicField!
1017
+ """
1018
+ A cursor for use in pagination
1019
+ """
1020
+ cursor: String!
1021
+ }
1022
+
1023
+ input DynamicFieldName {
1024
+ """
1025
+ The string type of the DynamicField's 'name' field.
1026
+ A string representation of a Move primitive like 'u64', or a struct type like '0x2::kiosk::Listing'
1027
+ """
1028
+ type: String!
1029
+ """
1030
+ The Base64 encoded bcs serialization of the DynamicField's 'name' field.
1031
+ """
1032
+ bcs: Base64!
1033
+ }
1034
+
1035
+ union DynamicFieldValue = MoveObject | MoveValue
1036
+
1037
+ """
1038
+ System transaction that supersedes `ChangeEpochTransaction` as the new way to run transactions
1039
+ at the end of an epoch. Behaves similarly to `ChangeEpochTransaction` but can accommodate other
1040
+ optional transactions to run at the end of the epoch.
1041
+ """
1042
+ type EndOfEpochTransaction {
1043
+ """
1044
+ The list of system transactions that are allowed to run at the end of the epoch.
1045
+ """
1046
+ transactions(first: Int, before: String, last: Int, after: String): EndOfEpochTransactionKindConnection!
1047
+ }
1048
+
1049
+ union EndOfEpochTransactionKind = ChangeEpochTransaction | AuthenticatorStateCreateTransaction | AuthenticatorStateExpireTransaction | RandomnessStateCreateTransaction | CoinDenyListStateCreateTransaction | BridgeStateCreateTransaction | BridgeCommitteeInitTransaction
1050
+
1051
+ type EndOfEpochTransactionKindConnection {
1052
+ """
1053
+ Information to aid in pagination.
1054
+ """
1055
+ pageInfo: PageInfo!
1056
+ """
1057
+ A list of edges.
1058
+ """
1059
+ edges: [EndOfEpochTransactionKindEdge!]!
1060
+ """
1061
+ A list of nodes.
1062
+ """
1063
+ nodes: [EndOfEpochTransactionKind!]!
1064
+ }
1065
+
1066
+ """
1067
+ An edge in a connection.
1068
+ """
1069
+ type EndOfEpochTransactionKindEdge {
1070
+ """
1071
+ The item at the end of the edge
1072
+ """
1073
+ node: EndOfEpochTransactionKind!
1074
+ """
1075
+ A cursor for use in pagination
1076
+ """
1077
+ cursor: String!
1078
+ }
1079
+
1080
+ """
1081
+ Operation of the Sui network is temporally partitioned into non-overlapping epochs,
1082
+ and the network aims to keep epochs roughly the same duration as each other.
1083
+ During a particular epoch the following data is fixed:
1084
+
1085
+ - the protocol version
1086
+ - the reference gas price
1087
+ - the set of participating validators
1088
+ """
1089
+ type Epoch {
1090
+ """
1091
+ The epoch's id as a sequence number that starts at 0 and is incremented by one at every epoch change.
1092
+ """
1093
+ epochId: UInt53!
1094
+ """
1095
+ The minimum gas price that a quorum of validators are guaranteed to sign a transaction for.
1096
+ """
1097
+ referenceGasPrice: BigInt
1098
+ """
1099
+ Validator related properties, including the active validators.
1100
+ """
1101
+ validatorSet: ValidatorSet
1102
+ """
1103
+ The epoch's starting timestamp.
1104
+ """
1105
+ startTimestamp: DateTime!
1106
+ """
1107
+ The epoch's ending timestamp.
1108
+ """
1109
+ endTimestamp: DateTime
1110
+ """
1111
+ The total number of checkpoints in this epoch.
1112
+ """
1113
+ totalCheckpoints: UInt53
1114
+ """
1115
+ The total number of transaction blocks in this epoch.
1116
+ """
1117
+ totalTransactions: UInt53
1118
+ """
1119
+ The total amount of gas fees (in MIST) that were paid in this epoch.
1120
+ """
1121
+ totalGasFees: BigInt
1122
+ """
1123
+ The total MIST rewarded as stake.
1124
+ """
1125
+ totalStakeRewards: BigInt
1126
+ """
1127
+ The amount added to total gas fees to make up the total stake rewards.
1128
+ """
1129
+ totalStakeSubsidies: BigInt
1130
+ """
1131
+ The storage fund available in this epoch.
1132
+ This fund is used to redistribute storage fees from past transactions
1133
+ to future validators.
1134
+ """
1135
+ fundSize: BigInt
1136
+ """
1137
+ The difference between the fund inflow and outflow, representing
1138
+ the net amount of storage fees accumulated in this epoch.
1139
+ """
1140
+ netInflow: BigInt
1141
+ """
1142
+ The storage fees paid for transactions executed during the epoch.
1143
+ """
1144
+ fundInflow: BigInt
1145
+ """
1146
+ The storage fee rebates paid to users who deleted the data associated with past
1147
+ transactions.
1148
+ """
1149
+ fundOutflow: BigInt
1150
+ """
1151
+ The epoch's corresponding protocol configuration, including the feature flags and the
1152
+ configuration options.
1153
+ """
1154
+ protocolConfigs: ProtocolConfigs!
1155
+ """
1156
+ SUI set aside to account for objects stored on-chain, at the start of the epoch.
1157
+ This is also used for storage rebates.
1158
+ """
1159
+ storageFund: StorageFund
1160
+ """
1161
+ Information about whether this epoch was started in safe mode, which happens if the full epoch
1162
+ change logic fails for some reason.
1163
+ """
1164
+ safeMode: SafeMode
1165
+ """
1166
+ The value of the `version` field of `0x5`, the `0x3::sui::SuiSystemState` object. This
1167
+ version changes whenever the fields contained in the system state object (held in a dynamic
1168
+ field attached to `0x5`) change.
1169
+ """
1170
+ systemStateVersion: UInt53
1171
+ """
1172
+ Details of the system that are decided during genesis.
1173
+ """
1174
+ systemParameters: SystemParameters
1175
+ """
1176
+ Parameters related to the subsidy that supplements staking rewards
1177
+ """
1178
+ systemStakeSubsidy: StakeSubsidy
1179
+ """
1180
+ A commitment by the committee at the end of epoch on the contents of the live object set at
1181
+ that time. This can be used to verify state snapshots.
1182
+ """
1183
+ liveObjectSetDigest: String
1184
+ """
1185
+ The epoch's corresponding checkpoints.
1186
+ """
1187
+ checkpoints(first: Int, after: String, last: Int, before: String): CheckpointConnection!
1188
+ """
1189
+ The epoch's corresponding transaction blocks.
1190
+
1191
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
1192
+ results. It is required for queries that apply more than two complex filters (on function,
1193
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
1194
+ `serviceConfig.maxScanLimit`.
1195
+
1196
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
1197
+ results when paginating forward (`last` when paginating backwards). If there are more
1198
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
1199
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
1200
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
1201
+
1202
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
1203
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
1204
+ transactions in the scanning range have been visited.
1205
+
1206
+ By default, the scanning range consists of all transactions in this epoch.
1207
+ """
1208
+ transactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
1209
+ }
1210
+
1211
+ type EpochConnection {
1212
+ """
1213
+ Information to aid in pagination.
1214
+ """
1215
+ pageInfo: PageInfo!
1216
+ """
1217
+ A list of edges.
1218
+ """
1219
+ edges: [EpochEdge!]!
1220
+ """
1221
+ A list of nodes.
1222
+ """
1223
+ nodes: [Epoch!]!
1224
+ }
1225
+
1226
+ """
1227
+ An edge in a connection.
1228
+ """
1229
+ type EpochEdge {
1230
+ """
1231
+ The item at the end of the edge
1232
+ """
1233
+ node: Epoch!
1234
+ """
1235
+ A cursor for use in pagination
1236
+ """
1237
+ cursor: String!
1238
+ }
1239
+
1240
+ type Event {
1241
+ """
1242
+ The transaction block that emitted this event. This information is only available for
1243
+ events from indexed transactions, and not from transactions that have just been executed or
1244
+ dry-run.
1245
+ """
1246
+ transactionBlock: TransactionBlock
1247
+ """
1248
+ The Move module containing some function that when called by
1249
+ a programmable transaction block (PTB) emitted this event.
1250
+ For example, if a PTB invokes A::m1::foo, which internally
1251
+ calls A::m2::emit_event to emit an event,
1252
+ the sending module would be A::m1.
1253
+ """
1254
+ sendingModule: MoveModule
1255
+ """
1256
+ Address of the sender of the event
1257
+ """
1258
+ sender: Address
1259
+ """
1260
+ UTC timestamp in milliseconds since epoch (1/1/1970)
1261
+ """
1262
+ timestamp: DateTime
1263
+ """
1264
+ The event's contents as a Move value.
1265
+ """
1266
+ contents: MoveValue!
1267
+ """
1268
+ The Base64 encoded BCS serialized bytes of the event.
1269
+ """
1270
+ bcs: Base64!
1271
+ }
1272
+
1273
+ type EventConnection {
1274
+ """
1275
+ Information to aid in pagination.
1276
+ """
1277
+ pageInfo: PageInfo!
1278
+ """
1279
+ A list of edges.
1280
+ """
1281
+ edges: [EventEdge!]!
1282
+ """
1283
+ A list of nodes.
1284
+ """
1285
+ nodes: [Event!]!
1286
+ }
1287
+
1288
+ """
1289
+ An edge in a connection.
1290
+ """
1291
+ type EventEdge {
1292
+ """
1293
+ The item at the end of the edge
1294
+ """
1295
+ node: Event!
1296
+ """
1297
+ A cursor for use in pagination
1298
+ """
1299
+ cursor: String!
1300
+ }
1301
+
1302
+ input EventFilter {
1303
+ """
1304
+ Filter down to events from transactions sent by this address.
1305
+ """
1306
+ sender: SuiAddress
1307
+ """
1308
+ Filter down to the events from this transaction (given by its transaction digest).
1309
+ """
1310
+ transactionDigest: String
1311
+ """
1312
+ Events emitted by a particular module. An event is emitted by a
1313
+ particular module if some function in the module is called by a
1314
+ PTB and emits an event.
1315
+
1316
+ Modules can be filtered by their package, or package::module.
1317
+ We currently do not support filtering by emitting module and event type
1318
+ at the same time so if both are provided in one filter, the query will error.
1319
+ """
1320
+ emittingModule: String
1321
+ """
1322
+ This field is used to specify the type of event emitted.
1323
+
1324
+ Events can be filtered by their type's package, package::module,
1325
+ or their fully qualified type name.
1326
+
1327
+ Generic types can be queried by either the generic type name, e.g.
1328
+ `0x2::coin::Coin`, or by the full type name, such as
1329
+ `0x2::coin::Coin<0x2::sui::SUI>`.
1330
+ """
1331
+ eventType: String
1332
+ }
1333
+
1334
+ """
1335
+ The result of an execution, including errors that occurred during said execution.
1336
+ """
1337
+ type ExecutionResult {
1338
+ """
1339
+ The errors field captures any errors that occurred during execution
1340
+ """
1341
+ errors: [String!]
1342
+ """
1343
+ The effects of the executed transaction. Since the transaction was just executed
1344
+ and not indexed yet, fields including `balance_changes`, `timestamp` and `checkpoint`
1345
+ are not available.
1346
+ """
1347
+ effects: TransactionBlockEffects!
1348
+ }
1349
+
1350
+ """
1351
+ The execution status of this transaction block: success or failure.
1352
+ """
1353
+ enum ExecutionStatus {
1354
+ """
1355
+ The transaction block was successfully executed
1356
+ """
1357
+ SUCCESS
1358
+ """
1359
+ The transaction block could not be executed
1360
+ """
1361
+ FAILURE
1362
+ }
1363
+
1364
+ """
1365
+ Groups of features served by the RPC service. The GraphQL Service can be configured to enable
1366
+ or disable these features.
1367
+ """
1368
+ enum Feature {
1369
+ """
1370
+ Statistics about how the network was running (TPS, top packages, APY, etc)
1371
+ """
1372
+ ANALYTICS
1373
+ """
1374
+ Coin metadata, per-address coin and balance information.
1375
+ """
1376
+ COINS
1377
+ """
1378
+ Querying an object's dynamic fields.
1379
+ """
1380
+ DYNAMIC_FIELDS
1381
+ """
1382
+ SuiNS name and reverse name look-up.
1383
+ """
1384
+ NAME_SERVICE
1385
+ """
1386
+ Transaction and Event subscriptions.
1387
+ """
1388
+ SUBSCRIPTIONS
1389
+ """
1390
+ Aspects that affect the running of the system that are managed by the
1391
+ validators either directly, or through system transactions.
1392
+ """
1393
+ SYSTEM_STATE
1394
+ """
1395
+ Named packages service (utilizing dotmove package registry).
1396
+ """
1397
+ MOVE_REGISTRY
1398
+ }
1399
+
1400
+
1401
+ """
1402
+ Access to the gas inputs, after they have been smashed into one coin. The gas coin can only be
1403
+ used by reference, except for with `TransferObjectsTransaction` that can accept it by value.
1404
+ """
1405
+ type GasCoin {
1406
+ """
1407
+ A workaround to define an empty variant of a GraphQL union.
1408
+ """
1409
+ _: Boolean
1410
+ }
1411
+
1412
+ """
1413
+ Breakdown of gas costs in effects.
1414
+ """
1415
+ type GasCostSummary {
1416
+ """
1417
+ Gas paid for executing this transaction (in MIST).
1418
+ """
1419
+ computationCost: BigInt
1420
+ """
1421
+ Gas paid for the data stored on-chain by this transaction (in MIST).
1422
+ """
1423
+ storageCost: BigInt
1424
+ """
1425
+ Part of storage cost that can be reclaimed by cleaning up data created by this transaction
1426
+ (when objects are deleted or an object is modified, which is treated as a deletion followed
1427
+ by a creation) (in MIST).
1428
+ """
1429
+ storageRebate: BigInt
1430
+ """
1431
+ Part of storage cost that is not reclaimed when data created by this transaction is cleaned
1432
+ up (in MIST).
1433
+ """
1434
+ nonRefundableStorageFee: BigInt
1435
+ }
1436
+
1437
+ """
1438
+ Effects related to gas (costs incurred and the identity of the smashed gas object returned).
1439
+ """
1440
+ type GasEffects {
1441
+ gasObject: Object
1442
+ gasSummary: GasCostSummary
1443
+ }
1444
+
1445
+ """
1446
+ Configuration for this transaction's gas price and the coins used to pay for gas.
1447
+ """
1448
+ type GasInput {
1449
+ """
1450
+ Address of the owner of the gas object(s) used
1451
+ """
1452
+ gasSponsor: Address
1453
+ """
1454
+ Objects used to pay for a transaction's execution and storage
1455
+ """
1456
+ gasPayment(first: Int, after: String, last: Int, before: String): ObjectConnection!
1457
+ """
1458
+ An unsigned integer specifying the number of native tokens per gas unit this transaction
1459
+ will pay (in MIST).
1460
+ """
1461
+ gasPrice: BigInt
1462
+ """
1463
+ The maximum number of gas units that can be expended by executing this transaction
1464
+ """
1465
+ gasBudget: BigInt
1466
+ }
1467
+
1468
+ """
1469
+ System transaction that initializes the network and writes the initial set of objects on-chain.
1470
+ """
1471
+ type GenesisTransaction {
1472
+ """
1473
+ Objects to be created during genesis.
1474
+ """
1475
+ objects(first: Int, after: String, last: Int, before: String): ObjectConnection!
1476
+ }
1477
+
1478
+
1479
+ """
1480
+ Interface implemented by all GraphQL types that represent a Move datatype (either structs or
1481
+ enums). This interface is used to provide a way to access fields that are shared by both
1482
+ structs and enums, e.g., the module that the datatype belongs to, the name of the datatype,
1483
+ type parameters etc.
1484
+ """
1485
+ interface IMoveDatatype {
1486
+ """
1487
+ The module that the datatype belongs to.
1488
+ """
1489
+ module: MoveModule!
1490
+ """
1491
+ The name of the datatype.
1492
+ """
1493
+ name: String!
1494
+ """
1495
+ The abilities of the datatype.
1496
+ """
1497
+ abilities: [MoveAbility!]
1498
+ """
1499
+ The type parameters of the datatype.
1500
+ """
1501
+ typeParameters: [MoveStructTypeParameter!]
1502
+ }
1503
+
1504
+ """
1505
+ This interface is implemented by types that represent a Move object on-chain (A Move value whose
1506
+ type has `key`).
1507
+ """
1508
+ interface IMoveObject {
1509
+ """
1510
+ Displays the contents of the Move object in a JSON string and through GraphQL types. Also provides the flat representation of the type signature, and the BCS of the corresponding data.
1511
+ """
1512
+ contents: MoveValue
1513
+ """
1514
+ Determines whether a transaction can transfer this object, using the TransferObjects transaction command or `sui::transfer::public_transfer`, both of which require the object to have the `key` and `store` abilities.
1515
+ """
1516
+ hasPublicTransfer: Boolean!
1517
+ """
1518
+ The set of named templates defined on-chain for the type of this object, to be handled off-chain. The server substitutes data from the object into these templates to generate a display string per template.
1519
+ """
1520
+ display: [DisplayEntry!]
1521
+ """
1522
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS contents, Base64 encoded.
1523
+
1524
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Ownertype.
1525
+ """
1526
+ dynamicField(name: DynamicFieldName!): DynamicField
1527
+ """
1528
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values whose type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed off-chain directly via its address (e.g. using `Query.object`).
1529
+
1530
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner type.
1531
+ """
1532
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
1533
+ """
1534
+ The dynamic fields and dynamic object fields on an object.
1535
+
1536
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner type.
1537
+ """
1538
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
1539
+ }
1540
+
1541
+ """
1542
+ Interface implemented by on-chain values that are addressable by an ID (also referred to as its
1543
+ address). This includes Move objects and packages.
1544
+ """
1545
+ interface IObject {
1546
+ version: UInt53!
1547
+ """
1548
+ The current status of the object as read from the off-chain store. The possible states are: NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or system package upgrade transaction. LIVE, the version returned is the most recent for the object, and it is not deleted or wrapped at that version. HISTORICAL, the object was referenced at a specific version or checkpoint, so is fetched from historical tables and may not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or wrapped and only partial information can be loaded.
1549
+ """
1550
+ status: ObjectKind!
1551
+ """
1552
+ 32-byte hash that identifies the object's current contents, encoded as a Base58 string.
1553
+ """
1554
+ digest: String
1555
+ """
1556
+ The owner type of this object: Immutable, Shared, Parent, Address
1557
+ Immutable and Shared Objects do not have owners.
1558
+ """
1559
+ owner: ObjectOwner
1560
+ """
1561
+ The transaction block that created this version of the object.
1562
+ """
1563
+ previousTransactionBlock: TransactionBlock
1564
+ """
1565
+
1566
+ """
1567
+ storageRebate: BigInt
1568
+ """
1569
+ The transaction blocks that sent objects to this object.
1570
+ """
1571
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
1572
+ """
1573
+ The Base64-encoded BCS serialization of the object's content.
1574
+ """
1575
+ bcs: Base64
1576
+ }
1577
+
1578
+ """
1579
+ Interface implemented by GraphQL types representing entities that can own objects. Object owners
1580
+ are identified by an address which can represent either the public key of an account or another
1581
+ object. The same address can only refer to an account or an object, never both, but it is not
1582
+ possible to know which up-front.
1583
+ """
1584
+ interface IOwner {
1585
+ address: SuiAddress!
1586
+ """
1587
+ Objects owned by this object or address, optionally `filter`-ed.
1588
+ """
1589
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
1590
+ """
1591
+ Total balance of all coins with marker type owned by this object or address. If type is not supplied, it defaults to `0x2::sui::SUI`.
1592
+ """
1593
+ balance(type: String): Balance
1594
+ """
1595
+ The balances of all coin types owned by this object or address.
1596
+ """
1597
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
1598
+ """
1599
+ The coin objects for this object or address.
1600
+
1601
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
1602
+ """
1603
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
1604
+ """
1605
+ The `0x3::staking_pool::StakedSui` objects owned by this object or address.
1606
+ """
1607
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
1608
+ """
1609
+ The domain explicitly configured as the default domain pointing to this object or address.
1610
+ """
1611
+ defaultSuinsName(format: DomainFormat): String
1612
+ """
1613
+ The SuinsRegistration NFTs owned by this object or address. These grant the owner the capability to manage the associated domain.
1614
+ """
1615
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
1616
+ }
1617
+
1618
+ """
1619
+ An immutable object is an object that can't be mutated, transferred, or deleted.
1620
+ Immutable objects have no owner, so anyone can use them.
1621
+ """
1622
+ type Immutable {
1623
+ _: Boolean
1624
+ }
1625
+
1626
+ """
1627
+ One of the input objects or primitive values to the programmable transaction block.
1628
+ """
1629
+ type Input {
1630
+ """
1631
+ Index of the programmable transaction block input (0-indexed).
1632
+ """
1633
+ ix: Int!
1634
+ }
1635
+
1636
+
1637
+ """
1638
+ Arbitrary JSON data.
1639
+ """
1640
+ scalar JSON
1641
+
1642
+ """
1643
+ Information used by a package to link to a specific version of its dependency.
1644
+ """
1645
+ type Linkage {
1646
+ """
1647
+ The ID on-chain of the first version of the dependency.
1648
+ """
1649
+ originalId: SuiAddress!
1650
+ """
1651
+ The ID on-chain of the version of the dependency that this package depends on.
1652
+ """
1653
+ upgradedId: SuiAddress!
1654
+ """
1655
+ The version of the dependency that this package depends on.
1656
+ """
1657
+ version: UInt53!
1658
+ }
1659
+
1660
+ """
1661
+ Create a vector (possibly empty).
1662
+ """
1663
+ type MakeMoveVecTransaction {
1664
+ """
1665
+ If the elements are not objects, or the vector is empty, a type must be supplied.
1666
+ """
1667
+ type: MoveType
1668
+ """
1669
+ The values to pack into the vector, all of the same type.
1670
+ """
1671
+ elements: [TransactionArgument!]!
1672
+ }
1673
+
1674
+ """
1675
+ Merges `coins` into the first `coin` (produces no results).
1676
+ """
1677
+ type MergeCoinsTransaction {
1678
+ """
1679
+ The coin to merge into.
1680
+ """
1681
+ coin: TransactionArgument!
1682
+ """
1683
+ The coins to be merged.
1684
+ """
1685
+ coins: [TransactionArgument!]!
1686
+ }
1687
+
1688
+ """
1689
+ Abilities are keywords in Sui Move that define how types behave at the compiler level.
1690
+ """
1691
+ enum MoveAbility {
1692
+ """
1693
+ Enables values to be copied.
1694
+ """
1695
+ COPY
1696
+ """
1697
+ Enables values to be popped/dropped.
1698
+ """
1699
+ DROP
1700
+ """
1701
+ Enables values to be held directly in global storage.
1702
+ """
1703
+ KEY
1704
+ """
1705
+ Enables values to be held inside a struct in global storage.
1706
+ """
1707
+ STORE
1708
+ }
1709
+
1710
+ """
1711
+ A call to either an entry or a public Move function.
1712
+ """
1713
+ type MoveCallTransaction {
1714
+ """
1715
+ The storage ID of the package the function being called is defined in.
1716
+ """
1717
+ package: SuiAddress!
1718
+ """
1719
+ The name of the module the function being called is defined in.
1720
+ """
1721
+ module: String!
1722
+ """
1723
+ The name of the function being called.
1724
+ """
1725
+ functionName: String!
1726
+ """
1727
+ The function being called, resolved.
1728
+ """
1729
+ function: MoveFunction
1730
+ """
1731
+ The actual type parameters passed in for this move call.
1732
+ """
1733
+ typeArguments: [MoveType!]!
1734
+ """
1735
+ The actual function parameters passed in for this move call.
1736
+ """
1737
+ arguments: [TransactionArgument!]!
1738
+ }
1739
+
1740
+ """
1741
+ The contents of a Move Value, corresponding to the following recursive type:
1742
+
1743
+ type MoveData =
1744
+ { Address: SuiAddress }
1745
+ | { UID: SuiAddress }
1746
+ | { ID: SuiAddress }
1747
+ | { Bool: bool }
1748
+ | { Number: BigInt }
1749
+ | { String: string }
1750
+ | { Vector: [MoveData] }
1751
+ | { Option: MoveData? }
1752
+ | { Struct: [{ name: string , value: MoveData }] }
1753
+ | { Variant: {
1754
+ name: string,
1755
+ fields: [{ name: string, value: MoveData }],
1756
+ }
1757
+ """
1758
+ scalar MoveData
1759
+
1760
+ """
1761
+ The generic representation of a Move datatype (either a struct or an enum) which exposes common
1762
+ fields and information (module, name, abilities, type parameters etc.) that is shared across
1763
+ them.
1764
+ """
1765
+ type MoveDatatype implements IMoveDatatype {
1766
+ module: MoveModule!
1767
+ name: String!
1768
+ abilities: [MoveAbility!]
1769
+ typeParameters: [MoveStructTypeParameter!]
1770
+ asMoveEnum: MoveEnum
1771
+ asMoveStruct: MoveStruct
1772
+ }
1773
+
1774
+ type MoveDatatypeConnection {
1775
+ """
1776
+ Information to aid in pagination.
1777
+ """
1778
+ pageInfo: PageInfo!
1779
+ """
1780
+ A list of edges.
1781
+ """
1782
+ edges: [MoveDatatypeEdge!]!
1783
+ """
1784
+ A list of nodes.
1785
+ """
1786
+ nodes: [MoveDatatype!]!
1787
+ }
1788
+
1789
+ """
1790
+ An edge in a connection.
1791
+ """
1792
+ type MoveDatatypeEdge {
1793
+ """
1794
+ The item at the end of the edge
1795
+ """
1796
+ node: MoveDatatype!
1797
+ """
1798
+ A cursor for use in pagination
1799
+ """
1800
+ cursor: String!
1801
+ }
1802
+
1803
+ """
1804
+ Description of an enum type, defined in a Move module.
1805
+ """
1806
+ type MoveEnum implements IMoveDatatype {
1807
+ """
1808
+ The module this enum was originally defined in.
1809
+ """
1810
+ module: MoveModule!
1811
+ """
1812
+ The enum's (unqualified) type name.
1813
+ """
1814
+ name: String!
1815
+ """
1816
+ The enum's abilities.
1817
+ """
1818
+ abilities: [MoveAbility!]
1819
+ """
1820
+ Constraints on the enum's formal type parameters. Move bytecode does not name type
1821
+ parameters, so when they are referenced (e.g. in field types) they are identified by their
1822
+ index in this list.
1823
+ """
1824
+ typeParameters: [MoveStructTypeParameter!]
1825
+ """
1826
+ The names and types of the enum's fields. Field types reference type parameters, by their
1827
+ index in the defining enum's `typeParameters` list.
1828
+ """
1829
+ variants: [MoveEnumVariant!]
1830
+ }
1831
+
1832
+ type MoveEnumConnection {
1833
+ """
1834
+ Information to aid in pagination.
1835
+ """
1836
+ pageInfo: PageInfo!
1837
+ """
1838
+ A list of edges.
1839
+ """
1840
+ edges: [MoveEnumEdge!]!
1841
+ """
1842
+ A list of nodes.
1843
+ """
1844
+ nodes: [MoveEnum!]!
1845
+ }
1846
+
1847
+ """
1848
+ An edge in a connection.
1849
+ """
1850
+ type MoveEnumEdge {
1851
+ """
1852
+ The item at the end of the edge
1853
+ """
1854
+ node: MoveEnum!
1855
+ """
1856
+ A cursor for use in pagination
1857
+ """
1858
+ cursor: String!
1859
+ }
1860
+
1861
+ type MoveEnumVariant {
1862
+ """
1863
+ The name of the variant
1864
+ """
1865
+ name: String!
1866
+ """
1867
+ The names and types of the variant's fields. Field types reference type parameters, by their
1868
+ index in the defining enum's `typeParameters` list.
1869
+ """
1870
+ fields: [MoveField!]
1871
+ }
1872
+
1873
+ """
1874
+ Information for a particular field on a Move struct.
1875
+ """
1876
+ type MoveField {
1877
+ name: String!
1878
+ type: OpenMoveType
1879
+ }
1880
+
1881
+ """
1882
+ Signature of a function, defined in a Move module.
1883
+ """
1884
+ type MoveFunction {
1885
+ """
1886
+ The module this function was defined in.
1887
+ """
1888
+ module: MoveModule!
1889
+ """
1890
+ The function's (unqualified) name.
1891
+ """
1892
+ name: String!
1893
+ """
1894
+ The function's visibility: `public`, `public(friend)`, or `private`.
1895
+ """
1896
+ visibility: MoveVisibility
1897
+ """
1898
+ Whether the function has the `entry` modifier or not.
1899
+ """
1900
+ isEntry: Boolean
1901
+ """
1902
+ Constraints on the function's formal type parameters. Move bytecode does not name type
1903
+ parameters, so when they are referenced (e.g. in parameter and return types) they are
1904
+ identified by their index in this list.
1905
+ """
1906
+ typeParameters: [MoveFunctionTypeParameter!]
1907
+ """
1908
+ The function's parameter types. These types can reference type parameters introduce by this
1909
+ function (see `typeParameters`).
1910
+ """
1911
+ parameters: [OpenMoveType!]
1912
+ """
1913
+ The function's return types. There can be multiple because functions in Move can return
1914
+ multiple values. These types can reference type parameters introduced by this function (see
1915
+ `typeParameters`).
1916
+ """
1917
+ return: [OpenMoveType!]
1918
+ }
1919
+
1920
+ type MoveFunctionConnection {
1921
+ """
1922
+ Information to aid in pagination.
1923
+ """
1924
+ pageInfo: PageInfo!
1925
+ """
1926
+ A list of edges.
1927
+ """
1928
+ edges: [MoveFunctionEdge!]!
1929
+ """
1930
+ A list of nodes.
1931
+ """
1932
+ nodes: [MoveFunction!]!
1933
+ }
1934
+
1935
+ """
1936
+ An edge in a connection.
1937
+ """
1938
+ type MoveFunctionEdge {
1939
+ """
1940
+ The item at the end of the edge
1941
+ """
1942
+ node: MoveFunction!
1943
+ """
1944
+ A cursor for use in pagination
1945
+ """
1946
+ cursor: String!
1947
+ }
1948
+
1949
+ type MoveFunctionTypeParameter {
1950
+ constraints: [MoveAbility!]!
1951
+ }
1952
+
1953
+ """
1954
+ Represents a module in Move, a library that defines struct types
1955
+ and functions that operate on these types.
1956
+ """
1957
+ type MoveModule {
1958
+ """
1959
+ The package that this Move module was defined in
1960
+ """
1961
+ package: MovePackage!
1962
+ """
1963
+ The module's (unqualified) name.
1964
+ """
1965
+ name: String!
1966
+ """
1967
+ Format version of this module's bytecode.
1968
+ """
1969
+ fileFormatVersion: Int!
1970
+ """
1971
+ Modules that this module considers friends (these modules can access `public(friend)`
1972
+ functions from this module).
1973
+ """
1974
+ friends(first: Int, after: String, last: Int, before: String): MoveModuleConnection!
1975
+ """
1976
+ Look-up the definition of a struct defined in this module, by its name.
1977
+ """
1978
+ struct(name: String!): MoveStruct
1979
+ """
1980
+ Iterate through the structs defined in this module.
1981
+ """
1982
+ structs(first: Int, after: String, last: Int, before: String): MoveStructConnection
1983
+ """
1984
+ Look-up the definition of a enum defined in this module, by its name.
1985
+ """
1986
+ enum(name: String!): MoveEnum
1987
+ """
1988
+ Iterate through the enums defined in this module.
1989
+ """
1990
+ enums(first: Int, after: String, last: Int, before: String): MoveEnumConnection
1991
+ """
1992
+ Look-up the definition of a datatype (struct or enum) defined in this module, by its name.
1993
+ """
1994
+ datatype(name: String!): MoveDatatype
1995
+ """
1996
+ Iterate through the datatypes (enmums and structs) defined in this module.
1997
+ """
1998
+ datatypes(first: Int, after: String, last: Int, before: String): MoveDatatypeConnection
1999
+ """
2000
+ Look-up the signature of a function defined in this module, by its name.
2001
+ """
2002
+ function(name: String!): MoveFunction
2003
+ """
2004
+ Iterate through the signatures of functions defined in this module.
2005
+ """
2006
+ functions(first: Int, after: String, last: Int, before: String): MoveFunctionConnection
2007
+ """
2008
+ The Base64 encoded bcs serialization of the module.
2009
+ """
2010
+ bytes: Base64
2011
+ """
2012
+ Textual representation of the module's bytecode.
2013
+ """
2014
+ disassembly: String
2015
+ }
2016
+
2017
+ type MoveModuleConnection {
2018
+ """
2019
+ Information to aid in pagination.
2020
+ """
2021
+ pageInfo: PageInfo!
2022
+ """
2023
+ A list of edges.
2024
+ """
2025
+ edges: [MoveModuleEdge!]!
2026
+ """
2027
+ A list of nodes.
2028
+ """
2029
+ nodes: [MoveModule!]!
2030
+ }
2031
+
2032
+ """
2033
+ An edge in a connection.
2034
+ """
2035
+ type MoveModuleEdge {
2036
+ """
2037
+ The item at the end of the edge
2038
+ """
2039
+ node: MoveModule!
2040
+ """
2041
+ A cursor for use in pagination
2042
+ """
2043
+ cursor: String!
2044
+ }
2045
+
2046
+ """
2047
+ The representation of an object as a Move Object, which exposes additional information
2048
+ (content, module that governs it, version, is transferrable, etc.) about this object.
2049
+ """
2050
+ type MoveObject implements IMoveObject & IObject & IOwner {
2051
+ address: SuiAddress!
2052
+ """
2053
+ Objects owned by this object, optionally `filter`-ed.
2054
+ """
2055
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
2056
+ """
2057
+ Total balance of all coins with marker type owned by this object. If type is not supplied,
2058
+ it defaults to `0x2::sui::SUI`.
2059
+ """
2060
+ balance(type: String): Balance
2061
+ """
2062
+ The balances of all coin types owned by this object.
2063
+ """
2064
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
2065
+ """
2066
+ The coin objects for this object.
2067
+
2068
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
2069
+ """
2070
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
2071
+ """
2072
+ The `0x3::staking_pool::StakedSui` objects owned by this object.
2073
+ """
2074
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
2075
+ """
2076
+ The domain explicitly configured as the default domain pointing to this object.
2077
+ """
2078
+ defaultSuinsName(format: DomainFormat): String
2079
+ """
2080
+ The SuinsRegistration NFTs owned by this object. These grant the owner the capability to
2081
+ manage the associated domain.
2082
+ """
2083
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
2084
+ version: UInt53!
2085
+ """
2086
+ The current status of the object as read from the off-chain store. The possible states are:
2087
+ NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or
2088
+ system package upgrade transaction. LIVE, the version returned is the most recent for the
2089
+ object, and it is not deleted or wrapped at that version. HISTORICAL, the object was
2090
+ referenced at a specific version or checkpoint, so is fetched from historical tables and may
2091
+ not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or
2092
+ wrapped and only partial information can be loaded."
2093
+ """
2094
+ status: ObjectKind!
2095
+ """
2096
+ 32-byte hash that identifies the object's contents, encoded as a Base58 string.
2097
+ """
2098
+ digest: String
2099
+ """
2100
+ The owner type of this object: Immutable, Shared, Parent, Address
2101
+ """
2102
+ owner: ObjectOwner
2103
+ """
2104
+ The transaction block that created this version of the object.
2105
+ """
2106
+ previousTransactionBlock: TransactionBlock
2107
+ """
2108
+ The amount of SUI we would rebate if this object gets deleted or mutated. This number is
2109
+ recalculated based on the present storage gas price.
2110
+ """
2111
+ storageRebate: BigInt
2112
+ """
2113
+ The transaction blocks that sent objects to this object.
2114
+
2115
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
2116
+ results. It is required for queries that apply more than two complex filters (on function,
2117
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
2118
+ `serviceConfig.maxScanLimit`.
2119
+
2120
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
2121
+ results when paginating forward (`last` when paginating backwards). If there are more
2122
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
2123
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
2124
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
2125
+
2126
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
2127
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
2128
+ transactions in the scanning range have been visited.
2129
+
2130
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
2131
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
2132
+ `afterCheckpoint` and `atCheckpoint` filters.
2133
+ """
2134
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
2135
+ """
2136
+ The Base64-encoded BCS serialization of the object's content.
2137
+ """
2138
+ bcs: Base64
2139
+ """
2140
+ Displays the contents of the Move object in a JSON string and through GraphQL types. Also
2141
+ provides the flat representation of the type signature, and the BCS of the corresponding
2142
+ data.
2143
+ """
2144
+ contents: MoveValue
2145
+ """
2146
+ Determines whether a transaction can transfer this object, using the TransferObjects
2147
+ transaction command or `sui::transfer::public_transfer`, both of which require the object to
2148
+ have the `key` and `store` abilities.
2149
+ """
2150
+ hasPublicTransfer: Boolean!
2151
+ """
2152
+ The set of named templates defined on-chain for the type of this object, to be handled
2153
+ off-chain. The server substitutes data from the object into these templates to generate a
2154
+ display string per template.
2155
+ """
2156
+ display: [DisplayEntry!]
2157
+ """
2158
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose
2159
+ type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS
2160
+ contents, Base64 encoded.
2161
+
2162
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
2163
+ type.
2164
+ """
2165
+ dynamicField(name: DynamicFieldName!): DynamicField
2166
+ """
2167
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values
2168
+ whose type have `copy`, `drop`, and `store`, and are specified using their type, and their
2169
+ BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed
2170
+ off-chain directly via its address (e.g. using `Query.object`).
2171
+
2172
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
2173
+ type.
2174
+ """
2175
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
2176
+ """
2177
+ The dynamic fields and dynamic object fields on an object.
2178
+
2179
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
2180
+ type.
2181
+ """
2182
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
2183
+ """
2184
+ Attempts to convert the Move object into a `0x2::coin::Coin`.
2185
+ """
2186
+ asCoin: Coin
2187
+ """
2188
+ Attempts to convert the Move object into a `0x3::staking_pool::StakedSui`.
2189
+ """
2190
+ asStakedSui: StakedSui
2191
+ """
2192
+ Attempts to convert the Move object into a `0x2::coin::CoinMetadata`.
2193
+ """
2194
+ asCoinMetadata: CoinMetadata
2195
+ """
2196
+ Attempts to convert the Move object into a `SuinsRegistration` object.
2197
+ """
2198
+ asSuinsRegistration: SuinsRegistration
2199
+ }
2200
+
2201
+ type MoveObjectConnection {
2202
+ """
2203
+ Information to aid in pagination.
2204
+ """
2205
+ pageInfo: PageInfo!
2206
+ """
2207
+ A list of edges.
2208
+ """
2209
+ edges: [MoveObjectEdge!]!
2210
+ """
2211
+ A list of nodes.
2212
+ """
2213
+ nodes: [MoveObject!]!
2214
+ }
2215
+
2216
+ """
2217
+ An edge in a connection.
2218
+ """
2219
+ type MoveObjectEdge {
2220
+ """
2221
+ The item at the end of the edge
2222
+ """
2223
+ node: MoveObject!
2224
+ """
2225
+ A cursor for use in pagination
2226
+ """
2227
+ cursor: String!
2228
+ }
2229
+
2230
+ """
2231
+ A MovePackage is a kind of Move object that represents code that has been published on chain.
2232
+ It exposes information about its modules, type definitions, functions, and dependencies.
2233
+ """
2234
+ type MovePackage implements IObject & IOwner {
2235
+ address: SuiAddress!
2236
+ """
2237
+ Objects owned by this package, optionally `filter`-ed.
2238
+
2239
+ Note that objects owned by a package are inaccessible, because packages are immutable and
2240
+ cannot be owned by an address.
2241
+ """
2242
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
2243
+ """
2244
+ Total balance of all coins with marker type owned by this package. If type is not supplied,
2245
+ it defaults to `0x2::sui::SUI`.
2246
+
2247
+ Note that coins owned by a package are inaccessible, because packages are immutable and
2248
+ cannot be owned by an address.
2249
+ """
2250
+ balance(type: String): Balance
2251
+ """
2252
+ The balances of all coin types owned by this package.
2253
+
2254
+ Note that coins owned by a package are inaccessible, because packages are immutable and
2255
+ cannot be owned by an address.
2256
+ """
2257
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
2258
+ """
2259
+ The coin objects owned by this package.
2260
+
2261
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
2262
+
2263
+ Note that coins owned by a package are inaccessible, because packages are immutable and
2264
+ cannot be owned by an address.
2265
+ """
2266
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
2267
+ """
2268
+ The `0x3::staking_pool::StakedSui` objects owned by this package.
2269
+
2270
+ Note that objects owned by a package are inaccessible, because packages are immutable and
2271
+ cannot be owned by an address.
2272
+ """
2273
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
2274
+ """
2275
+ The domain explicitly configured as the default domain pointing to this object.
2276
+ """
2277
+ defaultSuinsName(format: DomainFormat): String
2278
+ """
2279
+ The SuinsRegistration NFTs owned by this package. These grant the owner the capability to
2280
+ manage the associated domain.
2281
+
2282
+ Note that objects owned by a package are inaccessible, because packages are immutable and
2283
+ cannot be owned by an address.
2284
+ """
2285
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
2286
+ version: UInt53!
2287
+ """
2288
+ The current status of the object as read from the off-chain store. The possible states are:
2289
+ NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or
2290
+ system package upgrade transaction. LIVE, the version returned is the most recent for the
2291
+ object, and it is not deleted or wrapped at that version. HISTORICAL, the object was
2292
+ referenced at a specific version or checkpoint, so is fetched from historical tables and may
2293
+ not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or
2294
+ wrapped and only partial information can be loaded."
2295
+ """
2296
+ status: ObjectKind!
2297
+ """
2298
+ 32-byte hash that identifies the package's contents, encoded as a Base58 string.
2299
+ """
2300
+ digest: String
2301
+ """
2302
+ The owner type of this object: Immutable, Shared, Parent, Address
2303
+ Packages are always Immutable.
2304
+ """
2305
+ owner: ObjectOwner
2306
+ """
2307
+ The transaction block that published or upgraded this package.
2308
+ """
2309
+ previousTransactionBlock: TransactionBlock
2310
+ """
2311
+ The amount of SUI we would rebate if this object gets deleted or mutated. This number is
2312
+ recalculated based on the present storage gas price.
2313
+
2314
+ Note that packages cannot be deleted or mutated, so this number is provided purely for
2315
+ reference.
2316
+ """
2317
+ storageRebate: BigInt
2318
+ """
2319
+ The transaction blocks that sent objects to this package.
2320
+
2321
+ Note that objects that have been sent to a package become inaccessible.
2322
+
2323
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
2324
+ results. It is required for queries that apply more than two complex filters (on function,
2325
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
2326
+ `serviceConfig.maxScanLimit`.
2327
+
2328
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
2329
+ results when paginating forward (`last` when paginating backwards). If there are more
2330
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
2331
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
2332
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
2333
+
2334
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
2335
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
2336
+ transactions in the scanning range have been visited.
2337
+
2338
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
2339
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
2340
+ `afterCheckpoint` and `atCheckpoint` filters.
2341
+ """
2342
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
2343
+ """
2344
+ The Base64-encoded BCS serialization of the package's content.
2345
+ """
2346
+ bcs: Base64
2347
+ """
2348
+ Fetch another version of this package (the package that shares this package's original ID,
2349
+ but has the specified `version`).
2350
+ """
2351
+ packageAtVersion(version: Int!): MovePackage
2352
+ """
2353
+ Fetch all versions of this package (packages that share this package's original ID),
2354
+ optionally bounding the versions exclusively from below with `afterVersion`, or from above
2355
+ with `beforeVersion`.
2356
+ """
2357
+ packageVersions(first: Int, after: String, last: Int, before: String, filter: MovePackageVersionFilter): MovePackageConnection!
2358
+ """
2359
+ Fetch the latest version of this package (the package with the highest `version` that shares
2360
+ this packages's original ID)
2361
+ """
2362
+ latestPackage: MovePackage!
2363
+ """
2364
+ A representation of the module called `name` in this package, including the
2365
+ structs and functions it defines.
2366
+ """
2367
+ module(name: String!): MoveModule
2368
+ """
2369
+ Paginate through the MoveModules defined in this package.
2370
+ """
2371
+ modules(first: Int, after: String, last: Int, before: String): MoveModuleConnection
2372
+ """
2373
+ The transitive dependencies of this package.
2374
+ """
2375
+ linkage: [Linkage!]
2376
+ """
2377
+ The (previous) versions of this package that introduced its types.
2378
+ """
2379
+ typeOrigins: [TypeOrigin!]
2380
+ """
2381
+ BCS representation of the package itself, as a MovePackage.
2382
+ """
2383
+ packageBcs: Base64
2384
+ """
2385
+ BCS representation of the package's modules. Modules appear as a sequence of pairs (module
2386
+ name, followed by module bytes), in alphabetic order by module name.
2387
+ """
2388
+ moduleBcs: Base64
2389
+ }
2390
+
2391
+ """
2392
+ Filter for paginating `MovePackage`s that were created within a range of checkpoints.
2393
+ """
2394
+ input MovePackageCheckpointFilter {
2395
+ """
2396
+ Fetch packages that were published strictly after this checkpoint. Omitting this fetches
2397
+ packages published since genesis.
2398
+ """
2399
+ afterCheckpoint: UInt53
2400
+ """
2401
+ Fetch packages that were published strictly before this checkpoint. Omitting this fetches
2402
+ packages published up to the latest checkpoint (inclusive).
2403
+ """
2404
+ beforeCheckpoint: UInt53
2405
+ }
2406
+
2407
+ type MovePackageConnection {
2408
+ """
2409
+ Information to aid in pagination.
2410
+ """
2411
+ pageInfo: PageInfo!
2412
+ """
2413
+ A list of edges.
2414
+ """
2415
+ edges: [MovePackageEdge!]!
2416
+ """
2417
+ A list of nodes.
2418
+ """
2419
+ nodes: [MovePackage!]!
2420
+ }
2421
+
2422
+ """
2423
+ An edge in a connection.
2424
+ """
2425
+ type MovePackageEdge {
2426
+ """
2427
+ The item at the end of the edge
2428
+ """
2429
+ node: MovePackage!
2430
+ """
2431
+ A cursor for use in pagination
2432
+ """
2433
+ cursor: String!
2434
+ }
2435
+
2436
+ """
2437
+ Filter for paginating versions of a given `MovePackage`.
2438
+ """
2439
+ input MovePackageVersionFilter {
2440
+ """
2441
+ Fetch versions of this package that are strictly newer than this version. Omitting this
2442
+ fetches versions since the original version.
2443
+ """
2444
+ afterVersion: UInt53
2445
+ """
2446
+ Fetch versions of this package that are strictly older than this version. Omitting this
2447
+ fetches versions up to the latest version (inclusive).
2448
+ """
2449
+ beforeVersion: UInt53
2450
+ }
2451
+
2452
+ """
2453
+ Description of a struct type, defined in a Move module.
2454
+ """
2455
+ type MoveStruct implements IMoveDatatype {
2456
+ """
2457
+ The module this struct was originally defined in.
2458
+ """
2459
+ module: MoveModule!
2460
+ """
2461
+ The struct's (unqualified) type name.
2462
+ """
2463
+ name: String!
2464
+ """
2465
+ Abilities this struct has.
2466
+ """
2467
+ abilities: [MoveAbility!]
2468
+ """
2469
+ Constraints on the struct's formal type parameters. Move bytecode does not name type
2470
+ parameters, so when they are referenced (e.g. in field types) they are identified by their
2471
+ index in this list.
2472
+ """
2473
+ typeParameters: [MoveStructTypeParameter!]
2474
+ """
2475
+ The names and types of the struct's fields. Field types reference type parameters, by their
2476
+ index in the defining struct's `typeParameters` list.
2477
+ """
2478
+ fields: [MoveField!]
2479
+ }
2480
+
2481
+ type MoveStructConnection {
2482
+ """
2483
+ Information to aid in pagination.
2484
+ """
2485
+ pageInfo: PageInfo!
2486
+ """
2487
+ A list of edges.
2488
+ """
2489
+ edges: [MoveStructEdge!]!
2490
+ """
2491
+ A list of nodes.
2492
+ """
2493
+ nodes: [MoveStruct!]!
2494
+ }
2495
+
2496
+ """
2497
+ An edge in a connection.
2498
+ """
2499
+ type MoveStructEdge {
2500
+ """
2501
+ The item at the end of the edge
2502
+ """
2503
+ node: MoveStruct!
2504
+ """
2505
+ A cursor for use in pagination
2506
+ """
2507
+ cursor: String!
2508
+ }
2509
+
2510
+ type MoveStructTypeParameter {
2511
+ constraints: [MoveAbility!]!
2512
+ isPhantom: Boolean!
2513
+ }
2514
+
2515
+ """
2516
+ Represents concrete types (no type parameters, no references).
2517
+ """
2518
+ type MoveType {
2519
+ """
2520
+ Flat representation of the type signature, as a displayable string.
2521
+ """
2522
+ repr: String!
2523
+ """
2524
+ Structured representation of the type signature.
2525
+ """
2526
+ signature: MoveTypeSignature!
2527
+ """
2528
+ Structured representation of the "shape" of values that match this type. May return no
2529
+ layout if the type is invalid.
2530
+ """
2531
+ layout: MoveTypeLayout
2532
+ """
2533
+ The abilities this concrete type has. Returns no abilities if the type is invalid.
2534
+ """
2535
+ abilities: [MoveAbility!]
2536
+ }
2537
+
2538
+ """
2539
+ The shape of a concrete Move Type (a type with all its type parameters instantiated with concrete types), corresponding to the following recursive type:
2540
+
2541
+ type MoveTypeLayout =
2542
+ "address"
2543
+ | "bool"
2544
+ | "u8" | "u16" | ... | "u256"
2545
+ | { vector: MoveTypeLayout }
2546
+ | {
2547
+ struct: {
2548
+ type: string,
2549
+ fields: [{ name: string, layout: MoveTypeLayout }],
2550
+ }
2551
+ }
2552
+ | { enum: [{
2553
+ type: string,
2554
+ variants: [{
2555
+ name: string,
2556
+ fields: [{ name: string, layout: MoveTypeLayout }],
2557
+ }]
2558
+ }]
2559
+ }
2560
+ """
2561
+ scalar MoveTypeLayout
2562
+
2563
+ """
2564
+ The signature of a concrete Move Type (a type with all its type parameters instantiated with concrete types, that contains no references), corresponding to the following recursive type:
2565
+
2566
+ type MoveTypeSignature =
2567
+ "address"
2568
+ | "bool"
2569
+ | "u8" | "u16" | ... | "u256"
2570
+ | { vector: MoveTypeSignature }
2571
+ | {
2572
+ datatype: {
2573
+ package: string,
2574
+ module: string,
2575
+ type: string,
2576
+ typeParameters: [MoveTypeSignature],
2577
+ }
2578
+ }
2579
+ """
2580
+ scalar MoveTypeSignature
2581
+
2582
+ type MoveValue {
2583
+ """
2584
+ The value's Move type.
2585
+ """
2586
+ type: MoveType!
2587
+ """
2588
+ The BCS representation of this value, Base64 encoded.
2589
+ """
2590
+ bcs: Base64!
2591
+ """
2592
+ Structured contents of a Move value.
2593
+ """
2594
+ data: MoveData!
2595
+ """
2596
+ Representation of a Move value in JSON, where:
2597
+
2598
+ - Addresses, IDs, and UIDs are represented in canonical form, as JSON strings.
2599
+ - Bools are represented by JSON boolean literals.
2600
+ - u8, u16, and u32 are represented as JSON numbers.
2601
+ - u64, u128, and u256 are represented as JSON strings.
2602
+ - Vectors are represented by JSON arrays.
2603
+ - Structs are represented by JSON objects.
2604
+ - Empty optional values are represented by `null`.
2605
+
2606
+ This form is offered as a less verbose convenience in cases where the layout of the type is
2607
+ known by the client.
2608
+ """
2609
+ json: JSON!
2610
+ }
2611
+
2612
+ """
2613
+ The visibility modifier describes which modules can access this module member.
2614
+ By default, a module member can be called only within the same module.
2615
+ """
2616
+ enum MoveVisibility {
2617
+ """
2618
+ A public member can be accessed by any module.
2619
+ """
2620
+ PUBLIC
2621
+ """
2622
+ A private member can be accessed in the module it is defined in.
2623
+ """
2624
+ PRIVATE
2625
+ """
2626
+ A friend member can be accessed in the module it is defined in and any other module in
2627
+ its package that is explicitly specified in its friend list.
2628
+ """
2629
+ FRIEND
2630
+ }
2631
+
2632
+ """
2633
+ Mutations are used to write to the Sui network.
2634
+ """
2635
+ type Mutation {
2636
+ """
2637
+ Execute a transaction, committing its effects on chain.
2638
+
2639
+ - `txBytes` is a `TransactionData` struct that has been BCS-encoded and then Base64-encoded.
2640
+ - `signatures` are a list of `flag || signature || pubkey` bytes, Base64-encoded.
2641
+
2642
+ Waits until the transaction has reached finality on chain to return its transaction digest,
2643
+ or returns the error that prevented finality if that was not possible. A transaction is
2644
+ final when its effects are guaranteed on chain (it cannot be revoked).
2645
+
2646
+ There may be a delay between transaction finality and when GraphQL requests (including the
2647
+ request that issued the transaction) reflect its effects. As a result, queries that depend
2648
+ on indexing the state of the chain (e.g. contents of output objects, address-level balance
2649
+ information at the time of the transaction), must wait for indexing to catch up by polling
2650
+ for the transaction digest using `Query.transactionBlock`.
2651
+ """
2652
+ executeTransactionBlock(txBytes: String!, signatures: [String!]!): ExecutionResult!
2653
+ }
2654
+
2655
+ """
2656
+ An object in Sui is a package (set of Move bytecode modules) or object (typed data structure
2657
+ with fields) with additional metadata detailing its id, version, transaction digest, owner
2658
+ field indicating how this object can be accessed.
2659
+ """
2660
+ type Object implements IObject & IOwner {
2661
+ address: SuiAddress!
2662
+ """
2663
+ Objects owned by this object, optionally `filter`-ed.
2664
+ """
2665
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
2666
+ """
2667
+ Total balance of all coins with marker type owned by this object. If type is not supplied,
2668
+ it defaults to `0x2::sui::SUI`.
2669
+ """
2670
+ balance(type: String): Balance
2671
+ """
2672
+ The balances of all coin types owned by this object.
2673
+ """
2674
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
2675
+ """
2676
+ The coin objects for this object.
2677
+
2678
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
2679
+ """
2680
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
2681
+ """
2682
+ The `0x3::staking_pool::StakedSui` objects owned by this object.
2683
+ """
2684
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
2685
+ """
2686
+ The domain explicitly configured as the default domain pointing to this object.
2687
+ """
2688
+ defaultSuinsName(format: DomainFormat): String
2689
+ """
2690
+ The SuinsRegistration NFTs owned by this object. These grant the owner the capability to
2691
+ manage the associated domain.
2692
+ """
2693
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
2694
+ version: UInt53!
2695
+ """
2696
+ The current status of the object as read from the off-chain store. The possible states are:
2697
+ NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or
2698
+ system package upgrade transaction. LIVE, the version returned is the most recent for the
2699
+ object, and it is not deleted or wrapped at that version. HISTORICAL, the object was
2700
+ referenced at a specific version or checkpoint, so is fetched from historical tables and may
2701
+ not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or
2702
+ wrapped and only partial information can be loaded."
2703
+ """
2704
+ status: ObjectKind!
2705
+ """
2706
+ 32-byte hash that identifies the object's current contents, encoded as a Base58 string.
2707
+ """
2708
+ digest: String
2709
+ """
2710
+ The owner type of this object: Immutable, Shared, Parent, Address
2711
+ Immutable and Shared Objects do not have owners.
2712
+ """
2713
+ owner: ObjectOwner
2714
+ """
2715
+ The transaction block that created this version of the object.
2716
+ """
2717
+ previousTransactionBlock: TransactionBlock
2718
+ """
2719
+ The amount of SUI we would rebate if this object gets deleted or mutated. This number is
2720
+ recalculated based on the present storage gas price.
2721
+ """
2722
+ storageRebate: BigInt
2723
+ """
2724
+ The transaction blocks that sent objects to this object.
2725
+
2726
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
2727
+ results. It is required for queries that apply more than two complex filters (on function,
2728
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
2729
+ `serviceConfig.maxScanLimit`.
2730
+
2731
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
2732
+ results when paginating forward (`last` when paginating backwards). If there are more
2733
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
2734
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
2735
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
2736
+
2737
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
2738
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
2739
+ transactions in the scanning range have been visited.
2740
+
2741
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
2742
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
2743
+ `afterCheckpoint` and `atCheckpoint` filters.
2744
+ """
2745
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
2746
+ """
2747
+ The Base64-encoded BCS serialization of the object's content.
2748
+ """
2749
+ bcs: Base64
2750
+ """
2751
+ The set of named templates defined on-chain for the type of this object, to be handled
2752
+ off-chain. The server substitutes data from the object into these templates to generate a
2753
+ display string per template.
2754
+ """
2755
+ display: [DisplayEntry!]
2756
+ """
2757
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose
2758
+ type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS
2759
+ contents, Base64 encoded.
2760
+
2761
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
2762
+ type.
2763
+ """
2764
+ dynamicField(name: DynamicFieldName!): DynamicField
2765
+ """
2766
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values
2767
+ whose type have `copy`, `drop`, and `store`, and are specified using their type, and their
2768
+ BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed
2769
+ off-chain directly via its address (e.g. using `Query.object`).
2770
+
2771
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
2772
+ type.
2773
+ """
2774
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
2775
+ """
2776
+ The dynamic fields and dynamic object fields on an object.
2777
+
2778
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
2779
+ type.
2780
+ """
2781
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
2782
+ """
2783
+ Attempts to convert the object into a MoveObject
2784
+ """
2785
+ asMoveObject: MoveObject
2786
+ """
2787
+ Attempts to convert the object into a MovePackage
2788
+ """
2789
+ asMovePackage: MovePackage
2790
+ }
2791
+
2792
+ """
2793
+ Effect on an individual Object (keyed by its ID).
2794
+ """
2795
+ type ObjectChange {
2796
+ """
2797
+ The address of the object that has changed.
2798
+ """
2799
+ address: SuiAddress!
2800
+ """
2801
+ The contents of the object immediately before the transaction.
2802
+ """
2803
+ inputState: Object
2804
+ """
2805
+ The contents of the object immediately after the transaction.
2806
+ """
2807
+ outputState: Object
2808
+ """
2809
+ Whether the ID was created in this transaction.
2810
+ """
2811
+ idCreated: Boolean
2812
+ """
2813
+ Whether the ID was deleted in this transaction.
2814
+ """
2815
+ idDeleted: Boolean
2816
+ }
2817
+
2818
+ type ObjectChangeConnection {
2819
+ """
2820
+ Information to aid in pagination.
2821
+ """
2822
+ pageInfo: PageInfo!
2823
+ """
2824
+ A list of edges.
2825
+ """
2826
+ edges: [ObjectChangeEdge!]!
2827
+ """
2828
+ A list of nodes.
2829
+ """
2830
+ nodes: [ObjectChange!]!
2831
+ }
2832
+
2833
+ """
2834
+ An edge in a connection.
2835
+ """
2836
+ type ObjectChangeEdge {
2837
+ """
2838
+ The item at the end of the edge
2839
+ """
2840
+ node: ObjectChange!
2841
+ """
2842
+ A cursor for use in pagination
2843
+ """
2844
+ cursor: String!
2845
+ }
2846
+
2847
+ type ObjectConnection {
2848
+ """
2849
+ Information to aid in pagination.
2850
+ """
2851
+ pageInfo: PageInfo!
2852
+ """
2853
+ A list of edges.
2854
+ """
2855
+ edges: [ObjectEdge!]!
2856
+ """
2857
+ A list of nodes.
2858
+ """
2859
+ nodes: [Object!]!
2860
+ }
2861
+
2862
+ """
2863
+ An edge in a connection.
2864
+ """
2865
+ type ObjectEdge {
2866
+ """
2867
+ The item at the end of the edge
2868
+ """
2869
+ node: Object!
2870
+ """
2871
+ A cursor for use in pagination
2872
+ """
2873
+ cursor: String!
2874
+ }
2875
+
2876
+ """
2877
+ Constrains the set of objects returned. All filters are optional, and the resulting set of
2878
+ objects are ones whose
2879
+
2880
+ - Type matches the `type` filter,
2881
+ - AND, whose owner matches the `owner` filter,
2882
+ - AND, whose ID is in `objectIds` OR whose ID and version is in `objectKeys`.
2883
+ """
2884
+ input ObjectFilter {
2885
+ """
2886
+ Filter objects by their type's `package`, `package::module`, or their fully qualified type
2887
+ name.
2888
+
2889
+ Generic types can be queried by either the generic type name, e.g. `0x2::coin::Coin`, or by
2890
+ the full type name, such as `0x2::coin::Coin<0x2::sui::SUI>`.
2891
+ """
2892
+ type: String
2893
+ """
2894
+ Filter for live objects by their current owners.
2895
+ """
2896
+ owner: SuiAddress
2897
+ """
2898
+ Filter for live objects by their IDs.
2899
+ """
2900
+ objectIds: [SuiAddress!]
2901
+ """
2902
+ Filter for live or potentially historical objects by their ID and version.
2903
+ """
2904
+ objectKeys: [ObjectKey!]
2905
+ }
2906
+
2907
+ input ObjectKey {
2908
+ objectId: SuiAddress!
2909
+ version: UInt53!
2910
+ }
2911
+
2912
+ enum ObjectKind {
2913
+ """
2914
+ The object is loaded from serialized data, such as the contents of a transaction that hasn't
2915
+ been indexed yet.
2916
+ """
2917
+ NOT_INDEXED
2918
+ """
2919
+ The object is fetched from the index.
2920
+ """
2921
+ INDEXED
2922
+ }
2923
+
2924
+ """
2925
+ The object's owner type: Immutable, Shared, Parent, or Address.
2926
+ """
2927
+ union ObjectOwner = Immutable | Shared | Parent | AddressOwner | ConsensusV2
2928
+
2929
+ input ObjectRef {
2930
+ """
2931
+ ID of the object.
2932
+ """
2933
+ address: SuiAddress!
2934
+ """
2935
+ Version or sequence number of the object.
2936
+ """
2937
+ version: UInt53!
2938
+ """
2939
+ Digest of the object.
2940
+ """
2941
+ digest: String!
2942
+ }
2943
+
2944
+ """
2945
+ Represents types that could contain references or free type parameters. Such types can appear
2946
+ as function parameters, in fields of structs, or as actual type parameter.
2947
+ """
2948
+ type OpenMoveType {
2949
+ """
2950
+ Structured representation of the type signature.
2951
+ """
2952
+ signature: OpenMoveTypeSignature!
2953
+ """
2954
+ Flat representation of the type signature, as a displayable string.
2955
+ """
2956
+ repr: String!
2957
+ }
2958
+
2959
+ """
2960
+ The shape of an abstract Move Type (a type that can contain free type parameters, and can optionally be taken by reference), corresponding to the following recursive type:
2961
+
2962
+ type OpenMoveTypeSignature = {
2963
+ ref: ("&" | "&mut")?,
2964
+ body: OpenMoveTypeSignatureBody,
2965
+ }
2966
+
2967
+ type OpenMoveTypeSignatureBody =
2968
+ "address"
2969
+ | "bool"
2970
+ | "u8" | "u16" | ... | "u256"
2971
+ | { vector: OpenMoveTypeSignatureBody }
2972
+ | {
2973
+ datatype {
2974
+ package: string,
2975
+ module: string,
2976
+ type: string,
2977
+ typeParameters: [OpenMoveTypeSignatureBody]
2978
+ }
2979
+ }
2980
+ | { typeParameter: number }
2981
+ """
2982
+ scalar OpenMoveTypeSignature
2983
+
2984
+ """
2985
+ A Move object, either immutable, or owned mutable.
2986
+ """
2987
+ type OwnedOrImmutable {
2988
+ """
2989
+ ID of the object being read.
2990
+ """
2991
+ address: SuiAddress!
2992
+ """
2993
+ Version of the object being read.
2994
+ """
2995
+ version: UInt53!
2996
+ """
2997
+ 32-byte hash that identifies the object's contents at this version, encoded as a Base58
2998
+ string.
2999
+ """
3000
+ digest: String!
3001
+ """
3002
+ The object at this version. May not be available due to pruning.
3003
+ """
3004
+ object: Object
3005
+ }
3006
+
3007
+ """
3008
+ An Owner is an entity that can own an object. Each Owner is identified by a SuiAddress which
3009
+ represents either an Address (corresponding to a public key of an account) or an Object, but
3010
+ never both (it is not known up-front whether a given Owner is an Address or an Object).
3011
+ """
3012
+ type Owner implements IOwner {
3013
+ address: SuiAddress!
3014
+ """
3015
+ Objects owned by this object or address, optionally `filter`-ed.
3016
+ """
3017
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
3018
+ """
3019
+ Total balance of all coins with marker type owned by this object or address. If type is not
3020
+ supplied, it defaults to `0x2::sui::SUI`.
3021
+ """
3022
+ balance(type: String): Balance
3023
+ """
3024
+ The balances of all coin types owned by this object or address.
3025
+ """
3026
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
3027
+ """
3028
+ The coin objects for this object or address.
3029
+
3030
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
3031
+ """
3032
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
3033
+ """
3034
+ The `0x3::staking_pool::StakedSui` objects owned by this object or address.
3035
+ """
3036
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
3037
+ """
3038
+ The domain explicitly configured as the default domain pointing to this object or address.
3039
+ """
3040
+ defaultSuinsName(format: DomainFormat): String
3041
+ """
3042
+ The SuinsRegistration NFTs owned by this object or address. These grant the owner the
3043
+ capability to manage the associated domain.
3044
+ """
3045
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
3046
+ asAddress: Address
3047
+ asObject: Object
3048
+ """
3049
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose
3050
+ type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS
3051
+ contents, Base64 encoded.
3052
+
3053
+ This field exists as a convenience when accessing a dynamic field on a wrapped object.
3054
+ """
3055
+ dynamicField(name: DynamicFieldName!): DynamicField
3056
+ """
3057
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values
3058
+ whose type have `copy`, `drop`, and `store`, and are specified using their type, and their
3059
+ BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed
3060
+ off-chain directly via its address (e.g. using `Query.object`).
3061
+
3062
+ This field exists as a convenience when accessing a dynamic field on a wrapped object.
3063
+ """
3064
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
3065
+ """
3066
+ The dynamic fields and dynamic object fields on an object.
3067
+
3068
+ This field exists as a convenience when accessing a dynamic field on a wrapped object.
3069
+ """
3070
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
3071
+ }
3072
+
3073
+ """
3074
+ Information about pagination in a connection
3075
+ """
3076
+ type PageInfo {
3077
+ """
3078
+ When paginating backwards, are there more items?
3079
+ """
3080
+ hasPreviousPage: Boolean!
3081
+ """
3082
+ When paginating forwards, are there more items?
3083
+ """
3084
+ hasNextPage: Boolean!
3085
+ """
3086
+ When paginating backwards, the cursor to continue.
3087
+ """
3088
+ startCursor: String
3089
+ """
3090
+ When paginating forwards, the cursor to continue.
3091
+ """
3092
+ endCursor: String
3093
+ }
3094
+
3095
+ """
3096
+ If the object's owner is a Parent, this object is part of a dynamic field (it is the value of
3097
+ the dynamic field, or the intermediate Field object itself), and it is owned by another object.
3098
+
3099
+ Although its owner is guaranteed to be an object, it is exposed as an Owner, as the parent
3100
+ object could be wrapped and therefore not directly accessible.
3101
+ """
3102
+ type Parent {
3103
+ parent: Owner
3104
+ }
3105
+
3106
+ """
3107
+ A single transaction, or command, in the programmable transaction block.
3108
+ """
3109
+ union ProgrammableTransaction = MoveCallTransaction | TransferObjectsTransaction | SplitCoinsTransaction | MergeCoinsTransaction | PublishTransaction | UpgradeTransaction | MakeMoveVecTransaction
3110
+
3111
+ """
3112
+ A user transaction that allows the interleaving of native commands (like transfer, split coins,
3113
+ merge coins, etc) and move calls, executed atomically.
3114
+ """
3115
+ type ProgrammableTransactionBlock {
3116
+ """
3117
+ Input objects or primitive values.
3118
+ """
3119
+ inputs(first: Int, after: String, last: Int, before: String): TransactionInputConnection!
3120
+ """
3121
+ The transaction commands, executed sequentially.
3122
+ """
3123
+ transactions(first: Int, after: String, last: Int, before: String): ProgrammableTransactionConnection!
3124
+ }
3125
+
3126
+ type ProgrammableTransactionConnection {
3127
+ """
3128
+ Information to aid in pagination.
3129
+ """
3130
+ pageInfo: PageInfo!
3131
+ """
3132
+ A list of edges.
3133
+ """
3134
+ edges: [ProgrammableTransactionEdge!]!
3135
+ """
3136
+ A list of nodes.
3137
+ """
3138
+ nodes: [ProgrammableTransaction!]!
3139
+ }
3140
+
3141
+ """
3142
+ An edge in a connection.
3143
+ """
3144
+ type ProgrammableTransactionEdge {
3145
+ """
3146
+ The item at the end of the edge
3147
+ """
3148
+ node: ProgrammableTransaction!
3149
+ """
3150
+ A cursor for use in pagination
3151
+ """
3152
+ cursor: String!
3153
+ }
3154
+
3155
+ """
3156
+ A single protocol configuration value.
3157
+ """
3158
+ type ProtocolConfigAttr {
3159
+ key: String!
3160
+ value: String
3161
+ }
3162
+
3163
+ """
3164
+ Whether or not a single feature is enabled in the protocol config.
3165
+ """
3166
+ type ProtocolConfigFeatureFlag {
3167
+ key: String!
3168
+ value: Boolean!
3169
+ }
3170
+
3171
+ """
3172
+ Constants that control how the chain operates.
3173
+
3174
+ These can only change during protocol upgrades which happen on epoch boundaries.
3175
+ """
3176
+ type ProtocolConfigs {
3177
+ """
3178
+ The protocol is not required to change on every epoch boundary, so the protocol version
3179
+ tracks which change to the protocol these configs are from.
3180
+ """
3181
+ protocolVersion: UInt53!
3182
+ """
3183
+ List all available feature flags and their values. Feature flags are a form of boolean
3184
+ configuration that are usually used to gate features while they are in development. Once a
3185
+ flag has been enabled, it is rare for it to be disabled.
3186
+ """
3187
+ featureFlags: [ProtocolConfigFeatureFlag!]!
3188
+ """
3189
+ List all available configurations and their values. These configurations can take any value
3190
+ (but they will all be represented in string form), and do not include feature flags.
3191
+ """
3192
+ configs: [ProtocolConfigAttr!]!
3193
+ """
3194
+ Query for the value of the configuration with name `key`.
3195
+ """
3196
+ config(key: String!): ProtocolConfigAttr
3197
+ """
3198
+ Query for the state of the feature flag with name `key`.
3199
+ """
3200
+ featureFlag(key: String!): ProtocolConfigFeatureFlag
3201
+ }
3202
+
3203
+ """
3204
+ Publishes a Move Package.
3205
+ """
3206
+ type PublishTransaction {
3207
+ """
3208
+ Bytecode for the modules to be published, BCS serialized and Base64 encoded.
3209
+ """
3210
+ modules: [Base64!]!
3211
+ """
3212
+ IDs of the transitive dependencies of the package to be published.
3213
+ """
3214
+ dependencies: [SuiAddress!]!
3215
+ }
3216
+
3217
+ """
3218
+ BCS encoded primitive value (not an object or Move struct).
3219
+ """
3220
+ type Pure {
3221
+ """
3222
+ BCS serialized and Base64 encoded primitive value.
3223
+ """
3224
+ bytes: Base64!
3225
+ }
3226
+
3227
+ type Query {
3228
+ """
3229
+ First four bytes of the network's genesis checkpoint digest (uniquely identifies the
3230
+ network).
3231
+ """
3232
+ chainIdentifier: String!
3233
+ """
3234
+ Range of checkpoints that the RPC has data available for (for data
3235
+ that can be tied to a particular checkpoint).
3236
+ """
3237
+ availableRange: AvailableRange!
3238
+ """
3239
+ Configuration for this RPC service
3240
+ """
3241
+ serviceConfig: ServiceConfig!
3242
+ """
3243
+ Simulate running a transaction to inspect its effects without
3244
+ committing to them on-chain.
3245
+
3246
+ `txBytes` either a `TransactionData` struct or a `TransactionKind`
3247
+ struct, BCS-encoded and then Base64-encoded. The expected
3248
+ type is controlled by the presence or absence of `txMeta`: If
3249
+ present, `txBytes` is assumed to be a `TransactionKind`, if
3250
+ absent, then `TransactionData`.
3251
+
3252
+ `txMeta` the data that is missing from a `TransactionKind` to make
3253
+ a `TransactionData` (sender address and gas information). All
3254
+ its fields are nullable.
3255
+
3256
+ `skipChecks` optional flag to disable the usual verification
3257
+ checks that prevent access to objects that are owned by
3258
+ addresses other than the sender, and calling non-public,
3259
+ non-entry functions, and some other checks. Defaults to false.
3260
+ """
3261
+ dryRunTransactionBlock(txBytes: String!, txMeta: TransactionMetadata, skipChecks: Boolean): DryRunResult!
3262
+ """
3263
+ Look up an Owner by its SuiAddress.
3264
+
3265
+ `rootVersion` represents the version of the root object in some nested chain of dynamic
3266
+ fields. It allows consistent historical queries for the case of wrapped objects, which don't
3267
+ have a version. For example, if querying the dynamic field of a table wrapped in a parent
3268
+ object, passing the parent object's version here will ensure we get the dynamic field's
3269
+ state at the moment that parent's version was created.
3270
+
3271
+ Also, if this Owner is an object itself, `rootVersion` will be used to bound its version
3272
+ from above when querying `Owner.asObject`. This can be used, for example, to get the
3273
+ contents of a dynamic object field when its parent was at `rootVersion`.
3274
+
3275
+ If `rootVersion` is omitted, dynamic fields will be from a consistent snapshot of the Sui
3276
+ state at the latest checkpoint known to the GraphQL RPC. Similarly, `Owner.asObject` will
3277
+ return the object's version at the latest checkpoint.
3278
+ """
3279
+ owner(address: SuiAddress!, rootVersion: UInt53): Owner
3280
+ """
3281
+ The object corresponding to the given address at the (optionally) given version.
3282
+ When no version is given, the latest version is returned.
3283
+ """
3284
+ object(address: SuiAddress!, version: UInt53): Object
3285
+ """
3286
+ The package corresponding to the given address (at the optionally given version).
3287
+
3288
+ When no version is given, the package is loaded directly from the address given. Otherwise,
3289
+ the address is translated before loading to point to the package whose original ID matches
3290
+ the package at `address`, but whose version is `version`. For non-system packages, this
3291
+ might result in a different address than `address` because different versions of a package,
3292
+ introduced by upgrades, exist at distinct addresses.
3293
+
3294
+ Note that this interpretation of `version` is different from a historical object read (the
3295
+ interpretation of `version` for the `object` query).
3296
+ """
3297
+ package(address: SuiAddress!, version: UInt53): MovePackage
3298
+ """
3299
+ The latest version of the package at `address`.
3300
+
3301
+ This corresponds to the package with the highest `version` that shares its original ID with
3302
+ the package at `address`.
3303
+ """
3304
+ latestPackage(address: SuiAddress!): MovePackage
3305
+ """
3306
+ Look-up an Account by its SuiAddress.
3307
+ """
3308
+ address(address: SuiAddress!): Address
3309
+ """
3310
+ Fetch a structured representation of a concrete type, including its layout information.
3311
+ Fails if the type is malformed.
3312
+ """
3313
+ type(type: String!): MoveType!
3314
+ """
3315
+ Fetch epoch information by ID (defaults to the latest epoch).
3316
+ """
3317
+ epoch(id: UInt53): Epoch
3318
+ """
3319
+ Fetch checkpoint information by sequence number or digest (defaults to the latest available
3320
+ checkpoint).
3321
+ """
3322
+ checkpoint(id: CheckpointId): Checkpoint
3323
+ """
3324
+ Fetch a transaction block by its transaction digest.
3325
+ """
3326
+ transactionBlock(digest: String!): TransactionBlock
3327
+ """
3328
+ The coin objects that exist in the network.
3329
+
3330
+ The type field is a string of the inner type of the coin by which to filter (e.g.
3331
+ `0x2::sui::SUI`). If no type is provided, it will default to `0x2::sui::SUI`.
3332
+ """
3333
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
3334
+ epochs(first: Int, after: String, last: Int, before: String): EpochConnection!
3335
+ """
3336
+ The checkpoints that exist in the network.
3337
+ """
3338
+ checkpoints(first: Int, after: String, last: Int, before: String): CheckpointConnection!
3339
+ """
3340
+ The transaction blocks that exist in the network.
3341
+
3342
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
3343
+ results. It is required for queries that apply more than two complex filters (on function,
3344
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
3345
+ `serviceConfig.maxScanLimit`.
3346
+
3347
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
3348
+ results when paginating forward (`last` when paginating backwards). If there are more
3349
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
3350
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
3351
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
3352
+
3353
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
3354
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
3355
+ transactions in the scanning range have been visited.
3356
+
3357
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
3358
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
3359
+ `afterCheckpoint` and `atCheckpoint` filters.
3360
+ """
3361
+ transactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
3362
+ """
3363
+ Query events that are emitted in the network.
3364
+ We currently do not support filtering by emitting module and event type
3365
+ at the same time so if both are provided in one filter, the query will error.
3366
+ """
3367
+ events(first: Int, after: String, last: Int, before: String, filter: EventFilter): EventConnection!
3368
+ """
3369
+ The objects that exist in the network.
3370
+ """
3371
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): ObjectConnection!
3372
+ """
3373
+ The Move packages that exist in the network, optionally filtered to be strictly before
3374
+ `beforeCheckpoint` and/or strictly after `afterCheckpoint`.
3375
+
3376
+ This query returns all versions of a given user package that appear between the specified
3377
+ checkpoints, but only records the latest versions of system packages.
3378
+ """
3379
+ packages(first: Int, after: String, last: Int, before: String, filter: MovePackageCheckpointFilter): MovePackageConnection!
3380
+ """
3381
+ Fetch all versions of package at `address` (packages that share this package's original ID),
3382
+ optionally bounding the versions exclusively from below with `afterVersion`, or from above
3383
+ with `beforeVersion`.
3384
+ """
3385
+ packageVersions(first: Int, after: String, last: Int, before: String, address: SuiAddress!, filter: MovePackageVersionFilter): MovePackageConnection!
3386
+ """
3387
+ Fetch the protocol config by protocol version (defaults to the latest protocol
3388
+ version known to the GraphQL service).
3389
+ """
3390
+ protocolConfig(protocolVersion: UInt53): ProtocolConfigs!
3391
+ """
3392
+ Resolves a SuiNS `domain` name to an address, if it has been bound.
3393
+ """
3394
+ resolveSuinsAddress(domain: String!): Address
3395
+ """
3396
+ Fetch a package by its name (using dot move service)
3397
+ """
3398
+ packageByName(name: String!): MovePackage
3399
+ """
3400
+ Fetch a type that includes dot move service names in it.
3401
+ """
3402
+ typeByName(name: String!): MoveType!
3403
+ """
3404
+ The coin metadata associated with the given coin type. Note that if the latest version of
3405
+ the coin's metadata is wrapped or deleted, it will not be found.
3406
+ """
3407
+ coinMetadata(coinType: String!): CoinMetadata
3408
+ """
3409
+ Verify a zkLogin signature based on the provided transaction or personal message
3410
+ based on current epoch, chain id, and latest JWKs fetched on-chain. If the
3411
+ signature is valid, the function returns a `ZkLoginVerifyResult` with success as
3412
+ true and an empty list of errors. If the signature is invalid, the function returns
3413
+ a `ZkLoginVerifyResult` with success as false with a list of errors.
3414
+
3415
+ - `bytes` is either the personal message in raw bytes or transaction data bytes in
3416
+ BCS-encoded and then Base64-encoded.
3417
+ - `signature` is a serialized zkLogin signature that is Base64-encoded.
3418
+ - `intentScope` is an enum that specifies the intent scope to be used to parse bytes.
3419
+ - `author` is the address of the signer of the transaction or personal msg.
3420
+ """
3421
+ verifyZkloginSignature(bytes: Base64!, signature: Base64!, intentScope: ZkLoginIntentScope!, author: SuiAddress!): ZkLoginVerifyResult!
3422
+ }
3423
+
3424
+ type RandomnessStateCreateTransaction {
3425
+ """
3426
+ A workaround to define an empty variant of a GraphQL union.
3427
+ """
3428
+ _: Boolean
3429
+ }
3430
+
3431
+ """
3432
+ System transaction to update the source of on-chain randomness.
3433
+ """
3434
+ type RandomnessStateUpdateTransaction {
3435
+ """
3436
+ Epoch of the randomness state update transaction.
3437
+ """
3438
+ epoch: Epoch
3439
+ """
3440
+ Randomness round of the update.
3441
+ """
3442
+ randomnessRound: UInt53!
3443
+ """
3444
+ Updated random bytes, encoded as Base64.
3445
+ """
3446
+ randomBytes: Base64!
3447
+ """
3448
+ The initial version the randomness object was shared at.
3449
+ """
3450
+ randomnessObjInitialSharedVersion: UInt53!
3451
+ }
3452
+
3453
+ """
3454
+ A Move object that can be received in this transaction.
3455
+ """
3456
+ type Receiving {
3457
+ """
3458
+ ID of the object being read.
3459
+ """
3460
+ address: SuiAddress!
3461
+ """
3462
+ Version of the object being read.
3463
+ """
3464
+ version: UInt53!
3465
+ """
3466
+ 32-byte hash that identifies the object's contents at this version, encoded as a Base58
3467
+ string.
3468
+ """
3469
+ digest: String!
3470
+ """
3471
+ The object at this version. May not be available due to pruning.
3472
+ """
3473
+ object: Object
3474
+ }
3475
+
3476
+ """
3477
+ The result of another transaction command.
3478
+ """
3479
+ type Result {
3480
+ """
3481
+ The index of the previous command (0-indexed) that returned this result.
3482
+ """
3483
+ cmd: Int!
3484
+ """
3485
+ If the previous command returns multiple values, this is the index of the individual result
3486
+ among the multiple results from that command (also 0-indexed).
3487
+ """
3488
+ ix: Int
3489
+ }
3490
+
3491
+ """
3492
+ Information about whether epoch changes are using safe mode.
3493
+ """
3494
+ type SafeMode {
3495
+ """
3496
+ Whether safe mode was used for the last epoch change. The system will retry a full epoch
3497
+ change on every epoch boundary and automatically reset this flag if so.
3498
+ """
3499
+ enabled: Boolean
3500
+ """
3501
+ Accumulated fees for computation and cost that have not been added to the various reward
3502
+ pools, because the full epoch change did not happen.
3503
+ """
3504
+ gasSummary: GasCostSummary
3505
+ }
3506
+
3507
+ """
3508
+ The enabled features and service limits configured by the server.
3509
+ """
3510
+ type ServiceConfig {
3511
+ """
3512
+ Check whether `feature` is enabled on this GraphQL service.
3513
+ """
3514
+ isEnabled(feature: Feature!): Boolean!
3515
+ """
3516
+ List of all features that are enabled on this GraphQL service.
3517
+ """
3518
+ enabledFeatures: [Feature!]!
3519
+ """
3520
+ The maximum depth a GraphQL query can be to be accepted by this service.
3521
+ """
3522
+ maxQueryDepth: Int!
3523
+ """
3524
+ The maximum number of nodes (field names) the service will accept in a single query.
3525
+ """
3526
+ maxQueryNodes: Int!
3527
+ """
3528
+ The maximum number of output nodes in a GraphQL response.
3529
+
3530
+ Non-connection nodes have a count of 1, while connection nodes are counted as
3531
+ the specified 'first' or 'last' number of items, or the default_page_size
3532
+ as set by the server if those arguments are not set.
3533
+
3534
+ Counts accumulate multiplicatively down the query tree. For example, if a query starts
3535
+ with a connection of first: 10 and has a field to a connection with last: 20, the count
3536
+ at the second level would be 200 nodes. This is then summed to the count of 10 nodes
3537
+ at the first level, for a total of 210 nodes.
3538
+ """
3539
+ maxOutputNodes: Int!
3540
+ """
3541
+ Maximum estimated cost of a database query used to serve a GraphQL request. This is
3542
+ measured in the same units that the database uses in EXPLAIN queries.
3543
+ """
3544
+ maxDbQueryCost: Int!
3545
+ """
3546
+ Default number of elements allowed on a single page of a connection.
3547
+ """
3548
+ defaultPageSize: Int!
3549
+ """
3550
+ Maximum number of elements allowed on a single page of a connection.
3551
+ """
3552
+ maxPageSize: Int!
3553
+ """
3554
+ Maximum time in milliseconds spent waiting for a response from fullnode after issuing a
3555
+ a transaction to execute. Note that the transaction may still succeed even in the case of a
3556
+ timeout. Transactions are idempotent, so a transaction that times out should be resubmitted
3557
+ until the network returns a definite response (success or failure, not timeout).
3558
+ """
3559
+ mutationTimeoutMs: Int!
3560
+ """
3561
+ Maximum time in milliseconds that will be spent to serve one query request.
3562
+ """
3563
+ requestTimeoutMs: Int!
3564
+ """
3565
+ The maximum bytes allowed for the `txBytes` and `signatures` fields of the GraphQL mutation
3566
+ `executeTransactionBlock` node, or for the `txBytes` of a `dryRunTransactionBlock`.
3567
+
3568
+ It is the value of the maximum transaction bytes (including the signatures) allowed by the
3569
+ protocol, plus the Base64 overhead (roughly 1/3 of the original string).
3570
+ """
3571
+ maxTransactionPayloadSize: Int!
3572
+ """
3573
+ The maximum bytes allowed for the JSON object in the request body of a GraphQL query, for
3574
+ the read part of the query.
3575
+ In case of mutations or dryRunTransactionBlocks the txBytes and signatures are not
3576
+ included in this limit.
3577
+ """
3578
+ maxQueryPayloadSize: Int!
3579
+ """
3580
+ Maximum nesting allowed in type arguments in Move Types resolved by this service.
3581
+ """
3582
+ maxTypeArgumentDepth: Int!
3583
+ """
3584
+ Maximum number of type arguments passed into a generic instantiation of a Move Type resolved
3585
+ by this service.
3586
+ """
3587
+ maxTypeArgumentWidth: Int!
3588
+ """
3589
+ Maximum number of structs that need to be processed when calculating the layout of a single
3590
+ Move Type.
3591
+ """
3592
+ maxTypeNodes: Int!
3593
+ """
3594
+ Maximum nesting allowed in struct fields when calculating the layout of a single Move Type.
3595
+ """
3596
+ maxMoveValueDepth: Int!
3597
+ """
3598
+ Maximum number of transaction ids that can be passed to a `TransactionBlockFilter`.
3599
+ """
3600
+ maxTransactionIds: Int!
3601
+ """
3602
+ Maximum number of candidates to scan when gathering a page of results.
3603
+ """
3604
+ maxScanLimit: Int!
3605
+ }
3606
+
3607
+ """
3608
+ A shared object is an object that is shared using the 0x2::transfer::share_object function.
3609
+ Unlike owned objects, once an object is shared, it stays mutable and is accessible by anyone.
3610
+ """
3611
+ type Shared {
3612
+ initialSharedVersion: UInt53!
3613
+ }
3614
+
3615
+ """
3616
+ A Move object that's shared.
3617
+ """
3618
+ type SharedInput {
3619
+ address: SuiAddress!
3620
+ """
3621
+ The version that this this object was shared at.
3622
+ """
3623
+ initialSharedVersion: UInt53!
3624
+ """
3625
+ Controls whether the transaction block can reference the shared object as a mutable
3626
+ reference or by value. This has implications for scheduling: Transactions that just read
3627
+ shared objects at a certain version (mutable = false) can be executed concurrently, while
3628
+ transactions that write shared objects (mutable = true) must be executed serially with
3629
+ respect to each other.
3630
+ """
3631
+ mutable: Boolean!
3632
+ }
3633
+
3634
+ """
3635
+ The transaction accpeted a shared object as input, but its execution was cancelled.
3636
+ """
3637
+ type SharedObjectCancelled {
3638
+ """
3639
+ ID of the shared object.
3640
+ """
3641
+ address: SuiAddress!
3642
+ """
3643
+ The assigned shared object version. It is a special version indicating transaction cancellation reason.
3644
+ """
3645
+ version: UInt53!
3646
+ }
3647
+
3648
+ """
3649
+ The transaction accepted a shared object as input, but it was deleted before the transaction
3650
+ executed.
3651
+ """
3652
+ type SharedObjectDelete {
3653
+ """
3654
+ ID of the shared object.
3655
+ """
3656
+ address: SuiAddress!
3657
+ """
3658
+ The version of the shared object that was assigned to this transaction during by consensus,
3659
+ during sequencing.
3660
+ """
3661
+ version: UInt53!
3662
+ """
3663
+ Whether this transaction intended to use this shared object mutably or not. See
3664
+ `SharedInput.mutable` for further details.
3665
+ """
3666
+ mutable: Boolean!
3667
+ }
3668
+
3669
+ """
3670
+ The transaction accepted a shared object as input, but only to read it.
3671
+ """
3672
+ type SharedObjectRead {
3673
+ """
3674
+ ID of the object being read.
3675
+ """
3676
+ address: SuiAddress!
3677
+ """
3678
+ Version of the object being read.
3679
+ """
3680
+ version: UInt53!
3681
+ """
3682
+ 32-byte hash that identifies the object's contents at this version, encoded as a Base58
3683
+ string.
3684
+ """
3685
+ digest: String!
3686
+ """
3687
+ The object at this version. May not be available due to pruning.
3688
+ """
3689
+ object: Object
3690
+ }
3691
+
3692
+ """
3693
+ Splits off coins with denominations in `amounts` from `coin`, returning multiple results (as
3694
+ many as there are amounts.)
3695
+ """
3696
+ type SplitCoinsTransaction {
3697
+ """
3698
+ The coin to split.
3699
+ """
3700
+ coin: TransactionArgument!
3701
+ """
3702
+ The denominations to split off from the coin.
3703
+ """
3704
+ amounts: [TransactionArgument!]!
3705
+ }
3706
+
3707
+ """
3708
+ The stake's possible status: active, pending, or unstaked.
3709
+ """
3710
+ enum StakeStatus {
3711
+ """
3712
+ The stake object is active in a staking pool and it is generating rewards.
3713
+ """
3714
+ ACTIVE
3715
+ """
3716
+ The stake awaits to join a staking pool in the next epoch.
3717
+ """
3718
+ PENDING
3719
+ """
3720
+ The stake is no longer active in any staking pool.
3721
+ """
3722
+ UNSTAKED
3723
+ }
3724
+
3725
+ """
3726
+ Parameters that control the distribution of the stake subsidy.
3727
+ """
3728
+ type StakeSubsidy {
3729
+ """
3730
+ SUI set aside for stake subsidies -- reduces over time as stake subsidies are paid out over
3731
+ time.
3732
+ """
3733
+ balance: BigInt
3734
+ """
3735
+ Number of times stake subsidies have been distributed subsidies are distributed with other
3736
+ staking rewards, at the end of the epoch.
3737
+ """
3738
+ distributionCounter: Int
3739
+ """
3740
+ Amount of stake subsidy deducted from the balance per distribution -- decays over time.
3741
+ """
3742
+ currentDistributionAmount: BigInt
3743
+ """
3744
+ Maximum number of stake subsidy distributions that occur with the same distribution amount
3745
+ (before the amount is reduced).
3746
+ """
3747
+ periodLength: Int
3748
+ """
3749
+ Percentage of the current distribution amount to deduct at the end of the current subsidy
3750
+ period, expressed in basis points.
3751
+ """
3752
+ decreaseRate: Int
3753
+ }
3754
+
3755
+ """
3756
+ Represents a `0x3::staking_pool::StakedSui` Move object on-chain.
3757
+ """
3758
+ type StakedSui implements IMoveObject & IObject & IOwner {
3759
+ address: SuiAddress!
3760
+ """
3761
+ Objects owned by this object, optionally `filter`-ed.
3762
+ """
3763
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
3764
+ """
3765
+ Total balance of all coins with marker type owned by this object. If type is not supplied,
3766
+ it defaults to `0x2::sui::SUI`.
3767
+ """
3768
+ balance(type: String): Balance
3769
+ """
3770
+ The balances of all coin types owned by this object.
3771
+ """
3772
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
3773
+ """
3774
+ The coin objects for this object.
3775
+
3776
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
3777
+ """
3778
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
3779
+ """
3780
+ The `0x3::staking_pool::StakedSui` objects owned by this object.
3781
+ """
3782
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
3783
+ """
3784
+ The domain explicitly configured as the default domain pointing to this object.
3785
+ """
3786
+ defaultSuinsName(format: DomainFormat): String
3787
+ """
3788
+ The SuinsRegistration NFTs owned by this object. These grant the owner the capability to
3789
+ manage the associated domain.
3790
+ """
3791
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
3792
+ version: UInt53!
3793
+ """
3794
+ The current status of the object as read from the off-chain store. The possible states are:
3795
+ NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or
3796
+ system package upgrade transaction. LIVE, the version returned is the most recent for the
3797
+ object, and it is not deleted or wrapped at that version. HISTORICAL, the object was
3798
+ referenced at a specific version or checkpoint, so is fetched from historical tables and may
3799
+ not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or
3800
+ wrapped and only partial information can be loaded."
3801
+ """
3802
+ status: ObjectKind!
3803
+ """
3804
+ 32-byte hash that identifies the object's contents, encoded as a Base58 string.
3805
+ """
3806
+ digest: String
3807
+ """
3808
+ The owner type of this object: Immutable, Shared, Parent, Address
3809
+ """
3810
+ owner: ObjectOwner
3811
+ """
3812
+ The transaction block that created this version of the object.
3813
+ """
3814
+ previousTransactionBlock: TransactionBlock
3815
+ """
3816
+ The amount of SUI we would rebate if this object gets deleted or mutated. This number is
3817
+ recalculated based on the present storage gas price.
3818
+ """
3819
+ storageRebate: BigInt
3820
+ """
3821
+ The transaction blocks that sent objects to this object.
3822
+
3823
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
3824
+ results. It is required for queries that apply more than two complex filters (on function,
3825
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
3826
+ `serviceConfig.maxScanLimit`.
3827
+
3828
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
3829
+ results when paginating forward (`last` when paginating backwards). If there are more
3830
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
3831
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
3832
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
3833
+
3834
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
3835
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
3836
+ transactions in the scanning range have been visited.
3837
+
3838
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
3839
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
3840
+ `afterCheckpoint` and `atCheckpoint` filters.
3841
+ """
3842
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
3843
+ """
3844
+ The Base64-encoded BCS serialization of the object's content.
3845
+ """
3846
+ bcs: Base64
3847
+ """
3848
+ Displays the contents of the Move object in a JSON string and through GraphQL types. Also
3849
+ provides the flat representation of the type signature, and the BCS of the corresponding
3850
+ data.
3851
+ """
3852
+ contents: MoveValue
3853
+ """
3854
+ Determines whether a transaction can transfer this object, using the TransferObjects
3855
+ transaction command or `sui::transfer::public_transfer`, both of which require the object to
3856
+ have the `key` and `store` abilities.
3857
+ """
3858
+ hasPublicTransfer: Boolean!
3859
+ """
3860
+ The set of named templates defined on-chain for the type of this object, to be handled
3861
+ off-chain. The server substitutes data from the object into these templates to generate a
3862
+ display string per template.
3863
+ """
3864
+ display: [DisplayEntry!]
3865
+ """
3866
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose
3867
+ type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS
3868
+ contents, Base64 encoded.
3869
+
3870
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
3871
+ type.
3872
+ """
3873
+ dynamicField(name: DynamicFieldName!): DynamicField
3874
+ """
3875
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values
3876
+ whose type have `copy`, `drop`, and `store`, and are specified using their type, and their
3877
+ BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed
3878
+ off-chain directly via its address (e.g. using `Query.object`).
3879
+
3880
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
3881
+ type.
3882
+ """
3883
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
3884
+ """
3885
+ The dynamic fields and dynamic object fields on an object.
3886
+
3887
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
3888
+ type.
3889
+ """
3890
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
3891
+ """
3892
+ A stake can be pending, active, or unstaked
3893
+ """
3894
+ stakeStatus: StakeStatus!
3895
+ """
3896
+ The epoch at which this stake became active.
3897
+ """
3898
+ activatedEpoch: Epoch
3899
+ """
3900
+ The epoch at which this object was requested to join a stake pool.
3901
+ """
3902
+ requestedEpoch: Epoch
3903
+ """
3904
+ The object id of the validator staking pool this stake belongs to.
3905
+ """
3906
+ poolId: SuiAddress
3907
+ """
3908
+ The SUI that was initially staked.
3909
+ """
3910
+ principal: BigInt
3911
+ """
3912
+ The estimated reward for this stake object, calculated as:
3913
+
3914
+ principal * (initial_stake_rate / current_stake_rate - 1.0)
3915
+
3916
+ Or 0, if this value is negative, where:
3917
+
3918
+ - `initial_stake_rate` is the stake rate at the epoch this stake was activated at.
3919
+ - `current_stake_rate` is the stake rate in the current epoch.
3920
+
3921
+ This value is only available if the stake is active.
3922
+ """
3923
+ estimatedReward: BigInt
3924
+ }
3925
+
3926
+ type StakedSuiConnection {
3927
+ """
3928
+ Information to aid in pagination.
3929
+ """
3930
+ pageInfo: PageInfo!
3931
+ """
3932
+ A list of edges.
3933
+ """
3934
+ edges: [StakedSuiEdge!]!
3935
+ """
3936
+ A list of nodes.
3937
+ """
3938
+ nodes: [StakedSui!]!
3939
+ }
3940
+
3941
+ """
3942
+ An edge in a connection.
3943
+ """
3944
+ type StakedSuiEdge {
3945
+ """
3946
+ The item at the end of the edge
3947
+ """
3948
+ node: StakedSui!
3949
+ """
3950
+ A cursor for use in pagination
3951
+ """
3952
+ cursor: String!
3953
+ }
3954
+
3955
+ """
3956
+ SUI set aside to account for objects stored on-chain.
3957
+ """
3958
+ type StorageFund {
3959
+ """
3960
+ Sum of storage rebates of live objects on chain.
3961
+ """
3962
+ totalObjectStorageRebates: BigInt
3963
+ """
3964
+ The portion of the storage fund that will never be refunded through storage rebates.
3965
+
3966
+ The system maintains an invariant that the sum of all storage fees into the storage fund is
3967
+ equal to the sum of of all storage rebates out, the total storage rebates remaining, and the
3968
+ non-refundable balance.
3969
+ """
3970
+ nonRefundableBalance: BigInt
3971
+ }
3972
+
3973
+
3974
+ """
3975
+ String containing 32B hex-encoded address, with a leading "0x". Leading zeroes can be omitted on input but will always appear in outputs (SuiAddress in output is guaranteed to be 66 characters long).
3976
+ """
3977
+ scalar SuiAddress
3978
+
3979
+ type SuinsRegistration implements IMoveObject & IObject & IOwner {
3980
+ address: SuiAddress!
3981
+ """
3982
+ Objects owned by this object, optionally `filter`-ed.
3983
+ """
3984
+ objects(first: Int, after: String, last: Int, before: String, filter: ObjectFilter): MoveObjectConnection!
3985
+ """
3986
+ Total balance of all coins with marker type owned by this object. If type is not supplied,
3987
+ it defaults to `0x2::sui::SUI`.
3988
+ """
3989
+ balance(type: String): Balance
3990
+ """
3991
+ The balances of all coin types owned by this object.
3992
+ """
3993
+ balances(first: Int, after: String, last: Int, before: String): BalanceConnection!
3994
+ """
3995
+ The coin objects for this object.
3996
+
3997
+ `type` is a filter on the coin's type parameter, defaulting to `0x2::sui::SUI`.
3998
+ """
3999
+ coins(first: Int, after: String, last: Int, before: String, type: String): CoinConnection!
4000
+ """
4001
+ The `0x3::staking_pool::StakedSui` objects owned by this object.
4002
+ """
4003
+ stakedSuis(first: Int, after: String, last: Int, before: String): StakedSuiConnection!
4004
+ """
4005
+ The domain explicitly configured as the default domain pointing to this object.
4006
+ """
4007
+ defaultSuinsName(format: DomainFormat): String
4008
+ """
4009
+ The SuinsRegistration NFTs owned by this object. These grant the owner the capability to
4010
+ manage the associated domain.
4011
+ """
4012
+ suinsRegistrations(first: Int, after: String, last: Int, before: String): SuinsRegistrationConnection!
4013
+ version: UInt53!
4014
+ """
4015
+ The current status of the object as read from the off-chain store. The possible states are:
4016
+ NOT_INDEXED, the object is loaded from serialized data, such as the contents of a genesis or
4017
+ system package upgrade transaction. LIVE, the version returned is the most recent for the
4018
+ object, and it is not deleted or wrapped at that version. HISTORICAL, the object was
4019
+ referenced at a specific version or checkpoint, so is fetched from historical tables and may
4020
+ not be the latest version of the object. WRAPPED_OR_DELETED, the object is deleted or
4021
+ wrapped and only partial information can be loaded."
4022
+ """
4023
+ status: ObjectKind!
4024
+ """
4025
+ 32-byte hash that identifies the object's contents, encoded as a Base58 string.
4026
+ """
4027
+ digest: String
4028
+ """
4029
+ The owner type of this object: Immutable, Shared, Parent, Address
4030
+ """
4031
+ owner: ObjectOwner
4032
+ """
4033
+ The transaction block that created this version of the object.
4034
+ """
4035
+ previousTransactionBlock: TransactionBlock
4036
+ """
4037
+ The amount of SUI we would rebate if this object gets deleted or mutated. This number is
4038
+ recalculated based on the present storage gas price.
4039
+ """
4040
+ storageRebate: BigInt
4041
+ """
4042
+ The transaction blocks that sent objects to this object.
4043
+
4044
+ `scanLimit` restricts the number of candidate transactions scanned when gathering a page of
4045
+ results. It is required for queries that apply more than two complex filters (on function,
4046
+ kind, sender, recipient, input object, changed object, or ids), and can be at most
4047
+ `serviceConfig.maxScanLimit`.
4048
+
4049
+ When the scan limit is reached the page will be returned even if it has fewer than `first`
4050
+ results when paginating forward (`last` when paginating backwards). If there are more
4051
+ transactions to scan, `pageInfo.hasNextPage` (or `pageInfo.hasPreviousPage`) will be set to
4052
+ `true`, and `PageInfo.endCursor` (or `PageInfo.startCursor`) will be set to the last
4053
+ transaction that was scanned as opposed to the last (or first) transaction in the page.
4054
+
4055
+ Requesting the next (or previous) page after this cursor will resume the search, scanning
4056
+ the next `scanLimit` many transactions in the direction of pagination, and so on until all
4057
+ transactions in the scanning range have been visited.
4058
+
4059
+ By default, the scanning range includes all transactions known to GraphQL, but it can be
4060
+ restricted by the `after` and `before` cursors, and the `beforeCheckpoint`,
4061
+ `afterCheckpoint` and `atCheckpoint` filters.
4062
+ """
4063
+ receivedTransactionBlocks(first: Int, after: String, last: Int, before: String, filter: TransactionBlockFilter, scanLimit: Int): TransactionBlockConnection!
4064
+ """
4065
+ The Base64-encoded BCS serialization of the object's content.
4066
+ """
4067
+ bcs: Base64
4068
+ """
4069
+ Displays the contents of the Move object in a JSON string and through GraphQL types. Also
4070
+ provides the flat representation of the type signature, and the BCS of the corresponding
4071
+ data.
4072
+ """
4073
+ contents: MoveValue
4074
+ """
4075
+ Determines whether a transaction can transfer this object, using the TransferObjects
4076
+ transaction command or `sui::transfer::public_transfer`, both of which require the object to
4077
+ have the `key` and `store` abilities.
4078
+ """
4079
+ hasPublicTransfer: Boolean!
4080
+ """
4081
+ The set of named templates defined on-chain for the type of this object, to be handled
4082
+ off-chain. The server substitutes data from the object into these templates to generate a
4083
+ display string per template.
4084
+ """
4085
+ display: [DisplayEntry!]
4086
+ """
4087
+ Access a dynamic field on an object using its name. Names are arbitrary Move values whose
4088
+ type have `copy`, `drop`, and `store`, and are specified using their type, and their BCS
4089
+ contents, Base64 encoded.
4090
+
4091
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
4092
+ type.
4093
+ """
4094
+ dynamicField(name: DynamicFieldName!): DynamicField
4095
+ """
4096
+ Access a dynamic object field on an object using its name. Names are arbitrary Move values
4097
+ whose type have `copy`, `drop`, and `store`, and are specified using their type, and their
4098
+ BCS contents, Base64 encoded. The value of a dynamic object field can also be accessed
4099
+ off-chain directly via its address (e.g. using `Query.object`).
4100
+
4101
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
4102
+ type.
4103
+ """
4104
+ dynamicObjectField(name: DynamicFieldName!): DynamicField
4105
+ """
4106
+ The dynamic fields and dynamic object fields on an object.
4107
+
4108
+ Dynamic fields on wrapped objects can be accessed by using the same API under the Owner
4109
+ type.
4110
+ """
4111
+ dynamicFields(first: Int, after: String, last: Int, before: String): DynamicFieldConnection!
4112
+ """
4113
+ Domain name of the SuinsRegistration object
4114
+ """
4115
+ domain: String!
4116
+ }
4117
+
4118
+ type SuinsRegistrationConnection {
4119
+ """
4120
+ Information to aid in pagination.
4121
+ """
4122
+ pageInfo: PageInfo!
4123
+ """
4124
+ A list of edges.
4125
+ """
4126
+ edges: [SuinsRegistrationEdge!]!
4127
+ """
4128
+ A list of nodes.
4129
+ """
4130
+ nodes: [SuinsRegistration!]!
4131
+ }
4132
+
4133
+ """
4134
+ An edge in a connection.
4135
+ """
4136
+ type SuinsRegistrationEdge {
4137
+ """
4138
+ The item at the end of the edge
4139
+ """
4140
+ node: SuinsRegistration!
4141
+ """
4142
+ A cursor for use in pagination
4143
+ """
4144
+ cursor: String!
4145
+ }
4146
+
4147
+ """
4148
+ Details of the system that are decided during genesis.
4149
+ """
4150
+ type SystemParameters {
4151
+ """
4152
+ Target duration of an epoch, in milliseconds.
4153
+ """
4154
+ durationMs: BigInt
4155
+ """
4156
+ The epoch at which stake subsidies start being paid out.
4157
+ """
4158
+ stakeSubsidyStartEpoch: UInt53
4159
+ """
4160
+ The minimum number of active validators that the system supports.
4161
+ """
4162
+ minValidatorCount: Int
4163
+ """
4164
+ The maximum number of active validators that the system supports.
4165
+ """
4166
+ maxValidatorCount: Int
4167
+ """
4168
+ Minimum stake needed to become a new validator.
4169
+ """
4170
+ minValidatorJoiningStake: BigInt
4171
+ """
4172
+ Validators with stake below this threshold will enter the grace period (see
4173
+ `validatorLowStakeGracePeriod`), after which they are removed from the active validator set.
4174
+ """
4175
+ validatorLowStakeThreshold: BigInt
4176
+ """
4177
+ Validators with stake below this threshold will be removed from the active validator set
4178
+ at the next epoch boundary, without a grace period.
4179
+ """
4180
+ validatorVeryLowStakeThreshold: BigInt
4181
+ """
4182
+ The number of epochs that a validator has to recover from having less than
4183
+ `validatorLowStakeThreshold` stake.
4184
+ """
4185
+ validatorLowStakeGracePeriod: BigInt
4186
+ }
4187
+
4188
+ """
4189
+ An argument to a programmable transaction command.
4190
+ """
4191
+ union TransactionArgument = GasCoin | Input | Result
4192
+
4193
+ type TransactionBlock {
4194
+ """
4195
+ A 32-byte hash that uniquely identifies the transaction block contents, encoded in Base58.
4196
+ This serves as a unique id for the block on chain.
4197
+ """
4198
+ digest: String
4199
+ """
4200
+ The address corresponding to the public key that signed this transaction. System
4201
+ transactions do not have senders.
4202
+ """
4203
+ sender: Address
4204
+ """
4205
+ The gas input field provides information on what objects were used as gas as well as the
4206
+ owner of the gas object(s) and information on the gas price and budget.
4207
+
4208
+ If the owner of the gas object(s) is not the same as the sender, the transaction block is a
4209
+ sponsored transaction block.
4210
+ """
4211
+ gasInput: GasInput
4212
+ """
4213
+ The type of this transaction as well as the commands and/or parameters comprising the
4214
+ transaction of this kind.
4215
+ """
4216
+ kind: TransactionBlockKind
4217
+ """
4218
+ A list of all signatures, Base64-encoded, from senders, and potentially the gas owner if
4219
+ this is a sponsored transaction.
4220
+ """
4221
+ signatures: [Base64!]
4222
+ """
4223
+ The effects field captures the results to the chain of executing this transaction.
4224
+ """
4225
+ effects: TransactionBlockEffects
4226
+ """
4227
+ This field is set by senders of a transaction block. It is an epoch reference that sets a
4228
+ deadline after which validators will no longer consider the transaction valid. By default,
4229
+ there is no deadline for when a transaction must execute.
4230
+ """
4231
+ expiration: Epoch
4232
+ """
4233
+ Serialized form of this transaction's `TransactionData`, BCS serialized and Base64 encoded.
4234
+ """
4235
+ bcs: Base64
4236
+ }
4237
+
4238
+ type TransactionBlockConnection {
4239
+ """
4240
+ Information to aid in pagination.
4241
+ """
4242
+ pageInfo: PageInfo!
4243
+ """
4244
+ A list of edges.
4245
+ """
4246
+ edges: [TransactionBlockEdge!]!
4247
+ """
4248
+ A list of nodes.
4249
+ """
4250
+ nodes: [TransactionBlock!]!
4251
+ }
4252
+
4253
+ """
4254
+ An edge in a connection.
4255
+ """
4256
+ type TransactionBlockEdge {
4257
+ """
4258
+ The item at the end of the edge
4259
+ """
4260
+ node: TransactionBlock!
4261
+ """
4262
+ A cursor for use in pagination
4263
+ """
4264
+ cursor: String!
4265
+ }
4266
+
4267
+ """
4268
+ The effects representing the result of executing a transaction block.
4269
+ """
4270
+ type TransactionBlockEffects {
4271
+ """
4272
+ The transaction that ran to produce these effects.
4273
+ """
4274
+ transactionBlock: TransactionBlock
4275
+ """
4276
+ Whether the transaction executed successfully or not.
4277
+ """
4278
+ status: ExecutionStatus
4279
+ """
4280
+ The latest version of all objects (apart from packages) that have been created or modified
4281
+ by this transaction, immediately following this transaction.
4282
+ """
4283
+ lamportVersion: UInt53!
4284
+ """
4285
+ The reason for a transaction failure, if it did fail.
4286
+ If the error is a Move abort, the error message will be resolved to a human-readable form if
4287
+ possible, otherwise it will fall back to displaying the abort code and location.
4288
+ """
4289
+ errors: String
4290
+ """
4291
+ Transactions whose outputs this transaction depends upon.
4292
+ """
4293
+ dependencies(first: Int, after: String, last: Int, before: String): DependencyConnection!
4294
+ """
4295
+ Effects to the gas object.
4296
+ """
4297
+ gasEffects: GasEffects
4298
+ """
4299
+ Shared objects that are referenced by but not changed by this transaction.
4300
+ """
4301
+ unchangedSharedObjects(first: Int, after: String, last: Int, before: String): UnchangedSharedObjectConnection!
4302
+ """
4303
+ The effect this transaction had on objects on-chain.
4304
+ """
4305
+ objectChanges(first: Int, after: String, last: Int, before: String): ObjectChangeConnection!
4306
+ """
4307
+ The effect this transaction had on the balances (sum of coin values per coin type) of
4308
+ addresses and objects.
4309
+ """
4310
+ balanceChanges(first: Int, after: String, last: Int, before: String): BalanceChangeConnection!
4311
+ """
4312
+ Events emitted by this transaction block.
4313
+ """
4314
+ events(first: Int, after: String, last: Int, before: String): EventConnection!
4315
+ """
4316
+ Timestamp corresponding to the checkpoint this transaction was finalized in.
4317
+ """
4318
+ timestamp: DateTime
4319
+ """
4320
+ The epoch this transaction was finalized in.
4321
+ """
4322
+ epoch: Epoch
4323
+ """
4324
+ The checkpoint this transaction was finalized in.
4325
+ """
4326
+ checkpoint: Checkpoint
4327
+ """
4328
+ Base64 encoded bcs serialization of the on-chain transaction effects.
4329
+ """
4330
+ bcs: Base64!
4331
+ }
4332
+
4333
+ input TransactionBlockFilter {
4334
+ """
4335
+ Filter transactions by move function called. Calls can be filtered by the `package`,
4336
+ `package::module`, or the `package::module::name` of their function.
4337
+ """
4338
+ function: String
4339
+ """
4340
+ An input filter selecting for either system or programmable transactions.
4341
+ """
4342
+ kind: TransactionBlockKindInput
4343
+ """
4344
+ Limit to transactions that occured strictly after the given checkpoint.
4345
+ """
4346
+ afterCheckpoint: UInt53
4347
+ """
4348
+ Limit to transactions in the given checkpoint.
4349
+ """
4350
+ atCheckpoint: UInt53
4351
+ """
4352
+ Limit to transaction that occured strictly before the given checkpoint.
4353
+ """
4354
+ beforeCheckpoint: UInt53
4355
+ """
4356
+ Limit to transactions that interacted with the given address. The address could be a
4357
+ sender, sponsor, or recipient of the transaction.
4358
+ """
4359
+ affectedAddress: SuiAddress
4360
+ """
4361
+ Limit to transactions that were sent by the given address.
4362
+ """
4363
+ sentAddress: SuiAddress
4364
+ """
4365
+ Limit to transactions that accepted the given object as an input. NOTE: this input filter
4366
+ has been deprecated in favor of `affectedObject` which offers an easier to under behavior.
4367
+
4368
+ This filter will be removed with 1.36.0 (2024-10-14), or at least one release after
4369
+ `affectedObject` is introduced, whichever is later.
4370
+ """
4371
+ inputObject: SuiAddress
4372
+ """
4373
+ Limit to transactions that output a versioon of this object. NOTE: this input filter has
4374
+ been deprecated in favor of `affectedObject` which offers an easier to understand behavor.
4375
+
4376
+ This filter will be removed with 1.36.0 (2024-10-14), or at least one release after
4377
+ `affectedObject` is introduced, whichever is later.
4378
+ """
4379
+ changedObject: SuiAddress
4380
+ """
4381
+ Select transactions by their digest.
4382
+ """
4383
+ transactionIds: [String!]
4384
+ }
4385
+
4386
+ """
4387
+ The kind of transaction block, either a programmable transaction or a system transaction.
4388
+ """
4389
+ union TransactionBlockKind = ConsensusCommitPrologueTransaction | GenesisTransaction | ChangeEpochTransaction | ProgrammableTransactionBlock | AuthenticatorStateUpdateTransaction | RandomnessStateUpdateTransaction | EndOfEpochTransaction
4390
+
4391
+ """
4392
+ An input filter selecting for either system or programmable transactions.
4393
+ """
4394
+ enum TransactionBlockKindInput {
4395
+ """
4396
+ A system transaction can be one of several types of transactions.
4397
+ See [unions/transaction-block-kind] for more details.
4398
+ """
4399
+ SYSTEM_TX
4400
+ """
4401
+ A user submitted transaction block.
4402
+ """
4403
+ PROGRAMMABLE_TX
4404
+ }
4405
+
4406
+ union TransactionInput = OwnedOrImmutable | SharedInput | Receiving | Pure
4407
+
4408
+ type TransactionInputConnection {
4409
+ """
4410
+ Information to aid in pagination.
4411
+ """
4412
+ pageInfo: PageInfo!
4413
+ """
4414
+ A list of edges.
4415
+ """
4416
+ edges: [TransactionInputEdge!]!
4417
+ """
4418
+ A list of nodes.
4419
+ """
4420
+ nodes: [TransactionInput!]!
4421
+ }
4422
+
4423
+ """
4424
+ An edge in a connection.
4425
+ """
4426
+ type TransactionInputEdge {
4427
+ """
4428
+ The item at the end of the edge
4429
+ """
4430
+ node: TransactionInput!
4431
+ """
4432
+ A cursor for use in pagination
4433
+ """
4434
+ cursor: String!
4435
+ }
4436
+
4437
+ """
4438
+ The optional extra data a user can provide to a transaction dry run.
4439
+ `sender` defaults to `0x0`. If gasObjects` is not present, or is an empty list,
4440
+ it is substituted with a mock Coin object, `gasPrice` defaults to the reference
4441
+ gas price, `gasBudget` defaults to the max gas budget and `gasSponsor` defaults
4442
+ to the sender.
4443
+ """
4444
+ input TransactionMetadata {
4445
+ sender: SuiAddress
4446
+ gasPrice: UInt53
4447
+ gasObjects: [ObjectRef!]
4448
+ gasBudget: UInt53
4449
+ gasSponsor: SuiAddress
4450
+ }
4451
+
4452
+ """
4453
+ Transfers `inputs` to `address`. All inputs must have the `store` ability (allows public
4454
+ transfer) and must not be previously immutable or shared.
4455
+ """
4456
+ type TransferObjectsTransaction {
4457
+ """
4458
+ The objects to transfer.
4459
+ """
4460
+ inputs: [TransactionArgument!]!
4461
+ """
4462
+ The address to transfer to.
4463
+ """
4464
+ address: TransactionArgument!
4465
+ }
4466
+
4467
+ """
4468
+ Information about which previous versions of a package introduced its types.
4469
+ """
4470
+ type TypeOrigin {
4471
+ """
4472
+ Module defining the type.
4473
+ """
4474
+ module: String!
4475
+ """
4476
+ Name of the struct.
4477
+ """
4478
+ struct: String!
4479
+ """
4480
+ The storage ID of the package that first defined this type.
4481
+ """
4482
+ definingId: SuiAddress!
4483
+ }
4484
+
4485
+ """
4486
+ An unsigned integer that can hold values up to 2^53 - 1. This can be treated similarly to `Int`,
4487
+ but it is guaranteed to be non-negative, and it may be larger than 2^32 - 1.
4488
+ """
4489
+ scalar UInt53
4490
+
4491
+ """
4492
+ Details pertaining to shared objects that are referenced by but not changed by a transaction.
4493
+ This information is considered part of the effects, because although the transaction specifies
4494
+ the shared object as input, consensus must schedule it and pick the version that is actually
4495
+ used.
4496
+ """
4497
+ union UnchangedSharedObject = SharedObjectRead | SharedObjectDelete | SharedObjectCancelled
4498
+
4499
+ type UnchangedSharedObjectConnection {
4500
+ """
4501
+ Information to aid in pagination.
4502
+ """
4503
+ pageInfo: PageInfo!
4504
+ """
4505
+ A list of edges.
4506
+ """
4507
+ edges: [UnchangedSharedObjectEdge!]!
4508
+ """
4509
+ A list of nodes.
4510
+ """
4511
+ nodes: [UnchangedSharedObject!]!
4512
+ }
4513
+
4514
+ """
4515
+ An edge in a connection.
4516
+ """
4517
+ type UnchangedSharedObjectEdge {
4518
+ """
4519
+ The item at the end of the edge
4520
+ """
4521
+ node: UnchangedSharedObject!
4522
+ """
4523
+ A cursor for use in pagination
4524
+ """
4525
+ cursor: String!
4526
+ }
4527
+
4528
+ """
4529
+ Upgrades a Move Package.
4530
+ """
4531
+ type UpgradeTransaction {
4532
+ """
4533
+ Bytecode for the modules to be published, BCS serialized and Base64 encoded.
4534
+ """
4535
+ modules: [Base64!]!
4536
+ """
4537
+ IDs of the transitive dependencies of the package to be published.
4538
+ """
4539
+ dependencies: [SuiAddress!]!
4540
+ """
4541
+ ID of the package being upgraded.
4542
+ """
4543
+ currentPackage: SuiAddress!
4544
+ """
4545
+ The `UpgradeTicket` authorizing the upgrade.
4546
+ """
4547
+ upgradeTicket: TransactionArgument!
4548
+ }
4549
+
4550
+ type Validator {
4551
+ """
4552
+ The validator's address.
4553
+ """
4554
+ address: Address!
4555
+ """
4556
+ Validator's set of credentials such as public keys, network addresses and others.
4557
+ """
4558
+ credentials: ValidatorCredentials
4559
+ """
4560
+ Validator's set of credentials for the next epoch.
4561
+ """
4562
+ nextEpochCredentials: ValidatorCredentials
4563
+ """
4564
+ Validator's name.
4565
+ """
4566
+ name: String
4567
+ """
4568
+ Validator's description.
4569
+ """
4570
+ description: String
4571
+ """
4572
+ Validator's url containing their custom image.
4573
+ """
4574
+ imageUrl: String
4575
+ """
4576
+ Validator's homepage URL.
4577
+ """
4578
+ projectUrl: String
4579
+ """
4580
+ The validator's current valid `Cap` object. Validators can delegate
4581
+ the operation ability to another address. The address holding this `Cap` object
4582
+ can then update the reference gas price and tallying rule on behalf of the validator.
4583
+ """
4584
+ operationCap: MoveObject
4585
+ """
4586
+ The validator's current staking pool object, used to track the amount of stake
4587
+ and to compound staking rewards.
4588
+ """
4589
+ stakingPool: MoveObject @deprecated(reason: "The staking pool is a wrapped object. Access its fields directly on the `Validator` type.")
4590
+ """
4591
+ The ID of this validator's `0x3::staking_pool::StakingPool`.
4592
+ """
4593
+ stakingPoolId: SuiAddress!
4594
+ """
4595
+ The validator's current exchange object. The exchange rate is used to determine
4596
+ the amount of SUI tokens that each past SUI staker can withdraw in the future.
4597
+ """
4598
+ exchangeRates: MoveObject @deprecated(reason: "The exchange object is a wrapped object. Access its dynamic fields through the `exchangeRatesTable` query.")
4599
+ """
4600
+ A wrapped object containing the validator's exchange rates. This is a table from epoch
4601
+ number to `PoolTokenExchangeRate` value. The exchange rate is used to determine the amount
4602
+ of SUI tokens that each past SUI staker can withdraw in the future.
4603
+ """
4604
+ exchangeRatesTable: Owner
4605
+ """
4606
+ Number of exchange rates in the table.
4607
+ """
4608
+ exchangeRatesSize: UInt53
4609
+ """
4610
+ The epoch at which this pool became active.
4611
+ """
4612
+ stakingPoolActivationEpoch: UInt53
4613
+ """
4614
+ The total number of SUI tokens in this pool.
4615
+ """
4616
+ stakingPoolSuiBalance: BigInt
4617
+ """
4618
+ The epoch stake rewards will be added here at the end of each epoch.
4619
+ """
4620
+ rewardsPool: BigInt
4621
+ """
4622
+ Total number of pool tokens issued by the pool.
4623
+ """
4624
+ poolTokenBalance: BigInt
4625
+ """
4626
+ Pending stake amount for this epoch.
4627
+ """
4628
+ pendingStake: BigInt
4629
+ """
4630
+ Pending stake withdrawn during the current epoch, emptied at epoch boundaries.
4631
+ """
4632
+ pendingTotalSuiWithdraw: BigInt
4633
+ """
4634
+ Pending pool token withdrawn during the current epoch, emptied at epoch boundaries.
4635
+ """
4636
+ pendingPoolTokenWithdraw: BigInt
4637
+ """
4638
+ The voting power of this validator in basis points (e.g., 100 = 1% voting power).
4639
+ """
4640
+ votingPower: Int
4641
+ """
4642
+ The reference gas price for this epoch.
4643
+ """
4644
+ gasPrice: BigInt
4645
+ """
4646
+ The fee charged by the validator for staking services.
4647
+ """
4648
+ commissionRate: Int
4649
+ """
4650
+ The total number of SUI tokens in this pool plus
4651
+ the pending stake amount for this epoch.
4652
+ """
4653
+ nextEpochStake: BigInt
4654
+ """
4655
+ The validator's gas price quote for the next epoch.
4656
+ """
4657
+ nextEpochGasPrice: BigInt
4658
+ """
4659
+ The proposed next epoch fee for the validator's staking services.
4660
+ """
4661
+ nextEpochCommissionRate: Int
4662
+ """
4663
+ The number of epochs for which this validator has been below the
4664
+ low stake threshold.
4665
+ """
4666
+ atRisk: UInt53
4667
+ """
4668
+ The addresses of other validators this validator has reported.
4669
+ """
4670
+ reportRecords(first: Int, before: String, last: Int, after: String): AddressConnection!
4671
+ """
4672
+ The APY of this validator in basis points.
4673
+ To get the APY in percentage, divide by 100.
4674
+ """
4675
+ apy: Int
4676
+ }
4677
+
4678
+ type ValidatorConnection {
4679
+ """
4680
+ Information to aid in pagination.
4681
+ """
4682
+ pageInfo: PageInfo!
4683
+ """
4684
+ A list of edges.
4685
+ """
4686
+ edges: [ValidatorEdge!]!
4687
+ """
4688
+ A list of nodes.
4689
+ """
4690
+ nodes: [Validator!]!
4691
+ }
4692
+
4693
+ """
4694
+ The credentials related fields associated with a validator.
4695
+ """
4696
+ type ValidatorCredentials {
4697
+ protocolPubKey: Base64
4698
+ networkPubKey: Base64
4699
+ workerPubKey: Base64
4700
+ proofOfPossession: Base64
4701
+ netAddress: String
4702
+ p2PAddress: String
4703
+ primaryAddress: String
4704
+ workerAddress: String
4705
+ }
4706
+
4707
+ """
4708
+ An edge in a connection.
4709
+ """
4710
+ type ValidatorEdge {
4711
+ """
4712
+ The item at the end of the edge
4713
+ """
4714
+ node: Validator!
4715
+ """
4716
+ A cursor for use in pagination
4717
+ """
4718
+ cursor: String!
4719
+ }
4720
+
4721
+ """
4722
+ Representation of `0x3::validator_set::ValidatorSet`.
4723
+ """
4724
+ type ValidatorSet {
4725
+ """
4726
+ Total amount of stake for all active validators at the beginning of the epoch.
4727
+ """
4728
+ totalStake: BigInt
4729
+ """
4730
+ Validators that are pending removal from the active validator set, expressed as indices in
4731
+ to `activeValidators`.
4732
+ """
4733
+ pendingRemovals: [Int!]
4734
+ """
4735
+ Object ID of the wrapped object `TableVec` storing the pending active validators.
4736
+ """
4737
+ pendingActiveValidatorsId: SuiAddress
4738
+ """
4739
+ Size of the pending active validators table.
4740
+ """
4741
+ pendingActiveValidatorsSize: Int
4742
+ """
4743
+ Object ID of the `Table` storing the mapping from staking pool ids to the addresses
4744
+ of the corresponding validators. This is needed because a validator's address
4745
+ can potentially change but the object ID of its pool will not.
4746
+ """
4747
+ stakingPoolMappingsId: SuiAddress
4748
+ """
4749
+ Size of the stake pool mappings `Table`.
4750
+ """
4751
+ stakingPoolMappingsSize: Int
4752
+ """
4753
+ Object ID of the `Table` storing the inactive staking pools.
4754
+ """
4755
+ inactivePoolsId: SuiAddress
4756
+ """
4757
+ Size of the inactive pools `Table`.
4758
+ """
4759
+ inactivePoolsSize: Int
4760
+ """
4761
+ Object ID of the `Table` storing the validator candidates.
4762
+ """
4763
+ validatorCandidatesId: SuiAddress
4764
+ """
4765
+ Size of the validator candidates `Table`.
4766
+ """
4767
+ validatorCandidatesSize: Int
4768
+ """
4769
+ The current set of active validators.
4770
+ """
4771
+ activeValidators(first: Int, before: String, last: Int, after: String): ValidatorConnection!
4772
+ }
4773
+
4774
+ """
4775
+ An enum that specifies the intent scope to be used to parse the bytes for signature
4776
+ verification.
4777
+ """
4778
+ enum ZkLoginIntentScope {
4779
+ """
4780
+ Indicates that the bytes are to be parsed as transaction data bytes.
4781
+ """
4782
+ TRANSACTION_DATA
4783
+ """
4784
+ Indicates that the bytes are to be parsed as a personal message.
4785
+ """
4786
+ PERSONAL_MESSAGE
4787
+ }
4788
+
4789
+ """
4790
+ The result of the zkLogin signature verification.
4791
+ """
4792
+ type ZkLoginVerifyResult {
4793
+ """
4794
+ The boolean result of the verification. If true, errors should be empty.
4795
+ """
4796
+ success: Boolean!
4797
+ """
4798
+ The errors field captures any verification error
4799
+ """
4800
+ errors: [String!]!
4801
+ }
4802
+
4803
+ directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
4804
+ directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
4805
+ schema {
4806
+ query: Query
4807
+ mutation: Mutation
4808
+ }