@ocap/client 1.25.5 → 1.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +15 -15
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# 查詢與變動方法
|
|
2
2
|
|
|
3
|
-
OCAP
|
|
3
|
+
OCAP 客戶端透過 GraphQL 與區塊鏈互動。方法分為兩大類:
|
|
4
4
|
|
|
5
|
-
* **查詢 (Queries)
|
|
6
|
-
* **變動 (Mutations)
|
|
5
|
+
* **查詢 (Queries)**:這些是唯讀操作,用於從區塊鏈擷取資料,例如檢索帳戶狀態、列出交易或取得一般鏈資訊。它們不會改變鏈的狀態。
|
|
6
|
+
* **變動 (Mutations)**:這些是會修改區塊鏈狀態的寫入操作。傳送交易是變動的主要範例。
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
本節提供客戶端所有可用的查詢與變動方法的完整參考。
|
|
9
9
|
|
|
10
10
|
## 查詢方法
|
|
11
11
|
|
|
@@ -13,7 +13,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
13
13
|
|
|
14
14
|
### `getAccountState`
|
|
15
15
|
|
|
16
|
-
檢索特定帳戶的目前狀態,包括其餘額、nonce
|
|
16
|
+
檢索特定帳戶的目前狀態,包括其餘額、nonce 及其他詳細資訊。
|
|
17
17
|
|
|
18
18
|
**參數**
|
|
19
19
|
|
|
@@ -26,7 +26,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
26
26
|
|
|
27
27
|
**傳回值**
|
|
28
28
|
|
|
29
|
-
<x-field data-name="ResponseGetAccountState" data-type="object" data-desc="
|
|
29
|
+
<x-field data-name="ResponseGetAccountState" data-type="object" data-desc="一個包含回應碼和帳戶狀態的物件。">
|
|
30
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>
|
|
@@ -45,7 +45,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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 Client 透過 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>
|
|
@@ -81,14 +81,14 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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
|
|
|
@@ -98,31 +98,31 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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
103
|
<x-field data-name="state" data-type="TokenState" data-desc="代幣的詳細狀態。"></x-field>
|
|
104
104
|
</x-field>
|
|
105
105
|
|
|
106
106
|
### `getEvidenceState`
|
|
107
107
|
|
|
108
|
-
|
|
108
|
+
根據其雜湊值檢索證據記錄。
|
|
109
109
|
|
|
110
110
|
**參數**
|
|
111
111
|
|
|
112
112
|
<x-field-group>
|
|
113
|
-
<x-field data-name="hash" data-type="string" data-required="true" data-desc="
|
|
113
|
+
<x-field data-name="hash" data-type="string" data-required="true" data-desc="要檢索的證據的雜湊值。"></x-field>
|
|
114
114
|
</x-field-group>
|
|
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>
|
|
122
122
|
|
|
123
123
|
### `getForgeState`
|
|
124
124
|
|
|
125
|
-
擷取 OCAP
|
|
125
|
+
擷取 OCAP 區塊鏈的整體設定與狀態。
|
|
126
126
|
|
|
127
127
|
**參數**
|
|
128
128
|
|
|
@@ -133,7 +133,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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>
|
|
@@ -150,41 +150,41 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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
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
|
|
|
164
164
|
<x-field-group>
|
|
165
|
-
<x-field data-name="hash" data-type="string" data-required="true" data-desc="
|
|
165
|
+
<x-field data-name="hash" data-type="string" data-required="true" data-desc="要檢索的交易的雜湊值。"></x-field>
|
|
166
166
|
</x-field-group>
|
|
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
|
|
|
181
181
|
<x-field-group>
|
|
182
|
-
<x-field data-name="height" data-type="string" data-required="true" data-desc="
|
|
182
|
+
<x-field data-name="height" data-type="string" data-required="true" data-desc="要檢索的區塊的高度。"></x-field>
|
|
183
183
|
</x-field-group>
|
|
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>
|
|
@@ -197,16 +197,16 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
197
197
|
|
|
198
198
|
<x-field-group>
|
|
199
199
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
200
|
-
<x-field data-name="heightFilter" data-type="RangeFilterInput" data-required="false" data-desc="
|
|
201
|
-
<x-field data-name="emptyExcluded" data-type="boolean" data-required="false" data-desc="若為 true
|
|
200
|
+
<x-field data-name="heightFilter" data-type="RangeFilterInput" data-required="false" data-desc="按高度範圍篩選區塊。"></x-field>
|
|
201
|
+
<x-field data-name="emptyExcluded" data-type="boolean" data-required="false" data-desc="若為 true,則排除不含交易的區塊。"></x-field>
|
|
202
202
|
</x-field-group>
|
|
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,7 +221,7 @@ OCAP Client 透過 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
227
|
<x-field data-name="unconfirmedTxs" data-type="UnconfirmedTxs" data-desc="未確認交易的詳細資訊。"></x-field>
|
|
@@ -229,7 +229,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
229
229
|
|
|
230
230
|
### `getChainInfo`
|
|
231
231
|
|
|
232
|
-
|
|
232
|
+
檢索關於區塊鏈的一般資訊。
|
|
233
233
|
|
|
234
234
|
**參數**
|
|
235
235
|
|
|
@@ -237,7 +237,7 @@ OCAP Client 透過 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,14 +254,14 @@ OCAP Client 透過 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>
|
|
261
261
|
|
|
262
262
|
### `getNetInfo`
|
|
263
263
|
|
|
264
|
-
|
|
264
|
+
檢索網路資訊,包括已連線的對等節點。
|
|
265
265
|
|
|
266
266
|
**參數**
|
|
267
267
|
|
|
@@ -269,14 +269,14 @@ OCAP Client 透過 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 Client 透過 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 Client 透過 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 Client 透過 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,10 +332,10 @@ OCAP Client 透過 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`
|
|
@@ -346,17 +346,17 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
346
346
|
|
|
347
347
|
<x-field-group>
|
|
348
348
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
349
|
-
<x-field data-name="ownerAddress" data-type="string" data-required="false" data-desc="
|
|
350
|
-
<x-field data-name="factoryAddress" data-type="string" data-required="false" data-desc="
|
|
351
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
349
|
+
<x-field data-name="ownerAddress" data-type="string" data-required="false" data-desc="按擁有者地址篩選資產。"></x-field>
|
|
350
|
+
<x-field data-name="factoryAddress" data-type="string" data-required="false" data-desc="按工廠地址篩選資產。"></x-field>
|
|
351
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按時間範圍篩選資產。"></x-field>
|
|
352
352
|
</x-field-group>
|
|
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`
|
|
@@ -367,90 +367,90 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
367
367
|
|
|
368
368
|
<x-field-group>
|
|
369
369
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
370
|
-
<x-field data-name="proposer" data-type="string" data-required="false" data-desc="
|
|
371
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
372
|
-
<x-field data-name="heightFilter" data-type="RangeFilterInput" data-required="false" data-desc="
|
|
373
|
-
<x-field data-name="numTxsFilter" data-type="RangeFilterInput" data-required="false" data-desc="
|
|
374
|
-
<x-field data-name="numInvalidTxsFilter" data-type="RangeFilterInput" data-required="false" data-desc="
|
|
370
|
+
<x-field data-name="proposer" data-type="string" data-required="false" data-desc="按提案者地址篩選區塊。"></x-field>
|
|
371
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按時間範圍篩選區塊。"></x-field>
|
|
372
|
+
<x-field data-name="heightFilter" data-type="RangeFilterInput" data-required="false" data-desc="按高度範圍篩選區塊。"></x-field>
|
|
373
|
+
<x-field data-name="numTxsFilter" data-type="RangeFilterInput" data-required="false" data-desc="按交易數量篩選區塊。"></x-field>
|
|
374
|
+
<x-field data-name="numInvalidTxsFilter" data-type="RangeFilterInput" data-required="false" data-desc="按無效交易數量篩選區塊。"></x-field>
|
|
375
375
|
</x-field-group>
|
|
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
393
|
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="代幣的地址。若未提供,則預設為原生代幣。"></x-field>
|
|
394
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
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
|
|
|
411
411
|
<x-field-group>
|
|
412
412
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
413
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
414
|
-
<x-field data-name="addressFilter" data-type="AddressFilterInput" data-required="false" data-desc="
|
|
415
|
-
<x-field data-name="typeFilter" data-type="TypeFilterInput" data-required="false" data-desc="
|
|
416
|
-
<x-field data-name="validityFilter" data-type="ValidityFilterInput" data-required="false" data-desc="
|
|
417
|
-
<x-field data-name="factoryFilter" data-type="FactoryFilterInput" data-required="false" data-desc="
|
|
418
|
-
<x-field data-name="tokenFilter" data-type="TokenFilterInput" data-required="false" data-desc="
|
|
419
|
-
<x-field data-name="assetFilter" data-type="AssetFilterInput" data-required="false" data-desc="
|
|
420
|
-
<x-field data-name="accountFilter" data-type="AccountFilterInput" data-required="false" data-desc="
|
|
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="
|
|
423
|
-
<x-field data-name="stakeFilter" data-type="StakeFilterInput" data-required="false" data-desc="
|
|
424
|
-
<x-field data-name="delegationFilter" data-type="DelegationFilterInput" data-required="false" data-desc="
|
|
425
|
-
<x-field data-name="tokenFactoryFilter" data-type="TokenFactoryFilterInput" data-required="false" data-desc="
|
|
413
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按時間範圍篩選交易。"></x-field>
|
|
414
|
+
<x-field data-name="addressFilter" data-type="AddressFilterInput" data-required="false" data-desc="按傳送者或接收者地址篩選交易。"></x-field>
|
|
415
|
+
<x-field data-name="typeFilter" data-type="TypeFilterInput" data-required="false" data-desc="按交易類型篩選。"></x-field>
|
|
416
|
+
<x-field data-name="validityFilter" data-type="ValidityFilterInput" data-required="false" data-desc="按交易有效性篩選。"></x-field>
|
|
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="按代幣地址篩選。"></x-field>
|
|
419
|
+
<x-field data-name="assetFilter" data-type="AssetFilterInput" data-required="false" data-desc="按資產地址篩選。"></x-field>
|
|
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="按交易雜湊值篩選。"></x-field>
|
|
422
|
+
<x-field data-name="rollupFilter" data-type="RollupFilterInput" data-required="false" data-desc="按 rollup 地址篩選。"></x-field>
|
|
423
|
+
<x-field data-name="stakeFilter" data-type="StakeFilterInput" data-required="false" data-desc="按質押地址篩選。"></x-field>
|
|
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="按代幣工廠地址篩選。"></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`
|
|
@@ -461,17 +461,17 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
461
461
|
|
|
462
462
|
<x-field-group>
|
|
463
463
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
464
|
-
<x-field data-name="ownerAddress" data-type="string" data-required="false" data-desc="
|
|
464
|
+
<x-field data-name="ownerAddress" data-type="string" data-required="false" data-desc="按擁有者地址篩選工廠。"></x-field>
|
|
465
465
|
<x-field data-name="addressList" data-type="string[]" data-required="false" data-desc="要查詢的工廠地址列表。"></x-field>
|
|
466
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
466
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按時間範圍篩選工廠。"></x-field>
|
|
467
467
|
</x-field-group>
|
|
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`
|
|
@@ -487,9 +487,9 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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`
|
|
@@ -506,7 +506,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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>
|
|
@@ -519,17 +519,17 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
519
519
|
|
|
520
520
|
<x-field-group>
|
|
521
521
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
522
|
-
<x-field data-name="addressFilter" data-type="AddressFilterInput" data-required="false" data-desc="
|
|
523
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
524
|
-
<x-field data-name="assetFilter" data-type="AssetFilterInput" data-required="false" data-desc="
|
|
522
|
+
<x-field data-name="addressFilter" data-type="AddressFilterInput" data-required="false" data-desc="按傳送者或接收者地址篩選質押。"></x-field>
|
|
523
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按時間範圍篩選質押。"></x-field>
|
|
524
|
+
<x-field data-name="assetFilter" data-type="AssetFilterInput" data-required="false" data-desc="按資產地址篩選質押。"></x-field>
|
|
525
525
|
</x-field-group>
|
|
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`
|
|
@@ -546,7 +546,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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
551
|
<x-field data-name="state" data-type="RollupState" data-desc="rollup 的詳細狀態。"></x-field>
|
|
552
552
|
</x-field>
|
|
@@ -559,17 +559,17 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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="rollup 狀態物件的陣列。"></x-field>
|
|
572
|
+
<x-field data-name="rollups" data-type="IndexedRollupState[]" data-desc="一個 rollup 狀態物件的陣列。"></x-field>
|
|
573
573
|
</x-field>
|
|
574
574
|
|
|
575
575
|
### `getRollupBlock`
|
|
@@ -586,7 +586,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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
591
|
<x-field data-name="block" data-type="RollupBlock" data-desc="rollup 區塊的詳細資訊。"></x-field>
|
|
592
592
|
</x-field>
|
|
@@ -600,19 +600,19 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
600
600
|
<x-field-group>
|
|
601
601
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
602
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="
|
|
604
|
-
<x-field data-name="proposer" data-type="string" data-required="false" data-desc="
|
|
605
|
-
<x-field data-name="validatorFilter" data-type="ValidatorFilterInput" data-required="false" data-desc="
|
|
606
|
-
<x-field data-name="txFilter" data-type="TxFilterInput" data-required="false" data-desc="
|
|
607
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
603
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="false" data-desc="按代幣地址篩選。"></x-field>
|
|
604
|
+
<x-field data-name="proposer" data-type="string" data-required="false" data-desc="按提案者地址篩選。"></x-field>
|
|
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="按交易雜湊值篩選。"></x-field>
|
|
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="rollup 區塊物件的陣列。"></x-field>
|
|
615
|
+
<x-field data-name="blocks" data-type="IndexedRollupBlock[]" data-desc="一個 rollup 區塊物件的陣列。"></x-field>
|
|
616
616
|
</x-field>
|
|
617
617
|
|
|
618
618
|
### `listRollupValidators`
|
|
@@ -628,10 +628,10 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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="rollup 驗證者物件的陣列。"></x-field>
|
|
634
|
+
<x-field data-name="validators" data-type="IndexedRollupValidator[]" data-desc="一個 rollup 驗證者物件的陣列。"></x-field>
|
|
635
635
|
</x-field>
|
|
636
636
|
|
|
637
637
|
### `listDelegations`
|
|
@@ -642,22 +642,22 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
642
642
|
|
|
643
643
|
<x-field-group>
|
|
644
644
|
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="分頁設定。"></x-field>
|
|
645
|
-
<x-field data-name="from" data-type="string" data-required="false" data-desc="
|
|
646
|
-
<x-field data-name="to" data-type="string" data-required="false" data-desc="
|
|
647
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="
|
|
645
|
+
<x-field data-name="from" data-type="string" data-required="false" data-desc="按委託人地址篩選。"></x-field>
|
|
646
|
+
<x-field data-name="to" data-type="string" data-required="false" data-desc="按受託人地址篩選。"></x-field>
|
|
647
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="按時間範圍篩選。"></x-field>
|
|
648
648
|
</x-field-group>
|
|
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
|
|
|
@@ -668,10 +668,10 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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`
|
|
@@ -687,7 +687,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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>
|
|
@@ -703,20 +703,20 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
703
703
|
<x-field data-name="accountAddress" data-type="string" data-required="true" data-desc="要追蹤的帳戶地址。"></x-field>
|
|
704
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`
|
|
718
718
|
|
|
719
|
-
|
|
719
|
+
評估指定帳戶的風險狀況。
|
|
720
720
|
|
|
721
721
|
**參數**
|
|
722
722
|
|
|
@@ -727,14 +727,14 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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
|
|
|
@@ -744,7 +744,7 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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
749
|
<x-field data-name="data" data-type="TokenDistribution" data-desc="代幣分佈統計數據。"></x-field>
|
|
750
750
|
</x-field>
|
|
@@ -757,41 +757,41 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
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="
|
|
762
|
-
<x-field data-name="owner" data-type="string" data-required="false" data-desc="
|
|
763
|
-
<x-field data-name="timeFilter" data-type="TimeFilterInput" 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
|
+
<x-field data-name="owner" data-type="string" data-required="false" data-desc="按擁有者地址篩選。"></x-field>
|
|
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
|
## 變動方法
|
|
775
775
|
|
|
776
|
-
|
|
776
|
+
變動用於傳送會修改區塊鏈狀態的交易。
|
|
777
777
|
|
|
778
778
|
### `sendTx`
|
|
779
779
|
|
|
780
|
-
|
|
780
|
+
將預先簽署的交易廣播到網路。這是所有寫入操作的基礎方法。關於建立和簽署交易,請參閱 [高階 API](./api-reference-transaction-helpers.md) 和 [交易生命週期](./core-concepts-transaction-lifecycle.md) 指南。
|
|
781
781
|
|
|
782
782
|
**參數**
|
|
783
783
|
|
|
784
784
|
<x-field-group>
|
|
785
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
|
-
<x-field data-name="token" data-type="string" data-required="false" data-desc="
|
|
788
|
-
<x-field data-name="commit" data-type="boolean" data-required="false" data-default="true" data-desc="若為 true
|
|
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,則等待交易被提交到區塊中。"></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
796
|
<x-field data-name="hash" data-type="string" data-desc="已提交交易的雜湊值。"></x-field>
|
|
797
797
|
</x-field>
|
|
@@ -800,15 +800,15 @@ OCAP Client 透過 GraphQL 與區塊鏈互動。方法主要分為兩種類型
|
|
|
800
800
|
|
|
801
801
|
```javascript icon=logos:javascript
|
|
802
802
|
// 此範例假設 `signedTx` 是一個經過適當編碼和簽署的交易字串。
|
|
803
|
-
//
|
|
803
|
+
// 關於如何建立它,請參閱其他指南。
|
|
804
804
|
|
|
805
805
|
const signedTx = '...';
|
|
806
|
-
const wallet = { ... }; //
|
|
806
|
+
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
|
```
|