@did-btcr2/common 1.1.0

package/dist/types/interfaces.d.ts

@@ -0,0 +1,282 @@
+export type JsonPatch = Array<PatchOperation>;
+export type PatchOpCode = 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' | string;
+/**
+ * A JSON Patch operation, as defined in {@link https://datatracker.ietf.org/doc/html/rfc6902 | RFC 6902}.
+ */
+export interface PatchOperation {
+    op: PatchOpCode;
+    path: string;
+    value?: any;
+    from?: string;
+}
+/**
+ * The unsigned payload object containing instructions for how to update a
+ * did:btcr2 DID Document. Once signed, it becomes a
+ * {@link DidUpdateInvocation | DID Update Invocation}
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#construct-did-update-payload | 4.3.1 Construct DID Update Payload}.
+ *
+ * Found in DID BTCR2 Specification {@link https://dcdpr.github.io/did-btcr2/#dereference-root-capability-identifier | Section 9.4.2}
+ * @example
+ * ```
+ * {
+ *  "@context": [
+ *    "https://w3id.org/zcap/v1",
+ *    "https://w3id.org/security/data-integrity/v2",
+ *    "https://w3id.org/json-ld-patch/v1"
+ *  ],
+ *  "patch": [
+ *    {
+ *      "op": "add",
+ *      "path": "/service/4",
+ *      "value": {
+ *        "id": "#linked-domain",
+ *        "type": "LinkedDomains",
+ *        "serviceEndpoint": "https://contact-me.com"
+ *      }
+ *    }
+ *   ],
+ *   "proof":{
+ *   "type": "DataIntegrityProof,
+ *   "cryptosuite": "schnorr-secp256k1-jcs-2025,
+ *   "verificationMethod": "did:btcr2:k1qqpuwwde82nennsavvf0lqfnlvx7frrgzs57lchr02q8mz49qzaaxmqphnvcx#initialKey,
+ *   "invocationTarget": "did:btcr2:k1qqpuwwde82nennsavvf0lqfnlvx7frrgzs57lchr02q8mz49qzaaxmqphnvcx,
+ *   "capability": "urn:zcap:root:did%3Abtc1%3Ak1qqpuwwde82nennsavvf0lqfnlvx7frrgzs57lchr02q8mz49qzaaxmqphnvcx,
+ *   "capabilityAction": "Write,
+ *   "proofPurpose": "assertionMethod,
+ *   "proofValue": "z381yXYmxU8NudZ4HXY56DfMN6zfD8syvWcRXzT9xD9uYoQToo8QsXD7ahM3gXTzuay5WJbqTswt2BKaGWYn2hHhVFKJLXaD
+ *  }
+ * }
+ * ```
+ */
+export interface DidUpdatePayload {
+    /**
+     * JSON-LD context URIs for interpreting this payload, including contexts
+     * for ZCAP (capabilities), Data Integrity proofs, and JSON-LD patch ops.
+     */
+    '@context': string[];
+    /**
+     * A JSON Patch (or JSON-LD Patch) object defining the mutations to apply to
+     * the DID Document. Applying this patch to the current DID Document yields
+     * the new DID Document (which must remain valid per DID Core spec).
+     */
+    patch: JsonPatch;
+    /**
+     * The multihash of the current (source) DID Document, encoded as a multibase
+     * base58-btc string. This is a SHA-256 hash of the canonicalized source DID
+     * Document, used to ensure the patch is applied to the correct document state.
+     */
+    sourceHash: string;
+    /**
+     * The multihash of the updated (target) DID Document, encoded as multibase
+     * base58-btc. This is the SHA-256 hash of the canonicalized
+     * DID Document after applying the patch, used to verify the update result.
+     */
+    targetHash: string;
+    /**
+     * The version number of the DID Document after this update.
+     * It is equal to the previous document version + 1.
+     */
+    targetVersionId: number;
+    /**
+     * A proof object (Data Integrity proof) that authorizes this update.
+     * It is a JSON-LD proof indicating a capability invocation on the DID's
+     * root capability, typically signed with the DID's verification key (using
+     * Schnorr secp256k1 in did:btcr2).
+     */
+    proof?: Proof;
+}
+/**
+ * An extension of {@link DidUpdatePayload | DID Update Payload} containing a
+ * Data Integrity proof that authorizes the update. Once signed, the spec calls
+ * this an 'invoked DID Update Payload' or 'didUpdateInvocation'.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#invoke-did-update-payload | 4.3.2 Invoke DID Update Payload}
+ * and
+ * {@link https://dcdpr.github.io/did-btcr2/#root-didbtc1-update-capabilities | 9.4 Root did:btcr2 Update Capabilities}.
+ */
+export interface DidUpdateInvocation extends DidUpdatePayload {
+    proof: Proof;
+}
+/**
+ * Proof is the Data Integrity proof (ZCAP-LD style) added to a did:btcr2 DID
+ * Update Payload.
+ *
+ * Verifiable Credential Data Integrity
+ * {@link https://w3c.github.io/vc-data-integrity/#proofs | 2.1 Proofs}.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#invoke-did-update-payload | 4.3.2 Invoke DID Update Payload}.
+ */
+export interface Proof extends ProofOptions {
+    /**
+     * The cryptographic signature value. The exact property name may be defined
+     * by the cryptosuite (for instance, `proofValue` for a raw signature) and
+     * contains the actual signature bytes in an encoded form.
+     */
+    proofValue: string;
+}
+/**
+ * Proof Options used when adding a Data Integrity proof (ZCAP-LD style)
+ * to a did:btcr2 DID Update Payload.
+ *
+ * Verifiable Credential Data Integrity
+ * {@link https://w3c.github.io/vc-data-integrity/#proofs | 2.1 Proofs}.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#invoke-did-update-payload | 4.3.2 Invoke DID Update Payload}.
+ */
+export interface ProofOptions {
+    /**
+     * The proof type—per the spec’s example, "DataIntegrityProof".
+     */
+    type: string;
+    /**
+     * The cryptographic suite used, e.g. "schnorr-secp256k1-jcs-2025".
+     */
+    cryptosuite: string;
+    /**
+     * DID URL of the key invoking the capability, i.e. the DID
+     * Document's verificationMethod.id used to sign this update.
+     */
+    verificationMethod: string;
+    /**
+     * The purpose of the proof, which the spec sets to "capabilityInvocation".
+     */
+    proofPurpose: string;
+    /**
+     * The root capability being invoked. In did:btcr2, this is typically
+     * `urn:zcap:root:<urlencoded-did>` (see Section 9.4.1).
+     */
+    capability?: string;
+    /**
+     * The action performed under the capability—set to "Write" in the spec
+     * for DID document updates.
+     */
+    capabilityAction?: string;
+    /**
+     * (Optional) Some cryptosuites or proofs may include a timestamp, domain,
+     * or challenge. Although not explicitly required in the doc's steps, they
+     * often appear in Data Integrity proofs and may be included as needed.
+     */
+    created?: string;
+    domain?: string;
+    challenge?: string;
+}
+/**
+ * A JSON object that maps did:btcr2 identifiers to the CID of the corresponding
+ * DID Update Payload.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#cidaggregate-beacon | 5.2 CIDAggregate Beacons}.
+ */
+export interface DidUpdateBundle {
+    /**
+     * The keys are did:btcr2 identifiers as strings. The values are
+     * IPFS CIDs (or other CAS IDs) referencing the actual DID Update Payload.
+     */
+    [didBtc1Identifier: string]: string;
+}
+/**
+ * A container for out-of-band data the resolver may need. This includes the
+ * initial DID document if it isn't stored in IPFS, plus references for each
+ * on-chain Beacon signal.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#sidecar-initial-document-validation | 4.2.1.2.1 Sidecar Initial Document Validation},
+ * {@link https://dcdpr.github.io/did-btcr2/#resolve-target-document | 4.2.2 Resolve Target Document},
+ * {@link https://dcdpr.github.io/did-btcr2/#traverse-blockchain-history | 4.2.2.2 Traverse Blockchain History},
+ * {@link https://dcdpr.github.io/did-btcr2/#find-next-signals | 4.2.2.3 Find Next Signals}.
+ */
+export interface SidecarData {
+    /**
+     * The initial DID Document for an externally created did:btcr2,
+     * if not fetched from IPFS or another CAS.
+     */
+    initialDocument?: Record<string, any>;
+    /**
+     * A map from Bitcoin transaction IDs to the sidecar info about that signal.
+     * Each signal might provide a single DID Update Payload, or (for aggregator beacons)
+     * a bundle or proofs.
+     */
+    signalsMetadata: {
+        [txid: string]: SignalSidecarData;
+    };
+}
+/**
+ * Sidecar data for a specific Beacon Signal. Different Beacon types store different fields.
+ * - SingletonBeacon might just store one `updatePayload`.
+ * - CIDAggregateBeacon might store `updateBundle` + an `updatePayload`.
+ * - SMTAggregateBeacon might store `updatePayload` + a `smtProof`.
+ */
+export interface SignalSidecarData {
+    updatePayload?: DidUpdateInvocation;
+    updateBundle?: DidUpdateBundle;
+    /**
+     * For SMTAggregateBeacon, a Merkle proof that the `updatePayload`
+     * is included (or not included) in the aggregator's Sparse Merkle Tree.
+     */
+    smtProof?: SmtProof;
+}
+/**
+ * A placeholder for the actual Sparse Merkle Tree inclusion/non-inclusion proof.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#smtaggregate-beacon | 5.3 SMTAggregate Beacon}.
+ */
+export interface SmtProof {
+    siblingHashes: string[];
+    leafIndex?: string;
+}
+/**
+ * The known Beacon types from the spec.
+ */
+export type BeaconType = 'SingletonBeacon' | 'CIDAggregateBeacon' | 'SMTAggregateBeacon';
+/**
+ * Represents a transaction discovered on the Bitcoin blockchain that
+ * spends from a Beacon address, thus announcing DID updates.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#find-next-signals | 4.2.2.3 Find Next Signals}
+ * and
+ * {@link https://dcdpr.github.io/did-btcr2/#process-beacon-signals | 4.2.2.4 Process Beacon Signals}.
+ */
+export interface BeaconSignal {
+    /**
+     * The DID Document's `service` ID of the Beacon that produced this signal, e.g. "#cidAggregateBeacon".
+     */
+    beaconId: string;
+    /**
+     * The type of Beacon, e.g. "SingletonBeacon".
+     */
+    beaconType: BeaconType;
+    /**
+     * The Bitcoin transaction that is the actual on-chain Beacon Signal.
+     * Typically you'd store a minimal subset or a reference/ID for real usage.
+     */
+    tx: any;
+}
+/**
+ * A ZCAP-LD root capability object that authorizes updates for a particular did:btcr2.
+ *
+ * DID BTCR2
+ * {@link https://dcdpr.github.io/did-btcr2/#derive-root-capability-from-didbtc1-identifier | 9.4.1 Derive Root Capability from did:btcr2 Identifier}.
+ *
+ * @example Found in DID BTCR2 Specification Section 9.4.1
+ * ```
+ * {
+ *   "@context": "https://w3id.org/zcap/v1",
+ *   "id": "urn:zcap:root:did%3Abtc1%3Ak1qq...",
+ *   "controller": "did:btcr2:k1qq...",
+ *   "invocationTarget": "did:btcr2:k1qq..."
+ * }
+ * ```
+ */
+export interface DidBtc1RootCapability {
+    '@context': string | string[];
+    id: string;
+    controller: string;
+    invocationTarget: string;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAC9C,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAC3F;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,WAAW,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,KAAK,EAAE,KAAK,CAAC;CACd;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAM,SAAQ,YAAY;IACzC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC;CACrC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEtC;;;;OAIG;IACH,eAAe,EAAE;QACf,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;KACnC,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IAEvB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,CAAC;AAEzB;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;;OAGG;IACH,EAAE,EAAE,GAAG,CAAC;CACT;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}

