@ocap/client 1.25.3 → 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.
Files changed (92) hide show
  1. package/README.md +76 -80
  2. package/dist/report.html +1 -1
  3. package/docs/_sidebar.md +22 -0
  4. package/docs/api-reference-client-methods.ja.md +229 -0
  5. package/docs/api-reference-client-methods.md +229 -0
  6. package/docs/api-reference-client-methods.zh-TW.md +229 -0
  7. package/docs/api-reference-client-methods.zh.md +229 -0
  8. package/docs/api-reference-data-types.ja.md +482 -0
  9. package/docs/api-reference-data-types.md +482 -0
  10. package/docs/api-reference-data-types.zh-TW.md +482 -0
  11. package/docs/api-reference-data-types.zh.md +482 -0
  12. package/docs/api-reference-low-level-api.ja.md +228 -0
  13. package/docs/api-reference-low-level-api.md +228 -0
  14. package/docs/api-reference-low-level-api.zh-TW.md +228 -0
  15. package/docs/api-reference-low-level-api.zh.md +228 -0
  16. package/docs/api-reference-query-mutation-methods.ja.md +814 -0
  17. package/docs/api-reference-query-mutation-methods.md +814 -0
  18. package/docs/api-reference-query-mutation-methods.zh-TW.md +814 -0
  19. package/docs/api-reference-query-mutation-methods.zh.md +814 -0
  20. package/docs/api-reference-transaction-helpers.ja.md +649 -0
  21. package/docs/api-reference-transaction-helpers.md +649 -0
  22. package/docs/api-reference-transaction-helpers.zh-TW.md +649 -0
  23. package/docs/api-reference-transaction-helpers.zh.md +649 -0
  24. package/docs/api-reference.ja.md +23 -0
  25. package/docs/api-reference.md +23 -0
  26. package/docs/api-reference.zh-TW.md +23 -0
  27. package/docs/api-reference.zh.md +23 -0
  28. package/docs/core-concepts-client-architecture.ja.md +102 -0
  29. package/docs/core-concepts-client-architecture.md +102 -0
  30. package/docs/core-concepts-client-architecture.zh-TW.md +102 -0
  31. package/docs/core-concepts-client-architecture.zh.md +102 -0
  32. package/docs/core-concepts-event-subscriptions.ja.md +123 -0
  33. package/docs/core-concepts-event-subscriptions.md +123 -0
  34. package/docs/core-concepts-event-subscriptions.zh-TW.md +123 -0
  35. package/docs/core-concepts-event-subscriptions.zh.md +123 -0
  36. package/docs/core-concepts-gas-payment.ja.md +111 -0
  37. package/docs/core-concepts-gas-payment.md +111 -0
  38. package/docs/core-concepts-gas-payment.zh-TW.md +111 -0
  39. package/docs/core-concepts-gas-payment.zh.md +111 -0
  40. package/docs/core-concepts-transaction-lifecycle.ja.md +183 -0
  41. package/docs/core-concepts-transaction-lifecycle.md +183 -0
  42. package/docs/core-concepts-transaction-lifecycle.zh-TW.md +183 -0
  43. package/docs/core-concepts-transaction-lifecycle.zh.md +183 -0
  44. package/docs/core-concepts.ja.md +22 -0
  45. package/docs/core-concepts.md +22 -0
  46. package/docs/core-concepts.zh-TW.md +22 -0
  47. package/docs/core-concepts.zh.md +22 -0
  48. package/docs/getting-started-basic-usage.ja.md +87 -0
  49. package/docs/getting-started-basic-usage.md +87 -0
  50. package/docs/getting-started-basic-usage.zh-TW.md +87 -0
  51. package/docs/getting-started-basic-usage.zh.md +87 -0
  52. package/docs/getting-started-installation.ja.md +60 -0
  53. package/docs/getting-started-installation.md +60 -0
  54. package/docs/getting-started-installation.zh-TW.md +60 -0
  55. package/docs/getting-started-installation.zh.md +60 -0
  56. package/docs/getting-started.ja.md +16 -0
  57. package/docs/getting-started.md +16 -0
  58. package/docs/getting-started.zh-TW.md +16 -0
  59. package/docs/getting-started.zh.md +17 -0
  60. package/docs/how-to-guides-delegate-permissions.ja.md +167 -0
  61. package/docs/how-to-guides-delegate-permissions.md +167 -0
  62. package/docs/how-to-guides-delegate-permissions.zh-TW.md +167 -0
  63. package/docs/how-to-guides-delegate-permissions.zh.md +166 -0
  64. package/docs/how-to-guides-manage-accounts.ja.md +73 -0
  65. package/docs/how-to-guides-manage-accounts.md +73 -0
  66. package/docs/how-to-guides-manage-accounts.zh-TW.md +73 -0
  67. package/docs/how-to-guides-manage-accounts.zh.md +73 -0
  68. package/docs/how-to-guides-manage-assets.ja.md +255 -0
  69. package/docs/how-to-guides-manage-assets.md +255 -0
  70. package/docs/how-to-guides-manage-assets.zh-TW.md +255 -0
  71. package/docs/how-to-guides-manage-assets.zh.md +255 -0
  72. package/docs/how-to-guides-manage-tokens.ja.md +179 -0
  73. package/docs/how-to-guides-manage-tokens.md +179 -0
  74. package/docs/how-to-guides-manage-tokens.zh-TW.md +179 -0
  75. package/docs/how-to-guides-manage-tokens.zh.md +179 -0
  76. package/docs/how-to-guides-stake-tokens-and-assets.ja.md +205 -0
  77. package/docs/how-to-guides-stake-tokens-and-assets.md +205 -0
  78. package/docs/how-to-guides-stake-tokens-and-assets.zh-TW.md +205 -0
  79. package/docs/how-to-guides-stake-tokens-and-assets.zh.md +205 -0
  80. package/docs/how-to-guides-transfer-tokens-and-nfts.ja.md +179 -0
  81. package/docs/how-to-guides-transfer-tokens-and-nfts.md +179 -0
  82. package/docs/how-to-guides-transfer-tokens-and-nfts.zh-TW.md +179 -0
  83. package/docs/how-to-guides-transfer-tokens-and-nfts.zh.md +179 -0
  84. package/docs/how-to-guides.ja.md +27 -0
  85. package/docs/how-to-guides.md +27 -0
  86. package/docs/how-to-guides.zh-TW.md +27 -0
  87. package/docs/how-to-guides.zh.md +27 -0
  88. package/docs/overview.ja.md +70 -0
  89. package/docs/overview.md +70 -0
  90. package/docs/overview.zh-TW.md +70 -0
  91. package/docs/overview.zh.md +70 -0
  92. package/package.json +14 -14
