@bsv/sdk 1.1.33 → 1.2.1

package/dist/types/src/overlay-tools/SHIPBroadcaster.d.ts

@@ -0,0 +1,90 @@
+import { Transaction, BroadcastResponse, BroadcastFailure, Broadcaster } from '../transaction/index.js';
+import LookupResolver from './LookupResolver.js';
+/**
+ * Tagged BEEF
+ *
+ * @description
+ * Tagged BEEF ([Background Evaluation Extended Format](https://brc.dev/62)) structure. Comprises a transaction, its SPV information, and the overlay topics where its inclusion is requested.
+ */
+export interface TaggedBEEF {
+    beef: number[];
+    topics: string[];
+}
+/**
+ * Instructs the Overlay Services Engine about which outputs to admit and which previous outputs to retain. Returned by a Topic Manager.
+ */
+export interface AdmittanceInstructions {
+    /**
+       * The indices of all admissable outputs into the managed topic from the provided transaction.
+       */
+    outputsToAdmit: number[];
+    /**
+       * The indices of all inputs from the provided transaction which spend previously-admitted outputs that should be retained for historical record-keeping.
+       */
+    coinsToRetain: number[];
+}
+/**
+ * Submitted Transaction Execution AcKnowledgment
+ *
+ * @description
+ * Comprises the topics where a transaction was submitted, and for each one, the output indices for the UTXOs newly admitted into the topics, and the coins retained.
+ * An object whose keys are topic names and whose values are topical admittance instructions denoting the state of the submitted transaction with respect to the associated topic.
+ */
+export type STEAK = Record<string, AdmittanceInstructions>;
+/** Configuration options for the SHIP broadcaster. */
+export interface SHIPBroadcasterConfig {
+    /** The facilitator used to make requests to Overlay Services hosts. */
+    facilitator?: OverlayBroadcastFacilitator;
+    /** The resolver used to locate suitable hosts with SHIP */
+    resolver: LookupResolver;
+    /** Determines which topics (all, any, or a specific list) must be present within all STEAKs received from every host for the broadcast to be considered a success. By default, all hosts must acknowledge all topics. */
+    requireAcknowledgmentFromAllHostsForTopics?: 'all' | 'any' | string[];
+    /** Determines which topics (all, any, or a specific list) must be present within STEAK received from at least one host for the broadcast to be considered a success. */
+    requireAcknowledgmentFromAnyHostForTopics?: 'all' | 'any' | string[];
+    /** Determines a mapping whose keys are specific hosts and whose values are the topics (all, any, or a specific list) that must be present within the STEAK received by the given hosts, in order for the broadcast to be considered a success. */
+    requireAcknowledgmentFromSpecificHostsForTopics?: Record<string, 'all' | 'any' | string[]>;
+}
+/** Facilitates transaction broadcasts that return STEAK. */
+export interface OverlayBroadcastFacilitator {
+    send: (url: string, taggedBEEF: TaggedBEEF) => Promise<STEAK>;
+}
+export declare class HTTPSOverlayBroadcastFacilitator implements OverlayBroadcastFacilitator {
+    httpClient: typeof fetch;
+    constructor(httpClient?: typeof fetch);
+    send(url: string, taggedBEEF: TaggedBEEF): Promise<STEAK>;
+}
+/**
+ * Represents a SHIP transaction broadcaster.
+ */
+export default class SHIPCast implements Broadcaster {
+    private readonly topics;
+    private readonly facilitator;
+    private readonly resolver;
+    private readonly requireAcknowledgmentFromAllHostsForTopics;
+    private readonly requireAcknowledgmentFromAnyHostForTopics;
+    private readonly requireAcknowledgmentFromSpecificHostsForTopics;
+    /**
+       * Constructs an instance of the SHIP broadcaster.
+       *
+       * @param {string[]} topics - The list of SHIP topic names where transactions are to be sent.
+       * @param {SHIPBroadcasterConfig} config - Configuration options for the SHIP broadcaster.
+       */
+    constructor(topics: string[], config?: SHIPBroadcasterConfig);
+    /**
+       * Broadcasts a transaction to Overlay Services via SHIP.
+       *
+       * @param {Transaction} tx - The transaction to be sent.
+       * @returns {Promise<BroadcastResponse | BroadcastFailure>} A promise that resolves to either a success or failure response.
+       */
+    broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>;
+    private checkAcknowledgmentFromAllHosts;
+    private checkAcknowledgmentFromAnyHost;
+    private checkAcknowledgmentFromSpecificHosts;
+    /**
+       * Finds which hosts are interested in transactions tagged with the given set of topics.
+       *
+       * @returns A mapping of URLs for hosts interested in this transaction. Keys are URLs, values are which of our topics the specific host cares about.
+       */
+    private findInterestedHosts;
+}
+//# sourceMappingURL=SHIPBroadcaster.d.ts.map

