@le-space/aleph-bootstrap 0.9.2 → 0.9.3

package/index.d.ts

@@ -85,6 +85,13 @@ interface DiscoverAlephBootstrapOptions {
     maxAgeMs?: number;
     compactMultiaddrLimit?: number;
     browserDialableOnly?: boolean;
+    /**
+     * Keep plaintext `/ws` relays in a browser-dialable result. Defaults to
+     * false so an https page never receives an address the browser will block as
+     * mixed content. Set it for consumers that dial from node or a plain-http
+     * origin.
+     */
+    allowInsecureWebSockets?: boolean;
     requireDualKeyAttestation?: boolean;
     verifyDualKeyAttestation?: boolean;
     /**
@@ -101,6 +108,15 @@ interface DiscoverAlephBootstrapOptions {
 interface FilterPublicMultiaddrsOptions {
     browserDialableOnly?: boolean;
     requirePeerId?: boolean;
+    /**
+     * Keep plaintext `/ws` addresses in the browser-dialable set. Defaults to
+     * false: a page served over https cannot open a `ws://` socket, the browser
+     * blocks it as mixed content, so a plaintext relay is dead weight in a
+     * browser bootstrap list. Publishers pass true — a relay should still
+     * announce the plaintext port it really serves, for node peers that can use
+     * it.
+     */
+    allowInsecureWebSockets?: boolean;
 }
 interface CreateRelayBootstrapPostOptions {
     sender: string;
@@ -122,7 +138,14 @@ interface CreateRelayBootstrapPostOptions {
 }
 type RelayBootstrapTrustMode = "wallet-signed" | "dual-key-attested";
 declare function relayBootstrapMultiaddrsHash(addrs: readonly string[]): string;
+/**
+ * Publish-side helper: pick the addresses a relay announces to the registry.
+ * Plaintext `/ws` is kept here on purpose — announcing the port the relay
+ * really serves is honest, and node peers can dial it. Browsers filter it out
+ * again on the read side, where the https origin makes it undialable.
+ */
 declare function selectCompactRelayBootstrapMultiaddrs(addrs: readonly string[], limit?: number): string[];
+declare function isBrowserDialableMultiaddr(addr: string, options?: Pick<FilterPublicMultiaddrsOptions, "allowInsecureWebSockets">): boolean;
 declare function dedupeMultiaddrs(addrs: readonly string[]): string[];
 declare function isPublicMultiaddr(addr: string): boolean;
 declare function filterPublicMultiaddrs(addrs: readonly string[], options?: FilterPublicMultiaddrsOptions): string[];
@@ -202,4 +225,4 @@ declare function createLibp2pAlephBootstrap(options?: DiscoverAlephBootstrapOpti
     tagName?: string;
 }): Promise<ReturnType<typeof bootstrap>>;
 
