Skip to main content

Adapters (Issuers & Resolvers)

Adapters let you add DID methods without forking the SDK.

Resolver DX is adapter-first:

  • register with registerAdapter(...)
  • discover with listAdapters() / filterAdapters(...)
  • resolve with resolveDidProfile(...) / resolveUaidProfile(...)

IssuersDirect link to Issuers​

Register issuers to create new DIDs. The SDK ships with a Hedera issuer.

import { HCS14Client, HederaHieroIssuer } from '@hashgraphonline/standards-sdk';
const hcs14 = new HCS14Client();

// Register Hedera issuer (built‑in)
hcs14.getIssuerRegistry().register(new HederaHieroIssuer());

// Issue a did:hedera (requires configured Hedera Client)
const did = await hcs14.createDid({ method: 'hedera', client });

// Discover available issuers
const issuers = hcs14.listIssuers();

Custom issuers implement DidIssuer and validate their own inputs.

import type { DidIssuer, DidIssueRequest } from '@hashgraphonline/standards-sdk';

class WebDidIssuer implements DidIssuer {
  readonly meta = { id: 'web/custom', didMethods: ['web'] };
  supports(m: string) { return m === 'web'; }
  async issue(_req: DidIssueRequest) { return 'did:web:agent.example'; }
}

hcs14.getIssuerRegistry().register(new WebDidIssuer());

ResolversDirect link to Resolvers​

Resolvers map DIDs to DID Documents. The SDK includes a Hedera resolver.

import {
  HCS14Client,
  HieroDidResolver,
  isUaidProfileResolverAdapter,
} from '@hashgraphonline/standards-sdk';
const hcs14 = new HCS14Client();

hcs14.registerAdapter(new HieroDidResolver());

const didResolverIds = hcs14
  .filterAdapters({ capability: 'did-resolver' })
  .map(record => record.adapter.meta?.id || 'unknown');

const uaidProfileIds = hcs14
  .filterAdapters({ capability: 'uaid-profile-resolver' })
  .map(record => record.adapter)
  .filter(isUaidProfileResolverAdapter)
  .map(adapter => adapter.profile);

const didProfile = await hcs14.resolveDidProfile('did:hedera:testnet:0.0.1234');
const uaidProfile = await hcs14.resolveUaidProfile('uaid:did:z6Mk...;uid=0;proto=hcs-10;nativeId=hedera:testnet:0.0.1234');

For full resolver and profile resolver coverage, see Resolvers.

Built‑in AdaptersDirect link to Built‑in Adapters​

  • Issuer: Hedera (Hiero Registrar)
    • id: hedera/hiero
    • didMethods: ['hedera']
    • caip2Networks: ['hedera:mainnet','hedera:testnet','hedera:previewnet','hedera:devnet']
  • Resolver: Hedera (Hiero Resolver)
    • id: hedera/hiero-resolver
    • didMethods: ['hedera']
    • caip2Networks: ['hedera:mainnet','hedera:testnet','hedera:previewnet','hedera:devnet']

Contribute New AdaptersDirect link to Contribute New Adapters​

We welcome PRs that add issuers and resolvers for additional DID methods.

  • Minimal requirements

    • Implement DidIssuer or DidResolver with meaningful meta (id, didMethods, optional caip2Networks/caip10Namespaces).
    • Add unit tests that exercise supports, issue/resolve, and basic error paths.
    • Export from src/hcs-14/issuers/<name>.ts or src/hcs-14/resolvers/<name>.ts and wire into src/hcs-14/index.ts.
    • Update these docs with a short usage snippet.

  • Standards & style

    • No inline comments; use JSDoc.
    • No any/casts to force types; keep adapters precisely typed.
    • Follow existing naming/structure; keep diffs minimal and focused.

Open a PR with a clear description, links to any method specs, and basic validation steps. We’ll help review and ship it.

  • Issuers folder (add your file):
  • Resolvers folder (add your file):
  • Export from the HCS‑14 index:

Add small tests, then open a PR linking to your DID method’s spec or documentation.