package/dist/types/src/overlay-tools/SHIPBroadcaster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SHIPBroadcaster.d.ts","sourceRoot":"","sources":["../../../../src/overlay-tools/SHIPBroadcaster.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACvG,OAAO,cAAc,MAAM,qBAAqB,CAAA;AAGhD;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;SAEK;IACL,cAAc,EAAE,MAAM,EAAE,CAAA;IAExB;;SAEK;IACL,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;AAE1D,sDAAsD;AACtD,MAAM,WAAW,qBAAqB;IACpC,uEAAuE;IACvE,WAAW,CAAC,EAAE,2BAA2B,CAAA;IACzC,2DAA2D;IAC3D,QAAQ,EAAE,cAAc,CAAA;IACxB,yNAAyN;IACzN,0CAA0C,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,EAAE,CAAA;IACrE,wKAAwK;IACxK,yCAAyC,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,EAAE,CAAA;IACpE,kPAAkP;IAClP,+CAA+C,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,EAAE,CAAC,CAAA;CAC3F;AAED,4DAA4D;AAC5D,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,KAAK,OAAO,CAAC,KAAK,CAAC,CAAA;CAC9D;AAED,qBAAa,gCAAiC,YAAW,2BAA2B;IAClF,UAAU,EAAE,OAAO,KAAK,CAAA;gBAEZ,UAAU,eAAQ;IAIxB,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;CAkBhE;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,WAAW;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAU;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6B;IACzD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,0CAA0C,CAA0B;IACrF,OAAO,CAAC,QAAQ,CAAC,yCAAyC,CAA0B;IACpF,OAAO,CAAC,QAAQ,CAAC,+CAA+C,CAA0C;IAE1G;;;;;SAKK;gBACO,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,qBAAqB;IAqB5D;;;;;SAKK;IACC,SAAS,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IA6I/E,OAAO,CAAC,+BAA+B;IAwBvC,OAAO,CAAC,8BAA8B;IA6BtC,OAAO,CAAC,oCAAoC;IAyC5C;;;;SAIK;YACS,mBAAmB;CAmClC"}

package/dist/types/src/overlay-tools/index.d.ts

@@ -0,0 +1,6 @@
+export * from './LookupResolver.js';
+export * from './SHIPBroadcaster.js';
+export { default as OverlayAdminTokenTemplate } from './OverlayAdminTokenTemplate.js';
+export { default as LookupResolver } from './LookupResolver.js';
+export { default as SHIPBroadcaster } from './SHIPBroadcaster.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/overlay-tools/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/overlay-tools/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AACrF,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAC/D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/types/src/script/templates/PushDrop.d.ts