-export { type CreateRelayBootstrapPostOptions, DEFAULT_ALEPH_API_HOST, DEFAULT_ALEPH_BOOTSTRAP_CHANNEL, DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE, DEFAULT_ALEPH_BOOTSTRAP_REF, DEFAULT_BOOTSTRAP_COMPACT_MULTIADDR_LIMIT, DEFAULT_BOOTSTRAP_MAX_AGE_MS, DEFAULT_BOOTSTRAP_MAX_PAGES, DEFAULT_BOOTSTRAP_PAGINATION, type DiscoverAlephBootstrapOptions, type FilterPublicMultiaddrsOptions, RELAY_BOOTSTRAP_SIGNATURE_SCHEME, type RelayBootstrapAuthorizationPayload, type RelayBootstrapAuthorizationRecord, type RelayBootstrapContent, type RelayBootstrapPostContent, type RelayBootstrapPostRecord, type RelayBootstrapProofPayload, type RelayBootstrapProofRecord, type RelayBootstrapProofSigner, type RelayBootstrapTrustMode, type RelayBootstrapVerificationResult, buildRelayBootstrapPostContent, createLibp2pAlephBootstrap, createRelayBootstrapPost, dedupeMultiaddrs, discoverAlephBootstrapMultiaddrs, fetchAlephBootstrapPosts, filterPublicMultiaddrs, filterRelayBootstrapPostsByProfile, isPublicMultiaddr, relayBootstrapMultiaddrsHash, relayBootstrapTrustMode, selectCompactRelayBootstrapMultiaddrs, selectCurrentRelayBootstrapPosts, signRelayBootstrapAuthorization, signRelayBootstrapProof, verifyRelayBootstrapAuthorization, verifyRelayBootstrapDualKeyContent, verifyRelayBootstrapProof };
+export { type CreateRelayBootstrapPostOptions, DEFAULT_ALEPH_API_HOST, DEFAULT_ALEPH_BOOTSTRAP_CHANNEL, DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE, DEFAULT_ALEPH_BOOTSTRAP_REF, DEFAULT_BOOTSTRAP_COMPACT_MULTIADDR_LIMIT, DEFAULT_BOOTSTRAP_MAX_AGE_MS, DEFAULT_BOOTSTRAP_MAX_PAGES, DEFAULT_BOOTSTRAP_PAGINATION, type DiscoverAlephBootstrapOptions, type FilterPublicMultiaddrsOptions, RELAY_BOOTSTRAP_SIGNATURE_SCHEME, type RelayBootstrapAuthorizationPayload, type RelayBootstrapAuthorizationRecord, type RelayBootstrapContent, type RelayBootstrapPostContent, type RelayBootstrapPostRecord, type RelayBootstrapProofPayload, type RelayBootstrapProofRecord, type RelayBootstrapProofSigner, type RelayBootstrapTrustMode, type RelayBootstrapVerificationResult, buildRelayBootstrapPostContent, createLibp2pAlephBootstrap, createRelayBootstrapPost, dedupeMultiaddrs, discoverAlephBootstrapMultiaddrs, fetchAlephBootstrapPosts, filterPublicMultiaddrs, filterRelayBootstrapPostsByProfile, isBrowserDialableMultiaddr, isPublicMultiaddr, relayBootstrapMultiaddrsHash, relayBootstrapTrustMode, selectCompactRelayBootstrapMultiaddrs, selectCurrentRelayBootstrapPosts, signRelayBootstrapAuthorization, signRelayBootstrapProof, verifyRelayBootstrapAuthorization, verifyRelayBootstrapDualKeyContent, verifyRelayBootstrapProof };

package/index.js

