@red-isbe/isbe-service-did-registry 1.1.0 → 2.0.0

package/README.md

@@ -34,7 +34,8 @@ const tx = await new ServiceDidRegistryTransactions(context)
   .buildRegisterServiceDidTx(controllerDid, publicKey, 1, "billing pipeline", 0, from);
 
 // …the caller signs it, broadcasts it, and then:
-const doc = await new ServiceDidRegistryQueries(context).toDidDocumentW3C(serviceDid);
+const { didDocument, didDocumentMetadata } =
+  await new ServiceDidRegistryQueries(context).resolve(serviceDid);
 ```
 
 Every write builder returns the transaction fields and stops there. `from` is used only to
@@ -46,8 +47,8 @@ on-chain, from the signature.
 | | |
 |---|---|
 | `ServiceDidRegistryContext` | Provider, Diamond address, network discriminator and curve |
-| `ServiceDidRegistryTransactions` | `buildRegisterServiceDidTx`, `buildUpdateServiceDocumentTx`, `buildRotateSigningKeyTx`, `buildUpdateExpiryTx`, `buildDeactivateServiceDidTx`, `buildInitializeServiceDidRegistryTx` |
-| `ServiceDidRegistryQueries` | `getServiceDid`, `getServiceDocument`, `getServiceDidsByController`, `getServiceDidsByAddress`, `findServiceDidsByAddress`, `isServiceDidActive`, `signingKeyAddressOf`, `computeServiceDid`, `toDidDocumentW3C` |
+| `ServiceDidRegistryTransactions` | `buildRegisterServiceDidTx`, `buildUpdateServiceDocumentTx`, `buildRotateSigningKeyTx`, `buildUpdateExpiryTx`, `buildDeactivateServiceDidTx`, `buildInitializeServiceDidRegistryTx`, `buildIndexServiceDidsByAddressTx`. They throw `ContractRevertError` when the call would revert |
+| `ServiceDidRegistryQueries` | `getServiceDid`, `getServiceDocument`, `getServiceDidsByController`, `isServiceDidActive`, `signingKeyAddressOf`, `serviceDidOf`, `isKnownServiceDid`, `serviceDidsOf`, `computeServiceDid`, `toDidDocumentW3C`, `resolve` |
 | `ServiceDidTransactionExecutor` | Broadcasts a signed transaction and waits for its receipt |
 | Derivation helpers | `buildServiceDid`, `parseServiceDid`, `computeServiceDidHex`, `serviceDidToHex`, `signingKeyAddress`, `toUncompressedPublicKey` |
 
@@ -59,15 +60,32 @@ carry any fields its organisation wants, as one JSON object:
 ```ts
 await transactions.buildRegisterServiceDidTx(
   controllerDid, publicKey, 1, "billing pipeline", 0, from,
-  { serviceEndpoint: "https://billing.example.com", companyName: "Example Ltd" },
+  {
+    name: "Billing",
+    service: [
+      { id: "#api", type: "InvoicingAPI", serviceEndpoint: "https://billing.example.com/v2" },
+    ],
+  },
 );
-await transactions.buildUpdateServiceDocumentTx(serviceDid, { serviceEndpoint: "https://new.example.com" }, from);
 ```
 
 It is stored on-chain and `toDidDocumentW3C` adds its fields to the DID Document. It may
 not set the members the registry derives (`RESERVED_DOCUMENT_KEYS`: `id`, `controller`,
-the keys and relationships…), it must fit in 4096 bytes, and it is public and permanent
-in the chain history. An update replaces the whole document; `null` clears it.
+the keys and relationships, `deactivated`, `reason`), it must fit in 4096 bytes, and it
+is public and permanent in the chain history. An update replaces the whole document;
+`null` clears it.
+
+Two members follow DID Core and are checked when the document is built:
+
+- `service` is a list of entries with `id`, `type` and `serviceEndpoint` (§5.4). An `id`
+  may be relative (`#api`); the resolver expands it to `did:isbe:svc:…#api`. Ids must be
+  unique; if two expand to the same id, the DID document keeps the first.
+- `@context` may add JSON-LD contexts for the extra fields, as absolute http(s) URLs.
+  They go after the two the registry always puts first.
+
+`getServiceDocument` returns the stored members as they are, minus the reserved ones,
+so a read, edit and write-back never loses data silently. Entries that break these
+rules (written without this library) are left out of the DID document only.
 
 ## The identifier
 
