@le-space/browser 0.1.26 → 0.1.28

package/README.md

@@ -13,6 +13,26 @@ The package should stay UI-neutral. It should provide browser-safe helpers, but
 it should not own app-specific Svelte state, prepaid product logic, or wallet
 UX.
 
+## Client Surface
+
+The preferred public entrypoint is a typed browser client factory:
+
+- `createAlephBrowserClient({ apiHost?, crnListUrl? })`
+
+That client should remain small and stable. It currently owns:
+
+- balance lookup
+- CRN listing
+- instance listing
+- message envelope lookup
+- scheduler allocation lookup
+- deployment result inspection and polling
+- Aleph message broadcast helpers
+
+Lower-level helper functions remain exported too, but new extractions should
+prefer hanging reusable behavior off the client surface unless there is a good
+reason to keep them as standalone utilities.
+
 ## Planned v1 Scope
 
 The first real extraction wave should cover:
@@ -23,6 +43,7 @@ The first real extraction wave should cover:
   - balance fetch
   - CRN fetch
   - instance listing
+  - typed browser client factory
   - Aleph message broadcast helpers
   - deployment polling and result inspection
   - runtime detail inspection

package/index.d.ts

@@ -6,6 +6,8 @@ interface BrowserPackagePlan {
 declare const BROWSER_PACKAGE_PLAN: BrowserPackagePlan;
 type MessageStatus = 'processed' | 'pending' | 'rejected' | 'unknown';
 type ReferenceStatus = MessageStatus | 'missing';
+type AlephSenderChain = 'ETH';
+type AlephMessageType = 'INSTANCE' | 'FORGET' | 'AGGREGATE';
 interface BalanceResponse {
     address: string;
     balance: string;
@@ -141,6 +143,60 @@ interface DeploymentInspectionResult {
     rejectionReason: string | null;
     references: MessageReference[];
 }
+interface InstanceAllocationNode {
+    node_id?: string;
+    url?: string;
+    ipv6?: string | null;
+    supports_ipv6?: boolean;
+}
+interface InstanceAllocationPeriod {
+    start_timestamp?: string;
+    duration_seconds?: number;
+}
+interface InstanceAllocation {
+    source: 'scheduler' | 'manual';
+    crnHash?: string | null;
+    crnUrl?: string | null;
+    node?: InstanceAllocationNode | null;
+    vmIpv6?: string | null;
+    period?: InstanceAllocationPeriod | null;
+}
+interface AlephBroadcastMessage {
+    sender: string;
+    chain: AlephSenderChain;
+    signature: string;
+    type: AlephMessageType;
+    item_hash: string;
+    item_type: 'inline';
+    item_content: string;
+    time: number;
+    channel: string;
+}
+interface AlephBroadcastResponse {
+    publication_status?: {
+        status: string;
+        failed?: unknown[];
+    };
+    message_status?: MessageStatus;
+    [key: string]: unknown;
+}
+interface BroadcastResult {
+    response: AlephBroadcastResponse;
+    httpStatus: number;
+}
+interface AlephBrowserClient {
+    apiHost: string;
+    crnListUrl: 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>;
+    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>;
+    broadcastAlephMessage(message: AlephBroadcastMessage, sync?: boolean): Promise<BroadcastResult>;
+}
 interface RootfsRequiredPortForward {
     port: number;
     tcp?: boolean;
@@ -183,13 +239,23 @@ 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 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 fetchSchedulerAllocation(itemHash: string, schedulerApiHost?: string): Promise<InstanceAllocation | null>;
 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>;
+declare function broadcastInstanceMessage(message: AlephBroadcastMessage, apiHost?: string, sync?: boolean): Promise<BroadcastResult>;
+declare function broadcastAlephMessage(message: AlephBroadcastMessage, apiHost?: string, sync?: boolean): Promise<BroadcastResult>;
+
+interface CreateAlephBrowserClientOptions {
+    apiHost?: string;
+    crnListUrl?: string;
+}
+declare function createAlephBrowserClient(options?: CreateAlephBrowserClientOptions): AlephBrowserClient;
 
 declare const ITEM_HASH_RE: RegExp;
 declare const DEFAULT_ROOTFS_MANIFEST_URL = "./rootfs-manifest.json";
@@ -206,4 +272,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 AlephMessageEnvelope, BROWSER_PACKAGE_PLAN, type BalanceResponse, type BrowserExtractionPhase, type BrowserPackagePlan, type ComputeUnit, type Crn, type CrnListResponse, type CrnLocation, type CrnUsage, DEFAULT_ALEPH_AGGREGATE_ADDRESS, DEFAULT_ALEPH_API_HOST, DEFAULT_CRN_LIST_URL, DEFAULT_IPFS_GATEWAY_BASE_URL, DEFAULT_ROOTFS_MANIFEST_URL, type DeploymentInspectionResult, type GatewayProbeStatus, ITEM_HASH_RE, 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, fetchBalance, fetchCrns, fetchInstancePricing, fetchInstances, fetchMessageEnvelope, fetchWithTimeout, inspectDeploymentResult, loadRootfsManifest, normalizeMessageStatus, parseInstancePricing, resolveRootfsReference, validateRootfsManifest, verifyRootfsExists, waitForDeploymentResult };
+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 };

package/index.js

@@ -50,6 +50,7 @@ async function fetchWithTimeout(input, init = {}, timeoutMs = 15e3) {
 // src/aleph-api.ts
 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";
 function normalizeMessageStatus(status) {
   if (typeof status !== "string") return "unknown";
   const normalized = status.toLowerCase();
@@ -58,6 +59,12 @@ function normalizeMessageStatus(status) {
   }
   return "unknown";
 }
+function asString(value) {
+  return typeof value === "string" && value.trim() ? value : null;
+}
+function asNumber(value) {
+  return typeof value === "number" && Number.isFinite(value) ? value : null;
+}
 async function fetchBalance(address, apiHost = DEFAULT_ALEPH_API_HOST) {
   const response = await fetchWithTimeout(`${apiHost}/api/v0/addresses/${address}/balance`, {
     cache: "no-cache"
@@ -89,6 +96,30 @@ 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 fetchSchedulerAllocation(itemHash, schedulerApiHost = DEFAULT_ALEPH_SCHEDULER_API_HOST) {
+  const response = await fetchWithTimeout(`${schedulerApiHost}/api/v0/allocation/${itemHash}`, {
+    cache: "no-cache"
+  });
+  if (response.status === 404) return null;
+  if (!response.ok) throw new Error(`Scheduler allocation request failed: ${response.status}`);
+  const payload = await response.json();
+  const node = payload.node;
+  return {
+    source: "scheduler",
+    crnUrl: asString(node?.url),
+    node: node ? {
+      node_id: asString(node.node_id) ?? void 0,
+      url: asString(node.url) ?? void 0,
+      ipv6: asString(node.ipv6),
+      supports_ipv6: typeof node.supports_ipv6 === "boolean" ? node.supports_ipv6 : void 0
+    } : null,
+    vmIpv6: asString(payload.vm_ipv6),
+    period: payload.period ? {
+      start_timestamp: asString(payload.period.start_timestamp) ?? void 0,
+      duration_seconds: asNumber(payload.period.duration_seconds) ?? void 0
+    } : null
+  };
+}
 function messageTypeFromEnvelope(payload) {
   if (!payload) return null;
   const type = payload.type ?? payload.message?.type ?? (Array.isArray(payload.messages) ? payload.messages[0]?.type : void 0);
@@ -181,6 +212,86 @@ async function waitForDeploymentResult(itemHash, rootfsRef, apiHost = DEFAULT_AL
   }
   return lastResult;
 }
+function isInvalidMessageFormatResponse(response, payload) {
+  if (response.status !== 422) return false;
+  const details = payload.details;
+  if (typeof details === "string" && details.includes("InvalidMessageFormat")) return true;
+  if (details && typeof details === "object") {
+    const detailMessage = details.message;
+    if (typeof detailMessage === "string" && detailMessage.includes("InvalidMessageFormat")) return true;
+  }
+  return false;
+}
+async function postBroadcastPayload(body, apiHost) {
+  const rawResponse = await fetchWithTimeout(`${apiHost}/api/v0/messages`, {
+    method: "POST",
+    headers: { "content-type": "application/json" },
+    body: JSON.stringify(body)
+  });
+  const response = await rawResponse.json().catch(() => ({}));
+  return {
+    response,
+    httpStatus: rawResponse.status,
+    rawResponse
+  };
+}
+async function broadcastInstanceMessage(message, apiHost = DEFAULT_ALEPH_API_HOST, sync = false) {
+  const attempts = [{ sync, message }, { ...message, sync }, { ...message }];
+  for (let index = 0; index < attempts.length; index += 1) {
+    const result = await postBroadcastPayload(attempts[index], apiHost);
+    if (result.rawResponse.ok || result.httpStatus === 202) {
+      return {
+        response: result.response,
+        httpStatus: result.httpStatus
+      };
+    }
+    const canRetry = index < attempts.length - 1 && isInvalidMessageFormatResponse(result.rawResponse, result.response);
+    if (!canRetry) {
+      throw new Error(`Broadcast failed: ${result.httpStatus} ${JSON.stringify(result.response)}`);
+    }
+  }
+  throw new Error("Broadcast failed: no compatible request format was accepted");
+}
+async function broadcastAlephMessage(message, apiHost = DEFAULT_ALEPH_API_HOST, sync = false) {
+  return broadcastInstanceMessage(message, apiHost, sync);
+}
+
+// src/client.ts
+function createAlephBrowserClient(options = {}) {
+  const apiHost = options.apiHost ?? DEFAULT_ALEPH_API_HOST;
+  const crnListUrl = options.crnListUrl ?? DEFAULT_CRN_LIST_URL;
+  return {
+    apiHost,
+    crnListUrl,
+    fetchBalance(address) {
+      return fetchBalance(address, apiHost);
+    },
+    fetchCrns() {
+      return fetchCrns(crnListUrl);
+    },
+    fetchInstances(address) {
+      return fetchInstances(address, apiHost);
+    },
+    fetchMessageEnvelope(itemHash) {
+      return fetchMessageEnvelope(itemHash, apiHost);
+    },
+    fetchSchedulerAllocation(itemHash) {
+      return fetchSchedulerAllocation(itemHash);
+    },
+    inspectDeploymentResult(itemHash, rootfsRef) {
+      return inspectDeploymentResult(itemHash, rootfsRef, apiHost);
+    },
+    waitForDeploymentResult(itemHash, rootfsRef, attempts, delayMs) {
+      return waitForDeploymentResult(itemHash, rootfsRef, apiHost, attempts, delayMs);
+    },
+    broadcastInstanceMessage(message, sync) {
+      return broadcastInstanceMessage(message, apiHost, sync);
+    },
+    broadcastAlephMessage(message, sync) {
+      return broadcastAlephMessage(message, apiHost, sync);
+    }
+  };
+}
 
 // src/rootfs.ts
 var ITEM_HASH_RE = /^[a-fA-F0-9]{64}$/u;
@@ -395,15 +506,20 @@ export {
   BROWSER_PACKAGE_PLAN,
   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,
   ITEM_HASH_RE,
+  broadcastAlephMessage,
+  broadcastInstanceMessage,
+  createAlephBrowserClient,
   fetchBalance,
   fetchCrns,
   fetchInstancePricing,
   fetchInstances,
   fetchMessageEnvelope,
+  fetchSchedulerAllocation,
   fetchWithTimeout,
   inspectDeploymentResult,
   loadRootfsManifest,

package/package.json

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