@ocap/client 1.25.6 → 1.26.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.
- package/README.md +77 -79
- package/dist/base.js +2 -2
- package/dist/base.js.map +1 -1
- package/dist/bundle.js +1 -1
- package/dist/extension.js +4 -4
- package/dist/extension.js.map +1 -1
- package/dist/report.html +2 -2
- package/docs/api-reference-client-methods.ja.md +38 -38
- package/docs/api-reference-client-methods.zh-TW.md +47 -47
- package/docs/api-reference-client-methods.zh.md +34 -34
- package/docs/api-reference-data-types.ja.md +20 -20
- package/docs/api-reference-data-types.zh-TW.md +17 -17
- package/docs/api-reference-data-types.zh.md +24 -24
- package/docs/api-reference-low-level-api.ja.md +49 -49
- package/docs/api-reference-low-level-api.zh-TW.md +48 -48
- package/docs/api-reference-low-level-api.zh.md +43 -43
- package/docs/api-reference-query-mutation-methods.ja.md +85 -85
- package/docs/api-reference-query-mutation-methods.zh-TW.md +140 -140
- package/docs/api-reference-query-mutation-methods.zh.md +141 -141
- package/docs/api-reference-transaction-helpers.ja.md +120 -120
- package/docs/api-reference-transaction-helpers.zh-TW.md +119 -119
- package/docs/api-reference-transaction-helpers.zh.md +153 -153
- package/docs/api-reference.ja.md +6 -6
- package/docs/api-reference.zh-TW.md +5 -5
- package/docs/api-reference.zh.md +8 -8
- package/docs/core-concepts-client-architecture.ja.md +26 -26
- package/docs/core-concepts-client-architecture.zh-TW.md +34 -34
- package/docs/core-concepts-client-architecture.zh.md +26 -26
- package/docs/core-concepts-event-subscriptions.ja.md +29 -29
- package/docs/core-concepts-event-subscriptions.zh-TW.md +23 -23
- package/docs/core-concepts-event-subscriptions.zh.md +29 -29
- package/docs/core-concepts-gas-payment.ja.md +27 -27
- package/docs/core-concepts-gas-payment.zh-TW.md +28 -28
- package/docs/core-concepts-gas-payment.zh.md +32 -32
- package/docs/core-concepts-transaction-lifecycle.ja.md +40 -40
- package/docs/core-concepts-transaction-lifecycle.zh-TW.md +43 -43
- package/docs/core-concepts-transaction-lifecycle.zh.md +49 -49
- package/docs/core-concepts.ja.md +7 -7
- package/docs/core-concepts.zh-TW.md +6 -6
- package/docs/core-concepts.zh.md +7 -7
- package/docs/getting-started-basic-usage.ja.md +24 -24
- package/docs/getting-started-basic-usage.zh-TW.md +28 -28
- package/docs/getting-started-basic-usage.zh.md +24 -24
- package/docs/getting-started-installation.ja.md +13 -13
- package/docs/getting-started-installation.zh-TW.md +9 -9
- package/docs/getting-started-installation.zh.md +15 -15
- package/docs/getting-started.ja.md +5 -5
- package/docs/getting-started.zh-TW.md +6 -6
- package/docs/getting-started.zh.md +6 -7
- package/docs/how-to-guides-delegate-permissions.ja.md +21 -21
- package/docs/how-to-guides-delegate-permissions.zh-TW.md +20 -21
- package/docs/how-to-guides-delegate-permissions.zh.md +18 -18
- package/docs/how-to-guides-manage-accounts.ja.md +21 -21
- package/docs/how-to-guides-manage-accounts.zh-TW.md +23 -23
- package/docs/how-to-guides-manage-accounts.zh.md +17 -17
- package/docs/how-to-guides-manage-assets.ja.md +137 -60
- package/docs/how-to-guides-manage-assets.md +77 -0
- package/docs/how-to-guides-manage-assets.zh-TW.md +116 -39
- package/docs/how-to-guides-manage-assets.zh.md +142 -65
- package/docs/how-to-guides-manage-tokens.ja.md +47 -47
- package/docs/how-to-guides-manage-tokens.zh-TW.md +49 -49
- package/docs/how-to-guides-manage-tokens.zh.md +34 -34
- package/docs/how-to-guides-stake-tokens-and-assets.ja.md +56 -56
- package/docs/how-to-guides-stake-tokens-and-assets.zh-TW.md +55 -55
- package/docs/how-to-guides-stake-tokens-and-assets.zh.md +51 -51
- package/docs/how-to-guides-transfer-tokens-and-nfts.ja.md +45 -45
- package/docs/how-to-guides-transfer-tokens-and-nfts.zh-TW.md +46 -46
- package/docs/how-to-guides-transfer-tokens-and-nfts.zh.md +37 -37
- package/docs/how-to-guides.ja.md +8 -8
- package/docs/how-to-guides.zh-TW.md +4 -4
- package/docs/how-to-guides.zh.md +6 -6
- package/docs/overview.ja.md +15 -15
- package/docs/overview.zh-TW.md +14 -14
- package/docs/overview.zh.md +12 -12
- package/lib/base.js +2 -2
- package/lib/base.js.map +1 -1
- package/lib/extension.js +4 -4
- package/lib/extension.js.map +1 -1
- package/package.json +16 -16
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 查询与变更方法
|
|
2
2
|
|
|
3
|
-
OCAP
|
|
3
|
+
OCAP Client 通过 GraphQL 与区块链进行交互。其方法主要分为两类:
|
|
4
4
|
|
|
5
|
-
*
|
|
6
|
-
*
|
|
5
|
+
* **查询 (Queries)**:这些是只读操作,用于从区块链中获取数据,例如检索账户状态、列出交易或获取常规链信息。它们不会改变链的状态。
|
|
6
|
+
* **变更 (Mutations)**:这些是写入操作,会修改区块链的状态。发送交易是变更操作的主要示例。
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
本节提供了该客户端所有可用的查询和变更方法的完整参考。
|
|
9
9
|
|
|
10
10
|
## 查询方法
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
查询用于从区块链中检索数据。以下是所有可用查询方法的完整列表。
|
|
13
13
|
|
|
14
14
|
### `getAccountState`
|
|
15
15
|
|
|
@@ -19,33 +19,33 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
19
19
|
|
|
20
20
|
<x-field-group>
|
|
21
21
|
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的账户地址。"></x-field>
|
|
22
|
-
<x-field data-name="height" data-type="string" data-required="false" data-desc="
|
|
22
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="查询特定区块高度下的状态。"></x-field>
|
|
23
23
|
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="要检索的特定字段。"></x-field>
|
|
24
|
-
<x-field data-name="traceMigration" data-type="boolean" data-required="false" data-desc="如果为 true
|
|
24
|
+
<x-field data-name="traceMigration" data-type="boolean" data-required="false" data-desc="如果为 true,则追踪账户的迁移历史。"></x-field>
|
|
25
25
|
</x-field-group>
|
|
26
26
|
|
|
27
27
|
**返回**
|
|
28
28
|
|
|
29
|
-
<x-field data-name="ResponseGetAccountState" data-type="object" data-desc="
|
|
30
|
-
<x-field data-name="code" data-type="string" data-desc="
|
|
29
|
+
<x-field data-name="ResponseGetAccountState" data-type="object" data-desc="包含响应码和账户状态的对象。">
|
|
30
|
+
<x-field data-name="code" data-type="string" data-desc="响应的状态码(例如 'OK')。"></x-field>
|
|
31
31
|
<x-field data-name="state" data-type="AccountState" data-desc="账户的详细状态。"></x-field>
|
|
32
32
|
</x-field>
|
|
33
33
|
|
|
34
34
|
### `getAssetState`
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
检索特定资产 (NFT) 的当前状态。
|
|
37
37
|
|
|
38
38
|
**参数**
|
|
39
39
|
|
|
40
40
|
<x-field-group>
|
|
41
41
|
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的资产地址。"></x-field>
|
|
42
|
-
<x-field data-name="height" data-type="string" data-required="false" data-desc="
|
|
42
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="查询特定区块高度下的状态。"></x-field>
|
|
43
43
|
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="要检索的特定字段。"></x-field>
|
|
44
44
|
</x-field-group>
|
|
45
45
|
|
|
46
46
|
**返回**
|
|
47
47
|
|
|
48
|
-
<x-field data-name="ResponseGetAssetState" data-type="object" data-desc="
|
|
48
|
+
<x-field data-name="ResponseGetAssetState" data-type="object" data-desc="包含响应码和资产状态的对象。">
|
|
49
49
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
50
50
|
<x-field data-name="state" data-type="AssetState" data-desc="资产的详细状态。"></x-field>
|
|
51
51
|
</x-field>
|
|
@@ -62,7 +62,7 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
62
62
|
|
|
63
63
|
**返回**
|
|
64
64
|
|
|
65
|
-
<x-field data-name="ResponseGetFactoryState" data-type="object" data-desc="
|
|
65
|
+
<x-field data-name="ResponseGetFactoryState" data-type="object" data-desc="包含响应码和工厂状态的对象。">
|
|
66
66
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
67
67
|
<x-field data-name="state" data-type="AssetFactoryState" data-desc="资产工厂的详细状态。"></x-field>
|
|
68
68
|
</x-field>
|
|
@@ -75,32 +75,32 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
75
75
|
|
|
76
76
|
<x-field-group>
|
|
77
77
|
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的委托地址。"></x-field>
|
|
78
|
-
<x-field data-name="height" data-type="string" data-required="false" data-desc="
|
|
78
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="查询特定区块高度下的状态。"></x-field>
|
|
79
79
|
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="要检索的特定字段。"></x-field>
|
|
80
80
|
</x-field-group>
|
|
81
81
|
|
|
82
82
|
**返回**
|
|
83
83
|
|
|
84
|
-
<x-field data-name="ResponseGetDelegateState" data-type="object" data-desc="
|
|
84
|
+
<x-field data-name="ResponseGetDelegateState" data-type="object" data-desc="包含响应码和委托状态的对象。">
|
|
85
85
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
86
86
|
<x-field data-name="state" data-type="DelegateState" data-desc="委托的详细状态。"></x-field>
|
|
87
87
|
</x-field>
|
|
88
88
|
|
|
89
89
|
### `getTokenState`
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
获取特定同质化通证的状态。
|
|
92
92
|
|
|
93
93
|
**参数**
|
|
94
94
|
|
|
95
95
|
<x-field-group>
|
|
96
|
-
<x-field data-name="address" data-type="string" data-required="true" data-desc="
|
|
96
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的通证地址。"></x-field>
|
|
97
97
|
</x-field-group>
|
|
98
98
|
|
|
99
99
|
**返回**
|
|
100
100
|
|
|
101
|
-
<x-field data-name="ResponseGetTokenState" data-type="object" data-desc="
|
|
101
|
+
<x-field data-name="ResponseGetTokenState" data-type="object" data-desc="包含响应码和通证状态的对象。">
|
|
102
102
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
103
|
-
<x-field data-name="state" data-type="TokenState" data-desc="
|
|
103
|
+
<x-field data-name="state" data-type="TokenState" data-desc="通证的详细状态。"></x-field>
|
|
104
104
|
</x-field>
|
|
105
105
|
|
|
106
106
|
### `getEvidenceState`
|
|
@@ -115,7 +115,7 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
115
115
|
|
|
116
116
|
**返回**
|
|
117
117
|
|
|
118
|
-
<x-field data-name="ResponseGetEvidenceState" data-type="object" data-desc="
|
|
118
|
+
<x-field data-name="ResponseGetEvidenceState" data-type="object" data-desc="包含响应码和证据状态的对象。">
|
|
119
119
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
120
120
|
<x-field data-name="state" data-type="EvidenceState" data-desc="证据的详细状态。"></x-field>
|
|
121
121
|
</x-field>
|
|
@@ -127,37 +127,37 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
127
127
|
**参数**
|
|
128
128
|
|
|
129
129
|
<x-field-group>
|
|
130
|
-
<x-field data-name="height" data-type="string" data-required="false" data-desc="
|
|
130
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="查询特定区块高度下的状态。"></x-field>
|
|
131
131
|
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="要检索的特定字段。"></x-field>
|
|
132
132
|
</x-field-group>
|
|
133
133
|
|
|
134
134
|
**返回**
|
|
135
135
|
|
|
136
|
-
<x-field data-name="ResponseGetForgeState" data-type="object" data-desc="
|
|
136
|
+
<x-field data-name="ResponseGetForgeState" data-type="object" data-desc="包含响应码和链状态的对象。">
|
|
137
137
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
138
138
|
<x-field data-name="state" data-type="ForgeState" data-desc="OCAP 链的详细状态。"></x-field>
|
|
139
139
|
</x-field>
|
|
140
140
|
|
|
141
141
|
### `getTokenFactoryState`
|
|
142
142
|
|
|
143
|
-
|
|
143
|
+
检索特定通证工厂的状态。
|
|
144
144
|
|
|
145
145
|
**参数**
|
|
146
146
|
|
|
147
147
|
<x-field-group>
|
|
148
|
-
<x-field data-name="address" data-type="string" data-required="true" data-desc="
|
|
148
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的通证工厂地址。"></x-field>
|
|
149
149
|
</x-field-group>
|
|
150
150
|
|
|
151
151
|
**返回**
|
|
152
152
|
|
|
153
|
-
<x-field data-name="ResponseGetTokenFactoryState" data-type="object" data-desc="
|
|
153
|
+
<x-field data-name="ResponseGetTokenFactoryState" data-type="object" data-desc="包含响应码和通证工厂状态的对象。">
|
|
154
154
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
155
|
-
<x-field data-name="state" data-type="TokenFactoryState" data-desc="
|
|
155
|
+
<x-field data-name="state" data-type="TokenFactoryState" data-desc="通证工厂的详细状态。"></x-field>
|
|
156
156
|
</x-field>
|
|
157
157
|
|
|
158
158
|
### `getTx`
|
|
159
159
|
|
|
160
|
-
|
|
160
|
+
通过哈希值获取单笔交易。
|
|
161
161
|
|
|
162
162
|
**参数**
|
|
163
163
|
|
|
@@ -167,14 +167,14 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
167
167
|
|
|
168
168
|
**返回**
|
|
169
169
|
|
|
170
|
-
<x-field data-name="ResponseGetTx" data-type="object" data-desc="
|
|
170
|
+
<x-field data-name="ResponseGetTx" data-type="object" data-desc="包含响应码和交易详情的对象。">
|
|
171
171
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
172
172
|
<x-field data-name="info" data-type="TransactionInfo" data-desc="交易的详细信息。"></x-field>
|
|
173
173
|
</x-field>
|
|
174
174
|
|
|
175
175
|
### `getBlock`
|
|
176
176
|
|
|
177
|
-
|
|
177
|
+
通过区块高度检索单个区块。
|
|
178
178
|
|
|
179
179
|
**参数**
|
|
180
180
|
|
|
@@ -184,14 +184,14 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
184
184
|
|
|
185
185
|
**返回**
|
|
186
186
|
|
|
187
|
-
<x-field data-name="ResponseGetBlock" data-type="object" data-desc="
|
|
187
|
+
<x-field data-name="ResponseGetBlock" data-type="object" data-desc="包含响应码和区块详情的对象。">
|
|
188
188
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
189
189
|
<x-field data-name="block" data-type="BlockInfo" data-desc="区块的详细信息。"></x-field>
|
|
190
190
|
</x-field>
|
|
191
191
|
|
|
192
192
|
### `getBlocks`
|
|
193
193
|
|
|
194
|
-
|
|
194
|
+
检索区块列表,可附带筛选条件。
|
|
195
195
|
|
|
196
196
|
**参数**
|
|
197
197
|
|
|
@@ -203,10 +203,10 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
203
203
|
|
|
204
204
|
**返回**
|
|
205
205
|
|
|
206
|
-
<x-field data-name="ResponseGetBlocks" data-type="object" data-desc="
|
|
206
|
+
<x-field data-name="ResponseGetBlocks" data-type="object" data-desc="包含分页信息和区块列表的对象。">
|
|
207
207
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
208
208
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
209
|
-
<x-field data-name="blocks" data-type="BlockInfoSimple[]" data-desc="
|
|
209
|
+
<x-field data-name="blocks" data-type="BlockInfoSimple[]" data-desc="简化区块对象的数组。"></x-field>
|
|
210
210
|
</x-field>
|
|
211
211
|
|
|
212
212
|
### `getUnconfirmedTxs`
|
|
@@ -221,10 +221,10 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
221
221
|
|
|
222
222
|
**返回**
|
|
223
223
|
|
|
224
|
-
<x-field data-name="ResponseGetUnconfirmedTxs" data-type="object" data-desc="
|
|
224
|
+
<x-field data-name="ResponseGetUnconfirmedTxs" data-type="object" data-desc="包含分页信息和未确认交易列表的对象。">
|
|
225
225
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
226
226
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
227
|
-
<x-field data-name="unconfirmedTxs" data-type="UnconfirmedTxs" data-desc="
|
|
227
|
+
<x-field data-name="unconfirmedTxs" data-type="UnconfirmedTxs" data-desc="未确认交易的详细信息。"></x-field>
|
|
228
228
|
</x-field>
|
|
229
229
|
|
|
230
230
|
### `getChainInfo`
|
|
@@ -237,7 +237,7 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
237
237
|
|
|
238
238
|
**返回**
|
|
239
239
|
|
|
240
|
-
<x-field data-name="ResponseGetChainInfo" data-type="object" data-desc="
|
|
240
|
+
<x-field data-name="ResponseGetChainInfo" data-type="object" data-desc="包含响应码和链信息的对象。">
|
|
241
241
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
242
242
|
<x-field data-name="info" data-type="ChainInfo" data-desc="链的详细信息。"></x-field>
|
|
243
243
|
</x-field>
|
|
@@ -254,7 +254,7 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
254
254
|
|
|
255
255
|
**返回**
|
|
256
256
|
|
|
257
|
-
<x-field data-name="ResponseGetConfig" data-type="object" data-desc="
|
|
257
|
+
<x-field data-name="ResponseGetConfig" data-type="object" data-desc="包含响应码和配置的对象。">
|
|
258
258
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
259
259
|
<x-field data-name="config" data-type="string" data-desc="节点的配置,以字符串形式表示。"></x-field>
|
|
260
260
|
</x-field>
|
|
@@ -269,14 +269,14 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
269
269
|
|
|
270
270
|
**返回**
|
|
271
271
|
|
|
272
|
-
<x-field data-name="ResponseGetNetInfo" data-type="object" data-desc="
|
|
272
|
+
<x-field data-name="ResponseGetNetInfo" data-type="object" data-desc="包含响应码和网络信息的对象。">
|
|
273
273
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
274
274
|
<x-field data-name="netInfo" data-type="NetInfo" data-desc="详细的网络信息。"></x-field>
|
|
275
275
|
</x-field>
|
|
276
276
|
|
|
277
277
|
### `getNodeInfo`
|
|
278
278
|
|
|
279
|
-
|
|
279
|
+
检索有关被查询的特定节点的信息。
|
|
280
280
|
|
|
281
281
|
**参数**
|
|
282
282
|
|
|
@@ -284,14 +284,14 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
284
284
|
|
|
285
285
|
**返回**
|
|
286
286
|
|
|
287
|
-
<x-field data-name="ResponseGetNodeInfo" data-type="object" data-desc="
|
|
287
|
+
<x-field data-name="ResponseGetNodeInfo" data-type="object" data-desc="包含响应码和节点信息的对象。">
|
|
288
288
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
289
|
-
<x-field data-name="info" data-type="NodeInfo" data-desc="
|
|
289
|
+
<x-field data-name="info" data-type="NodeInfo" data-desc="有关节点的详细信息。"></x-field>
|
|
290
290
|
</x-field>
|
|
291
291
|
|
|
292
292
|
### `getValidatorsInfo`
|
|
293
293
|
|
|
294
|
-
|
|
294
|
+
获取有关当前验证者集的信息。
|
|
295
295
|
|
|
296
296
|
**参数**
|
|
297
297
|
|
|
@@ -299,14 +299,14 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
299
299
|
|
|
300
300
|
**返回**
|
|
301
301
|
|
|
302
|
-
<x-field data-name="ResponseGetValidatorsInfo" data-type="object" data-desc="
|
|
302
|
+
<x-field data-name="ResponseGetValidatorsInfo" data-type="object" data-desc="包含响应码和验证者信息的对象。">
|
|
303
303
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
304
|
-
<x-field data-name="validatorsInfo" data-type="ValidatorsInfo" data-desc="
|
|
304
|
+
<x-field data-name="validatorsInfo" data-type="ValidatorsInfo" data-desc="有关验证者的详细信息。"></x-field>
|
|
305
305
|
</x-field>
|
|
306
306
|
|
|
307
307
|
### `getForgeStats`
|
|
308
308
|
|
|
309
|
-
|
|
309
|
+
检索有关区块链活动的各种统计数据。
|
|
310
310
|
|
|
311
311
|
**参数**
|
|
312
312
|
|
|
@@ -314,9 +314,9 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
314
314
|
|
|
315
315
|
**返回**
|
|
316
316
|
|
|
317
|
-
<x-field data-name="ResponseGetForgeStats" data-type="object" data-desc="
|
|
317
|
+
<x-field data-name="ResponseGetForgeStats" data-type="object" data-desc="包含响应码和链统计数据的对象。">
|
|
318
318
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
319
|
-
<x-field data-name="forgeStats" data-type="ForgeStats" data-desc="
|
|
319
|
+
<x-field data-name="forgeStats" data-type="ForgeStats" data-desc="有关 OCAP 链的各种统计数据。"></x-field>
|
|
320
320
|
</x-field>
|
|
321
321
|
|
|
322
322
|
### `listAssetTransactions`
|
|
@@ -332,15 +332,15 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
332
332
|
|
|
333
333
|
**返回**
|
|
334
334
|
|
|
335
|
-
<x-field data-name="ResponseListAssetTransactions" data-type="object" data-desc="
|
|
335
|
+
<x-field data-name="ResponseListAssetTransactions" data-type="object" data-desc="包含分页信息和交易列表的对象。">
|
|
336
336
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
337
337
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
338
|
-
<x-field data-name="transactions" data-type="IndexedTransaction[]" data-desc="
|
|
338
|
+
<x-field data-name="transactions" data-type="IndexedTransaction[]" data-desc="交易对象的数组。"></x-field>
|
|
339
339
|
</x-field>
|
|
340
340
|
|
|
341
341
|
### `listAssets`
|
|
342
342
|
|
|
343
|
-
|
|
343
|
+
列出所有资产,可通过所有者或工厂进行筛选。
|
|
344
344
|
|
|
345
345
|
**参数**
|
|
346
346
|
|
|
@@ -353,15 +353,15 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
353
353
|
|
|
354
354
|
**返回**
|
|
355
355
|
|
|
356
|
-
<x-field data-name="ResponseListAssets" data-type="object" data-desc="
|
|
356
|
+
<x-field data-name="ResponseListAssets" data-type="object" data-desc="包含分页信息和资产列表的对象。">
|
|
357
357
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
358
358
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
359
|
-
<x-field data-name="assets" data-type="IndexedAssetState[]" data-desc="
|
|
359
|
+
<x-field data-name="assets" data-type="IndexedAssetState[]" data-desc="资产状态对象的数组。"></x-field>
|
|
360
360
|
</x-field>
|
|
361
361
|
|
|
362
362
|
### `listBlocks`
|
|
363
363
|
|
|
364
|
-
|
|
364
|
+
列出区块,并提供多种筛选选项。
|
|
365
365
|
|
|
366
366
|
**参数**
|
|
367
367
|
|
|
@@ -376,35 +376,35 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
376
376
|
|
|
377
377
|
**返回**
|
|
378
378
|
|
|
379
|
-
<x-field data-name="ResponseListBlocks" data-type="object" data-desc="
|
|
379
|
+
<x-field data-name="ResponseListBlocks" data-type="object" data-desc="包含分页信息和区块列表的对象。">
|
|
380
380
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
381
381
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
382
|
-
<x-field data-name="blocks" data-type="IndexedBlock[]" data-desc="
|
|
382
|
+
<x-field data-name="blocks" data-type="IndexedBlock[]" data-desc="区块对象的数组。"></x-field>
|
|
383
383
|
</x-field>
|
|
384
384
|
|
|
385
385
|
### `listTopAccounts`
|
|
386
386
|
|
|
387
|
-
|
|
387
|
+
列出持有特定通证余额最高的账户。
|
|
388
388
|
|
|
389
389
|
**参数**
|
|
390
390
|
|
|
391
391
|
<x-field-group>
|
|
392
392
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
393
|
-
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="
|
|
393
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="通证的地址。如果未提供,则默认为原生通证。"></x-field>
|
|
394
394
|
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按时间范围筛选账户。"></x-field>
|
|
395
395
|
</x-field-group>
|
|
396
396
|
|
|
397
397
|
**返回**
|
|
398
398
|
|
|
399
|
-
<x-field data-name="ResponseListTopAccounts" data-type="object" data-desc="
|
|
399
|
+
<x-field data-name="ResponseListTopAccounts" data-type="object" data-desc="包含分页信息和排名靠前账户列表的对象。">
|
|
400
400
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
401
401
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
402
|
-
<x-field data-name="accounts" data-type="IndexedAccountState[]" data-desc="
|
|
402
|
+
<x-field data-name="accounts" data-type="IndexedAccountState[]" data-desc="账户状态对象的数组。"></x-field>
|
|
403
403
|
</x-field>
|
|
404
404
|
|
|
405
405
|
### `listTransactions`
|
|
406
406
|
|
|
407
|
-
|
|
407
|
+
一个功能强大的方法,可通过多种筛选条件列出交易。
|
|
408
408
|
|
|
409
409
|
**参数**
|
|
410
410
|
|
|
@@ -415,42 +415,42 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
415
415
|
<x-field data-name="typeFilter" data-type="TypeFilterInput" data-required="false" data-desc="按交易类型筛选。"></x-field>
|
|
416
416
|
<x-field data-name="validityFilter" data-type="ValidityFilterInput" data-required="false" data-desc="按交易有效性筛选。"></x-field>
|
|
417
417
|
<x-field data-name="factoryFilter" data-type="FactoryFilterInput" data-required="false" data-desc="按工厂地址筛选。"></x-field>
|
|
418
|
-
<x-field data-name="tokenFilter" data-type="TokenFilterInput" data-required="false" data-desc="
|
|
418
|
+
<x-field data-name="tokenFilter" data-type="TokenFilterInput" data-required="false" data-desc="按通证地址筛选。"></x-field>
|
|
419
419
|
<x-field data-name="assetFilter" data-type="AssetFilterInput" data-required="false" data-desc="按资产地址筛选。"></x-field>
|
|
420
420
|
<x-field data-name="accountFilter" data-type="AccountFilterInput" data-required="false" data-desc="按账户地址筛选。"></x-field>
|
|
421
|
-
<x-field data-name="txFilter" data-type="TxFilterInput" data-required="false" data-desc="
|
|
422
|
-
<x-field data-name="rollupFilter" data-type="RollupFilterInput" data-required="false" data-desc="按
|
|
421
|
+
<x-field data-name="txFilter" data-type="TxFilterInput" data-required="false" data-desc="按交易哈希筛选。"></x-field>
|
|
422
|
+
<x-field data-name="rollupFilter" data-type="RollupFilterInput" data-required="false" data-desc="按 Rollup 地址筛选。"></x-field>
|
|
423
423
|
<x-field data-name="stakeFilter" data-type="StakeFilterInput" data-required="false" data-desc="按质押地址筛选。"></x-field>
|
|
424
424
|
<x-field data-name="delegationFilter" data-type="DelegationFilterInput" data-required="false" data-desc="按委托地址筛选。"></x-field>
|
|
425
|
-
<x-field data-name="tokenFactoryFilter" data-type="TokenFactoryFilterInput" data-required="false" data-desc="
|
|
425
|
+
<x-field data-name="tokenFactoryFilter" data-type="TokenFactoryFilterInput" data-required="false" data-desc="按通证工厂地址筛选。"></x-field>
|
|
426
426
|
</x-field-group>
|
|
427
427
|
|
|
428
428
|
**返回**
|
|
429
429
|
|
|
430
|
-
<x-field data-name="ResponseListTransactions" data-type="object" data-desc="
|
|
430
|
+
<x-field data-name="ResponseListTransactions" data-type="object" data-desc="包含分页信息和交易列表的对象。">
|
|
431
431
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
432
432
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
433
|
-
<x-field data-name="transactions" data-type="IndexedTransaction[]" data-desc="
|
|
433
|
+
<x-field data-name="transactions" data-type="IndexedTransaction[]" data-desc="交易对象的数组。"></x-field>
|
|
434
434
|
</x-field>
|
|
435
435
|
|
|
436
436
|
### `listTokens`
|
|
437
437
|
|
|
438
|
-
|
|
438
|
+
列出链上所有的同质化通证。
|
|
439
439
|
|
|
440
440
|
**参数**
|
|
441
441
|
|
|
442
442
|
<x-field-group>
|
|
443
443
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
444
|
-
<x-field data-name="issuerAddress" data-type="string" data-required="false" data-desc="
|
|
445
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
444
|
+
<x-field data-name="issuerAddress" data-type="string" data-required="false" data-desc="按发行方地址筛选通证。"></x-field>
|
|
445
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按时间范围筛选通证。"></x-field>
|
|
446
446
|
</x-field-group>
|
|
447
447
|
|
|
448
448
|
**返回**
|
|
449
449
|
|
|
450
|
-
<x-field data-name="ResponseListTokens" data-type="object" data-desc="
|
|
450
|
+
<x-field data-name="ResponseListTokens" data-type="object" data-desc="包含分页信息和通证列表的对象。">
|
|
451
451
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
452
452
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
453
|
-
<x-field data-name="tokens" data-type="IndexedTokenState[]" data-desc="
|
|
453
|
+
<x-field data-name="tokens" data-type="IndexedTokenState[]" data-desc="通证状态对象的数组。"></x-field>
|
|
454
454
|
</x-field>
|
|
455
455
|
|
|
456
456
|
### `listFactories`
|
|
@@ -468,28 +468,28 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
468
468
|
|
|
469
469
|
**返回**
|
|
470
470
|
|
|
471
|
-
<x-field data-name="ResponseListFactories" data-type="object" data-desc="
|
|
471
|
+
<x-field data-name="ResponseListFactories" data-type="object" data-desc="包含分页信息和工厂列表的对象。">
|
|
472
472
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
473
473
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
474
|
-
<x-field data-name="factories" data-type="IndexedFactoryState[]" data-desc="
|
|
474
|
+
<x-field data-name="factories" data-type="IndexedFactoryState[]" data-desc="工厂状态对象的数组。"></x-field>
|
|
475
475
|
</x-field>
|
|
476
476
|
|
|
477
477
|
### `getAccountTokens`
|
|
478
478
|
|
|
479
|
-
|
|
479
|
+
检索特定账户的通证余额。
|
|
480
480
|
|
|
481
481
|
**参数**
|
|
482
482
|
|
|
483
483
|
<x-field-group>
|
|
484
484
|
<x-field data-name="address" data-type="string" data-required="true" data-desc="账户的地址。"></x-field>
|
|
485
|
-
<x-field data-name="token" data-type="string" data-required="false" data-desc="
|
|
485
|
+
<x-field data-name="token" data-type="string" data-required="false" data-desc="要查询的特定通证地址。"></x-field>
|
|
486
486
|
</x-field-group>
|
|
487
487
|
|
|
488
488
|
**返回**
|
|
489
489
|
|
|
490
|
-
<x-field data-name="ResponseGetAccountTokens" data-type="object" data-desc="
|
|
490
|
+
<x-field data-name="ResponseGetAccountTokens" data-type="object" data-desc="包含响应码和账户通证列表的对象。">
|
|
491
491
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
492
|
-
<x-field data-name="tokens" data-type="AccountToken[]" data-desc="
|
|
492
|
+
<x-field data-name="tokens" data-type="AccountToken[]" data-desc="通证余额对象的数组。"></x-field>
|
|
493
493
|
</x-field>
|
|
494
494
|
|
|
495
495
|
### `getStakeState`
|
|
@@ -500,20 +500,20 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
500
500
|
|
|
501
501
|
<x-field-group>
|
|
502
502
|
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的质押地址。"></x-field>
|
|
503
|
-
<x-field data-name="height" data-type="string" data-required="false" data-desc="
|
|
503
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="查询特定区块高度下的状态。"></x-field>
|
|
504
504
|
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="要检索的特定字段。"></x-field>
|
|
505
505
|
</x-field-group>
|
|
506
506
|
|
|
507
507
|
**返回**
|
|
508
508
|
|
|
509
|
-
<x-field data-name="ResponseGetStakeState" data-type="object" data-desc="
|
|
509
|
+
<x-field data-name="ResponseGetStakeState" data-type="object" data-desc="包含响应码和质押状态的对象。">
|
|
510
510
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
511
511
|
<x-field data-name="state" data-type="StakeState" data-desc="质押的详细状态。"></x-field>
|
|
512
512
|
</x-field>
|
|
513
513
|
|
|
514
514
|
### `listStakes`
|
|
515
515
|
|
|
516
|
-
|
|
516
|
+
列出所有质押记录,可附带筛选条件。
|
|
517
517
|
|
|
518
518
|
**参数**
|
|
519
519
|
|
|
@@ -526,112 +526,112 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
526
526
|
|
|
527
527
|
**返回**
|
|
528
528
|
|
|
529
|
-
<x-field data-name="ResponseListStakes" data-type="object" data-desc="
|
|
529
|
+
<x-field data-name="ResponseListStakes" data-type="object" data-desc="包含分页信息和质押列表的对象。">
|
|
530
530
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
531
531
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
532
|
-
<x-field data-name="stakes" data-type="IndexedStakeState[]" data-desc="
|
|
532
|
+
<x-field data-name="stakes" data-type="IndexedStakeState[]" data-desc="质押状态对象的数组。"></x-field>
|
|
533
533
|
</x-field>
|
|
534
534
|
|
|
535
535
|
### `getRollupState`
|
|
536
536
|
|
|
537
|
-
检索特定
|
|
537
|
+
检索特定 Rollup 的状态。
|
|
538
538
|
|
|
539
539
|
**参数**
|
|
540
540
|
|
|
541
541
|
<x-field-group>
|
|
542
|
-
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的
|
|
543
|
-
<x-field data-name="height" data-type="string" data-required="false" data-desc="
|
|
542
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="要查询的 Rollup 地址。"></x-field>
|
|
543
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="查询特定区块高度下的状态。"></x-field>
|
|
544
544
|
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="要检索的特定字段。"></x-field>
|
|
545
545
|
</x-field-group>
|
|
546
546
|
|
|
547
547
|
**返回**
|
|
548
548
|
|
|
549
|
-
<x-field data-name="ResponseGetRollupState" data-type="object" data-desc="
|
|
549
|
+
<x-field data-name="ResponseGetRollupState" data-type="object" data-desc="包含响应码和 Rollup 状态的对象。">
|
|
550
550
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
551
|
-
<x-field data-name="state" data-type="RollupState" data-desc="
|
|
551
|
+
<x-field data-name="state" data-type="RollupState" data-desc="Rollup 的详细状态。"></x-field>
|
|
552
552
|
</x-field>
|
|
553
553
|
|
|
554
554
|
### `listRollups`
|
|
555
555
|
|
|
556
|
-
列出链上所有的
|
|
556
|
+
列出链上所有的 Rollup。
|
|
557
557
|
|
|
558
558
|
**参数**
|
|
559
559
|
|
|
560
560
|
<x-field-group>
|
|
561
561
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
562
|
-
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="
|
|
563
|
-
<x-field data-name="foreignTokenAddress" data-type="string" data-required="false" data-desc="
|
|
564
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按时间范围筛选
|
|
562
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="按通证地址筛选 Rollup。"></x-field>
|
|
563
|
+
<x-field data-name="foreignTokenAddress" data-type="string" data-required="false" data-desc="按外部通证地址筛选 Rollup。"></x-field>
|
|
564
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按时间范围筛选 Rollup。"></x-field>
|
|
565
565
|
</x-field-group>
|
|
566
566
|
|
|
567
567
|
**返回**
|
|
568
568
|
|
|
569
|
-
<x-field data-name="ResponseListRollups" data-type="object" data-desc="
|
|
569
|
+
<x-field data-name="ResponseListRollups" data-type="object" data-desc="包含分页信息和 Rollup 列表的对象。">
|
|
570
570
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
571
571
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
572
|
-
<x-field data-name="rollups" data-type="IndexedRollupState[]" data-desc="
|
|
572
|
+
<x-field data-name="rollups" data-type="IndexedRollupState[]" data-desc="Rollup 状态对象的数组。"></x-field>
|
|
573
573
|
</x-field>
|
|
574
574
|
|
|
575
575
|
### `getRollupBlock`
|
|
576
576
|
|
|
577
|
-
从
|
|
577
|
+
从 Rollup 侧链获取特定区块。
|
|
578
578
|
|
|
579
579
|
**参数**
|
|
580
580
|
|
|
581
581
|
<x-field-group>
|
|
582
|
-
<x-field data-name="hash" data-type="string" data-required="false" data-desc="
|
|
583
|
-
<x-field data-name="height" data-type="string" data-required="false" data-desc="
|
|
584
|
-
<x-field data-name="rollupAddress" data-type="string" data-required="true" data-desc="
|
|
582
|
+
<x-field data-name="hash" data-type="string" data-required="false" data-desc="Rollup 区块的哈希值。"></x-field>
|
|
583
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="Rollup 区块的高度。"></x-field>
|
|
584
|
+
<x-field data-name="rollupAddress" data-type="string" data-required="true" data-desc="Rollup 的地址。"></x-field>
|
|
585
585
|
</x-field-group>
|
|
586
586
|
|
|
587
587
|
**返回**
|
|
588
588
|
|
|
589
|
-
<x-field data-name="ResponseGetRollupBlock" data-type="object" data-desc="
|
|
589
|
+
<x-field data-name="ResponseGetRollupBlock" data-type="object" data-desc="包含响应码和 Rollup 区块的对象。">
|
|
590
590
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
591
|
-
<x-field data-name="block" data-type="RollupBlock" data-desc="
|
|
591
|
+
<x-field data-name="block" data-type="RollupBlock" data-desc="Rollup 区块的详细信息。"></x-field>
|
|
592
592
|
</x-field>
|
|
593
593
|
|
|
594
594
|
### `listRollupBlocks`
|
|
595
595
|
|
|
596
|
-
列出
|
|
596
|
+
列出 Rollup 侧链的区块。
|
|
597
597
|
|
|
598
598
|
**参数**
|
|
599
599
|
|
|
600
600
|
<x-field-group>
|
|
601
601
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
602
|
-
<x-field data-name="rollupAddress" data-type="string" data-required="true" data-desc="
|
|
603
|
-
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="
|
|
602
|
+
<x-field data-name="rollupAddress" data-type="string" data-required="true" data-desc="Rollup 的地址。"></x-field>
|
|
603
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="按通证地址筛选。"></x-field>
|
|
604
604
|
<x-field data-name="proposer" data-type="string" data-required="false" data-desc="按提议者地址筛选。"></x-field>
|
|
605
605
|
<x-field data-name="validatorFilter" data-type="ValidatorFilterInput" data-required="false" data-desc="按验证者筛选。"></x-field>
|
|
606
|
-
<x-field data-name="txFilter" data-type="TxFilterInput" data-required="false" data-desc="
|
|
606
|
+
<x-field data-name="txFilter" data-type="TxFilterInput" data-required="false" data-desc="按交易哈希筛选。"></x-field>
|
|
607
607
|
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按时间范围筛选。"></x-field>
|
|
608
608
|
</x-field-group>
|
|
609
609
|
|
|
610
610
|
**返回**
|
|
611
611
|
|
|
612
|
-
<x-field data-name="ResponseListRollupBlocks" data-type="object" data-desc="
|
|
612
|
+
<x-field data-name="ResponseListRollupBlocks" data-type="object" data-desc="包含分页信息和 Rollup 区块列表的对象。">
|
|
613
613
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
614
614
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
615
|
-
<x-field data-name="blocks" data-type="IndexedRollupBlock[]" data-desc="
|
|
615
|
+
<x-field data-name="blocks" data-type="IndexedRollupBlock[]" data-desc="Rollup 区块对象的数组。"></x-field>
|
|
616
616
|
</x-field>
|
|
617
617
|
|
|
618
618
|
### `listRollupValidators`
|
|
619
619
|
|
|
620
|
-
列出特定
|
|
620
|
+
列出特定 Rollup 的验证者。
|
|
621
621
|
|
|
622
622
|
**参数**
|
|
623
623
|
|
|
624
624
|
<x-field-group>
|
|
625
625
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
626
|
-
<x-field data-name="rollupAddress" data-type="string" data-required="true" data-desc="
|
|
626
|
+
<x-field data-name="rollupAddress" data-type="string" data-required="true" data-desc="Rollup 的地址。"></x-field>
|
|
627
627
|
</x-field-group>
|
|
628
628
|
|
|
629
629
|
**返回**
|
|
630
630
|
|
|
631
|
-
<x-field data-name="ResponseListRollupValidators" data-type="object" data-desc="
|
|
631
|
+
<x-field data-name="ResponseListRollupValidators" data-type="object" data-desc="包含分页信息和 Rollup 验证者列表的对象。">
|
|
632
632
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
633
633
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
634
|
-
<x-field data-name="validators" data-type="IndexedRollupValidator[]" data-desc="
|
|
634
|
+
<x-field data-name="validators" data-type="IndexedRollupValidator[]" data-desc="Rollup 验证者对象的数组。"></x-field>
|
|
635
635
|
</x-field>
|
|
636
636
|
|
|
637
637
|
### `listDelegations`
|
|
@@ -649,29 +649,29 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
649
649
|
|
|
650
650
|
**返回**
|
|
651
651
|
|
|
652
|
-
<x-field data-name="ResponseListDelegations" data-type="object" data-desc="
|
|
652
|
+
<x-field data-name="ResponseListDelegations" data-type="object" data-desc="包含分页信息和委托列表的对象。">
|
|
653
653
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
654
654
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
655
|
-
<x-field data-name="delegations" data-type="IndexedDelegationState[]" data-desc="
|
|
655
|
+
<x-field data-name="delegations" data-type="IndexedDelegationState[]" data-desc="委托状态对象的数组。"></x-field>
|
|
656
656
|
</x-field>
|
|
657
657
|
|
|
658
658
|
### `search`
|
|
659
659
|
|
|
660
|
-
|
|
660
|
+
对账户、资产或交易进行关键字搜索。
|
|
661
661
|
|
|
662
662
|
**参数**
|
|
663
663
|
|
|
664
664
|
<x-field-group>
|
|
665
665
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
666
|
-
<x-field data-name="keyword" data-type="string" data-required="true" data-desc="
|
|
666
|
+
<x-field data-name="keyword" data-type="string" data-required="true" data-desc="要搜索的关键字。"></x-field>
|
|
667
667
|
</x-field-group>
|
|
668
668
|
|
|
669
669
|
**返回**
|
|
670
670
|
|
|
671
|
-
<x-field data-name="ResponseSearch" data-type="object" data-desc="
|
|
671
|
+
<x-field data-name="ResponseSearch" data-type="object" data-desc="包含分页信息和搜索结果的对象。">
|
|
672
672
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
673
673
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
674
|
-
<x-field data-name="results" data-type="SearchResult[]" data-desc="
|
|
674
|
+
<x-field data-name="results" data-type="SearchResult[]" data-desc="搜索结果对象的数组。"></x-field>
|
|
675
675
|
</x-field>
|
|
676
676
|
|
|
677
677
|
### `estimateGas`
|
|
@@ -682,36 +682,36 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
682
682
|
|
|
683
683
|
<x-field-group>
|
|
684
684
|
<x-field data-name="typeUrl" data-type="string" data-required="true" data-desc="交易的类型 URL。"></x-field>
|
|
685
|
-
<x-field data-name="tx" data-type="string" data-required="true" data-desc="
|
|
685
|
+
<x-field data-name="tx" data-type="string" data-required="true" data-desc="已编码的交易字符串。"></x-field>
|
|
686
686
|
</x-field-group>
|
|
687
687
|
|
|
688
688
|
**返回**
|
|
689
689
|
|
|
690
|
-
<x-field data-name="ResponseEstimateGas" data-type="object" data-desc="
|
|
690
|
+
<x-field data-name="ResponseEstimateGas" data-type="object" data-desc="包含响应码和 gas 估算值的对象。">
|
|
691
691
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
692
692
|
<x-field data-name="estimate" data-type="GasEstimate" data-desc="估算的 gas。"></x-field>
|
|
693
693
|
</x-field>
|
|
694
694
|
|
|
695
695
|
### `listTokenFlows`
|
|
696
696
|
|
|
697
|
-
|
|
697
|
+
追踪账户之间的通证流动。
|
|
698
698
|
|
|
699
699
|
**参数**
|
|
700
700
|
|
|
701
701
|
<x-field-group>
|
|
702
702
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
703
703
|
<x-field data-name="accountAddress" data-type="string" data-required="true" data-desc="要追踪的账户地址。"></x-field>
|
|
704
|
-
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="
|
|
704
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="要追踪的通证地址。"></x-field>
|
|
705
705
|
<x-field data-name="depth" data-type="number" data-required="false" data-desc="追踪的深度。"></x-field>
|
|
706
|
-
<x-field data-name="direction" data-type="TokenFlowDirection" data-required="false" data-desc="
|
|
706
|
+
<x-field data-name="direction" data-type="TokenFlowDirection" data-required="false" data-desc="流动方向(IN 或 OUT)。"></x-field>
|
|
707
707
|
</x-field-group>
|
|
708
708
|
|
|
709
709
|
**返回**
|
|
710
710
|
|
|
711
|
-
<x-field data-name="ResponseListTokenFlows" data-type="object" data-desc="
|
|
711
|
+
<x-field data-name="ResponseListTokenFlows" data-type="object" data-desc="包含分页信息和通证流动数据的对象。">
|
|
712
712
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
713
713
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
714
|
-
<x-field data-name="data" data-type="IndexedTokenFlow[]" data-desc="
|
|
714
|
+
<x-field data-name="data" data-type="IndexedTokenFlow[]" data-desc="通证流动对象的数组。"></x-field>
|
|
715
715
|
</x-field>
|
|
716
716
|
|
|
717
717
|
### `verifyAccountRisk`
|
|
@@ -722,53 +722,53 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
722
722
|
|
|
723
723
|
<x-field-group>
|
|
724
724
|
<x-field data-name="accountAddress" data-type="string" data-required="true" data-desc="要验证的账户地址。"></x-field>
|
|
725
|
-
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="
|
|
725
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="用于提供上下文的通证地址。"></x-field>
|
|
726
726
|
</x-field-group>
|
|
727
727
|
|
|
728
728
|
**返回**
|
|
729
729
|
|
|
730
|
-
<x-field data-name="ResponseVerifyAccountRisk" data-type="object" data-desc="
|
|
730
|
+
<x-field data-name="ResponseVerifyAccountRisk" data-type="object" data-desc="包含响应码和风险验证结果的对象。">
|
|
731
731
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
732
732
|
<x-field data-name="data" data-type="VerifyAccountRiskResult" data-desc="风险验证的结果。"></x-field>
|
|
733
733
|
</x-field>
|
|
734
734
|
|
|
735
735
|
### `getTokenDistribution`
|
|
736
736
|
|
|
737
|
-
|
|
737
|
+
检索给定通证的分布统计数据。
|
|
738
738
|
|
|
739
739
|
**参数**
|
|
740
740
|
|
|
741
741
|
<x-field-group>
|
|
742
|
-
<x-field data-name="tokenAddress" data-type="string" data-required="true" data-desc="
|
|
742
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="true" data-desc="通证的地址。"></x-field>
|
|
743
743
|
</x-field-group>
|
|
744
744
|
|
|
745
745
|
**返回**
|
|
746
746
|
|
|
747
|
-
<x-field data-name="ResponseGetTokenDistribution" data-type="object" data-desc="
|
|
747
|
+
<x-field data-name="ResponseGetTokenDistribution" data-type="object" data-desc="包含响应码和通证分布数据的对象。">
|
|
748
748
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
749
|
-
<x-field data-name="data" data-type="TokenDistribution" data-desc="
|
|
749
|
+
<x-field data-name="data" data-type="TokenDistribution" data-desc="通证分布统计数据。"></x-field>
|
|
750
750
|
</x-field>
|
|
751
751
|
|
|
752
752
|
### `listTokenFactories`
|
|
753
753
|
|
|
754
|
-
|
|
754
|
+
列出链上所有的通证工厂。
|
|
755
755
|
|
|
756
756
|
**参数**
|
|
757
757
|
|
|
758
758
|
<x-field-group>
|
|
759
759
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分页设置。"></x-field>
|
|
760
|
-
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="
|
|
761
|
-
<x-field data-name="reserveAddress" data-type="string" data-required="false" data-desc="
|
|
760
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="按通证地址筛选。"></x-field>
|
|
761
|
+
<x-field data-name="reserveAddress" data-type="string" data-required="false" data-desc="按储备通证地址筛选。"></x-field>
|
|
762
762
|
<x-field data-name="owner" data-type="string" data-required="false" data-desc="按所有者地址筛选。"></x-field>
|
|
763
763
|
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按时间范围筛选。"></x-field>
|
|
764
764
|
</x-field-group>
|
|
765
765
|
|
|
766
766
|
**返回**
|
|
767
767
|
|
|
768
|
-
<x-field data-name="ResponseListTokenFactories" data-type="object" data-desc="
|
|
768
|
+
<x-field data-name="ResponseListTokenFactories" data-type="object" data-desc="包含分页信息和通证工厂列表的对象。">
|
|
769
769
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
770
770
|
<x-field data-name="page" data-type="PageInfo" data-desc="分页信息。"></x-field>
|
|
771
|
-
<x-field data-name="tokenFactories" data-type="IndexedTokenFactoryState[]" data-desc="
|
|
771
|
+
<x-field data-name="tokenFactories" data-type="IndexedTokenFactoryState[]" data-desc="通证工厂状态对象的数组。"></x-field>
|
|
772
772
|
</x-field>
|
|
773
773
|
|
|
774
774
|
## 变更方法
|
|
@@ -777,23 +777,23 @@ OCAP 客户端通过 GraphQL 与区块链进行交互。方法分为两大类:
|
|
|
777
777
|
|
|
778
778
|
### `sendTx`
|
|
779
779
|
|
|
780
|
-
将预先签名的交易广播到网络。这是所有写入操作的基础方法。关于创建和签署交易,请参阅[高级 API](./api-reference-transaction-helpers.md) 和[交易生命周期](./core-concepts-transaction-lifecycle.md)指南。
|
|
780
|
+
将预先签名的交易广播到网络。这是所有写入操作的基础方法。关于创建和签署交易,请参阅 [高级 API](./api-reference-transaction-helpers.md) 和 [交易生命周期](./core-concepts-transaction-lifecycle.md) 指南。
|
|
781
781
|
|
|
782
782
|
**参数**
|
|
783
783
|
|
|
784
784
|
<x-field-group>
|
|
785
|
-
<x-field data-name="tx" data-type="string" data-required="true" data-desc="
|
|
785
|
+
<x-field data-name="tx" data-type="string" data-required="true" data-desc="已编码的交易字符串。"></x-field>
|
|
786
786
|
<x-field data-name="wallet" data-type="object" data-required="true" data-desc="用于签名的钱包对象。"></x-field>
|
|
787
787
|
<x-field data-name="token" data-type="string" data-required="false" data-desc="身份验证令牌(如果需要)。"></x-field>
|
|
788
|
-
<x-field data-name="commit" data-type="boolean" data-required="false" data-default="true" data-desc="如果为 true
|
|
788
|
+
<x-field data-name="commit" data-type="boolean" data-required="false" data-default="true" data-desc="如果为 true,则等待交易提交到区块中。"></x-field>
|
|
789
789
|
<x-field data-name="extra" data-type="string" data-required="false" data-desc="要包含的额外数据。"></x-field>
|
|
790
790
|
</x-field-group>
|
|
791
791
|
|
|
792
792
|
**返回**
|
|
793
793
|
|
|
794
|
-
<x-field data-name="ResponseSendTx" data-type="object" data-desc="
|
|
794
|
+
<x-field data-name="ResponseSendTx" data-type="object" data-desc="包含响应码和交易哈希的对象。">
|
|
795
795
|
<x-field data-name="code" data-type="string" data-desc="响应的状态码。"></x-field>
|
|
796
|
-
<x-field data-name="hash" data-type="string" data-desc="
|
|
796
|
+
<x-field data-name="hash" data-type="string" data-desc="已提交交易的哈希。"></x-field>
|
|
797
797
|
</x-field>
|
|
798
798
|
|
|
799
799
|
**示例**
|
|
@@ -807,8 +807,8 @@ const wallet = { ... }; // 签署该交易的钱包
|
|
|
807
807
|
|
|
808
808
|
try {
|
|
809
809
|
const { hash } = await client.sendTx({ tx: signedTx, wallet });
|
|
810
|
-
console.log('
|
|
810
|
+
console.log('Transaction sent successfully! Hash:', hash);
|
|
811
811
|
} catch (error) {
|
|
812
|
-
console.error('
|
|
812
|
+
console.error('Failed to send transaction:', error);
|
|
813
813
|
}
|
|
814
814
|
```
|