@@ -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) 以學習如何執行常見任務,例如轉移代幣、管理資產等。
@@ -0,0 +1,87 @@
1
+ # 基本用法
2
+
3
+ 本指南将引导你完成 OCAP Client 的基本入门步骤。你将学习如何初始化客户端、连接到 ArcBlock 测试链,并执行基本查询以确保一切设置正确。
4
+
5
+ 遵循本指南,你只需几分钟即可拥有一个可与区块链交互的客户端实例。
6
+
7
+ ## 1. 初始化客户端
8
+
9
+ 首先,你需要导入 `@ocap/client` 包并创建一个 `GraphQLClient` 实例。构造函数接收你要连接的区块链节点的 GraphQL 端点。在本指南中,我们将使用 ArcBlock 测试链的公共端点。
10
+
11
+ ```javascript Initialize Client icon=logos:javascript
12
+ const GraphQLClient = require('@ocap/client');
13
+
14
+ // 连接到测试链
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
+ 要激活你的新账户,你需要为其充入一些测试代币。你可以从官方水龙头获取用于测试链的免费测试代币(`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) 以学习如何执行转账、管理资产等常见任务。
@@ -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
+ # Installation
2
+
3
+ The OCAP Client is a JavaScript library that connects your application to an OCAP blockchain. It works in both Node.js and browser environments. This guide will walk you through installing the client using a package manager.
4
+
5
+ ## Prerequisites
6
+
7
+ Before you begin, ensure you have the following installed:
8
+
9
+ - [Node.js](https://nodejs.org/) (which includes the npm package manager)
10
+ - [pnpm](https://pnpm.io/) (optional, but recommended)
11
+
12
+ ## Install the Package
13
+
14
+ You can install the `@ocap/client` package from the npm registry using either `npm` or `pnpm`.
15
+
16
+ ### Using npm
17
+
18
+ Run the following command in your project's terminal:
19
+
20
+ ```shell npm icon=logos:npm
21
+ npm install @ocap/client
22
+ ```
23
+
24
+ ### Using pnpm
25
+
26
+ If you prefer using `pnpm`, run this command:
27
+
28
+ ```shell pnpm icon=logos:pnpm
29
+ pnpm install @ocap/client
30
+ ```
31
+
32
+ This command will download the package and add it to your project's dependencies.
33
+
34
+ ## Verify Installation
35
+
36
+ After the installation is complete, you can verify that the package is correctly installed by importing it into a JavaScript file. Create a file named `test-client.js` and add the following code:
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
+ Run the file from your terminal:
49
+
50
+ ```shell
51
+ node test-client.js
52
+ ```
53
+
54
+ You should see the success message printed to the console, confirming that the client is ready to use.
55
+
56
+ ## Next Steps
57
+
58
+ Now that you have the client installed, you're ready to connect to the blockchain and start making requests. Continue to the next section to learn the basics.
59
+
60
+ - **[Basic Usage](./getting-started-basic-usage.md)**: Learn how to initialize the client and make your first query.
@@ -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)**:學習如何初始化用戶端並進行您的第一次查詢。
@@ -0,0 +1,60 @@
1
+ # 安装
2
+
3
+ OCAP 客户端是一个 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('成功安装并导入 @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,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
+ # Getting Started
2
+
3
+ Welcome! This guide will get you up and running with the OCAP Client in under 30 minutes. You'll learn how to install the client, connect your application to an OCAP-compatible blockchain, and make your first API call to verify your setup.
4
+
5
+ Follow these simple steps to begin interacting with the network.
6
+
7
+ <x-cards data-columns="2">
8
+ <x-card data-title="Installation" data-href="/getting-started/installation" data-icon="lucide:download">
9
+ Learn how to add the OCAP Client package to your project using npm or pnpm.
10
+ </x-card>
11
+ <x-card data-title="Basic Usage" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
12
+ Initialize the client, connect to the Beta chain, and make your first API call to verify your setup.
13
+ </x-card>
14
+ </x-cards>
15
+
16
+ Once you've completed these initial steps, you'll be ready to explore more advanced features. For practical, task-oriented examples, be sure to check out the [How-to Guides](./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)。
@@ -0,0 +1,17 @@
1
+ # 入门指南
2
+
3
+ 欢迎!本指南将帮助您在 30 分钟内启动并运行 OCAP Client。
4
+ 您将学习如何安装客户端,将您的应用程序连接到兼容 OCAP 的区块链,并进行首次 API 调用以验证您的设置。
5
+
6
+ 按照以下简单步骤开始与网络进行交互。
7
+
8
+ <x-cards data-columns="2">
9
+ <x-card data-title="安装" data-href="/getting-started/installation" data-icon="lucide:download">
10
+ 了解如何使用 npm 或 pnpm 将 OCAP Client 包添加到您的项目中。
11
+ </x-card>
12
+ <x-card data-title="基本用法" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
13
+ 初始化客户端,连接到 Beta 链,并进行首次 API 调用以验证您的设置。
14
+ </x-card>
15
+ </x-cards>
16
+
17
+ 完成这些初始步骤后,您就可以开始探索更高级的功能了。如需查看面向任务的实用示例,请务必查阅 [操作指南](./how-to-guides.md)。
@@ -0,0 +1,167 @@
1
+ # 権限の委任
2
+
3
+ 権限の委任は、あるアカウント(委任者)が別のアカウント(被委任者)に、自身に代わって特定の種類のトランザクションを送信することを許可する強力な機能です。これは、ユーザーの主要な秘密鍵に直接アクセスすることなく、ユーザーのためにアクションを実行する必要があるアプリケーションにとって特に便利です。例えば、特定の資産を転送したり、スマートコントラクトと対話したりする権限をアプリケーション固有のキーに委任することで、キーの権限範囲を制限し、セキュリティを向上させることができます。
4
+
5
+ このガイドでは、委任の付与、使用、取り消しの手順を説明します。
6
+
7
+ ## 委任の付与
8
+
9
+ 別のアカウントを認可するには、`delegate` メソッドを使用します。誰に委任するのか、そして彼らが送信を許可される特定のトランザクションタイプを指定する必要があります。各権限には、どのトークンや資産が関与できるかなどの制限を設けることもできます。
10
+
11
+ ### パラメータ
12
+
13
+ <x-field-group>
14
+ <x-field data-name="from" data-type="WalletObject" data-required="true">
15
+ <x-field-desc markdown>委任者(権限を付与するアカウント)のウォレットオブジェクト。</x-field-desc>
16
+ </x-field>
17
+ <x-field data-name="to" data-type="WalletObject" data-required="true">
18
+ <x-field-desc markdown>被委任者(権限を受け取るアカウント)のウォレットオブジェクト。</x-field-desc>
19
+ </x-field>
20
+ <x-field data-name="privileges" data-type="Array<object>" data-required="true">
21
+ <x-field-desc markdown>付与する権限オブジェクトの配列。各オブジェクトは特定の認可を定義します。</x-field-desc>
22
+ <x-field data-name="typeUrl" data-type="string" data-required="true">
23
+ <x-field-desc markdown>許可されるトランザクションのタイプ URL(例:`fg:t:transfer_v2`)。</x-field-desc>
24
+ </x-field>
25
+ <x-field data-name="limit" data-type="object" data-required="false">
26
+ <x-field-desc markdown>権限に対するオプションの制限。特定のトークンや資産に制限するなど。</x-field-desc>
27
+ <x-field data-name="tokens" data-type="Array<string>" data-required="false" data-desc="この権限が適用されるトークンアドレスの配列。"></x-field>
28
+ <x-field data-name="assets" data-type="Array<string>" data-required="false" data-desc="この権限が適用される資産アドレスの配列。"></x-field>
29
+ </x-field>
30
+ </x-field>
31
+ </x-field-group>
32
+
33
+ ### 戻り値
34
+
35
+ <x-field data-name="result" data-type="Promise<[string, string]>" data-desc="トランザクションハッシュと新しく作成された委任アドレスを含む配列に解決される Promise。"></x-field>
36
+
37
+ ### 例
38
+
39
+ あるアカウントから別のアカウントに `transfer` 権限を委任する方法は次のとおりです。
40
+
41
+ ```javascript 転送権限の付与 icon=logos:javascript
42
+ import Client from '@ocap/client';
43
+ import { fromRandom } from '@ocap/wallet';
44
+ import { typeUrls } from '@ocap/proto';
45
+
46
+ const client = new Client('https://beta.abtnetwork.io/api');
47
+
48
+ // 権限を付与するアカウント
49
+ const delegatorWallet = fromRandom();
50
+
51
+ // 権限を受け取るアカウント
52
+ const delegateeWallet = fromRandom();
53
+
54
+ async function grantPermission() {
55
+ try {
56
+ // まず、委任者アカウントに資金があることを確認します。
57
+ // 実際のアプリケーションでは、faucet や別のアカウントから
58
+ // delegatorWallet.address に資金を送金します。
59
+ console.log(`Delegator address: ${delegatorWallet.address}`);
60
+ console.log(`Delegatee address: ${delegateeWallet.address}`);
61
+ console.log('Please fund the delegator account before proceeding.');
62
+
63
+ const privileges = [
64
+ {
65
+ typeUrl: typeUrls.TransferV2Tx,
66
+ // 制限は指定されておらず、任意のトークン/資産の転送を許可します
67
+ limit: { tokens: [], assets: [] },
68
+ },
69
+ ];
70
+
71
+ const [hash, delegateAddress] = await client.delegate({
72
+ from: delegatorWallet,
73
+ to: delegateeWallet,
74
+ privileges: privileges,
75
+ });
76
+
77
+ console.log('Delegation successful!');
78
+ console.log('Transaction Hash:', hash);
79
+ console.log('Delegate Address:', delegateAddress);
80
+ } catch (error) {
81
+ console.error('Error delegating permissions:', error);
82
+ }
83
+ }
84
+
85
+ grantPermission();
86
+ ```
87
+
88
+ ## 被委任者としてトランザクションを送信する
89
+
90
+ 委任されると、被委任者のウォレットは、トランザクションパラメータで `delegator` のアドレスを指定することにより、認可されたトランザクションを送信できます。トランザクションは被委任者によって署名されますが、委任者に代わって実行され、トランザクション手数料は委任者のアカウントから支払われます。
91
+
92
+ ### 例
93
+
94
+ ```javascript 被委任者として転送を送信する icon=logos:javascript
95
+ // 前の例の grantPermission() 関数が成功したと仮定します
96
+
97
+ // 転送の受信者
98
+ const recipientWallet = fromRandom();
99
+
100
+ async function sendDelegatedTransaction() {
101
+ try {
102
+ const hash = await client.transfer({
103
+ to: recipientWallet.address,
104
+ token: 1, // チェーンのネイティブトークンを1転送
105
+ wallet: delegateeWallet, // 被委任者によって署名
106
+ delegator: delegatorWallet.address, // 委任者に代わって実行
107
+ });
108
+
109
+ console.log('Delegated transfer successful!');
110
+ console.log('Transaction Hash:', hash);
111
+ console.log(`Check transaction at: https://beta.abtnetwork.io/explorer/txs/${hash}`);
112
+ } catch (error) {
113
+ console.error('Error sending delegated transaction:', error);
114
+ }
115
+ }
116
+
117
+ // 委任がオンチェーンで確認された後にこれを呼び出すようにしてください。
118
+ // sendDelegatedTransaction();
119
+ ```
120
+
121
+ ## 委任の取り消し
122
+
123
+ 委任者は、`revokeDelegate` メソッドを使用して、いつでも付与された権限を取り消すことができます。特定の被委任者に対してどのトランザクションタイプを取り消すかを指定する必要があります。
124
+
125
+ ### パラメータ
126
+
127
+ <x-field-group>
128
+ <x-field data-name="from" data-type="WalletObject" data-required="true">
129
+ <x-field-desc markdown>最初に権限を付与した委任者のウォレットオブジェクト。</x-field-desc>
130
+ </x-field>
131
+ <x-field data-name="to" data-type="WalletObject" data-required="true">
132
+ <x-field-desc markdown>権限が取り消される被委任者のウォレットオブジェクト。</x-field-desc>
133
+ </x-field>
134
+ <x-field data-name="privileges" data-type="Array<string>" data-required="true">
135
+ <x-field-desc markdown>取り消すトランザクションの `typeUrl` 文字列の配列。</x-field-desc>
136
+ </x-field>
137
+ </x-field-group>
138
+
139
+ ### 戻り値
140
+
141
+ <x-field data-name="hash" data-type="Promise<string>" data-desc="取り消しのトランザクションハッシュに解決される Promise。"></x-field>
142
+
143
+ ### 例
144
+
145
+ ```javascript 転送権限の取り消し icon=logos:javascript
146
+ // 前の例と同じ delegatorWallet と delegateeWallet を使用すると仮定します
147
+
148
+ async function revokePermission() {
149
+ try {
150
+ const hash = await client.revokeDelegate({
151
+ from: delegatorWallet,
152
+ to: delegateeWallet,
153
+ privileges: [typeUrls.TransferV2Tx], // 取り消す権限のリスト
154
+ });
155
+
156
+ console.log('Revocation successful!');
157
+ console.log('Transaction Hash:', hash);
158
+ console.log(`Check transaction at: https://beta.abtnetwork.io/explorer/txs/${hash}`);
159
+ } catch (error) {
160
+ console.error('Error revoking delegation:', error);
161
+ }
162
+ }
163
+
164
+ // revokePermission();
165
+ ```
166
+
167
+ このトランザクションが確認されると、`delegateeWallet` は `delegatorWallet` に代わって `transfer` トランザクションを送信できなくなります。