@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,44 +1,44 @@
|
|
|
1
1
|
# 基本用法
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
本指南将引导您完成 OCAP Client 的基本入门步骤。您将学习如何初始化客户端、连接到 ArcBlock Beta Chain,并执行基本查询以确保一切设置正确。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
遵循本指南,您应该能在几分钟内拥有一个可以与区块链交互的正常工作的客户端实例。
|
|
6
6
|
|
|
7
7
|
## 1. 初始化客户端
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
首先,您需要导入 `@ocap/client` 包并创建一个 `GraphQLClient` 实例。构造函数接收您想要连接的区块链节点的 GraphQL 端点。在本指南中,我们将使用 ArcBlock Beta Chain 的公共端点。
|
|
10
10
|
|
|
11
11
|
```javascript Initialize Client icon=logos:javascript
|
|
12
12
|
const GraphQLClient = require('@ocap/client');
|
|
13
13
|
|
|
14
|
-
//
|
|
14
|
+
// 连接到 Beta Chain
|
|
15
15
|
const client = new GraphQLClient('https://beta.abtnetwork.io/api');
|
|
16
16
|
|
|
17
|
-
console.log('OCAP Client
|
|
17
|
+
console.log('OCAP Client initialized!');
|
|
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 () => {
|
|
28
28
|
try {
|
|
29
29
|
const { info } = await client.getChainInfo();
|
|
30
|
-
console.log('
|
|
30
|
+
console.log('Chain Info:', info);
|
|
31
31
|
} catch (error) {
|
|
32
|
-
console.error('
|
|
32
|
+
console.error('Failed to get chain info:', error);
|
|
33
33
|
}
|
|
34
34
|
})();
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
如果请求成功,`info`
|
|
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');
|
|
@@ -46,42 +46,42 @@ const { fromRandom } = require('@ocap/wallet');
|
|
|
46
46
|
// 创建一个新的随机钱包
|
|
47
47
|
const wallet = fromRandom();
|
|
48
48
|
|
|
49
|
-
console.log('
|
|
50
|
-
console.log('
|
|
51
|
-
console.log('
|
|
52
|
-
console.log('
|
|
49
|
+
console.log('New wallet created:');
|
|
50
|
+
console.log('Address:', wallet.address);
|
|
51
|
+
console.log('PublicKey:', wallet.publicKey);
|
|
52
|
+
console.log('SecretKey:', wallet.secretKey);
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
**重要提示:**
|
|
55
|
+
**重要提示:** 新生成的钱包只是一个密钥对。它在区块链上尚不存在。当其地址收到第一笔转入交易时,账户会自动在链上创建。
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
要激活您的新账户,您需要为其充值一些测试代币。您可以从官方水龙头获取用于 Beta Chain 的免费测试代币(`TBA`):
|
|
58
58
|
|
|
59
59
|
<x-card data-title="ArcBlock 水龙头" data-icon="lucide:droplet" data-href="https://faucet.abtnetwork.io/" data-cta="获取测试代币">
|
|
60
|
-
|
|
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 });
|
|
74
|
-
console.log('
|
|
74
|
+
console.log('Account State:', state);
|
|
75
75
|
} catch (error) {
|
|
76
|
-
console.error('
|
|
76
|
+
console.error('Failed to get account state:', error);
|
|
77
77
|
}
|
|
78
78
|
})();
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
响应中的 `state`
|
|
81
|
+
响应中的 `state` 对象将包含您账户的地址、余额、nonce(已发送交易数量)和其他详细信息。看到非零余额即确认您的账户已从水龙头收到代币,并且现已在区块链上激活。
|
|
82
82
|
|
|
83
83
|
## 后续步骤
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
您已成功设置 OCAP Client、连接到区块链并验证了您的账户。现在您可以开始探索更高级的操作。
|
|
86
86
|
|
|
87
|
-
查阅 [操作指南](./how-to-guides.md)
|
|
87
|
+
查阅 [操作指南](./how-to-guides.md) 以学习如何执行转账代币、管理资产等常见任务。
|
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
# インストール
|
|
2
2
|
|
|
3
|
-
OCAP Clientは、アプリケーションをOCAPブロックチェーンに接続するためのJavaScriptライブラリです。Node.js
|
|
3
|
+
OCAP Client は、アプリケーションを OCAP ブロックチェーンに接続するための JavaScript ライブラリです。Node.js とブラウザ環境の両方で動作します。このガイドでは、パッケージマネージャーを使用してクライアントをインストールする方法を説明します。
|
|
4
4
|
|
|
5
5
|
## 前提条件
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
開始する前に、次のものがインストールされていることを確認してください:
|
|
8
8
|
|
|
9
|
-
- [Node.js](https://nodejs.org/) (npm
|
|
9
|
+
- [Node.js](https://nodejs.org/) (npm パッケージマネージャーを含みます)
|
|
10
10
|
- [pnpm](https://pnpm.io/) (任意ですが、推奨されます)
|
|
11
11
|
|
|
12
12
|
## パッケージのインストール
|
|
13
13
|
|
|
14
14
|
`npm` または `pnpm` を使用して、npm レジストリから `@ocap/client` パッケージをインストールできます。
|
|
15
15
|
|
|
16
|
-
### npm
|
|
16
|
+
### npm を使用する
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
プロジェクトのターミナルで次のコマンドを実行します:
|
|
19
19
|
|
|
20
20
|
```shell npm icon=logos:npm
|
|
21
21
|
npm install @ocap/client
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
### pnpm
|
|
24
|
+
### pnpm を使用する
|
|
25
25
|
|
|
26
|
-
`pnpm`
|
|
26
|
+
`pnpm` の使用を希望する場合は、次のコマンドを実行します:
|
|
27
27
|
|
|
28
28
|
```shell pnpm icon=logos:pnpm
|
|
29
29
|
pnpm install @ocap/client
|
|
@@ -33,28 +33,28 @@ pnpm install @ocap/client
|
|
|
33
33
|
|
|
34
34
|
## インストールの確認
|
|
35
35
|
|
|
36
|
-
インストールが完了したら、JavaScript
|
|
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('@ocap/client
|
|
42
|
+
console.log('Successfully installed and imported @ocap/client!');
|
|
43
43
|
} else {
|
|
44
|
-
console.error('@ocap/client
|
|
44
|
+
console.error('Failed to import @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
60
|
- **[基本操作](./getting-started-basic-usage.md)**: クライアントを初期化し、最初のクエリを実行する方法を学びます。
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# 安裝
|
|
2
2
|
|
|
3
|
-
OCAP Client
|
|
3
|
+
OCAP Client 是一套 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 函式庫,可將您的應用程式連接到 O
|
|
|
15
15
|
|
|
16
16
|
### 使用 npm
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
在您專案的終端機中執行以下指令:
|
|
19
19
|
|
|
20
20
|
```shell npm icon=logos:npm
|
|
21
21
|
npm install @ocap/client
|
|
@@ -29,11 +29,11 @@ npm install @ocap/client
|
|
|
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');
|
|
@@ -51,10 +51,10 @@ if (OCapClient) {
|
|
|
51
51
|
node test-client.js
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
您應該會看到成功訊息輸出到主控台,這表示用戶端已準備就緒,可供使用。
|
|
55
55
|
|
|
56
56
|
## 後續步驟
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
現在您已經安裝了用戶端,可以準備連接到區塊鏈並開始發送請求。請繼續下一節來學習基礎知識。
|
|
59
59
|
|
|
60
60
|
- **[基本用法](./getting-started-basic-usage.md)**:學習如何初始化用戶端並進行您的第一次查詢。
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
# 安装
|
|
2
2
|
|
|
3
|
-
OCAP
|
|
3
|
+
OCAP Client 是一个 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
|
|
|
14
|
-
您可以使用 `npm` 或 `pnpm` 从 npm 注册表安装 `@ocap/client`
|
|
14
|
+
您可以使用 `npm` 或 `pnpm` 从 npm 注册表安装 `@ocap/client` 软件包。
|
|
15
15
|
|
|
16
16
|
### 使用 npm
|
|
17
17
|
|
|
@@ -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
|
-
```javascript
|
|
38
|
+
```javascript 验证安装 icon=logos:javascript
|
|
39
39
|
const OCapClient = require('@ocap/client');
|
|
40
40
|
|
|
41
41
|
if (OCapClient) {
|
|
42
|
-
console.log('
|
|
42
|
+
console.log('Successfully installed and imported @ocap/client!');
|
|
43
43
|
} else {
|
|
44
|
-
console.error('
|
|
44
|
+
console.error('Failed to import @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
60
|
- **[基本用法](./getting-started-basic-usage.md)**:学习如何初始化客户端并发起您的第一个查询。
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
# はじめに
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ようこそ!このガイドは、30分以内にOCAP Clientを使い始められるように案内します。クライアントのインストール方法、アプリケーションをOCAP互換のブロックチェーンに接続する方法、そしてセットアップを検証するための最初のAPIコールを行う方法を学びます。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
ネットワークとの対話を開始するために、以下の簡単なステップに従ってください。
|
|
6
6
|
|
|
7
7
|
<x-cards data-columns="2">
|
|
8
8
|
<x-card data-title="インストール" data-href="/getting-started/installation" data-icon="lucide:download">
|
|
9
|
-
npmまたはpnpm
|
|
9
|
+
npmまたはpnpmを使用して、プロジェクトにOCAP Clientパッケージを追加する方法を学びます。
|
|
10
10
|
</x-card>
|
|
11
11
|
<x-card data-title="基本的な使い方" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
|
|
12
|
-
|
|
12
|
+
クライアントを初期化し、ベータチェーンに接続し、セットアップを検証するための最初のAPIコールを行います。
|
|
13
13
|
</x-card>
|
|
14
14
|
</x-cards>
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
これらの初期ステップが完了すれば、より高度な機能を探求する準備が整います。実践的でタスク指向の例については、[ハウツーガイド](./how-to-guides.md)をご覧ください。
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 快速入門
|
|
2
2
|
|
|
3
|
-
歡迎!本指南將引導您在 30
|
|
3
|
+
歡迎!本指南將引導您在 30 分鐘內設定並執行 OCAP Client。您將學習如何安裝用戶端、將您的應用程式連接到與 OCAP 相容的區塊鏈,並進行您的第一次 API 呼叫以驗證您的設定。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
請遵循以下簡單步驟開始與網路互動。
|
|
6
6
|
|
|
7
7
|
<x-cards data-columns="2">
|
|
8
8
|
<x-card data-title="安裝" data-href="/getting-started/installation" data-icon="lucide:download">
|
|
9
|
-
了解如何使用 npm 或 pnpm 將 OCAP Client
|
|
9
|
+
了解如何使用 npm 或 pnpm 將 OCAP Client 套件新增至您的專案。
|
|
10
10
|
</x-card>
|
|
11
11
|
<x-card data-title="基本用法" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
|
|
12
|
-
|
|
12
|
+
初始化用戶端,連接到 Beta 鏈,並進行您的第一次 API 呼叫以驗證您的設定。
|
|
13
13
|
</x-card>
|
|
14
14
|
</x-cards>
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
完成這些初始步驟後,您就可以開始探索更進階的功能了。如需實用的、以任務為導向的範例,請務必查看 [操作指南](./how-to-guides.md)。
|
|
@@ -1,17 +1,16 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 快速入门
|
|
2
2
|
|
|
3
|
-
欢迎!本指南将帮助您在 30
|
|
4
|
-
您将学习如何安装客户端,将您的应用程序连接到兼容 OCAP 的区块链,并进行首次 API 调用以验证您的设置。
|
|
3
|
+
欢迎!本指南将帮助您在 30 分钟内快速上手 OCAP Client。您将学习如何安装该客户端,将您的应用程序连接到兼容 OCAP 的区块链,并进行您的第一次 API 调用以验证您的设置。
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
请按照以下简单步骤开始与网络交互。
|
|
7
6
|
|
|
8
7
|
<x-cards data-columns="2">
|
|
9
8
|
<x-card data-title="安装" data-href="/getting-started/installation" data-icon="lucide:download">
|
|
10
|
-
|
|
9
|
+
学习如何使用 npm 或 pnpm 将 OCAP Client 包添加到您的项目中。
|
|
11
10
|
</x-card>
|
|
12
11
|
<x-card data-title="基本用法" data-href="/getting-started/basic-usage" data-icon="lucide:play-circle">
|
|
13
|
-
初始化客户端,连接到 Beta
|
|
12
|
+
初始化客户端,连接到 Beta 链,并进行您的第一次 API 调用以验证您的设置。
|
|
14
13
|
</x-card>
|
|
15
14
|
</x-cards>
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
完成这些初始步骤后,您就可以探索更高级的功能了。有关实用的、面向任务的示例,请务必查看[操作指南](./how-to-guides.md)。
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# 権限の委任
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
権限の委任は、あるアカウント(委任者)が別のアカウント(受任者)に対し、自身に代わって特定の種類のトランザクションを送信することを許可する強力な機能です。これは、ユーザーの主要な秘密鍵に直接アクセスすることなく、ユーザーのためにアクションを実行する必要があるアプリケーションにとって特に便利です。例えば、特定の資産の移転やスマートコントラクトとの対話を行う権限をアプリケーション専用の鍵に委任することで、その鍵の権限範囲を限定し、セキュリティを向上させることができます。
|
|
4
4
|
|
|
5
5
|
このガイドでは、委任の付与、使用、取り消しの手順を説明します。
|
|
6
6
|
|
|
7
7
|
## 委任の付与
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
別のアカウントを承認するには、`delegate` メソッドを使用します。誰に委任するのか、そしてどの特定のトランザクションタイプを送信することを許可するのかを指定する必要があります。各権限には、関連するトークンや資産などの制限を設けることもできます。
|
|
10
10
|
|
|
11
11
|
### パラメータ
|
|
12
12
|
|
|
@@ -15,15 +15,15 @@
|
|
|
15
15
|
<x-field-desc markdown>委任者(権限を付与するアカウント)のウォレットオブジェクト。</x-field-desc>
|
|
16
16
|
</x-field>
|
|
17
17
|
<x-field data-name="to" data-type="WalletObject" data-required="true">
|
|
18
|
-
<x-field-desc markdown
|
|
18
|
+
<x-field-desc markdown>受任者(権限を受け取るアカウント)のウォレットオブジェクト。</x-field-desc>
|
|
19
19
|
</x-field>
|
|
20
20
|
<x-field data-name="privileges" data-type="Array<object>" data-required="true">
|
|
21
|
-
<x-field-desc markdown
|
|
21
|
+
<x-field-desc markdown>付与する権限オブジェクトの配列。各オブジェクトは特定の承認を定義します。</x-field-desc>
|
|
22
22
|
<x-field data-name="typeUrl" data-type="string" data-required="true">
|
|
23
23
|
<x-field-desc markdown>許可されるトランザクションのタイプ URL(例:`fg:t:transfer_v2`)。</x-field-desc>
|
|
24
24
|
</x-field>
|
|
25
25
|
<x-field data-name="limit" data-type="object" data-required="false">
|
|
26
|
-
<x-field-desc markdown
|
|
26
|
+
<x-field-desc markdown>権限に対するオプションの制限。特定のトークンや資産に限定するなど。</x-field-desc>
|
|
27
27
|
<x-field data-name="tokens" data-type="Array<string>" data-required="false" data-desc="この権限が適用されるトークンアドレスの配列。"></x-field>
|
|
28
28
|
<x-field data-name="assets" data-type="Array<string>" data-required="false" data-desc="この権限が適用される資産アドレスの配列。"></x-field>
|
|
29
29
|
</x-field>
|
|
@@ -32,13 +32,13 @@
|
|
|
32
32
|
|
|
33
33
|
### 戻り値
|
|
34
34
|
|
|
35
|
-
<x-field data-name="result" data-type="Promise<[string, string]>" data-desc="
|
|
35
|
+
<x-field data-name="result" data-type="Promise<[string, string]>" data-desc="トランザクションハッシュと新しく作成されたデリゲートアドレスを含む配列に解決される Promise。"></x-field>
|
|
36
36
|
|
|
37
37
|
### 例
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
あるアカウントから別のアカウントへ `transfer` 権限を委任する方法は次のとおりです。
|
|
40
40
|
|
|
41
|
-
```javascript
|
|
41
|
+
```javascript 移転権限の付与 icon=logos:javascript
|
|
42
42
|
import Client from '@ocap/client';
|
|
43
43
|
import { fromRandom } from '@ocap/wallet';
|
|
44
44
|
import { typeUrls } from '@ocap/proto';
|
|
@@ -54,7 +54,7 @@ const delegateeWallet = fromRandom();
|
|
|
54
54
|
async function grantPermission() {
|
|
55
55
|
try {
|
|
56
56
|
// まず、委任者アカウントに資金があることを確認します。
|
|
57
|
-
//
|
|
57
|
+
// 実際のアプリケーションでは、フォーセットや別のアカウントから
|
|
58
58
|
// delegatorWallet.address に資金を送金します。
|
|
59
59
|
console.log(`Delegator address: ${delegatorWallet.address}`);
|
|
60
60
|
console.log(`Delegatee address: ${delegateeWallet.address}`);
|
|
@@ -63,7 +63,7 @@ async function grantPermission() {
|
|
|
63
63
|
const privileges = [
|
|
64
64
|
{
|
|
65
65
|
typeUrl: typeUrls.TransferV2Tx,
|
|
66
|
-
//
|
|
66
|
+
// 制限は指定されておらず、任意のトークン/資産の移転を許可します
|
|
67
67
|
limit: { tokens: [], assets: [] },
|
|
68
68
|
},
|
|
69
69
|
];
|
|
@@ -85,25 +85,25 @@ async function grantPermission() {
|
|
|
85
85
|
grantPermission();
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
##
|
|
88
|
+
## 受任者としてトランザクションを送信する
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
委任が完了すると、受任者のウォレットはトランザクションパラメータで `delegator` のアドレスを指定することで、承認されたトランザクションを送信できます。トランザクションは受任者によって署名されますが、委任者に代わって実行され、トランザクション手数料は委任者のアカウントから支払われます。
|
|
91
91
|
|
|
92
92
|
### 例
|
|
93
93
|
|
|
94
|
-
```javascript
|
|
94
|
+
```javascript 受任者として移転を送信する icon=logos:javascript
|
|
95
95
|
// 前の例の grantPermission() 関数が成功したと仮定します
|
|
96
96
|
|
|
97
|
-
//
|
|
97
|
+
// 移転の受信者
|
|
98
98
|
const recipientWallet = fromRandom();
|
|
99
99
|
|
|
100
100
|
async function sendDelegatedTransaction() {
|
|
101
101
|
try {
|
|
102
102
|
const hash = await client.transfer({
|
|
103
103
|
to: recipientWallet.address,
|
|
104
|
-
token: 1, // チェーンのネイティブトークンを1
|
|
105
|
-
wallet: delegateeWallet, //
|
|
106
|
-
delegator: delegatorWallet.address, //
|
|
104
|
+
token: 1, // チェーンのネイティブトークンを1つ移転します
|
|
105
|
+
wallet: delegateeWallet, // 受任者によって署名されます
|
|
106
|
+
delegator: delegatorWallet.address, // 委任者に代わって実行されます
|
|
107
107
|
});
|
|
108
108
|
|
|
109
109
|
console.log('Delegated transfer successful!');
|
|
@@ -120,7 +120,7 @@ async function sendDelegatedTransaction() {
|
|
|
120
120
|
|
|
121
121
|
## 委任の取り消し
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
委任者は `revokeDelegate` メソッドを使用して、付与された権限をいつでも取り消すことができます。特定の受任者に対してどのトランザクションタイプを取り消すかを指定する必要があります。
|
|
124
124
|
|
|
125
125
|
### パラメータ
|
|
126
126
|
|
|
@@ -129,10 +129,10 @@ async function sendDelegatedTransaction() {
|
|
|
129
129
|
<x-field-desc markdown>最初に権限を付与した委任者のウォレットオブジェクト。</x-field-desc>
|
|
130
130
|
</x-field>
|
|
131
131
|
<x-field data-name="to" data-type="WalletObject" data-required="true">
|
|
132
|
-
<x-field-desc markdown
|
|
132
|
+
<x-field-desc markdown>権限が取り消される受任者のウォレットオブジェクト。</x-field-desc>
|
|
133
133
|
</x-field>
|
|
134
134
|
<x-field data-name="privileges" data-type="Array<string>" data-required="true">
|
|
135
|
-
<x-field-desc markdown
|
|
135
|
+
<x-field-desc markdown>取り消すトランザクション `typeUrl` 文字列の配列。</x-field-desc>
|
|
136
136
|
</x-field>
|
|
137
137
|
</x-field-group>
|
|
138
138
|
|
|
@@ -142,7 +142,7 @@ async function sendDelegatedTransaction() {
|
|
|
142
142
|
|
|
143
143
|
### 例
|
|
144
144
|
|
|
145
|
-
```javascript
|
|
145
|
+
```javascript 移転権限の取り消し icon=logos:javascript
|
|
146
146
|
// 前の例と同じ delegatorWallet と delegateeWallet を使用すると仮定します
|
|
147
147
|
|
|
148
148
|
async function revokePermission() {
|