跳到主要內容

@arcblock/did

此套件提供了一個 JavaScript 函式庫,用於處理 ArcBlock 的去中心化身分(DID)協定。它允許您建立、管理和驗證 DID,這些是建構 OCAP 平台應用程式的基礎。本節涵蓋了該函式庫的基本功能。

若想更深入地了解其底層原理,請參閱我們的 核心概念。有關所有可用功能的詳細說明,請參閱 API 參考

安裝

首先,請使用 npm 或您偏好的套件管理器來安裝必要的套件。

安裝

bash
npm install @ocap/mcrypto @arcblock/did

快速入門

您可以輕鬆地從一個私鑰生成一個新的 DID。該函式庫會處理密碼學操作,以根據指定的角色和密碼學類型派生公鑰並建構相應的 DID 地址。

從私鑰生成 DID

javascript
const Mcrypto = require('@ocap/mcrypto');
const { fromSecretKey } = require('@arcblock/did');

// 從 Mcrypto 解構所需的類型
const { types } = Mcrypto;

// 1. 生成一個新的 Ed25519 金鑰對
const keyPair = Mcrypto.Signer.Ed25519.genKeyPair();

// 2. 從私鑰生成 DID
// 我們指定角色、公鑰類型和雜湊演算法
const didAddress = fromSecretKey(keyPair.secretKey, {
  role: types.RoleType.ROLE_APPLICATION,
  pk: types.KeyType.ED25519,
  hash: types.HashType.SHA3,
});

// 3. 完整的 DID 字串包含 'abt:did:' 前綴
console.log(`Generated DID: abt:did:${didAddress}`);

此範例展示了建立應用程式 DID 的基本工作流程。有關更進階的使用案例,例如從公鑰建立 DID 或驗證 DID 所有權,請參閱以下各節的詳細指南。

後續步驟

透過探索以下各節,深入了解 ArcBlock DID 的具體細節。