Skip to main content

API Summary

HCS14Client

MethodParameters (summary)ReturnsNotes
createUaid(data, params?, opts?)data: CanonicalAgentData, params: DidRoutingParams, opts: { includeParams?: boolean }Promise<string>Generates uaid:aid:.... Canonicalizes 6 fields, hashes (SHA‑384 → Base58). When includeParams === false, omits routing params.
createUaid(did, params?)did: string, params: DidRoutingParamsstringGenerates uaid:did:.... Sanitizes method‑specific id (strips ; ? #). Adds src (multibase b58btc) if sanitization removed a suffix.
parseHcs14Did(value)value: stringParsed UAID object (method, id, params)Parses UAID into method, id, and params.
createDid({ method, ... })DidIssueRequestPromise<string>Issues a DID via registered issuers (e.g., method hedera). Hedera requires a configured Client.
createDidWithUaid({ issue, proto?, uid?, nativeId? })issue: DidIssueRequest, optional proto, uid, nativeIdObject with did, uaid, parsedIssues a DID, then generates UAID. For Hedera + proto hcs-10, derives uid (inboundTopicId@accountId when available) and nativeId (Hedera CAIP‑10) when not provided.
getIssuerRegistry() / getResolverRegistry()registriesAccess registries to register/list/filter adapters.
listIssuers() / listResolvers()arraysIntrospection of registered adapters (includes meta).
filterIssuersByMethod(method) / filterResolversByMethod(method)method: stringarraysFind adapters that support a DID method.

CAIP Helpers

HelperSignatureReturnsNotes
toHederaCaip10(network: HederaNetwork, accountId: string)stringBuilds hedera:<network>:<accountId>. Validates input.
parseHederaCaip10(value: string)Object with network and accountIdParses and validates a Hedera CAIP‑10 string.
isHederaNetwork(value: string)booleanType guard for Hedera networks.
isHederaCaip10(value: string)booleanValidates Hedera CAIP‑10 format.
toEip155Caip10(chainId: number or string, address: string)stringBuilds eip155:<chainId>:<0xAddress>. Validates input.
isEip155Caip10(value: string)booleanValidates EIP‑155 CAIP‑10 format.

HederaNetwork values: mainnet, testnet, previewnet, devnet.

UAID Grammar

  • uaid:aid:{base58hash};uid={uid};registry={registry};proto={protocol};nativeId={nativeId};domain={domain}
  • uaid:did:{methodSpecificId};uid={uid};proto={protocol};nativeId={nativeId};domain={domain};src=z…