歡迎使用 DID Space Client SDK！本指南將引導您完成安裝、設定 SDK 以及執行首次檔案上傳的基本步驟。只需幾分鐘，您就可以開始使用了。
先決條件
在開始之前，請確保您具備以下條件：
- 已設定一個 Blocklet 專案。
- 一個 DID Space 端點 URL。若要了解如何取得，請參閱 Connect to DID Spaces。
步驟 1：安裝 SDK
首先，使用您偏好的套件管理器將 @blocklet/did-space-js 套件新增到您的專案中。
使用 npm 安裝
npm install @blocklet/did-space-js使用 yarn 安裝
yarn add @blocklet/did-space-js步驟 2：初始化 SpaceClient
SpaceClient 是與 SDK 互動的主要進入點。要初始化它，您需要提供身份驗證憑證。在 Blocklet 環境中，最簡單的方法是使用當前 Blocklet 的錢包和您的 space 端點。
初始化客戶端
import { SpaceClient } from '@blocklet/did-space-js';
import getWallet from '@blocklet/sdk/lib/wallet';
// 這會擷取由 Blocklet 環境管理的錢包。
const wallet = getWallet();
// 請替換為您實際的 DID Space 端點。
const endpoint = 'https://your-space-endpoint.did.abtnet.io/api/space/...';
const spaceClient = new SpaceClient({
auth: {
wallet,
endpoint,
},
});步驟 3：上傳檔案
客戶端初始化後，您現在可以傳送指令了。我們將使用 PutObjectCommand 來上傳一個簡單的文字檔案。
指令遵循一致的模式：您使用其所需輸入建立一個指令實例，然後將其傳遞給 spaceClient.send() 方法。
send 方法會回傳一個包含請求狀態的輸出物件。statusCode 為 200 表示成功。
上傳檔案
import { PutObjectCommand } from '@blocklet/did-space-js';
import { Buffer } from 'buffer';
async function uploadFile() {
const command = new PutObjectCommand({
// 您 DID Space 中檔案的名稱（或物件金鑰）。
key: 'greeting.txt',
// 檔案的內容。最好使用 Buffer。
data: Buffer.from('Hello from the DID Space SDK!'),
});
const output = await spaceClient.send(command);
if (output.statusCode === 200) {
console.log('Success! Your file has been uploaded.');
} else {
console.error(`Upload failed with status ${output.statusCode}: ${output.statusMessage}`);
}
}
uploadFile();完整範例
這是一個結合了上述所有步驟的完整、可直接執行的範例。您可以將此程式碼放置在您的 Blocklet 專案中的一個非同步函式內。
完整範例
import { SpaceClient, PutObjectCommand } from '@blocklet/did-space-js';
import getWallet from '@blocklet/sdk/lib/wallet';
import { Buffer } from 'buffer';
async function run() {
// 1. 初始化客戶端
const wallet = getWallet();
const endpoint = 'https://your-space-endpoint.did.abtnet.io/api/space/...'; // TODO: 請替換為您的端點
const spaceClient = new SpaceClient({
auth: {
wallet,
endpoint,
},
});
console.log('Client initialized. Preparing to upload file...');
// 2. 建立並傳送上傳指令
const command = new PutObjectCommand({
key: 'greeting.txt',
data: Buffer.from('Hello from the DID Space SDK!'),
});
const output = await spaceClient.send(command);
// 3. 檢查結果
if (output.statusCode === 200) {
console.log('Success! Your file has been uploaded.');
} else {
console.error(`Upload failed with status ${output.statusCode}: ${output.statusMessage}`);
console.error('Stack trace:', output.stack);
}
}
run().catch(console.error);執行此程式碼後，您應該會在您的 DID Space 中看到 greeting.txt 檔案。
後續步驟
恭喜！您已成功使用 DID Space Client SDK 上傳了您的第一個檔案。
現在您已經掌握了基礎知識，可以探索更進階的主題：