@le-space/aleph-bootstrap 0.6.23 → 0.6.25

package/README.md

@@ -27,20 +27,21 @@ The package defaults to the shared relay-bootstrap namespace:
 
 - channel: `simple-todo`
 - ref: `simple-todo-bootstrap`
-- post type: `relay-bootstrap`
+- post type: `relay-bootstrap-v2`
 
-All values are overrideable per app or environment.
+The channel and ref are overrideable per app or environment. The post type is
+fixed to `relay-bootstrap-v2`.
 
 ## Discovery Trust Modes
 
-The package accepts both:
+The package accepts two signing modes for v2 records:
 
-- legacy wallet-signed bootstrap posts
+- wallet-signed bootstrap posts
 - dual-key-attested bootstrap posts
 
 By default, discovery will:
 
-- accept legacy posts
+- accept wallet-signed v2 posts
 - verify dual-key records when they are present
 - ignore malformed or invalid dual-key records
 

package/index.d.ts

@@ -3,8 +3,7 @@ import { bootstrap } from '@libp2p/bootstrap';
 declare const DEFAULT_ALEPH_API_HOST = "https://api.aleph.im";
 declare const DEFAULT_ALEPH_BOOTSTRAP_CHANNEL = "simple-todo";
 declare const DEFAULT_ALEPH_BOOTSTRAP_REF = "simple-todo-bootstrap";
-declare const DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE = "relay-bootstrap";
-declare const DEFAULT_ALEPH_BOOTSTRAP_COMPACT_POST_TYPE = "relay-bootstrap-v2";
+declare const DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE = "relay-bootstrap-v2";
 declare const DEFAULT_BOOTSTRAP_MAX_AGE_MS: number;
 declare const DEFAULT_BOOTSTRAP_PAGINATION = 50;
 declare const DEFAULT_BOOTSTRAP_MAX_PAGES = 5;
@@ -80,8 +79,6 @@ interface DiscoverAlephBootstrapOptions {
     apiHost?: string;
     channel?: string;
     ref?: string;
-    postType?: string;
-    postTypes?: string[];
     page?: number;
     pagination?: number;
     maxPages?: number;
@@ -104,19 +101,17 @@ interface CreateRelayBootstrapPostOptions {
     registrationId?: string;
     ref?: string;
     channel?: string;
-    postType?: string;
     profile?: string;
     version?: string;
     ownerAddress?: string;
     publisherAddress?: string;
     authorization?: RelayBootstrapAuthorizationRecord;
     relayProof?: RelayBootstrapProofRecord;
-    compact?: boolean;
     compactMultiaddrLimit?: number;
     now?: number;
     hasher: (payload: string) => Promise<string> | string;
 }
-type RelayBootstrapTrustMode = "legacy-wallet-signed" | "dual-key-attested";
+type RelayBootstrapTrustMode = "wallet-signed" | "dual-key-attested";
 declare function relayBootstrapMultiaddrsHash(addrs: readonly string[]): string;
 declare function selectCompactRelayBootstrapMultiaddrs(addrs: readonly string[], limit?: number): string[];
 declare function dedupeMultiaddrs(addrs: readonly string[]): string[];
@@ -129,14 +124,12 @@ declare function buildRelayBootstrapPostContent(args: {
     browserMultiaddrs?: string[];
     registrationId?: string;
     ref?: string;
-    postType?: string;
     profile?: string;
     version?: string;
     ownerAddress?: string;
     publisherAddress?: string;
     authorization?: RelayBootstrapAuthorizationRecord;
     relayProof?: RelayBootstrapProofRecord;
-    compact?: boolean;
     compactMultiaddrLimit?: number;
     now?: number;
 }): RelayBootstrapPostContent;
@@ -172,7 +165,6 @@ declare function signRelayBootstrapProof(args: {
     profile?: string;
     version?: string;
     updatedAt?: number;
-    compact?: boolean;
     compactMultiaddrLimit?: number;
     signer: RelayBootstrapProofSigner;
 }): Promise<RelayBootstrapProofRecord>;
@@ -196,4 +188,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_COMPACT_POST_TYPE, 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, 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, isPublicMultiaddr, relayBootstrapMultiaddrsHash, relayBootstrapTrustMode, selectCompactRelayBootstrapMultiaddrs, selectCurrentRelayBootstrapPosts, signRelayBootstrapAuthorization, signRelayBootstrapProof, verifyRelayBootstrapAuthorization, verifyRelayBootstrapDualKeyContent, verifyRelayBootstrapProof };

package/index.js

@@ -4,8 +4,7 @@ import { keccak256, recoverMessageAddress, stringToHex } from "viem";
 var DEFAULT_ALEPH_API_HOST = "https://api.aleph.im";
 var DEFAULT_ALEPH_BOOTSTRAP_CHANNEL = "simple-todo";
 var DEFAULT_ALEPH_BOOTSTRAP_REF = "simple-todo-bootstrap";
