@bsv/sdk 1.3.13 → 1.3.15

package/src/transaction/index.ts

@@ -1,14 +1,14 @@
-export { default as Transaction } from './Transaction'
-export { default as MerklePath } from './MerklePath'
-export type { default as TransactionInput } from './TransactionInput'
-export type { default as TransactionOutput } from './TransactionOutput'
+export { default as Transaction } from './Transaction.js'
+export { default as MerklePath } from './MerklePath.js'
+export type { default as TransactionInput } from './TransactionInput.js'
+export type { default as TransactionOutput } from './TransactionOutput.js'
 export type {
   Broadcaster,
   BroadcastFailure,
   BroadcastResponse
-} from './Broadcaster'
-export { isBroadcastResponse, isBroadcastFailure } from './Broadcaster'
-export type { default as ChainTracker } from './ChainTracker'
-export { default as BeefTx } from './BeefTx'
-export * from './Beef'
-export { default as BeefParty } from './BeefParty'
+} from './Broadcaster.js'
+export { isBroadcastResponse, isBroadcastFailure } from './Broadcaster.js'
+export type { default as ChainTracker } from './ChainTracker.js'
+export { default as BeefTx } from './BeefTx.js'
+export * from './Beef.js'
+export { default as BeefParty } from './BeefParty.js'

package/src/wallet/CachedKeyDeriver.ts

