@ocap/client 1.25.4 → 1.25.6
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
package/docs/core-concepts.zh.md
CHANGED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
# 核心概念
|
|
2
2
|
|
|
3
|
-
本节深入探讨了构成 OCAP Client
|
|
3
|
+
本节深入探讨了构成 OCAP Client 库的基本原则和架构决策。理解这些核心概念将帮助您充分发挥该库的潜力,编写更高效的代码,并更有效地解决问题。
|
|
4
4
|
|
|
5
|
-
[操作指南](./how-to-guides.md)
|
|
5
|
+
虽然[操作指南](./how-to-guides.md)为特定任务提供了分步说明,但本节解释了“如何做”背后的“为什么”。我们将探讨客户端的结构、交易从开始到结束的处理过程、如何监听实时事件以及如何创建无 Gas 费用的用户体验。
|
|
6
6
|
|
|
7
7
|
<x-cards data-columns="2">
|
|
8
8
|
<x-card data-title="客户端架构" data-icon="lucide:architecture" data-href="/core-concepts/client-architecture">
|
|
9
9
|
了解不同的客户端实现(Node、Browser、Lite),以及如何为您的环境选择合适的实现以优化性能和包大小。
|
|
10
10
|
</x-card>
|
|
11
11
|
<x-card data-title="交易生命周期" data-icon="lucide:refresh-cw" data-href="/core-concepts/transaction-lifecycle">
|
|
12
|
-
|
|
12
|
+
追踪一笔交易从简单的 JavaScript 对象到链上确认块的全过程,包括创建、编码、签名和广播。
|
|
13
13
|
</x-card>
|
|
14
14
|
<x-card data-title="事件订阅" data-icon="lucide:radio-tower" data-href="/core-concepts/event-subscriptions">
|
|
15
|
-
了解如何使用基于 WebSocket
|
|
15
|
+
了解如何使用基于 WebSocket 的订阅功能来监听链上实时事件,从而实现动态和响应迅速的应用程序。
|
|
16
16
|
</x-card>
|
|
17
17
|
<x-card data-title="Gas 费支付" data-icon="lucide:gas-pump" data-href="/core-concepts/gas-payment">
|
|
18
|
-
探索强大的 Gas
|
|
18
|
+
探索强大的 Gas 费支付功能,该功能允许指定钱包为用户代付交易费用,从而创造无缝、无需 Gas 费的体验。
|
|
19
19
|
</x-card>
|
|
20
20
|
</x-cards>
|
|
21
21
|
|
|
22
|
-
通过掌握这些基础主题,您将能够使用 OCAP Client
|
|
22
|
+
通过掌握这些基础主题,您将能够使用 OCAP Client 构建稳健、可扩展且用户友好的应用程序。
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# 基本的な使い方
|
|
2
|
+
|
|
3
|
+
このガイドでは、OCAP Clientを使い始めるための基本的な手順を説明します。クライアントの初期化、ArcBlock Beta Chainへの接続、そしてすべてが正しく設定されていることを確認するための基本的なクエリの実行方法を学びます。
|
|
4
|
+
|
|
5
|
+
このガイドに従うことで、わずか数分でブロックチェーンと対話する準備が整ったクライアントインスタンスを稼働させることができます。
|
|
6
|
+
|
|
7
|
+
## 1. クライアントの初期化
|
|
8
|
+
|
|
9
|
+
まず、`@ocap/client` パッケージをインポートし、`GraphQLClient` のインスタンスを作成する必要があります。コンストラクタには、接続したいブロックチェーンノードのGraphQLエンドポイントを渡します。このガイドでは、ArcBlock Beta Chainの公開エンドポイントを使用します。
|
|
10
|
+
|
|
11
|
+
```javascript Initialize Client icon=logos:javascript
|
|
12
|
+
const GraphQLClient = require('@ocap/client');
|
|
13
|
+
|
|
14
|
+
// Beta Chainに接続
|
|
15
|
+
const client = new GraphQLClient('https://beta.abtnetwork.io/api');
|
|
16
|
+
|
|
17
|
+
console.log('OCAP Clientが初期化されました!');
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
これにより、チェーンのクエリ、トランザクションの送信などのメソッドが事前設定されたクライアントインスタンスが作成されます。
|
|
21
|
+
|
|
22
|
+
## 2. ブロックチェーンのクエリ
|
|
23
|
+
|
|
24
|
+
クライアントが初期化されたので、簡単な読み取り専用操作を実行して接続を確認できます。`getChainInfo` メソッドは、接続されたブロックチェーンに関する基本情報を取得し、認証を必要としないため、この目的に最適です。
|
|
25
|
+
|
|
26
|
+
```javascript Query Chain Info icon=logos:javascript
|
|
27
|
+
(async () => {
|
|
28
|
+
try {
|
|
29
|
+
const { info } = await client.getChainInfo();
|
|
30
|
+
console.log('チェーン情報:', info);
|
|
31
|
+
} catch (error) {
|
|
32
|
+
console.error('チェーン情報の取得に失敗しました:', error);
|
|
33
|
+
}
|
|
34
|
+
})();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
リクエストが成功すると、`info` オブジェクトがコンソールに出力されます。これには、チェーンのID、ネットワーク、サポートされているトランザクションタイプなどの詳細が含まれます。これにより、クライアントがブロックチェーンノードと正常に通信していることが確認できます。
|
|
38
|
+
|
|
39
|
+
## 3. アカウントの準備
|
|
40
|
+
|
|
41
|
+
トランザクション(書き込み操作)を送信するには、ウォレットが必要です。ローカルで新しいウォレットを生成できます。このウォレットは、オンチェーンでのアカウントIDを表します。
|
|
42
|
+
|
|
43
|
+
```javascript Create a Wallet icon=logos:javascript
|
|
44
|
+
const { fromRandom } = require('@ocap/wallet');
|
|
45
|
+
|
|
46
|
+
// 新しいランダムなウォレットを作成
|
|
47
|
+
const wallet = fromRandom();
|
|
48
|
+
|
|
49
|
+
console.log('新しいウォレットが作成されました:');
|
|
50
|
+
console.log('アドレス:', wallet.address);
|
|
51
|
+
console.log('公開鍵:', wallet.publicKey);
|
|
52
|
+
console.log('秘密鍵:', wallet.secretKey);
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**重要:** 新しく生成されたウォレットは単なるキーペアであり、まだブロックチェーン上には存在しません。アカウントは、そのアドレスが最初の受信トランザクションを受け取ったときに、オンチェーンで自動的に作成されます。
|
|
56
|
+
|
|
57
|
+
新しいアカウントを有効にするには、テストトークンで資金を供給する必要があります。公式フォーセットからBeta Chain用の無料テストトークン(`TBA`)を入手できます:
|
|
58
|
+
|
|
59
|
+
<x-card data-title="ArcBlockフォーセット" data-icon="lucide:droplet" data-href="https://faucet.abtnetwork.io/" data-cta="テストトークンを取得">
|
|
60
|
+
フォーセットにアクセスし、新しく生成したアドレスにTBAを送信して有効化してください。
|
|
61
|
+
</x-card>
|
|
62
|
+
|
|
63
|
+
## 4. アカウント状態のクエリ
|
|
64
|
+
|
|
65
|
+
フォーセットを使って新しいアカウントに資金を入金したら、その状態をクエリして残高を確認できます。
|
|
66
|
+
|
|
67
|
+
```javascript Query Account State icon=logos:javascript
|
|
68
|
+
(async () => {
|
|
69
|
+
try {
|
|
70
|
+
// フォーセットから資金供給したアドレスに置き換えてください
|
|
71
|
+
const address = wallet.address;
|
|
72
|
+
|
|
73
|
+
const { state } = await client.getAccountState({ address });
|
|
74
|
+
console.log('アカウント状態:', state);
|
|
75
|
+
} catch (error) {
|
|
76
|
+
console.error('アカウント状態の取得に失敗しました:', error);
|
|
77
|
+
}
|
|
78
|
+
})();
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
レスポンスの `state` オブジェクトには、アカウントのアドレス、残高、ナンス(送信されたトランザクション数)、その他の詳細が含まれます。残高がゼロでないことを確認できれば、アカウントがフォーセットからトークンを受け取り、ブロックチェーン上で有効になったことが確定します。
|
|
82
|
+
|
|
83
|
+
## 次のステップ
|
|
84
|
+
|
|
85
|
+
これでOCAP Clientのセットアップ、ブロックチェーンへの接続、アカウントの確認が正常に完了しました。より高度な操作に進む準備が整いました。
|
|
86
|
+
|
|
87
|
+
トークンの転送、アセットの管理などの一般的なタスクを実行する方法については、[ハウツーガイド](./how-to-guides.md)をご覧ください。
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# 基本用法
|
|
2
|
+
|
|
3
|
+
本指南將引導您完成開始使用 OCAP Client 的基本步驟。您將學習如何初始化客戶端、連接到 ArcBlock Beta Chain,並執行基本查詢以確保一切設定正確。
|
|
4
|
+
|
|
5
|
+
遵循本指南,您應可在幾分鐘內擁有一個可運作的客戶端實例,準備好與區塊鏈進行互動。
|
|
6
|
+
|
|
7
|
+
## 1. 初始化客戶端
|
|
8
|
+
|
|
9
|
+
首先,您需要匯入 `@ocap/client` 套件並建立一個 `GraphQLClient` 的實例。建構函式需要傳入您想連接的區塊鏈節點的 GraphQL 端點。在本指南中,我們將使用 ArcBlock Beta Chain 的公共端點。
|
|
10
|
+
|
|
11
|
+
```javascript Initialize Client icon=logos:javascript
|
|
12
|
+
const GraphQLClient = require('@ocap/client');
|
|
13
|
+
|
|
14
|
+
// 連接到 Beta Chain
|
|
15
|
+
const client = new GraphQLClient('https://beta.abtnetwork.io/api');
|
|
16
|
+
|
|
17
|
+
console.log('OCAP Client 初始化完成!');
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
這會建立一個客戶端實例,該實例已預先配置了查詢鏈、發送交易等方法。
|
|
21
|
+
|
|
22
|
+
## 2. 查詢區塊鏈
|
|
23
|
+
|
|
24
|
+
現在客戶端已初始化,您可以執行一個簡單的唯讀操作來驗證連接。`getChainInfo` 方法非常適合此目的,因為它會獲取有關所連接區塊鏈的基本資訊,且無需任何身份驗證。
|
|
25
|
+
|
|
26
|
+
```javascript Query Chain Info icon=logos:javascript
|
|
27
|
+
(async () => {
|
|
28
|
+
try {
|
|
29
|
+
const { info } = await client.getChainInfo();
|
|
30
|
+
console.log('鏈資訊:', info);
|
|
31
|
+
} catch (error) {
|
|
32
|
+
console.error('獲取鏈資訊失敗:', error);
|
|
33
|
+
}
|
|
34
|
+
})();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
如果請求成功,`info` 物件將被記錄到控制台,其中包含有關鏈的詳細資訊,例如其 ID、網路和支援的交易類型。這確認了您的客戶端已成功與區塊鏈節點通訊。
|
|
38
|
+
|
|
39
|
+
## 3. 準備一個帳戶
|
|
40
|
+
|
|
41
|
+
要發送交易(寫入操作),您需要一個錢包。您可以在本地生成一個新錢包。這個錢包代表您在鏈上的帳戶身份。
|
|
42
|
+
|
|
43
|
+
```javascript Create a Wallet icon=logos:javascript
|
|
44
|
+
const { fromRandom } = require('@ocap/wallet');
|
|
45
|
+
|
|
46
|
+
// 建立一個新的隨機錢包
|
|
47
|
+
const wallet = fromRandom();
|
|
48
|
+
|
|
49
|
+
console.log('新錢包已建立:');
|
|
50
|
+
console.log('地址:', wallet.address);
|
|
51
|
+
console.log('公鑰:', wallet.publicKey);
|
|
52
|
+
console.log('私鑰:', wallet.secretKey);
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**重要事項:** 新生成的錢包只是一個金鑰對。它尚未存在於區塊鏈上。當其地址收到第一筆傳入交易時,帳戶將在鏈上自動建立。
|
|
56
|
+
|
|
57
|
+
要啟用您的新帳戶,您需要為其注資一些測試代幣。您可以從官方水龍頭獲取 Beta Chain 的免費測試代幣(`TBA`):
|
|
58
|
+
|
|
59
|
+
<x-card data-title="ArcBlock 水龍頭" data-icon="lucide:droplet" data-href="https://faucet.abtnetwork.io/" data-cta="獲取測試代幣">
|
|
60
|
+
訪問水龍頭並發送一些 TBA 到您新生成的地址以啟用它。
|
|
61
|
+
</x-card>
|
|
62
|
+
|
|
63
|
+
## 4. 查詢帳戶狀態
|
|
64
|
+
|
|
65
|
+
使用水龍頭為您的新帳戶注資後,您可以查詢其狀態以驗證餘額。
|
|
66
|
+
|
|
67
|
+
```javascript Query Account State icon=logos:javascript
|
|
68
|
+
(async () => {
|
|
69
|
+
try {
|
|
70
|
+
// 替換為您從水龍頭注資的地址
|
|
71
|
+
const address = wallet.address;
|
|
72
|
+
|
|
73
|
+
const { state } = await client.getAccountState({ address });
|
|
74
|
+
console.log('帳戶狀態:', state);
|
|
75
|
+
} catch (error) {
|
|
76
|
+
console.error('獲取帳戶狀態失敗:', error);
|
|
77
|
+
}
|
|
78
|
+
})();
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
回應中的 `state` 物件將包含您帳戶的地址、餘額、nonce(已發送的交易數量)以及其他詳細資訊。看到非零餘額即確認您的帳戶已從水龍頭收到代幣,並已在區塊鏈上啟用。
|
|
82
|
+
|
|
83
|
+
## 後續步驟
|
|
84
|
+
|
|
85
|
+
您已成功設定 OCAP Client、連接到區塊鏈並驗證了您的帳戶。現在您已準備好探索更進階的操作。
|
|
86
|
+
|
|
87
|
+
查看 [操作指南](./how-to-guides.md) 以學習如何執行常見任務,例如轉移代幣、管理資產等。
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# 基本用法
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
本指南将引导你完成 OCAP Client 的基本入门步骤。你将学习如何初始化客户端、连接到 ArcBlock 测试链,并执行基本查询以确保一切设置正确。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
遵循本指南,你只需几分钟即可拥有一个可与区块链交互的客户端实例。
|
|
6
6
|
|
|
7
7
|
## 1. 初始化客户端
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
首先,你需要导入 `@ocap/client` 包并创建一个 `GraphQLClient` 实例。构造函数接收你要连接的区块链节点的 GraphQL 端点。在本指南中,我们将使用 ArcBlock 测试链的公共端点。
|
|
10
10
|
|
|
11
11
|
```javascript Initialize Client icon=logos:javascript
|
|
12
12
|
const GraphQLClient = require('@ocap/client');
|
|
@@ -14,14 +14,14 @@ const GraphQLClient = require('@ocap/client');
|
|
|
14
14
|
// 连接到测试链
|
|
15
15
|
const client = new GraphQLClient('https://beta.abtnetwork.io/api');
|
|
16
16
|
|
|
17
|
-
console.log('OCAP
|
|
17
|
+
console.log('OCAP Client 已初始化!');
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
这将创建一个客户端实例,该实例已预先配置了用于查询链、发送交易等方法。
|
|
21
21
|
|
|
22
22
|
## 2. 查询区块链
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
客户端初始化后,你可以执行一个简单的只读操作来验证连接。`getChainInfo` 方法非常适合此目的,因为它能获取所连接区块链的基本信息,且无需任何身份验证。
|
|
25
25
|
|
|
26
26
|
```javascript Query Chain Info icon=logos:javascript
|
|
27
27
|
(async () => {
|
|
@@ -34,11 +34,11 @@ console.log('OCAP 客户端已初始化!');
|
|
|
34
34
|
})();
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
如果请求成功,`info` 对象将被打印到控制台,其中包含有关链的详细信息,例如其 ID
|
|
37
|
+
如果请求成功,`info` 对象将被打印到控制台,其中包含有关链的详细信息,例如其 ID、网络和支持的交易类型。这确认了你的客户端已成功与区块链节点通信。
|
|
38
38
|
|
|
39
39
|
## 3. 准备账户
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
要发送交易(写操作),你需要一个钱包。你可以在本地生成一个新钱包。这个钱包代表你在链上的账户身份。
|
|
42
42
|
|
|
43
43
|
```javascript Create a Wallet icon=logos:javascript
|
|
44
44
|
const { fromRandom } = require('@ocap/wallet');
|
|
@@ -52,22 +52,22 @@ console.log('公钥:', wallet.publicKey);
|
|
|
52
52
|
console.log('私钥:', wallet.secretKey);
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
**重要提示:**
|
|
55
|
+
**重要提示:** 新生成的钱包只是一个密钥对,它尚未在区块链上存在。当其地址收到第一笔转入交易时,链上会自动创建一个账户。
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
要激活你的新账户,你需要为其充入一些测试代币。你可以从官方水龙头获取用于测试链的免费测试代币(`TBA`):
|
|
58
58
|
|
|
59
|
-
<x-card data-title="ArcBlock 水龙头" data-icon="lucide:droplet" data-href="https://faucet.abtnetwork.io/" data-cta="
|
|
60
|
-
|
|
59
|
+
<x-card data-title="ArcBlock 水龙头" data-icon="lucide:droplet" data-href="https://faucet.abtnetwork.io/" data-cta="获取测试代币">
|
|
60
|
+
访问水龙头,向你新生成的地址发送一些 TBA 以激活它。
|
|
61
61
|
</x-card>
|
|
62
62
|
|
|
63
63
|
## 4. 查询账户状态
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
使用水龙头为新账户充值后,你可以查询其状态以验证余额。
|
|
66
66
|
|
|
67
67
|
```javascript Query Account State icon=logos:javascript
|
|
68
68
|
(async () => {
|
|
69
69
|
try {
|
|
70
|
-
//
|
|
70
|
+
// 替换为你从水龙头充值的地址
|
|
71
71
|
const address = wallet.address;
|
|
72
72
|
|
|
73
73
|
const { state } = await client.getAccountState({ address });
|
|
@@ -78,10 +78,10 @@ console.log('私钥:', wallet.secretKey);
|
|
|
78
78
|
})();
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
响应中的 `state`
|
|
81
|
+
响应中的 `state` 对象将包含你的账户地址、余额、nonce(已发送交易数量)和其他详细信息。看到非零余额即确认你的账户已从水龙头收到代币,并已在区块链上激活。
|
|
82
82
|
|
|
83
83
|
## 后续步骤
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
你已成功设置 OCAP Client、连接到区块链并验证了你的账户。现在你可以探索更高级的操作了。
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
查阅 [操作指南](./how-to-guides.md) 以学习如何执行转账、管理资产等常见任务。
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# インストール
|
|
2
|
+
|
|
3
|
+
OCAP Clientは、アプリケーションをOCAPブロックチェーンに接続するためのJavaScriptライブラリです。Node.jsとブラウザ環境の両方で動作します。このガイドでは、パッケージマネージャーを使用してクライアントをインストールする手順を説明します。
|
|
4
|
+
|
|
5
|
+
## 前提条件
|
|
6
|
+
|
|
7
|
+
始める前に、以下がインストールされていることを確認してください。
|
|
8
|
+
|
|
9
|
+
- [Node.js](https://nodejs.org/) (npm パッケージマネージャーを含む)
|
|
10
|
+
- [pnpm](https://pnpm.io/) (任意ですが、推奨されます)
|
|
11
|
+
|
|
12
|
+
## パッケージのインストール
|
|
13
|
+
|
|
14
|
+
`npm` または `pnpm` を使用して、npm レジストリから `@ocap/client` パッケージをインストールできます。
|
|
15
|
+
|
|
16
|
+
### npm の使用
|
|
17
|
+
|
|
18
|
+
プロジェクトのターミナルで次のコマンドを実行してください。
|
|
19
|
+
|
|
20
|
+
```shell npm icon=logos:npm
|
|
21
|
+
npm install @ocap/client
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### pnpm の使用
|
|
25
|
+
|
|
26
|
+
`pnpm` を使用する場合は、次のコマンドを実行してください。
|
|
27
|
+
|
|
28
|
+
```shell pnpm icon=logos:pnpm
|
|
29
|
+
pnpm install @ocap/client
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
このコマンドはパッケージをダウンロードし、プロジェクトの依存関係に追加します。
|
|
33
|
+
|
|
34
|
+
## インストールの確認
|
|
35
|
+
|
|
36
|
+
インストールが完了したら、JavaScriptファイルにインポートして、パッケージが正しくインストールされていることを確認できます。`test-client.js` という名前のファイルを作成し、次のコードを追加してください。
|
|
37
|
+
|
|
38
|
+
```javascript Verify Installation icon=logos:javascript
|
|
39
|
+
const OCapClient = require('@ocap/client');
|
|
40
|
+
|
|
41
|
+
if (OCapClient) {
|
|
42
|
+
console.log('@ocap/clientのインストールとインポートに成功しました!');
|
|
43
|
+
} else {
|
|
44
|
+
console.error('@ocap/clientのインポートに失敗しました。');
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
ターミナルからファイルを実行してください。
|
|
49
|
+
|
|
50
|
+
```shell
|
|
51
|
+
node test-client.js
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
コンソールに成功メッセージが出力され、クライアントが使用準備完了であることが確認できます。
|
|
55
|
+
|
|
56
|
+
## 次のステップ
|
|
57
|
+
|
|
58
|
+
クライアントがインストールされたので、ブロックチェーンに接続してリクエストを開始する準備が整いました。次のセクションに進み、基本的な使い方を学びましょう。
|
|
59
|
+
|
|
60
|
+
- **[基本操作](./getting-started-basic-usage.md)**: クライアントを初期化し、最初のクエリを実行する方法を学びます。
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# 安裝
|
|
2
|
+
|
|
3
|
+
OCAP Client 是一個 JavaScript 函式庫,可將您的應用程式連接到 OCAP 區塊鏈。它可以在 Node.js 和瀏覽器環境中運作。本指南將引導您使用套件管理器安裝用戶端。
|
|
4
|
+
|
|
5
|
+
## 事前準備
|
|
6
|
+
|
|
7
|
+
在開始之前,請確保您已安裝以下項目:
|
|
8
|
+
|
|
9
|
+
- [Node.js](https://nodejs.org/) (包含 npm 套件管理器)
|
|
10
|
+
- [pnpm](https://pnpm.io/) (可選,但建議使用)
|
|
11
|
+
|
|
12
|
+
## 安裝套件
|
|
13
|
+
|
|
14
|
+
您可以使用 `npm` 或 `pnpm` 從 npm 登錄檔安裝 `@ocap/client` 套件。
|
|
15
|
+
|
|
16
|
+
### 使用 npm
|
|
17
|
+
|
|
18
|
+
在您的專案終端機中執行以下指令:
|
|
19
|
+
|
|
20
|
+
```shell npm icon=logos:npm
|
|
21
|
+
npm install @ocap/client
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### 使用 pnpm
|
|
25
|
+
|
|
26
|
+
如果您偏好使用 `pnpm`,請執行此指令:
|
|
27
|
+
|
|
28
|
+
```shell pnpm icon=logos:pnpm
|
|
29
|
+
pnpm install @ocap/client
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
此指令將下載套件並將其新增到您的專案依賴項中。
|
|
33
|
+
|
|
34
|
+
## 驗證安裝
|
|
35
|
+
|
|
36
|
+
安裝完成後,您可以透過將套件匯入 JavaScript 檔案來驗證其是否已正確安裝。建立一個名為 `test-client.js` 的檔案並新增以下程式碼:
|
|
37
|
+
|
|
38
|
+
```javascript Verify Installation icon=logos:javascript
|
|
39
|
+
const OCapClient = require('@ocap/client');
|
|
40
|
+
|
|
41
|
+
if (OCapClient) {
|
|
42
|
+
console.log('Successfully installed and imported @ocap/client!');
|
|
43
|
+
} else {
|
|
44
|
+
console.error('Failed to import @ocap/client.');
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
從您的終端機執行該檔案:
|
|
49
|
+
|
|
50
|
+
```shell
|
|
51
|
+
node test-client.js
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
您應該會在主控台中看到成功訊息,確認用戶端已準備就緒可供使用。
|
|
55
|
+
|
|
56
|
+
## 後續步驟
|
|
57
|
+
|
|
58
|
+
現在您已經安裝了用戶端,您可以連接到區塊鏈並開始發送請求。請繼續下一節以學習基礎知識。
|
|
59
|
+
|
|
60
|
+
- **[基本用法](./getting-started-basic-usage.md)**:學習如何初始化用戶端並進行您的第一次查詢。
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# 安装
|
|
2
2
|
|
|
3
|
-
OCAP
|
|
3
|
+
OCAP 客户端是一个 JavaScript 库,可将您的应用程序连接到 OCAP 区块链。它同时适用于 Node.js 和浏览器环境。本指南将引导您使用包管理器安装该客户端。
|
|
4
4
|
|
|
5
5
|
## 前提条件
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
开始之前,请确保您已安装以下软件:
|
|
8
8
|
|
|
9
|
-
- [Node.js](https://nodejs.org/)
|
|
10
|
-
- [pnpm](https://pnpm.io/)
|
|
9
|
+
- [Node.js](https://nodejs.org/) (包含 npm 包管理器)
|
|
10
|
+
- [pnpm](https://pnpm.io/) (可选,但推荐)
|
|
11
11
|
|
|
12
12
|
## 安装包
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ OCAP Client 是一个 JavaScript 库,可将您的应用程序连接到 OCAP
|
|
|
15
15
|
|
|
16
16
|
### 使用 npm
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
在您项目的终端中运行以下命令:
|
|
19
19
|
|
|
20
20
|
```shell npm icon=logos:npm
|
|
21
21
|
npm install @ocap/client
|
|
@@ -23,38 +23,38 @@ npm install @ocap/client
|
|
|
23
23
|
|
|
24
24
|
### 使用 pnpm
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
如果您偏好使用 `pnpm`,请运行此命令:
|
|
27
27
|
|
|
28
28
|
```shell pnpm icon=logos:pnpm
|
|
29
29
|
pnpm install @ocap/client
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
此命令将下载该包并将其添加到项目的依赖项中。
|
|
33
33
|
|
|
34
34
|
## 验证安装
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
安装完成后,您可以通过将其导入一个 JavaScript 文件来验证包是否已正确安装。创建一个名为 `test-client.js` 的文件并添加以下代码:
|
|
37
37
|
|
|
38
38
|
```javascript Verify Installation icon=logos:javascript
|
|
39
39
|
const OCapClient = require('@ocap/client');
|
|
40
40
|
|
|
41
41
|
if (OCapClient) {
|
|
42
|
-
console.log('
|
|
42
|
+
console.log('成功安装并导入 @ocap/client!');
|
|
43
43
|
} else {
|
|
44
|
-
console.error('
|
|
44
|
+
console.error('导入 @ocap/client 失败。');
|
|
45
45
|
}
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
从终端运行该文件:
|
|
49
49
|
|
|
50
50
|
```shell
|
|
51
51
|
node test-client.js
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
您应该会在控制台中看到成功消息,这确认了客户端已准备就绪,可以使用。
|
|
55
55
|
|
|
56
56
|
## 后续步骤
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
既然您已经安装了客户端,就可以连接到区块链并开始发出请求了。请继续阅读下一部分以学习基础知识。
|
|
59
59
|
|
|
60
|
-
- **[基本用法](./getting-started-basic-usage.md)
|
|
60
|
+
- **[基本用法](./getting-started-basic-usage.md)**:学习如何初始化客户端并发起您的第一个查询。
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# はじめに
|
|
2
|
+
|
|
3
|
+
ようこそ!このガイドでは、30分以内にOCAP Clientを起動して実行する方法を説明します。クライアントのインストール方法、アプリケーションをOCAP互換のブロックチェーンに接続する方法、そしてセットアップを検証するための最初のAPIコールを行う方法を学びます。
|
|
4
|
+
|
|
5
|
+
これらの簡単な手順に従って、ネットワークとの対話を開始してください。
|
|
6
|
+
|
|
7
|
+
<x-cards data-columns="2">
|
|
8
|
+
<x-card data-title="インストール" data-href="/getting-started/installation" data-icon="lucide:download">
|
|
9
|
+
npmまたはpnpmを使用してOCAP Clientパッケージをプロジェクトに追加する方法を学びます。
|
|
10
|
+
</x-card>
|
|
11
|
+
<x-card data-title="基本的な使い方" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
|
|
12
|
+
クライアントを初期化し、ベータチェーンに接続し、最初のAPIコールを行ってセットアップを検証します。
|
|
13
|
+
</x-card>
|
|
14
|
+
</x-cards>
|
|
15
|
+
|
|
16
|
+
これらの初期ステップを完了したら、より高度な機能を探求する準備が整います。実践的でタスク指向の例については、必ず[ハウツーガイド](./how-to-guides.md)を確認してください。
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# 入門指南
|
|
2
|
+
|
|
3
|
+
歡迎!本指南將引導您在 30 分鐘內開始使用 OCAP Client。您將學習如何安裝客戶端、將您的應用程式連接到與 OCAP 相容的區塊鏈,並進行您的第一次 API 呼叫以驗證您的設定。
|
|
4
|
+
|
|
5
|
+
請遵循以下簡單步驟,開始與網路互動。
|
|
6
|
+
|
|
7
|
+
<x-cards data-columns="2">
|
|
8
|
+
<x-card data-title="安裝" data-href="/getting-started/installation" data-icon="lucide:download">
|
|
9
|
+
了解如何使用 npm 或 pnpm 將 OCAP Client 套件新增至您的專案中。
|
|
10
|
+
</x-card>
|
|
11
|
+
<x-card data-title="基本用法" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
|
|
12
|
+
初始化客戶端,連接到 Beta 鏈,並進行您的第一次 API 呼叫以驗證您的設定。
|
|
13
|
+
</x-card>
|
|
14
|
+
</x-cards>
|
|
15
|
+
|
|
16
|
+
完成這些初始步驟後,您就可以開始探索更進階的功能。若需要實用且以任務為導向的範例,請務必查閱 [操作指南](./how-to-guides.md)。
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
# 入门指南
|
|
2
2
|
|
|
3
|
-
欢迎!本指南将帮助您在 30 分钟内启动并运行 OCAP Client
|
|
3
|
+
欢迎!本指南将帮助您在 30 分钟内启动并运行 OCAP Client。
|
|
4
|
+
您将学习如何安装客户端,将您的应用程序连接到兼容 OCAP 的区块链,并进行首次 API 调用以验证您的设置。
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
按照以下简单步骤开始与网络进行交互。
|
|
6
7
|
|
|
7
8
|
<x-cards data-columns="2">
|
|
8
9
|
<x-card data-title="安装" data-href="/getting-started/installation" data-icon="lucide:download">
|
|
9
|
-
|
|
10
|
+
了解如何使用 npm 或 pnpm 将 OCAP Client 包添加到您的项目中。
|
|
10
11
|
</x-card>
|
|
11
12
|
<x-card data-title="基本用法" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
|
|
12
|
-
初始化客户端,连接到 Beta
|
|
13
|
+
初始化客户端,连接到 Beta 链,并进行首次 API 调用以验证您的设置。
|
|
13
14
|
</x-card>
|
|
14
15
|
</x-cards>
|
|
15
16
|
|
|
16
|
-
|
|
17
|
+
完成这些初始步骤后,您就可以开始探索更高级的功能了。如需查看面向任务的实用示例,请务必查阅 [操作指南](./how-to-guides.md)。
|