@@ -84,23 +102,48 @@ halves of that translation.
 
 ## Resolution
 
-`toDidDocumentW3C` produces a W3C DID Document. The verification method follows the curve
-of the key, not the network: on the network's own curve it carries a `blockchainAccountId`,
-on any other curve the coordinates as a JWK — publishing an address for a key no account
-can use would point a verifier at something that can never sign. The declared `@context`
-follows that same branch.
+`toDidDocumentW3C` produces a W3C DID Document with the same shape as an organisational
+one from `@red-isbe/did-isbe-registry`:
+
+- `@context`: `https://www.w3.org/ns/did/v1` and `https://w3id.org/security/suites/jws-2020/v1`;
+- `controller`: the organisational DID;
+- one `JsonWebKey2020` with the key in `publicKeyJwk`, on either curve;
+- the method id is the DID plus the RFC 7638 thumbprint of the key, the same id `did-gen`
+  prints for an organisational key;
+- `authentication` and `assertionMethod` point at that key.
+
+```json
+{
+  "@context": ["https://www.w3.org/ns/did/v1", "https://w3id.org/security/suites/jws-2020/v1"],
+  "id": "did:isbe:svc:uc:z1Ms…:3",
+  "controller": ["did:isbe:uc:z1Ms…"],
+  "verificationMethod": [{
+    "id": "did:isbe:svc:uc:z1Ms…:3#9lfZ28jd…",
+    "type": "JsonWebKey2020",
+    "controller": "did:isbe:svc:uc:z1Ms…:3",
+    "publicKeyJwk": { "kty": "EC", "crv": "secp256k1", "x": "…", "y": "…" }
+  }],
+  "authentication": ["did:isbe:svc:uc:z1Ms…:3#9lfZ28jd…"],
+  "assertionMethod": ["did:isbe:svc:uc:z1Ms…:3#9lfZ28jd…"],
+  "name": "Billing",
+  "service": [{ "id": "did:isbe:svc:uc:z1Ms…:3#api", "type": "InvoicingAPI", "serviceEndpoint": "https://billing.example.com/v2" }]
+}
+```
 
-A service also stops resolving as valid when its controlling organisation stops being
-operative. That cascade is evaluated only if the caller supplies it, because reading the
-organisational registry is not this library's job:
+Whether the identity is still valid is not part of the document. DID Core puts it in the
+document metadata (§7.1.3), which `resolve` returns next to the document:
 
 ```ts
-await queries.toDidDocumentW3C(serviceDid, { isControllerActive, now });
+const { didDocument, didDocumentMetadata } =
+  await queries.resolve(serviceDid, { isControllerActive, now });
+// didDocumentMetadata: { created, updated?, deactivated, reason? }
 ```
 
-The document then comes back marked `deactivated: true` with a `reason` —
-`deactivated`, `expired` or `controller-inactive` — so a caller can tell "this service was
-revoked" from "this service is fine but its organisation is not".
+`deactivated` is `true` when the service was deactivated, has expired, or its controlling
+organisation is no longer operative; `reason` says which — `deactivated`, `expired` or
+`controller-inactive`. The cascade of the organisation is evaluated only if the caller
+supplies `isControllerActive`, because reading the organisational registry is not this
+library's job.
 
 ## Relationship with `@red-isbe/did-isbe-registry`
 
@@ -116,20 +159,22 @@ vectors read from the DEV network, not computed by the functions themselves.
 
 ## Search by address
 
-Which service identities does an address belong to? The registry keeps no index by
-address: it derives it from each stored key, walking every organisation and its services.
+Which service identity does an address sign for? The registry keeps an index by address,
+the counterpart of `didOf` in the organisational registry, so the answer is one read:
 
 ```ts
-// Every service whose current key is this address (all pages walked for you)
-const services = await queries.findServiceDidsByAddress("0x4f6A…", { activeOnly: true });
+// The active service that address signs for, or null
+const serviceDid = await queries.serviceDidOf("0x4f6A…");
 
-// Or one page at a time: pagination counts organisations, not matches
-const page = await queries.getServiceDidsByAddress("0x4f6A…", 1, 50);
+// Every non-deactivated service whose current key is that address
+const records = await queries.serviceDidsOf("0x4f6A…");
 ```
 