@@ -0,0 +1,53 @@
+import { ScriptTemplate, LockingScript, UnlockingScript } from '../index.js';
+import { PublicKey } from '../../primitives/index.js';
+import { Wallet } from '../../wallet/Wallet.interfaces.js';
+import { Transaction } from '../../transaction/index.js';
+export default class PushDrop implements ScriptTemplate {
+    wallet: Wallet;
+    /**
+     * Decodes a PushDrop script back into its token fields and the locking public key. If a signature was present, it will be the last field returned.
+     * Warning: Only works with a P2PK lock at the beginning of the script.
+     * @param script PushDrop script to decode back into token fields
+     * @returns An object containing PushDrop token fields and the locking public key. If a signature was included, it will be the last field.
+     */
+    static decode(script: LockingScript): {
+        lockingPublicKey: PublicKey;
+        fields: number[][];
+    };
+    /**
+     * Constructs a new instance of the PushDrop class.
+     *
+     * @param {Wallet} wallet - The wallet interface used for creating signatures and accessing public keys.
+     */
+    constructor(wallet: Wallet);
+    /**
+     * Creates a PushDrop locking script with arbitrary data fields and a public key lock.
+     *
+     * @param {number[][]} fields - The token fields to include in the locking script.
+     * @param {[0 | 1 | 2, string]} protocolID - The protocol ID to use.
+     * @param {string} keyID - The key ID to use.
+     * @param {string} counterparty - The counterparty involved in the transaction, "self" or "anyone".
+     * @param {boolean} [forSelf=false] - Flag indicating if the lock is for the creator (default no).
+     * @param {boolean} [includeSignature=true] - Flag indicating if a signature should be included in the script (default yes).
+     * @returns {Promise<LockingScript>} The generated PushDrop locking script.
+     */
+    lock(fields: number[][], protocolID: [0 | 1 | 2, string], keyID: string, counterparty: string, forSelf?: boolean, includeSignature?: boolean, lockPosition?: 'before' | 'after'): Promise<LockingScript>;
+    /**
+     * Creates an unlocking script for spending a PushDrop token output.
+     *
+     * @param {[0 | 1 | 2, string]} protocolID - The protocol ID to use.
+     * @param {string} keyID - The key ID to use.
+     * @param {string} counterparty - The counterparty involved in the transaction, "self" or "anyone".
+     * @param {string} [sourceTXID] - The TXID of the source transaction.
+     * @param {number} [sourceSatoshis] - The number of satoshis in the source output.
+     * @param {LockingScript} [lockingScript] - The locking script of the source output.
+     * @param {'all' | 'none' | 'single'} [signOutputs='all'] - Specifies which outputs to sign.
+     * @param {boolean} [anyoneCanPay=false] - Specifies if the anyone-can-pay flag is set.
+     * @returns {Object} An object containing functions to sign the transaction and estimate the script length.
+     */
+    unlock(protocolID: [0 | 1 | 2, string], keyID: string, counterparty: string, signOutputs?: 'all' | 'none' | 'single', anyoneCanPay?: boolean, sourceSatoshis?: number, lockingScript?: LockingScript): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: () => Promise<73>;
+    };
+}
+//# sourceMappingURL=PushDrop.d.ts.map

package/dist/types/src/script/templates/PushDrop.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PushDrop.d.ts","sourceRoot":"","sources":["../../../../../src/script/templates/PushDrop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,eAAe,EAAM,MAAM,aAAa,CAAA;AAChF,OAAO,EAAgD,SAAS,EAAE,MAAM,2BAA2B,CAAA;AACnG,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAA;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAyCxD,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,cAAc;IACrD,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG;QAAE,gBAAgB,EAAE,SAAS,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAA;KAAE;IA6BzF;;;;OAIG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;OAUG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,UAAQ,EAAE,gBAAgB,UAAO,EAAE,YAAY,GAAE,QAAQ,GAAG,OAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IA6CnN;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAC/B,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,EACpB,WAAW,GAAE,KAAK,GAAG,MAAM,GAAG,QAAgB,EAC9C,YAAY,UAAQ,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,aAAa,GAC5B;QACD,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;QACvE,cAAc,EAAE,MAAM,OAAO,CAAC,EAAE,CAAC,CAAA;KAClC;CA0EF"}

package/dist/types/src/script/templates/index.d.ts

@@ -1,3 +1,4 @@
 export { default as P2PKH } from './P2PKH.js';
 export { default as RPuzzle } from './RPuzzle.js';
+export { default as PushDrop } from './PushDrop.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/script/templates/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/script/templates/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/script/templates/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAA"}

package/dist/types/src/wallet/CachedKeyDeriver.d.ts

