@le-space/browser 0.1.29 → 0.1.31

package/README.md

@@ -24,9 +24,11 @@ That client should remain small and stable. It currently owns:
 - balance lookup
 - CRN listing
 - instance listing
+- 2n6 web access lookup
 - message envelope lookup
 - scheduler allocation lookup
 - CRN allocation notify
+- relay setup-server configure request
 - deployment result inspection and polling
 - Aleph message broadcast helpers
 

package/index.d.ts

@@ -164,6 +164,21 @@ interface InstanceAllocation {
 interface AllocationNotifyResult {
     status: 'confirmed' | 'unconfirmed';
 }
+interface RelaySetupRequest {
+    hostIpv4: string;
+    publicIpv6?: string | null;
+    setupPort: number;
+    tcpPort: number;
+    wsPort: number;
+    proxyUrl?: string | null;
+    metricsPort?: number | null;
+    metricsHttpsPort?: number | null;
+    webrtcPort?: number | null;
+    quicPort?: number | null;
+}
+interface RelaySetupResult {
+    status: 'configured' | 'unconfirmed';
+}
 interface AlephBroadcastMessage {
     sender: string;
     chain: AlephSenderChain;
@@ -194,9 +209,11 @@ interface AlephBrowserClient {
     fetchBalance(address: string): Promise<BalanceResponse>;
     fetchCrns(): Promise<Crn[]>;
     fetchInstances(address: string): Promise<InstanceMessage[]>;
+    fetch2n6WebAccessUrl(itemHash: string): Promise<string | null>;
     fetchMessageEnvelope(itemHash: string): Promise<AlephMessageEnvelope | null>;
     fetchSchedulerAllocation(itemHash: string): Promise<InstanceAllocation | null>;
     notifyCrnAllocation(crnUrl: string, itemHash: string): Promise<AllocationNotifyResult>;
+    configureOrbitdbRelaySetup(args: RelaySetupRequest): Promise<RelaySetupResult>;
     inspectDeploymentResult(itemHash: string, rootfsRef?: string): Promise<DeploymentInspectionResult>;
     waitForDeploymentResult(itemHash: string, rootfsRef?: string, attempts?: number, delayMs?: number): Promise<DeploymentInspectionResult>;
     broadcastInstanceMessage(message: AlephBroadcastMessage, sync?: boolean): Promise<BroadcastResult>;
@@ -245,12 +262,15 @@ declare function fetchWithTimeout(input: RequestInfo | URL, init?: RequestInit,
 declare const DEFAULT_ALEPH_API_HOST = "https://api2.aleph.im";
 declare const DEFAULT_CRN_LIST_URL = "https://crns-list.aleph.sh/crns.json";
 declare const DEFAULT_ALEPH_SCHEDULER_API_HOST = "https://scheduler.api.aleph.cloud";
+declare const DEFAULT_2N6_API_HOST = "https://api.2n6.me";
 declare function normalizeMessageStatus(status: unknown): MessageStatus;
 declare function fetchBalance(address: string, apiHost?: string): Promise<BalanceResponse>;
 declare function fetchCrns(url?: string): Promise<Crn[]>;
 declare function fetchInstances(address: string, apiHost?: string): Promise<InstanceMessage[]>;
+declare function fetch2n6WebAccessUrl(itemHash: string, twoN6ApiHost?: string): Promise<string | null>;
 declare function fetchSchedulerAllocation(itemHash: string, schedulerApiHost?: string): Promise<InstanceAllocation | null>;
 declare function notifyCrnAllocation(crnUrl: string, itemHash: string): Promise<AllocationNotifyResult>;
+declare function configureOrbitdbRelaySetup(args: RelaySetupRequest): Promise<RelaySetupResult>;
 declare function fetchMessageEnvelope(itemHash: string, apiHost?: string): Promise<AlephMessageEnvelope | null>;
 declare function inspectDeploymentResult(itemHash: string, rootfsRef?: string, apiHost?: string): Promise<DeploymentInspectionResult>;
 declare function waitForDeploymentResult(itemHash: string, rootfsRef?: string, apiHost?: string, attempts?: number, delayMs?: number): Promise<DeploymentInspectionResult>;
@@ -261,6 +281,7 @@ interface CreateAlephBrowserClientOptions {
     apiHost?: string;
     crnListUrl?: string;
     schedulerApiHost?: string;
+    twoN6ApiHost?: string;
 }
 declare function createAlephBrowserClient(options?: CreateAlephBrowserClientOptions): AlephBrowserClient;
 
@@ -279,4 +300,4 @@ declare const DEFAULT_ALEPH_AGGREGATE_ADDRESS = "0xFba561a84A537fCaa567bb7A2257e
 declare function parseInstancePricing(payload: unknown): InstancePricing;
 declare function fetchInstancePricing(apiHost?: string, aggregateAddress?: string): Promise<PricingState>;
 
-export { type AlephBroadcastMessage, type AlephBroadcastResponse, type AlephBrowserClient, type AlephMessageEnvelope, type AlephMessageType, type AlephSenderChain, type AllocationNotifyResult, BROWSER_PACKAGE_PLAN, type BalanceResponse, type BroadcastResult, type BrowserExtractionPhase, type BrowserPackagePlan, type ComputeUnit, type CreateAlephBrowserClientOptions, type Crn, type CrnListResponse, type CrnLocation, type CrnUsage, DEFAULT_ALEPH_AGGREGATE_ADDRESS, DEFAULT_ALEPH_API_HOST, DEFAULT_ALEPH_SCHEDULER_API_HOST, DEFAULT_CRN_LIST_URL, DEFAULT_IPFS_GATEWAY_BASE_URL, DEFAULT_ROOTFS_MANIFEST_URL, type DeploymentInspectionResult, type GatewayProbeStatus, ITEM_HASH_RE, type InstanceAllocation, type InstanceAllocationNode, type InstanceAllocationPeriod, type InstanceMessage, type InstancePricing, type LoadRootfsManifestOptions, type MessageReference, type MessageStatus, type PaymentMode, type Price, type PricingState, type ReferenceStatus, type RootfsManifest, type RootfsManifestState, type RootfsRequiredPortForward, type RootfsResolution, type Tier, broadcastAlephMessage, broadcastInstanceMessage, createAlephBrowserClient, fetchBalance, fetchCrns, fetchInstancePricing, fetchInstances, fetchMessageEnvelope, fetchSchedulerAllocation, fetchWithTimeout, inspectDeploymentResult, loadRootfsManifest, normalizeMessageStatus, notifyCrnAllocation, parseInstancePricing, resolveRootfsReference, validateRootfsManifest, verifyRootfsExists, waitForDeploymentResult };
+export { type AlephBroadcastMessage, type AlephBroadcastResponse, type AlephBrowserClient, type AlephMessageEnvelope, type AlephMessageType, type AlephSenderChain, type AllocationNotifyResult, BROWSER_PACKAGE_PLAN, type BalanceResponse, type BroadcastResult, type BrowserExtractionPhase, type BrowserPackagePlan, type ComputeUnit, type CreateAlephBrowserClientOptions, type Crn, type CrnListResponse, type CrnLocation, type CrnUsage, DEFAULT_2N6_API_HOST, DEFAULT_ALEPH_AGGREGATE_ADDRESS, DEFAULT_ALEPH_API_HOST, DEFAULT_ALEPH_SCHEDULER_API_HOST, DEFAULT_CRN_LIST_URL, DEFAULT_IPFS_GATEWAY_BASE_URL, DEFAULT_ROOTFS_MANIFEST_URL, type DeploymentInspectionResult, type GatewayProbeStatus, ITEM_HASH_RE, type InstanceAllocation, type InstanceAllocationNode, type InstanceAllocationPeriod, type InstanceMessage, type InstancePricing, type LoadRootfsManifestOptions, type MessageReference, type MessageStatus, type PaymentMode, type Price, type PricingState, type ReferenceStatus, type RelaySetupRequest, type RelaySetupResult, type RootfsManifest, type RootfsManifestState, type RootfsRequiredPortForward, type RootfsResolution, type Tier, broadcastAlephMessage, broadcastInstanceMessage, configureOrbitdbRelaySetup, createAlephBrowserClient, fetch2n6WebAccessUrl, fetchBalance, fetchCrns, fetchInstancePricing, fetchInstances, fetchMessageEnvelope, fetchSchedulerAllocation, fetchWithTimeout, inspectDeploymentResult, loadRootfsManifest, normalizeMessageStatus, notifyCrnAllocation, parseInstancePricing, resolveRootfsReference, validateRootfsManifest, verifyRootfsExists, waitForDeploymentResult };

package/index.js

@@ -51,6 +51,7 @@ async function fetchWithTimeout(input, init = {}, timeoutMs = 15e3) {
 var DEFAULT_ALEPH_API_HOST = "https://api2.aleph.im";
 var DEFAULT_CRN_LIST_URL = "https://crns-list.aleph.sh/crns.json";
 var DEFAULT_ALEPH_SCHEDULER_API_HOST = "https://scheduler.api.aleph.cloud";
+var DEFAULT_2N6_API_HOST = "https://api.2n6.me";
 function normalizeMessageStatus(status) {
   if (typeof status !== "string") return "unknown";
   const normalized = status.toLowerCase();
@@ -69,6 +70,12 @@ function isUnconfirmedNetworkError(error) {
   const message = error instanceof Error ? error.message : String(error);
   return error instanceof TypeError || message.includes("Failed to fetch") || message.includes("Request timed out");
 }
+function normalizeProxyUrl(value) {
+  const stringValue = asString(value);
+  if (!stringValue) return null;
+  if (/^https?:\/\//i.test(stringValue)) return stringValue;
+  return `https://${stringValue}`;
+}
 async function fetchBalance(address, apiHost = DEFAULT_ALEPH_API_HOST) {
   const response = await fetchWithTimeout(`${apiHost}/api/v0/addresses/${address}/balance`, {
     cache: "no-cache"
@@ -100,6 +107,19 @@ async function fetchInstances(address, apiHost = DEFAULT_ALEPH_API_HOST) {
     status: typeof message.status === "string" && message.status.trim() ? message.status : message.confirmed ? "processed" : message.status
   }));
 }
+async function fetch2n6WebAccessUrl(itemHash, twoN6ApiHost = DEFAULT_2N6_API_HOST) {
+  const requestUrl = new URL(`/api/hash/${itemHash}`, twoN6ApiHost).toString();
+  try {
+    const response = await fetchWithTimeout(requestUrl, { cache: "no-cache" });
+    if (response.status === 404 || !response.ok) {
+      return null;
+    }
+    const payload = await response.json();
+    return normalizeProxyUrl(payload.url ?? payload.subdomain);
+  } catch {
+    return null;
+  }
+}
 async function fetchSchedulerAllocation(itemHash, schedulerApiHost = DEFAULT_ALEPH_SCHEDULER_API_HOST) {
   const response = await fetchWithTimeout(`${schedulerApiHost}/api/v0/allocation/${itemHash}`, {
     cache: "no-cache"
@@ -147,6 +167,43 @@ async function notifyCrnAllocation(crnUrl, itemHash) {
     throw error;
   }
 }
+async function configureOrbitdbRelaySetup(args) {
+  const targetUrl = `http://${args.hostIpv4}:${args.setupPort}/configure`;
+  try {
+    const response = await fetchWithTimeout(
+      targetUrl,
+      {
+        method: "POST",
+        headers: {
+          "content-type": "text/plain;charset=UTF-8"
+        },
+        body: JSON.stringify({
+          public_ipv4: args.hostIpv4,
+          public_ipv6: args.publicIpv6 ?? void 0,
+          tcp_port: args.tcpPort,
+          ws_port: args.wsPort,
+          proxy_url: args.proxyUrl ?? void 0,
+          metrics_port: args.metricsPort ?? void 0,
+          metrics_https_port: args.metricsHttpsPort ?? void 0,
+          webrtc_port: args.webrtcPort ?? void 0,
+          quic_port: args.quicPort ?? void 0
+        }),
+        mode: "cors"
+      },
+      3e4
+    );
+    if (!response.ok) {
+      const responseText = await response.text().catch(() => "");
+      throw new Error(`Relay setup request failed: ${response.status}${responseText ? ` ${responseText}` : ""}`);
+    }
+    return { status: "configured" };
+  } catch (error) {
+    if (isUnconfirmedNetworkError(error)) {
+      return { status: "unconfirmed" };
+    }
+    throw error;
+  }
+}
 function messageTypeFromEnvelope(payload) {
   if (!payload) return null;
   const type = payload.type ?? payload.message?.type ?? (Array.isArray(payload.messages) ? payload.messages[0]?.type : void 0);
@@ -288,6 +345,7 @@ function createAlephBrowserClient(options = {}) {
   const apiHost = options.apiHost ?? DEFAULT_ALEPH_API_HOST;
   const crnListUrl = options.crnListUrl ?? DEFAULT_CRN_LIST_URL;
   const schedulerApiHost = options.schedulerApiHost ?? DEFAULT_ALEPH_SCHEDULER_API_HOST;
+  const twoN6ApiHost = options.twoN6ApiHost ?? DEFAULT_2N6_API_HOST;
   return {
     apiHost,
     crnListUrl,
@@ -301,6 +359,9 @@ function createAlephBrowserClient(options = {}) {
     fetchInstances(address) {
       return fetchInstances(address, apiHost);
     },
+    fetch2n6WebAccessUrl(itemHash) {
+      return fetch2n6WebAccessUrl(itemHash, twoN6ApiHost);
+    },
     fetchMessageEnvelope(itemHash) {
       return fetchMessageEnvelope(itemHash, apiHost);
     },
@@ -310,6 +371,9 @@ function createAlephBrowserClient(options = {}) {
     notifyCrnAllocation(crnUrl, itemHash) {
       return notifyCrnAllocation(crnUrl, itemHash);
     },
+    configureOrbitdbRelaySetup(args) {
+      return configureOrbitdbRelaySetup(args);
+    },
     inspectDeploymentResult(itemHash, rootfsRef) {
       return inspectDeploymentResult(itemHash, rootfsRef, apiHost);
     },
@@ -536,6 +600,7 @@ async function fetchInstancePricing(apiHost = DEFAULT_ALEPH_API_HOST, aggregateA
 }
 export {
   BROWSER_PACKAGE_PLAN,
+  DEFAULT_2N6_API_HOST,
   DEFAULT_ALEPH_AGGREGATE_ADDRESS,
   DEFAULT_ALEPH_API_HOST,
   DEFAULT_ALEPH_SCHEDULER_API_HOST,
@@ -545,7 +610,9 @@ export {
   ITEM_HASH_RE,
   broadcastAlephMessage,
   broadcastInstanceMessage,
+  configureOrbitdbRelaySetup,
   createAlephBrowserClient,
+  fetch2n6WebAccessUrl,
   fetchBalance,
   fetchCrns,
   fetchInstancePricing,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@le-space/browser",
-  "version": "0.1.29",
+  "version": "0.1.31",
   "description": "Shared browser-safe Aleph deployment and polling helpers.",
   "license": "MIT",
   "type": "module",