DID ISBE TS Library

TypeScript library to interact with the ISBE DID Registry contract from Node.js. It provides utilities to build transactions, query data, and convert formats used by the DID registry.

Requirements

• Node.js 18 or higher
• npm 9 or higher
• TypeScript 5.9 or higher

Build

npm install
npm run build
npm run test

Main exported classes

• DidRegistryContext: Initializes and maintains the connection context (provider, deployment model, and DID Registry contract).
• DidRegistryQueries: Provides read-only methods to query DIDs and DID Documents in the contract.
• DidRegistryTransactions: Builds transactions for write operations on DIDs.
• BlockchainTransactionExecutor: Sends signed transactions and allows waiting for blockchain confirmation.

Basic usage

Example: querying a DID Document

1) Install package

npm install @red-isbe/did-isbe-registry

2) Import and initialize

import { JsonRpcProvider } from "ethers";
import { DidRegistryContext } from "@red-isbe/did-isbe-registry";

const rpcUrl = "http://your-rpc-url";
const modelDeployId = "uc-dev";
const didRegistryAddress = "0x00000000000000000000000000000000000015BE";

const provider = new JsonRpcProvider(rpcUrl);
const context = new DidRegistryContext(
  provider,
  modelDeployId,
  didRegistryAddress,
);

3) Usage

import { DidRegistryQueries } from "@red-isbe/did-isbe-registry";

const did = "did:isbe:uc-dev:z1VDuuYvwpXRNoi9HG9gYga1nPfG";
const queries = new DidRegistryQueries(context);

const doc = await queries.getDidDocument(did);
console.log("DID Document:", doc);

License

Apache-2.0

Copyright © 2025 Comunidad de Madrid & Alastria