@@ -1,6 +1,6 @@
-import { PrivateKey, PublicKey, SymmetricKey } from '../primitives/index'
-import { Counterparty, KeyDeriver } from './KeyDeriver'
-import { WalletProtocol } from './Wallet.interfaces'
+import { PrivateKey, PublicKey, SymmetricKey } from '../primitives/index.js'
+import { Counterparty, KeyDeriver } from './KeyDeriver.js'
+import { WalletProtocol } from './Wallet.interfaces.js'
 
 /**
  * A cached version of KeyDeriver that caches the results of key derivation methods.
@@ -9,7 +9,7 @@ import { WalletProtocol } from './Wallet.interfaces'
  */
 export default class CachedKeyDeriver {
   private readonly keyDeriver: KeyDeriver
-  private readonly cache: Map<string, any>
+  private readonly cache: Map<string, PublicKey | PrivateKey | SymmetricKey | number[]>
   private readonly maxCacheSize: number
 
   /**
@@ -23,8 +23,9 @@ export default class CachedKeyDeriver {
     options?: { maxCacheSize?: number }
   ) {
     this.keyDeriver = new KeyDeriver(rootKey)
-    this.cache = new Map<string, any>()
-    this.maxCacheSize = options?.maxCacheSize || 1000
+    this.cache = new Map<string, PublicKey | PrivateKey | SymmetricKey | number[]>()
+    const maxCacheSize = options?.maxCacheSize
+    this.maxCacheSize = (maxCacheSize != null && !isNaN(maxCacheSize) && maxCacheSize > 0) ? maxCacheSize : 1000
   }
 
   /**
@@ -50,7 +51,11 @@ export default class CachedKeyDeriver {
       forSelf
     )
     if (this.cache.has(cacheKey)) {
-      return this.cacheGet(cacheKey)
+      const cachedValue = this.cacheGet(cacheKey)
+      if (cachedValue === undefined) {
+        throw new Error('Cached value is undefined')
+      }
+      return cachedValue as PublicKey
     } else {
       const result = this.keyDeriver.derivePublicKey(
         protocolID,
@@ -83,7 +88,11 @@ export default class CachedKeyDeriver {
       counterparty
     )
     if (this.cache.has(cacheKey)) {
-      return this.cacheGet(cacheKey)
+      const cachedValue = this.cacheGet(cacheKey)
+      if (cachedValue === undefined) {
+        throw new Error('Cached value is undefined')
+      }
+      return cachedValue as PrivateKey
     } else {
       const result = this.keyDeriver.derivePrivateKey(
         protocolID,
@@ -116,7 +125,11 @@ export default class CachedKeyDeriver {
       counterparty
     )
     if (this.cache.has(cacheKey)) {
-      return this.cacheGet(cacheKey)
+      const cachedValue = this.cacheGet(cacheKey)
+      if (cachedValue === undefined) {
+        throw new Error('Cached value is undefined')
+      }
+      return cachedValue as SymmetricKey
     } else {
       const result = this.keyDeriver.deriveSymmetricKey(
         protocolID,
@@ -141,7 +154,11 @@ export default class CachedKeyDeriver {
       counterparty
     )
     if (this.cache.has(cacheKey)) {
-      return this.cacheGet(cacheKey)
+      const cachedValue = this.cacheGet(cacheKey)
+      if (cachedValue === undefined) {
+        throw new Error('Cached value is undefined')
+      }
+      return cachedValue as number[]
     } else {
       const result = this.keyDeriver.revealCounterpartySecret(counterparty)
       this.cacheSet(cacheKey, result)
@@ -169,7 +186,11 @@ export default class CachedKeyDeriver {
       keyID
     )
     if (this.cache.has(cacheKey)) {
-      return this.cacheGet(cacheKey)
+      const cachedValue = this.cacheGet(cacheKey)
+      if (cachedValue === undefined) {
+        throw new Error('Cached value is undefined')
+      }
+      return cachedValue as number[]
     } else {
       const result = this.keyDeriver.revealSpecificSecret(
         counterparty,
@@ -187,7 +208,7 @@ export default class CachedKeyDeriver {
    * @param {...any} args - The arguments passed to the method.
    * @returns {string} - The generated cache key.
    */
-  private generateCacheKey (methodName: string, ...args: any[]): string {
+  private generateCacheKey (methodName: string, ...args: Array<string | number | boolean | PublicKey | PrivateKey | Counterparty | WalletProtocol>): string {
     const serializedArgs = args
       .map((arg) => this.serializeArgument(arg))
       .join('|')
@@ -199,7 +220,7 @@ export default class CachedKeyDeriver {
    * @param {any} arg - The argument to serialize.
    * @returns {string} - The serialized argument.
    */
-  private serializeArgument (arg: any): string {
+  private serializeArgument (arg: string | number | boolean | PublicKey | PrivateKey | Counterparty | WalletProtocol | object | null): string {
     if (arg instanceof PublicKey || arg instanceof PrivateKey) {
       return arg.toString()
     } else if (Array.isArray(arg)) {
@@ -216,11 +237,13 @@ export default class CachedKeyDeriver {
    * @param {string} cacheKey - The key of the cached item.
    * @returns {any} - The cached value.
    */
-  private cacheGet (cacheKey: string): any {
+  private cacheGet (cacheKey: string): PublicKey | PrivateKey | SymmetricKey | number[] | undefined {
     const value = this.cache.get(cacheKey)
     // Update the entry to reflect recent use
     this.cache.delete(cacheKey)
-    this.cache.set(cacheKey, value)
+    if (value !== undefined) {
+      this.cache.set(cacheKey, value)
+    }
     return value
   }
 
@@ -229,7 +252,7 @@ export default class CachedKeyDeriver {
    * @param {string} cacheKey - The key of the item to cache.
    * @param {any} value - The value to cache.
    */
-  private cacheSet (cacheKey: string, value: any): void {
+  private cacheSet (cacheKey: string, value: PublicKey | PrivateKey | SymmetricKey | number[]): void {
     if (this.cache.size >= this.maxCacheSize) {
       // Evict the least recently used item (first item in Map)
       const firstKey = this.cache.keys().next().value

package/src/wallet/KeyDeriver.ts

@@ -4,8 +4,8 @@ import {
   SymmetricKey,
   Hash,
   Utils
-} from '../primitives/index'
-import { WalletProtocol, PubKeyHex } from './Wallet.interfaces'
+} from '../primitives/index.js'
+import { WalletProtocol, PubKeyHex } from './Wallet.interfaces.js'
 
 export type Counterparty = PublicKey | PubKeyHex | 'self' | 'anyone'
 
@@ -182,7 +182,7 @@ export class KeyDeriver implements KeyDeriverApi {
       counterparty
     )
     return new SymmetricKey(
-      derivedPrivateKey.deriveSharedSecret(derivedPublicKey).x.toArray()
+      derivedPrivateKey.deriveSharedSecret(derivedPublicKey)?.x?.toArray() ?? []
     )
   }
 
@@ -247,7 +247,7 @@ export class KeyDeriver implements KeyDeriverApi {
    * @throws {Error} - Throws an error if the counterparty is invalid.
    */
   private normalizeCounterparty (counterparty: Counterparty): PublicKey {
-    if (!counterparty) {
+    if (counterparty === null || counterparty === undefined) {
       throw new Error('counterparty must be self, anyone or a public key!')
     } else if (counterparty === 'self') {
       return this.rootKey.toPublicKey()

package/src/wallet/ProtoWallet.ts

@@ -1,4 +1,4 @@
-import { KeyDeriver, KeyDeriverApi } from './KeyDeriver'
+import { KeyDeriver, KeyDeriverApi } from './KeyDeriver.js'
 import {
   Hash,
   ECDSA,
@@ -8,17 +8,13 @@ import {
   PublicKey,
   Point,
   PrivateKey
-} from '../primitives/index'
+} from '../primitives/index.js'
 import {
-  AuthenticatedResult,
   CreateHmacArgs,
   CreateHmacResult,
   CreateSignatureArgs,
   CreateSignatureResult,
-  GetNetworkResult,
   GetPublicKeyArgs,
-  GetVersionResult,
-  OriginatorDomainNameStringUnder250Bytes,
   PubKeyHex,
   RevealCounterpartyKeyLinkageArgs,
   RevealCounterpartyKeyLinkageResult,
@@ -32,7 +28,7 @@ import {
   WalletDecryptResult,
   WalletEncryptArgs,
   WalletEncryptResult
-} from './Wallet.interfaces'
+} from './Wallet.interfaces.js'
 
 /**
  * A ProtoWallet is precursor to a full wallet, capable of performing all foundational cryptographic operations.
@@ -54,23 +50,30 @@ export class ProtoWallet {
   }
 
   async getPublicKey (
-    args: GetPublicKeyArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: GetPublicKeyArgs
   ): Promise<{ publicKey: PubKeyHex }> {
     if (args.identityKey) {
+      if (this.keyDeriver == null) {
+        throw new Error('keyDeriver is undefined')
+      }
       return { publicKey: this.keyDeriver.rootKey.toPublicKey().toString() }
     } else {
-      if (!args.protocolID || !args.keyID) {
+      if (args.protocolID == null || args.keyID == null || args.keyID === '') {
         throw new Error(
           'protocolID and keyID are required if identityKey is false or undefined.'
         )
       }
+      const keyDeriver =
+        this.keyDeriver ??
+        (() => {
+          throw new Error('keyDeriver is undefined')
+        })()
       return {
-        publicKey: this.keyDeriver
+        publicKey: keyDeriver
           .derivePublicKey(
             args.protocolID,
             args.keyID,
-            args.counterparty || 'self',
+            args.counterparty ?? 'self',
             args.forSelf
           )
           .toString()
@@ -79,12 +82,14 @@ export class ProtoWallet {
   }
 
   async revealCounterpartyKeyLinkage (
-    args: RevealCounterpartyKeyLinkageArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: RevealCounterpartyKeyLinkageArgs
   ): Promise<RevealCounterpartyKeyLinkageResult> {
     const { publicKey: identityKey } = await this.getPublicKey({
       identityKey: true
     })
+    if (this.keyDeriver == null) {
+      throw new Error('keyDeriver is undefined')
+    }
     const linkage = this.keyDeriver.revealCounterpartySecret(args.counterparty)
     const linkageProof = new Schnorr().generateProof(
       this.keyDeriver.rootKey,
@@ -121,12 +126,14 @@ export class ProtoWallet {
   }
 
   async revealSpecificKeyLinkage (
-    args: RevealSpecificKeyLinkageArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: RevealSpecificKeyLinkageArgs
   ): Promise<RevealSpecificKeyLinkageResult> {
     const { publicKey: identityKey } = await this.getPublicKey({
       identityKey: true
     })
+    if (this.keyDeriver == null) {
+      throw new Error('keyDeriver is undefined')
+    }
     const linkage = this.keyDeriver.revealSpecificSecret(
       args.counterparty,
       args.protocolID,
@@ -163,103 +170,129 @@ export class ProtoWallet {
   }
 
   async encrypt (
-    args: WalletEncryptArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: WalletEncryptArgs
   ): Promise<WalletEncryptResult> {
+    if (this.keyDeriver == null) {
+      throw new Error('keyDeriver is undefined')
+    }
     const key = this.keyDeriver.deriveSymmetricKey(
       args.protocolID,
       args.keyID,
-      args.counterparty || 'self'
+      args.counterparty ?? 'self'
     )
     return { ciphertext: key.encrypt(args.plaintext) as number[] }
   }
 
   async decrypt (
-    args: WalletDecryptArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: WalletDecryptArgs
   ): Promise<WalletDecryptResult> {
+    if (this.keyDeriver == null) {
+      throw new Error('keyDeriver is undefined')
+    }
     const key = this.keyDeriver.deriveSymmetricKey(
       args.protocolID,
       args.keyID,
-      args.counterparty || 'self'
+      args.counterparty ?? 'self'
     )
     return { plaintext: key.decrypt(args.ciphertext) as number[] }
   }
 
   async createHmac (
-    args: CreateHmacArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: CreateHmacArgs
   ): Promise<CreateHmacResult> {
+    if (this.keyDeriver == null) {
+      throw new Error('keyDeriver is undefined')
+    }
     const key = this.keyDeriver.deriveSymmetricKey(
       args.protocolID,
       args.keyID,
-      args.counterparty || 'self'
+      args.counterparty ?? 'self'
     )
     return { hmac: Hash.sha256hmac(key.toArray(), args.data) }
   }
 
   async verifyHmac (
-    args: VerifyHmacArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: VerifyHmacArgs
   ): Promise<VerifyHmacResult> {
+    if (this.keyDeriver == null) {
+      throw new Error('keyDeriver is undefined')
+    }
     const key = this.keyDeriver.deriveSymmetricKey(
       args.protocolID,
       args.keyID,
-      args.counterparty || 'self'
+      args.counterparty ?? 'self'
     )
     const valid =
       Hash.sha256hmac(key.toArray(), args.data).toString() ===
       args.hmac.toString()
     if (!valid) {
-      const e = new Error('HMAC is not valid')
-      ;(e as any).code = 'ERR_INVALID_HMAC'
+      const e = new Error('HMAC is not valid') as Error & { code: string }
+      e.code = 'ERR_INVALID_HMAC'
       throw e
     }
     return { valid }
   }
 
   async createSignature (
-    args: CreateSignatureArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: CreateSignatureArgs
   ): Promise<CreateSignatureResult> {
-    if (!args.hashToDirectlySign && !args.data) {
+    if ((args.hashToDirectlySign == null) && (args.data == null)) {
       throw new Error('args.data or args.hashToDirectlySign must be valid')
     }
-    const hash: number[] = args.hashToDirectlySign || Hash.sha256(args.data)
-    const key = this.keyDeriver.derivePrivateKey(
+
+    const hash: number[] =
+      args.hashToDirectlySign ?? Hash.sha256(args.data ?? [])
+    const keyDeriver =
+      this.keyDeriver ??
+      (() => {
+        throw new Error('keyDeriver is undefined')
+      })()
+
+    const key = keyDeriver.derivePrivateKey(
       args.protocolID,
       args.keyID,
-      args.counterparty || 'anyone'
+      args.counterparty ?? 'anyone'
     )
+
     return {
       signature: ECDSA.sign(new BigNumber(hash), key, true).toDER() as number[]
     }
   }
 
   async verifySignature (
-    args: VerifySignatureArgs,
-    originator?: OriginatorDomainNameStringUnder250Bytes
+    args: VerifySignatureArgs
   ): Promise<VerifySignatureResult> {
-    if (!args.hashToDirectlyVerify && !args.data) {
+    if ((args.hashToDirectlyVerify == null) && (args.data == null)) {
       throw new Error('args.data or args.hashToDirectlyVerify must be valid')
     }
-    const hash: number[] = args.hashToDirectlyVerify || Hash.sha256(args.data)
-    const key = this.keyDeriver.derivePublicKey(
+
+    const hash: number[] =
+      args.hashToDirectlyVerify ?? Hash.sha256(args.data ?? [])
+    const keyDeriver =
+      this.keyDeriver ??
+      (() => {
+        throw new Error('keyDeriver is undefined')
+      })()
+
+    const key = keyDeriver.derivePublicKey(
       args.protocolID,
       args.keyID,
-      args.counterparty || 'self',
+      args.counterparty ?? 'self',
       args.forSelf
     )
+
     const valid = ECDSA.verify(
       new BigNumber(hash),
       Signature.fromDER(args.signature),
       key
     )
+
     if (!valid) {
-      const e = new Error('Signature is not valid')
-      ;(e as any).code = 'ERR_INVALID_SIGNATURE'
+      const e = new Error('Signature is not valid') as Error & { code: string }
+      e.code = 'ERR_INVALID_SIGNATURE'
       throw e
     }
+
     return { valid }
   }
 }

package/src/wallet/Wallet.interfaces.ts

@@ -391,6 +391,8 @@ export interface AbortActionResult {
   aborted: true
 }
 
+export type AcquireCertificateResult = WalletCertificate
+
 /**
  * @param {LabelStringUnder300Bytes[]} labels - An array of labels used to filter actions.
  * @param {'any' | 'all'} [labelQueryMode] - Specifies how to match labels (default is any which matches any of the labels).
@@ -782,8 +784,6 @@ export interface IdentityCertificate extends WalletCertificate {
   decryptedFields: Record<CertificateFieldNameUnder50Bytes, string>
 }
 
-export interface AcquireCertificateResult extends WalletCertificate {}
-
 /**
  * @param {PubKeyHex[]} certifiers - An array of public keys for specific certifiers (filters by these certifiers).
  * @param {Base64String[]} types - An array of certificate types issued by any of the specified certifiers, which should be returned.
@@ -907,6 +907,8 @@ export interface DiscoverByAttributesArgs {
   seekPermission?: BooleanDefaultTrue
 }
 
+// export interface AcquireCertificateResult extends WalletCertificate {}
+
 /**
  * Every method of the `Wallet` interface has a return value of the form `Promise<object>`.
  * When errors occur, an exception object may be thrown which must conform to the `WalletErrorObject` interface.
@@ -1142,7 +1144,7 @@ export interface WalletInterface {
   acquireCertificate: (
     args: AcquireCertificateArgs,
     originator?: OriginatorDomainNameStringUnder250Bytes
-  ) => Promise<AcquireCertificateResult>
+  ) => Promise<WalletCertificate>
 
   /**
    * Lists identity certificates belonging to the user, filtered by certifier(s) and type(s).
@@ -1212,7 +1214,7 @@ export interface WalletInterface {
    * @returns {Promise<AuthenticatedResult>} The promise resolves to an object indicating whether the user is authenticated or an error response.
    */
   isAuthenticated: (
-    args: {},
+    args: object,
     originator?: OriginatorDomainNameStringUnder250Bytes
   ) => Promise<AuthenticatedResult>
 
@@ -1224,7 +1226,7 @@ export interface WalletInterface {
    * @returns {Promise<AuthenticatedResult>} The final result indicating that the user is authenticated or an error object.
    */
   waitForAuthentication: (
-    args: {},
+    args: object,
     originator?: OriginatorDomainNameStringUnder250Bytes
   ) => Promise<AuthenticatedResult>
 
@@ -1236,7 +1238,7 @@ export interface WalletInterface {
    * @returns {Promise<Object>} Resolves to an object indicating the current height or an error on failure.
    */
   getHeight: (
-    args: {},
+    args: object,
     originator?: OriginatorDomainNameStringUnder250Bytes
   ) => Promise<GetHeightResult>
 
@@ -1260,7 +1262,7 @@ export interface WalletInterface {
    * @returns {Promise<GetNetworkResult>} The promise resolves to an object indicating whether the client is using the mainnet or testnet.
    */
   getNetwork: (
-    args: {},
+    args: object,
     originator?: OriginatorDomainNameStringUnder250Bytes
   ) => Promise<GetNetworkResult>
 
@@ -1272,7 +1274,7 @@ export interface WalletInterface {
    * @returns {Promise<GetVersionResult>} Resolves to an object containing the version string of the wallet, or an error.
    */
   getVersion: (
-    args: {},
+    args: object,
     originator?: OriginatorDomainNameStringUnder250Bytes
   ) => Promise<GetVersionResult>
 }