brk-client 0.3.4 → 0.3.5

package/index.js

@@ -29,6 +29,18 @@
  * @property {TypeIndex} typeIndex - Index of this address within its type on the blockchain
  * @property {Dollars} realizedPrice - Realized price (average cost basis) in USD
  */
+/**
+ * @typedef {Object} AddrHashPrefixMatches
+ * @property {OutputType} addrType
+ * @property {string} prefix
+ * @property {boolean} truncated
+ * @property {Addr[]} addresses
+ */
+/**
+ * @typedef {Object} AddrHashPrefixParam
+ * @property {OutputType} addrType
+ * @property {string} prefix
+ */
 /**
  * Address statistics in the mempool (unconfirmed transactions only)
  *
@@ -1485,6 +1497,12 @@ const _openBrowserCache = (option) => {
   return caches.open(name).catch(() => null);
 };
 
+/**
+ * @param {string} url
+ * @returns {URL}
+ */
+const _parseBaseUrl = (url) => new URL(url, typeof location === 'undefined' ? undefined : location.href);
+
 /**
  * Custom error class for BRK client errors
  */
@@ -1837,6 +1855,9 @@ class BrkClientBase {
     const isString = typeof options === 'string';
     const rawUrl = isString ? options : options.baseUrl;
     this.baseUrl = rawUrl.endsWith('/') ? rawUrl.slice(0, -1) : rawUrl;
+    const url = _parseBaseUrl(this.baseUrl);
+    this.url = url.href.endsWith('/') ? url.href.slice(0, -1) : url.href;
+    this.domain = url.hostname;
     this.timeout = isString ? 5000 : (options.timeout ?? 5000);
     /** @type {Promise<Cache | null>} */
     this._browserCachePromise = _openBrowserCache(isString ? undefined : options.browserCache);
@@ -7872,7 +7893,7 @@ function createTransferPattern(client, acc) {
  * @extends BrkClientBase
  */
 class BrkClient extends BrkClientBase {
-  VERSION = "v0.3.4";
+  VERSION = "v0.3.5";
 
   INDEXES = /** @type {const} */ ([
     "minute10",
@@ -11476,6 +11497,23 @@ class BrkClient extends BrkClientBase {
     return this.getJson(path, { signal, onValue, cache });
   }
 
+  /**
+   * Address hash-prefix matches
+   *
+   * Find addresses by address type and address-payload hash prefix. Intended for privacy-preserving client-side wallet discovery without sending raw addresses or xpubs. Fetch metadata for the returned addresses through `/api/address/{address}`.
+   *
+   * Endpoint: `GET /api/address/hash-prefix/{addr_type}/{prefix}`
+   *
+   * @param {OutputType} addr_type
+   * @param {string} prefix
+   * @param {{ signal?: AbortSignal, onValue?: (value: AddrHashPrefixMatches) => void, cache?: boolean }} [options]
+   * @returns {Promise<AddrHashPrefixMatches>}
+   */
+  async getAddressHashPrefixMatches(addr_type, prefix, { signal, onValue, cache } = {}) {
+    const path = `/api/address/hash-prefix/${addr_type}/${prefix}`;
+    return this.getJson(path, { signal, onValue, cache });
+  }
+
   /**
    * Address information
    *

package/package.json

@@ -40,5 +40,5 @@
     "url": "git+https://github.com/bitcoinresearchkit/brk.git"
   },
   "type": "module",
-  "version": "0.3.4"
+  "version": "0.3.5"
 }