-Only the current key matches: after a rotation the old address no longer finds the
-service. The cost grows with the number of organisations, so it is meant for reads, not
-for hot paths. Needs a registry with the address search (isbe-contracts ISBECORE-354).
+`serviceDidOf` also applies the cascade of the organisation: if it no longer holds a
+capability invocation in force, the answer is `null`. Only the current key matches:
+after a rotation the old address no longer finds the service. Needs a registry with the
+address index; services registered before it are found once the admin has run
+`indexServiceDidsByAddress` (`buildIndexServiceDidsByAddressTx`).
 
 ## Tests
 

package/dist/index.d.ts

@@ -14,13 +14,15 @@
 * limitations under the License.
 */
 export { ServiceDidRegistryContext } from "./src/ServiceDidRegistryContext.js";
-export { ServiceDidRegistryQueries } from "./src/ServiceDidRegistryQueries.js";
+export { ServiceDidRegistryQueries, SERVICE_DID_DOCUMENT_CONTEXT, } from "./src/ServiceDidRegistryQueries.js";
+export type { ResolveServiceDidOptions } from "./src/ServiceDidRegistryQueries.js";
 export { ServiceDidRegistryTransactions } from "./src/ServiceDidRegistryTransactions.js";
 export { ServiceDidTransactionExecutor } from "./src/ServiceDidTransactionExecutor.js";
-export type { ServiceDidRecord, ServiceDidParts, ServiceDidInactiveReason, GetServiceDidsByControllerResult, GetServiceDidsByAddressResult, FindServiceDidsByAddressOptions, } from "./src/serviceDid.types.js";
-export type { DidW3CDocument } from "./src/types.js";
+export type { ServiceDidRecord, ServiceDidParts, ServiceDidInactiveReason, GetServiceDidsByControllerResult, ServiceDidDocumentMetadata, ServiceDidResolutionResult, } from "./src/serviceDid.types.js";
+export type { DidService, DidW3CDocument } from "./src/types.js";
 export { MAX_SERVICE_DOCUMENT_BYTES, RESERVED_DOCUMENT_KEYS, ServiceDocumentError, parseServiceDocument, serializeServiceDocument, } from "./src/utils/serviceDocument.utils.js";
 export type { ServiceDocument } from "./src/utils/serviceDocument.utils.js";
 export { buildServiceDid, parseServiceDid, serviceDidToHex, computeServiceDidHex, signingKeyAddress, toUncompressedPublicKey, } from "./src/utils/serviceDid.utils.js";
 export { didToHex, hexToDid } from "./src/utils/did.utils.js";
+export { ContractRevertError } from "./src/utils/blockchain.utils.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAEvF,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,wBAAwB,EACxB,gCAAgC,EAChC,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,sCAAsC,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAE5E,OAAO,EACL,eAAe,EACf,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,iCAAiC,CAAC;AAKzC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EACL,yBAAyB,EACzB,4BAA4B,GAC7B,MAAM,oCAAoC,CAAC;AAC5C,YAAY,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAEvF,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,wBAAwB,EACxB,gCAAgC,EAChC,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,sCAAsC,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAE5E,OAAO,EACL,eAAe,EACf,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,iCAAiC,CAAC;AAKzC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAI9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC"}

package/dist/index.js

@@ -14,7 +14,7 @@
 * limitations under the License.
 */
 export { ServiceDidRegistryContext } from "./src/ServiceDidRegistryContext.js";
