@ocap/client 1.25.3 → 1.25.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/README.md +76 -80
  2. package/dist/report.html +1 -1
  3. package/docs/_sidebar.md +22 -0
  4. package/docs/api-reference-client-methods.md +229 -0
  5. package/docs/api-reference-client-methods.zh.md +229 -0
  6. package/docs/api-reference-data-types.md +482 -0
  7. package/docs/api-reference-data-types.zh.md +482 -0
  8. package/docs/api-reference-low-level-api.md +228 -0
  9. package/docs/api-reference-low-level-api.zh.md +228 -0
  10. package/docs/api-reference-query-mutation-methods.md +814 -0
  11. package/docs/api-reference-query-mutation-methods.zh.md +814 -0
  12. package/docs/api-reference-transaction-helpers.md +649 -0
  13. package/docs/api-reference-transaction-helpers.zh.md +649 -0
  14. package/docs/api-reference.md +23 -0
  15. package/docs/api-reference.zh.md +23 -0
  16. package/docs/core-concepts-client-architecture.md +102 -0
  17. package/docs/core-concepts-client-architecture.zh.md +102 -0
  18. package/docs/core-concepts-event-subscriptions.md +123 -0
  19. package/docs/core-concepts-event-subscriptions.zh.md +123 -0
  20. package/docs/core-concepts-gas-payment.md +111 -0
  21. package/docs/core-concepts-gas-payment.zh.md +111 -0
  22. package/docs/core-concepts-transaction-lifecycle.md +183 -0
  23. package/docs/core-concepts-transaction-lifecycle.zh.md +183 -0
  24. package/docs/core-concepts.md +22 -0
  25. package/docs/core-concepts.zh.md +22 -0
  26. package/docs/getting-started-basic-usage.md +87 -0
  27. package/docs/getting-started-basic-usage.zh.md +87 -0
  28. package/docs/getting-started-installation.md +60 -0
  29. package/docs/getting-started-installation.zh.md +60 -0
  30. package/docs/getting-started.md +16 -0
  31. package/docs/getting-started.zh.md +16 -0
  32. package/docs/how-to-guides-delegate-permissions.md +167 -0
  33. package/docs/how-to-guides-delegate-permissions.zh.md +167 -0
  34. package/docs/how-to-guides-manage-accounts.md +73 -0
  35. package/docs/how-to-guides-manage-accounts.zh.md +73 -0
  36. package/docs/how-to-guides-manage-assets.md +255 -0
  37. package/docs/how-to-guides-manage-assets.zh.md +255 -0
  38. package/docs/how-to-guides-manage-tokens.md +179 -0
  39. package/docs/how-to-guides-manage-tokens.zh.md +179 -0
  40. package/docs/how-to-guides-stake-tokens-and-assets.md +205 -0
  41. package/docs/how-to-guides-stake-tokens-and-assets.zh.md +205 -0
  42. package/docs/how-to-guides-transfer-tokens-and-nfts.md +179 -0
  43. package/docs/how-to-guides-transfer-tokens-and-nfts.zh.md +179 -0
  44. package/docs/how-to-guides.md +27 -0
  45. package/docs/how-to-guides.zh.md +27 -0
  46. package/docs/overview.md +70 -0
  47. package/docs/overview.zh.md +70 -0
  48. package/package.json +14 -14
