@did-btcr2/api 0.2.1 → 0.3.0

package/dist/esm/method.js

@@ -0,0 +1,262 @@
+import { IdentifierTypes, NotImplementedError } from '@did-btcr2/common';
+import { BeaconSignalDiscovery, DidBtcr2 } from '@did-btcr2/method';
+import { assertBytes, assertCompressedPubkey, assertString, NOOP_LOGGER } from './helpers.js';
+/**
+ * DID method operations sub-facade: create, resolve, update, deactivate.
+ *
+ * Lazily initialized by {@link DidBtcr2Api} because it depends on
+ * {@link BitcoinApi} which requires network configuration.
+ * @public
+ */
+export class DidMethodApi {
+    #btc;
+    #cas;
+    #log;
+    constructor(btc, cas, logger) {
+        this.#btc = btc;
+        this.#cas = cas;
+        this.#log = logger ?? NOOP_LOGGER;
+    }
+    /**
+     * Create a deterministic (k1) DID from a public key.
+     * Sets idType to KEY automatically.
+     * @param genesisBytes The compressed public key bytes (33 bytes).
+     * @param options Creation options (idType is set for you).
+     * @returns The created DID identifier string.
+     */
+    createDeterministic(genesisBytes, options = {}) {
+        assertCompressedPubkey(genesisBytes, 'genesisBytes');
+        return DidBtcr2.create(genesisBytes, { ...options, idType: IdentifierTypes.KEY });
+    }
+    /**
+     * Create a non-deterministic (x1) DID from external genesis document bytes.
+     * Sets idType to EXTERNAL automatically.
+     * @param genesisBytes The genesis document bytes.
+     * @param options Creation options (idType is set for you).
+     * @returns The created DID identifier string.
+     */
+    createExternal(genesisBytes, options = {}) {
+        assertBytes(genesisBytes, 'genesisBytes');
+        return DidBtcr2.create(genesisBytes, { ...options, idType: IdentifierTypes.EXTERNAL });
+    }
+    /**
+     * Resolve a DID by driving the sans-I/O {@link Resolver} state machine.
+     * If a Bitcoin connection is configured on the API, it is used automatically
+     * to fetch beacon signals. Sidecar data flows through `options.sidecar`.
+     * @param did The DID to resolve.
+     * @param options Resolution options.
+     * @returns The resolution result.
+     */
+    async resolve(did, options) {
+        assertString(did, 'did');
+        this.#log.debug('Resolving DID', did);
+        try {
+            const resolver = DidBtcr2.resolve(did, options);
+            let state = resolver.resolve();
+            while (state.status === 'action-required') {
+                for (const need of state.needs) {
+                    switch (need.kind) {
+                        case 'NeedBeaconSignals': {
+                            if (!this.#btc) {
+                                throw new Error('Bitcoin connection required to fetch beacon signals. '
+                                    + 'Configure a BitcoinApi on the DidBtcr2Api instance.');
+                            }
+                            this.#log.debug('Fetching beacon signals for %d service(s)', need.beaconServices.length);
+                            const signals = await BeaconSignalDiscovery.indexer([...need.beaconServices], this.#btc.connection);
+                            resolver.provide(need, signals);
+                            break;
+                        }
+                        case 'NeedGenesisDocument': {
+                            if (!this.#cas) {
+                                throw new Error(`Genesis document required but not in sidecar (hash: ${need.genesisHash}), `
+                                    + 'and no CAS driver configured. Either provide the genesis document via '
+                                    + 'options.sidecar.genesisDocument or configure a CAS driver.');
+                            }
+                            this.#log.debug('Fetching genesis document from CAS: %s', need.genesisHash);
+                            const doc = await this.#cas.retrieve(need.genesisHash);
+                            if (!doc) {
+                                throw new Error(`Genesis document not found in CAS (hash: ${need.genesisHash}).`);
+                            }
+                            resolver.provide(need, doc);
+                            break;
+                        }
+                        case 'NeedCASAnnouncement': {
+                            if (!this.#cas) {
+                                throw new Error(`CAS announcement required but not in sidecar (hash: ${need.announcementHash}), `
+                                    + 'and no CAS driver configured. Either provide it via '
+                                    + 'options.sidecar.casUpdates or configure a CAS driver.');
+                            }
+                            this.#log.debug('Fetching CAS announcement from CAS: %s', need.announcementHash);
+                            const announcement = await this.#cas.retrieve(need.announcementHash);
+                            if (!announcement) {
+                                throw new Error(`CAS announcement not found in CAS (hash: ${need.announcementHash}).`);
+                            }
+                            resolver.provide(need, announcement);
+                            break;
+                        }
+                        case 'NeedSignedUpdate': {
+                            if (!this.#cas) {
+                                throw new Error(`Signed update required but not in sidecar (hash: ${need.updateHash}), `
+                                    + 'and no CAS driver configured. Either provide it via '
+                                    + 'options.sidecar.updates or configure a CAS driver.');
+                            }
+                            this.#log.debug('Fetching signed update from CAS: %s', need.updateHash);
+                            const update = await this.#cas.retrieve(need.updateHash);
+                            if (!update) {
+                                throw new Error(`Signed update not found in CAS (hash: ${need.updateHash}).`);
+                            }
+                            resolver.provide(need, update);
+                            break;
+                        }
+                    }
+                }
+                state = resolver.resolve();
+            }
+            this.#log.debug('DID resolved successfully', did, state.result.metadata);
+            return {
+                didResolutionMetadata: {},
+                didDocument: state.result.didDocument,
+                didDocumentMetadata: state.result.metadata,
+            };
+        }
+        catch (err) {
+            this.#log.error('DID resolution failed', did, err);
+            throw new Error(`Failed to resolve DID: ${did}`, { cause: err });
+        }
+    }
+    /**
+     * Update an existing DID document. If a Bitcoin connection is configured on
+     * the API, it is injected automatically.
+     * @param params The update parameters.
+     * @returns The signed update.
+     */
+    async update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, signingMaterial, bitcoin, }) {
+        const btcConnection = bitcoin ?? this.#btc?.connection ?? undefined;
+        return await DidBtcr2.update({
+            sourceDocument,
+            patches,
+            sourceVersionId,
+            verificationMethodId,
+            beaconId,
+            signingMaterial,
+            bitcoin: btcConnection,
+        });
+    }
+    /**
+     * Get the signing method from a DID document by method ID.
+     * @param didDocument The DID document.
+     * @param methodId The method ID (if omitted, the first signing method is returned).
+     * @returns The found signing method.
+     */
+    getSigningMethod(didDocument, methodId) {
+        return DidBtcr2.getSigningMethod(didDocument, methodId);
+    }
+    /**
+     * Create a fluent builder for a DID update operation.
+     * @param sourceDocument The current DID document to update.
+     * @returns An {@link UpdateBuilder} for chaining update parameters.
+     *
+     * @example
+     * ```ts
+     * const signed = await api.btcr2
+     *   .buildUpdate(currentDoc)
+     *   .patch({ op: 'add', path: '/service/1', value: newService })
+     *   .version(2)
+     *   .signer('#initialKey')
+     *   .beacon('#beacon-0')
+     *   .execute();
+     * ```
+     */
+    buildUpdate(sourceDocument) {
+        return new UpdateBuilder(this, sourceDocument);
+    }
+    /** Deactivate a DID (not yet implemented in the core method). */
+    async deactivate() {
+        throw new NotImplementedError('DidMethodApi.deactivate is not implemented yet.', {
+            type: 'DID_API_METHOD_NOT_IMPLEMENTED',
+            name: 'NOT_IMPLEMENTED_ERROR'
+        });
+    }
+}
+/**
+ * Fluent builder for DID update operations. Reduces the cognitive load of
+ * the 7-parameter `update()` call by letting callers chain named steps.
+ *
+ * Created via {@link DidMethodApi.buildUpdate}.
+ * @public
+ */
+export class UpdateBuilder {
+    #methodApi;
+    #sourceDocument;
+    #patches = [];
+    #sourceVersionId;
+    #verificationMethodId;
+    #beaconId;
+    #signingMaterial;
+    #bitcoin;
+    /** @internal */
+    constructor(methodApi, sourceDocument) {
+        this.#methodApi = methodApi;
+        this.#sourceDocument = sourceDocument;
+    }
+    /** Add a single JSON Patch operation. Can be called multiple times. */
+    patch(op) {
+        this.#patches.push(op);
+        return this;
+    }
+    /** Set all patches at once (replaces any previously added). */
+    patches(ops) {
+        this.#patches = [...ops];
+        return this;
+    }
+    /** Set the source version ID. */
+    version(id) {
+        this.#sourceVersionId = id;
+        return this;
+    }
+    /** Set the verification method ID used for signing. */
+    signer(methodId) {
+        this.#verificationMethodId = methodId;
+        return this;
+    }
+    /** Set the beacon ID for the update announcement. */
+    beacon(beaconId) {
+        this.#beaconId = beaconId;
+        return this;
+    }
+    /** Set the signing material (secret key bytes or hex). */
+    signingMaterial(material) {
+        this.#signingMaterial = material;
+        return this;
+    }
+    /** Override the Bitcoin connection for this update. */
+    withBitcoin(connection) {
+        this.#bitcoin = connection;
+        return this;
+    }
+    /**
+     * Execute the update.
+     * @throws {Error} If required fields (version, signer, beacon) are missing.
+     */
+    async execute() {
+        if (this.#sourceVersionId === undefined) {
+            throw new Error('UpdateBuilder: sourceVersionId is required. Call .version(id) before .execute().');
+        }
+        if (!this.#verificationMethodId) {
+            throw new Error('UpdateBuilder: verificationMethodId is required. Call .signer(id) before .execute().');
+        }
+        if (!this.#beaconId) {
+            throw new Error('UpdateBuilder: beaconId is required. Call .beacon(id) before .execute().');
+        }
+        return this.#methodApi.update({
+            sourceDocument: this.#sourceDocument,
+            patches: this.#patches,
+            sourceVersionId: this.#sourceVersionId,
+            verificationMethodId: this.#verificationMethodId,
+            beaconId: this.#beaconId,
+            signingMaterial: this.#signingMaterial,
+            bitcoin: this.#bitcoin,
+        });
+    }
+}
+//# sourceMappingURL=method.js.map