-export { ServiceDidRegistryQueries } from "./src/ServiceDidRegistryQueries.js";
+export { ServiceDidRegistryQueries, SERVICE_DID_DOCUMENT_CONTEXT, } from "./src/ServiceDidRegistryQueries.js";
 export { ServiceDidRegistryTransactions } from "./src/ServiceDidRegistryTransactions.js";
 export { ServiceDidTransactionExecutor } from "./src/ServiceDidTransactionExecutor.js";
 export { MAX_SERVICE_DOCUMENT_BYTES, RESERVED_DOCUMENT_KEYS, ServiceDocumentError, parseServiceDocument, serializeServiceDocument, } from "./src/utils/serviceDocument.utils.js";
@@ -23,4 +23,7 @@ export { buildServiceDid, parseServiceDid, serviceDidToHex, computeServiceDidHex
 // paquete comparte con @red-isbe/did-isbe-registry, y tenerla accesible permite
 // comprobar desde fuera que ambas implementaciones coinciden.
 export { didToHex, hexToDid } from "./src/utils/did.utils.js";
+// Lanzado al construir una transacción que revertiría; mismo error que la librería de
+// organizaciones, para tratar los de ambos registros igual.
+export { ContractRevertError } from "./src/utils/blockchain.utils.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAWvF,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EACL,eAAe,EACf,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,iCAAiC,CAAC;AAEzC,sFAAsF;AACtF,gFAAgF;AAChF,8DAA8D;AAC9D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EACL,yBAAyB,EACzB,4BAA4B,GAC7B,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAWvF,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EACL,eAAe,EACf,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,iCAAiC,CAAC;AAEzC,sFAAsF;AACtF,gFAAgF;AAChF,8DAA8D;AAC9D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAE9D,sFAAsF;AACtF,4DAA4D;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC"}

package/dist/src/ServiceDidRegistryQueries.d.ts

@@ -16,12 +16,17 @@
 import { parseServiceDid, serviceDidToHex } from "./utils/serviceDid.utils.js";
 import { ServiceDidRegistryContext } from "./ServiceDidRegistryContext.js";
 import { type ServiceDocument } from "./utils/serviceDocument.utils.js";
-import type { FindServiceDidsByAddressOptions, GetServiceDidsByAddressResult, GetServiceDidsByControllerResult, ServiceDidInactiveReason, ServiceDidRecord } from "./serviceDid.types.js";
+import type { GetServiceDidsByControllerResult, ServiceDidRecord, ServiceDidResolutionResult } from "./serviceDid.types.js";
 import type { DidW3CDocument } from "./types.js";
 /** secp256k1, the curve the Case network operates on. */
 export declare const ELLIPTIC_TYPE_SECP256K1 = 1;
 /** P-256, the curve the Bare network operates on. */
 export declare const ELLIPTIC_TYPE_P256 = 2;
+/**
+ * Contexts every service DID Document starts with: DID Core, then the suite that
+ * defines `JsonWebKey2020`. The same pair the organisational registry publishes.
+ */
+export declare const SERVICE_DID_DOCUMENT_CONTEXT: readonly string[];
 /**
  * Options for resolving a service identity into a W3C DID Document.
  */