package/docs/api-reference-data-types.md ADDED
@@ -0,0 +1,482 @@
1
+ # Data Types
2
+
3
+ This section provides a comprehensive reference for all the custom data structures, input parameters, and response objects used throughout the OCAP Client API. Understanding these types is essential for effectively interacting with the OCAP blockchain.
4
+
5
+ ## Core Types
6
+
7
+ These are fundamental data structures used across various API calls.
8
+
9
+ ### Any
10
+
11
+ A generic container for protobuf messages, allowing for flexible data structures.
12
+
13
+ <x-field-group>
14
+ <x-field data-name="typeUrl" data-type="string" data-desc="A URL-like string that uniquely identifies the type of the serialized message."></x-field>
15
+ <x-field data-name="value" data-type="string" data-desc="The serialized message content as a string."></x-field>
16
+ </x-field-group>
17
+
18
+ ### Multisig
19
+
20
+ Represents a multi-signature, often used in transactions requiring multiple approvals.
21
+
22
+ <x-field-group>
23
+ <x-field data-name="signer" data-type="string" data-desc="The address of the signer."></x-field>
24
+ <x-field data-name="pk" data-type="string" data-desc="The public key of the signer."></x-field>
25
+ <x-field data-name="signature" data-type="string" data-desc="The signature generated by the signer."></x-field>
26
+ <x-field data-name="delegator" data-type="string" data-desc="The address of the delegator, if the signature is delegated."></x-field>
27
+ <x-field data-name="data" data-type="Any" data-desc="Optional arbitrary data associated with the signature."></x-field>
28
+ </x-field-group>
29
+
30
+ ### PageInfo
31
+
32
+ Contains pagination details for list-based query responses.
33
+
34
+ <x-field-group>
35
+ <x-field data-name="cursor" data-type="string" data-desc="A cursor for fetching the next page of results."></x-field>
36
+ <x-field data-name="next" data-type="boolean" data-desc="Indicates if there is a next page of results available."></x-field>
37
+ <x-field data-name="total" data-type="number" data-desc="The total number of items matching the query."></x-field>
38
+ </x-field-group>
39
+
40
+ ### StateContext
41
+
42
+ Provides context about the creation and last modification of a state object.
43
+
44
+ <x-field-group>
45
+ <x-field data-name="genesisTx" data-type="TransactionInfo" data-desc="The transaction that created this state object."></x-field>
46
+ <x-field data-name="renaissanceTx" data-type="TransactionInfo" data-desc="The transaction that last updated this state object."></x-field>
47
+ <x-field data-name="genesisTime" data-type="string" data-desc="The timestamp when the state object was created."></x-field>
48
+ <x-field data-name="renaissanceTime" data-type="string" data-desc="The timestamp when the state object was last updated."></x-field>
49
+ </x-field-group>
50
+
51
+ ### Wallet Objects
52
+
53
+ These types define the structure of wallets used for signing transactions.
54
+
55
+ #### WalletObject
56
+
57
+ <x-field-group>
58
+ <x-field data-name="publicKey" data-type="string"></x-field>
59
+ <x-field data-name="secretKey" data-type="string"></x-field>
60
+ <x-field data-name="type" data-type="WalletTypeObject"></x-field>
61
+ </x-field-group>
62
+
63
+ #### WalletTypeObject
64
+
65
+ <x-field-group>
66
+ <x-field data-name="pk" data-type="number"></x-field>
67
+ <x-field data-name="role" data-type="number"></x-field>
68
+ <x-field data-name="hash" data-type="number"></x-field>
69
+ <x-field data-name="address" data-type="number" data-desc="Defaults to base58btc"></x-field>
70
+ </x-field-group>
71
+
72
+ #### WalletType
73
+
74
+ <x-field-group>
75
+ <x-field data-name="pk" data-type="KeyType"></x-field>
76
+ <x-field data-name="hash" data-type="HashType"></x-field>
77
+ <x-field data-name="address" data-type="EncodingType"></x-field>
78
+ <x-field data-name="role" data-type="RoleType"></x-field>
79
+ </x-field-group>
80
+
81
+ ## Input & Filter Types
82
+
83
+ These objects are used to provide parameters and filters for GraphQL queries.
84
+
85
+ ### General Filter Inputs
86
+
87
+ <x-field-group>
88
+ <x-field data-name="AccountFilterInput" data-type="object">
89
+ <x-field data-name="accounts" data-type="array<string>"></x-field>
90
+ </x-field>
91
+ <x-field data-name="AddressFilterInput" data-type="object">
92
+ <x-field data-name="sender" data-type="string"></x-field>
93
+ <x-field data-name="receiver" data-type="string"></x-field>
94
+ <x-field data-name="direction" data-type="Direction"></x-field>
95
+ </x-field>
96
+ <x-field data-name="AssetFilterInput" data-type="object">
97
+ <x-field data-name="assets" data-type="array<string>"></x-field>
98
+ </x-field>
99
+ <x-field data-name="DelegationFilterInput" data-type="object">
100
+ <x-field data-name="delegations" data-type="array<string>"></x-field>
101
+ </x-field>
102
+ <x-field data-name="FactoryFilterInput" data-type="object">
103
+ <x-field data-name="factories" data-type="array<string>"></x-field>
104
+ </x-field>
105
+ <x-field data-name="RangeFilterInput" data-type="object">
106
+ <x-field data-name="from" data-type="string"></x-field>
107
+ <x-field data-name="to" data-type="string"></x-field>
108
+ </x-field>
109
+ <x-field data-name="RollupFilterInput" data-type="object">
110
+ <x-field data-name="rollups" data-type="array<string>"></x-field>
111
+ </x-field>
112
+ <x-field data-name="StakeFilterInput" data-type="object">
113
+ <x-field data-name="stakes" data-type="array<string>"></x-field>
114
+ </x-field>
115
+ <x-field data-name="TimeFilterInput" data-type="object">
116
+ <x-field data-name="startDateTime" data-type="string"></x-field>
117
+ <x-field data-name="endDateTime" data-type="string"></x-field>
118
+ <x-field data-name="field" data-type="string"></x-field>
119
+ </x-field>
120
+ <x-field data-name="TokenFactoryFilterInput" data-type="object">
121
+ <x-field data-name="tokenFactories" data-type="array<string>"></x-field>
122
+ </x-field>
123
+ <x-field data-name="TokenFilterInput" data-type="object">
124
+ <x-field data-name="tokens" data-type="array<string>"></x-field>
125
+ </x-field>
126
+ <x-field data-name="TxFilterInput" data-type="object">
127
+ <x-field data-name="txs" data-type="array<string>"></x-field>
128
+ </x-field>
129
+ <x-field data-name="TypeFilterInput" data-type="object">
130
+ <x-field data-name="types" data-type="array<string>"></x-field>
131
+ </x-field>
132
+ <x-field data-name="ValidatorFilterInput" data-type="object">
133
+ <x-field data-name="validators" data-type="array<string>"></x-field>
134
+ </x-field>
135
+ <x-field data-name="ValidityFilterInput" data-type="object">
136
+ <x-field data-name="validity" data-type="Validity"></x-field>
137
+ </x-field>
138
+ </x-field-group>
139
+
140
+ ### Pagination Inputs
141
+
142
+ #### PageInput
143
+
144
+ <x-field-group>
145
+ <x-field data-name="cursor" data-type="string"></x-field>
146
+ <x-field data-name="size" data-type="number"></x-field>
147
+ <x-field data-name="order" data-type="array<PageOrderInput>"></x-field>
148
+ </x-field-group>
149
+
150
+ #### PageOrderInput
151
+
152
+ <x-field-group>
153
+ <x-field data-name="field" data-type="string"></x-field>
154
+ <x-field data-name="type" data-type="string"></x-field>
155
+ </x-field-group>
156
+
157
+ ### Request-Specific Inputs
158
+
159
+ These objects are used as parameters for specific query and mutation methods.
160
+
161
+ <x-field-group>
162
+ <x-field data-name="RequestEstimateGasInput" data-type="object">
163
+ <x-field data-name="typeUrl" data-type="string"></x-field>
164
+ <x-field data-name="tx" data-type="string"></x-field>
165
+ </x-field>
166
+ <x-field data-name="RequestGetAccountStateInput" data-type="object">
167
+ <x-field data-name="address" data-type="string"></x-field>
168
+ <x-field data-name="keys" data-type="array<string>"></x-field>
169
+ <x-field data-name="height" data-type="number"></x-field>
170
+ <x-field data-name="traceMigration" data-type="boolean"></x-field>
171
+ </x-field>
172
+ <x-field data-name="RequestGetAccountTokensInput" data-type="object">
173
+ <x-field data-name="address" data-type="string"></x-field>
174
+ <x-field data-name="token" data-type="string"></x-field>
175
+ </x-field>
176
+ <x-field data-name="RequestGetBlockInput" data-type="object">
177
+ <x-field data-name="height" data-type="number"></x-field>
178
+ </x-field>
179
+ <x-field data-name="RequestGetBlocksInput" data-type="object">
180
+ <x-field data-name="paging" data-type="PageInput"></x-field>
181
+ <x-field data-name="heightFilter" data-type="RangeFilterInput"></x-field>
182
+ <x-field data-name="emptyExcluded" data-type="boolean"></x-field>
183
+ </x-field>
184
+ <x-field data-name="RequestListTransactionsInput" data-type="object">
185
+ <x-field data-name="paging" data-type="PageInput"></x-field>
186
+ <x-field data-name="timeFilter" data-type="TimeFilterInput"></x-field>
187
+ <x-field data-name="addressFilter" data-type="AddressFilterInput"></x-field>
188
+ <x-field data-name="typeFilter" data-type="TypeFilterInput"></x-field>
189
+ <x-field data-name="validityFilter" data-type="ValidityFilterInput"></x-field>
190
+ <x-field data-name="factoryFilter" data-type="FactoryFilterInput"></x-field>
191
+ <x-field data-name="tokenFilter" data-type="TokenFilterInput"></x-field>
192
+ <x-field data-name="assetFilter" data-type="AssetFilterInput"></x-field>
193
+ <x-field data-name="accountFilter" data-type="AccountFilterInput"></x-field>
194
+ <x-field data-name="txFilter" data-type="TxFilterInput"></x-field>
195
+ <x-field data-name="rollupFilter" data-type="RollupFilterInput"></x-field>
196
+ <x-field data-name="stakeFilter" data-type="StakeFilterInput"></x-field>
197
+ <x-field data-name="delegationFilter" data-type="DelegationFilterInput"></x-field>
198
+ <x-field data-name="tokenFactoryFilter" data-type="TokenFactoryFilterInput"></x-field>
199
+ </x-field>
200
+ </x-field-group>
201
+
202
+ ## State Objects
203
+
204
+ These types represent the state of various entities on the blockchain, such as accounts, assets, and tokens.
205
+
206
+ ### AccountState
207
+
208
+ Represents the state of a user account.
209
+
210
+ <x-field-group>
211
+ <x-field data-name="balance" data-type="string"></x-field>
212
+ <x-field data-name="nonce" data-type="string"></x-field>
213
+ <x-field data-name="numTxs" data-type="string"></x-field>
214
+ <x-field data-name="address" data-type="string"></x-field>
215
+ <x-field data-name="pk" data-type="string"></x-field>
216
+ <x-field data-name="type" data-type="WalletType"></x-field>
217
+ <x-field data-name="moniker" data-type="string"></x-field>
218
+ <x-field data-name="context" data-type="StateContext"></x-field>
219
+ <x-field data-name="issuer" data-type="string"></x-field>
220
+ <x-field data-name="gasBalance" data-type="string"></x-field>
221
+ <x-field data-name="migratedTo" data-type="array<string>"></x-field>
222
+ <x-field data-name="migratedFrom" data-type="array<string>"></x-field>
223
+ <x-field data-name="numAssets" data-type="string"></x-field>
224
+ <x-field data-name="tokens" data-type="array<IndexedTokenInput>"></x-field>
225
+ <x-field data-name="data" data-type="Any"></x-field>
226
+ </x-field-group>
227
+
228
+ ### AssetState
229
+
230
+ Represents the state of a non-fungible asset (NFT).
231
+
232
+ <x-field-group>
233
+ <x-field data-name="address" data-type="string"></x-field>
234
+ <x-field data-name="owner" data-type="string"></x-field>
235
+ <x-field data-name="moniker" data-type="string"></x-field>
236
+ <x-field data-name="readonly" data-type="boolean"></x-field>
237
+ <x-field data-name="transferrable" data-type="boolean"></x-field>
238
+ <x-field data-name="ttl" data-type="number"></x-field>
239
+ <x-field data-name="consumedTime" data-type="string"></x-field>
240
+ <x-field data-name="issuer" data-type="string"></x-field>
241
+ <x-field data-name="parent" data-type="string"></x-field>
242
+ <x-field data-name="endpoint" data-type="NFTEndpoint"></x-field>
243
+ <x-field data-name="display" data-type="NFTDisplay"></x-field>
244
+ <x-field data-name="tags" data-type="array<string>"></x-field>
245
+ <x-field data-name="context" data-type="StateContext"></x-field>
246
+ <x-field data-name="data" data-type="Any"></x-field>
247
+ </x-field-group>
248
+
249
+ ### AssetFactoryState
250
+
251
+ Represents the state of an asset factory, which is used to mint new assets.
252
+
253
+ <x-field-group>
254
+ <x-field data-name="address" data-type="string"></x-field>
255
+ <x-field data-name="owner" data-type="string"></x-field>
256
+ <x-field data-name="name" data-type="string"></x-field>
257
+ <x-field data-name="description" data-type="string"></x-field>
258
+ <x-field data-name="settlement" data-type="string"></x-field>
259
+ <x-field data-name="limit" data-type="number"></x-field>
260
+ <x-field data-name="trustedIssuers" data-type="array<string>"></x-field>
261
+ <x-field data-name="input" data-type="IndexedFactoryInput"></x-field>
262
+ <x-field data-name="output" data-type="CreateAssetTx"></x-field>
263
+ <x-field data-name="hooks" data-type="array<AssetFactoryHook>"></x-field>
264
+ <x-field data-name="data" data-type="Any"></x-field>
265
+ <x-field data-name="context" data-type="StateContext"></x-field>
266
+ <x-field data-name="balance" data-type="string"></x-field>
267
+ <x-field data-name="tokens" data-type="array<IndexedTokenInput>"></x-field>
268
+ <x-field data-name="numMinted" data-type="number"></x-field>
269
+ <x-field data-name="display" data-type="NFTDisplay"></x-field>
270
+ <x-field data-name="lastSettlement" data-type="string"></x-field>
271
+ </x-field-group>
272
+
273
+ ### DelegateState
274
+
275
+ Represents the state of a delegation, where one account authorizes another to perform actions on its behalf.
276
+
277
+ <x-field-group>
278
+ <x-field data-name="address" data-type="string"></x-field>
279
+ <x-field data-name="ops" data-type="array<DelegateState_OpsEntry>"></x-field>
280
+ <x-field data-name="from" data-type="string"></x-field>
281
+ <x-field data-name="to" data-type="string"></x-field>
282
+ <x-field data-name="context" data-type="StateContext"></x-field>
283
+ <x-field data-name="data" data-type="Any"></x-field>
284
+ </x-field-group>
285
+
286
+ ### StakeState
287
+
288
+ Represents the state of a stake, which can involve tokens or assets.
289
+
290
+ <x-field-group>
291
+ <x-field data-name="address" data-type="string"></x-field>
292
+ <x-field data-name="sender" data-type="string"></x-field>
293
+ <x-field data-name="receiver" data-type="string"></x-field>
294
+ <x-field data-name="tokens" data-type="array<IndexedTokenInput>"></x-field>
295
+ <x-field data-name="assets" data-type="array<string>"></x-field>
296
+ <x-field data-name="revocable" data-type="boolean"></x-field>
297
+ <x-field data-name="message" data-type="string"></x-field>
298
+ <x-field data-name="revokeWaitingPeriod" data-type="number"></x-field>
299
+ <x-field data-name="revokedTokens" data-type="array<IndexedTokenInput>"></x-field>
300
+ <x-field data-name="revokedAssets" data-type="array<string>"></x-field>
301
+ <x-field data-name="slashers" data-type="array<string>"></x-field>
302
+ <x-field data-name="nonce" data-type="string"></x-field>
303
+ <x-field data-name="context" data-type="StateContext"></x-field>
304
+ <x-field data-name="data" data-type="Any"></x-field>
305
+ </x-field-group>
306
+
307
+ ### TokenState
308
+
309
+ Represents the state of a fungible token.
310
+
311
+ <x-field-group>
312
+ <x-field data-name="address" data-type="string"></x-field>
313
+ <x-field data-name="issuer" data-type="string"></x-field>
314
+ <x-field data-name="name" data-type="string"></x-field>
315
+ <x-field data-name="description" data-type="string"></x-field>
316
+ <x-field data-name="symbol" data-type="string"></x-field>
317
+ <x-field data-name="unit" data-type="string"></x-field>
318
+ <x-field data-name="decimal" data-type="number"></x-field>
319
+ <x-field data-name="icon" data-type="string"></x-field>
320
+ <x-field data-name="totalSupply" data-type="string"></x-field>
321
+ <x-field data-name="initialSupply" data-type="string"></x-field>
322
+ <x-field data-name="maxTotalSupply" data-type="string"></x-field>
323
+ <x-field data-name="foreignToken" data-type="ForeignToken"></x-field>
324
+ <x-field data-name="tokenFactoryAddress" data-type="string"></x-field>
325
+ <x-field data-name="context" data-type="StateContext"></x-field>
326
+ <x-field data-name="data" data-type="Any"></x-field>
327
+ </x-field-group>
328
+
329
+ ### TokenFactoryState
330
+
331
+ Represents the state of a token factory, used for minting and burning tokens.
332
+
333
+ <x-field-group>
334
+ <x-field data-name="address" data-type="string"></x-field>
335
+ <x-field data-name="tokenAddress" data-type="string"></x-field>
336
+ <x-field data-name="reserveAddress" data-type="string"></x-field>
337
+ <x-field data-name="currentSupply" data-type="string"></x-field>
338
+ <x-field data-name="reserveBalance" data-type="string"></x-field>
339
+ <x-field data-name="owner" data-type="string"></x-field>
340
+ <x-field data-name="feeRate" data-type="number"></x-field>
341
+ <x-field data-name="curve" data-type="CurveConfig"></x-field>
342
+ <x-field data-name="context" data-type="StateContext"></x-field>
343
+ <x-field data-name="token" data-type="TokenState"></x-field>
344
+ <x-field data-name="reserveToken" data-type="TokenState"></x-field>
345
+ <x-field data-name="data" data-type="Any"></x-field>
346
+ </x-field-group>
347
+
348
+ ## Transaction Payloads (ITX)
349
+
350
+ These types define the `itx` (inner transaction) object for various transaction types.
351
+
352
+ ### AccountMigrateTx
353
+
354
+ <x-field-group>
355
+ <x-field data-name="pk" data-type="string"></x-field>
356
+ <x-field data-name="type" data-type="WalletType"></x-field>
357
+ <x-field data-name="address" data-type="string"></x-field>
358
+ <x-field data-name="data" data-type="Any"></x-field>
359
+ </x-field-group>
360
+
361
+ ### AcquireAssetV2Tx
362
+
363
+ <x-field-group>
364
+ <x-field data-name="factory" data-type="string"></x-field>
365
+ <x-field data-name="address" data-type="string"></x-field>
366
+ <x-field data-name="assets" data-type="array<string>"></x-field>
367
+ <x-field data-name="variables" data-type="array<VariableInput>"></x-field>
368
+ <x-field data-name="issuer" data-type="NFTIssuer"></x-field>
369
+ <x-field data-name="data" data-type="Any"></x-field>
370
+ </x-field-group>
371
+
372
+ ### CreateAssetTx
373
+
374
+ <x-field-group>
375
+ <x-field data-name="moniker" data-type="string"></x-field>
376
+ <x-field data-name="data" data-type="Any"></x-field>
377
+ <x-field data-name="readonly" data-type="boolean"></x-field>
378
+ <x-field data-name="transferrable" data-type="boolean"></x-field>
379
+ <x-field data-name="ttl" data-type="number"></x-field>
380
+ <x-field data-name="parent" data-type="string"></x-field>
381
+ <x-field data-name="address" data-type="string"></x-field>
382
+ <x-field data-name="issuer" data-type="string"></x-field>
383
+ <x-field data-name="endpoint" data-type="NFTEndpoint"></x-field>
384
+ <x-field data-name="display" data-type="NFTDisplay"></x-field>
385
+ <x-field data-name="tags" data-type="array<string>"></x-field>
386
+ </x-field-group>
387
+
388
+ ### DelegateTx
389
+
390
+ <x-field-group>
391
+ <x-field data-name="address" data-type="string"></x-field>
392
+ <x-field data-name="to" data-type="string"></x-field>
393
+ <x-field data-name="ops" data-type="array<DelegateOp>"></x-field>
394
+ <x-field data-name="data" data-type="Any"></x-field>
395
+ </x-field-group>
396
+
397
+ ### ExchangeTx
398
+
399
+ <x-field-group>
400
+ <x-field data-name="to" data-type="string"></x-field>
401
+ <x-field data-name="sender" data-type="ExchangeInfo"></x-field>
402
+ <x-field data-name="receiver" data-type="ExchangeInfo"></x-field>
403
+ <x-field data-name="expiredAt" data-type="string"></x-field>
404
+ <x-field data-name="data" data-type="Any"></x-field>
405
+ </x-field-group>
406
+
407
+ ### StakeTx
408
+
409
+ <x-field-group>
410
+ <x-field data-name="address" data-type="string"></x-field>
411
+ <x-field data-name="receiver" data-type="string"></x-field>
412
+ <x-field data-name="inputs" data-type="array<TransactionInput>"></x-field>
413
+ <x-field data-name="locked" data-type="boolean"></x-field>
414
+ <x-field data-name="message" data-type="string"></x-field>
415
+ <x-field data-name="revokeWaitingPeriod" data-type="number"></x-field>
416
+ <x-field data-name="slashers" data-type="array<string>"></x-field>
417
+ <x-field data-name="nonce" data-type="string"></x-field>
418
+ <x-field data-name="data" data-type="Any"></x-field>
419
+ </x-field-group>
420
+
421
+ ### TransferTx
422
+
423
+ <x-field-group>
424
+ <x-field data-name="to" data-type="string"></x-field>
425
+ <x-field data-name="value" data-type="string"></x-field>
426
+ <x-field data-name="assets" data-type="array<string>"></x-field>
427
+ <x-field data-name="data" data-type="Any"></x-field>
428
+ </x-field-group>
429
+
430
+ ## Response Wrappers
431
+
432
+ These types are the top-level objects returned by API queries, containing a status code and the requested data.
433
+
434
+ ### ResponseGetAccountState
435
+
436
+ <x-field-group>
437
+ <x-field data-name="code" data-type="string"></x-field>
438
+ <x-field data-name="state" data-type="AccountState"></x-field>
439
+ </x-field-group>
440
+
441
+ ### ResponseGetAssetState
442
+
443
+ <x-field-group>
444
+ <x-field data-name="code" data-type="string"></x-field>
445
+ <x-field data-name="state" data-type="AssetState"></x-field>
446
+ </x-field-group>
447
+
448
+ ### ResponseGetBlock
449
+
450
+ <x-field-group>
451
+ <x-field data-name="code" data-type="string"></x-field>
452
+ <x-field data-name="block" data-type="BlockInfo"></x-field>
453
+ </x-field-group>
454
+
455
+ ### ResponseGetChainInfo
456
+
457
+ <x-field-group>
458
+ <x-field data-name="code" data-type="string"></x-field>
459
+ <x-field data-name="info" data-type="ChainInfo"></x-field>
460
+ </x-field-group>
461
+
462
+ ### ResponseGetTx
463
+
464
+ <x-field-group>
465
+ <x-field data-name="code" data-type="string"></x-field>
466
+ <x-field data-name="info" data-type="TransactionInfo"></x-field>
467
+ </x-field-group>
468
+
469
+ ### ResponseListTransactions
470
+
471
+ <x-field-group>
472
+ <x-field data-name="code" data-type="string"></x-field>
473
+ <x-field data-name="page" data-type="PageInfo"></x-field>
474
+ <x-field data-name="transactions" data-type="array<IndexedTransaction>"></x-field>
475
+ </x-field-group>
476
+
477
+ ### ResponseSendTx
478
+
479
+ <x-field-group>
480
+ <x-field data-name="code" data-type="string"></x-field>
481
+ <x-field data-name="hash" data-type="string"></x-field>
482
+ </x-field-group>