package/dist/esm/method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"method.js","sourceRoot":"","sources":["../../src/method.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAGzE,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAIpE,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG9F;;;;;;GAMG;AACH,MAAM,OAAO,YAAY;IACvB,IAAI,CAAc;IAClB,IAAI,CAAU;IACd,IAAI,CAAS;IAEb,YAAY,GAAgB,EAAE,GAAY,EAAE,MAAe;QACzD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,WAAW,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,YAAsB,EAAE,UAA4C,EAAE;QACxF,sBAAsB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACrD,OAAO,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,YAA2B,EAAE,UAA4C,EAAE;QACxF,WAAW,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,OAA2B;QACpD,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,KAAK,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;YAE/B,OAAM,KAAK,CAAC,MAAM,KAAK,iBAAiB,EAAE,CAAC;gBACzC,KAAI,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;oBAC9B,QAAO,IAAI,CAAC,IAAI,EAAE,CAAC;wBACjB,KAAK,mBAAmB,CAAC,CAAC,CAAC;4BACzB,IAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gCACd,MAAM,IAAI,KAAK,CACb,uDAAuD;sCACrD,qDAAqD,CACxD,CAAC;4BACJ,CAAC;4BACD,IAAI,CAAC,IAAI,CAAC,KAAK,CACb,2CAA2C,EAC3C,IAAI,CAAC,cAAc,CAAC,MAAM,CAC3B,CAAC;4BACF,MAAM,OAAO,GAAG,MAAM,qBAAqB,CAAC,OAAO,CACjD,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAC/C,CAAC;4BACF,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;4BAChC,MAAM;wBACR,CAAC;wBACD,KAAK,qBAAqB,CAAC,CAAC,CAAC;4BAC3B,IAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gCACd,MAAM,IAAI,KAAK,CACb,uDAAuD,IAAI,CAAC,WAAW,KAAK;sCAC1E,wEAAwE;sCACxE,4DAA4D,CAC/D,CAAC;4BACJ,CAAC;4BACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,wCAAwC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;4BAC5E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;4BACvD,IAAG,CAAC,GAAG,EAAE,CAAC;gCACR,MAAM,IAAI,KAAK,CACb,4CAA4C,IAAI,CAAC,WAAW,IAAI,CACjE,CAAC;4BACJ,CAAC;4BACD,QAAQ,CAAC,OAAO,CAAC,IAA2B,EAAE,GAAG,CAAC,CAAC;4BACnD,MAAM;wBACR,CAAC;wBACD,KAAK,qBAAqB,CAAC,CAAC,CAAC;4BAC3B,IAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gCACd,MAAM,IAAI,KAAK,CACb,uDAAuD,IAAI,CAAC,gBAAgB,KAAK;sCAC/E,sDAAsD;sCACtD,uDAAuD,CAC1D,CAAC;4BACJ,CAAC;4BACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,wCAAwC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;4BACjF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;4BACrE,IAAG,CAAC,YAAY,EAAE,CAAC;gCACjB,MAAM,IAAI,KAAK,CACb,4CAA4C,IAAI,CAAC,gBAAgB,IAAI,CACtE,CAAC;4BACJ,CAAC;4BACD,QAAQ,CAAC,OAAO,CAAC,IAA2B,EAAE,YAA+B,CAAC,CAAC;4BAC/E,MAAM;wBACR,CAAC;wBACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;4BACxB,IAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gCACd,MAAM,IAAI,KAAK,CACb,oDAAoD,IAAI,CAAC,UAAU,KAAK;sCACtE,sDAAsD;sCACtD,oDAAoD,CACvD,CAAC;4BACJ,CAAC;4BACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,qCAAqC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;4BACxE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;4BACzD,IAAG,CAAC,MAAM,EAAE,CAAC;gCACX,MAAM,IAAI,KAAK,CACb,yCAAyC,IAAI,CAAC,UAAU,IAAI,CAC7D,CAAC;4BACJ,CAAC;4BACD,QAAQ,CAAC,OAAO,CAAC,IAAwB,EAAE,MAA2B,CAAC,CAAC;4BACxE,MAAM;wBACR,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,KAAK,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC7B,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACzE,OAAO;gBACL,qBAAqB,EAAG,EAAE;gBAC1B,WAAW,EAAa,KAAK,CAAC,MAAM,CAAC,WAA4D;gBACjG,mBAAmB,EAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;aAC9C,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,IAAI,KAAK,CACb,0BAA0B,GAAG,EAAE,EAC/B,EAAE,KAAK,EAAE,GAAG,EAAE,CACf,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EACX,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,eAAe,EACf,OAAO,GASR;QACC,MAAM,aAAa,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,UAAU,IAAI,SAAS,CAAC;QACpE,OAAO,MAAM,QAAQ,CAAC,MAAM,CAAC;YAC3B,cAAc;YACd,OAAO;YACP,eAAe;YACf,oBAAoB;YACpB,QAAQ;YACR,eAAe;YACf,OAAO,EAAG,aAAa;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,WAA6B,EAAE,QAAiB;QAC/D,OAAO,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,cAAgC;QAC1C,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,mBAAmB,CAC3B,iDAAiD,EACjD;YACE,IAAI,EAAG,gCAAgC;YACvC,IAAI,EAAG,uBAAuB;SAC/B,CACF,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAa;IACxB,UAAU,CAAe;IACzB,eAAe,CAAmB;IAClC,QAAQ,GAAqB,EAAE,CAAC;IAChC,gBAAgB,CAAU;IAC1B,qBAAqB,CAAU;IAC/B,SAAS,CAAU;IACnB,gBAAgB,CAAwB;IACxC,QAAQ,CAAqB;IAE7B,gBAAgB;IAChB,YAAY,SAAuB,EAAE,cAAgC;QACnE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,CAAC;IAED,uEAAuE;IACvE,KAAK,CAAC,EAAkB;QACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+DAA+D;IAC/D,OAAO,CAAC,GAAqB;QAC3B,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iCAAiC;IACjC,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uDAAuD;IACvD,MAAM,CAAC,QAAgB;QACrB,IAAI,CAAC,qBAAqB,GAAG,QAAQ,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qDAAqD;IACrD,MAAM,CAAC,QAAgB;QACrB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0DAA0D;IAC1D,eAAe,CAAC,QAA8B;QAC5C,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uDAAuD;IACvD,WAAW,CAAC,UAA6B;QACvC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,sFAAsF,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAC9F,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC5B,cAAc,EAAS,IAAI,CAAC,eAAe;YAC3C,OAAO,EAAgB,IAAI,CAAC,QAAQ;YACpC,eAAe,EAAQ,IAAI,CAAC,gBAAgB;YAC5C,oBAAoB,EAAG,IAAI,CAAC,qBAAqB;YACjD,QAAQ,EAAe,IAAI,CAAC,SAAS;YACrC,eAAe,EAAQ,IAAI,CAAC,gBAAgB;YAC5C,OAAO,EAAgB,IAAI,CAAC,QAAQ;SACrC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/types/api.d.ts

@@ -1,113 +1,123 @@
-import { BitcoinCoreRpcClient, BitcoinNetworkConnection, BitcoinRestClient, BlockV3, RawTransactionV2, RestClientConfigParams, RpcClientConfig } from '@did-btcr2/bitcoin';
-import type { Bytes, CryptosuiteName, DocumentBytes, Entropy, HashBytes, Hex, HexString, JSONObject, KeyBytes, PatchOperation, ProofBytes, SchnorrKeyPairObject, SignatureBytes } from '@did-btcr2/common';
-import { IdentifierTypes } from '@did-btcr2/common';
-import type { MultikeyObject, SignedBTCR2Update } from '@did-btcr2/cryptosuite';
-import { SchnorrMultikey } from '@did-btcr2/cryptosuite';
-import { SchnorrKeyPair } from '@did-btcr2/keypair';
-import type { Btcr2DidDocument, DidCreateOptions, ResolutionOptions, SidecarData } from '@did-btcr2/method';
-import { DidDocument, DidDocumentBuilder, Identifier } from '@did-btcr2/method';
-import type { DidResolutionResult, DidService, DidVerificationMethod } from '@web5/dids';
-export { DidDocument, DidDocumentBuilder, Identifier, IdentifierTypes };
-export type { BlockV3, Bytes, CryptosuiteName, DidResolutionResult, DidService, DidVerificationMethod, DocumentBytes, HashBytes, Hex, JSONObject, KeyBytes, MultikeyObject, PatchOperation, ProofBytes, RawTransactionV2, RestClientConfigParams, RpcClientConfig, SchnorrKeyPairObject, SignatureBytes };
-export type NetworkName = 'mainnet' | 'testnet4' | 'signet' | 'regtest';
-export type BitcoinApiConfig = {
-    /** Shortcut to compute base URLs and params via @did-btcr2/bitcoin getNetwork */
-    network?: NetworkName;
-    /** Override REST client settings */
-    rest?: RestClientConfigParams;
-    /** Override RPC client settings */
-    rpc?: RpcClientConfig;
-    /** Default number of confirmations to consider "final" */
-    defaultConfirmations?: number;
-};
-export type ApiConfig = {
-    bitcoin?: BitcoinApiConfig;
-};
-export declare class KeyPairApi {
-    /** Generate a new Schnorr keypair (secp256k1). */
-    static generate(): SchnorrKeyPair;
-    /** Import from secret key bytes or bigint. */
-    static fromSecret(ent: Entropy): SchnorrKeyPair;
-}
-export declare class MultikeyApi {
+import type { NetworkName } from '@did-btcr2/bitcoin';
+import type { DocumentBytes, KeyBytes, PatchOperation } from '@did-btcr2/common';
+import { SignedBTCR2Update } from '@did-btcr2/cryptosuite';
+import { KeyIdentifier } from '@did-btcr2/kms';
+import type { Btcr2DidDocument, DidCreateOptions, ResolutionOptions } from '@did-btcr2/method';
+import type { DidResolutionResult } from '@web5/dids';
+import { BitcoinApi } from './bitcoin.js';
+import { CasApi } from './cas.js';
+import { CryptoApi } from './crypto.js';
+import { DidApi } from './did.js';
+import { KeyManagerApi } from './kms.js';
+import { DidMethodApi } from './method.js';
+import type { ApiConfig, ResolutionResult } from './types.js';
+/**
+ * Main DidBtcr2Api facade — the primary entry point for the SDK.
+ *
+ * Exposes sub-facades for Bitcoin, DID Method, KeyPair, Crypto, and
+ * KeyManager operations. Created via the {@link createApi} factory.
+ * @public
+ */
+export declare class DidBtcr2Api {
+    #private;
+    /** Cryptographic operations (keypair, multikey, cryptosuite, proof). */
+    readonly crypto: CryptoApi;
+    /** DID identifier operations (encode, decode, generate, parse). */
+    readonly did: DidApi;
+    /** Key management operations. */
+    readonly kms: KeyManagerApi;
+    constructor(config?: ApiConfig);
     /**
-     * Create a Schnorr Multikey wrapper (includes verificationMethod, sign/verify).
-     * If secret is present, the multikey can sign.
+     * Bitcoin API sub-facade (lazily initialized).
+     * Only available when `btc` config was provided to the constructor.
+     * @throws {Error} If the instance has been disposed or no Bitcoin config was provided.
      */
-    static create(params: {
-        id: string;
-        controller: string;
-        keys: SchnorrKeyPair;
-    }): SchnorrMultikey;
-    /** Produce a DID Verification Method JSON from a multikey. */
-    static toVerificationMethod(mk: SchnorrMultikey): DidVerificationMethod;
-    /** Sign bytes via the multikey (requires secret). */
-    static sign(mk: SchnorrMultikey, data: Bytes): Promise<SignatureBytes>;
-    /** Verify signature via multikey. */
-    static verify(mk: SchnorrMultikey, data: Bytes, signature: SignatureBytes): Promise<boolean>;
-}
-export declare class CryptoApi {
-    static keyPairApi: KeyPairApi;
-    static multikeyApi: MultikeyApi;
-}
-export declare class BitcoinApi {
-    readonly rest: BitcoinRestClient;
-    readonly rpc: BitcoinCoreRpcClient;
-    readonly defaultConfirmations: number;
-    constructor(cfg?: BitcoinApiConfig);
-    /** Fetch a transaction by txid via REST. */
-    getTransaction(txid: string): Promise<import("@did-btcr2/bitcoin").RawTransactionRest>;
-    /** Broadcast a raw tx (hex) via REST. */
-    send(rawTxHex: string): Promise<string>;
-    /** Get UTXOs for an address via REST. */
-    getUtxos(address: string): Promise<import("@did-btcr2/bitcoin").AddressUtxo[]>;
-    /** Get a block by hash or height via REST. */
-    getBlock(params: {
-        hash?: string;
-        height?: number;
-    }): Promise<import("@did-btcr2/bitcoin").BlockResponse | undefined>;
-}
-export declare class DidApi {
+    get btc(): BitcoinApi;
+    /**
+     * CAS API sub-facade (lazily initialized).
+     * Only available when `cas` config was provided to the constructor.
+     * @throws {Error} If the instance has been disposed or no CAS config was provided.
+     */
+    get cas(): CasApi;
+    /**
+     * DID Method API sub-facade (lazily initialized with bitcoin + CAS wiring).
+     * @throws {Error} If the instance has been disposed.
+     */
+    get btcr2(): DidMethodApi;
     /**
-     * Create a deterministic DID from a public key (bytes).
+     * Whether this API instance has been disposed.
      */
-    createDeterministic({ genesisBytes, options }: {
-        genesisBytes: KeyBytes;
-        options: DidCreateOptions;
-    }): Promise<string>;
+    get disposed(): boolean;
     /**
-     * Create from an intermediate DID document (external genesis).
+     * Create a DID using either deterministic (KEY) or external (EXTERNAL) mode.
+     * @param type The creation mode.
+     * @param genesisBytes Public key bytes (deterministic) or document bytes (external).
+     * @param options Creation options (idType is set for you).
+     * @returns The created DID identifier string.
      */
-    createExternal({ genesisBytes, options }: {
-        genesisBytes: DocumentBytes;
-        options: DidCreateOptions;
-    }): Promise<string>;
+    createDid(type: 'deterministic' | 'external', genesisBytes: KeyBytes | DocumentBytes, options?: Omit<DidCreateOptions, 'idType'>): string;
     /**
-     * Resolve DID document from DID (did:btcr2:...).
+     * Generate a new DID, create the keypair, and import it into the KMS.
+     * @param options Optional settings.
+     * @param options.setActive Whether to set the imported key as active in the KMS (default `true`).
+     * @param options.network Network for the generated DID (default `'regtest'`).
+     * @returns The generated DID string and KMS key identifier.
      */
-    resolve(did: string, options: ResolutionOptions): Promise<DidResolutionResult>;
+    generateDid(options?: {
+        setActive?: boolean;
+        network?: NetworkName;
+    }): {
+        did: string;
+        keyId: KeyIdentifier;
+    };
     /**
-     * Update a DID Document using a JSON Patch, signed as capabilityInvocation.
-     * You provide the prior DID Document (to pick VM), a JSON Patch, and a signer multikey.
-     * This delegates to MethodUpdate (which follows the cryptosuite rules internally).
+     * Resolve a DID, automatically injecting the configured Bitcoin connection.
+     * @param did The DID to resolve.
+     * @param options Optional resolution options.
+     * @returns The resolution result.
      */
-    update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, signingMaterial, bitcoin, }: {
-        sourceDocument: Btcr2DidDocument;
+    resolveDid(did: string, options?: ResolutionOptions): Promise<DidResolutionResult>;
+    /**
+     * Resolve a DID and return a discriminated result instead of throwing.
+     * Useful when resolution failure is an expected outcome (e.g. checking
+     * whether a DID exists before creating it).
+     * @param did The DID to resolve.
+     * @param options Optional resolution options.
+     * @returns A {@link ResolutionResult} with `ok: true` on success or
+     *          `ok: false` with error details on failure.
+     */
+    tryResolveDid(did: string, options?: ResolutionOptions): Promise<ResolutionResult>;
+    /**
+     * Update a DID document: resolve the current state, apply patches, sign, and announce.
+     * Automatically injects the configured Bitcoin connection.
+     *
+     * If `sourceDocument` and `sourceVersionId` are both provided, resolution
+     * is skipped. Otherwise the DID is resolved first to obtain them.
+     * @param params The update parameters.
+     * @returns The signed update.
+     */
+    updateDid({ did, patches, verificationMethodId, beaconId, sourceDocument, sourceVersionId, }: {
+        did: string;
         patches: PatchOperation[];
-        sourceVersionId: number;
         verificationMethodId: string;
         beaconId: string;
-        signingMaterial?: KeyBytes | HexString;
-        bitcoin?: BitcoinNetworkConnection;
+        sourceDocument?: Btcr2DidDocument;
+        sourceVersionId?: number;
     }): Promise<SignedBTCR2Update>;
-    /** Deactivate convenience: applies the standard `deactivated: true` patch. */
-    deactivate(): Promise<SidecarData>;
-}
-export declare class DidBtcr2Api {
-    readonly bitcoin: BitcoinApi;
-    readonly did: DidApi;
-    readonly keys: KeyPairApi;
-    readonly crypto: CryptoApi;
-    constructor(config?: ApiConfig);
+    /**
+     * Release internal references. After disposal, accessing `btc`, `btcr2`,
+     * or calling top-level methods will throw.
+     *
+     * Note: the underlying {@link BitcoinConnection} does not hold persistent
+     * connections, so this is primarily a guard against accidental reuse.
+     */
+    dispose(): void;
 }
+/**
+ * Create a new {@link DidBtcr2Api} instance with the given configuration.
+ * @param config Optional configuration for the API.
+ * @returns The created DidBtcr2Api instance.
+ * @public
+ */
 export declare function createApi(config?: ApiConfig): DidBtcr2Api;
+//# sourceMappingURL=api.d.ts.map

package/dist/types/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,wBAAwB,EACxB,iBAAiB,EACjB,OAAO,EACP,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,KAAK,EACL,eAAe,EACf,aAAa,EACb,OAAO,EACP,SAAS,EACT,GAAG,EACH,SAAS,EACT,UAAU,EACV,QAAQ,EACR,cAAc,EACd,UAAU,EACV,oBAAoB,EACpB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAwE,eAAe,EAAuB,MAAM,mBAAmB,CAAC;AAC/I,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAsB,MAAM,oBAAoB,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC5G,OAAO,EAAY,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC1F,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEzF,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;AACxE,YAAY,EACV,OAAO,EACP,KAAK,EACL,eAAe,EACf,mBAAmB,EACnB,UAAU,EACV,qBAAqB,EACrB,aAAa,EACb,SAAS,EACT,GAAG,EACH,UAAU,EACV,QAAQ,EACR,cAAc,EACd,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,oBAAoB,EACpB,cAAc,EACf,CAAC;AAMF,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC;AAExE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iFAAiF;IACjF,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,oCAAoC;IACpC,IAAI,CAAC,EAAE,sBAAsB,CAAC;IAC9B,mCAAmC;IACnC,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAMF,qBAAa,UAAU;IACrB,kDAAkD;IAClD,MAAM,CAAC,QAAQ,IAAI,cAAc;IAIjC,8CAA8C;IAC9C,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc;CAIhD;AAED,qBAAa,WAAW;IACtB;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QACpB,EAAE,EAAE,MAAM,CAAC;QACX,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,cAAc,CAAA;KACrB,GAAG,eAAe;IAInB,8DAA8D;IAC9D,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,eAAe,GAAG,qBAAqB;IAIvE,qDAAqD;WACxC,IAAI,CAAC,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC;IAI5E,qCAAqC;WACxB,MAAM,CAAC,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;CAGnG;AAMD,qBAAa,SAAS;IACpB,OAAc,UAAU,aAAoB;IAC5C,OAAc,WAAW,cAAqB;CAC/C;AAMD,qBAAa,UAAU;IACrB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC;IACnC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;gBAE1B,GAAG,CAAC,EAAE,gBAAgB;IAgBlC,4CAA4C;IACtC,cAAc,CAAC,IAAI,EAAE,MAAM;IAIjC,yCAAyC;IACnC,IAAI,CAAC,QAAQ,EAAE,MAAM;IAI3B,yCAAyC;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM;IAI9B,8CAA8C;IACxC,QAAQ,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;CAG1D;AAkCD,qBAAa,MAAM;IACjB;;OAEG;IACG,mBAAmB,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE;QACnD,YAAY,EAAE,QAAQ,CAAC;QACvB,OAAO,EAAE,gBAAgB,CAAC;KAC3B;IAID;;OAEG;IACG,cAAc,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE;QAC9C,YAAY,EAAE,aAAa,CAAC;QAC5B,OAAO,EAAE,gBAAgB,CAAC;KAC3B;IAID;;OAEG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIpF;;;;OAIG;IACG,MAAM,CAAC,EACX,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,eAAe,EACf,OAAO,GACR,EAAE;QACD,cAAc,EAAE,gBAAgB,CAAC;QACjC,OAAO,EAAE,cAAc,EAAE,CAAC;QAC1B,eAAe,EAAE,MAAM,CAAC;QACxB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QACvC,OAAO,CAAC,EAAE,wBAAwB,CAAC;KACpC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAc9B,8EAA8E;IACxE,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;CAWzC;AAMD,qBAAa,WAAW;IACtB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;gBAGf,MAAM,CAAC,EAAE,SAAS;CAO/B;AAMD,wBAAgB,SAAS,CAAC,MAAM,CAAC,EAAE,SAAS,eAE3C"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC/F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAkB,MAAM,UAAU,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,EAAE,SAAS,EAA4B,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAExF;;;;;;GAMG;AACH,qBAAa,WAAW;;IACtB,wEAAwE;IACxE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,mEAAmE;IACnE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;gBAUhB,MAAM,CAAC,EAAE,SAAS;IAS9B;;;;OAIG;IACH,IAAI,GAAG,IAAI,UAAU,CAYpB;IAED;;;;OAIG;IACH,IAAI,GAAG,IAAI,MAAM,CAYhB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,YAAY,CAUxB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;;OAMG;IACH,SAAS,CACP,IAAI,EAAE,eAAe,GAAG,UAAU,EAClC,YAAY,EAAE,QAAQ,GAAG,aAAa,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GACzC,MAAM;IAOT;;;;;;OAMG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,WAAW,CAAA;KAAE,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE;IAQ5G;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAKxF;;;;;;;;OAQG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAiCxF;;;;;;;;OAQG;IACG,SAAS,CAAC,EACd,GAAG,EACH,OAAO,EACP,oBAAoB,EACpB,QAAQ,EACR,cAAc,EACd,eAAe,GAChB,EAAE;QACD,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,cAAc,EAAE,CAAC;QAC1B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,gBAAgB,CAAC;QAClC,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+C9B;;;;;;OAMG;IACH,OAAO,IAAI,IAAI;CAchB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,WAAW,CAEzD"}

package/dist/types/bitcoin.d.ts

@@ -0,0 +1,64 @@
+import { BitcoinConnection, BitcoinCoreRpcClient, BitcoinRestClient, type RawTransactionRest } from '@did-btcr2/bitcoin';
+import type { BitcoinApiConfig } from './types.js';
+/**
+ * Bitcoin network operations sub-facade.
+ * Always backed by a {@link BitcoinConnection} so it can be passed to
+ * resolve/update without extra configuration.
+ *
+ * Lazily initialized by {@link DidBtcr2Api} to avoid connection overhead
+ * when Bitcoin features are not used.
+ * @public
+ */
+export declare class BitcoinApi {
+    /** The underlying BitcoinConnection used for all operations. */
+    readonly connection: BitcoinConnection;
+    /** REST client for the active network. */
+    get rest(): BitcoinRestClient;
+    /**
+     * RPC client for the active network, or `undefined` if not configured.
+     * Use {@link requireRpc} when RPC is expected to be available.
+     */
+    get rpc(): BitcoinCoreRpcClient | undefined;
+    /** Whether an RPC client is available for this network. */
+    get hasRpc(): boolean;
+    /**
+     * RPC client for the active network.
+     * @throws {Error} If RPC was not configured for this network.
+     */
+    requireRpc(): BitcoinCoreRpcClient;
+    /**
+     * Create a BitcoinApi for a specific network with optional endpoint overrides.
+     * Uses BitcoinConnection.forNetwork() — no env vars consulted.
+     * @param cfg The network and optional REST/RPC overrides.
+     */
+    constructor(cfg: BitcoinApiConfig);
+    /**
+     * Fetch a transaction by txid via REST.
+     * @param txid The transaction ID (64-character hex string).
+     * @returns The fetched transaction.
+     */
+    getTransaction(txid: string): Promise<RawTransactionRest>;
+    /**
+     * Broadcast a raw tx (hex) via REST.
+     * @param rawTxHex The raw transaction hex string.
+     */
+    send(rawTxHex: string): Promise<string>;
+    /**
+     * Get UTXOs for an address via REST.
+     * @param address The Bitcoin address.
+     */
+    getUtxos(address: string): Promise<import("@did-btcr2/bitcoin").AddressUtxo[]>;
+    /**
+     * Get a block by hash or height via REST.
+     * @param params Block identifier — at least one of `hash` or `height` is required.
+     */
+    getBlock(params: {
+        hash?: string;
+        height?: number;
+    }): Promise<import("@did-btcr2/bitcoin").EsploraBlock | undefined>;
+    /** Convert BTC to satoshis (integer-safe string-split arithmetic). */
+    static btcToSats(btc: number): number;
+    /** Convert satoshis to BTC (integer-safe string-split arithmetic). */
+    static satsToBtc(sats: number): number;
+}
+//# sourceMappingURL=bitcoin.d.ts.map

package/dist/types/bitcoin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bitcoin.d.ts","sourceRoot":"","sources":["../../src/bitcoin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,KAAK,kBAAkB,EACxB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD;;;;;;;;GAQG;AACH,qBAAa,UAAU;IACrB,gEAAgE;IAChE,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC;IAEvC,0CAA0C;IAC1C,IAAI,IAAI,IAAI,iBAAiB,CAE5B;IAED;;;OAGG;IACH,IAAI,GAAG,IAAI,oBAAoB,GAAG,SAAS,CAE1C;IAED,2DAA2D;IAC3D,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;OAGG;IACH,UAAU,IAAI,oBAAoB;IAWlC;;;;OAIG;gBACS,GAAG,EAAE,gBAAgB;IAoBjC;;;;OAIG;IACG,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAK/D;;;OAGG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM;IAK3B;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM;IAK9B;;;OAGG;IACG,QAAQ,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAOzD,sEAAsE;IACtE,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIrC,sEAAsE;IACtE,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAGvC"}