@@ -0,0 +1,92 @@
+import { PrivateKey, PublicKey, SymmetricKey } from '../primitives/index.js';
+/**
+ * A cached version of KeyDeriver that caches the results of key derivation methods.
+ * This is useful for optimizing performance when the same keys are derived multiple times.
+ * It supports configurable cache size with sane defaults and maintains cache entries using LRU (Least Recently Used) eviction policy.
+ */
+export default class CachedKeyDeriver {
+    private readonly keyDeriver;
+    private readonly cache;
+    private readonly maxCacheSize;
+    /**
+       * Initializes the CachedKeyDeriver instance with a root private key and optional cache settings.
+       * @param {PrivateKey | 'anyone'} rootKey - The root private key or the string 'anyone'.
+       * @param {Object} [options] - Optional settings for the cache.
+       * @param {number} [options.maxCacheSize=1000] - The maximum number of entries to store in the cache.
+       */
+    constructor(rootKey: PrivateKey | 'anyone', options?: {
+        maxCacheSize?: number;
+    });
+    /**
+       * Derives a public key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {boolean} [forSelf=false] - Whether deriving for self.
+       * @returns {PublicKey} - The derived public key.
+       */
+    derivePublicKey(protocolID: [0 | 1 | 2, string], keyID: string, counterparty: PublicKey | string | 'self' | 'anyone', forSelf?: boolean): PublicKey;
+    /**
+       * Derives a private key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PrivateKey} - The derived private key.
+       */
+    derivePrivateKey(protocolID: [0 | 1 | 2, string], keyID: string, counterparty: PublicKey | string | 'self' | 'anyone'): PrivateKey;
+    /**
+       * Derives a symmetric key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {SymmetricKey} - The derived symmetric key.
+       * @throws {Error} - Throws an error if attempting to derive a symmetric key for 'anyone'.
+       */
+    deriveSymmetricKey(protocolID: [0 | 1 | 2, string], keyID: string, counterparty: PublicKey | string | 'self' | 'anyone'): SymmetricKey;
+    /**
+       * Reveals the shared secret between the root key and the counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {number[]} - The shared secret as a number array.
+       * @throws {Error} - Throws an error if attempting to reveal a shared secret for 'self'.
+       */
+    revealCounterpartySecret(counterparty: PublicKey | string | 'self' | 'anyone'): number[];
+    /**
+       * Reveals the specific key association for a given protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {number[]} - The specific key association as a number array.
+       */
+    revealSpecificSecret(counterparty: PublicKey | string | 'self' | 'anyone', protocolID: [0 | 1 | 2, string], keyID: string): number[];
+    /**
+       * Generates a unique cache key based on the method name and input parameters.
+       * @param {string} methodName - The name of the method.
+       * @param {...any} args - The arguments passed to the method.
+       * @returns {string} - The generated cache key.
+       */
+    private generateCacheKey;
+    /**
+       * Serializes an argument to a string for use in a cache key.
+       * @param {any} arg - The argument to serialize.
+       * @returns {string} - The serialized argument.
+       */
+    private serializeArgument;
+    /**
+       * Retrieves an item from the cache and updates its position to reflect recent use.
+       * @param {string} cacheKey - The key of the cached item.
+       * @returns {any} - The cached value.
+       */
+    private cacheGet;
+    /**
+       * Adds an item to the cache and evicts the least recently used item if necessary.
+       * @param {string} cacheKey - The key of the item to cache.
+       * @param {any} value - The value to cache.
+       */
+    private cacheSet;
+}
+//# sourceMappingURL=CachedKeyDeriver.d.ts.map

package/dist/types/src/wallet/CachedKeyDeriver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachedKeyDeriver.d.ts","sourceRoot":"","sources":["../../../../src/wallet/CachedKeyDeriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAG5E;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAkB;IACxC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;IAErC;;;;;SAKK;gBACO,OAAO,EAAE,UAAU,GAAG,QAAQ,EAAE,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE;IAM/E;;;;;;;;SAQK;IACL,eAAe,CACb,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAC/B,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,EACpD,OAAO,GAAE,OAAe,GACvB,SAAS;IAWZ;;;;;;;SAOK;IACL,gBAAgB,CACd,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAC/B,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GACnD,UAAU;IAWb;;;;;;;;SAQK;IACL,kBAAkB,CAChB,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAC/B,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GACnD,YAAY;IAWf;;;;;;SAMK;IACL,wBAAwB,CAAC,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,EAAE;IAWxF;;;;;;;SAOK;IACL,oBAAoB,CAClB,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,EACpD,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAC/B,KAAK,EAAE,MAAM,GACZ,MAAM,EAAE;IAWX;;;;;SAKK;IACL,OAAO,CAAC,gBAAgB;IAKxB;;;;SAIK;IACL,OAAO,CAAC,iBAAiB;IAYzB;;;;SAIK;IACL,OAAO,CAAC,QAAQ;IAQhB;;;;SAIK;IACL,OAAO,CAAC,QAAQ;CAQjB"}

