@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,482 @@
|
|
|
1
|
+
# 資料類型
|
|
2
|
+
|
|
3
|
+
本節為整個 OCAP Client API 中使用的所有自訂資料結構、輸入參數和回應物件提供了全面的參考。了解這些類型對於有效與 OCAP 區塊鏈互動至關重要。
|
|
4
|
+
|
|
5
|
+
## 核心類型
|
|
6
|
+
|
|
7
|
+
這些是在各種 API 呼叫中使用的基本資料結構。
|
|
8
|
+
|
|
9
|
+
### Any
|
|
10
|
+
|
|
11
|
+
用於 protobuf 訊息的通用容器,允許靈活的資料結構。
|
|
12
|
+
|
|
13
|
+
<x-field-group>
|
|
14
|
+
<x-field data-name="typeUrl" data-type="string" data-desc="一個類似 URL 的字串,唯一標識序列化訊息的類型。"></x-field>
|
|
15
|
+
<x-field data-name="value" data-type="string" data-desc="序列化後的訊息內容,以字串形式表示。"></x-field>
|
|
16
|
+
</x-field-group>
|
|
17
|
+
|
|
18
|
+
### Multisig
|
|
19
|
+
|
|
20
|
+
表示多重簽名,通常用於需要多個批准的交易。
|
|
21
|
+
|
|
22
|
+
<x-field-group>
|
|
23
|
+
<x-field data-name="signer" data-type="string" data-desc="簽署者的地址。"></x-field>
|
|
24
|
+
<x-field data-name="pk" data-type="string" data-desc="簽署者的公鑰。"></x-field>
|
|
25
|
+
<x-field data-name="signature" data-type="string" data-desc="由簽署者生成的簽名。"></x-field>
|
|
26
|
+
<x-field data-name="delegator" data-type="string" data-desc="如果簽名是委託的,則為委託人的地址。"></x-field>
|
|
27
|
+
<x-field data-name="data" data-type="Any" data-desc="與簽名相關的可選任意資料。"></x-field>
|
|
28
|
+
</x-field-group>
|
|
29
|
+
|
|
30
|
+
### PageInfo
|
|
31
|
+
|
|
32
|
+
包含基於列表的查詢回應的分頁詳細資訊。
|
|
33
|
+
|
|
34
|
+
<x-field-group>
|
|
35
|
+
<x-field data-name="cursor" data-type="string" data-desc="用於獲取下一頁結果的游標。"></x-field>
|
|
36
|
+
<x-field data-name="next" data-type="boolean" data-desc="指示是否有下一頁結果可用。"></x-field>
|
|
37
|
+
<x-field data-name="total" data-type="number" data-desc="符合查詢條件的項目總數。"></x-field>
|
|
38
|
+
</x-field-group>
|
|
39
|
+
|
|
40
|
+
### StateContext
|
|
41
|
+
|
|
42
|
+
提供有關狀態物件的建立和上次修改的上下文。
|
|
43
|
+
|
|
44
|
+
<x-field-group>
|
|
45
|
+
<x-field data-name="genesisTx" data-type="TransactionInfo" data-desc="建立此狀態物件的交易。"></x-field>
|
|
46
|
+
<x-field data-name="renaissanceTx" data-type="TransactionInfo" data-desc="上次更新此狀態物件的交易。"></x-field>
|
|
47
|
+
<x-field data-name="genesisTime" data-type="string" data-desc="狀態物件建立時的時間戳。"></x-field>
|
|
48
|
+
<x-field data-name="renaissanceTime" data-type="string" data-desc="狀態物件上次更新時的時間戳。"></x-field>
|
|
49
|
+
</x-field-group>
|
|
50
|
+
|
|
51
|
+
### 錢包物件
|
|
52
|
+
|
|
53
|
+
這些類型定義了用於簽署交易的錢包結構。
|
|
54
|
+
|
|
55
|
+
#### WalletObject
|
|
56
|
+
|
|
57
|
+
<x-field-group>
|
|
58
|
+
<x-field data-name="publicKey" data-type="string"></x-field>
|
|
59
|
+
<x-field data-name="secretKey" data-type="string"></x-field>
|
|
60
|
+
<x-field data-name="type" data-type="WalletTypeObject"></x-field>
|
|
61
|
+
</x-field-group>
|
|
62
|
+
|
|
63
|
+
#### WalletTypeObject
|
|
64
|
+
|
|
65
|
+
<x-field-group>
|
|
66
|
+
<x-field data-name="pk" data-type="number"></x-field>
|
|
67
|
+
<x-field data-name="role" data-type="number"></x-field>
|
|
68
|
+
<x-field data-name="hash" data-type="number"></x-field>
|
|
69
|
+
<x-field data-name="address" data-type="number" data-desc="預設為 base58btc"></x-field>
|
|
70
|
+
</x-field-group>
|
|
71
|
+
|
|
72
|
+
#### WalletType
|
|
73
|
+
|
|
74
|
+
<x-field-group>
|
|
75
|
+
<x-field data-name="pk" data-type="KeyType"></x-field>
|
|
76
|
+
<x-field data-name="hash" data-type="HashType"></x-field>
|
|
77
|
+
<x-field data-name="address" data-type="EncodingType"></x-field>
|
|
78
|
+
<x-field data-name="role" data-type="RoleType"></x-field>
|
|
79
|
+
</x-field-group>
|
|
80
|
+
|
|
81
|
+
## 輸入與篩選器類型
|
|
82
|
+
|
|
83
|
+
這些物件用於為 GraphQL 查詢提供參數和篩選器。
|
|
84
|
+
|
|
85
|
+
### 通用篩選器輸入
|
|
86
|
+
|
|
87
|
+
<x-field-group>
|
|
88
|
+
<x-field data-name="AccountFilterInput" data-type="object">
|
|
89
|
+
<x-field data-name="accounts" data-type="array<string>"></x-field>
|
|
90
|
+
</x-field>
|
|
91
|
+
<x-field data-name="AddressFilterInput" data-type="object">
|
|
92
|
+
<x-field data-name="sender" data-type="string"></x-field>
|
|
93
|
+
<x-field data-name="receiver" data-type="string"></x-field>
|
|
94
|
+
<x-field data-name="direction" data-type="Direction"></x-field>
|
|
95
|
+
</x-field>
|
|
96
|
+
<x-field data-name="AssetFilterInput" data-type="object">
|
|
97
|
+
<x-field data-name="assets" data-type="array<string>"></x-field>
|
|
98
|
+
</x-field>
|
|
99
|
+
<x-field data-name="DelegationFilterInput" data-type="object">
|
|
100
|
+
<x-field data-name="delegations" data-type="array<string>"></x-field>
|
|
101
|
+
</x-field>
|
|
102
|
+
<x-field data-name="FactoryFilterInput" data-type="object">
|
|
103
|
+
<x-field data-name="factories" data-type="array<string>"></x-field>
|
|
104
|
+
</x-field>
|
|
105
|
+
<x-field data-name="RangeFilterInput" data-type="object">
|
|
106
|
+
<x-field data-name="from" data-type="string"></x-field>
|
|
107
|
+
<x-field data-name="to" data-type="string"></x-field>
|
|
108
|
+
</x-field>
|
|
109
|
+
<x-field data-name="RollupFilterInput" data-type="object">
|
|
110
|
+
<x-field data-name="rollups" data-type="array<string>"></x-field>
|
|
111
|
+
</x-field>
|
|
112
|
+
<x-field data-name="StakeFilterInput" data-type="object">
|
|
113
|
+
<x-field data-name="stakes" data-type="array<string>"></x-field>
|
|
114
|
+
</x-field>
|
|
115
|
+
<x-field data-name="TimeFilterInput" data-type="object">
|
|
116
|
+
<x-field data-name="startDateTime" data-type="string"></x-field>
|
|
117
|
+
<x-field data-name="endDateTime" data-type="string"></x-field>
|
|
118
|
+
<x-field data-name="field" data-type="string"></x-field>
|
|
119
|
+
</x-field>
|
|
120
|
+
<x-field data-name="TokenFactoryFilterInput" data-type="object">
|
|
121
|
+
<x-field data-name="tokenFactories" data-type="array<string>"></x-field>
|
|
122
|
+
</x-field>
|
|
123
|
+
<x-field data-name="TokenFilterInput" data-type="object">
|
|
124
|
+
<x-field data-name="tokens" data-type="array<string>"></x-field>
|
|
125
|
+
</x-field>
|
|
126
|
+
<x-field data-name="TxFilterInput" data-type="object">
|
|
127
|
+
<x-field data-name="txs" data-type="array<string>"></x-field>
|
|
128
|
+
</x-field>
|
|
129
|
+
<x-field data-name="TypeFilterInput" data-type="object">
|
|
130
|
+
<x-field data-name="types" data-type="array<string>"></x-field>
|
|
131
|
+
</x-field>
|
|
132
|
+
<x-field data-name="ValidatorFilterInput" data-type="object">
|
|
133
|
+
<x-field data-name="validators" data-type="array<string>"></x-field>
|
|
134
|
+
</x-field>
|
|
135
|
+
<x-field data-name="ValidityFilterInput" data-type="object">
|
|
136
|
+
<x-field data-name="validity" data-type="Validity"></x-field>
|
|
137
|
+
</x-field>
|
|
138
|
+
</x-field-group>
|
|
139
|
+
|
|
140
|
+
### 分頁輸入
|
|
141
|
+
|
|
142
|
+
#### PageInput
|
|
143
|
+
|
|
144
|
+
<x-field-group>
|
|
145
|
+
<x-field data-name="cursor" data-type="string"></x-field>
|
|
146
|
+
<x-field data-name="size" data-type="number"></x-field>
|
|
147
|
+
<x-field data-name="order" data-type="array<PageOrderInput>"></x-field>
|
|
148
|
+
</x-field-group>
|
|
149
|
+
|
|
150
|
+
#### PageOrderInput
|
|
151
|
+
|
|
152
|
+
<x-field-group>
|
|
153
|
+
<x-field data-name="field" data-type="string"></x-field>
|
|
154
|
+
<x-field data-name="type" data-type="string"></x-field>
|
|
155
|
+
</x-field-group>
|
|
156
|
+
|
|
157
|
+
### 特定請求的輸入
|
|
158
|
+
|
|
159
|
+
這些物件用作特定查詢和變異方法的參數。
|
|
160
|
+
|
|
161
|
+
<x-field-group>
|
|
162
|
+
<x-field data-name="RequestEstimateGasInput" data-type="object">
|
|
163
|
+
<x-field data-name="typeUrl" data-type="string"></x-field>
|
|
164
|
+
<x-field data-name="tx" data-type="string"></x-field>
|
|
165
|
+
</x-field>
|
|
166
|
+
<x-field data-name="RequestGetAccountStateInput" data-type="object">
|
|
167
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
168
|
+
<x-field data-name="keys" data-type="array<string>"></x-field>
|
|
169
|
+
<x-field data-name="height" data-type="number"></x-field>
|
|
170
|
+
<x-field data-name="traceMigration" data-type="boolean"></x-field>
|
|
171
|
+
</x-field>
|
|
172
|
+
<x-field data-name="RequestGetAccountTokensInput" data-type="object">
|
|
173
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
174
|
+
<x-field data-name="token" data-type="string"></x-field>
|
|
175
|
+
</x-field>
|
|
176
|
+
<x-field data-name="RequestGetBlockInput" data-type="object">
|
|
177
|
+
<x-field data-name="height" data-type="number"></x-field>
|
|
178
|
+
</x-field>
|
|
179
|
+
<x-field data-name="RequestGetBlocksInput" data-type="object">
|
|
180
|
+
<x-field data-name="paging" data-type="PageInput"></x-field>
|
|
181
|
+
<x-field data-name="heightFilter" data-type="RangeFilterInput"></x-field>
|
|
182
|
+
<x-field data-name="emptyExcluded" data-type="boolean"></x-field>
|
|
183
|
+
</x-field>
|
|
184
|
+
<x-field data-name="RequestListTransactionsInput" data-type="object">
|
|
185
|
+
<x-field data-name="paging" data-type="PageInput"></x-field>
|
|
186
|
+
<x-field data-name="timeFilter" data-type="TimeFilterInput"></x-field>
|
|
187
|
+
<x-field data-name="addressFilter" data-type="AddressFilterInput"></x-field>
|
|
188
|
+
<x-field data-name="typeFilter" data-type="TypeFilterInput"></x-field>
|
|
189
|
+
<x-field data-name="validityFilter" data-type="ValidityFilterInput"></x-field>
|
|
190
|
+
<x-field data-name="factoryFilter" data-type="FactoryFilterInput"></x-field>
|
|
191
|
+
<x-field data-name="tokenFilter" data-type="TokenFilterInput"></x-field>
|
|
192
|
+
<x-field data-name="assetFilter" data-type="AssetFilterInput"></x-field>
|
|
193
|
+
<x-field data-name="accountFilter" data-type="AccountFilterInput"></x-field>
|
|
194
|
+
<x-field data-name="txFilter" data-type="TxFilterInput"></x-field>
|
|
195
|
+
<x-field data-name="rollupFilter" data-type="RollupFilterInput"></x-field>
|
|
196
|
+
<x-field data-name="stakeFilter" data-type="StakeFilterInput"></x-field>
|
|
197
|
+
<x-field data-name="delegationFilter" data-type="DelegationFilterInput"></x-field>
|
|
198
|
+
<x-field data-name="tokenFactoryFilter" data-type="TokenFactoryFilterInput"></x-field>
|
|
199
|
+
</x-field>
|
|
200
|
+
</x-field-group>
|
|
201
|
+
|
|
202
|
+
## 狀態物件
|
|
203
|
+
|
|
204
|
+
這些類型表示區塊鏈上各種實體的狀態,例如帳戶、資產和代幣。
|
|
205
|
+
|
|
206
|
+
### AccountState
|
|
207
|
+
|
|
208
|
+
表示使用者帳戶的狀態。
|
|
209
|
+
|
|
210
|
+
<x-field-group>
|
|
211
|
+
<x-field data-name="balance" data-type="string"></x-field>
|
|
212
|
+
<x-field data-name="nonce" data-type="string"></x-field>
|
|
213
|
+
<x-field data-name="numTxs" data-type="string"></x-field>
|
|
214
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
215
|
+
<x-field data-name="pk" data-type="string"></x-field>
|
|
216
|
+
<x-field data-name="type" data-type="WalletType"></x-field>
|
|
217
|
+
<x-field data-name="moniker" data-type="string"></x-field>
|
|
218
|
+
<x-field data-name="context" data-type="StateContext"></x-field>
|
|
219
|
+
<x-field data-name="issuer" data-type="string"></x-field>
|
|
220
|
+
<x-field data-name="gasBalance" data-type="string"></x-field>
|
|
221
|
+
<x-field data-name="migratedTo" data-type="array<string>"></x-field>
|
|
222
|
+
<x-field data-name="migratedFrom" data-type="array<string>"></x-field>
|
|
223
|
+
<x-field data-name="numAssets" data-type="string"></x-field>
|
|
224
|
+
<x-field data-name="tokens" data-type="array<IndexedTokenInput>"></x-field>
|
|
225
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
226
|
+
</x-field-group>
|
|
227
|
+
|
|
228
|
+
### AssetState
|
|
229
|
+
|
|
230
|
+
表示非同質化資產 (NFT) 的狀態。
|
|
231
|
+
|
|
232
|
+
<x-field-group>
|
|
233
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
234
|
+
<x-field data-name="owner" data-type="string"></x-field>
|
|
235
|
+
<x-field data-name="moniker" data-type="string"></x-field>
|
|
236
|
+
<x-field data-name="readonly" data-type="boolean"></x-field>
|
|
237
|
+
<x-field data-name="transferrable" data-type="boolean"></x-field>
|
|
238
|
+
<x-field data-name="ttl" data-type="number"></x-field>
|
|
239
|
+
<x-field data-name="consumedTime" data-type="string"></x-field>
|
|
240
|
+
<x-field data-name="issuer" data-type="string"></x-field>
|
|
241
|
+
<x-field data-name="parent" data-type="string"></x-field>
|
|
242
|
+
<x-field data-name="endpoint" data-type="NFTEndpoint"></x-field>
|
|
243
|
+
<x-field data-name="display" data-type="NFTDisplay"></x-field>
|
|
244
|
+
<x-field data-name="tags" data-type="array<string>"></x-field>
|
|
245
|
+
<x-field data-name="context" data-type="StateContext"></x-field>
|
|
246
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
247
|
+
</x-field-group>
|
|
248
|
+
|
|
249
|
+
### AssetFactoryState
|
|
250
|
+
|
|
251
|
+
表示資產工廠的狀態,用於鑄造新資產。
|
|
252
|
+
|
|
253
|
+
<x-field-group>
|
|
254
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
255
|
+
<x-field data-name="owner" data-type="string"></x-field>
|
|
256
|
+
<x-field data-name="name" data-type="string"></x-field>
|
|
257
|
+
<x-field data-name="description" data-type="string"></x-field>
|
|
258
|
+
<x-field data-name="settlement" data-type="string"></x-field>
|
|
259
|
+
<x-field data-name="limit" data-type="number"></x-field>
|
|
260
|
+
<x-field data-name="trustedIssuers" data-type="array<string>"></x-field>
|
|
261
|
+
<x-field data-name="input" data-type="IndexedFactoryInput"></x-field>
|
|
262
|
+
<x-field data-name="output" data-type="CreateAssetTx"></x-field>
|
|
263
|
+
<x-field data-name="hooks" data-type="array<AssetFactoryHook>"></x-field>
|
|
264
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
265
|
+
<x-field data-name="context" data-type="StateContext"></x-field>
|
|
266
|
+
<x-field data-name="balance" data-type="string"></x-field>
|
|
267
|
+
<x-field data-name="tokens" data-type="array<IndexedTokenInput>"></x-field>
|
|
268
|
+
<x-field data-name="numMinted" data-type="number"></x-field>
|
|
269
|
+
<x-field data-name="display" data-type="NFTDisplay"></x-field>
|
|
270
|
+
<x-field data-name="lastSettlement" data-type="string"></x-field>
|
|
271
|
+
</x-field-group>
|
|
272
|
+
|
|
273
|
+
### DelegateState
|
|
274
|
+
|
|
275
|
+
表示委託的狀態,其中一個帳戶授權另一個帳戶代表其執行操作。
|
|
276
|
+
|
|
277
|
+
<x-field-group>
|
|
278
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
279
|
+
<x-field data-name="ops" data-type="array<DelegateState_OpsEntry>"></x-field>
|
|
280
|
+
<x-field data-name="from" data-type="string"></x-field>
|
|
281
|
+
<x-field data-name="to" data-type="string"></x-field>
|
|
282
|
+
<x-field data-name="context" data-type="StateContext"></x-field>
|
|
283
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
284
|
+
</x-field-group>
|
|
285
|
+
|
|
286
|
+
### StakeState
|
|
287
|
+
|
|
288
|
+
表示質押的狀態,可能涉及代幣或資產。
|
|
289
|
+
|
|
290
|
+
<x-field-group>
|
|
291
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
292
|
+
<x-field data-name="sender" data-type="string"></x-field>
|
|
293
|
+
<x-field data-name="receiver" data-type="string"></x-field>
|
|
294
|
+
<x-field data-name="tokens" data-type="array<IndexedTokenInput>"></x-field>
|
|
295
|
+
<x-field data-name="assets" data-type="array<string>"></x-field>
|
|
296
|
+
<x-field data-name="revocable" data-type="boolean"></x-field>
|
|
297
|
+
<x-field data-name="message" data-type="string"></x-field>
|
|
298
|
+
<x-field data-name="revokeWaitingPeriod" data-type="number"></x-field>
|
|
299
|
+
<x-field data-name="revokedTokens" data-type="array<IndexedTokenInput>"></x-field>
|
|
300
|
+
<x-field data-name="revokedAssets" data-type="array<string>"></x-field>
|
|
301
|
+
<x-field data-name="slashers" data-type="array<string>"></x-field>
|
|
302
|
+
<x-field data-name="nonce" data-type="string"></x-field>
|
|
303
|
+
<x-field data-name="context" data-type="StateContext"></x-field>
|
|
304
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
305
|
+
</x-field-group>
|
|
306
|
+
|
|
307
|
+
### TokenState
|
|
308
|
+
|
|
309
|
+
表示同質化代幣的狀態。
|
|
310
|
+
|
|
311
|
+
<x-field-group>
|
|
312
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
313
|
+
<x-field data-name="issuer" data-type="string"></x-field>
|
|
314
|
+
<x-field data-name="name" data-type="string"></x-field>
|
|
315
|
+
<x-field data-name="description" data-type="string"></x-field>
|
|
316
|
+
<x-field data-name="symbol" data-type="string"></x-field>
|
|
317
|
+
<x-field data-name="unit" data-type="string"></x-field>
|
|
318
|
+
<x-field data-name="decimal" data-type="number"></x-field>
|
|
319
|
+
<x-field data-name="icon" data-type="string"></x-field>
|
|
320
|
+
<x-field data-name="totalSupply" data-type="string"></x-field>
|
|
321
|
+
<x-field data-name="initialSupply" data-type="string"></x-field>
|
|
322
|
+
<x-field data-name="maxTotalSupply" data-type="string"></x-field>
|
|
323
|
+
<x-field data-name="foreignToken" data-type="ForeignToken"></x-field>
|
|
324
|
+
<x-field data-name="tokenFactoryAddress" data-type="string"></x-field>
|
|
325
|
+
<x-field data-name="context" data-type="StateContext"></x-field>
|
|
326
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
327
|
+
</x-field-group>
|
|
328
|
+
|
|
329
|
+
### TokenFactoryState
|
|
330
|
+
|
|
331
|
+
表示代幣工廠的狀態,用於鑄造和銷毀代幣。
|
|
332
|
+
|
|
333
|
+
<x-field-group>
|
|
334
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
335
|
+
<x-field data-name="tokenAddress" data-type="string"></x-field>
|
|
336
|
+
<x-field data-name="reserveAddress" data-type="string"></x-field>
|
|
337
|
+
<x-field data-name="currentSupply" data-type="string"></x-field>
|
|
338
|
+
<x-field data-name="reserveBalance" data-type="string"></x-field>
|
|
339
|
+
<x-field data-name="owner" data-type="string"></x-field>
|
|
340
|
+
<x-field data-name="feeRate" data-type="number"></x-field>
|
|
341
|
+
<x-field data-name="curve" data-type="CurveConfig"></x-field>
|
|
342
|
+
<x-field data-name="context" data-type="StateContext"></x-field>
|
|
343
|
+
<x-field data-name="token" data-type="TokenState"></x-field>
|
|
344
|
+
<x-field data-name="reserveToken" data-type="TokenState"></x-field>
|
|
345
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
346
|
+
</x-field-group>
|
|
347
|
+
|
|
348
|
+
## 交易負載 (ITX)
|
|
349
|
+
|
|
350
|
+
這些類型定義了各種交易類型的 `itx` (內部交易) 物件。
|
|
351
|
+
|
|
352
|
+
### AccountMigrateTx
|
|
353
|
+
|
|
354
|
+
<x-field-group>
|
|
355
|
+
<x-field data-name="pk" data-type="string"></x-field>
|
|
356
|
+
<x-field data-name="type" data-type="WalletType"></x-field>
|
|
357
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
358
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
359
|
+
</x-field-group>
|
|
360
|
+
|
|
361
|
+
### AcquireAssetV2Tx
|
|
362
|
+
|
|
363
|
+
<x-field-group>
|
|
364
|
+
<x-field data-name="factory" data-type="string"></x-field>
|
|
365
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
366
|
+
<x-field data-name="assets" data-type="array<string>"></x-field>
|
|
367
|
+
<x-field data-name="variables" data-type="array<VariableInput>"></x-field>
|
|
368
|
+
<x-field data-name="issuer" data-type="NFTIssuer"></x-field>
|
|
369
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
370
|
+
</x-field-group>
|
|
371
|
+
|
|
372
|
+
### CreateAssetTx
|
|
373
|
+
|
|
374
|
+
<x-field-group>
|
|
375
|
+
<x-field data-name="moniker" data-type="string"></x-field>
|
|
376
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
377
|
+
<x-field data-name="readonly" data-type="boolean"></x-field>
|
|
378
|
+
<x-field data-name="transferrable" data-type="boolean"></x-field>
|
|
379
|
+
<x-field data-name="ttl" data-type="number"></x-field>
|
|
380
|
+
<x-field data-name="parent" data-type="string"></x-field>
|
|
381
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
382
|
+
<x-field data-name="issuer" data-type="string"></x-field>
|
|
383
|
+
<x-field data-name="endpoint" data-type="NFTEndpoint"></x-field>
|
|
384
|
+
<x-field data-name="display" data-type="NFTDisplay"></x-field>
|
|
385
|
+
<x-field data-name="tags" data-type="array<string>"></x-field>
|
|
386
|
+
</x-field-group>
|
|
387
|
+
|
|
388
|
+
### DelegateTx
|
|
389
|
+
|
|
390
|
+
<x-field-group>
|
|
391
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
392
|
+
<x-field data-name="to" data-type="string"></x-field>
|
|
393
|
+
<x-field data-name="ops" data-type="array<DelegateOp>"></x-field>
|
|
394
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
395
|
+
</x-field-group>
|
|
396
|
+
|
|
397
|
+
### ExchangeTx
|
|
398
|
+
|
|
399
|
+
<x-field-group>
|
|
400
|
+
<x-field data-name="to" data-type="string"></x-field>
|
|
401
|
+
<x-field data-name="sender" data-type="ExchangeInfo"></x-field>
|
|
402
|
+
<x-field data-name="receiver" data-type="ExchangeInfo"></x-field>
|
|
403
|
+
<x-field data-name="expiredAt" data-type="string"></x-field>
|
|
404
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
405
|
+
</x-field-group>
|
|
406
|
+
|
|
407
|
+
### StakeTx
|
|
408
|
+
|
|
409
|
+
<x-field-group>
|
|
410
|
+
<x-field data-name="address" data-type="string"></x-field>
|
|
411
|
+
<x-field data-name="receiver" data-type="string"></x-field>
|
|
412
|
+
<x-field data-name="inputs" data-type="array<TransactionInput>"></x-field>
|
|
413
|
+
<x-field data-name="locked" data-type="boolean"></x-field>
|
|
414
|
+
<x-field data-name="message" data-type="string"></x-field>
|
|
415
|
+
<x-field data-name="revokeWaitingPeriod" data-type="number"></x-field>
|
|
416
|
+
<x-field data-name="slashers" data-type="array<string>"></x-field>
|
|
417
|
+
<x-field data-name="nonce" data-type="string"></x-field>
|
|
418
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
419
|
+
</x-field-group>
|
|
420
|
+
|
|
421
|
+
### TransferTx
|
|
422
|
+
|
|
423
|
+
<x-field-group>
|
|
424
|
+
<x-field data-name="to" data-type="string"></x-field>
|
|
425
|
+
<x-field data-name="value" data-type="string"></x-field>
|
|
426
|
+
<x-field data-name="assets" data-type="array<string>"></x-field>
|
|
427
|
+
<x-field data-name="data" data-type="Any"></x-field>
|
|
428
|
+
</x-field-group>
|
|
429
|
+
|
|
430
|
+
## 回應封裝器
|
|
431
|
+
|
|
432
|
+
這些類型是 API 查詢返回的頂層物件,包含狀態碼和請求的資料。
|
|
433
|
+
|
|
434
|
+
### ResponseGetAccountState
|
|
435
|
+
|
|
436
|
+
<x-field-group>
|
|
437
|
+
<x-field data-name="code" data-type="string"></x-field>
|
|
438
|
+
<x-field data-name="state" data-type="AccountState"></x-field>
|
|
439
|
+
</x-field-group>
|
|
440
|
+
|
|
441
|
+
### ResponseGetAssetState
|
|
442
|
+
|
|
443
|
+
<x-field-group>
|
|
444
|
+
<x-field data-name="code" data-type="string"></x-field>
|
|
445
|
+
<x-field data-name="state" data-type="AssetState"></x-field>
|
|
446
|
+
</x-field-group>
|
|
447
|
+
|
|
448
|
+
### ResponseGetBlock
|
|
449
|
+
|
|
450
|
+
<x-field-group>
|
|
451
|
+
<x-field data-name="code" data-type="string"></x-field>
|
|
452
|
+
<x-field data-name="block" data-type="BlockInfo"></x-field>
|
|
453
|
+
</x-field-group>
|
|
454
|
+
|
|
455
|
+
### ResponseGetChainInfo
|
|
456
|
+
|
|
457
|
+
<x-field-group>
|
|
458
|
+
<x-field data-name="code" data-type="string"></x-field>
|
|
459
|
+
<x-field data-name="info" data-type="ChainInfo"></x-field>
|
|
460
|
+
</x-field-group>
|
|
461
|
+
|
|
462
|
+
### ResponseGetTx
|
|
463
|
+
|
|
464
|
+
<x-field-group>
|
|
465
|
+
<x-field data-name="code" data-type="string"></x-field>
|
|
466
|
+
<x-field data-name="info" data-type="TransactionInfo"></x-field>
|
|
467
|
+
</x-field-group>
|
|
468
|
+
|
|
469
|
+
### ResponseListTransactions
|
|
470
|
+
|
|
471
|
+
<x-field-group>
|
|
472
|
+
<x-field data-name="code" data-type="string"></x-field>
|
|
473
|
+
<x-field data-name="page" data-type="PageInfo"></x-field>
|
|
474
|
+
<x-field data-name="transactions" data-type="array<IndexedTransaction>"></x-field>
|
|
475
|
+
</x-field-group>
|
|
476
|
+
|
|
477
|
+
### ResponseSendTx
|
|
478
|
+
|
|
479
|
+
<x-field-group>
|
|
480
|
+
<x-field data-name="code" data-type="string"></x-field>
|
|
481
|
+
<x-field data-name="hash" data-type="string"></x-field>
|
|
482
|
+
</x-field-group>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 数据类型
|
|
2
2
|
|
|
3
|
-
本节为整个 OCAP
|
|
3
|
+
本节为整个 OCAP 客户端 API 中使用的所有自定义数据结构、输入参数和响应对象提供了全面的参考。理解这些类型对于有效与 OCAP 区块链进行交互至关重要。
|
|
4
4
|
|
|
5
5
|
## 核心类型
|
|
6
6
|
|
|
@@ -12,12 +12,12 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
12
12
|
|
|
13
13
|
<x-field-group>
|
|
14
14
|
<x-field data-name="typeUrl" data-type="string" data-desc="一个类似 URL 的字符串,唯一标识序列化消息的类型。"></x-field>
|
|
15
|
-
<x-field data-name="value" data-type="string" data-desc="
|
|
15
|
+
<x-field data-name="value" data-type="string" data-desc="作为字符串的序列化消息内容。"></x-field>
|
|
16
16
|
</x-field-group>
|
|
17
17
|
|
|
18
18
|
### Multisig
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
表示多重签名,常用于需要多个批准的交易。
|
|
21
21
|
|
|
22
22
|
<x-field-group>
|
|
23
23
|
<x-field data-name="signer" data-type="string" data-desc="签名者的地址。"></x-field>
|
|
@@ -48,7 +48,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
48
48
|
<x-field data-name="renaissanceTime" data-type="string" data-desc="状态对象最后更新时的时间戳。"></x-field>
|
|
49
49
|
</x-field-group>
|
|
50
50
|
|
|
51
|
-
###
|
|
51
|
+
### Wallet 对象
|
|
52
52
|
|
|
53
53
|
这些类型定义了用于签署交易的钱包的结构。
|
|
54
54
|
|
|
@@ -154,7 +154,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
154
154
|
<x-field data-name="type" data-type="string"></x-field>
|
|
155
155
|
</x-field-group>
|
|
156
156
|
|
|
157
|
-
###
|
|
157
|
+
### 特定请求输入
|
|
158
158
|
|
|
159
159
|
这些对象用作特定查询和变更方法的参数。
|
|
160
160
|
|
|
@@ -201,11 +201,11 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
201
201
|
|
|
202
202
|
## 状态对象
|
|
203
203
|
|
|
204
|
-
|
|
204
|
+
这些类型表示区块链上各种实体的状态,例如账户、资产和代币。
|
|
205
205
|
|
|
206
206
|
### AccountState
|
|
207
207
|
|
|
208
|
-
|
|
208
|
+
表示用户账户的状态。
|
|
209
209
|
|
|
210
210
|
<x-field-group>
|
|
211
211
|
<x-field data-name="balance" data-type="string"></x-field>
|
|
@@ -227,7 +227,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
227
227
|
|
|
228
228
|
### AssetState
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
表示非同质化资产 (NFT) 的状态。
|
|
231
231
|
|
|
232
232
|
<x-field-group>
|
|
233
233
|
<x-field data-name="address" data-type="string"></x-field>
|
|
@@ -248,7 +248,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
248
248
|
|
|
249
249
|
### AssetFactoryState
|
|
250
250
|
|
|
251
|
-
|
|
251
|
+
表示资产工厂的状态,用于铸造新资产。
|
|
252
252
|
|
|
253
253
|
<x-field-group>
|
|
254
254
|
<x-field data-name="address" data-type="string"></x-field>
|
|
@@ -272,7 +272,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
272
272
|
|
|
273
273
|
### DelegateState
|
|
274
274
|
|
|
275
|
-
|
|
275
|
+
表示委托的状态,即一个账户授权另一个账户代表其执行操作。
|
|
276
276
|
|
|
277
277
|
<x-field-group>
|
|
278
278
|
<x-field data-name="address" data-type="string"></x-field>
|
|
@@ -285,7 +285,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
285
285
|
|
|
286
286
|
### StakeState
|
|
287
287
|
|
|
288
|
-
|
|
288
|
+
表示质押的状态,可以涉及代币或资产。
|
|
289
289
|
|
|
290
290
|
<x-field-group>
|
|
291
291
|
<x-field data-name="address" data-type="string"></x-field>
|
|
@@ -306,7 +306,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
306
306
|
|
|
307
307
|
### TokenState
|
|
308
308
|
|
|
309
|
-
|
|
309
|
+
表示同质化代币的状态。
|
|
310
310
|
|
|
311
311
|
<x-field-group>
|
|
312
312
|
<x-field data-name="address" data-type="string"></x-field>
|
|
@@ -328,7 +328,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
328
328
|
|
|
329
329
|
### TokenFactoryState
|
|
330
330
|
|
|
331
|
-
|
|
331
|
+
表示代币工厂的状态,用于铸造和销毁代币。
|
|
332
332
|
|
|
333
333
|
<x-field-group>
|
|
334
334
|
<x-field data-name="address" data-type="string"></x-field>
|
|
@@ -429,7 +429,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
429
429
|
|
|
430
430
|
## 响应包装器
|
|
431
431
|
|
|
432
|
-
这些类型是 API
|
|
432
|
+
这些类型是 API 查询返回的顶层对象,包含状态码和请求的数据。
|
|
433
433
|
|
|
434
434
|
### ResponseGetAccountState
|
|
435
435
|
|