@red-isbe/isbe-service-did-registry 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,129 @@
+# @red-isbe/isbe-service-did-registry
+
+Client library for the **ISBE Service DID Registry**: operational identities — services,
+pipelines, agents — under the `did:isbe:svc:` sub-namespace, controlled by an
+organisational `did:isbe`.
+
+The registry is a facet of the same EIP-2535 Diamond the organisational DID Registry lives
+in, so this library points at the same address. What differs is the ABI each one carries.
+
+## Install
+
+```bash
+npm install @red-isbe/isbe-service-did-registry
+```
+
+## Use
+
+```ts
+import {
+  ServiceDidRegistryContext,
+  ServiceDidRegistryQueries,
+  ServiceDidRegistryTransactions,
+} from "@red-isbe/isbe-service-did-registry";
+
+const context = new ServiceDidRegistryContext(
+  provider,          // ethers JsonRpcProvider
+  "uc-dev",          // model deploy id
+  diamondAddress,
+  1,                 // network curve: 1 = secp256k1, 2 = P-256
+);
+
+// Writes return an UNSIGNED transaction. This library never holds a key.
+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);
+```
+
+Every write builder returns the transaction fields and stops there. `from` is used only to
+look up that account's nonce — it authorises nothing. Who may perform the call is decided
+on-chain, from the signature.
+
+## What it offers
+
+| | |
+|---|---|
+| `ServiceDidRegistryContext` | Provider, Diamond address, network discriminator and curve |
+| `ServiceDidRegistryTransactions` | `buildRegisterServiceDidTx`, `buildUpdateServiceDocumentTx`, `buildRotateSigningKeyTx`, `buildUpdateExpiryTx`, `buildDeactivateServiceDidTx`, `buildInitializeServiceDidRegistryTx` |
+| `ServiceDidRegistryQueries` | `getServiceDid`, `getServiceDocument`, `getServiceDidsByController`, `isServiceDidActive`, `signingKeyAddressOf`, `computeServiceDid`, `toDidDocumentW3C` |
+| `ServiceDidTransactionExecutor` | Broadcasts a signed transaction and waits for its receipt |
+| Derivation helpers | `buildServiceDid`, `parseServiceDid`, `computeServiceDidHex`, `serviceDidToHex`, `signingKeyAddress`, `toUncompressedPublicKey` |
+
+## Service documents
+
+On top of the fixed minimum — controller, key, curve, label, expiry — each service may
+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" },
+);
+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 identifier
+
+On-chain a service identity is keyed by `keccak256(abi.encode(controllerDid, uint64 nonce))`
+— a full digest, not invertible. The readable form therefore carries its own pre-image:
+
+```
+did:isbe:svc:<network>:<parent segment>:<nonce>
+```
+
+so the string can be turned back into the digest with no network call, and so a reader can
+see which organisation owns it. `computeServiceDidHex` and `parseServiceDid` are the two
+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.
+
+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:
+
+```ts
+await queries.toDidDocumentW3C(serviceDid, { isControllerActive, now });
+```
+
+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".
+
+## Relationship with `@red-isbe/did-isbe-registry`
+
+This package is independent: it imports nothing from the organisational registry library,
+and a consumer that only deals with service identities does not need it.
+
+What the two share is the encoding of an organisational DID into its bytes32 form. Those
+functions — `didToHex` and `hexToDid` — are duplicated here rather than depended upon, and
+are exported so the equivalence can be checked from outside. **They must never diverge**: a
+service registered through one package would become unresolvable through the other, with
+nothing failing loudly. `src/utils/__test__/did.utils.test.ts` pins the behaviour with
+vectors read from the DEV network, not computed by the functions themselves.
+
+## Tests
+
+```bash
+npm test
+```
+
+53 tests across two suites. The ESM one exists because `multiformats` is ESM-only and the
+base58 encoding has to be exercised for real, not mocked.
+
+## Requirement
+
+The Diamond must have the Service DID Registry facet cut into it. Without it every call
+from this library reverts.

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+/**
+* Copyright (c) 2025 Comunidad de Madrid & Alastria
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+*
+* You may obtain a copy of the License at
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+export { ServiceDidRegistryContext } from "./src/ServiceDidRegistryContext.js";
+export { ServiceDidRegistryQueries } from "./src/ServiceDidRegistryQueries.js";
+export { ServiceDidRegistryTransactions } from "./src/ServiceDidRegistryTransactions.js";
+export { ServiceDidTransactionExecutor } from "./src/ServiceDidTransactionExecutor.js";
+export type { ServiceDidRecord, ServiceDidParts, ServiceDidInactiveReason, GetServiceDidsByControllerResult, } from "./src/serviceDid.types.js";
+export type { 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";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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,GACjC,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"}

package/dist/index.js

@@ -0,0 +1,26 @@
+/**
+* Copyright (c) 2025 Comunidad de Madrid & Alastria
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+*
+* You may obtain a copy of the License at
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+export { ServiceDidRegistryContext } from "./src/ServiceDidRegistryContext.js";
+export { ServiceDidRegistryQueries } 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";
+export { buildServiceDid, parseServiceDid, serviceDidToHex, computeServiceDidHex, signingKeyAddress, toUncompressedPublicKey, } from "./src/utils/serviceDid.utils.js";
+// La codificación del DID organizacional se exporta a propósito: es la pieza que este
+// 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";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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;AASvF,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"}

package/dist/src/ServiceDidRegistryContext.d.ts

@@ -0,0 +1,40 @@
+/**
+* Copyright (c) 2025 Comunidad de Madrid & Alastria
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+*
+* You may obtain a copy of the License at
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+import { Contract, JsonRpcProvider } from "ethers";
+/**
+ * Binding to the Service DID Registry facet.
+ *
+ * The address is the same diamond the DID Registry lives in — the registry is a facet,
+ * not a separate contract — so a consumer that needs both surfaces holds two contexts
+ * pointing at one address, each carrying its own ABI.
+ *
+ * `modelDeployId` is the network discriminator that appears in DID strings ("uc" for
+ * Case), the same value `DidRegistryContext` carries.
+ *
+ * `networkEllipticType` is the curve the network itself operates on — secp256k1 on
+ * Case, P-256 on Bare. It is configuration rather than something read from the chain:
+ * the registry stores the curve of each key but exposes no getter for the network's
+ * own, and a resolver needs it to decide whether a derived address is usable.
+ */
+export declare class ServiceDidRegistryContext {
+    provider: JsonRpcProvider;
+    modelDeployId: string;
+    contractAddress: string;
+    networkEllipticType: number;
+    contract: Contract;
+    constructor(provider: JsonRpcProvider, modelDeployId: string, diamondAddress: string, networkEllipticType?: number);
+}
+//# sourceMappingURL=ServiceDidRegistryContext.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceDidRegistryContext.d.ts","sourceRoot":"","sources":["../../src/ServiceDidRegistryContext.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAGnD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,yBAAyB;IACpC,QAAQ,EAAE,eAAe,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,QAAQ,CAAC;gBAGjB,QAAQ,EAAE,eAAe,EACzB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,mBAAmB,SAAI;CAY1B"}

