@did-btcr2/kms 0.1.1 → 0.4.0

package/src/store.ts

@@ -1,153 +1,64 @@
 /**
- * Re-implmentation of a interface for a generic key-value store.
+ * Interface for a generic key-value store.
  */
 export interface KeyValueStore<K, V> {
-  /**
-   * Clears the store, removing all key-value pairs.
-   *
-   * @returns {void} when the store has been cleared.
-   */
+  /** Clear all entries. */
   clear(): void;
 
-  /**
-   * Closes the store, freeing up any resources used. After calling this method, no other operations can be performed on the store.
-   *
-   * @returns {void} when the store has been closed.
-   */
+  /** Close the store, freeing resources. */
   close(): void;
 
-  /**
-   * Deletes a key-value pair from the store.
-   *
-   * @param {K} key - The key of the value to delete.
-   * @returns {boolean | void} True if the element existed and has been removed, or false if the element does not exist.
-   */
+  /** Delete an entry by key. Returns true if the entry existed. */
   delete(key: K): boolean | void;
 
-  /**
-   * Fetches a value from the store given its key.
-   *
-   * @param {K} key - The key of the value to retrieve.
-   * @returns {V | undefined} The value associated with the key, or `undefined` if no value exists for that key.
-   */
+  /** Get an entry by key. Returns undefined if not found. */
   get(key: K): V | undefined;
 
-  /**
-   * Sets the value for a key in the store.
-   *
-   * @param {K} key - The key under which to store the value.
-   * @param {V} value - The value to be stored.
-   * @returns {void} once the value has been set.
-   */
+  /** Check if a key exists in the store. */
+  has(key: K): boolean;
+
+  /** Set a value for a key. */
   set(key: K, value: V): void;
 
-  /**
-   * Fetches the keys and values as a nested array.
-   *
-   * @returns {Array<[K, V]>} An array of key-value pair arrays in the store.
-   */
+  /** Get all entries as key-value tuples. */
   entries(): Array<[K, V]>;
 }
 
 /**
- * Re-implementation of a simple in-memory key-value store.
- *
- * The `MemoryStore` class is an implementation of
- * `KeyValueStore` that holds data in memory.
- *
- * It provides a basic key-value store that works synchronously and keeps all
- * data in memory. This can be used for testing, or for handling small amounts
- * of data with simple key-value semantics.
- *
- * Example usage:
- *
- * ```ts
- * const memoryStore = new MemoryStore<string, number>();
- * await memoryStore.set("key1", 1);
- * const value = await memoryStore.get("key1");
- * console.log(value); // 1
- * ```
- *
- * @public
+ * In-memory key-value store backed by a Map.
  */
 export class MemoryStore<K, V> implements KeyValueStore<K, V> {
-  /**
-   * A private field that contains the Map used as the key-value store.
-   */
-  private store: Map<K, V> = new Map();
+  #store: Map<K, V> = new Map();
 
-  /**
-   * Clears all entries in the key-value store.
-   *
-   * @returns {void} returns once the operation is complete.
-   */
   clear(): void {
-    this.store.clear();
+    this.#store.clear();
   }
 
-  /**
-   * This operation is no-op for `MemoryStore`.
-   */
   close(): void {
     /** no-op */
   }
 
-  /**
-   * Deletes an entry from the key-value store by its key.
-   *
-   * @param {K} id - The key of the entry to delete.
-   * @returns {boolean} a boolean indicating whether the entry was successfully deleted.
-   */
-  delete(id: K): boolean {
-    return this.store.delete(id);
+  delete(key: K): boolean {
+    return this.#store.delete(key);
   }
 
-  /**
-   * Retrieves the value of an entry by its key.
-   *
-   * @param {K} id - The key of the entry to retrieve.
-   * @returns {V | undefined} the value of the entry, or `undefined` if the entry does not exist.
-   */
-  get(id: K): V | undefined {
-    return this.store.get(id);
+  get(key: K): V | undefined {
+    return this.#store.get(key);
   }
 
-  /**
-   * Checks for the presence of an entry by key.
-   *
-   * @param {K} id - The key to check for the existence of.
-   * @returns {boolean} a boolean indicating whether an element with the specified key exists or not.
-   */
-  has(id: K): boolean {
-    return this.store.has(id);
+  has(key: K): boolean {
+    return this.#store.has(key);
   }
 
-  /**
-   * Retrieves all values in the key-value store.
-
-   * @returns {Array<V>} an array of all values in the store.
-   */
   list(): Array<V> {
-    return Array.from(this.store.values());
+    return Array.from(this.#store.values());
   }
 
-  /**
-   * Retrieves all entries in the key-value store.
-   *
-   * @returns {Array<[K, V]>} an array of key-value pairs in the store.
-   */
   entries(): Array<[K, V]> {
-    return Array.from(this.store.entries());
+    return Array.from(this.#store.entries());
   }
 
-  /**
-   * Sets the value of an entry in the key-value store.
-   *
-   * @param {K} id - The key of the entry to set.
-   * @param {V} key - The new value for the entry.
-   * @returns {void} once operation is complete.
-   */
-  set(id: K, key: V): void {
-    this.store.set(id, key);
+  set(key: K, value: V): void {
+    this.#store.set(key, value);
   }
-}
+}

package/dist/cjs/signer.js

@@ -1,53 +0,0 @@
-/**
- * Class representing a signer for cryptographic operations.
- * Remains for backwards compatibility. Plan to migrate to Kms.
- * @class Signer
- * @type {Signer}
- */
-export class Signer {
-    /**
-     * The key pair used for signing.
-     * @type {SchnorrKeyPair}
-     */
-    keyPair;
-    /**
-     * The network associated with the signer.
-     * @type {keyof AvailableNetworks}
-     */
-    network;
-    /**
-     * Creates an instance of Signer.
-     * @param {{ keyPair: SchnorrKeyPair; network: keyof AvailableNetworks; }} params The parameters for the signer.
-     * @param {SchnorrKeyPair} params.keyPair The key pair used for signing.
-     * @param {keyof AvailableNetworks} params.network The network associated with the signer.
-     */
-    constructor(params) {
-        this.keyPair = params.keyPair;
-        this.network = params.network;
-    }
-    /**
-     * Gets the public key bytes.
-     * @returns {KeyBytes} The public key bytes.
-     */
-    get publicKey() {
-        return this.keyPair.publicKey.compressed;
-    }
-    /**
-     * Signs the given hash using ECDSA.
-     * @param {Bytes} hash The hash to sign.
-     * @returns {SignatureBytes} The signature of the hash.
-     */
-    signEcdsa(hash) {
-        return this.keyPair.secretKey.sign(hash, { scheme: 'ecdsa' });
-    }
-    ;
-    /**
-     * Signs the given hash using Schnorr signature.
-     * @param {Bytes} hash The hash to sign.
-     * @returns {SignatureBytes} The Schnorr signature of the hash.
-     */
-    sign(hash) {
-        return this.keyPair.secretKey.sign(hash);
-    }
-}
-//# sourceMappingURL=signer.js.map

package/dist/cjs/signer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signer.js","sourceRoot":"","sources":["../../src/signer.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,OAAO,MAAM;IACjB;;;OAGG;IACH,OAAO,CAAiB;IAExB;;;OAGG;IACH,OAAO,CAA0B;IAEjC;;;;;OAKG;IACH,YAAY,MAAsE;QAChF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAW;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACH,IAAI,CAAC,IAAW;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/esm/signer.js

@@ -1,53 +0,0 @@
-/**
- * Class representing a signer for cryptographic operations.
- * Remains for backwards compatibility. Plan to migrate to Kms.
- * @class Signer
- * @type {Signer}
- */
-export class Signer {
-    /**
-     * The key pair used for signing.
-     * @type {SchnorrKeyPair}
-     */
-    keyPair;
-    /**
-     * The network associated with the signer.
-     * @type {keyof AvailableNetworks}
-     */
-    network;
-    /**
-     * Creates an instance of Signer.
-     * @param {{ keyPair: SchnorrKeyPair; network: keyof AvailableNetworks; }} params The parameters for the signer.
-     * @param {SchnorrKeyPair} params.keyPair The key pair used for signing.
-     * @param {keyof AvailableNetworks} params.network The network associated with the signer.
-     */
-    constructor(params) {
-        this.keyPair = params.keyPair;
-        this.network = params.network;
-    }
-    /**
-     * Gets the public key bytes.
-     * @returns {KeyBytes} The public key bytes.
-     */
-    get publicKey() {
-        return this.keyPair.publicKey.compressed;
-    }
-    /**
-     * Signs the given hash using ECDSA.
-     * @param {Bytes} hash The hash to sign.
-     * @returns {SignatureBytes} The signature of the hash.
-     */
-    signEcdsa(hash) {
-        return this.keyPair.secretKey.sign(hash, { scheme: 'ecdsa' });
-    }
-    ;
-    /**
-     * Signs the given hash using Schnorr signature.
-     * @param {Bytes} hash The hash to sign.
-     * @returns {SignatureBytes} The Schnorr signature of the hash.
-     */
-    sign(hash) {
-        return this.keyPair.secretKey.sign(hash);
-    }
-}
-//# sourceMappingURL=signer.js.map

package/dist/esm/signer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signer.js","sourceRoot":"","sources":["../../src/signer.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,OAAO,MAAM;IACjB;;;OAGG;IACH,OAAO,CAAiB;IAExB;;;OAGG;IACH,OAAO,CAA0B;IAEjC;;;;;OAKG;IACH,YAAY,MAAsE;QAChF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAW;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACH,IAAI,CAAC,IAAW;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/types/signer.d.ts

@@ -1,48 +0,0 @@
-import { AvailableNetworks } from '@did-btcr2/bitcoin';
-import { KeyBytes, Bytes, SignatureBytes } from '@did-btcr2/common';
-import { SchnorrKeyPair } from '@did-btcr2/keypair';
-/**
- * Class representing a signer for cryptographic operations.
- * Remains for backwards compatibility. Plan to migrate to Kms.
- * @class Signer
- * @type {Signer}
- */
-export declare class Signer {
-    /**
-     * The key pair used for signing.
-     * @type {SchnorrKeyPair}
-     */
-    keyPair: SchnorrKeyPair;
-    /**
-     * The network associated with the signer.
-     * @type {keyof AvailableNetworks}
-     */
-    network: keyof AvailableNetworks;
-    /**
-     * Creates an instance of Signer.
-     * @param {{ keyPair: SchnorrKeyPair; network: keyof AvailableNetworks; }} params The parameters for the signer.
-     * @param {SchnorrKeyPair} params.keyPair The key pair used for signing.
-     * @param {keyof AvailableNetworks} params.network The network associated with the signer.
-     */
-    constructor(params: {
-        keyPair: SchnorrKeyPair;
-        network: keyof AvailableNetworks;
-    });
-    /**
-     * Gets the public key bytes.
-     * @returns {KeyBytes} The public key bytes.
-     */
-    get publicKey(): KeyBytes;
-    /**
-     * Signs the given hash using ECDSA.
-     * @param {Bytes} hash The hash to sign.
-     * @returns {SignatureBytes} The signature of the hash.
-     */
-    signEcdsa(hash: Bytes): SignatureBytes;
-    /**
-     * Signs the given hash using Schnorr signature.
-     * @param {Bytes} hash The hash to sign.
-     * @returns {SignatureBytes} The Schnorr signature of the hash.
-     */
-    sign(hash: Bytes): SignatureBytes;
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAG,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;GAKG;AACH,qBAAa,MAAM;IACjB;;;OAGG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB;;;OAGG;IACH,OAAO,EAAE,MAAM,iBAAiB,CAAC;IAEjC;;;;;OAKG;gBACS,MAAM,EAAE;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,OAAO,EAAE,MAAM,iBAAiB,CAAC;KAAE;IAKlF;;;OAGG;IACH,IAAI,SAAS,IAAI,QAAQ,CAExB;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc;IAItC;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc;CAGlC"}

package/src/signer.ts

@@ -1,60 +0,0 @@
-import { AvailableNetworks } from '@did-btcr2/bitcoin';
-import { KeyBytes, Bytes, SignatureBytes } from '@did-btcr2/common';
-import {  SchnorrKeyPair } from '@did-btcr2/keypair';
-
-/**
- * Class representing a signer for cryptographic operations.
- * Remains for backwards compatibility. Plan to migrate to Kms.
- * @class Signer
- * @type {Signer}
- */
-export class Signer {
-  /**
-   * The key pair used for signing.
-   * @type {SchnorrKeyPair}
-   */
-  keyPair: SchnorrKeyPair;
-
-  /**
-   * The network associated with the signer.
-   * @type {keyof AvailableNetworks}
-   */
-  network: keyof AvailableNetworks;
-
-  /**
-   * Creates an instance of Signer.
-   * @param {{ keyPair: SchnorrKeyPair; network: keyof AvailableNetworks; }} params The parameters for the signer.
-   * @param {SchnorrKeyPair} params.keyPair The key pair used for signing.
-   * @param {keyof AvailableNetworks} params.network The network associated with the signer.
-   */
-  constructor(params: { keyPair: SchnorrKeyPair; network: keyof AvailableNetworks; }) {
-    this.keyPair = params.keyPair;
-    this.network = params.network;
-  }
-
-  /**
-   * Gets the public key bytes.
-   * @returns {KeyBytes} The public key bytes.
-   */
-  get publicKey(): KeyBytes {
-    return this.keyPair.publicKey.compressed;
-  }
-
-  /**
-   * Signs the given hash using ECDSA.
-   * @param {Bytes} hash The hash to sign.
-   * @returns {SignatureBytes} The signature of the hash.
-   */
-  signEcdsa(hash: Bytes): SignatureBytes {
-    return this.keyPair.secretKey.sign(hash, { scheme: 'ecdsa' });
-  };
-
-  /**
-   * Signs the given hash using Schnorr signature.
-   * @param {Bytes} hash The hash to sign.
-   * @returns {SignatureBytes} The Schnorr signature of the hash.
-   */
-  sign(hash: Bytes): SignatureBytes {
-    return this.keyPair.secretKey.sign(hash);
-  }
-}