@ocap/client 1.25.6 → 1.26.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -79
- package/dist/base.js +2 -2
- package/dist/base.js.map +1 -1
- package/dist/bundle.js +1 -1
- package/dist/extension.js +4 -4
- package/dist/extension.js.map +1 -1
- package/dist/report.html +2 -2
- package/docs/api-reference-client-methods.ja.md +38 -38
- package/docs/api-reference-client-methods.zh-TW.md +47 -47
- package/docs/api-reference-client-methods.zh.md +34 -34
- package/docs/api-reference-data-types.ja.md +20 -20
- package/docs/api-reference-data-types.zh-TW.md +17 -17
- package/docs/api-reference-data-types.zh.md +24 -24
- package/docs/api-reference-low-level-api.ja.md +49 -49
- package/docs/api-reference-low-level-api.zh-TW.md +48 -48
- package/docs/api-reference-low-level-api.zh.md +43 -43
- package/docs/api-reference-query-mutation-methods.ja.md +85 -85
- package/docs/api-reference-query-mutation-methods.zh-TW.md +140 -140
- package/docs/api-reference-query-mutation-methods.zh.md +141 -141
- package/docs/api-reference-transaction-helpers.ja.md +120 -120
- package/docs/api-reference-transaction-helpers.zh-TW.md +119 -119
- package/docs/api-reference-transaction-helpers.zh.md +153 -153
- package/docs/api-reference.ja.md +6 -6
- package/docs/api-reference.zh-TW.md +5 -5
- package/docs/api-reference.zh.md +8 -8
- package/docs/core-concepts-client-architecture.ja.md +26 -26
- package/docs/core-concepts-client-architecture.zh-TW.md +34 -34
- package/docs/core-concepts-client-architecture.zh.md +26 -26
- package/docs/core-concepts-event-subscriptions.ja.md +29 -29
- package/docs/core-concepts-event-subscriptions.zh-TW.md +23 -23
- package/docs/core-concepts-event-subscriptions.zh.md +29 -29
- package/docs/core-concepts-gas-payment.ja.md +27 -27
- package/docs/core-concepts-gas-payment.zh-TW.md +28 -28
- package/docs/core-concepts-gas-payment.zh.md +32 -32
- package/docs/core-concepts-transaction-lifecycle.ja.md +40 -40
- package/docs/core-concepts-transaction-lifecycle.zh-TW.md +43 -43
- package/docs/core-concepts-transaction-lifecycle.zh.md +49 -49
- package/docs/core-concepts.ja.md +7 -7
- package/docs/core-concepts.zh-TW.md +6 -6
- package/docs/core-concepts.zh.md +7 -7
- package/docs/getting-started-basic-usage.ja.md +24 -24
- package/docs/getting-started-basic-usage.zh-TW.md +28 -28
- package/docs/getting-started-basic-usage.zh.md +24 -24
- package/docs/getting-started-installation.ja.md +13 -13
- package/docs/getting-started-installation.zh-TW.md +9 -9
- package/docs/getting-started-installation.zh.md +15 -15
- package/docs/getting-started.ja.md +5 -5
- package/docs/getting-started.zh-TW.md +6 -6
- package/docs/getting-started.zh.md +6 -7
- package/docs/how-to-guides-delegate-permissions.ja.md +21 -21
- package/docs/how-to-guides-delegate-permissions.zh-TW.md +20 -21
- package/docs/how-to-guides-delegate-permissions.zh.md +18 -18
- package/docs/how-to-guides-manage-accounts.ja.md +21 -21
- package/docs/how-to-guides-manage-accounts.zh-TW.md +23 -23
- package/docs/how-to-guides-manage-accounts.zh.md +17 -17
- package/docs/how-to-guides-manage-assets.ja.md +137 -60
- package/docs/how-to-guides-manage-assets.md +77 -0
- package/docs/how-to-guides-manage-assets.zh-TW.md +116 -39
- package/docs/how-to-guides-manage-assets.zh.md +142 -65
- package/docs/how-to-guides-manage-tokens.ja.md +47 -47
- package/docs/how-to-guides-manage-tokens.zh-TW.md +49 -49
- package/docs/how-to-guides-manage-tokens.zh.md +34 -34
- package/docs/how-to-guides-stake-tokens-and-assets.ja.md +56 -56
- package/docs/how-to-guides-stake-tokens-and-assets.zh-TW.md +55 -55
- package/docs/how-to-guides-stake-tokens-and-assets.zh.md +51 -51
- package/docs/how-to-guides-transfer-tokens-and-nfts.ja.md +45 -45
- package/docs/how-to-guides-transfer-tokens-and-nfts.zh-TW.md +46 -46
- package/docs/how-to-guides-transfer-tokens-and-nfts.zh.md +37 -37
- package/docs/how-to-guides.ja.md +8 -8
- package/docs/how-to-guides.zh-TW.md +4 -4
- package/docs/how-to-guides.zh.md +6 -6
- package/docs/overview.ja.md +15 -15
- package/docs/overview.zh-TW.md +14 -14
- package/docs/overview.zh.md +12 -12
- package/lib/base.js +2 -2
- package/lib/base.js.map +1 -1
- package/lib/extension.js +4 -4
- package/lib/extension.js.map +1 -1
- package/package.json +16 -16
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 辅助方法
|
|
2
2
|
|
|
3
|
-
`GraphQLClient`
|
|
3
|
+
`GraphQLClient` 类是与 OCAP 驱动的区块链进行交互的主要接口。它提供了一套全面的方法,用于查询链状态、发送交易以及订阅实时事件。它被设计为可以在 Node.js 和浏览器环境中无缝工作。
|
|
4
4
|
|
|
5
5
|
```javascript Client Initialization icon=logos:javascript
|
|
6
6
|
const GraphQLClient = require('@ocap/client');
|
|
@@ -10,26 +10,26 @@ const client = new GraphQLClient('https://beta.abtnetwork.io/api');
|
|
|
10
10
|
|
|
11
11
|
(async () => {
|
|
12
12
|
const res = await client.getChainInfo();
|
|
13
|
-
console.log('
|
|
13
|
+
console.log('Connected to chain:', res.info.network);
|
|
14
14
|
})();
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
本节为 `GraphQLClient` 类的核心辅助方法提供了详细的参考。
|
|
18
18
|
|
|
19
19
|
## 构造函数
|
|
20
20
|
|
|
21
21
|
### new GraphQLClient(endpoint, autoInit)
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
创建一个 `GraphQLClient` 的新实例。
|
|
24
24
|
|
|
25
25
|
**参数**
|
|
26
26
|
|
|
27
27
|
<x-field-group>
|
|
28
28
|
<x-field data-name="endpoint" data-type="string" data-required="true">
|
|
29
|
-
<x-field-desc markdown>区块链节点的 GraphQL 端点的绝对 URL
|
|
29
|
+
<x-field-desc markdown>区块链节点的 GraphQL 端点的绝对 URL(例如 `https://beta.abtnetwork.io/api`)。</x-field-desc>
|
|
30
30
|
</x-field>
|
|
31
31
|
<x-field data-name="autoInit" data-type="boolean" data-default="true" data-required="false">
|
|
32
|
-
<x-field-desc markdown>如果为 `true
|
|
32
|
+
<x-field-desc markdown>如果为 `true`,客户端将在初始化时自动获取并缓存关键的链信息(“上下文”)。对于大多数用例,建议使用此设置。</x-field-desc>
|
|
33
33
|
</x-field>
|
|
34
34
|
</x-field-group>
|
|
35
35
|
|
|
@@ -43,15 +43,15 @@ const client = new GraphQLClient('https://beta.abtnetwork.io/api', true);
|
|
|
43
43
|
|
|
44
44
|
## 核心方法
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
这些方法提供了与客户端和链进行交互的基本功能。
|
|
47
47
|
|
|
48
48
|
### getContext()
|
|
49
49
|
|
|
50
|
-
获取并缓存关键的链信息,例如链 ID
|
|
50
|
+
获取并缓存关键的链信息,例如链 ID、原生代币详情和交易费用配置。如果在构造函数中启用了 `autoInit`,此方法会自动调用。后续调用将返回缓存的上下文。
|
|
51
51
|
|
|
52
52
|
**返回**
|
|
53
53
|
|
|
54
|
-
<x-field data-name="Promise<object>" data-type="object" data-desc="一个解析为包含链元数据的上下文对象的
|
|
54
|
+
<x-field data-name="Promise<object>" data-type="object" data-desc="一个解析为包含链元数据的上下文对象的 promise。">
|
|
55
55
|
<x-field data-name="chainId" data-type="string" data-desc="区块链网络的唯一标识符。"></x-field>
|
|
56
56
|
<x-field data-name="consensus" data-type="string" data-desc="共识引擎版本。"></x-field>
|
|
57
57
|
<x-field data-name="token" data-type="object" data-desc="关于原生代币的信息。">
|
|
@@ -59,7 +59,7 @@ const client = new GraphQLClient('https://beta.abtnetwork.io/api', true);
|
|
|
59
59
|
<x-field data-name="decimal" data-type="number" data-desc="原生代币的小数位数。"></x-field>
|
|
60
60
|
<x-field data-name="symbol" data-type="string" data-desc="原生代币的符号(例如,TBA)。"></x-field>
|
|
61
61
|
</x-field>
|
|
62
|
-
<x-field data-name="txConfig" data-type="object" data-desc="
|
|
62
|
+
<x-field data-name="txConfig" data-type="object" data-desc="交易费用和 gas 配置。"></x-field>
|
|
63
63
|
</x-field>
|
|
64
64
|
|
|
65
65
|
**示例**
|
|
@@ -67,7 +67,7 @@ const client = new GraphQLClient('https://beta.abtnetwork.io/api', true);
|
|
|
67
67
|
```javascript Fetching Chain Context icon=logos:javascript
|
|
68
68
|
async function logChainToken() {
|
|
69
69
|
const context = await client.getContext();
|
|
70
|
-
console.log(
|
|
70
|
+
console.log(`Native Token Symbol: ${context.token.symbol}`);
|
|
71
71
|
}
|
|
72
72
|
|
|
73
73
|
logChainToken();
|
|
@@ -75,12 +75,12 @@ logChainToken();
|
|
|
75
75
|
|
|
76
76
|
### setGasPayer(wallet)
|
|
77
77
|
|
|
78
|
-
配置一个钱包作为“gas
|
|
78
|
+
配置一个钱包作为“gas 支付者”。设置后,该钱包将赞助通过此客户端实例发送的交易的交易费用,从而为用户提供无 gas 体验。更多详情,请参见 [Gas 支付](./core-concepts-gas-payment.md) 概念指南。
|
|
79
79
|
|
|
80
80
|
**参数**
|
|
81
81
|
|
|
82
82
|
<x-field data-name="wallet" data-type="WalletObject" data-required="true">
|
|
83
|
-
<x-field-desc markdown
|
|
83
|
+
<x-field-desc markdown>一个钱包对象,具有 `address`、`publicKey` 和 `secretKey` 属性,并配备一个 `sign` 方法。</x-field-desc>
|
|
84
84
|
</x-field>
|
|
85
85
|
|
|
86
86
|
### decodeTx(input)
|
|
@@ -99,11 +99,11 @@ logChainToken();
|
|
|
99
99
|
|
|
100
100
|
### getType(name)
|
|
101
101
|
|
|
102
|
-
|
|
102
|
+
检索给定类型名称的 Protobuf 消息类。这在需要手动构建或检查 Protobuf 消息的高级场景中很有用。
|
|
103
103
|
|
|
104
104
|
**参数**
|
|
105
105
|
|
|
106
|
-
<x-field data-name="name" data-type="string" data-required="true" data-desc="Protobuf 消息类型的名称(例如,'Transaction'
|
|
106
|
+
<x-field data-name="name" data-type="string" data-required="true" data-desc="Protobuf 消息类型的名称(例如,'Transaction', 'TransferTx')。"></x-field>
|
|
107
107
|
|
|
108
108
|
**返回**
|
|
109
109
|
|
|
@@ -113,17 +113,17 @@ logChainToken();
|
|
|
113
113
|
|
|
114
114
|
## 事件订阅
|
|
115
115
|
|
|
116
|
-
客户端支持通过 WebSocket
|
|
116
|
+
客户端支持通过 WebSocket 进行实时事件订阅,使您的应用程序能够对链上事件做出即时反应。
|
|
117
117
|
|
|
118
118
|
### subscribe(topic, callback)
|
|
119
119
|
|
|
120
|
-
|
|
120
|
+
建立 WebSocket 连接并订阅特定的事件主题。
|
|
121
121
|
|
|
122
122
|
**参数**
|
|
123
123
|
|
|
124
124
|
<x-field-group>
|
|
125
|
-
<x-field data-name="topic" data-type="string" data-required="true" data-desc="要订阅的事件主题(例如,'newBlock'
|
|
126
|
-
<x-field data-name="callback" data-type="function" data-required="true" data-desc="
|
|
125
|
+
<x-field data-name="topic" data-type="string" data-required="true" data-desc="要订阅的事件主题(例如,'newBlock', 'tx:transfer')。"></x-field>
|
|
126
|
+
<x-field data-name="callback" data-type="function" data-required="true" data-desc="接收到事件时执行的函数。它接收事件的有效载荷作为其唯一参数。"></x-field>
|
|
127
127
|
</x-field-group>
|
|
128
128
|
|
|
129
129
|
### unsubscribe(topic, callback)
|
|
@@ -141,22 +141,22 @@ logChainToken();
|
|
|
141
141
|
|
|
142
142
|
```javascript Subscribing to New Blocks icon=logos:javascript
|
|
143
143
|
const handleNewBlock = (block) => {
|
|
144
|
-
console.log(
|
|
144
|
+
console.log(`New block received! Height: ${block.height}`);
|
|
145
145
|
|
|
146
146
|
// 接收到一个区块后取消订阅
|
|
147
147
|
client.unsubscribe('newBlock', handleNewBlock);
|
|
148
|
-
console.log('
|
|
148
|
+
console.log('Unsubscribed from newBlock events.');
|
|
149
149
|
};
|
|
150
150
|
|
|
151
151
|
client.subscribe('newBlock', handleNewBlock);
|
|
152
|
-
console.log('
|
|
152
|
+
console.log('Subscribed to newBlock events...');
|
|
153
153
|
```
|
|
154
154
|
|
|
155
155
|
---
|
|
156
156
|
|
|
157
|
-
##
|
|
157
|
+
## Token 工具方法
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
这些辅助方法简化了人类可读的 token 数量与链上基本单位表示之间的转换。
|
|
160
160
|
|
|
161
161
|
### fromUnitToToken(value)
|
|
162
162
|
|
|
@@ -168,7 +168,7 @@ console.log('已订阅 newBlock 事件...');
|
|
|
168
168
|
|
|
169
169
|
**返回**
|
|
170
170
|
|
|
171
|
-
<x-field data-name="string" data-type="string" data-desc="
|
|
171
|
+
<x-field data-name="string" data-type="string" data-desc="以标准 token 单位表示的数量。"></x-field>
|
|
172
172
|
|
|
173
173
|
### fromTokenToUnit(amount)
|
|
174
174
|
|
|
@@ -176,11 +176,11 @@ console.log('已订阅 newBlock 事件...');
|
|
|
176
176
|
|
|
177
177
|
**参数**
|
|
178
178
|
|
|
179
|
-
<x-field data-name="amount" data-type="number | string" data-required="true" data-desc="
|
|
179
|
+
<x-field data-name="amount" data-type="number | string" data-required="true" data-desc="以标准十进制形式表示的 token 数量。"></x-field>
|
|
180
180
|
|
|
181
181
|
**返回**
|
|
182
182
|
|
|
183
|
-
<x-field data-name="BN" data-type="object" data-desc="
|
|
183
|
+
<x-field data-name="BN" data-type="object" data-desc="一个表示链基本单位值的 BN.js 实例。"></x-field>
|
|
184
184
|
|
|
185
185
|
**示例**
|
|
186
186
|
|
|
@@ -188,11 +188,11 @@ console.log('已订阅 newBlock 事件...');
|
|
|
188
188
|
async function convertToken() {
|
|
189
189
|
// 将 100 TBA 转换为其基本单位
|
|
190
190
|
const unitAmount = await client.fromTokenToUnit(100);
|
|
191
|
-
console.log(`100 TBA
|
|
191
|
+
console.log(`100 TBA is ${unitAmount.toString()} in base units.`);
|
|
192
192
|
|
|
193
|
-
//
|
|
193
|
+
// 再转换回来
|
|
194
194
|
const tokenAmount = await client.fromUnitToToken(unitAmount.toString());
|
|
195
|
-
console.log(`${unitAmount.toString()}
|
|
195
|
+
console.log(`${unitAmount.toString()} base units is ${tokenAmount} TBA.`);
|
|
196
196
|
}
|
|
197
197
|
|
|
198
198
|
convertToken();
|
|
@@ -202,7 +202,7 @@ convertToken();
|
|
|
202
202
|
|
|
203
203
|
## 方法发现
|
|
204
204
|
|
|
205
|
-
|
|
205
|
+
客户端为所连接的 OCAP 节点支持的每种交易类型动态生成方法。这些发现方法允许您以编程方式列出所有可用的与交易相关的函数。
|
|
206
206
|
|
|
207
207
|
### getTxSendMethods()
|
|
208
208
|
|
|
@@ -210,7 +210,7 @@ convertToken();
|
|
|
210
210
|
|
|
211
211
|
### getTxEncodeMethods()
|
|
212
212
|
|
|
213
|
-
返回所有可用的 `encode...Tx`
|
|
213
|
+
返回所有可用的 `encode...Tx` 方法名称的数组。这些方法将交易准备并序列化为缓冲区,但不对其进行签名。
|
|
214
214
|
|
|
215
215
|
### getTxSignMethods()
|
|
216
216
|
|
|
@@ -224,6 +224,6 @@ convertToken();
|
|
|
224
224
|
|
|
225
225
|
```javascript Listing Available Transaction Methods icon=logos:javascript
|
|
226
226
|
const sendMethods = client.getTxSendMethods();
|
|
227
|
-
console.log('
|
|
227
|
+
console.log('Available send methods:', sendMethods);
|
|
228
228
|
// 示例输出:[ 'sendPokeTx', 'sendTransferTx', ... ]
|
|
229
|
-
```
|
|
229
|
+
```
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
# データ型
|
|
2
2
|
|
|
3
|
-
このセクションでは、OCAP Client API
|
|
3
|
+
このセクションでは、OCAP Client API全体で使用されるすべてのカスタムデータ構造、入力パラメータ、および応答オブジェクトに関する包括的なリファレンスを提供します。これらの型を理解することは、OCAPブロックチェーンと効果的に対話するために不可欠です。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## コアタイプ
|
|
6
6
|
|
|
7
|
-
これらは、さまざまなAPI
|
|
7
|
+
これらは、さまざまなAPIコールで使用される基本的なデータ構造です。
|
|
8
8
|
|
|
9
9
|
### Any
|
|
10
10
|
|
|
11
11
|
protobufメッセージ用の汎用コンテナで、柔軟なデータ構造を可能にします。
|
|
12
12
|
|
|
13
13
|
<x-field-group>
|
|
14
|
-
<x-field data-name="typeUrl" data-type="string" data-desc="シリアル化されたメッセージの型を一意に識別するURL
|
|
15
|
-
<x-field data-name="value" data-type="string" data-desc="
|
|
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
16
|
</x-field-group>
|
|
17
17
|
|
|
18
18
|
### Multisig
|
|
@@ -23,7 +23,7 @@ protobufメッセージ用の汎用コンテナで、柔軟なデータ構造を
|
|
|
23
23
|
<x-field data-name="signer" data-type="string" data-desc="署名者のアドレス。"></x-field>
|
|
24
24
|
<x-field data-name="pk" data-type="string" data-desc="署名者の公開鍵。"></x-field>
|
|
25
25
|
<x-field data-name="signature" data-type="string" data-desc="署名者によって生成された署名。"></x-field>
|
|
26
|
-
<x-field data-name="delegator" data-type="string" data-desc="
|
|
26
|
+
<x-field data-name="delegator" data-type="string" data-desc="署名が委任されている場合の委任者のアドレス。"></x-field>
|
|
27
27
|
<x-field data-name="data" data-type="Any" data-desc="署名に関連付けられた任意のオプションデータ。"></x-field>
|
|
28
28
|
</x-field-group>
|
|
29
29
|
|
|
@@ -39,18 +39,18 @@ protobufメッセージ用の汎用コンテナで、柔軟なデータ構造を
|
|
|
39
39
|
|
|
40
40
|
### StateContext
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
ステートオブジェクトの作成と最終更新に関するコンテキストを提供します。
|
|
43
43
|
|
|
44
44
|
<x-field-group>
|
|
45
|
-
<x-field data-name="genesisTx" data-type="TransactionInfo" data-desc="
|
|
46
|
-
<x-field data-name="renaissanceTx" data-type="TransactionInfo" data-desc="
|
|
47
|
-
<x-field data-name="genesisTime" data-type="string" data-desc="
|
|
48
|
-
<x-field data-name="renaissanceTime" data-type="string" data-desc="
|
|
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
49
|
</x-field-group>
|
|
50
50
|
|
|
51
51
|
### ウォレットオブジェクト
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
これらの型は、トランザクション署名に使用されるウォレットの構造を定義します。
|
|
54
54
|
|
|
55
55
|
#### WalletObject
|
|
56
56
|
|
|
@@ -78,9 +78,9 @@ protobufメッセージ用の汎用コンテナで、柔軟なデータ構造を
|
|
|
78
78
|
<x-field data-name="role" data-type="RoleType"></x-field>
|
|
79
79
|
</x-field-group>
|
|
80
80
|
|
|
81
|
-
##
|
|
81
|
+
## 入力およびフィルタータイプ
|
|
82
82
|
|
|
83
|
-
これらのオブジェクトは、GraphQL
|
|
83
|
+
これらのオブジェクトは、GraphQLクエリのパラメータとフィルターを提供するために使用されます。
|
|
84
84
|
|
|
85
85
|
### 一般的なフィルター入力
|
|
86
86
|
|
|
@@ -199,7 +199,7 @@ protobufメッセージ用の汎用コンテナで、柔軟なデータ構造を
|
|
|
199
199
|
</x-field>
|
|
200
200
|
</x-field-group>
|
|
201
201
|
|
|
202
|
-
##
|
|
202
|
+
## ステートオブジェクト
|
|
203
203
|
|
|
204
204
|
これらの型は、アカウント、アセット、トークンなど、ブロックチェーン上のさまざまなエンティティの状態を表します。
|
|
205
205
|
|
|
@@ -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>
|
|
@@ -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>
|
|
@@ -347,7 +347,7 @@ protobufメッセージ用の汎用コンテナで、柔軟なデータ構造を
|
|
|
347
347
|
|
|
348
348
|
## トランザクションペイロード(ITX)
|
|
349
349
|
|
|
350
|
-
|
|
350
|
+
これらの型は、さまざまなトランザクションタイプに対する `itx` (内部トランザクション) オブジェクトを定義します。
|
|
351
351
|
|
|
352
352
|
### AccountMigrateTx
|
|
353
353
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# 資料類型
|
|
2
2
|
|
|
3
|
-
本節為整個 OCAP Client API
|
|
3
|
+
本節為整個 OCAP Client API 中使用的所有自訂資料結構、輸入參數和回應物件提供了全面的參考。理解這些類型對於有效與 OCAP 區塊鏈互動至關重要。
|
|
4
4
|
|
|
5
5
|
## 核心類型
|
|
6
6
|
|
|
7
|
-
這些是在各種 API
|
|
7
|
+
這些是在各種 API 呼叫中使用的基礎資料結構。
|
|
8
8
|
|
|
9
9
|
### Any
|
|
10
10
|
|
|
@@ -12,19 +12,19 @@
|
|
|
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>
|
|
24
24
|
<x-field data-name="pk" data-type="string" data-desc="簽署者的公鑰。"></x-field>
|
|
25
|
-
<x-field data-name="signature" data-type="string" data-desc="
|
|
26
|
-
<x-field data-name="delegator" data-type="string" data-desc="
|
|
27
|
-
<x-field data-name="data" data-type="Any" data-desc="
|
|
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
28
|
</x-field-group>
|
|
29
29
|
|
|
30
30
|
### PageInfo
|
|
@@ -32,20 +32,20 @@
|
|
|
32
32
|
包含基於列表的查詢回應的分頁詳細資訊。
|
|
33
33
|
|
|
34
34
|
<x-field-group>
|
|
35
|
-
<x-field data-name="cursor" data-type="string" data-desc="
|
|
35
|
+
<x-field data-name="cursor" data-type="string" data-desc="用於取得下一頁結果的游標。"></x-field>
|
|
36
36
|
<x-field data-name="next" data-type="boolean" data-desc="指示是否有下一頁結果可用。"></x-field>
|
|
37
|
-
<x-field data-name="total" data-type="number" data-desc="
|
|
37
|
+
<x-field data-name="total" data-type="number" data-desc="符合查詢的項目總數。"></x-field>
|
|
38
38
|
</x-field-group>
|
|
39
39
|
|
|
40
40
|
### StateContext
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
提供有關狀態物件的建立和最後修改的上下文資訊。
|
|
43
43
|
|
|
44
44
|
<x-field-group>
|
|
45
45
|
<x-field data-name="genesisTx" data-type="TransactionInfo" data-desc="建立此狀態物件的交易。"></x-field>
|
|
46
|
-
<x-field data-name="renaissanceTx" data-type="TransactionInfo" data-desc="
|
|
46
|
+
<x-field data-name="renaissanceTx" data-type="TransactionInfo" data-desc="最後更新此狀態物件的交易。"></x-field>
|
|
47
47
|
<x-field data-name="genesisTime" data-type="string" data-desc="狀態物件建立時的時間戳。"></x-field>
|
|
48
|
-
<x-field data-name="renaissanceTime" data-type="string" data-desc="
|
|
48
|
+
<x-field data-name="renaissanceTime" data-type="string" data-desc="狀態物件最後更新時的時間戳。"></x-field>
|
|
49
49
|
</x-field-group>
|
|
50
50
|
|
|
51
51
|
### 錢包物件
|
|
@@ -154,7 +154,7 @@
|
|
|
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,7 +201,7 @@
|
|
|
201
201
|
|
|
202
202
|
## 狀態物件
|
|
203
203
|
|
|
204
|
-
|
|
204
|
+
這些類型表示區塊鏈上各種實體(如帳戶、資產和代幣)的狀態。
|
|
205
205
|
|
|
206
206
|
### AccountState
|
|
207
207
|
|
|
@@ -227,7 +227,7 @@
|
|
|
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>
|
|
@@ -347,7 +347,7 @@
|
|
|
347
347
|
|
|
348
348
|
## 交易負載 (ITX)
|
|
349
349
|
|
|
350
|
-
|
|
350
|
+
這些類型為各種交易類型定義了 `itx`(內部交易)物件。
|
|
351
351
|
|
|
352
352
|
### AccountMigrateTx
|
|
353
353
|
|
|
@@ -429,7 +429,7 @@
|
|
|
429
429
|
|
|
430
430
|
## 回應封裝器
|
|
431
431
|
|
|
432
|
-
這些類型是 API
|
|
432
|
+
這些類型是 API 查詢返回的頂層物件,包含一個狀態碼和請求的資料。
|
|
433
433
|
|
|
434
434
|
### ResponseGetAccountState
|
|
435
435
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 数据类型
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
本节为 OCAP 客户端 API 中使用的所有自定义数据结构、输入参数和响应对象提供了全面的参考。理解这些类型对于有效与 OCAP 区块链交互至关重要。
|
|
4
4
|
|
|
5
5
|
## 核心类型
|
|
6
6
|
|
|
@@ -8,28 +8,28 @@
|
|
|
8
8
|
|
|
9
9
|
### Any
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Protobuf 消息的通用容器,允许灵活的数据结构。
|
|
12
12
|
|
|
13
13
|
<x-field-group>
|
|
14
|
-
<x-field data-name="typeUrl" data-type="string" data-desc="一个类似 URL
|
|
15
|
-
<x-field data-name="value" data-type="string" data-desc="
|
|
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
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>
|
|
24
24
|
<x-field data-name="pk" data-type="string" data-desc="签名者的公钥。"></x-field>
|
|
25
|
-
<x-field data-name="signature" data-type="string" data-desc="
|
|
26
|
-
<x-field data-name="delegator" data-type="string" data-desc="
|
|
27
|
-
<x-field data-name="data" data-type="Any" data-desc="
|
|
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
28
|
</x-field-group>
|
|
29
29
|
|
|
30
30
|
### PageInfo
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
包含基于列表的查询响应的分页详情。
|
|
33
33
|
|
|
34
34
|
<x-field-group>
|
|
35
35
|
<x-field data-name="cursor" data-type="string" data-desc="用于获取下一页结果的游标。"></x-field>
|
|
@@ -39,16 +39,16 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
39
39
|
|
|
40
40
|
### StateContext
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
提供关于状态对象的创建和最后修改的上下文信息。
|
|
43
43
|
|
|
44
44
|
<x-field-group>
|
|
45
45
|
<x-field data-name="genesisTx" data-type="TransactionInfo" data-desc="创建此状态对象的交易。"></x-field>
|
|
46
|
-
<x-field data-name="renaissanceTx" data-type="TransactionInfo" data-desc="
|
|
47
|
-
<x-field data-name="genesisTime" data-type="string" data-desc="
|
|
48
|
-
<x-field data-name="renaissanceTime" data-type="string" data-desc="
|
|
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
49
|
</x-field-group>
|
|
50
50
|
|
|
51
|
-
###
|
|
51
|
+
### 钱包对象
|
|
52
52
|
|
|
53
53
|
这些类型定义了用于签署交易的钱包的结构。
|
|
54
54
|
|
|
@@ -154,9 +154,9 @@ 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
|
|
|
161
161
|
<x-field-group>
|
|
162
162
|
<x-field data-name="RequestEstimateGasInput" data-type="object">
|
|
@@ -201,7 +201,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
201
201
|
|
|
202
202
|
## 状态对象
|
|
203
203
|
|
|
204
|
-
|
|
204
|
+
这些类型表示区块链上各种实体(如账户、资产和通证)的状态。
|
|
205
205
|
|
|
206
206
|
### AccountState
|
|
207
207
|
|
|
@@ -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>
|
|
@@ -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>
|
|
@@ -347,7 +347,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
347
347
|
|
|
348
348
|
## 交易负载 (ITX)
|
|
349
349
|
|
|
350
|
-
|
|
350
|
+
这些类型定义了各种交易类型的 `itx` (内部交易) 对象。
|
|
351
351
|
|
|
352
352
|
### AccountMigrateTx
|
|
353
353
|
|
|
@@ -429,7 +429,7 @@ protobuf 消息的通用容器,允许灵活的数据结构。
|
|
|
429
429
|
|
|
430
430
|
## 响应包装器
|
|
431
431
|
|
|
432
|
-
|
|
432
|
+
这些类型是由 API 查询返回的顶层对象,包含一个状态码和请求的数据。
|
|
433
433
|
|
|
434
434
|
### ResponseGetAccountState
|
|
435
435
|
|