@ocap/client 1.25.4 → 1.25.5
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/dist/report.html +1 -1
- package/docs/api-reference-client-methods.ja.md +229 -0
- package/docs/api-reference-client-methods.zh-TW.md +229 -0
- package/docs/api-reference-client-methods.zh.md +27 -27
- package/docs/api-reference-data-types.ja.md +482 -0
- package/docs/api-reference-data-types.zh-TW.md +482 -0
- package/docs/api-reference-data-types.zh.md +14 -14
- package/docs/api-reference-low-level-api.ja.md +228 -0
- package/docs/api-reference-low-level-api.zh-TW.md +228 -0
- package/docs/api-reference-low-level-api.zh.md +39 -39
- package/docs/api-reference-query-mutation-methods.ja.md +814 -0
- package/docs/api-reference-query-mutation-methods.zh-TW.md +814 -0
- package/docs/api-reference-query-mutation-methods.zh.md +158 -158
- package/docs/api-reference-transaction-helpers.ja.md +649 -0
- package/docs/api-reference-transaction-helpers.zh-TW.md +649 -0
- package/docs/api-reference-transaction-helpers.zh.md +112 -112
- package/docs/api-reference.ja.md +23 -0
- package/docs/api-reference.zh-TW.md +23 -0
- package/docs/api-reference.zh.md +6 -6
- package/docs/core-concepts-client-architecture.ja.md +102 -0
- package/docs/core-concepts-client-architecture.zh-TW.md +102 -0
- package/docs/core-concepts-client-architecture.zh.md +21 -21
- package/docs/core-concepts-event-subscriptions.ja.md +123 -0
- package/docs/core-concepts-event-subscriptions.zh-TW.md +123 -0
- package/docs/core-concepts-event-subscriptions.zh.md +22 -22
- package/docs/core-concepts-gas-payment.ja.md +111 -0
- package/docs/core-concepts-gas-payment.zh-TW.md +111 -0
- package/docs/core-concepts-gas-payment.zh.md +30 -30
- package/docs/core-concepts-transaction-lifecycle.ja.md +183 -0
- package/docs/core-concepts-transaction-lifecycle.zh-TW.md +183 -0
- package/docs/core-concepts-transaction-lifecycle.zh.md +51 -51
- package/docs/core-concepts.ja.md +22 -0
- package/docs/core-concepts.zh-TW.md +22 -0
- package/docs/core-concepts.zh.md +6 -6
- package/docs/getting-started-basic-usage.ja.md +87 -0
- package/docs/getting-started-basic-usage.zh-TW.md +87 -0
- package/docs/getting-started-basic-usage.zh.md +17 -17
- package/docs/getting-started-installation.ja.md +60 -0
- package/docs/getting-started-installation.zh-TW.md +60 -0
- package/docs/getting-started-installation.zh.md +14 -14
- package/docs/getting-started.ja.md +16 -0
- package/docs/getting-started.zh-TW.md +16 -0
- package/docs/getting-started.zh.md +6 -5
- package/docs/how-to-guides-delegate-permissions.ja.md +167 -0
- package/docs/how-to-guides-delegate-permissions.zh-TW.md +167 -0
- package/docs/how-to-guides-delegate-permissions.zh.md +27 -28
- package/docs/how-to-guides-manage-accounts.ja.md +73 -0
- package/docs/how-to-guides-manage-accounts.zh-TW.md +73 -0
- package/docs/how-to-guides-manage-accounts.zh.md +14 -14
- package/docs/how-to-guides-manage-assets.ja.md +255 -0
- package/docs/how-to-guides-manage-assets.zh-TW.md +255 -0
- package/docs/how-to-guides-manage-assets.zh.md +60 -60
- package/docs/how-to-guides-manage-tokens.ja.md +179 -0
- package/docs/how-to-guides-manage-tokens.zh-TW.md +179 -0
- package/docs/how-to-guides-manage-tokens.zh.md +52 -52
- package/docs/how-to-guides-stake-tokens-and-assets.ja.md +205 -0
- package/docs/how-to-guides-stake-tokens-and-assets.zh-TW.md +205 -0
- package/docs/how-to-guides-stake-tokens-and-assets.zh.md +44 -44
- package/docs/how-to-guides-transfer-tokens-and-nfts.ja.md +179 -0
- package/docs/how-to-guides-transfer-tokens-and-nfts.zh-TW.md +179 -0
- package/docs/how-to-guides-transfer-tokens-and-nfts.zh.md +47 -47
- package/docs/how-to-guides.ja.md +27 -0
- package/docs/how-to-guides.zh-TW.md +27 -0
- package/docs/how-to-guides.zh.md +11 -11
- package/docs/overview.ja.md +70 -0
- package/docs/overview.zh-TW.md +70 -0
- package/docs/overview.zh.md +8 -8
- package/package.json +14 -14
|
@@ -0,0 +1,814 @@
|
|
|
1
|
+
# クエリとミューテーションメソッド
|
|
2
|
+
|
|
3
|
+
OCAPクライアントはGraphQLを介してブロックチェーンと対話します。メソッドは主に2つのタイプに分類されます:
|
|
4
|
+
|
|
5
|
+
* **クエリ**:これらはブロックチェーンからデータを取得するために使用される読み取り専用の操作です。例えば、アカウントの状態の取得、トランザクションのリスト表示、または一般的なチェーン情報の取得などがあります。これらはチェーンの状態を変更しません。
|
|
6
|
+
* **ミューテーション**:これらはブロックチェーンの状態を変更する書き込み操作です。トランザクションの送信がミューテーションの主要な例です。
|
|
7
|
+
|
|
8
|
+
このセクションでは、クライアントが提供するすべての利用可能なクエリおよびミューテーションメソッドの完全なリファレンスを提供します。
|
|
9
|
+
|
|
10
|
+
## クエリメソッド
|
|
11
|
+
|
|
12
|
+
クエリはブロックチェーンからデータを取得するために使用されます。以下は、利用可能なすべてのクエリメソッドの完全なリストです。
|
|
13
|
+
|
|
14
|
+
### `getAccountState`
|
|
15
|
+
|
|
16
|
+
特定のアカウントの現在の状態(残高、ナンス、その他の詳細を含む)を取得します。
|
|
17
|
+
|
|
18
|
+
**パラメータ**
|
|
19
|
+
|
|
20
|
+
<x-field-group>
|
|
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="特定のブロック高での状態をクエリします。"></x-field>
|
|
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の場合、アカウントの移行履歴をトレースします。"></x-field>
|
|
25
|
+
</x-field-group>
|
|
26
|
+
|
|
27
|
+
**戻り値**
|
|
28
|
+
|
|
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
|
+
<x-field data-name="state" data-type="AccountState" data-desc="アカウントの詳細な状態。"></x-field>
|
|
32
|
+
</x-field>
|
|
33
|
+
|
|
34
|
+
### `getAssetState`
|
|
35
|
+
|
|
36
|
+
特定の資産(NFT)の現在の状態を取得します。
|
|
37
|
+
|
|
38
|
+
**パラメータ**
|
|
39
|
+
|
|
40
|
+
<x-field-group>
|
|
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="特定のブロック高での状態をクエリします。"></x-field>
|
|
43
|
+
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="取得する特定のフィールド。"></x-field>
|
|
44
|
+
</x-field-group>
|
|
45
|
+
|
|
46
|
+
**戻り値**
|
|
47
|
+
|
|
48
|
+
<x-field data-name="ResponseGetAssetState" data-type="object" data-desc="レスポンスコードと資産の状態を含むオブジェクト。">
|
|
49
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
50
|
+
<x-field data-name="state" data-type="AssetState" data-desc="資産の詳細な状態。"></x-field>
|
|
51
|
+
</x-field>
|
|
52
|
+
|
|
53
|
+
### `getFactoryState`
|
|
54
|
+
|
|
55
|
+
特定の資産ファクトリの状態を取得します。
|
|
56
|
+
|
|
57
|
+
**パラメータ**
|
|
58
|
+
|
|
59
|
+
<x-field-group>
|
|
60
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="クエリ対象のファクトリのアドレス。"></x-field>
|
|
61
|
+
</x-field-group>
|
|
62
|
+
|
|
63
|
+
**戻り値**
|
|
64
|
+
|
|
65
|
+
<x-field data-name="ResponseGetFactoryState" data-type="object" data-desc="レスポンスコードとファクトリの状態を含むオブジェクト。">
|
|
66
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
67
|
+
<x-field data-name="state" data-type="AssetFactoryState" data-desc="資産ファクトリの詳細な状態。"></x-field>
|
|
68
|
+
</x-field>
|
|
69
|
+
|
|
70
|
+
### `getDelegateState`
|
|
71
|
+
|
|
72
|
+
委任関係の状態を取得します。
|
|
73
|
+
|
|
74
|
+
**パラメータ**
|
|
75
|
+
|
|
76
|
+
<x-field-group>
|
|
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="特定のブロック高での状態をクエリします。"></x-field>
|
|
79
|
+
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="取得する特定のフィールド。"></x-field>
|
|
80
|
+
</x-field-group>
|
|
81
|
+
|
|
82
|
+
**戻り値**
|
|
83
|
+
|
|
84
|
+
<x-field data-name="ResponseGetDelegateState" data-type="object" data-desc="レスポンスコードと委任の状態を含むオブジェクト。">
|
|
85
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
86
|
+
<x-field data-name="state" data-type="DelegateState" data-desc="委任の詳細な状態。"></x-field>
|
|
87
|
+
</x-field>
|
|
88
|
+
|
|
89
|
+
### `getTokenState`
|
|
90
|
+
|
|
91
|
+
特定の代替可能トークンの状態を取得します。
|
|
92
|
+
|
|
93
|
+
**パラメータ**
|
|
94
|
+
|
|
95
|
+
<x-field-group>
|
|
96
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="クエリ対象のトークンのアドレス。"></x-field>
|
|
97
|
+
</x-field-group>
|
|
98
|
+
|
|
99
|
+
**戻り値**
|
|
100
|
+
|
|
101
|
+
<x-field data-name="ResponseGetTokenState" data-type="object" data-desc="レスポンスコードとトークンの状態を含むオブジェクト。">
|
|
102
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
103
|
+
<x-field data-name="state" data-type="TokenState" data-desc="トークンの詳細な状態。"></x-field>
|
|
104
|
+
</x-field>
|
|
105
|
+
|
|
106
|
+
### `getEvidenceState`
|
|
107
|
+
|
|
108
|
+
ハッシュによって証拠レコードを取得します。
|
|
109
|
+
|
|
110
|
+
**パラメータ**
|
|
111
|
+
|
|
112
|
+
<x-field-group>
|
|
113
|
+
<x-field data-name="hash" data-type="string" data-required="true" data-desc="取得する証拠のハッシュ。"></x-field>
|
|
114
|
+
</x-field-group>
|
|
115
|
+
|
|
116
|
+
**戻り値**
|
|
117
|
+
|
|
118
|
+
<x-field data-name="ResponseGetEvidenceState" data-type="object" data-desc="レスポンスコードと証拠の状態を含むオブジェクト。">
|
|
119
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
120
|
+
<x-field data-name="state" data-type="EvidenceState" data-desc="証拠の詳細な状態。"></x-field>
|
|
121
|
+
</x-field>
|
|
122
|
+
|
|
123
|
+
### `getForgeState`
|
|
124
|
+
|
|
125
|
+
OCAPブロックチェーンの全体的な設定と状態を取得します。
|
|
126
|
+
|
|
127
|
+
**パラメータ**
|
|
128
|
+
|
|
129
|
+
<x-field-group>
|
|
130
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="特定のブロック高での状態をクエリします。"></x-field>
|
|
131
|
+
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="取得する特定のフィールド。"></x-field>
|
|
132
|
+
</x-field-group>
|
|
133
|
+
|
|
134
|
+
**戻り値**
|
|
135
|
+
|
|
136
|
+
<x-field data-name="ResponseGetForgeState" data-type="object" data-desc="レスポンスコードとチェーンの状態を含むオブジェクト。">
|
|
137
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
138
|
+
<x-field data-name="state" data-type="ForgeState" data-desc="OCAPチェーンの詳細な状態。"></x-field>
|
|
139
|
+
</x-field>
|
|
140
|
+
|
|
141
|
+
### `getTokenFactoryState`
|
|
142
|
+
|
|
143
|
+
特定のトークンファクトリの状態を取得します。
|
|
144
|
+
|
|
145
|
+
**パラメータ**
|
|
146
|
+
|
|
147
|
+
<x-field-group>
|
|
148
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="クエリ対象のトークンファクトリのアドレス。"></x-field>
|
|
149
|
+
</x-field-group>
|
|
150
|
+
|
|
151
|
+
**戻り値**
|
|
152
|
+
|
|
153
|
+
<x-field data-name="ResponseGetTokenFactoryState" data-type="object" data-desc="レスポンスコードとトークンファクトリの状態を含むオブジェクト。">
|
|
154
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
155
|
+
<x-field data-name="state" data-type="TokenFactoryState" data-desc="トークンファクトリの詳細な状態。"></x-field>
|
|
156
|
+
</x-field>
|
|
157
|
+
|
|
158
|
+
### `getTx`
|
|
159
|
+
|
|
160
|
+
ハッシュによって単一のトランザクションを取得します。
|
|
161
|
+
|
|
162
|
+
**パラメータ**
|
|
163
|
+
|
|
164
|
+
<x-field-group>
|
|
165
|
+
<x-field data-name="hash" data-type="string" data-required="true" data-desc="取得するトランザクションのハッシュ。"></x-field>
|
|
166
|
+
</x-field-group>
|
|
167
|
+
|
|
168
|
+
**戻り値**
|
|
169
|
+
|
|
170
|
+
<x-field data-name="ResponseGetTx" data-type="object" data-desc="レスポンスコードとトランザクションの詳細を含むオブジェクト。">
|
|
171
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
172
|
+
<x-field data-name="info" data-type="TransactionInfo" data-desc="トランザクションの詳細情報。"></x-field>
|
|
173
|
+
</x-field>
|
|
174
|
+
|
|
175
|
+
### `getBlock`
|
|
176
|
+
|
|
177
|
+
ブロック高によって単一のブロックを取得します。
|
|
178
|
+
|
|
179
|
+
**パラメータ**
|
|
180
|
+
|
|
181
|
+
<x-field-group>
|
|
182
|
+
<x-field data-name="height" data-type="string" data-required="true" data-desc="取得するブロックの高さ。"></x-field>
|
|
183
|
+
</x-field-group>
|
|
184
|
+
|
|
185
|
+
**戻り値**
|
|
186
|
+
|
|
187
|
+
<x-field data-name="ResponseGetBlock" data-type="object" data-desc="レスポンスコードとブロックの詳細を含むオブジェクト。">
|
|
188
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
189
|
+
<x-field data-name="block" data-type="BlockInfo" data-desc="ブロックの詳細情報。"></x-field>
|
|
190
|
+
</x-field>
|
|
191
|
+
|
|
192
|
+
### `getBlocks`
|
|
193
|
+
|
|
194
|
+
オプションのフィルターを使用してブロックのリストを取得します。
|
|
195
|
+
|
|
196
|
+
**パラメータ**
|
|
197
|
+
|
|
198
|
+
<x-field-group>
|
|
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="ブロックを高さの範囲でフィルタリングします。"></x-field>
|
|
201
|
+
<x-field data-name="emptyExcluded" data-type="boolean" data-required="false" data-desc="trueの場合、トランザクションのないブロックは除外されます。"></x-field>
|
|
202
|
+
</x-field-group>
|
|
203
|
+
|
|
204
|
+
**戻り値**
|
|
205
|
+
|
|
206
|
+
<x-field data-name="ResponseGetBlocks" data-type="object" data-desc="ページネーション情報とブロックのリストを含むオブジェクト。">
|
|
207
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
208
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
209
|
+
<x-field data-name="blocks" data-type="BlockInfoSimple[]" data-desc="簡略化されたブロックオブジェクトの配列。"></x-field>
|
|
210
|
+
</x-field>
|
|
211
|
+
|
|
212
|
+
### `getUnconfirmedTxs`
|
|
213
|
+
|
|
214
|
+
mempool内にあり、まだ確認されていないトランザクションを取得します。
|
|
215
|
+
|
|
216
|
+
**パラメータ**
|
|
217
|
+
|
|
218
|
+
<x-field-group>
|
|
219
|
+
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="ページネーション設定。"></x-field>
|
|
220
|
+
</x-field-group>
|
|
221
|
+
|
|
222
|
+
**戻り値**
|
|
223
|
+
|
|
224
|
+
<x-field data-name="ResponseGetUnconfirmedTxs" data-type="object" data-desc="ページネーション情報と未確認トランザクションのリストを含むオブジェクト。">
|
|
225
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
226
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
227
|
+
<x-field data-name="unconfirmedTxs" data-type="UnconfirmedTxs" data-desc="未確認トランザクションの詳細。"></x-field>
|
|
228
|
+
</x-field>
|
|
229
|
+
|
|
230
|
+
### `getChainInfo`
|
|
231
|
+
|
|
232
|
+
ブロックチェーンに関する一般情報を取得します。
|
|
233
|
+
|
|
234
|
+
**パラメータ**
|
|
235
|
+
|
|
236
|
+
このメソッドはパラメータを取りません。
|
|
237
|
+
|
|
238
|
+
**戻り値**
|
|
239
|
+
|
|
240
|
+
<x-field data-name="ResponseGetChainInfo" data-type="object" data-desc="レスポンスコードとチェーン情報を含むオブジェクト。">
|
|
241
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
242
|
+
<x-field data-name="info" data-type="ChainInfo" data-desc="チェーンの詳細情報。"></x-field>
|
|
243
|
+
</x-field>
|
|
244
|
+
|
|
245
|
+
### `getConfig`
|
|
246
|
+
|
|
247
|
+
ノードの設定を取得します。
|
|
248
|
+
|
|
249
|
+
**パラメータ**
|
|
250
|
+
|
|
251
|
+
<x-field-group>
|
|
252
|
+
<x-field data-name="parsed" data-type="boolean" data-required="false" data-desc="trueの場合、解析済みの設定を返します。"></x-field>
|
|
253
|
+
</x-field-group>
|
|
254
|
+
|
|
255
|
+
**戻り値**
|
|
256
|
+
|
|
257
|
+
<x-field data-name="ResponseGetConfig" data-type="object" data-desc="レスポンスコードと設定を含むオブジェクト。">
|
|
258
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
259
|
+
<x-field data-name="config" data-type="string" data-desc="ノードの設定(文字列)。"></x-field>
|
|
260
|
+
</x-field>
|
|
261
|
+
|
|
262
|
+
### `getNetInfo`
|
|
263
|
+
|
|
264
|
+
接続されているピアを含むネットワーク情報を取得します。
|
|
265
|
+
|
|
266
|
+
**パラメータ**
|
|
267
|
+
|
|
268
|
+
このメソッドはパラメータを取りません。
|
|
269
|
+
|
|
270
|
+
**戻り値**
|
|
271
|
+
|
|
272
|
+
<x-field data-name="ResponseGetNetInfo" data-type="object" data-desc="レスポンスコードとネットワーク情報を含むオブジェクト。">
|
|
273
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
274
|
+
<x-field data-name="netInfo" data-type="NetInfo" data-desc="詳細なネットワーク情報。"></x-field>
|
|
275
|
+
</x-field>
|
|
276
|
+
|
|
277
|
+
### `getNodeInfo`
|
|
278
|
+
|
|
279
|
+
クエリされている特定のノードに関する情報を取得します。
|
|
280
|
+
|
|
281
|
+
**パラメータ**
|
|
282
|
+
|
|
283
|
+
このメソッドはパラメータを取りません。
|
|
284
|
+
|
|
285
|
+
**戻り値**
|
|
286
|
+
|
|
287
|
+
<x-field data-name="ResponseGetNodeInfo" data-type="object" data-desc="レスポンスコードとノード情報を含むオブジェクト。">
|
|
288
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
289
|
+
<x-field data-name="info" data-type="NodeInfo" data-desc="ノードに関する詳細情報。"></x-field>
|
|
290
|
+
</x-field>
|
|
291
|
+
|
|
292
|
+
### `getValidatorsInfo`
|
|
293
|
+
|
|
294
|
+
現在のバリデーターセットに関する情報を取得します。
|
|
295
|
+
|
|
296
|
+
**パラメータ**
|
|
297
|
+
|
|
298
|
+
このメソッドはパラメータを取りません。
|
|
299
|
+
|
|
300
|
+
**戻り値**
|
|
301
|
+
|
|
302
|
+
<x-field data-name="ResponseGetValidatorsInfo" data-type="object" data-desc="レスポンスコードとバリデーター情報を含むオブジェクト。">
|
|
303
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
304
|
+
<x-field data-name="validatorsInfo" data-type="ValidatorsInfo" data-desc="バリデーターに関する詳細情報。"></x-field>
|
|
305
|
+
</x-field>
|
|
306
|
+
|
|
307
|
+
### `getForgeStats`
|
|
308
|
+
|
|
309
|
+
ブロックチェーンのアクティビティに関する様々な統計情報を取得します。
|
|
310
|
+
|
|
311
|
+
**パラメータ**
|
|
312
|
+
|
|
313
|
+
このメソッドはパラメータを取りません。
|
|
314
|
+
|
|
315
|
+
**戻り値**
|
|
316
|
+
|
|
317
|
+
<x-field data-name="ResponseGetForgeStats" data-type="object" data-desc="レスポンスコードとチェーンの統計情報を含むオブジェクト。">
|
|
318
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
319
|
+
<x-field data-name="forgeStats" data-type="ForgeStats" data-desc="OCAPチェーンに関する様々な統計情報。"></x-field>
|
|
320
|
+
</x-field>
|
|
321
|
+
|
|
322
|
+
### `listAssetTransactions`
|
|
323
|
+
|
|
324
|
+
特定の資産に関連するすべてのトランザクションを一覧表示します。
|
|
325
|
+
|
|
326
|
+
**パラメータ**
|
|
327
|
+
|
|
328
|
+
<x-field-group>
|
|
329
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="資産のアドレス。"></x-field>
|
|
330
|
+
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="ページネーション設定。"></x-field>
|
|
331
|
+
</x-field-group>
|
|
332
|
+
|
|
333
|
+
**戻り値**
|
|
334
|
+
|
|
335
|
+
<x-field data-name="ResponseListAssetTransactions" data-type="object" data-desc="ページネーション情報とトランザクションのリストを含むオブジェクト。">
|
|
336
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
337
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
338
|
+
<x-field data-name="transactions" data-type="IndexedTransaction[]" data-desc="トランザクションオブジェクトの配列。"></x-field>
|
|
339
|
+
</x-field>
|
|
340
|
+
|
|
341
|
+
### `listAssets`
|
|
342
|
+
|
|
343
|
+
所有者またはファクトリでフィルタリングして、すべての資産を一覧表示します。
|
|
344
|
+
|
|
345
|
+
**パラメータ**
|
|
346
|
+
|
|
347
|
+
<x-field-group>
|
|
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="所有者のアドレスで資産をフィルタリングします。"></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
|
+
</x-field-group>
|
|
353
|
+
|
|
354
|
+
**戻り値**
|
|
355
|
+
|
|
356
|
+
<x-field data-name="ResponseListAssets" data-type="object" data-desc="ページネーション情報と資産のリストを含むオブジェクト。">
|
|
357
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
358
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
359
|
+
<x-field data-name="assets" data-type="IndexedAssetState[]" data-desc="資産状態オブジェクトの配列。"></x-field>
|
|
360
|
+
</x-field>
|
|
361
|
+
|
|
362
|
+
### `listBlocks`
|
|
363
|
+
|
|
364
|
+
さまざまなフィルタリングオプションを使用してブロックを一覧表示します。
|
|
365
|
+
|
|
366
|
+
**パラメータ**
|
|
367
|
+
|
|
368
|
+
<x-field-group>
|
|
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="提案者のアドレスでブロックをフィルタリングします。"></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
|
+
</x-field-group>
|
|
376
|
+
|
|
377
|
+
**戻り値**
|
|
378
|
+
|
|
379
|
+
<x-field data-name="ResponseListBlocks" data-type="object" data-desc="ページネーション情報とブロックのリストを含むオブジェクト。">
|
|
380
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
381
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
382
|
+
<x-field data-name="blocks" data-type="IndexedBlock[]" data-desc="ブロックオブジェクトの配列。"></x-field>
|
|
383
|
+
</x-field>
|
|
384
|
+
|
|
385
|
+
### `listTopAccounts`
|
|
386
|
+
|
|
387
|
+
特定のトークンの残高が最も高いアカウントを一覧表示します。
|
|
388
|
+
|
|
389
|
+
**パラメータ**
|
|
390
|
+
|
|
391
|
+
<x-field-group>
|
|
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="トークンのアドレス。指定しない場合、ネイティブトークンがデフォルトになります。"></x-field>
|
|
394
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="アカウントを期間でフィルタリングします。"></x-field>
|
|
395
|
+
</x-field-group>
|
|
396
|
+
|
|
397
|
+
**戻り値**
|
|
398
|
+
|
|
399
|
+
<x-field data-name="ResponseListTopAccounts" data-type="object" data-desc="ページネーション情報と上位アカウントのリストを含むオブジェクト。">
|
|
400
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
401
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
402
|
+
<x-field data-name="accounts" data-type="IndexedAccountState[]" data-desc="アカウント状態オブジェクトの配列。"></x-field>
|
|
403
|
+
</x-field>
|
|
404
|
+
|
|
405
|
+
### `listTransactions`
|
|
406
|
+
|
|
407
|
+
幅広いフィルターを使用してトランザクションを一覧表示する強力なメソッドです。
|
|
408
|
+
|
|
409
|
+
**パラメータ**
|
|
410
|
+
|
|
411
|
+
<x-field-group>
|
|
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="トランザクションを期間でフィルタリングします。"></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="ロールアップアドレスでフィルタリングします。"></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
|
+
</x-field-group>
|
|
427
|
+
|
|
428
|
+
**戻り値**
|
|
429
|
+
|
|
430
|
+
<x-field data-name="ResponseListTransactions" data-type="object" data-desc="ページネーション情報とトランザクションのリストを含むオブジェクト。">
|
|
431
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
432
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
433
|
+
<x-field data-name="transactions" data-type="IndexedTransaction[]" data-desc="トランザクションオブジェクトの配列。"></x-field>
|
|
434
|
+
</x-field>
|
|
435
|
+
|
|
436
|
+
### `listTokens`
|
|
437
|
+
|
|
438
|
+
チェーン上のすべての代替可能トークンを一覧表示します。
|
|
439
|
+
|
|
440
|
+
**パラメータ**
|
|
441
|
+
|
|
442
|
+
<x-field-group>
|
|
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="発行者のアドレスでトークンをフィルタリングします。"></x-field>
|
|
445
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="トークンを期間でフィルタリングします。"></x-field>
|
|
446
|
+
</x-field-group>
|
|
447
|
+
|
|
448
|
+
**戻り値**
|
|
449
|
+
|
|
450
|
+
<x-field data-name="ResponseListTokens" data-type="object" data-desc="ページネーション情報とトークンのリストを含むオブジェクト。">
|
|
451
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
452
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
453
|
+
<x-field data-name="tokens" data-type="IndexedTokenState[]" data-desc="トークン状態オブジェクトの配列。"></x-field>
|
|
454
|
+
</x-field>
|
|
455
|
+
|
|
456
|
+
### `listFactories`
|
|
457
|
+
|
|
458
|
+
チェーン上のすべての資産ファクトリを一覧表示します。
|
|
459
|
+
|
|
460
|
+
**パラメータ**
|
|
461
|
+
|
|
462
|
+
<x-field-group>
|
|
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="所有者のアドレスでファクトリをフィルタリングします。"></x-field>
|
|
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="ファクトリを期間でフィルタリングします。"></x-field>
|
|
467
|
+
</x-field-group>
|
|
468
|
+
|
|
469
|
+
**戻り値**
|
|
470
|
+
|
|
471
|
+
<x-field data-name="ResponseListFactories" data-type="object" data-desc="ページネーション情報とファクトリのリストを含むオブジェクト。">
|
|
472
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
473
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
474
|
+
<x-field data-name="factories" data-type="IndexedFactoryState[]" data-desc="ファクトリ状態オブジェクトの配列。"></x-field>
|
|
475
|
+
</x-field>
|
|
476
|
+
|
|
477
|
+
### `getAccountTokens`
|
|
478
|
+
|
|
479
|
+
特定のアカウントのトークン残高を取得します。
|
|
480
|
+
|
|
481
|
+
**パラメータ**
|
|
482
|
+
|
|
483
|
+
<x-field-group>
|
|
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="クエリする特定のトークンアドレス。"></x-field>
|
|
486
|
+
</x-field-group>
|
|
487
|
+
|
|
488
|
+
**戻り値**
|
|
489
|
+
|
|
490
|
+
<x-field data-name="ResponseGetAccountTokens" data-type="object" data-desc="レスポンスコードとアカウントトークンのリストを含むオブジェクト。">
|
|
491
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
492
|
+
<x-field data-name="tokens" data-type="AccountToken[]" data-desc="トークン残高オブジェクトの配列。"></x-field>
|
|
493
|
+
</x-field>
|
|
494
|
+
|
|
495
|
+
### `getStakeState`
|
|
496
|
+
|
|
497
|
+
特定のステークの状態を取得します。
|
|
498
|
+
|
|
499
|
+
**パラメータ**
|
|
500
|
+
|
|
501
|
+
<x-field-group>
|
|
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="特定のブロック高での状態をクエリします。"></x-field>
|
|
504
|
+
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="取得する特定のフィールド。"></x-field>
|
|
505
|
+
</x-field-group>
|
|
506
|
+
|
|
507
|
+
**戻り値**
|
|
508
|
+
|
|
509
|
+
<x-field data-name="ResponseGetStakeState" data-type="object" data-desc="レスポンスコードとステークの状態を含むオブジェクト。">
|
|
510
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
511
|
+
<x-field data-name="state" data-type="StakeState" data-desc="ステークの詳細な状態。"></x-field>
|
|
512
|
+
</x-field>
|
|
513
|
+
|
|
514
|
+
### `listStakes`
|
|
515
|
+
|
|
516
|
+
オプションのフィルターを使用して、すべてのステークレコードを一覧表示します。
|
|
517
|
+
|
|
518
|
+
**パラメータ**
|
|
519
|
+
|
|
520
|
+
<x-field-group>
|
|
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="送信者または受信者のアドレスでステークをフィルタリングします。"></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
|
+
</x-field-group>
|
|
526
|
+
|
|
527
|
+
**戻り値**
|
|
528
|
+
|
|
529
|
+
<x-field data-name="ResponseListStakes" data-type="object" data-desc="ページネーション情報とステークのリストを含むオブジェクト。">
|
|
530
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
531
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
532
|
+
<x-field data-name="stakes" data-type="IndexedStakeState[]" data-desc="ステーク状態オブジェクトの配列。"></x-field>
|
|
533
|
+
</x-field>
|
|
534
|
+
|
|
535
|
+
### `getRollupState`
|
|
536
|
+
|
|
537
|
+
特定のロールアップの状態を取得します。
|
|
538
|
+
|
|
539
|
+
**パラメータ**
|
|
540
|
+
|
|
541
|
+
<x-field-group>
|
|
542
|
+
<x-field data-name="address" data-type="string" data-required="true" data-desc="クエリ対象のロールアップのアドレス。"></x-field>
|
|
543
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="特定のブロック高での状態をクエリします。"></x-field>
|
|
544
|
+
<x-field data-name="keys" data-type="string[]" data-required="false" data-desc="取得する特定のフィールド。"></x-field>
|
|
545
|
+
</x-field-group>
|
|
546
|
+
|
|
547
|
+
**戻り値**
|
|
548
|
+
|
|
549
|
+
<x-field data-name="ResponseGetRollupState" data-type="object" data-desc="レスポンスコードとロールアップの状態を含むオブジェクト。">
|
|
550
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
551
|
+
<x-field data-name="state" data-type="RollupState" data-desc="ロールアップの詳細な状態。"></x-field>
|
|
552
|
+
</x-field>
|
|
553
|
+
|
|
554
|
+
### `listRollups`
|
|
555
|
+
|
|
556
|
+
チェーン上のすべてのロールアップを一覧表示します。
|
|
557
|
+
|
|
558
|
+
**パラメータ**
|
|
559
|
+
|
|
560
|
+
<x-field-group>
|
|
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="トークンアドレスでロールアップをフィルタリングします。"></x-field>
|
|
563
|
+
<x-field data-name="foreignTokenAddress" data-type="string" data-required="false" data-desc="外部トークンアドレスでロールアップをフィルタリングします。"></x-field>
|
|
564
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput" data-required="false" data-desc="ロールアップを期間でフィルタリングします。"></x-field>
|
|
565
|
+
</x-field-group>
|
|
566
|
+
|
|
567
|
+
**戻り値**
|
|
568
|
+
|
|
569
|
+
<x-field data-name="ResponseListRollups" data-type="object" data-desc="ページネーション情報とロールアップのリストを含むオブジェクト。">
|
|
570
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
571
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
572
|
+
<x-field data-name="rollups" data-type="IndexedRollupState[]" data-desc="ロールアップ状態オブジェクトの配列。"></x-field>
|
|
573
|
+
</x-field>
|
|
574
|
+
|
|
575
|
+
### `getRollupBlock`
|
|
576
|
+
|
|
577
|
+
ロールアップサイドチェーンから特定のブロックを取得します。
|
|
578
|
+
|
|
579
|
+
**パラメータ**
|
|
580
|
+
|
|
581
|
+
<x-field-group>
|
|
582
|
+
<x-field data-name="hash" data-type="string" data-required="false" data-desc="ロールアップブロックのハッシュ。"></x-field>
|
|
583
|
+
<x-field data-name="height" data-type="string" data-required="false" data-desc="ロールアップブロックの高さ。"></x-field>
|
|
584
|
+
<x-field data-name="rollupAddress" data-type="string" data-required="true" data-desc="ロールアップのアドレス。"></x-field>
|
|
585
|
+
</x-field-group>
|
|
586
|
+
|
|
587
|
+
**戻り値**
|
|
588
|
+
|
|
589
|
+
<x-field data-name="ResponseGetRollupBlock" data-type="object" data-desc="レスポンスコードとロールアップブロックを含むオブジェクト。">
|
|
590
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
591
|
+
<x-field data-name="block" data-type="RollupBlock" data-desc="ロールアップブロックの詳細情報。"></x-field>
|
|
592
|
+
</x-field>
|
|
593
|
+
|
|
594
|
+
### `listRollupBlocks`
|
|
595
|
+
|
|
596
|
+
ロールアップサイドチェーンからブロックを一覧表示します。
|
|
597
|
+
|
|
598
|
+
**パラメータ**
|
|
599
|
+
|
|
600
|
+
<x-field-group>
|
|
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="ロールアップのアドレス。"></x-field>
|
|
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
|
+
</x-field-group>
|
|
609
|
+
|
|
610
|
+
**戻り値**
|
|
611
|
+
|
|
612
|
+
<x-field data-name="ResponseListRollupBlocks" data-type="object" data-desc="ページネーション情報とロールアップブロックのリストを含むオブジェクト。">
|
|
613
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
614
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
615
|
+
<x-field data-name="blocks" data-type="IndexedRollupBlock[]" data-desc="ロールアップブロックオブジェクトの配列。"></x-field>
|
|
616
|
+
</x-field>
|
|
617
|
+
|
|
618
|
+
### `listRollupValidators`
|
|
619
|
+
|
|
620
|
+
特定のロールアップのバリデーターを一覧表示します。
|
|
621
|
+
|
|
622
|
+
**パラメータ**
|
|
623
|
+
|
|
624
|
+
<x-field-group>
|
|
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="ロールアップのアドレス。"></x-field>
|
|
627
|
+
</x-field-group>
|
|
628
|
+
|
|
629
|
+
**戻り値**
|
|
630
|
+
|
|
631
|
+
<x-field data-name="ResponseListRollupValidators" data-type="object" data-desc="ページネーション情報とロールアップバリデーターのリストを含むオブジェクト。">
|
|
632
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
633
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
634
|
+
<x-field data-name="validators" data-type="IndexedRollupValidator[]" data-desc="ロールアップバリデーターオブジェクトの配列。"></x-field>
|
|
635
|
+
</x-field>
|
|
636
|
+
|
|
637
|
+
### `listDelegations`
|
|
638
|
+
|
|
639
|
+
すべての委任レコードを一覧表示します。
|
|
640
|
+
|
|
641
|
+
**パラメータ**
|
|
642
|
+
|
|
643
|
+
<x-field-group>
|
|
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="委任者のアドレスでフィルタリングします。"></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
|
+
</x-field-group>
|
|
649
|
+
|
|
650
|
+
**戻り値**
|
|
651
|
+
|
|
652
|
+
<x-field data-name="ResponseListDelegations" data-type="object" data-desc="ページネーション情報と委任のリストを含むオブジェクト。">
|
|
653
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
654
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
655
|
+
<x-field data-name="delegations" data-type="IndexedDelegationState[]" data-desc="委任状態オブジェクトの配列。"></x-field>
|
|
656
|
+
</x-field>
|
|
657
|
+
|
|
658
|
+
### `search`
|
|
659
|
+
|
|
660
|
+
アカウント、資産、またはトランザクションをキーワードで検索します。
|
|
661
|
+
|
|
662
|
+
**パラメータ**
|
|
663
|
+
|
|
664
|
+
<x-field-group>
|
|
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="検索するキーワード。"></x-field>
|
|
667
|
+
</x-field-group>
|
|
668
|
+
|
|
669
|
+
**戻り値**
|
|
670
|
+
|
|
671
|
+
<x-field data-name="ResponseSearch" data-type="object" data-desc="ページネーション情報と検索結果を含むオブジェクト。">
|
|
672
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
673
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
674
|
+
<x-field data-name="results" data-type="SearchResult[]" data-desc="検索結果オブジェクトの配列。"></x-field>
|
|
675
|
+
</x-field>
|
|
676
|
+
|
|
677
|
+
### `estimateGas`
|
|
678
|
+
|
|
679
|
+
トランザクションに必要なガスを推定します。
|
|
680
|
+
|
|
681
|
+
**パラメータ**
|
|
682
|
+
|
|
683
|
+
<x-field-group>
|
|
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="エンコードされたトランザクション文字列。"></x-field>
|
|
686
|
+
</x-field-group>
|
|
687
|
+
|
|
688
|
+
**戻り値**
|
|
689
|
+
|
|
690
|
+
<x-field data-name="ResponseEstimateGas" data-type="object" data-desc="レスポンスコードとガス推定値を含むオブジェクト。">
|
|
691
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
692
|
+
<x-field data-name="estimate" data-type="GasEstimate" data-desc="推定ガス量。"></x-field>
|
|
693
|
+
</x-field>
|
|
694
|
+
|
|
695
|
+
### `listTokenFlows`
|
|
696
|
+
|
|
697
|
+
アカウント間のトークンの流れを追跡します。
|
|
698
|
+
|
|
699
|
+
**パラメータ**
|
|
700
|
+
|
|
701
|
+
<x-field-group>
|
|
702
|
+
<x-field data-name="paging" data-type="PageInput" data-required="false" data-desc="ページネーション設定。"></x-field>
|
|
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="追跡するトークンのアドレス。"></x-field>
|
|
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="フローの方向(INまたはOUT)。"></x-field>
|
|
707
|
+
</x-field-group>
|
|
708
|
+
|
|
709
|
+
**戻り値**
|
|
710
|
+
|
|
711
|
+
<x-field data-name="ResponseListTokenFlows" data-type="object" data-desc="ページネーション情報とトークンフローデータを含むオブジェクト。">
|
|
712
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
713
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
714
|
+
<x-field data-name="data" data-type="IndexedTokenFlow[]" data-desc="トークンフローオブジェクトの配列。"></x-field>
|
|
715
|
+
</x-field>
|
|
716
|
+
|
|
717
|
+
### `verifyAccountRisk`
|
|
718
|
+
|
|
719
|
+
指定されたアカウントのリスクプロファイルを評価します。
|
|
720
|
+
|
|
721
|
+
**パラメータ**
|
|
722
|
+
|
|
723
|
+
<x-field-group>
|
|
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="コンテキスト用のトークンのアドレス。"></x-field>
|
|
726
|
+
</x-field-group>
|
|
727
|
+
|
|
728
|
+
**戻り値**
|
|
729
|
+
|
|
730
|
+
<x-field data-name="ResponseVerifyAccountRisk" data-type="object" data-desc="レスポンスコードとリスク検証結果を含むオブジェクト。">
|
|
731
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
732
|
+
<x-field data-name="data" data-type="VerifyAccountRiskResult" data-desc="リスク検証の結果。"></x-field>
|
|
733
|
+
</x-field>
|
|
734
|
+
|
|
735
|
+
### `getTokenDistribution`
|
|
736
|
+
|
|
737
|
+
指定されたトークンの分布統計を取得します。
|
|
738
|
+
|
|
739
|
+
**パラメータ**
|
|
740
|
+
|
|
741
|
+
<x-field-group>
|
|
742
|
+
<x-field data-name="tokenAddress" data-type="string" data-required="true" data-desc="トークンのアドレス。"></x-field>
|
|
743
|
+
</x-field-group>
|
|
744
|
+
|
|
745
|
+
**戻り値**
|
|
746
|
+
|
|
747
|
+
<x-field data-name="ResponseGetTokenDistribution" data-type="object" data-desc="レスポンスコードとトークン分布データを含むオブジェクト。">
|
|
748
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
749
|
+
<x-field data-name="data" data-type="TokenDistribution" data-desc="トークンの分布統計。"></x-field>
|
|
750
|
+
</x-field>
|
|
751
|
+
|
|
752
|
+
### `listTokenFactories`
|
|
753
|
+
|
|
754
|
+
チェーン上のすべてのトークンファクトリを一覧表示します。
|
|
755
|
+
|
|
756
|
+
**パラメータ**
|
|
757
|
+
|
|
758
|
+
<x-field-group>
|
|
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="トークンアドレスでフィルタリングします。"></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
|
+
</x-field-group>
|
|
765
|
+
|
|
766
|
+
**戻り値**
|
|
767
|
+
|
|
768
|
+
<x-field data-name="ResponseListTokenFactories" data-type="object" data-desc="ページネーション情報とトークンファクトリのリストを含むオブジェクト。">
|
|
769
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
770
|
+
<x-field data-name="page" data-type="PageInfo" data-desc="ページネーション情報。"></x-field>
|
|
771
|
+
<x-field data-name="tokenFactories" data-type="IndexedTokenFactoryState[]" data-desc="トークンファクトリ状態オブジェクトの配列。"></x-field>
|
|
772
|
+
</x-field>
|
|
773
|
+
|
|
774
|
+
## ミューテーションメソッド
|
|
775
|
+
|
|
776
|
+
ミューテーションは、ブロックチェーンの状態を変更するトランザクションを送信するために使用されます。
|
|
777
|
+
|
|
778
|
+
### `sendTx`
|
|
779
|
+
|
|
780
|
+
事前に署名されたトランザクションをネットワークにブロードキャストします。これは、すべての書き込み操作の基本的なメソッドです。トランザクションの作成と署名については、[高レベルAPI](./api-reference-transaction-helpers.md)および[トランザクションライフサイクル](./core-concepts-transaction-lifecycle.md)のガイドを参照してください。
|
|
781
|
+
|
|
782
|
+
**パラメータ**
|
|
783
|
+
|
|
784
|
+
<x-field-group>
|
|
785
|
+
<x-field data-name="tx" data-type="string" data-required="true" data-desc="エンコードされたトランザクション文字列。"></x-field>
|
|
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="認証トークン(必要な場合)。"></x-field>
|
|
788
|
+
<x-field data-name="commit" data-type="boolean" data-required="false" data-default="true" data-desc="trueの場合、トランザクションがブロックにコミットされるのを待ちます。"></x-field>
|
|
789
|
+
<x-field data-name="extra" data-type="string" data-required="false" data-desc="含める追加データ。"></x-field>
|
|
790
|
+
</x-field-group>
|
|
791
|
+
|
|
792
|
+
**戻り値**
|
|
793
|
+
|
|
794
|
+
<x-field data-name="ResponseSendTx" data-type="object" data-desc="レスポンスコードとトランザクションハッシュを含むオブジェクト。">
|
|
795
|
+
<x-field data-name="code" data-type="string" data-desc="レスポンスのステータスコード。"></x-field>
|
|
796
|
+
<x-field data-name="hash" data-type="string" data-desc="送信されたトランザクションのハッシュ。"></x-field>
|
|
797
|
+
</x-field>
|
|
798
|
+
|
|
799
|
+
**例**
|
|
800
|
+
|
|
801
|
+
```javascript icon=logos:javascript
|
|
802
|
+
// この例では、`signedTx`が適切にエンコードされ、署名されたトランザクション文字列であることを前提としています。
|
|
803
|
+
// 作成方法については、他のガイドを参照してください。
|
|
804
|
+
|
|
805
|
+
const signedTx = '...';
|
|
806
|
+
const wallet = { ... }; // トランザクションに署名したウォレット
|
|
807
|
+
|
|
808
|
+
try {
|
|
809
|
+
const { hash } = await client.sendTx({ tx: signedTx, wallet });
|
|
810
|
+
console.log('トランザクションの送信に成功しました!ハッシュ:', hash);
|
|
811
|
+
} catch (error) {
|
|
812
|
+
console.error('トランザクションの送信に失敗しました:', error);
|
|
813
|
+
}
|
|
814
|
+
```
|