package/dist/types/logger.browser.d.ts

@@ -0,0 +1,28 @@
+export declare enum Env {
+    Development = "development",
+    Production = "production",
+    Test = "test"
+}
+export type Level = 'debug' | 'error' | 'info' | 'log' | 'warn' | 'security';
+export declare const NODE_ENV: Env;
+export declare class Logger {
+    private levels;
+    private namespace?;
+    constructor(namespace?: string);
+    private _log;
+    debug(m?: unknown, ...a: unknown[]): this;
+    error(m?: unknown, ...a: unknown[]): this;
+    info(m?: unknown, ...a: unknown[]): this;
+    warn(m?: unknown, ...a: unknown[]): this;
+    security(m?: unknown, ...a: unknown[]): this;
+    log(m?: unknown, ...a: unknown[]): this;
+    newline(): this;
+    static debug(m?: unknown, ...a: unknown[]): void;
+    static error(m?: unknown, ...a: unknown[]): void;
+    static info(m?: unknown, ...a: unknown[]): void;
+    static warn(m?: unknown, ...a: unknown[]): void;
+    static security(m?: unknown, ...a: unknown[]): void;
+    static log(m?: unknown, ...a: unknown[]): void;
+    static newline(): void;
+    private static getCallerLocation;
+}

package/dist/types/logger.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.browser.d.ts","sourceRoot":"","sources":["../../src/logger.browser.ts"],"names":[],"mappings":"AAAA,oBAAY,GAAG;IACX,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,IAAI,SAAS;CAChB;AAED,MAAM,MAAM,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,CAAC;AAE7E,eAAO,MAAM,QAAQ,EAAE,GAEJ,CAAC;AA4BpB,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,SAAS,CAAC,CAAS;gBAEf,SAAS,CAAC,EAAE,MAAM;IAK9B,OAAO,CAAC,IAAI;IAiBL,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;IAClC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;IAClC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;IACjC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;IACjC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;IACrC,GAAG,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;IAChC,OAAO;WAGA,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;WAClC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;WAClC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;WACjC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;WACjC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;WACrC,GAAG,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE;WAChC,OAAO;IAIrB,OAAO,CAAC,MAAM,CAAC,iBAAiB;CAQjC"}