package/dist/types/src/wallet/KeyDeriver.d.ts

@@ -0,0 +1,72 @@
+import { PrivateKey, PublicKey, SymmetricKey } from '../primitives/index.js';
+/**
+ * Class responsible for deriving various types of keys using a root private key.
+ * It supports deriving public and private keys, symmetric keys, and revealing key linkages.
+ */
+export default class KeyDeriver {
+    rootKey: PrivateKey;
+    /**
+       * Initializes the KeyDeriver instance with a root private key.
+       * @param {PrivateKey | 'anyone'} rootKey - The root private key or the string 'anyone'.
+       */
+    constructor(rootKey: PrivateKey | 'anyone');
+    /**
+       * Derives a public key based on protocol ID, key ID, and counterparty.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {boolean} [forSelf=false] - Whether deriving for self.
+       * @returns {PublicKey} - The derived public key.
+       */
+    derivePublicKey(protocolID: [0 | 1 | 2, string], keyID: string, counterparty: PublicKey | string | 'self' | 'anyone', forSelf?: boolean): PublicKey;
+    /**
+       * Derives a private key based on protocol ID, key ID, and counterparty.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PrivateKey} - The derived private key.
+       */
+    derivePrivateKey(protocolID: [0 | 1 | 2, string], keyID: string, counterparty: PublicKey | string | 'self' | 'anyone'): PrivateKey;
+    /**
+       * Derives a symmetric key based on protocol ID, key ID, and counterparty.
+       * Note: Symmetric keys should not be derivable by everyone due to security risks.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {SymmetricKey} - The derived symmetric key.
+       * @throws {Error} - Throws an error if attempting to derive a symmetric key for 'anyone'.
+       */
+    deriveSymmetricKey(protocolID: [0 | 1 | 2, string], keyID: string, counterparty: PublicKey | string | 'self' | 'anyone'): SymmetricKey;
+    /**
+       * Reveals the shared secret between the root key and the counterparty.
+       * Note: This should not be used for 'self'.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {number[]} - The shared secret as a number array.
+       * @throws {Error} - Throws an error if attempting to reveal a shared secret for 'self'.
+       */
+    revealCounterpartySecret(counterparty: PublicKey | string | 'self' | 'anyone'): number[];
+    /**
+       * Reveals the specific key association for a given protocol ID, key ID, and counterparty.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {number[]} - The specific key association as a number array.
+       */
+    revealSpecificSecret(counterparty: PublicKey | string | 'self' | 'anyone', protocolID: [0 | 1 | 2, string], keyID: string): number[];
+    /**
+       * Normalizes the counterparty to a public key.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PublicKey} - The normalized counterparty public key.
+       * @throws {Error} - Throws an error if the counterparty is invalid.
+       */
+    private normalizeCounterparty;
+    /**
+       * Computes the invoice number based on the protocol ID and key ID.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {string} - The computed invoice number.
+       * @throws {Error} - Throws an error if protocol ID or key ID are invalid.
+       */
+    private computeInvoiceNumber;
+}
+//# sourceMappingURL=KeyDeriver.d.ts.map

package/dist/types/src/wallet/KeyDeriver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyDeriver.d.ts","sourceRoot":"","sources":["../../../../src/wallet/KeyDeriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAe,MAAM,wBAAwB,CAAA;AAEzF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,EAAE,UAAU,CAAA;IAEnB;;;SAGK;gBACO,OAAO,EAAE,UAAU,GAAG,QAAQ;IAQ1C;;;;;;;SAOK;IACL,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,EAAE,OAAO,GAAE,OAAe,GAAG,SAAS;IAS1J;;;;;;SAMK;IACL,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU;IAKlI;;;;;;;;SAQK;IACL,kBAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY;IAYtI;;;;;;SAMK;IACL,wBAAwB,CAAC,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,EAAE;IAkBxF;;;;;;SAMK;IACL,oBAAoB,CAAC,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE;IAOpI;;;;;SAKK;IACL,OAAO,CAAC,qBAAqB;IAc7B;;;;;;SAMK;IACL,OAAO,CAAC,oBAAoB;CAwC7B"}