package/dist/src/ServiceDidRegistryContext.js

@@ -0,0 +1,42 @@
+/**
+* Copyright (c) 2025 Comunidad de Madrid & Alastria
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+*
+* You may obtain a copy of the License at
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+import { Contract, JsonRpcProvider } from "ethers";
+import { IServiceDidRegistryAbi } from "./abi/IServiceDidRegistry.abi.js";
+/**
+ * Binding to the Service DID Registry facet.
+ *
+ * The address is the same diamond the DID Registry lives in — the registry is a facet,
+ * not a separate contract — so a consumer that needs both surfaces holds two contexts
+ * pointing at one address, each carrying its own ABI.
+ *
+ * `modelDeployId` is the network discriminator that appears in DID strings ("uc" for
+ * Case), the same value `DidRegistryContext` carries.
+ *
+ * `networkEllipticType` is the curve the network itself operates on — secp256k1 on
+ * Case, P-256 on Bare. It is configuration rather than something read from the chain:
+ * the registry stores the curve of each key but exposes no getter for the network's
+ * own, and a resolver needs it to decide whether a derived address is usable.
+ */
+export class ServiceDidRegistryContext {
+    constructor(provider, modelDeployId, diamondAddress, networkEllipticType = 1) {
+        this.provider = provider;
+        this.modelDeployId = modelDeployId;
+        this.contractAddress = diamondAddress;
+        this.networkEllipticType = networkEllipticType;
+        this.contract = new Contract(this.contractAddress, IServiceDidRegistryAbi, this.provider);
+    }
+}
+//# sourceMappingURL=ServiceDidRegistryContext.js.map

package/dist/src/ServiceDidRegistryContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceDidRegistryContext.js","sourceRoot":"","sources":["../../src/ServiceDidRegistryContext.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAE1E;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,yBAAyB;IAOpC,YACE,QAAyB,EACzB,aAAqB,EACrB,cAAsB,EACtB,mBAAmB,GAAG,CAAC;QAEvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAC1B,IAAI,CAAC,eAAe,EACpB,sBAA0C,EAC1C,IAAI,CAAC,QAAQ,CACd,CAAC;IACJ,CAAC;CACF"}