@@ -65,35 +70,33 @@ export declare class ServiceDidRegistryQueries {
      */
     getServiceDidsByController(controllerDid: string, page?: number, pageSize?: number): Promise<GetServiceDidsByControllerResult>;
     /**
-     * Lists, one page at a time, the service identities whose current signing key
-     * derives `address`.
+     * Resolves an address to the service identity it currently signs for, the
+     * counterpart of `didOf` in the organisational registry.
      *
-     * The registry keeps no index by address: it walks the global list of organisational
-     * DIDs and, for each one, every service it controls, deriving the address from the
-     * stored key. Pagination therefore applies to **organisations**, not to matches —
-     * `total`, `howMany`, `prev` and `next` count organisations, and a page may come back
-     * empty while a later one does not. Use `findServiceDidsByAddress` to walk them all.
+     * One read of the registry's address index, whatever the number of organisations.
+     * Returns `null` when nothing usable is found: no service holds a key deriving the
+     * address, every such service is deactivated or expired, or their organisation no
+     * longer holds a capability invocation in force (the registry applies that cascade
+     * itself here). When several services of one organisation share the key, the most
+     * recently registered active one is returned.
      *
-     * Only the current key matches: a key rotated away no longer does. Deactivated and
-     * expired identities are returned as well; filter them with `isServiceDidActive` or
-     * the record's own fields. Needs a registry with the address search (ISBECORE-354).
+     * Needs a registry with the address index; against an older one the call fails.
      */
-    getServiceDidsByAddress(address: string, page?: number, pageSize?: number): Promise<GetServiceDidsByAddressResult>;
+    serviceDidOf(address: string): Promise<string | null>;
+    /** The counterpart of `isKnownDid`: true when `serviceDidOf` finds a service. */
+    isKnownServiceDid(address: string): Promise<boolean>;
     /**
-     * Finds every service identity whose current signing key derives `address`, walking
-     * all the pages of `getServiceDidsByAddress`.
-     *
-     * With `activeOnly`, identities that are deactivated or past their expiry are left
-     * out. The cascade of the controlling organisation is not evaluated here; it belongs
-     * to `toDidDocumentW3C`.
+     * Every service identity whose current key derives `address`, read from the address
+     * index. Deactivated identities are not indexed; expired ones are, and the cascade
+     * of the organisation is not applied. Needs a registry with the address index.
      */
-    findServiceDidsByAddress(address: string, options?: FindServiceDidsByAddressOptions): Promise<ServiceDidRecord[]>;
+    serviceDidsOf(address: string): Promise<ServiceDidRecord[]>;
     /**
      * Reports whether a service identity is usable right now.
      *
      * False for an unknown identifier as well as for one deactivated or past its expiry,
      * so it never throws. It does not evaluate the parent: that cascade belongs to
-     * `toDidDocumentW3C`.
+     * `resolve`.
      */
     isServiceDidActive(serviceDid: string): Promise<boolean>;
     /**
@@ -114,25 +117,32 @@ export declare class ServiceDidRegistryQueries {
     /**
      * Resolves a service identity into a W3C DID Document.
      *
-     * Three things can make an identity resolve as no longer valid, and they are checked
-     * in this order: it was deactivated, it passed its expiry, or its controlling
-     * organisation stopped being operative. The last one is only evaluated when the
-     * caller supplies `isControllerActive`.
-     *
-     * The verification method depends on the curve, not on the network: a key on the
-     * network's own curve yields `EcdsaSecp256k1RecoveryMethod2020` with a
-     * `blockchainAccountId`, and any other curve yields `JsonWebKey2020` carrying the
-     * coordinates. Emitting a `blockchainAccountId` for a key no account can use would
-     * point a verifier at an address that can never sign.
+     * The document has the same shape as an organisational one from
+     * `@red-isbe/did-isbe-registry`: the same `@context`, a `JsonWebKey2020` with the key
+     * in `publicKeyJwk` whatever the curve, and a method id made of the DID and the RFC
+     * 7638 thumbprint of the key — the same id `did-gen` gives an organisational key.
      *
      * The service's free-form fields, if any, are added to the document. They can never
-     * override what the registry asserts: the identifier, the controller, the keys and
-     * the deactivation status always come from the record.
+     * override what the registry asserts: the identifier, the controller and the keys
+     * always come from the record. A `service` entry with a relative id (`#api`) is
+     * expanded against the service DID, and any `@context` the document declares is
+     * appended after the two the registry puts first.
+     *
+     * Whether the identity is still valid is not part of the document: DID Core puts it
+     * in the document metadata, which `resolve` returns.
+     */
+    toDidDocumentW3C(serviceDid: string): Promise<DidW3CDocument>;
+    /**
+     * Resolves a service identity into a DID resolution result: the document plus its
+     * metadata (DID Core §7.1).
+     *
+     * Three things can make an identity no longer valid, and they are checked in this
+     * order: it was deactivated, it passed its expiry, or its controlling organisation
+     * stopped being operative. The last one is only evaluated when the caller supplies
+     * `isControllerActive`. Any of them sets `deactivated: true` in the metadata, with
+     * the `reason`; the document is returned all the same, as DID Core allows.
      */
-    toDidDocumentW3C(serviceDid: string, options?: ResolveServiceDidOptions): Promise<DidW3CDocument & {
-        deactivated?: boolean;
-        reason?: ServiceDidInactiveReason;
-    }>;
+    resolve(serviceDid: string, options?: ResolveServiceDidOptions): Promise<ServiceDidResolutionResult>;
     /** Reads a service identity by its on-chain digest. */
     private getServiceDidByHex;
     /** Derives the identifier a controller and nonce produce, without a network call. */

package/dist/src/ServiceDidRegistryQueries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ServiceDidRegistryQueries.d.ts","sourceRoot":"","sources":["../../src/ServiceDidRegistryQueries.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAIF,OAAO,EAEL,eAAe,EACf,eAAe,EAEhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EACV,+BAA+B,EAC/B,6BAA6B,EAC7B,gCAAgC,EAChC,wBAAwB,EACxB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,yDAAyD;AACzD,eAAO,MAAM,uBAAuB,IAAI,CAAC;AACzC,qDAAqD;AACrD,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,2EAA2E;IAC3E,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,aAAa,CAA4B;gBAErC,aAAa,EAAE,yBAAyB;IAIpD;;;;;;OAMG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYlE;;;;;OAKG;IACG,0BAA0B,CAC9B,aAAa,EAAE,MAAM,EACrB,IAAI,SAAI,EACR,QAAQ,SAAK,GACZ,OAAO,CAAC,gCAAgC,CAAC;IAyB5C;;;;;;;;;;;;;OAaG;IACG,uBAAuB,CAC3B,OAAO,EAAE,MAAM,EACf,IAAI,SAAI,EACR,QAAQ,SAAK,GACZ,OAAO,CAAC,6BAA6B,CAAC;IAwBzC;;;;;;;OAOG;IACG,wBAAwB,CAC5B,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,+BAAoC,GAC5C,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAuB9B;;;;;;OAMG;IACG,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO9D;;;;;;OAMG;IACG,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO9D;;;;;OAKG;IACG,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAY7E;;;;;;;;;;;;;;;;;OAiBG;IACG,gBAAgB,CACpB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,cAAc,GAAG;QAAE,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,wBAAwB,CAAA;KAAE,CAAC;IAUzF,uDAAuD;YACzC,kBAAkB;IAShC,qFAAqF;IACrF,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;YAI1D,cAAc;YAkBd,aAAa;IAiD3B;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;CAsBjB;AAED,wFAAwF;AACxF,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"ServiceDidRegistryQueries.d.ts","sourceRoot":"","sources":["../../src/ServiceDidRegistryQueries.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAIF,OAAO,EAEL,eAAe,EACf,eAAe,EAEhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAIL,KAAK,eAAe,EACrB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EACV,gCAAgC,EAGhC,gBAAgB,EAChB,0BAA0B,EAC3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAc,cAAc,EAAE,MAAM,YAAY,CAAC;AAE7D,yDAAyD;AACzD,eAAO,MAAM,uBAAuB,IAAI,CAAC;AACzC,qDAAqD;AACrD,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;;GAGG;AACH,eAAO,MAAM,4BAA4B,EAAE,SAAS,MAAM,EAGzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,2EAA2E;IAC3E,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,aAAa,CAA4B;gBAErC,aAAa,EAAE,yBAAyB;IAIpD;;;;;;OAMG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYlE;;;;;OAKG;IACG,0BAA0B,CAC9B,aAAa,EAAE,MAAM,EACrB,IAAI,SAAI,EACR,QAAQ,SAAK,GACZ,OAAO,CAAC,gCAAgC,CAAC;IAyB5C;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAS3D,iFAAiF;IAC3E,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO1D;;;;OAIG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAQjE;;;;;;OAMG;IACG,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO9D;;;;;;OAMG;IACG,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO9D;;;;;OAKG;IACG,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAY7E;;;;;;;;;;;;;;;;OAgBG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAMnE;;;;;;;;;OASG;IACG,OAAO,CACX,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,0BAA0B,CAAC;IAoBtC,uDAAuD;YACzC,kBAAkB;IAShC,qFAAqF;IACrF,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;YAI1D,cAAc;IAkB5B,OAAO,CAAC,aAAa;IAuDrB;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;CAsBjB;AAED,wFAAwF;AACxF,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC"}