@le-space/browser 0.1.28 → 0.1.30

package/README.md

@@ -26,6 +26,8 @@ That client should remain small and stable. It currently owns:
 - instance listing
 - 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

@@ -161,6 +161,24 @@ interface InstanceAllocation {
     vmIpv6?: string | null;
     period?: InstanceAllocationPeriod | null;
 }
+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;
@@ -187,11 +205,14 @@ interface BroadcastResult {
 interface AlephBrowserClient {
     apiHost: string;
     crnListUrl: string;
+    schedulerApiHost: string;
     fetchBalance(address: string): Promise<BalanceResponse>;
     fetchCrns(): Promise<Crn[]>;
     fetchInstances(address: string): Promise<InstanceMessage[]>;
     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,6 +266,8 @@ declare function fetchBalance(address: string, apiHost?: string): Promise<Balanc
 declare function fetchCrns(url?: string): Promise<Crn[]>;
 declare function fetchInstances(address: string, apiHost?: string): Promise<InstanceMessage[]>;
 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>;
@@ -254,6 +277,7 @@ declare function broadcastAlephMessage(message: AlephBroadcastMessage, apiHost?:
 interface CreateAlephBrowserClientOptions {
     apiHost?: string;
     crnListUrl?: string;
+    schedulerApiHost?: string;
 }
 declare function createAlephBrowserClient(options?: CreateAlephBrowserClientOptions): AlephBrowserClient;
 
@@ -272,4 +296,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, 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, 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_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, fetchBalance, fetchCrns, fetchInstancePricing, fetchInstances, fetchMessageEnvelope, fetchSchedulerAllocation, fetchWithTimeout, inspectDeploymentResult, loadRootfsManifest, normalizeMessageStatus, notifyCrnAllocation, parseInstancePricing, resolveRootfsReference, validateRootfsManifest, verifyRootfsExists, waitForDeploymentResult };

package/index.js

@@ -65,6 +65,10 @@ function asString(value) {
 function asNumber(value) {
   return typeof value === "number" && Number.isFinite(value) ? value : null;
 }
+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");
+}
 async function fetchBalance(address, apiHost = DEFAULT_ALEPH_API_HOST) {
   const response = await fetchWithTimeout(`${apiHost}/api/v0/addresses/${address}/balance`, {
     cache: "no-cache"
@@ -120,6 +124,66 @@ async function fetchSchedulerAllocation(itemHash, schedulerApiHost = DEFAULT_ALE
     } : null
   };
 }
+async function notifyCrnAllocation(crnUrl, itemHash) {
+  const normalizedCrnUrl = crnUrl.replace(/\/+$/, "");
+  try {
+    const response = await fetchWithTimeout(`${normalizedCrnUrl}/control/allocation/notify`, {
+      method: "POST",
+      headers: {
+        "content-type": "text/plain;charset=UTF-8"
+      },
+      body: JSON.stringify({ instance: itemHash }),
+      mode: "cors"
+    });
+    if (!response.ok) {
+      const responseText = await response.text().catch(() => "");
+      throw new Error(`CRN allocation notify failed: ${response.status}${responseText ? ` ${responseText}` : ""}`);
+    }
+    return { status: "confirmed" };
+  } catch (error) {
+    if (isUnconfirmedNetworkError(error)) {
+      return { status: "unconfirmed" };
+    }
+    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);
@@ -260,9 +324,11 @@ async function broadcastAlephMessage(message, apiHost = DEFAULT_ALEPH_API_HOST,
 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;
   return {
     apiHost,
     crnListUrl,
+    schedulerApiHost,
     fetchBalance(address) {
       return fetchBalance(address, apiHost);
     },
@@ -276,7 +342,13 @@ function createAlephBrowserClient(options = {}) {
       return fetchMessageEnvelope(itemHash, apiHost);
     },
     fetchSchedulerAllocation(itemHash) {
-      return fetchSchedulerAllocation(itemHash);
+      return fetchSchedulerAllocation(itemHash, schedulerApiHost);
+    },
+    notifyCrnAllocation(crnUrl, itemHash) {
+      return notifyCrnAllocation(crnUrl, itemHash);
+    },
+    configureOrbitdbRelaySetup(args) {
+      return configureOrbitdbRelaySetup(args);
     },
     inspectDeploymentResult(itemHash, rootfsRef) {
       return inspectDeploymentResult(itemHash, rootfsRef, apiHost);
@@ -513,6 +585,7 @@ export {
   ITEM_HASH_RE,
   broadcastAlephMessage,
   broadcastInstanceMessage,
+  configureOrbitdbRelaySetup,
   createAlephBrowserClient,
   fetchBalance,
   fetchCrns,
@@ -524,6 +597,7 @@ export {
   inspectDeploymentResult,
   loadRootfsManifest,
   normalizeMessageStatus,
+  notifyCrnAllocation,
   parseInstancePricing,
   resolveRootfsReference,
   validateRootfsManifest,

package/package.json

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