-var DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE = "relay-bootstrap";
-var DEFAULT_ALEPH_BOOTSTRAP_COMPACT_POST_TYPE = "relay-bootstrap-v2";
+var DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE = "relay-bootstrap-v2";
 var DEFAULT_BOOTSTRAP_MAX_AGE_MS = 7 * 24 * 60 * 60 * 1e3;
 var DEFAULT_BOOTSTRAP_PAGINATION = 50;
 var DEFAULT_BOOTSTRAP_MAX_PAGES = 5;
@@ -40,9 +39,6 @@ function serializeRelayProofPayload(payload) {
 function relayBootstrapMultiaddrsHash(addrs) {
   return keccak256(stringToHex(JSON.stringify(dedupeMultiaddrs(addrs))));
 }
-function compactPostType(postType) {
-  return (postType ?? DEFAULT_ALEPH_BOOTSTRAP_COMPACT_POST_TYPE) === DEFAULT_ALEPH_BOOTSTRAP_COMPACT_POST_TYPE;
-}
 function browserMultiaddrPreference(addr) {
   const normalized = addr.toLowerCase();
   if (normalized.includes("/tcp/443/tls/ws/")) return 0;
@@ -278,8 +274,6 @@ function normalizeRelayBootstrapPostRecord(value) {
 function buildRelayBootstrapPostContent(args) {
   const now = args.now ?? Date.now() / 1e3;
   const updatedAt = args.now ?? Date.now();
-  const postType = args.postType ?? DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE;
-  const compact = args.compact ?? compactPostType(postType);
   const fullMultiaddrs = filterPublicMultiaddrs(args.multiaddrs);
   const fullBrowserMultiaddrs = args.browserMultiaddrs ? filterPublicMultiaddrs(args.browserMultiaddrs, {
     browserDialableOnly: true
@@ -289,13 +283,13 @@ function buildRelayBootstrapPostContent(args) {
     args.compactMultiaddrLimit
   );
   return {
-    type: postType,
+    type: DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE,
     address: args.sender,
     ...args.ref ? { ref: args.ref } : {},
     content: {
       peerId: args.peerId,
-      multiaddrs: compact ? compactMultiaddrs : fullMultiaddrs,
-      browserMultiaddrs: compact ? void 0 : fullBrowserMultiaddrs,
+      multiaddrs: compactMultiaddrs,
+      browserMultiaddrs: void 0,
       registrationId: args.registrationId,
       profile: args.profile,
       version: args.version,
@@ -318,14 +312,12 @@ async function createRelayBootstrapPost(args) {
     browserMultiaddrs: args.browserMultiaddrs,
     registrationId: args.registrationId,
     ref: args.ref ?? DEFAULT_ALEPH_BOOTSTRAP_REF,
-    postType: args.postType ?? DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE,
     profile: args.profile,
     version: args.version,
     ownerAddress: args.ownerAddress,
     publisherAddress: args.publisherAddress,
     authorization: args.authorization,
     relayProof: args.relayProof,
-    compact: args.compact,
     compactMultiaddrLimit: args.compactMultiaddrLimit,
     now: nowMillis
   });
@@ -347,7 +339,7 @@ function relayBootstrapTrustMode(content) {
   if (content?.authorization && content?.relayProof && content.authorization.payload.publisherAddress && content.relayProof.payload.peerId) {
     return "dual-key-attested";
   }
-  return "legacy-wallet-signed";
+  return "wallet-signed";
 }
 async function signRelayBootstrapAuthorization(args) {
   const payload = {
@@ -378,12 +370,11 @@ async function signRelayBootstrapProof(args) {
     fullBrowserMultiaddrs && fullBrowserMultiaddrs.length > 0 ? fullBrowserMultiaddrs : fullMultiaddrs,
     args.compactMultiaddrLimit
   );
-  const compact = args.compact ?? false;
   const payload = {
     peerId: args.peerId,
-    multiaddrs: compact ? void 0 : fullMultiaddrs,
-    browserMultiaddrs: compact ? void 0 : fullBrowserMultiaddrs,
-    multiaddrsHash: compact ? relayBootstrapMultiaddrsHash(compactMultiaddrs) : void 0,
+    multiaddrs: void 0,
+    browserMultiaddrs: void 0,
+    multiaddrsHash: relayBootstrapMultiaddrsHash(compactMultiaddrs),
     registrationId: args.registrationId,
     profile: args.profile,
     version: args.version,
@@ -538,10 +529,7 @@ async function fetchAlephBootstrapPosts(options = {}) {
     options.channel ?? DEFAULT_ALEPH_BOOTSTRAP_CHANNEL
   );
   url.searchParams.set("refs", options.ref ?? DEFAULT_ALEPH_BOOTSTRAP_REF);
-  url.searchParams.set(
-    "types",
-    options.postType ?? DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE
-  );
+  url.searchParams.set("types", DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE);
   url.searchParams.set(
     "pagination",
     String(options.pagination ?? DEFAULT_BOOTSTRAP_PAGINATION)
@@ -555,7 +543,21 @@ async function fetchAlephBootstrapPosts(options = {}) {
     throw new Error(`Aleph bootstrap post lookup failed: ${response.status}`);
   }
   const payload = await response.json();
-  return (payload.posts ?? []).map((entry) => normalizeRelayBootstrapPostRecord(entry)).filter((entry) => entry != null).sort((left, right) => compareRelayBootstrapPostRecency(right, left));
+  const posts = (payload.posts ?? []).map((entry) => normalizeRelayBootstrapPostRecord(entry)).filter((entry) => entry != null).sort((left, right) => compareRelayBootstrapPostRecency(right, left));
+  posts.forEach(assertSupportedRelayBootstrapPost);
+  return posts;
+}
+function assertSupportedRelayBootstrapPost(post) {
+  if (post.type === "relay-bootstrap") {
+    throw new Error(
+      "Legacy relay-bootstrap record encountered. Only relay-bootstrap-v2 is supported."
+    );
+  }
+  if (post.type && post.type !== DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE) {
+    throw new Error(
+      `Unsupported relay bootstrap post type: ${post.type}. Expected ${DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE}.`
+    );
+  }
 }
 function compareRelayBootstrapPostRecency(left, right) {
   const leftUpdatedAt = left.content?.updatedAt ?? 0;
@@ -577,6 +579,7 @@ function selectCurrentRelayBootstrapPosts(posts, options = {}) {
   const now = options.now ?? Date.now();
   const selected = /* @__PURE__ */ new Map();
   for (const post of posts) {
+    assertSupportedRelayBootstrapPost(post);
     const content = post.content;
     if (!content) continue;
     if (now - content.updatedAt > maxAgeMs) continue;
@@ -599,7 +602,7 @@ async function filterTrustedRelayBootstrapPosts(posts, options = {}) {
     const content = post.content;
     if (!content) continue;
     const trustMode = relayBootstrapTrustMode(content);
-    if (trustMode === "legacy-wallet-signed") {
+    if (trustMode === "wallet-signed") {
       if (!requireDualKeyAttestation) {
         trusted.push(post);
       }
@@ -621,38 +624,31 @@ async function discoverAlephBootstrapMultiaddrs(options = {}) {
   const pagination = options.pagination ?? DEFAULT_BOOTSTRAP_PAGINATION;
   const startPage = options.page ?? 1;
   const maxPages = Math.max(1, options.maxPages ?? DEFAULT_BOOTSTRAP_MAX_PAGES);
-  const postTypes = options.postType != null ? [options.postType] : options.postTypes && options.postTypes.length > 0 ? options.postTypes : [
-    DEFAULT_ALEPH_BOOTSTRAP_COMPACT_POST_TYPE,
-    DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE
-  ];
-  for (const postType of postTypes) {
-    const collectedPosts = [];
-    for (let offset = 0; offset < maxPages; offset += 1) {
-      const page = startPage + offset;
-      const pagePosts = await fetchAlephBootstrapPosts({
-        ...options,
-        postType,
-        page,
-        pagination
-      });
-      collectedPosts.push(...pagePosts);
-      const selectedPosts = selectCurrentRelayBootstrapPosts(collectedPosts, {
-        maxAgeMs: options.maxAgeMs
-      });
-      const trustedPosts = await filterTrustedRelayBootstrapPosts(selectedPosts, {
-        requireDualKeyAttestation: options.requireDualKeyAttestation,
-        verifyDualKeyAttestation: options.verifyDualKeyAttestation
-      });
-      const addrs = relayBootstrapPostsToMultiaddrs(
-        trustedPosts,
-        browserDialableOnly
-      );
-      if (addrs.length > 0) {
-        return addrs;
-      }
-      if (pagePosts.length < pagination) {
-        break;
-      }
+  const collectedPosts = [];
+  for (let offset = 0; offset < maxPages; offset += 1) {
+    const page = startPage + offset;
+    const pagePosts = await fetchAlephBootstrapPosts({
+      ...options,
+      page,
+      pagination
+    });
+    collectedPosts.push(...pagePosts);
+    const selectedPosts = selectCurrentRelayBootstrapPosts(collectedPosts, {
+      maxAgeMs: options.maxAgeMs
+    });
+    const trustedPosts = await filterTrustedRelayBootstrapPosts(selectedPosts, {
+      requireDualKeyAttestation: options.requireDualKeyAttestation,
+      verifyDualKeyAttestation: options.verifyDualKeyAttestation
+    });
+    const addrs = relayBootstrapPostsToMultiaddrs(
+      trustedPosts,
+      browserDialableOnly
+    );
+    if (addrs.length > 0) {
+      return addrs;
+    }
+    if (pagePosts.length < pagination) {
+      break;
     }
   }
   return [];
@@ -682,7 +678,6 @@ async function createLibp2pAlephBootstrap(options = {}) {
 export {
   DEFAULT_ALEPH_API_HOST,
   DEFAULT_ALEPH_BOOTSTRAP_CHANNEL,
-  DEFAULT_ALEPH_BOOTSTRAP_COMPACT_POST_TYPE,
   DEFAULT_ALEPH_BOOTSTRAP_POST_TYPE,
   DEFAULT_ALEPH_BOOTSTRAP_REF,
   DEFAULT_BOOTSTRAP_COMPACT_MULTIADDR_LIMIT,

package/package.json

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