package/dist/types/logger.d.ts

@@ -0,0 +1,45 @@
+export declare enum Env {
+    Development = "development",
+    Production = "production",
+    Test = "test"
+}
+export type Level = 'debug' | 'error' | 'info' | 'log' | 'warn' | 'security';
+export declare const NODE_ENV: Env;
+/**
+ * A flexible, feature-rich logger with:
+ * - Environment-based filtering
+ * - Namespacing
+ * - File/line tracing
+ * - Timestamps
+ * - Colorized output
+ */
+export declare class Logger {
+    private levels;
+    private namespace?;
+    constructor(namespace?: string);
+    /**
+     * Logs a message with the specified level.
+     */
+    private _log;
+    debug(message?: unknown, ...args: unknown[]): this;
+    error(message?: unknown, ...args: unknown[]): this;
+    info(message?: unknown, ...args: unknown[]): this;
+    warn(message?: unknown, ...args: unknown[]): this;
+    security(message?: unknown, ...args: unknown[]): this;
+    log(message?: unknown, ...args: unknown[]): this;
+    newline(): this;
+    /**
+     * Static methods for convenience (auto-instantiate).
+     */
+    static debug(message?: unknown, ...args: unknown[]): void;
+    static error(message?: unknown, ...args: unknown[]): void;
+    static info(message?: unknown, ...args: unknown[]): void;
+    static warn(message?: unknown, ...args: unknown[]): void;
+    static security(message?: unknown, ...args: unknown[]): void;
+    static log(message?: unknown, ...args: unknown[]): void;
+    static newline(): void;
+    /**
+     * Returns the caller's file and line number.
+     */
+    private static getCallerLocation;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAGA,oBAAY,GAAG;IACb,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,IAAI,SAAS;CACd;AAED,MAAM,MAAM,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,CAAC;AAE7E,eAAO,MAAM,QAAQ,KAAmD,CAAC;AAoCzE;;;;;;;GAOG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,SAAS,CAAC,CAAS;gBAEf,SAAS,CAAC,EAAE,MAAM;IAK9B;;OAEG;IACH,OAAO,CAAC,IAAI;IAgBL,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAI3C,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAI3C,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAI1C,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAI1C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAI9C,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;IAIzC,OAAO;IAId;;OAEG;WACW,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;WAI3C,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;WAI3C,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;WAI1C,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;WAI1C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;WAI9C,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;WAIzC,OAAO;IAIrB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;CAgBjC"}

package/dist/types/patch.d.ts

@@ -0,0 +1,63 @@
+import { PatchOperation } from './interfaces.js';
+import { JSONObject } from './types.js';
+/**
+ * Implementation of {@link https://datatracker.ietf.org/doc/html/rfc6902 | IETF RFC 6902 JSON Patch}.
+ *
+ * JavaScript Object Notation (JSON) Patch defines a JSON document structure for expressing a sequence of operations to
+ * apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The
+ * "application/json-patch+json" media type is used to identify such patch documents.
+ *
+ * @class Patch
+ * @type {Patch}
+ */
+export declare class Patch {
+    /**
+     * Applies a JSON Patch to a source document and returns the patched document.
+     * @param {JSONObject} sourceDocument The source document to patch.
+     * @param {PatchOperation[]} operations The JSON Patch operations to apply.
+     * @returns {JSONObject} The patched document.
+     * @throws {Error} If an unsupported operation is provided.
+     */
+    apply(sourceDocument: JSONObject, operations: PatchOperation[]): JSONObject;
+    /**
+   * Constructs a JSON Patch with a single operation (e.g. add service).
+   * @param {PatchOperation} patches - The patch operation to create.
+   * @param {string} patch.op - The patch operation type (e.g. 'add').
+   * @param {string} patch.path - The JSON Pointer path to apply the operation.
+   * @param {*} patch.value - The value to apply (if applicable).
+   * @returns {PatchOperation[]} A single-entry JSON Patch array.
+   */
+    create(patches: PatchOperation[]): PatchOperation[];
+    /**
+     * Find the diff between a source and target document constructing the patch operations from source => target.
+     * @param {JSONObject} sourceDocument The original JSON object.
+     * @param {JSONObject} targetDocument The target JSON object to transform into.
+     * @returns {PatchOperation[]} An array of JSON Patch operations.
+     */
+    diff(sourceDocument: JSONObject, targetDocument: JSONObject, path: string): PatchOperation[];
+    /**
+     * Gets the value at a given path in an object.
+     * @private
+     * @param {*} obj The object to get the value from.
+     * @param {string[]} path The path to the value.
+     * @returns {*} The value at the given path.
+     */
+    private getValue;
+    /**
+     * Sets the value at a given path in an object.
+     * @private
+     * @param {*} obj The object to set the value in.
+     * @param {string[]} path The path to the value.
+     * @param {*} value The value to set.
+     * @returns {*} The object with the value set.
+     */
+    private setValue;
+    /**
+     * Removes the value at a given path in an object.
+     * @private
+     * @param {*} obj The object to remove the value from.
+     * @param {string[]} path The path to the value.
+     * @returns {*} The object with the value removed.
+     */
+    private removeValue;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"patch.d.ts","sourceRoot":"","sources":["../../src/patch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGxC;;;;;;;;;GASG;AACH,qBAAa,KAAK;IAChB;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,UAAU;IAmDlF;;;;;;;KAOC;IACM,MAAM,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,cAAc,EAAE;IAgB1D;;;;;OAKG;IACI,IAAI,CAAC,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc,EAAE;IA8BnG;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IAKhB;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ;IAWhB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;CASpB"}

package/dist/types/types.d.ts

@@ -0,0 +1,104 @@
+import { HDKey } from '@scure/bip32';
+export type Hex = Uint8Array | string;
+export type SignatureHex = Hex;
+export type HashHex = Hex;
+export type Bytes = Uint8Array;
+export type DocumentBytes = Bytes;
+export type SignatureBytes = Bytes;
+export type ProofBytes = Bytes;
+export type HashBytes = Bytes;
+export type MessageBytes = Bytes;
+export type Entropy = Bytes | bigint;
+export type CompressedPublicKeyParityByte = 0x02 | 0x03;
+export type Bip340Encoding = string;
+export type Base58BtcPrefix = 'z';
+export type KeyBytes = Bytes;
+export type Point = {
+    x: Array<number>;
+    y: Array<number>;
+    parity: number;
+};
+export type PublicKeyObject = {
+    point: Point;
+    hex: Hex;
+    multibase: MultibaseObject;
+};
+export type SecretKeyObject = {
+    bytes: Array<number>;
+    seed?: string;
+    hex?: Hex;
+};
+export type SchnorrKeyPair = {
+    secretKey: KeyBytes;
+    publicKey: KeyBytes;
+};
+export type SchnorrKeyPairObject = {
+    secretKey: SecretKeyObject;
+    publicKey: PublicKeyObject;
+};
+export type MultibaseObject = {
+    address: string;
+    prefix: Bytes;
+    key: Array<number>;
+};
+export type HdWallet = {
+    mnemonic: string;
+    hdkey: HDKey;
+};
+export type DID = 'did';
+export type MethodName = string;
+export type MethodSpecificId = string;
+export type DecentralizedIdentifierExplicit = `${DID}:${MethodName}:${MethodSpecificId}`;
+export type DecentralizedIdentifier = string;
+export type Btc1MethodName = 'btcr2';
+export type Btc1DeterministicPrefix = 'k';
+export type Btc1ExternalPrefix = 'x';
+export type Btc1Prefix = `${Btc1DeterministicPrefix | Btc1ExternalPrefix}1`;
+export type Bech32Id = string;
+export type Btc1Id = `${Btc1Prefix}${Bech32Id}`;
+export type Btc1IdentifierExplicit = `${DID}:${Btc1MethodName}:${Btc1Id}`;
+export type Btc1Identifier = string;
+export type Controller = Btc1Identifier;
+export type Id = 'initialKey';
+export type FullId = `${Controller}#${Id}`;
+export declare enum Btc1IdentifierTypes {
+    KEY = "KEY",
+    EXTERNAL = "EXTERNAL"
+}
+export declare enum Btc1IdentifierHrp {
+    k = "k",
+    x = "x"
+}
+export declare enum BitcoinNetworkNames {
+    bitcoin = 0,
+    signet = 1,
+    regtest = 2,
+    testnet3 = 3,
+    testnet4 = 4,
+    mutinynet = 5
+}
+export type KeyIdentifier = string;
+export type BeaconUri = string;
+export type DidPlaceholder = 'did:btcr2:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
+export type CanonicalizedProofConfig = string;
+export type CryptosuiteName = 'bip340-jcs-2025' | 'bip340-rdfc-2025';
+export type ContextObject = Record<string | number | symbol, any>;
+export type Context = string | string[] | ContextObject | ContextObject[];
+export type Maybe<T> = T | any;
+export type JSONObject = Record<string | number | symbol, any>;
+export type Prototyped = JSONObject;
+export type Unprototyped = JSONObject;
+export type TwoDigits = `${number}${number}`;
+export type ThreeDigits = `${number}${number}${number}`;
+export type Year = `${1 | 2}${ThreeDigits}`;
+export type Month = TwoDigits;
+export type Day = TwoDigits;
+export type Hours = TwoDigits;
+export type Minutes = TwoDigits;
+export type Seconds = TwoDigits;
+export type UtcTimestamp = `${Year}-${Month}-${Day}T${Hours}:${Minutes}:${Seconds}`;
+export type TzOffset = `${Hours}:${Minutes}`;
+export type DateTimestamp = `${UtcTimestamp}Z` | `${UtcTimestamp}-${TzOffset}`;
+export type CanonicalizableObject = Record<string, any>;
+export type CanonicalizationAlgorithm = 'jcs' | 'rdfc';
+export type UnixTimestamp = number;

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAGrC,MAAM,MAAM,GAAG,GAAG,UAAU,GAAG,MAAM,CAAC;AACtC,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC;AAC/B,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC;AAE1B,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC;AAC/B,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC;AAClC,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC;AACnC,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC;AAC/B,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC;AAC9B,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC;AACjC,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAErC,MAAM,MAAM,6BAA6B,GAAG,IAAI,GAAG,IAAI,CAAC;AACxD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,eAAe,GAAG,GAAG,CAAC;AAElC,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAC7B,MAAM,MAAM,KAAK,GAAG;IAClB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACjB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAA;AACD,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;IACT,SAAS,EAAE,eAAe,CAAC;CAC5B,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,GAAG,CAAC;CACX,CAAC;AACF,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,QAAQ,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,eAAe,CAAC;IAC3B,SAAS,EAAE,eAAe,CAAC;CAC5B,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC;IACd,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,QAAQ,GAAG;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAA;CACf,CAAC;AAGF,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC;AACxB,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC,MAAM,MAAM,+BAA+B,GAAG,GAAG,GAAG,IAAI,UAAU,IAAI,gBAAgB,EAAE,CAAC;AACzF,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAC7C,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC;AACrC,MAAM,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAC1C,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC;AACrC,MAAM,MAAM,UAAU,GAAG,GAAG,uBAAuB,GAAG,kBAAkB,GAAG,CAAC;AAC5E,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,MAAM,GAAG,GAAG,UAAU,GAAG,QAAQ,EAAE,CAAA;AAC/C,MAAM,MAAM,sBAAsB,GAAG,GAAG,GAAG,IAAI,cAAc,IAAI,MAAM,EAAE,CAAC;AAC1E,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC;AACxC,MAAM,MAAM,EAAE,GAAG,YAAY,CAAC;AAC9B,MAAM,MAAM,MAAM,GAAG,GAAG,UAAU,IAAI,EAAE,EAAE,CAAC;AAC3C,oBAAY,mBAAmB;IAC3B,GAAG,QAAQ;IACX,QAAQ,aAAa;CACxB;AACD,oBAAY,iBAAiB;IACzB,CAAC,MAAM;IACP,CAAC,MAAM;CACV;AACD,oBAAY,mBAAmB;IAC3B,OAAO,IAAI;IACX,MAAM,IAAI;IACV,OAAO,IAAI;IACX,QAAQ,IAAI;IACZ,QAAQ,IAAI;IACZ,SAAS,IAAI;CAChB;AACD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,cAAc,GAAG,wEAAwE,CAAC;AACtG,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAC9C,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAAG,kBAAkB,CAAC;AACrE,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;AAClE,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,aAAa,GAAG,aAAa,EAAE,CAAA;AAGzE,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;AAC/B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;AAC/D,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC;AACpC,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AACtC,MAAM,MAAM,SAAS,GAAG,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAC7C,MAAM,MAAM,WAAW,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AACxD,MAAM,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,WAAW,EAAE,CAAC;AAC5C,MAAM,MAAM,KAAK,GAAG,SAAS,CAAC;AAC9B,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC;AAC5B,MAAM,MAAM,KAAK,GAAG,SAAS,CAAC;AAC9B,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC;AAChC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC;AAChC,MAAM,MAAM,YAAY,GAAG,GAAG,IAAI,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;AACpF,MAAM,MAAM,QAAQ,GAAG,GAAG,KAAK,IAAI,OAAO,EAAE,CAAC;AAC7C,MAAM,MAAM,aAAa,GAAG,GAAG,YAAY,GAAG,GAAG,GAAG,YAAY,IAAI,QAAQ,EAAE,CAAC;AAC/E,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,MAAM,yBAAyB,GAAG,KAAK,GAAG,MAAM,CAAC;AACvD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@did-btcr2/common",
+  "version": "1.1.0",
+  "type": "module",
+  "description": "Common utilities, types, interfaces, etc. shared across the did-btcr2-js monorepo packages.",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./logger": {
+      "browser": "./dist/esm/logger.browser.js",
+      "default": "./dist/esm/logger.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "license": "MPL-2.0",
+  "contributors": [
+    {
+      "name": "dcdpr",
+      "url": "https://github.com/dcdpr"
+    },
+    {
+      "name": "jintekc",
+      "url": "https://github.com/jintekc",
+      "email": "github@jintek.consulting"
+    }
+  ],
+  "homepage": "https://github.com/dcdpr/did-btcr2-js/tree/main/packages/common",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:dcdpr/did-btcr2-js.git",
+    "directory": "packages/common"
+  },
+  "bugs": "https://github.com/dcdpr/did-btcr2-js/issues",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "keywords": [],
+  "dependencies": {
+    "@noble/hashes": "^1.7.1",
+    "@scure/bip32": "^1.5.0",
+    "canonicalize": "^2.1.0",
+    "chalk": "^5.4.1",
+    "json-canonicalize": "^1.0.6",
+    "multiformats": "^13.3.2",
+    "rdf-canonize": "^4.0.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "@types/chai": "^5.0.1",
+    "@types/chai-as-promised": "^8.0.1",
+    "@types/eslint": "^9.6.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.13.8",
+    "@typescript-eslint/eslint-plugin": "^8.25.0",
+    "@typescript-eslint/parser": "^8.25.0",
+    "c8": "^10.1.3",
+    "chai": "^5.2.0",
+    "chai-as-promised": "^8.0.1",
+    "esbuild": "^0.25.0",
+    "eslint": "^9.21.0",
+    "eslint-plugin-mocha": "^10.5.0",
+    "globals": "^16.0.0",
+    "mocha": "^11.1.0",
+    "mocha-junit-reporter": "^2.2.1",
+    "node-stdlib-browser": "^1.3.1",
+    "rimraf": "^6.0.1",
+    "typedoc-plugin-markdown": "^4.7.0",
+    "typescript": "~5.7.3",
+    "typescript-eslint": "^8.25.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist coverage tests/compiled",
+    "clean:build": "rimraf dist",
+    "clean:coverage": "rimraf coverage",
+    "clean:tests": "rimraf tests/compiled",
+    "clean:test-coverage": "pnpm clean:tests && pnpm clean:coverage",
+    "wipe": "rimraf node_modules pnpm-lock.json",
+    "wipe:clean": "pnpm wipe && pnpm clean",
+    "wipe:install": "pnpm wipe && pnpm install",
+    "clean:install": "pnpm clean && pnpm install",
+    "wipe:clean:install": "pnpm wipe:clean && pnpm install",
+    "reinstall": "pnpm install --force",
+    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs",
+    "build:esm": "rimraf dist/esm dist/types && pnpm tsc -p tsconfig.json",
+    "build:cjs": "rimraf dist/cjs && tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
+    "build:tests": "pnpm tsc -p tests/tsconfig.json",
+    "build:docs": "typedoc --options typedoc.json",
+    "build:all": "pnpm build && pnpm build:tests && pnpm build:docs",
+    "release": "pnpm build && pnpm pack && mv *.tgz ../../release/common",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix",
+    "test": "pnpm c8 mocha",
+    "build:test": "pnpm build && pnpm build:tests && pnpm c8 mocha",
+    "build:lint:test": "pnpm build && pnpm build:tests && pnpm lint:fix",
+    "prepublish": "pnpm build"
+  }
+}