@@ -58,7 +58,8 @@ function browserMultiaddrTransport(addr) {
 }
 function selectCompactRelayBootstrapMultiaddrs(addrs, limit = DEFAULT_BOOTSTRAP_COMPACT_MULTIADDR_LIMIT) {
   const entries = filterPublicMultiaddrs(addrs, {
-    browserDialableOnly: true
+    browserDialableOnly: true,
+    allowInsecureWebSockets: true
   }).map((addr, index) => ({
     addr,
     index,
@@ -134,12 +135,23 @@ function isLocalHostname(host) {
 function hasPeerId(addr) {
   return splitMultiaddr(addr).includes("p2p");
 }
-function isBrowserDialableMultiaddr(addr) {
+function isSecureWebSocketMultiaddr(addr) {
+  const parts = splitMultiaddr(addr.toLowerCase());
+  if (parts.includes("wss")) return true;
+  const wsIndex = parts.indexOf("ws");
+  return wsIndex > 0 && parts.lastIndexOf("tls", wsIndex) >= 0;
+}
+function isWebSocketMultiaddr(addr) {
+  const parts = splitMultiaddr(addr.toLowerCase());
+  return parts.includes("ws") || parts.includes("wss");
+}
+function isBrowserDialableMultiaddr(addr, options = {}) {
   const normalized = addr.toLowerCase();
   if (normalized.includes("/webtransport") || normalized.includes("/webrtc-direct")) {
     return normalized.includes("/certhash/");
   }
-  return normalized.includes("/ws") || normalized.includes("/wss");
+  if (!isWebSocketMultiaddr(addr)) return false;
+  return (options.allowInsecureWebSockets ?? false) || isSecureWebSocketMultiaddr(addr);
 }
 function dedupeMultiaddrs(addrs) {
   const seen = /* @__PURE__ */ new Set();
@@ -173,7 +185,9 @@ function filterPublicMultiaddrs(addrs, options = {}) {
   return dedupeMultiaddrs(addrs).filter((addr) => {
     if (!isPublicMultiaddr(addr)) return false;
     if (options.requirePeerId !== false && !hasPeerId(addr)) return false;
-    if (options.browserDialableOnly && !isBrowserDialableMultiaddr(addr)) {
+    if (options.browserDialableOnly && !isBrowserDialableMultiaddr(addr, {
+      allowInsecureWebSockets: options.allowInsecureWebSockets
+    })) {
       return false;
     }
     return true;
@@ -288,7 +302,8 @@ function buildRelayBootstrapPostContent(args) {
   const updatedAt = args.now ?? Date.now();
   const fullMultiaddrs = filterPublicMultiaddrs(args.multiaddrs);
   const fullBrowserMultiaddrs = args.browserMultiaddrs ? filterPublicMultiaddrs(args.browserMultiaddrs, {
-    browserDialableOnly: true
+    browserDialableOnly: true,
+    allowInsecureWebSockets: true
   }) : void 0;
   const compactMultiaddrs = selectCompactRelayBootstrapMultiaddrs(
     fullBrowserMultiaddrs && fullBrowserMultiaddrs.length > 0 ? fullBrowserMultiaddrs : fullMultiaddrs,
@@ -376,7 +391,8 @@ async function signRelayBootstrapAuthorization(args) {
 async function signRelayBootstrapProof(args) {
   const fullMultiaddrs = filterPublicMultiaddrs(args.multiaddrs);
   const fullBrowserMultiaddrs = args.browserMultiaddrs ? filterPublicMultiaddrs(args.browserMultiaddrs, {
-    browserDialableOnly: true
+    browserDialableOnly: true,
+    allowInsecureWebSockets: true
   }) : void 0;
   const compactMultiaddrs = selectCompactRelayBootstrapMultiaddrs(
     fullBrowserMultiaddrs && fullBrowserMultiaddrs.length > 0 ? fullBrowserMultiaddrs : fullMultiaddrs,
@@ -688,7 +704,8 @@ async function discoverAlephBootstrapMultiaddrs(options = {}) {
     });
     const addrs = relayBootstrapPostsToMultiaddrs(
       trustedPosts,
-      browserDialableOnly
+      browserDialableOnly,
+      options.allowInsecureWebSockets ?? false
     );
     if (addrs.length > 0) {
       return addrs;
@@ -699,7 +716,7 @@ async function discoverAlephBootstrapMultiaddrs(options = {}) {
   }
   return [];
 }
-function relayBootstrapPostsToMultiaddrs(posts, browserDialableOnly) {
+function relayBootstrapPostsToMultiaddrs(posts, browserDialableOnly, allowInsecureWebSockets) {
   const addrs = [];
   for (const post of posts) {
     const content = post.content;
@@ -707,7 +724,8 @@ function relayBootstrapPostsToMultiaddrs(posts, browserDialableOnly) {
     const candidates = browserDialableOnly && Array.isArray(content.browserMultiaddrs) && content.browserMultiaddrs.length > 0 ? content.browserMultiaddrs : content.multiaddrs;
     addrs.push(
       ...filterPublicMultiaddrs(candidates, {
-        browserDialableOnly
+        browserDialableOnly,
+        allowInsecureWebSockets
       })
     );
   }
@@ -739,6 +757,7 @@ export {
   fetchAlephBootstrapPosts,
   filterPublicMultiaddrs,
   filterRelayBootstrapPostsByProfile,
+  isBrowserDialableMultiaddr,
   isPublicMultiaddr,
   relayBootstrapMultiaddrsHash,
   relayBootstrapTrustMode,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@le-space/aleph-bootstrap",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "description": "Aleph-backed libp2p bootstrap discovery and relay registration helpers.",
   "license": "MIT",
   "type": "module",