package/dist/src/ServiceDidRegistryQueries.d.ts

@@ -0,0 +1,127 @@
+/**
+* Copyright (c) 2025 Comunidad de Madrid & Alastria
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+*
+* You may obtain a copy of the License at
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+import { parseServiceDid, serviceDidToHex } from "./utils/serviceDid.utils.js";
+import { ServiceDidRegistryContext } from "./ServiceDidRegistryContext.js";
+import { type ServiceDocument } from "./utils/serviceDocument.utils.js";
+import type { GetServiceDidsByControllerResult, ServiceDidInactiveReason, ServiceDidRecord } 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;
+/**
+ * Options for resolving a service identity into a W3C DID Document.
+ */
+export type ResolveServiceDidOptions = {
+    /**
+     * Reports whether the controlling organisation is still operative.
+     *
+     * Deactivating a parent is not propagated on-chain — writing to every child would
+     * cost gas and add nothing the parent's own state does not already say — so the
+     * cascade is applied here, at resolution time. Supplied as a callback rather than
+     * by importing the organisational queries, so this module stays independent of them
+     * and the caller decides what "operative" means for its deployment.
+     *
+     * When omitted the cascade is not evaluated, and a service whose parent is no longer
+     * operative will still resolve as valid.
+     */
+    isControllerActive?: (controllerDid: string) => Promise<boolean>;
+    /** Seconds since the epoch to evaluate expiry against. Defaults to now. */
+    now?: number;
+};
+/**
+ * Read surface of the Service DID Registry, and the resolver for the
+ * `did:isbe:svc:` sub-namespace.
+ */
+export declare class ServiceDidRegistryQueries {
+    private configManager;
+    constructor(configManager: ServiceDidRegistryContext);
+    /**
+     * Reads a service identity.
+     *
+     * Reverts on-chain for an identifier that was never registered; use
+     * `isServiceDidActive` to probe without an exception. Expired and deactivated
+     * records are returned verbatim, so the caller applies its own validity policy.
+     */
+    getServiceDid(serviceDid: string): Promise<ServiceDidRecord>;
+    /**
+     * Lists the service identities of a controller.
+     *
+     * Pages start at one, matching the registry's other paginated getters, and `total`
+     * comes back alongside the page — which is why there is no separate count call.
+     */
+    getServiceDidsByController(controllerDid: string, page?: number, pageSize?: number): Promise<GetServiceDidsByControllerResult>;
+    /**
+     * 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`.
+     */
+    isServiceDidActive(serviceDid: string): Promise<boolean>;
+    /**
+     * Address derived from the signing key of a service identity.
+     *
+     * Only meaningful when the key is on the curve the network operates on. For any
+     * other curve no account can transact with it, and it must not be published as a
+     * `blockchainAccountId`.
+     */
+    signingKeyAddressOf(serviceDid: string): Promise<string>;
+    /**
+     * Reads the free-form fields of a service identity, or `null` when it has none.
+     *
+     * Also `null` against a registry deployed before documents existed, where the call
+     * itself fails: resolution keeps working there, it just has no extra fields to add.
+     */
+    getServiceDocument(serviceDid: string): Promise<ServiceDocument | null>;
+    /**
+     * 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 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.
+     */
+    toDidDocumentW3C(serviceDid: string, options?: ResolveServiceDidOptions): Promise<DidW3CDocument & {
+        deactivated?: boolean;
+        reason?: ServiceDidInactiveReason;
+    }>;
+    /** Derives the identifier a controller and nonce produce, without a network call. */
+    computeServiceDid(controllerDid: string, nonce: bigint | number): string;
+    private inactiveReason;
+    private buildDocument;
+    /**
+     * Maps the on-chain struct into the shape this library returns.
+     *
+     * The readable identifier is rebuilt from the controller and the nonce rather than
+     * from the record's own key: a service identifier is a full digest, so the DID string
+     * cannot be recovered from it. Storing the nonce is what makes this possible.
+     */
+    private toRecord;
+}
+/** Re-exported so a caller can parse a service DID without importing the utils path. */
+export { parseServiceDid, serviceDidToHex };
+//# sourceMappingURL=ServiceDidRegistryQueries.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceDidRegistryQueries.d.ts","sourceRoot":"","sources":["../../src/ServiceDidRegistryQueries.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAGF,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,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;;;;;;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,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"}